dimensioned< Type > Class Template Reference

Generic dimensioned Type class. More...

#include <dimensionedType.H>

Inheritance diagram for dimensioned< Type >:

Public Types
typedef Type	value_type
	The underlying data type.
typedef pTraits< Type >::cmptType	cmptType
	Component type.

Public Member Functions
	dimensioned ()
	A dimensionless Zero, named "0".
	dimensioned (const dimensionSet &dims)
	A dimensioned Zero, named "0".
	dimensioned (const dimensionSet &dims, const Foam::zero)
	A dimensioned Zero, named "0".
	dimensioned (const dimensionSet &dims, const Foam::one)
	A dimensioned pTraits::one, named "1".
	dimensioned (const Type &val)
	Implicit construct dimensionless from given value.
	dimensioned (const dimensionSet &dims, const Type &val)
	Construct dimensioned from given value.
	dimensioned (const word &name, const dimensionSet &dims, const Type &val)
	Construct from components (name, dimensions, value).
	dimensioned (const word &name, const dimensioned< Type > &dt)
	Copy construct dimensioned Type with a new name.
	dimensioned (const primitiveEntry &e)
	Construct from primitive entry with given name.
	dimensioned (const primitiveEntry &e, const dimensionSet &dims)
	Construct from primitive entry with given name and dimensions.
	dimensioned (const word &name, const dictionary &dict)
	Construct from dictionary lookup with a given name.
	dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict)
	Construct from dictionary lookup with a given name and dimensions.
	dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict, const word &entryName)
	Construct from dictionary lookup with a given name and dimensions.
	dimensioned (const word &name, const dimensionSet &dims, const Type &val, const dictionary &dict)
	Construct from components (name, dimensions, value) with optional dictionary override.
const word &	name () const noexcept
	Return const reference to name.
word &	name () noexcept
	Return non-const reference to name.
const dimensionSet &	dimensions () const noexcept
	Return const reference to dimensions.
dimensionSet &	dimensions () noexcept
	Return non-const reference to dimensions.
const Type &	value () const noexcept
	Return const reference to value.
Type &	value () noexcept
	Return non-const reference to value.
dimensioned< cmptType >	component (const direction d) const
	Return a component as a dimensioned<cmptType>.
void	replace (const direction d, const dimensioned< cmptType > &dc)
	Return a component with a dimensioned<cmptType>.
dimensioned< Type >	T () const
	Return transpose.
bool	read (const dictionary &dict)
	Update the value of dimensioned<Type>, lookup in dictionary with the name().
bool	readIfPresent (const dictionary &dict)
	Update the value of dimensioned<Type> if found in the dictionary, lookup in dictionary with the name().
bool	read (const word &entryName, const dictionary &dict)
	Update the value of dimensioned<Type>, using an alternative entry name.
bool	readIfPresent (const word &entryName, const dictionary &dict)
	Update the value of dimensioned<Type> if found in the dictionary, using an alternative entry name.
Istream &	read (Istream &is, const bool readName=true)
	Read (name, dimensions, value) from stream, using units from system table.
Istream &	read (Istream &is, const dictionary &readSet)
	Read (name, dimensions, value) from stream, using units from dictionary.
Istream &	read (Istream &is, const HashTable< dimensionedScalar > &readSet)
	Read (name, dimensions, value) from stream, using units from table.
void	writeEntry (const word &keyword, Ostream &os) const
	Write as a dictionary entry with keyword.
dimensioned< cmptType >	operator[] (const direction d) const
	Return a component as a dimensioned<cmptType>.
void	operator+= (const dimensioned< Type > &dt)
void	operator-= (const dimensioned< Type > &dt)
void	operator*= (const scalar s)
void	operator/= (const scalar s)
	dimensioned (Istream &is)
	Deprecated(2018-11) Construct from Istream (expects name, dimensions, value).
	dimensioned (const word &name, Istream &is)
	Deprecated(2018-11) Construct from Istream with given name (expects dimensions, value).
	dimensioned (const word &name, const dimensionSet &dims, Istream &is)
	Deprecated(2018-11) Construct from Istream with given name and expected dimensions.
auto	expr (const label size) const
	Wrap value as constant-value List expression.
template<class GeoField>
auto	expr (const GeoField &fld) const
	Wrap value as constant-value GeometricField expression. Supplied.

Static Public Member Functions
static dimensioned< Type >	getOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
	Construct dimensioned from dictionary, with default value.
static dimensioned< Type >	getOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))
	Construct dimensionless from dictionary, with default value.
static dimensioned< Type >	getOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
	Construct dimensioned from dictionary, with default value.
static dimensioned< Type >	getOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))
	Construct dimensionless from dictionary, with default value.
static dimensioned< Type >	lookupOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
	Same as getOrDefault().
static dimensioned< Type >	lookupOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))
	Same as getOrDefault().
static dimensioned< Type >	lookupOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
	Same as getOrAddToDict().
static dimensioned< Type >	lookupOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))
	Same as getOrAddToDict().

Friends
Istream &	operator>> (Istream &is, dimensioned< Type > &dt)
	Read from stream. The name and dimensions are optional.

Detailed Description

template<class Type>
class Foam::dimensioned< Type >

Generic dimensioned Type class.

Source files

• dimensionedType.H
• dimensionedType.C

Definition at line 69 of file dimensionedType.H.

Member Typedef Documentation

value_type

template<class Type>

typedef Type value_type

The underlying data type.

Definition at line 134 of file dimensionedType.H.

cmptType

template<class Type>

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 139 of file dimensionedType.H.

Constructor & Destructor Documentation

dimensioned() [1/17]

template<class Type>

dimensioned

(

)

A dimensionless Zero, named "0".

Definition at line 110 of file dimensionedType.C.

References Foam::Zero.

Referenced by component(), dimensioned(), getOrAddToDict(), getOrDefault(), getOrDefault(), operator+=(), operator-=(), UniformDimensionedField< Type >::operator=(), UniformDimensionedField< Type >::operator=(), replace(), UniformDimensionedField< Type >::UniformDimensionedField(), UniformDimensionedField< Type >::UniformDimensionedField(), UniformDimensionedField< Type >::UniformDimensionedField(), UniformDimensionedField< Type >::UniformDimensionedField(), and UniformDimensionedField< Type >::UniformDimensionedField().

Here is the caller graph for this function:

dimensioned() [2/17]

template<class Type>

dimensioned ( const dimensionSet & dims )

explicit

A dimensioned Zero, named "0".

Definition at line 119 of file dimensionedType.C.

References Foam::Zero.

dimensioned() [3/17]

template<class Type>

dimensioned ( const dimensionSet & dims, const Foam::zero  )

explicit

A dimensioned Zero, named "0".

Definition at line 128 of file dimensionedType.C.

References Foam::Zero.

dimensioned() [4/17]

template<class Type>

dimensioned ( const dimensionSet & dims, const Foam::one  )

explicit

A dimensioned pTraits::one, named "1".

Definition at line 141 of file dimensionedType.C.

dimensioned() [5/17]

template<class Type>

dimensioned ( const Type & val )

inline

Implicit construct dimensionless from given value.

Definition at line 167 of file dimensionedType.H.

dimensioned() [6/17]

template<class Type>

dimensioned	(	const dimensionSet &	dims,
		const Type &	val )

Construct dimensioned from given value.

Definition at line 154 of file dimensionedType.C.

References name().

Here is the call graph for this function:

dimensioned() [7/17]

template<class Type>

dimensioned	(	const word &	name,
		const dimensionSet &	dims,
		const Type &	val )

Construct from components (name, dimensions, value).

Definition at line 167 of file dimensionedType.C.

References name().

Here is the call graph for this function:

dimensioned() [8/17]

template<class Type>

dimensioned	(	const word &	name,
		const dimensioned< Type > &	dt )

Copy construct dimensioned Type with a new name.

Definition at line 181 of file dimensionedType.C.

References dimensioned(), and name().

Here is the call graph for this function:

dimensioned() [9/17]

template<class Type>

dimensioned ( const primitiveEntry & e )

explicit

Construct from primitive entry with given name.

The entry may contain optional name and dimensions.

* [name] [dims] value
* 

If the optional name is found, it is used for renaming. If the optional dimensions are present, they are read and used without further verification. If no dimensions are found, the quantity is dimensionless. Fatal if not primitiveEntry or if number of tokens is incorrect.

Definition at line 194 of file dimensionedType.C.

References e, name(), and Foam::Zero.

Here is the call graph for this function:

dimensioned() [10/17]

template<class Type>

dimensioned ( const primitiveEntry & e, const dimensionSet & dims )

explicit

Construct from primitive entry with given name and dimensions.

