Commit 5f3f101b authored by Andrew Heather's avatar Andrew Heather
Browse files

BUG: Doxygen corrections

parent 31fbc95f
......@@ -22,11 +22,11 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::phasePair description for mass transfer between a pair of
phases. The direction of the mass transfer is from the phase
'from' to the phasse 'to'.
Foam::phasePair
Description
Description for mass transfer between a pair of phases. The direction of
the mass transfer is from the phase 'from' to the phasse 'to'.
SourceFiles
phasePair.C
......
......@@ -155,7 +155,7 @@ public:
// \code
// (numElem / elem_per_block)
// + (numElem % elem_per_block) ? 1 : 0
// \code
// \endcode
// But avoiding the modulus operation
static constexpr label num_blocks(label numElem)
{
......@@ -471,7 +471,6 @@ public:
Ostream& os,
const PackedList<Width>& list
);
};
......
......@@ -32,7 +32,7 @@ Description
field and derived quantities. Alternatively, the same actions can be
executed after the simulation using the \c -postProcess command-line option.
\subsection secFunctionObjects Using function objects
\section secFunctionObjects Using function objects
FunctionObjects are selected by additional entries in the
$FOAM_CASE/system/controlDict dictionary. Each object is listed in the \c
......
......@@ -29,9 +29,9 @@ Description
In parallel it will assume ranks are sorted according to hostname
and the lowest rank per hostname will be the IO rank. The output directories
will get a unique name processors<N>_<low>-<high> where N is the overall
number of processors and low and high is the range of ranks contained
in the files. Each of these subsets uses its own communicator.
will get a unique name processors\<N\>_\<low\>-\<high\> where N is the
overall number of processors and low and high is the range of ranks
contained in the files. Each of these subsets uses its own communicator.
Instead of using the hostnames the IO ranks can be assigned using the
FOAM_IORANKS environment variable (also when running non-parallel), e.g.
......
......@@ -28,8 +28,9 @@ Description
fileOperations that performs all file operations on the master processor.
Requires the calls to be parallel synchronised!
Limitations: - no /processor in filename
- no /uniform/ in the filename
Limitations
- no /processor in filename
- no /uniform/ in the filename
The main logic is in ::filePath which returns a
- same path on all processors. This can either be a global file
......@@ -40,12 +41,12 @@ Description
- different path on all processors (processor0/0/p)
system/controlDict:
filePath worldmaster: <globalRoot>/system/controlDict
filePath worldmaster: \<globalRoot\>/system/controlDict
localmaster: ,,
slave : ,,
processor0/uniform/time
filePath worldmaster: <globalRoot>/processorXXX/uniform/time
filePath worldmaster: \<globalRoot\>/processorXXX/uniform/time
localmaster: ,,
slave : ,,
......
......@@ -231,6 +231,7 @@ public:
//
// if (nOrig == zones.size()) { existing... } else { new... }
// \endcode
// \param zoneName the name of the zone
// \param verbose report if an existing zone was selected or
// a new zone was created.
// \return non-const reference to the existing or new zone
......
......@@ -86,6 +86,12 @@ public:
//- Copy constructor
explicit Table(const Table<Type>& tbl);
//- Construct and return a clone
virtual tmp<Function1<Type>> clone() const
{
return tmp<Function1<Type>>(new Table<Type>(*this));
}
//- Destructor
virtual ~Table();
......
......@@ -218,10 +218,10 @@ namespace stringOps
// -# current directory
// - leading "./" : the current directory
// -# leading tag expansion for commonly used directories
// - <etc>/ : user/group/other OpenFOAM directory
// - <case>/ : FOAM_CASE directory
// - <constant>/ : FOAM_CASE/constant directory
// - <system>/ : FOAM_CASE/system directory
// - \<etc\>/ : user/group/other OpenFOAM directory
// - \<case\>/ : FOAM_CASE directory
// - \<constant\>/ : FOAM_CASE/constant directory
// - \<system\>/ : FOAM_CASE/system directory
// -# tilde expansion
// - leading "~/" : home directory
// - leading "~user" : home directory for specified user
......@@ -258,10 +258,10 @@ namespace stringOps
// -# current directory
// - leading "./" : the current directory
// -# leading tag expansion for commonly used directories
// - <etc>/ : user/group/other OpenFOAM directory
// - <case>/ : FOAM_CASE directory
// - <constant>/ : FOAM_CASE/constant directory
// - <system>/ : FOAM_CASE/system directory
// - \<etc\>/ : user/group/other OpenFOAM directory
// - \<case\>/ : FOAM_CASE directory
// - \<constant\>/ : FOAM_CASE/constant directory
// - \<system\>/ : FOAM_CASE/system directory
// -# tilde expansion
// - leading "~/" : home directory
// - leading "~user" : home directory for specified user
......
......@@ -35,7 +35,7 @@ Description
There are many versions and developments of the EDC model, 4 of which are
currently supported in this implementation: v1981, v1996, v2005 and
v2016. The model variant is selected using the optional \c version entry in
the \c EDCCoeffs dictionary, \eg
the \c EDCCoeffs dictionary, e.g.
\verbatim
EDCCoeffs
......
......@@ -45,6 +45,7 @@ Usage
}
}
}
\endverbatim
Where the loop entries comprise:
\table
......
......@@ -45,8 +45,8 @@ Description
except that no interpolation in time is supported. These should be
located in the directory:
\$FOAM_CASE/constant/boundaryData/<patchName>/points
\$FOAM_CASE/constant/boundaryData/<patchName>/0/\{R|U|L\}
\$FOAM_CASE/constant/boundaryData/\<patchName\>/points
\$FOAM_CASE/constant/boundaryData/\<patchName\>/0/\{R|U|L\}
Usage
......
......@@ -49,7 +49,7 @@ Usage
type | Type name: CourantNo | yes |
rho | Name of density field | no | rho
field | Name of flux field | no | phi
result | Name of Courant number field | no | <function name>
result | Name of Courant number field | no | \<function name\>
log | Log to standard output | no | yes
\endtable
......
......@@ -51,7 +51,7 @@ Usage
\table
Property | Description | Required | Default value
type | type name: DESModelRegions| yes |
resultName | Name of DES indicator field | no | <function name>
resultName | Name of DES indicator field | no | \<function name\>
log | log to standard output | no | yes
\endtable
......
......@@ -47,7 +47,7 @@ Usage
type | type name: Peclet | yes |
phi | Name of flux field | no | phi
rho | Name of density field | no | rho
result | Name of Peclet field | no | <function name>
result | Name of Peclet field | no | \<function name\>
log | Log to standard output | no | yes
\endtable
......
......@@ -56,7 +56,7 @@ Usage
Property | Description | Required | Default value
type | type name: Q | yes |
U | Name of velocity field | no | U
result | Name of Q field | no | <function name>
result | Name of Q field | no | \<function name\>
log | Log to standard output | no | yes
\endtable
......
......@@ -42,7 +42,7 @@ Description
The factor is a face-based quantity, which is converted to a cell-based
quantity by assigning the minimum blending factor for any cell face.
An indicator (volume) field, named <functionObjectName>:<fieldName>, is
An indicator (volume) field, named \<functionObjectName\>:\<fieldName\>, is
generated that is set to (1 - f), i.e. values of:
- 0 represent scheme1 as active, and
- 1 represent scheme2 as active.
......
......@@ -71,7 +71,7 @@ Usage
- surface
- surfaceAndDirection
Output data is written to files of the form \<timeDir\>/<faceZoneName>.dat
Output data is written to files of the form \<timeDir\>/\<faceZoneName\>.dat
See also
Foam::functionObjects::fvMeshFunctionObject
......
......@@ -53,7 +53,7 @@ Usage
type | Type name: mapFields | yes |
mapRegion | Name of region to map to | yes |
mapMethod | Mapping method | yes |
patchMapMethod | Patch mapping method | no | <auto>
patchMapMethod | Patch mapping method | no | \<auto\>
consistent | Mapping meshes have consistent boundaries | yes |
fields | List of field names to map | yes |
log | Log to standard output | no | yes
......
......@@ -67,8 +67,8 @@ Usage
Property | Description | Required | Default value
type | Type name: reference | yes |
field | Name of field | yes |
result | Name of result field | no | reference(<field>)
position | Position to sample | no | <not used>
result | Name of result field | no | reference(\<field\>)
position | Position to sample | no | \<not used\>
scale | Scale value | no | 1
offset | Offset value | no | zero
log | Log to standard output | no | yes
......
......@@ -63,7 +63,7 @@ Description
),
1.0
)
\f[
\f]
For option 2, the following relation is used:
\f[
......@@ -78,7 +78,7 @@ Description
),
1.0
)
\f[
\f]
Note that magGradCC is equal to 3 for ortoghonal meshes
For option 3 a PID control is used in order to control residual
......@@ -89,14 +89,14 @@ Description
P*residual
+ I*residualIntegral
+ D*residualDifferential
\f[
\f]
where P, I and D are user inputs
The following relation is used:
\f[
fRes = (factor - meanRes)/(maxRes*meanRes);
\f[
\f]
where:
meanRes = average(residual)
......@@ -120,7 +120,7 @@ Description
),
1.0
)
\f[
\f]
Note that faceWeights for a orthogonal mesh is 0.5.
......@@ -138,7 +138,7 @@ Description
),
1.0
)
\f[
\f]
For option 6 , the following relation is used:
......@@ -275,8 +275,7 @@ Usage
tolerance | Tolerance for number of blended cells | no | 0.001
field | Name of field to evaluate | yes |
result | Name of surface field to be used in the localBlended scheme
| yes
| yes |
\endtable
The 'log' flag true write the number of cells on each scheme, plus it
......
Markdown is supported
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