MeanField_SERiF/docs/xml/radial__interpolation_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="radial__interpolation_8hpp" kind="file" language="C++">
    <compoundname>radial_interpolation.hpp</compoundname>
    <includes local="no">utility</includes>
    <includes local="no">vector</includes>
    <includes refid="geometry_2deformation_2failure_8hpp" local="yes">serif/geometry/deformation/failure.hpp</includes>
    <includedby refid="radial__extension_8hpp" local="yes">src/include/serif/geometry/deformation/radial_extension.hpp</includedby>
    <includedby refid="radial__interpolation_8cpp" local="yes">src/lib/serif/geometry/deformation/radial_interpolation.cpp</includedby>
    <incdepgraph>
      <node id="4">
        <label>serif/geometry/deformation/failure.hpp</label>
        <link refid="geometry_2deformation_2failure_8hpp"/>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/geometry/deformation/radial_interpolation.hpp</label>
        <link refid="radial__interpolation_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="5">
        <label>expected</label>
      </node>
      <node id="6">
        <label>string</label>
      </node>
      <node id="2">
        <label>utility</label>
      </node>
      <node id="3">
        <label>vector</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="3">
        <label>src/compile_time_checks/serif/geometry/deformation.cpp</label>
        <link refid="compile__time__checks_2serif_2geometry_2deformation_8cpp"/>
      </node>
      <node id="5">
        <label>src/include/serif/geometry/deformation/backend/mfem/computations.hpp</label>
        <link refid="geometry_2deformation_2backend_2mfem_2computations_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>src/include/serif/geometry/deformation/backend/mfem/radial_interpolation.hpp</label>
        <link refid="backend_2mfem_2radial__interpolation_8hpp"/>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="10">
        <label>src/include/serif/geometry/deformation/deformation.hpp</label>
        <link refid="geometry_2deformation_2deformation_8hpp"/>
      </node>
      <node id="2">
        <label>src/include/serif/geometry/deformation/radial_extension.hpp</label>
        <link refid="radial__extension_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/geometry/deformation/radial_interpolation.hpp</label>
        <link refid="radial__interpolation_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
      </node>
      <node id="7">
        <label>src/include/serif/model/backend/mfem/equilibrium.hpp</label>
        <link refid="equilibrium_8hpp"/>
      </node>
      <node id="6">
        <label>src/include/serif/model/graph.hpp</label>
        <link refid="model_2graph_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>src/include/serif/model/normalization/computations.hpp</label>
        <link refid="model_2normalization_2computations_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="9">
        <label>src/lib/serif/geometry/deformation/backend/mfem/radial_interpolation.cpp</label>
        <link refid="backend_2mfem_2radial__interpolation_8cpp"/>
      </node>
      <node id="11">
        <label>src/lib/serif/geometry/deformation/radial_extension.cpp</label>
        <link refid="radial__extension_8cpp"/>
      </node>
      <node id="12">
        <label>src/lib/serif/geometry/deformation/radial_interpolation.cpp</label>
        <link refid="radial__interpolation_8cpp"/>
      </node>
    </invincdepgraph>
    <innerclass refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data" prot="public">serif::geometry::deformation::RadialInterpolationData</innerclass>
    <innerclass refid="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation" prot="public">serif::geometry::deformation::RadialInterpolation</innerclass>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1geometry">serif::geometry</innernamespace>
    <innernamespace refid="namespaceserif_1_1geometry_1_1deformation">serif::geometry::deformation</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;utility&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;vector&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="geometry_2deformation_2failure_8hpp" kindref="compound">serif/geometry/deformation/failure.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1geometry_1_1deformation" kindref="compound">serif::geometry::deformation</ref></highlight></codeline>
