/
BackendDAEUtil.mo
9082 lines (8452 loc) · 345 KB
/
BackendDAEUtil.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 BackendDAEUtil
" file: BackendDAEUtil.mo
package: BackendDAEUtil
description: BackendDAEUtil comprised functions for BackendDAE data types.
RCS: $Id$
This module is a lowered form of a DAE including equations
and simple equations in
two separate lists. The variables are split into known variables
parameters and constants, and unknown variables,
states and algebraic variables.
The module includes the BLT sorting algorithm which sorts the
equations into blocks, and the index reduction algorithm using
dummy derivatives for solving higher index problems.
It also includes the tarjan algorithm to detect strong components
in the BLT sorting."
public import Absyn;
public import BackendDAE;
public import BackendDAEFunc;
public import DAE;
public import Env;
public import Util;
protected import Algorithm;
protected import BackendDAECreate;
protected import BackendDAEOptimize;
protected import BackendDAETransform;
protected import BackendDump;
protected import BackendEquation;
protected import BackendVariable;
protected import BackendVarTransform;
protected import BinaryTree;
protected import Causalize;
protected import Ceval;
protected import CheckModel;
protected import ClassInf;
protected import ComponentReference;
protected import Config;
protected import DAEDump;
protected import DAEUtil;
protected import Debug;
protected import Differentiate;
protected import Error;
protected import EvaluateParameter;
protected import Expression;
protected import ExpressionDump;
protected import ExpressionSimplify;
protected import Flags;
protected import Global;
protected import GlobalScript;
protected import IndexReduction;
protected import Initialization;
protected import Inline;
protected import List;
protected import Matching;
protected import OnRelaxation;
protected import RemoveSimpleEquations;
protected import SCode;
protected import System;
protected import Tearing;
protected import Types;
protected import Values;
protected
type Var = BackendDAE.Var;
type VarKind = BackendDAE.VarKind;
type VariableArray = BackendDAE.VariableArray;
type EquationArray = BackendDAE.EquationArray;
type ExternalObjectClasses = BackendDAE.ExternalObjectClasses;
type BackendDAEType = BackendDAE.BackendDAEType;
type SymbolicJacobians = BackendDAE.SymbolicJacobians;
type EqSystems = BackendDAE.EqSystems;
type WhenClause = BackendDAE.WhenClause;
type ZeroCrossing = BackendDAE.ZeroCrossing;
/*************************************************
* checkBackendDAE and stuff
************************************************/
public function checkBackendDAEWithErrorMsg "author: Frenkel TUD
run checkDEALow and prints all errors"
input BackendDAE.BackendDAE inBackendDAE;
protected
list<tuple<DAE.Exp, list<DAE.ComponentRef>>> expCrefs;
list<BackendDAE.Equation> wrongEqns;
algorithm
_ := matchcontinue (inBackendDAE)
local
Integer nVars, nEqns;
Boolean samesize;
case (_) equation
false = Flags.isSet(Flags.CHECK_BACKEND_DAE);
then ();
case (BackendDAE.DAE(eqs=BackendDAE.EQSYSTEM(orderedVars=BackendDAE.VARIABLES(numberOfVars=nVars), orderedEqs=BackendDAE.EQUATION_ARRAY(size=nEqns))::{})) equation
//true = Flags.isSet(Flags.CHECK_BACKEND_DAE);
//Check for correct size
samesize = nVars == nEqns;
Debug.fcall(Flags.CHECK_BACKEND_DAE, print, "No. of Equations: " +& intString(nVars) +& " No. of BackendDAE.Variables: " +& intString(nEqns) +& " Samesize: " +& boolString(samesize) +& "\n");
(expCrefs, wrongEqns) = checkBackendDAE(inBackendDAE);
printcheckBackendDAEWithErrorMsg(expCrefs, wrongEqns);
then ();
else equation
Error.addMessage(Error.INTERNAL_ERROR, {"./Compiler/BackEnd/BackendDAEUtil.mo: function checkBackendDAEWithErrorMsg failed"});
then fail();
end matchcontinue;
end checkBackendDAEWithErrorMsg;
public function printcheckBackendDAEWithErrorMsg"author: Frenkel TUD
helper for checkDEALowWithErrorMsg"
input list<tuple<DAE.Exp,list<DAE.ComponentRef>>> inExpCrefs;
input list<BackendDAE.Equation> inWrongEqns;
algorithm
_ := match (inExpCrefs,inWrongEqns)
local
DAE.Exp e;
list<DAE.ComponentRef> crefs;
list<tuple<DAE.Exp,list<DAE.ComponentRef>>> res;
list<String> strcrefs;
String crefstring, expstr,scopestr;
BackendDAE.Equation eqn;
list<BackendDAE.Equation> wrongEqns;
case ({},{}) then ();
case ({},eqn::wrongEqns)
equation
printEqnSizeError(eqn);
printcheckBackendDAEWithErrorMsg({},wrongEqns);
then ();
case (((e,crefs))::res,wrongEqns)
equation
strcrefs = List.map(crefs,ComponentReference.crefStr);
crefstring = stringDelimitList(strcrefs,", ");
expstr = ExpressionDump.printExpStr(e);
scopestr = stringAppendList({crefstring," from Expression: ",expstr});
Error.addMessage(Error.LOOKUP_VARIABLE_ERROR, {scopestr,"BackendDAE object"});
printcheckBackendDAEWithErrorMsg(res,wrongEqns);
then
();
end match;
end printcheckBackendDAEWithErrorMsg;
protected function printEqnSizeError"author: Frenkel TUD 2010-12"
input BackendDAE.Equation inEqn;
algorithm
_ := matchcontinue(inEqn)
local
BackendDAE.Equation eqn;
DAE.Exp e1, e2;
DAE.ComponentRef cr;
DAE.Type t1,t2;
String eqnstr, t1str, t2str, tstr;
DAE.ElementSource source;
case (eqn as BackendDAE.EQUATION(exp=e1,scalar=e2,source=source))
equation
eqnstr = BackendDump.equationString(eqn);
t1 = Expression.typeof(e1);
t2 = Expression.typeof(e2);
t1str = Types.unparseType(t1);
t2str = Types.unparseType(t2);
tstr = stringAppendList({t1str," != ", t2str});
Error.addSourceMessage(Error.EQUATION_TYPE_MISMATCH_ERROR, {eqnstr,tstr}, DAEUtil.getElementSourceFileInfo(source));
then ();
case (eqn as BackendDAE.SOLVED_EQUATION(componentRef=cr,exp=e1,source=source))
equation
eqnstr = BackendDump.equationString(eqn);
t1 = Expression.typeof(e1);
t2 = ComponentReference.crefLastType(cr);
t1str = Types.unparseType(t1);
t2str = Types.unparseType(t2);
tstr = stringAppendList({t1str," != ", t2str});
Error.addSourceMessage(Error.EQUATION_TYPE_MISMATCH_ERROR, {eqnstr,tstr}, DAEUtil.getElementSourceFileInfo(source));
then ();
//
case eqn then ();
end matchcontinue;
end printEqnSizeError;
public function checkBackendDAE "author: Frenkel TUD
This function checks the BackendDAE object if
- all component refercences used in the expressions are
part of the BackendDAE object.
- all variables that are reinit are states
Returns all component references which not part of the BackendDAE object."
input BackendDAE.BackendDAE inBackendDAE;
output list<tuple<DAE.Exp,list<DAE.ComponentRef>>> outExpCrefs;
output list<BackendDAE.Equation> outWrongEqns;
algorithm
(outExpCrefs,outWrongEqns) := matchcontinue (inBackendDAE)
local
BackendDAE.Variables vars1,vars2,allvars;
EquationArray eqns,reqns,ieqns;
list<BackendDAE.WhenClause> whenClauseLst;
list<BackendDAE.Var> varlst1,varlst2,allvarslst;
list<tuple<DAE.Exp,list<DAE.ComponentRef>>> expcrefs,expcrefs1,expcrefs2,expcrefs3,expcrefs4,expcrefs5;
list<BackendDAE.Equation> wrongEqns,wrongEqns1,wrongEqns2;
case (BackendDAE.DAE(eqs=BackendDAE.EQSYSTEM(orderedVars = vars1,orderedEqs = eqns)::{},shared=BackendDAE.SHARED(knownVars = vars2,initialEqs = ieqns,removedEqs = reqns,
eventInfo = BackendDAE.EVENT_INFO(whenClauseLst=whenClauseLst))))
equation
varlst1 = BackendVariable.varList(vars1);
varlst2 = BackendVariable.varList(vars2);
allvarslst = listAppend(varlst1,varlst2);
allvars = BackendVariable.listVar(allvarslst);
((_,expcrefs)) = traverseBackendDAEExpsVars(vars1,checkBackendDAEExp,(allvars,{}));
((_,expcrefs1)) = traverseBackendDAEExpsVars(vars2,checkBackendDAEExp,(allvars,expcrefs));
((_,expcrefs2)) = traverseBackendDAEExpsEqns(eqns,checkBackendDAEExp,(allvars,expcrefs1));
((_,expcrefs3)) = traverseBackendDAEExpsEqns(reqns,checkBackendDAEExp,(allvars,expcrefs2));
((_,expcrefs4)) = traverseBackendDAEExpsEqns(ieqns,checkBackendDAEExp,(allvars,expcrefs3));
(_,(_,expcrefs5)) = BackendDAETransform.traverseBackendDAEExpsWhenClauseLst(whenClauseLst,checkBackendDAEExp,(allvars,expcrefs4));
wrongEqns = BackendEquation.traverseBackendDAEEqns(eqns,checkEquationSize,{});
wrongEqns1 = BackendEquation.traverseBackendDAEEqns(reqns,checkEquationSize,wrongEqns);
wrongEqns2 = BackendEquation.traverseBackendDAEEqns(ieqns,checkEquationSize,wrongEqns1);
then
(expcrefs5,wrongEqns2);
else
equation
Debug.fprintln(Flags.FAILTRACE, "- BackendDAEUtil.checkBackendDAE failed");
then
fail();
end matchcontinue;
end checkBackendDAE;
protected function checkBackendDAEExp
input tuple<DAE.Exp, tuple<BackendDAE.Variables,list<tuple<DAE.Exp,list<DAE.ComponentRef>>>>> inTpl;
output tuple<DAE.Exp, tuple<BackendDAE.Variables,list<tuple<DAE.Exp,list<DAE.ComponentRef>>>>> outTpl;
algorithm
outTpl :=
matchcontinue inTpl
local
DAE.Exp exp;
BackendDAE.Variables vars;
list<DAE.ComponentRef> crefs;
list<tuple<DAE.Exp,list<DAE.ComponentRef>>> lstExpCrefs,lstExpCrefs1;
case ((exp,(vars,lstExpCrefs)))
equation
((_,(_,crefs))) = Expression.traverseExp(exp,traversecheckBackendDAEExp,(vars,{}));
lstExpCrefs1 = Util.if_(List.isNotEmpty(crefs),(exp,crefs)::lstExpCrefs,lstExpCrefs);
then
((exp,(vars,lstExpCrefs1)));
case _ then inTpl;
end matchcontinue;
end checkBackendDAEExp;
protected function traversecheckBackendDAEExp
input tuple<DAE.Exp, tuple<BackendDAE.Variables,list<DAE.ComponentRef>>> inTuple;
output tuple<DAE.Exp, tuple<BackendDAE.Variables,list<DAE.ComponentRef>>> outTuple;
algorithm
outTuple := matchcontinue(inTuple)
local
DAE.Exp e,e1;
BackendDAE.Variables vars,vars1;
DAE.ComponentRef cr;
list<DAE.ComponentRef> crefs,crefs1;
list<DAE.Exp> expl;
list<DAE.Var> varLst;
list<BackendDAE.Var> backendVars;
DAE.ReductionIterators riters;
// special case for time, it is never part of the equation system
case ((e as DAE.CREF(componentRef = DAE.CREF_IDENT(ident="time")),(vars,crefs)))
then ((e, (vars,crefs)));
// Special Case for Records
case ((e as DAE.CREF(componentRef = cr,ty= DAE.T_COMPLEX(varLst=varLst,complexClassType=ClassInf.RECORD(_))),(vars,crefs)))
equation
expl = List.map1(varLst,Expression.generateCrefsExpFromExpVar,cr);
((_,(vars1,crefs1))) = Expression.traverseExpList(expl,traversecheckBackendDAEExp,(vars,crefs));
then
((e, (vars1,crefs1)));
// Special Case for Arrays
case ((e as DAE.CREF(ty = DAE.T_ARRAY(ty=_)),(vars,crefs)))
equation
((e1,(_,true))) = extendArrExp((e,(NONE(),false)));
((_,(vars1,crefs1))) = Expression.traverseExp(e1,traversecheckBackendDAEExp,(vars,crefs));
then
((e, (vars1,crefs1)));
// case for Reductions
case ((e as DAE.REDUCTION(iterators = riters),(vars,crefs)))
equation
// add idents to vars
backendVars = List.map(riters,makeIterVariable);
vars = BackendVariable.addVars(backendVars,vars);
then
((e, (vars,crefs)));
// case for functionpointers
case ((e as DAE.CREF(ty=DAE.T_FUNCTION_REFERENCE_FUNC(builtin=_)),(vars,crefs)))
then
((e, (vars,crefs)));
case ((e as DAE.CREF(componentRef = cr),(vars,crefs)))
equation
(_,_) = BackendVariable.getVar(cr, vars);
then
((e, (vars,crefs)));
case ((e as DAE.CREF(componentRef = cr),(vars,crefs)))
equation
failure((_,_) = BackendVariable.getVar(cr, vars));
then
((e, (vars,cr::crefs)));
case _ then inTuple;
end matchcontinue;
end traversecheckBackendDAEExp;
protected function makeIterVariable
input DAE.ReductionIterator iter;
output BackendDAE.Var backendVar;
protected
String name;
DAE.ComponentRef cr;
algorithm
name := Expression.reductionIterName(iter);
cr := ComponentReference.makeCrefIdent(name,DAE.T_INTEGER_DEFAULT,{});
backendVar := BackendDAE.VAR(cr,BackendDAE.VARIABLE(),DAE.BIDIR(),DAE.NON_PARALLEL(),DAE.T_INTEGER_DEFAULT,NONE(),NONE(),{},
DAE.emptyElementSource,NONE(),NONE(),DAE.NON_CONNECTOR());
end makeIterVariable;
protected function checkEquationSize"author: Frenkel TUD 2010-12
- check if the left hand side and the rigth hand side have equal types."
input tuple<BackendDAE.Equation, list<BackendDAE.Equation>> inTpl;
output tuple<BackendDAE.Equation, list<BackendDAE.Equation>> outTpl;
algorithm
outTpl := matchcontinue(inTpl)
local
BackendDAE.Equation e;
list<BackendDAE.Equation> wrongEqns,wrongEqns1;
DAE.Exp e1, e2;
DAE.ComponentRef cr;
DAE.Type t1,t2;
Boolean b;
case ((e as BackendDAE.EQUATION(exp=e1,scalar=e2),wrongEqns))
equation
t1 = Expression.typeof(e1);
t2 = Expression.typeof(e2);
b = Expression.equalTypes(t1,t2);
wrongEqns1 = List.consOnTrue(not b,e,wrongEqns);
then ((e,wrongEqns1));
case ((e as BackendDAE.SOLVED_EQUATION(componentRef=cr,exp=e1),wrongEqns))
equation
t1 = Expression.typeof(e1);
t2 = ComponentReference.crefLastType(cr);
b = Expression.equalTypes(t1,t2);
wrongEqns1 = List.consOnTrue(not b,e,wrongEqns);
then ((e,wrongEqns1));
//
case _ then inTpl;
end matchcontinue;
end checkEquationSize;
public function checkAssertCondition "Succeds if condition of assert is not constant false"
input DAE.Exp cond;
input DAE.Exp message;
input DAE.Exp level;
input Absyn.Info info;
algorithm
_ := matchcontinue(cond,message,level,info)
local
String messageStr;
case(_, _, _,_)
equation
// Don't check assertions when checking models
true = Flags.getConfigBool(Flags.CHECK_MODEL);
then ();
case (_,_,_,_)
equation
false = Expression.isConstFalse(cond);
then ();
case (_,_,_,_)
equation
failure(DAE.ENUM_LITERAL(index=1) = level);
then ();
case(_,_,_,_)
equation
true = Expression.isConstFalse(cond);
messageStr = ExpressionDump.printExpStr(message);
Error.addSourceMessage(Error.ASSERT_CONSTANT_FALSE_ERROR,{messageStr},info);
then fail();
end matchcontinue;
end checkAssertCondition;
/************************************************************
Util function at Backend using for lowering and other stuff
************************************************************/
/* adrpo: 2013-10-14 not used function
public function createEmptyBackendDAE "author: wbraun
Copy the dae to avoid changes in vectors."
input BackendDAE.BackendDAEType inBDAEType;
output BackendDAE.BackendDAE outBDAE;
protected
BackendDAE.Variables emptyvars;
EquationArray emptyEqns;
BackendDAE.Variables emptyAliasVars;
Env.Cache cache;
DAE.FunctionTree funcTree;
algorithm
emptyvars := BackendVariable.emptyVars();
emptyEqns := BackendEquation.emptyEqns();
emptyAliasVars := BackendVariable.emptyVars();
cache := Env.emptyCache();
funcTree := DAEUtil.avlTreeNew();
outBDAE := BackendDAE.DAE({BackendDAE.EQSYSTEM(emptyvars,
emptyEqns,
NONE(),
NONE(),
BackendDAE.NO_MATCHING(),{})},
BackendDAE.SHARED(emptyvars,
emptyvars,
emptyAliasVars,
emptyEqns,
emptyEqns,
{},
{},
cache,
{},
funcTree,
BackendDAE.EVENT_INFO(BackendDAE.SAMPLE_LOOKUP(0, {}), {}, {}, {}, {}, 0, 0),
{},
inBDAEType,
{},
BackendDAE.EXTRA_INFO("")));
end createEmptyBackendDAE;
*/
public function copyBackendDAE "author: Frenkel TUD, wbraun
Copy the dae to avoid changes in vectors."
input BackendDAE.BackendDAE inBDAE;
output BackendDAE.BackendDAE outBDAE;
algorithm
outBDAE:=
match (inBDAE)
local
EqSystems eqns;
BackendDAE.Shared shared,shared1;
BackendDAE.BackendDAE bDAE;
case (bDAE as BackendDAE.DAE(eqs=eqns, shared=shared))
equation
BackendDAE.DAE(eqs=eqns) = mapEqSystem(bDAE, copyBackendDAEEqSystem);
shared1 = copyBackendDAEShared(shared);
then
BackendDAE.DAE(eqns, shared1);
end match;
end copyBackendDAE;
public function copyBackendDAEEqSystem
" author: Frenkel TUD, wbraun
Copy the dae to avoid changes in
vectors."
input BackendDAE.EqSystem inSysts;
input BackendDAE.Shared inShared;
output BackendDAE.EqSystem outSysts;
output BackendDAE.Shared outShared;
algorithm
(outSysts, outShared) :=
match (inSysts,inShared)
local
BackendDAE.Variables ordvars,ordvars1;
EquationArray eqns,eqns1;
Option<BackendDAE.IncidenceMatrix> m,mT,m1,mT1;
BackendDAE.Matching matching,matching1;
BackendDAE.Shared shared;
BackendDAE.StateSets stateSets;
case (BackendDAE.EQSYSTEM(ordvars,eqns,m,mT,matching,stateSets),shared)
equation
// copy varibales
ordvars1 = BackendVariable.copyVariables(ordvars);
// copy equations
eqns1 = BackendEquation.copyEquationArray(eqns);
m1 = copyIncidenceMatrix(m);
mT1 = copyIncidenceMatrix(mT);
matching1 = copyMatching(matching);
then
(BackendDAE.EQSYSTEM(ordvars1,eqns1,m1,mT1,matching1,stateSets),shared);
end match;
end copyBackendDAEEqSystem;
public function copyBackendDAEShared
" author: Frenkel TUD, wbraun
Copy the shared part of an BackendDAE to avoid changes in
vectors."
input BackendDAE.Shared inShared;
output BackendDAE.Shared outShared;
algorithm
outShared:=
match (inShared)
local
BackendDAE.Variables knvars,exobj,knvars1,exobj1,av;
EquationArray remeqns,inieqns,remeqns1,inieqns1;
list<DAE.Constraint> constrs;
list<DAE.ClassAttributes> clsAttrs;
Env.Cache cache;
Env.Env env;
DAE.FunctionTree funcTree;
BackendDAE.EventInfo einfo;
ExternalObjectClasses eoc;
BackendDAEType btp;
BackendDAE.SymbolicJacobians symjacs;
BackendDAE.ExtraInfo ei;
case (BackendDAE.SHARED(knvars,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,funcTree,einfo,eoc,btp,symjacs,ei))
equation
knvars1 = BackendVariable.copyVariables(knvars);
exobj1 = BackendVariable.copyVariables(exobj);
inieqns1 = BackendEquation.copyEquationArray(inieqns);
remeqns1 = BackendEquation.copyEquationArray(remeqns);
then
BackendDAE.SHARED(knvars1,exobj,av,inieqns1,remeqns1,constrs,clsAttrs,cache,env,funcTree,einfo,eoc,btp,symjacs,ei);
end match;
end copyBackendDAEShared;
public function copyMatching
input BackendDAE.Matching inMatching;
output BackendDAE.Matching outMatching;
algorithm
outMatching := match (inMatching)
local
array<Integer> ass1, cass1, ass2, cass2;
BackendDAE.StrongComponents comps;
case (BackendDAE.NO_MATCHING()) then BackendDAE.NO_MATCHING();
case (BackendDAE.MATCHING(ass1=ass1,ass2=ass2,comps=comps))
equation
cass1 = arrayCreate(arrayLength(ass1),0);
_ = Util.arrayCopy(ass1, cass1);
cass2 = arrayCreate(arrayLength(ass2),0);
_ = Util.arrayCopy(ass2, cass2);
then BackendDAE.MATCHING(cass1,cass2,comps);
end match;
end copyMatching;
public function addBackendDAESharedJacobian
" author: wbraun"
input BackendDAE.SymbolicJacobian inSymJac;
input BackendDAE.SparsePattern inSparsePattern;
input BackendDAE.SparseColoring inSparseColoring;
input BackendDAE.Shared inShared;
output BackendDAE.Shared outShared;
algorithm
outShared:=
match (inSymJac, inSparsePattern, inSparseColoring, inShared)
local
BackendDAE.Variables knvars,exobj,av;
EquationArray remeqns,inieqns;
list<DAE.Constraint> constrs;
list<DAE.ClassAttributes> clsAttrs;
Env.Cache cache;
Env.Env env;
DAE.FunctionTree funcTree;
BackendDAE.EventInfo einfo;
ExternalObjectClasses eoc;
BackendDAEType btp;
BackendDAE.SymbolicJacobians symjacs;
BackendDAE.ExtraInfo ei;
case (_,_,_,BackendDAE.SHARED(knvars,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,funcTree,einfo,eoc,btp,symjacs,ei))
equation
symjacs = {(SOME(inSymJac),inSparsePattern,inSparseColoring),(NONE(),({},({},{})),{}),(NONE(),({},({},{})),{}),(NONE(),({},({},{})),{})};
then
BackendDAE.SHARED(knvars,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,funcTree,einfo,eoc,btp,symjacs,ei);
end match;
end addBackendDAESharedJacobian;
public function addBackendDAESharedJacobians
" author: wbraun"
input BackendDAE.SymbolicJacobians inSymJac;
input BackendDAE.Shared inShared;
output BackendDAE.Shared outShared;
algorithm
outShared:=
match (inSymJac, inShared)
local
BackendDAE.Variables knvars,exobj,av;
EquationArray remeqns,inieqns;
list<DAE.Constraint> constrs;
list<DAE.ClassAttributes> clsAttrs;
Env.Cache cache;
Env.Env env;
DAE.FunctionTree funcTree;
BackendDAE.EventInfo einfo;
ExternalObjectClasses eoc;
BackendDAEType btp;
BackendDAE.SymbolicJacobians symjacs;
BackendDAE.ExtraInfo ei;
case (_,BackendDAE.SHARED(knvars,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,funcTree,einfo,eoc,btp,symjacs,ei))
then
BackendDAE.SHARED(knvars,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,funcTree,einfo,eoc,btp,inSymJac,ei);
end match;
end addBackendDAESharedJacobians;
public function addBackendDAESharedJacobianSparsePattern
" author: wbraun"
input BackendDAE.SparsePattern inSparsePattern;
input BackendDAE.SparseColoring inSparseColoring;
input Integer inIndex;
input BackendDAE.Shared inShared;
output BackendDAE.Shared outShared;
algorithm
outShared:=
match (inSparsePattern, inSparseColoring, inIndex, inShared)
local
BackendDAE.Variables knvars,exobj,av;
EquationArray remeqns,inieqns;
list<DAE.Constraint> constrs;
list<DAE.ClassAttributes> clsAttrs;
Env.Cache cache;
Env.Env env;
DAE.FunctionTree funcTree;
BackendDAE.EventInfo einfo;
ExternalObjectClasses eoc;
BackendDAEType btp;
BackendDAE.SymbolicJacobians symjacs;
Option<BackendDAE.SymbolicJacobian> symJac;
BackendDAE.ExtraInfo ei;
case (_, _, _, BackendDAE.SHARED(knvars,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,funcTree,einfo,eoc,btp,symjacs,ei))
equation
((symJac,_,_)) = listGet(symjacs, inIndex);
symjacs = List.set(symjacs, inIndex, ((symJac, inSparsePattern, inSparseColoring)));
then
BackendDAE.SHARED(knvars,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,funcTree,einfo,eoc,btp,symjacs,ei);
end match;
end addBackendDAESharedJacobianSparsePattern;
public function addBackendDAEKnVars
" That function replace the KnownVars in BackendDAE.
author: wbraun"
input BackendDAE.Variables inKnVars;
input BackendDAE.BackendDAE inBDAE;
output BackendDAE.BackendDAE outBDAE;
algorithm
outBDAE := match (inKnVars, inBDAE)
local
BackendDAE.Variables exobj,av;
EquationArray remeqns,inieqns;
list<DAE.Constraint> constrs;
list<DAE.ClassAttributes> clsAttrs;
Env.Cache cache;
Env.Env env;
DAE.FunctionTree funcTree;
BackendDAE.EventInfo einfo;
ExternalObjectClasses eoc;
BackendDAEType btp;
BackendDAE.SymbolicJacobians symjacs;
EqSystems eqs;
BackendDAE.ExtraInfo ei;
case (_,BackendDAE.DAE(eqs=eqs,shared=BackendDAE.SHARED(_,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,funcTree,einfo,eoc,btp,symjacs,ei)))
then BackendDAE.DAE(eqs,BackendDAE.SHARED(inKnVars,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,funcTree,einfo,eoc,btp,symjacs,ei));
end match;
end addBackendDAEKnVars;
public function addBackendDAEFunctionTree
" That function replace the FunctionTree in BackendDAE.
author: wbraun"
input DAE.FunctionTree inFunctionTree;
input BackendDAE.BackendDAE inBDAE;
output BackendDAE.BackendDAE outBDAE;
algorithm
outBDAE := match (inFunctionTree, inBDAE)
local
BackendDAE.Variables knvars,exobj,av;
EquationArray remeqns,inieqns;
list<DAE.Constraint> constrs;
list<DAE.ClassAttributes> clsAttrs;
Env.Cache cache;
Env.Env env;
BackendDAE.EventInfo einfo;
ExternalObjectClasses eoc;
BackendDAEType btp;
BackendDAE.SymbolicJacobians symjacs;
EqSystems eqs;
BackendDAE.ExtraInfo ei;
case (_,BackendDAE.DAE(eqs=eqs,shared=BackendDAE.SHARED(knvars,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,_,einfo,eoc,btp,symjacs,ei)))
then BackendDAE.DAE(eqs,BackendDAE.SHARED(knvars,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,inFunctionTree,einfo,eoc,btp,symjacs,ei));
end match;
end addBackendDAEFunctionTree;
public function addFunctionTree
" function: addBackendDAEFunctionTree
That function replace the FunctionTree in shared object.
author: wbraun"
input DAE.FunctionTree inFunctionTree;
input BackendDAE.Shared inShared;
output BackendDAE.Shared outShared;
algorithm
outShared := match (inFunctionTree, inShared)
local
BackendDAE.Variables knvars,exobj,av;
EquationArray remeqns,inieqns;
list<DAE.Constraint> constrs;
list<DAE.ClassAttributes> clsAttrs;
Env.Cache cache;
Env.Env env;
BackendDAE.EventInfo einfo;
ExternalObjectClasses eoc;
BackendDAEType btp;
BackendDAE.SymbolicJacobians symjacs;
EqSystems eqs;
BackendDAE.ExtraInfo ei;
case (_,BackendDAE.SHARED(knvars,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,_,einfo,eoc,btp,symjacs,ei))
then BackendDAE.SHARED(knvars,exobj,av,inieqns,remeqns,constrs,clsAttrs,cache,env,inFunctionTree,einfo,eoc,btp,symjacs,ei);
end match;
end addFunctionTree;
public function addVarsToEqSystem
input BackendDAE.EqSystem syst;
input list<BackendDAE.Var> varlst;
output BackendDAE.EqSystem osyst;
algorithm
osyst := match (syst,varlst)
local
BackendDAE.Variables vars;
EquationArray eqs;
Option<BackendDAE.IncidenceMatrix> m,mT;
BackendDAE.Matching matching;
BackendDAE.StateSets stateSets;
case (BackendDAE.EQSYSTEM(vars, eqs, m, mT, matching, stateSets),_)
equation
vars = BackendVariable.addVars(varlst, vars);
then BackendDAE.EQSYSTEM(vars, eqs, m, mT, matching, stateSets);
end match;
end addVarsToEqSystem;
public function addDummyStateIfNeeded
"author: Frenkel TUD 2012-09
adds a dummy state if dae contains no states"
input BackendDAE.BackendDAE inBackendDAE;
output BackendDAE.BackendDAE outBackendDAE;
protected
BackendDAE.EqSystems systs;
BackendDAE.Shared shared;
Boolean daeContainsNoStates;
algorithm
BackendDAE.DAE(eqs=systs,shared=shared) := inBackendDAE;
// check if the DAE has states
daeContainsNoStates := addDummyStateIfNeeded1(systs);
// adrpo: add the dummy derivative state ONLY IF the DAE contains no states
systs := Debug.bcallret1(daeContainsNoStates,addDummyState,systs,systs);
outBackendDAE := Util.if_(daeContainsNoStates,BackendDAE.DAE(systs,shared),inBackendDAE);
end addDummyStateIfNeeded;
protected function addDummyStateIfNeeded1
input BackendDAE.EqSystems iSysts;
output Boolean oContainsNoStates;
algorithm
oContainsNoStates := match(iSysts)
local
BackendDAE.EqSystems systs;
BackendDAE.Variables vars;
Boolean containsNoStates;
case ({}) then true;
case (BackendDAE.EQSYSTEM(orderedVars = vars)::systs)
equation
containsNoStates = BackendVariable.traverseBackendDAEVarsWithStop(vars, traverserVaraddDummyStateIfNeeded, true);
containsNoStates = Debug.bcallret1(containsNoStates,addDummyStateIfNeeded1,systs,containsNoStates);
then
containsNoStates;
end match;
end addDummyStateIfNeeded1;
protected function traverserVaraddDummyStateIfNeeded
input tuple<BackendDAE.Var, Boolean> inTpl;
output tuple<BackendDAE.Var, Boolean, Boolean> outTpl;
algorithm
outTpl:= match (inTpl)
local
BackendDAE.Var v;
Boolean b;
case ((v as BackendDAE.VAR(varKind=BackendDAE.STATE(index=_)),_))
then ((v,false,false));
case ((v,b)) then ((v,b,b));
end match;
end traverserVaraddDummyStateIfNeeded;
protected function addDummyState
"In order for the solver to work correctly at least one state variable
must exist in the equation system. This function therefore adds a
dummy state variable and an equation for that variable."
input BackendDAE.EqSystems isysts;
output BackendDAE.EqSystems osysts;
protected
DAE.ComponentRef cr;
BackendDAE.Var v;
BackendDAE.Variables vars;
DAE.Exp exp;
BackendDAE.Equation eqn;
BackendDAE.EquationArray eqns;
array<Integer> ass;
BackendDAE.EqSystem syst;
algorithm
// generate dummy state
(v,cr) := BackendVariable.createDummyVar();
// generate vars
vars := BackendVariable.listVar({v});
/*
* adrpo: after a bit of talk with Francesco Casella & Peter Aronsson we will add der($dummy) = 0;
*/
exp := Expression.crefExp(cr);
eqn := BackendDAE.EQUATION(DAE.CALL(Absyn.IDENT("der"),{exp},DAE.callAttrBuiltinReal),DAE.RCONST(0.0), DAE.emptyElementSource,false);
eqns := BackendEquation.listEquation({eqn});
// generate equationsystem
ass := listArray({1});
syst := BackendDAE.EQSYSTEM(vars,eqns,NONE(),NONE(),BackendDAE.MATCHING(ass,ass,{BackendDAE.SINGLEEQUATION(1,1)}),{});
// add system to list of systems
osysts := syst::isysts;
end addDummyState;
/* Actually obsolete code, should be removed
but is used in modpar in Main.mo
*/
public function calculateSizes "author: PA
Calculates the number of state variables, nx,
the number of algebraic variables, ny
and the number of parameters/constants, np.
inputs: BackendDAE
outputs: (int, // nx
int, // ny
int, // np
int // ng
int) next"
input BackendDAE.BackendDAE inBackendDAE;
output Integer outnx "number of states";
output Integer outny "number of alg. vars";
output Integer outnp "number of parameters";
output Integer outng "number of zerocrossings";
output Integer outng_sample "number of zerocrossings that are samples";
output Integer outnext "number of external objects";
// nx cannot be strings
output Integer outny_string "number of alg.vars which are strings";
output Integer outnp_string "number of parameters which are strings";
// nx cannot be int
output Integer outny_int "number of alg.vars which are ints";
output Integer outnp_int "number of parameters which are ints";
// nx cannot be int
output Integer outny_bool "number of alg.vars which are bools";
output Integer outnp_bool "number of parameters which are bools";
algorithm
(outnx,outny,outnp,outng,outng_sample,outnext, outny_string, outnp_string, outny_int, outnp_int, outny_bool, outnp_bool):=
match (inBackendDAE)
local
Integer np,ng,nsam,nx,ny,nx_1,ny_1,next,ny_string,np_string,ny_1_string,np_int,np_bool,ny_int,ny_1_int,ny_bool,ny_1_bool;
BackendDAE.Variables vars,knvars,extvars;
list<BackendDAE.WhenClause> wc;
list<ZeroCrossing> zc;
Integer numberOfRelations;
case (BackendDAE.DAE(eqs=BackendDAE.EQSYSTEM(orderedVars = vars)::{},shared=BackendDAE.SHARED(knownVars = knvars, externalObjects = extvars,
eventInfo = BackendDAE.EVENT_INFO(whenClauseLst = wc,
zeroCrossingLst = zc,relationsNumber=numberOfRelations))))
equation
// input variables are put in the known var list, but they should be counted by the ny counter
next = BackendVariable.varsSize(extvars);
((np,np_string,np_int, np_bool)) = BackendVariable.traverseBackendDAEVars(knvars,calculateParamSizes,(0,0,0,0));
(ng,nsam) = calculateNumberZeroCrossings(zc, 0, 0);
((nx,ny,ny_string,ny_int, ny_bool)) = BackendVariable.traverseBackendDAEVars(vars,calculateVarSizes,(0, 0, 0, 0, 0));
((nx_1,ny_1,ny_1_string,ny_1_int, ny_1_bool)) = BackendVariable.traverseBackendDAEVars(knvars,calculateVarSizes,(nx, ny, ny_string, ny_int, ny_bool));
then
(nx_1,ny_1,np,numberOfRelations,nsam,next,ny_1_string, np_string, ny_1_int, np_int, ny_1_bool, np_bool);
end match;
end calculateSizes;
protected function calculateNumberZeroCrossings "author: unknown"
input list<ZeroCrossing> zcLst;
input Integer inZc_index;
input Integer inSample_index;
output Integer zc;
output Integer sample;
algorithm
(zc,sample) := matchcontinue (zcLst,inZc_index,inSample_index)
local
list<ZeroCrossing> xs;
Integer sample_index, zc_index;
case ({},zc_index,sample_index) then (zc_index,sample_index);
case (BackendDAE.ZERO_CROSSING(relation_ = DAE.CALL(path = Absyn.IDENT(name = "sample")))::xs,zc_index,sample_index)
equation
sample_index = sample_index + 1;
zc_index = zc_index + 1;
(zc,sample) = calculateNumberZeroCrossings(xs,zc_index,sample_index);
then (zc,sample);
case (BackendDAE.ZERO_CROSSING(relation_ = DAE.RELATION(operator = _), occurEquLst = _)::xs,zc_index,sample_index)
equation
zc_index = zc_index + 1;
(zc,sample) = calculateNumberZeroCrossings(xs,zc_index,sample_index);
then (zc,sample);
case (BackendDAE.ZERO_CROSSING(relation_ = DAE.LBINARY(operator = _), occurEquLst = _)::xs,zc_index,sample_index)
equation
zc_index = zc_index + 1;
(zc,sample) = calculateNumberZeroCrossings(xs,zc_index,sample_index);
then (zc,sample);
case (BackendDAE.ZERO_CROSSING(relation_ = DAE.LUNARY(operator = _), occurEquLst = _)::xs,zc_index,sample_index)
equation
zc_index = zc_index + 1;
(zc,sample) = calculateNumberZeroCrossings(xs,zc_index,sample_index);
then (zc,sample);
case (_,_,_)
equation
print("- BackendDAEUtil.calculateNumberZeroCrossings failed\n");
then
fail();
end matchcontinue;
end calculateNumberZeroCrossings;
protected function calculateParamSizes "author: PA
Helper function to calculateSizes"
input tuple<Var, tuple<Integer,Integer,Integer,Integer>> inTpl;
output tuple<Var, tuple<Integer,Integer,Integer,Integer>> outTpl;
algorithm
outTpl :=
matchcontinue (inTpl)
local
Integer s1,s2,s3, s4;
Var var;
case ((var,(s1,s2,s3,s4)))
equation
true = BackendVariable.isBoolParam(var);
then
((var,(s1,s2,s3,s4 + 1)));
case ((var,(s1,s2,s3,s4)))
equation
true = BackendVariable.isIntParam(var);
then
((var,(s1,s2,s3 + 1,s4)));
case ((var,(s1,s2,s3,s4)))
equation
true = BackendVariable.isStringParam(var);
then
((var,(s1,s2 + 1,s3,s4)));
case ((var,(s1,s2,s3,s4)))
equation
true = BackendVariable.isParam(var);
then
((var,(s1 + 1,s2,s3,s4)));
case _ then inTpl;
end matchcontinue;
end calculateParamSizes;