Unit
Abstract base class for all DWSIM unit operation simulation objects.
Provides CAPE-OPEN identification, property package management, persistence,
debug reporting, and dynamic simulation support.
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]
[ComVisibleAttribute(true)]
public abstract class UnitOpBaseClass : BaseClass,
ICapeIdentification, IUnitOperationVB
<SerializableAttribute>
<ComVisibleAttribute(true)>
Public MustInherit Class UnitOpBaseClass
Inherits BaseClass
Implements ICapeIdentification, IUnitOperation- Derived
- Implements
- ICapeIdentification, IUnitOperation
Constructors
| UnitOpBaseClass | Initializes a new instance of UnitOpBaseClass and sets up the dimensions list. |
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) |
| CanUsePreviousResults | (Inherited from BaseClass) |
| ComponentDescription |
Gets or sets the CAPE-OPEN component description for this unit operation.
(Overrides BaseClassComponentDescription) |
| ComponentName |
Gets or sets the CAPE-OPEN component name for this unit operation.
(Overrides BaseClassComponentName) |
| CreateChartAction | (Inherited from BaseClass) |
| DebugMode | (Inherited from BaseClass) |
| DebugText | (Inherited from BaseClass) |
| DetailedDebugReport | (Inherited from BaseClass) |
| Dimensions | Gets or sets the list of physical dimensions (e.g. vessel diameter, length) associated with this unit operation. |
| 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 available equipment type names supported by this unit operation. |
| 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. |
| ExternalSolverID | Gets or sets the unique identifier of an external solver to be used for this unit operation. |
| 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 | (Inherited from BaseClass) |
| 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) |
| MobileCompatible | (Inherited from BaseClass) |
| Name |
Object's Unique ID (Name)
(Inherited from BaseClass) |
| ObjectClass | (Inherited from BaseClass) |
| OverrideCalculationRoutine | (Inherited from BaseClass) |
| ParticleSizeDistributions | Gets or sets the dictionary of particle size distribution data, keyed by compound or stream name. |
| Phases |
Phase collection, only implemented for Material Streams.
(Inherited from BaseClass) |
| PreferredFlashAlgorithmTag | (Inherited from BaseClass) |
| 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.
(Overrides BaseClassPropertyPackage) |
| Right | (Inherited from BaseClass) |
| SelectedEquipmentType | Gets or sets the name of the equipment type currently selected for this unit operation. |
| 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 | (Inherited from BaseClass) |
| SupportsParticleSizeDistributions | Gets a value indicating whether this unit operation supports particle size distribution calculations. |
| SupportsRestoreStateAfterError | Gets a value indicating whether this unit operation supports restoring its state after a solver error. |
| 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 |
Calculates the object.
(Inherited from BaseClass) |
| CheckDirtyStatus |
Checks whether the unit operation's input data has changed since the last successful solve,
and updates the dirty flag accordingly.
(Overrides BaseClassCheckDirtyStatus) |
| 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.
(Overrides BaseClassClearPropertyPackageInstance) |
| Clone |
Clones the current object, returning a new one with identical properties.
(Inherited from BaseClass) |
| CloneJSON | (Inherited from BaseClass) |
| CloneXML | (Inherited from BaseClass) |
| CloseDynamicsEditForm | (Inherited from BaseClass) |
| CloseEditForm | (Inherited from BaseClass) |
| 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 list of equipment dimensions for this unit operation. Override to populate the Dimensions collection with dimension entries. |
| CreateDynamicProperties | (Inherited from BaseClass) |
| CreateNew | (Inherited from BaseClass) |
| DeCalculate | Decalculates the object. |
| DeCalculate(Object) | (Inherited from BaseClass) |
| DisplayDynamicsEditForm | (Inherited from BaseClass) |
| DisplayEditForm | (Inherited from BaseClass) |
| 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. |
| 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.
(Overrides BaseClassGetDebugReport) |
| GetDebugWriter | (Inherited from BaseClass) |
| GetDefaultProperties | (Inherited from BaseClass) |
| GetDisplayDescription | (Inherited from BaseClass) |
| GetDisplayName | (Inherited from BaseClass) |
| GetDynamicContents |
Returns the current mass held in the accumulation stream of this unit operation.
(Overrides BaseClassGetDynamicContents) |
| 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.
(Overrides BaseClassGetDynamicResidenceTime) |
| GetDynamicVolume |
Returns the dynamic volume of this unit operation from its dynamic property store.
(Overrides BaseClassGetDynamicVolume) |
| 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.
(Overrides BaseClassGetEnergyConsumption) |
| GetExtraPropertyValue | (Inherited from BaseClass) |
| GetFlowsheet | (Inherited from BaseClass) |
| GetIconBitmap | (Inherited from BaseClass) |
| GetIconBitmapBytes | (Inherited from BaseClass) |
| GetKeyPropertyNames | Returns the names of the key output properties reported by this unit operation. |
| GetKeyPropertyUnits | Returns the display unit string for a named key property. |
| GetKeyPropertyValue | Returns the current numeric value of a named key property in SI units. |
| GetMassBalanceResidual | (Inherited from BaseClass) |
| GetPowerGeneratedOrConsumed | (Inherited from BaseClass) |
| GetPreferredGraphicObjectHeight | (Inherited from BaseClass) |
| GetPreferredGraphicObjectWidth | (Inherited from BaseClass) |
| GetProperties | (Inherited from BaseClass) |
| GetProperties2 | (Inherited from BaseClass) |
| GetPropertyDescription | (Inherited from BaseClass) |
| GetPropertyUnit | (Inherited from BaseClass) |
| GetPropertyUnits2 | (Inherited from BaseClass) |
| GetPropertyValue |
Returns the value of a named property, converting from SI to the current unit system.
Falls back to extra properties if the property is not found in the base implementation.
(Overrides BaseClassGetPropertyValue(String, IUnitsOfMeasure)) |
| GetPropertyValue2 | (Inherited from BaseClass) |
| GetReport | (Inherited from BaseClass) |
| GetStructuredReport | (Inherited from BaseClass) |
| GetVersion | (Inherited from BaseClass) |
| IsDynamicProperty | (Inherited from BaseClass) |
| LoadData |
Restores the unit operation state from a list of XML elements previously produced by SaveData.
(Overrides BaseClassLoadData(ListXElement)) |
| ObjectCopy | (Inherited from BaseClass) |
| PerformPostCalcValidation | (Inherited from BaseClass) |
| RemoveDynamicProperty | (Inherited from BaseClass) |
| RemoveExtraProperty | (Inherited from BaseClass) |
| RunDynamicModel | (Inherited from BaseClass) |
| SaveData |
Serializes the unit operation state to a list of XML elements for persistence.
(Overrides BaseClassSaveData) |
| SetCalculationMode | Sets the active calculation mode for this unit operation by numeric identifier. |
| 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. |
| SetPropertyPackageInstance |
Assigns an externally supplied property package instance to this unit operation,
bypassing the flowsheet-level property package lookup.
(Overrides BaseClassSetPropertyPackageInstance(IPropertyPackage)) |
| SetPropertyValue | (Inherited from BaseClass) |
| SetPropertyValue2 | (Inherited from BaseClass) |
| Solve |
Solves the unit operation, optionally saving and restoring state on error
when the flowsheet option RestoreUnitOperationStateAfterError is enabled.
(Overrides BaseClassSolve) |
| StoreDebugReport | (Inherited from BaseClass) |
| ToString | (Inherited from BaseClass) |
| TransferAdditionalSolidData | (Inherited from BaseClass) |
| Unsolve | Decalculates the object. |
| UpdateDimensionsList | Updates the equipment dimensions list after a successful calculation. Override to refresh computed dimension values. |
| UpdateDynamicsEditForm | (Inherited from BaseClass) |
| UpdateEditForm | (Inherited from BaseClass) |
| UpdateExtraPropertiesEditForm | (Inherited from BaseClass) |
| Validate |
Validates the object, checking its connections and other parameters.
(Inherited from BaseClass) |
Fields
| _CanUsePreviousResults | (Inherited from BaseClass) |
| _capeopenmode | |
| _IsDirty | (Inherited from BaseClass) |
| _pp | |
| _ppid | |
| _ppwasset | |
| AccumulationStream | |
| CalculationRoutineOverride | (Inherited from BaseClass) |
| disposedValue | (Inherited from BaseClass) |
| ExtraPropertiesEditor | (Inherited from BaseClass) |
| 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) |