Commit d8e01f72 authored by Lukas Riedel's avatar Lukas Riedel

Reorder NewtonParameters by importance and improve their descriptions

parent 52c8597c
......@@ -277,6 +277,31 @@ adding an empty line, make text **bold** or ``monospaced``.
</category>
<category name="NewtonParameters">
<parameter name="ForceIteration" hidden="true">
<definition> Force the Newton solver to calculate at least one iteration,
even if the initial defect is below ``AbsoluteLimit``. This ensures
that dynamics cannot be 'skipped' at very small time steps.
</definition>
<values> true, false </values>
<suggestion> false </suggestion>
</parameter>
<parameter name="AbsoluteLimit" hidden="true">
<definition> Absolute error tolerance of the Newton solver.
Reduce this value to increase precision.
</definition>
<values> 1E-11 &lt; float &lt; 1E-8 </values>
<suggestion> 1E-10 </suggestion>
</parameter>
<parameter name="Reduction" hidden="true">
<definition> Relative error tolerance of the Newton solver.
Reduce this value to increase precision.
</definition>
<values> float </values>
<suggestion> 1E-4 </suggestion>
</parameter>
<parameter name="ReassembleThreshold" hidden="true">
<definition> If the ratio between last and current calculation defect exceeds this value,
the linear operator matrix is reassembled to ensure convergence. </definition>
......@@ -291,18 +316,6 @@ adding an empty line, make text **bold** or ``monospaced``.
<suggestion> 10 </suggestion>
</parameter>
<parameter name="AbsoluteLimit" hidden="true">
<definition> Absolute error tolerance of the Newton solver. </definition>
<values> float </values>
<suggestion> 1E-10 </suggestion>
</parameter>
<parameter name="Reduction" hidden="true">
<definition> Relative error tolerance of the Newton solver. </definition>
<values> float </values>
<suggestion> 1E-4 </suggestion>
</parameter>
<parameter name="MinLinearReduction" hidden="true">
<definition> Required defect reduction of the linear solver. The Newton solver calculates
the required linear reduction for second order Newton convergence automatically and
......@@ -310,15 +323,6 @@ adding an empty line, make text **bold** or ``monospaced``.
<values> float </values>
<suggestion> 1E-3 </suggestion>
</parameter>
<parameter name="ForceIteration" hidden="true">
<definition> Force the Newton solver to calculate at least one iteration,
even if the initial defect is below ``AbsoluteLimit``. This ensures
that dynamics cannot be 'skipped' at very small time steps.
</definition>
<values> true, false </values>
<suggestion> false </suggestion>
</parameter>
</category>
<category name="adaptivity">
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment