Pump Class
Represents a centrifugal (or other type) pump unit operation that increases the pressure of a
liquid stream. Supports multiple calculation modes including fixed pressure rise, fixed outlet
pressure, energy-stream-driven, power-driven, and performance-curve-based calculations.
Adiabatic efficiency and NPSH are computed alongside outlet conditions.
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 Pump : UnitOpBaseClassVB
<SerializableAttribute>
Public Class Pump
Inherits UnitOpBaseClass- Inheritance
- Object BaseClass UnitOpBaseClass Pump
Constructors
| Pump | Initializes a new default instance of the Pump class. |
| Pump(String, String) | Initializes a new instance of the Pump class with a name and description. |
Properties
| 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 pump. |
| 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 at the operating point read from the efficiency curve (%). |
| CurveFlow | Gets or sets the volumetric flow rate at the pump's operating point on the performance curve (m³/s). |
| CurveHead | Gets or sets the pump head at the operating point read from the head curve (m). |
| CurveNPSHr | Gets or sets the NPSHr at the operating point read from the NPSHr curve (m). |
| CurvePower | Gets or sets the shaft power at the operating point read from the power curve (kW). |
| CurveSysHead | Gets or sets the system resistance head at the operating point (m). |
| DebugMode | (Inherited from BaseClass) |
| DebugText | (Inherited from BaseClass) |
| DeltaP | Gets or sets the pressure rise across the pump (Pa). |
| DeltaQ | Gets or sets the power consumed by the pump (kW). |
| DeltaT | Gets or sets the temperature rise across the pump (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) |
| Efficiency | Gets or sets the adiabatic pump efficiency as a percentage (0–100). |
| Eficiencia | Gets or sets the adiabatic efficiency of the pump as a percentage (0–100). |
| EnergyFlow |
Energy Flow property. Only implemented for Energy Streams.
(Inherited from BaseClass) |
| EquipmentTypes | Gets the list of pump equipment sub-types available for this unit operation. (Overrides UnitOpBaseClassEquipmentTypes) |
| 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) |
| FixOnDeltaP | Gets or sets a value indicating whether the pump should fix the calculation on delta pressure rather than recalculating it from other specifications. |
| 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 has no dedicated dynamic-mode properties. (Overrides BaseClassHasPropertiesForDynamicMode) |
| Head | Gets or sets the pump head (pressure rise expressed as liquid column height, in m). |
| HeatDuty | Gets or sets the power consumed by the pump (kW). |
| Height | (Inherited from BaseClass) |
| IgnorePhase | Gets or sets a value indicating whether the pump ignores the phase check on the inlet stream, allowing calculation even when vapor is detected. |
| 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 that this pump unit operation is compatible with the DWSIM mobile platform. (Overrides BaseClassMobileCompatible) |
| Name |
Object's Unique ID (Name)
(Inherited from BaseClass) |
| NPSH | Gets or sets the available Net Positive Suction Head (NPSH) at the pump inlet (m). |
| ObjectClass | Gets or sets the simulation object class category (PressureChangers). (Overrides BaseClassObjectClass) |
| OutletTemperature | Gets or sets the calculated outlet temperature of the pump (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) |
| Pout | Gets or sets the calculated outlet pressure of the pump (Pa). |
| PreferredFlashAlgorithmTag | (Inherited from BaseClass) |
| PressureIncrease | Gets or sets the pressure rise across the pump (Pa). |
| 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) |
| PumpCurveSet | Gets or sets the performance curve set used when the Curves calculation mode is active. |
| PumpType | Gets or sets the pump equipment sub-type (e.g. "Centrifugal", "Gear"). |
| 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) |
| 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 across the pump (K). |
| 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 pump steady-state calculation. Determines outlet pressure, temperature,
enthalpy, power consumption, and NPSH based on the active CalcMode.
(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 pump object by round-tripping through JSON serialization. (Overrides BaseClassCloneJSON) |
| CloneXML | Creates a deep copy of this pump object by round-tripping through XML serialization. (Overrides BaseClassCloneXML) |
| CloseDynamicsEditForm | (Inherited from BaseClass) |
| CloseEditForm | Closes the pump property editor form if it is currently open. (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) |
| CreateDimensionsList | Initializes the physical dimensions list used for dynamic sizing and scaling of the pump. (Overrides UnitOpBaseClassCreateDimensionsList) |
| CreateDynamicProperties | (Inherited from BaseClass) |
| CreateNew | (Inherited from BaseClass) |
| DeCalculate | Resets the outlet material stream and connected energy stream to an uncalculated state. (Overrides UnitOpBaseClassDeCalculate) |
| DeCalculate(Object) | (Inherited from BaseClass) |
| DisplayDynamicsEditForm | (Inherited from BaseClass) |
| DisplayEditForm | Opens the pump property editor form, or activates it if it is already open. (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 the available calculation mode names and their IDs for this unit operation. (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 description string for the pump unit operation. (Overrides BaseClassGetDisplayDescription) |
| GetDisplayName | Returns the localized display name for the pump 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 bitmap icon used to represent the pump on the flowsheet canvas. (Overrides BaseClassGetIconBitmap) |
| GetIconBitmapBytes | Returns the raw bytes of the pump icon image for serialization or transfer purposes. (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 all property identifiers supported by this pump for the given property type. (Overrides BaseClassGetProperties(PropertyType)) |
| GetProperties2 | (Inherited from BaseClass) |
| GetPropertyDescription | Returns a user-friendly description for a named pump property, used in property grids and tooltips. (Overrides BaseClassGetPropertyDescription(String)) |
| GetPropertyUnit | Returns the display unit string for the specified property. (Overrides BaseClassGetPropertyUnit(String, IUnitsOfMeasure)) |
| GetPropertyUnits2 | (Inherited from BaseClass) |
| GetPropertyValue | Returns the value of the specified property, converted to the given unit system. (Overrides UnitOpBaseClassGetPropertyValue(String, IUnitsOfMeasure)) |
| GetPropertyValue2 | (Inherited from BaseClass) |
| GetReport | Generates a plain-text results report for this pump, including inlet conditions and calculated results. (Overrides BaseClassGetReport(IUnitsOfMeasure, CultureInfo, String)) |
| GetStructuredReport |
Generates a structured report for this pump as a list of typed report items,
suitable for rendering in tabular or hierarchical UI components.
(Overrides BaseClassGetStructuredReport) |
| GetVersion | (Inherited from BaseClass) |
| IsDynamicProperty | (Inherited from BaseClass) |
| LoadData | Restores the pump's state from a list of XML elements, including legacy curve data. (Overrides UnitOpBaseClassLoadData(ListXElement)) |
| ObjectCopy | (Inherited from BaseClass) |
| PerformPostCalcValidation | (Inherited from BaseClass) |
| RemoveDynamicProperty | (Inherited from BaseClass) |
| RemoveExtraProperty | (Inherited from BaseClass) |
| RunDynamicModel | Executes the pump calculation in dynamic simulation mode. (Overrides BaseClassRunDynamicModel) |
| SaveData | Serializes the pump's state to a list of XML elements. (Overrides UnitOpBaseClassSaveData) |
| SetCalculationMode | Sets the active calculation mode 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 physical dimensions list with the current calculated values from the pump. (Overrides UnitOpBaseClassUpdateDimensionsList) |
| UpdateDynamicsEditForm | (Inherited from BaseClass) |
| UpdateEditForm | Refreshes the pump editor form with the latest calculated values, if it is 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) |
| _curveeff | |
| _curveflow | |
| _curvehead | |
| _curvenpsh | |
| _curvepower | |
| _curvesyshead | |
| _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_cmode | |
| m_dp | |
| m_DQ | |
| m_dt | |
| m_eta | |
| m_FixOnDeltaP | |
| m_flowsheet | (Inherited from BaseClass) |
| m_ignorephase | |
| m_npsh | |
| m_pout |
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) |