This function object overrides the calculation time step. More...

#include <setTimeStepFunctionObject.H>

Inheritance diagram for setTimeStepFunctionObject:

Collaboration diagram for setTimeStepFunctionObject:

Public Member Functions
	TypeName ("setTimeStep")
	Runtime type information.
	setTimeStepFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from components.
virtual	~setTimeStepFunctionObject ()=default
virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool	read (const dictionary &dict)
	Read the function-object dictionary.
virtual bool	execute ()
	Execute the function-object operations (no-op).
virtual bool	write ()
	Write the function-object results (no-op).
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time.
virtual	~timeFunctionObject ()=default
	Destructor.
const Time &	time () const
	Return time database.
objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time.
const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time.
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.
autoPtr< functionObject >	clone () const
	Return clone.
virtual	~functionObject ()=default
	Destructor.
virtual const word &	type () const =0
	Runtime type information.
const word &	name () const noexcept
	Return the name of this functionObject.
bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix.
bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix.
virtual bool	execute (const label subIndex)
	Execute using the specified subIndex.
virtual bool	end ()
	Called when Time::run() determines that the time-loop exits.
virtual bool	filesModified () const
	Did any file get changed during execution?
virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh.

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.
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info.
Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content.
static bool	postProcess
	Global post-processing mode switch.
static bool	defaultUseNamePrefix
	Global default for useNamePrefix.
static word	outputPrefix
	Directory prefix.
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects".
	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct.
void	operator= (const timeFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name.
Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database.

Detailed Description

This function object overrides the calculation time step.

Can only be used with solvers with 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

Minimal example by using system/controlDict.functions:

setTimeStepFO
{
    // Mandatory entries
    type        setTimeStep;
    libs        (utilityFunctionObjects);

    deltaT      <Function1<scalar>>;  // table ((0 5e-4)(0.01 1e-3));

    // Inherited entries
    ...
}

where the entries mean: