setTimeStepFaRegionsFunctionObject Class Reference

This function object controls the time step for classes of the type regionFaModel. It reads regionFaMaxCo entry from controlDict and evaluate the time step based on the finite area Courant Number. More...

Inheritance diagram for setTimeStepFaRegionsFunctionObject:

Collaboration diagram for setTimeStepFaRegionsFunctionObject:

Public Member Functions
	TypeName ("setTimeStepFaRegion")
	setTimeStepFaRegionsFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
virtual	~setTimeStepFaRegionsFunctionObject ()=default
virtual bool	adjustTimeStep ()
virtual bool	read (const dictionary &dict)
virtual bool	execute ()
virtual bool	write ()
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
virtual	~timeFunctionObject ()=default
const Time &	time () const
objectRegistry &	storedObjects ()
const objectRegistry &	storedObjects () const
Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
autoPtr< functionObject >	clone () const
virtual	~functionObject ()=default
virtual const word &	type () const =0
const word &	name () const noexcept
bool	useNamePrefix () const noexcept
bool	useNamePrefix (bool on) noexcept
virtual bool	execute (const label subIndex)
virtual bool	end ()
virtual bool	filesModified () const
virtual void	updateMesh (const mapPolyMesh &mpm)
virtual void	movePoints (const polyMesh &mesh)

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
Public Attributes inherited from functionObject
bool	log
Static Public Attributes inherited from functionObject
static int	debug
static bool	postProcess
static bool	defaultUseNamePrefix
static word	outputPrefix
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	timeFunctionObject (const timeFunctionObject &)=delete
void	operator= (const timeFunctionObject &)=delete
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
Protected Attributes inherited from timeFunctionObject
const Time &	time_

Detailed Description

This function object controls the time step for classes of the type regionFaModel. It reads regionFaMaxCo entry from controlDict and evaluate the time step based on the finite area Courant Number.

Can only be used with solvers using adjustTimeStep control (e.g. pimpleFoam). It makes no attempt to co-operate with other time step 'controllers', e.g. maxCo, other functionObjects. Supports enabled flag but none of the other options timeStart, timeEnd, writeControl etc.

Usage

Example of function object specification to manipulate the time step:

setTimeStep1
{
    // Mandatory entries
    type        setTimeStepFaRegion;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
type	Type name: setTimeStepFaRegion	word	yes	-
enabled	On/off switch	bool	no	yes

The inherited entries are elaborated in:

• timeFunctionObject.H
• regionFaModel.H

Source files

• setTimeStepFaRegionsFunctionObject.H
• setTimeStepFaRegionsFunctionObject.C

Definition at line 104 of file setTimeStepFaRegionsFunctionObject.H.

Constructor & Destructor Documentation

setTimeStepFaRegionsFunctionObject()

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

Definition at line 47 of file setTimeStepFaRegionsFunctionObject.C.

References dict, and Foam::blockMeshTools::read().

Here is the call graph for this function:

~setTimeStepFaRegionsFunctionObject()

virtual ~setTimeStepFaRegionsFunctionObject ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"setTimeStepFaRegion"

)

adjustTimeStep()

bool adjustTimeStep ( )

virtual

Reimplemented from functionObject.

Definition at line 61 of file setTimeStepFaRegionsFunctionObject.C.

References TimeState::deltaTValue(), timeFunctionObject::time_, and TimeState::timeIndex().

Here is the call graph for this function:

read()

bool read ( const dictionary &  dict )

virtual

Reimplemented from functionObject.

Definition at line 85 of file setTimeStepFaRegionsFunctionObject.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::nl, and functionObject::read().

Here is the call graph for this function:

execute()

bool execute ( )

virtual

Implements functionObject.

Definition at line 144 of file setTimeStepFaRegionsFunctionObject.C.

write()

bool write ( )

virtual

Implements functionObject.

Definition at line 150 of file setTimeStepFaRegionsFunctionObject.C.

---

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

• src/regionFaModels/functionObjects/setTimeStep/setTimeStepFaRegionsFunctionObject.H
• src/regionFaModels/functionObjects/setTimeStep/setTimeStepFaRegionsFunctionObject.C