runTimeCondition Class Reference

Base class for run time conditions. More...

Inheritance diagram for runTimeCondition:

Collaboration diagram for runTimeCondition:

Public Member Functions
	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
virtual bool	apply ()=0
virtual void	write ()=0

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

Public Attributes
Switch	log

Protected Member Functions
dictionary &	setConditionDict ()
const dictionary &	conditionDict () const
dictionary &	conditionDict ()

Protected Attributes
word	name_
const objectRegistry &	obr_
stateFunctionObject &	state_
bool	active_
dictionary &	conditionDict_
label	groupID_

Detailed Description

Base class for run time conditions.

Source files

• runTimeCondition.H
• runTimeCondition.C
• runTimeConditionNew.C
• runTimeCondition.H

Definition at line 57 of file runTimeCondition.H.

Constructor & Destructor Documentation

runTimeCondition()

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

Definition at line 71 of file runTimeCondition.C.

~runTimeCondition()

virtual ~runTimeCondition ( )

virtualdefault

Member Function Documentation

setConditionDict()

Foam::dictionary & setConditionDict ( )

protected

Definition at line 41 of file runTimeCondition.C.

References dictionary::add(), dictionary::found(), runTimeCondition::name_, stateFunctionObject::propertyDict(), runTimeCondition::state_, and dictionary::subDict().

Here is the call graph for this function:

conditionDict() [1/2]

Foam::dictionary & conditionDict ( ) const

protected

Definition at line 55 of file runTimeCondition.C.

conditionDict() [2/2]

dictionary& conditionDict ( )

protected

TypeName()

TypeName

(

"runTimeCondition"

)

declareRunTimeSelectionTable()

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

New()

Foam::autoPtr< Foam::functionObjects::runTimeControls::runTimeCondition > New ( const word &  conditionName, const objectRegistry &  obr, const dictionary &  dict, stateFunctionObject &  state  )

static

Definition at line 28 of file runTimeConditionNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.

Here is the call graph for this function:

name()

const Foam::word & name ( ) const

virtual

Definition at line 91 of file runTimeCondition.C.

active()

bool active ( ) const

virtual

Definition at line 97 of file runTimeCondition.C.

Referenced by runTimeControl::execute().

Here is the caller graph for this function:

groupID()

Foam::label groupID ( ) const

virtual

Definition at line 104 of file runTimeCondition.C.

Referenced by runTimeControl::execute().

Here is the caller graph for this function:

apply()

virtual bool apply ( )

pure virtual

Implemented in averageCondition, equationInitialResidualCondition, minMaxCondition, maxDurationCondition, equationMaxIterCondition, and minTimeStepCondition.

Referenced by runTimeControl::execute().

Here is the caller graph for this function:

write()

virtual void write ( )

pure virtual

Implemented in averageCondition, equationInitialResidualCondition, minMaxCondition, maxDurationCondition, equationMaxIterCondition, and minTimeStepCondition.

Member Data Documentation

name_

word name_

protected

Definition at line 65 of file runTimeCondition.H.

Referenced by equationMaxIterCondition::apply(), maxDurationCondition::apply(), averageCondition::apply(), and runTimeCondition::setConditionDict().

obr_

const objectRegistry& obr_

protected

Definition at line 68 of file runTimeCondition.H.

Referenced by minTimeStepCondition::apply(), equationMaxIterCondition::apply(), maxDurationCondition::apply(), and averageCondition::apply().

state_

stateFunctionObject& state_

protected

Definition at line 71 of file runTimeCondition.H.

Referenced by minMaxCondition::apply(), and runTimeCondition::setConditionDict().

active_

bool active_

protected

Definition at line 74 of file runTimeCondition.H.

Referenced by minTimeStepCondition::apply(), equationMaxIterCondition::apply(), maxDurationCondition::apply(), minMaxCondition::apply(), and averageCondition::apply().

conditionDict_

dictionary& conditionDict_

protected

Definition at line 77 of file runTimeCondition.H.

groupID_

label groupID_

protected

Definition at line 81 of file runTimeCondition.H.

log

Switch log

Definition at line 141 of file runTimeCondition.H.

---

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

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