OpenFOAM logo
Open Source CFD Toolkit

FieldField Class Template Reference

Inheritance diagram for FieldField:

Inheritance graph
[legend]
Collaboration diagram for FieldField:

Collaboration graph
[legend]
List of all members.

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


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> Construct from Istream.
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.
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>
tmp< FieldField< Field, Type > > NewCalculatedType (const FieldField< Field, Type2 > &ff)
 Return a pointer to a new calculatedFvPatchFieldField created on.

Friends

Ostreamoperator (Ostream &, const FieldField< Field, Type > &)
Ostreamoperator (Ostream &, const tmp< FieldField< Field, Type > > &)

Member Typedef Documentation

typedef pTraits<Type>::cmptType cmptType
 

Component type.

Definition at line 91 of file FieldField.H.


Constructor & Destructor Documentation

FieldField  ) 
 

Construct null.

Used for temporary fields which are initialised after construction

FieldField const   label  )  [explicit]
 

Construct given size.

Used for temporary fields which are initialised after construction

FieldField const word ,
const FieldField< Field, Type > & 
 

Construct using the Field sizes from the given FieldField.

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

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> Construct from Istream.


Member Function Documentation

tmp<FieldField<Field, Type> > clone  )  const
 

Clone.

tmp<FieldField<Field, cmptType> > component const   direction  )  const
 

Return a component field of the field.

void negate  ) 
 

Negate this field.

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 141 of file FieldField.H.

void operator *= const scalar &   ) 
 

void operator *= const tmp< FieldField< Field, scalar > > &   ) 
 

void operator *= const FieldField< Field, scalar > &   ) 
 

void operator+= const Type &   ) 
 

void operator+= const tmp< FieldField< Field, Type > > &   ) 
 

void operator+= const FieldField< Field, Type > &   ) 
 

void operator-= const Type &   ) 
 

void operator-= const tmp< FieldField< Field, Type > > &   ) 
 

void operator-= const FieldField< Field, Type > &   ) 
 

void operator/= const scalar &   ) 
 

void operator/= const tmp< FieldField< Field, scalar > > &   ) 
 

void operator/= const FieldField< Field, scalar > &   ) 
 

void operator= const Type &   ) 
 

Reimplemented in GeometricField::GeometricBoundaryField.

void operator= const tmp< FieldField< Field, Type > > &   ) 
 

void operator= const FieldField< Field, Type > &   ) 
 

void replace const   direction,
const FieldField< Field, cmptType > & 
 

Replace a component field of the field.

tmp<FieldField<Field, Type> > T  )  const
 

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


Friends And Related Function Documentation

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

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


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org