Dimension set for the base types. More...

Collaboration diagram for dimensionSet:

Public Types
enum	{ nDimensions = 7 }
	Define an enumeration for the number of dimensions. More...

enum	dimensionType { MASS , LENGTH , TIME , TEMPERATURE , MOLES , CURRENT , LUMINOUS_INTENSITY }
	Define an enumeration for the names of the dimension exponents. More...

Public Member Functions
	ClassName ("dimensionSet")

	dimensionSet (const scalar mass, const scalar length, const scalar time, const scalar temperature, const scalar moles, const scalar current, const scalar luminousIntensity)
	Construct given individual dimension exponents for all. More...

	dimensionSet (const scalar mass, const scalar length, const scalar time, const scalar temperature, const scalar moles)
	Construct given individual dimension exponents for first. More...

	dimensionSet (const dimensionSet &ds)
	Copy constructor. More...

autoPtr< dimensionSet >	clone () const
	Construct and return a clone. More...

	dimensionSet (Istream &)
	Construct from Istream. More...

bool	dimensionless () const
	Return true if it is dimensionless. More...

void	reset (const dimensionSet &)

Istream &	readNoBeginOrEnd (Istream &is)
	Read without the square brackets. More...

Istream &	read (Istream &is)
	Read. More...

Ostream &	writeNoBeginOrEnd (Ostream &os) const
	Write without the square brackets. More...

Ostream &	write (Ostream &os) const
	Write. More...

Ostream &	writeInfoNoBeginOrEnd (Ostream &os) const
	Write info without the square brackets. More...

InfoProxy< dimensionSet >	info () const
	Return info proxy. More...

scalar	operator[] (const dimensionType) const

scalar &	operator[] (const dimensionType)

scalar	operator[] (const label) const

scalar &	operator[] (const label)

bool	operator== (const dimensionSet &) const

bool	operator!= (const dimensionSet &) const

bool	operator= (const dimensionSet &) const

bool	operator+= (const dimensionSet &) const

bool	operator-= (const dimensionSet &) const

bool	operator*= (const dimensionSet &)

bool	operator/= (const dimensionSet &)

Static Public Attributes
static const NamedEnum< dimensionType, 7 >	dimensionTypeNames_
	Names of the dimensions. More...

static const scalar	smallExponent = rootSmall
	A small exponent with which to perform inexact comparisons. More...

Friends
dimensionSet	max (const dimensionSet &, const dimensionSet &)

dimensionSet	min (const dimensionSet &, const dimensionSet &)

dimensionSet	cmptMultiply (const dimensionSet &, const dimensionSet &)

dimensionSet	cmptDivide (const dimensionSet &, const dimensionSet &)

dimensionSet	cmptMag (const dimensionSet &)

dimensionSet	pow (const dimensionSet &, const scalar)

dimensionSet	pow (const dimensionSet &, const dimensionedScalar &)

dimensionSet	pow (const dimensionedScalar &, const dimensionSet &)

dimensionSet	sqr (const dimensionSet &)

dimensionSet	pow3 (const dimensionSet &)

dimensionSet	pow4 (const dimensionSet &)

dimensionSet	pow5 (const dimensionSet &)

dimensionSet	pow6 (const dimensionSet &)

dimensionSet	pow025 (const dimensionSet &)

dimensionSet	sqrt (const dimensionSet &)

dimensionSet	magSqr (const dimensionSet &)

dimensionSet	mag (const dimensionSet &)

dimensionSet	sign (const dimensionSet &)

dimensionSet	pos0 (const dimensionSet &)

dimensionSet	neg (const dimensionSet &)

dimensionSet	inv (const dimensionSet &)

dimensionSet	trans (const dimensionSet &)
	Function to check the argument is dimensionless. More...

dimensionSet	atan2 (const dimensionSet &, const dimensionSet &)

dimensionSet	transform (const dimensionSet &)

dimensionSet	normalised (const dimensionSet &)

dimensionSet	perpendicular (const dimensionSet &)

dimensionSet	operator- (const dimensionSet &)

dimensionSet	operator+ (const dimensionSet &, const dimensionSet &)

dimensionSet	operator- (const dimensionSet &, const dimensionSet &)

dimensionSet	operator* (const dimensionSet &, const dimensionSet &)

dimensionSet	operator/ (const dimensionSet &, const dimensionSet &)

dimensionSet	operator& (const dimensionSet &, const dimensionSet &)

dimensionSet	operator^ (const dimensionSet &, const dimensionSet &)

dimensionSet	operator&& (const dimensionSet &, const dimensionSet &)

Istream &	operator>> (Istream &, dimensionSet &)

Ostream &	operator<< (Ostream &, const dimensionSet &)

Ostream &	operator<< (Ostream &, const InfoProxy< dimensionSet > &)

Detailed Description

Dimension set for the base types.

This type may be used to implement rigorous dimension checking for algebraic manipulation.

Source files

Definition at line 124 of file dimensionSet.H.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Define an enumeration for the number of dimensions.

Enumerator
nDimensions

Definition at line 132 of file dimensionSet.H.

◆ dimensionType

enum dimensionType

Define an enumeration for the names of the dimension exponents.

Enumerator
MASS
LENGTH
TIME
TEMPERATURE
MOLES
CURRENT
LUMINOUS_INTENSITY

Definition at line 138 of file dimensionSet.H.

Constructor & Destructor Documentation

◆ dimensionSet() [1/4]

dimensionSet	(	const scalar	mass,
		const scalar	length,
		const scalar	time,
		const scalar	temperature,
		const scalar	moles,
		const scalar	current,
		const scalar	luminousIntensity
	)

Construct given individual dimension exponents for all.

seven dimensions

Definition at line 59 of file dimensionSet.C.

References dimensionSet::CURRENT, dimensionSet::LENGTH, dimensionSet::LUMINOUS_INTENSITY, dimensionSet::MASS, dimensionSet::MOLES, dimensionSet::TEMPERATURE, and dimensionSet::TIME.

Referenced by dimensionSet::clone().

Here is the caller graph for this function:

◆ dimensionSet() [2/4]

dimensionSet	(	const scalar	mass,
		const scalar	length,
		const scalar	time,
		const scalar	temperature,
		const scalar	moles
	)

Construct given individual dimension exponents for first.

five dimensions

Definition at line 80 of file dimensionSet.C.

◆ dimensionSet() [3/4]

dimensionSet ( const dimensionSet & ds )

Copy constructor.

Definition at line 99 of file dimensionSet.C.

◆ dimensionSet() [4/4]

dimensionSet ( Istream & is )

Construct from Istream.

Definition at line 56 of file dimensionSetIO.C.

Member Function Documentation

◆ ClassName()

ClassName ( "dimensionSet" )

◆ clone()

autoPtr<dimensionSet> clone ( ) const

inline

Construct and return a clone.

Definition at line 210 of file dimensionSet.H.

References dimensionSet::dimensionSet().

Here is the call graph for this function:

◆ dimensionless()

bool dimensionless ( ) const

Return true if it is dimensionless.

Definition at line 107 of file dimensionSet.C.

Referenced by Foam::pow(), and Foam::trans().

Here is the caller graph for this function:

◆ reset()

void reset ( const dimensionSet & ds )

Definition at line 126 of file dimensionSet.C.

Referenced by LehrMilliesMewes::addToBinaryBreakupRate(), reuseTmpTmpDimensionedField< TypeR, Type1, TypeR, GeoMesh, PrimitiveField1, Field >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, Type2, GeoMesh, Field, PrimitiveField2 >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, GeoMesh, Field, Field >::New(), Foam::New(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh, Field >::New(), reuseTmpTmpGeometricField< TypeR, Type1, TypeR, GeoMesh, PrimitiveField1, Field >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, Type2, GeoMesh, Field, PrimitiveField2 >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, GeoMesh, Field, Field >::New(), and reuseTmpGeometricField< TypeR, TypeR, GeoMesh, Field >::New().

Here is the caller graph for this function:

◆ readNoBeginOrEnd()

Foam::Istream & readNoBeginOrEnd ( Istream & is )

Read without the square brackets.

Definition at line 64 of file dimensionSetIO.C.

References dimensionSet::CURRENT, Foam::dimensions(), Foam::dimless, token::isNumber(), dimensionSet::LUMINOUS_INTENSITY, Foam::symbols::parseNoBeginOrEnd(), and Istream::putBack().

Here is the call graph for this function:

◆ read()

Foam::Istream & read ( Istream & is )

Read.

Definition at line 109 of file dimensionSetIO.C.

References token::BEGIN_SQR, IOstream::check(), token::END_SQR, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and IOstream::info().

Referenced by Foam::operator>>(), and UniformDimensionedField< Type >::UniformDimensionedField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeNoBeginOrEnd()

Foam::Ostream & writeNoBeginOrEnd ( Ostream & os ) const

Write without the square brackets.

Definition at line 140 of file dimensionSetIO.C.

References dimensionSet::nDimensions, and token::SPACE.

◆ write()

Foam::Ostream & write ( Ostream & os ) const

Write.

Definition at line 160 of file dimensionSetIO.C.

References token::BEGIN_SQR, IOstream::check(), and token::END_SQR.

Referenced by Foam::operator<<(), Foam::writeEntry(), and streamlinesParticle::writeFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeInfoNoBeginOrEnd()

Foam::Ostream & writeInfoNoBeginOrEnd ( Ostream & os ) const

Write info without the square brackets.

Definition at line 175 of file dimensionSetIO.C.

References dimensionSet::dimensionTypeNames_, Foam::first(), Foam::mag(), dimensionSet::nDimensions, dimensionSet::smallExponent, and token::SPACE.

Here is the call graph for this function:

◆ info()

InfoProxy<dimensionSet> info ( ) const

inline

Return info proxy.

Definition at line 245 of file dimensionSet.H.

Referenced by Foam::atan2(), Foam::max(), Foam::min(), dimensionSet::operator+=(), dimensionSet::operator-=(), and dimensionSet::operator=().

Here is the caller graph for this function:

◆ operator[]() [1/4]

Foam::scalar operator[] ( const dimensionType type ) const

Definition at line 137 of file dimensionSet.C.

References Foam::type().

Here is the call graph for this function:

◆ operator[]() [2/4]

Foam::scalar & operator[] ( const dimensionType type )

Definition at line 143 of file dimensionSet.C.

References Foam::type().

Here is the call graph for this function:

◆ operator[]() [3/4]

Foam::scalar operator[] ( const label type ) const

Definition at line 149 of file dimensionSet.C.

References Foam::type().

Here is the call graph for this function:

◆ operator[]() [4/4]

Foam::scalar & operator[] ( const label type )

Definition at line 155 of file dimensionSet.C.

References Foam::type().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const dimensionSet & ds ) const

