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, stateFunctionObject &state) | |
Constructor. More... | |
virtual | ~minMaxCondition ()=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... | |
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 |
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... | |
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... | |
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... | |
Definition at line 54 of file minMaxCondition.H.
enum modeType |
Enumerator | |
---|---|
mdMin | Minimum. |
mdMax | Maximum. |
Definition at line 63 of file minMaxCondition.H.
minMaxCondition | ( | const word & | name, |
const objectRegistry & | obr, | ||
const dictionary & | dict, | ||
stateFunctionObject & | state | ||
) |
Constructor.
Definition at line 74 of file minMaxCondition.C.
|
virtualdefault |
Destructor.
Helper function to retrieve the value from the state dictionary.
Definition at line 26 of file minMaxConditionTemplates.C.
References Foam::mag().
TypeName | ( | "minMax" | ) |
Runtime type information.
|
virtual |
Apply the condition.
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_, stateFunctionObject::objectResultType(), runTimeCondition::state_, Foam::type(), minMaxCondition::value_, and WarningInFunction.
|
virtual |
|
virtual |
|
static |
Definition at line 69 of file minMaxCondition.H.
Referenced by minMaxCondition::apply().
|
protected |
Name of function object to retrueve data from.
Definition at line 79 of file minMaxCondition.H.
Referenced by minMaxCondition::apply().
|
protected |
|
protected |
Field names.
Definition at line 89 of file minMaxCondition.H.
Referenced by minMaxCondition::apply().
|
protected |
Value to compare.
Definition at line 94 of file minMaxCondition.H.
Referenced by minMaxCondition::apply().