The entry may contain optional name and dimensions.

* [name] [dims] value
* 

If the optional name is found, it is used for renaming. If the optional dimensions are present, they are read and verified against the expected dimensions. Fatal if not primitiveEntry or if number of tokens is incorrect.

Definition at line 213 of file dimensionedType.C.

References e, name(), and Foam::Zero.

Here is the call graph for this function:

dimensioned() [11/17]

template<class Type>

dimensioned	(	const word &	name,
		const dictionary &	dict )

Construct from dictionary lookup with a given name.

The entry may contain optional name and dimensions.

* [name] [dims] value
* 

If the optional name is found, it is used for renaming. If the optional dimensions are present, they are read and used without further verification. If no dimensions are found, the quantity is dimensionless.

Definition at line 233 of file dimensionedType.C.

References dict, IOobjectOption::MUST_READ, name(), and Foam::Zero.

Here is the call graph for this function:

dimensioned() [12/17]

template<class Type>

dimensioned	(	const word &	name,
		const dimensionSet &	dims,
		const dictionary &	dict )

Construct from dictionary lookup with a given name and dimensions.

The entry may contain optional name and dimensions.

* [name] [dims] value
* 

If the optional name is found, it is used for renaming. If the optional dimensions are present, they are read and verified against the expected dimensions.

Definition at line 249 of file dimensionedType.C.

References dict, IOobjectOption::MUST_READ, name(), and Foam::Zero.

Here is the call graph for this function:

dimensioned() [13/17]

template<class Type>

dimensioned	(	const word &	name,
		const dimensionSet &	dims,
		const dictionary &	dict,
		const word &	entryName )

Construct from dictionary lookup with a given name and dimensions.

The entry may contain optional name and dimensions.

* [name] [dims] value
* 

If the optional name is found, it is used for renaming. If the optional dimensions are present, they are read and verified against the expected dimensions.

Parameters

entryName

dictionary lookup name

Definition at line 266 of file dimensionedType.C.

References dict, IOobjectOption::MUST_READ, name(), and Foam::Zero.

Here is the call graph for this function:

dimensioned() [14/17]

template<class Type>

dimensioned	(	const word &	name,
		const dimensionSet &	dims,
		const Type &	val,
		const dictionary &	dict )

Construct from components (name, dimensions, value) with optional dictionary override.

The entry may contain optional name and dimensions.

* [name] [dims] value
* 

Definition at line 284 of file dimensionedType.C.

References dict, name(), and IOobjectOption::READ_IF_PRESENT.

Here is the call graph for this function:

dimensioned() [15/17]

template<class Type>

dimensioned ( Istream & is )

explicit

Deprecated(2018-11) Construct from Istream (expects name, dimensions, value).

Deprecated

(2018-11) - should generally use construct from dictionary or primitiveEntry instead (additional checks on the input stream).

Definition at line 302 of file dimensionedType.C.

References read().

Here is the call graph for this function:

dimensioned() [16/17]

template<class Type>

dimensioned	(	const word &	name,
		Istream &	is )

Deprecated(2018-11) Construct from Istream with given name (expects dimensions, value).

Deprecated

(2018-11) - should generally use construct from dictionary or primitiveEntry instead (additional checks on the input stream).

Definition at line 311 of file dimensionedType.C.

References name(), and read().

Here is the call graph for this function:

dimensioned() [17/17]

template<class Type>

dimensioned	(	const word &	name,
		const dimensionSet &	dims,
		Istream &	is )

Deprecated(2018-11) Construct from Istream with given name and expected dimensions.

Expects value, but supports optional name and dimensions. If the optional dimensions are present, they are read and verified against the expected dimensions.

Deprecated

(2018-11) - should generally use construct from dictionary or primitiveEntry instead (additional checks on the input stream).

Definition at line 325 of file dimensionedType.C.

References name(), and Foam::Zero.

Here is the call graph for this function:

Member Function Documentation

getOrDefault() [1/2]

template<class Type>

Foam::dimensioned< Type > getOrDefault ( const word & name, const dictionary & dict, const dimensionSet & dims = dimless, const Type & deflt = Type(Zero) )

static

Construct dimensioned from dictionary, with default value.

FatalIOError if there are excess tokens.

Definition at line 344 of file dimensionedType.C.

References dict, dimensioned(), and name().

Referenced by dimensioned< label >::lookupOrDefault(), and dimensioned< label >::lookupOrDefault().

Here is the call graph for this function:

Here is the caller graph for this function:

getOrDefault() [2/2]

template<class Type>

Foam::dimensioned< Type > getOrDefault ( const word & name, const dictionary & dict, const Type & deflt = Type(Zero) )

static

Construct dimensionless from dictionary, with default value.

FatalIOError if it is found and there are excess tokens.

Definition at line 358 of file dimensionedType.C.

References dict, dimensioned(), Foam::dimless, and name().

Here is the call graph for this function:

getOrAddToDict() [1/2]

template<class Type>

Foam::dimensioned< Type > getOrAddToDict ( const word & name, dictionary & dict, const dimensionSet & dims = dimless, const Type & deflt = Type(Zero) )

static

Construct dimensioned from dictionary, with default value.

If the value is not found, it is added into the dictionary. FatalIOError if it is found and there are excess tokens.

Definition at line 370 of file dimensionedType.C.

References dict, dimensioned(), and name().

Referenced by getOrAddToDict(), kOmegaSSTDES< BasicTurbulenceModel >::kOmegaSSTDES(), dimensioned< label >::lookupOrAddToDict(), dimensioned< label >::lookupOrAddToDict(), and SpalartAllmarasDES< BasicTurbulenceModel >::SpalartAllmarasDES().

Here is the call graph for this function:

Here is the caller graph for this function:

getOrAddToDict() [2/2]

template<class Type>

Foam::dimensioned< Type > getOrAddToDict ( const word & name, dictionary & dict, const Type & deflt = Type(Zero) )

static

Construct dimensionless from dictionary, with default value.

If the value is not found, it is added into the dictionary. FatalIOError if it is found and there are excess tokens.

Definition at line 389 of file dimensionedType.C.

References dict, Foam::dimless, getOrAddToDict(), and name().

Here is the call graph for this function:

name() [1/2]

template<class Type>

const word & name ( ) const

inlinenoexcept

Return const reference to name.

Definition at line 352 of file dimensionedType.H.

