forked from OpenModelica/OpenModelica
-
Notifications
You must be signed in to change notification settings - Fork 0
/
NFFlatten.mo
2913 lines (2547 loc) · 87.6 KB
/
NFFlatten.mo
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
/*
* This file is part of OpenModelica.
*
* Copyright (c) 1998-CurrentYear, Linköping University,
* Department of Computer and Information Science,
* SE-58183 Linköping, Sweden.
*
* All rights reserved.
*
* THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3
* AND THIS OSMC PUBLIC LICENSE (OSMC-PL).
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES RECIPIENT'S
* ACCEPTANCE OF THE OSMC PUBLIC LICENSE.
*
* The OpenModelica software and the Open Source Modelica
* Consortium (OSMC) Public License (OSMC-PL) are obtained
* from Linköping University, either from the above address,
* from the URLs: http://www.ida.liu.se/projects/OpenModelica or
* http://www.openmodelica.org, and in the OpenModelica distribution.
* GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
*
* This program is distributed WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
* IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS
* OF OSMC-PL.
*
* See the full OSMC Public License conditions for more details.
*
*/
encapsulated package NFFlatten
" file: NFFlatten.mo
package: NFFlatten
description: Flattening
New instantiation, enable with -d=newInst.
"
import Binding = NFBinding;
import Equation = NFEquation;
import NFFunction.Function;
import NFInstNode.InstNode;
import Statement = NFStatement;
import FlatModel = NFFlatModel;
import Algorithm = NFAlgorithm;
import CardinalityTable = NFCardinalityTable;
protected
import Attributes = NFAttributes;
import ComponentRef = NFComponentRef;
import Dimension = NFDimension;
import ExecStat.execStat;
import ExpressionIterator = NFExpressionIterator;
import Expression = NFExpression;
import Flags;
import List;
import Call = NFCall;
import Class = NFClass;
import NFClassTree.ClassTree;
import Component = NFComponent;
import NFModifier.Modifier;
import Sections = NFSections;
import NFOCConnectionGraph;
import Prefixes = NFPrefixes;
import RangeIterator = NFRangeIterator;
import StringUtil;
import Subscript = NFSubscript;
import Type = NFType;
import Util;
import MetaModelica.Dangerous.listReverseInPlace;
import ConnectionSets = NFConnectionSets.ConnectionSets;
import Connection = NFConnection;
import Connector = NFConnector;
import ConnectEquations = NFConnectEquations;
import Connections = NFConnections;
import Face = NFConnector.Face;
import System;
import ComplexType = NFComplexType;
import NFInstNode.CachedData;
import NFPrefixes.{ConnectorType, Direction, Variability, Visibility, Purity, Parallelism};
import Variable = NFVariable;
import ElementSource;
import Ceval = NFCeval;
import SimplifyExp = NFSimplifyExp;
import Restriction = NFRestriction;
import EvalConstants = NFEvalConstants;
import SimplifyModel = NFSimplifyModel;
import InstNodeType = NFInstNode.InstNodeType;
import ExpandableConnectors = NFExpandableConnectors;
import SCodeUtil;
import DAE;
import Structural = NFStructural;
import ArrayConnections = NFArrayConnections;
import UnorderedMap;
import UnorderedSet;
import Inline = NFInline;
import ExpandExp = NFExpandExp;
import InstUtil = NFInstUtil;
public
type FunctionTree = FunctionTreeImpl.Tree;
encapsulated package FunctionTreeImpl
import Absyn.Path;
import NFFunction.Function;
import BaseAvlTree;
extends BaseAvlTree;
redeclare type Key = Absyn.Path;
redeclare type Value = Function;
redeclare function extends keyStr
algorithm
outString := AbsynUtil.pathString(inKey);
end keyStr;
redeclare function extends valueStr
algorithm
outString := "";
end valueStr;
redeclare function extends keyCompare
algorithm
outResult := AbsynUtil.pathCompareNoQual(inKey1, inKey2);
end keyCompare;
redeclare function addConflictDefault = addConflictKeep;
end FunctionTreeImpl;
uniontype FlattenSettings
record SETTINGS
Boolean scalarize;
Boolean arrayConnect;
Boolean nfAPI;
Boolean relaxedErrorChecking;
Boolean newBackend;
Boolean vectorizeBindings;
end SETTINGS;
end FlattenSettings;
uniontype Prefix
record PREFIX
InstNode root;
ComponentRef prefix;
end PREFIX;
record INDEXED_PREFIX
InstNode root;
ComponentRef prefix;
ComponentRef indexedPrefix;
end INDEXED_PREFIX;
function new
input InstNode root;
input Boolean indexed = false;
output Prefix prefix;
algorithm
prefix := if indexed then
INDEXED_PREFIX(root, ComponentRef.EMPTY(), ComponentRef.EMPTY()) else
PREFIX(root, ComponentRef.EMPTY());
end new;
function isEmpty
input Prefix prefix;
output Boolean empty;
algorithm
empty := match prefix
case PREFIX() then ComponentRef.isEmpty(prefix.prefix);
case INDEXED_PREFIX() then ComponentRef.isEmpty(prefix.indexedPrefix);
end match;
end isEmpty;
function isIndexed
input Prefix prefix;
output Boolean indexed;
algorithm
indexed := match prefix
case INDEXED_PREFIX() then true;
else false;
end match;
end isIndexed;
function push
input InstNode node;
input Type ty;
input list<Dimension> dims;
input output Prefix prefix;
algorithm
() := match prefix
case PREFIX()
algorithm
prefix.prefix := ComponentRef.prefixCref(node, ty, {}, prefix.prefix);
then
();
case INDEXED_PREFIX()
algorithm
prefix.prefix := ComponentRef.prefixCref(node, ty, {}, prefix.prefix);
prefix.indexedPrefix := ComponentRef.prefixCref(node, ty, {}, prefix.indexedPrefix);
prefix.indexedPrefix := ComponentRef.setSubscripts(makeBindingIterators(prefix.indexedPrefix, dims),
prefix.indexedPrefix);
then
();
end match;
end push;
function pop
input output Prefix prefix;
algorithm
() := match prefix
case PREFIX()
algorithm
prefix.prefix := ComponentRef.rest(prefix.prefix);
then
();
case INDEXED_PREFIX()
algorithm
prefix.prefix := ComponentRef.rest(prefix.prefix);
prefix.indexedPrefix := ComponentRef.rest(prefix.indexedPrefix);
then
();
end match;
end pop;
function prefix
input Prefix prefix;
output ComponentRef cref;
algorithm
cref := match prefix
case PREFIX() then prefix.prefix;
case INDEXED_PREFIX() then prefix.prefix;
end match;
end prefix;
function indexedPrefix
input Prefix prefix;
output ComponentRef cref;
algorithm
cref := match prefix
case PREFIX() then prefix.prefix;
case INDEXED_PREFIX() then prefix.indexedPrefix;
end match;
end indexedPrefix;
function toNonIndexedPrefix
input output Prefix prefix;
algorithm
prefix := match prefix
case PREFIX() then prefix;
case INDEXED_PREFIX() then PREFIX(prefix.root, prefix.prefix);
end match;
end toNonIndexedPrefix;
function apply
input Prefix prefix;
input output ComponentRef cref;
algorithm
cref := ComponentRef.transferSubscripts(indexedPrefix(prefix), cref);
end apply;
function subscript
input list<Subscript> subs;
input output Prefix prefix;
algorithm
() := match prefix
case PREFIX()
algorithm
prefix.prefix := ComponentRef.setSubscripts(subs, prefix.prefix);
then
();
case INDEXED_PREFIX()
algorithm
prefix.prefix := ComponentRef.setSubscripts(subs, prefix.prefix);
then
();
end match;
end subscript;
function toString
input Prefix pre;
output String str = ComponentRef.toString(prefix(pre));
end toString;
function rootNode
input Prefix pre;
output InstNode node;
algorithm
node := match pre
case PREFIX() then pre.root;
case INDEXED_PREFIX() then pre.root;
end match;
end rootNode;
function instanceName
input Prefix pre;
output String str;
algorithm
str := InstNode.name(rootNode(pre));
if not ComponentRef.isEmpty(indexedPrefix(pre)) then
str := str + "." + toString(pre);
end if;
end instanceName;
end Prefix;
constant Prefix EMPTY_PREFIX = Prefix.PREFIX(InstNode.EMPTY_NODE(), ComponentRef.EMPTY());
constant Prefix EMPTY_INDEXED_PREFIX = Prefix.INDEXED_PREFIX(InstNode.EMPTY_NODE(), ComponentRef.EMPTY(), ComponentRef.EMPTY());
function flatten
input InstNode classInst;
input Absyn.Path classPath;
input Boolean getConnectionResolved = true;
output FlatModel flatModel;
protected
Sections sections;
list<Variable> vars;
list<Equation> eql, ieql;
list<Algorithm> alg, ialg;
DAE.ElementSource src;
Option<SCode.Comment> cmt;
FlattenSettings settings;
UnorderedSet<ComponentRef> deleted_vars;
Prefix prefix;
algorithm
settings := FlattenSettings.SETTINGS(
Flags.isSet(Flags.NF_SCALARIZE),
Flags.isSet(Flags.ARRAY_CONNECT),
Flags.isSet(Flags.NF_API),
Flags.isSet(Flags.NF_API) or Flags.getConfigBool(Flags.CHECK_MODEL),
Flags.getConfigBool(Flags.NEW_BACKEND),
Flags.isSet(Flags.VECTORIZE_BINDINGS)
);
prefix := Prefix.new(classInst, indexed = settings.vectorizeBindings);
sections := Sections.EMPTY();
src := ElementSource.createElementSource(InstNode.info(classInst));
src := ElementSource.addCommentToSource(src,
SCodeUtil.getElementComment(InstNode.definition(classInst)));
deleted_vars := UnorderedSet.new(ComponentRef.hash, ComponentRef.isEqual);
(vars, sections) := flattenClass(InstNode.getClass(classInst), prefix,
Visibility.PUBLIC, NONE(), {}, sections, deleted_vars, settings);
vars := listReverseInPlace(vars);
flatModel := match sections
case Sections.SECTIONS()
algorithm
eql := listReverseInPlace(sections.equations);
ieql := listReverseInPlace(sections.initialEquations);
alg := listReverseInPlace(sections.algorithms);
ialg := listReverseInPlace(sections.initialAlgorithms);
then
FlatModel.FLAT_MODEL(classPath, vars, eql, ieql, alg, ialg, src);
else FlatModel.FLAT_MODEL(classPath, vars, {}, {}, {}, {}, src);
end match;
// get inputs and outputs for algorithms now that types are computed
flatModel.algorithms := list(Algorithm.setInputsOutputs(al) for al in flatModel.algorithms);
flatModel.initialAlgorithms := list(Algorithm.setInputsOutputs(al) for al in flatModel.initialAlgorithms);
execStat(getInstanceName());
InstUtil.dumpFlatModelDebug("flatten", flatModel);
if getConnectionResolved then
if settings.arrayConnect then
flatModel := resolveArrayConnections(flatModel);
else
flatModel := resolveConnections(flatModel, deleted_vars, settings);
end if;
InstUtil.dumpFlatModelDebug("connections", flatModel);
end if;
end flatten;
function flattenConnection
input InstNode classInst;
input Absyn.Path classPath;
output Connections conns;
protected
FlatModel flatModel;
UnorderedSet<ComponentRef> deleted_vars;
algorithm
flatModel := flatten(classInst, classPath, false);
deleted_vars := UnorderedSet.new(ComponentRef.hash, ComponentRef.isEqual);
// get the connections from the model
(flatModel, conns) := Connections.collectConnections(flatModel, function isDeletedConnector(deletedVars = deleted_vars));
// Elaborate expandable connectors.
(_, conns) := ExpandableConnectors.elaborate(flatModel, conns);
conns := Connections.collectFlows(flatModel, conns);
end flattenConnection;
function collectFunctions
input FlatModel flatModel;
output FunctionTree funcs;
algorithm
funcs := FunctionTree.new();
funcs := List.fold(flatModel.variables, collectComponentFuncs, funcs);
funcs := List.fold(flatModel.equations, collectEquationFuncs, funcs);
funcs := List.fold(flatModel.initialEquations, collectEquationFuncs, funcs);
funcs := List.fold(flatModel.algorithms, collectAlgorithmFuncs, funcs);
funcs := List.fold(flatModel.initialAlgorithms, collectAlgorithmFuncs, funcs);
execStat(getInstanceName());
end collectFunctions;
function fillVectorizedVariableBinding
input output Variable var;
protected
list<tuple<String, Binding>> ty_attrs = {};
String attr_name;
Binding attr_binding;
algorithm
var.binding := fillVectorizedBinding(var.binding, var.ty);
for ty_attr in var.typeAttributes loop
(attr_name, attr_binding) := ty_attr;
attr_binding := fillVectorizedBinding(attr_binding,
Type.copyDims(var.ty, Binding.getType(attr_binding)));
ty_attrs := (attr_name, attr_binding) :: ty_attrs;
end for;
var.typeAttributes := listReverseInPlace(ty_attrs);
end fillVectorizedVariableBinding;
protected
function flattenClass
input Class cls;
input Prefix prefix;
input Visibility visibility;
input Option<Binding> binding;
input output list<Variable> vars;
input output Sections sections;
input UnorderedSet<ComponentRef> deletedVars;
input FlattenSettings settings;
protected
array<InstNode> comps;
list<Binding> bindings = {};
Binding b;
algorithm
() := match cls
case Class.INSTANCED_CLASS(elements = ClassTree.FLAT_TREE(components = comps))
algorithm
if isSome(binding) then
SOME(b) := binding;
if Binding.isBound(b) then
b := flattenBinding(b, Prefix.pop(prefix));
bindings := getRecordBindings(b, comps, prefix);
end if;
end if;
if listEmpty(bindings) then
for c in comps loop
(vars, sections) := flattenComponent(c, prefix, visibility, binding, vars, sections, deletedVars, settings);
end for;
else
for c in comps loop
b :: bindings := bindings;
(vars, sections) := flattenComponent(c, prefix, visibility, SOME(b), vars, sections, deletedVars, settings);
end for;
end if;
sections := flattenSections(cls.sections, Prefix.toNonIndexedPrefix(prefix), sections, settings);
then
();
case Class.TYPED_DERIVED()
algorithm
(vars, sections) :=
flattenClass(InstNode.getClass(cls.baseClass), prefix, visibility, binding, vars, sections, deletedVars, settings);
then
();
case Class.INSTANCED_BUILTIN() then ();
else
algorithm
Error.assertion(false, getInstanceName() + " got non-instantiated component " + Prefix.toString(prefix) + "\n", sourceInfo());
then
();
end match;
end flattenClass;
function flattenComponent
input InstNode component;
input Prefix prefix;
input Visibility visibility;
input Option<Binding> outerBinding;
input output list<Variable> vars;
input output Sections sections;
input UnorderedSet<ComponentRef> deletedVars;
input FlattenSettings settings;
protected
InstNode comp_node;
Component c;
Type ty;
Binding condition;
Class cls;
Visibility vis;
list<Variable> children;
algorithm
// Remove components that are only outer.
if InstNode.isOnlyOuter(component) then
return;
end if;
comp_node := InstNode.resolveOuter(component);
c := InstNode.component(comp_node);
() := match c
case Component.COMPONENT(condition = condition, ty = ty)
algorithm
// Delete the component if it has a condition that's false.
if isDeletedComponent(condition, prefix) then
deleteComponent(component, prefix, deletedVars);
return;
end if;
cls := InstNode.getClass(c.classInst);
vis := if InstNode.isProtected(component) then Visibility.PROTECTED else visibility;
(vars, sections) := match getComponentType(ty, settings)
case ComponentType.COMPLEX
then flattenComplexComponent(comp_node, c, cls, ty,
vis, outerBinding, prefix, vars, sections, deletedVars, settings);
case ComponentType.NORMAL
then flattenSimpleComponent(comp_node, c, vis, outerBinding,
Class.getTypeAttributes(cls), prefix, vars, sections, settings, {});
case ComponentType.RECORD algorithm
(children, sections) := flattenComplexComponent(comp_node, c, cls, ty,
vis, outerBinding, prefix, {}, sections, deletedVars, settings);
then flattenSimpleComponent(comp_node, c, vis, outerBinding,
Class.getTypeAttributes(cls), prefix, vars, sections, settings, children);
else algorithm
Error.assertion(false, getInstanceName() + " got unknown component", sourceInfo());
then fail();
end match;
then
();
// A component that was already deleted during e.g. typing.
case _ guard Component.isDeleted(c)
algorithm
deleteComponent(component, prefix, deletedVars);
then
();
else
algorithm
Error.assertion(false, getInstanceName() + " got unknown component", sourceInfo());
then
fail();
end match;
end flattenComponent;
function isDeletedComponent
input Binding condition;
input Prefix prefix;
output Boolean isDeleted;
protected
Expression exp;
Binding cond;
algorithm
if Binding.isBound(condition) then
cond := flattenBinding(condition, prefix);
exp := Binding.getTypedExp(cond);
exp := Ceval.evalExp(exp, Ceval.EvalTarget.CONDITION(Binding.getInfo(cond)));
exp := Expression.expandSplitIndices(exp);
// Hack to make arrays work when all elements have the same value.
if Expression.arrayAllEqual(exp) then
exp := Expression.arrayFirstScalar(exp);
end if;
isDeleted := match exp
case Expression.BOOLEAN() then not exp.value;
else
algorithm
Error.addSourceMessage(Error.CONDITIONAL_EXP_WITHOUT_VALUE,
{Expression.toString(exp)}, Binding.getInfo(cond));
then
fail();
end match;
else
isDeleted := false;
end if;
end isDeletedComponent;
function deleteComponent
input InstNode node;
input Prefix prefix;
input UnorderedSet<ComponentRef> deletedVars;
protected
ComponentRef cref;
algorithm
cref := ComponentRef.prefixCref(node, Type.UNKNOWN(), {}, Prefix.prefix(prefix));
UnorderedSet.add(cref, deletedVars);
end deleteComponent;
function getComponentType
input Type ty;
input FlattenSettings settings;
output ComponentType compTy;
algorithm
compTy := match ty
case Type.COMPLEX(complexTy = ComplexType.EXTERNAL_OBJECT())
then ComponentType.NORMAL;
case Type.COMPLEX(complexTy = ComplexType.RECORD()) guard(settings.newBackend)
then ComponentType.RECORD;
case Type.COMPLEX() then ComponentType.COMPLEX;
case Type.ARRAY() then getComponentType(ty.elementType, settings);
else ComponentType.NORMAL;
end match;
end getComponentType;
type ComponentType = enumeration(NORMAL, COMPLEX, RECORD);
function flattenSimpleComponent
input InstNode node;
input Component comp;
input Visibility visibility;
input Option<Binding> outerBinding;
input list<Modifier> typeAttrs;
input Prefix prefix;
input output list<Variable> vars;
input output Sections sections;
input FlattenSettings settings;
input list<Variable> children;
protected
InstNode comp_node = node;
ComponentRef name;
Binding binding;
Type ty;
Option<SCode.Comment> cmt;
SourceInfo info;
Attributes comp_attr;
Visibility vis;
Equation eq;
list<tuple<String, Binding>> ty_attrs;
Variability var;
Boolean unfix;
Prefix pre;
Variable v;
algorithm
Component.COMPONENT(ty = ty, binding = binding, attributes = comp_attr, comment = cmt, info = info) := comp;
checkUnspecifiedEnumType(ty, node, info);
var := comp_attr.variability;
if isSome(outerBinding) then
SOME(binding) := outerBinding;
unfix := Binding.isUnbound(binding) and var == Variability.PARAMETER;
else
binding := flattenBinding(binding, prefix);
unfix := false;
end if;
// If the component is an array component with a binding and at least discrete
// variability, and scalarization is enabled, move the binding into an equation.
// This avoids having to scalarize the binding.
if not settings.nfAPI and settings.scalarize then
if var >= Variability.DISCRETE and Type.isArray(ty) and
not Type.isExternalObject(Type.arrayElementType(ty)) and Binding.isBound(binding) then
name := ComponentRef.prefixCref(comp_node, ty, {}, Prefix.prefix(prefix));
eq := Equation.ARRAY_EQUALITY(Expression.CREF(ty, name), Binding.getTypedExp(binding), ty,
InstNode.EMPTY_NODE(), ElementSource.createElementSource(info));
sections := Sections.prependEquation(eq, sections);
binding := NFBinding.EMPTY_BINDING;
// Moving the binding of an input variable to an equation can change how
// the variable is counted when counting variables and equations, but
// since there's no way to override such a binding from outside the model
// we can remove the input prefix to keep the balance.
if comp_attr.direction == Direction.INPUT and Prefix.isEmpty(prefix) then
comp_attr.direction := Direction.NONE;
Error.addSourceMessage(Error.TOP_LEVEL_INPUT_WITH_BINDING,
{ComponentRef.toString(name)}, info);
end if;
end if;
end if;
ty := flattenType(ty, prefix);
verifyDimensions(Type.arrayDims(ty), comp_node);
pre := Prefix.push(comp_node, ty, Type.arrayDims(ty), prefix);
ty_attrs := list(flattenTypeAttribute(m, prefix) for m in typeAttrs);
// Set fixed = false for parameters that are part of a record instance whose
// binding couldn't be split and was moved to an initial equation.
if unfix then
ty_attrs := Binding.setAttr(ty_attrs, "fixed",
Binding.makeFlat(Expression.BOOLEAN(false), Variability.CONSTANT, NFBinding.Source.GENERATED));
end if;
// kabdelhak: add dummy backend info, will be changed to actual value in
// conversion to backend process. NBackendDAE.lower
name := Prefix.prefix(pre);
v := Variable.VARIABLE(name, ty, binding, visibility, comp_attr, ty_attrs, children, cmt, info, NFBackendExtension.DUMMY_BACKEND_INFO);
if not settings.relaxedErrorChecking and var < Variability.DISCRETE and
not unfix and not Type.isComplex(Type.arrayElementType(ty)) then
// Check that the component has a binding if it's required to have one.
verifyBinding(v, var, binding, settings);
end if;
vars := v :: vars;
end flattenSimpleComponent;
function checkUnspecifiedEnumType
input Type ty;
input InstNode node;
input SourceInfo info;
algorithm
() := match ty
case Type.ENUMERATION(literals = {})
algorithm
Error.addSourceMessage(Error.UNSPECIFIED_ENUM_COMPONENT, {InstNode.name(node)}, info);
then
fail();
else ();
end match;
end checkUnspecifiedEnumType;
function flattenTypeAttribute
input Modifier attr;
input Prefix prefix;
output tuple<String, Binding> outAttr;
protected
Binding binding;
algorithm
binding := flattenBinding(Modifier.binding(attr), prefix, isTypeAttribute = true);
outAttr := (Modifier.name(attr), binding);
end flattenTypeAttribute;
function isTypeAttributeNamed
input String name;
input tuple<String, Binding> attr;
output Boolean isNamed;
protected
String attr_name;
algorithm
(attr_name, _) := attr;
isNamed := name == attr_name;
end isTypeAttributeNamed;
function verifyBinding
input Variable var;
input Variability variability;
input Binding binding;
input FlattenSettings settings;
protected
Binding fixed_binding, start_binding;
Expression fixed_exp;
Boolean fixed;
algorithm
if variability > Variability.CONSTANT and Binding.isBound(binding) then
// Parameter with a binding is ok.
return;
end if;
// Check if the variable is fixed or not.
fixed_binding := Variable.lookupTypeAttribute("fixed", var);
if Binding.isBound(fixed_binding) then
fixed_exp := Binding.getExp(fixed_binding);
fixed_exp := Ceval.tryEvalExp(fixed_exp);
if not Expression.isBoolean(fixed_exp) then
return;
end if;
fixed := Expression.isTrue(fixed_exp);
else
fixed := true;
end if;
if variability == Variability.CONSTANT then
if not fixed then
// Constants are not allowed to be non-fixed.
Error.addSourceMessage(Error.NON_FIXED_CONSTANT,
{ComponentRef.toString(var.name)}, var.info);
if not settings.relaxedErrorChecking then
fail();
end if;
end if;
// Constants also must have binding equations if they are used, but this is
// checked when evaluating them.
else
if fixed and Binding.isUnbound(binding) then
start_binding := Variable.lookupTypeAttribute("start", var);
if Binding.isUnbound(start_binding) then
// Fixed parameters must have a binding equation or a start attribute.
Error.addSourceMessage(Error.UNBOUND_PARAMETER_ERROR,
{ComponentRef.toString(var.name)}, var.info);
if not settings.relaxedErrorChecking then
fail();
end if;
else
Error.addSourceMessage(Error.UNBOUND_PARAMETER_WITH_START_VALUE_WARNING,
{ComponentRef.toString(var.name), Binding.toString(start_binding)}, var.info);
end if;
end if;
end if;
end verifyBinding;
function getRecordBindings
input Binding binding;
input array<InstNode> comps;
input Prefix prefix;
output list<Binding> recordBindings = {};
protected
Expression binding_exp;
Variability var;
Binding.Source bind_src;
algorithm
binding_exp := Binding.getTypedExp(binding);
var := Binding.variability(binding);
bind_src := Binding.source(binding);
// Convert the expressions in the record expression into bindings.
recordBindings := match binding_exp
case Expression.RECORD()
then list(if Expression.isEmpty(e) then
// The binding for a record field might be Expression.EMPTY if it comes
// from an evaluated function call where it wasn't assigned a value.
NFBinding.EMPTY_BINDING
else
Binding.makeFlat(e, var, bind_src)
for e in binding_exp.elements);
case Expression.ARRAY()
guard Type.isRecord(Type.arrayElementType(Expression.typeOf(binding_exp)))
then list(Binding.makeFlat(Expression.nthRecordElement(i, binding_exp), var, bind_src)
for i in 1:arrayLength(comps));
else
algorithm
Error.assertion(false, getInstanceName() + " got non-record binding " +
Expression.toString(binding_exp), sourceInfo());
then
fail();
end match;
Error.assertion(listLength(recordBindings) == arrayLength(comps),
getInstanceName() + " got record binding with wrong number of elements for " + Prefix.toString(prefix),
sourceInfo());
end getRecordBindings;
function flattenComplexComponent
input InstNode node;
input Component comp;
input Class cls;
input Type nodeTy;
input Visibility visibility;
input Option<Binding> outerBinding;
input Prefix prefix;
input output list<Variable> vars;
input output Sections sections;
input UnorderedSet<ComponentRef> deletedVars;
input FlattenSettings settings;
protected
list<Dimension> dims;
ComponentRef name;
Binding binding;
Option<Binding> opt_binding;
Expression binding_exp, binding_exp_eval;
Equation eq;
list<Expression> bindings;
Variability comp_var, binding_var;
Type ty;
Prefix pre;
algorithm
ty := flattenType(nodeTy, prefix);
dims := Type.arrayDims(ty);
binding := if isSome(outerBinding) then Util.getOption(outerBinding) else Component.getBinding(comp);
// For a complex component with a binding the binding needs to be split into
// a binding for each record field, or moved to an initial equation if
// splitting the binding fails.
if Binding.isExplicitlyBound(binding) then
binding := flattenBinding(binding, prefix);
binding_exp := Binding.getTypedExp(binding);
binding_var := Binding.variability(binding);
comp_var := Component.variability(comp);
if comp_var <= Variability.STRUCTURAL_PARAMETER or binding_var <= Variability.STRUCTURAL_PARAMETER then
// Constant evaluate parameters that are structural/constant.
binding_exp := Ceval.evalExp(binding_exp);
binding_exp := flattenExp(binding_exp, prefix);
elseif binding_var == Variability.PARAMETER and Component.isFinal(comp) then
// Try to use inlining first.
try
binding_exp := Inline.inlineCallExp(binding_exp, forceInline = true);
else
end try;
// If inlining fails, try to evaluate the binding instead.
if not (Expression.isRecord(binding_exp) or Expression.isCref(binding_exp)) then
try
binding_exp_eval := Ceval.tryEvalExp(binding_exp);
binding_exp_eval := flattenExp(binding_exp_eval, prefix);
// Throw away the evaluated binding if the number of dimensions no
// longer match after evaluation, in case Ceval fails to apply the
// subscripts correctly.
// TODO: Fix this, it shouldn't be needed.
0 := Type.dimensionDiff(ty, Expression.typeOf(binding_exp_eval));
binding_exp := binding_exp_eval;
else
end try;
end if;
else
binding_exp := SimplifyExp.simplify(binding_exp);
end if;
binding_exp := splitRecordCref(binding_exp);
// TODO: This will probably not work so well if the binding is an array that
// contains record non-literals. In that case we should probably
// create an equation for each non-literal in the array, and pass the
// rest on as usual.
if not Expression.isRecordOrRecordArray(binding_exp) then
// Skip adding the equation when using the new backend, since this only
// occurs when flattening the children of a record instance and will
// conflict with the binding on the actual record instance.
if not settings.newBackend then
name := ComponentRef.prefixCref(node, ty, {}, Prefix.prefix(prefix));
eq := Equation.EQUALITY(Expression.CREF(ty, name), binding_exp, ty,
InstNode.EMPTY_NODE(), ElementSource.createElementSource(InstNode.info(node)));
sections := Sections.prependEquation(eq, sections, isInitial = comp_var <= Variability.PARAMETER);
end if;
opt_binding := SOME(NFBinding.EMPTY_BINDING);
else
binding := Binding.setTypedExp(binding_exp, binding);
opt_binding := SOME(binding);
end if;
else
opt_binding := NONE();
end if;
pre := Prefix.push(node, ty, dims, prefix);
// Flatten the class directly if the component is a scalar, otherwise scalarize it.
if listEmpty(dims) then
(vars, sections) := flattenClass(cls, pre, visibility, opt_binding, vars, sections, deletedVars, settings);
elseif settings.scalarize then
dims := list(flattenDimension(d, pre) for d in dims);
verifyDimensions(dims, node);
(vars, sections) := flattenArray(cls, dims, pre, visibility, opt_binding, vars, sections, {}, deletedVars, settings);
else
(vars, sections) := vectorizeArray(cls, dims, pre, visibility, opt_binding, vars, sections, {}, deletedVars, settings);
end if;
end flattenComplexComponent;
function splitRecordCref
input Expression exp;
output Expression outExp;
protected
InstNode cls;
array<InstNode> comps;
ComponentRef cr, field_cr;
Type ty;
list<Expression> fields;
Expression cond;
algorithm
outExp := ExpandExp.expand(exp);
outExp := match outExp
case Expression.CREF(ty = Type.COMPLEX(cls = cls), cref = cr)
algorithm
comps := ClassTree.getComponents(Class.classTree(InstNode.getClass(cls)));
fields := {};
for i in arrayLength(comps):-1:1 loop
ty := InstNode.getType(comps[i]);
field_cr := ComponentRef.prefixCref(comps[i], ty, {}, cr);
field_cr := flattenCref(field_cr, Prefix.PREFIX(InstNode.EMPTY_NODE(), cr));
fields := Expression.fromCref(field_cr) :: fields;
end for;
then
Expression.makeRecord(InstNode.scopePath(cls), outExp.ty, fields);
case Expression.ARRAY()
algorithm
outExp.elements := Array.map(outExp.elements, splitRecordCref);