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:

[legend]

List of all members.

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 &)

---

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
    }

Source files

• fieldAverageItem.H
• fieldAverageItem.C
• fieldAverageItemIO.C

Definition at line 65 of file fieldAverageItem.H.

---

Member Enumeration Documentation

enum baseType

Enumeration defining the averaging base type.

Enumerator:

ITER
TIME

Definition at line 72 of file fieldAverageItem.H.

---

Constructor & Destructor Documentation

fieldAverageItem

(

)

Construct null.

Definition at line 35 of file fieldAverageItem.C.

fieldAverageItem

(

Istream &

is

)

Construct from Istream.

Definition at line 24 of file fieldAverageItemIO.C.

References IOstream::check(), and dictionary::null.

Here is the call graph for this function:

fieldAverageItem

(

const fieldAverageItem &

faItem

)

Construct as copy.

Definition at line 44 of file fieldAverageItem.C.

~fieldAverageItem

(

)

Definition at line 55 of file fieldAverageItem.C.

---

Member Function Documentation

const word& fieldName

(

)

const [inline]

Return const access to the field name.

Definition at line 123 of file fieldAverageItem.H.

const Switch& mean

(

)

const [inline]

Return const access to the mean flag.

Definition at line 129 of file fieldAverageItem.H.

const Switch& prime2Mean

(

)

const [inline]

Return const access to the prime-squared mean flag.

Definition at line 135 of file fieldAverageItem.H.

const word base

(

)

const [inline]

Return averaging base type name.

Definition at line 141 of file fieldAverageItem.H.

Switch ITERBase

(

)

const [inline]

Return true if base is ITER.

Definition at line 147 of file fieldAverageItem.H.

Switch timeBase

(

)

const [inline]

Return true if base is time.

Definition at line 153 of file fieldAverageItem.H.

References fieldAverageItem::ITER.

void operator=

(

const fieldAverageItem &

rhs

)

Definition at line 61 of file fieldAverageItem.C.

---

Friends And Related Function Documentation

bool operator==	(	const fieldAverageItem &	a,
		const fieldAverageItem &	b
	)			[friend]

Definition at line 166 of file fieldAverageItem.H.

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

Definition at line 179 of file fieldAverageItem.H.

Istream& operator>>	(	Istream &	,
		fieldAverageItem &
	)			[friend]

Ostream& operator<<	(	Ostream &	,
		const fieldAverageItem &
	)			[friend]

---

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

• src/postProcessing/functionObjects/field/fieldAverage/fieldAverageItem/fieldAverageItem.H
• src/postProcessing/functionObjects/field/fieldAverage/fieldAverageItem/fieldAverageItem.C
• src/postProcessing/functionObjects/field/fieldAverage/fieldAverageItem/fieldAverageItemIO.C