' DWSIM Flowsheet Solver & Auxiliary Functions ' Copyright 2025 Daniel Wagner O. de Medeiros ' ' This file is part of DWSIM. ' ' DWSIM is free software: you can redistribute it and/or modify ' it under the terms of the GNU General Public License as published by ' the Free Software Foundation, either version 3 of the License, or ' (at your option) any later version. ' ' DWSIM is distributed in the hope that it will be useful, ' but WITHOUT ANY WARRANTY; without even the implied warranty of ' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ' GNU General Public License for more details. ' ' You should have received a copy of the GNU General Public License ' along with DWSIM. If not, see . Imports System.IO Imports System.Threading Imports DWSIM.Interfaces Imports DWSIM.Interfaces.Enums.GraphicObjects Imports DWSIM.Interfaces.Enums Imports DWSIM.ExtensionMethods Imports cv = DWSIM.SharedClasses.SystemsOfUnits.Converter Imports DWSIM.SharedClasses Public Class FlowsheetSolver2 Public Property SolverTimeoutSeconds As Integer = 60 Public Property ThisCancellationToken As CancellationToken ''' ''' Calculates the flowsheet objects asynchronously. This function is always called from a task or a different thread other than UI's. ''' ''' Flowsheet to calculate (FormChild object). ''' A CalculationArgs object containing information about the object to be calculated and its current status. ''' The cancellation token, used to listen for calculation cancellation requests from the user. ''' Public Sub CalculateObjectAsync(ByVal fobj As Object, ByVal objArgs As CalculationArgs, ct As Threading.CancellationToken) Dim fgui As IFlowsheet = TryCast(fobj, IFlowsheet) Dim fbag As IFlowsheet = TryCast(fobj, IFlowsheet) If ct.IsCancellationRequested = True Then ct.ThrowIfCancellationRequested() If objArgs.Sender = "FlowsheetSolver" Then fgui.ProcessScripts(Scripts.EventType.ObjectCalculationStarted, Scripts.ObjectType.FlowsheetObject, objArgs.Name) Select Case objArgs.ObjectType Case ObjectType.MaterialStream Dim myObj = fbag.SimulationObjects(objArgs.Name) CalculateMaterialStreamAsync(fobj, myObj, ct) Case ObjectType.EnergyStream Dim myObj = fbag.SimulationObjects(objArgs.Name) If myObj.IsSpecAttached = True Then If myObj.SpecVarType = SpecVarType.Target And fbag.FlowsheetOptions.SpecCalculationMode = SpecCalcMode.BeforeTargetObject Then fbag.SimulationObjects(myObj.AttachedSpecId).Solve() End If End If For Each obj In fbag.SimulationObjects.Values.Where(Function(o) TypeOf o Is ISpec) Dim spec = DirectCast(obj, ISpec) If spec.SpecCalculationMode = SpecCalcMode2.BeforeObject And spec.ReferenceObjectID = objArgs.Name Then obj.Solve() End If Next myObj.Solve() If myObj.IsSpecAttached = True Then If myObj.SpecVarType = SpecVarType.Source And fbag.FlowsheetOptions.SpecCalculationMode = SpecCalcMode.AfterSourceObject Then fbag.SimulationObjects(myObj.AttachedSpecId).Solve() End If End If For Each obj In fbag.SimulationObjects.Values.Where(Function(o) TypeOf o Is ISpec) Dim spec = DirectCast(obj, ISpec) If spec.SpecCalculationMode = SpecCalcMode2.AfterObject And spec.ReferenceObjectID = objArgs.Name Then obj.Solve() End If Next myObj.Calculated = True Case Else Dim myObj As ISimulationObject = fbag.SimulationObjects(objArgs.Name) If myObj.IsSpecAttached = True Then If myObj.SpecVarType = SpecVarType.Target And fbag.FlowsheetOptions.SpecCalculationMode = SpecCalcMode.BeforeTargetObject Then fbag.SimulationObjects(myObj.AttachedSpecId).Solve() End If End If For Each obj In fbag.SimulationObjects.Values.Where(Function(o) TypeOf o Is ISpec) Dim spec = DirectCast(obj, ISpec) If spec.SpecCalculationMode = SpecCalcMode2.BeforeObject And spec.ReferenceObjectID = objArgs.Name Then obj.Solve() End If Next If fbag.DynamicMode Then myObj.RunDynamicModel() Else myObj.Solve() End If For Each utility In myObj.AttachedUtilities If utility.AutoUpdate Then fbag.RunCodeOnUIThread(Sub() utility.Update()) Next myObj.Calculated = True If myObj.IsSpecAttached = True Then If myObj.SpecVarType = SpecVarType.Source And fbag.FlowsheetOptions.SpecCalculationMode = SpecCalcMode.AfterSourceObject Then fbag.SimulationObjects(myObj.AttachedSpecId).Solve() End If End If For Each obj In fbag.SimulationObjects.Values.Where(Function(o) TypeOf o Is ISpec) Dim spec = DirectCast(obj, ISpec) If spec.SpecCalculationMode = SpecCalcMode2.BeforeObject And spec.ReferenceObjectID = objArgs.Name Then obj.Solve() End If Next End Select fgui.ProcessScripts(Scripts.EventType.ObjectCalculationFinished, Scripts.ObjectType.FlowsheetObject, objArgs.Name) End If End Sub ''' ''' Calculates a material stream object asynchronously. This function is always called from a task or a different thread other than UI's. ''' ''' Flowsheet to what the stream belongs to. ''' Material Stream object to be calculated. ''' The cancellation token, used to listen for calculation cancellation requests from the user. ''' Public Sub CalculateMaterialStreamAsync(ByVal fobj As Object, ByVal ms As ISimulationObject, ct As Threading.CancellationToken) Dim fgui As IFlowsheet = TryCast(fobj, IFlowsheet) Dim fbag As IFlowsheet = TryCast(fobj, IFlowsheet) If ct.IsCancellationRequested = True Then ct.ThrowIfCancellationRequested() ms.Calculated = False fgui.ProcessScripts(Scripts.EventType.ObjectCalculationStarted, Scripts.ObjectType.FlowsheetObject, ms.Name) If ms.IsSpecAttached = True Then If ms.SpecVarType = SpecVarType.Target And fbag.FlowsheetOptions.SpecCalculationMode = SpecCalcMode.BeforeTargetObject Then fbag.SimulationObjects(ms.AttachedSpecId).Solve() End If End If For Each obj In fbag.SimulationObjects.Values.Where(Function(o) TypeOf o Is ISpec) Dim spec = DirectCast(obj, ISpec) If spec.SpecCalculationMode = SpecCalcMode2.BeforeObject And spec.ReferenceObjectID = ms.Name Then obj.Solve() End If Next If fbag.DynamicMode Then ms.RunDynamicModel() Else ms.Solve() End If fgui.ProcessScripts(Scripts.EventType.ObjectCalculationFinished, Scripts.ObjectType.FlowsheetObject, ms.Name) If ms.IsSpecAttached = True Then If ms.SpecVarType = SpecVarType.Source And fbag.FlowsheetOptions.SpecCalculationMode = SpecCalcMode.AfterSourceObject Then fbag.SimulationObjects(ms.AttachedSpecId).Solve() End If End If For Each obj In fbag.SimulationObjects.Values.Where(Function(o) TypeOf o Is ISpec) Dim spec = DirectCast(obj, ISpec) If spec.SpecCalculationMode = SpecCalcMode2.BeforeObject And spec.ReferenceObjectID = ms.Name Then obj.Solve() End If Next ms.LastUpdated = Date.Now ms.Calculated = True End Sub ''' ''' Process the calculation queue of the Flowsheet passed as an argument. Checks all elements in the queue and calculates them. ''' ''' Flowsheet to be calculated (FormChild object) ''' Public Function ProcessCalculationQueue(ByVal fobj As Object, Optional ByVal ct As Threading.CancellationToken = Nothing, Optional ByVal Adjusting As Boolean = False) As List(Of Exception) Dim exlist As New List(Of Exception) exlist = ProcessQueueInternalAsync(fobj, ct) If Not Adjusting Then SolveSimultaneousAdjustsAsync(fobj, ct) Return exlist End Function Private Sub CheckExceptionForAdditionalInfo(ex As Exception) If Not ex.Data.Contains("DetailedDescription") Then ex.Data.Add("DetailedDescription", "This error was raised during the calculation of a Unit Operation or Material Stream.") End If If Not ex.Data.Contains("UserAction") Then ex.Data.Add("UserAction", "Check input parameters. If this error keeps occurring, try another Property Package and/or Flash Algorithm.") End If End Sub ''' ''' This is the internal routine called by ProcessCalculationQueue when a background thread is used to calculate the flowsheet. ''' ''' Flowsheet to be calculated (FormChild object) ''' The cancellation token, used to listen for calculation cancellation requests from the user. ''' Private Function ProcessQueueInternalAsync(ByVal fobj As Object, ByVal ct As Threading.CancellationToken) As List(Of Exception) Dim fgui As IFlowsheet = TryCast(fobj, IFlowsheet) Dim fbag As IFlowsheet = TryCast(fobj, IFlowsheet) Dim fqueue As IFlowsheetCalculationQueue = TryCast(fobj, IFlowsheetCalculationQueue) Dim d0 As Date = Date.Now Dim loopex As New List(Of Exception) While fqueue.CalculationQueue.Count >= 1 If ct.IsCancellationRequested = True Then ct.ThrowIfCancellationRequested() Dim myinfo As CalculationArgs = fqueue.CalculationQueue.Peek() 'fobj.UIThread(Sub() UpdateDisplayStatus(fobj, New String() {myinfo.Name}, True)) Dim myobj = fbag.SimulationObjects(myinfo.Name) Dim IObj As Inspector.InspectorItem = Inspector.Host.GetNewInspectorItem() Inspector.SetCurrent(Nothing) IObj?.Paragraphs.Add("This is the main routine for the calculation of a single object. Check the nested items for model details.") Try myobj.GraphicObject.Status = Status.Calculating myobj.ErrorMessage = "" If myobj.GraphicObject.Active Then If myinfo.ObjectType = ObjectType.MaterialStream Then CalculateMaterialStreamAsync(fobj, myobj, ct) Else CalculateObjectAsync(fobj, myinfo, ct) End If For Each au In myobj.AttachedUtilities If au.AutoUpdate Then fbag.RunCodeOnUIThread(Sub() au.Update()) Next myobj.GraphicObject.Calculated = True myobj.LastUpdated = Date.Now End If myobj.GraphicObject.Status = Status.Calculated Catch ex As AggregateException myobj.GraphicObject.Status = Status.ErrorCalculating fgui.ProcessScripts(Scripts.EventType.ObjectCalculationError, Scripts.ObjectType.FlowsheetObject, myobj.Name) myobj.ErrorMessage = "" For Each iex In ex.InnerExceptions If TypeOf iex Is AggregateException Then For Each iex2 In DirectCast(iex, AggregateException).InnerExceptions If TypeOf iex2 Is AggregateException Then For Each iex3 In DirectCast(iex2, AggregateException).InnerExceptions If TypeOf iex3 Is AggregateException Then For Each iex4 In DirectCast(iex3, AggregateException).InnerExceptions myobj.ErrorMessage += iex4.Message.ToString & vbCrLf CheckExceptionForAdditionalInfo(iex4) iex4.Source = myinfo.Tag loopex.Add(New Exception(myinfo.Tag & ": " & iex4.Message, iex4)) Next Else myobj.ErrorMessage += iex3.Message.ToString & vbCrLf CheckExceptionForAdditionalInfo(iex3) iex3.Source = myinfo.Tag loopex.Add(New Exception(myinfo.Tag & ": " & iex3.Message, iex3)) End If Next Else myobj.ErrorMessage += iex2.Message.ToString & vbCrLf CheckExceptionForAdditionalInfo(iex2) iex2.Source = myinfo.Tag loopex.Add(New Exception(myinfo.Tag & ": " & iex2.Message, iex2)) End If Next Else myobj.ErrorMessage += iex.Message.ToString & vbCrLf CheckExceptionForAdditionalInfo(iex) iex.Source = myinfo.Tag loopex.Add(New Exception(myinfo.Tag & ": " & iex.Message, iex)) End If Next Exit While Catch ex As Exception myobj.GraphicObject.Status = Status.ErrorCalculating fgui.ProcessScripts(Scripts.EventType.ObjectCalculationError, Scripts.ObjectType.FlowsheetObject, myobj.Name) myobj.ErrorMessage = ex.Message.ToString CheckExceptionForAdditionalInfo(ex) ex.Source = myinfo.Tag loopex.Add(New Exception(myinfo.Tag & ": " & ex.Message, ex)) Exit While Finally fgui.UpdateInterface() End Try IObj?.Close() If fqueue.CalculationQueue.Count > 0 Then fqueue.CalculationQueue.Dequeue() End While Return loopex End Function ''' ''' Checks the calculator status to see if the user did any stop/abort request, and throws an exception to force aborting, if necessary. ''' ''' ''' ''' This routine updates the display status of a list of graphic objects in the flowsheet according to their calculated status. ''' ''' Flowsheet to be calculated (FormChild object). ''' List of object IDs to be updated. ''' Tell the routine that the objects in the list are being calculated at the moment. ''' Shared Sub UpdateDisplayStatus(fobj As Object, Optional ByVal ObjIDlist() As String = Nothing, Optional ByVal calculating As Boolean = False) Dim fgui As IFlowsheet = TryCast(fobj, IFlowsheet) Dim fbag As IFlowsheet = TryCast(fobj, IFlowsheet) If ObjIDlist Is Nothing Then For Each baseobj In fbag.SimulationObjects.Values If Not baseobj.GraphicObject Is Nothing Then If Not baseobj.GraphicObject.Active Then baseobj.GraphicObject.Status = Status.Inactive Else baseobj.GraphicObject.Calculated = baseobj.Calculated 'If baseobj.Calculated Then baseobj.UpdatePropertyNodes(fobj.Options.SelectedUnitSystem, fobj.Options.NumberFormat) End If End If Next Else For Each ObjID In ObjIDlist If fbag.SimulationObjects.ContainsKey(ObjID) Then Dim baseobj = fbag.SimulationObjects(ObjID) If Not baseobj.GraphicObject Is Nothing Then If calculating Then baseobj.GraphicObject.Status = Status.Calculating Else If Not baseobj.GraphicObject.Active Then baseobj.GraphicObject.Status = Status.Inactive Else baseobj.GraphicObject.Calculated = baseobj.Calculated 'If baseobj.Calculated Then baseobj.UpdatePropertyNodes(fobj.Options.SelectedUnitSystem, fobj.Options.NumberFormat) End If End If End If End If Next End If 'fobj.UIThread(Sub() ' fobj.FormSurface.FlowsheetDesignSurface.Invalidate() ' End Sub) End Sub ''' ''' Retrieves the list of objects to be solved in the flowsheet. ''' ''' Flowsheet to be calculated (FormChild object) ''' Starts the search from the edited object if the propert was changed from the property grid. ''' A list of objects to be calculated in the flowsheet. ''' Public Function GetSolvingList(fobj As Object, frompgrid As Boolean) As Object() Dim fgui As IFlowsheet = TryCast(fobj, IFlowsheet) Dim fbag As IFlowsheet = TryCast(fobj, IFlowsheet) Dim fqueue As IFlowsheetCalculationQueue = TryCast(fobj, IFlowsheetCalculationQueue) Dim obj As ISimulationObject Dim lists As New Dictionary(Of Integer, List(Of String)) Dim filteredlist As New Dictionary(Of Integer, List(Of String)) Dim objstack As New List(Of String) Dim onqueue As CalculationArgs = Nothing Dim listidx As Integer = 0 Dim maxidx As Integer = 0 If frompgrid Then If fqueue.CalculationQueue.Count > 0 Then onqueue = fqueue.CalculationQueue.Dequeue() fqueue.CalculationQueue.Clear() lists.Add(0, New List(Of String)) lists(0).Add(onqueue.Name) 'now start walking through the flowsheet until it reaches its end starting from this particular object. Do listidx += 1 If lists(listidx - 1).Count > 0 Then lists.Add(listidx, New List(Of String)) maxidx = listidx For Each o As String In lists(listidx - 1) obj = fbag.SimulationObjects(o) If obj.GraphicObject.Active Then For Each c As IConnectionPoint In obj.GraphicObject.OutputConnectors If c.IsAttached Then If obj.GraphicObject.ObjectType = ObjectType.OT_Recycle Or obj.GraphicObject.ObjectType = ObjectType.OT_EnergyRecycle Then Exit For lists(listidx).Add(c.AttachedConnector.AttachedTo.Name) End If Next If obj.GraphicObject.EnergyConnector.IsAttached AndAlso obj.GraphicObject.EnergyConnector.AttachedConnector.AttachedTo IsNot obj Then lists(listidx).Add(obj.GraphicObject.EnergyConnector.AttachedConnector.AttachedTo.Name) End If End If Next Else Exit Do End If If lists.Count > 10000 Then lists.Clear() Throw New Exception("Infinite loop detected while obtaining flowsheet object calculation order. Please insert recycle blocks where needed.") End If Loop 'process the lists , adding objects to the stack, discarding duplicate entries. listidx = 0 Do If lists.ContainsKey(listidx) Then filteredlist.Add(listidx, New List(Of String)(lists(listidx).ToArray)) For Each o As String In lists(listidx) objstack.Add(o) Next Else Exit Do End If listidx += 1 Loop Until listidx > maxidx objstack.Reverse() objstack = objstack.Distinct().ToList() objstack.Reverse() End If Else 'add endpoint material streams and recycle ops to the list, they will be the last objects to be calculated. lists.Add(0, New List(Of String)) For Each baseobj In fbag.SimulationObjects.Values If baseobj.GraphicObject.ObjectType = ObjectType.MaterialStream Then If baseobj.GraphicObject.OutputConnectors(0).IsAttached = False Then lists(0).Add(baseobj.Name) End If ElseIf baseobj.GraphicObject.ObjectType = ObjectType.EnergyStream Then If baseobj.GraphicObject.OutputConnectors(0).IsAttached = False Then lists(0).Add(baseobj.Name) End If ElseIf baseobj.GraphicObject.ObjectType = ObjectType.OT_Recycle Then lists(0).Add(baseobj.Name) ElseIf baseobj.GraphicObject.ObjectType = ObjectType.OT_EnergyRecycle Then lists(0).Add(baseobj.Name) ElseIf baseobj.IsSource Then lists(0).Add(baseobj.Name) End If Next 'now start processing the list at each level, until it reaches the beginning of the flowsheet. Dim totalobjs As Integer = 0 Do listidx += 1 If lists(listidx - 1).Count > 0 Then lists.Add(listidx, New List(Of String)) maxidx = listidx For Each o As String In lists(listidx - 1) If fbag.SimulationObjects.ContainsKey(o) Then obj = fbag.SimulationObjects(o) If Not onqueue Is Nothing Then If onqueue.Name = obj.Name Then Exit Do End If For Each c As IConnectionPoint In obj.GraphicObject.InputConnectors If c.IsAttached Then If c.AttachedConnector.AttachedFrom.ObjectType <> ObjectType.OT_Recycle And c.AttachedConnector.AttachedFrom.ObjectType <> ObjectType.OT_EnergyRecycle Then lists(listidx).Add(c.AttachedConnector.AttachedFrom.Name) totalobjs += 1 If totalobjs > 10000 Then Throw New Exception("Infinite loop detected while obtaining flowsheet object calculation order. Please insert recycle blocks where needed.") End If End If End If Next End If Next Else Exit Do End If Loop 'process the lists backwards, adding objects to the stack, discarding duplicate entries. listidx = maxidx Do If lists.ContainsKey(listidx) Then filteredlist.Add(maxidx - listidx, New List(Of String)(lists(listidx).ToArray)) For Each o As String In lists(listidx) If Not objstack.Contains(o) Then objstack.Add(o) Else filteredlist(maxidx - listidx).Remove(o) End If Next Else Exit Do End If listidx -= 1 Loop 'special loop for batch unit ops in dynamic mode If fbag.DynamicMode Then For Each baseobj In fbag.SimulationObjects.Values If TypeOf baseobj Is IUnitOperation AndAlso baseobj.SupportsDynamicMode Then Dim inletconnected = baseobj.GraphicObject.InputConnectors.Where(Function(c) c.IsAttached).Count Dim outletconnected = baseobj.GraphicObject.OutputConnectors.Where(Function(c) c.IsAttached).Count Dim n_inlets = baseobj.GraphicObject.InputConnectors.Count Dim n_outlets = baseobj.GraphicObject.OutputConnectors.Count If inletconnected = 0 And outletconnected = 0 And (n_inlets + n_outlets) > 0 Then objstack.Add(baseobj.Name) End If End If Next End If End If Return New Object() {objstack, lists, filteredlist} End Function ''' ''' Calculate all objects in the Flowsheet using an ordering method. ''' ''' Flowsheet to be calculated (FormFlowsheet object). ''' True if the routine is called from the Simultaneous Adjust Solver. ''' True if the routine is called from a PropertyGrid PropertyChanged event. ''' Public Function SolveFlowsheet(ByVal fobj As Object, Optional frompgrid As Boolean = False, Optional Adjusting As Boolean = False, Optional ByVal FinishSuccess As Action = Nothing, Optional ByVal FinishWithErrors As Action = Nothing, Optional ByVal FinishAny As Action = Nothing, Optional ByVal ChangeCalcOrder As Boolean = False) As List(Of Exception) Dim fs As IFlowsheet = TryCast(fobj, IFlowsheet) Inspector.Host.CurrentSolutionID = Date.Now.ToBinary Dim IObj As Inspector.InspectorItem = Inspector.Host.GetNewInspectorItem() Inspector.Host.CheckAndAdd(IObj, "", "SolveFlowsheet", "Solver Call", "Flowsheet Solver Call Event") IObj?.Paragraphs.Add("The Flowsheet Solver controls the calculation of the entire flowsheet.") IObj?.Paragraphs.Add("When the user requests a flowsheet calculation, it tries to determine the order of the objects to be calculated.") If fs.PropertyPackages.Count = 0 Then Dim el = New List(Of Exception) el.Add(New Exception(fs.GetTranslatedString("NoPropPackAdded"))) fs.ShowMessage(fs.GetTranslatedString("NoPropPackAdded"), IFlowsheet.MessageType.GeneralError) Return el End If If fs.SelectedCompounds.Count = 0 Then Dim el = New List(Of Exception) el.Add(New Exception(fs.GetTranslatedString("NoCompoundsAdded"))) fs.ShowMessage(fs.GetTranslatedString("NoCompoundsAdded"), IFlowsheet.MessageType.GeneralError) Return el End If Dim fgui As IFlowsheet = TryCast(fobj, IFlowsheet) Dim fbag As IFlowsheet = TryCast(fobj, IFlowsheet) Dim fqueue As IFlowsheetCalculationQueue = TryCast(fobj, IFlowsheetCalculationQueue) 'this is the cancellation token for background threads. it checks for calculator stop requests and forwards the request to the tasks. Dim obj As ISimulationObject 'mode: '0 = Synchronous (main thread) '1 = Asynchronous (background thread) '2 = Asynchronous Parallel (background thread) '3 = Azure Service Bus '4 = Network Computer Dim d1 As Date = Date.Now Dim age As AggregateException = Nothing Dim exlist As New List(Of Exception) 'gets a list of objects to be solved in the flowsheet Dim objl As Object() Try objl = GetSolvingList(fobj, frompgrid) Catch ex As Exception FinishAny?.Invoke() FinishWithErrors?.Invoke() Dim euid As String = Guid.NewGuid().ToString() ExceptionProcessing.ExceptionList.Exceptions.Add(euid, ex) fgui.ShowMessage(ex.Message, IFlowsheet.MessageType.GeneralError, euid) IObj?.Paragraphs.Add(ex.Message) Return New List(Of Exception)({ex}) End Try 'assign the list of objects, the filtered list (which contains no duplicate elements) and the object stack 'which contains the ordered list of objects to be calculated. Dim objstack As List(Of String) = objl(0) If ChangeCalcOrder Then fgui.RunCodeOnUIThread(Sub() Dim customlist = fgui.FlowsheetOptions.CustomCalculationOrder Dim reflist = New List(Of String)(customlist) If customlist.Count > 0 Then For Each item In reflist If Not objstack.Contains(item) Then customlist.Remove(item) End If Next For Each item In objstack If Not customlist.Contains(item) Then customlist.Add(item) End If Next objstack = fgui.ChangeCalculationOrder(customlist) Else objstack = fgui.ChangeCalculationOrder(objstack) End If fgui.FlowsheetOptions.CustomCalculationOrder = New List(Of String)(objstack) End Sub) End If IObj?.Paragraphs.Add("The objects which will be calculated are (in this order): ") If IObj IsNot Nothing Then For Each item In objstack IObj.Paragraphs.Add(fbag.SimulationObjects(item).GraphicObject.Tag & " (" & fbag.SimulationObjects(item).GetDisplayName & ")") Next End If If objstack.Count = 0 Then FinishAny?.Invoke() Return New List(Of Exception) End If fs.Solved = False fs.ErrorMessage = "" 'adds a message to the log window to indicate that the flowsheet started solving fgui.ShowMessage(fgui.GetTranslatedString("FSstartedsolving"), IFlowsheet.MessageType.Information) If fgui.FlowsheetOptions.ForceStreamPhase <> ForcedPhase.None Then fgui.ShowMessage(fgui.GetTranslatedString(String.Format("Global Phase Override is defined to '{0}'", fgui.FlowsheetOptions.ForceStreamPhase)), IFlowsheet.MessageType.Warning) End If 'process scripts associated with the solverstarted event fgui.ProcessScripts(Scripts.EventType.SolverStarted, Scripts.ObjectType.Solver, "") 'call spreadsheet update to get values when in write mode fs.UpdateSpreadsheet(Nothing) fs.WriteSpreadsheetVariables(Nothing) 'find recycles IObj?.Paragraphs.Add("The solver will now check for Recycles connected to 'tear' Material Streams...") Dim recycles As New List(Of String) Dim totalv As Integer = 0 Dim totalr As Integer = 0 For Each r In objstack If fbag.SimulationObjects.ContainsKey(r) Then Dim robj = fbag.SimulationObjects(r) If robj.GraphicObject.ObjectType = ObjectType.OT_Recycle Then recycles.Add(robj.Name) Dim rec As IRecycle = fbag.SimulationObjects(robj.Name) If rec.AccelerationMethod = AccelMethod.GlobalBroyden Then If rec.Values.Count = 0 Then fbag.SimulationObjects(robj.Name).Solve() totalv += rec.Values.Count End If totalr += 1 End If End If Next IObj?.Paragraphs.Add(String.Format("Number of Recycles found: {0}.", totalr)) 'size hessian matrix, variables and error vectors for recycle simultaneous solving. Dim rechess(totalv - 1, totalv - 1), recvars(totalv - 1), recdvars(totalv - 1), recerrs(totalv - 1), recvarsb(totalv - 1), recerrsb(totalv - 1) As Double 'identity matrix as first hessian. For i As Integer = 0 To totalv - 1 rechess(i, i) = 1 Next Dim maintask As Task '0 = main thread, 1 = bg thread, 2 = bg parallel threads 'define variable to check for flowsheet convergence if there are recycle ops Dim converged As Boolean = False Dim loopidx As Integer = 0 'process/calculate the queue. If fqueue.CalculationQueue Is Nothing Then fqueue.CalculationQueue = New Queue(Of ICalculationArgs) 'My.Application.MasterCalculatorStopRequested = False Dim objargs As CalculationArgs = Nothing maintask = TaskHelper.Run(Sub() Dim icount As Integer = 0 While Not converged fgui.ClearLog() 'calc specs If fbag.FlowsheetOptions.SpecCalculationMode = SpecCalcMode.BeforeFlowsheet Then For Each obj In fbag.SimulationObjects.Values.Where(Function(o) TypeOf o Is ISpec) Dim spec = DirectCast(obj, ISpec) If spec.SpecCalculationMode = SpecCalcMode2.GlobalSetting Or spec.SpecCalculationMode = SpecCalcMode2.BeforeFlowsheet Then obj.Solve() End If Next End If 'add the objects to the calculation queue. For Each o As String In objstack If fbag.SimulationObjects.ContainsKey(o) Then obj = fbag.SimulationObjects(o) If obj.GraphicObject.ObjectType = ObjectType.MaterialStream Then Dim ms As IMaterialStream = fbag.SimulationObjects(obj.Name) ms.AtEquilibrium = False End If objargs = New CalculationArgs With objargs .Sender = "FlowsheetSolver" .Calculated = True .Name = obj.Name .ObjectType = obj.GraphicObject.ObjectType .Tag = obj.GraphicObject.Tag fqueue.CalculationQueue.Enqueue(objargs) End With End If Next 'set the flowsheet instance for all objects, this is required for the async threads For Each o In fbag.SimulationObjects.Values o.SetFlowsheet(fobj) Next 'set all objects' status to 'not calculated' (red) in the list For Each o In objstack obj = fbag.SimulationObjects(o) With obj .Calculated = False If Not obj.GraphicObject Is Nothing Then If obj.GraphicObject.Active Then obj.GraphicObject.Calculated = False Else fgui.ShowMessage(obj.GraphicObject.Tag & ": " & fgui.GetTranslatedString("ObjDeactivated"), IFlowsheet.MessageType.Warning) obj.GraphicObject.Status = Status.Inactive End If End If End With Next exlist = ProcessCalculationQueue(fobj, ThisCancellationToken, Adjusting) 'calc specs If fbag.FlowsheetOptions.SpecCalculationMode = SpecCalcMode.AfterFlowsheet Then For Each obj In fbag.SimulationObjects.Values.Where(Function(o) TypeOf o Is ISpec) Dim spec = DirectCast(obj, ISpec) If spec.SpecCalculationMode = SpecCalcMode2.GlobalSetting Or spec.SpecCalculationMode = SpecCalcMode2.AfterFlowsheet Then obj.Solve() End If Next 'calc again 'add the objects to the calculation queue. For Each o As String In objstack If fbag.SimulationObjects.ContainsKey(o) Then obj = fbag.SimulationObjects(o) If obj.GraphicObject.ObjectType = ObjectType.MaterialStream Then Dim ms As IMaterialStream = fbag.SimulationObjects(obj.Name) ms.AtEquilibrium = False End If objargs = New CalculationArgs With objargs .Sender = "FlowsheetSolver" .Calculated = True .Name = obj.Name .ObjectType = obj.GraphicObject.ObjectType .Tag = obj.GraphicObject.Tag fqueue.CalculationQueue.Enqueue(objargs) End With End If Next exlist = ProcessCalculationQueue(fobj, ThisCancellationToken, Adjusting) End If 'throws exceptions if any If exlist.Count > 0 Then Throw New AggregateException(exlist) End If 'checks for recycle convergence. converged = True For Each r As String In recycles obj = fbag.SimulationObjects(r) converged = DirectCast(obj, IRecycle).Converged If Not converged Then Exit For Next 'in dynamic mode, recycles are redundant If fbag.DynamicMode Then converged = True If Not converged Then Dim avgerr As Double = 0.0# Dim rcount As Integer = 0 For Each r As String In recycles obj = fbag.SimulationObjects(r) With DirectCast(obj, IRecycle) avgerr += 0.33 * .ConvergenceHistory.TemperaturaE / .ConvergenceHistory.Temperatura avgerr += 0.33 * .ConvergenceHistory.PressaoE / .ConvergenceHistory.Pressao avgerr += 0.33 * .ConvergenceHistory.VazaoMassicaE / .ConvergenceHistory.VazaoMassica End With rcount += 1 Next avgerr *= 100 avgerr /= rcount fgui.ClearLog() fgui.ShowMessage("Recycle loop #" & (icount + 1) & ", average recycle error: " & Format(avgerr, "N") & "%", IFlowsheet.MessageType.Information) fgui.UpdateInterface() If Not fgui.DynamicMode Then fgui.UpdateOpenEditForms() End If End If 'process the scripts associated with the recycle loop event. fgui.ProcessScripts(Scripts.EventType.SolverRecycleLoop, Scripts.ObjectType.Solver, "") 'if the all recycles have converged (if any), then exit the loop. If converged Then Exit While Else If totalv > 0 Then 'update variables of all recycles set to global broyden. Dim i As Integer = 0 For Each r As String In recycles Dim rec = DirectCast(fbag.SimulationObjects(r), IRecycle) If rec.AccelerationMethod = AccelMethod.GlobalBroyden Then For Each kvp In rec.Values recvars(i) = kvp.Value recerrs(i) = rec.Errors(kvp.Key) i += 1 Next End If Next MathEx.Broyden.broydn(totalv - 1, recvars, recerrs, recdvars, recvarsb, recerrsb, rechess, If(icount < 2, 0, 1)) i = 0 For Each r As String In recycles Dim rec = DirectCast(fbag.SimulationObjects(r), IRecycle) If rec.AccelerationMethod = AccelMethod.GlobalBroyden Then For Each kvp In rec.Errors rec.Values(kvp.Key) = 0.3 * recvars(i) + 0.7 * recdvars(i) i += 1 Next End If rec.SetOutletStreamProperties() Next End If End If If frompgrid Then Try objl = GetSolvingList(fobj, False) objstack = objl(0) Catch ex As Exception Throw ex End Try End If icount += 1 End While End Sub) Try While Not (Date.Now - d1).TotalMilliseconds >= SolverTimeoutSeconds * 1000 maintask.Wait(500) fgui.UpdateInterface() If maintask.Status = TaskStatus.RanToCompletion Then Exit While End While fgui.UpdateInterface() If maintask.Status = TaskStatus.Running Then Throw New TimeoutException(fgui.GetTranslatedString("SolverTimeout")) End If If maintask.IsFaulted Then Throw maintask.Exception If exlist.Count > 0 Then Throw New AggregateException(exlist) Catch agex As AggregateException age = agex Catch ex As OperationCanceledException age = New AggregateException(fgui.GetTranslatedString("CalculationAborted"), ex) Catch ex As Exception age = New AggregateException(ex.Message.ToString, ex) Finally If maintask.IsCompleted Then maintask.Dispose() maintask = Nothing End If End Try 'clears the calculation queue. fqueue.CalculationQueue.Clear() 'clears the object lists. objstack.Clear() recycles.Clear() fs.UpdateMassAndEnergyBalance() 'updates the display status of all objects in the calculation list. UpdateDisplayStatus(fobj, objstack.ToArray) 'checks if exceptions were thrown during the calculation and displays them in the log window. If age Is Nothing Then fgui.ShowMessage(fgui.GetTranslatedString("FSfinishedsolvingok") + " [" & (Date.Now - d1).TotalSeconds.ToString("G4") + "s]", IFlowsheet.MessageType.Information) IObj?.Paragraphs.Add(String.Format("Solver finished calculation of all objects in {0} seconds.", (Date.Now - d1).TotalSeconds)) fs.ErrorMessage = "" fs.Solved = True Else Dim baseexception As Exception = Nothing fgui.ShowMessage(fgui.GetTranslatedString("FSfinishedsolvingerror"), IFlowsheet.MessageType.GeneralError) IObj?.Paragraphs.Add(fgui.GetTranslatedString("FSfinishedsolvingerror")) For Each ex In age.Flatten().InnerExceptions Dim euid As String = Guid.NewGuid().ToString() SharedClasses.ExceptionProcessing.ExceptionList.Exceptions.Add(euid, ex) If TypeOf ex Is AggregateException Then baseexception = ex.InnerException For Each iex In DirectCast(ex, AggregateException).Flatten().InnerExceptions While iex.InnerException IsNot Nothing baseexception = iex.InnerException End While Next Else baseexception = ex While baseexception.InnerException IsNot Nothing baseexception = baseexception.InnerException End While End If Dim message = baseexception.Message If baseexception.Source <> "" Then message = String.Format("Error in '{0}': {1}", baseexception.Source, baseexception.Message) End If Try Dim st As New StackTrace(baseexception, True) Dim frame As StackFrame = st.GetFrame(0) Dim line = frame.GetFileLineNumber().ToString() Dim dirName = New DirectoryInfo(frame.GetFileName).Name message += " (" + dirName + ", " + line + ")" Catch exs As Exception End Try fgui.ShowMessage(message, IFlowsheet.MessageType.GeneralError, euid) 'Console.WriteLine(baseexception.ToString) IObj?.Paragraphs.Add(baseexception.Message) Next 'fgui.ShowMessage(fgui.GetTranslatedString("If Anonymous Analytics Sharing is enabled, the developers will be notified shortly about the errors. Thank you for your contribution!"), IFlowsheet.MessageType.GeneralError) fs.Solved = False If baseexception IsNot Nothing Then fs.ErrorMessage = baseexception.ToString End If 'updates the flowsheet display information if the fobj is visible. fs.UpdateSpreadsheet(Nothing) fs.UpdateSpreadsheet(Nothing) fgui.UpdateInformation() fgui.UpdateInterface() fgui.ProcessScripts(Scripts.EventType.SolverFinished, Scripts.ObjectType.Solver, "") IObj?.Close() FinishAny?.Invoke() If age Is Nothing Then FinishSuccess?.Invoke() Return New List(Of Exception) Else FinishWithErrors?.Invoke() Return age.Flatten().InnerExceptions.ToList() End If End Function ''' ''' Async simultaneous adjust solver routine. ''' ''' Flowsheet where the object belongs to. ''' The cancellation token, used to listen for calculation cancellation requests from the user. ''' Solves all marked Adjust objects in the flowsheet simultaneously using Netwon's method. Private Sub SolveSimultaneousAdjustsAsync(ByVal fobj As Object, ct As CancellationToken) Dim fgui As IFlowsheet = TryCast(fobj, IFlowsheet) Dim fbag As IFlowsheet = TryCast(fobj, IFlowsheet) Dim fqueue As IFlowsheetCalculationQueue = TryCast(fobj, IFlowsheetCalculationQueue) Dim fs As IFlowsheet = TryCast(fobj, IFlowsheet) If fs.FlowsheetOptions.SimultaneousAdjustSolverEnabled Then 'this is the cancellation token for background threads. it checks for calculator stop requests and passes the request to the tasks. Dim n As Integer = 0 For Each adj As IAdjust In fbag.SimulationObjects.Values.Where(Function(a) TypeOf a Is IAdjust) If adj.SimultaneousAdjust And DirectCast(adj, ISimulationObject).GraphicObject.Active Then n += 1 Next If n > 0 Then n -= 1 Dim i As Integer = 0 Dim dfdx(n, n), dx(n), fx(n), x(n), tols(n) As Double Dim il_err_ant As Double = 10000000000.0 Dim il_err As Double = 10000000000.0 Dim ic As Integer Dim converged As Boolean = False i = 0 For Each adj As IAdjust In fbag.SimulationObjects.Values.Where(Function(a) TypeOf a Is IAdjust) If adj.SimultaneousAdjust And DirectCast(adj, ISimulationObject).GraphicObject.Active Then x(i) = GetMnpVarValue(fobj, adj) tols(i) = adj.Tolerance i += 1 End If Next ic = 0 Do fx = FunctionValueAsync(fobj, x, ct) converged = False il_err_ant = il_err il_err = fx.AbsSqrSumY For i = 0 To x.Length - 1 If Math.Abs(fx(i)) < tols(i) Then converged = True Else converged = False Exit For End If Next fgui.ShowMessage(fgui.GetTranslatedString("SimultaneousAdjust") & ": Iteration #" & ic + 1 & ", NSSE: " & il_err, IFlowsheet.MessageType.Information) If converged Then Exit Do dfdx = FunctionGradientAsync(fobj, x, ct) Dim dfac As Double = 100000.0 Dim success = MathEx.SysLin.rsolve.rmatrixsolve(dfdx, fx, x.Length, dx) If success Then dfac = (ic + 1) * 0.2 If dfac > 1.0 Then dfac = 1.0 For i = 0 To x.Length - 1 If Math.Abs(-dx(i) * dfac) > x(i) Then dfac /= 10 Exit For End If Next For i = 0 To x.Length - 1 dx(i) = -dx(i) x(i) += dfac * dx(i) Next End If fs.CheckStatus() fgui.UpdateInterface() ic += 1 If ic >= 25 Then Throw New Exception(fgui.GetTranslatedString("SADJMaxIterationsReached")) If Double.IsNaN(il_err) Then Throw New Exception(fgui.GetTranslatedString("SADJGeneralError")) If Math.Abs(MathEx.Common.AbsSum(dx)) < 0.000001 Then Exit Do Loop End If End If End Sub ''' ''' Function called asynchronously by the simultaneous adjust solver. Retrieves the error function value for each adjust object. ''' ''' Flowsheet where the object belongs to. ''' ''' The cancellation token, used to listen for calculation cancellation requests from the user. ''' ''' Private Function FunctionValueAsync(ByVal fobj As Object, ByVal x() As Double, ct As CancellationToken) As Double() Dim fbag As IFlowsheet = TryCast(fobj, IFlowsheet) Dim i As Integer = 0 For Each adj As IAdjust In fbag.SimulationObjects.Values.Where(Function(a) TypeOf a Is IAdjust) If adj.SimultaneousAdjust And DirectCast(adj, ISimulationObject).GraphicObject.Active Then SetMnpVarValue(x(i), fobj, adj) i += 1 End If Next Dim exceptions = SolveFlowsheet(fobj, False, True) If exceptions.Count > 0 Then Throw New AggregateException(exceptions) Dim fx(x.Length - 1) As Double i = 0 For Each adj As IAdjust In fbag.SimulationObjects.Values.Where(Function(a) TypeOf a Is IAdjust) If adj.SimultaneousAdjust And DirectCast(adj, ISimulationObject).GraphicObject.Active Then Dim adjvalue As Double Dim punit = fbag.SimulationObjects(adj.ControlledObjectData.ID).GetPropertyUnit(adj.ControlledObjectData.PropertyName, fbag.FlowsheetOptions.SelectedUnitSystem) If adj.Referenced Then If fbag.FlowsheetOptions.SelectedUnitSystem.GetUnitType(punit) = UnitOfMeasure.temperature Then adjvalue = cv.ConvertFromSI(punit & ".", adj.AdjustValue) Else adjvalue = cv.ConvertFromSI(punit, adj.AdjustValue) End If fx(i) = adjvalue + GetRefVarValue(fobj, adj) - GetCtlVarValue(fobj, adj) Else adjvalue = cv.ConvertFromSI(fbag.SimulationObjects(adj.ControlledObjectData.ID).GetPropertyUnit(adj.ControlledObjectData.PropertyName, fbag.FlowsheetOptions.SelectedUnitSystem), adj.AdjustValue) fx(i) = adjvalue - GetCtlVarValue(fobj, adj) End If i = i + 1 End If Next Return fx End Function ''' ''' Gradient function called asynchronously by the simultaneous adjust solver. Retrieves the gradient of the error function value for each adjust object. ''' ''' Flowsheet where the object belongs to. ''' ''' The cancellation token, used to listen for calculation cancellation requests from the user. ''' ''' Private Function FunctionGradientAsync(ByVal fobj As Object, ByVal x() As Double, ct As CancellationToken) As Double(,) Dim epsilon As Double = 0.01 Dim f2(), f3() As Double Dim g(x.Length - 1, x.Length - 1), x1(x.Length - 1), x2(x.Length - 1), x3(x.Length - 1), x4(x.Length - 1) As Double Dim i, j, k As Integer For i = 0 To x.Length - 1 For j = 0 To x.Length - 1 If i <> j Then x2(j) = x(j) x3(j) = x(j) Else If x(j) <> 0.0# Then x2(j) = x(j) * (1 + epsilon) x3(j) = x(j) * (1 - epsilon) Else x2(j) = x(j) + epsilon x3(j) = x(j) End If End If Next f2 = FunctionValueAsync(fobj, x2, ct) f3 = FunctionValueAsync(fobj, x3, ct) For k = 0 To x.Length - 1 g(k, i) = (f2(k) - f3(k)) / (x2(i) - x3(i)) Next Next Return g End Function ''' ''' Gets the controlled variable value for the selected adjust op. ''' ''' ''' ''' ''' Private Function GetCtlVarValue(ByVal fobj As Object, ByVal adj As IAdjust) As Double Dim fbag As IFlowsheet = TryCast(fobj, IFlowsheet) With adj.ControlledObjectData Return fbag.SimulationObjects(.ID).GetPropertyValue(.PropertyName, fbag.FlowsheetOptions.SelectedUnitSystem) End With End Function ''' ''' Gets the manipulated variable value for the selected adjust op. ''' ''' ''' ''' ''' Private Function GetMnpVarValue(ByVal fobj As Object, ByVal adj As IAdjust) As Double Dim fbag As IFlowsheet = TryCast(fobj, IFlowsheet) With adj.ManipulatedObjectData Return fbag.SimulationObjects(.ID).GetPropertyValue(.PropertyName) End With End Function ''' ''' Sets the manipulated variable value for the selected adjust op. ''' ''' ''' ''' ''' Private Function SetMnpVarValue(ByVal val As Nullable(Of Double), ByVal fobj As Object, ByVal adj As IAdjust) Dim fbag As IFlowsheet = TryCast(fobj, IFlowsheet) With adj.ManipulatedObjectData fbag.SimulationObjects(.ID).SetPropertyValue(.PropertyName, val) End With Return 1 End Function ''' ''' Gets the referenced variable value for the selected adjust op. ''' ''' ''' ''' ''' Private Function GetRefVarValue(ByVal fobj As Object, ByVal adj As IAdjust) As Double Dim fbag As IFlowsheet = TryCast(fobj, IFlowsheet) With adj.ReferencedObjectData Return fbag.SimulationObjects(.ID).GetPropertyValue(.PropertyName, fbag.FlowsheetOptions.SelectedUnitSystem) End With End Function End Class