<codeline lineno="8"><highlight class="normal">{</highlight></codeline>
<codeline lineno="10" refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data" kindref="compound">RadialInterpolationData</ref></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;int&gt;<sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data_1a9c85ad741d523a9c60165920918416a5" kindref="member">surface_scalar_dofs</ref>;</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;int&gt;<sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data_1aee5926eace08a44b76cb1bf104103523" kindref="member">row_offsets</ref>;</highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;int&gt;<sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data_1a8dfb14a5fe5caee930bb0b63d6462822" kindref="member">surface_columns</ref>;</highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;double&gt;<sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data_1adfd4fabc734d82afd7c0afb214e106ab" kindref="member">interpolation_weights</ref>;</highlight></codeline>
<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;double&gt;<sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data_1ad0d752afb58d560dc9e365eed0b873b8" kindref="member">logical_radii</ref>;</highlight></codeline>
<codeline lineno="17"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;int&gt;<sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data_1a1ecec30ed6b7f2416b625cfbdcda787f" kindref="member">stellar_support</ref>;</highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;int&gt;<sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data_1a4b71723a00367fdcd42b5f4a30e50334" kindref="member">vacuum_support</ref>;</highlight></codeline>
<codeline lineno="19"><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_1geometry_1_1deformation_1_1_radial_interpolation_data_1a4aa149d98e4b478f648b41f0dbd84cb4" kindref="member">stellar_radius</ref>{};</highlight></codeline>
<codeline lineno="20"><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_1geometry_1_1deformation_1_1_radial_interpolation_data_1a94c25b7ba1f43bd96957b2b2fbc96fe4" kindref="member">infinity_radius</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="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1a9220d2db13c64133a59fe54b1c64989d" kindref="member">RadialInterpolation</ref></highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal">:</highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data" kindref="compound">RadialInterpolationData</ref>&amp;<sp/><ref refid="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1aa7f8cdc59a5dbafe8b11ca4552d886ce" kindref="member">data</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="30"><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="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1a2f26624eea3a35a5d88a222023bd7678" kindref="member">m_data</ref>;</highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="32"><highlight class="normal"></highlight></codeline>
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::size_t<sp/><ref refid="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1a0a26d55d7c8b2a06079004a9ce3b9e16" kindref="member">scalar_dof_count</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"></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/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1a2f26624eea3a35a5d88a222023bd7678" kindref="member">m_data</ref>.logical_radii.size();</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="38"><highlight class="normal"></highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::size_t<sp/><ref refid="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1aa492130de99595143678efa7c8abead1" kindref="member">surface_node_count</ref>()<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">noexcept</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="42"><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="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1a2f26624eea3a35a5d88a222023bd7678" kindref="member">m_data</ref>.surface_scalar_dofs.size();</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="44"><highlight class="normal"></highlight></codeline>
<codeline lineno="45"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">private</highlight><highlight class="normal">:</highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">explicit</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1a9220d2db13c64133a59fe54b1c64989d" kindref="member">RadialInterpolation</ref>(<ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data" kindref="compound">RadialInterpolationData</ref><sp/><ref refid="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1aa7f8cdc59a5dbafe8b11ca4552d886ce" kindref="member">data</ref>)<sp/>:<sp/><ref refid="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1a2f26624eea3a35a5d88a222023bd7678" kindref="member">m_data</ref>(std::move(<ref refid="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1aa7f8cdc59a5dbafe8b11ca4552d886ce" kindref="member">data</ref>))</highlight></codeline>
<codeline lineno="48"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="49"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="50"><highlight class="normal"></highlight></codeline>
<codeline lineno="51"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">friend</highlight><highlight class="normal"><sp/>std::expected&lt;RadialInterpolation,<sp/>DeformationFailure&gt;<sp/><ref refid="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1acfc8d067cc2b7c90f3943be69bcb3f9e" kindref="member">make_radial_interpolation</ref>(<ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data" kindref="compound">RadialInterpolationData</ref>);</highlight></codeline>
<codeline lineno="52"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data" kindref="compound">RadialInterpolationData</ref><sp/><ref refid="classserif_1_1geometry_1_1deformation_1_1_radial_interpolation_1a2f26624eea3a35a5d88a222023bd7678" kindref="member">m_data</ref>;</highlight></codeline>
<codeline lineno="53"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="54"><highlight class="normal"></highlight></codeline>
<codeline lineno="56"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;RadialInterpolation,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1a81d1d0df5d554d5af5149549b484a0bb" kindref="member">make_radial_interpolation</ref>(<ref refid="structserif_1_1geometry_1_1deformation_1_1_radial_interpolation_data" kindref="compound">RadialInterpolationData</ref><sp/>data);</highlight></codeline>
<codeline lineno="57"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>serif::geometry::deformation</highlight><highlight class="normal"></highlight></codeline>
    </programlisting>
    <location file="src/include/serif/geometry/deformation/radial_interpolation.hpp"/>
  </compounddef>
</doxygen>