Filter Class
Represents a continuous cake filter unit operation that separates solids from a liquid
stream. The calculation is based on the cake filter equations from McCabe, Smith and
Harriott, "Unit Operations of Chemical Engineering", Chapter 29. Solids removal
efficiency is governed by the specified cake relative humidity, filter area, and
operating parameters.
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 Filter : UnitOpBaseClassVB
<SerializableAttribute>
Public Class Filter
Inherits UnitOpBaseClass- Inheritance
- Object BaseClass UnitOpBaseClass Filter
Constructors
| Filter | Initializes a new instance of the Filter class with default settings. |
| Filter(String, String) | Initializes a new instance of the Filter class with the specified 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) |
| CakeRelativeHumidity | Gets or sets the relative humidity of the discharged cake as a percentage (%). |
| CalcMode | Gets or sets the calculation mode (Design or Simulation). |
| 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) |
| 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.
(Inherited from UnitOpBaseClass) |
| DynamicsOnly | (Inherited from BaseClass) |
| DynamicsSpec | (Inherited from BaseClass) |
| EnergyFlow |
Energy Flow property. Only implemented for Energy Streams.
(Inherited from BaseClass) |
| EnergyImb | Gets or sets the energy imbalance across the filter (kW). |
| EquipmentTypes | Gets the list of supported equipment types 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) |
| FilterCycleTime | Gets or sets the filter cycle time (s). |
| FilterMediumResistance | Gets or sets the filter medium resistance (1/m). |
| 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 | 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 for this unit operation. (Overrides BaseClassObjectClass) |
| 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) |
| PreferredFlashAlgorithmTag | (Inherited from BaseClass) |
| PressureDrop | Gets or sets the total pressure drop across the filter (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) |
| Right | (Inherited from BaseClass) |
| SelectedEquipmentType |
Gets or sets the name of the equipment type currently selected for this unit operation.
(Inherited from UnitOpBaseClass) |
| SpecificCakeResistance | Gets or sets the specific cake resistance (m/kg). |
| 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) |
| SubmergedAreaFraction | Gets or sets the fraction of the filter area that is submerged during filtration (dimensionless, 0 to 1). |
| SupportsDynamicMode | (Inherited from BaseClass) |
| 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) |
| Top | (Inherited from BaseClass) |
| TotalFilterArea | Gets or sets the total filter area (m²). |
| 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 filter separation results. (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 |
Initializes the list of equipment dimensions for this unit operation.
Override to populate the Dimensions collection with dimension entries.
(Inherited from UnitOpBaseClass) |
| CreateDynamicProperties | (Inherited from BaseClass) |
| 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 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 |
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 | (Inherited from BaseClass) |
| 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 filter results. (Overrides BaseClassGetReport(IUnitsOfMeasure, CultureInfo, String)) |
| GetStructuredReport | (Inherited from BaseClass) |
| GetVersion | (Inherited from BaseClass) |
| IsDynamicProperty | (Inherited from BaseClass) |
| LoadData | Loads object data from a list of XML elements. (Overrides UnitOpBaseClassLoadData(ListXElement)) |
| ObjectCopy | (Inherited from BaseClass) |
| PerformPostCalcValidation | (Inherited from BaseClass) |
| RemoveDynamicProperty | (Inherited from BaseClass) |
| RemoveExtraProperty | (Inherited from BaseClass) |
| RunDynamicModel | (Inherited from BaseClass) |
| SaveData | Saves object data to a list of XML elements for serialization. (Overrides UnitOpBaseClassSaveData) |
| 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) |
| 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 equipment dimensions list after a successful calculation.
Override to refresh computed dimension values.
(Inherited from UnitOpBaseClass) |
| 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) |
| CalculationRoutineOverride | (Inherited from BaseClass) |
| disposedValue | (Inherited from BaseClass) |
| ExtraPropertiesEditor | (Inherited from BaseClass) |
| f | |
| fd | (Inherited from BaseClass) |
| LaunchExternalPropertyEditor | (Inherited from BaseClass) |
| m_ei | |
| 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) |