DimensionedField Class Reference

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

Inheritance diagram for DimensionedField:

Public Types
typedef GeoMesh::Mesh	Mesh
typedef Field< Type >	FieldType
typedef Field< Type >::cmptType	cmptType

Public Member Functions
	TypeName ("DimensionedField")
	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &field)
	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&field)
	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, List< Type > &&field)
	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const tmp< Field< Type >> &tfield)
	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const bool checkIOFlags=true)
	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const bool checkIOFlags=true)
	DimensionedField (const IOobject &io, const Mesh &mesh, const word &fieldDictEntry="value")
	DimensionedField (const IOobject &io, const Mesh &mesh, const dictionary &fieldDict, const word &fieldDictEntry="value")
	DimensionedField (const DimensionedField< Type, GeoMesh > &df)
	DimensionedField (DimensionedField< Type, GeoMesh > &&df)
	DimensionedField (DimensionedField< Type, GeoMesh > &df, bool reuse)
	DimensionedField (const tmp< DimensionedField< Type, GeoMesh >> &tdf)
	DimensionedField (const IOobject &io, const DimensionedField< Type, GeoMesh > &df)
	DimensionedField (const IOobject &io, DimensionedField< Type, GeoMesh > &&df)
	DimensionedField (const IOobject &io, DimensionedField< Type, GeoMesh > &df, bool reuse)
	DimensionedField (const IOobject &io, const tmp< DimensionedField< Type, GeoMesh >> &tdf)
	DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh > &df)
	DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &&df)
	DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &df, bool reuse)
	DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh >> &tdf)
tmp< DimensionedField< Type, GeoMesh > >	clone () const
virtual	~DimensionedField ()=default
void	readField (const dictionary &fieldDict, const word &fieldDictEntry="value")
const Mesh &	mesh () const
const dimensionSet &	dimensions () const
dimensionSet &	dimensions ()
const orientedType &	oriented () const noexcept
orientedType &	oriented () noexcept
void	setOriented (const bool oriented=true) noexcept
const Field< Type > &	field () const
Field< Type > &	field ()
tmp< DimensionedField< cmptType, GeoMesh > >	component (const direction d) const
void	replace (const direction d, const DimensionedField< cmptType, GeoMesh > &df)
void	replace (const direction d, const tmp< DimensionedField< cmptType, GeoMesh >> &tdf)
tmp< DimensionedField< Type, GeoMesh > >	T () const
dimensioned< Type >	average () const
dimensioned< Type >	weightedAverage (const DimensionedField< scalar, GeoMesh > &weightField) const
dimensioned< Type >	weightedAverage (const tmp< DimensionedField< scalar, GeoMesh >> &tweightField) const
bool	writeData (Ostream &os, const word &fieldDictEntry) const
bool	writeData (Ostream &os) const
void	operator= (const DimensionedField< Type, GeoMesh > &df)
void	operator= (const tmp< DimensionedField< Type, GeoMesh >> &tdf)
void	operator= (const dimensioned< Type > &dt)
void	operator+= (const DimensionedField< Type, GeoMesh > &df)
void	operator+= (const tmp< DimensionedField< Type, GeoMesh >> &tdf)
void	operator-= (const DimensionedField< Type, GeoMesh > &df)
void	operator-= (const tmp< DimensionedField< Type, GeoMesh >> &tdf)
void	operator*= (const DimensionedField< scalar, GeoMesh > &df)
void	operator*= (const tmp< DimensionedField< scalar, GeoMesh >> &tdf)
void	operator/= (const DimensionedField< scalar, GeoMesh > &df)
void	operator/= (const tmp< DimensionedField< scalar, GeoMesh >> &tdf)
void	operator+= (const dimensioned< Type > &dt)
void	operator-= (const dimensioned< Type > &dt)
void	operator*= (const dimensioned< scalar > &dt)
void	operator/= (const dimensioned< scalar > &dt)
const word	typeName ("volScalarField::Internal")
const word	typeName ("volVectorField::Internal")
const word	typeName ("volSphericalTensorField::Internal")
const word	typeName ("volSymmTensorField::Internal")
const word	typeName ("volTensorField::Internal")

Static Public Member Functions
static const DimensionedField< Type, GeoMesh > &	null ()

Friends
Ostream &	operator (Ostream &os, const DimensionedField< Type, GeoMesh > &df)
Ostream &	operator (Ostream &os, const tmp< DimensionedField< Type, GeoMesh >> &tdf)

Detailed Description

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

Source files

• DimensionedField.H
• DimensionedFieldI.H
• DimensionedField.C
• DimensionedFieldIO.C

Definition at line 50 of file DimensionedField.H.

Member Typedef Documentation

Mesh

typedef GeoMesh::Mesh Mesh

Definition at line 82 of file DimensionedField.H.

FieldType

typedef Field<Type> FieldType

Definition at line 85 of file DimensionedField.H.

cmptType

typedef Field<Type>::cmptType cmptType

Definition at line 88 of file DimensionedField.H.

Constructor & Destructor Documentation

