get_unit_dimensions#
- ENS_GLOBALS.get_unit_dimensions(obj: ENS_VAR, normalized: bool = False) str#
This method will return the units dimension string for a given variable object.
The dimension string is a collection of characters that represent fundamental quantities, mass, length, time, etc. The string repeats a character if the quantity is of another order (e.g. volume would be “LL”) and quantities with a negative exponent, will appear after a ‘/’ character. These quantity characters include:
Character
Quantity (SI value)
M
Mass (Kilogram)
L
Length (Meter)
I
Intensity (Candela)
D
Angle (Radian)
K
Temperature (Kelvin)
Q
Current (Ampere)
T
Time (Second)
A
Substance amount (Mol)
If there is a variable ‘v’ that is velocity, the call
ensight.object.core.get_unit_dimensions(v)will return the dimension string: “L/T”.- Args:
- obj:
An ENS_VAR object instance.
- normalized:
If normalized is set to True, the form of the dimension string will be standardized. For example: ‘LT/TT’ would be converted to ‘L/T’ and the ordering of the dimension characters will be sorted to a standard order (MLIDKQTA). This allows for the direct comparison of variable unit dimensions.
- Returns:
A string describing the dimensionality of the variable.
- See also: