Vessel Class
Represents a separator vessel unit operation that splits an inlet multi-phase stream
into separate vapour and liquid outlet streams. Supports two-phase and three-phase
operation, optional heat duty, and dynamic simulation.
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 Vessel : UnitOpBaseClassVB
<SerializableAttribute>
Public Class Vessel
Inherits UnitOpBaseClass- Inheritance
- Object BaseClass UnitOpBaseClass Vessel
Constructors
| Vessel | |
| Vessel | Initializes a new default instance of the Vessel class. |
| Vessel(String, String) | Initializes a new instance of the Vessel 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) |
| Calculated | (Inherited from BaseClass) |
| CalculateRigorousHeatBalance | Gets or sets whether a rigorous wall heat-balance is performed instead of the legacy adiabatic model. |
| CalculationMode | Gets or sets the active thermal calculation mode for the vessel. |
| 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) |
| DebugMode | (Inherited from BaseClass) |
| DebugText | (Inherited from BaseClass) |
| DeltaQ | Gets or sets the net heat duty (kW) added to or removed from the vessel content. Positive values indicate heating. |
| DetailedDebugReport | (Inherited from BaseClass) |
| DimensionRatio | Gets or sets the length-to-diameter ratio used to size the vessel geometry. |
| 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 vessel (Vertical, Horizontal). (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) |
| FlashPressure | Gets or sets the fixed vessel pressure (Pa) used when OverrideP is True. |
| FlashTemperature | Gets or sets the fixed vessel temperature (K) used when OverrideT is True. |
| 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 dedicated properties for dynamic mode configuration. (Overrides BaseClassHasPropertiesForDynamicMode) |
| HeadType | Gets or sets the head geometry type for sizing calculations (e.g. "Hemispherical", "Flat"). |
| HeadTypes | Gets the list of vessel head geometry types available for sizing calculations. |
| HeatingCoolingAmount | Gets or sets the fixed heating or cooling duty (kW) applied to the vessel content when the calculation mode requires it. |
| Height | (Inherited from BaseClass) |
| 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) |
| MaterialTypes | Gets the list of wall material names selectable for rigorous heat-balance calculations. |
| MobileCompatible | Gets a value indicating whether this unit operation is compatible with mobile interfaces. (Overrides BaseClassMobileCompatible) |
| Name |
Object's Unique ID (Name)
(Inherited from BaseClass) |
| ObjectClass | Gets or sets the simulation object class category for this vessel (Separators). (Overrides BaseClassObjectClass) |
| OverrideCalculationRoutine | (Inherited from BaseClass) |
| OverrideP | Gets or sets whether the vessel pressure is fixed to FlashPressure instead of being determined from the inlet streams. |
| OverrideT | Gets or sets whether the vessel temperature is fixed to FlashTemperature instead of being determined by the flash calculation. |
| 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) |
| PreferredFlashAlgorithmTag | (Inherited from BaseClass) |
| PressureCalculation | Gets or sets the rule used to determine the vessel operating pressure from the inlet stream pressures. |
| 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) |
| ResidenceTime | Gets or sets the required liquid residence time (minutes) used in vessel sizing. |
| 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) |
| SurgeFactor | Gets or sets the surge factor applied to the minimum vapour velocity when sizing the vessel. |
| ThermalProperties | Gets or sets the thermal property definitions used for the rigorous heat-balance model. |
| Top | (Inherited from BaseClass) |
| UserDefinedChartNames | (Inherited from BaseClass) |
| Visible | (Inherited from BaseClass) |
| WallMaterial | Gets or sets the vessel wall material name. Used to look up thermal conductivity in rigorous mode. |
| WallTemperature | Gets or sets the ambient/external wall temperature (K) for rigorous heat-balance calculations. |
| WallThickness | Gets or sets the vessel wall thickness in metres. Used in rigorous heat-balance and sizing calculations. |
| Width | (Inherited from BaseClass) |
Methods
| AddButtonsToDynEditor | |
| AddDynamicProperty | (Inherited from BaseClass) |
| AddExtraProperty | (Inherited from BaseClass) |
| AppendDebugLine | (Inherited from BaseClass) |
| CalcOverallExternalHeatTransferCoefficient | |
| CalcOverallInternalHeatTransferCoefficient | |
| Calculate | Calculates the gas-liquid separation vessel (flash drum). (Overrides BaseClassCalculate(Object)) |
| CalculateVolume | Computes the internal volume of the vessel (m³) based on either the user-entered value or the configured geometry (diameter, length, and head type) from the dimensions list. |
| 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 vessel via JSON serialization. (Overrides BaseClassCloneJSON) |
| CloneXML | Creates a deep copy of this vessel via XML serialization. (Overrides BaseClassCloneXML) |
| CloseDynamicsEditForm | (Inherited from BaseClass) |
| CloseEditForm | Closes and disposes the editing form. (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 | Creates the dimensions list (Diameter, Length) used for vessel sizing calculations. (Overrides UnitOpBaseClassCreateDimensionsList) |
| CreateDynamicProperties |
Registers the dynamic properties that are exposed in dynamic simulation mode,
such as vessel orientation, operating pressure, liquid level, volume, and height.
(Overrides BaseClassCreateDynamicProperties) |
| CreateNew | (Inherited from BaseClass) |
| DeCalculate | Clears all calculated results. (Overrides UnitOpBaseClassDeCalculate) |
| DeCalculate(Object) | (Inherited from BaseClass) |
| DisplayDynamicsEditForm |
Opens or activates the dynamics property editor form for this vessel,
including buttons to view the accumulation stream and to fill the vessel from an inlet stream.
(Overrides BaseClassDisplayDynamicsEditForm) |
| DisplayEditForm | Opens or activates the editing form. (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 list of available calculation mode names for this unit operation.
(Inherited from UnitOpBaseClass) |
| 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 localised display description. (Overrides BaseClassGetDisplayDescription) |
| GetDisplayName | Returns the localised display name. (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 |
Calculates the theoretical residence time (s) of fluid in the vessel by dividing the
vessel volume by the total volumetric inlet flow rate.
Returns Double if the calculation cannot be performed.
(Overrides UnitOpBaseClassGetDynamicResidenceTime) |
| GetDynamicVolume | Returns the dynamic simulation volume of the vessel by delegating to CalculateVolume. (Overrides UnitOpBaseClassGetDynamicVolume) |
| 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. (Overrides BaseClassGetIconBitmap) |
| GetIconBitmapBytes | Returns the icon bitmap as a byte array. (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 an array of property identifiers for the specified property type. (Overrides BaseClassGetProperties(PropertyType)) |
| GetProperties2 | (Inherited from BaseClass) |
| GetPropertyDescription | Returns a human-readable description of the specified property. (Overrides BaseClassGetPropertyDescription(String)) |
| GetPropertyUnit | Returns the unit string for the specified property. (Overrides BaseClassGetPropertyUnit(String, IUnitsOfMeasure)) |
| GetPropertyUnits2 | (Inherited from BaseClass) |
| GetPropertyValue | Returns the value of the specified property. (Overrides UnitOpBaseClassGetPropertyValue(String, IUnitsOfMeasure)) |
| GetPropertyValue2 | (Inherited from BaseClass) |
| GetReport | Generates a plain-text report of the vessel results. (Overrides BaseClassGetReport(IUnitsOfMeasure, CultureInfo, String)) |
| GetRugosity | Returns the pipe-wall rugosity (m) for the given material name. |
| GetStructuredReport | (Inherited from BaseClass) |
| GetVersion | (Inherited from BaseClass) |
| IsDynamicProperty | (Inherited from BaseClass) |
| Kwall | |
| LoadData |
Restores the unit operation state from a list of XML elements previously produced by SaveData.
(Inherited from UnitOpBaseClass) |
| ObjectCopy | (Inherited from BaseClass) |
| PerformPostCalcValidation | (Inherited from BaseClass) |
| RemoveDynamicProperty | (Inherited from BaseClass) |
| RemoveExtraProperty | (Inherited from BaseClass) |
| RunDynamicModel |
Executes one dynamic simulation step for the vessel: integrates inlet and outlet mass flows
over the current time step, updates the accumulation stream, and flashes the vessel content
to determine the outlet stream conditions.
(Overrides BaseClassRunDynamicModel) |
| SaveData |
Serializes the unit operation state to a list of XML elements for persistence.
(Inherited from UnitOpBaseClass) |
| SetCalculationMode |
Sets the active calculation mode for this unit operation by numeric identifier.
(Inherited from UnitOpBaseClass) |
| 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. (Overrides BaseClassSetPropertyValue(String, Object, IUnitsOfMeasure)) |
| SetPropertyValue2 | (Inherited from BaseClass) |
| SizeHorizontal | Sizes the vessel in horizontal orientation using the calculated flow rates and settling velocity. |
| SizeVertical | Sizes the vessel in vertical orientation using the calculated flow rates and settling velocity. |
| 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 Diameter and Length dimension values from the last sizing calculation results. (Overrides UnitOpBaseClassUpdateDimensionsList) |
| UpdateDynamicsEditForm | (Inherited from BaseClass) |
| UpdateEditForm | Refreshes the editing form with updated data. (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) |
| AH | |
| AV | |
| BeH | |
| BeV | |
| BSGH | |
| BSGV | |
| BSLH | |
| BSLV | |
| C | |
| CalculationRoutineOverride | (Inherited from BaseClass) |
| currentM | |
| DH | |
| disposedValue | (Inherited from BaseClass) |
| DV | |
| ExtraPropertiesEditor | (Inherited from BaseClass) |
| f | |
| fd | (Inherited from BaseClass) |
| K | |
| LaunchExternalPropertyEditor | (Inherited from BaseClass) |
| m_DQ | |
| m_flowsheet | (Inherited from BaseClass) |
| MixedStream | |
| prevM | |
| qe | |
| ql | |
| qv | |
| rhoe | |
| rhol | |
| rhov | |
| VGI | |
| VMAX | |
| wl | |
| wv |
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) |