Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
GeometricField< Type, PatchField, GeoMesh > Class Template Reference

Generic GeometricField class. More...

Inheritance diagram for GeometricField< Type, PatchField, GeoMesh >:
[legend]

Classes

class  Boundary
 The boundary fields. More...
 

Public Types

typedef GeoMesh::Mesh Mesh
 Type of mesh on which this GeometricField is instantiated. More...
 
typedef GeoMesh::BoundaryMesh BoundaryMesh
 
typedef DimensionedField< Type, GeoMesh > Internal
 Type of the internal field from which this GeometricField is derived. More...
 
typedef PatchField< Type > Patch
 
typedef Field< Type >::cmptType cmptType
 

Public Member Functions

 TypeName ("GeometricField")
 Runtime type information. More...
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=PatchField< Type >::calculatedType())
 Construct given IOobject, mesh, dimensions and patch type. More...
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 Construct given IOobject, mesh, dimensions and patch types. More...
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType())
 Construct given IOobject, mesh, dimensioned<Type> and patch type. More...
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 Construct given IOobject, mesh, dimensioned<Type> and patch types. More...
 
 GeometricField (const IOobject &io, const Internal &diField, const PtrList< PatchField< Type >> &ptfl)
 Copy construct from components. More...
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType())
 Copy construct from internal field, with specified patch type. More...
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType())
 Move construct from internal field, with specified patch type. More...
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const PtrList< PatchField< Type >> &ptfl)
 Copy construct from components. More...
 
 GeometricField (const IOobject &io, const Mesh &mesh, const bool readOldTime=true)
 Construct and read given IOobject. More...
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
 GeometricField (const GeometricField< Type, PatchField, GeoMesh > &gf)
 Copy construct. More...
 
 GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
 Construct from tmp<GeometricField> deleting argument. More...
 
 GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf)
 Construct as copy resetting IO parameters. More...
 
 GeometricField (const IOobject &io, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
 Construct as copy of tmp<GeometricField> resetting IO parameters. More...
 
 GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &gf)
 Copy construct with a new name. More...
 
 GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
 Construct with a new name from tmp<GeometricField> More...
 
 GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const word &patchFieldType)
 Construct as copy resetting IO parameters and patch type. More...
 
 GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const labelList &patchIDs, const word &patchFieldType)
 
 GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
 Construct as copy resetting IO parameters and boundary types. More...
 
 GeometricField (const IOobject &io, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
 Construct as copy resetting IO parameters and boundary types. More...
 
tmp< GeometricField< Type, PatchField, GeoMesh > > clone () const
 Clone. More...
 
virtual ~GeometricField ()
 Destructor. More...
 
Internal & ref (const bool updateAccessTime=true)
 Return a reference to the dimensioned internal field. More...
 
const Internal & internalField () const
 Return a const-reference to the dimensioned internal field. More...
 
const Internal & v () const
 
Internal::FieldType & primitiveFieldRef (const bool updateAccessTime=true)
 Return a reference to the internal field. More...
 
const Internal::FieldType & primitiveField () const
 Return a const-reference to the internal field. More...
 
Boundary & boundaryFieldRef (const bool updateAccessTime=true)
 Return a reference to the boundary field. More...
 
const Boundary & boundaryField () const
 Return const-reference to the boundary field. More...
 
label timeIndex () const
 Return the time index of the field. More...
 
label & timeIndex ()
 Return the time index of the field. More...
 
void storeOldTimes () const
 Store the old-time fields. More...
 
void storeOldTime () const
 Store the old-time field. More...
 
label nOldTimes () const
 Return the number of old time fields stored. More...
 
const GeometricField< Type, PatchField, GeoMesh > & oldTime () const
 Return old time field. More...
 
GeometricField< Type, PatchField, GeoMesh > & oldTime ()
 Return non-const old time field. More...
 
void storePrevIter () const
 Store the field as the previous iteration value. More...
 
const GeometricField< Type, PatchField, GeoMesh > & prevIter () const
 Return previous iteration field. More...
 
void correctBoundaryConditions ()
 Correct boundary field. More...
 
bool needReference () const
 Does the field need a reference level for solution. More...
 
tmp< GeometricField< cmptType, PatchField, GeoMesh > > component (const direction) const
 Return a component of the field. More...
 
bool writeData (Ostream &) const
 WriteData member function required by regIOobject. More...
 
tmp< GeometricField< Type, PatchField, GeoMesh > > T () const
 Return transpose (only if it is a tensor field) More...
 
void relax (const scalar alpha)
 Relax field (for steady-state solution). More...
 
void relax ()
 Relax field (for steady-state solution). More...
 
word select (bool final) const
 Select the final iteration parameters if `final' is true. More...
 
void writeMinMax (Ostream &os) const
 Helper function to write the min and max to an Ostream. More...
 
void negate ()
 Negate the field inplace. More...
 
void replace (const direction d, const GeometricField< cmptType, PatchField, GeoMesh > &gcf)
 Replace specified field component with content from another field. More...
 
void replace (const direction d, const dimensioned< cmptType > &ds)
 Replace specified field component with specified value. More...
 
void min (const dimensioned< Type > &dt)
 Use the minimum of the field and specified value. More...
 
void max (const dimensioned< Type > &dt)
 Use the maximum of the field and specified value. More...
 
void clip (const dimensioned< MinMax< Type >> &range)
 Clip the field to be bounded within the specified range. More...
 
void clip (const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal)
 Clip the field to be bounded within the specified range. More...
 
void maxMin (const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal)
 Deprecated(2019-01) identical to clip() More...
 
const Internal & operator() () const
 Return a const-reference to the dimensioned internal field. More...
 
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 > &)
 
template<>
tmp< GeometricField< scalar, faPatchField, areaMesh > > component (const direction) const
 
template<>
void replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &gsf)
 
template<>
tmp< GeometricField< scalar, faPatchField, areaMesh > > component (const direction) const
 
template<>
void replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &sf)
 
template<>
tmp< GeometricField< scalar, fvPatchField, volMesh > > component (const direction) const
 
template<>
void replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf)
 
template<>
tmp< GeometricField< scalar, fvPatchField, volMesh > > component (const direction) const
 
template<>
void replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &sf)
 

Static Public Member Functions

static const GeometricField< Type, PatchField, GeoMesh > & null ()
 Return a null geometric field. More...
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &name, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=PatchField< Type >::calculatedType())
 Return tmp field from name, mesh, dimensions and patch type. More...
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &name, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType())
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &name, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType())
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType())
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
 Return renamed tmp field. More...
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
 Rename tmp field and reset patch field types and return. More...
 

Friends

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

Detailed Description

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

Generic GeometricField class.

Source files

Definition at line 53 of file areaFieldsFwd.H.

Member Typedef Documentation

◆ Mesh

typedef GeoMesh::Mesh Mesh

Type of mesh on which this GeometricField is instantiated.

Definition at line 100 of file GeometricField.H.

◆ BoundaryMesh

typedef GeoMesh::BoundaryMesh BoundaryMesh

Type of boundary mesh on which this GeometricField::Boundary is instantiated

Definition at line 104 of file GeometricField.H.

◆ Internal

typedef DimensionedField<Type, GeoMesh> Internal

Type of the internal field from which this GeometricField is derived.

Definition at line 107 of file GeometricField.H.

◆ Patch

typedef PatchField<Type> Patch

Type of the patch field of which the GeometricField::Boundary is composed

Definition at line 111 of file GeometricField.H.

◆ cmptType

typedef Field<Type>::cmptType cmptType

Definition at line 290 of file GeometricField.H.

Constructor & Destructor Documentation

◆ GeometricField() [1/20]

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

Construct given IOobject, mesh, dimensions and patch type.

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

Definition at line 197 of file GeometricField.C.

◆ GeometricField() [2/20]

GeometricField ( const IOobject &  io,
const Mesh &  mesh,
const dimensionSet &  ds,
const wordList &  wantedPatchTypes,
const wordList &  actualPatchTypes = wordList() 
)

Construct given IOobject, mesh, dimensions and patch types.

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

Definition at line 219 of file GeometricField.C.

◆ GeometricField() [3/20]

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

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

This assigns both dimensions and values. The internal name for the dimensioned<Type> has no influence.

Definition at line 242 of file GeometricField.C.

◆ GeometricField() [4/20]

GeometricField ( const IOobject &  io,
const Mesh &  mesh,
const dimensioned< Type > &  dt,
const wordList &  wantedPatchTypes,
const wordList &  actualPatchTypes = wordList() 
)

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

This assigns both dimensions and values. The internal name for the dimensioned<Type> has no influence.

Definition at line 266 of file GeometricField.C.

◆ GeometricField() [5/20]

GeometricField ( const IOobject &  io,
const Internal &  diField,
const PtrList< PatchField< Type >> &  ptfl 
)

Copy construct from components.

Definition at line 291 of file GeometricField.C.

◆ GeometricField() [6/20]

GeometricField ( const IOobject &  io,
const Mesh &  mesh,
const dimensionSet &  ds,
const Field< Type > &  iField,
const word &  patchFieldType = PatchField<Type>::calculatedType() 
)

Copy construct from internal field, with specified patch type.

Definition at line 312 of file GeometricField.C.

◆ GeometricField() [7/20]

GeometricField ( const IOobject &  io,
const Mesh &  mesh,
const dimensionSet &  ds,
Field< Type > &&  iField,
const word &  patchFieldType = PatchField<Type>::calculatedType() 
)

Move construct from internal field, with specified patch type.

Definition at line 335 of file GeometricField.C.

◆ GeometricField() [8/20]

GeometricField ( const IOobject &  io,
const Mesh &  mesh,
const dimensionSet &  ds,
const Field< Type > &  iField,
const PtrList< PatchField< Type >> &  ptfl 
)

Copy construct from components.

Definition at line 358 of file GeometricField.C.

◆ GeometricField() [9/20]

GeometricField ( const IOobject &  io,
const Mesh &  mesh,
const bool  readOldTime = true 
)

Construct and read given IOobject.

Definition at line 381 of file GeometricField.C.

◆ GeometricField() [10/20]

GeometricField ( const IOobject &  io,
const Mesh &  mesh,
const dictionary &  dict 
)

Construct from dictionary.

Definition at line 417 of file GeometricField.C.

◆ GeometricField() [11/20]

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

Copy construct.

Definition at line 448 of file GeometricField.C.

◆ GeometricField() [12/20]

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

Construct from tmp<GeometricField> deleting argument.

Definition at line 475 of file GeometricField.C.

◆ GeometricField() [13/20]

GeometricField ( const IOobject &  io,
const GeometricField< Type, PatchField, GeoMesh > &  gf 
)

Construct as copy resetting IO parameters.

Definition at line 496 of file GeometricField.C.

◆ GeometricField() [14/20]

GeometricField ( const IOobject &  io,
const tmp< GeometricField< Type, PatchField, GeoMesh >> &  tgf 
)

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

Definition at line 524 of file GeometricField.C.

◆ GeometricField() [15/20]

GeometricField ( const word &  newName,
const GeometricField< Type, PatchField, GeoMesh > &  gf 
)

Copy construct with a new name.

Definition at line 547 of file GeometricField.C.

◆ GeometricField() [16/20]

GeometricField ( const word &  newName,
const tmp< GeometricField< Type, PatchField, GeoMesh >> &  tgf 
)

Construct with a new name from tmp<GeometricField>

Definition at line 575 of file GeometricField.C.

◆ GeometricField() [17/20]

GeometricField ( const IOobject &  io,
const GeometricField< Type, PatchField, GeoMesh > &  gf,
const word &  patchFieldType 
)

Construct as copy resetting IO parameters and patch type.

Definition at line 596 of file GeometricField.C.

◆ GeometricField() [18/20]

GeometricField ( const IOobject &  io,
const GeometricField< Type, PatchField, GeoMesh > &  gf,
const labelList &  patchIDs,
const word &  patchFieldType 
)

Construct as copy resetting IO parameters and boundary type for selected patchIDs

Definition at line 665 of file GeometricField.C.

◆ GeometricField() [19/20]

GeometricField ( const IOobject &  io,
const GeometricField< Type, PatchField, GeoMesh > &  gf,
const wordList &  patchFieldTypes,
const wordList &  actualPatchTypes = wordList() 
)

Construct as copy resetting IO parameters and boundary types.

Definition at line 627 of file GeometricField.C.

◆ GeometricField() [20/20]

GeometricField ( const IOobject &  io,
const tmp< GeometricField< Type, PatchField, GeoMesh >> &  tgf,
const wordList &  patchFieldTypes,
const wordList &  actualPatchTypes = wordList() 
)

Construct as copy resetting IO parameters and boundary types.

Definition at line 696 of file GeometricField.C.

◆ ~GeometricField()

~GeometricField ( )
virtual

Destructor.

Definition at line 736 of file GeometricField.C.

Member Function Documentation

◆ TypeName()

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

Runtime type information.

◆ null()

const Foam::GeometricField< Type, PatchField, GeoMesh > & null ( )
inlinestatic

Return a null geometric field.

Definition at line 32 of file GeometricFieldI.H.

Referenced by ddtScheme< Type >::fvcDdt().

Here is the caller graph for this function:

◆ clone()

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > clone ( ) const

Clone.

Definition at line 727 of file GeometricField.C.

◆ New() [1/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word &  name,
const Mesh &  mesh,
const dimensionSet &  ds,
const word &  patchFieldType = PatchField<Type>::calculatedType() 
)
static

Return tmp field from name, mesh, dimensions and patch type.

The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry

Definition at line 34 of file GeometricFieldNew.C.

Referenced by Foam::makeZeroGradientField(), and subCycleField< GeometricField >::subCycleField().

Here is the caller graph for this function:

◆ New() [2/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word &  name,
const Mesh &  mesh,
const dimensionSet &  ds,
const Field< Type > &  iField,
const word &  patchFieldType = PatchField<Type>::calculatedType() 
)
static

Return tmp field from name, mesh, dimensions, copy of internal field, with specified patch type.

The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry

Definition at line 62 of file GeometricFieldNew.C.

◆ New() [3/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word &  name,
const Mesh &  mesh,
const dimensionSet &  ds,
Field< Type > &&  iField,
const word &  patchFieldType = PatchField<Type>::calculatedType() 
)
static

Return tmp field from name, mesh, dimensions, moved internal field contents, with specified patch type.

The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry

Definition at line 92 of file GeometricFieldNew.C.

◆ New() [4/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word &  name,
const Mesh &  mesh,
const dimensioned< Type > &  dt,
const word &  patchFieldType = PatchField<Type>::calculatedType() 
)
static

Return tmp field from name, mesh, dimensioned<Type> and patch type.

The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry

Definition at line 122 of file GeometricFieldNew.C.

◆ New() [5/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word &  name,
const Mesh &  mesh,
const dimensioned< Type > &  dt,
const wordList &  patchFieldTypes,
const wordList &  actualPatchTypes = wordList() 
)
static

Return tmp field from name, mesh, dimensioned<Type> and patch types.

The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry

Definition at line 150 of file GeometricFieldNew.C.

◆ New() [6/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word &  newName,
const tmp< GeometricField< Type, PatchField, GeoMesh >> &  tgf 
)
static

Return renamed tmp field.

The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry

Definition at line 180 of file GeometricFieldNew.C.

◆ New() [7/7]

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > New ( const word &  newName,
const tmp< GeometricField< Type, PatchField, GeoMesh >> &  tgf,
const wordList &  patchFieldTypes,
const wordList &  actualPatchTypes = wordList() 
)
static

Rename tmp field and reset patch field types and return.

The field is NO_READ, NO_WRITE, unregistered and uses the current timeName from the mesh registry

Definition at line 205 of file GeometricFieldNew.C.

◆ ref()

Foam::GeometricField< Type, PatchField, GeoMesh >::Internal & ref ( const bool  updateAccessTime = true)

Return a reference to the dimensioned internal field.

Parameters
updateAccessTimeupdate event counter and check old-time fields
Note
Should avoid using updateAccessTime = true within loops.

Definition at line 749 of file GeometricField.C.

Referenced by viscousDissipation::addSup(), interRegionHeatTransferModel::addSup(), adjointSensitivity::adjointMeshMovementSource(), MassTransferPhaseSystem< BasePhaseSystem >::alphaTransfer(), Foam::atan2(), Foam::fac::average(), adjointSensitivity::computeGradDxDbMultiplier(), shapeSensitivitiesBase::constructVolSensitivtyField(), Poisson::correct(), diffusionMulticomponent< ReactionThermo, ThermoType >::correct(), linearUpwind< Type >::correction(), linearUpwindV< Type >::correction(), heThermo< BasicSolidThermo, MixtureType >::CpByCpv(), heThermo< BasicSolidThermo, MixtureType >::Cpv(), basicFvGeometryScheme::deltaCoeffs(), Foam::fac::div(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), multiphaseMangrovesTurbulenceModel::epsilonCoeff(), filmFlux::execute(), ATCstandard::getFISensitivityTerm(), ATCUaGradU::getFISensitivityTerm(), adjointEikonalSolver::getFISensitivityTerm(), faMatrix< Type >::H(), fvMatrix< Type >::H1(), MassTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), Foam::interpolate(), volPointInterpolation::interpolate(), heSolidThermo< BasicSolidThermo, MixtureType >::Kappa(), multiphaseMangrovesTurbulenceModel::kCoeff(), interfaceOxideRate< Thermo, OtherThermo >::Kexp(), laplaceFilter::laplaceFilter(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::fac::ndiv(), basicFvGeometryScheme::nonOrthCorrectionVectors(), basicFvGeometryScheme::nonOrthDeltaCoeffs(), Foam::pow(), variablesSet::renameTurbulenceField(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), dynamicOversetFvMesh::solve(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), multiphaseSystem::Svm(), heheuPsiThermo< BasicPsiThermo, MixtureType >::Tb(), SRFModel::Uabs(), heThermo< BasicSolidThermo, MixtureType >::W(), extendedUpwindCellToFaceStencil::weightedSum(), extendedFaceToCellStencil::weightedSum(), extendedCellToFaceStencil::weightedSum(), basicFvGeometryScheme::weights(), reverseLinear< Type >::weights(), clippedLinear< Type >::weights(), and writeCellVolumes::write().

◆ internalField()

const Foam::GeometricField< Type, PatchField, GeoMesh >::Internal & internalField ( ) const
inline

Return a const-reference to the dimensioned internal field.

Definition at line 43 of file GeometricFieldI.H.

Referenced by assemblyFaceAreaPairGAMGAgglomeration::assemblyFaceAreaPairGAMGAgglomeration(), Foam::fac::div(), edgeInterpolationScheme< scalar >::euclidianInterpolate(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::famDdt(), gaussConvectionScheme< Type >::famDiv(), gaussLaplacianScheme< Type >::famLaplacian(), interfaceTrackingFvMesh::freeSurfacePressureJump(), interfaceTrackingFvMesh::freeSurfaceSnGradU(), interfaceTrackingFvMesh::freeSurfaceSnGradUn(), skewCorrectedSnGrad< Type >::fullGradCorrection(), edgeInterpolationScheme< scalar >::interpolate(), dynamicRefineFvMesh::mapNewInternalFaces(), volSurfaceMapping::mapToField(), volSurfaceMapping::mapToVolume(), Foam::fac::ndiv(), faFieldReconstructor::reconstructFaAreaField(), faFieldReconstructor::reconstructFaEdgeField(), faMatrix< Type >::residual(), Foam::fam::Sp(), Foam::fam::Su(), Foam::fam::SuSp(), liquidFilmBase::Up(), interfaceTrackingFvMesh::update(), liquidFilmBase::Uw(), dynamicOversetFvMesh::writeObject(), and Foam::ensightOutput::writePointField().

Here is the caller graph for this function:

◆ v()

const Foam::GeometricField< Type, PatchField, GeoMesh >::Internal & v ( ) const
inline

Return a const-reference to the dimensioned internal field of a "vol" field.

Useful in the formulation of source-terms for FV equations

Note
definition in finiteVolume/fields/volFields/volFieldsI.H

Definition at line 33 of file volFieldsI.H.

◆ primitiveFieldRef()

Foam::GeometricField< Type, PatchField, GeoMesh >::Internal::FieldType & primitiveFieldRef ( const bool  updateAccessTime = true)

Return a reference to the internal field.

Parameters
updateAccessTimeupdate event counter and check old-time fields
Note
Should avoid using updateAccessTime = true within loops.

Definition at line 766 of file GeometricField.C.

Referenced by faMatrix< Type >::A(), fvMatrix< Type >::A(), MRFZone::addCoriolis(), interRegionExplicitPorositySource::addSup(), externalHeatFluxSource::addSup(), powerLawUniformBinary::addToBinaryBreakupRate(), hydrodynamic::addToCoalescenceRate(), Foam::FieldOps::assign(), Foam::atan2(), Foam::fvc::average(), Foam::bound(), Implicit< CloudType >::cacheFields(), curvatureSeparation::calcCosAngle(), cubeRootVolDelta::calcDelta(), maxDeltaxyz::calcDelta(), curvatureSeparation::calcInvR1(), variableHeatTransfer::calculateHtc(), pointConstraints::constrain(), pointConstraints::constrainDisplacement(), inverseVolumeDiffusivity::correct(), contactAngleForce::correct(), curvatureSeparation::correct(), wideBandAbsorptionEmission::correct(), distanceSurface::createGeometry(), Foam::fac::div(), edgeInterpolationScheme< scalar >::euclidianInterpolate(), faMatrix< Type >::flux(), fvMatrix< Type >::flux(), faMatrix< Type >::H(), fvMatrix< Type >::H(), heThermo< BasicSolidThermo, MixtureType >::hc(), dynamicOversetFvMesh::interpolate(), edgeInterpolationScheme< scalar >::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), volPointInterpolation::interpolateBoundaryField(), Foam::invTransform(), isoSurfaceCell::isoSurfaceCell(), isoSurfacePoint::isoSurfacePoint(), isoSurfaceTopo::isoSurfaceTopo(), dynamicRefineFvMesh::mapFields(), meshToMesh::mapInternalSrcToTgt(), meshToMesh::mapInternalTgtToSrc(), fvMesh::movePoints(), heheuPsiThermo< BasicPsiThermo, MixtureType >::mub(), heheuPsiThermo< BasicPsiThermo, MixtureType >::muu(), Foam::fac::ndiv(), liquidFilmBase::pg(), VoidFraction< CloudType >::postEvolve(), Foam::pow(), liquidFilmModel::preEvolveRegion(), snappySnapDriver::preSmoothPatch(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psib(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psiu(), variablesSet::renameTurbulenceField(), rigidBodyMeshMotion::rigidBodyMeshMotion(), acousticDampingSource::setBlendingFactor(), powerLaw::setBreakupRate(), exponential::setBreakupRate(), standardRadiation::Shs(), sensitivitySurface::smoothSensitivities(), Foam::sqr(), Foam::stabilise(), ReactingCloud< Foam::DSMCCloud >::SYi(), Foam::T(), Foam::FieldOps::ternary(), Foam::FieldOps::ternarySelect(), KinematicCloud< Cloud< basicKinematicCollidingParcel > >::theta(), Foam::transform(), Foam::unzip(), interfaceTrackingFvMesh::update(), NURBS3DVolumeCylindrical::updateLocalCoordinateSystem(), KinematicCloud< Cloud< basicKinematicCollidingParcel > >::vDotSweep(), velocityDisplacementMotionSolver::velocityDisplacementMotionSolver(), faNVDscheme< Type, NVDweight >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), AveragingMethod< Foam::Vector >::write(), solverInfo::write(), dynamicOversetFvMesh::writeAgglomeration(), and MRFZone::zero().

◆ primitiveField()

const Foam::GeometricField< Type, PatchField, GeoMesh >::Internal::FieldType & primitiveField ( ) const
inline

Return a const-reference to the internal field.

Definition at line 53 of file GeometricFieldI.H.

Referenced by sensitivityVolBSplinesFI::assembleSensitivities(), sensitivityBezierFI::assembleSensitivities(), assemblyFaceAreaPairGAMGAgglomeration::assemblyFaceAreaPairGAMGAgglomeration(), Foam::FieldOps::assign(), Foam::atan2(), Foam::bound(), faceLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), Foam::cmptAv(), Foam::component(), phaseChangeModel::correct(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), kinematicSingleLayer::CourantNumber(), motionSmootherAlgo::curPoints(), filmTurbulenceModel::Cw(), EulerFaD2dt2Scheme< Type >::facD2dt2(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt0(), faceAreaPairGAMGAgglomeration::faceAreaPairGAMGAgglomeration(), boundedBackwardFaDdtScheme::famDdt(), EulerD2dt2Scheme< Type >::fvcD2dt2(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), ddtScheme< Type >::fvcDdtPhiCoeff(), ddtScheme< Type >::fvcDdtPhiCoeffExperimental(), EulerD2dt2Scheme< Type >::fvmD2dt2(), EulerDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), kinematicSingleLayer::info(), Foam::invTransform(), Foam::mag(), Foam::magSqr(), Foam::makeGraph(), isoSurfaceBase::New(), GeometricField< Type, fvPatchField, volMesh >::operator=(), MomentumTransferPhaseSystem< BasePhaseSystem >::partialElimination(), MomentumTransferPhaseSystem< BasePhaseSystem >::partialEliminationf(), Foam::pow(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructFvVolumeField(), fvMatrix< Type >::residual(), rigidBodyMeshMotion::rigidBodyMeshMotion(), parseDriver::setResult(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >::SlicedGeometricField(), reactingOneDim::solidRegionDiffNo(), surfaceAlignedSBRStressFvMotionSolver::solve(), Foam::sqr(), Foam::stabilise(), Foam::T(), Foam::FieldOps::ternary(), Foam::FieldOps::ternarySelect(), Foam::transform(), Foam::fvc::volumeIntegrate(), Foam::writeCellGraph(), and Foam::zip().

◆ boundaryFieldRef()

Foam::GeometricField< Type, PatchField, GeoMesh >::Boundary & boundaryFieldRef ( const bool  updateAccessTime = true)

Return a reference to the boundary field.

Parameters
updateAccessTimeupdate event counter and check old-time fields
Note
Should avoid using updateAccessTime = true within loops.

Definition at line 783 of file GeometricField.C.

Referenced by shapeSensitivities::accumulateBCSensitivityIntegrand(), sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurface::accumulateIntegrand(), Foam::FieldOps::assign(), Foam::atan2(), Foam::fac::average(), Foam::fvc::average(), Foam::bound(), wallShearStress::calcShearStress(), adjointSensitivity::computeGradDxDbMultiplier(), shapeSensitivitiesBase::constructAndWriteSensitivityField(), reconstructedDistanceFunction::constructRDF(), inversePointDistanceDiffusivity::correct(), injectionModelList::correct(), wallDistData< TransferType >::correct(), ShihQuadraticKE::correct(), LamBremhorstKE::correct(), LienLeschziner::correct(), LienCubicKE::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correct(), kkLOmega::correct(), motionSmootherAlgo::correctBoundaryConditions(), MRFZoneList::correctBoundaryFlux(), thermoSingleLayer::correctHsForMappedT(), phaseModel::correctInflowOutflow(), mixtureKEpsilon< BasicTurbulenceModel >::correctInletOutlet(), cubic< Type >::correction(), liquidFilmModel::correctThermoFields(), multiphaseSystem::dragCoeffs(), edgeInterpolationScheme< scalar >::euclidianInterpolate(), faMatrix< Type >::faMatrix(), adjointSpalartAllmaras::FISensitivityTerm(), faMatrix< Type >::flux(), fvMatrix< Type >::flux(), ddtScheme< Type >::fvcDdtPhiCoeff(), ddtScheme< Type >::fvcDdtPhiCoeffExperimental(), NURBS3DVolume::getDxCellsDb(), ATCstandard::getFISensitivityTerm(), heThermo< BasicSolidThermo, MixtureType >::hc(), psiuReactionThermo::heuBoundaryCorrection(), localReferenceTemperature::htc(), fixedReferenceTemperature::htc(), ReynoldsAnalogy::htc(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), pointVolInterpolation::interpolate(), edgeInterpolationScheme< scalar >::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), singleCellFvMesh::interpolate(), meshToMesh0::interpolate(), Foam::invTransform(), Foam::MULES::limit(), lnGradScheme< Type >::lnGrad(), adjointSimple::mainIter(), fvMatrix< Type >::manipulateMatrix(), dynamicRefineFvMesh::mapFields(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), fvMesh::movePoints(), heheuPsiThermo< BasicPsiThermo, MixtureType >::mub(), heheuPsiThermo< BasicPsiThermo, MixtureType >::muu(), Schaeffer::nu(), JohnsonJacksonSchaeffer::nu(), consumptionSpeed::omega0Sigma(), liquidFilmBase::postEvolveRegion(), Foam::pow(), phasePressureModel::pPrime(), phasePressureModel::pPrimef(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psib(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psiu(), variablesSet::renameTurbulenceField(), laplacianMotionSolver::setBoundaryConditions(), elasticityMotionSolver::setBoundaryConditions(), motionSmootherAlgo::setDisplacementPatchFields(), pointConstraints::setPatchFields(), snGradScheme< Type >::snGrad(), adjointMeshMovementSolver::solve(), sensitivityBezierFI::solveMeshMovementEqn(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), Foam::sqr(), Foam::stabilise(), Foam::T(), Foam::FieldOps::ternary(), Foam::FieldOps::ternarySelect(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), Foam::transform(), polynomial::Tsat(), function1::Tsat(), dynamicRefineFvMesh::unrefine(), Foam::unzip(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), reactingOneDim::updatePhiGas(), reactingOneDim::updateqr(), faNVDscheme< Type, NVDweight >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), dynamicOversetFvMesh::writeAgglomeration(), MRFZone::zero(), and wallLubricationModel::zeroGradWalls().

◆ boundaryField()

const Foam::GeometricField< Type, PatchField, GeoMesh >::Boundary & boundaryField ( ) const
inline

Return const-reference to the boundary field.

Definition at line 62 of file GeometricFieldI.H.

Referenced by sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurface::accumulateIntegrand(), reactingOneDim::addMassSources(), basicThermo::alpha(), lumpedPointMovement::areas(), Foam::FieldOps::assign(), Foam::atan2(), Foam::fac::average(), Foam::fvc::average(), Foam::bound(), ThermoSurfaceFilm< CloudType >::cacheFilmFields(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::cacheFilmFields(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::calcAlphat(), fieldExtents::calcFieldExtents(), CentredFitSnGradData< Polynomial >::calcFit(), forces::calcForcesMoment(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), nutUWallFunctionFvPatchScalarField::calcNut(), nutUTabulatedWallFunctionFvPatchScalarField::calcNut(), nutUBlendedWallFunctionFvPatchScalarField::calcNut(), nutUSpaldingWallFunctionFvPatchScalarField::calcNut(), atmNutUWallFunctionFvPatchScalarField::calcNut(), wallShearStress::calcShearStress(), atmOmegaWallFunctionFvPatchScalarField::calculate(), atmEpsilonWallFunctionFvPatchScalarField::calculate(), epsilonWallFunctionFvPatchScalarField::calculate(), omegaWallFunctionFvPatchScalarField::calculate(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::calculateVolumeFractions(), Foam::cmptAv(), Foam::component(), NURBS3DVolume::computeControlPointSensitivities(), adjointSensitivity::computeGradDxDbMultiplier(), adjointSpalartAllmaras::conservativeMomentumSource(), shapeSensitivitiesBase::constructAndWriteSensitivtyPointField(), reconstructedDistanceFunction::constructRDF(), transferModelList::correct(), injectionModelList::correct(), contactAngleForce::correct(), gaussGrad< Type >::correctBoundaryConditions(), thermoSingleLayer::correctHsForMappedT(), phaseModel::correctInflowOutflow(), mixtureKEpsilon< BasicTurbulenceModel >::correctInletOutlet(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), linearUpwind< Type >::correction(), linearUpwindV< Type >::correction(), linearUpwindNormal< Type >::correction(), outletStabilised< Type >::correction(), omegaWallFunctionFvPatchScalarField::createAveragingWeights(), distanceSurface::createGeometry(), adjointSpalartAllmaras::diffusionCoeffVar1(), adjointEikonalSolver::distanceSensitivities(), adjointSpalartAllmaras::distanceSensitivities(), multiphaseSystem::dragCoeffs(), shapeSensitivities::dvdbMult(), Foam::fac::edgeIntegrate(), Foam::fac::edgeSum(), edgeInterpolationScheme< scalar >::euclidianInterpolate(), yPlus::execute(), surfaceDistance::execute(), EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt0(), FacePostProcessing< CloudType >::FacePostProcessing(), gaussConvectionScheme< Type >::famDiv(), gaussLaplacianScheme< Type >::famLaplacian(), adjointSpalartAllmaras::FISensitivityTerm(), volPointInterpolation::flatBoundaryField(), faMatrix< Type >::flux(), lumpedPointMovement::forcesAndMoments(), interfaceTrackingFvMesh::freeSurfacePressureJump(), skewCorrectedSnGrad< Type >::fullGradCorrection(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), relaxedNonOrthoGaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), GenericPatchGeoFieldsWriter< PatchType >::getFaceField(), psiuReactionThermo::heuBoundaryTypes(), thermalBaffle::info(), fluxSummary::initialiseFaceZoneAndDirection(), mixtureKEpsilon< BasicTurbulenceModel >::initMixtureFields(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::injectParticles(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), pointVolInterpolation::interpolate(), edgeInterpolationScheme< scalar >::interpolate(), surfaceInterpolationScheme< GType >::interpolate(), weightedFlux< Type >::interpolate(), singleCellFvMesh::interpolate(), meshToMesh0::interpolate(), Foam::invTransform(), objectiveForce::J(), objectiveMoment::J(), kkLOmega::k(), interfaceOxideRate< Thermo, OtherThermo >::Kexp(), Foam::MULES::limit(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::MULES::limiter(), Foam::MULES::limiterCorr(), lnGradScheme< Type >::lnGrad(), Foam::mag(), Foam::magSqr(), fvMatrix< Type >::mapContributions(), dynamicRefineFvMesh::mapFields(), dynamicRefineFvMesh::mapNewInternalFaces(), adjointMeshMovementSolver::meshMovementSensitivities(), incompressibleTwoPhaseInteractingMixture::mu(), heheuPsiThermo< BasicPsiThermo, MixtureType >::mub(), CompressibleTurbulenceModel< TransportModel >::mut(), basicFvGeometryScheme::nonOrthCorrectionVectors(), basicFvGeometryScheme::nonOrthDeltaCoeffs(), Schaeffer::nu(), Newtonian::nu(), strainRateFunction::nu(), JohnsonJacksonSchaeffer::nu(), powerLaw::nu(), HerschelBulkley::nu(), CrossPowerLaw::nu(), BirdCarreau::nu(), CompressibleTurbulenceModel< TransportModel >::nu(), Casson::nu(), incompressibleTwoPhaseMixture::nu(), incompressibleTwoPhaseInteractingMixture::nu(), incompressibleThreePhaseMixture::nu(), eddyViscosity< RASModel< BasicTurbulenceModel > >::nut(), ReynoldsStress< RASModel< BasicTurbulenceModel > >::nut(), omegaWallFunctionFvPatchScalarField::omegaPatch(), GeometricField< Type, fvPatchField, volMesh >::operator/=(), GeometricField< Type, fvPatchField, volMesh >::operator=(), GeometricField< Type, fvPatchField, volMesh >::operator==(), boundaryAdjointContributionIncompressible::pab(), PatchCollisionDensity< CloudType >::PatchCollisionDensity(), homogeneousMixture< ThermoType >::patchFaceMixture(), egrMixture< ThermoType >::patchFaceMixture(), inhomogeneousMixture< ThermoType >::patchFaceMixture(), veryInhomogeneousMixture< ThermoType >::patchFaceMixture(), egrMixture< ThermoType >::patchFaceProducts(), inhomogeneousMixture< ThermoType >::patchFaceProducts(), veryInhomogeneousMixture< ThermoType >::patchFaceProducts(), egrMixture< ThermoType >::patchFaceReactants(), inhomogeneousMixture< ThermoType >::patchFaceReactants(), veryInhomogeneousMixture< ThermoType >::patchFaceReactants(), homogeneousMixture< ThermoType >::patchFaceVolMixture(), inhomogeneousMixture< ThermoType >::patchFaceVolMixture(), veryInhomogeneousMixture< ThermoType >::patchFaceVolMixture(), fvPatch::patchField(), faPatch::patchField(), lumpedPointDisplacementPointPatchVectorField::patchIds(), boundaryAdjointContributionIncompressible::pb(), liquidFilmBase::pg(), boundaryAdjointContributionIncompressible::phiab(), boundaryAdjointContributionIncompressible::phib(), PatchCollisionDensity< CloudType >::postPatch(), Foam::pow(), liquidFilmModel::preEvolveRegion(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psib(), reactingEulerHtcModel::q(), heatTransferCoeffModel::q(), thermoSingleLayer::qconvp(), thermoSingleLayer::qconvw(), greyDiffusiveViewFactorFixedValueFvPatchScalarField::qro(), faFieldReconstructor::reconstructFaAreaField(), faFieldReconstructor::reconstructFaEdgeField(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructFvVolumeField(), Foam::fvc::reconstructMag(), RemoveParcels< CloudType >::RemoveParcels(), faMatrix< Type >::residual(), fvMatrix< Type >::residual(), Foam::reusable(), incompressibleTwoPhaseInteractingMixture::rho(), patchProbes::sample(), sampledMeshedSurface::sampleOnFaces(), sampledPatch::sampleOnFaces(), sampledFaceZone::sampleOnFaces(), extractEulerianParticles::setBlockedFaces(), fvMatrix< Type >::setBounAndInterCoeffs(), laplacianMotionSolver::setBoundaryConditions(), elasticityMotionSolver::setBoundaryConditions(), fvMatrix< Type >::setInterfaces(), lumpedPointDisplacementPointPatchVectorField::setInterpolators(), displacementMethoddisplacementLaplacian::setMotionField(), displacementMethodlaplacianMotionSolver::setMotionField(), displacementMethodvelocityLaplacian::setMotionField(), displacementMethodelasticityMotionSolver::setMotionField(), lumpedPointDisplacementPointPatchVectorField::setPatchControls(), thermoSingleLayer::Sh(), snGradScheme< Type >::snGrad(), thermalBaffle::solveEnergy(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), KinematicSurfaceFilm< CloudType >::splashInteraction(), Foam::sqr(), thermoSingleLayer::Srho(), Foam::stabilise(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), multiphaseSystem::Svm(), Foam::T(), Foam::FieldOps::ternary(), Foam::FieldOps::ternarySelect(), fluxSummary::totalArea(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), Foam::transform(), polynomial::Tsat(), function1::Tsat(), boundaryAdjointContributionIncompressible::Uab(), boundaryAdjointContributionIncompressible::Ub(), dynamicRefineFvMesh::unrefine(), liquidFilmBase::Up(), interfaceTrackingFvMesh::update(), objectiveForce::update_dSdbMultiplier(), objectiveMoment::update_dSdbMultiplier(), objectiveMoment::update_dxdbDirectMultiplier(), objectiveForce::update_dxdbMultiplier(), objectiveMoment::update_dxdbMultiplier(), inclinedFilmNusseltHeightFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltInletVelocityFvPatchVectorField::updateCoeffs(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), alphatWallFunctionFvPatchScalarField::updateCoeffs(), outletMappedUniformInletHeatAdditionFvPatchField::updateCoeffs(), fixedMultiPhaseHeatFluxFvPatchScalarField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), advectiveFvPatchField< Type >::updateCoeffs(), alphatWallBoilingWallFunctionFvPatchScalarField::updateCoeffs(), reactingOneDim::updateqr(), thermoSingleLayer::updateSurfaceTemperatures(), kinematicSingleLayer::updateSurfaceVelocities(), adjointSpalartAllmaras::wallFloCoSensitivities(), adjointSpalartAllmaras::wallShapeSensitivities(), outletStabilised< Type >::weights(), faNVDscheme< Type, NVDweight >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), dynamicOversetFvMesh::write(), Foam::writePatchGraph(), Foam::ensightOutput::writePointField(), Foam::ensightOutput::writeVolField(), alphatJayatillekeWallFunctionFvPatchScalarField::yPlus(), and Foam::zip().

◆ timeIndex() [1/2]

Foam::label timeIndex ( ) const
inline

Return the time index of the field.

Definition at line 70 of file GeometricFieldI.H.

Referenced by subCycleField< GeometricField >::~subCycleField().

Here is the caller graph for this function:

◆ timeIndex() [2/2]

Foam::label & timeIndex ( )
inline

Return the time index of the field.

Definition at line 78 of file GeometricFieldI.H.

◆ storeOldTimes()

void storeOldTimes ( ) const

Store the old-time fields.

Definition at line 797 of file GeometricField.C.

◆ storeOldTime()

void storeOldTime ( ) const

Store the old-time field.

Definition at line 816 of file GeometricField.C.

◆ nOldTimes()

Foam::label nOldTimes ( ) const

Return the number of old time fields stored.

Definition at line 837 of file GeometricField.C.

◆ oldTime() [1/2]

const Foam::GeometricField< Type, PatchField, GeoMesh > & oldTime ( ) const

Return old time field.

Definition at line 850 of file GeometricField.C.

Referenced by EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), EulerFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), EulerFaD2dt2Scheme< Type >::famD2dt2(), EulerFaDdtScheme< Type >::famDdt(), backwardFaDdtScheme< Type >::famDdt(), boundedBackwardFaDdtScheme::famDdt(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerD2dt2Scheme< Type >::fvmD2dt2(), EulerDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), MassTransferPhaseSystem< BasePhaseSystem >::massSpeciesTransfer(), GeometricField< Type, fvPatchField, volMesh >::oldTime(), KirchhoffShell::solveDisplacement(), and waveSurfacePressureFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ oldTime() [2/2]

Foam::GeometricField< Type, PatchField, GeoMesh > & oldTime ( )

Return non-const old time field.

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

Definition at line 890 of file GeometricField.C.

◆ storePrevIter()

void storePrevIter ( ) const

Store the field as the previous iteration value.

Definition at line 900 of file GeometricField.C.

Referenced by adjointSpalartAllmaras::correct(), kinematicThinFilm::evolveRegion(), and kinematicThinFilm::preEvolveRegion().

Here is the caller graph for this function:

◆ prevIter()

const Foam::GeometricField< Type, PatchField, GeoMesh > & prevIter ( ) const

Return previous iteration field.

Definition at line 923 of file GeometricField.C.

Referenced by Foam::fvc::alphaCorr().

Here is the caller graph for this function:

◆ correctBoundaryConditions()

void correctBoundaryConditions ( )

Correct boundary field.

Definition at line 940 of file GeometricField.C.

Referenced by faMatrix< Type >::A(), fvMatrix< Type >::A(), porosityModel::addResistance(), Foam::fac::average(), Foam::fvc::average(), Implicit< CloudType >::cacheFields(), curvatureSeparation::calcCosAngle(), cubeRootVolDelta::calcDelta(), maxDeltaxyz::calcDelta(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::calculateVolumeFractions(), pointConstraints::constrain(), pointConstraints::constrainDisplacement(), reconstructedDistanceFunction::constructRDF(), inverseVolumeDiffusivity::correct(), transferModelList::correct(), injectionModelList::correct(), primaryRadiation::correct(), mappedConvectiveHeatTransfer::correct(), standardRadiation::correct(), phaseChangeModel::correct(), qZeta::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correct(), kkLOmega::correct(), adjointSpalartAllmaras::correct(), thermoSingleLayer::correctAlpha(), thermoSingleLayer::correctHsForMappedT(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), ShihQuadraticKE::correctNonlinearStress(), LienCubicKE::correctNonlinearStress(), incompressibleVars::correctNonTurbulentBoundaryConditions(), qZeta::correctNut(), LienLeschziner::correctNut(), SpalartAllmarasDES< BasicTurbulenceModel >::correctNut(), Foam::fac::div(), electricPotential::electricPotential(), kinematicThinFilm::evolveRegion(), interfaceTrackingFvMesh::freeSurfaceSnGradU(), NURBS3DVolume::getDxCellsDb(), Foam::fac::grad(), faMatrix< Type >::H(), fvMatrix< Type >::H(), dynamicOversetFvMesh::interpolate(), patchTransformedInterpolation::interpolate(), pointVolInterpolation::interpolate(), SpalartAllmarasDES< BasicTurbulenceModel >::k(), adjointSimple::mainIter(), Foam::fac::ndiv(), Foam::fac::ngrad(), Schaeffer::nu(), JohnsonJacksonSchaeffer::nu(), acousticDampingSource::setBlendingFactor(), standardRadiation::Shs(), twoPhaseSystem::solve(), fvMatrix< Type >::solveSegregated(), KinematicCloud< Cloud< basicKinematicCollidingParcel > >::theta(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), thermoSingleLayer::transferPrimaryRegionThermoFields(), kinematicSingleLayer::transferPrimaryRegionThermoFields(), dynamicMotionSolverListFvMesh::update(), dynamicMultiMotionSolverFvMesh::update(), dynamicMotionSolverFvMeshAMI::update(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), reactingOneDim::updateqr(), thermoSingleLayer::updateSurfaceTemperatures(), kinematicSingleLayer::updateSurfaceVelocities(), KinematicCloud< Cloud< basicKinematicCollidingParcel > >::vDotSweep(), and dynamicOversetFvMesh::writeObject().

◆ needReference()

bool needReference ( ) const

Does the field need a reference level for solution.

Definition at line 949 of file GeometricField.C.

Referenced by Foam::setRefCell().

Here is the caller graph for this function:

◆ component() [1/5]

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

Return a component of the field.

Referenced by sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurface::accumulateIntegrand(), adjointSensitivity::computeGradDxDbMultiplier(), correctedLnGrad< Type >::correction(), fourthLnGrad< Type >::correction(), cubic< Type >::correction(), linearUpwind< Type >::correction(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), skewCorrectedSnGrad< Type >::correction(), setFlow::execute(), skewCorrectedSnGrad< Type >::fullGradCorrection(), ATCUaGradU::getFISensitivityTerm(), Foam::fvc::magSqrGradGrad(), skewCorrectedEdgeInterpolation< Type >::skewCorrection(), skewCorrected< Type >::skewCorrection(), surfaceAlignedSBRStressFvMotionSolver::solve(), objectiveForce::update_dxdbMultiplier(), objectiveMoment::update_dxdbMultiplier(), and Foam::writePatchGraph().

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream &  os) const

WriteData member function required by regIOobject.

Definition at line 1035 of file GeometricField.C.

Referenced by GeometricField< Type, fvPatchField, volMesh >::operator/=().

Here is the caller graph for this function:

◆ T()

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > T ( ) const

Return transpose (only if it is a tensor field)

Definition at line 1046 of file GeometricField.C.

Referenced by adjointSensitivity::adjointMeshMovementSource(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), displacementSBRStressFvMotionSolver::solve(), and surfaceAlignedSBRStressFvMotionSolver::solve().

Here is the caller graph for this function:

◆ relax() [1/2]

void relax ( const scalar  alpha)

Relax field (for steady-state solution).

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

Definition at line 972 of file GeometricField.C.

Referenced by diffusionMulticomponent< ReactionThermo, ThermoType >::correct(), adjointSpalartAllmaras::correct(), kinematicThinFilm::evolveRegion(), simple::mainIter(), adjointSimple::mainIter(), and liquidFilmModel::preEvolveRegion().

Here is the caller graph for this function:

◆ relax() [2/2]

void relax ( )

Relax field (for steady-state solution).

alpha is read from controlDict

Definition at line 982 of file GeometricField.C.

◆ select()

Foam::word select ( bool  final) const

Select the final iteration parameters if `final' is true.

by returning the field name + "Final" otherwise the standard parameters by returning the field name

Definition at line 1007 of file GeometricField.C.

◆ writeMinMax()

void writeMinMax ( Ostream &  os) const

Helper function to write the min and max to an Ostream.

Definition at line 1022 of file GeometricField.C.

◆ negate()

void negate ( )

Negate the field inplace.

Definition at line 1189 of file GeometricField.C.

◆ replace() [1/6]

void replace ( const direction  d,
const GeometricField< cmptType, PatchField, GeoMesh > &  gcf 
)

Replace specified field component with content from another field.

Referenced by sensitivityVolBSplinesFI::assembleSensitivities(), correctedLnGrad< Type >::correction(), fourthLnGrad< Type >::correction(), cubic< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), correctedSnGrad< Type >::correction(), fvMatrix< Type >::H(), anisotropicFilter::operator()(), shallowWaterAbsorption::setVelocity(), and surfaceAlignedSBRStressFvMotionSolver::solve().

Here is the caller graph for this function:

◆ replace() [2/6]

void replace ( const direction  d,
const dimensioned< cmptType > &  ds 
)

Replace specified field component with specified value.

Definition at line 1120 of file GeometricField.C.

◆ min()

void min ( const dimensioned< Type > &  dt)

Use the minimum of the field and specified value.

This sets the ceiling on the field values

Definition at line 1132 of file GeometricField.C.

Referenced by kineticTheoryModel::correct(), and laminar::Su().

Here is the caller graph for this function:

◆ max()

void max ( const dimensioned< Type > &  dt)

Use the maximum of the field and specified value.

This sets the floor on the field values

Definition at line 1143 of file GeometricField.C.

Referenced by dynamicKEqn< BasicTurbulenceModel >::Ce(), dynamicKEqn< BasicTurbulenceModel >::correct(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), and reactingOneDim::solveSpeciesMass().

Here is the caller graph for this function:

◆ clip() [1/2]

void clip ( const dimensioned< MinMax< Type >> &  range)

Clip the field to be bounded within the specified range.

Definition at line 1154 of file GeometricField.C.

Referenced by comfort::execute(), and twoPhaseSystem::solve().

Here is the caller graph for this function:

◆ clip() [2/2]

void clip ( const dimensioned< Type > &  minVal,
const dimensioned< Type > &  maxVal 
)

