adjustTimeStepToChemistry Class Reference

Returns the minimum chemistry chemical time scale. More...

Inheritance diagram for adjustTimeStepToChemistry:
Collaboration diagram for adjustTimeStepToChemistry:

Public Member Functions

 TypeName ("adjustTimeStepToChemistry")
 Runtime type information. More...
 
 adjustTimeStepToChemistry (const word &name, const Time &runTime, const dictionary &dict)
 Construct from components. More...
 
 adjustTimeStepToChemistry (const adjustTimeStepToChemistry &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~adjustTimeStepToChemistry ()
 
virtual bool read (const dictionary &)
 Read and reset the timeStep Function1. More...
 
virtual wordList fields () const
 Return the list of fields required. More...
 
virtual bool execute ()
 Do nothing. More...
 
virtual bool write ()
 Do nothing. More...
 
virtual scalar maxDeltaT () const
 Return the minimum chemistry.deltaTChem() More...
 
void operator= (const adjustTimeStepToChemistry &)=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, const Time &runTime)
 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 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< 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...
 
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 >
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 regionFunctionObject
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 
- Protected Attributes inherited from functionObject
const Timetime_
 Reference to time. More...
 

Detailed Description

Returns the minimum chemistry chemical time scale.

This allows the solver to temporally resolve chemical changes, in order to better couple the chemistry and transport, or in order to accurately post-process the chemical changes.

Note that this function only does anything if time step adjustment is enabled in the controlDict.

Example of function object specification:

adjustTimeStepToChemistry
{
    type            adjustTimeStepToChemistry;
    libs            ("libchemistryModel.so");
}
Usage
Property Description Required Default value
type type name: adjustTimeStepToChemistry yes
phase name of the reacting phase no
Source files

Definition at line 88 of file adjustTimeStepToChemistry.H.

Constructor & Destructor Documentation

◆ adjustTimeStepToChemistry() [1/2]

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

Construct from components.

Definition at line 51 of file adjustTimeStepToChemistry.C.

References dict, and adjustTimeStepToChemistry::read().

Here is the call graph for this function:

◆ adjustTimeStepToChemistry() [2/2]

Disallow default bitwise copy construction.

◆ ~adjustTimeStepToChemistry()

Definition at line 67 of file adjustTimeStepToChemistry.C.

Member Function Documentation

◆ TypeName()

TypeName ( "adjustTimeStepToChemistry"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read and reset the timeStep Function1.

Reimplemented from regionFunctionObject.

Definition at line 73 of file adjustTimeStepToChemistry.C.

References dict, and word::null.

Referenced by adjustTimeStepToChemistry::adjustTimeStepToChemistry().

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 128 of file adjustTimeStepToChemistry.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Do nothing.

Implements functionObject.

Definition at line 84 of file adjustTimeStepToChemistry.C.

◆ write()

bool write ( )
virtual

Do nothing.

Implements functionObject.

Definition at line 90 of file adjustTimeStepToChemistry.C.

◆ maxDeltaT()

Foam::scalar maxDeltaT ( ) const
virtual

Return the minimum chemistry.deltaTChem()

Reimplemented from functionObject.

Definition at line 96 of file adjustTimeStepToChemistry.C.

References chemistry, Foam::gMin(), and IOobject::groupName().

Here is the call graph for this function:

◆ operator=()

void operator= ( const adjustTimeStepToChemistry )
delete

Disallow default bitwise assignment.


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