-
Notifications
You must be signed in to change notification settings - Fork 299
/
CodegenFMUCppOld.tpl
877 lines (786 loc) · 36.9 KB
/
CodegenFMUCppOld.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
// 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 CodegenFMUCppOld
import interface SimCodeTV;
import interface SimCodeBackendTV;
import CodegenUtil.*;
import CodegenCppOld.*; //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 CodegenCppCommon.*;
import CodegenFMU.*;
import CodegenCppInit;
import CodegenFMUCommon;
import CodegenFMU2;
template translateModel(SimCode simCode, String FMUVersion, String FMUType, list<String> sourceFiles)
"Generates C++ code and Makefile for compiling an FMU of a Modelica model.
Calls CodegenCppOld.translateModel for the actual model code."
::=
match simCode
case SIMCODE(modelInfo=modelInfo as MODELINFO(__)) then
let guid = getUUIDStr()
let target = simulationCodeTarget()
let stateDerVectorName = "__zDot"
let &extraFuncs = buffer "" /*BUFD*/
let &extraFuncsDecl = buffer "" /*BUFD*/
let &complexStartExpressions = buffer ""
let numRealVars = numRealvars(modelInfo)
let numIntVars = numIntvars(modelInfo)
let numBoolVars = numBoolvars(modelInfo)
let numStringVars = numStringvars(modelInfo)
let _ = FlagsUtil.set(Flags.HARDCODED_START_VALUES, true)
let cpp = CodegenCppOld.translateModel(simCode)
let()= textFile(fmuWriteOutputHeaderFile(simCode , &extraFuncs , &extraFuncsDecl, ""),'OMCpp<%fileNamePrefix%>WriteOutput.h')
let()= textFile(fmuModelHeaderFile(simCode, extraFuncs, extraFuncsDecl, "",guid, FMUVersion), 'OMCpp<%fileNamePrefix%>FMU.h')
let()= textFile(fmuModelCppFile(simCode, extraFuncs, extraFuncsDecl, "",guid, FMUVersion), 'OMCpp<%fileNamePrefix%>FMU.cpp')
let()= textFile((if isFMIVersion10(FMUVersion) then CodegenCppInit.modelInitXMLFile(simCode, numRealVars, numIntVars, numBoolVars, numStringVars, FMUVersion, FMUType, guid, true, "cpp-runtime", complexStartExpressions, stateDerVectorName) else
CodegenFMU.fmuModelDescriptionFile(simCode, guid, FMUVersion, FMUType, sourceFiles)), 'modelDescription.xml')
let()= textFile(fmudeffile(simCode, FMUVersion), '<%fileNamePrefix%>.def')
let()= textFile(fmuMakefile(target,simCode, extraFuncs, extraFuncsDecl, "", FMUVersion, "", "", "", ""), '<%fileNamePrefix%>_FMU.makefile')
let()= textFile(fmuCalcHelperMainfile(simCode), 'OMCpp<%fileNamePrefix%>CalcHelperMain.cpp')
let _ = FlagsUtil.set(Flags.HARDCODED_START_VALUES, false)
""
// Return empty result since result written to files directly
end translateModel;
template fmuCalcHelperMainfile(SimCode simCode)
::=
match simCode
case SIMCODE(modelInfo = MODELINFO(__)) then
<<
/*****************************************************************************
*
* Helper file that includes all generated calculation files, except the alg loops.
* This file is generated by the OpenModelica Compiler and produced to speed-up the compile time.
*
*****************************************************************************/
#include <Core/ModelicaDefine.h>
#include <Core/Modelica.h>
#include <Core/System/FactoryExport.h>
#include <Core/DataExchange/SimData.h>
#include <Core/System/SimVars.h>
#include <Core/System/DiscreteEvents.h>
#include <Core/System/EventHandling.h>
#include <Core/Utils/extension/logger.hpp>
#include "OMCpp<%fileNamePrefix%>Types.h"
#include "OMCpp<%fileNamePrefix%>Functions.h"
#include "OMCpp<%fileNamePrefix%>.h"
#include "OMCpp<%fileNamePrefix%>Jacobian.h"
#include "OMCpp<%fileNamePrefix%>Mixed.h"
#include "OMCpp<%fileNamePrefix%>StateSelection.h"
#include "OMCpp<%fileNamePrefix%>WriteOutput.h"
#include "OMCpp<%fileNamePrefix%>Initialize.h"
#include "OMCpp<%fileNamePrefix%>FMU.h"
#include "OMCpp<%fileNamePrefix%>AlgLoopMain.cpp"
#include "OMCpp<%fileNamePrefix%>Mixed.cpp"
#include "OMCpp<%fileNamePrefix%>Functions.cpp"
<%if(boolOr(Flags.isSet(Flags.HARDCODED_START_VALUES), Flags.isSet(Flags.GEN_DEBUG_SYMBOLS))) then
<<
#include "OMCpp<%fileNamePrefix%>InitializeParameter.cpp"
#include "OMCpp<%fileNamePrefix%>InitializeAlgVars.cpp"
>>
%>
#include "OMCpp<%fileNamePrefix%>Initialize.cpp"
#include "OMCpp<%fileNamePrefix%>Jacobian.cpp"
#include "OMCpp<%fileNamePrefix%>StateSelection.cpp"
#include "OMCpp<%fileNamePrefix%>.cpp"
#include "OMCpp<%fileNamePrefix%>FMU.cpp"
>>
end fmuCalcHelperMainfile;
template fmuWriteOutputHeaderFile(SimCode simCode ,Text& extraFuncs,Text& extraFuncsDecl,Text extraFuncsNamespace)
"Overrides code for writing simulation file. FMU does not write an output file"
::=
match simCode
case SIMCODE(modelInfo=MODELINFO(__),simulationSettingsOpt = SOME(settings as SIMULATION_SETTINGS(__))) then
<<
#pragma once
// Dummy code for FMU that writes no output file
class <%lastIdentOfPath(modelInfo.name)%>WriteOutput : public IWriteOutput,public <%lastIdentOfPath(modelInfo.name)%>StateSelection
{
public:
<%lastIdentOfPath(modelInfo.name)%>WriteOutput(IGlobalSettings* globalSettings, shared_ptr<ISimObjects> simObjects): <%lastIdentOfPath(modelInfo.name)%>StateSelection(globalSettings, simObjects) {}
virtual ~<%lastIdentOfPath(modelInfo.name)%>WriteOutput() {}
virtual void writeOutput(const IWriteOutput::OUTPUT command = IWriteOutput::UNDEF_OUTPUT) {}
virtual IHistory* getHistory() {return NULL;}
protected:
void initialize() {}
};
>>
end fmuWriteOutputHeaderFile;
template fmuModelHeaderFile(SimCode simCode,Text& extraFuncs,Text& extraFuncsDecl,Text extraFuncsNamespace, String guid, String FMUVersion)
"Generates declaration for FMU target."
::=
match simCode
case SIMCODE(modelInfo=MODELINFO(__)) then
let modelShortName = lastIdentOfPath(modelInfo.name)
//let modelIdentifier = System.stringReplace(dotPath(modelInfo.name), ".", "_")
<<
// declaration for Cpp FMU target
class <%modelShortName%>FMU: public <%modelShortName%>Initialize {
public:
// constructor
<%modelShortName%>FMU(IGlobalSettings* globalSettings, shared_ptr<ISimObjects> simObjects);
// initialization
virtual void initialize();
// getters for given value references
virtual void getReal(const unsigned int vr[], size_t nvr, double value[]);
virtual void getInteger(const unsigned int vr[], size_t nvr, int value[]);
virtual void getBoolean(const unsigned int vr[], size_t nvr, int value[]);
virtual void getString(const unsigned int vr[], size_t nvr, string value[]);
// setters for given value references
virtual void setReal(const unsigned int vr[], size_t nvr, const double value[]);
virtual void setInteger(const unsigned int vr[], size_t nvr, const int value[]);
virtual void setBoolean(const unsigned int vr[], size_t nvr, const int value[]);
virtual void setString(const unsigned int vr[], size_t nvr, const string value[]);
// Jacobian
void getDirectionalDerivative(const unsigned int vrUnknown[], size_t nUnknown,
const unsigned int vrKnown[], size_t nKnown,
const double dvKnown[], double dvUnknown[]);
protected:
static unsigned int _inputRefs[]; ///< Value references of input variables
static unsigned int _outputRefs[]; ///< Value references of discrete states and outputs
};
/// create instance of <%modelShortName%>FMU
static <%modelShortName%>FMU *createSystemFMU(IGlobalSettings *globalSettings);
>>
end fmuModelHeaderFile;
template fmuModelCppFile(SimCode simCode,Text& extraFuncs,Text& extraFuncsDecl,Text extraFuncsNamespace, String guid, String FMUVersion)
"Generates code for FMU target."
::=
match simCode
case SIMCODE(modelInfo=MODELINFO(vars=SIMVARS(inputVars=inputVars, algVars=algVars)), modelStructure=modelStructure) then
let modelName = dotPath(modelInfo.name)
let modelShortName = lastIdentOfPath(modelInfo.name)
let modelLongName = System.stringReplace(modelName, ".", "_")
let algloopfiles = (listAppend(listAppend(allEquations, initialEquations), getClockedEquations(getSubPartitions(clockedPartitions))) |> eqs => algloopMainfile2(eqs, simCode , &extraFuncs , &extraFuncsDecl, extraFuncsNamespace, modelShortName) ;separator="\n")
let solverFactory = match algloopfiles case "" then '' else
'createStaticAlgLoopSolverFactory(globalSettings, PATH(""), PATH(""))'
<<
// define model identifier and unique id
#define MODEL_IDENTIFIER <%modelLongName%>
#define MODEL_IDENTIFIER_SHORT <%modelShortName%>
#define MODEL_CLASS <%modelShortName%>FMU
#define MODEL_GUID "{<%guid%>}"
<%ModelDefineData(modelInfo)%>
#define NUMBER_OF_EVENT_INDICATORS <%CodegenFMUCommon.getNumberOfEventIndicators(simCode)%>
<%if isFMIVersion10(FMUVersion) then
'#include <FMU/FMUWrapper.h>'
else
'#include "FMU2/FMU2Wrapper.cpp"'%>
<%if isFMIVersion10(FMUVersion) then
'#include <FMU/FMULibInterface.h>'
else
'#include "FMU2/FMU2Interface.cpp"'%>
// SimObjects for <%modelShortName%>FMU
shared_ptr<IAlgLoopSolverFactory> createStaticAlgLoopSolverFactory(IGlobalSettings*, PATH, PATH);
class <%modelShortName%>SimObjects : public ISimObjects {
public:
<%modelShortName%>SimObjects(IGlobalSettings *globalSettings) {
_algLoopSolverFactory = shared_ptr<IAlgLoopSolverFactory>(<%solverFactory%>);
}
<%modelShortName%>SimObjects(<%modelShortName%>SimObjects& instance) {
_algLoopSolverFactory = instance._algLoopSolverFactory;
}
weak_ptr<ISimData> LoadSimData(string modelKey) {
return shared_ptr<ISimData>();
}
weak_ptr<ISimVars> LoadSimVars(string modelKey, size_t dim_real, size_t dim_int, size_t dim_bool, size_t dim_string, size_t dim_pre_vars, size_t dim_z, size_t z_i) {
_simVars = shared_ptr<ISimVars>(new SimVars(dim_real, dim_int, dim_bool, dim_string, dim_pre_vars, dim_z, z_i));
return _simVars;
}
weak_ptr<IHistory> LoadWriter(size_t) {
return shared_ptr<IHistory>();
}
shared_ptr<ISimData> getSimData(string modelKey) {
return shared_ptr<ISimData>();
}
shared_ptr<ISimVars> getSimVars(string modelKey) {
return _simVars;
}
void eraseSimData(string modelKey) {}
void eraseSimVars(string modelKey) {}
shared_ptr<IAlgLoopSolverFactory> getAlgLoopSolverFactory() {
return _algLoopSolverFactory;
}
ISimObjects* clone() {
return new <%modelShortName%>SimObjects(*this);
}
protected:
shared_ptr<ISimVars> _simVars;
shared_ptr<IAlgLoopSolverFactory> _algLoopSolverFactory;
};
// create instance of <%modelShortName%>FMU
<%modelShortName%>FMU *createSystemFMU(IGlobalSettings *globalSettings) {
shared_ptr<ISimObjects> simObjects(new <%modelShortName%>SimObjects(globalSettings));
simObjects->LoadSimVars("<%modelShortName%>", <%numRealvars(modelInfo)%>, <%numIntvars(modelInfo)%>, <%numBoolvars(modelInfo)%>, <%numStringvars(modelInfo)%>, <%getPreVarsCount(modelInfo)%>, <%numStatevars(modelInfo)%>, <%numStateVarIndex(modelInfo)%>);
simObjects->LoadSimData("<%modelShortName%>");
globalSettings->setOutputFormat(EMPTY);
return new <%modelShortName%>FMU(globalSettings, simObjects);
}
// value references of real inputs
unsigned int <%modelShortName%>FMU::_inputRefs[] = {<%inputVars |> var =>
match var case SIMVAR(name=name, type_=T_REAL()) then
intSub(getVariableIndex(cref2simvar(name, simCode)), 1) ;separator=", "%>};
// value references of real discrete states and outputs
unsigned int <%modelShortName%>FMU::_outputRefs[] = {<%algVars |> var =>
match var case SIMVAR(name=name, type_=T_REAL(), varKind=CLOCKED_STATE())
case SIMVAR(name=name, type_=T_REAL(), causality=SOME(OUTPUT())) then
intSub(getVariableIndex(cref2simvar(name, simCode)), 1) ;separator=", "%>};
// constructor
<%modelShortName%>FMU::<%modelShortName%>FMU(IGlobalSettings* globalSettings, shared_ptr<ISimObjects> simObjects)
: <%modelShortName%>Initialize(globalSettings, simObjects) {
}
// initialization
void <%modelShortName%>FMU::initialize() {
<%modelShortName%>WriteOutput::initialize();
<%modelShortName%>Initialize::initializeMemory();
<%modelShortName%>Initialize::initializeFreeVariables();
<%modelShortName%>Jacobian::initialize();
}
// getters
<%accessFunctions(simCode, "get", modelShortName, modelInfo)%>
// setters
<%accessFunctions(simCode, "set", modelShortName, modelInfo)%>
// Jacobian
<%directionalDerivativeFunction(simCode)%>
>>
// TODO:
// <%setDefaultStartValues(modelInfo)%>
// <%setStartValues(modelInfo)%>
// <%setExternalFunction(modelInfo)%>
end fmuModelCppFile;
template ModelDefineData(ModelInfo modelInfo)
"Generates global data in simulation file."
::=
match modelInfo
case MODELINFO(varInfo=VARINFO(__), vars=SIMVARS(stateVars = listStates)) then
<<
/* TODO: implement external functions in FMU wrapper for c++ target
<%System.tmpTickReset(0)%>
<%(functions |> fn => defineExternalFunction(fn) ; separator="\n")%>
*/
>>
end ModelDefineData;
template DefineVariables(SimVar simVar, Boolean useFlatArrayNotation)
"Generates code for defining variables in c file for FMU target. "
::=
match simVar
case SIMVAR(__) then
let description = if comment then '// "<%comment%>"'
if stringEq(crefStr(name),"$dummy") then
<<>>
else if stringEq(crefStr(name),"der($dummy)") then
<<>>
else
<<
#define <%cref(name,useFlatArrayNotation)%>_ <%System.tmpTick()%> <%description%>
>>
end DefineVariables;
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
void setDefaultStartValues(ModelInstance *comp) {
/*
<%vars.stateVars |> var => initValsDefault(var,"realVars",0) ;separator="\n"%>
<%vars.derivativeVars |> var => initValsDefault(var,"realVars",numStateVars) ;separator="\n"%>
<%vars.algVars |> var => initValsDefault(var,"realVars",intMul(2,numStateVars)) ;separator="\n"%>
<%vars.discreteAlgVars |> var => initValsDefault(var, "realVars", intAdd(intMul(2,numStateVars), numAlgVars)) ;separator="\n"%>
<%vars.intAlgVars |> var => initValsDefault(var,"integerVars",0) ;separator="\n"%>
<%vars.boolAlgVars |> var => initValsDefault(var,"booleanVars",0) ;separator="\n"%>
<%vars.stringAlgVars |> var => initValsDefault(var,"stringVars",0) ;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
void setStartValues(ModelInstance *comp) {
/*
<%vars.stateVars |> var => initVals(var,"realVars",0) ;separator="\n"%>
<%vars.derivativeVars |> var => initVals(var,"realVars",numStateVars) ;separator="\n"%>
<%vars.algVars |> var => initVals(var,"realVars",intMul(2,numStateVars)) ;separator="\n"%>
<%vars.discreteAlgVars |> var => initVals(var, "realVars", intAdd(intMul(2,numStateVars), numAlgVars)) ;separator="\n"%>
<%vars.intAlgVars |> var => initVals(var,"integerVars",0) ;separator="\n"%>
<%vars.boolAlgVars |> var => initVals(var,"booleanVars",0) ;separator="\n"%>
<%vars.stringAlgVars |> var => initVals(var,"stringVars",0) ;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 initVals(SimVar var, String arrayName, Integer offset) ::=
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[<%intAdd(index,offset)%>].attribute.start'
<<
<%str%> = comp->fmuData->localData[0]-><%arrayName%>[<%intAdd(index,offset)%>];
>>
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, Integer offset) ::=
match var
case SIMVAR(index=index, type_=type_) then
let str = 'comp->fmuData->modelData.<%arrayName%>Data[<%intAdd(index,offset)%>].attribute.start'
match initialValue
case SOME(v) then
'<%str%> = <%initVal(v)%>;'
case NONE() then
match type_
case T_INTEGER(__)
case T_REAL(__)
case T_ENUMERATION(__)
case T_BOOL(__) then '<%str%> = 0;'
case T_STRING(__) then '<%str%> = "";'
else 'UNKOWN_TYPE'
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) then
'<%str%> = <%initVal(v)%>;'
end initParamsDefault;
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%>/*ENUM:<%dotPath(name)%>*/'
else "*ERROR* initial value of unknown type"
end initVal;
template setExternalFunction(ModelInfo modelInfo)
"Generates setString 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 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;
template accessFunctions(SimCode simCode, String direction, String modelShortName, ModelInfo modelInfo)
"Generates getters or setters for Real, Integer, Boolean, and String."
::=
match modelInfo
case MODELINFO(vars=SIMVARS(__), varInfo=VARINFO(numStateVars=numStateVars, numAlgVars=numAlgVars, numDiscreteReal=numDiscreteReal, numParams=numParams)) then
<<
<%accessVarsFunction(simCode, direction, modelShortName, "Real", "Real", "double", intAdd(intAdd(intAdd(intMul(2, numStateVars), numAlgVars), numDiscreteReal), numParams), vars.aliasVars)%>
<%accessVarsFunction(simCode, direction, modelShortName, "Integer", "Int", "int", intAdd(listLength(vars.intAlgVars), listLength(vars.intParamVars)), vars.intAliasVars)%>
<%accessVarsFunction(simCode, direction, modelShortName, "Boolean", "Bool", "int", intAdd(listLength(vars.boolAlgVars), listLength(vars.boolParamVars)), vars.boolAliasVars)%>
<%accessVarsFunction(simCode, direction, modelShortName, "String", "String", "string", intAdd(listLength(vars.stringAlgVars), listLength(vars.stringParamVars)), vars.stringAliasVars)%>
>>
end accessFunctions;
template accessVarsFunction(SimCode simCode, String direction, String modelShortName, String typeName, String pointerName, String typeImpl, Integer offset, list<SimVar> aliasVars)
"Generates get<%typeName%> or set<%typeName%> function."
::=
let qualifier = if stringEq(direction, "set") then "const"
<<
void <%modelShortName%>FMU::<%direction%><%typeName%>(const unsigned int vr[], size_t nvr, <%qualifier%> <%typeImpl%> value[]) {
for (size_t i = 0; i < nvr; i++, vr++, value++) {
// access variables and aliases in SimVars memory
if (*vr < _dim<%typeName%>)
<%if stringEq(direction, "get") then
<<
*value = _pointerTo<%pointerName%>Vars[*vr];
>>
else
<<
_pointerTo<%pointerName%>Vars[*vr] = *value;
>>%>
// convert negated aliases
else switch (*vr) {
<%aliasVars |> var => match var
case SIMVAR(aliasvar=NEGATEDALIAS()) then
accessVar(simCode, direction, var, offset)
else ''
end match; separator="\n"%>
default:
throw std::invalid_argument("<%direction%><%typeName%> with wrong value reference " + omcpp::to_string(*vr));
}
}
}
>>
end accessVarsFunction;
template accessVar(SimCode simCode, String direction, SimVar simVar, Integer offset)
"Generates a case statement accessing one variable."
::=
match simVar
case SIMVAR(__) then
let descName = System.stringReplace(crefStrNoUnderscore(name), "$", "_D_")
let description = if comment then '/* <%descName%> "<%comment%>" */' else '/* <%descName%> */'
let cppName = getCppName(simCode, simVar)
let cppSign = getCppSign(simCode, simVar)
if stringEq(direction, "get") then
<<
case <%intAdd(offset, index)%>: <%description%>
*value = <%cppSign%><%cppName%>; break;
>>
else
<<
case <%intAdd(offset, index)%>: <%description%>
<%cppName%> = <%cppSign%>*value; break;
>>
end accessVar;
template getCppName(SimCode simCode, SimVar simVar)
"Get name of variable in Cpp runtime, resolving aliases"
::=
match simVar
case SIMVAR(__) then
let actualName = cref1(name, simCode, "", "", "", contextOther, "", "", false)
match aliasvar
case ALIAS(__)
case NEGATEDALIAS(__) then
'<%cref1(varName, simCode, "", "", "", contextOther, "", "", false)%>'
else
'<%actualName%>'
end getCppName;
template getCppSign(SimCode simCode, SimVar simVar)
"Get sign of variable in Cpp runtime, resolving aliases"
::=
match simVar
case SIMVAR(type_=type_) then
match aliasvar
case NEGATEDALIAS(__) then
match type_ case T_BOOL(__) then '!' else '-'
else ''
end getCppSign;
template directionalDerivativeFunction(SimCode simCode)
"Generates getDirectionalDerivative."
::=
match simCode
case SIMCODE(modelInfo=MODELINFO(), modelStructure=fmiModelStructure) then
let modelShortName = lastIdentOfPath(modelInfo.name)
let dimDiscreteStates = match fmiModelStructure
case SOME(modelStructure as FMIMODELSTRUCTURE(__)) then
match modelStructure.fmiDiscreteStates
case FMIDISCRETESTATES(fmiUnknownsList=fmiUnknownsList) then
listLength(fmiUnknownsList)
else "0"
else "0"
<<
void <%modelShortName%>FMU::getDirectionalDerivative(
const unsigned int vrUnknown[], size_t nUnknown,
const unsigned int vrKnown[], size_t nKnown,
const double dvKnown[], double dvUnknown[])
{
<% if providesDirectionalDerivative(simCode) then
<<
unsigned int idx, *ref_p, ref_1;
int dimStates = _dimContinuousStates + <%dimDiscreteStates%>;
_FMIDERjac_x.clear();
ref_p = NULL;
for (size_t j = 0; j < nKnown; j++) {
idx = vrKnown[j];
if (idx >= dimStates) {
// find input reference
if (ref_p == NULL || idx < ref_1)
ref_p = _inputRefs; // reset ref_p if vrKnown decreases
ref_p = std::find(ref_p, _inputRefs + sizeof(_inputRefs)/sizeof(unsigned int), vrKnown[j]);
ref_1 = idx;
idx = dimStates + (ref_p - _inputRefs);
}
if (idx >= _FMIDERjac_x.size())
throw std::invalid_argument("getDirectionalDerivative with wrong value reference of known " + omcpp::to_string(vrKnown[j]));
_FMIDERjac_x(idx) = dvKnown[j];
}
calcFMIDERJacobianColumn();
ref_p = NULL;
for (size_t i = 0; i < nUnknown; i++) {
idx = vrUnknown[i] - _dimContinuousStates; // derivatives behind states
if (idx >= _dimContinuousStates) {
// find output reference
if (ref_p == NULL || idx < ref_1)
ref_p = _outputRefs; // reset ref_p if vrUnknown decreases
ref_p = std::find(ref_p, _outputRefs + sizeof(_outputRefs)/sizeof(unsigned int), vrUnknown[i]);
ref_1 = idx;
idx = _dimContinuousStates + (ref_p - _outputRefs);
}
if (idx >= _FMIDERjac_y.size())
throw std::invalid_argument("getDirectionalDerivative with wrong value reference of unknown " + omcpp::to_string(vrUnknown[i]));
dvUnknown[i] = _FMIDERjac_y(idx);
}
>>
else
<<
throw ModelicaSimulationError(MATH_FUNCTION, "No derivative code, see flag disableDirectionalDerivatives");
>>
%>
}
>>
end directionalDerivativeFunction;
template fmuMakefile(String target, SimCode simCode, Text& extraFuncs, Text& extraFuncsDecl, Text extraFuncsNamespace, String FMUVersion, String additionalLinkerFlags_GCC,
String additionalLinkerFlags_MSVC, String additionalCFlags_GCC, String additionalCFlags_MSVC)
"Generates the contents of the makefile for the simulation case. Copy libexpat & correct linux fmu"
::=
match getGeneralTarget(target)
case "msvc" then
match simCode
case SIMCODE(modelInfo=MODELINFO(__), makefileParams=MAKEFILE_PARAMS(__), simulationSettingsOpt = sopt) then
let dirExtra = if modelInfo.directory then '-L"<%modelInfo.directory%>"' //else ""
let libsExtra = (makefileParams.libs |> lib => lib ;separator=" ")
let ParModelicaLibs = if acceptParModelicaGrammar() then '-lOMOCLRuntime -lOpenCL' // else ""
let extraCflags = match sopt case SOME(s as SIMULATION_SETTINGS(__)) then
match s.method case "dassljac" then "-D_OMC_JACOBIAN "
<<
# Makefile generated by OpenModelica
# run with nmake from Visual Studio Command Prompt
# FMU packaging requires PATH to <%makefileParams.omhome%>/mingw/bin
OMHOME=<%if boolOr(stringEq(makefileParams.platform, "win32"),stringEq(makefileParams.platform, "win64")) then '$(OPENMODELICAHOME)' else makefileParams.omhome%>
<% /* Don't use $(OMHOME) with include. NMAKE fails to evaluate it. */ %>
include <%makefileParams.omhome%>/include/omc/cpp/ModelicaConfig_msvc.inc
include <%makefileParams.omhome%>/include/omc/cpp/ModelicaLibraryConfig_msvc.inc
# Simulations use /Od by default
SIM_OR_DYNLOAD_OPT_LEVEL=
MODELICAUSERCFLAGS=
CXX=cl
EXEEXT=.exe
DLLEXT=.dll
# /Od - Optimization disabled
# /EHa enable C++ EH (w/ SEH exceptions)
# /fp:except - consider floating-point exceptions when generating code
# /arch:SSE2 - enable use of instructions available with SSE2 enabled CPUs
# /I - Include Directories
# /DNOMINMAX - Define NOMINMAX (does what it says)
# /TP - Use C++ Compiler
CFLAGS=$(SYSTEM_CFLAGS) /w /I"<%makefileParams.omhome%>/include/omc/cpp/" /I"$(BOOST_INCLUDE)" /I"$(SUITESPARSE_INCLUDE)" /I. /TP /DNOMINMAX /DNO_INTERACTIVE_DEPENDENCY /DFMU_BUILD /DRUNTIME_STATIC_LINKING
# /MD - link with MSVCRT.LIB
# /link - [linker options and libraries]
# /LIBPATH: - Directories where libs can be found
OMCPP_SOLVER_LIBS=OMCppNewton_static.lib OMCppDgesv_static.lib OMCppDgesvSolver_static.lib -lOMCppSolver_static
MODELICA_UTILITIES_LIB=OMCppModelicaUtilities_static.lib
EXTRA_LIBS=<%dirExtra%> <%libsExtra%>
LDFLAGS=/link /DLL /NOENTRY /LIBPATH:"<%makefileParams.omhome%>/lib/omc/cpp/msvc" /LIBPATH:"<%makefileParams.omhome%>/bin" OMCppSystem_static.lib OMCppMath_static.lib OMCppExtensionUtilities_static.lib OMCppFMU_static.lib $(OMCPP_SOLVER_LIBS) $(EXTRA_LIBS) $(MODELICA_UTILITIES_LIB)
PLATFORM="<%makefileParams.platform%>"
MODELICA_SYSTEM_LIB=<%fileNamePrefix%>
CALCHELPERMAINFILE=OMCpp$(MODELICA_SYSTEM_LIB)CalcHelperMain.cpp
<%fmuTargetName%>.fmu: $(MODELICA_SYSTEM_LIB)$(DLLEXT)
<%\t%>rm -rf binaries
<%\t%>mkdir -p "binaries/$(PLATFORM)"
<%\t%>mv $(MODELICA_SYSTEM_LIB)$(DLLEXT) "binaries/$(PLATFORM)/"
<%\t%>rm -f $(MODELICA_SYSTEM_LIB).fmu
<%\t%>zip -r "<%fmuTargetName%>.fmu" modelDescription.xml binaries
<%\t%>rm -rf binaries
$(MODELICA_SYSTEM_LIB)$(DLLEXT):
<%\t%>$(CXX) /Fe$(MODELICA_SYSTEM_LIB)$(DLLEXT) $(CALCHELPERMAINFILE) $(CFLAGS) $(LDFLAGS)
>>
end match
case "gcc" then
match simCode
case SIMCODE(modelInfo=MODELINFO(__), makefileParams=MAKEFILE_PARAMS(__), simulationSettingsOpt = sopt) then
let dirExtra = if modelInfo.directory then '-L"<%modelInfo.directory%>"' //else ""
let libsExtra = (makefileParams.libs |> lib => lib ;separator=" ")
let extraCflags = match sopt case SOME(s as SIMULATION_SETTINGS(__)) then ""
// Note: FMI 1.0 did not distinguish modelIdentifier from fileNamePrefix
let platformstr = match makefileParams.platform case "i386-pc-linux" then 'linux32' case "x86_64-linux" then 'linux64' else '<%makefileParams.platform%>'
let omhome = makefileParams.omhome
let platformbins = match platformstr case "win32" case "win64" then '"<%omhome%>/bin/libgcc_s_*.dll" "<%omhome%>/bin/libstdc++-6.dll" "<%omhome%>/bin/libwinpthread-1.dll"' else ''
let lapackbins = match platformstr case "win32" case "win64" then '"<%omhome%>/bin/libopenblas.dll"' else ''
let mkdir = match makefileParams.platform case "win32" case "win64" then '"mkdir.exe"' else 'mkdir'
<<
# Makefile generated by OpenModelica for native and cross compilation
# How to cross compile:
# - build OpenModelica (omc) from source code (see github.com/OpenModelica)
# - install a cross compiler, e.g. apt-get install g++-mingw-w64-i686
# - fix or work around capitalization of windows.h in MSL, see
# https://trac.modelica.org/Modelica/ticket/1962
# - add the target triplet, e.g. i686-w64-mingw32, to
# OMCompiler/SimulationRuntime/cpp/Makefile
# - rebuild omc to add the new platform
# - invoke the omc commands
# setCommandLineOptions("--simCodeTarget=Cpp");
# buildModelFMU(MyModel, platforms={"i686-w64-mingw32"});
# - alternatively call this Makefile with
# make TARGET_TRIPLET=i686-w64-mingw32 -f <%fileNamePrefix%>_FMU.makefile
#TARGET_TRIPLET=
OMHOME=<%if boolOr(stringEq(makefileParams.platform, "win32"),stringEq(makefileParams.platform, "win64")) then '$(OPENMODELICAHOME)' else makefileParams.omhome%>
include $(OMHOME)/include/omc/cpp/ModelicaConfig_gcc.inc
include $(OMHOME)/include/omc/cpp/ModelicaLibraryConfig_gcc.inc
# simulations use -O0 by default; can be changed to e.g. -O2 or -Ofast
SIM_OPT_LEVEL=-O0
# native build or cross compilation
ifeq ($(TARGET_TRIPLET),)
TRIPLET=<%Autoconf.triple%>
CC=<%makefileParams.ccompiler%>
CXX=<%makefileParams.cxxcompiler%>
ABI_CFLAG=
DLLEXT=<%makefileParams.dllext%>
PLATFORM=<%platformstr%>
else
TRIPLET=$(TARGET_TRIPLET)
CC=$(TRIPLET)-gcc
CXX=$(TRIPLET)-g++
ABI_CFLAG=-D_GLIBCXX_USE_CXX11_ABI=0
DLLEXT=$(if $(findstring mingw,$(TRIPLET)),.dll,.so)
WORDSIZE=$(if $(findstring x86_64,$(TRIPLET)),64,32)
PLATFORM=$(if $(findstring darwin,$(TRIPLET)),darwin,$(if $(findstring mingw,$(TRIPLET)),win,linux))$(WORDSIZE)
endif
CFLAGS_BASED_ON_INIT_FILE=<%extraCflags%>
FMU_CFLAGS=$(subst -DUSE_THREAD,,$(subst -O0,$(SIM_OPT_LEVEL),$(SYSTEM_CFLAGS))) $(ABI_CFLAG)
CFLAGS=$(CFLAGS_BASED_ON_INIT_FILE) -Winvalid-pch $(FMU_CFLAGS) -DFMU_BUILD -DRUNTIME_STATIC_LINKING -I"$(OMHOME)/include/omc/cpp" -I"$(UMFPACK_INCLUDE)" -I"$(SUNDIALS_INCLUDE)" -I"$(BOOST_INCLUDE)" <%makefileParams.includes ; separator=" "%> <%additionalCFlags_GCC%>
ifeq ($(USE_LOGGER),ON)
$(eval CFLAGS=$(CFLAGS) -DUSE_LOGGER)
endif
LDFLAGS=-L"$(OMHOME)/lib/$(TRIPLET)/omc/cpp" <%additionalLinkerFlags_GCC%> -Wl,--no-undefined
CALCHELPERMAINFILE=OMCpp<%fileNamePrefix%>CalcHelperMain.cpp
# CVode can be used for Co-Simulation FMUs, Kinsol is available to handle non linear equation systems
OMCPP_SOLVER_LIBS=-lOMCppNewton_static -lOMCppDgesvSolver_static -lOMCppSolver_static
ifeq ($(USE_FMU_SUNDIALS),ON)
$(eval OMCPP_SOLVER_LIBS=$(OMCPP_SOLVER_LIBS) -lOMCppKinsol_static $(SUNDIALS_LIBRARIES))
$(eval CFLAGS=-DENABLE_SUNDIALS_STATIC $(CFLAGS))
endif
CPPFLAGS=$(CFLAGS)
BINARIES=<%fileNamePrefix%>$(DLLEXT)
OMCPP_LIBS=-lOMCppSystem_static -lOMCppMath_static -lOMCppFMU_static $(OMCPP_SOLVER_LIBS) -lOMCppExtensionUtilities_static
MODELICA_UTILITIES_LIB=-lOMCppModelicaUtilities_static
EXTRA_LIBS=<%dirExtra%> <%libsExtra%>
LIBS=$(EXTRA_LIBS) $(OMCPP_LIBS) $(MODELICA_UTILITIES_LIB) $(BASE_LIB)
# link with simple dgesv or full lapack
ifeq ($(USE_DGESV),ON)
$(eval LIBS=$(LIBS) -lOMCppDgesv_static)
else
$(eval LIBS=$(LIBS) -L$(LAPACK_LIBS) $(LAPACK_LIBRARIES))
$(eval BINARIES=$(BINARIES) <%lapackbins%>)
endif
# need boost system lib prior to C++11, forcing also dynamic libs
ifeq ($(findstring USE_CPP_03,$(CFLAGS)),USE_CPP_03)
$(eval LIBS=$(LIBS) -L"$(BOOST_LIBS)" -l$(BOOST_SYSTEM_LIB))
$(eval BINARIES=$(BINARIES) $(BOOST_LIBS)/lib$(BOOST_SYSTEM_LIB)$(DLLEXT) <%platformbins%>)
# link static libs to avoid dependencies; can't link all static under Linux
else ifeq ($(findstring gcc,$(CC)),gcc)
$(eval LIBS=$(LIBS) $(if $(findstring linux,$(PLATFORM)),-static-libstdc++ -static-libgcc,-static))
else ifeq ($(findstring clang,$(CC)),clang)
$(eval LIBS=$(LIBS) $(if $(findstring linux,$(PLATFORM)),-static-libstdc++ -static-libgcc,-static))
endif
CPPFILES=$(CALCHELPERMAINFILE)
OFILES=$(CPPFILES:.cpp=.o)
.PHONY: <%fmuTargetName%>.fmu $(CPPFILES) clean
<%fmuTargetName%>.fmu: $(OFILES)
<%\t%>$(CXX) -shared -o <%fileNamePrefix%>$(DLLEXT) $(OFILES) $(LDFLAGS) $(LIBS)
<%\t%><%mkdir%> -p "binaries/$(PLATFORM)"
<%\t%>mv $(BINARIES) "binaries/$(PLATFORM)/"
<%\t%>rm -rf sources
<%\t%><%mkdir%> -p sources
<%\t%>install -p OMCpp<%fileNamePrefix%>*.h OMCpp<%fileNamePrefix%>*.cpp <%fileNamePrefix%>_init.xml <%fileNamePrefix%>_FMU.makefile sources/
ifeq ($(USE_FMU_SUNDIALS),ON)
<%\t%>rm -rf documentation
<%\t%><%mkdir%> -p "documentation"
<%\t%>cp $(SUNDIALS_LIBRARIES_KINSOL) "binaries/$(PLATFORM)/"
<%\t%>cp "$(OMHOME)/share/omc/runtime/cpp/licenses/sundials.license" "documentation/"
endif
<%\t%>rm -f <%fmuTargetName%>.fmu
ifeq ($(USE_FMU_SUNDIALS),ON)
<%\t%>zip -r "<%fmuTargetName%>.fmu" modelDescription.xml binaries sources documentation
<%\t%>rm -rf documentation
else
<%\t%>zip -r "<%fmuTargetName%>.fmu" modelDescription.xml binaries sources
endif
clean:
<%\t%>rm -f OMCpp<%fileNamePrefix%>* <%fileNamePrefix%>_FMU.* <%fileNamePrefix%>.def <%fileNamePrefix%>.sh <%fileNamePrefix%>.bat <%fileNamePrefix%>.makefile <%fileNamePrefix%>_init.xml
<%\t%>rm -rf modelDescription.xml binaries sources documentation
>>
end fmuMakefile;
annotation(__OpenModelica_Interface="backend");
end CodegenFMUCppOld;
// vim: filetype=susan sw=2 sts=2