Clip the field to be bounded within the specified range.

Definition at line 1165 of file GeometricField.C.

◆ maxMin()

void maxMin ( const dimensioned< Type > &  minVal,
const dimensioned< Type > &  maxVal 
)

Deprecated(2019-01) identical to clip()

Deprecated:
(2019-01) identical to clip()

Definition at line 1179 of file GeometricField.C.

◆ operator()()

const Foam::GeometricField< Type, PatchField, GeoMesh >::Internal & operator() ( ) const
inline

Return a const-reference to the dimensioned internal field.

Useful in the formulation of source-terms for FV equations

Definition at line 91 of file GeometricFieldI.H.

◆ operator=() [1/3]

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

Definition at line 1200 of file GeometricField.C.

◆ operator=() [2/3]

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

Definition at line 1220 of file GeometricField.C.

◆ operator=() [3/3]

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

Definition at line 1256 of file GeometricField.C.

◆ operator==() [1/2]

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

Definition at line 1267 of file GeometricField.C.

◆ operator==() [2/2]

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

Definition at line 1286 of file GeometricField.C.

◆ operator+=() [1/3]

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

Definition at line 1329 of file GeometricField.C.

◆ operator+=() [2/3]

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

Definition at line 1329 of file GeometricField.C.

◆ operator-=() [1/3]

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

