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:

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< fieldAverageItemclone () const
 Clone function. More...
 
 ~fieldAverageItem ()
 Destructor. 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...
 

Static Public Attributes

static const word meanExt
 Mean average. More...
 
static const word prime2MeanExt
 Prime-squared average. More...
 

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;   // (default = on)
    prime2Mean      on;   // (default = off)
    base            time; // time or iteration (default = time)
    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 72 of file fieldAverageItem.H.

Constructor & Destructor Documentation

◆ fieldAverageItem() [1/3]

Construct null.

Definition at line 43 of file fieldAverageItem.C.

Referenced by fieldAverageItem::clone(), and fieldAverageItem::iNew::operator()().

Here is the caller graph for this function:

◆ fieldAverageItem() [2/3]

◆ fieldAverageItem() [3/3]

fieldAverageItem ( const fieldAverageItem )
default

Copy constructor.

◆ ~fieldAverageItem()

Destructor.

Definition at line 55 of file fieldAverageItem.C.

Referenced by fieldAverageItem::iNew::operator()().

Here is the caller graph for this function:

Member Function Documentation

◆ clone()

autoPtr<fieldAverageItem> clone ( ) const
inline

Clone function.

Definition at line 117 of file fieldAverageItem.H.

References fieldAverageItem::fieldAverageItem().

Here is the call graph for this function:

◆ fieldName()

const word& fieldName ( ) const
inline

Return const access to the field name.

Definition at line 151 of file fieldAverageItem.H.

◆ mean() [1/2]

const Switch& mean ( ) const
inline

Return const access to the mean flag.

Definition at line 157 of file fieldAverageItem.H.

◆ mean() [2/2]

Switch& mean ( )
inline

Return non-const access to the mean flag.

Definition at line 163 of file fieldAverageItem.H.

◆ meanFieldName()

const word& meanFieldName ( ) const
inline

Return const access to the mean field name.

Definition at line 169 of file fieldAverageItem.H.

◆ prime2Mean() [1/2]

const Switch& prime2Mean ( ) const
inline

Return const access to the prime-squared mean flag.

Definition at line 175 of file fieldAverageItem.H.

◆ prime2Mean() [2/2]

Switch& prime2Mean ( )
inline

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

Definition at line 181 of file fieldAverageItem.H.

◆ prime2MeanFieldName()

const word& prime2MeanFieldName ( ) const
inline

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

Definition at line 187 of file fieldAverageItem.H.

Member Data Documentation

◆ meanExt

const Foam::word meanExt
static

Mean average.

Definition at line 99 of file fieldAverageItem.H.

◆ prime2MeanExt

const Foam::word prime2MeanExt
static

Prime-squared average.

Definition at line 102 of file fieldAverageItem.H.


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