This function object stores turbulence fields on the mesh database for further manipulation. More...

Collaboration diagram for turbulenceFields:

[legend]

Public Types
enum	compressibleField { cfK, cfEpsilon, cfMut, cfMuEff, cfAlphat, cfAlphaEff, cfR, cfDevRhoReff }

enum	incompressibleField { ifK, ifEpsilon, ifNut, ifNuEff, ifR, ifDevReff }

Public Member Functions
	TypeName ("turbulenceFields")
	Runtime type information. More...

	turbulenceFields (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
	Construct for given objectRegistry and dictionary. More...

virtual	~turbulenceFields ()
	Destructor. More...

virtual const word &	name () const
	Return name of the turbulenceFields object. More...

virtual void	read (const dictionary &)
	Read the field min/max data. More...

virtual void	execute ()
	Execute, currently does nothing. More...

virtual void	end ()
	Execute at the final time-loop, currently does nothing. More...

virtual void	timeSet ()
	Called when time was set at the end of the Time::operator++. More...

virtual void	write ()
	Write. More...

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

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

Static Public Attributes
static const NamedEnum< compressibleField, 8 >	compressibleFieldNames_

static const NamedEnum< incompressibleField, 6 >	incompressibleFieldNames_

static const word	modelName = turbulenceModel::propertiesName

Protected Member Functions
	turbulenceFields (const turbulenceFields &)
	Disallow default bitwise copy construct. More...

void	operator= (const turbulenceFields &)
	Disallow default bitwise assignment. 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...

Protected Attributes
word	name_
	Name of this set of turbulenceFields object. More...

const objectRegistry &	obr_

bool	active_
	on/off switch More...

wordHashSet	fieldSet_
	Fields to load. More...

Switch	log_
	Switch to send output to Info as well as to file. More...

Detailed Description

This function object stores turbulence fields on the mesh database for further manipulation.

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

turbulenceModel:R

Example of function object specification:

turbulenceFields1
{
    type        turbulenceFields;
    functionObjectLibs ("libutilityFunctionObjects.so");
    ...
    fields
    (
        R
        devRhoReff
    );
}

Function object usage

Property	Description	Required	Default value
`type`	type name: turbulenceFields	yes
`fields`	fields to store (see below)	yes

Where fields can include:

k	:	turbulence kinetic energy
epsilon	:	turbulence kinetic energy dissipation rate
nut	:	turbulence viscosity (incompressible)
nuEff	:	effective turbulence viscosity (incompressible)
mut	:	turbulence viscosity (compressible)
muEff	:	effective turbulence 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

See also: Foam::functionObject Foam::OutputFilterFunctionObject

Source files

Definition at line 167 of file turbulenceFields.H.

Member Enumeration Documentation

◆ compressibleField

enum compressibleField

Enumerator
cfK
cfEpsilon
cfMut
cfMuEff
cfAlphat
cfAlphaEff
cfR
cfDevRhoReff

Definition at line 171 of file turbulenceFields.H.

◆ incompressibleField

enum incompressibleField

Enumerator
ifK
ifEpsilon
ifNut
ifNuEff
ifR
ifDevReff

Definition at line 184 of file turbulenceFields.H.

Constructor & Destructor Documentation

◆ turbulenceFields() [1/2]

turbulenceFields ( const turbulenceFields & )

protected

Disallow default bitwise copy construct.

◆ turbulenceFields() [2/2]

turbulenceFields	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const bool	loadFromFiles = `false`
	)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 95 of file turbulenceFields.C.

References dict, Foam::endl(), Foam::read(), and WarningInFunction.

Here is the call graph for this function:

◆ ~turbulenceFields()

~turbulenceFields ( )

virtual

Destructor.

Definition at line 125 of file turbulenceFields.C.

Member Function Documentation

◆ operator=()

void operator= ( const turbulenceFields & )

protected

Disallow default bitwise assignment.

◆ compressible()

bool compressible ( )

protected

Return true if compressible turbulence model is identified.

Definition at line 71 of file turbulenceFields.C.

References turbulenceFields::active_, objectRegistry::foundObject(), turbulenceFields::modelName, turbulenceFields::obr_, and WarningInFunction.

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 32 of file turbulenceFieldsTemplates.C.