Definition at line 1330 of file GeometricField.C.

◆ operator-=() [2/3]

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

Definition at line 1330 of file GeometricField.C.

◆ operator*=() [1/3]

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

Definition at line 1331 of file GeometricField.C.

◆ operator*=() [2/3]

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

Definition at line 1331 of file GeometricField.C.

◆ operator/=() [1/3]

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

Definition at line 1332 of file GeometricField.C.

◆ operator/=() [2/3]

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

Definition at line 1332 of file GeometricField.C.

◆ operator+=() [3/3]

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

Definition at line 1329 of file GeometricField.C.

◆ operator-=() [3/3]

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

Definition at line 1330 of file GeometricField.C.

◆ operator*=() [3/3]

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

Definition at line 1331 of file GeometricField.C.

◆ operator/=() [3/3]

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

Definition at line 1332 of file GeometricField.C.

◆ component() [2/5]

tmp< GeometricField< scalar, faPatchField, areaMesh > > component ( const  direction) const

Definition at line 61 of file areaFields.C.

◆ replace() [3/6]

void replace ( const  direction,
const GeometricField< scalar, faPatchField, areaMesh > &  gsf 
)

Definition at line 70 of file areaFields.C.

◆ component() [3/5]

tmp< GeometricField< scalar, faPatchField, areaMesh > > component ( const  direction) const

◆ replace() [4/6]

void replace ( const  direction,
const GeometricField< scalar, faPatchField, areaMesh > &  sf 
)

◆ component() [4/5]

tmp< GeometricField< scalar, fvPatchField, volMesh > > component ( const  direction) const

Definition at line 68 of file volFields.C.

◆ replace() [5/6]

void replace ( const  direction,
const GeometricField< scalar, fvPatchField, volMesh > &  gsf 
)

Definition at line 78 of file volFields.C.

◆ component() [5/5]

tmp< GeometricField< scalar, fvPatchField, volMesh > > component ( const  direction) const

◆ replace() [6/6]

void replace ( const  direction,
const GeometricField< scalar, fvPatchField, volMesh > &  sf 
)

Friends And Related Function Documentation

◆ operator [1/2]

Ostream& operator ( Ostream &  ,
const GeometricField< Type, PatchField, GeoMesh > &   
)
friend

◆ operator [2/2]

Ostream& operator ( Ostream &  ,
const tmp< GeometricField< Type, PatchField, GeoMesh >> &   
)
friend
The documentation for this class was generated from the following files: