Class for representation SI units of Fields. More...
#include <unit_si.hh>
Classes | |
| struct | OutputFormat |
Variable parts of output format. Used in the format method. More... | |
Public Member Functions | |
| UnitSI () | |
| Constructor. More... | |
| UnitSI & | m (int exp=1) |
| Methods set values of exponents for SI units with similar name. More... | |
| UnitSI & | kg (int exp=1) |
| UnitSI & | s (int exp=1) |
| UnitSI & | A (int exp=1) |
| UnitSI & | K (int exp=1) |
| UnitSI & | mol (int exp=1) |
| UnitSI & | cd (int exp=1) |
| UnitSI & | md (int exp=-1) |
| Method sets value of exponent for m^{-d}, where d is dimension of region. More... | |
| std::string | format_latex () const |
| std::string | format_text () const |
| void | undef (bool val=true) |
| bool | is_def () const |
| Return true if the unit is defined. More... | |
Static Public Member Functions | |
| static UnitSI & | N () |
| static UnitSI & | J () |
| Returns Joule. More... | |
| static UnitSI & | W () |
| Returns Watt. More... | |
| static UnitSI & | Pa () |
| Returns Pascal. More... | |
| static UnitSI & | dimensionless () |
| Returns dimensionless unit. More... | |
Private Types | |
| enum | UnitOrder { order_m =0, order_md =1, order_kg =2, order_s =3, order_A =4, order_K =5, order_mol =6, order_cd =7, n_base_units =8 } |
| Values determine positions of exponents in exponents_ vector. More... | |
Private Member Functions | |
| std::string | format (OutputFormat form) const |
| Generic output formating mtehod. More... | |
Private Attributes | |
| std::vector< int > | exponents_ |
| bool | undef_ |
Friends | |
| UnitSI | operator* (const UnitSI &a, const UnitSI &b) |
| Product of two units. More... | |
| UnitSI | operator/ (const UnitSI &a, const UnitSI &b) |
| Proportion of two units. More... | |
Detailed Description
Class for representation SI units of Fields.
Units are set through exponents of basic SI units. These exponents are set in methods with same name as unit symbols (e.g. kg(), K() etc).
Class contains method that provides formated string representing full unit symbol (usable in LaTeX output).
UnitSI object contains flag that says if it is defined
- undefined object can't be formated
- if any exponent is set, flag is set to defined
Class contains static methods that return frequently used derived units (Watt, Pascal etc).
Definition at line 31 of file unit_si.hh.
Member Enumeration Documentation
|
private |
Values determine positions of exponents in exponents_ vector.
| Enumerator | |
|---|---|
| order_m | |
| order_md | |
| order_kg | |
| order_s | |
| order_A | |
| order_K | |
| order_mol | |
| order_cd | |
| n_base_units | |
Definition at line 82 of file unit_si.hh.
Constructor & Destructor Documentation
| UnitSI::UnitSI | ( | ) |
Constructor.
Definition at line 18 of file unit_si.cc.
Member Function Documentation
| UnitSI & UnitSI::A | ( | int | exp = 1 | ) |
Definition at line 67 of file unit_si.cc.
| UnitSI & UnitSI::cd | ( | int | exp = 1 | ) |
Definition at line 85 of file unit_si.cc.
|
static |
Returns dimensionless unit.
Definition at line 44 of file unit_si.cc.
|
private |
Generic output formating mtehod.
Definition at line 122 of file unit_si.cc.
| std::string UnitSI::format_latex | ( | ) | const |
Makes unit description string in Latex format, e.g. "$[m.kg^{2}.s^{-2}]$"
Have assert for undefined units.
Definition at line 102 of file unit_si.cc.
| std::string UnitSI::format_text | ( | ) | const |
| bool UnitSI::is_def | ( | ) | const |
Return true if the unit is defined.
Definition at line 167 of file unit_si.cc.
|
static |
Returns Joule.
Definition at line 29 of file unit_si.cc.
| UnitSI & UnitSI::K | ( | int | exp = 1 | ) |
Definition at line 73 of file unit_si.cc.
| UnitSI & UnitSI::kg | ( | int | exp = 1 | ) |
| UnitSI & UnitSI::m | ( | int | exp = 1 | ) |
Methods set values of exponents for SI units with similar name.
Definition at line 49 of file unit_si.cc.
| UnitSI & UnitSI::md | ( | int | exp = -1 | ) |
Method sets value of exponent for m^{-d}, where d is dimension of region.
Definition at line 91 of file unit_si.cc.
| UnitSI & UnitSI::mol | ( | int | exp = 1 | ) |
Definition at line 79 of file unit_si.cc.
|
static |
Methods return frequently used derived units Returns Newton
Definition at line 24 of file unit_si.cc.
|
static |
Returns Pascal.
Definition at line 39 of file unit_si.cc.
| UnitSI & UnitSI::s | ( | int | exp = 1 | ) |
| void UnitSI::undef | ( | bool | val = true | ) |
Set flag that unit is undefined.
Default value is true (set in constructor). If any exponent is set, undef_ flag is unset. In all fields unit must be defined by user.
Definition at line 163 of file unit_si.cc.
|
static |
Friends And Related Function Documentation
Product of two units.
Definition at line 172 of file unit_si.cc.
Proportion of two units.
Definition at line 185 of file unit_si.cc.
Member Data Documentation
|
private |
Stores exponents of base SI units in this order: [m, kg, s, A, K, mol, cd, md]
where md represents value of exponent depended on dimension (m^{-d})
Definition at line 108 of file unit_si.hh.
|
private |
Flag if object is undefined.
Value is set on true in constructor, when any exponent is changed, false value is set.
Definition at line 117 of file unit_si.hh.
The documentation for this class was generated from the following files:
- /home/builder/jenkins/F123-linux-release/flow123d/src/fields/unit_si.hh
- /home/builder/jenkins/F123-linux-release/flow123d/src/fields/unit_si.cc
