Updated docs for Doxygen: '<' -> '\<' and '>' -> '\>'
This commit is contained in:
@ -29,7 +29,7 @@ Description
|
||||
|
||||
Command-line option handling:
|
||||
- If -all specified or no refineMeshDict exists or, refine all cells
|
||||
- If -dict {file} specified refine according to {file}
|
||||
- If -dict \<file\> specified refine according to \<file\>
|
||||
- If refineMeshDict exists refine according to refineMeshDict
|
||||
|
||||
When the refinement or all cells is selected apply 3D refinement for 3D
|
||||
|
||||
@ -32,25 +32,25 @@ Description
|
||||
application. Values are transferred as plain text files, where OpenFOAM
|
||||
data is written as:
|
||||
|
||||
# Patch: <patch name>
|
||||
<magSf1> <value1> <qDot1> <htc1>
|
||||
<magSf2> <value2> <qDot2> <htc2>
|
||||
<magSf3> <value3> <qDot3> <htc2>
|
||||
# Patch: \<patch name\>
|
||||
\<magSf1\> \<value1\> \<qDot1\> \<htc1\>
|
||||
\<magSf2\> \<value2\> \<qDot2\> \<htc2\>
|
||||
\<magSf3\> \<value3\> \<qDot3\> \<htc2\>
|
||||
...
|
||||
<magSfN> <valueN> <qDotN> <htcN>
|
||||
\<magSfN\> \<valueN\> \<qDotN\> \<htcN\>
|
||||
|
||||
and received as the constituent pieces of the `mixed' condition, i.e.
|
||||
|
||||
# Patch: <patch name>
|
||||
<value1> <gradient1> <valueFracion1>
|
||||
<value2> <gradient2> <valueFracion2>
|
||||
<value3> <gradient3> <valueFracion3>
|
||||
# Patch: \<patch name\>
|
||||
\<value1\> \<gradient1\> \<valueFracion1\>
|
||||
\<value2\> \<gradient2\> \<valueFracion2\>
|
||||
\<value3\> \<gradient3\> \<valueFracion3\>
|
||||
...
|
||||
<valueN> <gradientN> <valueFracionN>
|
||||
\<valueN\> \<gradientN\> \<valueFracionN\>
|
||||
|
||||
Data is sent/received as a single file for all patches from the directory
|
||||
|
||||
$FOAM_CASE/<commsDir>
|
||||
$FOAM_CASE/\<commsDir\>
|
||||
|
||||
At start-up, the boundary creates a lock file, i.e..
|
||||
|
||||
@ -59,13 +59,13 @@ Description
|
||||
... to signal the external source to wait. During the boundary condition
|
||||
update, boundary values are written to file, e.g.
|
||||
|
||||
<fileName>.out
|
||||
\<fileName\>.out
|
||||
|
||||
The lock file is then removed, instructing the external source to take
|
||||
control of the program execution. When ready, the external program
|
||||
should create the return values, e.g. to file
|
||||
|
||||
<fileName>.in
|
||||
\<fileName\>.in
|
||||
|
||||
... and then re-instate the lock file. The boundary condition will then
|
||||
read the return values, and pass program execution back to OpenFOAM.
|
||||
|
||||
@ -32,25 +32,25 @@ Description
|
||||
Values are transferred as plain text files, where OpenFOAM data is written
|
||||
as:
|
||||
|
||||
# Patch: <patch name>
|
||||
<magSf1> <value1> <surfaceNormalGradient1>
|
||||
<magSf2> <value2> <surfaceNormalGradient2>
|
||||
<magSf3> <value3> <surfaceNormalGradient3>
|
||||
# Patch: \<patch name\>
|
||||
\<magSf1\> \<value1\> \<surfaceNormalGradient1\>
|
||||
\<magSf2\> \<value2\> \<surfaceNormalGradient2\>
|
||||
\<magSf3\> \<value3\> \<surfaceNormalGradient3\>
|
||||
...
|
||||
<magSfN> <valueN> <surfaceNormalGradientN>
|
||||
\<magSfN\> \<valueN\> \<surfaceNormalGradientN\>
|
||||
|
||||
and received as the constituent pieces of the `mixed' condition, i.e.
|
||||
|
||||
# Patch: <patch name>
|
||||
<value1> <gradient1> <valueFracion1>
|
||||
<value2> <gradient2> <valueFracion2>
|
||||
<value3> <gradient3> <valueFracion3>
|
||||
# Patch: \<patch name\>
|
||||
\<value1\> \<gradient1\> \<valueFracion1\>
|
||||
\<value2\> \<gradient2\> \<valueFracion2\>
|
||||
\<value3\> \<gradient3\> \<valueFracion3\>
|
||||
...
|
||||
<valueN> <gradientN> <valueFracionN>
|
||||
\<valueN\> \<gradientN\> \<valueFracionN\>
|
||||
|
||||
Data is sent/received as a single file for all patches from the directory
|
||||
|
||||
$FOAM_CASE/<commsDir>
|
||||
$FOAM_CASE/\<commsDir\>
|
||||
|
||||
At start-up, the boundary creates a lock file, i.e..
|
||||
|
||||
@ -59,13 +59,13 @@ Description
|
||||
... to signal the external source to wait. During the boundary condition
|
||||
update, boundary values are written to file, e.g.
|
||||
|
||||
<fileName>.out
|
||||
\<fileName\>.out
|
||||
|
||||
The lock file is then removed, instructing the external source to take
|
||||
control of the program execution. When ready, the external program
|
||||
should create the return values, e.g. to file
|
||||
|
||||
<fileName>.in
|
||||
\<fileName\>.in
|
||||
|
||||
... and then re-instate the lock file. The boundary condition will then
|
||||
read the return values, and pass program execution back to OpenFOAM.
|
||||
|
||||
@ -34,11 +34,11 @@ Description
|
||||
non-orthogonal contribution does not exceed the orthogonal part.
|
||||
|
||||
Format:
|
||||
limited <corrected scheme> <coefficient>;
|
||||
limited \<corrected scheme\> \<coefficient\>;
|
||||
|
||||
or
|
||||
|
||||
limited <coefficient>; // Backward compatibility
|
||||
limited \<coefficient\>; // Backward compatibility
|
||||
|
||||
SourceFiles
|
||||
limitedSnGrad.C
|
||||
|
||||
@ -39,7 +39,7 @@ Description
|
||||
- Parcel velocity is calculated as:
|
||||
|
||||
- Constant velocity
|
||||
U = <specified by user>
|
||||
U = \<specified by user\>
|
||||
- Pressure driven velocity
|
||||
U = sqrt(2*(Pinj - Pamb)/rho)
|
||||
- Flow rate and discharge
|
||||
|
||||
@ -114,8 +114,8 @@ License
|
||||
}
|
||||
|
||||
|
||||
Note: instead of gmap run gpart <nProcs> -vs <grfFile>
|
||||
where <grfFile> can be obtained by running with 'writeGraph=true'
|
||||
Note: instead of gmap run gpart \<nProcs\> -vs \<grfFile\>
|
||||
where \<grfFile\> can be obtained by running with 'writeGraph=true'
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user