FieldField< Field, Type > Class Template Reference

Generic field type. More...

#include <OpenFOAM/FieldField.H>

---

Detailed Description

template<template< class > class Field, class Type>
class Foam::FieldField< Field, Type >

Generic field type.

Source files

• src/OpenFOAM/fields/FieldFields/FieldField/FieldField.H
• src/OpenFOAM/fields/FieldFields/FieldField/FieldField.C

Definition at line 74 of file FieldField.H.

Inheritance diagram for FieldField< Field, Type >:

Collaboration diagram for FieldField< Field, Type >:

List of all members.

Public Types
typedef pTraits< Type >::cmptType	cmptType
	Component type.
Public Member Functions
	FieldField ()
	Construct null.
	FieldField (const label)
	Construct given size.
	FieldField (const word &, const FieldField< Field, Type > &)
	Construct using the Field sizes from the given FieldField.
	FieldField (const FieldField< Field, Type > &)
	Construct as copy.
	FieldField (FieldField< Field, Type > &, bool reUse)
	Construct as copy or re-use as specified.
	FieldField (const PtrList< Field< Type > > &)
	Construct as copy of a PtrList<Field, Type>
	FieldField (Istream &)
	Construct as copy of tmp<FieldField>
tmp< FieldField< Field, Type > >	clone () const
	Clone.
void	negate ()
	Negate this field.
tmp< FieldField< Field, cmptType > >	component (const direction) const
	Return a component field of the field.
void	replace (const direction, const FieldField< Field, cmptType > &)
	Replace a component field of the field.
void	replace (const direction, const cmptType &)
	Replace a component field of the field.
tmp< FieldField< Field, Type > >	T () const
	Return the field transpose (only defined for second rank tensors)
void	operator= (const FieldField< Field, Type > &)
void	operator= (const tmp< FieldField< Field, Type > > &)
void	operator= (const Type &)
void	operator+= (const FieldField< Field, Type > &)
void	operator+= (const tmp< FieldField< Field, Type > > &)
void	operator-= (const FieldField< Field, Type > &)
void	operator-= (const tmp< FieldField< Field, Type > > &)
void	operator*= (const FieldField< Field, scalar > &)
void	operator*= (const tmp< FieldField< Field, scalar > > &)
void	operator/= (const FieldField< Field, scalar > &)
void	operator/= (const tmp< FieldField< Field, scalar > > &)
void	operator+= (const Type &)
void	operator-= (const Type &)
void	operator*= (const scalar &)
void	operator/= (const scalar &)
Static Public Member Functions
template<class Type2 >
static tmp< FieldField< Field, Type > >	NewCalculatedType (const FieldField< Field, Type2 > &ff)
	Return a pointer to a new calculatedFvPatchFieldField created on.
Friends
Ostream &	operator (Ostream &, const FieldField< Field, Type > &)
Ostream &	operator (Ostream &, const tmp< FieldField< Field, Type > > &)

---

Member Typedef Documentation

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 83 of file FieldField.H.

---

Constructor & Destructor Documentation

FieldField

(

)

Construct null.

Used for temporary fields which are initialised after construction

Definition at line 118 of file FieldField.C.

FieldField

(

const label

size  )

[explicit]

Construct given size.

Used for temporary fields which are initialised after construction

Definition at line 125 of file FieldField.C.

FieldField	(	const word &	type,
		const FieldField< Field, Type > &	ff
	)

Construct using the Field sizes from the given FieldField.

and the given Field type. Used for temporary fields which are initialised after construction

Definition at line 133 of file FieldField.C.

References forAll.

FieldField

(

const FieldField< Field, Type > &

f  )

Construct as copy.

Definition at line 148 of file FieldField.C.

FieldField	(	FieldField< Field, Type > &	f,
		bool	reUse
	)

Construct as copy or re-use as specified.

Definition at line 156 of file FieldField.C.

FieldField

(

const PtrList< Field< Type > > &

tl  )

Construct as copy of a PtrList<Field, Type>

Definition at line 164 of file FieldField.C.

FieldField

(

Istream &

is  )

Construct as copy of tmp<FieldField>

Construct from Istream

Definition at line 187 of file FieldField.C.

---

Member Function Documentation

tmp< FieldField< Field, Type > > clone

(

)

const

Clone.

Definition at line 194 of file FieldField.C.

tmp< FieldField< Field, Type > > NewCalculatedType

(

const FieldField< Field, Type2 > &

ff  )

[static]

Return a pointer to a new calculatedFvPatchFieldField created on.

freestore without setting patchField values

Definition at line 204 of file FieldField.C.

References forAll, PtrList< Field< Type > >::set(), and PtrList< Field< Type > >::size().

void negate

(

)

Negate this field.

Definition at line 226 of file FieldField.C.

References forAll.

tmp< FieldField< Field, typename FieldField< Field, Type >::cmptType > > component

(

const direction

d  )

const

Return a component field of the field.

Definition at line 238 of file FieldField.C.

References component(), and d.

void replace	(	const direction	d,
		const FieldField< Field, cmptType > &	sf
	)

Replace a component field of the field.

Definition at line 256 of file FieldField.C.

References forAll.

void replace	(	const direction	d,
		const cmptType &	s
	)

Replace a component field of the field.

Definition at line 270 of file FieldField.C.

References forAll.

tmp< FieldField< Field, Type > > T

(

)

const

Return the field transpose (only defined for second rank tensors)

Definition at line 283 of file FieldField.C.

References T.

void operator=

(

const FieldField< Field, Type > &

f  )

Reimplemented in GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField.

Definition at line 298 of file FieldField.C.

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

Referenced by GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField::operator=().

void operator=

(

const tmp< FieldField< Field, Type > > &

)

void operator=

(

const Type &

t  )

Reimplemented in GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField.

Definition at line 337 of file FieldField.C.

References forAll.

void operator+=

(

const FieldField< Field, Type > &

)

void operator+=

(

const tmp< FieldField< Field, Type > > &

)

void operator-=

(

const FieldField< Field, Type > &

)

void operator-=

(

const tmp< FieldField< Field, Type > > &

)

void operator*=

(

const FieldField< Field, scalar > &

)

void operator*=

(

const tmp< FieldField< Field, scalar > > &

)

void operator/=

(

const FieldField< Field, scalar > &

)

void operator/=

(

const tmp< FieldField< Field, scalar > > &

)

void operator+=

(

const Type &

)

void operator-=

(

const Type &

)

void operator*=

(

const scalar &

)

void operator/=

(

const scalar &

)

---

Friends And Related Function Documentation

Ostream& operator	(	Ostream &	,
		const FieldField< Field, Type > &
	)		[friend]

Ostream& operator	(	Ostream &	,
		const tmp< FieldField< Field, Type > > &
	)		[friend]

---

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

• src/OpenFOAM/fields/FieldFields/FieldField/FieldField.H
• src/OpenFOAM/fields/FieldFields/FieldField/FieldField.C