MeanField_SERiF/docs/xml/radial__locator_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__locator_8hpp" kind="file" language="C++">
    <compoundname>radial_locator.hpp</compoundname>
    <includes local="yes">mfem/fem/intrules.hpp</includes>
    <includes local="yes">mfem/linalg/vector.hpp</includes>
    <includes refid="geometry_2deformation_2failure_8hpp" local="yes">serif/geometry/deformation/failure.hpp</includes>
    <includedby refid="backend_2mfem_2geometry_2deformation_2radial__interpolation_8cpp" local="yes">src/lib/serif/backend/mfem/geometry/deformation/radial_interpolation.cpp</includedby>
    <includedby refid="radial__locator_8cpp" local="yes">src/lib/serif/backend/mfem/geometry/deformation/radial_locator.cpp</includedby>
    <incdepgraph>
      <node id="1">
        <label>src/include/serif/backend/mfem/geometry/deformation/detail/radial_locator.hpp</label>
        <link refid="radial__locator_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <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="5">
        <label>expected</label>
      </node>
      <node id="2">
        <label>mfem/fem/intrules.hpp</label>
      </node>
      <node id="3">
        <label>mfem/linalg/vector.hpp</label>
      </node>
      <node id="6">
        <label>string</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="1">
        <label>src/include/serif/backend/mfem/geometry/deformation/detail/radial_locator.hpp</label>
        <link refid="radial__locator_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>src/lib/serif/backend/mfem/geometry/deformation/radial_interpolation.cpp</label>
        <link refid="backend_2mfem_2geometry_2deformation_2radial__interpolation_8cpp"/>
      </node>
      <node id="3">
        <label>src/lib/serif/backend/mfem/geometry/deformation/radial_locator.cpp</label>
        <link refid="radial__locator_8cpp"/>
      </node>
    </invincdepgraph>
    <innerclass refid="structserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_1_1_located_boundary_point" prot="public">serif::geometry::deformation::backend::mfem::detail::LocatedBoundaryPoint</innerclass>
    <innernamespace refid="namespacemfem">mfem</innernamespace>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1geometry">serif::geometry</innernamespace>
    <innernamespace refid="namespaceserif_1_1geometry_1_1deformation">serif::geometry::deformation</innernamespace>
    <innernamespace refid="namespaceserif_1_1geometry_1_1deformation_1_1backend">serif::geometry::deformation::backend</innernamespace>
    <innernamespace refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem">serif::geometry::deformation::backend::mfem</innernamespace>
    <innernamespace refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail">serif::geometry::deformation::backend::mfem::detail</innernamespace>
    <briefdescription>
<para>File containing some utility functions for locating points on a radial shell. </para>
    </briefdescription>
    <detaileddescription>
<para><simplesect kind="author"><para>Emily M. Boudreaux </para>
</simplesect>
</para>
    </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="9"><highlight class="normal"></highlight></codeline>
<codeline lineno="10"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;mfem/fem/intrules.hpp&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="11"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;mfem/linalg/vector.hpp&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="12"><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="13"><highlight class="normal"></highlight></codeline>
<codeline lineno="14"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespacemfem" kindref="compound">mfem</ref><sp/>{</highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal">Mesh;</highlight></codeline>
<codeline lineno="19"><highlight class="normal">}</highlight></codeline>
<codeline lineno="20"><highlight class="normal"></highlight></codeline>
<codeline lineno="21"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail" kindref="compound">serif::geometry::deformation::backend::mfem::detail</ref><sp/>{</highlight></codeline>
<codeline lineno="26" refid="structserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_1_1_located_boundary_point" 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_1backend_1_1mfem_1_1detail_1_1_located_boundary_point" kindref="compound">LocatedBoundaryPoint</ref><sp/>{</highlight></codeline>
<codeline lineno="27"><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_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_1_1_located_boundary_point_1a45a2eb3f40c3df6785351f902b4ebf98" kindref="member">boundary_element</ref>;<sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>::mfem::IntegrationPoint<sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_1_1_located_boundary_point_1a0145321c7786ec89b3e8869ee48bd01d" kindref="member">point</ref>;<sp/></highlight></codeline>
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="30"><highlight class="normal"></highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_1a6e6de6a39085122a94b23c06512e48e8" kindref="member">logical_radius</ref>(const<sp/>::mfem::Vector&amp;<sp/>position);</highlight></codeline>
<codeline lineno="39"><highlight class="normal"></highlight></codeline>
<codeline lineno="40"><highlight class="normal"></highlight></codeline>
<codeline lineno="63"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;double,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_1af74cbfc2f3db601dcb00258dace52361" kindref="member">boundary_logical_radius</ref>(::mfem::Mesh&amp;<sp/>mesh,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>attribute);</highlight></codeline>
<codeline lineno="64"><highlight class="normal"></highlight></codeline>
<codeline lineno="74"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;LocatedBoundaryPoint,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_1a82e9f8756275515ac2ba12399df8680a" kindref="member">locate_boundary_point</ref>(</highlight></codeline>
<codeline lineno="75"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>::mfem::Mesh&amp;<sp/>mesh,</highlight></codeline>
<codeline lineno="76"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>attribute,</highlight></codeline>
<codeline lineno="77"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>const<sp/>::mfem::Vector&amp;<sp/>target</highlight></codeline>
<codeline lineno="78"><highlight class="normal"><sp/><sp/><sp/><sp/>);</highlight></codeline>
<codeline lineno="79"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="src/include/serif/backend/mfem/geometry/deformation/detail/radial_locator.hpp"/>
  </compounddef>
</doxygen>