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:

[legend]

Collaboration diagram for DimensionedField:

[legend]

Public Types
typedef GeoMesh::Mesh	Mesh

typedef Field< Type >::cmptType	cmptType

Public Member Functions
	TypeName ("DimensionedField")
	Runtime type information. More...

	DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const Field< Type > &)
	Construct from components. More...

	DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const bool checkIOFlags=true)
	Construct from components. More...

	DimensionedField (const IOobject &, const Mesh &mesh, const dimensioned< Type > &, const bool checkIOFlags=true)
	Construct from components. More...

	DimensionedField (const IOobject &, const Mesh &mesh, const word &fieldDictEntry="value")
	Construct from Istream. More...

	DimensionedField (const IOobject &, const Mesh &mesh, const dictionary &fieldDict, const word &fieldDictEntry="value")
	Construct from dictionary. More...

	DimensionedField (const DimensionedField< Type, GeoMesh > &)
	Construct as copy. More...

	DimensionedField (DimensionedField< Type, GeoMesh > &, bool reUse)
	Construct as copy or re-use as specified. More...

	DimensionedField (const Xfer< DimensionedField< Type, GeoMesh > > &)
	Construct by transferring the DimensionedField. More...

	DimensionedField (const tmp< DimensionedField< Type, GeoMesh > > &)
	Construct as copy of tmp<DimensionedField> deleting argument. More...

	DimensionedField (const IOobject &, const DimensionedField< Type, GeoMesh > &)
	Construct as copy resetting IO parameters. More...

	DimensionedField (const IOobject &, DimensionedField< Type, GeoMesh > &, bool reUse)
	Construct as copy resetting IO parameters and re-use as specified. More...

	DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh > &)
	Construct as copy resetting name. More...

	DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &, bool reUse)
	Construct as copy resetting name and re-use as specified. More...

	DimensionedField (const word &newName, const Xfer< DimensionedField< Type, GeoMesh > > &)
	Construct by transferring the DimensionedField with a new name. More...

	DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh > > &)
	Construct as copy resetting name. More...

tmp< DimensionedField< Type, GeoMesh > >	clone () const
	Clone. More...

virtual	~DimensionedField ()
	Destructor. More...

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

const Mesh &	mesh () const
	Return mesh. More...

const dimensionSet &	dimensions () const
	Return dimensions. More...

dimensionSet &	dimensions ()
	Return non-const access to dimensions. More...

const Field< Type > &	field () const

Field< Type > &	field ()

tmp< DimensionedField< cmptType, GeoMesh > >	component (const direction) const
	Return a component field of the field. More...

void	replace (const direction, const DimensionedField< cmptType, GeoMesh > &)
	Replace a component field of the field. More...

void	replace (const direction, const tmp< DimensionedField< cmptType, GeoMesh > > &)
	Replace a component field of the field. More...

tmp< DimensionedField< Type, GeoMesh > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

dimensioned< Type >	average () const
	Calculate and return arithmetic average. More...

dimensioned< Type >	weightedAverage (const DimensionedField< scalar, GeoMesh > &) const
	Calculate and return weighted average. More...

dimensioned< Type >	weightedAverage (const tmp< DimensionedField< scalar, GeoMesh > > &) const
	Calculate and return weighted average. More...

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

bool	writeData (Ostream &) const

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

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

void	operator= (const dimensioned< Type > &)

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Member Functions
void	readIfPresent (const word &fieldDictEntry="value")

Private Attributes
const Mesh &	mesh_
	Reference to mesh. More...

dimensionSet	dimensions_
	Dimension set for this field. More...

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

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

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

Definition at line 51 of file DimensionedField.H.

Member Typedef Documentation

◆ Mesh

typedef GeoMesh::Mesh Mesh

Definition at line 81 of file DimensionedField.H.

◆ cmptType

typedef Field<Type>::cmptType cmptType

Definition at line 82 of file DimensionedField.H.

Constructor & Destructor Documentation

◆ DimensionedField() [1/15]

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

Construct from components.

◆ DimensionedField() [2/15]

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

Construct from components.

Used for temporary fields which are initialised after construction

◆ DimensionedField() [3/15]

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

Construct from components.

◆ DimensionedField() [4/15]

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

Construct from Istream.

◆ DimensionedField() [5/15]

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

Construct from dictionary.

◆ DimensionedField() [6/15]

DimensionedField ( const DimensionedField< Type, GeoMesh > & )

Construct as copy.

◆ DimensionedField() [7/15]

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

Construct as copy or re-use as specified.

◆ DimensionedField() [8/15]

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

Construct by transferring the DimensionedField.

◆ DimensionedField() [9/15]

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

Construct as copy of tmp<DimensionedField> deleting argument.

◆ DimensionedField() [10/15]

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

Construct as copy resetting IO parameters.

◆ DimensionedField() [11/15]

DimensionedField	(	const IOobject &	,
		DimensionedField< Type, GeoMesh > &	,
		bool	reUse
	)

Construct as copy resetting IO parameters and re-use as specified.

◆ DimensionedField() [12/15]

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

Construct as copy resetting name.

◆ DimensionedField() [13/15]

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

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

◆ DimensionedField() [14/15]

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

Construct by transferring the DimensionedField with a new name.

◆ DimensionedField() [15/15]

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

Construct as copy resetting name.

◆ ~DimensionedField()

~DimensionedField ( )

virtual

Destructor.

Definition at line 286 of file DimensionedField.C.

Member Function Documentation

◆ readIfPresent()

void readIfPresent ( const word & fieldDictEntry = "value" )

private

Definition at line 48 of file DimensionedFieldIO.C.

◆ TypeName()

TypeName ( "DimensionedField" )

Runtime type information.

◆ null()

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