Definition at line 161 of file dimensionSet.C.

References Foam::mag().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const dimensionSet & ds ) const

Definition at line 179 of file dimensionSet.C.

References Foam::operator==().

Here is the call graph for this function:

◆ operator=()

bool operator= ( const dimensionSet & ds ) const

Definition at line 185 of file dimensionSet.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, and dimensionSet::info().

Here is the call graph for this function:

◆ operator+=()

bool operator+= ( const dimensionSet & ds ) const

Definition at line 199 of file dimensionSet.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, and dimensionSet::info().

Here is the call graph for this function:

◆ operator-=()

bool operator-= ( const dimensionSet & ds ) const

Definition at line 213 of file dimensionSet.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, and dimensionSet::info().

Here is the call graph for this function:

◆ operator*=()

bool operator*= ( const dimensionSet & ds )

Definition at line 227 of file dimensionSet.C.

◆ operator/=()

bool operator/= ( const dimensionSet & ds )

Definition at line 235 of file dimensionSet.C.

Friends And Related Function Documentation

◆ max

dimensionSet max	(	const dimensionSet &	,
		const dimensionSet &
	)

friend

◆ min

dimensionSet min	(	const dimensionSet &	,
		const dimensionSet &
	)

friend

◆ cmptMultiply

dimensionSet cmptMultiply	(	const dimensionSet &	,
		const dimensionSet &
	)

friend

◆ cmptDivide

dimensionSet cmptDivide	(	const dimensionSet &	,
		const dimensionSet &
	)

friend

◆ cmptMag

dimensionSet cmptMag ( const dimensionSet & )

friend

◆ pow [1/3]

dimensionSet pow	(	const dimensionSet &	,
		const	scalar
	)

friend

◆ pow [2/3]

dimensionSet pow	(	const dimensionSet &	,
		const dimensionedScalar &
	)

friend

◆ pow [3/3]

dimensionSet pow	(	const dimensionedScalar &	,
		const dimensionSet &
	)

friend

◆ sqr

dimensionSet sqr ( const dimensionSet & )

friend

◆ pow3

dimensionSet pow3 ( const dimensionSet & )

friend

◆ pow4

dimensionSet pow4 ( const dimensionSet & )

friend

◆ pow5

dimensionSet pow5 ( const dimensionSet & )

friend

◆ pow6

dimensionSet pow6 ( const dimensionSet & )

friend

◆ pow025

dimensionSet pow025 ( const dimensionSet & )

friend

◆ sqrt

dimensionSet sqrt ( const dimensionSet & )

friend

◆ magSqr

dimensionSet magSqr ( const dimensionSet & )

friend

◆ mag

dimensionSet mag ( const dimensionSet & )

friend

◆ sign

dimensionSet sign ( const dimensionSet & )

friend

◆ pos0

dimensionSet pos0 ( const dimensionSet & )

friend

◆ neg

dimensionSet neg ( const dimensionSet & )

friend

◆ inv

dimensionSet inv ( const dimensionSet & )

friend

