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...
#include <fieldFunctionObjects/fieldAverageItem.H>
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:
{
meanon;
prime2Mean on;
basetime; // iteration
}
Definition at line 70 of file fieldAverageItem.H.
Collaboration diagram for fieldAverageItem:Public Types | |
| enum | baseType { ITER, TIME } |
Enumeration defining the averaging base type. More... | |
Public Member Functions | |
| fieldAverageItem () | |
| Construct null.
| |
| fieldAverageItem (Istream &) | |
| Construct from Istream.
| |
| fieldAverageItem (const fieldAverageItem &) | |
| Construct as copy.
| |
| ~fieldAverageItem () | |
| const word & | fieldName () const |
| Return const access to the field name.
| |
| const Switch & | mean () const |
| Return const access to the mean flag.
| |
| const Switch & | prime2Mean () const |
| Return const access to the prime-squared mean flag.
| |
| const word | base () const |
| Return averaging base type name.
| |
| Switch | ITERBase () const |
| Return true if base is ITER.
| |
| Switch | timeBase () const |
| Return true if base is time.
| |
| void | operator= (const fieldAverageItem &) |
Friends | |
| bool | operator== (const fieldAverageItem &a, const fieldAverageItem &b) |
| bool | operator!= (const fieldAverageItem &a, const fieldAverageItem &b) |
| Istream & | operator>> (Istream &, fieldAverageItem &) |
| Ostream & | operator<< (Ostream &, const fieldAverageItem &) |
| enum baseType |
Enumeration defining the averaging base type.
Definition at line 77 of file fieldAverageItem.H.
| fieldAverageItem | ( | ) |
Construct null.
Definition at line 43 of file fieldAverageItem.C.
| fieldAverageItem | ( | Istream & | is ) |
Construct from Istream.
Definition at line 32 of file fieldAverageItemIO.C.
References IOstream::check(), entry::keyword(), dictionary::lookup(), and dictionary::null.
| fieldAverageItem | ( | const fieldAverageItem & | faItem ) |
Construct as copy.
Definition at line 52 of file fieldAverageItem.C.
| ~fieldAverageItem | ( | ) |
Definition at line 63 of file fieldAverageItem.C.
| const word& fieldName | ( | ) | const [inline]
|
Return const access to the field name.
Definition at line 128 of file fieldAverageItem.H.
| const Switch& mean | ( | ) | const [inline]
|
Return const access to the mean flag.
Definition at line 134 of file fieldAverageItem.H.
| const Switch& prime2Mean | ( | ) | const [inline]
|
Return const access to the prime-squared mean flag.
Definition at line 140 of file fieldAverageItem.H.
| const word base | ( | ) | const [inline]
|
Return averaging base type name.
Definition at line 146 of file fieldAverageItem.H.
| Switch ITERBase | ( | ) | const [inline]
|
Return true if base is ITER.
Definition at line 152 of file fieldAverageItem.H.
References fieldAverageItem::ITER.
| Switch timeBase | ( | ) | const [inline]
|
Return true if base is time.
Definition at line 158 of file fieldAverageItem.H.
References fieldAverageItem::TIME.
| void operator= | ( | const fieldAverageItem & | rhs ) |
Definition at line 69 of file fieldAverageItem.C.
References Foam::abort(), Foam::FatalError, FatalErrorIn, and Foam::nl.
| bool operator== | ( | const fieldAverageItem & | a, |
| const fieldAverageItem & | b | ||
| ) | [friend]
|
Definition at line 171 of file fieldAverageItem.H.
| bool operator!= | ( | const fieldAverageItem & | a, |
| const fieldAverageItem & | b | ||
| ) | [friend]
|
Definition at line 184 of file fieldAverageItem.H.
| Istream& operator>> | ( | Istream & | , |
| fieldAverageItem & | |||
| ) | [friend]
|
| Ostream& operator<< | ( | Ostream & | , |
| const fieldAverageItem & | |||
| ) | [friend]
|
