dimensioned< Type > Class Template Reference

Generic dimensioned Type class. More...

Inheritance diagram for dimensioned< Type >:

Public Types
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...

Public Member Functions
	dimensioned ()
	Null constructor. More...
	dimensioned (const word &, const dimensionSet &, const Type &)
	Construct given name, dimensions and value. More...
	dimensioned (const dimensionSet &, const Type &)
	Construct given dimensions and value. More...
	dimensioned (const Type &)
	Construct dimensionless given value only. More...
	dimensioned (const word &, const dimensioned< Type > &)
	Construct from a dimensioned<Type> changing the name. More...
	dimensioned (Istream &)
	Construct from Istream. More...
	dimensioned (const word &, Istream &)
	Construct from an Istream with a given name. More...
	dimensioned (const word &, const dimensionSet &, Istream &)
	Construct from an Istream with a given name and dimensions. More...
	dimensioned (const word &, const unitSet &, Istream &)
	Construct from an Istream with a given name and units. More...
	dimensioned (const word &, const dimensionSet &, const dictionary &)
	Construct from dictionary lookup with a given name and dimensions. More...
	dimensioned (const word &, const unitSet &, const dictionary &)
	Construct from dictionary lookup with a given name and units. More...
	dimensioned (const word &name, const dimensionSet &dimensions, const dictionary &dict, const Type &defaultValue)
	Construct from dictionary lookup with a given name and dimensions. More...
	dimensioned (const word &name, const dictionary &dict, const Type &defaultValue)
	Construct from dictionary lookup with the given name, dimensionless,. More...
	dimensioned (const word &name, const unitSet &, const dictionary &, const Type &defaultValue)
	Construct from dictionary lookup with the given name and units. More...
const word &	name () const
	Return const reference to name. More...
word &	name ()
	Return non-const reference to name. More...
const dimensionSet &	dimensions () const
	Return const reference to dimensions. More...
dimensionSet &	dimensions ()
	Return non-const reference to dimensions. More...
const Type &	value () const
	Return const reference to value. More...
Type &	value ()
	Return non-const reference to value. More...
dimensioned< cmptType >	component (const direction) const
	Return a component as a dimensioned<cmptType> More...
void	replace (const direction, const dimensioned< cmptType > &)
	Return a component with a dimensioned<cmptType> More...
dimensioned< Type >	T () const
	Return transpose. More...
void	read (const dictionary &, const unitSet &defaultUnits=NullObjectRef< unitSet >())
	Update the value of dimensioned<Type> More...
bool	readIfPresent (const dictionary &, const unitSet &defaultUnits=NullObjectRef< unitSet >())
	Update the value of dimensioned<Type> if found in the dictionary. More...
void	readOrDefault (const dictionary &, const Type &defaultValue, const unitSet &defaultUnits=NullObjectRef< unitSet >())
	Update the value of dimensioned<Type> if found in the dictionary. More...
dimensioned< cmptType >	operator[] (const direction) const
	Return a component as a dimensioned<cmptType> More...
void	operator+= (const dimensioned< Type > &)
void	operator-= (const dimensioned< Type > &)
void	operator*= (const scalar)
void	operator/= (const scalar)

Friends
Istream &	operator>> (Istream &, dimensioned< Type > &)
Ostream &	operator (Ostream &, const dimensioned< Type > &)

Detailed Description

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

Generic dimensioned Type class.

Source files

• dimensionedType.H
• dimensionedType.C

Definition at line 62 of file dimensionedType.H.

Member Typedef Documentation

cmptType

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 101 of file dimensionedType.H.

Constructor & Destructor Documentation

dimensioned() [1/14]

dimensioned

Null constructor.

Definition at line 96 of file dimensionedType.C.

References Foam::nan.

dimensioned() [2/14]

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

Construct given name, dimensions and value.

Definition at line 105 of file dimensionedType.C.

dimensioned() [3/14]

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

