Heat
Represents a heat exchanger unit operation that transfers thermal energy between
a hot-side and a cold-side material stream. Supports counter-current and co-current
flow, multiple calculation modes (outlet temperature, UA, area, rating, pinch-point,
thermal efficiency), optional shell-and-tube geometry, 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 HeatExchanger : UnitOpBaseClass,
IHeatExchangerVB
<SerializableAttribute>
Public Class HeatExchanger
Inherits UnitOpBaseClass
Implements IHeatExchanger- Inheritance
- Object BaseClass UnitOpBaseClass HeatExchanger
- Implements
- IHeatExchanger
Constructors
| HeatExchanger | Initializes a new default instance. |
| HeatExchanger(String, String) | Initializes a new instance 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) |
| Area | Gets or sets the heat-transfer area (m�), nullable. |
| Area1 | Gets or sets the heat-transfer area (m�) used by the IHeatExchanger interface. |
| 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) |
| CalculatedMITA | Gets or sets the calculated minimum internal temperature approach (K) from the last simulation run. |
| CalculateHeatExchangeProfile | Gets or sets whether a detailed heat-exchange profile should be calculated along the exchanger length. |
| CalculationMode | Gets or sets the heat-exchanger calculation mode (e.g. CalcBothTemp, CalcArea). |
| CanUsePreviousResults | (Inherited from BaseClass) |
| ColdSideOutletTemperature | Gets or sets the calculated cold-side outlet temperature (K). |
| ColdSidePressureDrop | Gets or sets the pressure drop on the cold side (Pa). |
| ColdSideTemperatureChange | Gets or sets the temperature change on the cold side (K). |
| 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) |
| CorrectionFactorLMTD | Gets or sets the LMTD correction factor applied to the log-mean temperature difference. |
| CreateChartAction | (Inherited from BaseClass) |
| DebugMode | (Inherited from BaseClass) |
| DebugText | (Inherited from BaseClass) |
| DefinedTemperature | Gets or sets which fluid side has its outlet temperature explicitly specified by the user. |
| DeltaP | Gets or sets the overall pressure drop across the exchanger (Pa), nullable. |
| 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 thermal efficiency (interface proxy for ThermalEfficiency). |
| EnergyFlow |
Energy Flow property. Only implemented for Energy Streams.
(Inherited from BaseClass) |
| EquipmentTypes | Gets the list of equipment sub-types available for this heat exchanger. (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) |
| FlowDir | Gets or sets the relative flow direction of the two fluid streams (counter-current or co-current). |
| 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. (Overrides BaseClassHasPropertiesForDynamicMode) |
| HeatDuty | Gets or sets the heat duty (kW) exchanged between the two streams. Proxy for the internal Q property. |
| HeatLoss | Gets or sets the fractional heat loss to the environment (kW). |
| HeatProfile | Gets or sets the heat duty profile along the exchanger length (kW at each discretisation point). |
| Height | (Inherited from BaseClass) |
| HotSideOutletTemperature | Gets or sets the calculated hot-side outlet temperature (K). |
| HotSidePressureDrop | Gets or sets the pressure drop on the hot side (Pa). |
| HotSideTemperatureChange | Gets or sets the temperature change on the hot side (K). |
| IgnoreLMTDError | Gets or sets whether negative LMTD (temperature cross) errors are suppressed instead of throwing. |
| 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) |
| LMTD | Gets or sets the calculated log-mean temperature difference (K). |
| LMTD_F | Gets or sets the calculated LMTD correction factor (F) for multi-pass exchangers. |
| MaxHeatExchange | Gets or sets the maximum thermodynamically possible heat exchange (kW) between the two streams. |
| MITA | Gets or sets the specified minimum internal temperature approach (MITA / pinch) in K. |
| 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 (Exchangers). (Overrides BaseClassObjectClass) |
| OutletVaporFraction1 | Gets or sets the target vapour fraction for the hot-side outlet when using OutletVaporFraction1. |
| OutletVaporFraction2 | Gets or sets the target vapour fraction for the cold-side outlet when using OutletVaporFraction2. |
| OverallCoefficient | Gets or sets the overall heat-transfer coefficient (W/(m��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) |
| PinchPointAtOutlets | Gets or sets whether the pinch-point specification applies at the exchanger outlets rather than internally. |
| 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.
(Inherited from UnitOpBaseClass) |
| Q | Gets or sets the heat duty (W), nullable. |
| 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) |
| STProperties | Gets or sets the shell-and-tube heat exchanger geometry and physical properties used when ShellandTube_Rating is selected. |
| 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) |
| TemperatureProfileCold | Gets or sets the cold-side temperature profile along the exchanger length (K). |
| TemperatureProfileHot | Gets or sets the hot-side temperature profile along the exchanger length (K). |
| ThermalEfficiency | Gets or sets the thermal efficiency (0�1) when using ThermalEfficiency mode. |
| Top | (Inherited from BaseClass) |
| UserDefinedChartNames | (Inherited from BaseClass) |
| UseShellAndTubeGeometryInformation | Gets or sets whether shell-and-tube geometry information is used for heat-transfer coefficient estimation. |
| Visible | (Inherited from BaseClass) |
| Width | (Inherited from BaseClass) |
Methods
| AddDynamicProperty | (Inherited from BaseClass) |
| AddExtraProperty | (Inherited from BaseClass) |
| AppendDebugLine | (Inherited from BaseClass) |
| Calculate | Calculates the heat-exchanger performance for the selected calculation mode. (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 via JSON serialization. (Overrides BaseClassCloneJSON) |
| CloneXML | Creates a deep copy 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 (Area) for this heat exchanger. (Overrides UnitOpBaseClassCreateDimensionsList) |
| CreateDynamicProperties | Creates additional properties for dynamic simulation mode. (Overrides BaseClassCreateDynamicProperties) |
| CreateNew | (Inherited from BaseClass) |
| DeCalculate | Clears all calculated results. (Overrides UnitOpBaseClassDeCalculate) |
| DeCalculate(Object) | (Inherited from BaseClass) |
| DisplayDynamicsEditForm | (Inherited from BaseClass) |
| 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 an array of strings describing all available calculation modes for this heat exchanger. (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 | Returns the default set of properties shown in the flowsheet inspector. (Overrides BaseClassGetDefaultProperties) |
| 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 |
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. (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 heat-exchanger results. (Overrides BaseClassGetReport(IUnitsOfMeasure, CultureInfo, String)) |
| GetStructuredReport | Returns a structured (table-based) report of the heat-exchanger results. (Overrides BaseClassGetStructuredReport) |
| GetVersion | (Inherited from BaseClass) |
| IsDynamicProperty | (Inherited from BaseClass) |
| LoadData |
Restores the heat exchanger state from a list of XML elements, handling backward-compatible
renames and deserialising dynamic accumulation streams.
(Overrides UnitOpBaseClassLoadData(ListXElement)) |
| ObjectCopy | (Inherited from BaseClass) |
| PerformPostCalcValidation | (Inherited from BaseClass) |
| RemoveDynamicProperty | (Inherited from BaseClass) |
| RemoveExtraProperty | (Inherited from BaseClass) |
| RunDynamicModel | Performs the dynamic-mode calculation for the heat exchanger. (Overrides BaseClassRunDynamicModel) |
| SaveData |
Serializes the heat exchanger state, including hot- and cold-side dynamic accumulation
streams, into a list of XML elements.
(Overrides UnitOpBaseClassSaveData) |
| SetCalculationMode | Sets the active calculation mode for the heat exchanger using a numeric identifier. (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. (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 Area dimension value from the current calculated area. (Overrides UnitOpBaseClassUpdateDimensionsList) |
| UpdateDynamicsEditForm | (Inherited from BaseClass) |
| UpdateEditForm | Refreshes the editing form with updated data. (Overrides BaseClassUpdateEditForm) |
| UpdateExtraPropertiesEditForm | (Inherited from BaseClass) |
| Validate | Validates the heat-exchanger configuration and stream connections. (Overrides BaseClassValidate) |
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) |
| AccumulationStreamCold | |
| AccumulationStreamHot | |
| CalcMode | |
| CalculationRoutineOverride | (Inherited from BaseClass) |
| currentMCold | |
| currentMHot | |
| disposedValue | (Inherited from BaseClass) |
| ExtraPropertiesEditor | (Inherited from BaseClass) |
| f | |
| fd | (Inherited from BaseClass) |
| FoulingFactor | |
| LaunchExternalPropertyEditor | (Inherited from BaseClass) |
| m_Area | |
| m_ColdSidePressureDrop | |
| m_dp | |
| m_f | |
| m_flowdirection | |
| m_flowsheet | (Inherited from BaseClass) |
| m_HotSidePressureDrop | |
| m_OverallCoefficient | |
| m_Q | |
| m_specifiedtemperature | |
| m_stprops | |
| m_tempdiff | |
| prevMCold | |
| prevMHot | |
| TempColdOut | |
| TempHotOut | |
| Type |
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) |