Returns the minimum bulk reaction time scale. More...

Inheritance diagram for adjustTimeStepToCombustion:

Collaboration diagram for adjustTimeStepToCombustion:

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

	adjustTimeStepToCombustion (const word &name, const Time &runTime, const dictionary &dict)
	Construct from components. More...

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

virtual	~adjustTimeStepToCombustion ()

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 combustion time-scale. More...

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

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. 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 Attributes inherited from objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the objectRegistry. More...

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

Detailed Description

Returns the minimum bulk reaction time scale.

This allows the solver to temporally resolve chemical changes, in order to better couple the chemistry and transport, or to improve the time-accuracy of post-processing.

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

Example of function object specification:

adjustTimeStepToCombustion
{
    type            adjustTimeStepToCombustion;
    libs            ("libcombustionModels.so");
    maxCo           0.1;
    extrapolate     no;
}

Usage

Property	Description	Required	Default value
`type`	type name: adjustTimeStepToCombustion	yes
`phase`	name of the reacting phase	no
`maxCo`	maximum combustion "Courant" number	no	1
`extrapolate`	try to extrapolate decreases	no	false

Source files

Definition at line 103 of file adjustTimeStepToCombustion.H.

Constructor & Destructor Documentation

◆ adjustTimeStepToCombustion() [1/2]

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

Construct from components.

Definition at line 72 of file adjustTimeStepToCombustion.C.

References dict, and adjustTimeStepToCombustion::read().

Here is the call graph for this function:

◆ adjustTimeStepToCombustion() [2/2]

adjustTimeStepToCombustion ( const adjustTimeStepToCombustion & )

delete

Disallow default bitwise copy construction.

◆ ~adjustTimeStepToCombustion()

~adjustTimeStepToCombustion ( )

virtual

Definition at line 92 of file adjustTimeStepToCombustion.C.

Member Function Documentation

◆ TypeName()

TypeName ( "adjustTimeStepToCombustion" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read and reset the timeStep Function1.

Reimplemented from objectRegistryFunctionObject.

Definition at line 98 of file adjustTimeStepToCombustion.C.

References dict, IOobject::MUST_READ_IF_MODIFIED, word::null, and propsDict().

Referenced by adjustTimeStepToCombustion::adjustTimeStepToCombustion().

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 166 of file adjustTimeStepToCombustion.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 128 of file adjustTimeStepToCombustion.C.

◆ write()

bool write ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 134 of file adjustTimeStepToCombustion.C.

References IOobject::NO_READ, and propsDict().

Here is the call graph for this function:

◆ maxDeltaT()

Foam::scalar maxDeltaT ( ) const

virtual

Return the minimum combustion time-scale.

Reimplemented from functionObject.

Definition at line 150 of file adjustTimeStepToCombustion.C.

References combustionModel::combustionPropertiesName, Foam::dimless, Foam::dimTime, f(), forAll, Foam::gMax(), IOobject::groupName(), Foam::mag(), Foam::max(), combustionModel::mesh(), Foam::min(), DimensionedField< Type, GeoMesh, PrimitiveField >::New(), combustionModel::R(), Foam::sqr(), Foam::sqrt(), thermo, combustionModel::thermo(), and x.

Here is the call graph for this function:

◆ operator=()

void operator= ( const adjustTimeStepToCombustion & )

delete

Disallow default bitwise assignment.

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

src/combustionModels/functionObjects/adjustTimeStepToCombustion/adjustTimeStepToCombustion.H
src/combustionModels/functionObjects/adjustTimeStepToCombustion/adjustTimeStepToCombustion.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ adjustTimeStepToCombustion() [1/2]

◆ adjustTimeStepToCombustion() [2/2]

◆ ~adjustTimeStepToCombustion()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ maxDeltaT()

◆ operator=()