source: branches/dev-5819/Compiler/ModelicaCompiler/module.options @ 13800

Last change on this file since 13800 was 13800, checked in by randersson, 8 weeks ago

#5819 Merged trunk into branch

File size: 19.3 KB
Line 
1
2
3********************************************************************************
4STRING c_compiler compiler uncommon "gcc"
5
6"The C compiler to use to compile generated C code."
7
8********************************************************************************
9BOOLEAN copy_source_files_to_fmu compiler user false
10
11"If enabled, the generated source files will be copied to the FMU."
12
13********************************************************************************
14BOOLEAN generate_only_initial_system compiler user false
15
16"If enabled, then only the initial equation system will be generated."
17
18********************************************************************************
19REAL tearing_division_tolerance compiler user 1.0E-10
20
21"The minimum allowed size for a divisor constant when performing tearing."
22
23********************************************************************************
24BOOLEAN divide_by_vars_in_tearing compiler user false
25
26"If enabled, a less restrictive strategy is used for solving equations in the
27tearing algorithm. Specifically, division by parameters and variables is
28permitted, by default no such divisions are made during tearing."
29
30********************************************************************************
31STRING local_iteration_in_tearing compiler uncommon "off"
32"off" "annotation" "all"
33
34"This option controls whether equations can be solved local in tearing.
35Possible options are:
36'off', local iterations are not used (default).
37'annotation', only equations that are annotated are candidates.
38'all', all equations are candidates."
39
40********************************************************************************
41BOOLEAN automatic_tearing compiler user true
42
43"If enabled, then automatic tearing of equation systems is performed."
44
45********************************************************************************
46BOOLEAN allow_non_scalar_nested_blocks compiler uncommon true
47
48"If disabled, an error is given if there are nested blocks which are
49non-scalar."
50
51********************************************************************************
52BOOLEAN convert_free_dependent_parameters_to_algebraics compiler user true
53
54"If enabled, then free dependent parameters are converted to algebraic
55variables."
56
57********************************************************************************
58BOOLEAN generate_dae compiler internal false
59
60"If enabled, then code for solving DAEs are generated."
61
62********************************************************************************
63INTEGER generate_sparse_block_jacobian_threshold compiler experimental 100 0 Integer.MAX_VALUE
64
65"Threshold for when a sparse Jacobian should be generated. If the number of
66torn variables is less than the threshold a dense Jacobian is generated."
67
68********************************************************************************
69BOOLEAN generate_ode compiler internal true
70
71"If enabled, then code for solving ODEs are generated. "
72
73********************************************************************************
74BOOLEAN generate_mof_files compiler user false
75
76"If enabled, then flat model before and after transformations will be
77generated."
78
79********************************************************************************
80STRING fmu_type compiler internal ""
81
82"Semicolon separated list of defines to set, e.g. FMUCS20."
83
84********************************************************************************
85STRING extra_lib_dirs compiler internal ""
86
87"The value of this option is appended to the MODELICAPATH when searching for
88libraries. Deprecated."
89
90********************************************************************************
91BOOLEAN state_start_values_fixed compiler user false
92
93"If enabled, then initial equations are generated automatically for
94differentiated variables even though the fixed attribute is equal to fixed.
95Setting this option to true is, however, often practical in optimization
96problems."
97
98********************************************************************************
99BOOLEAN eliminate_alias_variables compiler uncommon true
100
101"If enabled, then alias variables are eliminated from the model."
102
103********************************************************************************
104BOOLEAN eliminate_alias_parameters compiler uncommon true false
105
106"If enabled, then alias parameters are eliminated from the model."
107
108********************************************************************************
109BOOLEAN eliminate_alias_constants compiler uncommon true
110
111"If enabled, then alias constants are eliminated from the model."
112
113********************************************************************************
114BOOLEAN eliminate_linear_equations compiler uncommon true
115
116"If enabled, then equations with linear sub expressions are substituted and
117eliminated."
118
119********************************************************************************
120BOOLEAN common_subexp_elim compiler uncommon true false
121
122"If enabled, the compiler performs a global analysis on the equation system and
123extract identical function calls into common equations."
124
125********************************************************************************
126INTEGER external_constant_evaluation compiler user 5000
127
128"Time limit (ms) when evaluating constant calls to external functions during
129compilation. 0 indicates no evaluation. -1 indicates no time limit."
130
131********************************************************************************
132INTEGER external_constant_evaluation_max_proc compiler uncommon 10
133
134"The maximum number of processes kept alive for evaluation of external
135functions during compilation. This speeds up evaluation of functions using
136external objects during compilation.If less than 1, no processes will be kept
137alive, i.e. this feature is turned off."
138
139********************************************************************************
140BOOLEAN external_constant_evaluation_dynamic compiler experimental false
141
142"If enabled, calls to external functions will be evaluated during compilation
143using a pre-compiled program (instead of generating and compiling one), if
144possible."
145
146********************************************************************************
147BOOLEAN halt_on_warning compiler user false
148
149"If enabled, compilation warnings will cause compilation to abort."
150
151********************************************************************************
152BOOLEAN generate_xml_equations compiler internal false
153
154"If enabled, then model equations are generated in XML format."
155
156********************************************************************************
157BOOLEAN index_reduction compiler user true
158
159"If enabled, then index reduction is performed for high-index systems."
160
161********************************************************************************
162INTEGER munkres_max_incidences compiler deprecated 0
163
164"The maximum number of incidences that can be in a graph when solving a munkres
165problem. A value of zero or less results in no limit."
166
167********************************************************************************
168BOOLEAN propagate_derivatives compiler uncommon true
169
170"If enabled, the compiler will try to replace ordinary variable references with
171derivative references. This is done by first finding equations on the form
172x = der(y). If possible, uses of x will then be replaced with der(x)."
173
174********************************************************************************
175BOOLEAN equation_sorting compiler uncommon true
176
177"If enabled, then the equation system is separated into minimal blocks that can
178be solved sequentially."
179
180********************************************************************************
181BOOLEAN generate_fmi_me_xml compiler internal true
182
183"If enabled, the model description part of the XML variables file will be FMI
184for model exchange compliant. To generate an XML which will validate with FMI
185schema the option generate_xml_equations must also be false."
186
187********************************************************************************
188BOOLEAN generate_fmi_cs_xml compiler internal false
189
190"If enabled, the model description part of the XML variables file will be FMI
191for co simulation compliant. To generate an XML which will validate with FMI
192schema the option generate_xml_equations must also be false."
193
194********************************************************************************
195STRING fmi_version compiler internal "1.0"
196"1.0" "2.0"
197
198"Version of the FMI specification to generate FMU for."
199
200********************************************************************************
201BOOLEAN expose_temp_vars_in_fmu compiler uncommon false
202
203"If enabled, then all temporary variables are exposed in the FMU XML and
204accessible as ordinary variables"
205
206********************************************************************************
207BOOLEAN enable_variable_scaling compiler uncommon false
208
209"If enabled, then the 'nominal' attribute will be used to scale variables in
210the model."
211
212********************************************************************************
213BOOLEAN event_indicator_scaling compiler experimental false
214
215"If enabled, event indicators will be scaled with nominal heuristics"
216
217********************************************************************************
218BOOLEAN normalize_minimum_time_problems compiler uncommon true
219
220"If enabled, then minimum time optimal control problems encoded in Optimica
221are converted to fixed interval problems by scaling of the
222derivative variables. Has no effect for Modelica models."
223
224********************************************************************************
225BOOLEAN enable_structural_diagnosis compiler uncommon true
226
227"If enabled, structural error diagnosis based on matching of equations to
228variables is used."
229
230********************************************************************************
231BOOLEAN automatic_add_initial_equations compiler uncommon true
232
233"If enabled, then additional initial equations are added to the model based
234equation matching. Initial equations are added for states that are not
235matched to an equation."
236
237********************************************************************************
238BOOLEAN compliance_as_warning compiler internal false
239
240"If enabled, then compliance errors are treated as warnings instead. This can
241lead to the compiler or solver crashing. Use with caution!"
242
243********************************************************************************
244BOOLEAN component_names_in_errors compiler user true
245
246"If enabled, the compiler will include the name of the component where the
247error was found, if applicable."
248
249********************************************************************************
250STRING filter_warnings compiler user ""
251
252"A comma separated list of warning identifiers that should be omitted from the
253logs."
254
255********************************************************************************
256BOOLEAN generate_html_diagnostics compiler user false
257
258"If enabled, model diagnostics are generated in HTML format. This includes the
259flattened model, connection sets, alias sets and BLT form."
260
261********************************************************************************
262STRING generate_html_diagnostics_output_directory compiler user "."
263
264"Path to directory where compiler output should be generated for the option
265'generate_html_diagnostics'. Default value is '.'. Directory is created if
266it doesn't exist. The html diagnostics is generated in a subdirectory of this
267directory."
268
269********************************************************************************
270INTEGER diagnostics_limit compiler uncommon 500 0 Integer.MAX_VALUE
271
272"This option specifies the equation system size at which the compiler will
273start to reduce model diagnostics. This option only affects diagnostic output
274that grows faster than linear with the number of equations."
275
276********************************************************************************
277BOOLEAN export_functions compiler uncommon false
278
279"Export used Modelica functions to generated C code in a manner that is
280compatible with the external C interface in the Modelica Language
281Specification."
282
283********************************************************************************
284BOOLEAN export_functions_vba compiler uncommon false
285
286"Create VBA-compatible wrappers for exported functions. Requires the option
287export_functions."
288
289********************************************************************************
290BOOLEAN state_initial_equations compiler user false
291
292"If enabled, the compiler ignores initial equations in the model and adds
293parameters for controlling intitial values of states.Default is false."
294
295********************************************************************************
296STRING inline_functions compiler uncommon "trivial"
297"none" "trivial" "all"
298
299"Controlles what function calls are inlined.
300'none' - no function calls are inlined.
301'trivial' - inline function calls that will not increase the number of
302variables in the system.
303'all' - inline all function calls that are possible."
304
305********************************************************************************
306STRING homotopy_type compiler uncommon "actual"
307"homotopy" "actual" "simplified"
308
309"Decides how homotopy expressions are interpreted during compilation. Can be
310set to either 'simplified' or 'actual' which will compile the model using only
311the simplified or actual expressions of the homotopy() operator."
312
313********************************************************************************
314BOOLEAN debug_csv_step_info compiler debug false
315
316"Debug option, outputs a csv file containing profiling recorded during
317compilation."
318
319********************************************************************************
320BOOLEAN debug_invoke_gc compiler debug false
321
322"Debug option, if enabled, GC will be invoked between the different steps
323during model compilation. This makes it possible to output accurate memory
324measurements."
325
326********************************************************************************
327BOOLEAN debug_duplicate_generated compiler debug false
328
329"Debug option, duplicates any generated files to stdout."
330
331********************************************************************************
332STRING debug_transformation_steps compiler debug "none"
333"none" "diag" "full"
334
335"Options for debugging the different transformation steps. If enabled,
336diagnostics files are written after each transformation step. Allowed values
337are
338'none',
339'diag' (only fixed-size model diagnostics),
340'full' (write diagnostics and flat tree)."
341
342********************************************************************************
343BOOLEAN debug_sanity_check compiler debug false
344
345"If enabled, flat tree will be checked for consistency between transformation
346steps."
347
348********************************************************************************
349BOOLEAN write_iteration_variables_to_file compiler uncommon false
350
351"If enabled, two text files containing one iteration variable name per row is
352written to disk. The files contains the iteration variables for the DAE and the
353DAE initialization system respectively. The files are output to the resource
354directory of the FMU."
355
356********************************************************************************
357BOOLEAN algorithms_as_functions compiler experimental false
358
359"If enabled, convert algorithm sections to function calls."
360
361********************************************************************************
362BOOLEAN write_tearing_pairs_to_file compiler uncommon false
363
364"If enabled, two text files containing tearing pairs is written to disk. The
365files contains the tearing pairs for the DAE and the DAE initialization system
366respectively. The files are output to the working directory."
367
368********************************************************************************
369BOOLEAN check_inactive_contitionals compiler user false
370
371"If enabled, check for errors in inactive conditional components when
372compiling. When using check mode, this is always done."
373
374********************************************************************************
375BOOLEAN ignore_within compiler uncommon false
376
377"If enabled, ignore within clauses both when reading input files and when
378error-checking."
379
380********************************************************************************
381STRING nonlinear_solver compiler user "kinsol"
382"kinsol" "minpack" "realtime"
383
384"Decides which nonlinear equation solver to use. Alternatives are 'kinsol or
385'minpack'."
386
387********************************************************************************
388STRING init_nonlinear_solver compiler user "kinsol"
389"kinsol" "minpack" "realtime"
390
391"Decides which nonlinear equation solver to use in the initial system.
392Alternatives are 'kinsol or 'minpack'."
393
394********************************************************************************
395BOOLEAN generate_event_switches compiler experimental true
396
397"If enabled, event generating expressions generates switches in the c-code.
398Setting this option to false can give unexpected results."
399
400********************************************************************************
401BOOLEAN relational_time_events compiler deprecated true
402
403"Deprecated, use option time_events instead. If enabled, then relational
404operators are allowed to generate time events."
405
406********************************************************************************
407BOOLEAN time_events compiler user true
408
409"If enabled, operators are allowed to generate time events."
410
411********************************************************************************
412BOOLEAN event_output_vars compiler user false
413
414"If enabled, output variables are added to model description for each generated
415state event indicator."
416
417********************************************************************************
418BOOLEAN disable_smooth_events compiler experimental false
419
420"If enabled, no events will be generated for smooth operator if order equals to
421zero."
422
423********************************************************************************
424BOOLEAN enable_block_function_extraction compiler user false
425
426"Looks for function calls in blocks. If a function call in a block doesn't
427depend on the block in question, it is extracted from the block."
428
429********************************************************************************
430STRING function_incidence_computation compiler uncommon "none"
431"none" "all"
432
433"Controls how matching algorithm computes incidences for function call
434equations. Possible values: 'none', 'all'. With 'none' all outputs are assumed
435to depend on all inputs. With 'all' the compiler analyses the function to
436determine dependencies."
437
438********************************************************************************
439INTEGER max_n_proc compiler uncommon 4
440
441"The maximum number of processes used during c-code compilation."
442
443********************************************************************************
444STRING cc_extra_flags_applies_to compiler uncommon "functions"
445"none" "functions" "all"
446
447"Parts of c-code to compile with extra compiler flags specified by
448ccompiler_extra_flags"
449
450********************************************************************************
451STRING cc_extra_flags compiler uncommon ":O1"
452":O1" ":O2"
453
454"Optimization level for c-code compilation"
455
456********************************************************************************
457STRING MODELICAPATH compiler internal ""
458
459"The MODELICAPATH to use during compilation."
460
461********************************************************************************
462STRING compiler_version compiler internal "compiler_version_file_not_read"
463
464"The version string for the compiler. Uses default value during unit testing."
465
466********************************************************************************
Note: See TracBrowser for help on using the repository browser.