OpenFOAM logo
Open Source CFD Toolkit

dimensioned Class Template Reference

Inheritance diagram for dimensioned:

Inheritance graph
[legend]
Collaboration diagram for dimensioned:

Collaboration graph
[legend]
List of all members.

template<class Type>
class Foam::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.
const wordname () const
 Return const reference to name.
wordname ()
 Return non-const reference to name.
const dimensionSetdimensions () const
 Return const reference to dimensions.
dimensionSetdimensions ()
 Return non-const reference to dimensions.
const Type & value () const
 Return const reference to value.
Type & value ()
 Return non-const reference to value.
dimensioned< cmptTypecomponent (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.
dimensioned< cmptTypeoperator[] (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)

Friends

Istreamoperator>> (Istream &, dimensioned< Type > &)
Ostreamoperator (Ostream &, const dimensioned< Type > &)

Member Typedef Documentation

typedef pTraits<Type>::cmptType cmptType
 

Component type.

Definition at line 89 of file dimensionedType.H.


Constructor & Destructor Documentation

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  )  [inline]
 

Construct given a value (creates dimensionless value).

Definition at line 101 of file dimensionedType.H.

dimensioned Istream  ) 
 

Construct from Istream.


Member Function Documentation

dimensioned<cmptType> component const   direction  )  const
 

Return a component as a dimensioned<cmptType>.

dimensionSet& dimensions  ) 
 

Return non-const reference to dimensions.

const dimensionSet& dimensions  )  const
 

Return const reference to dimensions.

word& name  ) 
 

Return non-const reference to name.

const word& name  )  const
 

Return const reference to name.

void operator *= const   scalar  ) 
 

void operator+= const dimensioned< Type > &   ) 
 

void operator-= const dimensioned< Type > &   ) 
 

void operator/= const   scalar  ) 
 

dimensioned<cmptType> operator[] 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.

Type& value  ) 
 

Return non-const reference to value.

const Type& value  )  const
 

Return const reference to value.

Referenced by spray::evaporationSource().


Friends And Related Function Documentation

Ostream& operator Ostream ,
const dimensioned< Type > & 
[friend]
 

Istream& operator>> Istream ,
dimensioned< Type > & 
[friend]
 


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org