Dimension set for the base types, which can be used to implement rigorous dimension checking for algebraic manipulation. More...

Public Types
enum	dimensionType { MASS, LENGTH, TIME, TEMPERATURE, MOLES, CURRENT, LUMINOUS_INTENSITY }

typedef FixedList< scalar, 7 >	list_type

Public Member Functions
	ClassName ("dimensionSet")

	dimensionSet ()

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

	dimensionSet (const FixedList< scalar, 7 > &dimensions)

	dimensionSet (const dimensionSet &ds)

	dimensionSet (const word &entryName, const dictionary &dict, const bool mandatory=true)

	dimensionSet (const dictionary &dict, const word &entryName, const bool mandatory=true)

autoPtr< dimensionSet >	clone () const

	dimensionSet (Istream &is)

bool	dimensionless () const

const FixedList< scalar, 7 > &	values () const noexcept

FixedList< scalar, 7 > &	values () noexcept

void	clear ()

void	reset (const dimensionSet &ds)

bool	readEntry (const word &entryName, const dictionary &dict, const bool mandatory=true)

Istream &	read (Istream &is, scalar &multiplier, const dictionary &)

Istream &	read (Istream &is, scalar &multiplier, const HashTable< dimensionedScalar > &)

Istream &	read (Istream &is, scalar &multiplier)

Ostream &	write (Ostream &os, scalar &multiplier, const dimensionSets &) const

Ostream &	write (Ostream &os, scalar &multiplier) const

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 Member Functions
static bool	checking (const bool on) noexcept

static bool	checking () noexcept

Static Public Attributes
static constexpr int	nDimensions = 7

static const scalar	smallExponent = SMALL

Detailed Description

Dimension set for the base types, which can be used to implement rigorous dimension checking for algebraic manipulation.

The dimensions are specified in the following order (SI units for reference only):

Property	SI Description	SI unit
`MASS`	kilogram	`kg`
`LENGTH`	metre	`m`
`TIME`	second	`s`
`TEMPERATURE`	Kelvin	`K`
`MOLES`	mole	`mol`
`CURRENT`	Ampere	`A`
`LUMINOUS_INTENSITY`	Candela	`cd`

Source files

Definition at line 104 of file dimensionSet.H.

Member Typedef Documentation

◆ list_type

typedef FixedList<scalar,7> list_type

Definition at line 109 of file dimensionSet.H.

Member Enumeration Documentation

◆ dimensionType

enum dimensionType

Enumerator
MASS	kilogram `kg`
LENGTH	metre `m`
TIME	second `s`
TEMPERATURE	Kelvin `K`.
MOLES	mole `mol`
CURRENT	Ampere `A`.
LUMINOUS_INTENSITY	Candela `cd`.

Definition at line 118 of file dimensionSet.H.

Constructor & Destructor Documentation

◆ dimensionSet() [1/7]

dimensionSet ( )

Definition at line 64 of file dimensionSet.C.

◆ dimensionSet() [2/7]

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

Definition at line 71 of file dimensionSet.C.

◆ dimensionSet() [3/7]

dimensionSet ( const FixedList< scalar, 7 > & dimensions )

Definition at line 93 of file dimensionSet.C.

◆ dimensionSet() [4/7]

dimensionSet ( const dimensionSet & ds )

Definition at line 99 of file dimensionSet.C.

◆ dimensionSet() [5/7]

dimensionSet	(	const word &	entryName,
		const dictionary &	dict,
		const bool	mandatory = `true`
	)

Parameters

entryName Lookup key. LITERAL (not REGEX)

Definition at line 31 of file dimensionSetIO.C.

References dict.

◆ dimensionSet() [6/7]

dimensionSet	(	const dictionary &	dict,
		const word &	entryName,
		const bool	mandatory = `true`
	)

Parameters

entryName Lookup key. LITERAL (not REGEX)

Definition at line 44 of file dimensionSetIO.C.

References dict.

◆ dimensionSet() [7/7]

dimensionSet ( Istream & is )

explicit

Definition at line 56 of file dimensionSetIO.C.

Member Function Documentation

◆ ClassName()

ClassName ( "dimensionSet" )

◆ checking() [1/2]

static bool checking ( const bool on )

inlinestaticnoexcept

Definition at line 217 of file dimensionSet.H.

References Foam::expressions::patchExpr::debug.

◆ checking() [2/2]

static bool checking ( )

inlinestaticnoexcept

Definition at line 225 of file dimensionSet.H.

References Foam::expressions::patchExpr::debug.

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

Here is the caller graph for this function:

◆ clone()

autoPtr<dimensionSet> clone ( ) const

inline

Definition at line 272 of file dimensionSet.H.

References autoPtr::New().

Here is the call graph for this function:

◆ dimensionless()

bool dimensionless ( ) const

Definition at line 107 of file dimensionSet.C.

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

Here is the caller graph for this function:

◆ values() [1/2]

Foam::FixedList< Foam::scalar, 7 > & values ( ) const

noexcept

Definition at line 123 of file dimensionSet.C.

Referenced by Foam::operator*(), Foam::operator/(), and dimensionSet::read().

Here is the caller graph for this function:

◆ values() [2/2]

FixedList<scalar,7>& values ( )

noexcept

◆ clear()

void clear ( )

Definition at line 136 of file dimensionSet.C.

References Foam::Zero.

◆ reset()

void reset ( const dimensionSet & ds )

