Commit 7a34f290 authored by Andrew Heather's avatar Andrew Heather
Browse files

DOC: header documentation updates/corrections

parent 77aa2e60
......@@ -36,7 +36,7 @@ Description
\verbatim
a 1.0;
b 3;
c #calc "$a/$b";
c \#calc "$a/$b";
\endverbatim
Note the explicit trailing 0 ('1.0') to force a to be read (and written)
......@@ -44,7 +44,7 @@ Description
Note
Internally this is just a wrapper around codeStream functionality - the
#calc string gets used to construct a dictionary for codeStream.
\#calc string gets used to construct a dictionary for codeStream.
SourceFiles
calcEntry.C
......
......@@ -131,7 +131,7 @@ Description
onEnd | Trigger on end of simulation run
\endtable
The sub-dictionary name \c <userDefinedSubDictName> is chosen by the user,
The sub-dictionary name \c \<userDefinedSubDictName\> is chosen by the user,
and is typically used as the name of the output directory for any data
written by the function object.
......
......@@ -32,7 +32,7 @@ Description
Usage
Example:
\verbatim
<patchName>
\<patchName\>
{
type uniformFixedValue;
uniformValue
......@@ -55,7 +55,7 @@ Usage
}
\endverbatim
Very much like '#eval' but runtime
Very much like '\#eval' but runtime
See also
Foam::exprFixedValueFvPatchField
......
......@@ -39,12 +39,12 @@ Description
The governing equation of the boundary condition:
\f[
\u = \frac{\u^*}{\kappa} ln \left(\frac{z + z_0}{z_0}\right)
u = \frac{u^*}{\kappa} ln \left(\frac{z + z_0}{z_0}\right)
\f]
where
\vartable
\u^* | Friction velocity
u^* | Friction velocity
\kappa | von Kármán constant
z_0 | Surface roughness length [m]
z | Ground-normal coordinate
......
......@@ -40,12 +40,12 @@ Description
The governing equation of the boundary condition:
\f[
\u = \frac{\u^*}{\kappa} ln \left(\frac{z + z_0}{z_0}\right)
u = \frac{u^*}{\kappa} ln \left(\frac{z + z_0}{z_0}\right)
\f]
where
\vartable
\u^* | Friction velocity
u^* | Friction velocity
\kappa | von Kármán constant
z_0 | Surface roughness length [m]
z | Ground-normal coordinate
......
......@@ -39,7 +39,7 @@ Description
shear in the production and dissipation of turbulent kinetic energy.
\f[
u^* = \sqrt{\max (\nu_t \sqrt{2 |\symm{\grad{\u}}|^2}, VSMALL)}
u^* = \sqrt{\max (\nu_t \sqrt{2 |\symm{\grad{u}}|^2}, VSMALL)}
\f]
\f[
......@@ -55,7 +55,7 @@ Description
\vartable
u^* | Friction velocity [m/s]
\nu_t | Turbulent viscosity [m2/s]
\u | Velocity [m/s]
u | Velocity [m/s]
L_o | Obukhov length [m]
B | Buoyancy production term [m2/s3]
\alpha_t | Kinematic turbulent thermal conductivity [m2/s]/[kg/m/s]
......
......@@ -38,7 +38,7 @@ Description
Operand | Type | Location
input | - | -
output file | - | -
output field | volScalarField | $FOAM_CASE/<time>/<outField>
output field | volScalarField | $FOAM_CASE/\<time\>/\<outField\>
\endtable
Usage
......
......@@ -69,7 +69,7 @@ Usage
Property | Description | Type | Req'd | Dflt
type | Type name: DESModelRegions | word | yes | -
libs | Library name: fieldFunctionObjects | word | yes | -
result | Name of DES indicator field | word | no | <FO>
result | Name of DES indicator field | word | no | \<FO\>
\endtable
The inherited entries are elaborated in:
......
......@@ -80,7 +80,7 @@ Usage
\endverbatim
Note
To execute \c LambVector function object on an input <field>, a numerical
To execute \c LambVector function object on an input \<field\>, a numerical
scheme should be defined for \c div(LambVector) in
\c system/fvSchemes.divSchemes.
......
......@@ -36,9 +36,9 @@ Description
Operands:
\table
Operand | Type | Location
input | volVectorField | $FOAM_CASE/<time>/<inpField>
input | volVectorField | $FOAM_CASE/\<time\>/\<inpField\>
output file | - | -
output field | volScalarField | $FOAM_CASE/<time>/<outField>
output field | volScalarField | $FOAM_CASE/\<time\>/\<outField\>
\endtable
Usage
......
......@@ -48,9 +48,9 @@ Description
Operands:
\table
Operand | Type | Location
input | volVectorField | $FOAM_CASE/<time>/<inpField>
input | volVectorField | $FOAM_CASE/\<time\>/\<inpField\>
output file | - | -
output field | volScalarField | $FOAM_CASE/<time>/<outField>
output field | volScalarField | $FOAM_CASE/\<time\>/\<outField\>
\endtable
Usage
......
......@@ -51,7 +51,7 @@ Usage
libs (fieldFunctionObjects);
// Mandatory (inherited) entry (runtime modifiable)
field <field>;
field \<field\>;
// Optional (inherited) entries
...
......@@ -72,12 +72,12 @@ Usage
Minimal example by using the \c postProcess utility:
\verbatim
postProcess -func "div(<field>)"
postProcess -func "div(\<field\>)"
\endverbatim
Note
To execute \c div function object on an input <field>, a numerical scheme
should be defined for \c div(<field>) in \c system/fvSchemes.divSchemes.
To execute \c div function object on an input \<field\>, a numerical scheme
should be defined for \c div(\<field\>) in \c system/fvSchemes.divSchemes.
See also
- Foam::functionObject
......
......@@ -34,10 +34,10 @@ Description
Operands:
\table
Operand | Type | Location
input | vol<Type>Field | $FOAM_CASE/<time>/<inpField>
output file | - | -
output field | vol<Type>Field | $FOAM_CASE/<time>/<outField>
Operand | Type | Location
input | vol\<Type\>Field | $FOAM_CASE/\<time\>/\<inpField\>
output file | - | -
output field | vol\<Type\>Field | $FOAM_CASE/\<time\>/\<outField\>
\endtable
where \c \<Type\>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor.
......
......@@ -78,9 +78,9 @@ Description
Operands:
\table
Operand | Type | Location
input | volScalarField | $FOAM_CASE/<time>/<inpField>
input | volScalarField | $FOAM_CASE/\<time\>/\<inpField\>
output file | - | -
output field | volScalarField | $FOAM_CASE/<time>/<outField>
output field | volScalarField | $FOAM_CASE/\<time\>/\<outField\>
\endtable
Usage
......@@ -93,11 +93,11 @@ Usage
libs (fieldFunctionObjects);
// Mandatory entries (runtime modifiable)
mode <option>;
mode \<option\>;
// Optional entries (runtime modifiable)
p <pName>;
U <UName>;
p \<pName\>;
U \<UName\>;
rho <rhoName>;
rhoInf 1.0; // enabled if rho=rhoInf
pRef 0.0;
......
......@@ -37,18 +37,19 @@ Description
Usage
Minimal example by using \c constant/fvOptions:
<Type>FixedValueConstraint1
\verbatim
\<Type\>FixedValueConstraint1
{
// Mandatory entries (unmodifiable)
type <Type>FixedValueConstraint;
type \<Type\>FixedValueConstraint;
// Mandatory entries (runtime modifiable)
fieldValues
{
<fieldName1> <value1>;
<fieldName2> <value2>;
\<fieldName1\> \<value1\>;
\<fieldName2\> \<value2\>;
...
<fieldNameN> <valueN>;
\<fieldNameN\> \<valueN\>;
}
// Mandatory/Optional (inherited) entries
......
......@@ -42,12 +42,13 @@ Description
Usage
Minimal example by using \c constant/fvOptions:
<Type>PhaseLimitStabilization1
\verbatim
\<Type\>PhaseLimitStabilization1
{
// Mandatory entries (unmodifiable)
type <Type>PhaseLimitStabilization;
field <fieldName>;
rate <rateName>;
type \<Type\>PhaseLimitStabilization;
field \<fieldName\>;
rate \<rateName\>;
// Mandatory entries (runtime modifiable)
residualAlpha 1.0;
......
......@@ -53,7 +53,7 @@ Usage
type rotorDiskSource;
// Mandatory entries (runtime modifiable)
fields (<field1> <field2> ... <fieldN>);
fields (\<field1\> \<field2\> ... \<fieldN\>);
rhoRef 1.0;
rpm 5.5;
nBlades 3;
......
......@@ -125,7 +125,6 @@ public:
// Constructors
//- Construct from components (default format INLINE_BASE64)
// \param useNearCellValue to use cell instead of patch values
patchMeshWriter
(
const polyMesh& mesh,
......
......@@ -52,27 +52,27 @@ Description
}
\endverbatim
\heading Output file locations
\section Output file locations
The \c rootdir normally corresponds to something like
\c postProcessing/\<name\>
\subheading Geometry
\subsection Geometry
\verbatim
rootdir
`-- surfaceName0
`-- geometry
`-- surfaceName0_<time>.abq
`-- surfaceName0_\<time\>.abq
\endverbatim
\subheading Fields
\subsection Fields
\verbatim
rootdir
`-- surfaceName0
`-- field0
| `-- surfaceName0_<time>.{inp}
| `-- surfaceName0_\<time\>.{inp}
`-- field1
`-- surfaceName0_<time>.{inp}
`-- surfaceName0_\<time\>.{inp}
\endverbatim
Note
......
......@@ -54,12 +54,12 @@ Description
fieldScale | output field scaling (dictionary) | no | empty
\endtable
\heading Output file locations
\section Output file locations
The \c rootdir normally corresponds to something like
\c postProcessing/\<name\>
\subheading Geometry
\subsection Geometry
\verbatim
rootdir
`-- timeName
......@@ -69,7 +69,7 @@ Description
`-- "faces"
\endverbatim
\subheading Fields
\subsection Fields
\verbatim
rootdir
`-- timeName
......
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