dimensioned Class Reference

Generic dimensioned Type class. More...

Inheritance diagram for dimensioned:

Public Types
typedef Type	value_type
typedef pTraits< Type >::cmptType	cmptType

Public Member Functions
	dimensioned ()
	dimensioned (const dimensionSet &dims)
	dimensioned (const dimensionSet &dims, const Foam::zero)
	dimensioned (const dimensionSet &dims, const Foam::one)
	dimensioned (const Type &val)
	dimensioned (const dimensionSet &dims, const Type &val)
	dimensioned (const word &name, const dimensionSet &dims, const Type &val)
	dimensioned (const word &name, const dimensioned< Type > &dt)
	dimensioned (const primitiveEntry &e)
	dimensioned (const primitiveEntry &e, const dimensionSet &dims)
	dimensioned (const word &name, const dictionary &dict)
	dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict)
	dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict, const word &entryName)
	dimensioned (const word &name, const dimensionSet &dims, const Type &val, const dictionary &dict)
const word &	name () const
word &	name ()
const dimensionSet &	dimensions () const
dimensionSet &	dimensions ()
const Type &	value () const
Type &	value ()
dimensioned< cmptType >	component (const direction d) const
void	replace (const direction d, const dimensioned< cmptType > &dc)
dimensioned< Type >	T () const
bool	read (const dictionary &dict)
bool	readIfPresent (const dictionary &dict)
bool	read (const word &entryName, const dictionary &dict)
bool	readIfPresent (const word &entryName, const dictionary &dict)
Istream &	read (Istream &is, const bool readName=true)
Istream &	read (Istream &is, const dictionary &readSet)
Istream &	read (Istream &is, const HashTable< dimensionedScalar > &readSet)
void	writeEntry (const word &keyword, Ostream &os) const
dimensioned< cmptType >	operator[] (const direction d) const
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)
	dimensioned (const word &name, Istream &is)
	dimensioned (const word &name, const dimensionSet &dims, Istream &is)

Static Public Member Functions
static dimensioned< Type >	getOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
static dimensioned< Type >	getOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))
static dimensioned< Type >	getOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
static dimensioned< Type >	getOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))
static dimensioned< Type >	lookupOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
static dimensioned< Type >	lookupOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))
static dimensioned< Type >	lookupOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
static dimensioned< Type >	lookupOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))

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

Detailed Description

Generic dimensioned Type class.

Source files

• dimensionedType.H
• dimensionedType.C

Definition at line 36 of file dimensionedScalarFwd.H.

Member Typedef Documentation

value_type

typedef Type value_type

Definition at line 113 of file dimensionedType.H.

cmptType

typedef pTraits<Type>::cmptType cmptType

Definition at line 116 of file dimensionedType.H.

Constructor & Destructor Documentation

dimensioned() [1/17]

dimensioned

(

)

Definition at line 106 of file dimensionedType.C.

dimensioned() [2/17]

dimensioned ( const dimensionSet &  dims )

explicit

Definition at line 115 of file dimensionedType.C.

dimensioned() [3/17]

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

explicit

Definition at line 125 of file dimensionedType.C.

dimensioned() [4/17]

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

explicit

Definition at line 138 of file dimensionedType.C.

dimensioned() [5/17]

dimensioned ( const Type &  val )

inline

Definition at line 134 of file dimensionedType.H.

dimensioned() [6/17]

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

Definition at line 151 of file dimensionedType.C.

dimensioned() [7/17]

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

Definition at line 164 of file dimensionedType.C.

dimensioned() [8/17]

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

Definition at line 178 of file dimensionedType.C.

dimensioned() [9/17]

dimensioned ( const primitiveEntry &  e )

explicit

Definition at line 191 of file dimensionedType.C.

dimensioned() [10/17]

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

explicit

Definition at line 210 of file dimensionedType.C.

dimensioned() [11/17]

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

Definition at line 230 of file dimensionedType.C.

dimensioned() [12/17]

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

Definition at line 246 of file dimensionedType.C.

dimensioned() [13/17]

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

Parameters

entryName

dictionary lookup name

Definition at line 263 of file dimensionedType.C.

dimensioned() [14/17]

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

Definition at line 281 of file dimensionedType.C.

dimensioned() [15/17]

dimensioned ( Istream &  is )

explicit

Definition at line 298 of file dimensionedType.C.

dimensioned() [16/17]

dimensioned	(	const word &	name,
		Istream &	is
	)

Definition at line 308 of file dimensionedType.C.

dimensioned() [17/17]

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

Definition at line 322 of file dimensionedType.C.

Member Function Documentation

getOrDefault() [1/2]

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

static

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

Here is the caller graph for this function:

getOrDefault() [2/2]

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

static

getOrAddToDict() [1/2]

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

static

Referenced by dimensioned< Type >::lookupOrAddToDict().

