-
Notifications
You must be signed in to change notification settings - Fork 298
/
CodegenFMU.tpl
3215 lines (2991 loc) · 160 KB
/
CodegenFMU.tpl
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 defines templates for transforming Modelica/MetaModelica code to FMU
// code. They are used in the code generator phase of the compiler to write
// target code.
//
// There are one root template intended to be called from the code generator:
// translateModel. These template do not return any
// result but instead write the result to files. All other templates return
// text and are used by the root templates (most of them indirectly).
//
// To future maintainers of this file:
//
// - A line like this
// # var = "" /*BUFD*/
// declares a text buffer that you can later append text to. It can also be
// passed to other templates that in turn can append text to it. In the new
// version of Susan it should be written like this instead:
// let &var = buffer ""
//
// - A line like this
// ..., Text var /*BUFP*/, ...
// declares that a template takes a text buffer as input parameter. In the
// new version of Susan it should be written like this instead:
// ..., Text &var, ...
//
// - A line like this:
// ..., var /*BUFC*/, ...
// passes a text buffer to a template. In the new version of Susan it should
// be written like this instead:
// ..., &var, ...
//
// - Style guidelines:
//
// - Try (hard) to limit each row to 80 characters
//
// - Code for a template should be indented with 2 spaces
//
// - Exception to this rule is if you have only a single case, then that
// single case can be written using no indentation
//
// This single case can be seen as a clarification of the input to the
// template
//
// - Code after a case should be indented with 2 spaces if not written on the
// same line
package CodegenFMU
import interface SimCodeTV;
import interface SimCodeBackendTV;
import CodegenUtil.*;
import CodegenUtilSimulation.*;
import CodegenC.*; //unqualified import, no need the CodegenC is optional when calling a template; or mandatory when the same named template exists in this package (name hiding)
import CodegenCFunctions.*;
import CodegenFMUCommon.*;
import CodegenFMU1;
import CodegenFMU2;
template translateModel(SimCode simCode, String FMUVersion, String FMUType, list<String> sourceFiles)
"Generates C code and Makefile for compiling a FMU of a
Modelica model."
::=
match simCode
case sc as SIMCODE(modelInfo=modelInfo as MODELINFO(__)) then
let guid = getUUIDStr()
let target = simulationCodeTarget()
let fileNamePrefixTmpDir = '<%fileNamePrefix%>.fmutmp/sources/<%fileNamePrefix%>'
let()= textFile(simulationLiteralsFile(fileNamePrefix, literals), '<%fileNamePrefixTmpDir%>_literals.h')
let()= textFile(simulationFunctionsHeaderFile(fileNamePrefix, modelInfo.functions, recordDecls), '<%fileNamePrefixTmpDir%>_functions.h')
let()= textFile(simulationFunctionsFile(fileNamePrefix, modelInfo.functions), '<%fileNamePrefixTmpDir%>_functions.c')
let()= textFile(externalFunctionIncludes(sc.externalFunctionIncludes), '<%fileNamePrefixTmpDir%>_includes.h')
let()= textFile(recordsFile(fileNamePrefix, recordDecls, true /*isSimulation*/), '<%fileNamePrefixTmpDir%>_records.c')
let()= textFile(simulationHeaderFile(simCode), '<%fileNamePrefixTmpDir%>_model.h')
let _ = generateSimulationFiles(simCode,guid,fileNamePrefixTmpDir,FMUVersion)
let()= textFile(simulationInitFunction(simCode,guid), '<%fileNamePrefixTmpDir%>_init_fmu.c')
let()= textFile(fmumodel_identifierFile(simCode,guid,FMUVersion), '<%fileNamePrefixTmpDir%>_FMU.c')
/* Doesn't seem to work properly
let &fmuModelDescription = buffer ""
let &fmuModelDescription += redirectToFile('<%fileNamePrefix%>.fmutmp/modelDescription.xml')
let &fmuModelDescription += fmuModelDescriptionFile(simCode,guid,FMUVersion,FMUType)
let &fmuModelDescription += closeFile()
*/
let()= textFile(fmuModelDescriptionFile(simCode, guid, FMUVersion, FMUType, sourceFiles), '<%fileNamePrefix%>.fmutmp/modelDescription.xml')
// Generate optional <fmiPrefix>_flags.json
let _ = match sc.fmiSimulationFlags
case SOME(fmiSimFlags as FMI_SIMULATION_FLAGS(__)) then
let() = textFile(fmuSimulationFlagsFile(fmiSimFlags), '<%fileNamePrefix%>.fmutmp/resources/<%fileNamePrefix%>_flags.json')
""
else
""
end match
let()= textFile(fmudeffile(simCode,FMUVersion), '<%fileNamePrefix%>.fmutmp/sources/<%fileNamePrefix%>.def')
let()= textFile('# Dummy file so OMDEV Compile.bat works<%\n%>include Makefile<%\n%>', '<%fileNamePrefix%>.fmutmp/sources/<%fileNamePrefix%>.makefile')
let()= textFile(fmuSourceMakefile(simCode,FMUVersion), '<%fileNamePrefix%>_FMU.makefile')
"" // Return empty result since result written to files directly
end translateModel;
/* public */ template generateSimulationFiles(SimCode simCode, String guid, String modelNamePrefix, String fmuVersion)
"Generates code in different C files for the simulation target.
To make the compilation faster we split the simulation files into several
used in Compiler/Template/CodegenFMU.tpl"
::=
match simCode
case simCode as SIMCODE(__) then
// external objects
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_exo(simCode), '<%modelNamePrefix%>_01exo.c')
// non-linear systems
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_nls(simCode), '<%modelNamePrefix%>_02nls.c')
// linear systems
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_lsy(simCode), '<%modelNamePrefix%>_03lsy.c')
// state set
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_set(simCode), '<%modelNamePrefix%>_04set.c')
// events: sample, zero crossings, relations
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_evt(simCode), '<%modelNamePrefix%>_05evt.c')
// initialization
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_inz(simCode), '<%modelNamePrefix%>_06inz.c')
// delay
let()= textFileConvertLines(simulationFile_dly(simCode), '<%modelNamePrefix%>_07dly.c')
// update bound start values, update bound parameters
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_bnd(simCode), '<%modelNamePrefix%>_08bnd.c')
// algebraic
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_alg(simCode), '<%modelNamePrefix%>_09alg.c')
// asserts
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_asr(simCode), '<%modelNamePrefix%>_10asr.c')
// mixed systems
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let &mixheader = buffer ""
let()= textFileConvertLines(simulationFile_mix(simCode,&mixheader), '<%modelNamePrefix%>_11mix.c')
let()= textFile(&mixheader, '<%modelNamePrefix%>_11mix.h')
// jacobians
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_jac(simCode), '<%modelNamePrefix%>_12jac.c')
let()= textFile(simulationFile_jac_header(simCode), '<%modelNamePrefix%>_12jac.h')
// optimization
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_opt(simCode), '<%modelNamePrefix%>_13opt.c')
let()= textFile(simulationFile_opt_header(simCode), '<%modelNamePrefix%>_13opt.h')
// linearization
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_lnz(simCode), '<%modelNamePrefix%>_14lnz.c')
// synchronous
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_syn(simCode), '<%modelNamePrefix%>_15syn.c')
// residuals
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_dae(simCode), '<%modelNamePrefix%>_16dae.c')
// inline solver
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile_inl(simCode), '<%modelNamePrefix%>_17inl.c')
// main file
let()=tmpTickResetIndex(0, 0)
let()=tmpTickResetIndex(0, 1)
let()= textFileConvertLines(simulationFile(simCode,guid,fmuVersion), '<%modelNamePrefix%>.c')
""
end match
end generateSimulationFiles;
template fmuModelDescriptionFile(SimCode simCode, String guid, String FMUVersion, String FMUType, list<String> sourceFiles)
"Generates code for ModelDescription file for FMU target."
::=
match simCode
case SIMCODE(__) then
<<
<?xml version="1.0" encoding="UTF-8"?>
<%
if isFMIVersion20(FMUVersion) then CodegenFMU2.fmiModelDescription(simCode, guid, FMUType, sourceFiles)
else CodegenFMU1.fmiModelDescription(simCode,guid,FMUType)
%>
>>
end fmuModelDescriptionFile;
template fmuSimulationFlagsFile(FmiSimulationFlags fmiSimulationFlags)
"Generates <fmiPrefix>_flags.json file for FMUs with custom simulation flags."
::=
match fmiSimulationFlags
case flags as FMI_SIMULATION_FLAGS(__) then
let fileContent = (flags.nameValueTuples |> (name, value) =>
'"<%name%>" : "<%value%>"'
;separator=",\n")
<<
{
<%fileContent%>
}
>>
end fmuSimulationFlagsFile;
template VendorAnnotations(SimCode simCode)
"Generates code for VendorAnnotations file for FMU target."
::=
match simCode
case SIMCODE(__) then
<<
<VendorAnnotations>
</VendorAnnotations>
>>
end VendorAnnotations;
template fmumodel_identifierFile(SimCode simCode, String guid, String FMUVersion)
"Generates code for ModelDescription file for FMU target."
::=
match simCode
case SIMCODE(__) then
<<
// define class name and unique id
#define MODEL_IDENTIFIER <%modelNamePrefix(simCode)%>
#define MODEL_GUID "{<%guid%>}"
// include fmu header files, typedefs and macros
#include <stdio.h>
#include <string.h>
#include <assert.h>
#include "openmodelica.h"
#include "openmodelica_func.h"
#include "simulation_data.h"
#include "util/omc_error.h"
#include "<%fileNamePrefix%>_functions.h"
#include "simulation/solver/initialization/initialization.h"
#include "simulation/solver/events.h"
<%if isFMIVersion20(FMUVersion) then
<<
#include "fmi-export/fmu2_model_interface.h"
#include "fmi-export/fmu_read_flags.h"
>>
else
'#include "fmi-export/fmu1_model_interface.h"'%>
#ifdef __cplusplus
extern "C" {
#endif
void setStartValues(ModelInstance *comp);
void setDefaultStartValues(ModelInstance *comp);
<%if isFMIVersion20(FMUVersion) then
<<
void eventUpdate(ModelInstance* comp, fmi2EventInfo* eventInfo);
fmi2Real getReal(ModelInstance* comp, const fmi2ValueReference vr);
fmi2Status setReal(ModelInstance* comp, const fmi2ValueReference vr, const fmi2Real value);
fmi2Integer getInteger(ModelInstance* comp, const fmi2ValueReference vr);
fmi2Status setInteger(ModelInstance* comp, const fmi2ValueReference vr, const fmi2Integer value);
fmi2Boolean getBoolean(ModelInstance* comp, const fmi2ValueReference vr);
fmi2Status setBoolean(ModelInstance* comp, const fmi2ValueReference vr, const fmi2Boolean value);
fmi2String getString(ModelInstance* comp, const fmi2ValueReference vr);
fmi2Status setString(ModelInstance* comp, const fmi2ValueReference vr, fmi2String value);
fmi2Status setExternalFunction(ModelInstance* c, const fmi2ValueReference vr, const void* value);
fmi2ValueReference mapInputReference2InputNumber(const fmi2ValueReference vr);
fmi2ValueReference mapOutputReference2OutputNumber(const fmi2ValueReference vr);
>>
else
<<
void eventUpdate(ModelInstance* comp, fmiEventInfo* eventInfo);
fmiReal getReal(ModelInstance* comp, const fmiValueReference vr);
fmiStatus setReal(ModelInstance* comp, const fmiValueReference vr, const fmiReal value);
fmiInteger getInteger(ModelInstance* comp, const fmiValueReference vr);
fmiStatus setInteger(ModelInstance* comp, const fmiValueReference vr, const fmiInteger value);
fmiBoolean getBoolean(ModelInstance* comp, const fmiValueReference vr);
fmiStatus setBoolean(ModelInstance* comp, const fmiValueReference vr, const fmiBoolean value);
fmiString getString(ModelInstance* comp, const fmiValueReference vr);
fmiStatus setString(ModelInstance* comp, const fmiValueReference vr, fmiString value);
fmiStatus setExternalFunction(ModelInstance* c, const fmiValueReference vr, const void* value);
>>
%>
<%ModelDefineData(simCode, modelInfo)%>
// implementation of the Model Exchange functions
<%if isFMIVersion20(FMUVersion) then
<<
extern void <%symbolName(modelNamePrefix(simCode),"setupDataStruc")%>(DATA *data, threadData_t *threadData);
#define fmu2_model_interface_setupDataStruc <%symbolName(modelNamePrefix(simCode),"setupDataStruc")%>
#include "fmi-export/fmu2_model_interface.c.inc"
#include "fmi-export/fmu_read_flags.c.inc"
>>
else
<<
extern void <%symbolName(modelNamePrefix(simCode),"setupDataStruc")%>(DATA *data, threadData_t *threadData);
#define fmu1_model_interface_setupDataStruc <%symbolName(modelNamePrefix(simCode),"setupDataStruc")%>
#include "fmi-export/fmu1_model_interface.c.inc"
>>
%>
<%setDefaultStartValues(modelInfo)%>
<%setStartValues(modelInfo)%>
<%if isFMIVersion20(FMUVersion) then
<<
<%eventUpdateFunction2(simCode)%>
<%getRealFunction2(simCode, modelInfo)%>
<%setRealFunction2(simCode, modelInfo)%>
<%getIntegerFunction2(simCode, modelInfo)%>
<%setIntegerFunction2(simCode, modelInfo)%>
<%getBooleanFunction2(simCode, modelInfo)%>
<%setBooleanFunction2(simCode, modelInfo)%>
<%getStringFunction2(simCode, modelInfo)%>
<%setStringFunction2(simCode, modelInfo)%>
<%setExternalFunction2(modelInfo)%>
<%mapInputAndOutputs(simCode)%>
>>
else
<<
<%eventUpdateFunction(simCode)%>
<%getRealFunction(simCode, modelInfo)%>
<%setRealFunction(simCode, modelInfo)%>
<%getIntegerFunction(simCode, modelInfo)%>
<%setIntegerFunction(simCode, modelInfo)%>
<%getBooleanFunction(simCode, modelInfo)%>
<%setBooleanFunction(simCode, modelInfo)%>
<%getStringFunction(simCode, modelInfo)%>
<%setStringFunction(simCode, modelInfo)%>
<%setExternalFunction(modelInfo)%>
>>
%>
#ifdef __cplusplus
}
#endif
>>
end fmumodel_identifierFile;
template ModelDefineData(SimCode simCode, ModelInfo modelInfo)
"Generates global data in simulation file."
::=
match modelInfo
case MODELINFO(varInfo=VARINFO(__), vars=SIMVARS(stateVars = listStates)) then
let numberOfReals = intAdd(intMul(varInfo.numStateVars,2),intAdd(varInfo.numDiscreteReal, intAdd(varInfo.numAlgVars,intAdd(varInfo.numParams,varInfo.numAlgAliasVars))))
let numberOfIntegers = intAdd(varInfo.numIntAlgVars,intAdd(varInfo.numIntParams,varInfo.numIntAliasVars))
let numberOfStrings = intAdd(varInfo.numStringAlgVars,intAdd(varInfo.numStringParamVars,varInfo.numStringAliasVars))
let numberOfBooleans = intAdd(varInfo.numBoolAlgVars,intAdd(varInfo.numBoolParams,varInfo.numBoolAliasVars))
<<
// define model size
#define NUMBER_OF_STATES <%if intEq(varInfo.numStateVars,1) then statesnumwithDummy(listStates) else varInfo.numStateVars%>
#define NUMBER_OF_EVENT_INDICATORS <%varInfo.numZeroCrossings%>
#define NUMBER_OF_REALS <%numberOfReals%>
#define NUMBER_OF_INTEGERS <%numberOfIntegers%>
#define NUMBER_OF_STRINGS <%numberOfStrings%>
#define NUMBER_OF_BOOLEANS <%numberOfBooleans%>
#define NUMBER_OF_EXTERNALFUNCTIONS <%countDynamicExternalFunctions(functions)%>
// define initial state vector as vector of value references
#define STATES { <%vars.stateVars |> SIMVAR(__) => if stringEq(crefStr(name),"$dummy") then '' else lookupVR(name, simCode) ;separator=", "%> }
#define STATESDERIVATIVES { <%vars.derivativeVars |> SIMVAR(__) => if stringEq(crefStr(name),"der($dummy)") then '' else lookupVR(name, simCode) ;separator=", "%> }
<%System.tmpTickReset(0)%>
<%(functions |> fn => defineExternalFunction(fn) ; separator="\n")%>
>>
end ModelDefineData;
template dervativeNameCStyle(ComponentRef cr)
"Generates the name of a derivative in c style, replaces ( with _"
::=
match cr
case CREF_QUAL(ident = "$DER") then 'der_<%crefStr(componentRef)%>_'
end dervativeNameCStyle;
template defineExternalFunction(Function fn)
"Generates external function definitions."
::=
match fn
case EXTERNAL_FUNCTION(dynamicLoad=true) then
let fname = extFunctionName(extName, language)
<<
#define $P<%fname%> <%System.tmpTick()%>
>>
end defineExternalFunction;
template setDefaultStartValues(ModelInfo modelInfo)
"Generates code in c file for function setStartValues() which will set start values for all variables."
::=
match modelInfo
case MODELINFO(varInfo=VARINFO(numStateVars=numStateVars, numAlgVars= numAlgVars),vars=SIMVARS(__)) then
<<
// Set values for all variables that define a start value
OMC_DISABLE_OPT
void setDefaultStartValues(ModelInstance *comp) {
<%vars.stateVars |> var => initValsDefault(var,"realVars") ;separator="\n"%>
<%vars.derivativeVars |> var => initValsDefault(var,"realVars") ;separator="\n"%>
<%vars.algVars |> var => initValsDefault(var,"realVars") ;separator="\n"%>
<%vars.discreteAlgVars |> var => initValsDefault(var, "realVars") ;separator="\n"%>
<%vars.intAlgVars |> var => initValsDefault(var,"integerVars") ;separator="\n"%>
<%vars.boolAlgVars |> var => initValsDefault(var,"booleanVars") ;separator="\n"%>
<%vars.stringAlgVars |> var => initValsDefault(var,"stringVars") ;separator="\n"%>
<%vars.paramVars |> var => initParamsDefault(var,"realParameter") ;separator="\n"%>
<%vars.intParamVars |> var => initParamsDefault(var,"integerParameter") ;separator="\n"%>
<%vars.boolParamVars |> var => initParamsDefault(var,"booleanParameter") ;separator="\n"%>
<%vars.stringParamVars |> var => initParamsDefault(var,"stringParameter") ;separator="\n"%>
}
>>
end setDefaultStartValues;
template setStartValues(ModelInfo modelInfo)
"Generates code in c file for function setStartValues() which will set start values for all variables."
::=
match modelInfo
case MODELINFO(varInfo=VARINFO(numStateVars=numStateVars, numAlgVars= numAlgVars),vars=SIMVARS(__)) then
<<
// Set values for all variables that define a start value
OMC_DISABLE_OPT
void setStartValues(ModelInstance *comp) {
<%vars.stateVars |> var => initVals(var,"realVars") ;separator="\n"%>
<%vars.derivativeVars |> var => initVals(var,"realVars") ;separator="\n"%>
<%vars.algVars |> var => initVals(var,"realVars") ;separator="\n"%>
<%vars.discreteAlgVars |> var => initVals(var, "realVars") ;separator="\n"%>
<%vars.intAlgVars |> var => initVals(var,"integerVars") ;separator="\n"%>
<%vars.boolAlgVars |> var => initVals(var,"booleanVars") ;separator="\n"%>
<%vars.stringAlgVars |> var => initVals(var,"stringVars") ;separator="\n"%>
<%vars.paramVars |> var => initParams(var,"realParameter") ;separator="\n"%>
<%vars.intParamVars |> var => initParams(var,"integerParameter") ;separator="\n"%>
<%vars.boolParamVars |> var => initParams(var,"booleanParameter") ;separator="\n"%>
<%vars.stringParamVars |> var => initParams(var,"stringParameter") ;separator="\n"%>
}
>>
end setStartValues;
template initializeFunction(list<SimEqSystem> allEquations)
"Generates initialize function for c file."
::=
let &varDecls = buffer "" /*BUFD*/
let eqPart = ""/* (allEquations |> eq as SES_SIMPLE_ASSIGN(__) =>
equation_(eq, contextOther, &varDecls)
;separator="\n") */
<<
// Used to set the first time event, if any.
void initialize(ModelInstance* comp, fmiEventInfo* eventInfo) {
<%varDecls%>
<%eqPart%>
<%allEquations |> SES_SIMPLE_ASSIGN(__) =>
'if (sim_verbose) { printf("Setting variable start value: %s(start=%f)\n", "<%escapeModelicaStringToCString(crefStrNoUnderscore(cref))%>", <%cref(cref)%>); }'
;separator="\n"%>
}
>>
end initializeFunction;
template initVals(SimVar var, String arrayName) ::=
match var
case SIMVAR(__) then
if stringEq(crefStr(name),"$dummy") then
''
else if stringEq(crefStr(name),"der($dummy)") then
''
else
let str = 'comp->fmuData->modelData-><%arrayName%>Data[<%index%>].attribute.start'
'<%str%> = comp->fmuData->localData[0]-><%arrayName%>[<%index%>];'
end initVals;
template initParams(SimVar var, String arrayName) ::=
match var
case SIMVAR(__) then
let str = 'comp->fmuData->modelData-><%arrayName%>Data[<%index%>].attribute.start'
'<%str%> = comp->fmuData->simulationInfo-><%arrayName%>[<%index%>];'
end initParams;
template initValsDefault(SimVar var, String arrayName) ::=
match var
case SIMVAR(index=index, type_=type_) then
let str = 'comp->fmuData->modelData-><%arrayName%>Data[<%index%>].attribute.start'
'<%str%> = <%initValDefault(var)%>;'
end initValsDefault;
template initParamsDefault(SimVar var, String arrayName) ::=
match var
case SIMVAR(__) then
let str = 'comp->fmuData->modelData-><%arrayName%>Data[<%index%>].attribute.start'
match initialValue
case SOME(v as SCONST(__)) then
'<%str%> = mmc_mk_scon_persist(<%initVal(v)%>); /* TODO: these are not freed currently, see #6161 */'
else
'<%str%> = <%initValDefault(var)%>;'
end initParamsDefault;
template initValDefault(SimVar var) ::=
match var
case var as SIMVAR(__) then
match var.initialValue
case SOME(v as ICONST(__))
case SOME(v as RCONST(__))
case SOME(v as SCONST(__))
case SOME(v as BCONST(__))
case SOME(v as ENUM_LITERAL(__)) then initVal(v)
else
match var.type_
case T_INTEGER(__)
case T_REAL(__)
case T_ENUMERATION(__)
case T_BOOL(__) then '0'
case T_STRING(__) then 'mmc_mk_scon("")'
else error(sourceInfo(), 'Unknown type for initValDefault: <%unparseType(var.type_)%>')
end initValDefault;
template initVal(Exp initialValue)
::=
match initialValue
case ICONST(__) then integer
case RCONST(__) then real
case SCONST(__) then '"<%Util.escapeModelicaStringToXmlString(string)%>"'
case BCONST(__) then if bool then "1" else "0"
case ENUM_LITERAL(__) then '<%index%>'
else error(sourceInfo(), 'initial value of unknown type: <%printExpStr(initialValue)%>')
end initVal;
template eventUpdateFunction(SimCode simCode)
"Generates event update function for c file."
::=
match simCode
case SIMCODE(__) then
<<
// Used to set the next time event, if any.
void eventUpdate(ModelInstance* comp, fmiEventInfo* eventInfo) {
}
>>
end eventUpdateFunction;
template getRealFunction(SimCode simCode, ModelInfo modelInfo)
"Generates getReal function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__),varInfo=VARINFO(numStateVars=numStateVars, numAlgVars= numAlgVars)) then
<<
fmiReal getReal(ModelInstance* comp, const fmiValueReference vr) {
switch (vr) {
<%vars.stateVars |> var => SwitchVars(simCode, var, "realVars") ;separator="\n"%>
<%vars.derivativeVars |> var => SwitchVars(simCode, var, "realVars") ;separator="\n"%>
<%vars.algVars |> var => SwitchVars(simCode, var, "realVars") ;separator="\n"%>
<%vars.discreteAlgVars |> var => SwitchVars(simCode, var, "realVars") ;separator="\n"%>
<%vars.paramVars |> var => SwitchParameters(simCode, var, "realParameter") ;separator="\n"%>
<%vars.aliasVars |> var => SwitchAliasVars(simCode, var, "Real","-") ;separator="\n"%>
default:
return 0;
}
}
>>
end getRealFunction;
template setRealFunction(SimCode simCode, ModelInfo modelInfo)
"Generates setReal function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__),varInfo=VARINFO(numStateVars=numStateVars, numAlgVars= numAlgVars)) then
<<
fmiStatus setReal(ModelInstance* comp, const fmiValueReference vr, const fmiReal value) {
switch (vr) {
<%vars.stateVars |> var => SwitchVarsSet(simCode, var, "realVars") ;separator="\n"%>
<%vars.derivativeVars |> var => SwitchVarsSet(simCode, var, "realVars") ;separator="\n"%>
<%vars.algVars |> var => SwitchVarsSet(simCode, var, "realVars") ;separator="\n"%>
<%vars.discreteAlgVars |> var => SwitchVarsSet(simCode, var, "realVars") ;separator="\n"%>
<%vars.paramVars |> var => SwitchParametersSet(simCode, var, "realParameter") ;separator="\n"%>
<%vars.aliasVars |> var => SwitchAliasVarsSet(simCode, var, "Real", "-") ;separator="\n"%>
default:
return fmiError;
}
return fmiOK;
}
>>
end setRealFunction;
template getIntegerFunction(SimCode simCode, ModelInfo modelInfo)
"Generates getInteger function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__)) then
<<
fmiInteger getInteger(ModelInstance* comp, const fmiValueReference vr) {
switch (vr) {
<%vars.intAlgVars |> var => SwitchVars(simCode, var, "integerVars") ;separator="\n"%>
<%vars.intParamVars |> var => SwitchParameters(simCode, var, "integerParameter") ;separator="\n"%>
<%vars.intAliasVars |> var => SwitchAliasVars(simCode, var, "Integer", "-") ;separator="\n"%>
default:
return 0;
}
}
>>
end getIntegerFunction;
template setIntegerFunction(SimCode simCode, ModelInfo modelInfo)
"Generates setInteger function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__)) then
<<
fmiStatus setInteger(ModelInstance* comp, const fmiValueReference vr, const fmiInteger value) {
switch (vr) {
<%vars.intAlgVars |> var => SwitchVarsSet(simCode, var, "integerVars") ;separator="\n"%>
<%vars.intParamVars |> var => SwitchParametersSet(simCode, var, "integerParameter") ;separator="\n"%>
<%vars.intAliasVars |> var => SwitchAliasVarsSet(simCode, var, "Integer", "-") ;separator="\n"%>
default:
return fmiError;
}
return fmiOK;
}
>>
end setIntegerFunction;
template getBooleanFunction(SimCode simCode, ModelInfo modelInfo)
"Generates getBoolean function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__)) then
<<
fmiBoolean getBoolean(ModelInstance* comp, const fmiValueReference vr) {
switch (vr) {
<%vars.boolAlgVars |> var => SwitchVars(simCode, var, "booleanVars") ;separator="\n"%>
<%vars.boolParamVars |> var => SwitchParameters(simCode, var, "booleanParameter") ;separator="\n"%>
<%vars.boolAliasVars |> var => SwitchAliasVars(simCode, var, "Boolean", "!") ;separator="\n"%>
default:
return fmiFalse;
}
}
>>
end getBooleanFunction;
template setBooleanFunction(SimCode simCode, ModelInfo modelInfo)
"Generates setBoolean function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__)) then
<<
fmiStatus setBoolean(ModelInstance* comp, const fmiValueReference vr, const fmiBoolean value) {
switch (vr) {
<%vars.boolAlgVars |> var => SwitchVarsSet(simCode, var, "booleanVars") ;separator="\n"%>
<%vars.boolParamVars |> var => SwitchParametersSet(simCode, var, "booleanParameter") ;separator="\n"%>
<%vars.boolAliasVars |> var => SwitchAliasVarsSet(simCode, var, "Boolean", "!") ;separator="\n"%>
default:
return fmiError;
}
return fmiOK;
}
>>
end setBooleanFunction;
template getStringFunction(SimCode simCode, ModelInfo modelInfo)
"Generates getString function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__)) then
<<
fmiString getString(ModelInstance* comp, const fmiValueReference vr) {
switch (vr) {
<%vars.stringAlgVars |> var => SwitchVars(simCode, var, "stringVars") ;separator="\n"%>
<%vars.stringParamVars |> var => SwitchParameters(simCode, var, "stringParameter") ;separator="\n"%>
<%vars.stringAliasVars |> var => SwitchAliasVars(simCode, var, "String", "") ;separator="\n"%>
default:
return "";
}
}
>>
end getStringFunction;
template setStringFunction(SimCode simCode, ModelInfo modelInfo)
"Generates setString function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__)) then
<<
fmiStatus setString(ModelInstance* comp, const fmiValueReference vr, fmiString value) {
switch (vr) {
<%vars.stringAlgVars |> var => SwitchVarsSet(simCode, var, "stringVars") ;separator="\n"%>
<%vars.stringParamVars |> var => SwitchParametersSet(simCode, var, "stringParameter") ;separator="\n"%>
<%vars.stringAliasVars |> var => SwitchAliasVarsSet(simCode, var, "String", "") ;separator="\n"%>
default:
return fmiError;
}
return fmiOK;
}
>>
end setStringFunction;
template setExternalFunction(ModelInfo modelInfo)
"Generates setExternal function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__)) then
let externalFuncs = setExternalFunctionsSwitch(functions)
<<
fmiStatus setExternalFunction(ModelInstance* c, const fmiValueReference vr, const void* value){
switch (vr) {
<%externalFuncs%>
default:
return fmiError;
}
return fmiOK;
}
>>
end setExternalFunction;
template eventUpdateFunction2(SimCode simCode)
"Generates event update function for c file."
::=
match simCode
case SIMCODE(__) then
<<
// Used to set the next time event, if any.
void eventUpdate(ModelInstance* comp, fmi2EventInfo* eventInfo) {
}
>>
end eventUpdateFunction2;
template getRealFunction2(SimCode simCode, ModelInfo modelInfo)
"Generates getReal function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__),varInfo=VARINFO(numAlgAliasVars=numAlgAliasVars, numParams=numParams, numStateVars=numStateVars, numAlgVars= numAlgVars, numDiscreteReal=numDiscreteReal)) then
let ixFirstParam = intAdd(intMul(2,numStateVars),intAdd(numAlgVars,numDiscreteReal))
let ixFirstAlias = intAdd(numParams, intAdd(intMul(2,numStateVars),intAdd(numAlgVars,numDiscreteReal)))
let ixEnd = intAdd(numAlgAliasVars,intAdd(numParams, intAdd(intMul(2,numStateVars),intAdd(numAlgVars,numDiscreteReal))))
<<
<%if numAlgAliasVars then
<<
static const int realAliasIndexes[<%numAlgAliasVars%>] = {
<%vars.aliasVars |> v as SIMVAR(__) => aliasSetVR(simCode, aliasvar) ; separator=", "; align=20; alignSeparator=",\n" %>
};
>>
%>
fmi2Real getReal(ModelInstance* comp, const fmi2ValueReference vr) {
if (vr < <%ixFirstParam%>) {
return comp->fmuData->localData[0]->realVars[vr];
}
if (vr < <%ixFirstAlias%>) {
return comp->fmuData->simulationInfo->realParameter[vr-<%ixFirstParam%>];
}
<%if numAlgAliasVars then
<<
if (vr < <%ixEnd%>) {
int ix = realAliasIndexes[vr-<%ixFirstAlias%>];
return ix>=0 ? getReal(comp, ix) : -getReal(comp, -(ix+1));
}
>>
%>
return NAN;
}
>>
end getRealFunction2;
template setRealFunction2(SimCode simCode, ModelInfo modelInfo)
"Generates setReal function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__),varInfo=VARINFO(numAlgAliasVars=numAlgAliasVars, numParams=numParams, numStateVars=numStateVars, numAlgVars= numAlgVars, numDiscreteReal=numDiscreteReal)) then
let ixFirstParam = intAdd(intMul(2,numStateVars),intAdd(numAlgVars,numDiscreteReal))
let ixFirstAlias = intAdd(numParams, intAdd(intMul(2,numStateVars),intAdd(numAlgVars,numDiscreteReal)))
let ixEnd = intAdd(numAlgAliasVars,intAdd(numParams, intAdd(intMul(2,numStateVars),intAdd(numAlgVars,numDiscreteReal))))
<<
fmi2Status setReal(ModelInstance* comp, const fmi2ValueReference vr, const fmi2Real value) {
if (vr < <%ixFirstParam%>) {
comp->fmuData->localData[0]->realVars[vr] = value;
return fmi2OK;
}
if (vr < <%ixFirstAlias%>) {
comp->fmuData->simulationInfo->realParameter[vr-<%ixFirstParam%>] = value;
return fmi2OK;
}
<%if numAlgAliasVars then
<<
if (vr < <%ixEnd%>) {
int ix = realAliasIndexes[vr-<%ixFirstAlias%>];
return ix >= 0 ? setReal(comp, ix, value) : setReal(comp, -(ix+1), -value);
}
>>
%>
return fmi2Error;
}
>>
end setRealFunction2;
template aliasSetVR(SimCode simCode, AliasVariable v)
::=
match v
case NOALIAS(__) then error(sourceInfo(), "aliasSetVR expected an alias")
case ALIAS(__) then lookupVR(varName,simCode)
case NEGATEDALIAS(__) then intSub(-1, lookupVR(varName,simCode)) /* Subtracting 1 is necessary to make vr=0 possible to have a negative alias */
end aliasSetVR;
template getIntegerFunction2(SimCode simCode, ModelInfo modelInfo)
"Generates setInteger function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__),varInfo=VARINFO(numIntAliasVars=numAliasVars, numIntParams=numParams, numIntAlgVars=numAlgVars)) then
let ixFirstParam = numAlgVars
let ixFirstAlias = intAdd(numParams, numAlgVars)
let ixEnd = intAdd(numAliasVars,intAdd(numParams, numAlgVars))
<<
<% if numAliasVars then
<<
static const int intAliasIndexes[<%numAliasVars%>] = {
<%vars.intAliasVars |> v as SIMVAR(__) => aliasSetVR(simCode, aliasvar) ; separator=", "; align=20; alignSeparator=",\n" %>
};
>>
%>
fmi2Integer getInteger(ModelInstance* comp, const fmi2ValueReference vr) {
if (vr < <%ixFirstParam%>) {
return comp->fmuData->localData[0]->integerVars[vr];
}
if (vr < <%ixFirstAlias%>) {
return comp->fmuData->simulationInfo->integerParameter[vr-<%ixFirstParam%>];
}
<% if numAliasVars then
<<
if (vr < <%ixEnd%>) {
int ix = intAliasIndexes[vr-<%ixFirstAlias%>];
return ix>=0 ? getInteger(comp, ix) : -getInteger(comp, -(ix+1));
}
>>
%>
return 0;
}
>>
end getIntegerFunction2;
template setIntegerFunction2(SimCode simCode, ModelInfo modelInfo)
"Generates getInteger function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__),varInfo=VARINFO(numIntAliasVars=numAliasVars, numIntParams=numParams, numIntAlgVars=numAlgVars)) then
let ixFirstParam = numAlgVars
let ixFirstAlias = intAdd(numParams, numAlgVars)
let ixEnd = intAdd(numAliasVars,intAdd(numParams, numAlgVars))
<<
fmi2Status setInteger(ModelInstance* comp, const fmi2ValueReference vr, const fmi2Integer value) {
if (vr < <%ixFirstParam%>) {
comp->fmuData->localData[0]->integerVars[vr] = value;
return fmi2OK;
}
if (vr < <%ixFirstAlias%>) {
comp->fmuData->simulationInfo->integerParameter[vr-<%ixFirstParam%>] = value;
return fmi2OK;
}
<% if numAliasVars then
<<
if (vr < <%ixEnd%>) {
int ix = intAliasIndexes[vr-<%ixFirstAlias%>];
return ix >= 0 ? setInteger(comp, ix, value) : setInteger(comp, -(ix+1), -value);
}
>>
%>
return fmi2Error;
}
>>
end setIntegerFunction2;
template getBooleanFunction2(SimCode simCode, ModelInfo modelInfo)
"Generates setBoolean function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__)) then
<<
fmi2Boolean getBoolean(ModelInstance* comp, const fmi2ValueReference vr) {
switch (vr) {
<%vars.boolAlgVars |> var => SwitchVars(simCode, var, "booleanVars") ;separator="\n"%>
<%vars.boolParamVars |> var => SwitchParameters(simCode, var, "booleanParameter") ;separator="\n"%>
<%vars.boolAliasVars |> var => SwitchAliasVars(simCode, var, "Boolean", "!") ;separator="\n"%>
default:
return fmi2False;
}
}
>>
end getBooleanFunction2;
template setBooleanFunction2(SimCode simCode, ModelInfo modelInfo)
"Generates getBoolean function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__)) then
<<
fmi2Status setBoolean(ModelInstance* comp, const fmi2ValueReference vr, const fmi2Boolean value) {
switch (vr) {
<%vars.boolAlgVars |> var => SwitchVarsSet(simCode, var, "booleanVars") ;separator="\n"%>
<%vars.boolParamVars |> var => SwitchParametersSet(simCode, var, "booleanParameter") ;separator="\n"%>
<%vars.boolAliasVars |> var => SwitchAliasVarsSet(simCode, var, "Boolean", "!") ;separator="\n"%>
default:
return fmi2Error;
}
return fmi2OK;
}
>>
end setBooleanFunction2;
template getStringFunction2(SimCode simCode, ModelInfo modelInfo)
"Generates getString function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__)) then
<<
fmi2String getString(ModelInstance* comp, const fmi2ValueReference vr) {
switch (vr) {
<%vars.stringAlgVars |> var => SwitchVars(simCode, var, "stringVars") ;separator="\n"%>
<%vars.stringParamVars |> var => SwitchParameters(simCode, var, "stringParameter") ;separator="\n"%>
<%vars.stringAliasVars |> var => SwitchAliasVars(simCode, var, "String", "") ;separator="\n"%>
default:
return "";
}
}
>>
end getStringFunction2;
template setStringFunction2(SimCode simCode, ModelInfo modelInfo)
"Generates setString function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__)) then
<<
fmi2Status setString(ModelInstance* comp, const fmi2ValueReference vr, fmi2String value) {
switch (vr) {
<%vars.stringAlgVars |> var => SwitchVarsSet(simCode, var, "stringVars") ;separator="\n"%>
<%vars.stringParamVars |> var => SwitchParametersSet(simCode, var, "stringParameter") ;separator="\n"%>
<%vars.stringAliasVars |> var => SwitchAliasVarsSet(simCode, var, "String", "") ;separator="\n"%>
default:
return fmi2Error;
}
return fmi2OK;
}
>>
end setStringFunction2;
template setExternalFunction2(ModelInfo modelInfo)
"Generates setExternal function for c file."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__)) then
let externalFuncs = setExternalFunctionsSwitch(functions)
<<
fmi2Status setExternalFunction(ModelInstance* c, const fmi2ValueReference vr, const void* value){
switch (vr) {
<%externalFuncs%>
default:
return fmi2Error;
}
return fmi2OK;
}
>>
end setExternalFunction2;
template setExternalFunctionsSwitch(list<Function> functions)
"Generates external function definitions."
::=
(functions |> fn => setExternalFunctionSwitch(fn) ; separator="\n")
end setExternalFunctionsSwitch;
template setExternalFunctionSwitch(Function fn)
"Generates external function definitions."
::=
match fn
case EXTERNAL_FUNCTION(dynamicLoad=true) then
let fname = extFunctionName(extName, language)
<<
case $P<%fname%> : ptr_<%fname%>=(ptrT_<%fname%>)value; break;
>>
end setExternalFunctionSwitch;