Writes volume averaged reaction rates in [kg/m^3/s] for each specie and each reaction into the file <timeDir>/specieReactionRates.dat. More...

Inheritance diagram for specieReactionRates:

[legend]

Collaboration diagram for specieReactionRates:

[legend]

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

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

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

virtual	~specieReactionRates ()
	Destructor. More...

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

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

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

virtual bool	write ()
	Write the specie reaction rates. More...

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

virtual void	topoChange (const polyTopoChangeMap &)
	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 specieReactionRates &)=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)
	Construct from the region objectRegistry. More...

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

virtual	~fvMeshFunctionObject ()
	Destructor. More...

const fvMesh &	mesh () const
	Return a reference to the mesh. 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)
	Construct from the region objectRegistry. 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 objectRegistryFunctionObject
	TypeName ("objectRegistryFunctionObject")
	Runtime type information. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from an objectRegistry and dictionary. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

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

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

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

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. 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 scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

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

Public Member Functions inherited from logFiles
	logFiles (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

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

virtual	~logFiles ()
	Destructor. More...

const wordList &	toc () const
	Return the list of log file names. More...

const wordList &	names () const
	Return the list of log file names. More...

PtrList< OFstream > &	files ()
	Return access to the files. More...

OFstream &	file ()
	Return access to the file (if only 1) More...

OFstream &	file (const label i)
	Return file 'i'. More...

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

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

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

	~writeFile ()
	Destructor. More...

void	initStream (Ostream &os) const
	Initialise the output stream for writing. More...

fileName	baseFileDir () const
	Return the base directory for output. More...

fileName	baseTimeDir () const
	Return the base directory for the current time value. More...

Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset. More...

void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream. More...

void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream. More...

void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream. More...

void	writeTime (Ostream &os) const
	Write the current time to stream. More...

template<class Type >
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair. More...

label	charWidth () const
	Return width of character stream output. More...

void	operator= (const writeFile &)=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 execute at start time. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Static Public Attributes inherited from writeFile
static const word	outputPrefix
	Directory prefix. More...

static label	addChars = 8
	Additional characters for writing. More...

Protected Member Functions inherited from objectRegistryFunctionObject
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...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames 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 >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
ObjectType &	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 Member Functions inherited from logFiles
virtual void	createFiles ()
	Create the output file. More...

virtual void	resetNames (const wordList &names)
	Reset the list of names from a wordList. More...

virtual void	resetName (const word &name)
	Reset the list of names to a single name entry. More...

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

Protected Attributes inherited from objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the objectRegistry. More...

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

Protected Attributes inherited from logFiles
wordList	names_
	File names. More...

PtrList< OFstream >	filePtrs_
	File pointer. More...

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry. More...

const word	prefix_
	Prefix. More...

Detailed Description

Writes volume averaged reaction rates in [kg/m^3/s] for each specie and each reaction into the file <timeDir>/specieReactionRates.dat.

Example of function object specification:

specieReactionRates1
{
    type            specieReactionRates;
    libs            ("libchemistryModel.so");

    cellZone        all; // Or points, cellSet, cellZone

    //phase         <phaseName>; // Optional name of the phase

    //writeFields   false; // Optionally also write the rate fields. Note
                           // that this can create a lot of data.
}

See also: Foam::functionObjects::fvMeshFunctionObject Foam::fvCellZone Foam::functionObjects::logFiles

Source files

Definition at line 75 of file specieReactionRates.H.

Constructor & Destructor Documentation

◆ specieReactionRates() [1/2]

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

Construct from Time and dictionary.

Definition at line 79 of file specieReactionRates.C.

References dict, and specieReactionRates::read().

Here is the call graph for this function:

◆ specieReactionRates() [2/2]

specieReactionRates ( const specieReactionRates & )

delete

Disallow default bitwise copy construction.

◆ ~specieReactionRates()

~specieReactionRates ( )

virtual

Destructor.

Definition at line 105 of file specieReactionRates.C.

Member Function Documentation

◆ TypeName()

TypeName ( "specieReactionRates" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the specieReactionRates data.

Reimplemented from objectRegistryFunctionObject.

Definition at line 111 of file specieReactionRates.C.

References dict, and objectRegistryFunctionObject::read().

Referenced by specieReactionRates::specieReactionRates().

Here is the call graph for this function:

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 131 of file specieReactionRates.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 123 of file specieReactionRates.C.

◆ write()

bool write ( )

virtual

Write the specie reaction rates.

Reimplemented from logFiles.

Definition at line 129 of file specieReactionRates.C.

References Foam::fvc::domainIntegrate(), Foam::endl(), Foam::file, Foam::gSum(), UPstream::master(), fvMeshFunctionObject::mesh_, Foam::nl, nSpecie, Foam::constant::physicoChemical::RR, token::TAB, and logFiles::write().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update for mesh motion.

Reimplemented from functionObject.

Definition at line 204 of file specieReactionRates.C.

References mesh.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 216 of file specieReactionRates.C.

References polyTopoChangeMap::mesh(), and mesh.

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Reimplemented from functionObject.

Definition at line 228 of file specieReactionRates.C.

References polyMeshMap::mesh(), and mesh.

Here is the call graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Reimplemented from functionObject.

Definition at line 240 of file specieReactionRates.C.

References polyDistributionMap::mesh(), and mesh.

Here is the call graph for this function:

◆ operator=()

void operator= ( const specieReactionRates & )

delete

Disallow default bitwise assignment.

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

src/thermophysicalModels/chemistryModel/functionObjects/specieReactionRates/specieReactionRates.H
src/thermophysicalModels/chemistryModel/functionObjects/specieReactionRates/specieReactionRates.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ specieReactionRates() [1/2]

◆ specieReactionRates() [2/2]

◆ ~specieReactionRates()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ operator=()