MeanField_SERiF/docs/xml/reference__mass_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="reference__mass_8cpp" kind="file" language="C++">
    <compoundname>reference_mass.cpp</compoundname>
    <includes refid="backend_2mfem_2surface_2reference__mass_8hpp" local="yes">serif/solver/preconditioner/backend/mfem/surface/reference_mass.hpp</includes>
    <includes local="no">vector</includes>
    <includes refid="preconditioner_2backend_2mfem_2inverse_2diagonal_8hpp" local="yes">serif/solver/preconditioner/backend/mfem/inverse/diagonal.hpp</includes>
    <includes refid="regularization_8hpp" local="yes">serif/solver/preconditioner/backend/mfem/inverse/regularization.hpp</includes>
    <includes refid="calibration_8hpp" local="yes">serif/solver/preconditioner/backend/mfem/surface/detail/calibration.hpp</includes>
    <incdepgraph>
      <node id="13">
        <label>serif/meta/enums.hpp</label>
        <link refid="enums_8hpp"/>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
      </node>
      <node id="5">
        <label>serif/solver/preconditioner/backend/mfem/inverse.hpp</label>
        <link refid="backend_2mfem_2inverse_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="22">
        <label>serif/solver/preconditioner/backend/mfem/inverse/diagonal.hpp</label>
        <link refid="preconditioner_2backend_2mfem_2inverse_2diagonal_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
      </node>
      <node id="25">
        <label>serif/solver/preconditioner/backend/mfem/inverse/regularization.hpp</label>
        <link refid="regularization_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
      </node>
      <node id="27">
        <label>serif/solver/preconditioner/backend/mfem/surface/calibrated_mass.hpp</label>
        <link refid="backend_2mfem_2surface_2calibrated__mass_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
      </node>
      <node id="26">
        <label>serif/solver/preconditioner/backend/mfem/surface/detail/calibration.hpp</label>
        <link refid="calibration_8hpp"/>
        <childnode refid="27" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>serif/solver/preconditioner/backend/mfem/surface/reference_mass.hpp</label>
        <link refid="backend_2mfem_2surface_2reference__mass_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>serif/solver/preconditioner/contract.hpp</label>
        <link refid="contract_8hpp"/>
      </node>
      <node id="9">
        <label>serif/solver/preconditioner/failure.hpp</label>
        <link refid="solver_2preconditioner_2failure_8hpp"/>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="23">
        <label>serif/solver/preconditioner/strategies/inverse/diagonal.hpp</label>
        <link refid="preconditioner_2strategies_2inverse_2diagonal_8hpp"/>
        <childnode refid="24" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
      </node>
      <node id="17">
        <label>serif/solver/preconditioner/strategies/inverse/diagonal_regularization.hpp</label>
        <link refid="diagonal__regularization_8hpp"/>
        <childnode refid="18" relation="include">
        </childnode>
      </node>
      <node id="19">
        <label>serif/solver/preconditioner/strategies/surface/calibrated_mass.hpp</label>
        <link refid="strategies_2surface_2calibrated__mass_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
      </node>
      <node id="20">
        <label>serif/solver/preconditioner/strategies/surface/reference_mass.hpp</label>
        <link refid="strategies_2surface_2reference__mass_8hpp"/>
        <childnode refid="17" relation="include">
        </childnode>
      </node>
      <node id="11">
        <label>serif/utils/error/codes.hpp</label>
        <link refid="codes_8hpp"/>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/lib/serif/solver/preconditioner/backend/mfem/surface/reference_mass.cpp</label>
        <link refid="reference__mass_8cpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
        <childnode refid="26" relation="include">
        </childnode>
      </node>
      <node id="18">
        <label>cstddef</label>
      </node>
      <node id="12">
        <label>cstdint</label>
      </node>
      <node id="3">
        <label>expected</label>
      </node>
      <node id="16">
        <label>magic_enum/magic_enum_all.hpp</label>
      </node>
      <node id="6">
        <label>memory</label>
      </node>
      <node id="7">
        <label>mfem/linalg/operator.hpp</label>
      </node>
      <node id="24">
        <label>optional</label>
      </node>
      <node id="4">
        <label>span</label>
      </node>
      <node id="10">
        <label>string</label>
      </node>
      <node id="15">
        <label>type_traits</label>
      </node>
      <node id="14">
        <label>unordered_map</label>
      </node>
      <node id="21">
        <label>vector</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_2surface_2reference__mass_8hpp" kindref="compound">serif/solver/preconditioner/backend/mfem/surface/reference_mass.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;vector&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="preconditioner_2backend_2mfem_2inverse_2diagonal_8hpp" kindref="compound">serif/solver/preconditioner/backend/mfem/inverse/diagonal.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="regularization_8hpp" kindref="compound">serif/solver/preconditioner/backend/mfem/inverse/regularization.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="calibration_8hpp" kindref="compound">serif/solver/preconditioner/backend/mfem/surface/detail/calibration.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"><highlight class="normal"><sp/><sp/><sp/><sp/>std::expected&lt;SurfaceMassInverse,<sp/>Failure&gt;<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_1a1d323db538f9dec160664c6b62e6122b" kindref="member">detail::surface_mass_inverse</ref>(std::span&lt;const<sp/>double&gt;<sp/>metric,<sp/>strategies::surface::SurfaceMassFit<sp/>fit,<sp/>strategies::inverse::DiagonalRegularization<sp/>regularization)</highlight></codeline>
