Qdot Class Reference

Calculates and outputs the heat release rate for the current combustion model. More...

Inheritance diagram for Qdot:
Collaboration diagram for Qdot:

Public Member Functions

 TypeName ("Qdot")
 Runtime type information. More...
 
 Qdot (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
virtual ~Qdot ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the data. More...
 
virtual wordList fields () const
 Return the list of fields required. More...
 
virtual bool execute ()
 Calculate the Qdot field. More...
 
virtual bool write ()
 Do nothing. 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 wordtype () 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< functionObjectclone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () 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...
 
- Public Member Functions inherited from writeLocalObjects
 writeLocalObjects (const objectRegistry &obr, const Switch &logRef)
 Construct from objectRegistry and inheriting function object. More...
 
 writeLocalObjects (const writeLocalObjects &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~writeLocalObjects ()
 Destructor. More...
 
const wordListlocalObjectNames () const
 Return const access to the local object names. More...
 
void operator= (const writeLocalObjects &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from writeObjectsBase
 writeObjectsBase (const objectRegistry &obr, const Switch &logRef)
 Construct from objectRegistry and inheriting function object. More...
 
 writeObjectsBase (const writeObjectsBase &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~writeObjectsBase ()
 Destructor. More...
 
const wordReListwriteObjectNames () const
 Return const access to the object names requested to be written. More...
 
void operator= (const writeObjectsBase &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (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 Member Functions inherited from writeLocalObjects
void resetLocalObjectName (const word &name)
 Reset the list of local object names from a single word. More...
 
void resetLocalObjectNames (const wordList &names)
 Reset the list of local object names from a wordList. More...
 
virtual wordList objectNames ()
 Get the list of field names to be written. More...
 
- Protected Member Functions inherited from writeObjectsBase
void resetWriteObjectName (const wordRe &name)
 Reset the list of object names to be written to a single regular. More...
 
void resetWriteObjectNames (const wordReList &names)
 Reset the list of object names to be written. More...
 
virtual void writeObject (const regIOobject &obj)
 Write the requested registered IO object. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 
- Protected Attributes inherited from writeLocalObjects
wordList localObjectNames_
 Object names that are handled on behalf of the inheritor. More...
 
- Protected Attributes inherited from writeObjectsBase
const objectRegistrywriteObr_
 Reference to the region objectRegistry. More...
 
const Switchlog_
 Reference to the inheriting function object's log variable. More...
 
Switch regExp_
 Optional switch for regular expression support. More...
 
wordReList writeObjectNames_
 Object names requested by the user to be written. More...
 

Detailed Description

Calculates and outputs the heat release rate for the current combustion model.

Source files

Definition at line 52 of file Qdot.H.

Constructor & Destructor Documentation

◆ Qdot()

Qdot ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from Time and dictionary.

Definition at line 52 of file Qdot.C.

References IOobject::groupName(), Foam::read(), and Foam::type().

Here is the call graph for this function:

◆ ~Qdot()

~Qdot ( )
virtual

Destructor.

Definition at line 69 of file Qdot.C.

References Qdot::read().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "Qdot"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the data.

Reimplemented from writeLocalObjects.

Definition at line 76 of file Qdot.C.

References dictionary::lookupOrDefault(), word::null, writeLocalObjects::read(), and regionFunctionObject::read().

Referenced by Qdot::~Qdot().

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 92 of file Qdot.H.

References Qdot::execute(), List< T >::null(), and Qdot::write().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Calculate the Qdot field.

Implements functionObject.

Definition at line 89 of file Qdot.C.

References combustionModel::combustionPropertiesName, IOobject::groupName(), combustionModel::Qdot(), and Foam::type().

Referenced by Qdot::fields().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write()

bool write ( )
virtual

Do nothing.

Reimplemented from writeObjectsBase.

Definition at line 111 of file Qdot.C.

References writeObjectsBase::write().

Referenced by Qdot::fields().

Here is the call graph for this function:
Here is the caller graph for this function:

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