maxDurationCondition Class Reference

Activated after a user-specified duration. More...

Inheritance diagram for maxDurationCondition:

Collaboration diagram for maxDurationCondition:

Public Member Functions
	TypeName ("maxDuration")
	maxDurationCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
virtual	~maxDurationCondition ()=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	duration_
scalar	startTime_
bool	initialised_
Switch	resetOnRestart_
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

Activated after a user-specified duration.

Source files

• maxDurationCondition.H
• maxDurationCondition.H
• maxDurationCondition.C

Definition at line 51 of file maxDurationCondition.H.

Constructor & Destructor Documentation

maxDurationCondition()

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

Definition at line 49 of file maxDurationCondition.C.

~maxDurationCondition()

virtual ~maxDurationCondition ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"maxDuration"

)

apply()

bool apply ( )

virtual

Implements runTimeCondition.

Definition at line 74 of file maxDurationCondition.C.

References runTimeCondition::active_, delta, maxDurationCondition::duration_, maxDurationCondition::initialised_, Log, runTimeCondition::name_, Foam::nl, runTimeCondition::obr_, maxDurationCondition::startTime_, objectRegistry::time(), TimeState::timeToUserTime(), Foam::type(), and dimensioned::value().

Here is the call graph for this function:

write()

void write ( )

virtual

Implements runTimeCondition.

Definition at line 97 of file maxDurationCondition.C.

Member Data Documentation

duration_

scalar duration_

protected

Definition at line 60 of file maxDurationCondition.H.

Referenced by maxDurationCondition::apply().

startTime_

scalar startTime_

protected

Definition at line 63 of file maxDurationCondition.H.

Referenced by maxDurationCondition::apply().

initialised_

bool initialised_

protected

Definition at line 66 of file maxDurationCondition.H.

Referenced by maxDurationCondition::apply().

resetOnRestart_

Switch resetOnRestart_

protected

Definition at line 69 of file maxDurationCondition.H.

---

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

• src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.H
• src/functionObjects/utilities/runTimeControl/runTimeCondition/maxDurationCondition/maxDurationCondition.C