maxDurationCondition Class Reference

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

#include <maxDurationCondition.H>

Inheritance diagram for maxDurationCondition:

Collaboration diagram for maxDurationCondition:

Public Member Functions
	TypeName ("maxDuration")
	Runtime type information.
	maxDurationCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
	Constructor.
virtual	~maxDurationCondition ()=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	duration_
	Duration.
scalar	startTime_
	Time when the condition is activated.
bool	initialised_
	Initialisation flag.
Switch	resetOnRestart_
	Reset on restart (ignores any state information).
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

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 )

Constructor.

Definition at line 47 of file maxDurationCondition.C.

References runTimeCondition::conditionDict(), dict, duration_, initialised_, runTimeCondition::name(), readIfPresent(), resetOnRestart_, runTimeCondition::runTimeCondition(), and startTime_.

Here is the call graph for this function:

~maxDurationCondition()

virtual ~maxDurationCondition ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"maxDuration"

)

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 74 of file maxDurationCondition.C.

References runTimeCondition::active_, delta, duration_, initialised_, Log, runTimeCondition::name_, Foam::nl, runTimeCondition::obr_, startTime_, and Foam::type().

Here is the call graph for this function:

write()

void write ( )

virtual

Write.

Implements runTimeCondition.

Definition at line 97 of file maxDurationCondition.C.

References runTimeCondition::conditionDict(), initialised_, and startTime_.

Here is the call graph for this function:

reset()

void reset ( )

virtual

Reset.

Implements runTimeCondition.

Definition at line 106 of file maxDurationCondition.C.

References initialised_.

Member Data Documentation

duration_

scalar duration_

protected

Duration.

Definition at line 62 of file maxDurationCondition.H.

Referenced by apply(), and maxDurationCondition().

startTime_

scalar startTime_

protected

Time when the condition is activated.

Definition at line 67 of file maxDurationCondition.H.

Referenced by apply(), maxDurationCondition(), and write().

initialised_

bool initialised_

protected

Initialisation flag.

Definition at line 72 of file maxDurationCondition.H.

Referenced by apply(), maxDurationCondition(), reset(), and write().

resetOnRestart_

Switch resetOnRestart_

protected

Reset on restart (ignores any state information).

Definition at line 77 of file maxDurationCondition.H.

Referenced by maxDurationCondition().

---

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