File size: 63,461 Bytes
b1b3bae |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 |
' 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 <http://www.gnu.org/licenses/>.
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
<System.Serializable()> Public Class FlowsheetSolver2
Public Property SolverTimeoutSeconds As Integer = 60
Public Property ThisCancellationToken As CancellationToken
''' <summary>
''' Calculates the flowsheet objects asynchronously. This function is always called from a task or a different thread other than UI's.
''' </summary>
''' <param name="fobj">Flowsheet to calculate (FormChild object).</param>
''' <param name="objArgs">A CalculationArgs object containing information about the object to be calculated and its current status.</param>
''' <param name="ct">The cancellation token, used to listen for calculation cancellation requests from the user.</param>
''' <remarks></remarks>
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
''' <summary>
''' Calculates a material stream object asynchronously. This function is always called from a task or a different thread other than UI's.
''' </summary>
''' <param name="fobj">Flowsheet to what the stream belongs to.</param>
''' <param name="ms">Material Stream object to be calculated.</param>
''' <param name="ct">The cancellation token, used to listen for calculation cancellation requests from the user.</param>
''' <remarks></remarks>
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
''' <summary>
''' Process the calculation queue of the Flowsheet passed as an argument. Checks all elements in the queue and calculates them.
''' </summary>
''' <param name="fobj">Flowsheet to be calculated (FormChild object)</param>
''' <remarks></remarks>
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
''' <summary>
''' This is the internal routine called by ProcessCalculationQueue when a background thread is used to calculate the flowsheet.
''' </summary>
''' <param name="fobj">Flowsheet to be calculated (FormChild object)</param>
''' <param name="ct">The cancellation token, used to listen for calculation cancellation requests from the user.</param>
''' <remarks></remarks>
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
''' <summary>
''' Checks the calculator status to see if the user did any stop/abort request, and throws an exception to force aborting, if necessary.
''' </summary>
''' <remarks></remarks>
''' <summary>
''' This routine updates the display status of a list of graphic objects in the flowsheet according to their calculated status.
''' </summary>
''' <param name="fobj">Flowsheet to be calculated (FormChild object).</param>
''' <param name="ObjIDlist">List of object IDs to be updated.</param>
''' <param name="calculating">Tell the routine that the objects in the list are being calculated at the moment.</param>
''' <remarks></remarks>
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
''' <summary>
''' Retrieves the list of objects to be solved in the flowsheet.
''' </summary>
''' <param name="fobj">Flowsheet to be calculated (FormChild object)</param>
''' <param name="frompgrid">Starts the search from the edited object if the propert was changed from the property grid.</param>
''' <returns>A list of objects to be calculated in the flowsheet.</returns>
''' <remarks></remarks>
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
''' <summary>
''' Calculate all objects in the Flowsheet using an ordering method.
''' </summary>
''' <param name="fobj">Flowsheet to be calculated (FormFlowsheet object).</param>
''' <param name="Adjusting">True if the routine is called from the Simultaneous Adjust Solver.</param>
''' <param name="frompgrid">True if the routine is called from a PropertyGrid PropertyChanged event.</param>
''' <remarks></remarks>
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
''' <summary>
''' Async simultaneous adjust solver routine.
''' </summary>
''' <param name="fobj">Flowsheet where the object belongs to.</param>
''' <param name="ct">The cancellation token, used to listen for calculation cancellation requests from the user.</param>
''' <remarks>Solves all marked Adjust objects in the flowsheet simultaneously using Netwon's method.</remarks>
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
''' <summary>
''' Function called asynchronously by the simultaneous adjust solver. Retrieves the error function value for each adjust object.
''' </summary>
''' <param name="fobj">Flowsheet where the object belongs to.</param>
''' <param name="x"></param>
''' <param name="ct">The cancellation token, used to listen for calculation cancellation requests from the user.</param>
''' <returns></returns>
''' <remarks></remarks>
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
''' <summary>
''' Gradient function called asynchronously by the simultaneous adjust solver. Retrieves the gradient of the error function value for each adjust object.
''' </summary>
''' <param name="fobj">Flowsheet where the object belongs to.</param>
''' <param name="x"></param>
''' <param name="ct">The cancellation token, used to listen for calculation cancellation requests from the user.</param>
''' <returns></returns>
''' <remarks></remarks>
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
''' <summary>
''' Gets the controlled variable value for the selected adjust op.
''' </summary>
''' <param name="fobj"></param>
''' <param name="adj"></param>
''' <returns></returns>
''' <remarks></remarks>
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
''' <summary>
''' Gets the manipulated variable value for the selected adjust op.
''' </summary>
''' <param name="fobj"></param>
''' <param name="adj"></param>
''' <returns></returns>
''' <remarks></remarks>
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
''' <summary>
''' Sets the manipulated variable value for the selected adjust op.
''' </summary>
''' <param name="fobj"></param>
''' <param name="adj"></param>
''' <returns></returns>
''' <remarks></remarks>
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
''' <summary>
''' Gets the referenced variable value for the selected adjust op.
''' </summary>
''' <param name="fobj"></param>
''' <param name="adj"></param>
''' <returns></returns>
''' <remarks></remarks>
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
|