Commit e5787485 authored by Henry Weller's avatar Henry Weller
Browse files

Updated Doxygen documentation and files

Contributed by Bruno Santos
Resolves patch report http://www.openfoam.org/mantisbt/view.php?id=2023

Update online documentation http://openfoam.github.io/Documentation-dev/html/
parent b4ebcd77
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -33,7 +33,7 @@ Description
This boundary condition provides a fixed density inlet condition for
compressible solvers, where the density of calculated using:
\f{
\f[
\rho = \psi p
\f]
......
......@@ -35,7 +35,7 @@ Usage
\param -ascii \n
Write Ensight data in ASCII format instead of "C Binary"
\parm -name \<subdir\>\n
\param -name \<subdir\>\n
define sub-directory name to use for Ensight data (default: "Ensight")
\param -noZero \n
......
......@@ -2,15 +2,19 @@
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UFT-8"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title> OpenFOAM&reg; Programmer's C++ documentation </title>
<!-- links -->
<link href="../OpenFOAMdocIcon.png" rel="icon" type="image/png" />
<link href="search/search.css" rel="stylesheet" type="text/css" />
<link href="../css/openfoam.css" rel="stylesheet" type="text/css" />
<script type="text/javaScript" src="search/searchdata.js"></script>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<!-- meta info -->
<meta
......
......@@ -11,6 +11,11 @@ body {
font-size: 62.5%;
} /*Font-size: 1.0em = 10px when browser default size is 16px*/
/* Using the same as the code/verbatim blocks in doxygen.css */
code {
font-family: "Courier New", Courier, monospace, fixed;
}
p:after {
content:".";
display:block;
......@@ -243,7 +248,7 @@ p:after {
padding-bottom:30px;
border-left: 3px solid rgb(175,175,175);
border-right:3px solid rgb(175,175,175);
background:transparent url(img/bg_main.gif) top left repeat-y;
background:transparent;
}
.main img {
clear:both;
......
......@@ -25,7 +25,7 @@ Class
Foam::Pstream
Description
Inter-processor communications stream
Inter-processor communications stream.
SourceFiles
Pstream.C
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -21,6 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
InNamespace
Foam
Description
Inter-processor communication reduction functions.
\*---------------------------------------------------------------------------*/
#ifndef PstreamReduceOps_H
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -110,12 +110,15 @@ public:
//- Construct from Time, a dictionary with "functions" entry
// and the execution setting.
// \param[in] t - the other Time instance to construct from
// \param[in] parentDict - the parent dictionary containing
// a "functions" entry, which can either be a list or a dictionary
// of functionObject specifications.
// \param[in] execution - whether the function objects should execute
// or not. Default: true.
functionObjectList
(
const Time&,
const Time& t,
const dictionary& parentDict,
const bool execution=true
);
......
......@@ -543,8 +543,6 @@ Type average(const FieldField<Field, Type>& f)
TMP_UNARY_FUNCTION(Type, average)
#include "PstreamReduceOps.H"
#define G_UNARY_FUNCTION(returnType, gFunc, func, rFunc) \
\
template<template<class> class Field, class Type> \
......
......@@ -30,34 +30,34 @@ Description
Example:
\verbatim
movingWall
{
type codedFixedValue;
value uniform 0;
redirectType rampedFixedValue; // name of generated bc
movingWall
{
type codedFixedValue;
value uniform 0;
redirectType rampedFixedValue; // name of generated bc
code
#{
operator==
(
vector(0,0,1)
*min(10, 0.1*this->db().time().value())
);
#};
//codeInclude
//#{
// #include "fvCFD.H"
//#};
//codeOptions
//#{
// -I$(LIB_SRC)/finiteVolume/lnInclude
//#};
}
code
#{
operator==
(
vector(0,0,1)
*min(10, 0.1*this->db().time().value())
);
#};
//codeInclude
//#{
// #include "fvCFD.H"
//#};
//codeOptions
//#{
// -I$(LIB_SRC)/finiteVolume/lnInclude
//#};
}
\endverbatim
A special form is if the 'code' section is not supplied. In this case
A special form is if the \c code section is not supplied. In this case
the code gets read from a (runTimeModifiable!) dictionary system/codeDict
which would have a corresponding entry
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -41,7 +41,9 @@ namespace Foam
namespace debug
{
//! \cond ignoreDocumentation - local scope
//! \cond ignoreDocumentation
//- Skip documentation : local scope only
dictionary* controlDictPtr_(NULL);
dictionary* debugSwitchesPtr_(NULL);
dictionary* infoSwitchesPtr_(NULL);
......@@ -55,7 +57,7 @@ simpleObjectRegistry* dimensionSetObjectsPtr_(NULL);
simpleObjectRegistry* dimensionedConstantObjectsPtr_(NULL);
// to ensure controlDictPtr_ is deleted at the end of the run
// To ensure controlDictPtr_ is deleted at the end of the run
class deleteControlDictPtr
{
public:
......
......@@ -4,6 +4,8 @@
#include "scalar.H"
#include "vector.H"
#include "curve.H"
#include "char.H"
#include "List.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
......@@ -13,9 +15,6 @@ namespace Foam
#define curveSmall 1.0e-8
#define curveGreat 1.0e8
#include "char.H"
#include "List.H"
typedef List<char> charList;
typedef List<charList> charListList;
......
......@@ -29,9 +29,9 @@ Description
The reference scalar values must be monotonically increasing.
The handling of out-of-bounds values depends on the current setting
of \a outOfBounds.
of \c outOfBounds.
If \a REPEAT is chosen for the out-of-bounds handling, the final time
If \c repeat is chosen for the out-of-bounds handling, the final time
value is treated as being equivalent to time=0 for the following periods.
......@@ -40,11 +40,13 @@ Description
other format is csv (comma separated values):
Read csv format:
\verbatim
readerType csv;
fileName "$FOAM_CASE/constant/p0vsTime.csv";
hasHeaderLine true; // skip first line
timeColumn 0; // time is in column 0
valueColumns (1); // value starts in column 1
\endverbatim
Note
......
......@@ -171,12 +171,13 @@ protected:
// Processor agglomeration
//- Collect and combine processor meshes into allMesh.
// - allMeshComm : communicator for combined mesh.
// - procAgglomMap : per processor the new agglomerated processor
// (rank in allMeshComm!). Global information.
// - procIDs : local information: same for all in
// agglomerated processor.
//- Collect and combine processor meshes into allMesh:
//
// - allMeshComm : communicator for combined mesh.
// - procAgglomMap : per processor the new agglomerated
// processor (rank in allMeshComm!). Global information.
// - procIDs : local information: same for all in
// agglomerated processor.
void procAgglomerateLduAddressing
(
const label comm,
......@@ -187,8 +188,9 @@ protected:
);
//- Collect and combine basic restriction addressing:
// nCells_
// restrictAddressing_
//
// - nCells_
// - restrictAddressing_
void procAgglomerateRestrictAddressing
(
const label comm,
......@@ -426,10 +428,11 @@ public:
// with GAMGSolver notation.
//- Given fine to coarse processor map determine:
// - for each coarse processor a master (minimum of the fine
// processors)
// - for each coarse processor the set of fine processors
// (element 0 is the master processor)
//
// - for each coarse processor a master (minimum of the fine
// processors)
// - for each coarse processor the set of fine processors
// (element 0 is the master processor)
static void calculateRegionMaster
(
const label comm,
......
......@@ -33,6 +33,7 @@ Description
MoveableMeshObject, UpdateableMeshObject) and the type of the actual object
it is created for example:
\verbatim
class leastSquaresVectors
:
public MeshObject<fvMesh, MoveableMeshObject, leastSquaresVectors>
......@@ -43,17 +44,20 @@ Description
//- Delete the least square vectors when the mesh moves
virtual bool movePoints();
};
\endverbatim
MeshObject types:
TopologicalMeshObject: mesh object to be deleted on topology change
GeometricMeshObject: mesh object to be deleted on geometry change
MoveableMeshObject: mesh object to be updated in movePoints
UpdateableMeshObject: mesh object to be updated in updateMesh or movePoints
- TopologicalMeshObject: mesh object to be deleted on topology change
- GeometricMeshObject: mesh object to be deleted on geometry change
- MoveableMeshObject: mesh object to be updated in movePoints
- UpdateableMeshObject: mesh object to be updated in updateMesh or
movePoints
Note that movePoints must be provided for MeshObjects of type
MoveableMeshObject and both movePoints and updateMesh functions must exist
provided for MeshObjects of type UpdateableMeshObject.
Note
movePoints must be provided for MeshObjects of type MoveableMeshObject
and both movePoints and updateMesh functions must exist, provided for
MeshObjects of type UpdateableMeshObject.
SourceFiles
MeshObject.C
......
......@@ -123,6 +123,7 @@ public:
//- Determine the mapping for a sub-patch.
// Only include faces for which bool-list entry is true.
// \param[in] p patch to be searched on
// \param[in] includeFaces faces to include
// \param[out] pointMap mapping new to old localPoints
// \param[out] faceMap mapping new to old faces
......@@ -136,7 +137,7 @@ public:
>
static void subsetMap
(
const PrimitivePatch<Face, FaceList, PointField, PointType>&,
const PrimitivePatch<Face, FaceList, PointField, PointType>& p,
const BoolListType& includeFaces,
labelList& pointMap,
labelList& faceMap
......
......@@ -44,7 +44,8 @@ const Foam::treeBoundBox Foam::treeBoundBox::invertedBox
);
//! \cond - skip documentation : local scope only
//! \cond ignoreDocumentation
//- Skip documentation : local scope only
const Foam::label facesArray[6][4] =
{
{0, 4, 6, 2}, // left
......@@ -63,7 +64,8 @@ const Foam::faceList Foam::treeBoundBox::faces
);
//! \cond - skip documentation : local scope only
//! \cond ignoreDocumentation
//- Skip documentation : local scope only
const Foam::label edgesArray[12][2] =
{
{0, 1}, // 0
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -62,7 +62,7 @@ Description
type compressible::turbulentTemperatureCoupledBaffleMixed;
Tnbr T;
kappa lookup;
KappaName kappa;
kappaName kappa;
thicknessLayers (0.1 0.2 0.3 0.4);
kappaLayers (1 2 3 4)
value uniform 300;
......@@ -71,14 +71,13 @@ Description
Needs to be on underlying mapped(Wall)FvPatch.
Note: kappa : heat conduction at patch. Gets supplied how to lookup
calculate kappa:
Note:
- 'lookup' : lookup volScalarField (or volSymmTensorField) with name
- 'fluidThermo' : use fluidThermo and compressible::RASmodel to calculate
kappa
- 'solidThermo' : use solidThermo kappa()
- 'directionalSolidThermo' directionalKappa()
\li \c kappa and \c kappaName are inherited from temperatureCoupledBase.
SeeAlso
Foam::temperatureCoupledBase
SourceFiles
turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.C
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2012-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2012-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -29,7 +29,7 @@ License
This group contains RAS turbulence model boundary conditions
@}
\defgroup grpWallFunctions RAS wall functions
\defgroup grpRASWallFunctions RAS wall functions
@{
\ingroup grpRASBoundaryConditions
This group contains RAS turbulence model wall functions
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -28,6 +28,8 @@ Description
Mesh at a patch created on the fly. The following entry should be used
on the field boundary dictionary:
Example:
\verbatim
// New Shell mesh data
extrudeModel linearNormal;
......@@ -61,6 +63,7 @@ Description
name "side";
type empty;
}
\endverbatim
\*---------------------------------------------------------------------------*/
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
......@@ -25,13 +25,14 @@ Class
Foam::fv::option
Description
Finite volume options abtract base class. Provides a base set of controls,
e.g.
Finite volume options abstract base class. Provides a base set of
controls, e.g.:
\verbatim
type scalarExplicitSource // source type
active on; // on/off switch
\endverbatim
Note:
Note
On evaluation, source/sink options are to be added to the equation R.H.S.
SourceFiles
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment