CentrifugalCompressor - abhishekvraman/Propylean GitHub Wiki

DESCRIPTION:

Class to create object which represents a Centrifugal Compressor. All the properties associated with a Centrifugal Compressor used in the process industry to analyse can be accessed as object property.

SAMPLE USE CASES:

# Importing and setting basic properties.
from propylean.equipment.rotary import CentrifugalCompressor
or 
from propylean import CentrifugalCompressor
from propylean import properties as prop
Compressor_1 = CentrifugalCompressor(tag="Feed_compressor", efficiency=80, differential_pressure=(10,"bar"))
print(Compressor_1)
Compressor_1.inlet_pressure = prop.Pressure(5, "bar")
print(Compressor_1.outlet_pressure)

PARAMETERS:

tag:

Required: No
Type: str
Acceptable values: Any string type
Default value: None
Description: Equipment tag the user wants to provide. If not provided, tag is automatically generated.

differential_pressure:

Required: No
Type: int or float or Pressure (recommended)
Acceptable values: Any. Negative value means pressure drop.
Default value: based on unit    
Description: Differential pressure generated by the equipment.

efficiency:

Required: No
Type: int or float (recommended)
Acceptable values: Non-negative integer [0-100]
Default value: 100 or 1 (representing 100%)    
Description: Efficiency of the equipment. If user provides value greater than 1, value provided is considered as percent. 
             If value provided is between 0 and 1 (inclusive) value is considered as fraction. 
             Efficency can be set as adiabatic/isentropic or polytropic efficiency.

adiabatic_efficiency:

Required: No
Type: int or float (recommended)
Acceptable values: Non-negative values
Default value: 0.7
Description: Efficiency of the compressor considering adiabatic/isentropic
             compression.

polytropic_efficiency:

Required: No
Type: int or float (recommended)
Acceptable values: Non-negative values
Default value: 0.7
Description: Efficiency of the compressor considering polytropic
             compression.

performance_curve:

Required: No
Type: pandas dataframe
Acceptable values: Non-negative integer in dataframe with flow and head values.
Default value: pandas.DataFrame()    
Description: Performance curve of the Compressor. 
             E.g. pd.DataFrame([{'flow':[2, 10, 30, 67], 'head':[45, 20, 10, 2]}])

NOTE: You can save the performance curve but no property of Compressor is derived. Deriviation of differential pressure and other properties will be supported later.

PROPERTIES:

Properties can be accessed using the dot '.' operator. For e.g. centrifugal_compressor.temperature_increase

suction_pressure/inlet_pressure

Type: Pressure
Description: Suction pressure of the Compressor.

discharge_pressure/outlet_pressure

Type: Pressure
Description: Discharge pressure of the Compressor.

inlet_temperature

Type: Temperature
Description: Inlet temperature of the Compressor.

outlet_temperature

Type: Temperature
Description: Outlet temperature of the Compressor.

temperature_change

Type: Temperature
Description: Temperature change due to compression.

inlet_mass_flowrate

Type: MassFlowRate
Description: Inlet mass flow rate of the Compressor.

outlet_mass_flowrate

Type: MassFlowRate
Description: Outlet mass flow rate of the Compressor.

head:

Type: Length
Description: Differential head generated by the Compressor.

power/energy_in:

Type: Power
Description: Power required by the Compressor.

RETURN VALUE:

Type: CentrifugalCompressor
Description: Returns an object of type CentrifugalCompressor with all properties of
             a centrifugal Compressor used in process industries.

ERROR RAISED:

Type:
Description:

SETTINGS:

Compression process can be set using Settings module. Setting the process leads to efficiency property return efficiency of the process.

from propylean.settings import Settings
Settings.compression_process = "Polytropic" # Polytropic or Adiabatic/Isentropic