Units Class Reference#
Public Member Functions |
Private Member Functions |
Private Attributes |
Friends |
List of all members
Units Class Reference
A representation of the units associated with a dimensional quantity. More...
#include <Units.h>
Detailed Description
A representation of the units associated with a dimensional quantity.
Used for converting quantities between unit systems and checking for dimensional consistency. Units objects are mainly used within UnitSystem class to convert values from a user-specified Unit system to Cantera's base units (SI + kmol).
Public Member Functions | |
Units (double factor=1.0, double mass=0, double length=0, double time=0, double temperature=0, double current=0, double quantity=0) | |
Create a Units object with the specified dimensions. | |
Units (const string &units, bool force_unity=false) | |
Create an object with the specified dimensions. | |
bool | convertible (const Units &other) const |
Returns true if the specified Units are dimensionally consistent. | |
double | factor () const |
Return the factor for converting from this unit to Cantera's base units. | |
Units & | operator*= (const Units &other) |
Multiply two Units objects, combining their conversion factors and dimensions. | |
string | str (bool skip_unity=true) const |
Provide a string representation of these Units. | |
Units | pow (double exponent) const |
Raise these Units to a power, changing both the conversion factor and the dimensions of these Units. | |
bool | operator== (const Units &other) const |
double | dimension (const string &primary) const |
Return dimension of primary unit component ("mass", "length", "time", "temperature", "current", or "quantity") | |
Private Member Functions | |
void | scale (double k) |
Scale the unit by the factor k | |
Private Attributes | |
double | m_factor = 1.0 |
conversion factor to Cantera base units | |
double | m_mass_dim = 0.0 |
double | m_length_dim = 0.0 |
double | m_time_dim = 0.0 |
double | m_temperature_dim = 0.0 |
double | m_current_dim = 0.0 |
double | m_quantity_dim = 0.0 |
double | m_pressure_dim = 0.0 |
pseudo-dimension to track explicit pressure units | |
double | m_energy_dim = 0.0 |
pseudo-dimension to track explicit energy units | |
Friends | |
class | UnitSystem |
Constructor & Destructor Documentation
◆ Units() [1/2]
|
explicit |
◆ Units() [2/2]
|
explicit |
Create an object with the specified dimensions.
- Parameters
-
units A string representation of the units. See UnitSystem for a description of the formatting options. force_unity ensure that conversion factor is equal to one
Member Function Documentation
◆ convertible()
bool convertible | ( | const Units & | other | ) | const |
◆ factor()
|
inline |
◆ operator*=()
◆ str()
string str | ( | bool | skip_unity = true | ) | const |
◆ pow()
Units pow | ( | double | exponent | ) | const |
◆ operator==()
◆ dimension()
double dimension | ( | const string & | primary | ) | const |
◆ scale()
|
inlineprivate |
Friends And Related Symbol Documentation
◆ UnitSystem
|
friend |
Member Data Documentation
◆ m_factor
|
private |
◆ m_mass_dim
◆ m_length_dim
◆ m_time_dim
◆ m_temperature_dim
◆ m_current_dim
◆ m_quantity_dim
◆ m_pressure_dim
|
private |
◆ m_energy_dim
|
private |
The documentation for this class was generated from the following files:
Generated by 1.9.7