Change default solver for nonlinear algebraic systems to kinsol (#1121)

Author: lochel

src/OMSimulatorLib/Flags.cpp

@@ -64,7 +64,7 @@ oms::Flags::~Flags()
 void oms::Flags::setDefaults()
 {
   addParametersToCSV = false;
-  algLoopSolver = oms_alg_solver_fixedpoint;
+  algLoopSolver = oms_alg_solver_kinsol;
   defaultModeIsCS = false;
   deleteTempFiles = true;
   dumpAlgLoops = false;

src/OMSimulatorLib/Flags.h

@@ -144,7 +144,7 @@ namespace oms
     const std::vector<Flag> flags = {
       {"", "", "FMU or SSP file", re_filename, Flags::Filename, false},
       {"--addParametersToCSV", "", "Export parameters to .csv file (true, [false])", re_default, Flags::AddParametersToCSV, false},
-      {"--algLoopSolver", "", "Specifies the alg. loop solver method ([fixedpoint], kinsol) used for algebraic loops spanning over multiple components.", re_default, Flags::AlgLoopSolver, false},
+      {"--algLoopSolver", "", "Specifies the alg. loop solver method (fixedpoint, [kinsol]) used for algebraic loops spanning over multiple components.", re_default, Flags::AlgLoopSolver, false},
       {"--clearAllOptions", "", "Reset all flags to default values", re_void, Flags::ClearAllOptions, false},
       {"--deleteTempFiles", "", "Deletes temp files as soon as they are no longer needed ([true], false)", re_bool, Flags::DeleteTempFiles, false},
       {"--dumpAlgLoops", "", "Dump information for alg loops (true, [false])", re_bool, Flags::DumpAlgLoops, false},

testsuite/simulation/Makefile

@@ -12,6 +12,7 @@ DualMassOscillator.lua \
 Enumeration.lua \
 Enumeration2.lua \
 equationPair.py \
+equationPair_fixedpoint.py \
 exportConnectorsToResultFile.lua \
 exportSnapshotSSP.lua \
 exportSSMTemplate.lua \

testsuite/simulation/equationPair.py

@@ -1,5 +1,5 @@
 ## status: correct
-## teardown_command: rm -rf equationPair-py/
+## teardown_command: rm -rf equationPair/
 ## linux: no
 ## mingw32: no
 ## mingw64: yes
@@ -9,7 +9,7 @@
 import OMSimulator as oms
 
 oms.setCommandLineOption("--suppressPath=true --algLoopSolver=kinsol --dumpAlgLoops=true")
-oms.setTempDirectory("./equationPair-py/")
+oms.setTempDirectory("./equationPair/")
 
 model = oms.newModel("equationPair")
 root = model.addSystem('root', oms.Types.System.WC)

testsuite/simulation/equationPair_fixedpoint.py

@@ -0,0 +1,76 @@
+## status: correct
+## teardown_command: rm -rf equationPair_fixedpoint/
+## linux: no
+## mingw32: no
+## mingw64: yes
+## win: yes
+## mac: no
+
+import OMSimulator as oms
+
+oms.setCommandLineOption("--suppressPath=true --algLoopSolver=fixedpoint --dumpAlgLoops=true --maxLoopIteration=3")
+oms.setTempDirectory("./equationPair_fixedpoint/")
+
+model = oms.newModel("equationPair")
+root = model.addSystem('root', oms.Types.System.WC)
+
+# instantiate FMUs
+root.addSubModel('equation1', '../resources/equationPair.equation1.fmu')
+root.addSubModel('equation2', '../resources/equationPair.equation2.fmu')
+
+# add connections
+root.addConnection('equation1.x1', 'equation2.x1')
+root.addConnection('equation1.x2', 'equation2.x2')
+
+# simulation settings
+model.resultFile = ''
+model.stopTime = 0.0
+
+model.instantiate()
+try:
+  model.initialize()
+except:
+  pass
+finally:
+  model.terminate()
+  model.delete()
+
+## Result:
+## info:    Alg. loop (size 2)
+##            equationPair.root.equation1
+##            equationPair.root.equation2
+## info:    iteration 1
+##          inputs:
+##            equation2.x2: 8.4
+##            equation1.x1: 4
+##          outputs:
+##            equation1.x2: 2
+##            equation2.x1: 54.4
+##          residuals:
+##            res[0]: 6.4
+##            res[1]: -50.4
+## info:    iteration 2
+##          inputs:
+##            equation2.x2: 2
+##            equation1.x1: 54.4
+##          outputs:
+##            equation1.x2: -1175.34
+##            equation2.x1: 16
+##          residuals:
+##            res[0]: 1177.34
+##            res[1]: 38.4
+## info:    iteration 3
+##          inputs:
+##            equation2.x2: -1175.34
+##            equation1.x1: 16
+##          outputs:
+##            equation1.x2: -94
+##            equation2.x1: -7048.06
+##          residuals:
+##            res[0]: -1081.34
+##            res[1]: 7064.06
+## error:   [fixPointIteration] max. number of iterations (3) exceeded at time = 0.000000
+## error:   [initialize] Initialization of system "equationPair.root" failed
+## info:    0 warnings
+## info:    2 errors
+## endResult