GeometricField Class Reference

Generic GeometricField class. More...

Inheritance diagram for GeometricField:

Collaboration diagram for GeometricField:

Data Structures
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

Public Member Functions
	TypeName ("GeometricField")
	Runtime type information. More...
	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=PatchField< Type >::calculatedType())
	Constructor given IOobject, mesh, dimensions and patch type. More...
	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Constructor given IOobject, mesh, dimensions and patch types. More...
	GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=PatchField< Type >::calculatedType())
	Constructor given IOobject, mesh, dimensioned<Type> and patch type. More...
	GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Constructor given IOobject, mesh, dimensioned<Type> and patch types. More...
	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &, const PtrList< PatchField< Type > > &)
	Constructor from components. More...
	GeometricField (const IOobject &, const Mesh &, const bool readOldTime=true)
	Construct and read given IOobject. More...
	GeometricField (const IOobject &, const Mesh &, const dictionary &)
	Construct from dictionary. More...
	GeometricField (const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy. More...
	GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
	Construct as copy of tmp<GeometricField> deleting argument. More...
	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy resetting IO parameters. More...
	GeometricField (const IOobject &, const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
	Construct as copy of tmp<GeometricField> resetting IO parameters. More...
	GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy resetting name. More...
	GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
	Construct as copy resetting name. More...
	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const word &patchFieldType)
	Construct as copy resetting IO parameters and patch type. More...
	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...
virtual	~GeometricField ()
	Destructor. More...
DimensionedInternalField &	dimensionedInternalField ()
	Return dimensioned internal field. More...
const DimensionedInternalField &	dimensionedInternalField () const
	Return dimensioned internal field. More...
InternalField &	internalField ()
	Return internal field. More...
const InternalField &	internalField () const
	Return internal field. More...
GeometricBoundaryField &	boundaryField ()
	Return reference to GeometricBoundaryField. More...
const GeometricBoundaryField &	boundaryField () const
	Return reference to GeometricBoundaryField for const 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 ()
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 > &)
tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const
void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf)
tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const
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...

Private Member Functions
bool	readIfPresent ()
	Read from file if it is present. More...
bool	readOldTimeIfPresent ()
	Read old time field from file if it is present. More...
void	readFields (const dictionary &)
	Read the field from the dictionary. More...
void	readFields ()
	Read the field - create the field dictionary on-the-fly. More...

Private Attributes
label	timeIndex_
	Current time index. More...
GeometricField< Type, PatchField, GeoMesh > *	field0Ptr_
	Pointer to old time field. More...
GeometricField< Type, PatchField, GeoMesh > *	fieldPrevIterPtr_
	Pointer to previous iteration (used for under-relaxation) More...
GeometricBoundaryField	boundaryField_
	Boundary Type field containing boundary field values. More...

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

Detailed Description

Generic GeometricField class.

Source files

• GeometricField.H
• GeometricFieldI.H
• GeometricField.C
• GeometricBoundaryField.C
• GeometricFieldFunctions.H
• GeometricFieldFunctions.C

Definition at line 52 of file surfaceFieldsFwd.H.

Member Typedef Documentation

Mesh

typedef GeoMesh::Mesh Mesh

Definition at line 97 of file GeometricField.H.

BoundaryMesh

typedef GeoMesh::BoundaryMesh BoundaryMesh

Definition at line 98 of file GeometricField.H.

DimensionedInternalField

typedef DimensionedField<Type, GeoMesh> DimensionedInternalField

Definition at line 100 of file GeometricField.H.

InternalField

typedef Field<Type> InternalField

Definition at line 101 of file GeometricField.H.

PatchFieldType

typedef PatchField<Type> PatchFieldType

Definition at line 102 of file GeometricField.H.

cmptType

typedef Field<Type>::cmptType cmptType

Definition at line 273 of file GeometricField.H.

Constructor & Destructor Documentation

GeometricField() [1/15]

