Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
fieldAverageItem Class Reference

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...

Collaboration diagram for fieldAverageItem:
Collaboration graph
[legend]

Public Types

enum  baseType { ITER, TIME }
 Enumeration defining the averaging base type. More...
 

Public Member Functions

 fieldAverageItem ()
 Construct null. More...
 
 fieldAverageItem (Istream &)
 Construct from Istream. More...
 
 fieldAverageItem (const fieldAverageItem &)
 Construct as copy. More...
 
 ~fieldAverageItem ()
 Destructor. More...
 
const Switchactive () const
 Return const access to the active flag. More...
 
Switchactive ()
 Return non-const access to the active flag. More...
 
const wordfieldName () const
 Return const access to the field name. More...
 
const Switchmean () const
 Return const access to the mean flag. More...
 
Switchmean ()
 Return non-const access to the mean flag. More...
 
const wordmeanFieldName () const
 Return const access to the mean field name. More...
 
const Switchprime2Mean () const
 Return const access to the prime-squared mean flag. More...
 
Switchprime2Mean ()
 Return non-const access to the prime-squared mean flag. More...
 
const wordprime2MeanFieldName () const
 Return const access to the prime-squared mean field name. More...
 
const word base () const
 Return averaging base type name. More...
 
Switch iterBase () const
 Return true if base is ITER. More...
 
Switch timeBase () const
 Return true if base is time. More...
 
scalar window () const
 
const wordwindowName () const
 
void operator= (const fieldAverageItem &)
 

Static Public Attributes

static const word EXT_MEAN = "Mean"
 Mean average. More...
 
static const word EXT_PRIME2MEAN = "Prime2Mean"
 Prime-squared average. More...
 

Friends

bool operator== (const fieldAverageItem &a, const fieldAverageItem &b)
 
bool operator!= (const fieldAverageItem &a, const fieldAverageItem &b)
 
Istreamoperator>> (Istream &, fieldAverageItem &)
 
Ostreamoperator<< (Ostream &, const fieldAverageItem &)
 

Detailed Description

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;
    prime2Mean      on;
    base            time; // iteration
    window          200;  // optional averaging window
    windowName      w1;   // optional window name (default = "")
}

The averaging window corresponds to the averaging interval (iters or time) If not specified, the averaging is over 'all iters/time'

Source files

Definition at line 74 of file fieldAverageItem.H.

Member Enumeration Documentation

enum baseType

Enumeration defining the averaging base type.

Enumerator
ITER 
TIME 

Definition at line 89 of file fieldAverageItem.H.

Constructor & Destructor Documentation

Construct null.

Definition at line 54 of file fieldAverageItem.C.

fieldAverageItem ( const fieldAverageItem faItem)

Construct as copy.

Definition at line 68 of file fieldAverageItem.C.

Destructor.

Definition at line 84 of file fieldAverageItem.C.

Member Function Documentation

const Switch& active ( ) const
inline

Return const access to the active flag.

Definition at line 154 of file fieldAverageItem.H.

Switch& active ( )
inline

Return non-const access to the active flag.

Definition at line 160 of file fieldAverageItem.H.

const word& fieldName ( ) const
inline

Return const access to the field name.

Definition at line 166 of file fieldAverageItem.H.

const Switch& mean ( ) const
inline

Return const access to the mean flag.

Definition at line 172 of file fieldAverageItem.H.

Switch& mean ( )
inline

Return non-const access to the mean flag.

Definition at line 178 of file fieldAverageItem.H.

const word& meanFieldName ( ) const
inline

Return const access to the mean field name.

Definition at line 184 of file fieldAverageItem.H.

const Switch& prime2Mean ( ) const
inline

Return const access to the prime-squared mean flag.

Definition at line 190 of file fieldAverageItem.H.

Switch& prime2Mean ( )
inline

Return non-const access to the prime-squared mean flag.

Definition at line 196 of file fieldAverageItem.H.

const word& prime2MeanFieldName ( ) const
inline

Return const access to the prime-squared mean field name.

Definition at line 202 of file fieldAverageItem.H.

const word base ( ) const
inline

Return averaging base type name.

Definition at line 208 of file fieldAverageItem.H.

Switch iterBase ( ) const
inline

Return true if base is ITER.

Definition at line 214 of file fieldAverageItem.H.

References fieldAverageItem::ITER.

Switch timeBase ( ) const
inline

Return true if base is time.

Definition at line 220 of file fieldAverageItem.H.

References fieldAverageItem::TIME.

scalar window ( ) const
inline

Definition at line 225 of file fieldAverageItem.H.

const word& windowName ( ) const
inline

Definition at line 230 of file fieldAverageItem.H.

References fieldAverageItem::operator=().

Here is the call graph for this function:

void operator= ( const fieldAverageItem rhs)

Definition at line 90 of file fieldAverageItem.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, and Foam::nl.

Referenced by fieldAverageItem::windowName().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

bool operator== ( const fieldAverageItem a,
const fieldAverageItem b 
)
friend

Definition at line 244 of file fieldAverageItem.H.

bool operator!= ( const fieldAverageItem a,
const fieldAverageItem b 
)
friend

Definition at line 261 of file fieldAverageItem.H.

Istream& operator>> ( Istream ,
fieldAverageItem  
)
friend
Ostream& operator<< ( Ostream ,
const fieldAverageItem  
)
friend

Member Data Documentation

const word EXT_MEAN = "Mean"
static

Mean average.

Definition at line 83 of file fieldAverageItem.H.

Referenced by fieldAverageItem::fieldAverageItem(), and Foam::operator>>().

const word EXT_PRIME2MEAN = "Prime2Mean"
static

Prime-squared average.

Definition at line 86 of file fieldAverageItem.H.

Referenced by fieldAverageItem::fieldAverageItem(), and Foam::operator>>().


The documentation for this class was generated from the following files: