GeometricField< Type, PatchField, GeoMesh > Class Template Reference

Generic GeometricField class. More...

#include <OpenFOAM/GeometricField.H>

---

Detailed Description

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

Generic GeometricField class.

Source files

• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricField.H
• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricFieldI.H
• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricField.C
• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricBoundaryField.C
• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricFieldFunctions.H
• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricFieldFunctions.C

Definition at line 80 of file GeometricField.H.

Inheritance diagram for GeometricField< Type, PatchField, GeoMesh >:

Collaboration diagram for GeometricField< Type, PatchField, GeoMesh >:

List of all members.

Classes
class	GeometricBoundaryField
Public Types
typedef GeoMesh::Mesh	Mesh
typedef GeoMesh::BoundaryMesh	BoundaryMesh
typedef DimensionedField< Type, GeoMesh >	DimensionedInternalField
typedef Field< Type >	InternalField
typedef PatchField< Type >	PatchFieldType
typedef Field< Type >::cmptType	cmptType
	Component type.
Public Member Functions
	TypeName ("GeometricField")
	Runtime type information.
	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=PatchField< Type >::calculatedType())
	Constructor given IOobject, mesh, dimensions and patch type.
	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const wordList &patchFieldTypes)
	Constructor given IOobject, mesh, dimensions and patch types.
	GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=PatchField< Type >::calculatedType())
	Constructor given IOobject, mesh, dimensioned<Type> and patch type.
	GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const wordList &patchFieldTypes)
	Constructor given IOobject, mesh, dimensioned<Type> and patch types.
	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &, const PtrList< PatchField< Type > > &)
	Constructor from components.
	GeometricField (const IOobject &, const Mesh &)
	Construct and read given IOobject.
	GeometricField (const IOobject &, const Mesh &, Istream &)
	Construct and read from given stream.
	GeometricField (const IOobject &, const Mesh &, const dictionary &)
	Construct from dictionary.
	GeometricField (const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy.
	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy of tmp<GeometricField> deleting argument.
	GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy resetting name.
	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const word &patchFieldType)
	Construct as copy resetting name.
	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const wordList &patchFieldTypes)
	Construct as copy resetting IO parameters and boundary types.
virtual	~GeometricField ()
	Destructor.
DimensionedInternalField &	dimensionedInternalField ()
	Return dimensioned internal field.
const DimensionedInternalField &	dimensionedInternalField () const
	Return dimensioned internal field.
InternalField &	internalField ()
	Return internal field.
const InternalField &	internalField () const
	Return internal field.
GeometricBoundaryField &	boundaryField ()
	Return reference to GeometricBoundaryField.
const GeometricBoundaryField &	boundaryField () const
	Return reference to GeometricBoundaryField for const field.
label	timeIndex () const
	Return the time index of the field.
label &	timeIndex ()
	Return the time index of the field.
void	storeOldTimes () const
	Store the old-time fields.
void	storeOldTime () const
	Store the old-time field.
label	nOldTimes () const
	Return the number of old time fields stored.
const GeometricField< Type, PatchField, GeoMesh > &	oldTime () const
	Return old time field.
GeometricField< Type, PatchField, GeoMesh > &	oldTime ()
	Return non-const old time field.
void	storePrevIter () const
	Store the field as the previous iteration value.
const GeometricField< Type, PatchField, GeoMesh > &	prevIter () const
	Return previous iteration field.
void	correctBoundaryConditions ()
	Correct boundary field.
bool	needReference () const
	Does the field need a reference level for solution.
tmp< GeometricField< cmptType, PatchField, GeoMesh > >	component (const direction) const
	Return a component of the field.
bool	writeData (Ostream &) const
	WriteData member function required by regIOobject.
tmp< GeometricField< Type, PatchField, GeoMesh > >	T () const
	Return transpose (only if it is a tensor field)
void	relax (const scalar alpha)
	Relax field (for steady-state solution).
void	relax ()
	Relax field (for steady-state solution).
word	select (bool final) const
	Select the final iteration parameters if `final' is true.
void	negate ()
	Negate this field.
void	replace (const direction, const GeometricField< cmptType, PatchField, GeoMesh > &)
void	replace (const direction, const dimensioned< cmptType > &)
void	max (const dimensioned< Type > &)
void	min (const dimensioned< Type > &)
void	max (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)
void	min (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)
void	scale (const GeometricField< Type, PatchField, GeoMesh > &, const GeometricField< Type, PatchField, GeoMesh > &)
void	scale (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)
void	operator= (const GeometricField< Type, PatchField, GeoMesh > &)
void	operator= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
void	operator= (const dimensioned< Type > &)
void	operator== (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
void	operator== (const dimensioned< Type > &)
void	operator+= (const GeometricField< Type, PatchField, GeoMesh > &)
void	operator+= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
void	operator-= (const GeometricField< Type, PatchField, GeoMesh > &)
void	operator-= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
void	operator*= (const GeometricField< scalar, PatchField, GeoMesh > &)
void	operator*= (const tmp< GeometricField< scalar, PatchField, GeoMesh > > &)
void	operator/= (const GeometricField< scalar, PatchField, GeoMesh > &)
void	operator/= (const tmp< GeometricField< scalar, PatchField, GeoMesh > > &)
void	operator+= (const dimensioned< Type > &)
void	operator-= (const dimensioned< Type > &)
void	operator*= (const dimensioned< scalar > &)
void	operator/= (const dimensioned< scalar > &)
template<>
tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const
	Return a component field of the field.
template<>
void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf)
template<>
tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const
	Return a component field of the field.
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.
Friends
Ostream &	operator (Ostream &, const GeometricField< Type, PatchField, GeoMesh > &)
Ostream &	operator (Ostream &, const tmp< GeometricField< Type, PatchField, GeoMesh > > &)

---

Member Typedef Documentation

typedef GeoMesh::Mesh Mesh

Reimplemented from DimensionedField< Type, GeoMesh >.

Reimplemented in SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >.

Definition at line 97 of file GeometricField.H.

typedef GeoMesh::BoundaryMesh BoundaryMesh

Reimplemented in SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >.

Definition at line 98 of file GeometricField.H.

typedef DimensionedField<Type, GeoMesh> DimensionedInternalField

Definition at line 100 of file GeometricField.H.

typedef Field<Type> InternalField

Definition at line 101 of file GeometricField.H.

typedef PatchField<Type> PatchFieldType

Definition at line 102 of file GeometricField.H.

typedef Field<Type>::cmptType cmptType

Component type.

Reimplemented from DimensionedField< Type, GeoMesh >.

Definition at line 257 of file GeometricField.H.

---

Constructor & Destructor Documentation

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

Constructor given IOobject, mesh, dimensions and patch type.

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

Definition at line 200 of file GeometricField.C.

References Foam::endl(), Foam::Info, and readIfPresent().

GeometricField	(	const IOobject &	io,
		const Mesh &	mesh,
		const dimensionSet &	ds,
		const wordList &	patchFieldTypes
	)

Constructor given IOobject, mesh, dimensions and patch types.

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

Definition at line 230 of file GeometricField.C.

References Foam::endl(), Foam::Info, and readIfPresent().

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

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

Definition at line 257 of file GeometricField.C.

References Foam::endl(), Foam::Info, readIfPresent(), and dimensioned< Type >::value().

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

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

Definition at line 286 of file GeometricField.C.

References Foam::endl(), Foam::Info, readIfPresent(), and dimensioned< Type >::value().

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

Constructor from components.

Definition at line 315 of file GeometricField.C.

References Foam::endl(), Foam::Info, and readIfPresent().

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

Construct and read given IOobject.

Definition at line 342 of file GeometricField.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, and mesh.

GeometricField	(	const IOobject &	io,
		const Mesh &	mesh,
		Istream &	is
	)

Construct and read from given stream.

Definition at line 382 of file GeometricField.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, and mesh.

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

Construct from dictionary.

Definition at line 421 of file GeometricField.C.

References Foam::endl(), Foam::exit(), FatalErrorIn, Foam::FatalIOError, Foam::Info, and mesh.

GeometricField

(

const GeometricField< Type, PatchField, GeoMesh > &

gf  )

Construct as copy.

Definition at line 460 of file GeometricField.C.

References Foam::endl(), and Foam::Info.

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

Construct as copy of tmp<GeometricField> deleting argument.

Construct as copy resetting IO parameters

Definition at line 523 of file GeometricField.C.

References Foam::endl(), Foam::Info, IOobject::name(), and readIfPresent().

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

Construct as copy resetting name.

Definition at line 555 of file GeometricField.C.

References Foam::endl(), Foam::Info, and readIfPresent().

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

Construct as copy resetting name.

Construct as copy resetting IO parameters and patch type

Definition at line 618 of file GeometricField.C.

References Foam::endl(), Foam::Info, IOobject::name(), and readIfPresent().

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

Construct as copy resetting IO parameters and boundary types.

Definition at line 653 of file GeometricField.C.

References Foam::endl(), Foam::Info, IOobject::name(), and readIfPresent().

~GeometricField

(

)

[virtual]

Destructor.

Definition at line 688 of file GeometricField.C.

References Foam::deleteDemandDrivenData().

---

Member Function Documentation

TypeName

(

"GeometricField< Type, PatchField, GeoMesh >"

)

Runtime type information.

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

(

)

[inline, static]

Return a null geometric field.

Reimplemented from DimensionedField< Type, GeoMesh >.

Definition at line 30 of file GeometricFieldI.H.

Foam::GeometricField< Type, PatchField, GeoMesh >::DimensionedInternalField & dimensionedInternalField

(

)

Return dimensioned internal field.

Definition at line 700 of file GeometricField.C.

Referenced by ODEChemistryModel< CompType, ThermoType >::dQ(), Foam::operator<<(), GeometricField< Type, PatchField, GeoMesh >::operator=(), and GeometricField< Type, PatchField, GeoMesh >::operator==().

const Foam::GeometricField< Type, PatchField, GeoMesh >::DimensionedInternalField & dimensionedInternalField

(

)

const [inline]

Return dimensioned internal field.

Definition at line 41 of file GeometricFieldI.H.

Foam::GeometricField< Type, PatchField, GeoMesh >::InternalField & internalField

(

)

Return internal field.

Definition at line 711 of file GeometricField.C.

Referenced by Foam::fvc::average(), Foam::bound(), Foam::calcEk(), Foam::cmptAv(), Foam::component(), SpalartAllmaras::correct(), wideBandAbsorptionEmission::correct(), absorptionEmissionModel::correct(), inverseVolumeDiffusivity::correct(), inverseDistanceDiffusivity::correct(), pointLinear< Type >::correction(), limitedSnGrad< Type >::correction(), hRhoMixtureThermo< MixtureType >::Cp(), hPsiMixtureThermo< MixtureType >::Cp(), hhuMixtureThermo< MixtureType >::Cp(), wideBandAbsorptionEmission::ECont(), ePsiThermo< MixtureType >::ePsiThermo(), errorEstimate< Type >::error(), faceAreaPairGAMGAgglomeration::faceAreaPairGAMGAgglomeration(), fvMatrix< Type >::flux(), EulerD2dt2Scheme< Type >::fvcD2dt2(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), CrankNicholsonDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), boundedBackwardDdtScheme::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), EulerD2dt2Scheme< Type >::fvmD2dt2(), SLTSDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), EulerDdtScheme< Type >::fvmDdt(), CrankNicholsonDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), boundedBackwardDdtScheme::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), gaussConvectionScheme< Type >::fvmDiv(), faceLimitedGrad< Type >::grad(), cellMDLimitedGrad< Type >::grad(), cellLimitedGrad< Type >::grad(), fvMatrix< Type >::H(), hsRhoMixtureThermo< MixtureType >::hc(), hRhoMixtureThermo< MixtureType >::hc(), hsPsiMixtureThermo< MixtureType >::hc(), hPsiMixtureThermo< MixtureType >::hc(), hhuMixtureThermo< MixtureType >::hc(), hhuMixtureThermo< MixtureType >::hhuMixtureThermo(), hPsiMixtureThermo< MixtureType >::hPsiMixtureThermo(), hPsiThermo< MixtureType >::hPsiThermo(), hRhoMixtureThermo< MixtureType >::hRhoMixtureThermo(), hRhoThermo< MixtureType >::hRhoThermo(), hsPsiMixtureThermo< MixtureType >::hsPsiMixtureThermo(), hsPsiThermo< MixtureType >::hsPsiThermo(), hsRhoMixtureThermo< MixtureType >::hsRhoMixtureThermo(), hsRhoThermo< MixtureType >::hsRhoThermo(), Foam::MULES::implicitSolve(), pointPatchInterpolation::interpolate(), surfaceInterpolationScheme< Type >::interpolate(), fvMeshSubset::interpolate(), isoSurface::isoSurface(), Kmesh::Kmesh(), laplaceFilter::laplaceFilter(), Foam::mag(), Foam::magSqr(), Foam::makeGraph(), Foam::MapGeometricFields(), fvMesh::movePoints(), hhuMixtureThermo< MixtureType >::mub(), hhuMixtureThermo< MixtureType >::muu(), errorEstimate< Type >::normFactor(), Foam::operator&(), GeometricField< Type, PatchField, GeoMesh >::operator=(), Foam::pow(), hhuMixtureThermo< MixtureType >::psib(), hhuMixtureThermo< MixtureType >::psiu(), fvMatrix< Type >::residual(), errorEstimate< Type >::residual(), SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >::SlicedGeometricField(), Foam::resError::Sp(), Foam::sqr(), Foam::stabilise(), Foam::fvm::SuSp(), Foam::T(), Foam::transform(), Foam::fvc::volumeIntegrate(), limitedSurfaceInterpolationScheme< Type >::weights(), and Foam::writeCellGraph().

const Foam::GeometricField< Type, PatchField, GeoMesh >::InternalField & internalField

(

)

const [inline]

Return internal field.

Definition at line 51 of file GeometricFieldI.H.

Foam::GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField & boundaryField

(

)

Return reference to GeometricBoundaryField.

Definition at line 723 of file GeometricField.C.

Referenced by MRFZone::absoluteVelocity(), Foam::adjustPhi(), Foam::fvc::average(), Foam::bound(), forces::calcForcesMoment(), mutWallFunctionFvPatchScalarField::calcMut(), mutSpalartAllmarasWallFunctionFvPatchScalarField::calcMut(), mutSpalartAllmarasStandardWallFunctionFvPatchScalarField::calcMut(), mutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField::calcMut(), mutRoughWallFunctionFvPatchScalarField::calcMut(), mutkWallFunctionFvPatchScalarField::calcMut(), mutSpalartAllmarasWallFunctionFvPatchScalarField::calcUTau(), mutSpalartAllmarasStandardWallFunctionFvPatchScalarField::calcYPlus(), mutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField::calcYPlus(), fvPatch::Cf(), Foam::cmptAv(), extendedFaceToCellStencil::collectData(), extendedCellToFaceStencil::collectData(), Foam::component(), LienCubicKE::correct(), kOmega::correct(), RNGkEpsilon::correct(), realizableKE::correct(), LRR::correct(), LaunderGibsonRSTM::correct(), kEpsilon::correct(), SpalartAllmaras::correct(), MixedDiffuseSpecular< CloudType >::correct(), MaxwellianThermal< CloudType >::correct(), reflectionVectors::correct(), gaussGrad< Type >::correctBoundaryConditions(), motionSmoother::correctBoundaryConditions(), MRFZone::correctBoundaryVelocity(), outletStabilised< Type >::correction(), cubic< Type >::correction(), linearUpwind< Type >::correction(), hRhoMixtureThermo< MixtureType >::Cp(), hPsiMixtureThermo< MixtureType >::Cp(), hhuMixtureThermo< MixtureType >::Cp(), hRhoThermo< MixtureType >::Cp(), hsPsiThermo< MixtureType >::Cp(), hPsiThermo< MixtureType >::Cp(), ePsiThermo< MixtureType >::Cp(), hRhoThermo< MixtureType >::Cv(), hPsiThermo< MixtureType >::Cv(), ePsiThermo< MixtureType >::Cv(), fvPatch::deltaCoeffs(), Foam::resError::div(), basicThermo::eBoundaryCorrection(), kOmega::epsilon(), kOmegaSST::epsilon(), ePsiThermo< MixtureType >::ePsiThermo(), errorEstimate< Type >::error(), alphaSgsJayatillekeWallFunctionFvPatchScalarField::evaluate(), faceSource::filterField(), fvMatrix< Type >::flux(), EulerD2dt2Scheme< Type >::fvcD2dt2(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), CrankNicholsonDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), boundedBackwardDdtScheme::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), ddtScheme< Type >::fvcDdtPhiCoeff(), CrankNicholsonDdtScheme< Type >::fvmDdt(), gaussConvectionScheme< Type >::fvmDiv(), faceMDLimitedGrad< Type >::grad(), faceLimitedGrad< Type >::grad(), cellMDLimitedGrad< Type >::grad(), cellLimitedGrad< Type >::grad(), basicThermo::hBoundaryCorrection(), basicThermo::hBoundaryTypes(), hsRhoMixtureThermo< MixtureType >::hc(), hRhoMixtureThermo< MixtureType >::hc(), hsPsiMixtureThermo< MixtureType >::hc(), hPsiMixtureThermo< MixtureType >::hc(), hhuMixtureThermo< MixtureType >::hc(), hhuMixtureThermo< MixtureType >::hhuMixtureThermo(), hPsiMixtureThermo< MixtureType >::hPsiMixtureThermo(), hPsiThermo< MixtureType >::hPsiThermo(), hRhoMixtureThermo< MixtureType >::hRhoMixtureThermo(), hRhoThermo< MixtureType >::hRhoThermo(), hsPsiMixtureThermo< MixtureType >::hsPsiMixtureThermo(), hsPsiThermo< MixtureType >::hsPsiThermo(), hsRhoMixtureThermo< MixtureType >::hsRhoMixtureThermo(), hsRhoThermo< MixtureType >::hsRhoThermo(), hhuCombustionThermo::huBoundaryCorrection(), hhuCombustionThermo::huBoundaryTypes(), meshToMesh::interpolate(), pointPatchInterpolation::interpolate(), surfaceInterpolationScheme< Type >::interpolate(), localMin< Type >::interpolate(), localMax< Type >::interpolate(), fvMeshSubset::interpolate(), PhiScheme< Type, PhiLimiter >::limiter(), LimitedScheme< Type, Limiter, LimitFunc >::limiter(), Foam::MULES::limiter(), Foam::mag(), fvPatch::magSf(), Foam::magSqr(), Foam::fv::makeFvGradScheme(), Foam::MapGeometricFields(), fvMotionSolverEngineMesh::move(), fvMesh::movePoints(), hhuMixtureThermo< MixtureType >::mub(), hhuMixtureThermo< MixtureType >::muu(), errorEstimate< Type >::normFactor(), Foam::operator<<(), GeometricField< Type, PatchField, GeoMesh >::operator=(), GeometricField< Type, PatchField, GeoMesh >::operator==(), veryInhomogeneousMixture< ThermoType >::patchFaceMixture(), inhomogeneousMixture< ThermoType >::patchFaceMixture(), homogeneousMixture< ThermoType >::patchFaceMixture(), egrMixture< ThermoType >::patchFaceMixture(), dieselMixture< ThermoType >::patchFaceMixture(), veryInhomogeneousMixture< ThermoType >::patchFaceProducts(), inhomogeneousMixture< ThermoType >::patchFaceProducts(), egrMixture< ThermoType >::patchFaceProducts(), dieselMixture< ThermoType >::patchFaceProducts(), veryInhomogeneousMixture< ThermoType >::patchFaceReactants(), inhomogeneousMixture< ThermoType >::patchFaceReactants(), egrMixture< ThermoType >::patchFaceReactants(), dieselMixture< ThermoType >::patchFaceReactants(), fvPatch::patchField(), Foam::pow(), hhuMixtureThermo< MixtureType >::psib(), hhuMixtureThermo< MixtureType >::psiu(), qZeta::R(), NonlinearKEShih::R(), LienLeschzinerLowRe::R(), LienCubicKELowRe::R(), LienCubicKE::R(), LamBremhorstKE::R(), kOmega::R(), RNGkEpsilon::R(), realizableKE::R(), LaunderSharmaKE::R(), kOmegaSST::R(), kEpsilon::R(), dynamicRefineFvMesh::refine(), MRFZone::relativeVelocity(), fvMatrix< Type >::residual(), errorEstimate< Type >::residual(), fvPatch::Sf(), snGradScheme< Type >::snGrad(), Foam::sqr(), Foam::stabilise(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), Foam::T(), Foam::transform(), dynamicRefineFvMesh::unrefine(), incompressible::fixedShearStressFvPatchVectorField::updateCoeffs(), mixedUnburntEnthalpyFvPatchScalarField::updateCoeffs(), gradientUnburntEnthalpyFvPatchScalarField::updateCoeffs(), fixedUnburntEnthalpyFvPatchScalarField::updateCoeffs(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), wallHeatTransferFvPatchScalarField::updateCoeffs(), mixedInternalEnergyFvPatchScalarField::updateCoeffs(), mixedEnthalpyFvPatchScalarField::updateCoeffs(), gradientInternalEnergyFvPatchScalarField::updateCoeffs(), gradientEnthalpyFvPatchScalarField::updateCoeffs(), fixedInternalEnergyFvPatchScalarField::updateCoeffs(), fixedEnthalpyFvPatchScalarField::updateCoeffs(), outletMappedUniformInletFvPatchField< Type >::updateCoeffs(), directMappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), advectiveFvPatchField< Type >::updateCoeffs(), extendedUpwindCellToFaceStencil::weightedSum(), outletStabilised< Type >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), fvPatch::weights(), dsmcFields::write(), ensightParts::writeField(), Foam::writePatchGraph(), nutWallFunctionFvPatchScalarField::yPlus(), RASModel::yPlus(), mutWallFunctionFvPatchScalarField::yPlus(), mutSpalartAllmarasWallFunctionFvPatchScalarField::yPlus(), mutSpalartAllmarasStandardWallFunctionFvPatchScalarField::yPlus(), mutSpalartAllmarasStandardRoughWallFunctionFvPatchScalarField::yPlus(), and mutkWallFunctionFvPatchScalarField::yPlus().

const Foam::GeometricField< Type, PatchField, GeoMesh >::GeometricBoundaryField & boundaryField

(

)

const [inline]

Return reference to GeometricBoundaryField for const field.

Definition at line 60 of file GeometricFieldI.H.

Foam::label timeIndex

(

)

const [inline]

Return the time index of the field.

Definition at line 68 of file GeometricFieldI.H.

Referenced by fvMesh::phi(), and subCycle< GeometricField >::~subCycle().

Foam::label & timeIndex

(

)

[inline]

Return the time index of the field.

Definition at line 76 of file GeometricFieldI.H.

void storeOldTimes

(

)

const

Store the old-time fields.

Definition at line 733 of file GeometricField.C.

References Foam::name(), and timeIndex.

Referenced by Foam::MapGeometricFields().

void storeOldTime

(

)

const

Store the old-time field.

Definition at line 754 of file GeometricField.C.

References Foam::endl(), Foam::Info, and GeometricField< Type, PatchField, GeoMesh >::storeOldTime().

Referenced by GeometricField< Type, PatchField, GeoMesh >::storeOldTime().

Foam::label nOldTimes

(

)

const

Return the number of old time fields stored.

Definition at line 778 of file GeometricField.C.

References GeometricField< Type, PatchField, GeoMesh >::nOldTimes().

Referenced by GeometricField< Type, PatchField, GeoMesh >::nOldTimes().

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

(

)

const

Return old time field.

Definition at line 793 of file GeometricField.C.

References Foam::name(), and timeName.

Referenced by ePsiThermo< MixtureType >::ePsiThermo(), Foam::MULES::explicitSolve(), EulerD2dt2Scheme< Type >::fvcD2dt2(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), CrankNicholsonDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), boundedBackwardDdtScheme::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdtPhiCorr(), localEulerDdtScheme< Type >::fvcDdtPhiCorr(), EulerDdtScheme< Type >::fvcDdtPhiCorr(), CrankNicholsonDdtScheme< Type >::fvcDdtPhiCorr(), CoEulerDdtScheme< Type >::fvcDdtPhiCorr(), backwardDdtScheme< Type >::fvcDdtPhiCorr(), EulerD2dt2Scheme< Type >::fvmD2dt2(), SLTSDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), EulerDdtScheme< Type >::fvmDdt(), CrankNicholsonDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), boundedBackwardDdtScheme::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), hhuMixtureThermo< MixtureType >::hhuMixtureThermo(), hPsiMixtureThermo< MixtureType >::hPsiMixtureThermo(), hPsiThermo< MixtureType >::hPsiThermo(), hsPsiMixtureThermo< MixtureType >::hsPsiMixtureThermo(), hsPsiThermo< MixtureType >::hsPsiThermo(), Foam::MULES::limiter(), CrankNicholsonDdtScheme< Type >::meshPhi(), backwardDdtScheme< Type >::meshPhi(), GeometricField< Type, PatchField, GeoMesh >::oldTime(), advectiveFvPatchField< Type >::updateCoeffs(), and subCycle< GeometricField >::~subCycle().

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 819 of file GeometricField.C.

References GeometricField< Type, PatchField, GeoMesh >::oldTime().

void storePrevIter

(

)

const

Store the field as the previous iteration value.

Definition at line 830 of file GeometricField.C.

References Foam::endl(), Foam::Info, and Foam::name().

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

(

)

const

Return previous iteration field.

Definition at line 856 of file GeometricField.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, and FatalErrorIn.

void correctBoundaryConditions

(

)

Correct boundary field.

Reimplemented in SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >, SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >, SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >, SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >, SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >, and SlicedGeometricField< Type, PatchField, SlicedPatchField, GeoMesh >.

Definition at line 876 of file GeometricField.C.

Referenced by porousZones::addResistance(), porousZone::addResistance(), Foam::fvc::average(), qZeta::correct(), LienCubicKE::correct(), kOmega::correct(), RNGkEpsilon::correct(), realizableKE::correct(), LRR::correct(), LaunderGibsonRSTM::correct(), kOmegaSST::correct(), kEpsilon::correct(), SpalartAllmaras::correct(), inverseVolumeDiffusivity::correct(), inverseDistanceDiffusivity::correct(), errorEstimate< Type >::error(), Foam::MULES::explicitSolve(), faceMDLimitedGrad< Type >::grad(), faceLimitedGrad< Type >::grad(), cellMDLimitedGrad< Type >::grad(), cellLimitedGrad< Type >::grad(), fvMatrix< Type >::H(), pointPatchInterpolation::interpolate(), Foam::fv::makeFvGradScheme(), errorEstimate< Type >::normFactor(), Foam::operator&(), errorEstimate< Type >::residual(), motionSmoother::smooth(), solidBodyMotionFvMesh::update(), dynamicMotionSolverFvMesh::update(), and dynamicInkJetFvMesh::update().

bool needReference

(

)

const

Does the field need a reference level for solution.

Definition at line 886 of file GeometricField.C.

References forAll, and Foam::reduce().

Referenced by Foam::adjustPhi(), and Foam::setRefCell().

tmp<GeometricField<cmptType, PatchField, GeoMesh> > component

(

const

direction  )

const

Return a component of the field.

Reimplemented from DimensionedField< Type, GeoMesh >.

Referenced by anisotropicFilter::anisotropicFilter(), LRRDiffStress::correct(), DeardorffDiffStress::correct(), cubic< Type >::correction(), correctedSnGrad< Type >::correction(), Foam::fvc::magSqrGradGrad(), and skewCorrected< Type >::skewCorrection().

bool writeData

(

Ostream &

os  )

const [virtual]

WriteData member function required by regIOobject.

Reimplemented from DimensionedField< Type, GeoMesh >.

Definition at line 952 of file GeometricField.C.

References IOstream::good().

Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > T

(

)

const

Return transpose (only if it is a tensor field)

Reimplemented from DimensionedField< Type, GeoMesh >.

Definition at line 963 of file GeometricField.C.

References boundaryField(), mesh, Foam::name(), and Foam::T().

Referenced by LienCubicKELowRe::correct(), LienCubicKE::correct(), ThermoCloud< ParcelType >::evolveCloud(), ReactingMultiphaseCloud< ParcelType >::evolveCloud(), ReactingCloud< ParcelType >::evolveCloud(), and displacementSBRStressFvMotionSolver::solve().

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 909 of file GeometricField.C.

References Foam::operator==().

void relax

(

)

Relax field (for steady-state solution).

alpha is read from controlDict

Definition at line 916 of file GeometricField.C.

References mesh, Foam::name(), relax(), and solution::relaxationFactor().

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 934 of file GeometricField.C.

References Foam::name().

void negate

(

)

Negate this field.

Reimplemented from Field< Type >.

Definition at line 1076 of file GeometricField.C.

References boundaryField(), and GeometricField< Type, PatchField, GeoMesh >::negate().

Referenced by GeometricField< Type, PatchField, GeoMesh >::negate(), and Foam::operator-().

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

Referenced by cubic< Type >::correction(), correctedSnGrad< Type >::correction(), fvMatrix< Type >::H(), and GeometricField< Type, PatchField, GeoMesh >::replace().

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

Definition at line 1043 of file GeometricField.C.

References boundaryField(), GeometricField< Type, PatchField, GeoMesh >::replace(), and dimensioned< Type >::value().

void max

(

const dimensioned< Type > &

dt  )

Definition at line 1055 of file GeometricField.C.

References boundaryField(), Foam::max(), and dimensioned< Type >::value().

Referenced by locDynOneEqEddy::correct(), LRR::correct(), and LaunderGibsonRSTM::correct().

void min

(

const dimensioned< Type > &

dt  )

Definition at line 1066 of file GeometricField.C.

References boundaryField(), Foam::min(), and dimensioned< Type >::value().

Referenced by octreeDataEdges::octreeDataEdges().

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

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

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

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

void operator=

(

const GeometricField< Type, PatchField, GeoMesh > &

gf  )

Definition at line 1087 of file GeometricField.C.

References Foam::abort(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), boundaryField(), checkField, GeometricField< Type, PatchField, GeoMesh >::dimensionedInternalField(), Foam::FatalError, and FatalErrorIn.

void operator=

(

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

tgf  )

Definition at line 1112 of file GeometricField.C.

References Foam::abort(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), boundaryField(), checkField, PtrList< T >::clear(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::FatalError, FatalErrorIn, and GeometricField< Type, PatchField, GeoMesh >::internalField().

void operator=

(

const dimensioned< Type > &

dt  )

Reimplemented from DimensionedField< Type, GeoMesh >.

Definition at line 1148 of file GeometricField.C.

References boundaryField(), and dimensioned< Type >::value().

void operator==

(

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

tgf  )

Definition at line 1159 of file GeometricField.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), boundaryField(), checkField, PtrList< T >::clear(), and GeometricField< Type, PatchField, GeoMesh >::dimensionedInternalField().

void operator==

(

const dimensioned< Type > &

dt  )

Definition at line 1178 of file GeometricField.C.

References boundaryField(), and dimensioned< Type >::value().

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

)

Reimplemented from DimensionedField< Type, GeoMesh >.

void operator-=

(

const dimensioned< Type > &

)

Reimplemented from DimensionedField< Type, GeoMesh >.

void operator*=

(

const dimensioned< scalar > &

)

Reimplemented from DimensionedField< Type, GeoMesh >.

void operator/=

(

const dimensioned< scalar > &

)

Reimplemented from DimensionedField< Type, GeoMesh >.

tmp< GeometricField< scalar, fvPatchField, volMesh > > component

(

const

direction  )

const

Return a component field of the field.

Reimplemented from DimensionedField< Type, GeoMesh >.

Definition at line 50 of file volFields.C.

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

Definition at line 59 of file volFields.C.

tmp< GeometricField< scalar, fvPatchField, volMesh > > component

(

const

direction  )

const

Return a component field of the field.

Reimplemented from DimensionedField< Type, GeoMesh >.

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

Definition at line 191 of file dimensionedType.C.

---

Friends And Related Function Documentation

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

Referenced by displacementSBRStressFvMotionSolver::solve().

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

---

The documentation for this class was generated from the following files:

• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricField.H
• src/OpenFOAM/dimensionedTypes/dimensionedType/dimensionedType.C
• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricField.C
• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricFieldI.H