Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
dimensioned< Type > Class Template Reference

Generic dimensioned Type class. More...

Inheritance diagram for dimensioned< Type >:
Inheritance graph
[legend]

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 dimensionSet &, const dictionary &)
 Construct from dictionary lookup with a given name and dimensions. 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 &)
 Update the value of dimensioned<Type> More...
 
bool readIfPresent (const dictionary &)
 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)
 

Static Public Member Functions

static dimensioned< Type > lookupOrDefault (const word &, const dictionary &, const dimensionSet &dims=dimless, const Type &defaultValue=pTraits< Type >::zero)
 Construct from dictionary, with default dimensions and value. More...
 
static dimensioned< Type > lookupOrDefault (const word &, const dictionary &, const Type &defaultValue=pTraits< Type >::zero)
 Construct from dictionary dimensionless with value. More...
 
static dimensioned< Type > lookupOrAddToDict (const word &, dictionary &, const dimensionSet &dims=dimless, const Type &defaultValue=pTraits< Type >::zero)
 Construct from dictionary, with default value. More...
 
static dimensioned< Type > lookupOrAddToDict (const word &, dictionary &, const Type &defaultValue=pTraits< Type >::zero)
 Construct from dictionary, dimensionless with default value. More...
 

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

Definition at line 61 of file dimensionedType.H.

Member Typedef Documentation

◆ cmptType

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 100 of file dimensionedType.H.

Constructor & Destructor Documentation

◆ dimensioned() [1/9]

dimensioned

Null constructor.

Definition at line 94 of file dimensionedType.C.

References Foam::nan.

◆ dimensioned() [2/9]

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

Construct given name, dimensions and value.

Definition at line 103 of file dimensionedType.C.

◆ dimensioned() [3/9]

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

Construct given dimensions and value.

with the name obtained from the value

Definition at line 117 of file dimensionedType.C.

◆ dimensioned() [4/9]

dimensioned ( const Type &  t)

Construct dimensionless given value only.

with a name obtained from the value

Definition at line 126 of file dimensionedType.C.

◆ dimensioned() [5/9]

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

Construct from a dimensioned<Type> changing the name.

Definition at line 135 of file dimensionedType.C.

◆ dimensioned() [6/9]

dimensioned ( Istream &  is)

Construct from Istream.

Definition at line 148 of file dimensionedType.C.

References word::null, and Foam::unitAny.

◆ dimensioned() [7/9]

dimensioned ( const word &  name,
Istream &  is 
)

Construct from an Istream with a given name.

Definition at line 157 of file dimensionedType.C.

References dimensioned< Type >::name(), and Foam::unitAny.

Here is the call graph for this function:

◆ dimensioned() [8/9]

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

Construct from an Istream with a given name and dimensions.

Definition at line 167 of file dimensionedType.C.

◆ dimensioned() [9/9]

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

Construct from dictionary lookup with a given name and dimensions.

Definition at line 183 of file dimensionedType.C.

Member Function Documentation

◆ lookupOrDefault() [1/2]

Foam::dimensioned< Type > lookupOrDefault ( const word &  name,
const dictionary &  dict,
const dimensionSet &  dims = dimless,
const Type &  defaultValue = pTraits<Type>::zero 
)
static

Construct from dictionary, with default dimensions and value.

Definition at line 201 of file dimensionedType.C.

◆ lookupOrDefault() [2/2]

Foam::dimensioned< Type > lookupOrDefault ( const word &  name,
const dictionary &  dict,
const Type &  defaultValue = pTraits<Type>::zero 
)
static

Construct from dictionary dimensionless with value.

Definition at line 221 of file dimensionedType.C.

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

Here is the call graph for this function:

◆ lookupOrAddToDict() [1/2]

Foam::dimensioned< Type > lookupOrAddToDict ( const word &  name,
dictionary &  dict,
const dimensionSet &  dims = dimless,
const Type &  defaultValue = pTraits<Type>::zero 
)
static

Construct from dictionary, with default value.

If the value is not found, it is added into the dictionary.

Definition at line 233 of file dimensionedType.C.

References dict, dictionary::lookupOrAddDefault(), and Foam::name().

Here is the call graph for this function:

◆ lookupOrAddToDict() [2/2]

Foam::dimensioned< Type > lookupOrAddToDict ( const word &  name,
dictionary &  dict,
const Type &  defaultValue = pTraits<Type>::zero 
)
static

Construct from dictionary, dimensionless with default value.

If the value is not found, it is added into the dictionary.

Definition at line 247 of file dimensionedType.C.

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

Here is the call graph for this function:

◆ name() [1/2]

const Foam::word & name

Return const reference to name.

Definition at line 261 of file dimensionedType.C.

Referenced by Foam::atan2(), cellCoBlended< Type >::blendingFactor(), nearWallFields::calcAddressing(), XiEqModel::calculateSchelkinEffect(), Foam::cbrt(), Foam::meshCheck::checkGeometry(), Foam::checkMethod(), Foam::meshCheck::checkTopology(), Foam::cof(), compressibleMultiphaseVoF::compressibleMultiphaseVoF(), compressibleTwoPhaseVoFMixture::compressibleTwoPhaseVoFMixture(), compressibleVoF::compressibleVoF(), Foam::fv::CorrectPhi(), nearWallFields::createFields(), logFiles::createFiles(), dynamicMeshPointInterpolator::curPointField(), Foam::fvc::ddt(), Foam::det(), Foam::dev(), Foam::dev2(), dimensioned< Type >::dimensioned(), displacementComponentLaplacianFvMotionSolver::displacementComponentLaplacianFvMotionSolver(), displacementLaplacianFvMotionSolver::displacementLaplacianFvMotionSolver(), cellsToCells::distributeMesh(), kineticTheoryModel::divDevTau(), Foam::eigenValues(), Foam::eigenVectors(), phaseScalarTransport::execute(), masterUncollatedFileOperation::findInstance(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), localEulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), steadyStateDdtScheme< Type >::fvcDdt(), psiuMulticomponentThermo::implementation::implementation(), incompressibleDriftFlux::incompressibleDriftFlux(), incompressibleFluid::incompressibleFluid(), incompressibleMultiphaseVoF::incompressibleMultiphaseVoF(), incompressibleVoF::incompressibleVoF(), Foam::innerSqr(), fvMeshSubset::interpolate(), Foam::inv(), isothermalFluid::isothermalFluid(), Foam::fvc::laplacian(), Foam::fvm::laplacian(), Foam::MULES::limit(), Foam::MULES::limitCorr(), LimitedScheme< Type, Limiter, LimitFunc >::limiter(), readFields::loadField(), basicThermo::lookupOrConstruct(), Foam::MapConsistentVolFields(), Foam::MapGeometricFields(), Foam::MapLagrangianFields(), Foam::MapVolFields(), LocalInteraction< CloudType >::massEscape(), LocalInteraction< CloudType >::massStick(), Foam::MeshToMeshMapVolFields(), solidParticle::move(), MovingPhaseModel< BasePhaseModel >::MovingPhaseModel(), Foam::neg(), Foam::neg0(), Foam::negPart(), buoyancy::New(), Foam::operator*(), phaseChange::phaseChange(), phaseForces::phaseForces(), 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(), KochFriedlander::R(), noSintering::R(), dummy::R(), radiativeIntensityRay::radiativeIntensityRay(), forcing::readLambda(), fieldAverage::readMeanFieldType(), scalarTransport::scalarTransport(), timeSelector::selectIfPresent(), refinementIterator::setRefinement(), masterUncollatedFileOperation::setTime(), shockFluid::shockFluid(), Foam::sign(), Foam::skew(), phaseSystem::solve(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), MPLIC::surfaceAlpha(), Foam::symm(), dimensioned< Type >::T(), Foam::tr(), Foam::transform(), cellsToCells::trimLocalTgt(), Foam::twoSymm(), MPPICParcel< ParcelType >::trackingData::updateAverages(), VoFSolver::VoFSolver(), FacePostProcessing< CloudType >::write(), ParticleCollector< CloudType >::write(), MeshedSurfaceProxy< Face >::write(), 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 267 of file dimensionedType.C.

