OpenFOAM logo
Open Source CFD Toolkit

GeometricField Class Template Reference

Inheritance diagram for GeometricField:

Inheritance graph
[legend]
Collaboration diagram for GeometricField:

Collaboration graph
[legend]
List of all members.

template<class Type, template< class > class PatchField, class GeoMesh>
class Foam::GeometricField< Type, PatchField, GeoMesh >


Public Types

typedef GeoMesh::Mesh Mesh
typedef Mesh::BoundaryMesh BoundaryMesh
typedef Field< Type >::cmptType cmptType
 Component type.

Public Member Functions

 TypeName ("GeometricField")
 Runtime type information.
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=PatchField< Type >::calculatedType())
 Constructor given IOobject, mesh, dimensions and patch type.
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const wordList &patchFieldTypes)
 Constructor given IOobject, mesh, dimensions and patch types.
 GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=PatchField< Type >::calculatedType())
 Constructor given IOobject, mesh, dimensioned<Type> and patch type.
 GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const wordList &patchFieldTypes)
 Constructor given IOobject, mesh, dimensioned<Type> and patch types.
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &, const PtrList< PatchField< Type > > &)
 Constructor from components.
 GeometricField (const IOobject &, const Mesh &)
 Construct and read.
 GeometricField (const GeometricField< Type, PatchField, GeoMesh > &)
 Construct as copy.
 GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &)
 Construct as copy of tmp<GeometricField> deleting argument Construct as copy resetting IO parameters.
 GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &)
 Construct as copy resetting name.
 GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const word &patchFieldType)
 Construct as copy resetting name Construct as copy resetting IO parameters and patch type.
 GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const wordList &patchFieldTypes)
 Construct as copy resetting IO parameters and boundary types.
virtual ~GeometricField ()
const Meshmesh () const
 Return reference to mesh.
dimensionSetdimensions ()
 Return dimensions.
const dimensionSetdimensions () const
 Return dimensions.
Field< Type > & internalField ()
 Return internal field.
const Field< Type > & internalField () const
 Return internal field.
GeometricBoundaryFieldboundaryField ()
 Return reference to GeometricBoundaryField.
const GeometricBoundaryFieldboundaryField () const
 Return reference to GeometricBoundaryField for const field.
label timeIndex () const
 Return the time index of the field.
void storeOldTimes () const
 Store the old-time fields.
void storeOldTime () const
 Store the old-time field.
label nOldTimes () const
 Return the number of old time fields stored.
const GeometricField< Type,
PatchField, GeoMesh > & 
oldTime () const
 Return old time field.
GeometricField< Type, PatchField,
GeoMesh > & 
oldTime ()
 Return non-const old time field.
void storePrevIter () const
 Store the field as the previous iteration value.
const GeometricField< Type,
PatchField, GeoMesh > & 
prevIter () const
 Return previous iteration field.
void correctBoundaryConditions ()
 Correct boundary field.
bool needReference () const
 Does the field need a reference level for solution.
tmp< GeometricField< cmptType,
PatchField, GeoMesh > > 
component (const direction) const
 Return a component of the field.
dimensioned< Type > average () const
 Calculate and return arithmetic average.
dimensioned< Type > weightedAverage (const scalarField &) const
 Calculate and return weighted average.
bool writeData (Ostream &) const
 WriteData member function required by regIOobject.
tmp< GeometricField< Type,
PatchField, GeoMesh > > 
T () const
 Return transpose (only if it is a tensor field).
void relax (const scalar alpha)
 Relax field (for steady-state solution).
void relax ()
 Relax field (for steady-state solution).
void negate ()
 Negate this field.
