FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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...

#include <OpenFOAM/DimensionedField.H>


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 72 of file DimensionedField.H.

Inheritance diagram for DimensionedField< Type, GeoMesh >:
Collaboration diagram for DimensionedField< Type, GeoMesh >:

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

Member Typedef Documentation


Constructor & Destructor Documentation

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

Construct from components.

Definition at line 52 of file DimensionedField.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, and List< Type >::size().

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

Construct from components.

Used for temporary fields which are initialised after construction

Definition at line 81 of file DimensionedField.C.

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

Construct from components.

Definition at line 96 of file DimensionedField.C.

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

Construct from Istream.

Definition at line 54 of file DimensionedFieldIO.C.

DimensionedField ( const DimensionedField< Type, GeoMesh > &   df  )

Construct as copy.

Definition at line 111 of file DimensionedField.C.

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

Construct as copy or re-use as specified.

Definition at line 128 of file DimensionedField.C.

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

Construct by transferring the DimensionedField.

Definition at line 142 of file DimensionedField.C.

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

Construct as copy of tmp<DimensionedField> deleting argument.

Construct as copy resetting IO parameters

Definition at line 176 of file DimensionedField.C.

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

Construct as copy resetting name.

Definition at line 190 of file DimensionedField.C.

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

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

Definition at line 204 of file DimensionedField.C.

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

Construct by transferring the DimensionedField with a new name.

Definition at line 219 of file DimensionedField.C.

~DimensionedField (  ) [virtual]

Destructor.

Definition at line 267 of file DimensionedField.C.


Member Function Documentation

TypeName ( "DimensionedField< Type, GeoMesh >"    )

Runtime type information.

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

Definition at line 38 of file DimensionedFieldIO.C.

References f(), and dictionary::lookup().

tmp< DimensionedField< Type, GeoMesh > > clone (  ) const

Construct as copy resetting name.

Clone

Reimplemented from Field< Type >.

Reimplemented in phase.

Definition at line 255 of file DimensionedField.C.

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

Return mesh.

Definition at line 43 of file DimensionedFieldI.H.

Referenced by Foam::fvc::average(), blackBodyEmission::blackBodyEmission(), forces::calcForcesMoment(), Foam::cmptAv(), gaussGrad< Type >::correctBoundaryConditions(), Foam::correction(), Foam::fvm::d2dt2(), Foam::fvc::d2dt2(), Foam::fvm::ddt(), Foam::fvc::DDt(), Foam::fvc::ddt(), Foam::fvc::ddtPhiCorr(), Foam::fvm::div(), Foam::fvc::div(), Foam::resError::div(), blackBodyEmission::EbDeltaLambdaT(), evaluateError::evaluateError(), Foam::MULES::explicitSolve(), Foam::fvc::flux(), fvMatrix< Type >::fvMatrix(), faceMDLimitedGrad< Type >::grad(), faceLimitedGrad< Type >::grad(), cellMDLimitedGrad< Type >::grad(), cellLimitedGrad< Type >::grad(), Foam::fvc::grad(), Foam::MULES::implicitSolve(), volPointInterpolation::interpolate(), surfaceInterpolationScheme< Type >::interpolate(), Foam::fvc::interpolate(), localMin< Type >::interpolate(), localMax< Type >::interpolate(), harmonic::interpolate(), fvMeshSubset::interpolate(), meshToMesh::interpolateInternalField(), volPointInterpolation::interpolateInternalField(), Foam::interpolatePointToCell(), Foam::fvm::laplacian(), Foam::fvc::laplacian(), Foam::resError::laplacian(), Foam::MULES::limiter(), Foam::linearInterpolate(), Foam::mag(), Foam::magSqr(), Foam::fvc::makeAbsolute(), Foam::fvc::makeRelative(), Foam::MapGeometricFields(), Foam::fvc::meshPhi(), radiationModel::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type12, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type12, Type2, PatchField, GeoMesh >::New(), reuseTmpGeometricField< TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpGeometricField< TypeR, Type1, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, TypeR, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, Type2, GeoMesh >::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), reuseTmpDimensionedField< TypeR, Type1, GeoMesh >::New(), Foam::operator&(), Foam::operator+(), fvMatrix< Type >::operator+=(), Foam::operator-(), fvMatrix< Type >::operator-=(), Foam::operator==(), Foam::pow(), Foam::fvc::reconstruct(), Foam::fvc::scheme(), Foam::setRefCell(), snGradScheme< Type >::snGrad(), Foam::fvc::snGrad(), fvMatrix< Type >::solve(), Foam::fvm::Sp(), Foam::sqr(), Foam::stabilise(), Foam::fvm::Su(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), Foam::fvm::SuSp(), Foam::transform(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), oscillatingDisplacementPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), Foam::fvc::volumeIntegrate(), extendedFaceToCellStencil::weightedSum(), extendedUpwindCellToFaceStencil::weightedSum(), extendedCellToFaceStencil::weightedSum(), Foam::writeCellGraph(), and Foam::writePatchGraph().

const dimensionSet & dimensions (  ) const [inline]