Construct given dimensions and value.

with the name obtained from the value

Definition at line 119 of file dimensionedType.C.

dimensioned() [4/14]

dimensioned

(

const Type &

t

)

Construct dimensionless given value only.

with a name obtained from the value

Definition at line 128 of file dimensionedType.C.

dimensioned() [5/14]

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

Construct from a dimensioned<Type> changing the name.

Definition at line 137 of file dimensionedType.C.

dimensioned() [6/14]

dimensioned

(

Istream &

is

)

Construct from Istream.

Definition at line 150 of file dimensionedType.C.

dimensioned() [7/14]

dimensioned	(	const word &	name,
		Istream &	is
	)

Construct from an Istream with a given name.

Definition at line 159 of file dimensionedType.C.

dimensioned() [8/14]

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

Construct from an Istream with a given name and dimensions.

Definition at line 169 of file dimensionedType.C.

dimensioned() [9/14]

dimensioned	(	const word &	name,
		const unitSet &	units,
		Istream &	is
	)

Construct from an Istream with a given name and units.

Definition at line 185 of file dimensionedType.C.

dimensioned() [10/14]

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

Construct from dictionary lookup with a given name and dimensions.

Definition at line 201 of file dimensionedType.C.

dimensioned() [11/14]

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

Construct from dictionary lookup with a given name and units.

Definition at line 217 of file dimensionedType.C.

dimensioned() [12/14]

dimensioned	(	const word &	name,
		const dimensionSet &	dimensions,
		const dictionary &	dict,
		const Type &	defaultValue
	)

Construct from dictionary lookup with a given name and dimensions.

and if not found set to the given default value

Definition at line 233 of file dimensionedType.C.

References dictionary::add(), printDictionary::defaults(), dict, printDictionary::haveDefaults(), and dimensioned< Type >::name().

Here is the call graph for this function:

dimensioned() [13/14]

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

Construct from dictionary lookup with the given name, dimensionless,.

and if not found set to the given default value

Definition at line 257 of file dimensionedType.C.

dimensioned() [14/14]

dimensioned	(	const word &	name,
		const unitSet &	units,
		const dictionary &	dict,
		const Type &	defaultValue
	)

Construct from dictionary lookup with the given name and units.

and if not found set to the given default value

Definition at line 269 of file dimensionedType.C.

References dictionary::add(), printDictionary::defaults(), dict, printDictionary::haveDefaults(), and dimensioned< Type >::name().

Here is the call graph for this function:

Member Function Documentation

name() [1/2]

const Foam::word & name

Return const reference to name.

Definition at line 295 of file dimensionedType.C.