References Foam::endl(), fld(), Foam::nl, and WarningInFunction.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "turbulenceFields" )

Runtime type information.

◆ name()

virtual const word& name ( ) const

inlinevirtual

Return name of the turbulenceFields object.

Definition at line 263 of file turbulenceFields.H.

References turbulenceFields::name_.

◆ read()

void read ( const dictionary & dict )

virtual

Read the field min/max data.

Definition at line 131 of file turbulenceFields.C.

References dict, Foam::endl(), forAllConstIter(), Foam::Info, dictionary::lookup(), Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ execute()

void execute ( )

virtual

Execute, currently does nothing.

Definition at line 160 of file turbulenceFields.C.

References Foam::abort(), ThermalDiffusivity< BasicTurbulenceModel >::alphaEff(), ThermalDiffusivity< BasicTurbulenceModel >::alphat(), compressible, IncompressibleTurbulenceModel< TransportModel >::devReff(), turbulenceModel::epsilon(), f(), Foam::FatalError, FatalErrorInFunction, forAllConstIter(), turbulenceModel::k(), turbulenceModel::nuEff(), turbulenceModel::nut(), and turbulenceModel::R().

Here is the call graph for this function:

◆ end()

void end ( )

virtual

Execute at the final time-loop, currently does nothing.

Definition at line 278 of file turbulenceFields.C.

◆ timeSet()

void timeSet ( )

virtual

Called when time was set at the end of the Time::operator++.

Definition at line 282 of file turbulenceFields.C.

◆ write()

void write ( )

virtual

Write.

Definition at line 286 of file turbulenceFields.C.

◆ updateMesh()

virtual void updateMesh ( const mapPolyMesh & )

inlinevirtual

Update for changes of mesh.

Definition at line 284 of file turbulenceFields.H.

◆ movePoints()

virtual void movePoints ( const polyMesh & )

inlinevirtual

Update for changes of mesh.

Definition at line 288 of file turbulenceFields.H.

Field Documentation

◆ compressibleFieldNames_

const NamedEnum< turbulenceFields::compressibleField, 8 > compressibleFieldNames_

static

Definition at line 182 of file turbulenceFields.H.

◆ incompressibleFieldNames_

const NamedEnum< turbulenceFields::incompressibleField, 6 > incompressibleFieldNames_

static

Definition at line 193 of file turbulenceFields.H.

◆ modelName

const word modelName = turbulenceModel::propertiesName

static

Definition at line 195 of file turbulenceFields.H.

Referenced by turbulenceFields::compressible().

◆ name_

word name_

protected

Name of this set of turbulenceFields object.

Definition at line 203 of file turbulenceFields.H.

Referenced by turbulenceFields::name().

◆ obr_

const objectRegistry& obr_

protected

Definition at line 205 of file turbulenceFields.H.

Referenced by turbulenceFields::compressible().

◆ active_

bool active_

protected

on/off switch

Definition at line 208 of file turbulenceFields.H.

Referenced by turbulenceFields::compressible().

◆ fieldSet_

wordHashSet fieldSet_

protected

Fields to load.

Definition at line 211 of file turbulenceFields.H.

◆ log_

Switch log_

protected

Switch to send output to Info as well as to file.

Definition at line 214 of file turbulenceFields.H.

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

src/postProcessing/functionObjects/utilities/turbulenceFields/turbulenceFields.H
src/postProcessing/functionObjects/utilities/turbulenceFields/turbulenceFields.C
src/postProcessing/functionObjects/utilities/turbulenceFields/turbulenceFieldsTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ compressibleField

◆ incompressibleField

Constructor & Destructor Documentation

◆ turbulenceFields() [1/2]

◆ turbulenceFields() [2/2]

◆ ~turbulenceFields()

Member Function Documentation

◆ operator=()

◆ compressible()

◆ processField()

◆ TypeName()

◆ name()

◆ read()

◆ execute()

◆ end()

◆ timeSet()

◆ write()

◆ updateMesh()

◆ movePoints()

Field Documentation

◆ compressibleFieldNames_

◆ incompressibleFieldNames_

◆ modelName

◆ name_

◆ obr_

◆ active_

◆ fieldSet_

◆ log_