Helper class to describe what form of averaging to apply. A set will be applied to each base field in Foam::fieldAverage, of the form: More...
Classes | |
class | iNew |
Class used for the read-construction of. More... | |
Public Member Functions | |
fieldAverageItem () | |
Construct null. More... | |
fieldAverageItem (const fieldAverage &fa, Istream &is) | |
Construct from Istream for given fieldAverage. More... | |
fieldAverageItem (const fieldAverageItem &)=default | |
Copy constructor. More... | |
autoPtr< fieldAverageItem > | clone () const |
Clone function. More... | |
~fieldAverageItem () | |
Destructor. More... | |
const word & | fieldName () const |
Return const access to the field name. More... | |
const Switch & | mean () const |
Return const access to the mean flag. More... | |
Switch & | mean () |
Return non-const access to the mean flag. More... | |
const word & | meanFieldName () const |
Return const access to the mean field name. More... | |
const Switch & | prime2Mean () const |
Return const access to the prime-squared mean flag. More... | |
Switch & | prime2Mean () |
Return non-const access to the prime-squared mean flag. More... | |
const word & | prime2MeanFieldName () const |
Return const access to the prime-squared mean field name. More... | |
Static Public Attributes | |
static const word | meanExt |
Mean average. More... | |
static const word | prime2MeanExt |
Prime-squared average. More... | |
Helper class to describe what form of averaging to apply. A set will be applied to each base field in Foam::fieldAverage, of the form:
{ mean on; // (default = on) prime2Mean on; // (default = off) }
Definition at line 66 of file fieldAverageItem.H.
fieldAverageItem | ( | ) |
Construct null.
Definition at line 43 of file fieldAverageItem.C.
Referenced by fieldAverageItem::clone(), and fieldAverageItem::iNew::operator()().
fieldAverageItem | ( | const fieldAverage & | fa, |
Istream & | is | ||
) |
Construct from Istream for given fieldAverage.
Definition at line 32 of file fieldAverageItemIO.C.
References IOstream::check(), Tuple2< Type1, Type2 >::first(), IOobject::group(), IOobject::groupName(), dictionary::lookupOrDefault(), fieldAverage::mean_, fieldAverageItem::meanExt, IOobject::member(), fieldAverage::prime2Mean_, fieldAverageItem::prime2MeanExt, Tuple2< Type1, Type2 >::second(), fieldAverage::window_, and fieldAverage::windowName_.
|
default |
Copy constructor.
~fieldAverageItem | ( | ) |
Destructor.
Definition at line 55 of file fieldAverageItem.C.
|
inline |
Clone function.
Definition at line 111 of file fieldAverageItem.H.
References fieldAverageItem::fieldAverageItem().
|
inline |
Return const access to the field name.
Definition at line 145 of file fieldAverageItem.H.
|
inline |
Return const access to the mean flag.
Definition at line 151 of file fieldAverageItem.H.
|
inline |
Return non-const access to the mean flag.
Definition at line 157 of file fieldAverageItem.H.
|
inline |
Return const access to the mean field name.
Definition at line 163 of file fieldAverageItem.H.
|
inline |
Return const access to the prime-squared mean flag.
Definition at line 169 of file fieldAverageItem.H.
|
inline |
Return non-const access to the prime-squared mean flag.
Definition at line 175 of file fieldAverageItem.H.
|
inline |
Return const access to the prime-squared mean field name.
Definition at line 181 of file fieldAverageItem.H.
|
static |
Mean average.
Definition at line 93 of file fieldAverageItem.H.
Referenced by fieldAverageItem::fieldAverageItem().
|
static |
Prime-squared average.
Definition at line 96 of file fieldAverageItem.H.
Referenced by fieldAverageItem::fieldAverageItem().