◆ dimensions() [1/2]

const Foam::dimensionSet & dimensions

Return const reference to dimensions.

Definition at line 274 of file dimensionedType.C.

Referenced by fvTotalSource::addSupType(), Foam::cbrt(), Foam::checkMethod(), Foam::cof(), relaxation::correct(), Foam::det(), Foam::dev(), Foam::dev2(), Foam::dimensionedConstant(), 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(), Foam::neg(), Foam::neg0(), Foam::negPart(), Foam::operator*(), DimensionedField< Type, GeoMesh >::operator=(), DimensionedField< Type, GeoMesh >::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 UniformDimensionedField< Type >::UniformDimensionedField().

Here is the caller graph for this function:

◆ dimensions() [2/2]

Foam::dimensionSet & dimensions

Return non-const reference to dimensions.

Definition at line 280 of file dimensionedType.C.

◆ value() [1/2]

const Type & value

Return const reference to value.

Definition at line 287 of file dimensionedType.C.

Referenced by fvTotalSource::addSupType(), powerLawUniformBinary::addToBinaryBreakupRate(), hydrodynamic::addToCoalescenceRate(), wallBoiling::addToNucleationRate(), porosityModel::adjustNegativeResistance(), Foam::atan2(), NonInertialFrameForce< CloudType >::cacheFields(), SprayParcel< ParcelType >::calcAtomisation(), ThermoParcel< ParcelType >::calcHeatTransfer(), ParamagneticForce< CloudType >::calcNonCoupled(), adsorptionMassFractionFvPatchScalarField::calcPhiYp(), semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), viewFactor::calculate(), singleStepCombustion::calculateqFuel(), Foam::cbrt(), Foam::cof(), movingForces::CofR(), Foam::correctContactAngle(), CrankNicolsonDdtScheme< Type >::ddt0_(), Foam::det(), Foam::dev(), Foam::dev2(), Foam::eigenValues(), Foam::eigenVectors(), ThermoCloud< CloudType >::Ep(), comfort::execute(), egrMixture< ThermoType >::fres(), inhomogeneousMixture< ThermoType >::fres(), veryInhomogeneousMixture< ThermoType >::fres(), EulerD2dt2Scheme< Type >::fvcD2dt2(), backwardDdtScheme< Type >::fvcDdt(), CoEulerDdtScheme< Type >::fvcDdt(), EulerDdtScheme< Type >::fvcDdt(), SLTSDdtScheme< Type >::fvcDdt(), CrankNicolsonDdtScheme< Type >::fvcDdt(), GeometricField< symmTensor >::GeometricField(), if(), InjectionModel< CloudType >::inject(), Foam::innerSqr(), Foam::inv(), rotating::jcalc(), tabulatedSolidTransport< Thermo >::Kappa(), laminarFlameSpeed::laminarFlameSpeed(), linearTsub::linearTsub(), ArdenBuck::lnPSat(), MarshakRadiationFixedTemperatureFvPatchScalarField::MarshakRadiationFixedTemperatureFvPatchScalarField(), PatchFlowRateInjection< CloudType >::massToInject(), GeometricField< Type, PatchField, GeoMesh >::max(), GeometricField< Type, PatchField, GeoMesh >::maxMin(), GeometricField< Type, PatchField, GeoMesh >::min(), solidParticleCloud::move(), Foam::neg(), Foam::neg0(), Foam::negPart(), PatchFlowRateInjection< CloudType >::nParcelsToInject(), JohnsonJacksonSchaeffer::nu(), Schaeffer::nu(), Foam::operator*(), Time::operator+=(), DimensionedField< Type, GeoMesh >::operator=(), GeometricField< Type, PatchField, GeoMesh >::operator=(), DimensionedField< Type, GeoMesh >::operator==(), GeometricField< Type, PatchField, GeoMesh >::operator==(), Foam::pos(), Foam::pos0(), Foam::posPart(), Foam::pow(), Foam::pow025(), Foam::pow3(), Foam::pow4(), Foam::pow5(), Foam::pow6(), LiaoBase::precompute(), reactionDriven::reactionDriven(), comfort::read(), GeometricField< Type, PatchField, GeoMesh >::replace(), exponential::setBreakupRate(), powerLaw::setBreakupRate(), Time::setDeltaT(), Time::setEndTime(), ConeInjection< CloudType >::setPositionAndCell(), Time::setTime(), masterUncollatedFileOperation::setTime(), temperatureDependent::sigma(), Foam::sign(), Foam::skew(), rigidBodyMeshMotion::solve(), rigidBodyMeshMotionSolver::solve(), sixDoFRigidBodyMotionSolver::solve(), Foam::sqr(), Foam::sqrt(), Foam::stabilise(), XiFluid::StCorr(), Foam::symm(), dimensioned< Type >::T(), KochFriedlander::tau(), Foam::tr(), Foam::transform(), Foam::twoSymm(), uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField(), smoluchowskiJumpTFvPatchScalarField::updateCoeffs(), fixedPressureCompressibleDensityFvPatchScalarField::updateCoeffs(), PrghPressureFvPatchScalarField< PressureFvPatchScalarField >::updateCoeffs(), rotatingTotalPressureFvPatchScalarField::updateCoeffs(), rotatingWallVelocityFvPatchVectorField::updateCoeffs(), angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), oscillatingDisplacementPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), waveDisplacementPointPatchVectorField::updateCoeffs(), MarshakRadiationFvPatchScalarField::updateCoeffs(), MarshakRadiationFixedTemperatureFvPatchScalarField::updateCoeffs(), externalTemperatureFvPatchScalarField::updateCoeffs(), UniformDimensionedField< Type >::value(), coefficient< Field< Type > >::value(), Sine< Type >::value(), fvMesh::Vsc(), fvMesh::Vsc0(), Foam::W(), wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField(), FacePostProcessing< CloudType >::write(), and ParticleCollector< CloudType >::write().

