registerDimensionedConstant Class Reference
Inheritance diagram for registerDimensionedConstant:
Collaboration diagram for registerDimensionedConstant:

Public Member Functions

 registerDimensionedConstant (const word &group, const char *name, const dimensionSet &dimensions)
 
virtual ~registerDimensionedConstant ()
 
virtual void readData (Istream &is)
 Read. More...
 
virtual void writeData (Ostream &os) const
 Write. More...
 
- Public Member Functions inherited from simpleRegIOobject
 simpleRegIOobject (void(*fn)(const char *name, simpleRegIOobject *), const char *name)
 Construct from objectregistry inserter and name. More...
 
virtual ~simpleRegIOobject ()
 Destructor. More...
 
- Public Member Functions inherited from dimensioned< Type >
 dimensioned (const word &, const dimensionSet &, const Type &)
 Construct given name, dimensions and value. More...
 
 dimensioned (const dimensionSet &, const Type &)
 Construct given dimensions and value. More...
 
 dimensioned (const Type &)
 Construct dimensionless given value only. More...
 
 dimensioned (const word &, const dimensioned< Type > &)
 Construct from a dimensioned<Type> changing the name. More...
 
 dimensioned (Istream &)
 Construct from Istream. More...
 
 dimensioned (const word &, Istream &)
 Construct from an Istream with a given name. More...
 
 dimensioned (const word &, const dimensionSet &, Istream &)
 Construct from an Istream with a given name and dimensions. More...
 
 dimensioned (const word &, const dimensionSet &, const dictionary &)
 Construct from dictionary lookup with a given name and dimensions. More...
 
 dimensioned ()
 Null constructor. More...
 
const wordname () const
 Return const reference to name. More...
 
wordname ()
 Return non-const reference to name. More...
 
const dimensionSetdimensions () const
 Return const reference to dimensions. More...
 
dimensionSetdimensions ()
 Return non-const reference to dimensions. More...
 
const Type & value () const
 Return const reference to value. More...
 
Type & value ()
 Return non-const reference to value. More...
 
dimensioned< cmptTypecomponent (const direction) const
 Return a component as a dimensioned<cmptType> More...
 
void replace (const direction, const dimensioned< cmptType > &)
 Return a component with a dimensioned<cmptType> More...
 
dimensioned< Type > T () const
 Return transpose. More...
 
void read (const dictionary &)
 Update the value of dimensioned<Type> More...
 
bool readIfPresent (const dictionary &)
 Update the value of dimensioned<Type> if found in the dictionary. More...
 
Istreamread (Istream &is, const dictionary &)
 Read value from stream and units from dictionary. More...
 
Istreamread (Istream &is, const HashTable< dimensionedScalar > &)
 Read value from stream and units from table. More...
 
Istreamread (Istream &is)
 Read value from stream and units from system table. More...
 
dimensioned< cmptTypeoperator[] (const direction) const
 Return a component as a dimensioned<cmptType> More...
 
void operator+= (const dimensioned< Type > &)
 
void operator-= (const dimensioned< Type > &)
 
void operator*= (const scalar)
 
void operator/= (const scalar)
 

Additional Inherited Members

- Public Types inherited from dimensioned< Type >
typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
- Static Public Member Functions inherited from dimensioned< Type >
static dimensioned< Type > lookupOrDefault (const word &, const dictionary &, const dimensionSet &dims=dimless, const Type &defaultValue=pTraits< Type >::zero)
 Construct from dictionary, with default dimensions and value. More...
 
static dimensioned< Type > lookupOrDefault (const word &, const dictionary &, const Type &defaultValue=pTraits< Type >::zero)
 Construct from dictionary dimensionless with value. More...
 
static dimensioned< Type > lookupOrAddToDict (const word &, dictionary &, const dimensionSet &dims=dimless, const Type &defaultValue=pTraits< Type >::zero)
 Construct from dictionary, with default value. More...
 
static dimensioned< Type > lookupOrAddToDict (const word &, dictionary &, const Type &defaultValue=pTraits< Type >::zero)
 Construct from dictionary, dimensionless with default value. More...
 

Detailed Description

Definition at line 52 of file dimensionedConstants.H.

Constructor & Destructor Documentation

◆ registerDimensionedConstant()

registerDimensionedConstant ( const word group,
const char *  name,
const dimensionSet dimensions 
)
inline

Definition at line 66 of file dimensionedConstants.H.

◆ ~registerDimensionedConstant()

virtual ~registerDimensionedConstant ( )
inlinevirtual

Definition at line 79 of file dimensionedConstants.H.

Member Function Documentation

◆ readData()

virtual void readData ( Istream )
inlinevirtual

Read.

Implements simpleRegIOobject.

Definition at line 82 of file dimensionedConstants.H.

◆ writeData()

virtual void writeData ( Ostream ) const
inlinevirtual

Write.

Implements simpleRegIOobject.

Definition at line 87 of file dimensionedConstants.H.


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