DimensionedField() [1/20]

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

Definition at line 64 of file DimensionedField.C.

DimensionedField() [2/20]

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

Definition at line 83 of file DimensionedField.C.

DimensionedField() [3/20]

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

Definition at line 102 of file DimensionedField.C.

DimensionedField() [4/20]

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

Definition at line 121 of file DimensionedField.C.

DimensionedField() [5/20]

DimensionedField	(	const IOobject &	io,
		const Mesh &	mesh,
		const dimensionSet &	dims,
		const bool	checkIOFlags = true
	)

DimensionedField() [6/20]

DimensionedField	(	const IOobject &	io,
		const Mesh &	mesh,
		const dimensioned< Type > &	dt,
		const bool	checkIOFlags = true
	)

DimensionedField() [7/20]

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

DimensionedField() [8/20]

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

DimensionedField() [9/20]

DimensionedField

(

const DimensionedField< Type, GeoMesh > &

df

)

Definition at line 185 of file DimensionedField.C.

DimensionedField() [10/20]

DimensionedField

(

DimensionedField< Type, GeoMesh > &&

df

)

Definition at line 199 of file DimensionedField.C.

DimensionedField() [11/20]

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

Definition at line 209 of file DimensionedField.C.

DimensionedField() [12/20]

DimensionedField

(

const tmp< DimensionedField< Type, GeoMesh >> &

tdf

)

Definition at line 224 of file DimensionedField.C.

DimensionedField() [13/20]

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

Definition at line 236 of file DimensionedField.C.

DimensionedField() [14/20]

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

Definition at line 251 of file DimensionedField.C.

DimensionedField() [15/20]

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

Definition at line 262 of file DimensionedField.C.

DimensionedField() [16/20]

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

Definition at line 278 of file DimensionedField.C.

DimensionedField() [17/20]

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

Definition at line 291 of file DimensionedField.C.

DimensionedField() [18/20]

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

Definition at line 306 of file DimensionedField.C.

DimensionedField() [19/20]

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

Definition at line 317 of file DimensionedField.C.

DimensionedField() [20/20]

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

Definition at line 333 of file DimensionedField.C.

~DimensionedField()

virtual ~DimensionedField ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"DimensionedField"

)

null()

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

inlinestatic

Definition at line 26 of file DimensionedFieldI.H.

Referenced by basicSolidChemistryModel::calculateRR(), and basicSolidChemistryModel::RR().

Here is the caller graph for this function:

clone()

Foam::tmp< Foam::DimensionedField< Type, GeoMesh > > clone

(

)

const

Definition at line 346 of file DimensionedField.C.

readField()

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

Definition at line 29 of file DimensionedFieldIO.C.

mesh()

const GeoMesh::Mesh & mesh ( ) const

inline

Definition at line 34 of file DimensionedFieldI.H.

Referenced by alphatWallBoilingWallFunctionFvPatchScalarField::alphatWallBoilingWallFunctionFvPatchScalarField(), Foam::atan2(), Foam::cmptAv(), faMatrix< Type >::H(), volPointInterpolation::interpolate(), volPointInterpolation::interpolateDimensionedInternalField(), Foam::mag(), Foam::magSqr(), Foam::pow(), Foam::sqr(), Foam::stabilise(), and Foam::fvc::volumeIntegrate().

Here is the caller graph for this function:

dimensions() [1/2]

const Foam::dimensionSet & dimensions ( ) const

inline

Definition at line 42 of file DimensionedFieldI.H.

Referenced by Foam::atan2(), Foam::checkMethod(), Foam::cmptAv(), Foam::fvc::domainIntegrate(), SpalartAllmaras< BasicTurbulenceModel >::fw(), volPointInterpolation::interpolate(), Foam::mag(), Foam::magSqr(), DimensionedField< Type, Foam::pointMesh >::operator=(), Foam::pow(), Foam::sqr(), Foam::stabilise(), surfMesh::storeField(), polySurface::storeField(), and KinematicCloud< Cloud< basicKinematicCollidingParcel > >::SU().

Here is the caller graph for this function:

dimensions() [2/2]

Foam::dimensionSet & dimensions ( )

inline

Definition at line 49 of file DimensionedFieldI.H.

oriented() [1/2]

const orientedType& oriented ( ) const

inlinenoexcept

Referenced by DimensionedField< Type, Foam::pointMesh >::operator=().

Here is the caller graph for this function:

oriented() [2/2]

orientedType& oriented ( )

inlinenoexcept

setOriented()

void setOriented ( const bool  oriented = true )

inlinenoexcept

Definition at line 73 of file DimensionedFieldI.H.

field() [1/2]

const Foam::Field< Type > & field ( ) const

inline

Definition at line 83 of file DimensionedFieldI.H.

Referenced by Foam::atan2(), Foam::cmptAv(), contactAngleForce::correct(), skewCorrectedSnGrad< Type >::fullGradCorrection(), liquidFilmModel::info(), Foam::mag(), Foam::magSqr(), Foam::pow(), fvFieldReconstructor::reconstructFvVolumeInternalField(), dynamicOversetFvMesh::solve(), Foam::sqr(), Foam::stabilise(), perturbedTemperatureDependentContactAngleForce::theta(), and Foam::fvc::volumeIntegrate().

