Loading...
Searching...
No Matches
minMaxCondition Class Reference

#include <minMaxCondition.H>

Inheritance diagram for minMaxCondition:
Inheritance graph
[legend]
Collaboration diagram for minMaxCondition:
Collaboration graph
[legend]

Public Types

enum  modeType { mdMin , mdMax }

Public Member Functions

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

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.
Protected Member Functions inherited from runTimeCondition
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 functionObjectName_
 Name of function object to retrueve data from.
modeType mode_
 Mode.
const wordList fieldNames_
 Field names.
const scalar value_
 Value to compare.
Protected Attributes inherited from runTimeCondition
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.

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.
Public Attributes inherited from runTimeCondition
Switch log
 Switch to send output to Info.

Detailed Description

Definition at line 54 of file minMaxCondition.H.

Member Enumeration Documentation

◆ modeType

enum modeType
Enumerator
mdMin 

Minimum.

mdMax 

Maximum.

Definition at line 63 of file minMaxCondition.H.

Constructor & Destructor Documentation

◆ minMaxCondition()

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

Constructor.

Definition at line 73 of file minMaxCondition.C.

References dict, fieldNames_, functionObjectName_, mode_, modeTypeNames_, runTimeCondition::name(), runTimeCondition::runTimeCondition(), and value_.

Here is the call graph for this function:

◆ ~minMaxCondition()

virtual ~minMaxCondition ( )
virtualdefault

Destructor.

Member Function Documentation

◆ setValue()

template<class Type>
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 25 of file minMaxConditionTemplates.C.

References functionObjectName_, Foam::mag(), and runTimeCondition::state_.

Referenced by apply(), and Foam::functionObjects::runTimeControls::minMaxCondition::setValue< Foam::scalar >().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "minMax" )

Runtime type information.

References dict, and runTimeCondition::name().

Here is the call graph for this function:

◆ apply()

bool apply ( )
virtual

Apply the condition.

Implements runTimeCondition.

Definition at line 91 of file minMaxCondition.C.

References runTimeCondition::active_, Foam::endl(), fieldNames_, functionObjectName_, Log, mdMax, mdMin, mode_, modeTypeNames_, setValue(), runTimeCondition::state_, Foam::type(), value_, and WarningInFunction.

Here is the call graph for this function:

◆ write()

void write ( )
virtual

Write.

Implements runTimeCondition.

Definition at line 156 of file minMaxCondition.C.

◆ reset()

void reset ( )
virtual

Reset.

Implements runTimeCondition.

Definition at line 162 of file minMaxCondition.C.

Member Data Documentation

◆ modeTypeNames_

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

Definition at line 69 of file minMaxCondition.H.

Referenced by apply(), and minMaxCondition().

◆ functionObjectName_

word functionObjectName_
protected

Name of function object to retrueve data from.

Definition at line 79 of file minMaxCondition.H.

Referenced by apply(), minMaxCondition(), and setValue().

◆ mode_

modeType mode_
protected

Mode.

Definition at line 84 of file minMaxCondition.H.

Referenced by apply(), and minMaxCondition().

◆ fieldNames_

const wordList fieldNames_
protected

Field names.

Definition at line 89 of file minMaxCondition.H.

Referenced by apply(), and minMaxCondition().

◆ value_

const scalar value_
protected

Value to compare.

Definition at line 94 of file minMaxCondition.H.

Referenced by apply(), and minMaxCondition().

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