[DAEMode] Several improvments to the DAEmode

- use sorting information to traverse equations
- fixing event update using ida solver
- added compilation debug flag: debugDAEmode
- better handling of algebraic state variables

Belonging to [master]:
  - #2242

Author: Willi Braun

Compiler/BackEnd/BackendDAE.mo

@@ -847,20 +847,15 @@ end CompInfo;
 public
 uniontype BackendDAEModeData
   record BDAE_MODE_DATA
-    Integer numAuxVars;
-    list<Var> auxVars;
+    list<Var> stateVars;
+    list<Var> algStateVars;
 
     Integer numResVars;
-    list<Var> resVars;
 
-    Integer numAuxEqns;
-    list<Equation> auxEqns;
-
-    Integer numResEqns;
-    list<Equation> resEqns;
+    Option<Variables> modelVars;
   end BDAE_MODE_DATA;
 end BackendDAEModeData;
-constant BackendDAEModeData emptyDAEModeData = BDAE_MODE_DATA(0,{},0,{},0,{},0,{});
+constant BackendDAEModeData emptyDAEModeData = BDAE_MODE_DATA({},{},0,NONE());
 
 annotation(__OpenModelica_Interface="backend");
 end BackendDAE;

Compiler/BackEnd/BackendDAEUtil.mo

@@ -9037,6 +9037,50 @@ algorithm
   comps := Sorting.TarjanTransposed(mT, ass2);
 end causalizeVarBindSystem;
 
+public function traverseEqSystemStrongComponents
+"This function goes through the strong components of a EqSystem and pass
+ the variables and equation with their indexes to the traversing function.
+ It fail if the EqSytem does not have the matching and strong components are
+ empty. It does not change the input EqSystem."
+  replaceable type Type_a subtypeof Any;
+  input BackendDAE.EqSystem syst;
+  input FuncExpType func;
+  input Type_a inTypeA;
+  output Type_a outTypeA = inTypeA;
+  partial function FuncExpType
+    input list<BackendDAE.Equation> inEqns;
+    input list<BackendDAE.Var> inVars;
+    input list<Integer> varIdxs;
+    input list<Integer> eqnIdxs;
+    input Type_a inA;
+    output Type_a outA;
+  end FuncExpType;
+protected
+  BackendDAE.StrongComponents comps;
+  BackendDAE.Variables varArr;
+  BackendDAE.EquationArray eqnArr;
+  list<BackendDAE.Var> vars;
+  list<BackendDAE.Equation> eqns;
+  list<Integer> varIdxs, eqnIdxs;
+  String name;
+algorithm
+  try
+    BackendDAE.EQSYSTEM(matching    = BackendDAE.MATCHING(comps=comps),
+                        orderedVars = varArr,
+                        orderedEqs  = eqnArr) := syst;
+
+    for component in comps loop
+      (vars, varIdxs, eqns, eqnIdxs) := getStrongComponentVarsAndEquations(component, varArr, eqnArr);
+      outTypeA := func(eqns, vars, varIdxs, eqnIdxs, outTypeA);
+    end for;
+  else
+    (_, _, name) := System.dladdr(func);
+    Error.addInternalError("BackendDAEUtil.traverseEqSystemStrongComponents failed
+                            with function:\n" +  name + "\n", sourceInfo());
+    fail();
+  end try;
+end traverseEqSystemStrongComponents;
+
 public function getStrongComponentsVarsAndEquations"gets the variables and and the equations from all sccs.
 author: Waurich TUD 09-2015"
   input BackendDAE.StrongComponents comps;

Compiler/BackEnd/BackendDump.mo

@@ -4564,6 +4564,24 @@ algorithm
   str := ComponentReference.printComponentRefStr(Util.tuple21(tpl)) + " -> " + ComponentReference.printComponentRefStr(Util.tuple22(tpl));
 end printStateOrderStr;
 
+public function dumpBackendDAEModeData
+  input BackendDAE.BackendDAEModeData inDAEmodeData;
+protected
+  BackendDAE.Variables modelVars;
+algorithm
+  print("\n" + BORDER + "\nDAEMode\n" + UNDERLINE + "\n");
+  if isSome(inDAEmodeData.modelVars) then
+    SOME(modelVars) := inDAEmodeData.modelVars;
+    dumpVariables(modelVars, "ModelVariables");
+  else
+    print("No ModelVariables\n");
+  end if;
+  print("DAEmode System:\n " + intString(inDAEmodeData.numResVars) + " residual variables\n " +
+        intString(listLength(inDAEmodeData.stateVars)) + " state variables\n " +
+        intString(listLength(inDAEmodeData.algStateVars)) + " algebraic state variables\n");
+  dumpVarList(inDAEmodeData.stateVars, "State Variables");
+  dumpVarList(inDAEmodeData.algStateVars, "Algebraic State Variables");
+end dumpBackendDAEModeData;
 
 annotation(__OpenModelica_Interface="backend");
 end BackendDump;

Compiler/BackEnd/CommonSubExpression.mo

@@ -1575,7 +1575,7 @@ algorithm
   end match;
 end createVarsForExp;
 
-protected function isCSECref
+public function isCSECref
 "Returns true if the cref is prefixed with '$cse'"
   input DAE.ComponentRef cr;
   output Boolean b;