MeanField_SERiF/docs/xml/backend_2mfem_2geometry__step_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="backend_2mfem_2geometry__step_8hpp" kind="file" language="C++">
    <compoundname>geometry_step.hpp</compoundname>
    <includes local="no">expected</includes>
    <includes local="no">span</includes>
    <includes refid="geometry_2deformation_2failure_8hpp" local="yes">serif/geometry/deformation/failure.hpp</includes>
    <includes refid="geometry__step_8hpp" local="yes">serif/geometry/deformation/geometry_step.hpp</includes>
    <includedby refid="geometry__step_8cpp" local="yes">src/lib/serif/geometry/deformation/backend/mfem/geometry_step.cpp</includedby>
    <incdepgraph>
      <node id="1">
        <label>src/include/serif/geometry/deformation/backend/mfem/geometry_step.hpp</label>
        <link refid="backend_2mfem_2geometry__step_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>serif/geometry/deformation/failure.hpp</label>
        <link refid="geometry_2deformation_2failure_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>serif/geometry/deformation/geometry_step.hpp</label>
        <link refid="geometry__step_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="7">
        <label>cstddef</label>
      </node>
      <node id="2">
        <label>expected</label>
      </node>
      <node id="8">
        <label>limits</label>
      </node>
      <node id="3">
        <label>span</label>
      </node>
      <node id="5">
        <label>string</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="1">
        <label>src/include/serif/geometry/deformation/backend/mfem/geometry_step.hpp</label>
        <link refid="backend_2mfem_2geometry__step_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>src/lib/serif/geometry/deformation/backend/mfem/geometry_step.cpp</label>
        <link refid="geometry__step_8cpp"/>
      </node>
    </invincdepgraph>
    <innerclass refid="structserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1_geometry_sample_rule" prot="public">serif::geometry::deformation::backend::mfem::GeometrySampleRule</innerclass>
    <innernamespace refid="namespacemfem">mfem</innernamespace>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1mapping">serif::mapping</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>
    <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><highlight class="preprocessor">#include<sp/>&lt;span&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><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="7"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="geometry__step_8hpp" kindref="compound">serif/geometry/deformation/geometry_step.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="8"><highlight class="normal"></highlight></codeline>
<codeline lineno="9"><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="10"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal">FiniteElementSpace;</highlight></codeline>
<codeline lineno="11"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal">GridFunction;</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal">IntegrationRule;</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1operators_1_1backend_1_1mfem_1a317d4e0bea2ef8780ac3747cfe62bf72" kindref="member">Vector</ref>;</highlight></codeline>
<codeline lineno="14"><highlight class="normal">}</highlight></codeline>
<codeline lineno="15"><highlight class="normal"></highlight></codeline>
<codeline lineno="16"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1mapping" kindref="compound">serif::mapping</ref><sp/>{</highlight></codeline>
<codeline lineno="17"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1mapping_1_1_domain_mapper" kindref="compound">DomainMapper</ref>;</highlight></codeline>
<codeline lineno="18"><highlight class="normal">}</highlight></codeline>
<codeline lineno="19"><highlight class="normal"></highlight></codeline>
<codeline lineno="20"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem" kindref="compound">serif::geometry::deformation::backend::mfem</ref><sp/>{</highlight></codeline>
<codeline lineno="22" refid="structserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1_geometry_sample_rule" 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_1_geometry_sample_rule" kindref="compound">GeometrySampleRule</ref><sp/>{</highlight></codeline>
<codeline lineno="23"><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_1_geometry_sample_rule_1a38f709325a0dc906aa1061906ce7d2a7" kindref="member">element</ref>;</highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>const<sp/>::mfem::IntegrationRule*<sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1_geometry_sample_rule_1a53ef551925e56dab19714707606902a8" kindref="member">integration_rule</ref>;</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="26"><highlight class="normal"></highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;GeometryStepLimit,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1ac4ca6d2962b7c60c015fb04baf8cfc6a" kindref="member">estimate_geometry_step_limit</ref>(</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1mapping_1_1_domain_mapper" kindref="compound">mapping::DomainMapper</ref>&amp;<sp/>mapper,</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>const<sp/>::mfem::FiniteElementSpace&amp;<sp/>displacement_space,</highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>const<sp/>::mfem::GridFunction&amp;<sp/>compactification_coordinate,</highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>const<sp/>::mfem::Vector&amp;<sp/>accepted_displacement,</highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>const<sp/>::mfem::Vector&amp;<sp/>displacement_direction,</highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::span&lt;const<sp/>GeometrySampleRule&gt;<sp/>sample_rules,</highlight></codeline>
<codeline lineno="42"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1_geometry_step_options" kindref="compound">GeometryStepOptions</ref><sp/>options<sp/>=<sp/>{}</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/>);</highlight></codeline>
<codeline lineno="44"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="src/include/serif/geometry/deformation/backend/mfem/geometry_step.hpp"/>
  </compounddef>
</doxygen>