runTimeCondition Class Reference

Base class for run time conditions. More...

Inheritance diagram for runTimeCondition:

Collaboration diagram for runTimeCondition:

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

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

Protected Member Functions
dictionary &	setConditionDict ()
	Set the condition dictionary (create if necessary) More...
const dictionary &	conditionDict () const
	Return const access to the conditions dictionary. More...
dictionary &	conditionDict ()
	Return non-const access to the conditions dictionary. More...

Protected Attributes
word	name_
	Condition name. More...
const objectRegistry &	obr_
	Reference to the object registry. More...
functionObjectState &	state_
	State. More...
bool	active_
	On/off switch. More...
dictionary &	conditionDict_
	Reference to the condition dictionary. More...
Switch	log_
	Switch to send output to Info. More...
label	groupID_
	Group index - if applied, all conditions in a group must be. More...

Detailed Description

Base class for run time conditions.

Source files

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

Definition at line 54 of file runTimeCondition.H.

Constructor & Destructor Documentation

runTimeCondition()

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

Constructor.

Definition at line 67 of file runTimeCondition.C.

~runTimeCondition()

~runTimeCondition ( )

virtual

Destructor.

Definition at line 86 of file runTimeCondition.C.

Member Function Documentation

setConditionDict()

Foam::dictionary & setConditionDict ( )

protected

Set the condition dictionary (create if necessary)

Definition at line 39 of file runTimeCondition.C.

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

Here is the call graph for this function:

conditionDict() [1/2]

Foam::dictionary & conditionDict ( ) const

protected

Return const access to the conditions dictionary.

Definition at line 52 of file runTimeCondition.C.

conditionDict() [2/2]

dictionary& conditionDict ( )

protected

Return non-const access to the conditions dictionary.

TypeName()

TypeName

(

"runTimeCondition"

)

Runtime type information.

declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

New()

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

static

Selector.

Definition at line 31 of file runTimeConditionNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, and Foam::nl.

Referenced by runTimeControl::read().

Here is the call graph for this function:

Here is the caller graph for this function:

name()

const Foam::word & name ( ) const

virtual

Return the condition name.

Definition at line 92 of file runTimeCondition.C.

active()

bool active ( ) const

virtual

Return the active flag.

Definition at line 98 of file runTimeCondition.C.

Referenced by runTimeControl::execute().

Here is the caller graph for this function:

groupID()

Foam::label groupID ( ) const

virtual

Return the group index.

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

Apply the condition.

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

Referenced by runTimeControl::execute().

Here is the caller graph for this function:

write()

virtual void write ( )

pure virtual

Write.

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

Field Documentation

name_

word name_

protected

Condition name.

Definition at line 62 of file runTimeCondition.H.

Referenced by runTimeCondition::setConditionDict().

obr_

const objectRegistry& obr_

protected

Reference to the object registry.

Definition at line 65 of file runTimeCondition.H.

state_

functionObjectState& state_

protected

State.

Definition at line 68 of file runTimeCondition.H.

Referenced by runTimeCondition::setConditionDict().

active_

bool active_

protected

On/off switch.

Definition at line 71 of file runTimeCondition.H.

conditionDict_

dictionary& conditionDict_

protected

Reference to the condition dictionary.

Definition at line 74 of file runTimeCondition.H.

log_

Switch log_

protected

Switch to send output to Info.

Definition at line 77 of file runTimeCondition.H.

groupID_

label groupID_

protected

Group index - if applied, all conditions in a group must be.

satisfield before condition is met

Definition at line 81 of file runTimeCondition.H.

---

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

• src/postProcessing/functionObjects/jobControl/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.H
• src/postProcessing/functionObjects/jobControl/runTimeControl/runTimeCondition/runTimeCondition/runTimeCondition.C
• src/postProcessing/functionObjects/jobControl/runTimeControl/runTimeCondition/runTimeCondition/runTimeConditionNew.C