MeanField_SERiF/docs/xml/strategies_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="strategies_2gravity_2factorization_8hpp" kind="file" language="C++">
    <compoundname>factorization.hpp</compoundname>
    <includes local="no">concepts</includes>
    <includedby refid="backend_2mfem_2gravity_2factorization_8hpp" local="yes">src/include/serif/solver/preconditioner/backend/mfem/gravity/factorization.hpp</includedby>
    <includedby refid="recipes_2gravity_8hpp" local="yes">src/include/serif/solver/preconditioner/recipes/gravity.hpp</includedby>
    <incdepgraph>
      <node id="1">
        <label>src/include/serif/solver/preconditioner/strategies/gravity/factorization.hpp</label>
        <link refid="strategies_2gravity_2factorization_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>concepts</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="3">
        <label>src/compile_time_checks/serif/solver/preconditioner/inverses.cpp</label>
        <link refid="inverses_8cpp"/>
      </node>
      <node id="2">
        <label>src/include/serif/solver/preconditioner/backend/mfem/gravity/factorization.hpp</label>
        <link refid="backend_2mfem_2gravity_2factorization_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>src/include/serif/solver/preconditioner/computations/gravity.hpp</label>
        <link refid="computations_2gravity_8hpp"/>
        <childnode refid="5" relation="include">
        </childnode>
      </node>
      <node id="5">
        <label>src/include/serif/solver/preconditioner/graph.hpp</label>
        <link refid="solver_2preconditioner_2graph_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>src/include/serif/solver/preconditioner/preconditioner.hpp</label>
        <link refid="preconditioner_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="9">
        <label>src/include/serif/solver/preconditioner/recipes/gravity.hpp</label>
        <link refid="recipes_2gravity_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/solver/preconditioner/strategies/gravity/factorization.hpp</label>
        <link refid="strategies_2gravity_2factorization_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="7">
        <label>src/include/serif/solver/solver.hpp</label>
        <link refid="solver_8hpp"/>
      </node>
      <node id="8">
        <label>src/lib/serif/solver/preconditioner/backend/mfem/gravity/factorization.cpp</label>
        <link refid="factorization_8cpp"/>
      </node>
    </invincdepgraph>
    <innerclass refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_block_diagonal" prot="public">serif::solver::preconditioner::strategies::gravity::BlockDiagonal</innerclass>
    <innerclass refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_lower_triangular" prot="public">serif::solver::preconditioner::strategies::gravity::LowerTriangular</innerclass>
    <innerclass refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_upper_triangular" prot="public">serif::solver::preconditioner::strategies::gravity::UpperTriangular</innerclass>
    <innerclass refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_approximate_l_d_u" prot="public">serif::solver::preconditioner::strategies::gravity::ApproximateLDU</innerclass>
    <innerclass refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_consistent_schur_l_d_u" prot="public">serif::solver::preconditioner::strategies::gravity::ConsistentSchurLDU</innerclass>
    <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_1strategies">serif::solver::preconditioner::strategies</innernamespace>
    <innernamespace refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity">serif::solver::preconditioner::strategies::gravity</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;concepts&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight></codeline>
