/
BackendVariable.mo
4447 lines (4045 loc) · 140 KB
/
BackendVariable.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-2014, Open Source Modelica Consortium (OSMC),
* c/o Linköpings universitet, 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 LICENSE OR
* THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
* ACCORDING TO RECIPIENTS CHOICE.
*
* The OpenModelica software and the Open Source Modelica
* Consortium (OSMC) Public License (OSMC-PL) are obtained
* from OSMC, 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 BackendVariable
"BackendVariables contains the function that deals with the datytypes
BackendDAE.VAR BackendDAE.Variables and BackendVariablesArray.
"
import BackendDAE;
import DAE;
import SCode;
import Values;
protected
import Absyn;
import AbsynUtil;
import Array;
import BackendDAEUtil;
import BaseHashSet;
import BaseHashTable;
import ComponentReference;
import CommonSubExpression;
import DAEUtil;
import Debug;
import ElementSource;
import Error;
import Expression;
import ExpressionDump;
import ExpressionSimplify;
import Flags;
import Global;
import HashSet;
import List;
import MetaModelica.Dangerous;
import Mutable;
import SCodeUtil;
import StringUtil;
import System;
import Types;
import Util;
/* =======================================================
*
* Section for type definitions
*
* =======================================================
*/
protected constant Real HASHVECFACTOR = 1.4;
/* =======================================================
*
* Section for functions that deals with Var
*
* =======================================================
*/
public function varEqual "author: PA
Returns true if two vars are equal."
input BackendDAE.Var inVar1;
input BackendDAE.Var inVar2;
output Boolean outBoolean = ComponentReference.crefEqualNoStringCompare(inVar1.varName, inVar2.varName) "a BackendDAE.Var is identified by its component reference";
end varEqual;
public function setVarFixed "author: PA
Sets the fixed attribute of a variable."
input BackendDAE.Var inVar;
input Boolean inBoolean;
output BackendDAE.Var outVar = inVar;
protected
Option<DAE.VariableAttributes> oattr;
algorithm
oattr := if isSome(inVar.values) then inVar.values else SOME(getVariableAttributefromType(inVar.varType));
outVar.values := DAEUtil.setFixedAttr(oattr, SOME(DAE.BCONST(inBoolean)));
end setVarFixed;
public function removeFixedAttribute
input output BackendDAE.Var var;
algorithm
if isSome(var.values) then
var.values := DAEUtil.setFixedAttr(var.values, NONE());
end if;
end removeFixedAttribute;
public function removeStartAttribute
input output BackendDAE.Var var;
algorithm
if isSome(var.values) then
var.values := DAEUtil.setStartAttrOption(var.values, NONE());
end if;
end removeStartAttribute;
public function varFixed "author: PA
Extracts the fixed attribute of a variable.
The default fixed value is used if not found. Default is true for parameters
(and constants) and false for variables."
input BackendDAE.Var inVar;
output Boolean outBoolean;
algorithm
outBoolean := match(inVar)
local
Boolean fixed;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_REAL(fixed=SOME(DAE.BCONST(fixed)))))) then fixed;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_INT(fixed=SOME(DAE.BCONST(fixed)))))) then fixed;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_BOOL(fixed=SOME(DAE.BCONST(fixed)))))) then fixed;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_STRING(fixed=SOME(DAE.BCONST(fixed)))))) then fixed;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_ENUMERATION(fixed=SOME(DAE.BCONST(fixed)))))) then fixed;
// params and consts are by default fixed
case (BackendDAE.VAR(varKind=BackendDAE.PARAM())) then true;
case (BackendDAE.VAR(varKind=BackendDAE.CONST(),bindExp=SOME(_))) then true;
// rest defaults to false
else false;
end match;
end varFixed;
public function setVarStartValue "author: Frenkel TUD
Sets the start value attribute of a variable."
input BackendDAE.Var inVar;
input DAE.Exp inExp;
output BackendDAE.Var outVar = inVar;
protected
Option<DAE.VariableAttributes> oattr;
algorithm
oattr := if isSome(inVar.values) then inVar.values else SOME(getVariableAttributefromType(inVar.varType));
outVar.values := DAEUtil.setStartAttr(oattr, inExp);
end setVarStartValue;
public function setVarStartValueOption "author: Frenkel TUD
Sets the start value attribute of a variable."
input BackendDAE.Var inVar;
input Option<DAE.Exp> inExp;
output BackendDAE.Var outVar = inVar;
protected
Option<DAE.VariableAttributes> oattr;
algorithm
oattr := if isSome(inVar.values) then inVar.values else SOME(getVariableAttributefromType(inVar.varType));
outVar.values := DAEUtil.setStartAttrOption(oattr, inExp);
end setVarStartValueOption;
public function setVarStartOrigin "author: Frenkel TUD
Sets the startOrigin attribute of a variable."
input BackendDAE.Var inVar;
input Option<DAE.Exp> startOrigin;
output BackendDAE.Var outVar = inVar;
protected
Option<DAE.VariableAttributes> oattr;
algorithm
oattr := if isSome(inVar.values) then inVar.values else SOME(getVariableAttributefromType(inVar.varType));
outVar.values := DAEUtil.setStartOrigin(oattr, startOrigin);
end setVarStartOrigin;
public function setVarAttributes "sets the variable attributes of a variable.
author: Peter Aronsson (paronsson@wolfram.com)"
input BackendDAE.Var inVar;
input Option<DAE.VariableAttributes> inAttr;
output BackendDAE.Var outVar = inVar;
algorithm
outVar.values := inAttr;
end setVarAttributes;
public function varStartValue "author: PA
Returns the DAE.StartValue of a variable."
input BackendDAE.Var inVar;
output DAE.Exp sv;
algorithm
sv := DAEUtil.getStartAttr(inVar.values);
end varStartValue;
public function varUnreplaceable "author: lochel
Returns the unreplaceable attribute of a variable."
input BackendDAE.Var inVar;
output Boolean outUnreplaceable = inVar.unreplaceable;
end varUnreplaceable;
public function setVarUnreplaceable "author: arun
sets the unreplaceable attribute of a variable to be false or true"
input BackendDAE.Var inVar;
input Boolean value;
output BackendDAE.Var outVar = inVar;
algorithm
outVar.unreplaceable:= value;
end setVarUnreplaceable;
public function varStartValueFail "author: Frenkel TUD
Returns the DAE.StartValue of a variable if there is one.
Otherwise fail"
input BackendDAE.Var v;
output DAE.Exp sv;
protected
Option<DAE.VariableAttributes> attr;
algorithm
BackendDAE.VAR(values = attr) := v;
sv := DAEUtil.getStartAttrFail(attr);
end varStartValueFail;
public function varNominalValueFail "author: lochel
Returns the DAE.NominalValue of a variable if there is one.
Otherwise fails."
input BackendDAE.Var v;
output DAE.Exp sv;
protected
Option<DAE.VariableAttributes> attr;
algorithm
BackendDAE.VAR(values = attr) := v;
sv := DAEUtil.getNominalAttrFail(attr);
end varNominalValueFail;
public function varMinValueFail "author: lochel
Returns the DAE.MinValue of a variable if there is one.
Otherwise fails."
input BackendDAE.Var v;
output DAE.Exp sv;
protected
Option<DAE.VariableAttributes> attr;
algorithm
BackendDAE.VAR(values = attr) := v;
sv := DAEUtil.getMinAttrFail(attr);
end varMinValueFail;
public function varMaxValueFail "author: lochel
Returns the DAE.MaxValue of a variable if there is one.
Otherwise fails."
input BackendDAE.Var v;
output DAE.Exp sv;
protected
Option<DAE.VariableAttributes> attr;
algorithm
BackendDAE.VAR(values = attr) := v;
sv := DAEUtil.getMaxAttrFail(attr);
end varMaxValueFail;
public function varStartValueType "author: Frenkel TUD 2012-11
Returns the DAE.StartValue of a variable. If nothing is set the type specific one is used"
input BackendDAE.Var v;
output DAE.Exp sv;
algorithm
sv := matchcontinue(v)
local
Option<DAE.VariableAttributes> attr;
DAE.Type ty;
case (BackendDAE.VAR(values=attr)) equation
sv = DAEUtil.getStartAttrFail(attr);
then sv;
case BackendDAE.VAR(varType=ty) equation
true = Types.isIntegerOrSubTypeInteger(ty);
then DAE.ICONST(0);
case BackendDAE.VAR(varType=ty) equation
true = Types.isBooleanOrSubTypeBoolean(ty);
then DAE.BCONST(false);
case BackendDAE.VAR(varType=ty) equation
true = Types.isStringOrSubTypeString(ty);
then DAE.SCONST("");
else DAE.RCONST(0.0);
end matchcontinue;
end varStartValueType;
public function varStartValueOption "author: Frenkel TUD
Returns the DAE.StartValue of a variable if there is one.
Otherwise fail"
input BackendDAE.Var v;
output Option<DAE.Exp> sv;
algorithm
sv := matchcontinue(v)
local
Option<DAE.VariableAttributes> attr;
DAE.Exp exp;
case (BackendDAE.VAR(values=attr)) equation
exp = DAEUtil.getStartAttrFail(attr);
then SOME(exp);
else NONE();
end matchcontinue;
end varStartValueOption;
public function varHasStartValue
input BackendDAE.Var inVar;
output Boolean outHasStartValue;
protected
Option<DAE.VariableAttributes> attr;
algorithm
BackendDAE.VAR(values=attr) := inVar;
outHasStartValue := DAEUtil.hasStartAttr(attr);
end varHasStartValue;
public function varHasNoStartValue
input BackendDAE.Var inVar;
output Boolean outHasNoStartValue;
algorithm
outHasNoStartValue := not varHasStartValue(inVar);
end varHasNoStartValue;
public function varStartOrigin "author: Frenkel TUD
Returns the StartOrigin of a variable."
input BackendDAE.Var v;
output Option<DAE.Exp> so;
protected
Option<DAE.VariableAttributes> attr;
algorithm
BackendDAE.VAR(values = attr) := v;
so := DAEUtil.getStartOrigin(attr);
end varStartOrigin;
public function varBindExp "author: Frenkel TUD 2010-12
Returns the bindExp of a variable if available otherwise fails."
input BackendDAE.Var v;
output DAE.Exp sv;
algorithm
BackendDAE.VAR(bindExp=SOME(sv)) := v;
end varBindExp;
public function varHasConstantBindExp
"Returns true if the bindExp is constant otherwise false."
input BackendDAE.Var v;
output Boolean out;
algorithm
out := match(v)
local
DAE.Exp e;
case (BackendDAE.VAR(bindExp=SOME(e)))
then Expression.isConst(e);
else false;
end match;
end varHasConstantBindExp;
public function varHasNonConstantBindExpOrStartValue
"Returns true if the bindExp is not constant otherwise false."
input BackendDAE.Var v;
output Boolean out;
algorithm
out := match(v)
local
DAE.Exp e;
case (BackendDAE.VAR(bindExp=SOME(e)))
then not Expression.isConstValue(e) /* Do not use isConst here; we need to evaluate non-literals at runtime */;
else not varHasConstantStartExp(v);
end match;
end varHasNonConstantBindExpOrStartValue;
public function varHasConstantStartExp
"Returns the true if the binding/start value is constant otherwise false."
input BackendDAE.Var v;
output Boolean out;
protected
DAE.Exp e;
algorithm
try
e := varStartValueFail(v);
out := Expression.isConstValue(e) /* Do not use isConst here; we need to evaluate non-literals at runtime */;
else
out := true;
end try;
end varHasConstantStartExp;
public function varHasBindExp
"Returns the true if a bindExp exists otherwise false."
input BackendDAE.Var v;
output Boolean out;
algorithm
out := match(v)
local
DAE.Exp e;
case (BackendDAE.VAR(bindExp = SOME(_)))
then true;
else false;
end match;
end varHasBindExp;
public function varBindExpStartValue "author: Frenkel TUD 2010-12
Returns the binding or the start value if no binding is available.
This function fails if there is neither a binding nor a start value."
input BackendDAE.Var v;
output DAE.Exp sv;
algorithm
sv := match(v)
local
DAE.Exp e;
case (BackendDAE.VAR(bindExp=SOME(e)))
then e;
else varStartValueFail(v);
end match;
end varBindExpStartValue;
public function varBindExpStartValueNoFail
"Returns the binding or the start value if no binding is available."
input BackendDAE.Var v;
output DAE.Exp sv;
algorithm
sv := match(v)
local
DAE.Exp e;
case (BackendDAE.VAR(bindExp=SOME(e)))
then e;
else varStartValue(v);
end match;
end varBindExpStartValueNoFail;
public function varStateSelect "author: PA
Extracts the state select attribute of a variable. If no stateselect explicilty set, return
StateSelect.default"
input BackendDAE.Var inVar;
output DAE.StateSelect outStateSelect;
algorithm
outStateSelect := match (inVar)
local
DAE.StateSelect stateselect;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_REAL(stateSelectOption=SOME(stateselect)))))
then stateselect;
else DAE.DEFAULT();
end match;
end varStateSelect;
public function varStateSelectAlways
"author: Frenkel TUD 2012-06
return true if var is StateSelect.always else false"
input BackendDAE.Var v;
output Boolean b;
algorithm
b := match(v)
case BackendDAE.VAR(varKind=BackendDAE.STATE(),values = SOME(DAE.VAR_ATTR_REAL(stateSelectOption = SOME(DAE.ALWAYS())))) then true;
else false;
end match;
end varStateSelectAlways;
public function notVarStateSelectAlways
"author: Frenkel TUD 2012-06
true if var is not StateSelect.always"
input BackendDAE.Var v;
input Integer level;
output Boolean b;
algorithm
b := match v
local Integer diffcount;
case BackendDAE.VAR(varKind=BackendDAE.STATE(index=diffcount))
then not(varStateSelectAlways(v) and (diffcount == level or diffcount == 1));
else true;
end match;
end notVarStateSelectAlways;
public function varStateSelectNever
"author: kabdelhak
Returns true, if the state select attribute is DAE.NEVER()"
input BackendDAE.Var inVar;
output Boolean isNever;
algorithm
isNever := match(varStateSelect(inVar))
case DAE.NEVER() then true;
else false;
end match;
end varStateSelectNever;
public function setVarStateSelect "Sets the state select attribute of a variable."
input BackendDAE.Var inVar;
input DAE.StateSelect stateSelect;
output BackendDAE.Var outVar = inVar;
protected
Option<DAE.VariableAttributes> oattr;
algorithm
oattr := if isSome(inVar.values) then inVar.values else SOME(getVariableAttributefromType(inVar.varType));
outVar.values := DAEUtil.setStateSelect(oattr, stateSelect);
end setVarStateSelect;
public function varStateSelectForced
"author kabdelhak FHB 2019-09
Returns true if the variable has a state select attribute that forces it to be a state."
input BackendDAE.Var inVar;
output Boolean isForced;
algorithm
isForced := match (inVar)
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_REAL(stateSelectOption=SOME(DAE.ALWAYS())))))
then true;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_REAL(stateSelectOption=SOME(DAE.PREFER())))))
then true;
else false;
end match;
end varStateSelectForced;
public function isNaturalState
"author kabdelhak FHB 2019-08
Returns true if the input is a natural state.
A state is considered natural, if it occurs differentiated before index reduction."
input BackendDAE.Var var;
output Boolean natural;
algorithm
natural := match var
local
Boolean n;
case BackendDAE.VAR(varKind = BackendDAE.STATE(natural = n))
then n;
else false;
end match;
end isNaturalState;
public function isArtificialState
"author kabdelhak FHB 2019-08
Returns true if the input is an artificial state.
A state is considered artificial, if it does not occur differentiated before
index reduction, but is forced to be a state by stateSelect attribute."
input BackendDAE.Var var;
output Boolean artificial;
algorithm
artificial := match var
local
Boolean n;
case BackendDAE.VAR(varKind = BackendDAE.STATE(natural = n))
then not n;
else false;
end match;
end isArtificialState;
public function varStateDerivative "author: Frenkel TUD 2013-01
Returns the name of the Derivative. Is no Derivative known the function will fail."
input BackendDAE.Var inVar;
output DAE.ComponentRef dcr;
algorithm
BackendDAE.VAR(varKind=BackendDAE.STATE(derName=SOME(dcr))) := inVar;
end varStateDerivative;
public function varHasStateDerivative "author: Frenkel TUD 2013-01
Returns the name of the Derivative. Is no Derivative known the function will fail."
input BackendDAE.Var inVar;
output Boolean b;
algorithm
b := match(inVar)
case BackendDAE.VAR(varKind=BackendDAE.STATE(derName=SOME(_))) then true;
else false;
end match;
end varHasStateDerivative;
public function setStateDerivative "author: Frenkel TUD
sets the state derivative."
input output BackendDAE.Var var;
input Option<DAE.ComponentRef> derName;
protected
Integer index;
Boolean natural;
algorithm
BackendDAE.STATE(index=index, natural=natural) := var.varKind;
var.varKind := BackendDAE.STATE(index, derName, natural);
end setStateDerivative;
public function getVariableAttributefromType
input DAE.Type inType;
output DAE.VariableAttributes attr;
algorithm
attr := match(inType)
case DAE.T_REAL() then DAE.VAR_ATTR_REAL(NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE());
case DAE.T_INTEGER() then DAE.VAR_ATTR_INT(NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE());
case DAE.T_INTEGER() then DAE.VAR_ATTR_INT(NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE());
case DAE.T_BOOL() then DAE.VAR_ATTR_BOOL(NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE());
case DAE.T_STRING() then DAE.VAR_ATTR_STRING(NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE());
case DAE.T_ENUMERATION() then DAE.VAR_ATTR_ENUMERATION(NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE());
else equation
// repord a warning on failtrace
if Flags.isSet(Flags.FAILTRACE) then
Debug.trace("getVariableAttributefromType called with unsopported Type!\n");
end if;
then DAE.VAR_ATTR_REAL(NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE(),NONE());
end match;
end getVariableAttributefromType;
public function setVarFinal "Sets the final attribute of a variable."
input BackendDAE.Var inVar;
input Boolean finalPrefix;
output BackendDAE.Var outVar = inVar;
protected
Option<DAE.VariableAttributes> oattr;
algorithm
oattr := if isSome(inVar.values) then inVar.values else SOME(getVariableAttributefromType(inVar.varType));
outVar.values := DAEUtil.setFinalAttr(oattr, finalPrefix);
end setVarFinal;
public function setVarMinMax "Sets the min/max attribute of a variable.
lochel: This function will not clear min/max attributes if both inMin and
inMax are NONE(). Is that the intended behaviour?"
input BackendDAE.Var inVar;
input Option<DAE.Exp> inMin;
input Option<DAE.Exp> inMax;
output BackendDAE.Var outVar = inVar;
protected
Option<DAE.VariableAttributes> oattr;
algorithm
if isSome(inMin) or isSome(inMax) then
oattr := if isSome(inVar.values) then inVar.values else SOME(getVariableAttributefromType(inVar.varType));
outVar.values := DAEUtil.setMinMax(oattr, inMin, inMax);
end if;
end setVarMinMax;
public function setUnit "author: jhagemann
Sets the unit attribute of a variable."
input BackendDAE.Var inVar;
input DAE.Exp inUnit;
output BackendDAE.Var outVar = inVar;
protected
Option<DAE.VariableAttributes> oattr;
algorithm
oattr := if isSome(inVar.values) then inVar.values else SOME(getVariableAttributefromType(inVar.varType));
outVar.values := DAEUtil.setUnitAttr(oattr, inUnit);
end setUnit;
public function varNominalValue "author: Frenkel TUD"
input BackendDAE.Var inVar;
output DAE.Exp outExp;
algorithm
BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_REAL(nominal=SOME(outExp)))) := inVar;
end varNominalValue;
public function setVarNominalValue "author: Frenkel TUD
Sets the nominal value attribute of a variable."
input BackendDAE.Var inVar;
input DAE.Exp inExp;
output BackendDAE.Var outVar = inVar;
protected
Option<DAE.VariableAttributes> oattr;
algorithm
oattr := if isSome(inVar.values) then inVar.values else SOME(getVariableAttributefromType(inVar.varType));
outVar.values := DAEUtil.setNominalAttr(oattr, inExp);
end setVarNominalValue;
public function varType "author: PA
extracts the type of a variable"
input BackendDAE.Var inVar;
output BackendDAE.Type outType;
algorithm
BackendDAE.VAR(varType=outType) := inVar;
end varType;
public function varKind "author: PA
extracts the kind of a variable"
input BackendDAE.Var inVar;
output BackendDAE.VarKind outVarKind;
algorithm
BackendDAE.VAR(varKind=outVarKind) := inVar;
end varKind;
public function varNominal "author: PA
Extacts the nominal attribute of a variable. If the variable has no
nominal value, the function fails."
input BackendDAE.Var inVar;
output Real outReal;
algorithm
BackendDAE.VAR(values = SOME(DAE.VAR_ATTR_REAL(nominal=SOME(DAE.RCONST(outReal))))) := inVar;
end varNominal;
public function varHasNominalValue "author: BB"
input BackendDAE.Var inVar;
output Boolean outBool;
algorithm
try
BackendDAE.VAR(values = SOME(DAE.VAR_ATTR_REAL(nominal=SOME(DAE.RCONST())))) := inVar;
outBool := true;
else
outBool :=false;
end try;
end varHasNominalValue;
public function varCref "author: PA
extracts the ComponentRef of a variable"
input BackendDAE.Var inVar;
output DAE.ComponentRef outComponentRef;
algorithm
BackendDAE.VAR(varName=outComponentRef) := inVar;
end varCref;
public function isStateVar
"Returns true for state variables, false otherwise."
input BackendDAE.Var inVar;
output Boolean outBoolean;
algorithm
outBoolean := match (inVar)
case (BackendDAE.VAR(varKind = BackendDAE.STATE())) then true;
else false;
end match;
end isStateVar;
public function isState
input DAE.ComponentRef inCref;
input BackendDAE.Variables inVars;
output Boolean outBool;
algorithm
outBool:=
matchcontinue(inCref, inVars)
case(_, _) equation
((BackendDAE.VAR(varKind = BackendDAE.STATE()) :: _),_) = getVar(inCref, inVars);
then true;
else false;
end matchcontinue;
end isState;
public function isNonStateVar
"this equation checks if the the varkind is state of variable
used both in build_equation and generate_compute_state"
input BackendDAE.Var inVar;
output Boolean outBoolean;
algorithm
outBoolean := match (inVar)
case BackendDAE.VAR(varKind=BackendDAE.VARIABLE()) then true;
case BackendDAE.VAR(varKind=BackendDAE.DUMMY_DER()) then true;
case BackendDAE.VAR(varKind=BackendDAE.DUMMY_STATE()) then true;
case BackendDAE.VAR(varKind=BackendDAE.DISCRETE()) then true;
case BackendDAE.VAR(varKind=BackendDAE.STATE_DER()) then true;
case BackendDAE.VAR(varKind=BackendDAE.OPT_CONSTR()) then true;
case BackendDAE.VAR(varKind=BackendDAE.OPT_FCONSTR()) then true;
case BackendDAE.VAR(varKind=BackendDAE.OPT_INPUT_WITH_DER()) then true;
case BackendDAE.VAR(varKind=BackendDAE.OPT_INPUT_DER()) then true;
case BackendDAE.VAR(varKind=BackendDAE.OPT_TGRID()) then true;
case BackendDAE.VAR(varKind=BackendDAE.OPT_LOOP_INPUT()) then true;
case BackendDAE.VAR(varKind=BackendDAE.ALG_STATE()) then true;
case BackendDAE.VAR(varKind=BackendDAE.LOOP_ITERATION()) then true;
case BackendDAE.VAR(varKind=BackendDAE.LOOP_SOLVED()) then true;
else false;
end match;
end isNonStateVar;
public function isClockedStateVar
"Returns true for clocked state variables, false otherwise."
input BackendDAE.Var inVar;
output Boolean outBool;
algorithm
outBool := match (inVar)
case (BackendDAE.VAR(varKind = BackendDAE.CLOCKED_STATE())) then true;
else false;
end match;
end isClockedStateVar;
public function isClockedState
"Returns true for clocked state variables, false otherwise."
input DAE.ComponentRef inCref;
input BackendDAE.Variables inVars;
output Boolean outBool;
algorithm
outBool :=
matchcontinue(inCref, inVars)
case(_, _) equation
((BackendDAE.VAR(varKind = BackendDAE.CLOCKED_STATE()) :: _),_) = getVar(inCref, inVars);
then true;
else false;
end matchcontinue;
end isClockedState;
public function varHasUncertainValueRefine "author: Daniel Hedberg, 2011-01
modified by: Leonardo Laguna, 2012-01
Returns true if the specified variable has the attribute uncertain and the
value of it is Uncertainty.refine, false otherwise."
input BackendDAE.Var var;
output Boolean b;
algorithm
b := match (var)
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_REAL(uncertainOption=SOME(DAE.REFINE()))))) then true;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_INT(uncertainOption=SOME(DAE.REFINE()))))) then true;
else false;
end match;
end varHasUncertainValueRefine;
public function varDistribution "author: Peter Aronsson, 2012-05
Returns Distribution record of a variable."
input BackendDAE.Var var;
output DAE.Distribution d;
algorithm
d := match (var)
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_REAL(distributionOption=SOME(d))))) then d;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_INT(distributionOption=SOME(d))))) then d;
end match;
end varDistribution;
public function varTryGetDistribution "author: Peter Aronsson, 2012-05
Returns Distribution record of a variable."
input BackendDAE.Var var;
output Option<DAE.Distribution> dout;
protected
Option<DAE.Distribution> d;
algorithm
dout := match (var)
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_REAL(distributionOption=d as SOME(_))))) then d;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_INT(distributionOption=d as SOME(_))))) then d;
else NONE();
end match;
end varTryGetDistribution;
public function varUncertainty "author: Peter Aronsson, 2012-05
Returns Uncertainty of a variable."
input BackendDAE.Var var;
output DAE.Uncertainty u;
algorithm
u := match (var)
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_REAL(uncertainOption=SOME(u))))) then u;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_INT(uncertainOption=SOME(u))))) then u;
end match;
end varUncertainty;
public function varHasDistributionAttribute "author: Peter Aronsson, 2012-05
Returns true if the specified variable has the attribute distribution set."
input BackendDAE.Var var;
output Boolean b;
algorithm
b := match (var)
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_REAL(distributionOption=SOME(_))))) then true;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_INT(distributionOption=SOME(_))))) then true;
else false;
end match;
end varHasDistributionAttribute;
public function varHasUncertaintyAttribute "author: Peter Aronsson, 2012-05
Returns true if the specified variable has the attribute uncertain set."
input BackendDAE.Var var;
output Boolean b;
algorithm
b := match (var)
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_REAL(uncertainOption=SOME(_))))) then true;
case (BackendDAE.VAR(values=SOME(DAE.VAR_ATTR_INT(uncertainOption=SOME(_))))) then true;
else false;
end match;
end varHasUncertaintyAttribute;
public function isDummyStateVar "Returns true for dummy state variables, false otherwise."
input BackendDAE.Var inVar;
output Boolean outBoolean;
algorithm
outBoolean := match (inVar)
case (BackendDAE.VAR(varKind = BackendDAE.DUMMY_STATE())) then true;
else false;
end match;
end isDummyStateVar;
public function isDummyDerVar
"Returns true for dummy state variables, false otherwise."
input BackendDAE.Var inVar;
output Boolean outBoolean;
algorithm
outBoolean := match (inVar)
case (BackendDAE.VAR(varKind = BackendDAE.DUMMY_DER())) then true;
else false;
end match;
end isDummyDerVar;
public function isStateDerVar "
Returns true for der(state) variables, false otherwise."
input BackendDAE.Var inVar;
output Boolean outBoolean;
algorithm
outBoolean := match (inVar)
case (BackendDAE.VAR(varKind = BackendDAE.STATE_DER())) then true;
else false;
end match;
end isStateDerVar;
public function isStateorStateDerVar
"Returns true for state and der(state) variables, false otherwise."
input BackendDAE.Var inVar;
output Boolean outBoolean;
algorithm
outBoolean := match (inVar)
case (BackendDAE.VAR(varKind = BackendDAE.STATE())) then true;
case (BackendDAE.VAR(varKind = BackendDAE.STATE_DER())) then true;
else false;
end match;
end isStateorStateDerVar;
public function isVarDiscrete
"This functions checks if BackendDAE.Var is discrete"
input BackendDAE.Var inVar;
output Boolean outBoolean;
algorithm
outBoolean := match (inVar)
case (BackendDAE.VAR(varKind = BackendDAE.DISCRETE())) then true;
case (BackendDAE.VAR(varKind = BackendDAE.PARAM())) then true;
case (BackendDAE.VAR(varKind = BackendDAE.CONST())) then true;
case (BackendDAE.VAR(varType = DAE.T_INTEGER())) then true;
case (BackendDAE.VAR(varType = DAE.T_BOOL())) then true;
case (BackendDAE.VAR(varType = DAE.T_ENUMERATION())) then true;
else false;
end match;
end isVarDiscrete;
public function isDiscrete
"This functions checks if BackendDAE.Var is discrete"
input DAE.ComponentRef cr;
input BackendDAE.Variables vars;
output Boolean outBoolean;
protected
BackendDAE.Var v;
algorithm
(v,_) := getVarSingle(cr,vars);
outBoolean := isVarDiscrete(v);
end isDiscrete;
public function isVarNonDiscrete
input BackendDAE.Var inVar;
output Boolean outBoolean;
algorithm
outBoolean := not isVarDiscrete(inVar);
end isVarNonDiscrete;
public function hasDiscreteVar
"Returns true if var list contains a discrete time variable."
input list<BackendDAE.Var> inBackendDAEVarLst;
output Boolean outBoolean = false;
algorithm
for v in inBackendDAEVarLst loop
outBoolean := isVarDiscrete(v);
if outBoolean then
break;
end if;
end for;
end hasDiscreteVar;
public function hasContinuousVar
"Returns true if var list contains a continuous time variable."
input list<BackendDAE.Var> inBackendDAEVarLst;
output Boolean outBoolean;
algorithm
outBoolean := match (inBackendDAEVarLst)
local
BackendDAE.Var v;
list<BackendDAE.Var> vs;
case ((BackendDAE.VAR(varKind=BackendDAE.VARIABLE(), varType = DAE.T_REAL()) :: _)) then true;
case ((BackendDAE.VAR(varKind=BackendDAE.VARIABLE(), varType = DAE.T_ARRAY(ty=DAE.T_REAL())) :: _)) then true;
case ((BackendDAE.VAR(varKind=BackendDAE.STATE()) :: _)) then true;
case ((BackendDAE.VAR(varKind=BackendDAE.STATE_DER()) :: _)) then true;
case ((BackendDAE.VAR(varKind=BackendDAE.DUMMY_DER()) :: _)) then true;
case ((BackendDAE.VAR(varKind=BackendDAE.DUMMY_STATE()) :: _)) then true;
case ((BackendDAE.VAR(varKind=BackendDAE.OPT_CONSTR()) :: _)) then true;
case ((BackendDAE.VAR(varKind=BackendDAE.OPT_FCONSTR()) :: _)) then true;
case ((BackendDAE.VAR(varKind=BackendDAE.OPT_INPUT_WITH_DER()) :: _)) then true;
case ((BackendDAE.VAR(varKind=BackendDAE.OPT_INPUT_DER()) :: _)) then true;
case ((BackendDAE.VAR(varKind=BackendDAE.OPT_TGRID()) :: _)) then true;
case ((BackendDAE.VAR(varKind=BackendDAE.OPT_LOOP_INPUT()) :: _)) then true;
case ((BackendDAE.VAR(varKind=BackendDAE.ALG_STATE()) :: _)) then true;
case ((_ :: vs)) then hasContinuousVar(vs);
case ({}) then false;
end match;
end hasContinuousVar;
public function isVarNonDiscreteAlg
input BackendDAE.Var var;
output Boolean result;
algorithm
result := match (var)
/* Real non discrete variable */
case (BackendDAE.VAR(varType = DAE.T_REAL())) equation
then (isVarAlg(var) and not isVarDiscreteRealAlg(var)) or isOptInputVar(var);
else false;
end match;
end isVarNonDiscreteAlg;