MeanField_SERiF/docs/xml/coupling_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="coupling_8hpp" kind="file" language="C++">
    <compoundname>coupling.hpp</compoundname>
    <includes local="no">expected</includes>
    <includes refid="inverse_8hpp" local="yes">serif/backend/mfem/solver/preconditioner/inverse.hpp</includes>
    <includes refid="solver_2preconditioner_2strategies_2coupling_2order_8hpp" local="yes">serif/solver/preconditioner/strategies/coupling/order.hpp</includes>
    <includedby refid="border_8hpp" local="yes">src/include/serif/backend/mfem/solver/preconditioner/border.hpp</includedby>
    <includedby refid="computations_2coupling_8hpp" local="yes">src/include/serif/backend/mfem/solver/preconditioner/computations/coupling.hpp</includedby>
    <includedby refid="lib_2serif_2backend_2mfem_2solver_2preconditioner_2coupling_8cpp" local="yes">src/lib/serif/backend/mfem/solver/preconditioner/coupling.cpp</includedby>
    <includedby refid="coupling__internal_8hpp" local="yes">src/lib/serif/backend/mfem/solver/preconditioner/coupling_internal.hpp</includedby>
    <incdepgraph>
      <node id="1">
        <label>src/include/serif/backend/mfem/solver/preconditioner/coupling.hpp</label>
        <link refid="coupling_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
      </node>
      <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="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="15">
        <label>serif/solver/preconditioner/strategies/coupling/order.hpp</label>
        <link refid="solver_2preconditioner_2strategies_2coupling_2order_8hpp"/>
      </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="10">
        <label>cstdint</label>
      </node>
      <node id="2">
        <label>expected</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="13">
        <label>type_traits</label>
      </node>
      <node id="12">
        <label>unordered_map</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="9">
        <label>src/compile_time_checks/serif/model/state.cpp</label>
        <link refid="state_8cpp"/>
      </node>
      <node id="3">
        <label>src/compile_time_checks/serif/solver/preconditioner/coupling.cpp</label>
        <link refid="compile__time__checks_2serif_2solver_2preconditioner_2coupling_8cpp"/>
      </node>
      <node id="17">
        <label>src/compile_time_checks/serif/solver/preconditioner/layout.cpp</label>
        <link refid="layout_8cpp"/>
      </node>
      <node id="8">
        <label>src/include/serif/backend/mfem/model/equilibrium.hpp</label>
        <link refid="backend_2mfem_2model_2equilibrium_8hpp"/>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
      </node>
      <node id="7">
        <label>src/include/serif/backend/mfem/model/equilibrium_evaluator.hpp</label>
        <link refid="equilibrium__evaluator_8hpp"/>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>src/include/serif/backend/mfem/model/preconditioning/computations.hpp</label>
        <link refid="backend_2mfem_2model_2preconditioning_2computations_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="11">
        <label>src/include/serif/backend/mfem/solver/equilibrium.hpp</label>
        <link refid="backend_2mfem_2solver_2equilibrium_8hpp"/>
        <childnode refid="12" relation="include">
        </childnode>
      </node>
      <node id="10">
        <label>src/include/serif/backend/mfem/solver/nonlinear/stellar_problem.hpp</label>
        <link refid="stellar__problem_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>src/include/serif/backend/mfem/solver/preconditioner/border.hpp</label>
        <link refid="border_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>src/include/serif/backend/mfem/solver/preconditioner/computations/coupling.hpp</label>
        <link refid="computations_2coupling_8hpp"/>
        <childnode refid="5" relation="include">
        </childnode>
      </node>
      <node id="16">
        <label>src/include/serif/backend/mfem/solver/preconditioner/computations/ordering.hpp</label>
        <link refid="ordering_8hpp"/>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/backend/mfem/solver/preconditioner/coupling.hpp</label>
        <link refid="coupling_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
      </node>
      <node id="5">
        <label>src/include/serif/backend/mfem/solver/preconditioner/graph.hpp</label>
        <link refid="backend_2mfem_2solver_2preconditioner_2graph_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
      </node>
      <node id="13">
        <label>src/include/serif/solver/continuation/equilibrium.hpp</label>
        <link refid="solver_2continuation_2equilibrium_8hpp"/>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="12">
        <label>src/include/serif/solver/equilibrium.hpp</label>
        <link refid="solver_2equilibrium_8hpp"/>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="15">
        <label>src/include/serif/solver/preconditioner/preconditioner.hpp</label>
        <link refid="preconditioner_8hpp"/>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="14">
        <label>src/include/serif/solver/solver.hpp</label>
        <link refid="solver_2solver_8hpp"/>
      </node>
      <node id="18">
        <label>src/lib/serif/backend/mfem/solver/preconditioner/border.cpp</label>
        <link refid="border_8cpp"/>
      </node>
      <node id="20">
        <label>src/lib/serif/backend/mfem/solver/preconditioner/coupling.cpp</label>
        <link refid="lib_2serif_2backend_2mfem_2solver_2preconditioner_2coupling_8cpp"/>
      </node>
      <node id="21">
        <label>src/lib/serif/backend/mfem/solver/preconditioner/coupling_internal.hpp</label>
        <link refid="coupling__internal_8hpp"/>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
      </node>
      <node id="19">
        <label>src/lib/serif/backend/mfem/solver/preconditioner/coupling_selection.cpp</label>
        <link refid="coupling__selection_8cpp"/>
      </node>
    </invincdepgraph>
    <innerclass refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_two_block_couplings" prot="public">serif::solver::preconditioner::backend::mfem::TwoBlockCouplings</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_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">#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></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="inverse_8hpp" kindref="compound">serif/backend/mfem/solver/preconditioner/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="solver_2preconditioner_2strategies_2coupling_2order_8hpp" kindref="compound">serif/solver/preconditioner/strategies/coupling/order.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="11" refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_two_block_couplings" 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_1backend_1_1mfem_1_1_two_block_couplings" kindref="compound">TwoBlockCouplings</ref><sp/>final</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1a12e3dd6e5e7ac18ab2dba10956af8d59" kindref="member">OperatorHandle</ref><sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_two_block_couplings_1a99f05ba8180b38d35356b729cccde30e" kindref="member">first_from_second</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_1backend_1_1mfem_1a12e3dd6e5e7ac18ab2dba10956af8d59" kindref="member">OperatorHandle</ref><sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_two_block_couplings_1ae74efcf76ce51b1b6f36ec53d70bafc7" kindref="member">second_from_first</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="23"><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_1a2e24799af31c301cb141c2bfd362669a" kindref="member">try_coupled_inverse</ref>(<ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse" kindref="compound">Inverse</ref><sp/>first,<sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse" kindref="compound">Inverse</ref><sp/>second,<sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_two_block_couplings" kindref="compound">TwoBlockCouplings</ref><sp/>couplings,<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1strategies_1_1coupling_1a1843f298d4e3fb5770085697b48ffa55" kindref="member">strategies::coupling::CouplingOrder</ref><sp/>order);</highlight></codeline>
<codeline lineno="24"><highlight class="normal"></highlight></codeline>
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;OperatorHandle,<sp/>Failure&gt;<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1aca9dd8c44b8ce1e631a6dc45396756c4" kindref="member">try_schur_operator</ref>(<ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1a12e3dd6e5e7ac18ab2dba10956af8d59" kindref="member">OperatorHandle</ref><sp/>retained_diagonal,<sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_inverse" kindref="compound">Inverse</ref><sp/>eliminated,<sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_two_block_couplings" kindref="compound">TwoBlockCouplings</ref><sp/>couplings);</highlight></codeline>
<codeline lineno="31"><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/backend/mfem/solver/preconditioner/coupling.hpp"/>
  </compounddef>
</doxygen>