<codeline lineno="5" refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity" kindref="compound">serif::solver::preconditioner::strategies::gravity</ref></highlight></codeline>
<codeline lineno="6"><highlight class="normal">{</highlight></codeline>
<codeline lineno="8"><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_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9" kindref="member">Factorization</ref></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/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9a810ed8e1ac64dff7364597fa4776c717" kindref="member">block_diagonal</ref>,</highlight></codeline>
<codeline lineno="11"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9aaf9387c48010a1e4a9768596ebdb07b8" kindref="member">lower_triangular</ref>,</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9a68ba2cbeae8199c4dd74004e3558a0a2" kindref="member">upper_triangular</ref>,</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9adaf3848f8cbb132f0e20a33939b3a61f" kindref="member">approximate_ldu</ref>,</highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9a7278304a39f6d53d9dcbd4761e2551ad" kindref="member">consistent_schur_ldu</ref></highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="16"><highlight class="normal"></highlight></codeline>
<codeline lineno="18" refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_block_diagonal" 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_1preconditioner_1_1strategies_1_1gravity_1_1_block_diagonal" kindref="compound">BlockDiagonal</ref><sp/>final</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="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9" kindref="member">Factorization</ref><sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_block_diagonal_1ae69a67fe7b58b45b1974d360e4bf73d1" kindref="member">method</ref>{<ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9a810ed8e1ac64dff7364597fa4776c717" kindref="member">Factorization::block_diagonal</ref>};</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="22"><highlight class="normal"></highlight></codeline>
<codeline lineno="24" refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_lower_triangular" 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_1preconditioner_1_1strategies_1_1gravity_1_1_lower_triangular" kindref="compound">LowerTriangular</ref><sp/>final</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="26"><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">constexpr</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9" kindref="member">Factorization</ref><sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_lower_triangular_1a68298d1e8d8f8384e9ac792f83b42be3" kindref="member">method</ref>{<ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9aaf9387c48010a1e4a9768596ebdb07b8" kindref="member">Factorization::lower_triangular</ref>};</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="28"><highlight class="normal"></highlight></codeline>
<codeline lineno="30" refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_upper_triangular" 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_1preconditioner_1_1strategies_1_1gravity_1_1_upper_triangular" kindref="compound">UpperTriangular</ref><sp/>final</highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="32"><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">constexpr</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9" kindref="member">Factorization</ref><sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_upper_triangular_1a30f8b83e3f0479da7599c9fbf5eb49c1" kindref="member">method</ref>{<ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9a68ba2cbeae8199c4dd74004e3558a0a2" kindref="member">Factorization::upper_triangular</ref>};</highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="34"><highlight class="normal"></highlight></codeline>
<codeline lineno="36" refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_approximate_l_d_u" 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_1preconditioner_1_1strategies_1_1gravity_1_1_approximate_l_d_u" kindref="compound">ApproximateLDU</ref><sp/>final</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="38"><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">constexpr</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9" kindref="member">Factorization</ref><sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_approximate_l_d_u_1a1c353a2ad4ad6eabfb18c6fedd4b6ea3" kindref="member">method</ref>{<ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9adaf3848f8cbb132f0e20a33939b3a61f" kindref="member">Factorization::approximate_ldu</ref>};</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_1preconditioner_1_1strategies_1_1gravity_1_1_consistent_schur_l_d_u" 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_1preconditioner_1_1strategies_1_1gravity_1_1_consistent_schur_l_d_u" kindref="compound">ConsistentSchurLDU</ref><sp/>final</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="44"><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">constexpr</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9" kindref="member">Factorization</ref><sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_consistent_schur_l_d_u_1a2faffb160dc772de7bcb5c5b42e2075c" kindref="member">method</ref>{<ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1ac8751bb2d27560447a3accbc439065b9a7278304a39f6d53d9dcbd4761e2551ad" kindref="member">Factorization::consistent_schur_ldu</ref>};</highlight></codeline>
<codeline lineno="45"><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_1preconditioner_1_1strategies_1_1gravity_1_1_consistent_schur_l_d_u_1a136f65d306225099d03eff60fd679ced" kindref="member">correction_sweeps</ref>{1};</highlight></codeline>
<codeline lineno="46"><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_1preconditioner_1_1strategies_1_1gravity_1_1_consistent_schur_l_d_u_1a2c232ddc703824b291208ba7c55bd0df" kindref="member">relaxation</ref>{1.0};</highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="48"><highlight class="normal"></highlight></codeline>
<codeline lineno="50"><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/>Cand</highlight><highlight class="keywordtype">id</highlight><highlight class="normal">ate&gt;</highlight></codeline>
<codeline lineno="51" refid="conceptserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_policy" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">concept<sp/></highlight><highlight class="normal"><ref refid="conceptserif_1_1solver_1_1preconditioner_1_1strategies_1_1gravity_1_1_policy" kindref="compound">Policy</ref><sp/>=<sp/>std::same_as&lt;Candidate,<sp/>BlockDiagonal&gt;<sp/>||<sp/>std::same_as&lt;Candidate,<sp/>LowerTriangular&gt;<sp/>||<sp/>std::same_as&lt;Candidate,<sp/>UpperTriangular&gt;<sp/>||</highlight></codeline>
<codeline lineno="52"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::same_as&lt;Candidate,<sp/>ApproximateLDU&gt;<sp/>||<sp/>std::same_as&lt;Candidate,<sp/>ConsistentSchurLDU&gt;;</highlight></codeline>
<codeline lineno="53"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>serif::solver::preconditioner::strategies::gravity</highlight><highlight class="normal"></highlight></codeline>
    </programlisting>
    <location file="src/include/serif/solver/preconditioner/strategies/gravity/factorization.hpp"/>
  </compounddef>
</doxygen>