inlinestatic

Return a null DimensionedField.

Definition at line 30 of file DimensionedFieldI.H.

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

Here is the caller graph for this function:

◆ clone()

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

Clone.

Definition at line 274 of file DimensionedField.C.

◆ readField()

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

Definition at line 34 of file DimensionedFieldIO.C.

◆ mesh()

const GeoMesh::Mesh & mesh ( ) const

inline

Return mesh.

Definition at line 38 of file DimensionedFieldI.H.

Referenced by Foam::atan2(), Foam::cmptAv(), vtkPV4Foam::convertDimFields(), volPointInterpolation::interpolate(), volPointInterpolation::interpolateDimensionedInternalField(), Foam::mag(), Foam::magSqr(), reuseTmpDimensionedField< TypeR, Type1, GeoMesh >::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, Type2, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, TypeR, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, TypeR, GeoMesh >::New(), 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

Return dimensions.

Definition at line 46 of file DimensionedFieldI.H.

Referenced by Foam::atan2(), Foam::checkMethod(), Foam::cmptAv(), vtkPV4Foam::convertDimFields(), dimFieldDecomposer::decomposeField(), Foam::fvc::domainIntegrate(), volPointInterpolation::interpolate(), fvMeshSubset::interpolate(), Foam::mag(), Foam::magSqr(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, Type1, Type12, TypeR, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, TypeR, GeoMesh >::New(), Foam::pow(), Foam::sqr(), and Foam::stabilise().

Here is the caller graph for this function:

◆ dimensions() [2/2]

Foam::dimensionSet & dimensions ( )

inline

Return non-const access to dimensions.

Definition at line 53 of file DimensionedFieldI.H.

◆ field() [1/2]

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

inline

Definition at line 61 of file DimensionedFieldI.H.

Referenced by Foam::atan2(), Foam::cmptAv(), Foam::mag(), Foam::magSqr(), Foam::pow(), fvFieldReconstructor::reconstructFvVolumeInternalField(), Foam::sqr(), Foam::stabilise(), and Foam::fvc::volumeIntegrate().

Here is the caller graph for this function:

◆ field() [2/2]

Foam::Field< Type > & field ( )

inline

Definition at line 68 of file DimensionedFieldI.H.

◆ component()

tmp<DimensionedField<cmptType, GeoMesh> > component ( const direction ) const

Return a component field of the field.

◆ replace() [1/2]

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

Replace a component field of the field.

◆ replace() [2/2]

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

Replace a component field of the field.

◆ T()

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

Return the field transpose (only defined for second rank tensors)

Definition at line 354 of file DimensionedField.C.

◆ average()

dimensioned< Type > average ( ) const

Calculate and return arithmetic average.

Definition at line 378 of file DimensionedField.C.

◆ weightedAverage() [1/2]

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

Calculate and return weighted average.

◆ weightedAverage() [2/2]

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

Calculate and return weighted average.

◆ writeData() [1/2]

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

◆ writeData() [2/2]

bool writeData ( Ostream & ) const

◆ operator=() [1/3]

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

◆ operator=() [2/3]

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

◆ operator=() [3/3]

void operator= ( const dimensioned< Type > & )

◆ operator+=() [1/3]

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

◆ operator+=() [2/3]

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

◆ operator-=() [1/3]

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

◆ operator-=() [2/3]

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

◆ operator*=() [1/3]

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

◆ operator*=() [2/3]

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

◆ operator/=() [1/3]

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

◆ operator/=() [2/3]

void operator/= ( const tmp< DimensionedField< scalar, 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 > & )

Friends And Related Function Documentation

◆ operator [1/2]

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

friend

◆ operator [2/2]

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

friend

Field Documentation

◆ mesh_

const Mesh& mesh_

private

Reference to mesh.

Definition at line 90 of file DimensionedField.H.

◆ dimensions_

dimensionSet dimensions_

private

Dimension set for this field.

Definition at line 93 of file DimensionedField.H.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Mesh

◆ cmptType

Constructor & Destructor Documentation

◆ DimensionedField() [1/15]

◆ DimensionedField() [2/15]

◆ DimensionedField() [3/15]

◆ DimensionedField() [4/15]

◆ DimensionedField() [5/15]

◆ DimensionedField() [6/15]

◆ DimensionedField() [7/15]

◆ DimensionedField() [8/15]

◆ DimensionedField() [9/15]

◆ DimensionedField() [10/15]

◆ DimensionedField() [11/15]

◆ DimensionedField() [12/15]

◆ DimensionedField() [13/15]

◆ DimensionedField() [14/15]

◆ DimensionedField() [15/15]

◆ ~DimensionedField()

Member Function Documentation

◆ readIfPresent()

◆ TypeName()

◆ null()

◆ clone()

◆ readField()

◆ mesh()

◆ dimensions() [1/2]

◆ dimensions() [2/2]

◆ field() [1/2]

◆ field() [2/2]

◆ component()

◆ replace() [1/2]

◆ replace() [2/2]

◆ T()

◆ average()

◆ weightedAverage() [1/2]

◆ weightedAverage() [2/2]

◆ writeData() [1/2]

◆ writeData() [2/2]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator+=() [1/3]

◆ operator+=() [2/3]

◆ operator-=() [1/3]

◆ operator-=() [2/3]

◆ operator*=() [1/3]

◆ operator*=() [2/3]

◆ operator/=() [1/3]

◆ operator/=() [2/3]

◆ operator+=() [3/3]

◆ operator-=() [3/3]

◆ operator*=() [3/3]

◆ operator/=() [3/3]

Friends And Related Function Documentation

◆ operator [1/2]

◆ operator [2/2]

Field Documentation

◆ mesh_

◆ dimensions_