coefficient Struct Reference

Structure to store a dimensioned coefficient of the saturation model. More...

Inheritance diagram for coefficient:
Collaboration diagram for coefficient:

Public Member Functions

 operator scalar () const
 Cast to a scalar. More...
 
- Public Member Functions inherited from dimensioned< scalar >
 dimensioned ()
 Null constructor. More...
 
 dimensioned (const word &, const dimensionSet &, const scalar &)
 Construct given name, dimensions and value. More...
 
 dimensioned (const dimensionSet &, const scalar &)
 Construct given dimensions and value. More...
 
 dimensioned (const scalar &)
 Construct dimensionless given value only. More...
 
 dimensioned (const word &, const dimensioned< scalar > &)
 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 unitConversion &, Istream &)
 Construct from an Istream with a given name and units. More...
 
 dimensioned (const word &, const dimensionSet &, const dictionary &)
 Construct from dictionary lookup with a given name and dimensions. More...
 
 dimensioned (const word &, const unitConversion &, const dictionary &)
 Construct from dictionary lookup with a given name and units. More...
 
 dimensioned (const word &name, const dimensionSet &dimensions, const dictionary &dict, const scalar &defaultValue, const bool writeDefault=dictionary::writeOptionalEntries > 0)
 Construct from dictionary lookup with a given name and dimensions. More...
 
 dimensioned (const word &name, const dictionary &dict, const scalar &defaultValue, const bool writeDefault=dictionary::writeOptionalEntries > 0)
 Construct from dictionary lookup with the given name, dimensionless,. More...
 
 dimensioned (const word &name, const unitConversion &, const dictionary &, const scalar &defaultValue, const bool writeDefault=dictionary::writeOptionalEntries > 0)
 Construct from dictionary lookup with the given name and units. 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 scalar & value () const
 Return const reference to value. More...
 
scalar & 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< scalar > T () const
 Return transpose. More...
 
void read (const dictionary &, const unitConversion &defaultUnits=NullObjectRef< unitConversion >())
 Update the value of dimensioned<Type> More...
 
bool readIfPresent (const dictionary &, const unitConversion &defaultUnits=NullObjectRef< unitConversion >())
 Update the value of dimensioned<Type> if found in the dictionary. More...
 
dimensioned< cmptTypeoperator[] (const direction) const
 Return a component as a dimensioned<cmptType> More...
 
void operator+= (const dimensioned< scalar > &)
 
void operator-= (const dimensioned< scalar > &)
 
void operator*= (const scalar)
 
void operator/= (const scalar)
 

Additional Inherited Members

- Public Types inherited from dimensioned< scalar >
typedef pTraits< scalar >::cmptType cmptType
 Component type. More...
 

Detailed Description

Structure to store a dimensioned coefficient of the saturation model.

Definition at line 48 of file saturationModels.H.

Member Function Documentation

◆ operator scalar()

operator scalar ( ) const
inline

Cast to a scalar.

Definition at line 56 of file saturationModels.H.

References dimensioned< scalar >::value().

Here is the call graph for this function:

The documentation for this struct was generated from the following file: