45 #ifndef functionObjects_valueAverageBase_H 46 #define functionObjects_valueAverageBase_H 56 namespace functionObjects
123 template<
class Type,
class Type2=Type>
windowType
Averaging window types.
stateFunctionObject & state_
Reference to the state functionObject.
Computes the natural logarithm of an input volScalarField.
virtual void writeState(dictionary &dict)
Write state to dictionary for restarts.
bool calc(const label fieldi, bool &converged, dictionary &dict)
Templated function to calculate the average.
A list of keyword definitions, which are a keyword followed by a number of values (eg...
word functionObjectName_
Name of function object to retrieve data from.
static const Enum< windowType > windowTypeNames
Names for windowType enumeration.
virtual bool calculate(dictionary &dict)
Calculate the averages.
windowType windowType_
Window type.
scalar window_
Averaging window.
wordList fieldNames_
List of fields on which to operate.
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
virtual void readState(dictionary &dict)
Read state from dictionary.
A class for handling words, derived from Foam::string.
virtual bool read(const dictionary &dict)
Read the field value average data.
virtual bool writeToFile() const
Flag to allow writing to file.
virtual void writeFileHeader(Ostream &os) const
Output file header information.
virtual ~valueAverageBase()=default
Destructor.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
OBJstream os(runTime.globalPath()/outputName)
void operator=(const valueAverageBase &)=delete
No copy assignment.
List< scalar > totalTime_
Average time per field.
valueAverageBase(const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state, const bool writeToFile=true)
Construct from Time and dictionary.
Base class for function objects, adding functionality to read/write state information (data required ...
Registry of regIOobjects.
bool resetOnRestart_
Reset the averaging process on restart.
Base class for writing single files from the function objects.
scalar tolerance_
Optional tolerance to check for converged results.
Base class that computes the ensemble- or time-based singular-value average values, with optional windowing, from the output of function objects that generate non-field type values, e.g. Cd of forceCoeffs or momentum_x in momentum function objects.
virtual void resetState(dictionary &dict)
Reset state.