Average run time condition - satisfied when average does not change by more than a given value. More...
Public Member Functions | |
TypeName ("average") | |
Runtime type information. More... | |
averageCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state) | |
Constructor. More... | |
virtual | ~averageCondition ()=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... | |
Public Member Functions inherited from valueAverageBase | |
valueAverageBase (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state, const bool writeToFile=true) | |
Construct from Time and dictionary. More... | |
valueAverageBase (const valueAverageBase &)=delete | |
No copy construct. More... | |
void | operator= (const valueAverageBase &)=delete |
No copy assignment. More... | |
virtual | ~valueAverageBase ()=default |
Destructor. More... | |
virtual bool | read (const dictionary &dict) |
Read the field value average data. More... | |
virtual bool | calculate (dictionary &dict) |
Calculate the averages. More... | |
Public Member Functions inherited from writeFile | |
writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true) | |
Construct from objectRegistry, prefix, fileName. More... | |
writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true) | |
Construct from objectRegistry, prefix, fileName and read options from dictionary. More... | |
writeFile (const writeFile &wf) | |
Construct copy. More... | |
virtual | ~writeFile ()=default |
Destructor. More... | |
virtual OFstream & | file () |
Return access to the file (if only 1) More... | |
virtual bool | writeToFile () const |
Flag to allow writing to file. More... | |
virtual bool | canWriteToFile () const |
Flag to allow writing to the file. More... | |
virtual bool | canResetFile () const |
Flag to allow resetting the file. More... | |
virtual bool | canWriteHeader () const |
Flag to allow writing the header. More... | |
virtual label | charWidth () const |
Return width of character stream output. More... | |
virtual void | writeCommented (Ostream &os, const string &str) const |
Write a commented string to stream. More... | |
virtual void | writeTabbed (Ostream &os, const string &str) const |
Write a tabbed string to stream. More... | |
virtual void | writeHeader (Ostream &os, const string &str) const |
Write a commented header to stream. More... | |
virtual void | writeCurrentTime (Ostream &os) const |
Write the current time to stream. More... | |
virtual void | writeBreak (Ostream &os) const |
Write a break marker to the stream. More... | |
template<class Type > | |
void | writeHeaderValue (Ostream &os, const string &property, const Type &value) const |
Write a (commented) header property and value pair. More... | |
template<class Type > | |
void | writeValue (Ostream &os, const Type &val) const |
Write a given value to stream with the space delimiter. More... | |
Protected Attributes | |
label | nIterStartUp_ |
Number of start-up iterations before allowing satisfied checks. More... | |
label | iter_ |
Current iteration count. 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... | |
Protected Attributes inherited from valueAverageBase | |
bool | resetOnRestart_ |
Reset the averaging process on restart. More... | |
windowType | windowType_ |
Window type. More... | |
stateFunctionObject & | state_ |
Reference to the state functionObject. More... | |
word | functionObjectName_ |
Name of function object to retrieve data from. More... | |
wordList | fieldNames_ |
List of fields on which to operate. More... | |
scalar | tolerance_ |
Optional tolerance to check for converged results. More... | |
scalar | window_ |
Averaging window. More... | |
List< scalar > | totalTime_ |
Average time per field. More... | |
Protected Attributes inherited from writeFile | |
const objectRegistry & | fileObr_ |
Reference to the region objectRegistry. More... | |
const fileName | prefix_ |
Prefix. More... | |
word | fileName_ |
Name of file. More... | |
autoPtr< OFstream > | filePtr_ |
File pointer. More... | |
label | writePrecision_ |
Write precision. More... | |
bool | writeToFile_ |
Flag to enable/disable writing to file. More... | |
bool | updateHeader_ |
Flag to update the header, e.g. on mesh changes. Default is true. More... | |
bool | writtenHeader_ |
Flag to identify whether the header has been written. More... | |
bool | useUserTime_ |
Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true. More... | |
scalar | startTime_ |
Start time value. More... | |
Additional Inherited Members | |
Public Types inherited from valueAverageBase | |
enum | windowType : uint8_t { NONE, APPROXIMATE, EXACT } |
Averaging window types. More... | |
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... | |
Static Public Attributes inherited from valueAverageBase | |
static const Enum< windowType > | windowTypeNames |
Names for windowType enumeration. More... | |
Static Public Attributes inherited from writeFile | |
static label | addChars = 8 |
Additional characters for writing. 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 Member Functions inherited from valueAverageBase | |
template<class Type , class Type2 = Type> | |
bool | calc (const label fieldi, bool &converged, dictionary &dict) |
Templated function to calculate the average. More... | |
virtual void | writeFileHeader (Ostream &os) const |
Output file header information. More... | |
virtual void | readState (dictionary &dict) |
Read state from dictionary. More... | |
virtual void | writeState (dictionary &dict) |
Write state to dictionary for restarts. More... | |
virtual void | resetState (dictionary &dict) |
Reset state. More... | |
Protected Member Functions inherited from writeFile | |
void | initStream (Ostream &os) const |
Initialise the output stream for writing. More... | |
fileName | baseFileDir () const |
Return the base directory for output. More... | |
fileName | baseTimeDir () const |
Return the base directory for the current time value. More... | |
fileName | filePath (const fileName &fName) const |
Return the full path for the supplied file name. More... | |
virtual autoPtr< OFstream > | newFile (const fileName &fName) const |
Return autoPtr to a new file using file name. More... | |
virtual autoPtr< OFstream > | newFileAtTime (const word &name, scalar timeValue) const |
Return autoPtr to a new file for a given time. More... | |
virtual autoPtr< OFstream > | newFileAtStartTime (const word &name) const |
Return autoPtr to a new file using the simulation start time. More... | |
virtual void | resetFile (const word &name) |
Reset internal file pointer to new file with new name. More... | |
Omanip< int > | valueWidth (const label offset=0) const |
Return the value width when writing to stream with optional offset. More... | |
void | operator= (const writeFile &)=delete |
No copy assignment. More... | |
virtual autoPtr< OFstream > | createFile (const word &name, scalar timeValue) const |
Deprecated(2022-09) Return autoPtr to a new file for a given time. More... | |
virtual autoPtr< OFstream > | createFile (const word &name) const |
Deprecated(2022-09) Return autoPtr to a new file using the simulation start time. More... | |
Average run time condition - satisfied when average does not change by more than a given value.
Definition at line 56 of file averageCondition.H.
averageCondition | ( | const word & | name, |
const objectRegistry & | obr, | ||
const dictionary & | dict, | ||
stateFunctionObject & | state | ||
) |
Constructor.
Definition at line 41 of file averageCondition.C.
References dictionary::readIfPresent().
|
virtualdefault |
Destructor.
TypeName | ( | "average" | ) |
Runtime type information.
|
virtual |
Apply the condition.
Implements runTimeCondition.
Definition at line 63 of file averageCondition.C.
References runTimeCondition::active_, valueAverageBase::calculate(), runTimeCondition::conditionDict(), Foam::decrIndent(), Foam::incrIndent(), Foam::Info, averageCondition::iter_, and averageCondition::nIterStartUp_.
|
virtual |
Write.
Implements runTimeCondition.
Definition at line 85 of file averageCondition.C.
References dictionary::set(), and valueAverageBase::writeState().
|
virtual |
Reset.
Implements runTimeCondition.
Definition at line 95 of file averageCondition.C.
References valueAverageBase::resetState().
|
protected |
Number of start-up iterations before allowing satisfied checks.
Definition at line 68 of file averageCondition.H.
Referenced by averageCondition::apply().
|
protected |
Current iteration count.
Definition at line 73 of file averageCondition.H.
Referenced by averageCondition::apply().