Definition at line 142 of file dimensionSet.C.

Referenced by dimensionSet::read(), and KinematicCloud< Cloud< basicKinematicCollidingParcel > >::SU().

Here is the caller graph for this function:

◆ readEntry()

bool readEntry	(	const word &	entryName,
		const dictionary &	dict,
		const bool	mandatory = `true`
	)

Parameters

entryName	Lookup key. LITERAL (not REGEX)
dict	The dictionary
mandatory	The entry is mandatory

Definition at line 422 of file dimensionSetIO.C.

References dict, Foam::constant::electromagnetic::e, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::findEntry(), keyType::LITERAL, Foam::nl, and dictionary::relativeName().

Here is the call graph for this function:

◆ read() [1/3]

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

Definition at line 541 of file dimensionSetIO.C.

References token::BEGIN_SQR, IOstream::check(), dimensionSet::CURRENT, token::END_SQR, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FUNCTION_NAME, IOstream::info(), token::isNumber(), token::isWord(), keyType::LITERAL, dictionary::lookup(), dimensionSet::LUMINOUS_INTENSITY, dimensionSet::MASS, dimensionSet::nDimensions, Foam::nl, token::number(), Foam::pow(), dimensionSet::reset(), s, and token::wordToken().

Referenced by Foam::operator>>().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read() [2/3]

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

Definition at line 454 of file dimensionSetIO.C.

References token::BEGIN_SQR, IOstream::check(), dimensionSet::CURRENT, dimensioned::dimensions(), token::END_SQR, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FUNCTION_NAME, IOstream::info(), token::isNumber(), dimensionSet::LUMINOUS_INTENSITY, dimensionSet::MASS, Foam::nl, token::number(), Istream::putBack(), dimensioned::value(), and dimensionSet::values().

Here is the call graph for this function:

◆ read() [3/3]

Foam::Istream & read	(	Istream &	is,
		scalar &	multiplier
	)

Definition at line 531 of file dimensionSetIO.C.

References Foam::read(), and Foam::unitSet().

Here is the call graph for this function:

◆ write() [1/2]

Foam::Ostream & write	(	Ostream &	os,
		scalar &	multiplier,
		const dimensionSets &	writeUnits
	)		const

Definition at line 665 of file dimensionSetIO.C.

References IOstreamOption::ASCII, token::BEGIN_SQR, IOstream::check(), dimensionSets::coefficients(), token::END_SQR, forAll, IOstreamOption::format(), FUNCTION_NAME, Foam::mag(), dimensioned::name(), dimensionSet::nDimensions, os(), Foam::pow(), OSstream::precision(), token::SPACE, dimensionSets::units(), dimensionSets::valid(), and dimensioned::value().

Referenced by Foam::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [2/2]

Foam::Ostream & write	(	Ostream &	os,
		scalar &	multiplier
	)		const

Definition at line 737 of file dimensionSetIO.C.

References os(), Foam::vtk::write(), and Foam::writeUnitSet().

Here is the call graph for this function:

◆ operator[]() [1/4]

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

Definition at line 150 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 156 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 162 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 168 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 174 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 192 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 198 of file dimensionSet.C.

References Foam::checkDims(), and dimensionSet::checking().

Here is the call graph for this function:

◆ operator+=()

bool operator+= ( const dimensionSet & ds ) const

Definition at line 209 of file dimensionSet.C.

References Foam::checkDims(), and dimensionSet::checking().

Here is the call graph for this function:

◆ operator-=()

bool operator-= ( const dimensionSet & ds ) const

Definition at line 220 of file dimensionSet.C.

References Foam::checkDims(), and dimensionSet::checking().

Here is the call graph for this function:

◆ operator*=()

bool operator*= ( const dimensionSet & ds )

Definition at line 231 of file dimensionSet.C.

References reset().

Here is the call graph for this function:

◆ operator/=()

bool operator/= ( const dimensionSet & ds )

Definition at line 239 of file dimensionSet.C.

References reset().

Here is the call graph for this function:

Member Data Documentation

◆ nDimensions

constexpr int nDimensions = 7

staticconstexpr

Definition at line 115 of file dimensionSet.H.

Referenced by dimensionSet::read(), and dimensionSet::write().

◆ smallExponent

const Foam::scalar smallExponent = SMALL

static

Definition at line 133 of file dimensionSet.H.

Referenced by Foam::operator>>().

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 Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ list_type

Member Enumeration Documentation

◆ dimensionType

Constructor & Destructor Documentation

◆ dimensionSet() [1/7]

◆ dimensionSet() [2/7]

◆ dimensionSet() [3/7]

◆ dimensionSet() [4/7]

◆ dimensionSet() [5/7]

◆ dimensionSet() [6/7]

◆ dimensionSet() [7/7]

Member Function Documentation

◆ ClassName()

◆ checking() [1/2]

◆ checking() [2/2]

◆ clone()

◆ dimensionless()

◆ values() [1/2]

◆ values() [2/2]

◆ clear()

◆ reset()

◆ readEntry()

◆ read() [1/3]

◆ read() [2/3]

◆ read() [3/3]

◆ write() [1/2]

◆ write() [2/2]

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ operator==()

◆ operator!=()

◆ operator=()

◆ operator+=()

◆ operator-=()

◆ operator*=()

◆ operator/=()

Member Data Documentation

◆ nDimensions

◆ smallExponent