Here is the caller graph for this function:

field() [2/2]

Foam::Field< Type > & field ( )

inline

Definition at line 91 of file DimensionedFieldI.H.

component()

tmp<DimensionedField<cmptType, GeoMesh> > component

(

const direction

d

)

const

Referenced by faMatrix< Type >::residual().

Here is the caller graph for this function:

replace() [1/2]

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

replace() [2/2]

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

T()

Foam::tmp< Foam::DimensionedField< Type, GeoMesh > > T

(

)

const

Definition at line 419 of file DimensionedField.C.

average()

Foam::dimensioned< Type > average

(

)

const

Definition at line 440 of file DimensionedField.C.

weightedAverage() [1/2]

Foam::dimensioned< Type > weightedAverage

(

const DimensionedField< scalar, GeoMesh > &

weightField

)

const

Definition at line 454 of file DimensionedField.C.

Referenced by simple::continuityErrors(), and adjointSimple::continuityErrors().

Here is the caller graph for this function:

weightedAverage() [2/2]

Foam::dimensioned< Type > weightedAverage

(

const tmp< DimensionedField< scalar, GeoMesh >> &

tweightField

)

const

Definition at line 470 of file DimensionedField.C.

writeData() [1/2]

bool writeData	(	Ostream &	os,
		const word &	fieldDictEntry
	)		const

Definition at line 111 of file DimensionedFieldIO.C.

writeData() [2/2]

bool writeData

(

Ostream &

os

)

const

Definition at line 132 of file DimensionedFieldIO.C.

operator=() [1/3]

void operator=

(

const DimensionedField< Type, GeoMesh > &

df

)

Definition at line 484 of file DimensionedField.C.

operator=() [2/3]

void operator=

(

const tmp< DimensionedField< Type, GeoMesh >> &

tdf

)

Definition at line 503 of file DimensionedField.C.

operator=() [3/3]

void operator=

(

const dimensioned< Type > &

dt

)

Definition at line 525 of file DimensionedField.C.

operator+=() [1/3]

void operator+=

(

const DimensionedField< Type, GeoMesh > &

df

)

Definition at line 569 of file DimensionedField.C.

operator+=() [2/3]

void operator+=

(

const tmp< DimensionedField< Type, GeoMesh >> &

tdf

)

Definition at line 569 of file DimensionedField.C.

operator-=() [1/3]

void operator-=

(

const DimensionedField< Type, GeoMesh > &

df

)

Definition at line 570 of file DimensionedField.C.

operator-=() [2/3]

void operator-=

(

const tmp< DimensionedField< Type, GeoMesh >> &

tdf

)

Definition at line 570 of file DimensionedField.C.

operator*=() [1/3]

void operator*=

(

const DimensionedField< scalar, GeoMesh > &

df

)

Definition at line 571 of file DimensionedField.C.

operator*=() [2/3]

void operator*=

(

const tmp< DimensionedField< scalar, GeoMesh >> &

tdf

)

Definition at line 571 of file DimensionedField.C.

operator/=() [1/3]

void operator/=

(

const DimensionedField< scalar, GeoMesh > &

df

)

Definition at line 572 of file DimensionedField.C.

operator/=() [2/3]

void operator/=

(

const tmp< DimensionedField< scalar, GeoMesh >> &

tdf

)

Definition at line 572 of file DimensionedField.C.

operator+=() [3/3]

void operator+=

(

const dimensioned< Type > &

dt

)

Definition at line 569 of file DimensionedField.C.

operator-=() [3/3]

void operator-=

(

const dimensioned< Type > &

dt

)

Definition at line 570 of file DimensionedField.C.

operator*=() [3/3]

void operator*=

(

const dimensioned< scalar > &

dt

)

Definition at line 571 of file DimensionedField.C.

operator/=() [3/3]

void operator/=

(

const dimensioned< scalar > &

dt

)

Definition at line 572 of file DimensionedField.C.

typeName() [1/5]

const word typeName

(

"volScalarField::Internal"

)

typeName() [2/5]

const word typeName

(

"volVectorField::Internal"

)

typeName() [3/5]

const word typeName

(

"volSphericalTensorField::Internal"

)

typeName() [4/5]

const word typeName

(

"volSymmTensorField::Internal"

)

typeName() [5/5]

const word typeName

(

"volTensorField::Internal"

)

Friends And Related Function Documentation

operator [1/2]

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

friend

operator [2/2]

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

friend

---

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

• src/OpenFOAM/fields/DimensionedFields/DimensionedField/DimensionedField.H
• src/OpenFOAM/fields/DimensionedFields/DimensionedField/DimensionedField.C
• src/OpenFOAM/fields/DimensionedFields/DimensionedField/DimensionedFieldI.H
• src/OpenFOAM/fields/DimensionedFields/DimensionedField/DimensionedFieldIO.C