turbulenceFields Class Reference

Stores turbulence fields on the mesh database for further manipulation. More...

Inheritance diagram for turbulenceFields:
Collaboration diagram for turbulenceFields:

Public Types

enum class  compressibleField {
  k , epsilon , omega , nut ,
  nuEff , kappaEff , R , devTau
}
 
enum class  incompressibleField {
  k , epsilon , omega , nut ,
  nuEff , R , devSigma
}
 

Public Member Functions

 TypeName ("turbulenceFields")
 Runtime type information. More...
 
 turbulenceFields (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 turbulenceFields (const turbulenceFields &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~turbulenceFields ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the controls. More...
 
virtual wordList fields () const
 Return the list of fields required. More...
 
virtual bool execute ()
 Calculate turbulence fields. More...
 
virtual bool write ()
 Write the turbulence fields. More...
 
void operator= (const turbulenceFields &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 Runtime type information. More...
 
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fvMeshFunctionObject ()
 Destructor. More...
 
void operator= (const fvMeshFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 Runtime type information. More...
 
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
 regionFunctionObject (const regionFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~regionFunctionObject ()
 Destructor. More...
 
void operator= (const regionFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from functionObject
 ClassName ("functionObject")
 
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name, const Time &runTime)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool executeAtStart () const
 Return true if the functionObject should be executed at the start. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual scalar timeToNextAction ()
 Called by Time::adjustTimeStep(). Allows the functionObject to. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update topology using the given map. More...
 
virtual void topoChange (const polyTopoChangeMap &map)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
void operator= (const functionObject &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Attributes

static const NamedEnum< compressibleField, 8 > compressibleFieldNames_
 
static const NamedEnum< incompressibleField, 7 > incompressibleFieldNames_
 
- Static Public Attributes inherited from functionObject
static bool postProcess
 Global post-processing mode switch. More...
 

Protected Member Functions

word modelName ()
 
template<class Type >
void processField (const word &fieldName, const tmp< VolField< Type >> &tvalue)
 Process the turbulence field. More...
 
- Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool foundObject (const word &fieldName) const
 Find field in the objectRegistry. More...
 
template<class ObjectType >
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 Lookup object from the objectRegistry. More...
 
template<class ObjectType >
ObjectType & lookupObjectRef (const word &fieldName)
 Lookup non-const object reference from the objectRegistry. More...
 
template<class ObjectType >
bool store (const tmp< ObjectType > &tfield)
 Store the given field in the objectRegistry. More...
 
template<class ObjectType >
bool store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 Store the given field in the objectRegistry under the given name. More...
 
bool writeObject (const word &fieldName)
 Write field if present in objectRegistry. More...
 
bool clearObject (const word &fieldName)
 Clear field from the objectRegistry if present. More...
 

Protected Attributes

wordHashSet fieldSet_
 Fields to load. More...
 
word prefix_
 Optional field prefix to avoid name clashes. More...
 
word phaseName_
 Optional phase name. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 
- Protected Attributes inherited from functionObject
const Timetime_
 Reference to time. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &, const dictionary &)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
Switch log
 Switch write log to Info. More...
 
Switch executeAtStart_
 Switch write log to Info. More...
 

Detailed Description

Stores turbulence fields on the mesh database for further manipulation.

Fields are stored as copies of the original, with the prefix "momentumTransportModel:", e.g.:

momentumTransportModel:R

Example of function object specification:

turbulenceFields1
{
    type        turbulenceFields;
    libs        ("libfieldFunctionObjects.so");
    ...
    fields
    (
        R
        devTau
    );
}
Usage
Property Description Required Default value
type Type name: processorField yes
fields Fields to store (see below) yes
prefix If true prefix fields no no
phase phase name no

Where fields can include:

k : turbulence kinetic energy
epsilon : turbulence kinetic energy dissipation rate
omega : turbulence specific dissipation rate
nut : turbulence viscosity (incompressible)
nuEff : effective turbulence viscosity (incompressible)
nut : turbulence viscosity (compressible)
nuEff : effective turbulence viscosity (compressible)
kappaEff : effective turbulence thermal diffusivity (compressible)
R : Reynolds stress tensor
devSigma : Deviatoric part of the effective Reynolds stress </td>
(incompressible) :
devTau : Divergence of the Reynolds stress (compressible)
See also
Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::timeControl
Source files

Definition at line 176 of file turbulenceFields.H.

Member Enumeration Documentation

◆ compressibleField

enum compressibleField
strong
Enumerator
epsilon 
omega 
nut 
nuEff 
kappaEff 
devTau 

Definition at line 182 of file turbulenceFields.H.

◆ incompressibleField

enum incompressibleField
strong
Enumerator
epsilon 
omega 
nut 
nuEff 
devSigma 

Definition at line 195 of file turbulenceFields.H.

Constructor & Destructor Documentation

◆ turbulenceFields() [1/2]

turbulenceFields ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from Time and dictionary.

Definition at line 96 of file turbulenceFields.C.

References dict, and turbulenceFields::read().

Here is the call graph for this function:

◆ turbulenceFields() [2/2]

turbulenceFields ( const turbulenceFields )
delete

Disallow default bitwise copy construction.

◆ ~turbulenceFields()

~turbulenceFields ( )
virtual

Destructor.

Definition at line 113 of file turbulenceFields.C.

Member Function Documentation

◆ modelName()

word modelName ( )
protected

◆ processField()

◆ TypeName()

TypeName ( "turbulenceFields"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the controls.

Reimplemented from regionFunctionObject.

Definition at line 119 of file turbulenceFields.C.

References dict, Foam::endl(), forAllConstIter, IOobject::groupName(), Foam::Info, Foam::name(), Foam::nl, word::null, and Foam::type().

Referenced by turbulenceFields::turbulenceFields().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ fields()

virtual wordList fields ( ) const
inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 266 of file turbulenceFields.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

◆ write()

bool write ( )
virtual

Write the turbulence fields.

Implements functionObject.

Definition at line 342 of file turbulenceFields.C.

References forAllConstIter, and IOobject::groupName().

Here is the call graph for this function:

◆ operator=()

void operator= ( const turbulenceFields )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ compressibleFieldNames_

Definition at line 193 of file turbulenceFields.H.

◆ incompressibleFieldNames_

Definition at line 205 of file turbulenceFields.H.

◆ fieldSet_

wordHashSet fieldSet_
protected

Fields to load.

Definition at line 213 of file turbulenceFields.H.

◆ prefix_

word prefix_
protected

Optional field prefix to avoid name clashes.

Defaults to null

Definition at line 217 of file turbulenceFields.H.

Referenced by turbulenceFields::processField().

◆ phaseName_

word phaseName_
protected

Optional phase name.

Definition at line 220 of file turbulenceFields.H.

Referenced by turbulenceFields::processField().


The documentation for this class was generated from the following files: