Flowsheet
Definition
Namespace: DWSIM.Automation
Assembly: DWSIM.Automation (in DWSIM.Automation.dll) Version: 10.0.0.0
Assembly: DWSIM.Automation (in DWSIM.Automation.dll) Version: 10.0.0.0
C#
[GuidAttribute("474a8e52-0b3e-48cb-a3bb-aae60f843578")]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
[ComVisibleAttribute(true)]
public class Flowsheet2 : FlowsheetBaseVB
<GuidAttribute("474a8e52-0b3e-48cb-a3bb-aae60f843578")>
<ClassInterfaceAttribute(ClassInterfaceType.None)>
<ComVisibleAttribute(true)>
Public Class Flowsheet2
Inherits FlowsheetBase- Inheritance
- Object FlowsheetBase Flowsheet2
Constructors
Properties
| AvailableCompounds | (Inherited from FlowsheetBase) |
| AvailableExternalUnitOperations | (Inherited from FlowsheetBase) |
| AvailablePropertyPackages | Gets or sets the dictionary of property packages available for selection in this flowsheet instance. (Inherited from FlowsheetBase) |
| AvailableSimulationObjects | (Inherited from FlowsheetBase) |
| AvailableSystemsOfUnits | Gets or sets the list of unit-of-measure systems available for this flowsheet. (Inherited from FlowsheetBase) |
| CalculationQueue | Gets or sets the FIFO queue of pending calculation requests consumed by the flowsheet solver. (Inherited from FlowsheetBase) |
| Charts | (Inherited from FlowsheetBase) |
| DynamicMode | Gets or sets a value indicating whether the flowsheet is operating in dynamic simulation mode. (Inherited from FlowsheetBase) |
| DynamicsManager | Gets or sets the dynamics manager responsible for dynamic simulation scheduling and event handling. (Inherited from FlowsheetBase) |
| ErrorMessage | (Inherited from FlowsheetBase) |
| ErrorMessages | Gets or sets the list of exceptions raised during the last calculation pass. (Inherited from FlowsheetBase) |
| ExternalSolvers | (Inherited from FlowsheetBase) |
| ExternalUnitOperations | Gets or sets the dictionary of external (plugin-defined) unit operations registered with this flowsheet. (Inherited from FlowsheetBase) |
| ExtraProperties | Gets or sets a dynamic property bag for attaching arbitrary extra data to the flowsheet at runtime. (Inherited from FlowsheetBase) |
| FileDatabaseProvider | (Inherited from FlowsheetBase) |
| FilePath | Gets or sets the full file path of the simulation file on disk. (Inherited from FlowsheetBase) |
| FlowsheetOptions | Gets the flowsheet configuration options (units, compounds, property packages, solver settings). (Inherited from FlowsheetBase) |
| GHGEmissionCompositions | Gets or sets the dictionary of GHG emission compositions associated with streams in this flowsheet. (Inherited from FlowsheetBase) |
| GraphicObjects | Gets or sets the dictionary of all graphic objects currently placed on the flowsheet surface, keyed by unique ID. (Inherited from FlowsheetBase) |
| InternalUnitOperations | Gets or sets the dictionary of internal unit operations registered with this flowsheet. (Inherited from FlowsheetBase) |
| LastSuccessfulSolutionState | (Inherited from FlowsheetBase) |
| MasterFlowsheet | (Inherited from FlowsheetBase) |
| MasterUnitOp | (Inherited from FlowsheetBase) |
| Message | (Inherited from FlowsheetBase) |
| MessagesLog | Gets or sets the list of informational and diagnostic messages generated during simulation. (Inherited from FlowsheetBase) |
| MobileCompatibilityMode | (Inherited from FlowsheetBase) |
| Options | (Inherited from FlowsheetBase) |
| ParticleSizeDistributions | (Inherited from FlowsheetBase) |
| PropertyPackages | Gets or sets the dictionary of property packages attached to this flowsheet, keyed by unique ID. (Inherited from FlowsheetBase) |
| PythonPreprocessor | (Inherited from FlowsheetBase) |
| Reactions | Gets or sets the dictionary of reactions defined for this flowsheet, keyed by unique ID. (Inherited from FlowsheetBase) |
| ReactionSets | Gets or sets the dictionary of reaction sets (groups of reactions) defined for this flowsheet, keyed by name. (Inherited from FlowsheetBase) |
| RedirectMessages | Gets or sets a value indicating whether flowsheet messages should be redirected to an external listener instead of the UI log. (Inherited from FlowsheetBase) |
| Results | (Inherited from FlowsheetBase) |
| ScriptKeywordsF | Gets or sets custom script keyword definitions for flowsheet-level scripts. (Inherited from FlowsheetBase) |
| ScriptKeywordsU | Gets or sets custom script keyword definitions for user-defined unit operation scripts. (Inherited from FlowsheetBase) |
| Scripts | (Inherited from FlowsheetBase) |
| SelectedCompounds | Gets or sets the ordered dictionary of compounds currently selected for this flowsheet, sorted according to the configured ordering mode. (Inherited from FlowsheetBase) |
| SimulationObjects | Gets or sets the dictionary of all simulation objects in this flowsheet, keyed by unique ID. (Inherited from FlowsheetBase) |
| Solved | (Inherited from FlowsheetBase) |
| StoredSolutions | (Inherited from FlowsheetBase) |
| SupressDataLoading | Gets or sets a value indicating whether data loading is suppressed during deserialization. (Inherited from FlowsheetBase) |
| SupressMessages | (Overrides FlowsheetBaseSupressMessages) |
| UtilityPlugins | (Inherited from FlowsheetBase) |
| WatchItems | (Inherited from FlowsheetBase) |
| WeatherProvider | Gets or sets the weather data provider used for ambient condition lookups. (Inherited from FlowsheetBase) |
Methods
| AddCompound | (Inherited from FlowsheetBase) |
| AddCompoundsToMaterialStream |
Adds all compounds currently selected in the flowsheet to all phases of the given material stream,
then equalises the overall composition and recalculates mass fractions.
(Inherited from FlowsheetBase) |
| AddConnectedObjects |
Automatically creates and connects material/energy streams around the specified object according to the given scheme.
(Inherited from FlowsheetBase) |
| AddDefaultProperties | (Inherited from FlowsheetBase) |
| AddExternalUOs | (Inherited from FlowsheetBase) |
| AddFlowsheetObject | Creates a simulation object by type name at the default position (50, 50) and assigns the given object name. (Inherited from FlowsheetBase) |
| AddGraphicObject | Adds a graphic object to both the drawing surface and the GraphicObjects dictionary. (Inherited from FlowsheetBase) |
| AddGraphicObjects | (Inherited from FlowsheetBase) |
| AddObject(ObjectType, Int32, Int32, String) | Creates a simulation object of the specified type, places its graphic on the surface, and returns the new object. (Inherited from FlowsheetBase) |
| AddObject(ObjectType, Int32, Int32, String, String) | Creates a simulation object with an explicit ID, places its graphic on the surface, and returns the new object. (Inherited from FlowsheetBase) |
| AddObject(String, Int32, Int32, String, String, Boolean) |
Creates a simulation object identified by its human-readable type name and places it on the flowsheet surface.
(Inherited from FlowsheetBase) |
| AddObjectToSurface |
Low-level method that instantiates the graphic and simulation objects for a given ObjectType,
adds them to the drawing surface and the SimulationObjects dictionary, and returns the new object's ID.
(Inherited from FlowsheetBase) |
| AddPropertyPackage | Registers a property package with the flowsheet, assigning a unique ID and tag if not already set. (Inherited from FlowsheetBase) |
| AddReaction | (Inherited from FlowsheetBase) |
| AddReactionSet | (Inherited from FlowsheetBase) |
| AddReactionToSet | (Inherited from FlowsheetBase) |
| AddSimulationObject | Adds a simulation object directly to the SimulationObjects dictionary without creating a graphic counterpart. (Inherited from FlowsheetBase) |
| AddSimulationObjects | (Inherited from FlowsheetBase) |
| AddTables | (Inherited from FlowsheetBase) |
| AddUndoRedoAction | (Inherited from FlowsheetBase) |
| AutoLayout | (Inherited from FlowsheetBase) |
| ChangeCalculationOrder | (Inherited from FlowsheetBase) |
| CheckStatus | Checks whether the flowsheet solver should pause or abort the current calculation, e.g. on user request. (Inherited from FlowsheetBase) |
| CheckTag | (Inherited from FlowsheetBase) |
| ClearLog | (Inherited from FlowsheetBase) |
| Clone | (Overrides FlowsheetBaseClone) |
| CloseOpenEditForms | (Overrides FlowsheetBaseCloseOpenEditForms) |
| Connect |
Connects two simulation objects. If both are unit operations, an intermediate material stream is
created automatically and positioned between them.
(Inherited from FlowsheetBase) |
| ConnectObject | (Inherited from FlowsheetBase) |
| ConnectObjects | Connects two graphic objects via their connector ports and registers an undo snapshot. (Inherited from FlowsheetBase) |
| CopyObjects | (Inherited from FlowsheetBase) |
| CreateAndAddPropertyPackage | (Inherited from FlowsheetBase) |
| CreateConversionReaction |
Creates a conversion reaction
(Inherited from FlowsheetBase) |
| CreateEquilibriumReaction |
Creates an equilibrium reaction
(Inherited from FlowsheetBase) |
| CreateHetCatReaction |
creates a heterogeneous catalytic reaction
(Inherited from FlowsheetBase) |
| CreateKineticReaction |
creates a kinetic reaction
(Inherited from FlowsheetBase) |
| CreatePropertyPackage | (Inherited from FlowsheetBase) |
| CreateReactionSet | (Inherited from FlowsheetBase) |
| CutObjects | (Inherited from FlowsheetBase) |
| DeleteObject | (Inherited from FlowsheetBase) |
| DeleteSelectedObject |
Removes a graphic object and its associated simulation object from the flowsheet,
automatically disconnecting all attached connectors and cleaning up spec/adjust references.
(Inherited from FlowsheetBase) |
| Disconnect | Disconnects two previously connected simulation objects via their graphic representations. (Inherited from FlowsheetBase) |
| DisconnectObjects | Disconnects two previously connected graphic objects and registers an undo snapshot. (Inherited from FlowsheetBase) |
| DisplayBrowserWindow | (Inherited from FlowsheetBase) |
| DisplayDockableBrowserWindow | (Inherited from FlowsheetBase) |
| DisplayForm | (Overrides FlowsheetBaseDisplayForm(Object)) |
| GenerateReport | |
| GetApplicationObject | (Overrides FlowsheetBaseGetApplicationObject) |
| GetAvailableFlowsheetObjectTypeNames | Returns a sorted array of all built-in flowsheet object type names that can be passed to AddObject(String, Int32, Int32, String, String, Boolean). (Inherited from FlowsheetBase) |
| GetAvailablePropertyPackages | (Inherited from FlowsheetBase) |
| GetCompound | (Inherited from FlowsheetBase) |
| GetDockPanel | (Inherited from FlowsheetBase) |
| GetFlowsheetBag | (Inherited from FlowsheetBase) |
| GetFlowsheetGraphicObject | Returns the graphic object whose user-visible tag matches the specified value. (Inherited from FlowsheetBase) |
| GetFlowsheetSimulationObject | Returns the simulation object whose user-visible tag matches the specified value. (Inherited from FlowsheetBase) |
| GetFlowsheetSurfaceHeight | (Inherited from FlowsheetBase) |
| GetFlowsheetSurfaceWidth | (Inherited from FlowsheetBase) |
| GetNewInstance | (Overrides FlowsheetBaseGetNewInstance) |
| GetObject | (Inherited from FlowsheetBase) |
| GetProcessData | (Inherited from FlowsheetBase) |
| GetPropertyPackage | (Inherited from FlowsheetBase) |
| GetPropertyPackages | (Inherited from FlowsheetBase) |
| GetReaction | (Inherited from FlowsheetBase) |
| GetReactionSet | (Inherited from FlowsheetBase) |
| GetResultIDs | (Inherited from FlowsheetBase) |
| GetResultUnits | (Inherited from FlowsheetBase) |
| GetResultValue | (Inherited from FlowsheetBase) |
| GetScriptText | (Inherited from FlowsheetBase) |
| GetSelectedFlowsheetSimulationObject |
Returns the currently selected simulation object, or searches by tag if one is provided.
(Inherited from FlowsheetBase) |
| GetSimulationFileDirectory | (Inherited from FlowsheetBase) |
| GetSimulationFilePath | (Inherited from FlowsheetBase) |
| GetSnapshot | (Inherited from FlowsheetBase) |
| GetSpreadsheetData | (Inherited from FlowsheetBase) |
| GetSpreadsheetDataFromRange | |
| GetSpreadsheetFormat | (Inherited from FlowsheetBase) |
| GetSpreadsheetFormatFromRange | |
| GetSpreadsheetObject | (Inherited from FlowsheetBase) |
| GetSurface | Returns the underlying GraphicsSurface used for drawing and hit-testing flowsheet objects. (Inherited from FlowsheetBase) |
| GetSurfaceControl | Returns the UI control that hosts the drawing surface, or Nothing in non-UI contexts. (Inherited from FlowsheetBase) |
| GetTempFileName | |
| GetTranslatedString(String) |
Looks up a localised string by key, searching flowsheet string resources first, then property name resources.
Falls back to the original key if no translation is found.
(Inherited from FlowsheetBase) |
| GetTranslatedString(String, String) | Overload that ignores locale and delegates to GetTranslatedString(String). (Inherited from FlowsheetBase) |
| GetUtility | (Inherited from FlowsheetBase) |
| Init | |
| Initialize | (Inherited from FlowsheetBase) |
| LoadExtenders | (Inherited from FlowsheetBase) |
| LoadFromMXML | (Inherited from FlowsheetBase) |
| LoadFromXML | (Inherited from FlowsheetBase) |
| LoadProcessData | (Inherited from FlowsheetBase) |
| LoadZippedXML | (Inherited from FlowsheetBase) |
| NaturalLayout | (Inherited from FlowsheetBase) |
| PasteObjects | (Inherited from FlowsheetBase) |
| ProcessRedo | (Inherited from FlowsheetBase) |
| ProcessScripts | (Inherited from FlowsheetBase) |
| ProcessUndo | (Inherited from FlowsheetBase) |
| RefreshInterface | (Inherited from FlowsheetBase) |
| RegisterSnapshot | (Inherited from FlowsheetBase) |
| ReleaseResources | (Inherited from FlowsheetBase) |
| RequestCalculation |
Requests a flowsheet calculation, optionally scoped to a single changed object.
When sender is provided the object is queued and the solver runs asynchronously.
(Inherited from FlowsheetBase) |
| RequestCalculation2 | Requests a full flowsheet calculation, optionally blocking the calling thread until it completes. (Inherited from FlowsheetBase) |
| RequestCalculation3 | Requests a calculation scoped to a single object, or a full solve when Obj is Nothing. (Inherited from FlowsheetBase) |
| RequestCalculationAndWait | Runs a full flowsheet calculation synchronously and returns any exceptions raised during the solve. (Inherited from FlowsheetBase) |
| RequestSave | (Inherited from FlowsheetBase) |
| RequestSaveWithDirectory | (Inherited from FlowsheetBase) |
| RequestSaveWithPath | (Inherited from FlowsheetBase) |
| Reset | (Inherited from FlowsheetBase) |
| ResetCalculationStatus | Marks all simulation objects as dirty and uncalculated, forcing a full recalculation on the next solve request. (Inherited from FlowsheetBase) |
| RestoreLastSuccessfulSolutionState | (Inherited from FlowsheetBase) |
| RestoreSnapshot | (Inherited from FlowsheetBase) |
| RunCodeOnUIThread | (Overrides FlowsheetBaseRunCodeOnUIThread(Action)) |
| RunCodeOnUIThread2 | (Inherited from FlowsheetBase) |
| RunScript | (Inherited from FlowsheetBase) |
| RunScriptAsync | (Inherited from FlowsheetBase) |
| SaveCurrentStateAsLastSuccessfulSolution | (Inherited from FlowsheetBase) |
| SavePFDScreenshotToPNG | (Inherited from FlowsheetBase) |
| SaveSimulation | |
| SaveToMXML | (Inherited from FlowsheetBase) |
| SaveToXML | (Inherited from FlowsheetBase) |
| SetCustomSpreadsheetFunctions | |
| SetDirtyStatus | (Inherited from FlowsheetBase) |
| SetMessageListener | (Overrides FlowsheetBaseSetMessageListener(ActionString, IFlowsheetMessageType)) |
| SetPropertyResourcesManager | Sets the resource manager used for resolving localised property names in this flowsheet. (Inherited from FlowsheetBase) |
| SetResourcesManager | Sets the resource manager used for resolving localised strings in this flowsheet. (Inherited from FlowsheetBase) |
| SetTranslateTextExternalFunction | (Inherited from FlowsheetBase) |
| ShowDebugInfo | (Overrides FlowsheetBaseShowDebugInfo(String, Int32)) |
| ShowMessage | (Overrides FlowsheetBaseShowMessage(String, IFlowsheetMessageType, String)) |
| Solve | Requests a full flowsheet calculation using the configured solver mode. (Inherited from FlowsheetBase) |
| SolveFlowsheet | |
| SolveFlowsheet2 | |
| ToggleFlowsheetAnimation | (Inherited from FlowsheetBase) |
| TriggerNewDataLoadedEvent |
Raises the new-data-loaded event. Override in derived classes to update the UI after data changes.
(Inherited from FlowsheetBase) |
| UnloadExtenders | (Inherited from FlowsheetBase) |
| UpdateInformation | (Overrides FlowsheetBaseUpdateInformation) |
| UpdateInterface | (Overrides FlowsheetBaseUpdateInterface) |
| UpdateMassAndEnergyBalance | (Inherited from FlowsheetBase) |
| UpdateOpenEditForms | (Overrides FlowsheetBaseUpdateOpenEditForms) |
| UpdateSpreadsheet | (Inherited from FlowsheetBase) |
| WriteMessage | |
| WriteSpreadsheetVariables | (Inherited from FlowsheetBase) |
Events
| FlowsheetLoadedFromXML | Raised after the flowsheet state has been successfully deserialized from XML. (Inherited from FlowsheetBase) |
| FlowsheetLoadingFromXML | Raised just before the flowsheet state is deserialized from XML. (Inherited from FlowsheetBase) |
| FlowsheetSavedToXML | Raised after the flowsheet state has been successfully serialized to XML. (Inherited from FlowsheetBase) |
| FlowsheetSavingToXML | Raised just before the flowsheet state is serialized to XML. (Inherited from FlowsheetBase) |
Fields
| _translatefunction | Optional translation function used to localize strings returned by GetTranslatedString(String). (Inherited from FlowsheetBase) |
| GetSpreadsheetObjectFunc | Function that returns the active spreadsheet object for scripting access. (Inherited from FlowsheetBase) |
| listeningaction | |
| LoadSpreadsheetData | Delegate invoked to load spreadsheet data from the simulation XML document. (Inherited from FlowsheetBase) |
| OptimizationCollection | Collection of optimization cases defined for this flowsheet. (Inherited from FlowsheetBase) |
| RedoStack | Stack of serialized snapshots used to support redo operations. (Inherited from FlowsheetBase) |
| RetrieveSpreadsheetData | Function that retrieves cell values from the spreadsheet by range address. (Inherited from FlowsheetBase) |
| RetrieveSpreadsheetFormat | Function that retrieves cell formatting information from the spreadsheet by range address. (Inherited from FlowsheetBase) |
| SaveSpreadsheetData | Delegate invoked to load spreadsheet data from the simulation XML document. (Inherited from FlowsheetBase) |
| SensAnalysisCollection | Collection of sensitivity analysis cases defined for this flowsheet. (Inherited from FlowsheetBase) |
| Spreadsheet | |
| UndoStack | Stack of serialized snapshots used to support undo operations. (Inherited from FlowsheetBase) |
| updateUIaction |
Extension Methods
| GetEnumNames | (Defined by General) |
| IsValidDouble | (Defined by General) |