Better flag handling for different homotopy approaches

Belonging to [master]:
  - OpenModelica/OMCompiler#2019
  - OpenModelica/OpenModelica-testsuite#781

Author: ptaeuber

Compiler/BackEnd/BackendDAEOptimize.mo

@@ -5706,19 +5706,22 @@ protected
   BackendDAE.StrongComponents comps;
   BackendDAE.EqSystems newEqSystems={};
   array<Integer> ass1, ass2;
-  Boolean globalHomotopy = stringEq(Flags.getConfigString(Flags.HOMOTOPY_APPROACH), "global");
 algorithm
-  for syst in outDAE.eqs loop
-    BackendDAE.MATCHING(ass1=ass1, ass2=ass2, comps=comps) := syst.matching;
-    if globalHomotopy then
-      (comps, syst) := traverseStrongComponentsForHomotopyLoop(comps, syst);
-    else
-      (comps, syst) := traverseStrongComponentsAddLambda(comps, syst);
-    end if;
-    syst.matching := BackendDAE.MATCHING(ass1=ass1, ass2=ass2, comps=comps);
-    newEqSystems := syst::newEqSystems;
-  end for;
-  outDAE.eqs := listReverse(newEqSystems);
+  if Config.adaptiveHomotopy() then
+    for syst in outDAE.eqs loop
+      BackendDAE.MATCHING(ass1=ass1, ass2=ass2, comps=comps) := syst.matching;
+      if Config.globalHomotopy() then
+        (comps, syst) := traverseStrongComponentsForHomotopyLoop(comps, syst);
+      else
+        (comps, syst) := traverseStrongComponentsAddLambda(comps, syst);
+      end if;
+      syst.matching := BackendDAE.MATCHING(ass1=ass1, ass2=ass2, comps=comps);
+      newEqSystems := syst::newEqSystems;
+    end for;
+    outDAE.eqs := listReverse(newEqSystems);
+  else
+    Error.addCompilerWarning("InitOptModule generateHomotopyComponents is activated for an equidistant homotopy method and will therefore be ignored.");
+  end if;
 end generateHomotopyComponents;
 
 protected function traverseStrongComponentsForHomotopyLoop " traverses all the strong components and finds the smallest homotopy loop

Compiler/BackEnd/Initialization.mo

@@ -95,7 +95,7 @@ protected
   BackendDAE.Variables vars, fixvars;
   Boolean b, b1, b2, useHomotopy;
   String msg;
-  list<String> disabledModules;
+  list<String> enabledModules, disabledModules;
   HashSet.HashSet hs "contains all pre variables";
   list<BackendDAE.Equation> removedEqns;
   list<BackendDAE.Var> dumpVars, dumpVars2, outAllPrimaryParameters;
@@ -228,15 +228,14 @@ algorithm
 
 
     if useHomotopy then
+      enabledModules := if Config.adaptiveHomotopy() then {"inlineHomotopy", "generateHomotopyComponents"} else {};
       disabledModules := {};
     else
+      enabledModules := {};
       disabledModules := {"inlineHomotopy", "generateHomotopyComponents"};
     end if;
 
-    initOptModules := BackendDAEUtil.getInitOptModules(NONE(), {}, disabledModules);
-    if BackendDAEUtil.isInitOptModuleActivated("generateHomotopyComponents", initOptModules) and not BackendDAEUtil.isInitOptModuleActivated("inlineHomotopy", initOptModules) then
-      initOptModules := (BackendDAEOptimize.inlineHomotopy, "inlineHomotopy")::initOptModules;
-    end if;
+    initOptModules := BackendDAEUtil.getInitOptModules(NONE(), enabledModules, disabledModules);
     matchingAlgorithm := BackendDAEUtil.getMatchingAlgorithm(NONE());
     daeHandler := BackendDAEUtil.getIndexReductionMethod(SOME("none"));
     initdae := BackendDAEUtil.postOptimizeDAE(initdae, initOptModules, matchingAlgorithm, daeHandler);
@@ -249,7 +248,7 @@ algorithm
     end if;
 
     // compute system for lambda=0
-    if useHomotopy and stringEq(Flags.getConfigString(Flags.HOMOTOPY_APPROACH), "global") then
+    if useHomotopy and Config.globalHomotopy() then
       initOptModulesLambda0 := BackendDAEUtil.getInitOptModules(NONE(),{"replaceHomotopyWithSimplified"},{"inlineHomotopy", "generateHomotopyComponents"});
       initdae0 := BackendDAEUtil.setFunctionTree(initdae0, BackendDAEUtil.getFunctions(initdae.shared));
       initdae0 := BackendDAEUtil.postOptimizeDAE(initdae0, initOptModulesLambda0, matchingAlgorithm, daeHandler);

Compiler/Template/CodegenC.tpl

@@ -1080,7 +1080,7 @@ template simulationFile(SimCode simCode, String guid, Boolean isModelExchangeFMU
        <%symbolName(modelNamePrefixStr,"function_storeDelayed")%>,
        <%symbolName(modelNamePrefixStr,"updateBoundVariableAttributes")%>,
        <%symbolName(modelNamePrefixStr,"functionInitialEquations")%>,
-       <%if listEmpty(initialEquations_lambda0) then (if not BackendDAEUtil.isInitOptModuleActivated("generateHomotopyComponents") then '0' else '3') else if not BackendDAEUtil.isInitOptModuleActivated("generateHomotopyComponents") then '1' else '2'%>, /* useHomotopy - 0: no homotopy or local homotopy (equidistant lambda), 1: global homotopy (equidistant lambda), 2: new global homotopy approach, 3: new local homotopy approach */
+       <%if Config.adaptiveHomotopy() then (if Config.globalHomotopy() then '2' else '3') else (if Config.globalHomotopy() then '1' else '0')%>, /* useHomotopy - 0: local homotopy (equidistant lambda), 1: global homotopy (equidistant lambda), 2: new global homotopy approach (adaptive lambda), 3: new local homotopy approach (adaptive lambda)*/
        <%symbolName(modelNamePrefixStr,"functionInitialEquations_lambda0")%>,
        <%symbolName(modelNamePrefixStr,"functionRemovedInitialEquations")%>,
        <%symbolName(modelNamePrefixStr,"updateBoundParameters")%>,

Compiler/Template/SimCodeTV.mo

@@ -3424,6 +3424,14 @@ package Config
   function typeinfo
     output Boolean flag;
   end typeinfo;
+
+  function globalHomotopy
+    output Boolean outBoolean;
+  end globalHomotopy;
+
+  function adaptiveHomotopy
+    output Boolean outBoolean;
+  end adaptiveHomotopy;
 end Config;
 
 package Flags
@@ -3567,13 +3575,6 @@ package DAEUtil
 
 end DAEUtil;
 
-package BackendDAEUtil
-  function isInitOptModuleActivated
-    input String initOptModule;
-    output Boolean isActivated;
-  end isInitOptModuleActivated;
-end BackendDAEUtil;
-
 package Types
   function getDimensionSizes
     input DAE.Type inType;

Compiler/Util/Config.mo

@@ -613,5 +613,27 @@ algorithm
   outBoolean := Flags.getConfigBool(Flags.IGNORE_COMMAND_LINE_OPTIONS_ANNOTATION);
 end ignoreCommandLineOptionsAnnotation;
 
+public function globalHomotopy
+  output Boolean outBoolean;
+algorithm
+  outBoolean := match(Flags.getConfigString(Flags.HOMOTOPY_APPROACH))
+    case("equidistantLocal") then false;
+    case("adaptiveLocal") then false;
+    case("equidistantGlobal") then true;
+    case("adaptiveGlobal") then true;
+  end match;
+end globalHomotopy;
+
+public function adaptiveHomotopy
+  output Boolean outBoolean;
+algorithm
+  outBoolean := match(Flags.getConfigString(Flags.HOMOTOPY_APPROACH))
+    case("equidistantLocal") then false;
+    case("adaptiveLocal") then true;
+    case("equidistantGlobal") then false;
+    case("adaptiveGlobal") then true;
+  end match;
+end adaptiveHomotopy;
+
 annotation(__OpenModelica_Interface="util");
 end Config;

Compiler/Util/Flags.mo

@@ -1390,10 +1390,12 @@ constant ConfigFlag ZEROMQ_FILE_SUFFIX = CONFIG_FLAG(115, "zeroMQFileSuffix",
   SOME("z"), EXTERNAL(), STRING_FLAG(""), NONE(),
   Util.gettext("Sets the file suffix for zeroMQ port file if --interactive=zmq is used."));
 constant ConfigFlag HOMOTOPY_APPROACH = CONFIG_FLAG(116, "homotopyApproach",
-  NONE(), EXTERNAL(), STRING_FLAG("global"),
+  NONE(), EXTERNAL(), STRING_FLAG("equidistantGlobal"),
   SOME(STRING_DESC_OPTION({
-    ("local", Util.gettext("Local homotopy approach. The homotopy parameter only effects the local strongly connected component.")),
-    ("global", Util.gettext("Default, global homotopy approach. The homotopy parameter effects the entire initialization system."))
+    ("equidistantLocal", Util.gettext("Local homotopy approach with equidistant lambda steps. The homotopy parameter only effects the local strongly connected component.")),
+    ("adaptiveLocal", Util.gettext("Local homotopy approach with adaptive lambda steps. The homotopy parameter only effects the local strongly connected component.")),
+    ("equidistantGlobal", Util.gettext("Default, global homotopy approach with equidistant lambda steps. The homotopy parameter effects the entire initialization system.")),
+    ("adaptiveGlobal", Util.gettext("Global homotopy approach with adaptive lambda steps. The homotopy parameter effects the entire initialization system."))
     })),
     Util.gettext("Sets the homotopy approach."));
 

SimulationRuntime/c/simulation/solver/initialization/initialization.c

@@ -185,7 +185,18 @@ static int symbolic_initialization(DATA *data, threadData_t *threadData)
   FILE *pFile = NULL;
   long i;
   MODEL_DATA *mData = data->modelData;
-  int solveWithGlobalHomotopy = (data->callback->useHomotopy == 1 && init_lambda_steps > 1) || data->callback->useHomotopy == 2;
+  int homotopySupport = 0;
+  int solveWithGlobalHomotopy;
+
+#if !defined(OMC_NUM_NONLINEAR_SYSTEMS) || OMC_NUM_NONLINEAR_SYSTEMS>0
+  for(i=0; i<mData->nNonLinearSystems; i++) {
+    if (data->simulationInfo->nonlinearSystemData[i].homotopySupport) {
+      homotopySupport = 1;
+      break;
+    }
+  }
+#endif
+  solveWithGlobalHomotopy = homotopySupport && ((data->callback->useHomotopy == 1 && init_lambda_steps > 1) || data->callback->useHomotopy == 2);
 
 #if !defined(OMC_NDELAY_EXPRESSIONS) || OMC_NDELAY_EXPRESSIONS>0
   /* initial sample and delay before initial the system */