MeanField_SERiF/docs/xml/linear_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="linear_8hpp" kind="file" language="C++">
    <compoundname>linear.hpp</compoundname>
    <includes local="no">cstdint</includes>
    <includedby refid="solve_8hpp" local="yes">src/include/serif/backend/mfem/solver/linear/solve.hpp</includedby>
    <includedby refid="solver_2nonlinear_2options_8hpp" local="yes">src/include/serif/solver/nonlinear/options.hpp</includedby>
    <includedby refid="solver_2nonlinear_2result_8hpp" local="yes">src/include/serif/solver/nonlinear/result.hpp</includedby>
    <includedby refid="linear_8cpp" local="yes">src/lib/serif/solver/linear/linear.cpp</includedby>
    <incdepgraph>
      <node id="1">
        <label>src/include/serif/solver/linear/linear.hpp</label>
        <link refid="linear_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>cstdint</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="15">
        <label>src/compile_time_checks/serif/backend_independent.cpp</label>
        <link refid="backend__independent_8cpp"/>
      </node>
      <node id="12">
        <label>src/compile_time_checks/serif/solver/public_contracts.cpp</label>
        <link refid="public__contracts_8cpp"/>
      </node>
      <node id="21">
        <label>src/include/serif/backend/mfem/serialize/configuration.hpp</label>
        <link refid="backend_2mfem_2serialize_2configuration_8hpp"/>
      </node>
      <node id="22">
        <label>src/include/serif/backend/mfem/serialize/options.hpp</label>
        <link refid="backend_2mfem_2serialize_2options_8hpp"/>
      </node>
      <node id="10">
        <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="2">
        <label>src/include/serif/backend/mfem/solver/linear/solve.hpp</label>
        <link refid="solve_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="8" 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="1">
        <label>src/include/serif/solver/linear/linear.hpp</label>
        <link refid="linear_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
      </node>
      <node id="14">
        <label>src/include/serif/solver/nonlinear/newton.hpp</label>
        <link refid="newton_8hpp"/>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
      </node>
      <node id="13">
        <label>src/include/serif/solver/nonlinear/observers.hpp</label>
        <link refid="solver_2nonlinear_2observers_8hpp"/>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="9">
        <label>src/include/serif/solver/nonlinear/options.hpp</label>
        <link refid="solver_2nonlinear_2options_8hpp"/>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
      </node>
      <node id="16">
        <label>src/include/serif/solver/nonlinear/qualification.hpp</label>
        <link refid="qualification_8hpp"/>
        <childnode refid="17" relation="include">
        </childnode>
      </node>
      <node id="11">
        <label>src/include/serif/solver/nonlinear/result.hpp</label>
        <link refid="solver_2nonlinear_2result_8hpp"/>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
      </node>
      <node id="17">
        <label>src/include/serif/solver/nonlinear/steps.hpp</label>
        <link refid="steps_8hpp"/>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="7">
        <label>src/include/serif/solver/solver.hpp</label>
        <link refid="solver_2solver_8hpp"/>
      </node>
      <node id="20">
        <label>src/include/serif/utils/serialize/numerics.hpp</label>
        <link refid="numerics_8hpp"/>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
      </node>
      <node id="19">
        <label>src/include/serif/utils/serialize/serialize.hpp</label>
        <link refid="serialize_8hpp"/>
        <childnode refid="15" relation="include">
        </childnode>
      </node>
      <node id="18">
        <label>src/include/serif/utils/serialize/solver.hpp</label>
        <link refid="utils_2serialize_2solver_8hpp"/>
        <childnode refid="19" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>src/lib/serif/backend/mfem/solver/linear/solve.cpp</label>
        <link refid="solve_8cpp"/>
      </node>
      <node id="24">
        <label>src/lib/serif/solver/linear/linear.cpp</label>
        <link refid="linear_8cpp"/>
      </node>
      <node id="23">
        <label>src/lib/serif/solver/nonlinear/options.cpp</label>
        <link refid="options_8cpp"/>
      </node>
    </invincdepgraph>
    <innerclass refid="structserif_1_1solver_1_1linear_1_1_control" prot="public">serif::solver::linear::Control</innerclass>
    <innerclass refid="structserif_1_1solver_1_1linear_1_1_f_g_m_r_e_s" prot="public">serif::solver::linear::FGMRES</innerclass>
    <innerclass refid="structserif_1_1solver_1_1linear_1_1_report" prot="public">serif::solver::linear::Report</innerclass>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver">serif::solver</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver_1_1linear">serif::solver::linear</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;cstdint&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1solver_1_1linear" kindref="compound">serif::solver::linear</ref><sp/>{</highlight></codeline>
<codeline lineno="7"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">enum<sp/>class</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569d" kindref="member">Status</ref><sp/>{<sp/><ref refid="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569da7de33615d7fbc1cb7bc608d12f1993d2" kindref="member">converged</ref>,<sp/><ref refid="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569daf9cc715fb6ecde5fea080ac57ad0dfaf" kindref="member">maximum_iterations</ref>,<sp/><ref refid="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569da0c465cebd957857d21f91945cc2127ee" kindref="member">breakdown</ref>,<sp/><ref refid="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569da4013d0a2d04acba5257678a15922a094" kindref="member">non_finite</ref>,<sp/><ref refid="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569da4012827e4f1918f330f4ffc6d03858ef" kindref="member">backend_failure</ref><sp/>};</highlight></codeline>
<codeline lineno="8"><highlight class="normal"></highlight></codeline>
<codeline lineno="10" refid="structserif_1_1solver_1_1linear_1_1_control" 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_1linear_1_1_control" kindref="compound">Control</ref><sp/>{</highlight></codeline>
<codeline lineno="11"><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_1linear_1_1_control_1a1dfa0bf223efb2e1c828f68926c2f544" kindref="member">relative_tolerance</ref>{1.0e-8};</highlight></codeline>
<codeline lineno="12"><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_1linear_1_1_control_1aee53a6c3a61ac1e76db6867800579382" kindref="member">absolute_tolerance</ref>{0.0};</highlight></codeline>
<codeline lineno="13"><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_1linear_1_1_control_1a40faab0885e0dbe0ae663e7d9764dce9" kindref="member">maximum_iterations</ref>{100};</highlight></codeline>
<codeline lineno="14"><highlight class="normal"></highlight></codeline>
<codeline lineno="16"><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_1linear_1_1_control_1a53c5ceb8c91660b55b64ec13ba6dfdfd" kindref="member">validate</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="17"><highlight class="normal"></highlight></codeline>
<codeline lineno="19"><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_1linear_1_1_control_1a95a5fcfd4cb1c4cdbf65100aad13fdc7" kindref="member">convergence_threshold</ref>(</highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>right_hand_side_norm)<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="21"><highlight class="normal"></highlight></codeline>
<codeline lineno="23" refid="structserif_1_1solver_1_1linear_1_1_f_g_m_r_e_s" 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_1linear_1_1_f_g_m_r_e_s" kindref="compound">FGMRES</ref><sp/>{</highlight></codeline>
<codeline lineno="24"><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_1linear_1_1_f_g_m_r_e_s_1a1acab699fb76610914b3a9bfcf916afc" kindref="member">restart_length</ref>{160};</highlight></codeline>
<codeline lineno="25"><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_1linear_1_1_f_g_m_r_e_s_1a1c8ce46064a938ab2215f490e569a82c" kindref="member">print_level</ref>{-1};</highlight></codeline>
<codeline lineno="26"><highlight class="normal"></highlight></codeline>
<codeline lineno="28"><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_1linear_1_1_f_g_m_r_e_s_1af2f04b567453e5c175747f9eb815c29c" kindref="member">validate</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="30"><highlight class="normal"></highlight></codeline>
<codeline lineno="36" refid="structserif_1_1solver_1_1linear_1_1_report" 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_1linear_1_1_report" kindref="compound">Report</ref><sp/>{</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569d" kindref="member">Status</ref><sp/><ref refid="structserif_1_1solver_1_1linear_1_1_report_1a87d0a4ff499085331bf8bf2606b454da" kindref="member">status</ref>{<ref refid="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569da4012827e4f1918f330f4ffc6d03858ef" kindref="member">Status::backend_failure</ref>};</highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1solver_1_1linear_1_1_control" kindref="compound">Control</ref><sp/><ref refid="structserif_1_1solver_1_1linear_1_1_report_1af323b2ccf9a950c5204495cdd8ebb881" kindref="member">control</ref>{};</highlight></codeline>
<codeline lineno="39"><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_1linear_1_1_report_1a70711580973e5fecfbce735bb985c358" kindref="member">iterations</ref>{0};</highlight></codeline>
<codeline lineno="40"><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_1linear_1_1_report_1a29677eb3f1d22a39725a1df74a4f65f8" kindref="member">restarts</ref>{0};</highlight></codeline>
<codeline lineno="41"><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_1linear_1_1_report_1aa7113fc3dc18a04ec3b73332663560d8" kindref="member">right_hand_side_norm</ref>{0.0};</highlight></codeline>
<codeline lineno="42"><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_1linear_1_1_report_1a43e11e594aa968076664c82ef293aa32" kindref="member">initial_residual_norm</ref>{0.0};</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_1linear_1_1_report_1a58cc0de84540b61431fafd94931cf885" kindref="member">reported_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_1linear_1_1_report_1abf0a2e2bf1a30d9b8e67d8ea658a9597" kindref="member">true_residual_norm</ref>{0.0};</highlight></codeline>
<codeline lineno="45"><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_1linear_1_1_report_1abe6c33bd144b775acab13748e9bf040c" kindref="member">relative_true_residual_norm</ref>{0.0};</highlight></codeline>
<codeline lineno="46"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::uint64_t<sp/><ref refid="structserif_1_1solver_1_1linear_1_1_report_1a006540b8a83be8769ba450140f3a214f" kindref="member">operator_applications</ref>{0};</highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::uint64_t<sp/><ref refid="structserif_1_1solver_1_1linear_1_1_report_1aa2d1cd0282df1d44901ae7c828125791" kindref="member">preconditioner_applications</ref>{0};</highlight></codeline>
<codeline lineno="48"><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_1linear_1_1_report_1a20c530f5fc5cb5b27f1d383054c9beb2" kindref="member">solve_seconds</ref>{0.0};</highlight></codeline>
<codeline lineno="49"><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_1linear_1_1_report_1ab9456327a69e3084aeec3c99d96781ab" kindref="member">operator_seconds</ref>{0.0};</highlight></codeline>
<codeline lineno="50"><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_1linear_1_1_report_1a115184a5288bd073fcdfa3a2a9f5aaa4" kindref="member">preconditioner_seconds</ref>{0.0};</highlight></codeline>
<codeline lineno="51"><highlight class="normal"></highlight></codeline>
<codeline lineno="53"><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_1linear_1_1_report_1ae7d7a9d96d2459abc9fd0af065b3545f" kindref="member">converged</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"><sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1linear_1_1_report_1a87d0a4ff499085331bf8bf2606b454da" kindref="member">status</ref><sp/>==<sp/><ref refid="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569da7de33615d7fbc1cb7bc608d12f1993d2" kindref="member">Status::converged</ref>;<sp/>}</highlight></codeline>
<codeline lineno="54"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="55"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="src/include/serif/solver/linear/linear.hpp"/>
  </compounddef>
</doxygen>