Here is the caller graph for this function:

getOrAddToDict() [2/2]

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

static

name() [1/2]

const Foam::word & name

(

)

const

Definition at line 399 of file dimensionedType.C.

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(), SLTSDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), Foam::innerSqr(), Foam::inv(), dimensioned< Type >::lookupOrAddToDict(), dimensioned< Type >::lookupOrDefault(), Foam::mapClouds(), UniformDimensionedField< vector >::name(), Foam::neg(), Foam::neg0(), Foam::negPart(), seriesLess::operator()(), Foam::operator*(), Time::operator++(), Foam::operator==(), Foam::pos(), Foam::pos0(), Foam::posPart(), Foam::pow(), Foam::pow025(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), Time::readDict(), Time::setTime(), Foam::sign(), Foam::skew(), multiphaseSystem::solve(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), Foam::symm(), Time::timeName(), Foam::tr(), Foam::twoSymm(), dimensionSet::write(), and regionSizeDistribution::write().

name() [2/2]

Foam::word & name

(

)

Definition at line 406 of file dimensionedType.C.

dimensions() [1/2]

const Foam::dimensionSet & dimensions

(

)

const

Definition at line 413 of file dimensionedType.C.

Referenced by ObukhovLength::calcOL(), DarcyForchheimer::calcTransformModelData(), Foam::cbrt(), Foam::checkMethod(), Foam::cof(), relaxation::correct(), 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(), CoEulerDdtScheme< Type >::fvmDdt(), backwardDdtScheme< Type >::fvmDdt(), SLTSDdtScheme< Type >::fvmDdt(), localEulerDdtScheme< Type >::fvmDdt(), ddtScheme< Type >::fvmDdt(), CrankNicolsonDdtScheme< Type >::fvmDdt(), Foam::innerSqr(), Foam::inv(), Foam::makeDimensionedMinMax(), Foam::neg(), Foam::neg0(), Foam::negPart(), optionList::operator()(), Foam::operator*(), Foam::pos(), Foam::pos0(), Foam::posPart(), Foam::pow(), Foam::pow025(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), dimensionSet::read(), Foam::sign(), Foam::skew(), Foam::fam::Sp(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), Foam::symm(), Foam::tr(), and Foam::twoSymm().

dimensions() [2/2]

Foam::dimensionSet & dimensions

(

)

Definition at line 420 of file dimensionedType.C.

value() [1/2]

const Type & value

(

)

const

Definition at line 427 of file dimensionedType.C.

Referenced by tabulated6DoFAcceleration::acceleration(), objective::accumulateJMean(), interRegionHeatTransferModel::addSup(), solidificationMeltingSource::addSup(), powerLawUniformBinary::addToBinaryBreakupRate(), hydrodynamic::addToCoalescenceRate(), wallBoiling::addToNucleationRate(), Time::adjustDeltaT(), porosityModel::adjustNegativeResistance(), Foam::adjustPhi(), maxDurationCondition::apply(), Foam::atan2(), surfaceWriter::beginTime(), Foam::bound(), NonInertialFrameForce< CloudType >::cacheFields(), SprayParcel::calcAtomization(), BrownianMotionForce< CloudType >::calcCoupled(), ThermoParcel::calcHeatTransfer(), SRFForce< CloudType >::calcNonCoupled(), ParamagneticForce< CloudType >::calcNonCoupled(), powerLaw::calcNu(), DarcyForchheimer::calcTransformModelData(), viewFactor::calculate(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::calculateVolumeFractions(), Foam::cbrt(), SIMPLEControlSingleRun::checkEndTime(), timeVaryingMappedFixedValuePointPatchField< Type >::checkTable(), GeometricField< scalar, faPatchField, areaMesh >::clip(), Foam::cof(), fixedTemperatureConstraint::constrain(), constantNucleation::correct(), BrunDrippingInjection::correct(), adjointSpalartAllmaras::correct(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), liquidFilmBase::CourantNumber(), logFiles::createFiles(), curvatureSeparation::curvatureSeparation(), filmTurbulenceModel::Cw(), thermoCoupleProbes::derivatives(), DEShybrid< Type >::DEShybrid(), Foam::det(), Foam::dev(), Foam::dev2(), adjointSpalartAllmaras::diffusionCoeffVar1(), Foam::eigenValues(), Foam::eigenVectors(), engineMesh::engineMesh(), ThermoCloud< CloudType >::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(), forAll(), interfaceTrackingFvMesh::freeSurfacePressureJump(), basicCombustionMixture::fres(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), backwardDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), waveMakerPointPatchVectorField::g(), populationBalanceModel::gamma(), if(), reactingOneDim::info(), InjectionModel< CloudType >::injectSteadyState(), Foam::innerSqr(), Foam::inv(), Foam::invTransform(), objective::isWithinIntegrationTime(), heatTransferModel::K(), laminarFlameSpeed::laminarFlameSpeed(), hexRef8::level0EdgeLength(), pressureControl::limit(), ArdenBuck::lnPSat(), adjointSimple::mainIter(), Foam::makeDimensionedMinMax(), Foam::max(), GeometricField< scalar, faPatchField, areaMesh >::max(), Foam::min(), GeometricField< scalar, faPatchField, areaMesh >::min(), egrMixture< ThermoType >::mixture(), inhomogeneousMixture< ThermoType >::mixture(), Foam::neg(), Foam::neg0(), Foam::negPart(), Schaeffer::nu(), JohnsonJacksonSchaeffer::nu(), Foam::operator!=(), seriesLess::operator()(), Instant< T >::less::operator()(), Foam::operator*(), Foam::operator+(), Time::operator+=(), Foam::operator-(), Foam::operator<(), Foam::operator<<(), Foam::operator==(), Foam::operator>(), Foam::operator>>(), Foam::oversetAdjustPhi(), 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(), dimensionSet::read(), comfort::read(), Time::readDict(), SIMPLEControlSingleRun::readIters(), GeometricField< scalar, faPatchField, areaMesh >::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::fam::Sp(), Foam::fvc::spreadSource(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), particle< Type >::stepFractionSpan(), Foam::symm(), freePiston::theta(), TimeState::timeOutputValue(), Foam::tr(), Foam::transform(), linearMotion::transformation(), multiMotion::transformation(), oscillatingLinearMotion::transformation(), oscillatingRotatingMotion::transformation(), drivenLinearMotion::transformation(), rotatingMotion::transformation(), tabulated6DoFMotion::transformation(), Foam::twoSymm(), interfaceTrackingFvMesh::update(), 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(), FacePostProcessing< CloudType >::write(), specieReactionRates< ChemistryModelType >::write(), dsmcFields::write(), ParticleCollector< CloudType >::write(), sizeDistribution::write(), dimensionSet::write(), objective::write(), regionSizeDistribution::write(), sizeDistribution::writeFileHeader(), objective::writeInstantaneousValue(), and objective::writeMeanValue().

value() [2/2]

Type & value

(

)

Definition at line 434 of file dimensionedType.C.

component()

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

(

const direction

d

)

const

Definition at line 443 of file dimensionedType.C.

Referenced by Foam::ComplexField(), Foam::ReComplexField(), and coordinateScaling< Type >::transform().

Here is the caller graph for this function:

replace()

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

Definition at line 458 of file dimensionedType.C.

T()

dimensioned<Type> T

(

)

const

Referenced by eddy::eddy(), Foam::inv(), leastSquares::stencilWeights(), and SVD::VSinvUt().

Here is the caller graph for this function:

read() [1/5]

bool read

(

const dictionary &

dict

)

Definition at line 469 of file dimensionedType.C.

Referenced by Foam::unitSet().

Here is the caller graph for this function:

readIfPresent() [1/2]

bool readIfPresent

(

const dictionary &

dict

)

Definition at line 476 of file dimensionedType.C.

Referenced by crankConRod::crankConRod(), ShihQuadraticKE::read(), LamBremhorstKE::read(), qZeta::read(), LienLeschziner::read(), LienCubicKE::read(), SpalartAllmarasDES< BasicTurbulenceModel >::read(), SpalartAllmaras< BasicTurbulenceModel >::read(), kkLOmega::read(), adjointSpalartAllmaras::read(), and sixDoFRigidBodyMotionSolver::solve().

Here is the caller graph for this function:

read() [2/5]

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

Definition at line 484 of file dimensionedType.C.

readIfPresent() [2/2]

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

Definition at line 496 of file dimensionedType.C.

read() [3/5]

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

read() [4/5]

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

Definition at line 530 of file dimensionedType.C.

read() [5/5]

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

Definition at line 550 of file dimensionedType.C.

writeEntry()

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

Definition at line 573 of file dimensionedType.C.

operator[]()

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

(

const direction

d

)

const

Definition at line 602 of file dimensionedType.C.

operator+=()

void operator+=

(

const dimensioned< Type > &

dt

)

Definition at line 612 of file dimensionedType.C.

operator-=()

void operator-=

(

const dimensioned< Type > &

dt

)

Definition at line 623 of file dimensionedType.C.

operator*=()

void operator*=

(

const scalar

s

)

Definition at line 634 of file dimensionedType.C.

operator/=()

void operator/=

(

const scalar

s

)

Definition at line 644 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

Definition at line 401 of file dimensionedType.H.

lookupOrDefault() [2/2]

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

inlinestatic

Definition at line 414 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

Definition at line 427 of file dimensionedType.H.

lookupOrAddToDict() [2/2]

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

inlinestatic

Definition at line 441 of file dimensionedType.H.

Friends And Related Function Documentation

operator>>

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

friend

---

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