Properties - abhishekvraman/Propylean GitHub Wiki
Introduction
Properties in Propylean package is a helper class which define value and unit of physical and chemical property. As many properties are assiciated with unit and unit can be of any system, Propylean allow users to use any available unit. We recommend to use SI system for better results. All the available properties can be used as generalized by below example:
from propylean import properties as prop
some_property = prop.SomeProperty(Value, Unit)
print(some_property)
# Change value of some_property
some_property.value = some_other_value_as_float_or_int
# Change unit of some_property
some_property.unit = "some_other_unit_as_string"
# Create Pressure property
pump_inlet_pressure = prop.Pressure(10, "bar")
All properties have following members that can be assigned in the constructor or as class property.
value
Integer of float value taken by the property.
min_val
Minimum integer of float value taken by the property.
max_val
Maximum integer of float value taken by the property.
unit
Unit taken by the property. Dimensionless properties do not support unit. Type: string
time_series
Time series value associated with the property for analysis. Type: Pandas Series, Pandas DataFrame, or dict
Length
Supported units are:
- m for meters
- mm for millimeters
- km for Kilometers
- cm for centimeters
- inch
- mile
- yard
- foot
Time
Supported units are:
- s for seconds
- min for minutes
- hour
- day
- week
- month
- year
Pressure
Supported units are:
- Pa for Pascals
- m water for meters of water column
- in water for inches of water column
- mm Hg for millimeters of Mercury
- Torr
- ata
- kg/cm^2 for kilogram per square centimeter
- MPa for Mega Pascal
- kPa for Kilo Pascal
- psi for Pound per square inch
- bar
- atm for Atmospheres
Temperature
Supported units are:
- K for Kelvin
- C for Degrees Celsius
- F for Degree Fahrenheit
- R for Degree Rankine
MassFlowRate
Supported units are:
- kg/s for kilogram per seconds
- kg/min for kilogram per minutes
- kg/h for kilogram per hour
- kg/d for kilogram per day
- g/s for gram per second
- lb/s for pound per second
- lb/min for pound per minutes
- lb/h for pound per hour
- lb/d for pound per day
- ton/d for metric ton per day
- ton/h for metric ton per hour
MolecularWeigth
Supported units are:
- g/mol for gram per mol
- kg/mol for kilogram per mol
MolarFlowRate
Supported units are:
- mol/s for moles per seconds
- mol/min for moles per minutes
- mol/h for moles per hour
- mol/d for moles per day
- lbmol/s for poundmole per second
- lbmol/min for poundmole per minute
- lbmol/d for poundmole per day
- kmol/h for kilomole per hour
- kmol/d for kilomole per day
VolumetricFlowRate
Supported units are:
- m^3/s for cubic meter per second
- ft^3/s for cubic feet per second
- cm^3/s for cubic centimeter per second
- m^3/min for cubic meter per minute
- m^3/h for cubic meter per hour
- m^3/d for cubic meter per day,
- ft^3/min for cubic feet per minute,
- ft^3/h for cubic feet per hour
- ft^3/d for cubic feet per day
- gal/s for US Gallons per second
- gal/min for US Gallon per minute
- gal/h for US Gallon per hour
- gal/d for US Gallin per day
- lit/s for Liters per second
- lit/min for Liters per minute
- lit/h for Liters per hour
- lit/d for Liters per day
Density
Supported units are:
- kg/m^3 for kilograms per cubic meter
- g/cm^3 for grams per per cubic centimeter
- lbm/ft^3 for pound mass per cubic feet
DViscosity(for dynamic viscosity)
Supported units are:
- Pa-s for Pascal second
- cP for centipoise
- lb/(ft-s) for pound mass per cubic feet
Power
Supported units are:
- W for Watts
- BTU/h for British Termal Units per hour
- BTU/min for Brititsh Termal Units per minutes
- BTU/s for British Termal Units per second
- cal/h for calories per hour
- cal/s for calories per second
- erg/h for ergs per hour
- erg/min for ergs per minutes
- erg/s for ergs per second
- hp for Horse Power
- MMBTU/h for Million Metric BTU/h
- MMBTU/min
- MMBTU/s
- kW for kilo watts
- MW for mega watts
- GW for giga watts
- TW for tera watts
- kWh/d for kilo watt hours per day
- MWh/d for Mega watt hours per day
- GWh/d for Giga watt hour per day
- TWh/d for Tera watt hour per day
Frequency
Supported units are:
- Hz for Hertz(cycle per second)
- /min for cylce per minute
- /hour for cycle per hour
Components
Components of a mixture of material. fractions: The fractional quantity a chemical component has in the mixture. To be specified as dictionary where key is the component in string and value is fraction of that component in float. Type: Dictionary type: The type of fractional quantity in "fractions". Types include "mass", "volumne" and "molar".
Dimensionless
Dimensionless property which has no unit associated. name: Name of the dimensionless property. For e.g. "Reynolds Number"
Efficiency
Efficiency as a fractional value without dimension.