Return dimensions.

Definition at line 50 of file DimensionedFieldI.H.

Referenced by waveTransmissiveFvPatchField< Type >::advectionSpeed(), advectiveFvPatchField< Type >::advectionSpeed(), Foam::fvc::average(), Foam::checkMethod(), Foam::cmptAv(), LienCubicKELowRe::correct(), locDynOneEqEddy::correct(), LRR::correct(), LaunderGibsonRSTM::correct(), SpalartAllmaras::correct(), linearUpwindV< Type >::correction(), linearUpwind< Type >::correction(), limitedSnGrad< Type >::correction(), correctedSnGrad< Type >::correction(), Foam::resError::div(), Foam::fvc::domainIntegrate(), laminar::epsilon(), fluxCorrectedVelocityFvPatchVectorField::evaluate(), steadyStateD2dt2Scheme< Type >::fvcD2dt2(), EulerD2dt2Scheme< Type >::fvcD2dt2(), steadyStateDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), CrankNicholsonDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), boundedBackwardDdtScheme::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), ddtScheme< Type >::fvcDdtPhiCoeff(), steadyStateDdtScheme< Type >::fvcDdtPhiCorr(), SLTSDdtScheme< Type >::fvcDdtPhiCorr(), localEulerDdtScheme< Type >::fvcDdtPhiCorr(), EulerDdtScheme< Type >::fvcDdtPhiCorr(), CrankNicholsonDdtScheme< Type >::fvcDdtPhiCorr(), CoEulerDdtScheme< Type >::fvcDdtPhiCorr(), backwardDdtScheme< Type >::fvcDdtPhiCorr(), steadyStateD2dt2Scheme< Type >::fvmD2dt2(), EulerD2dt2Scheme< Type >::fvmD2dt2(), steadyStateDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), EulerDdtScheme< Type >::fvmDdt(), CrankNicholsonDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), boundedBackwardDdtScheme::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), gaussConvectionScheme< Type >::fvmDiv(), fvMatrix< Type >::H(), meshToMesh::interpolate(), volPointInterpolation::interpolate(), surfaceInterpolationScheme< Type >::interpolate(), localMin< Type >::interpolate(), localMax< Type >::interpolate(), fvMeshSubset::interpolate(), laminar::k(), Foam::mag(), Foam::magSqr(), laminar::mut(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, Type1, Type12, TypeR, PatchField, GeoMesh >::New(), reuseTmpGeometricField< TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, TypeR, GeoMesh >::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), laminar::nuSgs(), laminar::nut(), GeometricField< Type, PatchField, GeoMesh >::operator=(), DimensionedField< Type, GeoMesh >::operator=(), Foam::pow(), laminar::R(), SpalartAllmaras::r(), forces::rho(), skewCorrected< Type >::skewCorrection(), snGradScheme< Type >::snGrad(), Foam::fvm::Sp(), Foam::resError::Sp(), Foam::sqr(), Foam::stabilise(), Foam::fvm::Su(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), Foam::fvm::SuSp(), Foam::transform(), timeVaryingMappedPressureDirectedInletVelocityFvPatchVectorField::updateCoeffs(), syringePressureFvPatchScalarField::updateCoeffs(), swirlFlowRateInletVelocityFvPatchVectorField::updateCoeffs(), pressureNormalInletOutletVelocityFvPatchVectorField::updateCoeffs(), pressureInletVelocityFvPatchVectorField::updateCoeffs(), pressureDirectedInletVelocityFvPatchVectorField::updateCoeffs(), pressureDirectedInletOutletVelocityFvPatchVectorField::updateCoeffs(), freestreamPressureFvPatchScalarField::updateCoeffs(), flowRateInletVelocityFvPatchVectorField::updateCoeffs(), fanFvPatchField< Type >::updateCoeffs(), extendedFaceToCellStencil::weightedSum(), extendedUpwindCellToFaceStencil::weightedSum(), and extendedCellToFaceStencil::weightedSum().

dimensionSet & dimensions (  ) [inline]

Return non-const access to dimensions.

Definition at line 56 of file DimensionedFieldI.H.

Field< Type > & field (  ) [inline]

Definition at line 69 of file DimensionedFieldI.H.

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.

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

Calculate and return weighted average.

Definition at line 374 of file DimensionedField.C.

References Foam::gSum(), and Foam::name().

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

Calculate and return weighted average.

Definition at line 392 of file DimensionedField.C.

bool writeData ( Ostream &   os,
const word &   fieldDictEntry  
) const
void operator= ( const tmp< DimensionedField< Type, GeoMesh > > &   tdf  )
void operator+= ( const DimensionedField< Type, GeoMesh > &   df  )

Definition at line 500 of file DimensionedField.C.

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

Definition at line 500 of file DimensionedField.C.

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

Definition at line 501 of file DimensionedField.C.

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

Definition at line 501 of file DimensionedField.C.

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

Definition at line 502 of file DimensionedField.C.

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

Definition at line 502 of file DimensionedField.C.

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

Definition at line 503 of file DimensionedField.C.

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

Definition at line 503 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: