Go to the documentation of this file.
98 #ifndef functionObjects_valueAverage_H
99 #define functionObjects_valueAverage_H
108 namespace functionObjects
117 public regionFunctionObject,
146 const word& fieldName,
147 const word& meanName,
170 const dictionary&
dict
193 virtual bool write();
A simple wrapper around bool so that it can be read as a word: true/false, on/off,...
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Computes the ensemble- or time-based singular-value average values, with optional windowing,...
virtual void writeFileHeader(Ostream &os) const
Output file header information.
A class for handling words, derived from Foam::string.
TypeName("valueAverage")
Runtime type information.
virtual bool execute()
Execute.
const dimensionedScalar alpha
Fine-structure constant: default SI units: [].
List< scalar > totalTime_
Average time per field.
void calc(const word &fieldName, const word &meanName, const scalar alpha, const scalar beta, bool &processed)
Templated function to calculate the average.
List< word > wordList
A List of words.
void operator=(const valueAverage &)=delete
No copy assignment.
virtual bool read(const dictionary &)
Read the field value average data.
wordList fieldNames_
List of fields on which to operate.
dimensionedScalar beta("beta", dimless/dimTemperature, laminarTransport)
word functionObjectName_
Name of function object to retrieve data from.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
OBJstream os(runTime.globalPath()/outputName)
virtual bool write()
Write the value average.
valueAverage(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
const word & name() const noexcept
Return the name of this functionObject.
virtual ~valueAverage()=default
Destructor.
Specialization of Foam::functionObject for a region and providing a reference to the region Foam::obj...
Base class for writing single files from the function objects.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Switch resetOnRestart_
Reset the averaging process on restart.
scalar window_
Averaging window.