Skip to content
Snippets Groups Projects
Commit c779674c authored by Kutalmış Berçin's avatar Kutalmış Berçin
Browse files

DOC: turbulenceFields: improve header documentation

parent f82a3eb1
No related merge requests found
......@@ -59,6 +59,12 @@ Description
Bathymetry induced turbulence modelling the
Alderney Race site: regional approach with TELEMAC-LES.
Normandie Université.
Estimation expressions for L (tag:P), Eq. 10.37:
Pope, S. B. (2000).
Turbulent flows.
Cambridge, UK: Cambridge Univ. Press
DOI:10.1017/CBO9780511840531
\endverbatim
Usage
......@@ -71,22 +77,26 @@ Usage
libs (fieldFunctionObjects);
// Mandatory entries (runtime modifiable)
// Either field or fields entries
fields (R devRhoReff);
field R;
// Optional (inherited) entries
// Either of the below
// Option-1
fields (R devRhoReff);
// Option-2
field R;
// Inherited entries
...
}
\endverbatim
where the entries mean:
\table
Property | Description | Type | Req'd | Dflt
type | Type name: turbulenceFields | word | yes | -
libs | Library name: fieldFunctionObjects | word | yes | -
Property | Description | Type | Reqd | Deflt
type | Type name: turbulenceFields | word | yes | -
libs | Library name: fieldFunctionObjects | word | yes | -
fields | Names of fields to store (see below) | wordList | yes | -
field | Name of a field to store (see below) | word | yes | -
field | Name of a field to store (see below) | word | yes | -
\endtable
where \c fields can include:
......@@ -116,10 +126,13 @@ Usage
<solver> -postProcess -func turbulenceFields
\endverbatim
Note
- Multiphase applications are not supported.
See also
- Foam::functionObject
- Foam::functionObjects::fvMeshFunctionObject
- ExtendedCodeGuide::functionObjects::field::turbulenceFields
- Foam::functionObject
- Foam::functionObjects::fvMeshFunctionObject
- ExtendedCodeGuide::functionObjects::field::turbulenceFields
SourceFiles
turbulenceFields.C
......@@ -162,8 +175,8 @@ public:
cfEpsilon, //!< "Turbulent kinetic energy dissipation rate"
cfOmega, //!< "Specific dissipation rate"
cfNuTilda, //!< "Modified turbulent viscosity"
cfMut, //!< "Turbulent viscosity"
cfMuEff, //!< "Effective turbulent viscosity"
cfMut, //!< "Turbulent dynamic viscosity"
cfMuEff, //!< "Effective turbulent dynamic viscosity"
cfAlphat, //!< "Turbulence thermal diffusivity"
cfAlphaEff, //!< "Effective turbulence thermal diffusivity"
cfR, //!< "Reynolds stress tensor"
......@@ -193,7 +206,7 @@ public:
//- Names for incompressibleField turbulence fields
static const Enum<incompressibleField> incompressibleFieldNames_;
//- Turbulence closure model name
//- Name of the turbulence properties dictionary
static const word modelName_;
......
......@@ -103,7 +103,7 @@ Foam::functionObjects::turbulenceFields::L
const Model& model
) const
{
// Assume k and epsilon are available
// (P:Eq. 10.37)
const scalar Cmu = 0.09;
const dimensionedScalar eps0(sqr(dimVelocity)/dimTime, SMALL);
......
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