noneCondition Class Reference

Inheritance diagram for noneCondition:

Collaboration diagram for noneCondition:

Public Member Functions
	TypeNameNoDebug ("none")
	Runtime type information. More...
	noneCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
	Constructor. More...
virtual	~noneCondition ()=default
	Destructor. More...
virtual bool	apply ()
	Apply the condition. More...
virtual void	write ()
	Write. More...
virtual void	reset ()
	Reset. More...
Public Member Functions inherited from runTimeCondition
	TypeName ("runTimeCondition")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, runTimeCondition, dictionary,(const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state),(name, obr, dict, state))
	Declare runtime constructor selection table. More...
	runTimeCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
	Constructor. More...
virtual	~runTimeCondition ()=default
	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...

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. More...
Public Attributes inherited from runTimeCondition
Switch	log
	Switch to send output to Info. More...
Protected Member Functions inherited from runTimeCondition
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 inherited from runTimeCondition
word	name_
	Condition name. More...
const objectRegistry &	obr_
	Reference to the object registry. More...
stateFunctionObject &	state_
	State. More...
bool	active_
	On/off switch. More...
dictionary &	conditionDict_
	Reference to the condition dictionary. More...
label	groupID_
	Group index - if applied, all conditions in a group must be. More...

Detailed Description

Definition at line 50 of file noneCondition.H.

Constructor & Destructor Documentation

noneCondition()

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

Constructor.

Definition at line 43 of file noneCondition.C.

~noneCondition()

virtual ~noneCondition ( )

virtualdefault

Destructor.

Member Function Documentation

TypeNameNoDebug()

TypeNameNoDebug

(

"none"

)

Runtime type information.

apply()

bool apply ( )

virtual

Apply the condition.

Implements runTimeCondition.

Definition at line 56 of file noneCondition.C.

write()

void write ( )

virtual

Write.

Implements runTimeCondition.

Definition at line 62 of file noneCondition.C.

reset()

void reset ( )

virtual

Reset.

Implements runTimeCondition.

Definition at line 68 of file noneCondition.C.

---

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

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