◆ trans

dimensionSet trans ( const dimensionSet & )

friend

Function to check the argument is dimensionless.

for transcendental functions

◆ atan2

dimensionSet atan2	(	const dimensionSet &	,
		const dimensionSet &
	)

friend

◆ transform

dimensionSet transform ( const dimensionSet & )

friend

Referenced by cyclicFvPatch::delta(), processorFvPatch::delta(), cyclicFvPatchField< Type >::patchNeighbourField(), jumpCyclicFvPatchField< Type >::patchNeighbourField(), pointData::transform(), DSMCParcel< ParcelType >::transformProperties(), molecule::transformProperties(), CollidingParcel< ParcelType >::transformProperties(), MomentumParcel< ParcelType >::transformProperties(), and solidParticle::transformProperties().

◆ normalised

dimensionSet normalised ( const dimensionSet & )

friend

◆ perpendicular

dimensionSet perpendicular ( const dimensionSet & )

friend

◆ operator- [1/2]

dimensionSet operator- ( const dimensionSet & )

friend

◆ operator+

dimensionSet operator+	(	const dimensionSet &	,
		const dimensionSet &
	)

friend

◆ operator- [2/2]

dimensionSet operator-	(	const dimensionSet &	,
		const dimensionSet &
	)

friend

◆ operator*

dimensionSet operator*	(	const dimensionSet &	,
		const dimensionSet &
	)

friend

◆ operator/

dimensionSet operator/	(	const dimensionSet &	,
		const dimensionSet &
	)

friend

◆ operator&

dimensionSet operator&	(	const dimensionSet &	,
		const dimensionSet &
	)

friend

◆ operator^

dimensionSet operator^	(	const dimensionSet &	,
		const dimensionSet &
	)

friend

◆ operator&&

dimensionSet operator&&	(	const dimensionSet &	,
		const dimensionSet &
	)

friend

◆ operator>>

Istream& operator>>	(	Istream &	,
		dimensionSet &
	)

friend

◆ operator<< [1/2]

Ostream& operator<<	(	Ostream &	,
		const dimensionSet &
	)

friend

◆ operator<< [2/2]

Ostream& operator<<	(	Ostream &	,
		const InfoProxy< dimensionSet > &
	)

friend

Member Data Documentation

◆ dimensionTypeNames_

const Foam::NamedEnum< Foam::dimensionSet::dimensionType, 7 > dimensionTypeNames_

static

Initial value:

{
    "mass",
    "length",
    "time",
    "temperature",
    "moles",
    "current",
    "luminousIntensity"
}

Names of the dimensions.

Definition at line 150 of file dimensionSet.H.

Referenced by dimensionSet::writeInfoNoBeginOrEnd().

◆ smallExponent

const scalar smallExponent = rootSmall

static

A small exponent with which to perform inexact comparisons.

Definition at line 156 of file dimensionSet.H.

Referenced by dimensionSet::writeInfoNoBeginOrEnd().

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

src/OpenFOAM/dimensionSet/dimensionSet.H
src/OpenFOAM/dimensionSet/dimensionSet.C
src/OpenFOAM/dimensionSet/dimensionSetIO.C

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ dimensionType

Constructor & Destructor Documentation

◆ dimensionSet() [1/4]

◆ dimensionSet() [2/4]

◆ dimensionSet() [3/4]

◆ dimensionSet() [4/4]

Member Function Documentation

◆ ClassName()

◆ clone()

◆ dimensionless()

◆ reset()

◆ readNoBeginOrEnd()

◆ read()

◆ writeNoBeginOrEnd()

◆ write()

◆ writeInfoNoBeginOrEnd()

◆ info()

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ operator==()

◆ operator!=()

◆ operator=()

◆ operator+=()

◆ operator-=()

◆ operator*=()

◆ operator/=()

Friends And Related Function Documentation

◆ max

◆ min

◆ cmptMultiply

◆ cmptDivide

◆ cmptMag

◆ pow [1/3]

◆ pow [2/3]

◆ pow [3/3]

◆ sqr

◆ pow3

◆ pow4

◆ pow5

◆ pow6

◆ pow025

◆ sqrt

◆ magSqr

◆ mag

◆ sign

◆ pos0

◆ neg

◆ inv

◆ trans

◆ atan2

◆ transform

◆ normalised

◆ perpendicular

◆ operator- [1/2]

◆ operator+

◆ operator- [2/2]

◆ operator*

◆ operator/

◆ operator&

◆ operator^

◆ operator&&

◆ operator>>

◆ operator<< [1/2]

◆ operator<< [2/2]

Member Data Documentation

◆ dimensionTypeNames_

◆ smallExponent