Computes various turbulence-related quantities that are not typically output during calculations, and stores/writes them on the mesh database for further manipulation. More...

Inheritance diagram for turbulenceFields:

[legend]

Collaboration diagram for turbulenceFields:

[legend]

Public Types
enum	compressibleField { cfK , cfEpsilon , cfOmega , cfNuTilda , cfMut , cfMuEff , cfAlphat , cfAlphaEff , cfR , cfDevRhoReff , cfL , cfI }
	Options for the turbulence fields (compressible) More...

enum	incompressibleField { ifK , ifEpsilon , ifOmega , ifNuTilda , ifNut , ifNuEff , ifR , ifDevReff , ifL , ifI }
	Options for the turbulence fields (incompressible) More...

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
	No copy construct. More...

void	operator= (const turbulenceFields &)=delete
	No copy assignment. More...

virtual	~turbulenceFields ()=default
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the controls. More...

virtual bool	execute ()
	Calculate turbulence fields. More...

virtual bool	write ()
	Do nothing. More...

template<class Model >
Foam::tmp< Foam::volScalarField >	nuTilda (const Model &model) const

template<class Model >
Foam::tmp< Foam::volScalarField >	L (const Model &model) const

template<class Model >
Foam::tmp< Foam::volScalarField >	I (const Model &model) const

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...

virtual	~fvMeshFunctionObject ()=default
	Destructor. 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...

virtual	~regionFunctionObject ()=default
	Destructor. More...

virtual bool	read (const dictionary &dict)
	Read optional controls. More...

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

virtual	~stateFunctionObject ()=default
	Destructor. More...

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri)
	Set new trigger index. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

virtual	~timeFunctionObject ()=default
	Destructor. More...

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

virtual	~functionObject ()=default
	Destructor. More...

virtual const word &	type () const =0
	Runtime type information. More...

const word &	name () const noexcept
	Return the name of this functionObject. More...

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	read (const dictionary &dict)
	Read and set the function object if its data have changed. More...

virtual bool	execute ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

virtual bool	write ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

Static Public Attributes
static const Enum< compressibleField >	compressibleFieldNames_
	Names for compressibleField turbulence fields. More...

static const Enum< incompressibleField >	incompressibleFieldNames_
	Names for incompressibleField turbulence fields. More...

static const word	modelName_
	Name of the turbulence properties dictionary. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Protected Member Functions
void	initialise ()
	Unset duplicate fields already registered by other function objects. More...

bool	compressible ()
	Return true if compressible turbulence model is identified. More...

template<class Type >
void	processField (const word &fieldName, const tmp< GeometricField< Type, fvPatchField, volMesh > > &tvalue)
	Process the turbulence field. More...

template<class Model >
tmp< volScalarField >	nuTilda (const Model &model) const
	Return nuTilda calculated from k and omega. More...

template<class Model >
tmp< volScalarField >	L (const Model &model) const
	Return integral length scale, L, calculated from k and epsilon. More...

template<class Model >
tmp< volScalarField >	I (const Model &model) const
	Return turbulence intensity, I, calculated from k and U. More...

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct. More...

void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the field in the (sub) objectRegistry under the given name. More...

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present. More...

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

void	operator= (const regionFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Attributes
bool	initialised_
	Flag to track initialisation. More...

word	prefix_
	Name of output-field prefix. More...

wordHashSet	fieldSet_
	Fields to load. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Detailed Description

Computes various turbulence-related quantities that are not typically output during calculations, and stores/writes them on the mesh database for further manipulation.

Fields are stored as copies of the original with a user-defined prefix e.g. a prefix of turbulenceModel yields the following for field R:

  turbulenceModel:R

Operands:

Operand	Type	Location
`input`	-	-
`output` file	-	-
`output` field	vol<Type>Field	$FOAM_CASE/<time>/<outField>

where <Type>=Scalar/SymmTensor.

References:

        Estimation expressions for L (tag:P), Eq. 10.37:
            Pope, S. B. (2000).
            Turbulent flows.
            Cambridge, UK: Cambridge Univ. Press
            DOI:10.1017/CBO9780511840531

Usage

Minimal example by using system/controlDict.functions:

turbulenceFields1
{
    // Mandatory entries (unmodifiable)
    type        turbulenceFields;
    libs        (fieldFunctionObjects);

    // Mandatory entries (runtime modifiable)

        // Either of the below
        // Option-1
        fields      (R devRhoReff);

        // Option-2
        field       R;

    // Optional entries (runtime modifiable)
    prefix          <word>;

    // Inherited entries
    ...
}

where the entries mean:

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	-
`prefix`	Name of output-field prefix	word	no	turbulenceProperties

where fields can include:

      k           | turbulent kinetic energy
      epsilon     | turbulent kinetic energy dissipation rate
      omega       | specific dissipation rate
      nuTilda     | modified turbulent viscosity
      nut         | turbulent viscosity (incompressible)
      nuEff       | effective turbulent viscosity (incompressible)
      mut         | turbulent viscosity (compressible)
      muEff       | effective turbulent viscosity (compressible)
      alphat      | turbulence thermal diffusivity (compressible)
      alphaEff    | effective turbulence thermal diffusivity (compressible)
      R           | Reynolds stress tensor
      devReff     | deviatoric part of the effective Reynolds stress
      devRhoReff  | divergence of the Reynolds stress
      L           | integral-length scale / mixing-length scale
      I           | turbulence intensity

The inherited entries are elaborated in:

functionObject.H

Minimal example by using the postProcess utility:

        <solver> -postProcess -func turbulenceFields

Note

Multiphase applications are not supported.
The governing expression of nuTilda is an approximation based on a dimensional analysis.

See also

Foam::functionObject
Foam::functionObjects::fvMeshFunctionObject
ExtendedCodeGuide::functionObjects::field::turbulenceFields

Source files

Definition at line 214 of file turbulenceFields.H.

Member Enumeration Documentation

◆ compressibleField

enum compressibleField

Options for the turbulence fields (compressible)

Enumerator
cfK	"Turbulent kinetic energy"
cfEpsilon	"Turbulent kinetic energy dissipation rate"
cfOmega	"Specific dissipation rate"
cfNuTilda	"Modified turbulent viscosity"
cfMut	"Turbulent dynamic viscosity"
cfMuEff	"Effective turbulent dynamic viscosity"
cfAlphat	"Turbulence thermal diffusivity"
cfAlphaEff	"Effective turbulence thermal diffusivity"
cfR	"Reynolds stress tensor"
cfDevRhoReff	"Divergence of the Reynolds stress"
cfL	"Integral-length/Mixing-length scale"
cfI	"Turbulence intensity"

Definition at line 223 of file turbulenceFields.H.

◆ incompressibleField

enum incompressibleField

Options for the turbulence fields (incompressible)

Enumerator
ifK	"Turbulent kinetic energy"
ifEpsilon	"Turbulent kinetic energy dissipation rate"
ifOmega	"Specific dissipation rate"
ifNuTilda	"Modified turbulent viscosity"
ifNut	"Turbulent viscosity"
ifNuEff	"Effective turbulent viscosity"
ifR	"Reynolds stress tensor"
ifDevReff	"Deviatoric part of the effective Reynolds stress"
ifL	"Integral-length/Mixing-length scale"
ifI	"Turbulence intensity"

Definition at line 243 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 135 of file turbulenceFields.C.

References dict, and turbulenceFields::read().

Here is the call graph for this function:

◆ turbulenceFields() [2/2]

turbulenceFields ( const turbulenceFields & )

delete

No copy construct.

◆ ~turbulenceFields()

virtual ~turbulenceFields ( )

virtualdefault

Destructor.

Member Function Documentation

◆ initialise()

void initialise ( )

protected

Unset duplicate fields already registered by other function objects.

Definition at line 93 of file turbulenceFields.C.

References Foam::endl(), f(), turbulenceFields::fieldSet_, objectRegistry::found(), turbulenceFields::initialised_, Foam::nl, regionFunctionObject::obr_, turbulenceFields::prefix_, IOobject::scopedName(), HashSet< Key, Hash >::unset(), and WarningInFunction.

Here is the call graph for this function:

◆ compressible()

bool compressible ( )

protected

Return true if compressible turbulence model is identified.

Definition at line 114 of file turbulenceFields.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ processField()

void processField	(	const word &	fieldName,
		const tmp< GeometricField< Type, fvPatchField, volMesh > > &	tvalue
	)

protected

Process the turbulence field.

Definition at line 34 of file turbulenceFieldsTemplates.C.

References objectRegistry::getObjectPtr(), IOobject::NO_WRITE, regionFunctionObject::obr_, turbulenceFields::prefix_, IOobject::READ_IF_PRESENT, IOobject::scopedName(), regIOobject::store(), objectRegistry::time(), and Time::timeName().

Here is the call graph for this function:

◆ nuTilda() [1/2]

tmp< volScalarField > nuTilda ( const Model & model ) const

protected

Return nuTilda calculated from k and omega.

◆ L() [1/2]

tmp< volScalarField > L ( const Model & model ) const

protected

Return integral length scale, L, calculated from k and epsilon.

◆ I() [1/2]

tmp< volScalarField > I ( const Model & model ) const

protected

Return turbulence intensity, I, calculated from k and U.

◆ TypeName()

TypeName ( "turbulenceFields" )

Runtime type information.

◆ operator=()

void operator= ( const turbulenceFields & )

delete

No copy assignment.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the controls.

Reimplemented from regionFunctionObject.

Definition at line 153 of file turbulenceFields.C.

References dict, Foam::endl(), f(), Foam::Info, Foam::name(), Foam::nl, kEpsilonLopesdaCosta< BasicTurbulenceModel >::read(), IOobject::scopedName(), and Foam::type().

Referenced by turbulenceFields::turbulenceFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

bool execute ( )

virtual

Calculate turbulence fields.

Implements functionObject.

Definition at line 192 of file turbulenceFields.C.

References compressible, f(), Foam::FatalError, FatalErrorInFunction, Foam::I, and L.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Do nothing.

The turbulence fields are registered and written automatically

Implements functionObject.

Definition at line 350 of file turbulenceFields.C.

References Foam::endl(), f(), Foam::Info, and IOobject::scopedName().

Here is the call graph for this function:

◆ nuTilda() [2/2]

Foam::tmp< Foam::volScalarField > nuTilda ( const Model & model ) const

Definition at line 73 of file turbulenceFieldsTemplates.C.

References Foam::dimless, Foam::dimTime, and Time::New().

Here is the call graph for this function:

◆ L() [2/2]

Foam::tmp< Foam::volScalarField > L ( const Model & model ) const

Definition at line 90 of file turbulenceFieldsTemplates.C.

References Foam::dimTime, Foam::dimVelocity, Time::New(), and Foam::sqr().

Here is the call graph for this function:

◆ I() [2/2]

Foam::tmp< Foam::volScalarField > I ( const Model & model ) const

Definition at line 109 of file turbulenceFieldsTemplates.C.

References Foam::dimVelocity, Foam::max(), Time::New(), and Foam::sqrt().

Here is the call graph for this function:

Member Data Documentation

◆ compressibleFieldNames_

const Foam::Enum< Foam::functionObjects::turbulenceFields::compressibleField > compressibleFieldNames_

static

Names for compressibleField turbulence fields.

Definition at line 240 of file turbulenceFields.H.

◆ incompressibleFieldNames_

const Foam::Enum< Foam::functionObjects::turbulenceFields::incompressibleField > incompressibleFieldNames_

static

Names for incompressibleField turbulence fields.

Definition at line 258 of file turbulenceFields.H.

◆ modelName_

const Foam::word modelName_

static

Name of the turbulence properties dictionary.

Definition at line 261 of file turbulenceFields.H.

◆ initialised_

bool initialised_

protected

Flag to track initialisation.

Definition at line 269 of file turbulenceFields.H.

Referenced by turbulenceFields::initialise().

◆ prefix_

word prefix_

protected

Name of output-field prefix.

Definition at line 272 of file turbulenceFields.H.

Referenced by turbulenceFields::initialise(), and turbulenceFields::processField().

◆ fieldSet_

wordHashSet fieldSet_

protected

Fields to load.

Definition at line 275 of file turbulenceFields.H.

Referenced by turbulenceFields::initialise().

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

src/functionObjects/field/turbulenceFields/turbulenceFields.H
src/functionObjects/field/turbulenceFields/turbulenceFields.C
src/functionObjects/field/turbulenceFields/turbulenceFieldsTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ compressibleField

◆ incompressibleField

Constructor & Destructor Documentation

◆ turbulenceFields() [1/2]

◆ turbulenceFields() [2/2]

◆ ~turbulenceFields()

Member Function Documentation

◆ initialise()

◆ compressible()

◆ processField()

◆ nuTilda() [1/2]

◆ L() [1/2]

◆ I() [1/2]

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()

◆ nuTilda() [2/2]

◆ L() [2/2]

◆ I() [2/2]

Member Data Documentation

◆ compressibleFieldNames_

◆ incompressibleFieldNames_

◆ modelName_

◆ initialised_

◆ prefix_

◆ fieldSet_