AverageIOField< Type > Class Template Reference

A primitive field + average with IO. More...

#include <finiteVolume/AverageIOField.H>

---

Detailed Description

template<class Type>
class Foam::AverageIOField< Type >

A primitive field + average with IO.

Source files

• src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/AverageIOField.H
• src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/AverageIOField.C

Definition at line 51 of file AverageIOField.H.

Inheritance diagram for AverageIOField< Type >:

Collaboration diagram for AverageIOField< Type >:

List of all members.

Public Member Functions
	TypeName ("AverageField")
	AverageIOField (const IOobject &)
	Construct from IOobject.
	AverageIOField (const IOobject &, const label size)
	Construct from IOobject and size (does not set values)
	AverageIOField (const IOobject &, const Type &average, const Field< Type > &)
	Construct from components.
const Type &	average () const
Type &	average ()
bool	writeData (Ostream &os) const
	Pure virtual writaData function.

---

Constructor & Destructor Documentation

AverageIOField

(

const IOobject &

io  )

Construct from IOobject.

Definition at line 32 of file AverageIOField.C.

AverageIOField	(	const IOobject &	io,
		const label	size
	)

Construct from IOobject and size (does not set values)

Definition at line 46 of file AverageIOField.C.

AverageIOField	(	const IOobject &	io,
		const Type &	average,
		const Field< Type > &	f
	)

Construct from components.

Definition at line 59 of file AverageIOField.C.

References IOobject::readOpt().

---

Member Function Documentation

TypeName

(

"AverageField"

)

const Type& average

(

)

const [inline]

Definition at line 93 of file AverageIOField.H.

Referenced by timeVaryingMappedFixedValueFvPatchField< Type >::checkTable().

Type& average

(

)

[inline]

Definition at line 98 of file AverageIOField.H.

bool writeData

(

Ostream &

)

const [virtual]

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 80 of file AverageIOField.C.

References IOstream::good().

---

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

• src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/AverageIOField.H
• src/finiteVolume/fields/fvPatchFields/derived/timeVaryingMappedFixedValue/AverageIOField.C