zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

DOC: header documentation updates/corrections

Browse Source
This commit is contained in:
Andrew Heather
2020-12-22 12:10:07 +00:00
parent 77aa2e6026
commit 7a34f29002
28 changed files with 73 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/functionObjects/field/CourantNo/CourantNo.H
View File

@ -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

2
src/functionObjects/field/DESModelRegions/DESModelRegions.H
View File

@ -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:

2
src/functionObjects/field/LambVector/LambVector.H
View File

@ -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.

4
src/functionObjects/field/MachNo/MachNo.H
View File

@ -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

4
src/functionObjects/field/Q/Q.H
View File

@ -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

8
src/functionObjects/field/div/div.H
View File

@ -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

8
src/functionObjects/field/limitFields/limitFields.H
View File

@ -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.

10
src/functionObjects/field/pressure/pressure.H
View File

@ -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;