Referenced by KochFriedlanderSintering::addSup(), Foam::atan2(), cellCoBlended< Type >::blendingFactor(), nearWallFields::calcAddressing(), Foam::patchCutPlot::calcCutXs(), Foam::cellCutPlot::calcCutXs(), XiEqModel::calculateSchelkinEffect(), Foam::cbrt(), Foam::meshCheck::checkGeometry(), Foam::checkMethod(), Foam::meshCheck::checkTopology(), Foam::cof(), compressibleMultiphaseVoF::compressibleMultiphaseVoF(), compressibleTwoPhaseVoFMixture::compressibleTwoPhaseVoFMixture(), compressibleVoF::compressibleVoF(), populationBalanceModel::correct(), Foam::fv::CorrectPhi(), nearWallFields::createFields(), logFiles::createFiles(), interpolator::curPointField(), Foam::fvc::ddt(), pointFieldDecomposer::decomposeField(), Foam::det(), Foam::dev(), Foam::dev2(), dimensioned< Type >::dimensioned(), cellsToCells::distributeMesh(), Foam::eigenValues(), Foam::eigenVectors(), phaseScalarTransport::execute(), scalarTransport::execute(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdt(), multicomponentLagrangianThermo::implementation::implementation(), psiuMulticomponentThermo::implementation::implementation(), incompressibleDriftFlux::incompressibleDriftFlux(), incompressibleFluid::incompressibleFluid(), incompressibleMultiphaseVoF::incompressibleMultiphaseVoF(), incompressibleVoF::incompressibleVoF(), Foam::innerSqr(), fvMeshSubset::interpolate(), Foam::inv(), isothermalFluid::isothermalFluid(), CrankNicolson< Type >::LagrangianmInitDdt(), Foam::fvc::laplacian(), Foam::fvm::laplacian(), Foam::MULES::limit(), Foam::MULES::limitCorr(), LimitedScheme< Type, Limiter, LimitFunc >::limiter(), basicThermo::lookupOrConstruct(), Foam::MapConsistentVolFields(), Foam::MapGeometricFields(), Foam::MapLagrangianFields(), Foam::MapVolFields(), massDiffusionLimitedPhaseChange::massDiffusionLimitedPhaseChange(), LocalInteraction< CloudType >::massEscape(), LocalInteraction< CloudType >::massStick(), polyMesh::meshDirInstance(), Foam::MeshToMeshMapVolFields(), populationBalanceModel::modelSourceSu(), solidParticle::move(), MovingPhaseModel< BasePhaseModel >::MovingPhaseModel(), Foam::neg(), Foam::neg0(), Foam::negPart(), buoyancy::New(), GeometricField< Type, GeoMesh, PrimitiveField >::New(), Foam::operator*(), Foam::polyMeshZipUpCells(), populationBalanceModel::populationBalanceModel(), Foam::pos(), Foam::pos0(), Foam::posPart(), Foam::pow(), Foam::pow025(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), ParticleErosion< CloudType >::preEvolve(), PrinceBlanch::PrinceBlanch(), turbulenceFields::processField(), radiativeIntensityRay::radiativeIntensityRay(), forcing::readLambda(), fieldAverage::readMeanFieldType(), timeSelector::selectIfPresent(), refinementIterator::setRefinement(), masterUncollatedFileOperation::setTime(), shockFluid::shockFluid(), Foam::sign(), Foam::skew(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), MPLIC::surfaceAlpha(), Foam::symm(), dimensioned< Type >::T(), KochFriedlanderSintering::tau(), Foam::tr(), Foam::transform(), cellsToCells::trimLocalTgt(), Foam::twoSymm(), MPPICParcel< ParcelType >::trackingData::updateAverages(), VoFSolver::VoFSolver(), MeshedSurfaceProxy< Face >::write(), Foam::writeEntry(), Foam::cellCutPlot::writeLayers(), Foam::patchCutPlot::writeLayers(), Foam::writeMeshObject(), and Foam::zeroDimensionalFvMesh().

Here is the caller graph for this function:

name() [2/2]

Foam::word & name

Return non-const reference to name.

Definition at line 301 of file dimensionedType.C.

dimensions() [1/2]

const Foam::dimensionSet & dimensions

Return const reference to dimensions.

Definition at line 308 of file dimensionedType.C.

Referenced by fvTotalSource::addSupType(), Foam::cbrt(), Foam::checkMethod(), Foam::cof(), relaxation::correct(), Foam::det(), Foam::dev(), Foam::dev2(), Foam::eigenValues(), comfort::execute(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdt(), Foam::innerSqr(), Foam::inv(), LocalUniformDimensionedField< Type >::LocalUniformDimensionedField(), Foam::neg(), Foam::neg0(), Foam::negPart(), Foam::operator*(), DimensionedField< Type, GeoMesh, PrimitiveField >::operator=(), Foam::pos(), Foam::pos0(), Foam::posPart(), Foam::pow(), Foam::pow025(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), LiaoBase::precompute(), forcing::readLambda(), Foam::sign(), Foam::skew(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), Foam::symm(), dimensioned< Type >::T(), Foam::tr(), Foam::twoSymm(), and Foam::writeEntry().

Here is the caller graph for this function:

dimensions() [2/2]

Foam::dimensionSet & dimensions

Return non-const reference to dimensions.

Definition at line 314 of file dimensionedType.C.

value() [1/2]

const Type & value

Return const reference to value.

Definition at line 321 of file dimensionedType.C.

Referenced by porosityModel::adjustNegativeResistance(), Foam::atan2(), NonInertialFrameForce< CloudType >::cacheFields(), SprayParcel< ParcelType >::calcAtomisation(), ThermoParcel< ParcelType >::calcHeatTransfer(), ParamagneticForce< CloudType >::calcNonCoupled(), adsorptionMassFractionFvPatchScalarField::calcPhiYp(), semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), viewFactor::calculate(), singleStepReaction::calculateqFuel(), Foam::cbrt(), Foam::cof(), movingForces::CofR(), fixedTemperature::constrain(), pointInjection::correct(), volumeInjection::correct(), waveForcing::correct(), Foam::correctContactAngle(), propellerDiskAdjustment::correctn(), CrankNicolsonDdtScheme< Type >::ddt0_(), Foam::det(), Foam::dev(), Foam::dev2(), Foam::eigenValues(), Foam::eigenVectors(), ThermoCloud< CloudType >::Ep(), waveAlpha::evaluate(), waveVelocity::evaluate(), Foam::saturationModels::evaluate(), comfort::execute(), EulerD2dt2Scheme< Type >::fvcD2dt2(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), if(), bXiTimedIgnition::ignited(), bXiTimedIgnition::igniting(), Foam::innerSqr(), Foam::inv(), rotating::jcalc(), tabulatedSolidTransport< Thermo >::Kappa(), linearTsub::linearTsub(), ArdenBuck::lnPSat(), MarshakRadiationFixedTemperatureFvPatchScalarField::MarshakRadiationFixedTemperatureFvPatchScalarField(), DimensionedField< Type, GeoMesh, PrimitiveField >::max(), GeometricField< Type, GeoMesh, PrimitiveField >::max(), DimensionedField< Type, GeoMesh, PrimitiveField >::maxMin(), GeometricField< Type, GeoMesh, PrimitiveField >::maxMin(), polyMesh::meshDirInstance(), DimensionedField< Type, GeoMesh, PrimitiveField >::min(), GeometricField< Type, GeoMesh, PrimitiveField >::min(), diskInjection::modify(), manualInjection::modify(), patchInjection::modify(), pointInjection::modify(), volumeInjection::modify(), solidParticleCloud::move(), Foam::neg(), Foam::neg0(), Foam::negPart(), rigidBodyDisplacement::newPoints(), JohnsonJacksonSchaeffer::nu(), Schaeffer::nu(), Foam::operator*(), Time::operator+=(), Foam::operator+=(), Foam::operator-=(), DimensionedField< Type, GeoMesh, PrimitiveField >::operator=(), GeometricField< Type, GeoMesh, PrimitiveField >::operator=(), GeometricField< Type, GeoMesh, PrimitiveField >::operator==(), Foam::pos(), Foam::pos0(), Foam::posPart(), Foam::pow(), Foam::pow025(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), LiaoBase::precompute(), powerLawUniformBinary::rate(), comfort::read(), GeometricField< Type, GeoMesh, PrimitiveField >::replace(), Time::setDeltaT(), Time::setEndTime(), ConeInjection< CloudType >::setPositionAndCell(), Time::setTime(), masterUncollatedFileOperation::setTime(), temperatureDependent::sigma(), Foam::sign(), Foam::skew(), nucleationGroupSurfaceAreaVolumeRatioFvScalarFieldSource::sourceValue(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), Foam::symm(), dimensioned< Type >::T(), Foam::tr(), Foam::transform(), Foam::twoSymm(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), inkJet::update(), fixedPressureCompressibleDensityFvPatchScalarField::updateCoeffs(), PrghPressureFvPatchScalarField< PressureFvPatchScalarField >::updateCoeffs(), rotatingTotalPressureFvPatchScalarField::updateCoeffs(), rotatingWallVelocityFvPatchVectorField::updateCoeffs(), angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), oscillatingDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), waveDisplacementPointPatchVectorField::updateCoeffs(), MarshakRadiationFvPatchScalarField::updateCoeffs(), MarshakRadiationFixedTemperatureFvPatchScalarField::updateCoeffs(), coefficient< Field< Type > >::value(), Function1LagrangianFieldSource::value(), Sine< Type >::value(), fvMesh::Vsc(), fvMesh::Vsc0(), Foam::W(), wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField(), and Foam::writeEntry().

Here is the caller graph for this function:

value() [2/2]

Type & value

Return non-const reference to value.

Definition at line 327 of file dimensionedType.C.

component()

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

(

const direction

d

)

const

Return a component as a dimensioned<cmptType>

Definition at line 335 of file dimensionedType.C.

References Foam::name().

Referenced by Foam::ComplexField().

Here is the call graph for this function:

Here is the caller graph for this function:

replace()

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

Return a component with a dimensioned<cmptType>

Definition at line 350 of file dimensionedType.C.

T()

dimensionedTensor T

Return transpose.

Definition at line 36 of file dimensionedSphericalTensor.C.

References dimensioned< Type >::dimensions(), dimensioned< Type >::name(), and dimensioned< Type >::value().

Here is the call graph for this function:

read()

void read	(	const dictionary &	dict,
		const unitSet &	defaultUnits = NullObjectRef<unitSet>()
	)

Update the value of dimensioned<Type>

Definition at line 362 of file dimensionedType.C.

References dict, Foam::isNull(), and dictionary::lookup().

Referenced by main(), cylindrical::readCoeffs(), linearEquilibrium::readCoeffs(), transport::readCoeffs(), uniformConstant::readCoeffs(), constant::readCoeffs(), and instability::readCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

readIfPresent()

bool readIfPresent	(	const dictionary &	dict,
		const unitSet &	defaultUnits = NullObjectRef<unitSet>()
	)