Referenced by Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::cbrt(), Foam::checkMethod(), Foam::checkMethod(), Foam::cof(), Foam::cof(), Foam::fac::d2dt2(), Foam::fac::ddt(), Foam::fvc::ddt(), Foam::det(), Foam::det(), Foam::det(), Foam::dev(), Foam::dev(), Foam::dev2(), Foam::dev2(), dimensioned(), dimensioned(), dimensioned(), dimensioned(), dimensioned(), dimensioned(), dimensioned(), dimensioned(), dimensioned(), dimensioned(), dimensioned(), Foam::eigenValues(), Foam::eigenVectors(), EulerFaD2dt2Scheme< Type >::facD2dt2(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), EulerFaDdtScheme< Type >::facDdt(), steadyStateFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), steadyStateFaDdtScheme< Type >::facDdt0(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdt(), getOrAddToDict(), getOrAddToDict(), getOrDefault(), getOrDefault(), Foam::innerSqr(), Foam::inv(), Foam::inv(), Foam::inv(), Foam::mapClouds(), UniformDimensionedField< label >::name(), Foam::neg(), Foam::neg0(), Foam::negPart(), Foam::operator*(), Foam::operator*(), Foam::operator*(), Foam::pos(), Foam::pos0(), Foam::posPart(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow025(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), Foam::sign(), Foam::skew(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), Foam::stabilise(), Foam::stabilise(), Foam::stabilise(), Foam::symm(), Foam::symm(), dimensioned< sphericalTensor >::T(), dimensioned< symmTensor >::T(), dimensioned< tensor >::T(), Foam::tr(), Foam::tr(), Foam::tr(), Foam::twoSymm(), Foam::twoSymm(), UniformDimensionedField< Type >::UniformDimensionedField(), and dimensionSet::write().

name() [2/2]

template<class Type>

word & name ( )

inlinenoexcept

Return non-const reference to name.

Definition at line 357 of file dimensionedType.H.

dimensions() [1/2]

template<class Type>

const dimensionSet & dimensions ( ) const

inlinenoexcept

Return const reference to dimensions.

Definition at line 362 of file dimensionedType.H.

Referenced by Foam::cbrt(), Foam::checkMethod(), Foam::checkMethod(), Foam::cof(), Foam::cof(), relaxation::correct(), Foam::det(), Foam::det(), Foam::det(), Foam::dev(), Foam::dev(), Foam::dev2(), Foam::dev2(), dimensionSets::dimensionSets(), Foam::eigenValues(), comfort::execute(), EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaD2dt2Scheme< Type >::facD2dt2(), backwardFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt(), EulerFaDdtScheme< Type >::facDdt(), EulerFaDdtScheme< Type >::facDdt(), EulerFaDdtScheme< Type >::facDdt(), EulerFaDdtScheme< Type >::facDdt(), steadyStateFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), steadyStateFaDdtScheme< Type >::facDdt0(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerD2dt2Scheme< Type >::fvcD2dt2(), backwardDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdt(), Foam::innerSqr(), Foam::inv(), Foam::inv(), Foam::inv(), Foam::makeDimensionedMinMax(), Foam::neg(), Foam::neg0(), Foam::negPart(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, areaMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, faPatchField, areaMesh >::New(), Foam::operator*(), Foam::operator*(), Foam::operator*(), Foam::pos(), Foam::pos0(), Foam::posPart(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow025(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), dimensionSet::read(), UniformDimensionedField< Type >::readData(), Foam::sign(), Foam::skew(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), Foam::stabilise(), Foam::stabilise(), Foam::stabilise(), Foam::symm(), Foam::symm(), dimensioned< sphericalTensor >::T(), dimensioned< symmTensor >::T(), dimensioned< tensor >::T(), Foam::tr(), Foam::tr(), Foam::tr(), Foam::twoSymm(), Foam::twoSymm(), and UniformDimensionedField< Type >::writeData().

dimensions() [2/2]

template<class Type>

dimensionSet & dimensions ( )

inlinenoexcept

Return non-const reference to dimensions.

Definition at line 367 of file dimensionedType.H.

value() [1/2]

template<class Type>

const Type & value ( ) const

inlinenoexcept

Return const reference to value.

Definition at line 372 of file dimensionedType.H.

Referenced by interRegionHeatTransferModel::addSup(), SemiImplicitSource< Type >::addSup(), solidificationMeltingSource::addSup(), powerLawUniformBinary::addToBinaryBreakupRate(), hydrodynamic::addToCoalescenceRate(), wallBoiling::addToNucleationRate(), porosityModel::adjustNegativeResistance(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), Foam::atan2(), coordSetWriter::beginTime(), surfaceWriter::beginTime(), Foam::bound(), SprayParcel< ParcelType >::calcAtomization(), forceCoeffs::calcForceCoeffs(), forceCoeffs::calcMomentCoeffs(), SRFForce< CloudType >::calcNonCoupled(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::calculateVolumeFractions(), Foam::cbrt(), GeometricField< Type, PatchField, GeoMesh >::clamp_min(), GeometricField< Type, PatchField, GeoMesh >::clamp_range(), Foam::cof(), Foam::cof(), adjointkOmegaSST::correct(), adjointSpalartAllmaras::correct(), relaxation::correct(), Foam::det(), Foam::det(), Foam::det(), Foam::dev(), Foam::dev(), Foam::dev2(), Foam::dev2(), Foam::eigenValues(), Foam::eigenVectors(), dimensionedScalarEntry::evaluate(), comfort::execute(), exprResult::exprResult(), EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaD2dt2Scheme< Type >::facD2dt2(), backwardFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt(), boundedBackwardFaDdtScheme::facDdt(), EulerFaDdtScheme< Type >::facDdt(), EulerFaDdtScheme< Type >::facDdt(), EulerFaDdtScheme< Type >::facDdt(), EulerFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), interfaceTrackingFvMesh::freeSurfacePressureJump(), basicCombustionMixture::fres(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerD2dt2Scheme< Type >::fvcD2dt2(), backwardDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), waveMakerPointPatchVectorField::g(), SinclairJackson::g0prime(), populationBalanceModel::gamma(), if(), Foam::innerSqr(), Foam::inv(), Foam::inv(), Foam::inv(), Foam::invTransform(), adjointSimple::mainIter(), Foam::makeDimensionedMinMax(), Foam::neg(), Foam::neg0(), Foam::negPart(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, GeoMesh >::New(), DimensionedField< Type, areaMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, PatchField, GeoMesh >::New(), GeometricField< Type, faPatchField, areaMesh >::New(), JohnsonJacksonSchaeffer::nu(), Schaeffer::nu(), Foam::operator*(), Foam::operator*(), Foam::operator*(), magnet::operator<<, magnet::operator>>, UniformDimensionedField< label >::operator[](), PatchFlowRateInjection< CloudType >::parcelsToInject(), PatchFlowRateInjection< CloudType >::PatchFlowRateInjection(), freePiston::pistonPosition(), Foam::pos(), Foam::pos0(), Foam::posPart(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow(), Foam::pow025(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), dimensionSet::read(), comfort::read(), UniformDimensionedField< Type >::readData(), GeometricField< Type, PatchField, GeoMesh >::replace(), exponential::setBreakupRate(), powerLaw::setBreakupRate(), masterUncollatedFileOperation::setTime(), Time::setTime(), Time::setTime(), constantRadiation::Shs(), Foam::sign(), Foam::skew(), rigidBodyMeshMotion::solve(), rigidBodyMeshMotionSolver::solve(), Foam::fvc::spreadSource(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), Foam::stabilise(), Foam::stabilise(), particle< Type >::stepFractionSpan(), Foam::symm(), Foam::symm(), dimensioned< sphericalTensor >::T(), dimensioned< symmTensor >::T(), dimensioned< tensor >::T(), Foam::tr(), Foam::tr(), Foam::tr(), Foam::transform(), Foam::twoSymm(), Foam::twoSymm(), angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), fixedPressureCompressibleDensityFvPatchScalarField::updateCoeffs(), oscillatingDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), SRFFreestreamVelocityFvPatchVectorField::updateCoeffs(), waveDisplacementPointPatchVectorField::updateCoeffs(), Lookup< Type >::value(), PatchFlowRateInjection< CloudType >::volumeToInject(), fvMesh::Vsc(), fvMesh::Vsc0(), dimensionSet::write(), FacePostProcessing< CloudType >::write(), sizeDistribution::write(), histogramModel::write(), ParticleCollector< CloudType >::write(), UniformDimensionedField< Type >::writeData(), and sizeDistribution::writeFileHeader().

value() [2/2]

template<class Type>

Type & value ( )

inlinenoexcept

Return non-const reference to value.

Definition at line 377 of file dimensionedType.H.

component()

template<class Type>

Foam::dimensioned< typename Foam::dimensioned< Type >::cmptType > component

(

const direction

d

)

const

Return a component as a dimensioned<cmptType>.

Definition at line 404 of file dimensionedType.C.

References dimensioned(), and Foam::name().

Here is the call graph for this function:

replace()

template<class Type>

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

Return a component with a dimensioned<cmptType>.

Definition at line 419 of file dimensionedType.C.

References dimensioned().

Here is the call graph for this function:

T()

template<class Type>

dimensioned< Type > T

(

)

const

Return transpose.

Referenced by eddy::eddy(), dimensioned< sphericalTensor >::T(), dimensioned< symmTensor >::T(), and dimensioned< tensor >::T().

Here is the caller graph for this function:

read() [1/5]

template<class Type>

bool read

(

const dictionary &

dict

)

Update the value of dimensioned<Type>, lookup in dictionary with the name().

Definition at line 431 of file dimensionedType.C.

References dict, and Foam::read().

Referenced by dimensioned(), dimensioned(), and Foam::unitSet().

Here is the call graph for this function:

Here is the caller graph for this function:

readIfPresent() [1/2]

template<class Type>

bool readIfPresent

(

const dictionary &

dict

)

Update the value of dimensioned<Type> if found in the dictionary, lookup in dictionary with the name().

Definition at line 438 of file dimensionedType.C.

References dict, and readIfPresent().

Here is the call graph for this function:

read() [2/5]

template<class Type>

bool read	(	const word &	entryName,
		const dictionary &	dict )

Update the value of dimensioned<Type>, using an alternative entry name.

Definition at line 445 of file dimensionedType.C.

References dict, and IOobjectOption::MUST_READ.

readIfPresent() [2/2]

template<class Type>

bool readIfPresent	(	const word &	entryName,
		const dictionary &	dict )

Update the value of dimensioned<Type> if found in the dictionary, using an alternative entry name.

Definition at line 457 of file dimensionedType.C.

References dict, and IOobjectOption::READ_IF_PRESENT.

read() [3/5]

template<class Type>

Foam::Istream & read	(	Istream &	is,
		const bool	readName = true )

Read (name, dimensions, value) from stream, using units from system table.

Optionally skip reading the name

Definition at line 469 of file dimensionedType.C.

References IOstream::check(), and FUNCTION_NAME.

Here is the call graph for this function:

read() [4/5]

template<class Type>

Foam::Istream & read	(	Istream &	is,
		const dictionary &	readSet )

Read (name, dimensions, value) from stream, using units from dictionary.

Definition at line 492 of file dimensionedType.C.

References IOstream::check(), FUNCTION_NAME, and Istream::read().

Here is the call graph for this function:

read() [5/5]

template<class Type>

Foam::Istream & read	(	Istream &	is,
		const HashTable< dimensionedScalar > &	readSet )

Read (name, dimensions, value) from stream, using units from table.

Definition at line 511 of file dimensionedType.C.

References IOstream::check(), FUNCTION_NAME, and Istream::read().

Here is the call graph for this function:

writeEntry()

template<class Type>

void writeEntry	(	const word &	keyword,
		Ostream &	os ) const

Write as a dictionary entry with keyword.

The name is not written when it is identical to keyword. The dimensions are always written.

Definition at line 534 of file dimensionedType.C.

References FUNCTION_NAME, os(), and token::SPACE.

Here is the call graph for this function:

operator[]()

template<class Type>

Foam::dimensioned< typename Foam::dimensioned< Type >::cmptType > operator[]

(

const direction

d

)

const

Return a component as a dimensioned<cmptType>.

Definition at line 572 of file dimensionedType.C.

References Foam::component().

Here is the call graph for this function:

operator+=()

template<class Type>

void operator+=

(

const dimensioned< Type > &

dt

)

Definition at line 582 of file dimensionedType.C.

References dimensioned().

Here is the call graph for this function:

operator-=()

template<class Type>

void operator-=

(

const dimensioned< Type > &

dt

)

Definition at line 593 of file dimensionedType.C.

References dimensioned().

Here is the call graph for this function:

operator*=()

template<class Type>

void operator*=

(

const scalar

s

)

Definition at line 604 of file dimensionedType.C.

References s().

Here is the call graph for this function:

operator/=()

template<class Type>

void operator/=

(

const scalar

s

)

Definition at line 614 of file dimensionedType.C.

References s().

Here is the call graph for this function:

lookupOrDefault() [1/2]

template<class Type>

dimensioned< Type > lookupOrDefault ( const word & name, const dictionary & dict, const dimensionSet & dims = dimless, const Type & deflt = Type(Zero) )

inlinestatic

Same as getOrDefault().

Definition at line 520 of file dimensionedType.H.

lookupOrDefault() [2/2]

template<class Type>

dimensioned< Type > lookupOrDefault ( const word & name, const dictionary & dict, const Type & deflt = Type(Zero) )

inlinestatic

Same as getOrDefault().

Definition at line 535 of file dimensionedType.H.

lookupOrAddToDict() [1/2]

template<class Type>

dimensioned< Type > lookupOrAddToDict ( const word & name, dictionary & dict, const dimensionSet & dims = dimless, const Type & deflt = Type(Zero) )

inlinestatic

Same as getOrAddToDict().

Definition at line 549 of file dimensionedType.H.

lookupOrAddToDict() [2/2]

template<class Type>

dimensioned< Type > lookupOrAddToDict ( const word & name, dictionary & dict, const Type & deflt = Type(Zero) )

inlinestatic

Same as getOrAddToDict().

Definition at line 564 of file dimensionedType.H.

expr() [1/2]

template<class Type>

auto expr ( const label size ) const

inline

Wrap value as constant-value List expression.

Definition at line 580 of file dimensionedType.H.

expr() [2/2]

template<class Type>

template<class GeoField>

auto expr ( const GeoField & fld ) const

inline

Wrap value as constant-value GeometricField expression. Supplied.

fields is used for sizing only and needs to be valid at time of evaluation.

Definition at line 592 of file dimensionedType.H.

Friends And Related Symbol Documentation

operator>>

template<class Type>

Istream & operator>> ( Istream & is, dimensioned< Type > & dt )

friend

Read from stream. The name and dimensions are optional.

If the optional dimensions are present, they are used without further verification.

---

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

• src/OpenFOAM/dimensionedTypes/dimensionedScalar/dimensionedScalarFwd.H
• src/OpenFOAM/dimensionedTypes/dimensionedType/dimensionedType.H
• src/OpenFOAM/dimensionedTypes/dimensionedType/dimensionedType.C