Skip to content

Commit

Permalink
sync options docu in docu to options docu in code
Browse files Browse the repository at this point in the history
  • Loading branch information
svigerske committed Jun 23, 2022
1 parent 2ba311b commit 4f7ac2d
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions doc/options.dox
Original file line number Diff line number Diff line change
Expand Up @@ -1521,31 +1521,31 @@ Possible values: yes, no
\anchor OPT_ma27_pivtol
<strong>ma27_pivtol</strong>: Pivot tolerance for the linear solver MA27.
<blockquote>
A smaller number pivots for sparsity, a larger number pivots for stability. This option is only available if Ipopt has been compiled with MA27. The valid range for this real option is 0 < ma27_pivtol < 1 and its default value is 10<sup>-08</sup>.
A smaller number pivots for sparsity, a larger number pivots for stability. The valid range for this real option is 0 < ma27_pivtol < 1 and its default value is 10<sup>-08</sup>.
</blockquote>

\anchor OPT_ma27_pivtolmax
<strong>ma27_pivtolmax</strong>: Maximum pivot tolerance for the linear solver MA27.
<blockquote>
Ipopt may increase pivtol as high as pivtolmax to get a more accurate solution to the linear system. This option is only available if Ipopt has been compiled with MA27. The valid range for this real option is 0 < ma27_pivtolmax < 1 and its default value is 0.0001.
Ipopt may increase pivtol as high as ma27_pivtolmax to get a more accurate solution to the linear system. The valid range for this real option is 0 < ma27_pivtolmax < 1 and its default value is 0.0001.
</blockquote>

\anchor OPT_ma27_liw_init_factor
<strong>ma27_liw_init_factor</strong>: Integer workspace memory for MA27.
<blockquote>
The initial integer workspace memory = liw_init_factor * memory required by unfactored system. Ipopt will increase the workspace size by meminc_factor if required. This option is only available if Ipopt has been compiled with MA27. The valid range for this real option is 1 &le; ma27_liw_init_factor and its default value is 5.
The initial integer workspace memory = liw_init_factor * memory required by unfactored system. Ipopt will increase the workspace size by ma27_meminc_factor if required. The valid range for this real option is 1 &le; ma27_liw_init_factor and its default value is 5.
</blockquote>

\anchor OPT_ma27_la_init_factor
<strong>ma27_la_init_factor</strong>: Real workspace memory for MA27.
<blockquote>
The initial real workspace memory = la_init_factor * memory required by unfactored system. Ipopt will increase the workspace size by meminc_factor if required. This option is only available if Ipopt has been compiled with MA27. The valid range for this real option is 1 &le; ma27_la_init_factor and its default value is 5.
The initial real workspace memory = la_init_factor * memory required by unfactored system. Ipopt will increase the workspace size by ma27_meminc_factor if required. The valid range for this real option is 1 &le; ma27_la_init_factor and its default value is 5.
</blockquote>

\anchor OPT_ma27_meminc_factor
<strong>ma27_meminc_factor</strong>: Increment factor for workspace size for MA27.
<blockquote>
If the integer or real workspace is not large enough, Ipopt will increase its size by this factor. This option is only available if Ipopt has been compiled with MA27. The valid range for this real option is 1 &le; ma27_meminc_factor and its default value is 2.
If the integer or real workspace is not large enough, Ipopt will increase its size by this factor. The valid range for this real option is 1 &le; ma27_meminc_factor and its default value is 2.
</blockquote>

\anchor OPT_ma27_skip_inertia_check
Expand All @@ -1570,19 +1570,19 @@ Possible values: yes, no
\anchor OPT_ma57_pivtol
<strong>ma57_pivtol</strong>: Pivot tolerance for the linear solver MA57.
<blockquote>
A smaller number pivots for sparsity, a larger number pivots for stability. This option is only available if Ipopt has been compiled with MA57. The valid range for this real option is 0 < ma57_pivtol < 1 and its default value is 10<sup>-08</sup>.
A smaller number pivots for sparsity, a larger number pivots for stability. The valid range for this real option is 0 < ma57_pivtol < 1 and its default value is 10<sup>-08</sup>.
</blockquote>

\anchor OPT_ma57_pivtolmax
<strong>ma57_pivtolmax</strong>: Maximum pivot tolerance for the linear solver MA57.
<blockquote>
Ipopt may increase pivtol as high as ma57_pivtolmax to get a more accurate solution to the linear system. This option is only available if Ipopt has been compiled with MA57. The valid range for this real option is 0 < ma57_pivtolmax < 1 and its default value is 0.0001.
Ipopt may increase pivtol as high as ma57_pivtolmax to get a more accurate solution to the linear system. The valid range for this real option is 0 < ma57_pivtolmax < 1 and its default value is 0.0001.
</blockquote>

\anchor OPT_ma57_pre_alloc
<strong>ma57_pre_alloc</strong>: Safety factor for work space memory allocation for the linear solver MA57.
<blockquote>
If 1 is chosen, the suggested amount of work space is used. However, choosing a larger number might avoid reallocation if the suggest values do not suffice. This option is only available if Ipopt has been compiled with MA57. The valid range for this real option is 1 &le; ma57_pre_alloc and its default value is 1.05.
If 1 is chosen, the suggested amount of work space is used. However, choosing a larger number might avoid reallocation if the suggest values do not suffice. The valid range for this real option is 1 &le; ma57_pre_alloc and its default value is 1.05.
</blockquote>

\anchor OPT_ma57_pivot_order
Expand Down

0 comments on commit 4f7ac2d

Please sign in to comment.