MeanField_SERiF/docs/xml/solver_8cpp.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_8cpp" kind="file" language="C++">
    <compoundname>solver.cpp</compoundname>
    <includes refid="backend_2mfem_2solver_2preconditioner_2solver_8hpp" local="yes">serif/backend/mfem/solver/preconditioner/solver.hpp</includes>
    <includes local="no">utility</includes>
    <includes refid="errors_8hpp" local="yes">serif/utils/error/errors.hpp</includes>
    <incdepgraph>
      <node id="3">
        <label>serif/backend/mfem/solver/preconditioner/inverse.hpp</label>
        <link refid="inverse_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>serif/backend/mfem/solver/preconditioner/solver.hpp</label>
        <link refid="backend_2mfem_2solver_2preconditioner_2solver_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
      </node>
      <node id="11">
        <label>serif/meta/enums.hpp</label>
        <link refid="enums_8hpp"/>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>serif/solver/preconditioner/contract.hpp</label>
        <link refid="contract_8hpp"/>
      </node>
      <node id="7">
        <label>serif/solver/preconditioner/failure.hpp</label>
        <link refid="solver_2preconditioner_2failure_8hpp"/>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="9">
        <label>serif/utils/error/codes.hpp</label>
        <link refid="codes_8hpp"/>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="16">
        <label>serif/utils/error/errors.hpp</label>
        <link refid="errors_8hpp"/>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="29" relation="include">
        </childnode>
      </node>
      <node id="25">
        <label>serif/utils/misc/concepts/exceptions.hpp</label>
        <link refid="utils_2misc_2concepts_2exceptions_8hpp"/>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="27" relation="include">
        </childnode>
      </node>
      <node id="27">
        <label>serif/utils/misc/concepts/numeric.hpp</label>
        <link refid="numeric_8hpp"/>
        <childnode refid="28" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
      </node>
      <node id="22">
        <label>serif/utils/misc/terminal/colors.hpp</label>
        <link refid="colors_8hpp"/>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
      </node>
      <node id="29">
        <label>serif/utils/types/strings.hpp</label>
        <link refid="types_2strings_8hpp"/>
        <childnode refid="20" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/lib/serif/backend/mfem/solver/preconditioner/solver.cpp</label>
        <link refid="solver_8cpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
      </node>
      <node id="20">
        <label>algorithm</label>
      </node>
      <node id="28">
        <label>concepts</label>
      </node>
      <node id="10">
        <label>cstdint</label>
      </node>
      <node id="19">
        <label>cstdio</label>
      </node>
      <node id="23">
        <label>cstdlib</label>
      </node>
      <node id="26">
        <label>exception</label>
      </node>
      <node id="18">
        <label>format</label>
      </node>
      <node id="30">
        <label>iostream</label>
      </node>
      <node id="14">
        <label>magic_enum/magic_enum_all.hpp</label>
      </node>
      <node id="4">
        <label>memory</label>
      </node>
      <node id="5">
        <label>mfem/linalg/operator.hpp</label>
      </node>
      <node id="8">
        <label>string</label>
      </node>
      <node id="17">
        <label>string_view</label>
      </node>
      <node id="13">
        <label>type_traits</label>
      </node>
      <node id="24">
        <label>unistd.h</label>
      </node>
      <node id="12">
        <label>unordered_map</label>
      </node>
      <node id="15">
        <label>utility</label>
      </node>
      <node id="21">
        <label>version</label>
      </node>
    </incdepgraph>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver">serif::solver</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver_1_1preconditioner">serif::solver::preconditioner</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend">serif::solver::preconditioner::backend</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem">serif::solver::preconditioner::backend::mfem</innernamespace>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <programlisting>
<codeline lineno="1"><highlight class="preprocessor">#include<sp/>&quot;<ref refid="backend_2mfem_2solver_2preconditioner_2solver_8hpp" kindref="compound">serif/backend/mfem/solver/preconditioner/solver.hpp</ref>&quot;</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;utility&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="errors_8hpp" kindref="compound">serif/utils/error/errors.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem" kindref="compound">serif::solver::preconditioner::backend::mfem</ref></highlight></codeline>
<codeline lineno="7"><highlight class="normal">{</highlight></codeline>
<codeline lineno="8"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="classserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_solver_1af6df611ee198b431666b4c29321fae2b" kindref="member">Solver::Solver</ref>(<ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse" kindref="compound">Inverse</ref><sp/>inverse,<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1a12e3dd6e5e7ac18ab2dba10956af8d59" kindref="member">OperatorHandle</ref><sp/>jacobian)<sp/>:<sp/>m_inverse(std::move(<ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1computations_1a4e68f4ddc06181dc9077cb41a6c795d5" kindref="member">inverse</ref>)),<sp/>m_jacobian(std::move(jacobian))</highlight></codeline>
<codeline lineno="9"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="10"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/>namespace<sp/></highlight><highlight class="normal">utils::errors;</highlight></codeline>
<codeline lineno="11"><highlight class="normal"></highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>serif_ensure&lt;SERiFErrorCode::PRECONDITIONER_INVALID_OPERATOR&gt;(m_inverse.action<sp/>&amp;&amp;<sp/>m_jacobian,</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="stringliteral">&quot;The<sp/>preconditioner<sp/>adapter<sp/>needs<sp/>an<sp/>accepted<sp/>inverse<sp/>and<sp/>physical<sp/>Jacobian.<sp/>Prepare<sp/>both<sp/>before<sp/>binding<sp/>the<sp/>solver.&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>height<sp/>=<sp/>m_inverse.action-&gt;Height();</highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>width<sp/>=<sp/>m_inverse.action-&gt;Width();</highlight></codeline>
<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>serif_ensure&lt;SERiFErrorCode::PRECONDITIONER_SIZE_MISMATCH&gt;(height<sp/>==<sp/>m_jacobian-&gt;Width()<sp/>&amp;&amp;<sp/>width<sp/>==<sp/>m_jacobian-&gt;Height(),</highlight></codeline>
<codeline lineno="17"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="stringliteral">&quot;The<sp/>inverse<sp/>dimensions<sp/>do<sp/>not<sp/>reverse<sp/>the<sp/>physical<sp/>Jacobian<sp/>dimensions.<sp/>Bind<sp/>matching<sp/>accepted<sp/>operators.&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>m_input.SetSize(width);</highlight></codeline>
<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>m_output.SetSize(height);</highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>iterative_mode<sp/>=<sp/></highlight><highlight class="keyword">false</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="22"><highlight class="normal"></highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>Solver::SetOperator(const<sp/>::mfem::Operator&amp;<sp/>jacobian)</highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>utils::errors::serif_ensure&lt;utils::errors::SERiFErrorCode::PRECONDITIONER_STALE_LINEARIZATION&gt;(&amp;jacobian<sp/>==<sp/>m_jacobian.get(),</highlight></codeline>
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="stringliteral">&quot;This<sp/>preconditioner<sp/>belongs<sp/>to<sp/>a<sp/>different<sp/>accepted<sp/>Jacobian.<sp/>Prepare<sp/>and<sp/>bind<sp/>a<sp/>new<sp/>inverse<sp/>for<sp/>the<sp/>new<sp/>linearization.&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="28"><highlight class="normal"></highlight></codeline>
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>Solver::Mult(const<sp/>::mfem::Vector&amp;<sp/>input,<sp/>::mfem::Vector&amp;<sp/>output)</highlight><highlight class="keyword"><sp/>const</highlight></codeline>
<codeline lineno="30"><highlight class="keyword"><sp/><sp/><sp/><sp/></highlight><highlight class="normal">{</highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>utils::errors::serif_ensure&lt;utils::errors::SERiFErrorCode::PRECONDITIONER_SIZE_MISMATCH&gt;(input.Size()<sp/>==<sp/>width<sp/>&amp;&amp;<sp/>output.Size()<sp/>==<sp/>height,</highlight></codeline>
<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="stringliteral">&quot;Preconditioner<sp/>application<sp/>needs<sp/>{}<sp/>residual<sp/>and<sp/>{}<sp/>state<sp/>coefficients<sp/>in<sp/>preallocated<sp/>vectors;<sp/>received<sp/>{}<sp/>and<sp/>{}.&quot;</highlight><highlight class="normal">,<sp/>width,<sp/>height,<sp/>input.Size(),<sp/>output.Size());</highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>m_input<sp/>=<sp/>input;</highlight></codeline>
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>m_output<sp/>=<sp/>0.0;</highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>m_inverse.action-&gt;Mult(m_input,<sp/>m_output);</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>output<sp/>=<sp/>m_output;</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="38"><highlight class="normal"></highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1aa7f59af2cd4988b0904ebc5b7b575a53" kindref="member">ApplicationContract</ref><sp/>Solver::contract()<sp/>const<sp/>noexcept</highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>m_inverse.contract;</highlight></codeline>
<codeline lineno="42"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="43"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>serif::solver::preconditioner::backend::mfem</highlight><highlight class="normal"></highlight></codeline>
    </programlisting>
    <location file="src/lib/serif/backend/mfem/solver/preconditioner/solver.cpp"/>
  </compounddef>
</doxygen>