[NB] update for equation handling (#12435)

- add the support of lists as iterator domains
 - ToDo: handling for events in for loops with list domains

Author: kabdelhak

OMCompiler/Compiler/BackEnd/BackendDAE.mo

@@ -666,12 +666,17 @@ uniontype ZeroCrossing
 end ZeroCrossing;
 
 public uniontype SimIterator
-  record SIM_ITERATOR
+  record SIM_ITERATOR_RANGE
     .DAE.ComponentRef name;
     Integer start;
     Integer step;
     Integer size;
-  end SIM_ITERATOR;
+  end SIM_ITERATOR_RANGE;
+  record SIM_ITERATOR_LIST
+    .DAE.ComponentRef name;
+    list<Integer> lst;
+    Integer size;
+  end SIM_ITERATOR_LIST;
 end SimIterator;
 
 public

OMCompiler/Compiler/BackEnd/BackendDump.mo

@@ -1819,7 +1819,10 @@ public function simIteratorString
   input BackendDAE.SimIterator iter;
   output String str;
 algorithm
-  str := ComponentReference.printComponentRefStr(iter.name) + " in " + intString(iter.start) + ":" + intString(iter.step) + ":" + intString(iter.start + iter.size);
+  str := match iter
+    case BackendDAE.SIM_ITERATOR_RANGE()  then ComponentReference.printComponentRefStr(iter.name) + " in " + intString(iter.start) + ":" + intString(iter.step) + ":" + intString(iter.start + iter.size);
+    case BackendDAE.SIM_ITERATOR_LIST()   then ComponentReference.printComponentRefStr(iter.name) + " in " + List.toString(iter.lst, intString, "", "{", ", ", "}", true, 10);
+  end match;
 end simIteratorString;
 
 // =============================================================================

OMCompiler/Compiler/NBackEnd/Util/NBSlice.mo

@@ -1423,6 +1423,8 @@ protected
         Expression range;
         Integer start, step, stop;
         list<tuple<Integer, Integer>> ranges;
+        list<Expression> iterator_exps;
+        list<Integer> iterator_lst;
 
       // only occurs for non-for-loop equations (no frames to replace)
       case {} algorithm
@@ -1431,9 +1433,22 @@ protected
 
       // extract numeric information about the range
       case (iterator, range) :: rest algorithm
-        (start, step, stop) := Expression.getIntegerRange(range);
+        iterator_lst := match range
+          case Expression.RANGE() algorithm
+            (start, step, stop) := Expression.getIntegerRange(range);
+          then List.intRange3(start,step, stop);
+          case Expression.ARRAY() algorithm
+            iterator_exps := list(Expression.map(e, function Replacements.applySimpleExp(replacements = replacements)) for e in range.elements);
+            iterator_lst  := list(Expression.integerValue(SimplifyExp.simplifyDump(e, true, getInstanceName())) for e in iterator_exps);
+          then iterator_lst;
+          else algorithm
+            Error.addMessage(Error.INTERNAL_ERROR,{getInstanceName() + " failed because iterator binding could not be parsed: "
+              + ComponentRef.toString(iterator) + " in " + Expression.toString(range)});
+          then fail();
+        end match;
+
         // traverse every index in the range
-        for index in start:step:stop loop
+        for index in iterator_lst loop
           UnorderedMap.add(iterator, Expression.INTEGER(index), replacements);
           if listEmpty(rest) then
             // bottom line, resolve current configuration and create index for it

OMCompiler/Compiler/NSimCode/NSimGenericCall.mo

@@ -152,16 +152,27 @@ public
   end convert;
 
   uniontype SimIterator
-    record SIM_ITERATOR
+    record SIM_ITERATOR_RANGE
       ComponentRef name;
       Integer start;
       Integer step;
       Integer size;
-    end SIM_ITERATOR;
+    end SIM_ITERATOR_RANGE;
+
+    record SIM_ITERATOR_LIST
+      ComponentRef name;
+      list<Integer> lst;
+      Integer size;
+    end SIM_ITERATOR_LIST;
 
     function toString
       input SimIterator iter;
-      output String str = "{" + ComponentRef.toString(iter.name) + " | start:" + intString(iter.start) + ", step:" + intString(iter.step) + ", size: " + intString(iter.size) + "}";
+      output String str;
+    algorithm
+      str := match iter
+        case SIM_ITERATOR_RANGE() then "{" + ComponentRef.toString(iter.name) + " | start:" + intString(iter.start) + ", step:" + intString(iter.step) + ", size: " + intString(iter.size) + "}";
+        case SIM_ITERATOR_LIST()  then "{" + ComponentRef.toString(iter.name) + " | list: " + List.toString(iter.lst, intString, "", "{", ", ", "}", true, 10) + "}";
+      end match;
     end toString;
 
     function fromIterator
@@ -173,23 +184,37 @@ public
       ComponentRef name;
       Expression range;
       Integer start, step, stop;
+      list<Integer> lst;
     algorithm
       (names, ranges) := Iterator.getFrames(iter);
       for tpl in listReverse(List.zip(names, ranges)) loop
         (name, range) := tpl;
-        (start, step, stop) := match range
-          case Expression.RANGE() then (Expression.integerValue(range.start), Expression.integerValue(Util.getOptionOrDefault(range.step, Expression.INTEGER(1))), Expression.integerValue(range.stop));
+        sim_iter := match range
+          case Expression.RANGE() algorithm
+            start := Expression.integerValue(range.start);
+            step  := Expression.integerValue(Util.getOptionOrDefault(range.step, Expression.INTEGER(1)));
+            stop  := Expression.integerValue(range.stop);
+          then SIM_ITERATOR_RANGE(name, start, step, intDiv(stop-start,step)+1) :: sim_iter;
+
+          case Expression.ARRAY() guard(range.literal) algorithm
+            lst   := list(Expression.integerValue(e) for e in range.elements);
+          then SIM_ITERATOR_LIST(name, lst, listLength(lst)) :: sim_iter;
+
           else algorithm
-            Error.addMessage(Error.INTERNAL_ERROR,{getInstanceName() + " failed for incorrect range: " + Expression.toString(range)});
+            Error.addMessage(Error.INTERNAL_ERROR,{getInstanceName() + " failed for incorrect iterator domain: " + Expression.toString(range)});
           then fail();
         end match;
-        sim_iter := SIM_ITERATOR(name, start, step, intDiv(stop-start,step)+1) :: sim_iter;
       end for;
     end fromIterator;
 
     function convert
       input SimIterator iter;
-      output OldBackendDAE.SimIterator old_iter = OldBackendDAE.SIM_ITERATOR(ComponentRef.toDAE(iter.name), iter.start, iter.step, iter.size);
+      output OldBackendDAE.SimIterator old_iter;
+    algorithm
+      old_iter := match iter
+        case SIM_ITERATOR_RANGE() then OldBackendDAE.SIM_ITERATOR_RANGE(ComponentRef.toDAE(iter.name), iter.start, iter.step, iter.size);
+        case SIM_ITERATOR_LIST()  then OldBackendDAE.SIM_ITERATOR_LIST(ComponentRef.toDAE(iter.name), iter.lst, iter.size);
+      end match;
     end convert;
   end SimIterator;
 

OMCompiler/Compiler/SimCode/SimCodeUtil.mo

@@ -15864,9 +15864,12 @@ end getCMakeVersion;
 function getSimIteratorSize
   input list<BackendDAE.SimIterator> iters;
   output Integer size = 1;
+protected
+  Integer local_size;
 algorithm
   for iter in iters loop
-    size := size * iter.size;
+    local_size := match iter case BackendDAE.SIM_ITERATOR_RANGE() then iter.size; case BackendDAE.SIM_ITERATOR_LIST() then iter.size; end match;
+    size := size * local_size;
   end for;
 end getSimIteratorSize;
 

OMCompiler/Compiler/Template/CodegenC.tpl

@@ -4952,7 +4952,7 @@ template zeroCrossingTpl(Integer index1, Exp relation, Option<list<SimIterator>>
   let &preExp = buffer ""
   let &sub = buffer ""
   let forHead = match iter
-    case SOME(iter_) then (iter_ |> it as SIM_ITERATOR(__) =>
+    case SOME(iter_) then (iter_ |> it =>
       forIterator(it, contextZeroCross, &preExp, &varDecls, &auxFunction, &sub)
       ;separator="\n";empty)
     else ""
@@ -4963,7 +4963,7 @@ template zeroCrossingTpl(Integer index1, Exp relation, Option<list<SimIterator>>
     else ""
   let tmp_ = match iter case SOME(iter_) then "+tmp" else ""
   let forTail = match iter
-    case SOME(iter_) then (iter_ |> it as SIM_ITERATOR(__) => "}";separator="\n";empty)
+    case SOME(iter_) then (iter_ |> it => "}";separator="\n";empty)
     else ""
   match relation
   case exp as RELATION(__) then
@@ -5124,7 +5124,7 @@ template relationTpl(Integer index1, Exp relation, Option<list<SimIterator>> ite
 let &preExp = buffer ""
   let &sub = buffer ""
   let forHead = match iter
-    case SOME(iter_) then (iter_ |> it as SIM_ITERATOR(__) =>
+    case SOME(iter_) then (iter_ |> it =>
       forIterator(it, contextZeroCross, &preExp, &varDecls, &auxFunction, &sub)
       ;separator="\n";empty)
     else ""
@@ -5135,7 +5135,7 @@ let &preExp = buffer ""
     else ""
   let tmp_ = match iter case SOME(iter_) then "+tmp" else ""
   let forTail = match iter
-    case SOME(iter_) then (iter_ |> it as SIM_ITERATOR(__) => "}";separator="\n";empty)
+    case SOME(iter_) then (iter_ |> it => "}";separator="\n";empty)
     else ""
   match relation
   case exp as RELATION(__) then
@@ -7438,33 +7438,53 @@ end genericBranch;
 
 template genericIterator(SimIterator iter, Context context, Text &preExp, Text &varDecls, Text &auxFunction, Text &sub)
 ::= match iter
-  case SIM_ITERATOR() then
-  let iter_ = contextCref(name, contextOther, &preExp, &varDecls, &auxFunction, &sub)
-  <<
-  int <%iter_%>_loc = tmp % <%size%>;
-  int <%iter_%> = <%step%> * <%iter_%>_loc + <%start%>;
-  tmp /= <%size%>;
-  >>
+  case SIM_ITERATOR_RANGE() then
+    let iter_ = contextCref(name, contextOther, &preExp, &varDecls, &auxFunction, &sub)
+    <<
+    int <%iter_%>_loc = tmp % <%size%>;
+    int <%iter_%> = <%step%> * <%iter_%>_loc + <%start%>;
+    tmp /= <%size%>;
+    >>
+  case SIM_ITERATOR_LIST() then
+    let iter_ = contextCref(name, contextOther, &preExp, &varDecls, &auxFunction, &sub)
+    let arr = (lst |> elem => '<%elem%>'; separator=", ")
+    <<
+    static const int <%iter_%>_lst[<%size%>] = {<%arr%>};
+    int <%iter_%>_loc = tmp % <%size%>;
+    int <%iter_%> = <%iter_%>_lst[<%iter_%>_loc];
+    tmp /= <%size%>;
+    >>
 end genericIterator;
 
 template forIterator(SimIterator iter, Context context, Text &preExp, Text &varDecls, Text &auxFunction, Text &sub)
 ::= match iter
-  case SIM_ITERATOR() then
-  let iter_ = contextCref(name, contextOther, &preExp, &varDecls, &auxFunction, &sub)
-  let rel = if intGt(step, 0) then "<" else ">"
-  let sign = if intGt(step, 0) then "+" else "-"
-  <<
-  for(int <%iter_%>=<%start%>; <%iter_%><%rel%><%start%><%sign%><%size%>; <%iter_%>+=<%step%>){
-  >>
+  case SIM_ITERATOR_RANGE() then
+    let iter_ = contextCref(name, contextOther, &preExp, &varDecls, &auxFunction, &sub)
+    let rel = if intGt(step, 0) then "<" else ">"
+    let sign = if intGt(step, 0) then "+" else "-"
+    <<
+    for(int <%iter_%>=<%start%>; <%iter_%><%rel%><%start%><%sign%><%size%>; <%iter_%>+=<%step%>){
+    >>
+  case SIM_ITERATOR_LIST() then
+    let iter_ = contextCref(name, contextOther, &preExp, &varDecls, &auxFunction, &sub)
+    <<
+    for(int <%iter_%>_=0; <%iter_%>_<<%size%>; <%iter_%>_++){
+      <%iter_%> = <%iter_%>_lst[<%iter_%>_];
+    >>
 end forIterator;
 
 template forIteratorBody(SimIterator iter, Context context, Text &preExp, Text &varDecls, Text &auxFunction, Text &sub)
 ::= match iter
-  case SIM_ITERATOR() then
-  let iter_ = contextCref(name, contextOther, &preExp, &varDecls, &auxFunction, &sub)
-  <<
-  (<%iter_%>-<%start%>)/<%step%>+<%size%>*(
-  >>
+  case SIM_ITERATOR_RANGE() then
+    let iter_ = contextCref(name, contextOther, &preExp, &varDecls, &auxFunction, &sub)
+    <<
+    (<%iter_%>-<%start%>)/<%step%>+<%size%>*(
+    >>
+  case SIM_ITERATOR_LIST() then
+    let iter_ = contextCref(name, contextOther, &preExp, &varDecls, &auxFunction, &sub)
+    <<
+    <%iter_%>_+<%size%>*(
+    >>
 end forIteratorBody;
 
 template genericCallHeaders(list<SimGenericCall> genericCalls, Context context)

OMCompiler/Compiler/Template/SimCodeTV.mo

@@ -1654,12 +1654,17 @@ package BackendDAE
   end ZeroCrossing;
 
   uniontype SimIterator
-    record SIM_ITERATOR
+    record SIM_ITERATOR_RANGE
       DAE.ComponentRef name;
       Integer start;
       Integer step;
       Integer size;
-    end SIM_ITERATOR;
+    end SIM_ITERATOR_RANGE;
+    record SIM_ITERATOR_LIST
+      DAE.ComponentRef name;
+      list<Integer> lst;
+      Integer size;
+    end SIM_ITERATOR_LIST;
   end SimIterator;
 
   uniontype TimeEvent

testsuite/simulation/modelica/NBackend/array_handling/Makefile

@@ -8,6 +8,7 @@ diagonal_slice_for.mos\
 exemplary.mos\
 simple_der_for.mos\
 for_exp.mos\
+for_list.mos\
 
 # test that currently fail. Move up when fixed.
 # Run make failingtest

testsuite/simulation/modelica/NBackend/array_handling/for_list.mos

@@ -0,0 +1,34 @@
+// name: for_list
+// keywords: NewBackend
+// status: correct
+
+loadString("
+model for_list
+  Real[7] x;
+equation
+  for i in {1,3,7} loop
+    x[i] = time + i;
+  end for;
+  for i in {2,4,5,6} loop
+    x[i] = time * i;
+  end for;
+end for_list;
+"); getErrorString();
+
+setCommandLineOptions("--newBackend");
+
+simulate(for_list); getErrorString();
+
+// Result:
+// true
+// ""
+// true
+// record SimulationResult
+//     resultFile = "for_list_res.mat",
+//     simulationOptions = "startTime = 0.0, stopTime = 1.0, numberOfIntervals = 500, tolerance = 1e-6, method = 'dassl', fileNamePrefix = 'for_list', options = '', outputFormat = 'mat', variableFilter = '.*', cflags = '', simflags = ''",
+//     messages = "LOG_SUCCESS       | info    | The initialization finished successfully without homotopy method.
+// LOG_SUCCESS       | info    | The simulation finished successfully.
+// "
+// end SimulationResult;
+// ""
+// endResult