Unit conversion structure. Contains the associated dimensions and the multiplier with which to convert values. More...

Inheritance diagram for unitConversion:

Collaboration diagram for unitConversion:

Public Types
enum	{ nDimlessUnits = 2 }
	Define an enumeration for the number of dimensionless units. More...

enum	dimlessUnitType { FRACTION , ANGLE }
	Define an enumeration for the names of the dimensionless unit. More...

Public Member Functions
	ClassName ("unitConversion")
	Run time type information. More...

	unitConversion (const dimensionSet &, const scalar fraction, const scalar angle, const scalar multiplier)
	Construct from components. More...

	unitConversion (const dimensionSet &)
	Construct from a dimension set. No dimensionless units. Unity. More...

	unitConversion (const unitConversion &)=default
	Copy constructor. More...

	unitConversion (unitConversion &&)=default
	Move constructor. More...

	unitConversion (Istream &is)
	Construct from stream. More...

const dimensionSet &	dimensions () const
	Access the dimensions. More...

template<class T >
T	toStandard (const T &) const
	Convert a value to standard units. More...

template<class T >
Pair< T >	toStandard (const Pair< T > &) const
	Convert a pair of values to standard units. More...

template<class T >
List< T >	toStandard (const List< T > &) const
	Convert a list of values to standard units. More...

template<class T >
tmp< Field< T > >	toStandard (const Field< T > &) const
	Convert a field of values to standard units. More...

template<class T >
tmp< Field< T > >	toStandard (const tmp< Field< T >> &) const
	Convert a tmp field of values to standard units. More...

template<class T >
void	makeStandard (T &) const
	Convert a value to standard units. More...

template<class T >
void	makeStandard (Pair< T > &) const
	Convert a pair of values to standard units. More...

template<class T >
void	makeStandard (List< T > &) const
	Convert a list of values to standard units. More...

template<class T >
T	toUser (const T &) const
	Convert a value to user units. More...

template<class T >
Pair< T >	toUser (const Pair< T > &) const
	Convert a pair of values to user units. More...

template<class T >
List< T >	toUser (const List< T > &) const
	Convert a list of values to user units. More...

template<class T >
tmp< Field< T > >	toUser (const Field< T > &) const
	Convert a field of values to user units. More...

template<class T >
tmp< Field< T > >	toUser (const tmp< Field< T >> &) const
	Convert a tmp field of values to user units. More...

bool	any () const
	Return whether this is the "any" unit. I.e., the case where. More...

bool	none () const
	Return whether this is the "none" unit. I.e., the case where unit. More...

bool	standard () const
	Return whether this unit is standard. I.e., is its multiplier one? More...

void	reset (const unitConversion &)
	Reset the unit conversion. More...

void	read (const word &keyword, const dictionary &)
	Update. More...

void	read (Istream &is)
	Update. More...

void	read (const word &keyword, const dictionary &, Istream &is)
	Update. More...

bool	readIfPresent (const word &keyword, const dictionary &)
	Update if found in the dictionary. More...

bool	readIfPresent (Istream &is)
	Update if found on the stream. More...

bool	readIfPresent (const word &keyword, const dictionary &, Istream &is)
	Update if found on the dictionary stream. More...

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

void	operator= (const unitConversion &)=delete
	Disallow default bitwise assignment. More...

void	operator= (const unitConversion &&)=delete
	Disallow default bitwise move assignment. More...

template<class T >
Foam::Pair< T >	toStandard (const Pair< T > &p) const

template<class T >
Foam::List< T >	toStandard (const List< T > &l) const

template<class T >
Foam::tmp< Foam::Field< T > >	toStandard (const Field< T > &f) const

template<class T >
Foam::tmp< Foam::Field< T > >	toStandard (const tmp< Field< T >> &tf) const

template<class T >
Foam::Pair< T >	toUser (const Pair< T > &p) const

template<class T >
Foam::List< T >	toUser (const List< T > &l) const

template<class T >
Foam::tmp< Foam::Field< T > >	toUser (const Field< T > &f) const

template<class T >
Foam::tmp< Foam::Field< T > >	toUser (const tmp< Field< T >> &tf) const

Static Public Attributes
static const NamedEnum< dimlessUnitType, 2 >	dimlessUnitTypeNames_
	Names of the dimensionless units. More...

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

Friends
unitConversion	pow (const unitConversion &, const scalar)
	Raise to a power. More...

const unitConversion &	operator+ (const unitConversion &, const unitConversion &)
	Combine. More...

unitConversion	operator* (const unitConversion &, const unitConversion &)
	Multiply. More...

unitConversion	operator/ (const unitConversion &, const unitConversion &)
	Divide. More...

Istream &	operator>> (Istream &, unitConversion &)
	Read from stream. More...

Ostream &	operator<< (Ostream &, const unitConversion &)
	Write to stream. More...

Ostream &	operator<< (Ostream &, const InfoProxy< unitConversion > &)
	Write info to stream. More...

Detailed Description

Unit conversion structure. Contains the associated dimensions and the multiplier with which to convert values.

Source files

Definition at line 67 of file unitConversion.H.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Define an enumeration for the number of dimensionless units.

Enumerator
nDimlessUnits

Definition at line 74 of file unitConversion.H.

◆ dimlessUnitType

enum dimlessUnitType

Define an enumeration for the names of the dimensionless unit.

exponents

Enumerator
FRACTION
ANGLE

Definition at line 81 of file unitConversion.H.

Constructor & Destructor Documentation

◆ unitConversion() [1/5]

unitConversion	(	const dimensionSet &	dimensions,
		const scalar	fraction,
		const scalar	angle,
		const scalar	multiplier
	)

Construct from components.

Definition at line 87 of file unitConversion.C.

References unitConversion::ANGLE, and unitConversion::FRACTION.

◆ unitConversion() [2/5]

unitConversion ( const dimensionSet & dimensions )

Construct from a dimension set. No dimensionless units. Unity.

multiplier.

Definition at line 103 of file unitConversion.C.

References unitConversion::ANGLE, and unitConversion::FRACTION.

◆ unitConversion() [3/5]

unitConversion ( const unitConversion & )

default

Copy constructor.

◆ unitConversion() [4/5]

unitConversion ( unitConversion && )

default

Move constructor.

◆ unitConversion() [5/5]

unitConversion ( Istream & is )

Construct from stream.

Definition at line 32 of file unitConversionIO.C.

Member Function Documentation

◆ ClassName()

ClassName ( "unitConversion" )

Run time type information.

◆ dimensions()

const Foam::dimensionSet & dimensions ( ) const

inline

Access the dimensions.

Definition at line 31 of file unitConversionI.H.

◆ toStandard() [1/9]

T toStandard ( const T & t ) const

Convert a value to standard units.

Definition at line 31 of file unitConversionTemplates.C.

References unitConversion::standard().

Referenced by Foam::degToRad().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toStandard() [2/9]

Pair<T> toStandard ( const Pair< T > & ) const

Convert a pair of values to standard units.

◆ toStandard() [3/9]

List<T> toStandard ( const List< T > & ) const

Convert a list of values to standard units.

◆ toStandard() [4/9]

tmp<Field<T> > toStandard ( const Field< T > & ) const

Convert a field of values to standard units.

◆ toStandard() [5/9]

tmp<Field<T> > toStandard ( const tmp< Field< T >> & ) const

Convert a tmp field of values to standard units.

◆ makeStandard() [1/3]

void makeStandard ( T & t ) const

Convert a value to standard units.

Definition at line 73 of file unitConversionTemplates.C.

◆ makeStandard() [2/3]

void makeStandard ( Pair< T > & p ) const

Convert a pair of values to standard units.

Definition at line 83 of file unitConversionTemplates.C.

References p.

◆ makeStandard() [3/3]

void makeStandard ( List< T > & l ) const

Convert a list of values to standard units.

Definition at line 94 of file unitConversionTemplates.C.

References forAll.

◆ toUser() [1/9]

T toUser ( const T & t ) const

Convert a value to user units.

Definition at line 107 of file unitConversionTemplates.C.

Referenced by greyMean::aCont(), wideBand::aCont(), Foam::radToDeg(), cyclicTransform::str(), and Foam::writeEntry().

Here is the caller graph for this function:

◆ toUser() [2/9]

Pair<T> toUser ( const Pair< T > & ) const

Convert a pair of values to user units.

◆ toUser() [3/9]

List<T> toUser ( const List< T > & ) const

Convert a list of values to user units.

◆ toUser() [4/9]

tmp<Field<T> > toUser ( const Field< T > & ) const

Convert a field of values to user units.

◆ toUser() [5/9]

tmp<Field<T> > toUser ( const tmp< Field< T >> & ) const

Convert a tmp field of values to user units.

◆ any()

bool any ( ) const

inline

Return whether this is the "any" unit. I.e., the case where.

dimensions and dimensionless units are not checked, and any conversion is permitted.

Definition at line 37 of file unitConversionI.H.

◆ none()

bool none ( ) const

inline

Return whether this is the "none" unit. I.e., the case where unit.

conversions are prohibited.

Definition at line 43 of file unitConversionI.H.

◆ standard()

bool standard ( ) const

inline

Return whether this unit is standard. I.e., is its multiplier one?

Definition at line 49 of file unitConversionI.H.

References Foam::any().

Referenced by unitConversion::toStandard().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

void reset ( const unitConversion & units )

Reset the unit conversion.

Definition at line 115 of file unitConversion.C.

References unitConversion::nDimlessUnits, and Foam::units().

Referenced by Foam::operator>>(), and unitConversions::unitConversions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read() [1/3]

void read	(	const word &	keyword,
		const dictionary &	dict
	)

Update.

Definition at line 43 of file unitConversionIO.C.

References Foam::abort(), dict, Foam::FatalIOError, FatalIOErrorInFunction, dictionary::lookup(), dictionaryName::name(), and Foam::units().

Referenced by namedUnitConversion::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read() [2/3]

void read ( Istream & is )

Update.

Definition at line 60 of file unitConversionIO.C.

References Foam::abort(), Foam::FatalIOError, FatalIOErrorInFunction, and Foam::units().

Here is the call graph for this function:

◆ read() [3/3]

void read	(	const word &	keyword,
		const dictionary &	dict,
		Istream &	is
	)

Update.

Definition at line 76 of file unitConversionIO.C.

References Foam::abort(), dict, Foam::FatalIOError, FatalIOErrorInFunction, dictionaryName::name(), and Foam::units().

Here is the call graph for this function:

◆ readIfPresent() [1/3]

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

Update if found in the dictionary.

Definition at line 98 of file unitConversionIO.C.

References Foam::abort(), dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInFunction, IOInfoInFunction, dictionary::lookupEntryPtr(), dictionaryName::name(), entry::stream(), Foam::units(), and dictionary::writeOptionalEntries.

Referenced by namedUnitConversion::readIfPresent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readIfPresent() [2/3]

bool readIfPresent ( Istream & is )

Update if found on the stream.

Definition at line 138 of file unitConversionIO.C.

References Foam::abort(), Foam::any(), token::BEGIN_SQR, Foam::endl(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, IOstream::lineNumber(), IOstream::name(), Istream::putBack(), and Foam::units().

Here is the call graph for this function:

◆ readIfPresent() [3/3]

bool readIfPresent	(	const word &	keyword,
		const dictionary &	dict,
		Istream &	is
	)

Update if found on the dictionary stream.

Definition at line 168 of file unitConversionIO.C.

References Foam::abort(), Foam::any(), token::BEGIN_SQR, dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, dictionaryName::name(), Istream::putBack(), and Foam::units().

Here is the call graph for this function:

◆ info()

InfoProxy<unitConversion> info ( ) const

inline

Return info proxy.

Definition at line 249 of file unitConversion.H.

◆ operator=() [1/2]

void operator= ( const unitConversion & )

delete

Disallow default bitwise assignment.

◆ operator=() [2/2]

void operator= ( const unitConversion && )

delete

Disallow default bitwise move assignment.

◆ toStandard() [6/9]

Foam::Pair<T> toStandard ( const Pair< T > & p ) const

Definition at line 38 of file unitConversionTemplates.C.

References p.

◆ toStandard() [7/9]

Foam::List<T> toStandard ( const List< T > & l ) const

Definition at line 45 of file unitConversionTemplates.C.

References forAll, and List< T >::size().

Here is the call graph for this function:

◆ toStandard() [8/9]

Foam::tmp<Foam::Field<T> > toStandard ( const Field< T > & f ) const

Definition at line 58 of file unitConversionTemplates.C.

References f().

Here is the call graph for this function:

◆ toStandard() [9/9]

Foam::tmp<Foam::Field<T> > toStandard ( const tmp< Field< T >> & tf ) const

Definition at line 66 of file unitConversionTemplates.C.

References tf.

◆ toUser() [6/9]

Foam::Pair<T> toUser ( const Pair< T > & p ) const

Definition at line 114 of file unitConversionTemplates.C.

References p.

◆ toUser() [7/9]

Foam::List<T> toUser ( const List< T > & l ) const

Definition at line 121 of file unitConversionTemplates.C.

References forAll, and List< T >::size().

Here is the call graph for this function:

◆ toUser() [8/9]

Foam::tmp<Foam::Field<T> > toUser ( const Field< T > & f ) const

Definition at line 134 of file unitConversionTemplates.C.

References f().

Here is the call graph for this function:

◆ toUser() [9/9]

Foam::tmp<Foam::Field<T> > toUser ( const tmp< Field< T >> & tf ) const

Definition at line 142 of file unitConversionTemplates.C.

References tf.

Friends And Related Function Documentation

◆ pow

unitConversion pow	(	const unitConversion &	,
		const	scalar
	)

friend

Raise to a power.

◆ operator+

const unitConversion& operator+	(	const unitConversion &	,
		const unitConversion &
	)

friend

Combine.

◆ operator*

unitConversion operator*	(	const unitConversion &	,
		const unitConversion &
	)

friend

Multiply.

◆ operator/

unitConversion operator/	(	const unitConversion &	,
		const unitConversion &
	)

friend

Divide.

◆ operator>>

Istream& operator>>	(	Istream &	,
		unitConversion &
	)

friend

Read from stream.

◆ operator<< [1/2]

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

friend

Write to stream.

◆ operator<< [2/2]

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

friend

Write info to stream.

Member Data Documentation

◆ dimlessUnitTypeNames_

const Foam::NamedEnum< Foam::unitConversion::dimlessUnitType, 2 > dimlessUnitTypeNames_

static

Initial value:

{
    "fraction",
    "angle"
}

Names of the dimensionless units.

Definition at line 88 of file unitConversion.H.

Referenced by Foam::operator<<().

◆ smallExponent

const scalar smallExponent = rootSmall

static

A small exponent with which to perform inexact comparisons.

Definition at line 94 of file unitConversion.H.

Referenced by Foam::operator<<().

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

src/OpenFOAM/unitConversion/unitConversion.H
src/OpenFOAM/unitConversion/unitConversion.C
src/OpenFOAM/unitConversion/unitConversionI.H
src/OpenFOAM/unitConversion/unitConversionIO.C
src/OpenFOAM/unitConversion/unitConversionTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ dimlessUnitType

Constructor & Destructor Documentation

◆ unitConversion() [1/5]

◆ unitConversion() [2/5]

◆ unitConversion() [3/5]

◆ unitConversion() [4/5]

◆ unitConversion() [5/5]

Member Function Documentation

◆ ClassName()

◆ dimensions()

◆ toStandard() [1/9]

◆ toStandard() [2/9]

◆ toStandard() [3/9]

◆ toStandard() [4/9]

◆ toStandard() [5/9]

◆ makeStandard() [1/3]

◆ makeStandard() [2/3]

◆ makeStandard() [3/3]

◆ toUser() [1/9]

◆ toUser() [2/9]

◆ toUser() [3/9]

◆ toUser() [4/9]

◆ toUser() [5/9]

◆ any()

◆ none()

◆ standard()

◆ reset()

◆ read() [1/3]

◆ read() [2/3]

◆ read() [3/3]

◆ readIfPresent() [1/3]

◆ readIfPresent() [2/3]

◆ readIfPresent() [3/3]

◆ info()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ toStandard() [6/9]

◆ toStandard() [7/9]

◆ toStandard() [8/9]

◆ toStandard() [9/9]

◆ toUser() [6/9]

◆ toUser() [7/9]

◆ toUser() [8/9]

◆ toUser() [9/9]

Friends And Related Function Documentation

◆ pow

◆ operator+

◆ operator*

◆ operator/

◆ operator>>

◆ operator<< [1/2]

◆ operator<< [2/2]

Member Data Documentation

◆ dimlessUnitTypeNames_

◆ smallExponent