BioSimSpace.Types.Pressure#
- class BioSimSpace.Types.Pressure(*args)[source]#
A pressure type.
- __init__(*args)[source]#
Constructor.
*args
can be a value and unit, or a string representation of the pressure, e.g. “1.38 bar”.- Parameters:
value (float) – The value.
unit (str) – The unit.
string (str) – A string representation of the pressure.
Examples
Create an object representing a pressure of 3.1 atmosphere then print the pressure in bar.
>>> import BioSimSpace as BSS >>> pressure = BSS.Types.Pressure(3.1, "atm") >>> print(pressure.bar())
The same as above, except passing a string representation of the pressure to the constructor.
>>> import BioSimSpace as BSS >>> pressure = BSS.Types.Pressure("3.1 atm") >>> print(pressure.nanoseconds())
The string matching is extremeley flexible, so all of the following would be valid arguments: “3.1 atm”, “3.1 atmosphere”, “0.31e1 atm”.
Methods
__init__
(*args)Constructor.
angle
()Return the power in the 'angle' dimension.
atm
()Return the atmospheric pressure.
bar
()Return the pressure in bar.
charge
()Return the power in the 'charge' dimension.
Return the dimensions of this type.
length
()Return the power in the 'length' dimension.
mass
()Return the power in the 'mass' dimension.
quantity
()Return the power in the 'quantity' dimension.
Return the power in the 'temperature' dimension.
time
()Return the power in the 'time' dimension.
to
(unit)Return the value of this general unit in the specified unit.
unit
()Return the unit.
value
()Return the value.
- classmethod angle()#
Return the power in the ‘angle’ dimension.
- Returns:
angle – The power in the ‘angle’ dimension.
- Return type:
int
- atm()[source]#
Return the atmospheric pressure.
- Returns:
pressure – The pressure in atomospheres.
- Return type:
- classmethod charge()#
Return the power in the ‘charge’ dimension.
- Returns:
charge – The power in the ‘charge’ dimension.
- Return type:
int
- classmethod dimensions()#
Return the dimensions of this type. This is a tuple containing the power in each dimension.
- Returns(int, int, int, int, int, int)
The power in each dimension: ‘mass’, ‘length’, ‘temperature’, ‘charge’, ‘time’, ‘quantity’, and ‘angle’.
- classmethod length()#
Return the power in the ‘length’ dimension.
- Returns:
length – The power in the ‘length’ dimension.
- Return type:
int
- classmethod mass()#
Return the power in the ‘mass’ dimension.
- Returns:
mass – The power in the ‘mass’ dimension.
- Return type:
int
- classmethod quantity()#
Return the power in the ‘quantity’ dimension.
- Returns:
quantity – The power in the ‘quantity’ dimension.
- Return type:
int
- classmethod temperature()#
Return the power in the ‘temperature’ dimension.
- Returns:
temperature – The power in the ‘temperature’ dimension.
- Return type:
int
- classmethod time()#
Return the power in the ‘time’ dimension.
- Returns:
time – The power the ‘time’ dimension.
- Return type:
int
- to(unit)#
Return the value of this general unit in the specified unit.
- Parameters:
unit (str) – The unit to convert to.
- Returns:
value – The value in the specified unit.
- Return type:
float
- unit()#
Return the unit.
- Returns:
unit – The unit of the type.
- Return type:
str
- value()#
Return the value.
- Returns:
value – The value of the type.
- Return type:
float