This function object calculates mole-fraction fields from the mass-fraction fields of the psi/rhoReactionThermo and caches them for output and further post-processing. More...

Inheritance diagram for moleFractions< ThermoType >:

[legend]

Collaboration diagram for moleFractions< ThermoType >:

[legend]

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

	moleFractions (const word &name, const Time &t, const dictionary &dict)
	Construct from Time and dictionary. More...

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

virtual	~moleFractions ()
	Destructor. More...

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

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

virtual bool	execute ()
	Calculate the mole-fraction fields. More...

virtual bool	write ()
	The mole-fraction fields auto-write. More...

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

template<class ThermoType>
class Foam::moleFractions< ThermoType >

This function object calculates mole-fraction fields from the mass-fraction fields of the psi/rhoReactionThermo and caches them for output and further post-processing.

The names of the mole-fraction fields are obtained from the corresponding mass-fraction fields prepended by "X_"

Example of function object specification:

moleFractions
{
    type psiReactionThermoMoleFractions;
}

or

moleFractions
{
    type rhoReactionThermoMoleFractions;
}

depending on the thermodynamics package used in the solver.

Optionally, the name of the phase can be specified for multiphase cases.

See also: Foam::functionObjects::fvMeshFunctionObject

Source files

Definition at line 76 of file moleFractions.H.

Constructor & Destructor Documentation

◆ moleFractions() [1/2]

moleFractions	(	const word &	name,
		const Time &	t,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 62 of file moleFractions.C.

References dictName(), Foam::dimless, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::name(), and PtrList< T >::setSize().

Here is the call graph for this function:

◆ moleFractions() [2/2]

moleFractions ( const moleFractions< ThermoType > & )

delete

Disallow default bitwise copy construction.

◆ ~moleFractions()

~moleFractions ( )

virtual

Destructor.

Definition at line 130 of file moleFractions.C.

References moleFractions< ThermoType >::read().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "moleFractions< ThermoType >" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the moleFractions data.

Reimplemented from regionFunctionObject.

Definition at line 138 of file moleFractions.C.

Referenced by moleFractions< ThermoType >::~moleFractions().

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 125 of file moleFractions.H.

References moleFractions< ThermoType >::execute(), List< T >::null(), moleFractions< ThermoType >::operator=(), and moleFractions< ThermoType >::write().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Calculate the mole-fraction fields.

Implements functionObject.

Definition at line 147 of file moleFractions.C.

Referenced by moleFractions< ThermoType >::fields().

Here is the caller graph for this function:

◆ write()

bool write ( )

virtual

The mole-fraction fields auto-write.

Implements functionObject.

Definition at line 155 of file moleFractions.C.

References forAll.

Referenced by moleFractions< ThermoType >::fields().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const moleFractions< ThermoType > & )

delete

Disallow default bitwise assignment.

Referenced by moleFractions< ThermoType >::fields().

Here is the caller graph for this function:

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

src/thermophysicalModels/reactionThermo/functionObjects/moleFractions/moleFractions.H
src/thermophysicalModels/reactionThermo/functionObjects/moleFractions/moleFractions.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class ThermoType> class Foam::moleFractions< ThermoType >

Constructor & Destructor Documentation

◆ moleFractions() [1/2]

◆ moleFractions() [2/2]

◆ ~moleFractions()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ operator=()

template<class ThermoType>
class Foam::moleFractions< ThermoType >