This function object calculates mass-fraction fields from mole-fraction or moles fields present on disk. This is intended to be used for initialisation where mole-fractions are known. If any mass fraction fields are found (other than Ydefault) then an error will be generated and the fields will not be overwritten. The names of the mole-fraction fields are obtained from the corresponding mass-fraction fields prepended by "X_", and the moles fields are prepended by "n_". Either mole-fraction fields or moles fields should be present, not both. More...

Inheritance diagram for massFractions:

[legend]

Collaboration diagram for massFractions:

[legend]

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

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

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

virtual	~massFractions ()
	Destructor. More...

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

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

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

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

void	operator= (const massFractions &)=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, const Time &runTime)
	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	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...

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 objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Detailed Description

This function object calculates mass-fraction fields from mole-fraction or moles fields present on disk. This is intended to be used for initialisation where mole-fractions are known. If any mass fraction fields are found (other than Ydefault) then an error will be generated and the fields will not be overwritten. The names of the mole-fraction fields are obtained from the corresponding mass-fraction fields prepended by "X_", and the moles fields are prepended by "n_". Either mole-fraction fields or moles fields should be present, not both.

Example of function object specification:

massFractions
{
    type massFractions;
}

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

See also: Foam::functionObjects::fvMeshFunctionObject

Source files

Definition at line 71 of file massFractions.H.

Constructor & Destructor Documentation

◆ massFractions() [1/2]

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

Construct from Time and dictionary.

Definition at line 44 of file massFractions.C.

◆ massFractions() [2/2]

massFractions ( const massFractions & )

delete

Disallow default bitwise copy construction.

◆ ~massFractions()

~massFractions ( )

virtual

Destructor.

Definition at line 59 of file massFractions.C.

Member Function Documentation

◆ TypeName()

TypeName ( "massFractions" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the massFractions data.

Reimplemented from regionFunctionObject.

Definition at line 65 of file massFractions.C.

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 109 of file massFractions.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Calculate the mass-fraction fields.

Implements functionObject.

Definition at line 71 of file massFractions.C.

References autoPtr< T >::clear(), fileOperation::cp(), Foam::dimless, Foam::dimMass, Foam::dimMoles, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::fileHandler(), typeIOobject< Type >::filePath(), forAll, IOobject::groupName(), typeIOobject< Type >::headerOk(), GeometricField< Type, PatchField, GeoMesh >::max(), IOobject::MUST_READ, fileOperation::mv(), IOobject::name(), Foam::name(), fluidMulticomponentThermo::New(), IOobject::NO_WRITE, IOobject::path(), IOobject::READ_IF_PRESENT, PtrList< T >::set(), thermo, PtrList< T >::transfer(), Foam::W(), regIOobject::write(), and Y.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

The mass-fraction fields auto-write.

Implements functionObject.

Definition at line 237 of file massFractions.C.

References forAll.

◆ operator=()

void operator= ( const massFractions & )

delete

Disallow default bitwise assignment.

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

src/thermophysicalModels/multicomponentThermo/functionObjects/massFractions/massFractions.H
src/thermophysicalModels/multicomponentThermo/functionObjects/massFractions/massFractions.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ massFractions() [1/2]

◆ massFractions() [2/2]

◆ ~massFractions()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ operator=()