Here is the caller graph for this function:

◆ value() [2/2]

Type & value

Return non-const reference to value.

Definition at line 293 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 301 of file dimensionedType.C.

References Foam::name().

Referenced by Foam::ComplexField(), cyclicLduInterfaceField::transformCoupleField(), and processorLduInterfaceField::transformCoupleField().

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 316 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().

Referenced by phaseChange::Tchange(), and SVD::VSinvUt().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ read()

void read ( const dictionary &  dict)

Update the value of dimensioned<Type>

Definition at line 328 of file dimensionedType.C.

References dict, and dictionary::lookup().

Referenced by interfaceTurbulenceDamping::interfaceTurbulenceDamping(), and VoFTurbulenceDamping::VoFTurbulenceDamping().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readIfPresent()

bool readIfPresent ( const dictionary &  dict)

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

Definition at line 335 of file dimensionedType.C.

References dict, Foam::endl(), IOInfoInFunction, dictionary::lookupEntryPtr(), entry::stream(), and dictionary::writeOptionalEntries.

Referenced by makeMomentumTransportModelTypes(), PDRkEpsilon::read(), SpalartAllmarasDES< BasicMomentumTransportModel >::read(), and SpalartAllmaras< BasicMomentumTransportModel >::read().

Here is the call graph for this function:
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 363 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 370 of file dimensionedType.C.

◆ operator-=()

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

Definition at line 378 of file dimensionedType.C.

◆ operator*=()

void operator*= ( const scalar  s)

Definition at line 386 of file dimensionedType.C.

References s().

Here is the call graph for this function:

◆ operator/=()

void operator/= ( const scalar  s)

Definition at line 393 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: