dimensioned< Type > Class Template Reference

Inheritance diagram for dimensioned< Type >:

Collaboration diagram for dimensioned< Type >:


Public Types
typedef pTraits< Type >::cmptType	cmptType
	Component type.
Public Member Functions
	dimensioned (const word &, const dimensionSet &, const Type)
	Construct given a name, a value and its dimensionSet.
	dimensioned (const word &, const dimensioned< Type > &)
	Construct from a dimensioned<Type> changing the name.
	dimensioned (const Type &t)
	Construct given a value (creates dimensionless value).
	dimensioned (Istream &)
	Construct from Istream.
	dimensioned (const word &, Istream &)
	Construct from an Istream with a given name.
	dimensioned (const word &, const dimensionSet &, Istream &)
	Construct from an Istream with a given name and dimensions.
const word &	name () const
	Return const reference to name.
word &	name ()
	Return non-const reference to name.
const dimensionSet &	dimensions () const
	Return const reference to dimensions.
dimensionSet &	dimensions ()
	Return non-const reference to dimensions.
const Type &	value () const
	Return const reference to value.
Type &	value ()
	Return non-const reference to value.
dimensioned< cmptType >	component (const direction) const
	Return a component as a dimensioned<cmptType>.
void	replace (const direction, const dimensioned< cmptType > &)
	Return a component with a dimensioned<cmptType>.
dimensioned< Type >	T () const
	Return transpose.
bool	readIfPresent (const dictionary &)
	Update the value of dimensioned<Type> if found in the dictionary.
dimensioned< cmptType >	operator[] (const direction) const
	Return a component as a dimensioned<cmptType>.
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 Type &defaultValue=pTraits< Type >::zero, const dimensionSet &dims=dimless)
	Construct from dictionary, with default value.
static dimensioned< Type >	lookupOrAddToDict (const word &, dictionary &, const Type &defaultValue=pTraits< Type >::zero, const dimensionSet &dims=dimless)
	Construct from dictionary, with default value.
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 60 of file dimensionedType.H.

Member Typedef Documentation

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 77 of file dimensionedType.H.

Constructor & Destructor Documentation

dimensioned	(	const word &	name,
		const dimensionSet &	dimSet,
		const Type	t
	)			`[inline]`

Construct given a name, a value and its dimensionSet.

Definition at line 61 of file dimensionedType.C.

dimensioned	(	const word &	name,
		const dimensioned< Type > &	dt
	)			`[inline]`

Construct from a dimensioned<Type> changing the name.

Definition at line 75 of file dimensionedType.C.

dimensioned ( const Type & t ) [inline]

Construct given a value (creates dimensionless value).

Definition at line 89 of file dimensionedType.H.

dimensioned ( Istream & is ) [inline]

Construct from Istream.

Definition at line 88 of file dimensionedType.C.

dimensioned	(	const word &	name,
		Istream &	is
	)			`[inline]`

Construct from an Istream with a given name.

Definition at line 100 of file dimensionedType.C.

dimensioned	(	const word &	name,
		const dimensionSet &	dimSet,
		Istream &	is
	)			`[inline]`

Construct from an Istream with a given name and dimensions.

Definition at line 113 of file dimensionedType.C.

Member Function Documentation

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

Construct from dictionary, with default value.

Definition at line 31 of file dimensionedType.C.

References Foam::name().

Here is the call graph for this function:

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