GeometricField	(	const IOobject &	,
		const Mesh &	,
		const dimensionSet &	,
		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

GeometricField() [2/15]

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

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

GeometricField() [3/15]

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

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

GeometricField() [4/15]

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

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

GeometricField() [5/15]

GeometricField	(	const IOobject &	,
		const Mesh &	,
		const dimensionSet &	,
		const Field< Type > &	,
		const PtrList< PatchField< Type > > &
	)

Constructor from components.

GeometricField() [6/15]

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

Construct and read given IOobject.

GeometricField() [7/15]

GeometricField	(	const IOobject &	,
		const Mesh &	,
		const dictionary &
	)

Construct from dictionary.

GeometricField() [8/15]

GeometricField

(

const GeometricField< Type, PatchField, GeoMesh > &

)

Construct as copy.

GeometricField() [9/15]

GeometricField

(

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

)

Construct as copy of tmp<GeometricField> deleting argument.

GeometricField() [10/15]

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

Construct as copy resetting IO parameters.

GeometricField() [11/15]

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

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

GeometricField() [12/15]

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

Construct as copy resetting name.

GeometricField() [13/15]

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

Construct as copy resetting name.

GeometricField() [14/15]

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

Construct as copy resetting IO parameters and patch type.

GeometricField() [15/15]

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

Construct as copy resetting IO parameters and boundary types.

~GeometricField()

~GeometricField ( )

virtual

Destructor.

Definition at line 701 of file GeometricField.C.

Member Function Documentation

readIfPresent()

bool readIfPresent ( )

private

Read from file if it is present.

Definition at line 95 of file GeometricField.C.

readOldTimeIfPresent()

bool readOldTimeIfPresent ( )

private

Read old time field from file if it is present.

Definition at line 132 of file GeometricField.C.

readFields() [1/2]

void readFields ( const dictionary &  )

private

Read the field from the dictionary.

readFields() [2/2]

void readFields ( )

private

Read the field - create the field dictionary on-the-fly.

Definition at line 72 of file GeometricField.C.

TypeName()

TypeName

(

"GeometricField"

)

Runtime type information.

null()

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

inlinestatic

Return a null geometric field.

Definition at line 30 of file GeometricFieldI.H.

Referenced by noFilm::alpha(), noFilm::cloudDiameterTrans(), noFilm::cloudMassTrans(), Poisson::correct(), advectionDiffusion::correct(), noFilm::Cp(), kinematicSingleLayer::Cp(), noFilm::delta(), wallShearStressWriter::devRhoReff(), forces::devRhoReff(), ddtScheme< Type >::fvcDdt(), wallHeatFluxWriter::htc(), noThermo::kappa(), noFilm::kappa(), kinematicSingleLayer::kappa(), noThermo::kappaRad(), forces::mu(), noPyrolysis::phiGas(), noThermo::rho(), noFilm::rho(), noFilm::sigma(), noThermo::T(), noFilm::T(), kinematicSingleLayer::T(), noFilm::Ts(), kinematicSingleLayer::Ts(), noFilm::Tw(), kinematicSingleLayer::Tw(), noFilm::U(), noFilm::Us(), and noFilm::Uw().

Here is the caller graph for this function:

dimensionedInternalField() [1/2]

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

(

)

Return dimensioned internal field.

Definition at line 713 of file GeometricField.C.

Referenced by diffusionMulticomponent< CombThermoType, ThermoType >::correct(), kkLOmega::correct(), fvFieldDecomposer::decomposeField(), CourantNo::execute(), singleCellFvMesh::interpolate(), fvMeshSubset::interpolate(), laplaceFilter::laplaceFilter(), meshToMesh::mapSrcToTgt(), meshToMesh::mapTgtToSrc(), and uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

dimensionedInternalField() [2/2]

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

inline

Return dimensioned internal field.

Definition at line 41 of file GeometricFieldI.H.

internalField() [1/2]

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

(

)

Return internal field.

Definition at line 724 of file GeometricField.C.

Referenced by MRFZone::addCoriolis(), refineImmersedBoundaryMesh::addIbCellCellFaces(), volPointInterpolation::addSeparated(), interRegionExplicitPorositySource::addSup(), interRegionHeatTransferModel::addSup(), Foam::atan2(), Foam::fvc::average(), cellCoBlended< Type >::blendingFactor(), Foam::bound(), Implicit< CloudType >::cacheFields(), curvatureSeparation::calcCosAngle(), cubeRootVolDelta::calcDelta(), IDDESDelta::calcDelta(), maxDeltaxyz::calcDelta(), faceLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), cellLimitedGrad< Type >::calcGrad(), LimitedScheme< Type, Limiter, LimitFunc >::calcLimiter(), skewCorrectionVectors::calcSkewCorrectionVectors(), meshToMesh0::calculateInverseDistanceWeights(), Foam::fvc::cellReduce(), Foam::cmptAv(), Foam::component(), pointConstraints::constrain(), pointConstraints::constrainDisplacement(), vtkPV3Foam::convertPointFields(), vtkPV4Foam::convertPointFields(), inverseVolumeDiffusivity::correct(), inverseDistanceDiffusivity::correct(), phaseChangeModel::correct(), curvatureSeparation::correct(), wideBandAbsorptionEmission::correct(), immersedBoundaryFvPatchField< Type >::correctOffDiag(), kinematicSingleLayer::CourantNumber(), sampledCuttingPlane::createGeometry(), distanceSurface::createGeometry(), motionSmootherAlgo::curPoints(), pointFieldDecomposer::decomposeField(), fvFieldDecomposer::decomposeField(), determineDecomposition(), domainDecomposition::distributeCells(), reactingOneDim::evolveRegion(), faceAreaPairGAMGAgglomeration::faceAreaPairGAMGAgglomeration(), fvMatrix< Type >::flux(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), ddtScheme< Type >::fvcDdtPhiCoeff(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), sampledIsoSurface::getIsoFields(), fvMatrix< Type >::H(), fvMatrix< Type >::H1(), heThermo< BasicSolidThermo, MixtureType >::hc(), thermoSingleLayer::info(), kinematicSingleLayer::info(), surfaceInterpolationScheme< scalar >::interpolate(), fvMeshSubset::interpolate(), volPointInterpolation::interpolateBoundaryField(), patchCorrectedInterpolation::interpolateDataFromPatchGroups(), patchCorrectedInterpolation::interpolateType(), isoSurface::isoSurface(), heSolidThermo< BasicSolidThermo, MixtureType >::Kappa(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::mag(), Foam::magSqr(), main(), MRFZone::makeAbsoluteRhoFlux(), immersedBoundaryFvPatch::makeDeadFaces(), immersedBoundaryFvPatch::makeGamma(), Foam::makeGraph(), immersedBoundaryFvPatch::makeIbCells(), immersedBoundaryFvPatch::makeIbInsideFaces(), immersedBoundaryFvPatch::makeIbInternalFaces(), immersedBoundaryFvPatch::makeIbSamplingWeights(), immersedBoundaryFvPatch::makeInvDirichletMatrices(), MRFZone::makeRelativeRhoFlux(), immersedBoundaryFvPatch::makeSGamma(), surfaceInterpolation::makeWeights(), Foam::MapGeometricFields(), meshToMesh::mapInternalSrcToTgt(), meshToMesh::mapInternalTgtToSrc(), fvMeshAdder::MapVolField(), fvMesh::movePoints(), heheuPsiThermo< BasicPsiThermo, MixtureType >::mub(), heheuPsiThermo< BasicPsiThermo, MixtureType >::muu(), consumptionSpeed::omega0Sigma(), VoidFraction< CloudType >::postEvolve(), Foam::pow(), autoSnapDriver::preSmoothPatch(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psib(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psiu(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructFvVolumeField(), dynamicRefineFvMesh::refine(), sampledPatchInternalField::sampleField(), rotorDiskSource::setFaceArea(), canopySource::setPatchLanduse(), primaryRadiation::Shs(), standardRadiation::Shs(), constantRadiation::Shs(), sixDoFRigidBodyMotionSolver::sixDoFRigidBodyMotionSolver(), SLTSDdtScheme< Type >::SLrDeltaT(), Foam::solidRegionDiffNo(), reactingOneDim::solidRegionDiffNo(), velocityDisplacementMotionSolver::solve(), surfaceAlignedSBRStressFvMotionSolver::solve(), Foam::sqr(), Foam::stabilise(), Foam::fvc::surfaceIntegrate(), ReactingCloud< CloudType >::SYi(), Foam::T(), heheuPsiThermo< BasicPsiThermo, MixtureType >::Tb(), KinematicCloud< CloudType >::theta(), Foam::transform(), sampledThresholdCellFaces::updateGeometry(), sampledIsoSurfaceCell::updateGeometry(), Basic< Type >::updateGrad(), KinematicCloud< CloudType >::vDotSweep(), velocityDisplacementMotionSolver::velocityDisplacementMotionSolver(), Foam::fvc::volumeIntegrate(), reverseLinear< Type >::weights(), clippedLinear< Type >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), AveragingMethod< Foam::Vector >::write(), and Foam::writeCellGraph().

internalField() [2/2]

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

inline

Return internal field.

Definition at line 51 of file GeometricFieldI.H.

boundaryField() [1/2]

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

(

)

Return reference to GeometricBoundaryField.

Definition at line 735 of file GeometricField.C.

Referenced by reactingOneDim::addMassSources(), volPointInterpolation::addSeparated(), forces::addToFields(), basicThermo::alpha(), Foam::atan2(), Foam::fvc::average(), Foam::bound(), SurfaceFilmModel< CloudType >::cacheFilmFields(), ThermoSurfaceFilm< CloudType >::cacheFilmFields(), volPointInterpolation::calcBoundaryAddressing(), vanDriestDelta::calcDelta(), CentredFitSnGradData< Polynomial >::calcFit(), immersedBoundaryForces::calcForcesMoment(), forces::calcForcesMoment(), faceLimitedGrad< Type >::calcGrad(), faceMDLimitedGrad< Type >::calcGrad(), cellMDLimitedGrad< Type >::calcGrad(), cellLimitedGrad< Type >::calcGrad(), LimitedScheme< Type, Limiter, LimitFunc >::calcLimiter(), fieldMinMax::calcMinMaxFields(), nutUWallFunctionFvPatchScalarField::calcNut(), nutUSpaldingWallFunctionFvPatchScalarField::calcNut(), nutUTabulatedWallFunctionFvPatchScalarField::calcNut(), nutURoughWallFunctionFvPatchScalarField::calcNut(), wallShearStress::calcShearStress(), skewCorrectionVectors::calcSkewCorrectionVectors(), faceHeatShading::calculate(), faceShading::calculate(), P1::calculate(), epsilonLowReWallFunctionFvPatchScalarField::calculate(), omegaWallFunctionFvPatchScalarField::calculate(), interfaceProperties::calculateK(), reactingOneDim::calculateMassTransfer(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), yPlus::calcYPlus(), Foam::fvc::cellReduce(), motionSmootherAlgo::checkConstraints(), Foam::cmptAv(), Foam::component(), vtkPV3Foam::convertPointFields(), vtkPV4Foam::convertPointFields(), CoEulerDdtScheme< Type >::CorDeltaT(), injectionModelList::correct(), contactAngleForce::correct(), kOmegaSSTDES< BasicTurbulenceModel >::correct(), LamBremhorstKE::correct(), ShihQuadraticKE::correct(), LienLeschziner::correct(), LienCubicKE::correct(), advectionDiffusion::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correct(), kkLOmega::correct(), gaussGrad< Type >::correctBoundaryConditions(), motionSmootherAlgo::correctBoundaryConditions(), MRFZoneList::correctBoundaryFlux(), thermoSingleLayer::correctHsForMappedT(), mixtureKEpsilon< BasicTurbulenceModel >::correctInletOutlet(), cubic< Type >::correction(), linearUpwindV< Type >::correction(), linearUpwind< Type >::correction(), outletStabilised< Type >::correction(), immersedBoundaryFvPatchField< Type >::correctOffDiag(), heThermo< BasicSolidThermo, MixtureType >::CpByCpv(), heThermo< BasicSolidThermo, MixtureType >::Cpv(), epsilonWallFunctionFvPatchScalarField::createAveragingWeights(), omegaWallFunctionFvPatchScalarField::createAveragingWeights(), sampledCuttingPlane::createGeometry(), distanceSurface::createGeometry(), heThermo< BasicSolidThermo, MixtureType >::Cv(), pointFieldDecomposer::decomposeField(), fvFieldDecomposer::decomposeField(), nearWallDistNoSearch::doAll(), kOmega< BasicTurbulenceModel >::epsilon(), kOmegaSSTBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::epsilon(), FacePostProcessing< CloudType >::FacePostProcessing(), faceSource::filterField(), volPointInterpolation::flatBoundaryField(), fvMatrix< Type >::flux(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), ddtScheme< Type >::fvcDdtPhiCoeff(), gaussConvectionScheme< Type >::fvmDiv(), gaussLaplacianScheme< Type, GType >::fvmLaplacianUncorrected(), SpalartAllmaras< BasicTurbulenceModel >::fw(), heThermo< BasicSolidThermo, MixtureType >::gamma(), isoSurface::generateTriPoints(), surfaceMeshWriter::getFaceField(), externalDisplacementMeshMover::getFixedValueBCs(), isoSurface::getNeighbour(), heThermo< BasicSolidThermo, MixtureType >::hc(), basicThermo::heBoundaryBaseTypes(), psiuReactionThermo::heuBoundaryCorrection(), psiuReactionThermo::heuBoundaryTypes(), thermoSingleLayer::hsBoundaryTypes(), thermalBaffle::info(), thermalBaffle::init(), regionModel1D::initialise(), fluxSummary::initialiseFaceArea(), fluxSummary::initialiseFaceZoneAndDirection(), mixtureKEpsilon< BasicTurbulenceModel >::initMixtureFields(), interpolationCellPointFace< Type >::interpolate(), localMax< Type >::interpolate(), localMin< Type >::interpolate(), surfaceInterpolationScheme< scalar >::interpolate(), singleCellFvMesh::interpolate(), fvMeshSubset::interpolate(), meshToMesh0::interpolate(), patchCorrectedInterpolation::interpolateType(), kkLOmega::k(), heSolidThermo< BasicSolidThermo, MixtureType >::Kappa(), Foam::MULES::limiter(), PhiScheme< Type, PhiLimiter >::limiter(), Foam::MULES::limiterCorr(), Foam::mag(), Foam::magSqr(), main(), MRFZone::makeAbsoluteRhoFlux(), immersedBoundaryFvPatch::makeDeadFaces(), surfaceInterpolation::makeDeltaCoeffs(), immersedBoundaryFvPatch::makeGamma(), immersedBoundaryFvPatch::makeIbCells(), immersedBoundaryFvPatch::makeIbInsideFaces(), immersedBoundaryFvPatch::makeIbInternalFaces(), surfaceInterpolation::makeNonOrthCorrectionVectors(), surfaceInterpolation::makeNonOrthDeltaCoeffs(), MRFZone::makeRelativeRhoFlux(), immersedBoundaryFvPatch::makeSGamma(), surfaceInterpolation::makeWeights(), Foam::MapGeometricFields(), meshToMesh::mapSrcToTgt(), fvMeshAdder::MapSurfaceField(), meshToMesh::mapTgtToSrc(), fvMeshAdder::MapVolField(), fvMesh::movePoints(), incompressibleTwoPhaseInteractingMixture::mu(), heheuPsiThermo< BasicPsiThermo, MixtureType >::mub(), CompressibleTurbulenceModel< TransportModel >::mut(), PhaseCompressibleTurbulenceModel< typename BasicTurbulenceModel::transportModel >::mut(), heheuPsiThermo< BasicPsiThermo, MixtureType >::muu(), cyclicACMIFvPatchField< Type >::nonOverlapPatchField(), Newtonian::nu(), CrossPowerLaw::nu(), powerLaw::nu(), HerschelBulkley::nu(), BirdCarreau::nu(), incompressibleTwoPhaseMixture::nu(), incompressibleTwoPhaseInteractingMixture::nu(), incompressibleThreePhaseMixture::nu(), eddyViscosity< RASModel< BasicTurbulenceModel > >::nut(), ReynoldsStress< RASModel< BasicTurbulenceModel > >::nut(), consumptionSpeed::omega0Sigma(), homogeneousMixture< ThermoType >::patchFaceMixture(), inhomogeneousMixture< ThermoType >::patchFaceMixture(), egrMixture< ThermoType >::patchFaceMixture(), veryInhomogeneousMixture< ThermoType >::patchFaceMixture(), inhomogeneousMixture< ThermoType >::patchFaceProducts(), veryInhomogeneousMixture< ThermoType >::patchFaceProducts(), egrMixture< ThermoType >::patchFaceProducts(), inhomogeneousMixture< ThermoType >::patchFaceReactants(), veryInhomogeneousMixture< ThermoType >::patchFaceReactants(), egrMixture< ThermoType >::patchFaceReactants(), fvPatch::patchField(), Foam::pow(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psib(), heheuPsiThermo< BasicPsiThermo, MixtureType >::psiu(), thermoSingleLayer::Qconvp(), thermoSingleLayer::Qconvw(), radiationTemperature(), pointFieldReconstructor::reconstructField(), fvFieldReconstructor::reconstructFvSurfaceField(), fvFieldReconstructor::reconstructFvVolumeField(), Foam::fvc::reconstructMag(), dynamicRefineFvMesh::refine(), incompressibleTwoPhaseInteractingMixture::rho(), patchProbes::sample(), sampledPatch::sampleField(), sampledTriSurfaceMesh::sampleField(), motionSmootherAlgo::setDisplacementPatchFields(), pointConstraints::setPatchFields(), canopySource::setPatchLanduse(), rawTopoChangerFvMesh::setUnmappedValues(), snGradScheme< Type >::snGrad(), velocityDisplacementMotionSolver::solve(), thermalBaffle::solveEnergy(), Foam::sqr(), thermoSingleLayer::Srho(), Foam::stabilise(), GuldersEGR::Su0pTphi(), Gulders::Su0pTphi(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), Foam::T(), heheuPsiThermo< BasicPsiThermo, MixtureType >::Tb(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), Foam::transform(), dynamicRefineFvMesh::unrefine(), medialAxisMeshMover::update(), inclinedFilmNusseltHeightFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltInletVelocityFvPatchVectorField::updateCoeffs(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), alphatWallFunctionFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), turbulentHeatFluxTemperatureFvPatchScalarField::updateCoeffs(), advectiveFvPatchField< Type >::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), reactingOneDim::updatePhiGas(), reactingOneDim::updateQr(), thermoSingleLayer::updateSurfaceTemperatures(), kinematicSingleLayer::updateSurfaceVelocities(), reverseLinear< Type >::weights(), clippedLinear< Type >::weights(), outletStabilised< Type >::weights(), limitedSurfaceInterpolationScheme< Type >::weights(), yPlusWriter::write(), wallHeatFluxWriter::write(), wallShearStressWriter::write(), fluxSummary::write(), ensightParts::writeField(), Foam::writePatchGraph(), Foam::writeSurfFields(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutUWallFunctionFvPatchScalarField::yPlus(), nutUSpaldingWallFunctionFvPatchScalarField::yPlus(), nutUTabulatedWallFunctionFvPatchScalarField::yPlus(), and nutURoughWallFunctionFvPatchScalarField::yPlus().

boundaryField() [2/2]

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.

timeIndex() [1/2]

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 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 76 of file GeometricFieldI.H.

storeOldTimes()

void storeOldTimes

(

)

const

Store the old-time fields.

Definition at line 744 of file GeometricField.C.

Referenced by Foam::MapGeometricFields().

Here is the caller graph for this function:

storeOldTime()

void storeOldTime

(

)

const

Store the old-time field.

Definition at line 765 of file GeometricField.C.

nOldTimes()

Foam::label nOldTimes

(

)

const

Return the number of old time fields stored.

Definition at line 789 of file GeometricField.C.

oldTime() [1/2]

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

(

)

const

Return old time field.

Definition at line 804 of file GeometricField.C.

Referenced by EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerD2dt2Scheme< Type >::fvmD2dt2(), EulerDdtScheme< Type >::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), GeometricField< vector, pointPatchField, pointMesh >::oldTime(), waveSurfacePressureFvPatchScalarField::updateCoeffs(), and advectiveFvPatchField< Type >::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 833 of file GeometricField.C.

storePrevIter()

void storePrevIter

(

)

const

Store the field as the previous iteration value.

Definition at line 843 of file GeometricField.C.

prevIter()

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

(

)

const

Return previous iteration field.

Definition at line 868 of file GeometricField.C.

correctBoundaryConditions()

void correctBoundaryConditions

(

)

Correct boundary field.

Definition at line 885 of file GeometricField.C.

Referenced by porosityModel::addResistance(), Foam::fvc::average(), cellCoBlended< Type >::blendingFactor(), Implicit< CloudType >::cacheFields(), blendingFactor::calc(), curvatureSeparation::calcCosAngle(), cubeRootVolDelta::calcDelta(), maxDeltaxyz::calcDelta(), IDDESDelta::calcDelta(), smoothDelta::calcDelta(), pointConstraints::constrain(), pointConstraints::constrainDisplacement(), vtkPV4Foam::convertDimFields(), CoEulerDdtScheme< Type >::CorDeltaT(), inverseVolumeDiffusivity::correct(), inverseDistanceDiffusivity::correct(), injectionModelList::correct(), primaryRadiation::correct(), mappedConvectiveHeatTransfer::correct(), standardRadiation::correct(), phaseChangeModel::correct(), curvatureSeparation::correct(), qZeta::correct(), mixtureKEpsilon< BasicTurbulenceModel >::correct(), kkLOmega::correct(), thermoSingleLayer::correctAlpha(), thermoSingleLayer::correctHsForMappedT(), ShihQuadraticKE::correctNonlinearStress(), LienCubicKE::correctNonlinearStress(), LamBremhorstKE::correctNut(), qZeta::correctNut(), LienLeschziner::correctNut(), SpalartAllmaras< BasicTurbulenceModel >::correctNut(), SpalartAllmarasDES< BasicTurbulenceModel >::correctNut(), fvMatrix< Type >::H(), fvMatrix< Type >::H1(), singleLayerRegion::initialise(), patchTransformedInterpolation::interpolate(), patchCorrectedInterpolation::interpolateType(), main(), sampledSurface::pointAverage(), standardRadiation::Shs(), SLTSDdtScheme< Type >::SLrDeltaT(), Foam::fvc::smooth(), Foam::fvc::spread(), Foam::fvc::surfaceIntegrate(), Foam::fvc::surfaceSum(), Foam::fvc::sweep(), KinematicCloud< CloudType >::theta(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), thermoSingleLayer::transferPrimaryRegionThermoFields(), kinematicSingleLayer::transferPrimaryRegionThermoFields(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), Basic< Type >::updateGrad(), reactingOneDim::updateQr(), thermoSingleLayer::updateSurfaceTemperatures(), kinematicSingleLayer::updateSurfaceVelocities(), KinematicCloud< CloudType >::vDotSweep(), regionSizeDistribution::write(), and regionSizeDistribution::writeAlphaFields().

needReference()

bool needReference

(

)

const

Does the field need a reference level for solution.

Definition at line 894 of file GeometricField.C.

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

Here is the caller graph for this function:

component() [1/3]

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

(

const

direction

)

const

Return a component of the field.

Referenced by cubic< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), correctedSnGrad< Type >::correction(), gaussLaplacianScheme< Type, GType >::gammaSnGradCorr(), Foam::fvc::magSqrGradGrad(), main(), skewCorrected< Type >::skewCorrection(), surfaceAlignedSBRStressFvMotionSolver::solve(), fvMatrix< Type >::solveCoupled(), 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 985 of file GeometricField.C.

T()

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

(

)

const

Return transpose (only if it is a tensor field)

Definition at line 996 of file GeometricField.C.

Referenced by 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 917 of file GeometricField.C.

Referenced by diffusionMulticomponent< CombThermoType, ThermoType >::correct().

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

writeMinMax()

void writeMinMax

(

Ostream &

os

)

const

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

Definition at line 972 of file GeometricField.C.

negate()

void negate

(

)

Definition at line 1109 of file GeometricField.C.

replace() [1/4]

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

Referenced by cubic< Type >::correction(), correctedSnGrad< Type >::correction(), faceCorrectedSnGrad< Type >::correction(), fvMatrix< Type >::H(), surfaceAlignedSBRStressFvMotionSolver::solve(), and fvMatrix< Type >::solveSegregated().

Here is the caller graph for this function:

replace() [2/4]

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

max() [1/2]

void max

(

const dimensioned< Type > &

)

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

Here is the caller graph for this function:

min() [1/2]

void min

(

const dimensioned< Type > &

)

Referenced by laminar::Su().

Here is the caller graph for this function:

max() [2/2]

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

min() [2/2]

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

scale() [1/2]

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

scale() [2/2]

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

operator=() [1/3]

void operator=

(

const GeometricField< Type, PatchField, GeoMesh > &

)

operator=() [2/3]

void operator=

(

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

)

operator=() [3/3]

void operator=

(

const dimensioned< Type > &

)

operator==() [1/2]

void operator==

(

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

)

operator==() [2/2]

void operator==

(

const dimensioned< Type > &

)

operator+=() [1/3]

void operator+=

(

const GeometricField< Type, PatchField, GeoMesh > &

)

operator+=() [2/3]

void operator+=

(

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

)

operator-=() [1/3]

void operator-=

(

const GeometricField< Type, PatchField, GeoMesh > &

)

operator-=() [2/3]

void operator-=

(

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

)

operator*=() [1/3]

void operator*=

(

const GeometricField< scalar, PatchField, GeoMesh > &

)

operator*=() [2/3]

void operator*=

(

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

)

operator/=() [1/3]

void operator/=

(

const GeometricField< scalar, PatchField, GeoMesh > &

)

operator/=() [2/3]

void operator/=

(

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

)

operator+=() [3/3]

void operator+=

(

const dimensioned< Type > &

)

operator-=() [3/3]

void operator-=

(

const dimensioned< Type > &

)

operator*=() [3/3]

void operator*=

(

const dimensioned< scalar > &

)

operator/=() [3/3]

void operator/=

(

const dimensioned< scalar > &

)

component() [2/3]

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

(

const

direction

)

const

Definition at line 62 of file volFields.C.

replace() [3/4]

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

Definition at line 73 of file volFields.C.

component() [3/3]

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

(

const

direction

)

const

replace() [4/4]

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

Field Documentation

timeIndex_

label timeIndex_

mutableprivate

Current time index.

Used to trigger the storing of the old-time value

Definition at line 244 of file GeometricField.H.

field0Ptr_

GeometricField<Type, PatchField, GeoMesh>* field0Ptr_

mutableprivate

Pointer to old time field.

Definition at line 247 of file GeometricField.H.

fieldPrevIterPtr_

GeometricField<Type, PatchField, GeoMesh>* fieldPrevIterPtr_

mutableprivate

Pointer to previous iteration (used for under-relaxation)

Definition at line 250 of file GeometricField.H.

boundaryField_

GeometricBoundaryField boundaryField_

private

Boundary Type field containing boundary field values.

Definition at line 253 of file GeometricField.H.

---

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

• src/finiteVolume/fields/surfaceFields/surfaceFieldsFwd.H
• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricField.H
• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricField.C
• src/OpenFOAM/fields/GeometricFields/GeometricField/GeometricFieldI.H