Expander Class
Represents an expander (turbine) unit operation that reduces the pressure of a gas or
vapor stream through isentropic or polytropic expansion, generating shaft work.
Definition
Namespace: DWSIM.UnitOperations.UnitOperations
Assembly: DWSIM.UnitOperations (in DWSIM.UnitOperations.dll) Version: 10.0.0.0
Assembly: DWSIM.UnitOperations (in DWSIM.UnitOperations.dll) Version: 10.0.0.0
C#
[SerializableAttribute]
public class Expander : UnitOpBaseClassVB
<SerializableAttribute>
Public Class Expander
Inherits UnitOpBaseClass- Inheritance
- Object BaseClass UnitOpBaseClass Expander
Remarks
The expander supports multiple calculation modes including outlet pressure, pressure
drop, power generated, head, performance curves, and pressure ratio. Both adiabatic
(isentropic) and polytropic thermodynamic paths are supported.
Constructors
| Expander | Initializes a new instance of the Expander class with default settings. |
| Expander(String, String) | Initializes a new instance of the Expander class with a specified name and description. |
Properties
| AdiabaticCoefficient | Gets or sets the isentropic (adiabatic) volume exponent coefficient, calculated from inlet and outlet conditions. |
| AdiabaticEfficiency | Gets or sets the adiabatic (isentropic) efficiency of the expander (%). |
| AdiabaticHead | Gets or sets the adiabatic head of the expander (m). |
| AdjustVarType |
If an Adjust object is attached to this object, returns a variable describing how this object is used by it (manipulated, controlled or reference).
(Inherited from BaseClass) |
| Annotation | (Inherited from BaseClass) |
| AttachedAdjustId |
If an Adjust object is attached to this object, returns its ID.
(Inherited from BaseClass) |
| AttachedInfoCarrierId | (Inherited from BaseClass) |
| AttachedSpecId |
If an Specification object is attached to this object, returns its ID.
(Inherited from BaseClass) |
| AttachedUtilities | (Inherited from BaseClass) |
| Bottom | (Inherited from BaseClass) |
| CalcMode | Gets or sets the active calculation mode for the expander. |
| Calculated | (Inherited from BaseClass) |
| CanUsePreviousResults | (Inherited from BaseClass) |
| ComponentDescription |
Gets or sets the CAPE-OPEN component description for this unit operation.
(Inherited from UnitOpBaseClass) |
| ComponentName |
Gets or sets the CAPE-OPEN component name for this unit operation.
(Inherited from UnitOpBaseClass) |
| CreateChartAction | (Inherited from BaseClass) |
| CurveEff | Gets or sets the efficiency value interpolated from the performance curves at the current flow (%). |
| CurveFlow | Gets or sets the volumetric or molar flow value read from the performance curves at the operating point. |
| CurveHead | Gets or sets the head value interpolated from the performance curves at the current flow (m). |
| CurvePower | Gets or sets the power value interpolated from the performance curves at the current flow (kW). |
| Curves | Gets or sets the collection of performance curve sets, keyed by rotation speed (rpm). |
| CurvesDB | Gets or sets the serialized performance curves database string. |
| DebugMode | (Inherited from BaseClass) |
| DebugText | (Inherited from BaseClass) |
| DeltaP | Gets or sets the pressure drop across the expander (Pa). |
| DeltaQ | Gets or sets the shaft power generated by the expander (kW). Positive values represent generated power. |
| DeltaT | Gets or sets the temperature change of the stream across the expander (K). |
| DetailedDebugReport | (Inherited from BaseClass) |
| Dimensions |
Gets or sets the list of physical dimensions (e.g. vessel diameter, length) associated with this unit operation.
(Inherited from UnitOpBaseClass) |
| DynamicsOnly | (Inherited from BaseClass) |
| DynamicsSpec | (Inherited from BaseClass) |
| EnergyFlow |
Energy Flow property. Only implemented for Energy Streams.
(Inherited from BaseClass) |
| EquipmentTypes |
Gets the list of equipment sub-types available for this expander (e.g., Steam, Gas).
(Overrides UnitOpBaseClassEquipmentTypes) |
| EquipType | Gets or sets the equipment type identifier used for selecting performance curve data sets. |
| ErrorMessage |
Gets or sets the error message regarding the last calculation attempt.
(Inherited from BaseClass) |
| ExternalSolverConfigData |
Gets or sets serialized configuration data for the external solver associated with this unit operation.
(Inherited from UnitOpBaseClass) |
| ExternalSolverID |
Gets or sets the unique identifier of an external solver to be used for this unit operation.
(Inherited from UnitOpBaseClass) |
| ExtraProperties | (Inherited from BaseClass) |
| ExtraPropertiesDescriptions | (Inherited from BaseClass) |
| ExtraPropertiesTypes | (Inherited from BaseClass) |
| ExtraPropertiesUnitTypes | (Inherited from BaseClass) |
| FlowSheet |
Gets the current flowsheet where this object is located.
(Inherited from BaseClass) |
| GHGEmissionData | (Inherited from BaseClass) |
| GraphicObject |
Gets or sets the graphic object representation of this object in the flowsheet.
(Inherited from BaseClass) |
| HasPropertiesForDynamicMode |
Gets a value indicating whether this unit operation exposes additional properties in dynamic mode.
(Overrides BaseClassHasPropertiesForDynamicMode) |
| HeatDuty | Gets or sets the shaft power generated by the expander (kW). Alias for DeltaQ. |
| Height | (Inherited from BaseClass) |
| IgnorePhase | Gets or sets a value indicating whether phase validation of the inlet stream is bypassed. |
| InfoCarrierVarType | (Inherited from BaseClass) |
| IsAdjustAttached |
Checks if an Adjust operation is attached to this object.
(Inherited from BaseClass) |
| IsDirty | (Inherited from BaseClass) |
| IsFunctional | (Inherited from BaseClass) |
| IsInfoCarrierAttached | (Inherited from BaseClass) |
| IsSink | (Inherited from BaseClass) |
| IsSource | (Inherited from BaseClass) |
| IsSpecAttached |
Checks if an Specification operation is attached to this object.
(Inherited from BaseClass) |
| LastSolutionInputSnapshot | (Inherited from BaseClass) |
| LastUpdated | (Inherited from BaseClass) |
| Left | (Inherited from BaseClass) |
| MobileCompatible |
Gets a value indicating whether this unit operation is compatible with DWSIM Mobile.
(Overrides BaseClassMobileCompatible) |
| Name |
Object's Unique ID (Name)
(Inherited from BaseClass) |
| ObjectClass | Gets or sets the simulation object class category (PressureChangers). (Overrides BaseClassObjectClass) |
| OutletTemperature | Gets or sets the calculated outlet temperature of the stream (K). |
| OverrideCalculationRoutine | (Inherited from BaseClass) |
| ParticleSizeDistributions |
Gets or sets the dictionary of particle size distribution data, keyed by compound or stream name.
(Inherited from UnitOpBaseClass) |
| Phases |
Phase collection, only implemented for Material Streams.
(Inherited from BaseClass) |
| PolytropicCoefficient | Gets or sets the polytropic volume exponent coefficient, calculated from inlet and outlet conditions. |
| PolytropicEfficiency | Gets or sets the polytropic efficiency of the expander (%). |
| PolytropicHead | Gets or sets the polytropic head of the expander (m). |
| POut | Gets or sets the outlet pressure of the expander (Pa). |
| PreferredFlashAlgorithmTag | (Inherited from BaseClass) |
| PressureDrop | Gets or sets the pressure drop across the expander (Pa). Alias for DeltaP. |
| PressureRatio | Gets or sets the outlet-to-inlet pressure ratio across the expander. |
| ProcessPath | Gets or sets the thermodynamic path (adiabatic or polytropic) used for expansion. |
| ProductAssembly | (Inherited from BaseClass) |
| ProductAuthor | (Inherited from BaseClass) |
| ProductContactInfo | (Inherited from BaseClass) |
| ProductDescription | (Inherited from BaseClass) |
| ProductName | (Inherited from BaseClass) |
| ProductPage | (Inherited from BaseClass) |
| ProductVersion | (Inherited from BaseClass) |
| PropertyPackage |
Gets or sets the property package associated with this object.
(Inherited from UnitOpBaseClass) |
| Right | (Inherited from BaseClass) |
| SelectedEquipmentType |
Gets or sets the name of the equipment type currently selected for this unit operation.
(Inherited from UnitOpBaseClass) |
| SpecVarType |
If an Specification object is attached to this object, returns a variable describing how this object is used by it (target or source).
(Inherited from BaseClass) |
| Speed | Gets or sets the rotation speed of the expander impeller (rpm). |
| StoreDetailedDebugReport | (Inherited from BaseClass) |
| SupportsDynamicMode |
Gets a value indicating whether this unit operation supports dynamic simulation mode.
(Overrides BaseClassSupportsDynamicMode) |
| SupportsParticleSizeDistributions |
Gets a value indicating whether this unit operation supports particle size distribution calculations.
(Inherited from UnitOpBaseClass) |
| SupportsRestoreStateAfterError |
Gets a value indicating whether this unit operation supports restoring its state after a solver error.
(Inherited from UnitOpBaseClass) |
| TemperatureChange | Gets or sets the temperature change of the stream (K). Alias for DeltaT. |
| Top | (Inherited from BaseClass) |
| UserDefinedChartNames | (Inherited from BaseClass) |
| Visible | (Inherited from BaseClass) |
| Width | (Inherited from BaseClass) |
Methods
| AddDynamicProperty | (Inherited from BaseClass) |
| AddExtraProperty | (Inherited from BaseClass) |
| AppendDebugLine | (Inherited from BaseClass) |
| Calculate |
Performs the main thermodynamic calculation for the expander: determines outlet conditions
(pressure, temperature, enthalpy) and the shaft power generated based on the selected
calculation mode and thermodynamic path.
(Overrides BaseClassCalculate(Object)) |
| CheckDirtyStatus |
Checks whether the unit operation's input data has changed since the last successful solve,
and updates the dirty flag accordingly.
(Inherited from UnitOpBaseClass) |
| CheckSpec |
Checks if a value is valid.
(Inherited from BaseClass) |
| ClearExtraProperties | (Inherited from BaseClass) |
| ClearPropertyPackageInstance |
Removes the externally set property package instance from this unit operation,
reverting to the flowsheet-level property package lookup.
(Inherited from UnitOpBaseClass) |
| Clone |
Clones the current object, returning a new one with identical properties.
(Inherited from BaseClass) |
| CloneJSON |
Creates a deep copy of this expander by serializing and deserializing through JSON.
(Overrides BaseClassCloneJSON) |
| CloneXML |
Creates a deep copy of this expander by serializing and deserializing through XML.
(Overrides BaseClassCloneXML) |
| CloseDynamicsEditForm | (Inherited from BaseClass) |
| CloseEditForm |
Closes the editing form for this expander if it is currently open and not already disposed.
(Overrides BaseClassCloseEditForm) |
| ConnectEnergyStream | (Inherited from BaseClass) |
| ConnectFeedEnergyStream | (Inherited from BaseClass) |
| ConnectFeedMaterialStream | (Inherited from BaseClass) |
| ConnectProductEnergyStream | (Inherited from BaseClass) |
| ConnectProductMaterialStream | (Inherited from BaseClass) |
| CopyDataToClipboard |
Copies the object properties to the Clipboard.
(Inherited from BaseClass) |
| CreateCurves | Creates a default set of performance curves (HEAD, EFF, POWER) for a new rotation speed entry. |
| CreateDimensionsList |
Creates the list of sizing dimensions applicable to this expander (flow, pressure, efficiency, power).
(Overrides UnitOpBaseClassCreateDimensionsList) |
| CreateDynamicProperties | (Inherited from BaseClass) |
| CreateNew | (Inherited from BaseClass) |
| DeCalculate |
Resets the outlet material stream and energy stream to an uncalculated state,
clearing all previously computed values.
(Overrides UnitOpBaseClassDeCalculate) |
| DeCalculate(Object) | (Inherited from BaseClass) |
| DisplayDynamicsEditForm | (Inherited from BaseClass) |
| DisplayEditForm |
Opens or activates the editing form for this expander unit operation.
(Overrides BaseClassDisplayEditForm) |
| DisplayExtraPropertiesEditForm | (Inherited from BaseClass) |
| Dispose | (Inherited from BaseClass) |
| Dispose(Boolean) | (Inherited from BaseClass) |
| FT |
Formats a property string, adding its units in parenthesis.
(Inherited from BaseClass) |
| GetAsObject | (Inherited from BaseClass) |
| GetBytesFromResource | (Inherited from BaseClass) |
| GetCalculationModes |
Returns an array of strings describing the available calculation modes for display in the UI.
(Overrides UnitOpBaseClassGetCalculationModes) |
| GetChartModel | (Inherited from BaseClass) |
| GetChartModelNames | (Inherited from BaseClass) |
| GetConnectionPortsInfo | (Inherited from BaseClass) |
| GetConnectionPortsList | (Inherited from BaseClass) |
| GetDebugReport |
Runs the unit operation in debug mode and returns a formatted text report
containing intermediate calculation steps and any error information.
(Inherited from UnitOpBaseClass) |
| GetDebugWriter | (Inherited from BaseClass) |
| GetDefaultProperties | (Inherited from BaseClass) |
| GetDisplayDescription |
Returns the localized display description for the expander unit operation.
(Overrides BaseClassGetDisplayDescription) |
| GetDisplayName |
Returns the localized display name for the expander unit operation.
(Overrides BaseClassGetDisplayName) |
| GetDynamicContents |
Returns the current mass held in the accumulation stream of this unit operation.
(Inherited from UnitOpBaseClass) |
| GetDynamicProperty | (Inherited from BaseClass) |
| GetDynamicPropertyUnitType | (Inherited from BaseClass) |
| GetDynamicResidenceTime |
Returns the dynamic residence time of this unit operation, computed as volume divided
by the total volumetric inlet flow rate.
(Inherited from UnitOpBaseClass) |
| GetDynamicVolume |
Returns the dynamic volume of this unit operation from its dynamic property store.
(Inherited from UnitOpBaseClass) |
| GetEditingForm | (Inherited from BaseClass) |
| GetEnergyBalanceResidual | (Inherited from BaseClass) |
| GetEnergyConsumption |
Returns the total energy consumed by this unit operation by summing the energy flows
from all connected energy streams and the energy connector.
(Inherited from UnitOpBaseClass) |
| GetExtraPropertyValue | (Inherited from BaseClass) |
| GetFlowsheet | (Inherited from BaseClass) |
| GetIconBitmap |
Returns the icon bitmap resource associated with the expander unit operation.
(Overrides BaseClassGetIconBitmap) |
| GetIconBitmapBytes |
Returns the icon for this expander as a raw byte array (PNG format).
(Overrides BaseClassGetIconBitmapBytes) |
| GetKeyPropertyNames |
Returns the names of the key output properties reported by this unit operation.
(Inherited from UnitOpBaseClass) |
| GetKeyPropertyUnits |
Returns the display unit string for a named key property.
(Inherited from UnitOpBaseClass) |
| GetKeyPropertyValue |
Returns the current numeric value of a named key property in SI units.
(Inherited from UnitOpBaseClass) |
| GetMassBalanceResidual | (Inherited from BaseClass) |
| GetPowerGeneratedOrConsumed | (Inherited from BaseClass) |
| GetPreferredGraphicObjectHeight | (Inherited from BaseClass) |
| GetPreferredGraphicObjectWidth | (Inherited from BaseClass) |
| GetProperties |
Returns the list of property identifiers for this expander filtered by the specified access type.
(Overrides BaseClassGetProperties(PropertyType)) |
| GetProperties2 | (Inherited from BaseClass) |
| GetPropertyDescription |
Returns a human-readable description of the specified property for display in the properties panel.
(Overrides BaseClassGetPropertyDescription(String)) |
| GetPropertyUnit |
Returns the unit string for the specified property in the given unit system.
(Overrides BaseClassGetPropertyUnit(String, IUnitsOfMeasure)) |
| GetPropertyUnits2 | (Inherited from BaseClass) |
| GetPropertyValue |
Returns the current value of the specified property, converted to the given unit system.
(Overrides UnitOpBaseClassGetPropertyValue(String, IUnitsOfMeasure)) |
| GetPropertyValue2 | (Inherited from BaseClass) |
| GetReport |
Generates a plain-text report of the expander's inlet conditions, calculation parameters, and results.
(Overrides BaseClassGetReport(IUnitsOfMeasure, CultureInfo, String)) |
| GetStructuredReport |
Generates a structured report of the expander's calculation parameters and results,
formatted as a list of typed report items for display in the UI.
(Overrides BaseClassGetStructuredReport) |
| GetVersion | (Inherited from BaseClass) |
| IsDynamicProperty | (Inherited from BaseClass) |
| LoadData |
Loads the expander's state from a list of XML elements, restoring saved properties and performance curves.
(Overrides UnitOpBaseClassLoadData(ListXElement)) |
| ObjectCopy | (Inherited from BaseClass) |
| PerformPostCalcValidation | (Inherited from BaseClass) |
| RemoveDynamicProperty | (Inherited from BaseClass) |
| RemoveExtraProperty | (Inherited from BaseClass) |
| RunDynamicModel |
Executes the dynamic model of the expander, delegating to the steady-state calculation routine.
(Overrides BaseClassRunDynamicModel) |
| SaveData |
Saves the expander's current state as a list of XML elements, including performance curves.
(Overrides UnitOpBaseClassSaveData) |
| SetCalculationMode |
Sets the active calculation mode of the expander by numeric ID.
(Overrides UnitOpBaseClassSetCalculationMode(Int32)) |
| SetCanUsePreviousResults | (Inherited from BaseClass) |
| SetDirtyStatus | (Inherited from BaseClass) |
| SetDynamicProperty | (Inherited from BaseClass) |
| SetExtraPropertyValue | (Inherited from BaseClass) |
| SetFlowsheet |
Sets the Flowsheet to which this object belongs to.
(Inherited from BaseClass) |
| SetKeyPropertyValue |
Sets the value of a named key property, converting from the supplied units to SI internally.
(Inherited from UnitOpBaseClass) |
| SetPropertyPackageInstance |
Assigns an externally supplied property package instance to this unit operation,
bypassing the flowsheet-level property package lookup.
(Inherited from UnitOpBaseClass) |
| SetPropertyValue |
Sets the value of the specified property, converting from the given unit system to SI.
(Overrides BaseClassSetPropertyValue(String, Object, IUnitsOfMeasure)) |
| SetPropertyValue2 | (Inherited from BaseClass) |
| Solve |
Solves the unit operation, optionally saving and restoring state on error
when the flowsheet option RestoreUnitOperationStateAfterError is enabled.
(Inherited from UnitOpBaseClass) |
| StoreDebugReport | (Inherited from BaseClass) |
| ToString | (Inherited from BaseClass) |
| TransferAdditionalSolidData | (Inherited from BaseClass) |
| Unsolve |
Decalculates the object.
(Inherited from UnitOpBaseClass) |
| UpdateDimensionsList |
Updates the sizing dimensions list with the current calculated values from the expander.
(Overrides UnitOpBaseClassUpdateDimensionsList) |
| UpdateDynamicsEditForm | (Inherited from BaseClass) |
| UpdateEditForm |
Refreshes the editing form with the latest calculated values if the form is currently open.
(Overrides BaseClassUpdateEditForm) |
| UpdateExtraPropertiesEditForm | (Inherited from BaseClass) |
| Validate |
Validates the object, checking its connections and other parameters.
(Inherited from BaseClass) |
Fields
| _CanUsePreviousResults | (Inherited from BaseClass) |
| _capeopenmode | (Inherited from UnitOpBaseClass) |
| _IsDirty | (Inherited from BaseClass) |
| _pp | (Inherited from UnitOpBaseClass) |
| _ppid | (Inherited from UnitOpBaseClass) |
| AccumulationStream | (Inherited from UnitOpBaseClass) |
| CalculationRoutineOverride | (Inherited from BaseClass) |
| disposedValue | (Inherited from BaseClass) |
| ExtraPropertiesEditor | (Inherited from BaseClass) |
| f | |
| fd | (Inherited from BaseClass) |
| LaunchExternalPropertyEditor | (Inherited from BaseClass) |
| m_flowsheet | (Inherited from BaseClass) |
Extension Methods
| GetEnergyStream | (Defined by StreamListExtender) |
| GetEnumNames | (Defined by General) |
| GetInletEnergyStream | (Defined by StreamListExtender) |
| GetInletMaterialStream | (Defined by StreamListExtender) |
| GetOutletEnergyStream | (Defined by StreamListExtender) |
| GetOutletMaterialStream | (Defined by StreamListExtender) |
| IsValidDouble | (Defined by General) |