OptionOverview.md

[ This file was auto-generated from the module's documentation included in the doc-strings. Use julia's help system to get these informations in a nicer output format. ]

The opt Argument: the Options

All options are handled by OptionsODE. See OptionsODE how to query, set and change options.

There are the following classes of options.

1. Options for this ODEInterface (common for all solvers)
2. Options for the ODE solvers

Options of this ODEInterface

• OPT_RHS_CALLMODE: There are two possible ways to call the Julia right-hand side: RHS_CALL_RETURNS_ARRAY and RHS_CALL_INSITU, see help_callsolvers for an explanation. difference.

• OPT_LOGIO: This option sets the IO that is used for logging messages

• OPT_LOGLEVEL: This is a bitmask for activating different logging messages. The following bitmasks are available.

     LOG_NOTHING     log nothing
     LOG_GENERAL     log some general information,
                     especially the main julia call of the solver
     LOG_RHS         log all calls of the right-hand side
     LOG_SOLVERARGS  log the arguments for the C-/Fortran-calls
                     before and after the call
     LOG_OUTPUTFCN   log calls of the julia output function
     LOG_SOLOUT      log calls of the solution output routine
     LOG_EVALSOL     log calls of the eval_sol_fcn
     LOG_MASS        log call(s) of the mass function
     LOG_JAC         log calls of the jacobian function of RHS
     LOG_BC          log calls of the boundary condition function
     LOG_BVPIVPSOL   log (during boundary value problems) calls to
                     initial value solvers
     LOG_RHSDT       log calls of the right-hand side time-derivative
     LOG_JACBC       log calls of the jacobian of the boundary condition
     LOG_GUESS       log calls to the guess function
     LOG_ALL         all of the above
  

Options for the solvers

Different solvers support different options. All the options a solver supports are listed in the help-command of the specific solver, e.g. help_dopri5.

To get an overview, what options are supported by what solvers, call ODEInterface.help_options().

Solvers

1. bvpm2
2. bvpsol
3. colnew
4. ddeabm
5. ddebdf
6. dop853
7. dopri5
8. odex
9. radau
10. radau5
11. rodas
12. seulex

Options used by Solvers

Option	1	2	3	4	5	6	7	8	9	10	11	12
OPT_ADDGRIDPOINTS			✔
OPT_ATOL				✔	✔	✔	✔	✔	✔	✔	✔	✔
OPT_BVPCLASS		✔	✔
OPT_COARSEGUESSGRID			✔
OPT_COLLOCATIONPTS			✔
OPT_DENSEOUTPUTWOEE								✔
OPT_DIAGNOSTICOUTPUT	✔		✔
OPT_DIMOFIND1VAR									✔	✔
OPT_DIMOFIND2VAR									✔	✔
OPT_DIMOFIND3VAR									✔	✔
OPT_EPS						✔	✔	✔			✔	✔
OPT_ERRORCONTROL	✔
OPT_FREEZEINTERVALS			✔
OPT_FREEZESSLEFT									✔	✔
OPT_FREEZESSRIGHT									✔	✔
OPT_INITIALSS						✔	✔	✔	✔	✔	✔	✔
OPT_INITSTAGES									✔
OPT_INTERPOLDEGREE								✔
OPT_IVPOPT		✔
OPT_JACOBIBANDSTRUCT					✔				✔	✔	✔	✔
OPT_JACOBIMATRIX					✔				✔	✔	✔	✔
OPT_JACRECOMPFACTOR									✔	✔		✔
OPT_LAMBDADENSE												✔
OPT_M1									✔	✔	✔	✔
OPT_M2									✔	✔	✔	✔
OPT_MASSMATRIX									✔	✔	✔	✔
OPT_MAXEXCOLUMN								✔				✔
OPT_MAXNEWTONITER									✔	✔
OPT_MAXS								✔
OPT_MAXSS						✔	✔				✔	✔
OPT_MAXSTABCHECKLINE								✔
OPT_MAXSTABCHECKS								✔
OPT_MAXSTAGES									✔
OPT_MAXSTEPS		✔		✔	✔	✔	✔	✔	✔	✔	✔	✔
OPT_MAXSUBINTERVALS			✔
OPT_METHODCHOICE	✔										✔
OPT_MINSTAGES									✔
OPT_NEWTONSTARTZERO									✔	✔
OPT_NEWTONSTOPCRIT									✔	✔
OPT_ORDERDECFACTOR									✔
OPT_ORDERDECFRAC								✔				✔
OPT_ORDERDECSTEPFAC1									✔
OPT_ORDERDECSTEPFAC2									✔
OPT_ORDERINCFACTOR									✔
OPT_ORDERINCFRAC								✔				✔
OPT_OUTPUTATTIMES				✔	✔
OPT_OUTPUTFCN				✔	✔	✔	✔	✔	✔	✔	✔	✔
OPT_OUTPUTMODE				✔	✔	✔	✔	✔	✔	✔	✔	✔
OPT_RHO						✔	✔	✔	✔	✔	✔	✔
OPT_RHO2								✔				✔
OPT_RHSAUTONOMOUS											✔	✔
OPT_RHSTIMEDERIV											✔
OPT_RHS_CALLMODE		✔		✔	✔
OPT_RTOL	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔	✔
OPT_SINGULARTERM	✔
OPT_SOLMETHOD		✔
OPT_SSBETA						✔	✔
OPT_SSMAXSEL						✔	✔		✔	✔	✔
OPT_SSMINSEL						✔	✔		✔	✔	✔
OPT_SSREDUCTION								✔
OPT_SSSELECTPAR1								✔				✔
OPT_SSSELECTPAR2								✔				✔
OPT_STEPSIZESEQUENCE								✔				✔
OPT_STEPSIZESTRATEGY									✔	✔	✔
OPT_STEST						✔	✔
OPT_SUBINTERVALS			✔
OPT_TRANSJTOH									✔	✔		✔
OPT_TSTOP				✔	✔
OPT_WORKFORDEC												✔
OPT_WORKFORJAC												✔
OPT_WORKFORRHS												✔
OPT_WORKFORSOL												✔