MeanField_SERiF/docs/xml/backend_2mfem_2gravity_2factorization_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="backend_2mfem_2gravity_2factorization_8hpp" kind="file" language="C++">
    <compoundname>factorization.hpp</compoundname>
    <includes local="no">expected</includes>
    <includes local="no">utility</includes>
    <includes refid="backend_2mfem_2inverse_8hpp" local="yes">serif/solver/preconditioner/backend/mfem/inverse.hpp</includes>
    <includes refid="strategies_2gravity_2factorization_8hpp" local="yes">serif/solver/preconditioner/strategies/gravity/factorization.hpp</includes>
    <includedby refid="inverses_8cpp" local="yes">src/compile_time_checks/serif/solver/preconditioner/inverses.cpp</includedby>
    <includedby refid="computations_2gravity_8hpp" local="yes">src/include/serif/solver/preconditioner/computations/gravity.hpp</includedby>
    <includedby refid="factorization_8cpp" local="yes">src/lib/serif/solver/preconditioner/backend/mfem/gravity/factorization.cpp</includedby>
    <incdepgraph>
      <node id="12">
        <label>serif/meta/enums.hpp</label>
        <link refid="enums_8hpp"/>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/solver/preconditioner/backend/mfem/gravity/factorization.hpp</label>
        <link refid="backend_2mfem_2gravity_2factorization_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>serif/solver/preconditioner/backend/mfem/inverse.hpp</label>
        <link refid="backend_2mfem_2inverse_8hpp"/>
        <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="7">
        <label>serif/solver/preconditioner/contract.hpp</label>
        <link refid="contract_8hpp"/>
      </node>
      <node id="8">
        <label>serif/solver/preconditioner/failure.hpp</label>
        <link refid="solver_2preconditioner_2failure_8hpp"/>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
      </node>
      <node id="16">
        <label>serif/solver/preconditioner/strategies/gravity/factorization.hpp</label>
        <link refid="strategies_2gravity_2factorization_8hpp"/>
        <childnode refid="17" relation="include">
        </childnode>
      </node>
      <node id="10">
        <label>serif/utils/error/codes.hpp</label>
        <link refid="codes_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
      </node>
      <node id="17">
        <label>concepts</label>
      </node>
      <node id="11">
        <label>cstdint</label>
      </node>
      <node id="2">
        <label>expected</label>
      </node>
      <node id="15">
        <label>magic_enum/magic_enum_all.hpp</label>
      </node>
      <node id="5">
        <label>memory</label>
      </node>
      <node id="6">
        <label>mfem/linalg/operator.hpp</label>
      </node>
      <node id="9">
        <label>string</label>
      </node>
      <node id="14">
        <label>type_traits</label>
      </node>
      <node id="13">
        <label>unordered_map</label>
      </node>
      <node id="3">
        <label>utility</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="2">
        <label>src/compile_time_checks/serif/solver/preconditioner/inverses.cpp</label>
        <link refid="inverses_8cpp"/>
      </node>
      <node id="1">
        <label>src/include/serif/solver/preconditioner/backend/mfem/gravity/factorization.hpp</label>
        <link refid="backend_2mfem_2gravity_2factorization_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="3">
        <label>src/include/serif/solver/preconditioner/computations/gravity.hpp</label>
        <link refid="computations_2gravity_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>src/include/serif/solver/preconditioner/graph.hpp</label>
        <link refid="solver_2preconditioner_2graph_8hpp"/>
        <childnode refid="5" relation="include">
        </childnode>
      </node>
      <node id="5">
        <label>src/include/serif/solver/preconditioner/preconditioner.hpp</label>
        <link refid="preconditioner_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>src/include/serif/solver/solver.hpp</label>
        <link refid="solver_8hpp"/>
      </node>
      <node id="7">
        <label>src/lib/serif/solver/preconditioner/backend/mfem/gravity/factorization.cpp</label>
        <link refid="factorization_8cpp"/>
      </node>
    </invincdepgraph>
    <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>
    <innernamespace refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail">serif::solver::preconditioner::backend::mfem::detail</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;expected&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;utility&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="backend_2mfem_2inverse_8hpp" kindref="compound">serif/solver/preconditioner/backend/mfem/inverse.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="strategies_2gravity_2factorization_8hpp" kindref="compound">serif/solver/preconditioner/strategies/gravity/factorization.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight></codeline>
<codeline lineno="8"><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="9"><highlight class="normal">{</highlight></codeline>
<codeline lineno="10" refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail" kindref="compound">detail</ref></highlight></codeline>
<codeline lineno="11"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;Inverse,<sp/>Failure&gt;<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_1aa4b8e90442528ed214bb2fc299dda426" kindref="member">prepare_gravity</ref>(<ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse" kindref="compound">Inverse</ref><sp/>mass,<sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse" kindref="compound">Inverse</ref><sp/>positive_schur,<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1a12e3dd6e5e7ac18ab2dba10956af8d59" kindref="member">OperatorHandle</ref><sp/>divergence,<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9" kindref="member">strategies::gravity::Factorization</ref><sp/>method,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>correction_sweeps,<sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>relaxation);</highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/>}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>detail</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="15"><highlight class="normal"></highlight></codeline>
<codeline lineno="17"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;strategies::gravity::Policy<sp/>Policy&gt;</highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;Inverse,<sp/>Failure&gt;<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1ae9c4d4743db072040e6bb6a4d6a91f66" kindref="member">try_gravity_inverse</ref>(<ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse" kindref="compound">Inverse</ref><sp/>mass,<sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse" kindref="compound">Inverse</ref><sp/>positive_schur,<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1a12e3dd6e5e7ac18ab2dba10956af8d59" kindref="member">OperatorHandle</ref><sp/>divergence,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>Policy&amp;<sp/>policy)</highlight></codeline>
<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/>(std::same_as&lt;Policy,<sp/>strategies::gravity::ConsistentSchurLDU&gt;)</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="22"><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/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_1aa4b8e90442528ed214bb2fc299dda426" kindref="member">detail::prepare_gravity</ref>(std::move(mass),<sp/>std::move(positive_schur),<sp/>std::move(divergence),<sp/>Policy::method,<sp/>policy.correction_sweeps,<sp/>policy.relaxation);</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">else</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="26"><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/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_1aa4b8e90442528ed214bb2fc299dda426" kindref="member">detail::prepare_gravity</ref>(std::move(mass),<sp/>std::move(positive_schur),<sp/>std::move(divergence),<sp/>Policy::method,<sp/>0,<sp/>1.0);</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="29"><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/include/serif/solver/preconditioner/backend/mfem/gravity/factorization.hpp"/>
  </compounddef>
</doxygen>