OpenFOAM logo
The Open Source CFD Toolbox
  Source Guide OpenCFD Solutions Contact OpenFOAM

DimensionedField< Type, GeoMesh > Class Template Reference

Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a reference to it is maintained. More...

Inheritance diagram for DimensionedField< Type, GeoMesh >:

Inheritance graph
[legend]
Collaboration diagram for DimensionedField< Type, GeoMesh >:

Collaboration graph
[legend]

List of all members.


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 dimensioned< Type > &)
 Construct from components.
 DimensionedField (const IOobject &, const Mesh &mesh, const word &fieldDictEntry="value")
 Construct from Istream.
void readField (const dictionary &fieldDict, const word &fieldDictEntry="value")
 DimensionedField (const DimensionedField< Type, GeoMesh > &)
 Construct as copy.
 DimensionedField (DimensionedField< Type, GeoMesh > &, bool reUse)
 Construct as copy or re-use as specified.
 DimensionedField (const Xfer< DimensionedField< Type, GeoMesh > > &)
 Construct by transferring the DimensionedField.
 DimensionedField (const IOobject &, const DimensionedField< Type, GeoMesh > &)
 Construct as copy of tmp<DimensionedField> deleting argument.
 DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh > &)
 Construct as copy resetting name.
 DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &, bool reUse)
 Construct as copy resetting name and re-use as specified.
 DimensionedField (const word &newName, const Xfer< DimensionedField< Type, GeoMesh > > &)
 Construct by transferring the DimensionedField with a new name.
tmp< DimensionedField< Type,
GeoMesh > > 		clone () const
 Construct as copy resetting name.
virtual ~DimensionedField ()
 Destructor.
const Mesh & mesh () const
 Return mesh.
const dimensionSet & dimensions () const
 Return dimensions.
dimensionSet & dimensions ()
 Return non-const access to dimensions.
const Field< Type > & field () const
Field< Type > & field ()
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.
void replace (const direction, const tmp< 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).
dimensioned< Type > average () const
 Calculate and return arithmetic average.
dimensioned< Type > weightedAverage (const DimensionedField< scalar, GeoMesh > &) const
 Calculate and return weighted average.
dimensioned< Type > weightedAverage (const tmp< DimensionedField< scalar, GeoMesh > > &) const
 Calculate and return weighted average.
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 > &)

Static Public Member Functions

static const DimensionedField
< Type, GeoMesh > & 		null ()
 Return a null DimensionedField.

Friends

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

Detailed Description

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

Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a reference to it is maintained.

Source files

Definition at line 67 of file DimensionedField.H.

Member Typedef Documentation

typedef GeoMesh::Mesh Mesh

Reimplemented in GeometricField< Type, PatchField, GeoMesh >, SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, PatchField, GeoMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< vector, pointPatchField, pointMesh >, and GeometricField< Type, fvPatchField, volMesh >.

Definition at line 77 of file DimensionedField.H.

typedef Field<Type>::cmptType cmptType

Component type.

Reimplemented from Field< Type >.

Reimplemented in GeometricField< Type, PatchField, GeoMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, PatchField, GeoMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< vector, pointPatchField, pointMesh >, and GeometricField< Type, fvPatchField, volMesh >.

Definition at line 78 of file DimensionedField.H.

Constructor & Destructor Documentation

DimensionedField ( const IOobject &  io,
const Mesh &  mesh,
const dimensionSet &  dims,
const Field< Type > &  field 
) [inline]

Construct from components.

Definition at line 44 of file DimensionedField.C.

References FatalErrorIn, List< T >::size(), and List< Type >::size().

Here is the call graph for this function:

DimensionedField ( const IOobject &  io,
const Mesh &  mesh,
const dimensionSet &  dims 
) [inline]

Construct from components.

Used for temporary fields which are initialised after construction

Definition at line 73 of file DimensionedField.C.