Update the value of dimensioned<Type> if found in the dictionary.

Definition at line 378 of file dimensionedType.C.

References dict, Foam::isNull(), dictionary::lookupEntryPtr(), and entry::stream().

Referenced by makeMomentumTransportModelTypes(), PDRkEpsilon::read(), cylindrical::readCoeffs(), spherical::readCoeffs(), Gulder::readCoeffs(), KTS::readCoeffs(), cubic::readCoeffs(), and linear::readCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

readOrDefault()

void readOrDefault	(	const dictionary &	dict,
		const Type &	defaultValue,
		const unitSet &	defaultUnits = NullObjectRef<unitSet>()
	)

Update the value of dimensioned<Type> if found in the dictionary.

and if not found set to the given default value

Definition at line 404 of file dimensionedType.C.

References dict, Foam::isNull(), dictionary::lookupEntryPtr(), and entry::stream().

Here is the call 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 433 of file dimensionedType.C.

References Foam::component().

Here is the call graph for this function:

operator+=()

void operator+=

(

const dimensioned< Type > &

dt

)

Definition at line 440 of file dimensionedType.C.

operator-=()

void operator-=

(

const dimensioned< Type > &

dt

)

Definition at line 448 of file dimensionedType.C.

operator*=()

void operator*=

(

const scalar

s

)

Definition at line 456 of file dimensionedType.C.

References s().

Here is the call graph for this function:

operator/=()

void operator/=

(

const scalar

s

)

Definition at line 463 of file dimensionedType.C.

References s().

Here is the call graph for this function:

Friends And Related Function Documentation

operator>>

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

friend

operator

Ostream& operator ( Ostream &  , const dimensioned< Type > &    )

friend

---

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

• 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