source: branches/dev-5819/Compiler/ModelicaCompiler/runtime.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: 10.2 KB
Line 
1
2
3********************************************************************************
4*** Runtime options
5********************************************************************************
6*** Note: Two JUnit tests are affected by changes to runtime options:
7*** ModelicaCompiler : TransformCanonicalTests.mo : TestRuntimeOptions1
8*** ModelicaCBackEnd : CCodeGenTests.mo : TestRuntimeOptions1
9***
10********************************************************************************
11INTEGER log_level runtime user 3 0 8
12
13"Log level for the runtime:
140 - none,
151 - fatal error,
162 - error,
173 - warning,
184 - info,
195 - verbose,
206 - debug."
21
22********************************************************************************
23BOOLEAN enforce_bounds runtime user true
24
25"If enabled, min / max bounds on variables are enforced in the equation blocks."
26
27********************************************************************************
28BOOLEAN use_jacobian_equilibration runtime uncommon false
29
30"If enabled, jacobian equilibration will be utilized in the equation block
31solvers to improve linear solver accuracy."
32
33********************************************************************************
34BOOLEAN use_newton_for_brent runtime uncommon true
35
36"If enabled, a few Newton steps are computed to get a better initial guess for
37Brent."
38
39********************************************************************************
40INTEGER iteration_variable_scaling runtime user 1 0 2
41
42"Scaling mode for the iteration variables in the equation block solvers:
430 - no scaling,
441 - scaling based on nominals,
452 - utilize heuristic to guess nominal based on min, max, start, etc."
46
47********************************************************************************
48INTEGER residual_equation_scaling runtime user 1 0 5
49
50"Equations scaling mode in equation block solvers:
510 - no scaling,
521 - automatic scaling,
532 - manual scaling,
543 - hybrid,
554 - aggressive automatic scaling,
565 - automatic rescaling at full Jacobian update"
57
58********************************************************************************
59INTEGER nle_solver_exit_criterion runtime user 3 0 3
60
61"Exit criterion mode:
620 - step length and residual based,
631 - only step length based,
642 - only residual based,
653 - hybrid."
66
67********************************************************************************
68INTEGER nle_jacobian_update_mode runtime user 2 0 2
69
70"Mode for how to update the Jacobian:
710 - full Jacobian,
721 - Broyden update,
732 - Reuse Jacobian."
74
75********************************************************************************
76INTEGER nle_jacobian_calculation_mode runtime user 0 0 9
77
78"Mode for how to calculate the Jacobian:
790 - onesided differences,
801 - central differences,
812 - central differences at bound,
823 - central differences at bound and 0,
834 - central differences in second Newton solve,
845 - central differences at bound in second Newton solve,
856 - central differences at bound and 0 in second Newton solve,
867 - central differences at small residual,
878 - calculate Jacobian externally,
889 - Jacobian compresssion."
89
90********************************************************************************
91REAL nle_jacobian_finite_difference_delta runtime user 1.490116119384766E-8 2.220446049250313e-16 1e-1
92
93"Delta to use when calculating finite difference Jacobians."
94
95********************************************************************************
96INTEGER nle_active_bounds_mode runtime user 0 0 1
97
98"Mode for how to handle active bounds:
990 - project Newton step at active bounds,
1001 - use projected steepest descent direction."
101
102********************************************************************************
103REAL nle_solver_min_residual_scaling_factor runtime user 1.0E-10 1e-32 1
104
105"Minimal scaling factor used by automatic and hybrid residual scaling algorithm."
106
107********************************************************************************
108REAL nle_solver_max_residual_scaling_factor runtime user 1.0E10 1 1e32
109
110"Maximal scaling factor used by automatic and hybrid residual scaling algorithm."
111
112********************************************************************************
113BOOLEAN rescale_each_step runtime user false
114
115"If enabled, scaling will be updated at every step (only active if automatic
116scaling is used)."
117
118********************************************************************************
119BOOLEAN rescale_after_singular_jac runtime user true
120
121"If enabled, scaling will be updated after a singular jacobian was detected
122(only active if automatic scaling is used)."
123
124********************************************************************************
125BOOLEAN use_Brent_in_1d runtime user true
126
127"If enabled, Brent search will be used to improve accuracy in solution of 1D
128non-linear equations."
129
130********************************************************************************
131BOOLEAN block_solver_profiling runtime uncommon false
132
133"If enabled, methods involved in solving an equation block will be timed."
134
135********************************************************************************
136INTEGER block_solver_experimental_mode runtime experimental 0 0 Integer.MAX_VALUE
137
138"Activates experimental features of equation block solvers"
139
140********************************************************************************
141REAL nle_solver_default_tol runtime user 1.0E-10 1e-14 1e-2
142
143"Default tolerance for the equation block solver."
144
145********************************************************************************
146BOOLEAN nle_solver_check_jac_cond runtime uncommon false
147
148"If enabled, the equation block solver computes and log the jacobian condition
149number."
150
151********************************************************************************
152BOOLEAN nle_brent_ignore_error runtime uncommon false
153
154"If enabled, the Brent solver will ignore convergence failures."
155
156********************************************************************************
157REAL nle_solver_min_tol runtime uncommon 1.0E-12 1e-14 1e-6
158
159"Minimum tolerance for the equation block solver. Note that, e.g. default
160Kinsol tolerance is machine precision pwr 1/3, i.e. 1e-6."
161
162********************************************************************************
163REAL nle_solver_tol_factor runtime uncommon 1.0E-4 1e-6 1.0
164
165"Tolerance safety factor for the equation block solver. Used when external
166solver specifies relative tolerance."
167
168********************************************************************************
169INTEGER nle_solver_max_iter runtime uncommon 100 2 500
170
171"Maximum number of iterations for the equation block solver."
172
173********************************************************************************
174INTEGER nle_solver_max_iter_no_jacobian runtime uncommon 10 1 500
175
176"Maximum number of iterations without jacobian update. Value 1 means an update
177in every iteration."
178
179********************************************************************************
180REAL nle_solver_step_limit_factor runtime uncommon 10.0 0 1e10
181
182"Factor limiting the step-size taken by the nonlinear block solver."
183
184********************************************************************************
185REAL nle_solver_regularization_tolerance runtime uncommon -1.0 -1 1e20
186
187"Tolerance for deciding when regularization should be activated (i.e. when
188condition number > reg tol)."
189
190********************************************************************************
191BOOLEAN nle_solver_use_nominals_as_fallback runtime uncommon true
192
193"If enabled, the nominal values will be used as initial guess to the solver if
194initialization failed."
195
196********************************************************************************
197BOOLEAN nle_solver_use_last_integrator_step runtime uncommon true
198
199"If enabled, the initial guess for the iteration variables will be set to the
200iteration variables from the last integrator step."
201
202********************************************************************************
203REAL events_default_tol runtime uncommon 1.0E-10 1e-14 1e-2
204
205"Default tolerance for the event iterations."
206
207********************************************************************************
208REAL time_events_default_tol runtime uncommon 2.220446049250313E-14 0 1.0
209
210"Default tolerance for the time event iterations."
211
212********************************************************************************
213REAL events_tol_factor runtime uncommon 1.0E-4 1e-6 1.0
214
215"Tolerance safety factor for the event indicators. Used when external solver
216specifies relative tolerance."
217
218********************************************************************************
219BOOLEAN block_jacobian_check runtime debug false
220
221"Compares the analytic block jacobians with the finite difference block
222jacobians during block evaluation. An error is given if the relative error is
223too big."
224
225********************************************************************************
226REAL block_jacobian_check_tol runtime debug 1.0E-6 1e-12 1.0
227
228"Specifies the relative tolerance for block jacobian check."
229
230********************************************************************************
231INTEGER cs_solver runtime user 0 0 1
232
233"Specifies the internal solver used in Co-Simulation.
2340 - CVode,
2351 - Euler."
236
237********************************************************************************
238REAL cs_rel_tol runtime user 1.0E-6 1e-14 1.0
239
240"Tolerance for the adaptive solvers in the Co-Simulation case."
241
242********************************************************************************
243REAL cs_step_size runtime user 0.001
244
245"Step-size for the fixed-step solvers in the Co-Simulation case."
246
247********************************************************************************
248INTEGER cs_experimental_mode runtime experimental 0 0 Integer.MAX_VALUE
249
250"Activates experimental features of CS ode solvers"
251
252********************************************************************************
253BOOLEAN runtime_log_to_file runtime user false
254
255"If enabled, log messages from the runtime are written directly to a file,
256besides passing it through the FMU interface. The log file name is generated
257based on the FMU name."
258
259********************************************************************************
260
Note: See TracBrowser for help on using the repository browser.