MeanField_SERiF/docs/xml/solver_2nonlinear_2options_8hpp.xml

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.13.2" xml:lang="en-US">
  <compounddef id="solver_2nonlinear_2options_8hpp" kind="file" language="C++">
    <compoundname>options.hpp</compoundname>
    <includes local="no">cmath</includes>
    <includes local="no">span</includes>
    <includes local="no">optional</includes>
    <includes local="no">string</includes>
    <includes local="no">tuple</includes>
    <includes local="no">utility</includes>
    <includes refid="linear_8hpp" local="yes">serif/solver/linear/linear.hpp</includes>
    <includedby refid="geometry_8hpp" local="yes">src/include/serif/backend/mfem/solver/admissibility/geometry.hpp</includedby>
    <includedby refid="stellar__problem_8hpp" local="yes">src/include/serif/backend/mfem/solver/nonlinear/stellar_problem.hpp</includedby>
    <includedby refid="solver_2nonlinear_2result_8hpp" local="yes">src/include/serif/solver/nonlinear/result.hpp</includedby>
    <includedby refid="numerics_8hpp" local="yes">src/include/serif/utils/serialize/numerics.hpp</includedby>
    <includedby refid="options_8cpp" local="yes">src/lib/serif/solver/nonlinear/options.cpp</includedby>
    <incdepgraph>
      <node id="8">
        <label>serif/solver/linear/linear.hpp</label>
        <link refid="linear_8hpp"/>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/solver/nonlinear/options.hpp</label>
        <link refid="solver_2nonlinear_2options_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>cmath</label>
      </node>
      <node id="9">
        <label>cstdint</label>
      </node>
      <node id="4">
        <label>optional</label>
      </node>
      <node id="3">
        <label>span</label>
      </node>
      <node id="5">
        <label>string</label>
      </node>
      <node id="6">
        <label>tuple</label>
      </node>
      <node id="7">
        <label>utility</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="12">
        <label>src/compile_time_checks/serif/backend_independent.cpp</label>
        <link refid="backend__independent_8cpp"/>
      </node>
      <node id="9">
        <label>src/compile_time_checks/serif/solver/public_contracts.cpp</label>
        <link refid="public__contracts_8cpp"/>
      </node>
      <node id="18">
        <label>src/include/serif/backend/mfem/serialize/configuration.hpp</label>
        <link refid="backend_2mfem_2serialize_2configuration_8hpp"/>
      </node>
      <node id="19">
        <label>src/include/serif/backend/mfem/serialize/options.hpp</label>
        <link refid="backend_2mfem_2serialize_2options_8hpp"/>
      </node>
      <node id="2">
        <label>src/include/serif/backend/mfem/solver/admissibility/geometry.hpp</label>
        <link refid="geometry_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>src/include/serif/backend/mfem/solver/equilibrium.hpp</label>
        <link refid="backend_2mfem_2solver_2equilibrium_8hpp"/>
        <childnode refid="5" relation="include">
        </childnode>
      </node>
      <node id="3">
        <label>src/include/serif/backend/mfem/solver/nonlinear/stellar_problem.hpp</label>
        <link refid="stellar__problem_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>src/include/serif/solver/continuation/equilibrium.hpp</label>
        <link refid="solver_2continuation_2equilibrium_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="5">
        <label>src/include/serif/solver/equilibrium.hpp</label>
        <link refid="solver_2equilibrium_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="11">
        <label>src/include/serif/solver/nonlinear/newton.hpp</label>
        <link refid="newton_8hpp"/>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
      </node>
      <node id="10">
        <label>src/include/serif/solver/nonlinear/observers.hpp</label>
        <link refid="solver_2nonlinear_2observers_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/solver/nonlinear/options.hpp</label>
        <link refid="solver_2nonlinear_2options_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
      </node>
      <node id="13">
        <label>src/include/serif/solver/nonlinear/qualification.hpp</label>
        <link refid="qualification_8hpp"/>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>src/include/serif/solver/nonlinear/result.hpp</label>
        <link refid="solver_2nonlinear_2result_8hpp"/>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
      </node>
      <node id="14">
        <label>src/include/serif/solver/nonlinear/steps.hpp</label>
        <link refid="steps_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="7">
        <label>src/include/serif/solver/solver.hpp</label>
        <link refid="solver_2solver_8hpp"/>
      </node>
      <node id="17">
        <label>src/include/serif/utils/serialize/numerics.hpp</label>
        <link refid="numerics_8hpp"/>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
      </node>
      <node id="16">
        <label>src/include/serif/utils/serialize/serialize.hpp</label>
        <link refid="serialize_8hpp"/>
        <childnode refid="12" relation="include">
        </childnode>
      </node>
      <node id="15">
        <label>src/include/serif/utils/serialize/solver.hpp</label>
        <link refid="utils_2serialize_2solver_8hpp"/>
        <childnode refid="16" relation="include">
        </childnode>
      </node>
      <node id="20">
        <label>src/lib/serif/solver/nonlinear/options.cpp</label>
        <link refid="options_8cpp"/>
      </node>
    </invincdepgraph>
    <innerclass refid="structserif_1_1solver_1_1_newton" prot="public">serif::solver::Newton</innerclass>
    <innerclass refid="structserif_1_1solver_1_1_backtracking" prot="public">serif::solver::Backtracking</innerclass>
    <innerclass refid="structserif_1_1solver_1_1_metric_evaluation" prot="public">serif::solver::MetricEvaluation</innerclass>
    <innerclass refid="structserif_1_1solver_1_1_normalized_residual_metric" prot="public">serif::solver::NormalizedResidualMetric</innerclass>
    <innerclass refid="structserif_1_1solver_1_1_direction_assessment" prot="public">serif::solver::DirectionAssessment</innerclass>
    <innerclass refid="structserif_1_1solver_1_1_trial_assessment" prot="public">serif::solver::TrialAssessment</innerclass>
    <innerclass refid="structserif_1_1solver_1_1_standard_newton" prot="public">serif::solver::StandardNewton</innerclass>
    <innerclass refid="structserif_1_1solver_1_1_solver_options" prot="public">serif::solver::SolverOptions</innerclass>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver">serif::solver</innernamespace>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <programlisting>
