dimensioned< Type > Class Template Reference

Generic dimensioned Type class. More...

Inheritance diagram for dimensioned< Type >:

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

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

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. More...
static dimensioned< Type >	getOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))
	Construct dimensionless from dictionary, with default value. More...
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. More...
static dimensioned< Type >	getOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))
	Construct dimensionless from dictionary, with default value. More...
static dimensioned< Type >	lookupOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
	Same as getOrDefault() More...
static dimensioned< Type >	lookupOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))
	Same as getOrDefault() More...
static dimensioned< Type >	lookupOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
	Same as getOrAddToDict() More...
static dimensioned< Type >	lookupOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))
	Same as getOrAddToDict() More...

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

Detailed Description

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

Generic dimensioned Type class.

Source files

• dimensionedType.H
• dimensionedType.C

Definition at line 33 of file dimensionedScalarFwd.H.

Member Typedef Documentation

value_type

typedef Type value_type

The underlying data type.

Definition at line 128 of file dimensionedType.H.

cmptType

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 133 of file dimensionedType.H.

Constructor & Destructor Documentation

dimensioned() [1/17]

dimensioned

(

)

A dimensionless Zero, named "0".

Definition at line 110 of file dimensionedType.C.

dimensioned() [2/17]

dimensioned ( const dimensionSet &  dims )

explicit

A dimensioned Zero, named "0".

Definition at line 119 of file dimensionedType.C.

dimensioned() [3/17]

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

explicit

A dimensioned Zero, named "0".

Definition at line 129 of file dimensionedType.C.

dimensioned() [4/17]

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

explicit

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

Definition at line 142 of file dimensionedType.C.

dimensioned() [5/17]

dimensioned ( const Type &  val )

inline

Implicit construct dimensionless from given value.

Definition at line 161 of file dimensionedType.H.

dimensioned() [6/17]

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

Construct dimensioned from given value.

Definition at line 155 of file dimensionedType.C.

dimensioned() [7/17]

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

Construct from components (name, dimensions, value).

Definition at line 168 of file dimensionedType.C.

dimensioned() [8/17]

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

Copy construct dimensioned Type with a new name.

Definition at line 182 of file dimensionedType.C.

dimensioned() [9/17]

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 195 of file dimensionedType.C.

dimensioned() [10/17]

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 214 of file dimensionedType.C.

dimensioned() [11/17]

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 234 of file dimensionedType.C.

dimensioned() [12/17]

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 250 of file dimensionedType.C.

dimensioned() [13/17]

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 267 of file dimensionedType.C.

dimensioned() [14/17]

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 285 of file dimensionedType.C.

dimensioned() [15/17]

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.

dimensioned() [16/17]

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 312 of file dimensionedType.C.

dimensioned() [17/17]

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 326 of file dimensionedType.C.

Member Function Documentation

getOrDefault() [1/2]

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 345 of file dimensionedType.C.

Referenced by dimensioned< vector >::lookupOrDefault().

Here is the caller graph for this function:

getOrDefault() [2/2]

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 359 of file dimensionedType.C.

getOrAddToDict() [1/2]

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 371 of file dimensionedType.C.

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

Here is the caller graph for this function:

getOrAddToDict() [2/2]

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 390 of file dimensionedType.C.

name() [1/2]

const word& name ( ) const

inlinenoexcept

Return const reference to name.

Definition at line 346 of file dimensionedType.H.

Referenced by Foam::atan2(), Foam::cbrt(), Foam::checkMethod(), Foam::cof(), Foam::fac::d2dt2(), Foam::fvc::ddt(), Foam::fac::ddt(), Foam::fvm::ddt(), Foam::det(), Foam::dev(), Foam::dev2(), Foam::eigenValues(), Foam::eigenVectors(), EulerFaD2dt2Scheme< Type >::facD2dt2(), steadyStateFaDdtScheme< Type >::facDdt(), EulerFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), steadyStateFaDdtScheme< Type >::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), forAll(), steadyStateDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), Foam::innerSqr(), Foam::inv(), dimensioned< vector >::lookupOrAddToDict(), dimensioned< vector >::lookupOrDefault(), Foam::mapClouds(), UniformDimensionedField< vector >::name(), Foam::neg(), Foam::neg0(), Foam::negPart(), seriesLess::operator()(), nameOp< T >::operator()(), Foam::operator*(), Foam::operator==(), Foam::pos(), Foam::pos0(), Foam::posPart(), Foam::pow(), Foam::pow025(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), Foam::sign(), Foam::skew(), multiphaseSystem::solve(), multiphaseSystem::solveAlphas(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), Foam::symm(), dimensioned< vector >::T(), Foam::tr(), Foam::twoSymm(), dimensionSet::write(), and regionSizeDistribution::write().

name() [2/2]

word& name ( )

inlinenoexcept

Return non-const reference to name.

Definition at line 351 of file dimensionedType.H.

dimensions() [1/2]

const dimensionSet& dimensions ( ) const

inlinenoexcept

Return const reference to dimensions.

Definition at line 356 of file dimensionedType.H.

Referenced by ObukhovLength::calcOL(), DarcyForchheimer::calcTransformModelData(), Foam::cbrt(), Foam::checkMethod(), Foam::cof(), Foam::det(), Foam::dev(), Foam::dev2(), dimensionSets::dimensionSets(), Foam::eigenValues(), comfort::execute(), EulerFaD2dt2Scheme< Type >::facD2dt2(), steadyStateFaDdtScheme< Type >::facDdt(), EulerFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), steadyStateFaDdtScheme< Type >::facDdt0(), EulerFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), EulerD2dt2Scheme< Type >::fvcD2dt2(), steadyStateDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvmDdt(), EulerDdtScheme< Type >::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), CoEulerDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), ddtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), heSolidThermo< BasicSolidThermo, MixtureType >::heSolidThermo(), Foam::innerSqr(), Foam::inv(), Foam::makeDimensionedMinMax(), Foam::neg(), Foam::neg0(), Foam::negPart(), DimensionedField< Type, Foam::pointMesh >::New(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::New(), optionList::operator()(), Foam::operator*(), DimensionedField< Type, Foam::pointMesh >::operator=(), Foam::pos(), Foam::pos0(), Foam::posPart(), Foam::pow(), Foam::pow025(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), dimensionSet::read(), forces::reset(), Foam::sign(), Foam::skew(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), Foam::symm(), dimensioned< vector >::T(), Foam::tr(), and Foam::twoSymm().

dimensions() [2/2]

dimensionSet& dimensions ( )

inlinenoexcept

Return non-const reference to dimensions.

Definition at line 361 of file dimensionedType.H.

value() [1/2]

const Type& value ( ) const

inlinenoexcept

Return const reference to value.

Definition at line 366 of file dimensionedType.H.

Referenced by tabulated6DoFAcceleration::acceleration(), objective::accumulateJMean(), interRegionHeatTransferModel::addSup(), powerLawUniformBinary::addToBinaryBreakupRate(), hydrodynamic::addToCoalescenceRate(), wallBoiling::addToNucleationRate(), porosityModel::adjustNegativeResistance(), maxDurationCondition::apply(), Foam::atan2(), coordSetWriter::beginTime(), surfaceWriter::beginTime(), Foam::bound(), NonInertialFrameForce< CloudType >::cacheFields(), SprayParcel< ParcelType >::calcAtomization(), BrownianMotionForce< CloudType >::calcCoupled(), forceCoeffs::calcForceCoeffs(), ThermoParcel< ParcelType >::calcHeatTransfer(), forceCoeffs::calcMomentCoeffs(), SRFForce< CloudType >::calcNonCoupled(), ParamagneticForce< CloudType >::calcNonCoupled(), powerLaw::calcNu(), DarcyForchheimer::calcTransformModelData(), viewFactor::calculate(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::calculateVolumeFractions(), Foam::cbrt(), SIMPLEControlSingleRun::checkEndTime(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::clamp_min(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::clip(), Foam::cof(), fixedTemperatureConstraint::constrain(), constantNucleation::correct(), BrunDrippingInjection::correct(), adjointSpalartAllmaras::correct(), adjointkOmegaSST::correct(), logFiles::createFiles(), curvatureSeparation::curvatureSeparation(), filmTurbulenceModel::Cw(), thermoCoupleProbes::derivatives(), Foam::det(), Foam::dev(), Foam::dev2(), adjointSpalartAllmaras::diffusionCoeffVar1(), Foam::eigenValues(), Foam::eigenVectors(), engineMesh::engineMesh(), ThermoCloud< Foam::DSMCCloud >::Ep(), DSMCCloud< ParcelType >::equipartitionInternalEnergy(), dimensionedScalarEntry::evaluate(), comfort::execute(), exprResult::exprResult(), EulerFaD2dt2Scheme< Type >::facD2dt2(), EulerFaDdtScheme< Type >::facDdt(), backwardFaDdtScheme< Type >::facDdt(), boundedBackwardFaDdtScheme::facDdt(), EulerFaDdtScheme< Type >::facDdt0(), backwardFaDdtScheme< Type >::facDdt0(), boundedBackwardFaDdtScheme::facDdt0(), interfaceTrackingFvMesh::freeSurfacePressureJump(), basicCombustionMixture::fres(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), waveMakerPointPatchVectorField::g(), SinclairJackson::g0prime(), populationBalanceModel::gamma(), if(), reactingOneDim::info(), InjectionModel< CloudType >::injectSteadyState(), Foam::innerSqr(), Foam::inv(), Foam::invTransform(), objective::isWithinIntegrationTime(), heatTransferModel::K(), laminarFlameSpeed::laminarFlameSpeed(), hexRef8::level0EdgeLength(), pressureControl::limit(), optimisationManager::lineSearchUpdate(), ArdenBuck::lnPSat(), adjointSimple::mainIter(), Foam::makeDimensionedMinMax(), Foam::max(), Foam::min(), inhomogeneousMixture< ThermoType >::mixture(), egrMixture< ThermoType >::mixture(), Foam::neg(), Foam::neg0(), Foam::negPart(), DimensionedField< Type, Foam::pointMesh >::New(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::New(), Schaeffer::nu(), JohnsonJacksonSchaeffer::nu(), Foam::operator!=(), seriesLess::operator()(), Instant< T >::less::operator()(), Foam::operator*(), Foam::operator+(), Time::operator+=(), Foam::operator-(), Foam::operator<(), Foam::operator<<(), DimensionedField< Type, Foam::pointMesh >::operator=(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::operator=(), Foam::operator==(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::operator==(), Foam::operator>(), Foam::operator>>(), UniformDimensionedField< vector >::operator[](), PatchFlowRateInjection< CloudType >::parcelsToInject(), freePiston::pistonPosition(), pointHistory::pointHistory(), Foam::pos(), Foam::pos0(), Foam::posPart(), Foam::pow(), Foam::pow025(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), comfort::read(), dimensionSet::read(), SIMPLEControlSingleRun::readIters(), GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >::replace(), incompressibleTwoPhaseInteractingMixture::rho(), rpm::rpm(), timeSelector::selectIfPresent(), powerLaw::setBreakupRate(), exponential::setBreakupRate(), Time::setDeltaT(), Time::setEndTime(), vtmWriter::setTime(), Time::setTime(), masterUncollatedFileOperation::setTime(), constantRadiation::Shs(), Foam::sign(), Foam::skew(), sixDoFRigidBodyMotionSolver::solve(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), thermalBaffle::solveEnergy(), Foam::fvc::spreadSource(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), particle< Type >::stepFractionSpan(), Foam::symm(), dimensioned< vector >::T(), Foam::tr(), Foam::transform(), multiMotion::transformation(), linearMotion::transformation(), drivenLinearMotion::transformation(), oscillatingRotatingMotion::transformation(), rotatingMotion::transformation(), tabulated6DoFMotion::transformation(), Foam::twoSymm(), oscillatingDisplacementPointPatchVectorField::updateCoeffs(), waveDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), JohnsonJacksonParticleSlipFvPatchVectorField::updateCoeffs(), JohnsonJacksonParticleThetaFvPatchScalarField::updateCoeffs(), fixedIncidentRadiationFvPatchScalarField::updateCoeffs(), MarshakRadiationFvPatchScalarField::updateCoeffs(), fixedPressureCompressibleDensityFvPatchScalarField::updateCoeffs(), MarshakRadiationFixedTemperatureFvPatchScalarField::updateCoeffs(), SRFFreestreamVelocityFvPatchVectorField::updateCoeffs(), PatchFlowRateInjection< CloudType >::volumeToInject(), fvMesh::Vsc(), fvMesh::Vsc0(), histogramModel::write(), FacePostProcessing< CloudType >::write(), ParticleCollector< CloudType >::write(), sizeDistribution::write(), dimensionSet::write(), objective::write(), sizeDistribution::writeFileHeader(), objective::writeInstantaneousValue(), and objective::writeMeanValue().

value() [2/2]

Type& value ( )

inlinenoexcept

Return non-const reference to value.

Definition at line 371 of file dimensionedType.H.

component()

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

(

const direction

d

)

const

Return a component as a dimensioned<cmptType>

Definition at line 405 of file dimensionedType.C.

Referenced by coordinateScaling< Foam::vector >::transform().

Here is the caller graph for this function:

replace()

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

Return a component with a dimensioned<cmptType>

Definition at line 420 of file dimensionedType.C.

T()

dimensionedTensor T

(

)

const

Return transpose.

Definition at line 31 of file dimensionedSphericalTensor.C.

Referenced by EBRSM< BasicTurbulenceModel >::correct(), eddy::eddy(), Foam::inv(), leastSquares::stencilWeights(), dimensioned< vector >::T(), and SVD::VSinvUt().

Here is the caller graph for this function:

read() [1/5]

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.

Referenced by Foam::unitSet().

Here is the caller graph for this function:

readIfPresent() [1/2]

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.

Referenced by crankConRod::crankConRod(), ShihQuadraticKE::read(), LamBremhorstKE::read(), qZeta::read(), LienLeschziner::read(), LienCubicKE::read(), SpalartAllmarasBase< eddyViscosity< RASModel< BasicTurbulenceModel > > >::read(), kkLOmega::read(), adjointSpalartAllmaras::read(), adjointkOmegaSST::read(), and sixDoFRigidBodyMotionSolver::solve().

Here is the caller graph for this function:

read() [2/5]

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

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

Definition at line 446 of file dimensionedType.C.

readIfPresent() [2/2]

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 458 of file dimensionedType.C.

read() [3/5]

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.

read() [4/5]

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.

read() [5/5]

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

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

Definition at line 512 of file dimensionedType.C.

writeEntry()

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 535 of file dimensionedType.C.

Referenced by topODesignVariables::writeData().

Here is the caller graph for this function:

operator[]()

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

(

const direction

d

)

const

Return a component as a dimensioned<cmptType>

Definition at line 573 of file dimensionedType.C.

operator+=()

void operator+=

(

const dimensioned< Type > &

dt

)

Definition at line 583 of file dimensionedType.C.

operator-=()

void operator-=

(

const dimensioned< Type > &

dt

)

Definition at line 594 of file dimensionedType.C.

operator*=()

void operator*=

(

const scalar

s

)

Definition at line 605 of file dimensionedType.C.

operator/=()

void operator/=

(

const scalar

s

)

Definition at line 615 of file dimensionedType.C.

lookupOrDefault() [1/2]

static 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 515 of file dimensionedType.H.

lookupOrDefault() [2/2]

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

inlinestatic

Same as getOrDefault()

Definition at line 530 of file dimensionedType.H.

lookupOrAddToDict() [1/2]

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

inlinestatic

Same as getOrAddToDict()

Definition at line 544 of file dimensionedType.H.

lookupOrAddToDict() [2/2]

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

inlinestatic

Same as getOrAddToDict()

Definition at line 559 of file dimensionedType.H.

Friends And Related Function Documentation

operator>>

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/dimensionedSphericalTensor/dimensionedSphericalTensor.C
• src/OpenFOAM/dimensionedTypes/dimensionedSymmTensor/dimensionedSymmTensor.C
• src/OpenFOAM/dimensionedTypes/dimensionedTensor/dimensionedTensor.C
• src/OpenFOAM/dimensionedTypes/dimensionedType/dimensionedType.C