Writes the turbulent flame-speed and reaction-rate volScalarFields for the Xi-based combustion models. More...

Inheritance diagram for XiReactionRate:

Collaboration diagram for XiReactionRate:

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

	XiReactionRate (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	XiReactionRate (const XiReactionRate &)=delete
	Disallow default bitwise copy construction. More...

virtual	~XiReactionRate ()
	Destructor. More...

virtual wordList	fields () const
	Return the list of fields required. More...

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

virtual bool	write ()
	Write the cell-centre fields. More...

void	operator= (const XiReactionRate &)=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...

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

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () 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)
	Construct from components. More...

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

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () 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	timeToNextWrite ()
	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...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (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...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. 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 inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
const Time &	time_
	Reference to the Time. More...

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

Detailed Description

Writes the turbulent flame-speed and reaction-rate volScalarFields for the Xi-based combustion models.

Example of function object specification:

XiReactionRate
{
    type        XiReactionRate;
    libs        ("libfieldFunctionObjects.so");
    ...
}

Usage

Property	Description	Required	Default value
`type`	type name: XiReactionRate	yes

See also: Foam::functionObjects::fvMeshFunctionObject

Source files

Definition at line 80 of file XiReactionRate.H.

Constructor & Destructor Documentation

◆ XiReactionRate() [1/2]

XiReactionRate	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 46 of file XiReactionRate.C.

References Foam::read().

Here is the call graph for this function:

◆ XiReactionRate() [2/2]

XiReactionRate ( const XiReactionRate & )

delete

Disallow default bitwise copy construction.

◆ ~XiReactionRate()

~XiReactionRate ( )

virtual

Destructor.

Definition at line 60 of file XiReactionRate.C.

Member Function Documentation

◆ TypeName()

TypeName ( "XiReactionRate" )

Runtime type information.

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the list of fields required.

Implements functionObject.

Definition at line 66 of file XiReactionRate.C.

◆ execute()

bool execute ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 72 of file XiReactionRate.C.

◆ write()

bool write ( )

virtual

Write the cell-centre fields.

Implements functionObject.

Definition at line 78 of file XiReactionRate.C.

References Foam::constant::physicoChemical::b, Foam::endl(), Foam::fvc::grad(), Log, Foam::mag(), IOobject::name(), Su, Ostream::write(), and regIOobject::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const XiReactionRate & )

delete

Disallow default bitwise assignment.

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

src/functionObjects/field/XiReactionRate/XiReactionRate.H
src/functionObjects/field/XiReactionRate/XiReactionRate.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XiReactionRate() [1/2]

◆ XiReactionRate() [2/2]

◆ ~XiReactionRate()

Member Function Documentation

◆ TypeName()

◆ fields()

◆ execute()

◆ write()

◆ operator=()