DimensionedField ( const IOobject &  io,
const Mesh &  mesh,
const dimensioned< Type > &  dt 
) [inline]

Construct from components.

Definition at line 88 of file DimensionedField.C.

DimensionedField ( const IOobject &  io,
const Mesh &  mesh,
const word &  fieldDictEntry = "value" 
) [inline]

Construct from Istream.

Definition at line 46 of file DimensionedFieldIO.C.

DimensionedField ( const DimensionedField< Type, GeoMesh > &  df  )  [inline]

Construct as copy.

Definition at line 103 of file DimensionedField.C.

DimensionedField ( DimensionedField< Type, GeoMesh > &  df,
bool  reUse 
) [inline]

Construct as copy or re-use as specified.

Definition at line 120 of file DimensionedField.C.

DimensionedField ( const Xfer< DimensionedField< Type, GeoMesh > > &  df  )  [inline]

Construct by transferring the DimensionedField.

Definition at line 134 of file DimensionedField.C.

DimensionedField ( const IOobject &  io,
const DimensionedField< Type, GeoMesh > &  df 
) [inline]

Construct as copy of tmp<DimensionedField> deleting argument.

Construct as copy resetting IO parameters

Definition at line 168 of file DimensionedField.C.

DimensionedField ( const word &  newName,
const DimensionedField< Type, GeoMesh > &  df 
) [inline]

Construct as copy resetting name.

Definition at line 182 of file DimensionedField.C.

DimensionedField ( const word &  newName,
DimensionedField< Type, GeoMesh > &  df,
bool  reUse 
) [inline]

Construct as copy resetting name and re-use as specified.

Definition at line 196 of file DimensionedField.C.

DimensionedField ( const word &  newName,
const Xfer< DimensionedField< Type, GeoMesh > > &  df 
) [inline]

Construct by transferring the DimensionedField with a new name.

Definition at line 211 of file DimensionedField.C.

~DimensionedField (  )  [inline, virtual]

Destructor.

Definition at line 259 of file DimensionedField.C.

Member Function Documentation

TypeName ( "DimensionedField< Type, GeoMesh >"   ) 

Runtime type information.

const DimensionedField< Type, GeoMesh > & null (  )  [inline, static]

Return a null DimensionedField.

Reimplemented from Field< Type >.

Reimplemented in GeometricField< Type, PatchField, GeoMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, PatchField, GeoMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< vector, pointPatchField, pointMesh >, and GeometricField< Type, fvPatchField, volMesh >.

Definition at line 27 of file DimensionedFieldI.H.

void readField ( const dictionary &  fieldDict,
const word &  fieldDictEntry = "value" 
) [inline]

Definition at line 30 of file DimensionedFieldIO.C.

References dictionary::lookup().

Here is the call graph for this function:

tmp< DimensionedField< Type, GeoMesh > > clone (  )  const [inline]

Construct as copy resetting name.

Clone

Reimplemented from Field< Type >.

Reimplemented in phase.

Definition at line 247 of file DimensionedField.C.

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

Return mesh.

Definition at line 35 of file DimensionedFieldI.H.