void replace (const direction, const GeometricField< cmptType, PatchField, GeoMesh > &)
void max (const dimensioned< Type > &)
void min (const dimensioned< Type > &)
void max (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)
void min (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)
void scale (const GeometricField< Type, PatchField, GeoMesh > &, const GeometricField< Type, PatchField, GeoMesh > &)
void scale (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)
void operator= (const GeometricField< Type, PatchField, GeoMesh > &)
void operator= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
void operator= (const dimensioned< Type > &)
void operator== (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
void operator== (const dimensioned< Type > &)
void operator+= (const GeometricField< Type, PatchField, GeoMesh > &)
void operator+= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
void operator-= (const GeometricField< Type, PatchField, GeoMesh > &)
void operator-= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
void operator *= (const GeometricField< scalar, PatchField, GeoMesh > &)
void operator *= (const tmp< GeometricField< scalar, PatchField, GeoMesh > > &)
void operator/= (const GeometricField< scalar, PatchField, GeoMesh > &)
void operator/= (const tmp< GeometricField< scalar, PatchField, GeoMesh > > &)
void operator+= (const dimensioned< Type > &)
void operator-= (const dimensioned< Type > &)
void operator *= (const dimensioned< scalar > &)
void operator/= (const dimensioned< scalar > &)

Static Public Member Functions

tmp< GeometricField< Type,
PatchField, GeoMesh > > 
New (const IOobject &, const tmp< GeometricField< Type, PatchField, GeoMesh > > &, const dimensionSet &)
 Return a pointer to a GeometricField created by re-using the given.
GeometricField< Type, PatchField,
GeoMesh > & 
null ()
 Return a null geometric field.

Friends

Ostreamoperator (Ostream &, const GeometricField< Type, PatchField, GeoMesh > &)
Ostreamoperator (Ostream &, const tmp< GeometricField< Type, PatchField, GeoMesh > > &)

Member Typedef Documentation

typedef Mesh::BoundaryMesh BoundaryMesh
 

Reimplemented in SlicedGeometricField, SlicedGeometricField< vector, fvPatchField, slicedFvPatchField, volMesh >, and SlicedGeometricField< vector, fvPatchField, slicedFvPatchField, surfaceMesh >.

Definition at line 103 of file GeometricField.H.

typedef Field<Type>::cmptType cmptType
 

Component type.

Reimplemented from Field.

Definition at line 270 of file GeometricField.H.

typedef GeoMesh::Mesh Mesh
 

Reimplemented in SlicedGeometricField, SlicedGeometricField< vector, fvPatchField, slicedFvPatchField, volMesh >, and SlicedGeometricField< vector, fvPatchField, slicedFvPatchField, surfaceMesh >.

Definition at line 102 of file GeometricField.H.


Constructor & Destructor Documentation

GeometricField const IOobject ,
const Mesh ,
const dimensionSet ,
const word patchFieldType = PatchField< Type >::calculatedType()
 

Constructor given IOobject, mesh, dimensions and patch type.

This allocates storage for the field but not values. Used only within this class to create TEMPORARY variables

GeometricField const IOobject ,
const Mesh ,
const dimensionSet ,
const wordList patchFieldTypes
 

Constructor given IOobject, mesh, dimensions and patch types.

This allocates storage for the field but not values. Used only within this class to create TEMPORARY variables

GeometricField const IOobject ,
const Mesh ,
const dimensioned< Type > &  ,
const word patchFieldType = PatchField< Type >::calculatedType()
 

Constructor given IOobject, mesh, dimensioned<Type> and patch type.

GeometricField const IOobject ,
const Mesh ,
const dimensioned< Type > &  ,
const wordList patchFieldTypes
 

Constructor given IOobject, mesh, dimensioned<Type> and patch types.

GeometricField const IOobject ,
const Mesh ,
const dimensionSet ,
const Field< Type > &  ,
const PtrList< PatchField< Type > > & 
 

Constructor from components.

GeometricField const IOobject ,
const Mesh
 

Construct and read.

GeometricField const GeometricField< Type, PatchField, GeoMesh > &   ) 
 

Construct as copy.

GeometricField const IOobject ,
const GeometricField< Type, PatchField, GeoMesh > & 
 

Construct as copy of tmp<GeometricField> deleting argument Construct as copy resetting IO parameters.

GeometricField const word newName,
const GeometricField< Type, PatchField, GeoMesh > & 
 

Construct as copy resetting name.

GeometricField const IOobject ,
const GeometricField< Type, PatchField, GeoMesh > &  ,
const word patchFieldType
 

Construct as copy resetting name Construct as copy resetting IO parameters and patch type.

GeometricField const IOobject ,
const GeometricField< Type, PatchField, GeoMesh > &  ,
const wordList patchFieldTypes
 

Construct as copy resetting IO parameters and boundary types.

virtual ~GeometricField  )  [virtual]
 


Member Function Documentation

dimensioned<Type> average  )  const
 

Calculate and return arithmetic average.

const GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField & boundaryField  )  const [inline]
 

Return reference to GeometricBoundaryField for const field.

Definition at line 82 of file GeometricFieldI.H.

References Foam::label.

GeometricBoundaryField& boundaryField  ) 
 

Return reference to GeometricBoundaryField.

tmp<GeometricField<cmptType, PatchField, GeoMesh> > component const   direction  )  const
 

Return a component of the field.

Reimplemented from Field.

void correctBoundaryConditions  ) 
 

Correct boundary field.

const dimensionSet & dimensions  )  const [inline]
 

Return dimensions.

Definition at line 65 of file GeometricFieldI.H.

dimensionSet & dimensions  )  [inline]
 

Return dimensions.

Definition at line 57 of file GeometricFieldI.H.

const Field< Type > & internalField  )  const [inline]
 

Return internal field.

