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

STYLE: Updated header documentation

Browse Source
This commit is contained in:
Andrew Heather
2016-12-18 21:25:12 +00:00
parent db0d8de756
commit 23dfba2f64
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/functionObjects/solvers/scalarTransport/scalarTransport.H
View File

@ -49,7 +49,7 @@ Usage
scalar1 scalar1
{ {
type scalarTransport; type scalarTransport;
libs ("libutilityFunctionObjects.so"); libs ("libsolverFunctionObjects.so");
resetOnStartUp no; resetOnStartUp no;
region cabin; region cabin;
@ -64,7 +64,7 @@ Usage
} }
\endverbatim \endverbatim
Example of function object specification to solve a residency time Example of function object specification to solve a residence time
in a two phase flow: in a two phase flow:
equation: equation:
\verbatim \verbatim
@ -117,13 +117,13 @@ Usage
rho | Name of density field | no | rho rho | Name of density field | no | rho
UPhi | Name of U to generate phi | no | none UPhi | Name of U to generate phi | no | none
phase | Name of the phase name | no | none phase | Name of the phase name | no | none
nut | Name of the turbulence viscocity | no | none nut | Name of the turbulence viscosity | no | none
D | Diffusion coefficient | no | auto generated D | Diffusion coefficient | no | auto generated
nCorr | Number of correctors | no | 0 nCorr | Number of correctors | no | 0
resetOnStartUp | Reset scalar to zero on start-up | no | no resetOnStartUp | Reset scalar to zero on start-up | no | no
schemesField | Name of field to specify schemes | no | fieldName schemesField | Name of field to specify schemes | no | fieldName
fvOptions | List of scalar sources | no | fvOptions | List of scalar sources | no |
bounded01 | Bounds scalar betwee 0-1 for multiphase | no |true bounded01 | Bounds scalar between 0-1 for multiphase | no |true
phasePhiCompressed |Compressed flux for VOF | no | alphaPhiUn phasePhiCompressed |Compressed flux for VOF | no | alphaPhiUn
\endtable \endtable