OpenFOAM logo
Open Source CFD Toolkit

DimensionedField Class Template Reference

Inheritance diagram for DimensionedField:

Inheritance graph
[legend]
Collaboration diagram for DimensionedField:

Collaboration graph
[legend]
List of all members.

template<class Type, class GeoMesh>
class Foam::DimensionedField< Type, GeoMesh >


Public Types

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

Public Member Functions

 TypeName ("DimensionedField")
 Runtime type information.
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const Field< Type > &)
 Construct from components.
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &)
 Construct from components.
 DimensionedField (const IOobject &, const Mesh &mesh, const word &fieldDictEntry="value")
 Construct from Istream.
 DimensionedField (const DimensionedField &)
 Construct as copy.
 ~DimensionedField ()
const Meshmesh () const
 Return mesh.
const dimensionSetdimensions () const
 Return dimensions.
dimensionSetdimensions ()
 Return non-const access to dimensions.
tmp< DimensionedField< cmptType,
GeoMesh > > 
component (const direction) const
 Return a component field of the field.
void replace (const direction, const DimensionedField< cmptType, GeoMesh > &)
 Replace a component field of the field.
tmp< DimensionedField< Type,
GeoMesh > > 
T () const
 Return the field transpose (only defined for second rank tensors).
bool writeData (Ostream &, const word &fieldDictEntry) const
bool writeData (Ostream &) const
 Pure virtual writaData function.
void operator= (const DimensionedField< Type, GeoMesh > &)
void operator= (const tmp< DimensionedField< Type, GeoMesh > > &)
void operator= (const dimensioned< Type > &)
void operator+= (const DimensionedField< Type, GeoMesh > &)
void operator+= (const tmp< DimensionedField< Type, GeoMesh > > &)
void operator-= (const DimensionedField< Type, GeoMesh > &)
void operator-= (const tmp< DimensionedField< Type, GeoMesh > > &)
void operator *= (const DimensionedField< scalar, GeoMesh > &)
void operator *= (const tmp< DimensionedField< scalar, GeoMesh > > &)
void operator/= (const DimensionedField< scalar, GeoMesh > &)
void operator/= (const tmp< DimensionedField< scalar, GeoMesh > > &)
void operator+= (const dimensioned< Type > &)
void operator-= (const dimensioned< Type > &)
void operator *= (const dimensioned< scalar > &)
void operator/= (const dimensioned< scalar > &)

Friends

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

Member Typedef Documentation

typedef Field<Type>::cmptType cmptType
 

Component type.

Reimplemented from Field.

Definition at line 91 of file DimensionedField.H.

typedef GeoMesh::Mesh Mesh
 

Definition at line 90 of file DimensionedField.H.


Constructor & Destructor Documentation

DimensionedField const IOobject ,
const Mesh mesh,
const dimensionSet ,
const Field< Type > & 
 

Construct from components.

DimensionedField const IOobject ,
const Mesh mesh,
const dimensionSet
 

Construct from components.

Used for temporary fields which are initialised after construction

DimensionedField const IOobject ,
const Mesh mesh,
const word fieldDictEntry = "value"
 

Construct from Istream.

DimensionedField const DimensionedField< Type, GeoMesh > &   ) 
 

Construct as copy.

~DimensionedField  ) 
 


Member Function Documentation

tmp<DimensionedField<cmptType, GeoMesh> > component const   direction  )  const
 

Return a component field of the field.

Reimplemented from Field.

dimensionSet & dimensions  )  [inline]
 

Return non-const access to dimensions.

Definition at line 54 of file DimensionedFieldI.H.

const dimensionSet & dimensions  )  const [inline]
 

Return dimensions.

Definition at line 48 of file DimensionedFieldI.H.

const GeoMesh::Mesh & mesh  )  const [inline]
 

Return mesh.

Definition at line 41 of file DimensionedFieldI.H.

void operator *= const dimensioned< scalar > &   ) 
 

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

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

void operator+= const dimensioned< Type > &   ) 
 

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

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

void operator-= const dimensioned< Type > &   ) 
 

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

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

void operator/= const dimensioned< scalar > &   ) 
 

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

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

void operator= const dimensioned< Type > &   ) 
 

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

void operator= const DimensionedField< Type, GeoMesh > &   ) 
 

void replace const   direction,
const DimensionedField< cmptType, GeoMesh > & 
 

Replace a component field of the field.

tmp<DimensionedField<Type, GeoMesh> > T  )  const
 

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

Reimplemented from Field.

TypeName "DimensionedField< Type, GeoMesh >"   ) 
 

Runtime type information.

bool writeData Ostream  )  const [virtual]
 

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

bool writeData Ostream ,
const word fieldDictEntry
const
 


Friends And Related Function Documentation

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

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


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