Public Member Functions | Protected Attributes | List of all members
minTimeStepCondition Class Reference

Minimum time step condition. More...

Inheritance diagram for minTimeStepCondition:
[legend]
Collaboration diagram for minTimeStepCondition:
[legend]

Public Member Functions

 TypeName ("minTimeStep")
 Runtime type information. More...
 
 minTimeStepCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
 Constructor. More...
 
virtual ~minTimeStepCondition ()=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...
 
virtual bool apply ()=0
 Apply the condition. More...
 
virtual void write ()=0
 Write. More...
 
virtual void reset ()=0
 Reset. More...
 

Protected Attributes

scalar minValue_
 Minimum time step 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...
 
- 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...
 

Detailed Description

Minimum time step condition.

Source files

Definition at line 56 of file minTimeStepCondition.H.

Constructor & Destructor Documentation

◆ minTimeStepCondition()

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

Constructor.

Definition at line 55 of file minTimeStepCondition.C.

References minTimeStepCondition::minValue_, Foam::name(), runTimeCondition::obr_, objectRegistry::time(), and TimeState::userTimeToTime().

Here is the call graph for this function:

◆ ~minTimeStepCondition()

virtual ~minTimeStepCondition ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "minTimeStep"  )

Runtime type information.

◆ apply()

bool apply ( )
virtual

Apply the condition.

Implements runTimeCondition.

Definition at line 73 of file minTimeStepCondition.C.

◆ write()

void write ( )
virtual

Write.

Implements runTimeCondition.

Definition at line 91 of file minTimeStepCondition.C.

◆ reset()

void reset ( )
virtual

Reset.

Implements runTimeCondition.

Definition at line 97 of file minTimeStepCondition.C.

Member Data Documentation

◆ minValue_

scalar minValue_
protected

Minimum time step value to compare.

Definition at line 65 of file minTimeStepCondition.H.

Referenced by minTimeStepCondition::minTimeStepCondition().

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