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:

[legend]

Collaboration diagram for setTimeStepFaRegionsFunctionObject:

[legend]

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

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

virtual	~setTimeStepFaRegionsFunctionObject ()=default

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	read (const dictionary &dict)
	Read and set the function object if its data have changed. More...

virtual bool	execute ()
	Execute does nothing. More...

virtual bool	write ()
	Write does nothing. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

virtual	~timeFunctionObject ()=default
	Destructor. More...

const Time &	time () const
	Return time database. More...

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)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

virtual	~functionObject ()=default
	Destructor. More...

virtual const word &	type () const =0
	Runtime type information. More...

const word &	name () const noexcept
	Return the name of this functionObject. More...

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	read (const dictionary &dict)
	Read and set the function object if its data have changed. More...

virtual bool	execute ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

virtual bool	write ()=0
	Called at each ++ or += of the time-loop. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

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

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

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:

Source files

Definition at line 108 of file setTimeStepFaRegionsFunctionObject.H.

Constructor & Destructor Documentation

◆ setTimeStepFaRegionsFunctionObject()

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

Construct from components.

Definition at line 51 of file setTimeStepFaRegionsFunctionObject.C.

References dict, Foam::name(), and setTimeStepFaRegionsFunctionObject::read().

Here is the call graph for this function:

◆ ~setTimeStepFaRegionsFunctionObject()

virtual ~setTimeStepFaRegionsFunctionObject ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "setTimeStepFaRegion" )

Runtime type information.

◆ adjustTimeStep()

bool adjustTimeStep ( )

virtual

Called at the end of Time::adjustDeltaT() if adjustTime is true.

Reimplemented from functionObject.

Definition at line 68 of file setTimeStepFaRegionsFunctionObject.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read and set the function object if its data have changed.

Reimplemented from functionObject.

Definition at line 91 of file setTimeStepFaRegionsFunctionObject.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::nl, and kEpsilonLopesdaCosta< BasicTurbulenceModel >::read().

Referenced by setTimeStepFaRegionsFunctionObject::setTimeStepFaRegionsFunctionObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

bool execute ( )

virtual

Execute does nothing.

Implements functionObject.

Definition at line 151 of file setTimeStepFaRegionsFunctionObject.C.

◆ write()

bool write ( )

virtual

Write does nothing.

Implements functionObject.

Definition at line 157 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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ setTimeStepFaRegionsFunctionObject()

◆ ~setTimeStepFaRegionsFunctionObject()

Member Function Documentation

◆ TypeName()

◆ adjustTimeStep()

◆ read()

◆ execute()

◆ write()