Referenced by Foam::fvc::average(), fvMatrix< Type >::boundaryManipulate(), Foam::cmptAv(), Foam::fvc::d2dt2(), Foam::fvm::d2dt2(), Foam::fvc::DDt(), Foam::fvc::div(), Foam::fvm::div(), Foam::resError::div(), Foam::MULES::explicitSolve(), Foam::fvc::flux(), Foam::fvc::grad(), fvMeshSubset::interpolate(), localMin< Type >::interpolate(), surfaceInterpolationScheme< Type >::interpolate(), localMax< Type >::interpolate(), harmonic::interpolate(), volPointInterpolation::interpolateInternalField(), Foam::interpolatePointToCell(), interpolation< Type >::interpolation(), interpolationCellPointFace< Type >::interpolationCellPointFace(), Foam::resError::laplacian(), Foam::fvm::laplacian(), Foam::fvc::makeAbsolute(), Foam::fv::makeFvGradScheme(), Foam::fvc::makeRelative(), Foam::MapGeometricFields(), radiationModel::New(), fvMatrix< Type >::operator+=(), fvMatrix< Type >::operator-=(), Foam::pow(), Foam::fvc::reconstruct(), fvMatrix< Type >::residual(), Foam::fvc::scheme(), fvMatrix< Type >::setComponentReference(), Foam::setRefCell(), fvMatrix< Type >::solve(), fvSolver::solve(), Foam::sqr(), Foam::stabilise(), Foam::fvm::Su(), Foam::fvc::surfaceIntegrate(), Foam::fvc::volumeIntegrate(), extendedUpwindCellToFaceStencil::weightedSum(), Foam::writeCellGraph(), and Foam::writePatchGraph().

Here is the caller graph for this function:

const dimensionSet & dimensions (  )  const [inline]

Return dimensions.

Definition at line 42 of file DimensionedFieldI.H.