Definition at line 73 of file GeometricFieldI.H.

Field<Type>& internalField  ) 
 

Return internal field.

void max const GeometricField< Type, PatchField, GeoMesh > &  ,
const dimensioned< Type > & 
 

void max const dimensioned< Type > &   ) 
 

const GeometricField< Type, PatchField, GeoMesh >::Mesh & mesh  )  const [inline]
 

Return reference to mesh.

Definition at line 48 of file GeometricFieldI.H.

void min const GeometricField< Type, PatchField, GeoMesh > &  ,
const dimensioned< Type > & 
 

void min const dimensioned< Type > &   ) 
 

bool needReference  )  const
 

Does the field need a reference level for solution.

void negate  ) 
 

Negate this field.

Reimplemented from Field.

tmp<GeometricField<Type, PatchField, GeoMesh> > New const IOobject ,
const tmp< GeometricField< Type, PatchField, GeoMesh > > &  ,
const dimensionSet
[static]
 

Return a pointer to a GeometricField created by re-using the given.

tmp<GeometricField>

label nOldTimes  )  const
 

Return the number of old time fields stored.

GeometricField<Type, PatchField, GeoMesh>& null  )  [static]
 

Return a null geometric field.

Reimplemented from Field.

GeometricField<Type, PatchField, GeoMesh>& oldTime  ) 
 

Return non-const old time field.

(Not a good idea but it is used for sub-cycling)

const GeometricField<Type, PatchField, GeoMesh>& oldTime  )  const
 

Return old time field.

Referenced by subCycle::subCycle().

void operator *= const dimensioned< scalar > &   ) 
 

void operator *= const tmp< GeometricField< scalar, PatchField, GeoMesh > > &   ) 
 

void operator *= const GeometricField< scalar, PatchField, GeoMesh > &   ) 
 

void operator+= const dimensioned< Type > &   ) 
 

void operator+= const tmp< GeometricField< Type, PatchField, GeoMesh > > &   ) 
 

void operator+= const GeometricField< Type, PatchField, GeoMesh > &   ) 
 

void operator-= const dimensioned< Type > &   ) 
 

void operator-= const tmp< GeometricField< Type, PatchField, GeoMesh > > &   ) 
 

void operator-= const GeometricField< Type, PatchField, GeoMesh > &   ) 
 

void operator/= const dimensioned< scalar > &   ) 
 

void operator/= const tmp< GeometricField< scalar, PatchField, GeoMesh > > &   ) 
 

void operator/= const GeometricField< scalar, PatchField, GeoMesh > &   ) 
 

void operator= const dimensioned< Type > &   ) 
 

void operator= const tmp< GeometricField< Type, PatchField, GeoMesh > > &   ) 
 

void operator= const GeometricField< Type, PatchField, GeoMesh > &   ) 
 

void operator== const dimensioned< Type > &   ) 
 

void operator== const tmp< GeometricField< Type, PatchField, GeoMesh > > &   ) 
 

const GeometricField<Type, PatchField, GeoMesh>& prevIter  )  const
 

Return previous iteration field.

void relax  ) 
 

Relax field (for steady-state solution).

alpha is read from controlDict

void relax const scalar  alpha  ) 
 

Relax field (for steady-state solution).

alpha = 1 : no relaxation alpha < 1 : relaxation alpha = 0 : do nothing

void replace const   direction,
const GeometricField< cmptType, PatchField, GeoMesh > & 
 

void scale const GeometricField< Type, PatchField, GeoMesh > &  ,
const dimensioned< Type > & 
 

void scale const GeometricField< Type, PatchField, GeoMesh > &  ,
const GeometricField< Type, PatchField, GeoMesh > & 
 

void storeOldTime  )  const
 

Store the old-time field.

void storeOldTimes  )  const
 

Store the old-time fields.

void storePrevIter  )  const
 

Store the field as the previous iteration value.

tmp<GeometricField<Type, PatchField, GeoMesh> > T  )  const
 

Return transpose (only if it is a tensor field).

Reimplemented from Field.

label timeIndex  )  const [inline]
 

Return the time index of the field.

Definition at line 90 of file GeometricFieldI.H.

TypeName "GeometricField< Type, PatchField, GeoMesh >"   ) 
 

Runtime type information.

dimensioned<Type> weightedAverage const scalarField  )  const
 

Calculate and return weighted average.

bool writeData Ostream  )  const [virtual]
 

WriteData member function required by regIOobject.

Implements regIOobject.


Friends And Related Function Documentation

Ostream& operator Ostream ,
const tmp< GeometricField< Type, PatchField, GeoMesh > > & 
[friend]
 

Ostream& operator Ostream ,
const GeometricField< Type, PatchField, GeoMesh > & 
[friend]
 


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