idas_interface_meta.cpp
1 /*
2  * This file is part of CasADi.
3  *
4  * CasADi -- A symbolic framework for dynamic optimization.
5  * Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
6  * KU Leuven. All rights reserved.
7  * Copyright (C) 2011-2014 Greg Horn
8  *
9  * CasADi is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 3 of the License, or (at your option) any later version.
13  *
14  * CasADi is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with CasADi; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  *
23  */
24 
25 
26  #include "idas_interface.hpp"
27  #include <string>
28 
29  const std::string casadi::IdasInterface::meta_doc=
30  "\n"
31 "\n"
32 "\n"
33 "Interface to IDAS from the Sundials suite.\n"
34 "\n"
35 "Extra doc: https://github.com/casadi/casadi/wiki/L_225 \n"
36 "\n"
37 "\n"
38 ">List of available options\n"
39 "\n"
40 "+---------------------------+-----------------+----------------------------+\n"
41 "| Id | Type | Description |\n"
42 "+===========================+=================+============================+\n"
43 "| abstol | OT_DOUBLE | Absolute tolerence for the |\n"
44 "| | | IVP solution |\n"
45 "+---------------------------+-----------------+----------------------------+\n"
46 "| abstolv | OT_DOUBLEVECTOR | Absolute tolerarance for |\n"
47 "| | | each component |\n"
48 "+---------------------------+-----------------+----------------------------+\n"
49 "| calc_ic | OT_BOOL | Use IDACalcIC to get |\n"
50 "| | | consistent initial |\n"
51 "| | | conditions. |\n"
52 "+---------------------------+-----------------+----------------------------+\n"
53 "| calc_icB | OT_BOOL | Use IDACalcIC to get |\n"
54 "| | | consistent initial |\n"
55 "| | | conditions for backwards |\n"
56 "| | | system [default: equal to |\n"
57 "| | | calc_ic]. |\n"
58 "+---------------------------+-----------------+----------------------------+\n"
59 "| cj_scaling | OT_BOOL | IDAS scaling on cj for the |\n"
60 "| | | user-defined linear solver |\n"
61 "| | | module |\n"
62 "+---------------------------+-----------------+----------------------------+\n"
63 "| constraints | OT_INTVECTOR | Constrain the solution |\n"
64 "| | | y=[x,z]. 0 (default): no |\n"
65 "| | | constraint on yi, 1: yi >= |\n"
66 "| | | 0.0, -1: yi <= 0.0, 2: yi |\n"
67 "| | | > 0.0, -2: yi < 0.0. |\n"
68 "+---------------------------+-----------------+----------------------------+\n"
69 "| disable_internal_warnings | OT_BOOL | Disable SUNDIALS internal |\n"
70 "| | | warning messages |\n"
71 "+---------------------------+-----------------+----------------------------+\n"
72 "| first_time | OT_DOUBLE | First requested time as a |\n"
73 "| | | fraction of the time |\n"
74 "| | | interval |\n"
75 "+---------------------------+-----------------+----------------------------+\n"
76 "| fsens_err_con | OT_BOOL | include the forward |\n"
77 "| | | sensitivities in all error |\n"
78 "| | | controls |\n"
79 "+---------------------------+-----------------+----------------------------+\n"
80 "| init_xdot | OT_DOUBLEVECTOR | Initial values for the |\n"
81 "| | | state derivatives |\n"
82 "+---------------------------+-----------------+----------------------------+\n"
83 "| interpolation_type | OT_STRING | Type of interpolation for |\n"
84 "| | | the adjoint sensitivities |\n"
85 "+---------------------------+-----------------+----------------------------+\n"
86 "| linear_solver | OT_STRING | A custom linear solver |\n"
87 "| | | creator function [default: |\n"
88 "| | | qr] |\n"
89 "+---------------------------+-----------------+----------------------------+\n"
90 "| linear_solver_options | OT_DICT | Options to be passed to |\n"
91 "| | | the linear solver |\n"
92 "+---------------------------+-----------------+----------------------------+\n"
93 "| max_krylov | OT_INT | Maximum Krylov subspace |\n"
94 "| | | size |\n"
95 "+---------------------------+-----------------+----------------------------+\n"
96 "| max_multistep_order | OT_INT | Maximum order for the |\n"
97 "| | | (variable-order) multistep |\n"
98 "| | | method |\n"
99 "+---------------------------+-----------------+----------------------------+\n"
100 "| max_num_steps | OT_INT | Maximum number of |\n"
101 "| | | integrator steps |\n"
102 "+---------------------------+-----------------+----------------------------+\n"
103 "| max_order | OT_DOUBLE | Maximum order |\n"
104 "+---------------------------+-----------------+----------------------------+\n"
105 "| max_step_size | OT_DOUBLE | Maximim step size |\n"
106 "+---------------------------+-----------------+----------------------------+\n"
107 "| newton_scheme | OT_STRING | Linear solver scheme in |\n"
108 "| | | the Newton method: |\n"
109 "| | | DIRECT|gmres|bcgstab|tfqmr |\n"
110 "+---------------------------+-----------------+----------------------------+\n"
111 "| nonlin_conv_coeff | OT_DOUBLE | Coefficient in the |\n"
112 "| | | nonlinear convergence test |\n"
113 "+---------------------------+-----------------+----------------------------+\n"
114 "| quad_err_con | OT_BOOL | Should the quadratures |\n"
115 "| | | affect the step size |\n"
116 "| | | control |\n"
117 "+---------------------------+-----------------+----------------------------+\n"
118 "| reltol | OT_DOUBLE | Relative tolerence for the |\n"
119 "| | | IVP solution |\n"
120 "+---------------------------+-----------------+----------------------------+\n"
121 "| scale_abstol | OT_BOOL | Scale absolute tolerance |\n"
122 "| | | by nominal value |\n"
123 "+---------------------------+-----------------+----------------------------+\n"
124 "| second_order_correction | OT_BOOL | Second order correction in |\n"
125 "| | | the augmented system |\n"
126 "| | | Jacobian [true] |\n"
127 "+---------------------------+-----------------+----------------------------+\n"
128 "| sensitivity_method | OT_STRING | Sensitivity method: |\n"
129 "| | | SIMULTANEOUS|staggered |\n"
130 "+---------------------------+-----------------+----------------------------+\n"
131 "| step0 | OT_DOUBLE | initial step size |\n"
132 "| | | [default: 0/estimated] |\n"
133 "+---------------------------+-----------------+----------------------------+\n"
134 "| steps_per_checkpoint | OT_INT | Number of steps between |\n"
135 "| | | two consecutive |\n"
136 "| | | checkpoints |\n"
137 "+---------------------------+-----------------+----------------------------+\n"
138 "| stop_at_end | OT_BOOL | [DEPRECATED] Stop the |\n"
139 "| | | integrator at the end of |\n"
140 "| | | the interval |\n"
141 "+---------------------------+-----------------+----------------------------+\n"
142 "| suppress_algebraic | OT_BOOL | Suppress algebraic |\n"
143 "| | | variables in the error |\n"
144 "| | | testing |\n"
145 "+---------------------------+-----------------+----------------------------+\n"
146 "| use_preconditioner | OT_BOOL | Precondition the iterative |\n"
147 "| | | solver [default: true] |\n"
148 "+---------------------------+-----------------+----------------------------+\n"
149 "\n"
150 "\n"
151 "\n"
152 "\n"
153 ;
casadi::IdasInterface::meta_doc
static const std::string meta_doc
A documentation string.
Definition: idas_interface.hpp:157