FieldField< Field, Type > Class Template Reference

Generic field type. More...

Inheritance diagram for FieldField< Field, Type >:

[legend]

Collaboration diagram for FieldField< Field, Type >:

[legend]

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

---

Detailed Description

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

Generic field type.

Source files

• FieldField.H
• FieldField.C

Definition at line 69 of file FieldField.H.

---

Member Typedef Documentation

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 78 of file FieldField.H.

---

Constructor & Destructor Documentation

FieldField

(

)

[inline]

Construct null.

Used for temporary fields which are initialised after construction

Definition at line 111 of file FieldField.C.

FieldField

(

const label

size

)

[inline, explicit]

Construct given size.

Used for temporary fields which are initialised after construction

Definition at line 118 of file FieldField.C.

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

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 126 of file FieldField.C.

FieldField

(

const FieldField< Field, Type > &

f

)

[inline]

Construct as copy.

Definition at line 141 of file FieldField.C.

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

Construct as copy or re-use as specified.

Definition at line 149 of file FieldField.C.

FieldField

(

const PtrList< Field< Type > > &

tl

)

[inline]

Construct as copy of a PtrList<Field, Type>.

Definition at line 157 of file FieldField.C.

FieldField

(

Istream &

is

)

[inline]

Construct as copy of tmp<FieldField>.

Construct from Istream

Definition at line 180 of file FieldField.C.

References refCount::resetRefCount(), and tf.

Here is the call graph for this function:

---

Member Function Documentation

tmp< FieldField< Field, Type > > clone

(

)

const [inline]

Clone.

Definition at line 187 of file FieldField.C.

tmp< FieldField< Field, Type > > NewCalculatedType

(

const FieldField< Field, Type2 > &

ff

)

[inline, static]

Return a pointer to a new calculatedFvPatchFieldField created on.

freestore without setting patchField values

Definition at line 197 of file FieldField.C.

void negate

(

)

[inline]

Negate this field.

Definition at line 219 of file FieldField.C.

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

(

const direction

d

)

const [inline]

Return a component field of the field.

Definition at line 231 of file FieldField.C.

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

Replace a component field of the field.

Definition at line 249 of file FieldField.C.

Referenced by GeometricField< Type, PatchField, GeoMesh >::max(), and GeometricField< Type, PatchField, GeoMesh >::replace().

Here is the caller graph for this function:

void replace	(	const direction	d,
		const cmptType &	s
	)			[inline]

Replace a component field of the field.

Definition at line 263 of file FieldField.C.

References PtrList< Field< Type > >::operator[](), and Field< Type >::replace().

Here is the call graph for this function:

tmp< FieldField< Field, Type > > T

(

)

const [inline]

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

Definition at line 276 of file FieldField.C.

References PtrList< Field< Type > >::operator[](), and Field< Type >::replace().

Here is the call graph for this function:

void operator=

(

const FieldField< Field, Type > &

f

)

[inline]

Reimplemented in GeometricBoundaryField.

Definition at line 291 of file FieldField.C.

void operator=

(

const tmp< FieldField< Field, Type > > &

)

void operator=

(

const Type &

t

)

[inline]

Reimplemented in GeometricBoundaryField.

Definition at line 330 of file FieldField.C.

void operator+=

(

const FieldField< Field, Type > &

f

)

[inline]

Definition at line 369 of file FieldField.C.

void operator+=

(

const tmp< FieldField< Field, Type > > &

tf

)

[inline]

Definition at line 369 of file FieldField.C.

void operator-=

(

const FieldField< Field, Type > &

f

)

[inline]

Definition at line 370 of file FieldField.C.

void operator-=

(

const tmp< FieldField< Field, Type > > &

tf

)

[inline]

Definition at line 370 of file FieldField.C.

void operator*=

(

const FieldField< Field, scalar > &

f

)

[inline]

Definition at line 371 of file FieldField.C.

void operator*=

(

const tmp< FieldField< Field, scalar > > &

tf

)

[inline]

Definition at line 371 of file FieldField.C.

void operator/=

(

const FieldField< Field, scalar > &

f

)

[inline]

Definition at line 372 of file FieldField.C.

void operator/=

(

const tmp< FieldField< Field, scalar > > &

tf

)

[inline]

Definition at line 372 of file FieldField.C.

void operator+=

(

const Type &

t

)

[inline]

Definition at line 369 of file FieldField.C.

void operator-=

(

const Type &

t

)

[inline]

Definition at line 370 of file FieldField.C.

void operator*=

(

const scalar &

t

)

[inline]

Definition at line 371 of file FieldField.C.

void operator/=

(

const scalar &

t

)

[inline]

Definition at line 372 of file FieldField.C.

---

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