Minimum time step condition. More...

Inheritance diagram for minTimeStepCondition:

Collaboration diagram for minTimeStepCondition:

Public Member Functions
	TypeName ("minTimeStep")

	minTimeStepCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)

virtual	~minTimeStepCondition ()=default

virtual bool	apply ()

virtual void	write ()

Public Member Functions inherited from runTimeCondition
	TypeName ("runTimeCondition")

	declareRunTimeSelectionTable (autoPtr, runTimeCondition, dictionary,(const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state),(name, obr, dict, state))

	runTimeCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)

virtual	~runTimeCondition ()=default

virtual const word &	name () const

virtual bool	active () const

virtual label	groupID () const

Protected Attributes
scalar	minValue_

Protected Attributes inherited from runTimeCondition
word	name_

const objectRegistry &	obr_

stateFunctionObject &	state_

bool	active_

dictionary &	conditionDict_

label	groupID_

Additional Inherited Members
Static Public Member Functions inherited from runTimeCondition
static autoPtr< runTimeCondition >	New (const word &conditionName, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)

Public Attributes inherited from runTimeCondition
Switch	log

Protected Member Functions inherited from runTimeCondition
dictionary &	setConditionDict ()

const dictionary &	conditionDict () const

dictionary &	conditionDict ()

Detailed Description

Minimum time step condition.

Source files

Definition at line 52 of file minTimeStepCondition.H.

Constructor & Destructor Documentation

◆ minTimeStepCondition()

minTimeStepCondition	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		stateFunctionObject &	state
	)

Definition at line 50 of file minTimeStepCondition.C.

◆ ~minTimeStepCondition()

virtual ~minTimeStepCondition ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "minTimeStep" )

◆ apply()

bool apply ( )

virtual

Implements runTimeCondition.

Definition at line 66 of file minTimeStepCondition.C.

References runTimeCondition::active_, TimeState::deltaTValue(), minTimeStepCondition::minValue_, runTimeCondition::obr_, and objectRegistry::time().

Here is the call graph for this function:

◆ write()

void write ( )

virtual

Implements runTimeCondition.

Definition at line 84 of file minTimeStepCondition.C.

Member Data Documentation

◆ minValue_

scalar minValue_

protected

Definition at line 61 of file minTimeStepCondition.H.

Referenced by minTimeStepCondition::apply().

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

src/functionObjects/utilities/runTimeControl/runTimeCondition/minTimeStepCondition/minTimeStepCondition.H
src/functionObjects/utilities/runTimeControl/runTimeCondition/minTimeStepCondition/minTimeStepCondition.C

Public Member Functions

Protected Attributes

Additional Inherited Members