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: adjust documentation for scalarTransport FO

Browse Source
This commit is contained in:
Mark Olesen
2017-01-18 11:31:15 +01:00
parent 77a3022c43
commit fe0bb227ae
2 changed files with 15 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/functionObjects/solvers/scalarTransport/scalarTransport.C
View File

@ -201,7 +201,7 @@ Foam::functionObjects::scalarTransport::scalarTransport
resetOnStartUp_(false), resetOnStartUp_(false),
schemesField_("unknown-schemesField"), schemesField_("unknown-schemesField"),
fvOptions_(mesh_), fvOptions_(mesh_),
bounded01_(dict.lookupOrDefault<bool>("bounded01", true)) bounded01_(dict.lookupOrDefault<Switch>("bounded01", true))
{ {
read(dict); read(dict);
@ -235,12 +235,7 @@ bool Foam::functionObjects::scalarTransport::read(const dictionary& dict)
dict.readIfPresent("bounded01", bounded01_); dict.readIfPresent("bounded01", bounded01_);
schemesField_ = dict.lookupOrDefault("schemesField", fieldName_); schemesField_ = dict.lookupOrDefault("schemesField", fieldName_);
constantD_ = dict.readIfPresent("D", D_);
constantD_ = false;
if (dict.readIfPresent("D", D_))
{
constantD_ = true;
}
dict.readIfPresent("nCorr", nCorr_); dict.readIfPresent("nCorr", nCorr_);
dict.readIfPresent("resetOnStartUp", resetOnStartUp_); dict.readIfPresent("resetOnStartUp", resetOnStartUp_);
@ -256,10 +251,10 @@ bool Foam::functionObjects::scalarTransport::read(const dictionary& dict)
bool Foam::functionObjects::scalarTransport::execute() bool Foam::functionObjects::scalarTransport::execute()
{ {
Log << type() << " write:" << endl;
volScalarField& s = transportedField(); volScalarField& s = transportedField();
Log << type() << " execute: " << s.name() << endl;
const surfaceScalarField& phi = const surfaceScalarField& phi =
mesh_.lookupObject<surfaceScalarField>(phiName_); mesh_.lookupObject<surfaceScalarField>(phiName_);

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

@ -111,17 +111,18 @@ Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default value
type | Type name: scalarTransport | yes | type | Type name: scalarTransport | yes |
phi | Name of flux field | yes | field | Name of the scalar field | no | s
phi | Name of flux field | no | phi
rho | Name of density field | no | rho rho | Name of density field | no | rho
phase | Name of the phase name | no | none phase | Name of the phase | no | none
nut | Name of the turbulence viscosity | 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 | field name
fvOptions | List of scalar sources | no | fvOptions | List of scalar sources | no |
bounded01 | Bounds scalar between 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
See also See also
@ -156,10 +157,10 @@ class scalarTransport
{ {
// Private data // Private data
//- Name of field to process //- Name of the transport field.
word fieldName_; word fieldName_;
//- Name of flux field //- Name of flux field (optional)
word phiName_; word phiName_;
//- Name of density field (optional) //- Name of density field (optional)
@ -168,10 +169,10 @@ class scalarTransport
//- Name of turbulent viscosity field (optional) //- Name of turbulent viscosity field (optional)
word nutName_; word nutName_;
//- Name of phase field //- Name of phase field (optional)
word phaseName_; word phaseName_;
//- Name of phase field compressed flux //- Name of phase field compressed flux (optional)
word phasePhiCompressedName_; word phasePhiCompressedName_;
//- Diffusion coefficient (optional) //- Diffusion coefficient (optional)