Referenced by Foam::fvc::average(), Foam::cmptAv(), linearUpwindV< Type >::correction(), linearUpwind< Type >::correction(), Foam::resError::div(), EulerD2dt2Scheme< Type >::fvcD2dt2(), steadyStateD2dt2Scheme< Type >::fvcD2dt2(), fvMeshSubset::interpolate(), localMin< Type >::interpolate(), surfaceInterpolationScheme< Type >::interpolate(), localMax< Type >::interpolate(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::pow(), Foam::resError::Sp(), Foam::sqr(), Foam::stabilise(), Foam::fvm::Su(), fanFvPatchField< Type >::updateCoeffs(), and extendedUpwindCellToFaceStencil::weightedSum().

Here is the caller graph for this function:

dimensionSet & dimensions (  )  [inline]

Return non-const access to dimensions.

Definition at line 48 of file DimensionedFieldI.H.

const Field< Type > & field (  )  const [inline]

Definition at line 55 of file DimensionedFieldI.H.

Referenced by Foam::MULES::explicitSolve(), KinematicCloud< ParcelType >::preEvolve(), and ThermoCloud< ParcelType >::preEvolve().

Here is the caller graph for this function:

Field< Type > & field (  )  [inline]

Definition at line 61 of file DimensionedFieldI.H.

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

Return a component field of the field.

Reimplemented from Field< Type >.

Reimplemented in GeometricField< Type, PatchField, GeoMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, PatchField, GeoMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< vector, pointPatchField, pointMesh >, GeometricField< Type, fvPatchField, volMesh >, GeometricField< Type, PatchField, GeoMesh >, and GeometricField< Type, PatchField, GeoMesh >.

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

Replace a component field of the field.

void replace ( const   direction,
const tmp< DimensionedField< cmptType, GeoMesh > > &   
)

Replace a component field of the field.

tmp< DimensionedField< Type, GeoMesh > > T (  )  const [inline]

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

Reimplemented from Field< Type >.

Reimplemented in GeometricField< Type, PatchField, GeoMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, PatchField, GeoMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< vector, pointPatchField, pointMesh >, and GeometricField< Type, fvPatchField, volMesh >.

Definition at line 327 of file DimensionedField.C.

dimensioned< Type > average (  )  const [inline]

Calculate and return arithmetic average.

Definition at line 351 of file DimensionedField.C.

Referenced by spray::inject().

Here is the caller graph for this function:

dimensioned< Type > weightedAverage ( const DimensionedField< scalar, GeoMesh > &  weightField  )  const [inline]

Calculate and return weighted average.

Definition at line 366 of file DimensionedField.C.

dimensioned< Type > weightedAverage ( const tmp< DimensionedField< scalar, GeoMesh > > &  tweightField  )  const [inline]

Calculate and return weighted average.

Definition at line 384 of file DimensionedField.C.

bool writeData ( Ostream &  os,
const word &  fieldDictEntry 
) const [inline]

Definition at line 65 of file DimensionedFieldIO.C.

bool writeData ( Ostream &   )  const [inline, virtual]

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Reimplemented in GeometricField< Type, PatchField, GeoMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, PatchField, GeoMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< vector, pointPatchField, pointMesh >, and GeometricField< Type, fvPatchField, volMesh >.

Definition at line 87 of file DimensionedFieldIO.C.

void operator= ( const DimensionedField< Type, GeoMesh > &  df  )  [inline]

Definition at line 398 of file DimensionedField.C.

Referenced by DimensionedInternalField::~DimensionedInternalField().

Here is the caller graph for this function:

void operator= ( const tmp< DimensionedField< Type, GeoMesh > > &  tdf  )  [inline]

Definition at line 422 of file DimensionedField.C.

void operator= ( const dimensioned< Type > &  dt  )  [inline]

Reimplemented in GeometricField< Type, PatchField, GeoMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, PatchField, GeoMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< vector, pointPatchField, pointMesh >, and GeometricField< Type, fvPatchField, volMesh >.

Definition at line 449 of file DimensionedField.C.

void operator+= ( const DimensionedField< Type, GeoMesh > &  df  )  [inline]

Definition at line 492 of file DimensionedField.C.

void operator+= ( const tmp< DimensionedField< Type, GeoMesh > > &  tdf  )  [inline]

Definition at line 492 of file DimensionedField.C.

void operator-= ( const DimensionedField< Type, GeoMesh > &  df  )  [inline]

Definition at line 493 of file DimensionedField.C.

void operator-= ( const tmp< DimensionedField< Type, GeoMesh > > &  tdf  )  [inline]

Definition at line 493 of file DimensionedField.C.

void operator*= ( const DimensionedField< scalar, GeoMesh > &  df  )  [inline]

Definition at line 494 of file DimensionedField.C.

void operator*= ( const tmp< DimensionedField< scalar, GeoMesh > > &  tdf  )  [inline]

Definition at line 494 of file DimensionedField.C.

void operator/= ( const DimensionedField< scalar, GeoMesh > &  df  )  [inline]

Definition at line 495 of file DimensionedField.C.

void operator/= ( const tmp< DimensionedField< scalar, GeoMesh > > &  tdf  )  [inline]

Definition at line 495 of file DimensionedField.C.

void operator+= ( const dimensioned< Type > &  dt  )  [inline]

Reimplemented in GeometricField< Type, PatchField, GeoMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, PatchField, GeoMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< vector, pointPatchField, pointMesh >, and GeometricField< Type, fvPatchField, volMesh >.

Definition at line 492 of file DimensionedField.C.

void operator-= ( const dimensioned< Type > &  dt  )  [inline]

Reimplemented in GeometricField< Type, PatchField, GeoMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, PatchField, GeoMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< vector, pointPatchField, pointMesh >, and GeometricField< Type, fvPatchField, volMesh >.

Definition at line 493 of file DimensionedField.C.

void operator*= ( const dimensioned< scalar > &  dt  )  [inline]

Reimplemented in GeometricField< Type, PatchField, GeoMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, PatchField, GeoMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< vector, pointPatchField, pointMesh >, and GeometricField< Type, fvPatchField, volMesh >.

Definition at line 494 of file DimensionedField.C.

void operator/= ( const dimensioned< scalar > &  dt  )  [inline]

Reimplemented in GeometricField< Type, PatchField, GeoMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, PatchField, GeoMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< vector, pointPatchField, pointMesh >, and GeometricField< Type, fvPatchField, volMesh >.

Definition at line 495 of file DimensionedField.C.

Friends And Related Function Documentation

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

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

The documentation for this class was generated from the following files:
Copyright © 2000-2009 OpenCFD Ltd