Base class for run time conditions. More...

#include <runTimeCondition.H>

Inheritance diagram for runTimeCondition:

[legend]

Collaboration diagram for runTimeCondition:

[legend]

Public Member Functions
	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.
virtual bool	apply ()=0
	Apply the condition.
virtual void	write ()=0
	Write.
virtual void	reset ()=0
	Reset.

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

Public Attributes
Switch	log
	Switch to send output to Info.

Protected Member Functions
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.

Protected Attributes
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.

Detailed Description

Base class for run time conditions.

Source files

Definition at line 57 of file runTimeCondition.H.

Constructor & Destructor Documentation

◆ runTimeCondition()

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

Constructor.

Definition at line 70 of file runTimeCondition.C.

References active_, conditionDict_, dict, groupID_, log, name(), name_, obr_, setConditionDict(), and state_.

Referenced by averageCondition::averageCondition(), declareRunTimeSelectionTable(), equationInitialResidualCondition::equationInitialResidualCondition(), equationMaxIterCondition::equationMaxIterCondition(), maxDurationCondition::maxDurationCondition(), minMaxCondition::minMaxCondition(), minTimeStepCondition::minTimeStepCondition(), and noneCondition::noneCondition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~runTimeCondition()

virtual ~runTimeCondition ( )

virtualdefault

Destructor.

References dict.

Member Function Documentation

◆ setConditionDict()

Foam::dictionary & setConditionDict ( )

protected

Set the condition dictionary (create if necessary).

Definition at line 41 of file runTimeCondition.C.

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

Referenced by runTimeCondition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ conditionDict() [1/2]

const Foam::dictionary & conditionDict ( ) const

protected

Return const access to the conditions dictionary.

Definition at line 55 of file runTimeCondition.C.

References conditionDict_.

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

Here is the caller graph for this function:

◆ conditionDict() [2/2]

Foam::dictionary & conditionDict ( )

protected

Return non-const access to the conditions dictionary.

Definition at line 62 of file runTimeCondition.C.

References conditionDict_.

◆ TypeName()

TypeName ( "runTimeCondition" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

References dict, name(), and runTimeCondition().

Here is the call graph for this function:

◆ New()

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

static

Selector.

Definition at line 27 of file runTimeConditionNew.C.

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

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 91 of file runTimeCondition.C.

References name_.

Referenced by averageCondition::averageCondition(), declareRunTimeSelectionTable(), equationInitialResidualCondition::equationInitialResidualCondition(), equationMaxIterCondition::equationMaxIterCondition(), maxDurationCondition::maxDurationCondition(), minMaxCondition::minMaxCondition(), minTimeStepCondition::minTimeStepCondition(), noneCondition::noneCondition(), runTimeCondition(), averageCondition::TypeName(), equationInitialResidualCondition::TypeName(), equationMaxIterCondition::TypeName(), maxDurationCondition::TypeName(), minMaxCondition::TypeName(), minTimeStepCondition::TypeName(), and noneCondition::TypeNameNoDebug().

Here is the caller graph for this function:

◆ active()

bool active ( ) const

virtual

Return the active flag.

Definition at line 97 of file runTimeCondition.C.

References active_.

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.

References groupID_.

Referenced by runTimeControl::execute().

Here is the caller graph for this function:

◆ apply()

virtual bool apply ( )

pure virtual

Apply the condition.

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

Referenced by runTimeControl::execute().

Here is the caller graph for this function:

◆ write()

virtual void write ( )

pure virtual

Write.

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

◆ reset()

virtual void reset ( )

pure virtual

Reset.

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

Referenced by runTimeControl::execute().

Here is the caller graph for this function:

Member Data Documentation

◆ name_

word name_

protected

Condition name.

Definition at line 67 of file runTimeCondition.H.

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

◆ obr_

const objectRegistry& obr_

protected

Reference to the object registry.

Definition at line 72 of file runTimeCondition.H.

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

◆ state_

stateFunctionObject& state_

protected

State.

Definition at line 77 of file runTimeCondition.H.

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

◆ active_

bool active_

protected

On/off switch.

Definition at line 82 of file runTimeCondition.H.

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

◆ conditionDict_

dictionary& conditionDict_

protected

Reference to the condition dictionary.

Definition at line 87 of file runTimeCondition.H.

Referenced by conditionDict(), conditionDict(), and runTimeCondition().

◆ groupID_

label groupID_

protected

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

satisfied before condition is met

Definition at line 94 of file runTimeCondition.H.

Referenced by groupID(), and runTimeCondition().

◆ log

Switch log

Switch to send output to Info.

Definition at line 172 of file runTimeCondition.H.

Referenced by runTimeCondition().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ runTimeCondition()

◆ ~runTimeCondition()

Member Function Documentation

◆ setConditionDict()

◆ conditionDict() [1/2]

◆ conditionDict() [2/2]

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ name()

◆ active()

◆ groupID()

◆ apply()

◆ write()

◆ reset()

Member Data Documentation

◆ name_

◆ obr_

◆ state_

◆ active_

◆ conditionDict_

◆ groupID_

◆ log