minMaxCondition Class Reference

Inheritance diagram for minMaxCondition:

Collaboration diagram for minMaxCondition:

Public Types
enum	modeType { mdMin, mdMax }

Public Member Functions
	TypeName ("minMax")
	minMaxCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
virtual	~minMaxCondition ()=default
virtual bool	apply ()
virtual void	write ()
Public Member Functions inherited from runTimeCondition
	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

Static Public Attributes
static const Enum< modeType >	modeTypeNames_

Protected Member Functions
template<class Type >
void	setValue (const word &valueType, const word &fieldName, scalar &value) const
Protected Member Functions inherited from runTimeCondition
dictionary &	setConditionDict ()
const dictionary &	conditionDict () const
dictionary &	conditionDict ()

Protected Attributes
word	functionObjectName_
modeType	mode_
const wordList	fieldNames_
const scalar	value_
Protected Attributes inherited from runTimeCondition
word	name_
const objectRegistry &	obr_
stateFunctionObject &	state_
bool	active_
dictionary &	conditionDict_
label	groupID_

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)
Public Attributes inherited from runTimeCondition
Switch	log

Detailed Description

Definition at line 53 of file minMaxCondition.H.

Member Enumeration Documentation

modeType

enum modeType

Enumerator
mdMin	Minimum.
mdMax	Maximum.

Definition at line 62 of file minMaxCondition.H.

Constructor & Destructor Documentation

minMaxCondition()

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

Definition at line 74 of file minMaxCondition.C.

~minMaxCondition()

virtual ~minMaxCondition ( )

virtualdefault

Member Function Documentation

setValue()

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

protected

Definition at line 26 of file minMaxConditionTemplates.C.

References Foam::mag().

Here is the call graph for this function:

TypeName()

TypeName

(

"minMax"

)

apply()

bool apply ( )

virtual

Implements runTimeCondition.

Definition at line 91 of file minMaxCondition.C.

References runTimeCondition::active_, Foam::endl(), minMaxCondition::fieldNames_, minMaxCondition::functionObjectName_, Log, minMaxCondition::mdMax, minMaxCondition::mdMin, minMaxCondition::mode_, minMaxCondition::modeTypeNames_, word::null, stateFunctionObject::objectResultType(), runTimeCondition::state_, Foam::type(), minMaxCondition::value_, and WarningInFunction.

Here is the call graph for this function:

write()

void write ( )

virtual

Implements runTimeCondition.

Definition at line 156 of file minMaxCondition.C.

Member Data Documentation

modeTypeNames_

const Foam::Enum< Foam::functionObjects::runTimeControls::minMaxCondition::modeType > modeTypeNames_

static

Definition at line 68 of file minMaxCondition.H.

Referenced by minMaxCondition::apply().

functionObjectName_

word functionObjectName_

protected

Definition at line 76 of file minMaxCondition.H.

Referenced by minMaxCondition::apply().

mode_

modeType mode_

protected

Definition at line 79 of file minMaxCondition.H.

Referenced by minMaxCondition::apply().

fieldNames_

const wordList fieldNames_

protected

Definition at line 82 of file minMaxCondition.H.

Referenced by minMaxCondition::apply().

value_

const scalar value_

protected

Definition at line 85 of file minMaxCondition.H.

Referenced by minMaxCondition::apply().

---

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

• src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.H
• src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxCondition.C
• src/functionObjects/utilities/runTimeControl/runTimeCondition/minMaxCondition/minMaxConditionTemplates.C