ae47738f9a8d1f0a24f45f8ba160eaff4bab3a20
[scilab.git] / scilab / modules / scicos / src / modelica_compiler / README.txt
1 1. Introduction\r
2 ===============\r
3 \r
4 This document describes the Modelica compiler Modelicac.\r
5 Modelicac is a tool that compiles a subset of the Modelica 2.0 language (see\r
6 section 4). This subset allows the description of continuous-time physical\r
7 models that can be simulated under AMESim.\r
8 \r
9 \r
10 2. How to compile Modelicac\r
11 ===========================\r
12 \r
13 Be sure to have a recent Objective Caml (v.3.06 or later) properly installed\r
14 on the machine.\r
15 In the source directory, type:\r
16 \r
17   make depend\r
18 \r
19 then:\r
20 \r
21   make (to compile a bytecode version of Modelicac)\r
22 or:\r
23   make opt (to compile a native-code version of Modelicac)\r
24 \r
25 Ocaml code HTML documentation can be automatically generated from module types\r
26 by typing:\r
27 \r
28  make doc\r
29 \r
30 This will create a directory named "doc" in the current directory. "index.html"\r
31 is the entry point of the documentation.\r
32 \r
33 \r
34 3. How to use Modelicac\r
35 =======================\r
36 \r
37 Modelicac compiles Modelica files whose name ends by ".mo".\r
38 The modelicac command, when invoked with the appropriate options, may produce:\r
39 - A C file containing a function suitable to be called by AMESim in\r
40   order to perform a model simulation;\r
41 - A "*.moc" file which is the format of a precompiled Modelica class stored for\r
42   later instantiation.\r
43 \r
44 It is required that each "*.mo" file contains exactly one Modelica class\r
45 (see section 4) and that the name of the class matches the name of the file that\r
46 contains its definition.\r
47 \r
48 By default, Modelicac removes every variable that is not reinitialized in a\r
49 "when" section and for which it can express its value with respect to the\r
50 remaining variables of the system. It is possible to disable this option by\r
51 specifying "-keep-all-variables" when calling Modelicac (see below).\r
52 \r
53 Usage\r
54 -----\r
55 \r
56 modelicac [-c] [-o <outputfile>] <inputfile> [other options]\r
57 \r
58 -c: Compile only, do not instantiate. Modelicac produces a "*.moc" file when\r
59     invoked with that option.\r
60 -o <outputfile>: Set output file name to <outputfile> (this option also works\r
61                  with -c option but is somewhat useless because of the class\r
62                  name restrictions given above).\r
63 Other options include:\r
64 -L <directory>: Add <directory> to the list of directories to be searched when\r
65                 producing a C file (no effect when used with -c).\r
66 -hpath <directory>: Specify a path to be added to #include directives in the\r
67                     generated C code.\r
68 -keep-all-variables: Do not remove any variable from the initial system.\r
69 -jac: Generate analytic jacobian matrix code.\r
70 -no-parameter-removal: Do not remove any parameter\r
71 -no-simplifs: Same as -keep-all-variables -no-parameter-removal\r
72 -xml: Generate an XML version of the model instead of target code\r
73 -with-init-in <filename>: Generate code for 'separate initialization' mode\r
74                           (where initialization data is loaded from\r
75                           <filename>)\r
76 -with-init-out <filename>: Generate code for 'separate initialization' mode\r
77                            (where initialization data is saved in\r
78                            <filename>)\r
79 \r
80 Examples\r
81 -------\r
82 \r
83 +------------------------------------------------------------------------------+\r
84 | Modelicac invokation         | Result                                        |\r
85 +------------------------------+-----------------------------------------------+\r
86 | modelicac foo.mo             | Produces a file named "foo.c" containing a    |\r
87 |                              | C function named "foo" to be called by AMESim.|\r
88 +------------------------------+-----------------------------------------------+\r
89 | modelicac -c foo.mo          | Produces a file named "foo.moc" containing a  |\r
90 |                              | precompiled class named "foo".                |\r
91 +------------------------------+-----------------------------------------------+\r
92 | modelicac -o dir/bar.c       | Same as "modelicac foo.mo", but output file   |\r
93 |  foo.mo                      | name is "bar.c" and the resulting file is     |\r
94 |                              | located in directory "dir".                   |\r
95 +------------------------------+-----------------------------------------------+\r
96 | modelicac -L dir1 -L dir2 ...| Same as "modelicac foo.mo", but if some       |\r
97 | -L dirN foo.mo               | precompiled class "bar" needed by class "foo" |\r
98 |                              | isn't found in the current directory (i.e.    |\r
99 |                              | there is no file named "bar.moc" in the       |\r
100 |                              | current directory), it is searched into       |\r
101 |                              | "dir1", and, if not found, into "dir2", ...,  |\r
102 |                              | "dirN" until a file named "bar.moc" is found. |\r
103 +------------------------------+-----------------------------------------------+\r
104 \r
105 \r
106 3. The compiled Modelica subset\r
107 ===============================\r
108 \r
109  The Modelicac compiler compiles a subset of the Modelica language that allows\r
110 the description of some countinuous equational models. Each Modelica class is\r
111 stored in its own file whose name is the name of the class followed by the "mo"\r
112 extension.\r
113 \r
114 Restrictions on the declaration of a modelica class header\r
115 ----------------------------------------------------------\r
116  - only the keyword "class" is allowed to declare a Modelica class ("function"\r
117    is allowed to define functions, but in a very restrictive way, see below);\r
118  - "within" is not allowed ;\r
119  - a class cannot be "final" ;\r
120  - short class definitions (type declarations) are not allowed ;\r
121  - inheritance is not allowed ;\r
122  - "encapsulated" and "partial" classes are not allowed ;\r
123 \r
124 Restrictions on the declaration of the components of a class\r
125 ------------------------------------------------------------\r
126  - imports are not allowed ;\r
127  - inner classes are not allowed ;\r
128  - "inner", "outer" are not allowed ;\r
129  - "protected" component lists are not allowed ;\r
130  - "final" and "replaceable" are not allowed ;\r
131  - "external" is restricted (see "Restrictions on external function\r
132    definitions") ;\r
133  - "constant" is not allowed ;\r
134  - "input" and "output" may only be used to define I/O ports of the toplevel\r
135    class beeing compiled to C code (see example below) ;\r
136  - "algorithm" sections are not allowed ;\r
137  - arrays must contain numerical types.\r
138 \r
139 Restrictions on modifications\r
140 -----------------------------\r
141  - modifications may only apply to base types, scalar or not ;\r
142  - selections of subarrays are not allowed (i.e. a[:].b = ...) ;\r
143  - "redeclare", "each" and "final" are not allowed.\r
144 \r
145 Restrictions on equations\r
146 -------------------------\r
147  - equational "if" is not allowed in the specification of an equation.\r
148 \r
149 Restrictions on expressions\r
150 -----------------------------\r
151  - "for" expressions must have an integer range (since algorithms are not\r
152    allowed) ;\r
153  - selection of subarrays is restricted to numerical arrays ;\r
154  - array concatenation (using "[" and "]") is not allowed.\r
155 \r
156 Restrictions on external function definitions\r
157 ---------------------------------------------\r
158  Only functions taking zero or more Integer scalars, String scalars,\r
159 Real scalars or Real arrays and returning exactly one\r
160 Real scalar are supported.\r
161  External functions must be declared in the Modelica file that\r
162 contains models that use them.\r
163 The compiler assumes a corresponding C function with the same\r
164 name to be provided by the simulation environment. For example:\r
165 \r
166 function Blackbox\r
167   input Real u[:];\r
168   output Real y;\r
169 external;\r
170 end Blackbox;\r
171 \r
172  This function can be called from a Modelica model using the following\r
173 syntax:\r
174 \r
175 ...Blackbox(u)...\r
176 \r
177  The corresponding C function is declared with the following signature:\r
178 \r
179 double blackbox(double *, int );\r
180 \r
181 (the last argument will be the size of the array whose first element\r
182 is pointed to by the first argument, as specified in the Modelica\r
183 Language Specification)\r