<codeline lineno="11"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;double&gt;<sp/>scaled(metric.size());</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">for</highlight><highlight class="normal"><sp/>(std::size_t<sp/>index<sp/>=<sp/>0;<sp/><ref refid="namespaceserif_1_1operators_1_1backend_1_1mfem_1ab297c6eedd8df878b6af2135b05e4616" kindref="member">index</ref><sp/>&lt;<sp/>metric.size();<sp/>++<ref refid="namespaceserif_1_1operators_1_1backend_1_1mfem_1ab297c6eedd8df878b6af2135b05e4616" kindref="member">index</ref>)</highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>scaled[<ref refid="namespaceserif_1_1operators_1_1backend_1_1mfem_1ab297c6eedd8df878b6af2135b05e4616" kindref="member">index</ref>]<sp/>=<sp/>metric[<ref refid="namespaceserif_1_1operators_1_1backend_1_1mfem_1ab297c6eedd8df878b6af2135b05e4616" kindref="member">index</ref>]<sp/>*<sp/>fit.scale;</highlight></codeline>
<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="17"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/>diagonal<sp/>=<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1afa442491abcdf9e4cfa770c6483feb33" kindref="member">try_regularize_diagonal</ref>(scaled,<sp/>regularization);</highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(!diagonal)</highlight></codeline>
<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="20"><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/>std::unexpected(diagonal.error());</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/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1computations_1a4e68f4ddc06181dc9077cb41a6c795d5" kindref="member">inverse</ref><sp/>=<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1a7ef085da7f588183a15325cdcf5b3c9e" kindref="member">try_diagonal_inverse</ref>(diagonal-&gt;values);</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(!inverse)</highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="25"><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/>std::unexpected(<ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1computations_1a4e68f4ddc06181dc9077cb41a6c795d5" kindref="member">inverse</ref>.error());</highlight></codeline>
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1_surface_mass_inverse" kindref="compound">SurfaceMassInverse</ref>{.inverse<sp/>=<sp/>*<ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1computations_1a4e68f4ddc06181dc9077cb41a6c795d5" kindref="member">inverse</ref>,<sp/>.fit<sp/>=<sp/>fit,<sp/>.regularization<sp/>=<sp/>diagonal-&gt;report};</highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="29"><highlight class="normal"></highlight></codeline>
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/>std::expected&lt;SurfaceMassInverse,<sp/>Failure&gt;<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1af5aa239965d4f5ff8922c42492abd16b" kindref="member">try_reference_surface_mass_inverse</ref>(std::span&lt;const<sp/>double&gt;<sp/>reference_metric,<sp/>strategies::surface::ReferenceSurfaceMass<sp/>options)</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="keywordflow">if</highlight><highlight class="normal"><sp/>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/>valid<sp/>=<sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1_1backend_1_1mfem_1_1detail_1a22124f4d33fc43b754f0eaf82aba5039" kindref="member">detail::validate_surface_metric</ref>(reference_metric);<sp/>!valid)</highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="34"><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/>std::unexpected(valid.error());</highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><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_1a1d323db538f9dec160664c6b62e6122b" kindref="member">detail::surface_mass_inverse</ref>(reference_metric,<sp/>{},<sp/>options.regularization);</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="38"><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/solver/preconditioner/backend/mfem/surface/reference_mass.cpp"/>
  </compounddef>
</doxygen>