minMaxCondition Class Reference

Minimum/maximum run time conditions. If the value type is not scalar, the magnitude of the value is used in the evaluation. More...

Inheritance diagram for minMaxCondition:

Collaboration diagram for minMaxCondition:

Public Types
enum	modeType { mdMin, mdMax }

Public Member Functions
	TypeName ("minMax")
	Runtime type information. More...
	minMaxCondition (const word &name, const objectRegistry &obr, const dictionary &dict, functionObjectState &state)
	Constructor. More...
virtual	~minMaxCondition ()
	Destructor. More...
virtual bool	apply ()
	Apply the condition. More...
virtual void	write ()
	Write. 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, 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...

Static Public Attributes
static const NamedEnum< modeType, 2 >	modeTypeNames_

Protected Member Functions
template<class Type >
void	setValue (const word &valueType, const word &fieldName, scalar &value) const
	Helper function to retrieve the value from the state dictionary. 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
word	functionObjectName_
	Name of function object to retrueve data from. More...
modeType	mode_
	Mode. More...
const wordList	fieldNames_
	Field names. More...
const scalar	value_
	Value to compare. More...
Protected Attributes inherited from runTimeCondition
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...

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

Detailed Description

Minimum/maximum run time conditions. If the value type is not scalar, the magnitude of the value is used in the evaluation.

Source files

• minMaxCondition.H
• minMaxCondition.H
• minMaxCondition.C

Definition at line 51 of file minMaxCondition.H.

Member Enumeration Documentation

modeType

enum modeType

Enumerator
mdMin
mdMax

Definition at line 60 of file minMaxCondition.H.

Constructor & Destructor Documentation

minMaxCondition()

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

Constructor.

Definition at line 66 of file minMaxCondition.C.

~minMaxCondition()

~minMaxCondition ( )

virtual

Destructor.

Definition at line 83 of file minMaxCondition.C.

Member Function Documentation

setValue()

void setValue ( const word &  valueType, const word &  fieldName, scalar &  value  ) const

protected

Helper function to retrieve the value from the state dictionary.

Definition at line 30 of file minMaxConditionTemplates.C.

References Foam::mag().

Here is the call graph for this function:

TypeName()

TypeName

(

"minMax"

)

Runtime type information.

apply()

bool apply ( )

virtual

Apply the condition.

Implements runTimeCondition.

Definition at line 89 of file minMaxCondition.C.

References Foam::endl(), forAll, Foam::Info, modeTypeNames_, word::null, Foam::type(), and WarningInFunction.

Here is the call graph for this function:

write()

void write ( )

virtual

Write.

Implements runTimeCondition.

Definition at line 159 of file minMaxCondition.C.

Field Documentation

modeTypeNames_

const Foam::NamedEnum< Foam::minMaxCondition::modeType, 2 > modeTypeNames_

static

Definition at line 66 of file minMaxCondition.H.

functionObjectName_

word functionObjectName_

protected

Name of function object to retrueve data from.

Definition at line 74 of file minMaxCondition.H.

mode_

modeType mode_

protected

Mode.

Definition at line 77 of file minMaxCondition.H.

fieldNames_

const wordList fieldNames_

protected

Field names.

Definition at line 80 of file minMaxCondition.H.

value_

const scalar value_

protected

Value to compare.

Definition at line 83 of file minMaxCondition.H.

---

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

• src/postProcessing/functionObjects/jobControl/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.H
• src/postProcessing/functionObjects/jobControl/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.C
• src/postProcessing/functionObjects/jobControl/runTimeControl/runTimeCondition/minMaxCondition/minMaxConditionTemplates.C