<codeline lineno="1"><highlight class="preprocessor">#pragma<sp/>once</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="2"><highlight class="normal"></highlight></codeline>
<codeline lineno="3"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;cmath&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;span&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;optional&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;string&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;tuple&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="8"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;utility&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="9"><highlight class="normal"></highlight></codeline>
<codeline lineno="10"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="linear_8hpp" kindref="compound">serif/solver/linear/linear.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="11"><highlight class="normal"></highlight></codeline>
<codeline lineno="12"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1solver" kindref="compound">serif::solver</ref><sp/>{</highlight></codeline>
<codeline lineno="14" refid="structserif_1_1solver_1_1_newton" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_newton" kindref="compound">Newton</ref><sp/>{</highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_newton_1a0f0f39dd50491d41a52256f9f6d7a397" kindref="member">relative_tolerance</ref>{1.0e-8};</highlight></codeline>
<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_newton_1ad898cfc3de115a418fc6782e31bb53fa" kindref="member">absolute_tolerance</ref>{0.0};</highlight></codeline>
<codeline lineno="17"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_newton_1a673a168331c73603a181f66f23487759" kindref="member">maximum_iterations</ref>{50};</highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>Inexact<sp/>Newton<sp/>needs<sp/>a<sp/>reliable<sp/>direction,<sp/>not<sp/>an<sp/>over-solved<sp/>early<sp/>correction.</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1linear_1_1_control" kindref="compound">linear::Control</ref><sp/><ref refid="structserif_1_1solver_1_1_newton_1ad7ad5d765234464e957ba660aa0253ff" kindref="member">linear_solve</ref>{.relative_tolerance<sp/>=<sp/>0.03,<sp/>.maximum_iterations<sp/>=<sp/>200};</highlight></codeline>
<codeline lineno="20"><highlight class="normal"></highlight></codeline>
<codeline lineno="22"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_newton_1a4123b39d2ef3dfdd9e5ca8d8fef43892" kindref="member">validate</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_newton_1a3b45548b6d188740685d4c38c4c1feda" kindref="member">convergence_threshold</ref>(</highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>initial_norm)<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="26"><highlight class="normal"></highlight></codeline>
<codeline lineno="28" refid="structserif_1_1solver_1_1_backtracking" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_backtracking" kindref="compound">Backtracking</ref><sp/>{</highlight></codeline>
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_backtracking_1aebcf24ae783fc9ff3ad60d99a2ec6c66" kindref="member">initial_step</ref>{1.0};</highlight></codeline>
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_backtracking_1a7911ba8308c60432c6de212dfd695e8f" kindref="member">contraction</ref>{0.5};</highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_backtracking_1a367c1a51e0b8d12774708d13c9094a8a" kindref="member">fraction_to_boundary</ref>{0.9};</highlight></codeline>
<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_backtracking_1abf45ecd4ec4a59442d45bca50a8d10ef" kindref="member">sufficient_decrease</ref>{1.0e-4};</highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_backtracking_1a53406b3dd0cdd6e269f8e7269ec02d03" kindref="member">minimum_step</ref>{1.0e-8};</highlight></codeline>
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_backtracking_1aeaad4d74cf2435b028349a8fee1d2710" kindref="member">maximum_trials</ref>{20};</highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_backtracking_1aa74244d42ad42a75376e4d647c983d93" kindref="member">geometry_preflight</ref>{</highlight><highlight class="keyword">true</highlight><highlight class="normal">};</highlight></codeline>
<codeline lineno="36"><highlight class="normal"></highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_backtracking_1abf0928f3cb06fbb4b5449d795b0d49f0" kindref="member">validate</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="40"><highlight class="normal"></highlight></codeline>
<codeline lineno="42" refid="structserif_1_1solver_1_1_metric_evaluation" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_metric_evaluation" kindref="compound">MetricEvaluation</ref><sp/>{</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_metric_evaluation_1a9ee79bf7923368d43f98567ba369aa36" kindref="member">residual_norm</ref>{0.0};</highlight></codeline>
<codeline lineno="44"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_metric_evaluation_1a0adc88f53770cc86150c7e741dbdd2b1" kindref="member">merit</ref>{0.0};</highlight></codeline>
<codeline lineno="45"><highlight class="normal"></highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_metric_evaluation_1a7932e18162f4079df5294b322346e71a" kindref="member">valid</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{</highlight></codeline>
<codeline lineno="48"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>std::isfinite(<ref refid="structserif_1_1solver_1_1_metric_evaluation_1a9ee79bf7923368d43f98567ba369aa36" kindref="member">residual_norm</ref>)<sp/>&amp;&amp;<sp/><ref refid="structserif_1_1solver_1_1_metric_evaluation_1a9ee79bf7923368d43f98567ba369aa36" kindref="member">residual_norm</ref><sp/>&gt;=<sp/>0.0<sp/>&amp;&amp;<sp/>std::isfinite(<ref refid="structserif_1_1solver_1_1_metric_evaluation_1a0adc88f53770cc86150c7e741dbdd2b1" kindref="member">merit</ref>)<sp/>&amp;&amp;<sp/><ref refid="structserif_1_1solver_1_1_metric_evaluation_1a0adc88f53770cc86150c7e741dbdd2b1" kindref="member">merit</ref><sp/>&gt;=<sp/>0.0;</highlight></codeline>
<codeline lineno="49"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="50"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="51"><highlight class="normal"></highlight></codeline>
<codeline lineno="53" refid="structserif_1_1solver_1_1_normalized_residual_metric" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_normalized_residual_metric" kindref="compound">NormalizedResidualMetric</ref><sp/>{</highlight></codeline>
<codeline lineno="55"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="structserif_1_1solver_1_1_metric_evaluation" kindref="compound">MetricEvaluation</ref><sp/><ref refid="structserif_1_1solver_1_1_normalized_residual_metric_1a66b41c0e236869b0c75af344de15b101" kindref="member">operator()</ref>(std::span&lt;const<sp/>double&gt;<sp/>residual)<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="56"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="57"><highlight class="normal"></highlight></codeline>
<codeline lineno="59" refid="structserif_1_1solver_1_1_direction_assessment" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_direction_assessment" kindref="compound">DirectionAssessment</ref><sp/>{</highlight></codeline>
<codeline lineno="60"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_direction_assessment_1acf75c61a8cde439d5ed8678636a86bde" kindref="member">usable</ref>{</highlight><highlight class="keyword">true</highlight><highlight class="normal">};</highlight></codeline>
<codeline lineno="61"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::optional&lt;double&gt;<sp/><ref refid="structserif_1_1solver_1_1_direction_assessment_1aae8268bd5ae4e15356ee9684e07544b6" kindref="member">merit_slope</ref>;</highlight></codeline>
<codeline lineno="62"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::string<sp/><ref refid="structserif_1_1solver_1_1_direction_assessment_1a3cbc4e9119451f2216a9de65a876a9a0" kindref="member">message</ref>;</highlight></codeline>
<codeline lineno="63"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="64"><highlight class="normal"></highlight></codeline>
<codeline lineno="66" refid="structserif_1_1solver_1_1_trial_assessment" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_trial_assessment" kindref="compound">TrialAssessment</ref><sp/>{</highlight></codeline>
<codeline lineno="67"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_trial_assessment_1a0f7c68b81fabb7f3ded11e99b9e7d6e8" kindref="member">usable</ref>{</highlight><highlight class="keyword">true</highlight><highlight class="normal">};</highlight></codeline>
<codeline lineno="68"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::string<sp/><ref refid="structserif_1_1solver_1_1_trial_assessment_1a687be5c3c49189ed61b6510a2275e3fa" kindref="member">message</ref>;</highlight></codeline>
<codeline lineno="69"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="70"><highlight class="normal"></highlight></codeline>
<codeline lineno="71"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_solve_diagnostics" kindref="compound">SolveDiagnostics</ref>;</highlight></codeline>
<codeline lineno="72"><highlight class="normal"></highlight></codeline>
<codeline lineno="74" refid="structserif_1_1solver_1_1_standard_newton" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_standard_newton" kindref="compound">StandardNewton</ref><sp/>{</highlight></codeline>
<codeline lineno="76"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_standard_newton_1a7db1f915c5425fc1d9a5f2c4032da4a6" kindref="member">computations</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;)<sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>std::pair{std::tuple{},<sp/>std::tuple{}};<sp/>}</highlight></codeline>
<codeline lineno="78"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1_trial_assessment" kindref="compound">TrialAssessment</ref><sp/><ref refid="namespaceserif_1a31cb75e36c6ad0a21557f789d67229f1" kindref="member">initialize</ref>(</highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;)<sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>{};<sp/>}</highlight></codeline>
<codeline lineno="80"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1_trial_assessment" kindref="compound">TrialAssessment</ref><sp/><ref refid="structserif_1_1solver_1_1_standard_newton_1abed13f7b0fdf3f57c1114f257fa573ab" kindref="member">admissible</ref>(</highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;)<sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>{};<sp/>}</highlight></codeline>
<codeline lineno="82"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1linear_1_1_report" kindref="compound">linear::Report</ref><sp/><ref refid="structserif_1_1solver_1_1_standard_newton_1a63380699f57b930d7ce6b99fee1af89b" kindref="member">solve</ref>(</highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;<sp/>problem,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;<sp/>prepared,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;<sp/>rhs,<sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;<sp/>correction,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;<sp/>options)<sp/>{</highlight></codeline>
<codeline lineno="83"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>problem.solve_linear(prepared,<sp/>rhs,<sp/>correction,<sp/>options);</highlight></codeline>
<codeline lineno="84"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="86"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1_direction_assessment" kindref="compound">DirectionAssessment</ref><sp/><ref refid="structserif_1_1solver_1_1_standard_newton_1aed78337f6b8a922f8f968c1404457e4e" kindref="member">direction</ref>(</highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;)<sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>{};<sp/>}</highlight></codeline>
<codeline lineno="88"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1_trial_assessment" kindref="compound">TrialAssessment</ref><sp/><ref refid="structserif_1_1solver_1_1_standard_newton_1aa2d3dd62a80f8d8b9a4c2d0fe6ea24bb" kindref="member">trial</ref>(</highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal">,<sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal">)<sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>{};<sp/>}</highlight></codeline>
<codeline lineno="90"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_standard_newton_1a9a8001af570e16d3e395e4b0029d66e3" kindref="member">contribute_diagnostics</ref>(<ref refid="structserif_1_1solver_1_1_solve_diagnostics" kindref="compound">SolveDiagnostics</ref>&amp;)</highlight><highlight class="keyword"><sp/>const<sp/></highlight><highlight class="normal">{}</highlight></codeline>
<codeline lineno="91"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="92"><highlight class="normal"></highlight></codeline>
<codeline lineno="94"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;</highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Metric<sp/>=<sp/>NormalizedRes</highlight><highlight class="keywordtype">id</highlight><highlight class="normal">ualMetric,<sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Strategies<sp/>=<sp/>StandardNewton,<sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>LinearSolver<sp/>=<sp/>linear::FGMRES&gt;</highlight></codeline>
<codeline lineno="95" refid="structserif_1_1solver_1_1_solver_options" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1_solver_options" kindref="compound">SolverOptions</ref><sp/>{</highlight></codeline>
<codeline lineno="96"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1_newton" kindref="compound">Newton</ref><sp/><ref refid="structserif_1_1solver_1_1_solver_options_1afcffd183ddae18b64c8e54739d0efcdc" kindref="member">method</ref>{};</highlight></codeline>
<codeline lineno="97"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>LinearSolver<sp/><ref refid="structserif_1_1solver_1_1_solver_options_1a550d84a311fc84906ecb7b5f1271d9d7" kindref="member">linear_solver</ref>{};</highlight></codeline>
<codeline lineno="98"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1_backtracking" kindref="compound">Backtracking</ref><sp/><ref refid="structserif_1_1solver_1_1_solver_options_1aff5b9e6845723e02340c2d8f3cd76178" kindref="member">line_search</ref>{};</highlight></codeline>
<codeline lineno="99"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>Metric<sp/><ref refid="structserif_1_1solver_1_1_solver_options_1a086c841a47cde4255896b508dc94848e" kindref="member">metric</ref>{};</highlight></codeline>
<codeline lineno="100"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>Strategies<sp/><ref refid="structserif_1_1solver_1_1_solver_options_1a6212e31119c4bd92bda8ac1e1163ba11" kindref="member">strategies</ref>{};</highlight></codeline>
<codeline lineno="101"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="102"><highlight class="normal"></highlight></codeline>
<codeline lineno="104"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1a4ae15221b9aded0dc3ec787898984462" kindref="member">next_backtracking_step</ref>(</highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>rejected_step,<sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>accepted_determinant,</highlight></codeline>
<codeline lineno="105"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>rejected_determinant,<sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/>inverted,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1_backtracking" kindref="compound">Backtracking</ref>&amp;<sp/>options)<sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="106"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="src/include/serif/solver/nonlinear/options.hpp"/>
  </compounddef>
</doxygen>