/
SimCodegen.rml
2833 lines (2337 loc) · 96 KB
/
SimCodegen.rml
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
(*
Copyright (c) PELAB, Dept. Computer and Information Science, Linkoping University,
Sweden, in the following denoted PELAB/LIU.
This file is part of OpenModelica, in the following denoted OSM.
The OSM License, Version 1.1, March 4, 2005.
1 Preface
The aim of this license is to lay down the conditions enabling you to use,
modify and circulate OSM. However, PELAB/LIU remain the authors of
OSM and so retain property rights and the use of all ancillary rights.
2 Definitions
OSM is defined as all successive versions of the OSM software and their
documentation that have been developed by PELAB/LIU and including
accepted contributions from other contributors according to this license.
OSM DERIVED SOFTWARE is defined as all or part of OSM that you have
modified and/or translated and/or adapted.
3 Dual License
OSM is made available under the OSM licensing scheme, which is a dual
licensing scheme with two options, a) and b):
a) OSM OPEN SOURCE LICENSE:
If you wish to write Open Source software you can use the Open Source version
of OSM, released under the OSM license which include GPL as its open source
licensing option. If you use the OSM Open Source version you must release your
Application using OSM including this Application's source code under the GPL as well.
This OSM license text, and Copyright (c) PELAB/Linkoping University, must
be present in your copy of OSM and in OSM DERIVED SOFTWARE.
You should have received a copy of the GPL - GNU General Public License
along with OpenModelica; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
b) OSM COMMERCIAL LICENSE
If you are using OSM commercially - that is, for commercial usage or
for creating proprietary software for sale or use in a commercial setting
- you must purchase a commercial license of OSM from PELAB/LIU, which allows
you to use OSM without releasing your Application under the GPL.
Comment: Payments for OSM are intended for OSM development and
integration of accepted contributions into OSM.
4 Priority
If there is any conflict between this OSM License text and the GNU GPL
license, this text has priority.
5 Contributions
PELAB/LIU reserves the right to accept or turn down source code contributions
to OSM.
6 Limitation of the warranty
Except when mentioned otherwise in writing, OSM is supplied as is, with
no explicit or implicit warranty, including warranties of commercialization or
adaptation. You assume all risks concerning the quality or the effects of
OSM and its use. If OSM is defective, you will bear the costs of
all required services, corrections or repairs.
7 Consent
When you access and use OSM, you are presumed to be aware of and to
have accepted all the rights and obligations of the present OSM license.
This includes accepting that your open source code contributions to OSM,
if accepted into OSM by PELAB/IDA, follow the OSM licensing rules including
copyright and ownership by PELAB/IDA.
8 Binding effect
This license has the binding value of a contract.
You are not responsible for respect of the license by a third party.
9 Applicable law
The present license and its effects are subject to Swedish law and
Swedish courts.
10 Contact information
See http://www.ida.liu.se/~pelab/modelica/OpenModelica.html
*)
(**
** file: SimCodegen.rml
** module: SimCodegen
** description: Generate Simulation code for connecting to solver.
** This can be done in two different ways.
** 1. Generation of simulation code on residual form. This will generate
** code on the form g(\dot{x},x,y,t)=0.
** 2. Generation of simulation code on solved form. This will generate
** code on ode form. \dot{x} = f(x,y,t). This means that "function" f will
** contain code for solving states from equations, some of them might be
** system of equations, linear or non-linear.
**
** Outputs: the simulation code in C/C++ to a given filename.
** Input: DAELow
** Uses: DAELow, Absyn, Exp
**
**
** RCS: $Id$
**
**)
module SimCodegen:
with "DAE.rml"
with "DAELow.rml"
with "Absyn.rml"
with "Exp.rml"
with "SCode.rml"
relation generate_simulation_code: (DAE.DAElist,
DAELow.DAELow,
int vector, (* ass1 *)
int vector, (* ass2 *)
DAELow.IncidenceMatrix,
DAELow.IncidenceMatrixT,
int list list, (* blocks*)
Absyn.Path, (* classname *)
string) => ()
relation generate_init_data: (DAELow.DAELow, Absyn.Path(* classname *),
string,real,real,real) => ()
relation generate_makefile: (string (*filename*),
Absyn.Path (* classname *)
) => ()
relation print_exp_cpp_str : Exp.Exp => string
relation cref_modelica_str : Exp.ComponentRef => string
relation generate_functions: (SCode.Program,DAE.DAElist, DAELow.DAELow, Absyn.Path, string) => ()
relation get_called_functions_in_functions : (Absyn.Path list, DAE.DAElist) => Absyn.Path list
relation get_called_functions_in_function : (Absyn.Path, DAE.DAElist) => Absyn.Path list
relation print_exp_opt_str_if_const:(Exp.Exp option) => string
end
val TAB = " " (* TAB is four whitespaces *)
with "Util.rml"
with "RTOpts.rml"
with "Debug.rml"
with "System.rml"
with "Values.rml"
with "Codegen.rml"
with "Print.rml"
with "ModUtil.rml"
with "VarTransform.rml"
with "Dump.rml"
with "Inst.rml"
(** relation: generate_makefile
**
** This relation generates a makefile for the simulation code.
** It uses OPENMODELICAHOME as a reference to find c_runtime with libraries.
**)
relation generate_makefile: (string, Absyn.Path) => () =
rule Absyn.path_string(class) => cname &
Util.string_append_list([cname,".cpp"]) => cpp_file &
Util.string_append_list(["#Makefile generated by OpenModelica\n\n",
"CXX=g++\n",
cname,": ",cpp_file, "\n",
"\t $(CXX) -o ",cname," ",cpp_file,
" -L$(OPENMODELICAHOME)/c_runtime/",
" -I$(OPENMODELICAHOME)/c_runtime/ ",
" -lsim -lg2c -lc_runtime\n"
]) => str &
System.write_file(filename,str)
-------------------------
generate_makefile(filename,class)
end
(** relation: generate_simulation_code
**
** Outputs simulation code from a DAELow suitable for connection to DASSL.
** The state calculations are generated on residual form, i.e.
** g(\dot{x},x,y,t) = 0.
** and on explicit ode form, \dot{x}=f(x,y,t)
**)
relation generate_simulation_code: (DAE.DAElist,
DAELow.DAELow,
int vector, (* ass1 *)
int vector, (* ass2 *)
DAELow.IncidenceMatrix,
DAELow.IncidenceMatrixT,
int list list, (* blocks*)
Absyn.Path, (* classname *)
string) => () =
rule Absyn.path_string(class) => cname &
DAELow.generate_state_partition(comps,dlow,ass1,ass2,m,mt)
=> (blt_states,blt_no_states) &
generate_output_function_code(dlow) => (out_str,n_o) &
generate_input_function_code(dlow) => (in_str,n_i) &
generate_global_data(class,dlow,n_o,n_i) => cglobal &
generate_compute_output(cname,dae,dlow,ass1,ass2,blt_no_states)
=> coutput &
generate_compute_residual_state(cname,dae,dlow,ass1,ass2,blt_states)
=> cstate &
generate_ode_code(dlow,blt_states,ass1,ass2,m,mt,class) => c_ode &
generate_initial_value_code(dlow) => s_code &
generate_when_clauses(cname,dae,dlow,ass1,ass2,comps) => cwhen &
string_append(cname,"_functions.cpp") => funcfilename &
Util.string_append_list(["//Simulation code for ",cname,
"\n//Generated by OpenModelica.\n",
"\n#include \"modelica.h\"\n",
"\n#include \"",funcfilename,"\"\n",
cglobal,coutput,in_str,out_str,cstate,cwhen,c_ode, s_code]) => res &
System.write_file(filename,res)
---------------------------------------------------------------------
generate_simulation_code(dae,dlow,ass1,ass2,m,mt,comps,class,filename) => ()
rule print "-generate_simulation_code failed\n"
-----------------------
generate_simulation_code(_,_,_,_,_,_,_,_,_) => fail
end
(** relation: generate_global_data
**
** This relation generates the C-code for the global data: arrays for states,
** derivatives and algebraic variables, etc.
** arg1
** arg2
** arg3 an int which shows the number of output variables on top level
** arg4 an int which shows the number of input variables on top level
**)
relation generate_global_data:(Absyn.Path,DAELow.DAELow,int,int) => string =
rule DAELow.calculate_sizes(dlow) => (nx,ny,np) &
Absyn.path_string(class) => class_str &
int_string(nx) => nx_str &
int_string(ny) => ny_str &
int_string(np) => np_str &
int_string(no) => no_str &
int_string(ni) => ni_str &
generate_var_names_and_comments(dlow,nx,ny) => (varnames,comments) &
generate_parameter_names(dlow,np) => paramnames &
Util.string_append_list(["\n",
"#define NX ",nx_str,"\n",
"#define NY ",ny_str,"\n",
"#define NP ",np_str,"\n",
"#define NO ",no_str," // number of outputvar on topmodel\n",
"#define NI ",ni_str," // number of inputvar on topmodel\n",
"#define MAXORD 5\n",
"#define time (*t)\n",
"\n",
"#if NX > 0 /* some c-compilers does not like a static array of |a|==0 */\n",
"double x[NX];\n",
"#else\n",
"double *x;\n",
"#endif\n",
"#if NX > 0\n",
"double xd[NX];\n",
"#else\n",
"double *xd;\n",
"#endif\n",
"#if NX > 0\n",
"double dummy_delta[NX];\n",
"#else\n",
"double *dummy_delta;\n",
"#endif\n",
"#if NY > 0\n",
"double y[NY];\n",
"#else\n",
"double *y;\n",
"#endif\n",
"#if NP > 0\n",
"double p[NP];\n",
"#else\n",
"double *p;\n",
"#endif\n",
"#if NO > 0\n",
"double out_y[NO];\n",
"#else\n",
"double *out_y;\n",
"#endif\n",
"#if NI > 0\n",
"double in_y[NI];\n",
"#else\n",
"double *in_y;\n",
"#endif\n",
"double rwork[50+(MAXORD+4)*NX+NX*NX];\n",
"long iwork[20+NX];\n",
"long liw = 20+NX;\n",
"long lrw = 50+(MAXORD+4)*NX+NX*NX;\n",
"long nx = NX;\n",
"long ny = NY;\n",
"long np = NP;\n",
"long no = NO;\n",
"long ni = NI;\n",
"char *model_name=\"",class_str,
"\";\n",
varnames,"\n",
comments,"\n",
paramnames,"\n"]
) => str
---------------------------
generate_global_data(class, dlow,no,ni) => str
end
(** relation: generate_var_names_and_comments
**
** Generates an array of the original variable names.
**)
relation generate_var_names_and_comments:(DAELow.DAELow,int, int) => (string,string) =
rule DAELow.var_list(vars) => var_lst &
DAELow.var_list(knvars) => knvar_lst &
generate_var_names_and_comments_states(var_lst) => (state_lst,state_comment_lst) &
generate_var_names_and_comments_derivatives(var_lst) => (der_lst,der_comment_lst) &
generate_var_names_and_comments_algvars(var_lst) => (algvar_lst,algvar_comment_lst) &
generate_var_names_and_comments_inputvars(knvar_lst) => (inputvar_lst,inputvar_comment_lst) &
Util.list_flatten([state_lst,der_lst,algvar_lst,inputvar_lst]) => varnames_lst &
Util.list_flatten([state_comment_lst,der_comment_lst,algvar_comment_lst,inputvar_comment_lst]) => comments_lst &
Util.string_delimit_list(varnames_lst,", ") => str &
Util.string_delimit_list(comments_lst,", ") => str2 &
int_add(nx,nx) => nxtwo &
int_add(ny,nxtwo) => tot_elts &
int_string(tot_elts) => tot_elts_str &
Util.string_append_list(["char* varnames[",tot_elts_str,"] = {",
str, "};\n"]) => res &
Util.string_append_list(["char* comments[",tot_elts_str,"] = {",
str2, "};\n"]) => res2
-------------------
generate_var_names_and_comments(DAELow.DAELOW(vars,knvars,_,_,_,_,_),nx,ny) => (res,res2)
end
(** relation: generate_parameter_names
**
** This function generates a char* parameternames[]=... that contain
** the name of the parameters.
**)
relation generate_parameter_names:(DAELow.DAELow,int) => string =
rule (* special case if no variables *)
DAELow.var_list(knvars) => []
------------------------------------
generate_parameter_names(DAELow.DAELOW(vars,knvars,_,_,_,_,_),np) => ""
rule DAELow.var_list(knvars) => knvar_lst &
generate_parameter_names2(knvar_lst) => param_str_lst &
Util.string_delimit_list(param_str_lst,", ") => str
&int_string(np) => np_str &
Util.string_append_list(["char* parameternames[",np_str,"] = {",
str, "};\n"]) => res
------------------------------------
generate_parameter_names(DAELow.DAELOW(vars,knvars,_,_,_,_,_),np) => res
end
(** relation: generate_parameter_names2
**
** Helper relation to generate_parameter_names
**)
relation generate_parameter_names2:(DAELow.Var list) => string list =
axiom generate_parameter_names2([]) => []
rule generate_parameter_names2(vs) => res &
Util.string_append_list(["\"",origname,"\""]) => origname'
-----------------------
generate_parameter_names2(DAELow.VAR(cr,DAELow.PARAM,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> origname'::res
rule generate_parameter_names2(vs) => res
-----------------------
generate_parameter_names2(_::vs)
=> res
end
(** relation: generate_var_names_and_comments_states
**
** Helper relation to generate_var_names_and_comments
**)
relation generate_var_names_and_comments_states:(DAELow.Var list) => (string list,string list) =
axiom generate_var_names_and_comments_states([]) => ([],[])
rule generate_var_names_and_comments_states(vs) => (res,res2) &
Util.string_append_list(["\"",origname,"\""]) => origname' &
Dump.unparse_comment_option(comment) => comment &
generate_empty_string(comment) => comment'
-----------------------
generate_var_names_and_comments_states(DAELow.VAR(cr,DAELow.STATE,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> (origname'::res,comment'::res2)
rule generate_var_names_and_comments_states(vs) => (res,res2)
-----------------------
generate_var_names_and_comments_states(_::vs)
=> (res,res2)
end
(** relation: generate_empty_string
**
** This relation adds citation chars to an empty string. Non empty strings
** are returned as is.
**)
relation generate_empty_string: (string) => string =
axiom generate_empty_string("") => "\"\""
axiom generate_empty_string(s) => s
end
(** relation: generate_var_names_and_comments_derivatives
**
** Helper relation to generate_var_names_and_comments
**)
relation generate_var_names_and_comments_derivatives:(DAELow.Var list) => (string list,string list) =
axiom generate_var_names_and_comments_derivatives([]) => ([],[])
rule generate_var_names_and_comments_derivatives(vs) => (res,res2) &
Util.string_append_list(["\"der(",origname,")\""]) => origname' &
Dump.unparse_comment_option(comment) => comment &
generate_empty_string(comment) => comment'
-----------------------
generate_var_names_and_comments_derivatives(DAELow.VAR(cr,DAELow.STATE,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> (origname'::res,comment'::res2)
rule generate_var_names_and_comments_derivatives(vs) =>(res,res2)
-----------------------
generate_var_names_and_comments_derivatives(_::vs)
=> (res,res2)
end
(** relation: generate_var_names_and_comments_algvars
**
** Helper relation to generate_var_names_and_comments
**)
relation generate_var_names_and_comments_algvars:(DAELow.Var list) => (string list,string list) =
axiom generate_var_names_and_comments_algvars([]) => ([],[])
rule generate_var_names_and_comments_algvars(vs) => (res,res2) &
Util.string_append_list(["\"",origname,"\""]) => origname' &
Dump.unparse_comment_option(comment) => comment &
generate_empty_string(comment) => comment'
-----------------------
generate_var_names_and_comments_algvars(DAELow.VAR(cr,DAELow.VARIABLE,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> (origname'::res,comment'::res2)
rule generate_var_names_and_comments_algvars(vs) => (res,res2) &
Util.string_append_list(["\"",origname,"\""]) => origname' &
Dump.unparse_comment_option(comment) => comment &
generate_empty_string(comment) => comment'
-----------------------
generate_var_names_and_comments_algvars(DAELow.VAR(cr,DAELow.DISCRETE,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> (origname'::res,comment'::res2)
rule generate_var_names_and_comments_algvars(vs) => (res,res2) &
Util.string_append_list(["\"",origname,"\""]) => origname' &
Dump.unparse_comment_option(comment) => comment &
generate_empty_string(comment) => comment'
-----------------------
generate_var_names_and_comments_algvars(DAELow.VAR(cr,DAELow.DUMMY_DER,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> (origname'::res,comment'::res2)
rule generate_var_names_and_comments_algvars(vs) => (res,res2) &
Util.string_append_list(["\"",origname,"\""]) => origname' &
Dump.unparse_comment_option(comment) => comment &
generate_empty_string(comment) => comment'
-----------------------
generate_var_names_and_comments_algvars(DAELow.VAR(cr,DAELow.DUMMY_STATE,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> (origname'::res,comment'::res2)
rule generate_var_names_and_comments_algvars(vs) => (res,res2) &
Util.string_append_list(["\"",origname,"\""]) => origname' &
Dump.unparse_comment_option(comment) => comment &
generate_empty_string(comment) => comment'
-----------------------
generate_var_names_and_comments_algvars(DAELow.VAR(cr,DAELow.DISCRETE,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> (origname'::res,comment'::res2)
rule generate_var_names_and_comments_algvars(vs) => (res,res2)
-----------------------
generate_var_names_and_comments_algvars(_::vs)
=> (res,res2)
end
(** relation: generate_input_function_code
**
** Generates the input_function for all the variables
** that are INPUT and on top model
**)
relation generate_input_function_code:(DAELow.DAELow) => (string,int) =
rule DAELow.var_list(knvars) => knvars_lst &
generate_input_function_code2(knvars_lst,0) => res1 &
list_length(res1) => lst_lenght &
Util.string_delimit_list_no_empty(res1,"\n ") => res1' &
Util.string_append_list(["\n/*\n*/\nvoid input_function(double *in_x,double *x, double *xd, double *y, double *p,\n",
" int nx, int ny, int np)\n",
"{\n ",
res1',
"\n}\n"]) => res
-------------------------------------
generate_input_function_code(DAELow.DAELOW(vars,knvars,eqns,se,ie,al,ev)) => (res,lst_lenght)
end
(** relation: generate_input_function_code2
**
** Helper relation to generate_input_function_code
**)
relation generate_input_function_code2:(DAELow.Var list,int) => string list =
axiom generate_input_function_code2([],int) => []
rule DAELow.is_var_on_top_level_and_input(var) => true &
int_string(i) => i_str &
int_add(i,1) => i' &
Exp.print_component_ref_str(cr) => cr_str &
Util.string_append_list([cr_str," = in_x[",i_str,"];"]) => assign_str &
generate_input_function_code2(rest,i') => res
--------------------------
generate_input_function_code2((var as DAELow.VAR(cr,_,dir,tp,exp,v,dim,st,index,name,classes,attr,comment,flow))::rest,
i)
=> assign_str::res
rule generate_input_function_code2(rest,index) => res
--------------------------------
generate_input_function_code2(var::rest,
index) => res
end
(** relation: generate_output_function_code
**
** Generates the output_function for all the variables
** that are OUTPUT and on top model
**)
relation generate_output_function_code:(DAELow.DAELow) => (string,int) =
rule DAELow.var_list(knvars) => knvars_lst &
DAELow.var_list(vars) => vars_lst &
list_append(knvars_lst,vars_lst) => vars_lst' &
generate_output_function_code2(vars_lst',0) => res1 &
list_length(res1) => lst_lenght &
Util.string_delimit_list_no_empty(res1,"\n ") => res1' &
Util.string_append_list(["\n/*\n*/\nvoid output_function(double *out_x,double *x, double *xd, double *y, double *p,\n",
" int nx, int ny, int np)\n",
"{\n ",
res1',
"\n}\n"]) => res
-------------------------------------
generate_output_function_code(DAELow.DAELOW(vars,knvars,eqns,se,ie,al,ev)) => (res,lst_lenght)
end
(** relation: generate_output_function_code2
**
** Helper relation to generate_output_function_code
**)
relation generate_output_function_code2:(DAELow.Var list,int) => string list =
axiom generate_output_function_code2([],int) => []
rule DAELow.is_var_on_top_level_and_output(var) => true &
int_string(i) => i_str &
int_add(i,1) => i' &
Exp.print_component_ref_str(cr) => cr_str &
Util.string_append_list(["out_y[",i_str,"] =",cr_str,";"]) => assign_str &
generate_output_function_code2(rest,i') => res
--------------------------
generate_output_function_code2((var as DAELow.VAR(cr,_,dir,tp,exp,v,dim,st,index,name,classes,attr,comment,flow))::rest,
i)
=> assign_str::res
rule generate_output_function_code2(rest,index) => res
--------------------------------
generate_output_function_code2(var::rest,
index) => res
end
(** relation: generate_var_names_and_comments_inputvars
**
** Helper relation to generate_var_names_and_comments
**)
relation generate_var_names_and_comments_inputvars:(DAELow.Var list) => (string list,string list) =
axiom generate_var_names_and_comments_inputvars([]) => ([],[])
rule generate_var_names_and_comments_inputvars(vs) => (res,res2) &
Util.string_append_list(["\"",origname,"\""]) => origname'&
Dump.unparse_comment_option(comment) => comment &
generate_empty_string(comment) => comment'
-----------------------
generate_var_names_and_comments_inputvars(DAELow.VAR(cr,DAELow.VARIABLE,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> (origname'::res,comment'::res2)
rule generate_var_names_and_comments_inputvars(vs) => (res,res2) &
Util.string_append_list(["\"",origname,"\""]) => origname'&
Dump.unparse_comment_option(comment) => comment &
generate_empty_string(comment) => comment'
-----------------------
generate_var_names_and_comments_inputvars(DAELow.VAR(cr,DAELow.DISCRETE,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> (origname'::res,comment'::res2)
rule generate_var_names_and_comments_inputvars(vs) => (res,res2) &
Util.string_append_list(["\"",origname,"\""]) => origname'&
Dump.unparse_comment_option(comment) => comment &
generate_empty_string(comment) => comment'
-----------------------
generate_var_names_and_comments_inputvars(DAELow.VAR(cr,DAELow.DUMMY_DER,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> (origname'::res,comment'::res2)
rule generate_var_names_and_comments_inputvars(vs) => (res,res2) &
Util.string_append_list(["\"",origname,"\""]) => origname'&
Dump.unparse_comment_option(comment) => comment &
generate_empty_string(comment) => comment'
-----------------------
generate_var_names_and_comments_inputvars(DAELow.VAR(cr,DAELow.DUMMY_STATE,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> (origname'::res,comment'::res2)
rule generate_var_names_and_comments_inputvars(vs) => (res,res2) &
Util.string_append_list(["\"",origname,"\""]) => origname'&
Dump.unparse_comment_option(comment) => comment &
generate_empty_string(comment) => comment'
-----------------------
generate_var_names_and_comments_inputvars(DAELow.VAR(cr,DAELow.DISCRETE,_,_,_,_,
_,value,indx,origname,_,dae_var_attr,comment,flow)::vs)
=> (origname'::res,comment'::res2)
rule generate_var_names_and_comments_inputvars(vs) => (res,res2)
-----------------------
generate_var_names_and_comments_inputvars(_::vs)
=> (res,res2)
end
(** relation: generate_initial_value_code
**
** This relation generates the code for solving the initial value problem.
** Information is gathered from the start and fixed attributes of variables
** and from initial equations.
**)
relation generate_initial_value_code:(DAELow.DAELow) => string =
rule DAELow.var_list(vars) => vars_lst &
DAELow.equation_list(ie) => initial_eqns1 &
generate_initial_equations_from_start(vars_lst) => initial_eqns2 &
list_append(initial_eqns1,initial_eqns2) => initial_eqns &
DAELow.list_equation(initial_eqns) => initial_eqns' &
list_array([]) => arr &
let empty_eqn = DAELow.EQUATION_ARRAY(0,0,arr) &
let initial_dae = DAELow.DAELOW(vars,knvars,initial_eqns',empty_eqn,empty_eqn,al,ev) &
(* States are no longer special, they are just a variable that
* needs an initial value. *)
DAELow.make_all_states_algebraic(initial_dae) => initial_dae' &
DAELow.incidence_matrix(initial_dae') => m &
DAELow.transpose_matrix(m) => mT &
(* once dae has been translated, state or not should not matter *)
DAELow.abs_incidence_matrix(m) => m' &
DAELow.abs_incidence_matrix(mT) => mT' &
DAELow.dump initial_dae' &
DAELow.dump_incidence_matrix m' &
(* index reduction for intitial equations makes no sense.. *)
DAELow.matching_algorithm(initial_dae',m',mT',DAELow.NO_INDEX_REDUCTION)
=> (ass1,ass2,initial_dae',m,mT) &
DAELow.strong_components(m',mT',ass1,ass2) => blocks &
generate_ode_blocks(initial_dae',ass1,ass2,blocks)
=> (block_code,extra_funcs) &
Util.string_append_list([extra_funcs,
"\n/*\n*/\nvoid initial_function(double *x, double *xd, double *y, double *p,\n",
" int nx, int ny, int np)\n",
"{\n",
block_code,
"\n}\n"]) => res
----------------------------------
generate_initial_value_code(DAELow.DAELOW(vars,knvars,eqns,se,ie,al,ev)) => res
axiom generate_initial_value_code(_) => ""
end
(** relation: generate_initial_equations_from_start
**
** This relation generates equations from the expressions in the start
** attributes of variables. Only variables with a start value and
** fixed set to true is converted by this relation. Fixed set to false
** means an initial guess, and is not considered here.
**)
relation generate_initial_equations_from_start: DAELow.Var list => DAELow.Equation list =
axiom generate_initial_equations_from_start ([]) => []
(* add equations for variables with fixed = true*)
rule DAELow.var_fixed(attr,kind) => true &
generate_initial_equations_from_start(vars) => eqns
--------------------------
generate_initial_equations_from_start(DAELow.VAR(cr,kind,_,_,_,_,_,SOME(startv),_,_,_,attr,_,_)::vars)
=> DAELow.EQUATION(Exp.CREF(cr,Exp.OTHER),startv)::eqns
rule generate_initial_equations_from_start(vars) => eqns
--------------------------
generate_initial_equations_from_start(_::vars)
=> eqns
end
(** relation generate_ode_code
** Outputs simulation code from a DAELow.
** The state calculations are generated on explicit ode form:
** \dot{x} := f(x,y,t)
**)
relation generate_ode_code: (DAELow.DAELow,
int list list, (* components*)
int vector, (* ass1 *)
int vector, (* ass2 *)
DAELow.IncidenceMatrix,
DAELow.IncidenceMatrixT,
Absyn.Path) => string =
rule Absyn.path_string(class) => cname &
DAELow.generate_state_partition(comps,dlow,ass1,ass2,m,mt)
=> (blt_states,blt_no_states) &
generate_ode_blocks(dlow,ass1,ass2,blt_states)
=> (block_code, extra_funcs) &
generate_ode_header() => cheader &
generate_ode_footer() => cfooter &
Util.string_append_list([extra_funcs,cheader,block_code,cfooter]) => res
-------------------------------------------
generate_ode_code(dlow,comps,ass1,ass2,m,mt,class) => res
end
(** relation: generate_ode_header
** author: PA
**
** Geneates the header of the function for calcuating the explicit ode
**)
relation generate_ode_header: () => string =
rule Util.string_append_list(
[
"void functionODE(double *x, double *xd, double *y, double *p, \n",
" int nx, int ny, int np, double *t)\n",
"{\n"
]) => res
------------------------
generate_ode_header() => res
end
(** relation: generate_ode_footer
** author: PA
**
** Geneates the footer of the function for calcuating the explicit ode
**)
relation generate_ode_footer: () => string =
rule Util.string_append_list(
[
"}\n"
]) => res
------------------------
generate_ode_footer() => res
end
(** relation: generate_ode_blocks
** author: PA
**
** Generates the simulation code for the ode code.
**
**)
relation generate_ode_blocks:(DAELow.DAELow, int vector, int vector, int list list)
=> (string, (* block code*)
string) (* extra functions code*) =
axiom generate_ode_blocks(_,_,_,[]) => ("","")
rule (* For system of equations *)
generate_ode_system(dae,ass1,ass2,block) => (s1,f1) &
generate_ode_blocks(dae,ass1,ass2,blocks) => (s2,f2) &
string_append(s1,s2) => res &
string_append(f1,f2) => res2
-------------------------------------
generate_ode_blocks(dae,ass1,ass2,(block as (_::_::_))::blocks)
=> (res,res2)
rule (* for single equations *)
generate_ode_equation(dae,ass1,ass2,eqn) => (s1,f1) &
generate_ode_blocks(dae,ass1,ass2,blocks) => (s2,f2) &
string_append(s1,s2) => res &
string_append(f1,f2) => res2
-------------------------------------
generate_ode_blocks(dae,ass1,ass2,(block as [eqn])::blocks) => (res,res2)
rule print "-generate_ode_blocks failed\n"
-----------------
generate_ode_blocks(_,_,_,_) => fail
end
(** relation: generate_ode_system
** author: PA
**
** Generates code for a subsystem of equations, both linear and non-linear.
**)
relation generate_ode_system: (DAELow.DAELow, int vector, int vector, int list)
=> (string, (* system code *)
string) = (* extra function code*)
rule (** extract the variables and equations of the block.*)
Util.list_map_3_2(block,get_equation_and_solved_var,eqns,vars,ass2)
=> (eqn_lst,var_lst) &
Util.list_map(var_lst,transform_x_to_xd) => var_lst' &
DAELow.list_var(var_lst') => vars' &
DAELow.list_equation(eqn_lst) => eqns' &
let subsystem_dae = DAELow.DAELOW(vars',knvars(* not used*),eqns',se,ie,al,ev) &
DAELow.incidence_matrix(subsystem_dae) => m &
DAELow.abs_incidence_matrix(m) => m' &
DAELow.transpose_matrix(m') => mt' &
(* calculate jacobian. If constant, linear system of equations. Otherwise nonlinear *)
DAELow.calculate_jacobian(vars',eqns',m',mt') => jac &
DAELow.analyze_jacobian(subsystem_dae,jac) => jac_tp &
generate_ode_system2(subsystem_dae,jac,jac_tp) => (str,f1) &
DAELow.jacobian_type_str jac_tp => jac_tp_str &
Util.string_append_list(["/* system of equations of type ",jac_tp_str, "*/\n",
str,
"/* End system of equations */\n"
])
=> res
-------------------------
generate_ode_system(daelow as DAELow.DAELOW(vars,knvars,eqns,se,ie,al,ev),ass1,ass2,block)
=> (res,f1)
end
(** relation: generate_ode_system2
** author: PA
**
** Generates the actual simulation code for the system of equation, once
** its jacobian and type has been given.
**)
relation generate_ode_system2: (DAELow.DAELow, (* the daelow for the subsystem*)
(int * int * DAELow.Equation) list, (* jacobian *)
DAELow.JacobianType) (* Type of jacobian, constant,etc.*)
=> (string, (* system code *)
string) = (* extra functions code *)
(* constant jacobians. Linear system of equations (A x = b) where
A and b are constants. *)
rule DAELow.equation_size(eqn) => eqn_size &
generate_ode_system2(d,jac,DAELow.JAC_TIME_VARYING) => (s1,f1)
------------------------------
generate_ode_system2(d as DAELow.DAELOW(v,kv,eqn,_,_,_,_),jac,
DAELow.JAC_CONSTANT) => (s1,f1)
(* Time varying jacobian. Linear system of equations that needs to
* be solved during runtime. *)
rule DAELow.equation_size(eqn) => eqn_size &
generate_ode_system2_declaration(eqn_size) => s1 &
generate_ode_system2_populate_Ab(jac,v,eqn) => s2 &
generate_ode_system2_solve_call(eqn_size) => s3 &
generate_ode_system2_collect_results(v) => s4 &
Util.string_append_list([s1,s2,s3,s4]) => str
--------------------
generate_ode_system2(d as DAELow.DAELOW(v,kv,eqn,_,_,_,_),jac,DAELow.JAC_TIME_VARYING) => (str,"")
(* Time varying nonlinear jacobian. Non-linear system of equations*)
rule DAELow.equation_list(eqn) => eqn_lst &
DAELow.var_list(v) => var_lst &
Util.list_map(var_lst,DAELow.var_cref) => crefs &
generate_ode_system2_nonlinear_residuals(crefs,eqn_lst) => (str,f1)
------------------------------------------------------
generate_ode_system2(DAELow.DAELOW(v,kv,eqn,_,_,_,_),jac,DAELow.JAC_NONLINEAR)
=> (str,f1)
rule print "-generate_ode_system2 failed\n"
-------------------------
generate_ode_system2(_,_,_) => fail
end
(** relation: generate_ode_system2_nonlinear_residuals
** author: PA
**
** Generates residual statements for nonlinear equation systems.
**)
relation generate_ode_system2_nonlinear_residuals: (Exp.ComponentRef list,
DAELow.Equation list)
=> (string, (* solve code *)
string) = (* extra functions: residual func*)
rule make_residual_replacements(crs) => repl &
generate_ode_system2_nonlinear_residuals2(eqns,0,repl) => s1 &
tick() => id &
int_string(id) => str_id &
list_length(eqns) => eqn_size & int_string(eqn_size) => size_str &
Util.string_append_list(["void residualFunc",str_id,
"(int* n, double* xloc, double*res, int* iflag)\n",
"{\n",
s1,
"}\n"]) => func &
generate_ode_system2_nonlinear_setvector(crs,0) => s2 &
generate_ode_system2_nonlinear_call(str_id) => s3 &
generate_ode_system2_nonlinear_store_results(crs,0) => s4 &
Util.string_append_list([TAB,"start_nonlinear_system(",size_str,");\n",
s2,s3,s4,
TAB, "end_nonlinear_system();\n"]) => res
-----------------------------------------------------------
generate_ode_system2_nonlinear_residuals(crs,eqns)
=> (res,func)
rule print "generate_ode_system2_nonlinear_residuals failed\n"
-----------------------------------------------------------
generate_ode_system2_nonlinear_residuals(crs,eqns)
=> fail
end
(** relation: make_residual_replacements
** author: PA
**
** This relation makes replacement rules for variables occuring in a
** nonlinear equation system. They should be replaced by x[index], i.e.
** an unique index in the x vector.
**)
relation make_residual_replacements:(Exp.ComponentRef list) =>
VarTransform.VariableReplacements =
rule VarTransform.empty_replacements() => repl &
make_residual_replacements2(repl,crefs,0) => repl'
---------------------
make_residual_replacements(crefs) => repl'