source: trunk/Compiler/ModelicaCompiler/module.options @ 12895

Last change on this file since 12895 was 12895, checked in by Jonathan Kämpe, 6 months ago

#5777 Added output directory option for html diagnostics

File size: 19.0 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 halt_on_warning compiler user false
141
142"If enabled, compilation warnings will cause compilation to abort."
143
144********************************************************************************
145BOOLEAN generate_xml_equations compiler internal false
146
147"If enabled, then model equations are generated in XML format."
148
149********************************************************************************
150BOOLEAN index_reduction compiler user true
151
152"If enabled, then index reduction is performed for high-index systems."
153
154********************************************************************************
155INTEGER munkres_max_incidences compiler deprecated 0
156
157"The maximum number of incidences that can be in a graph when solving a munkres
158problem. A value of zero or less results in no limit."
159
160********************************************************************************
161BOOLEAN propagate_derivatives compiler uncommon true
162
163"If enabled, the compiler will try to replace ordinary variable references with
164derivative references. This is done by first finding equations on the form
165x = der(y). If possible, uses of x will then be replaced with der(x)."
166
167********************************************************************************
168BOOLEAN equation_sorting compiler uncommon true
169
170"If enabled, then the equation system is separated into minimal blocks that can
171be solved sequentially."
172
173********************************************************************************
174BOOLEAN generate_fmi_me_xml compiler internal true
175
176"If enabled, the model description part of the XML variables file will be FMI
177for model exchange compliant. To generate an XML which will validate with FMI
178schema the option generate_xml_equations must also be false."
179
180********************************************************************************
181BOOLEAN generate_fmi_cs_xml compiler internal false
182
183"If enabled, the model description part of the XML variables file will be FMI
184for co simulation compliant. To generate an XML which will validate with FMI
185schema the option generate_xml_equations must also be false."
186
187********************************************************************************
188STRING fmi_version compiler internal "1.0"
189"1.0" "2.0"
190
191"Version of the FMI specification to generate FMU for."
192
193********************************************************************************
194BOOLEAN expose_temp_vars_in_fmu compiler uncommon false
195
196"If enabled, then all temporary variables are exposed in the FMU XML and
197accessible as ordinary variables"
198
199********************************************************************************
200BOOLEAN enable_variable_scaling compiler uncommon false
201
202"If enabled, then the 'nominal' attribute will be used to scale variables in
203the model."
204
205********************************************************************************
206BOOLEAN event_indicator_scaling compiler experimental false
207
208"If enabled, event indicators will be scaled with nominal heuristics"
209
210********************************************************************************
211BOOLEAN normalize_minimum_time_problems compiler uncommon true
212
213"If enabled, then minimum time optimal control problems encoded in Optimica
214are converted to fixed interval problems by scaling of the
215derivative variables. Has no effect for Modelica models."
216
217********************************************************************************
218BOOLEAN enable_structural_diagnosis compiler uncommon true
219
220"If enabled, structural error diagnosis based on matching of equations to
221variables is used."
222
223********************************************************************************
224BOOLEAN automatic_add_initial_equations compiler uncommon true
225
226"If enabled, then additional initial equations are added to the model based
227equation matching. Initial equations are added for states that are not
228matched to an equation."
229
230********************************************************************************
231BOOLEAN compliance_as_warning compiler internal false
232
233"If enabled, then compliance errors are treated as warnings instead. This can
234lead to the compiler or solver crashing. Use with caution!"
235
236********************************************************************************
237BOOLEAN component_names_in_errors compiler user true
238
239"If enabled, the compiler will include the name of the component where the
240error was found, if applicable."
241
242********************************************************************************
243STRING filter_warnings compiler user ""
244
245"A comma separated list of warning identifiers that should be omitted from the
246logs."
247
248********************************************************************************
249BOOLEAN generate_html_diagnostics compiler user false
250
251"If enabled, model diagnostics are generated in HTML format. This includes the
252flattened model, connection sets, alias sets and BLT form."
253
254********************************************************************************
255STRING generate_html_diagnostics_output_directory compiler user "."
256
257"Path to directory where compiler output should be generated for the option
258'generate_html_diagnostics'. Default value is '.'. Directory is created if
259it doesn't exist. The html diagnostics is generated in a subdirectory of this
260directory."
261
262********************************************************************************
263INTEGER diagnostics_limit compiler uncommon 500 0 Integer.MAX_VALUE
264
265"This option specifies the equation system size at which the compiler will
266start to reduce model diagnostics. This option only affects diagnostic output
267that grows faster than linear with the number of equations."
268
269********************************************************************************
270BOOLEAN export_functions compiler uncommon false
271
272"Export used Modelica functions to generated C code in a manner that is
273compatible with the external C interface in the Modelica Language
274Specification."
275
276********************************************************************************
277BOOLEAN export_functions_vba compiler uncommon false
278
279"Create VBA-compatible wrappers for exported functions. Requires the option
280export_functions."
281
282********************************************************************************
283BOOLEAN state_initial_equations compiler user false
284
285"If enabled, the compiler ignores initial equations in the model and adds
286parameters for controlling intitial values of states.Default is false."
287
288********************************************************************************
289STRING inline_functions compiler uncommon "trivial"
290"none" "trivial" "all"
291
292"Controlles what function calls are inlined.
293'none' - no function calls are inlined.
294'trivial' - inline function calls that will not increase the number of
295variables in the system.
296'all' - inline all function calls that are possible."
297
298********************************************************************************
299STRING homotopy_type compiler uncommon "actual"
300"homotopy" "actual" "simplified"
301
302"Decides how homotopy expressions are interpreted during compilation. Can be
303set to either 'simplified' or 'actual' which will compile the model using only
304the simplified or actual expressions of the homotopy() operator."
305
306********************************************************************************
307BOOLEAN debug_csv_step_info compiler debug false
308
309"Debug option, outputs a csv file containing profiling recorded during
310compilation."
311
312********************************************************************************
313BOOLEAN debug_invoke_gc compiler debug false
314
315"Debug option, if enabled, GC will be invoked between the different steps
316during model compilation. This makes it possible to output accurate memory
317measurements."
318
319********************************************************************************
320BOOLEAN debug_duplicate_generated compiler debug false
321
322"Debug option, duplicates any generated files to stdout."
323
324********************************************************************************
325STRING debug_transformation_steps compiler debug "none"
326"none" "diag" "full"
327
328"Options for debugging the different transformation steps. If enabled,
329diagnostics files are written after each transformation step. Allowed values
330are
331'none',
332'diag' (only fixed-size model diagnostics),
333'full' (write diagnostics and flat tree)."
334
335********************************************************************************
336BOOLEAN debug_sanity_check compiler debug false
337
338"If enabled, flat tree will be checked for consistency between transformation
339steps."
340
341********************************************************************************
342BOOLEAN write_iteration_variables_to_file compiler uncommon false
343
344"If enabled, two text files containing one iteration variable name per row is
345written to disk. The files contains the iteration variables for the DAE and the
346DAE initialization system respectively. The files are output to the resource
347directory of the FMU."
348
349********************************************************************************
350BOOLEAN algorithms_as_functions compiler experimental false
351
352"If enabled, convert algorithm sections to function calls."
353
354********************************************************************************
355BOOLEAN write_tearing_pairs_to_file compiler uncommon false
356
357"If enabled, two text files containing tearing pairs is written to disk. The
358files contains the tearing pairs for the DAE and the DAE initialization system
359respectively. The files are output to the working directory."
360
361********************************************************************************
362BOOLEAN check_inactive_contitionals compiler user false
363
364"If enabled, check for errors in inactive conditional components when
365compiling. When using check mode, this is always done."
366
367********************************************************************************
368BOOLEAN ignore_within compiler uncommon false
369
370"If enabled, ignore within clauses both when reading input files and when
371error-checking."
372
373********************************************************************************
374STRING nonlinear_solver compiler user "kinsol"
375"kinsol" "minpack" "realtime"
376
377"Decides which nonlinear equation solver to use. Alternatives are 'kinsol or
378'minpack'."
379
380********************************************************************************
381STRING init_nonlinear_solver compiler user "kinsol"
382"kinsol" "minpack" "realtime"
383
384"Decides which nonlinear equation solver to use in the initial system.
385Alternatives are 'kinsol or 'minpack'."
386
387********************************************************************************
388BOOLEAN generate_event_switches compiler experimental true
389
390"If enabled, event generating expressions generates switches in the c-code.
391Setting this option to false can give unexpected results."
392
393********************************************************************************
394BOOLEAN relational_time_events compiler deprecated true
395
396"Deprecated, use option time_events instead. If enabled, then relational
397operators are allowed to generate time events."
398
399********************************************************************************
400BOOLEAN time_events compiler user true
401
402"If enabled, operators are allowed to generate time events."
403
404********************************************************************************
405BOOLEAN event_output_vars compiler user false
406
407"If enabled, output variables are added to model description for each generated
408state event indicator."
409
410********************************************************************************
411BOOLEAN disable_smooth_events compiler experimental false
412
413"If enabled, no events will be generated for smooth operator if order equals to
414zero."
415
416********************************************************************************
417BOOLEAN enable_block_function_extraction compiler user false
418
419"Looks for function calls in blocks. If a function call in a block doesn't
420depend on the block in question, it is extracted from the block."
421
422********************************************************************************
423STRING function_incidence_computation compiler uncommon "none"
424"none" "all"
425
426"Controls how matching algorithm computes incidences for function call
427equations. Possible values: 'none', 'all'. With 'none' all outputs are assumed
428to depend on all inputs. With 'all' the compiler analyses the function to
429determine dependencies."
430
431********************************************************************************
432INTEGER max_n_proc compiler uncommon 4
433
434"The maximum number of processes used during c-code compilation."
435
436********************************************************************************
437STRING cc_extra_flags_applies_to compiler uncommon "functions"
438"none" "functions" "all"
439
440"Parts of c-code to compile with extra compiler flags specified by
441ccompiler_extra_flags"
442
443********************************************************************************
444STRING cc_extra_flags compiler uncommon ":O1"
445":O1" ":O2"
446
447"Optimization level for c-code compilation"
448
449********************************************************************************
450STRING MODELICAPATH compiler internal ""
451
452"The MODELICAPATH to use during compilation."
453
454********************************************************************************
455STRING compiler_version compiler internal "compiler_version_file_not_read"
456
457"The version string for the compiler. Uses default value during unit testing."
458
459********************************************************************************
460
Note: See TracBrowser for help on using the repository browser.