minTimeStepCondition Class Reference

Minimum time step condition. More...

#include <minTimeStepCondition.H>

Inheritance diagram for minTimeStepCondition:

Collaboration diagram for minTimeStepCondition:

Public Member Functions
	TypeName ("minTimeStep")
	Runtime type information.
	minTimeStepCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
	Constructor.
virtual	~minTimeStepCondition ()=default
	Destructor.
virtual bool	apply ()
	Apply the condition.
virtual void	write ()
	Write.
virtual void	reset ()
	Reset.
Public Member Functions inherited from runTimeCondition
	TypeName ("runTimeCondition")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, runTimeCondition, dictionary,(const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state),(name, obr, dict, state))
	Declare runtime constructor selection table.
	runTimeCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
	Constructor.
virtual	~runTimeCondition ()=default
	Destructor.
virtual const word &	name () const
	Return the condition name.
virtual bool	active () const
	Return the active flag.
virtual label	groupID () const
	Return the group index.

Protected Attributes
scalar	minValue_
	Minimum time step value to compare.
Protected Attributes inherited from runTimeCondition
word	name_
	Condition name.
const objectRegistry &	obr_
	Reference to the object registry.
stateFunctionObject &	state_
	State.
bool	active_
	On/off switch.
dictionary &	conditionDict_
	Reference to the condition dictionary.
label	groupID_
	Group index - if applied, all conditions in a group must be.

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)
	Selector.
Public Attributes inherited from runTimeCondition
Switch	log
	Switch to send output to Info.
Protected Member Functions inherited from runTimeCondition
dictionary &	setConditionDict ()
	Set the condition dictionary (create if necessary).
const dictionary &	conditionDict () const
	Return const access to the conditions dictionary.
dictionary &	conditionDict ()
	Return non-const access to the conditions dictionary.

Detailed Description

Minimum time step condition.

Source files

• minTimeStepCondition.H
• minTimeStepCondition.H
• minTimeStepCondition.C

Definition at line 52 of file minTimeStepCondition.H.

Constructor & Destructor Documentation

minTimeStepCondition()

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

Constructor.

Definition at line 48 of file minTimeStepCondition.C.

References dict, minValue_, runTimeCondition::name(), runTimeCondition::obr_, and runTimeCondition::runTimeCondition().

Here is the call graph for this function:

~minTimeStepCondition()

virtual ~minTimeStepCondition ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"minTimeStep"

)

Runtime type information.

References dict, and runTimeCondition::name().

Here is the call graph for this function:

apply()

bool apply ( )

virtual

Apply the condition.

Implements runTimeCondition.

Definition at line 66 of file minTimeStepCondition.C.

References runTimeCondition::active_, minValue_, and runTimeCondition::obr_.

write()

void write ( )

virtual

Write.

Implements runTimeCondition.

Definition at line 84 of file minTimeStepCondition.C.

reset()

void reset ( )

virtual

Reset.

Implements runTimeCondition.

Definition at line 90 of file minTimeStepCondition.C.

Member Data Documentation

minValue_

scalar minValue_

protected

Minimum time step value to compare.

Definition at line 63 of file minTimeStepCondition.H.

Referenced by apply(), and minTimeStepCondition().

---

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