MeanField_SERiF/docs/xml/failure_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="failure_8hpp" kind="file" language="C++">
    <compoundname>failure.hpp</compoundname>
    <includes local="no">expected</includes>
    <includes local="no">string</includes>
    <includedby refid="actions_8hpp" local="yes">src/include/serif/geometry/deformation/actions.hpp</includedby>
    <includedby refid="radial__locator_8hpp" local="yes">src/include/serif/geometry/deformation/backend/mfem/detail/radial_locator.hpp</includedby>
    <includedby refid="backend_2mfem_2geometry__step_8hpp" local="yes">src/include/serif/geometry/deformation/backend/mfem/geometry_step.hpp</includedby>
    <includedby refid="reference__geometry_8hpp" local="yes">src/include/serif/geometry/deformation/backend/mfem/reference_geometry.hpp</includedby>
    <includedby refid="surface__metric_8hpp" local="yes">src/include/serif/geometry/deformation/backend/mfem/surface_metric.hpp</includedby>
    <includedby refid="action__storage_8hpp" local="yes">src/include/serif/geometry/deformation/detail/action_storage.hpp</includedby>
    <includedby refid="radial__interpolation_8hpp" local="yes">src/include/serif/geometry/deformation/radial_interpolation.hpp</includedby>
    <includedby refid="surface__embedding_8hpp" local="yes">src/include/serif/geometry/deformation/surface_embedding.hpp</includedby>
    <incdepgraph>
      <node id="1">
        <label>src/include/serif/geometry/deformation/failure.hpp</label>
        <link refid="failure_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>expected</label>
      </node>
      <node id="3">
        <label>string</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="3">
        <label>src/compile_time_checks/serif/geometry/deformation.cpp</label>
        <link refid="deformation_8cpp"/>
      </node>
      <node id="4">
        <label>src/compile_time_checks/serif/geometry/deformation_meanfield.cpp</label>
        <link refid="deformation__meanfield_8cpp"/>
      </node>
      <node id="2">
        <label>src/include/serif/geometry/deformation/actions.hpp</label>
        <link refid="actions_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>src/include/serif/geometry/deformation/backend/mfem/computations.hpp</label>
        <link refid="geometry_2deformation_2backend_2mfem_2computations_8hpp"/>
      </node>
      <node id="15">
        <label>src/include/serif/geometry/deformation/backend/mfem/detail/radial_locator.hpp</label>
        <link refid="radial__locator_8hpp"/>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
      </node>
      <node id="13">
        <label>src/include/serif/geometry/deformation/backend/mfem/geometry_inspection.hpp</label>
        <link refid="backend_2mfem_2geometry__inspection_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="18">
        <label>src/include/serif/geometry/deformation/backend/mfem/geometry_step.hpp</label>
        <link refid="backend_2mfem_2geometry__step_8hpp"/>
        <childnode refid="19" relation="include">
        </childnode>
      </node>
      <node id="7">
        <label>src/include/serif/geometry/deformation/backend/mfem/inputs.hpp</label>
        <link refid="inputs_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
      </node>
      <node id="21">
        <label>src/include/serif/geometry/deformation/backend/mfem/radial_interpolation.hpp</label>
        <link refid="backend_2mfem_2radial__interpolation_8hpp"/>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
      </node>
      <node id="20">
        <label>src/include/serif/geometry/deformation/backend/mfem/reference_geometry.hpp</label>
        <link refid="reference__geometry_8hpp"/>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
      </node>
      <node id="24">
        <label>src/include/serif/geometry/deformation/backend/mfem/surface_metric.hpp</label>
        <link refid="surface__metric_8hpp"/>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
      </node>
      <node id="9">
        <label>src/include/serif/geometry/deformation/backend/mfem/volume_displacement.hpp</label>
        <link refid="volume__displacement_8hpp"/>
      </node>
      <node id="5">
        <label>src/include/serif/geometry/deformation/composition.hpp</label>
        <link refid="composition_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>src/include/serif/geometry/deformation/computations.hpp</label>
        <link refid="geometry_2deformation_2computations_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="11">
        <label>src/include/serif/geometry/deformation/deformation.hpp</label>
        <link refid="deformation_8hpp"/>
      </node>
      <node id="25">
        <label>src/include/serif/geometry/deformation/detail/action_storage.hpp</label>
        <link refid="action__storage_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="27" relation="include">
        </childnode>
      </node>
      <node id="32">
        <label>src/include/serif/geometry/deformation/detail/harmonics.hpp</label>
        <link refid="harmonics_8hpp"/>
        <childnode refid="33" relation="include">
        </childnode>
        <childnode refid="27" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/geometry/deformation/failure.hpp</label>
        <link refid="failure_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
        <childnode refid="28" relation="include">
        </childnode>
        <childnode refid="31" relation="include">
        </childnode>
      </node>
      <node id="12">
        <label>src/include/serif/geometry/deformation/linearization.hpp</label>
        <link refid="deformation_2linearization_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="29">
        <label>src/include/serif/geometry/deformation/radial_extension.hpp</label>
        <link refid="radial__extension_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="26" relation="include">
        </childnode>
      </node>
      <node id="28">
        <label>src/include/serif/geometry/deformation/radial_interpolation.hpp</label>
        <link refid="radial__interpolation_8hpp"/>
        <childnode refid="29" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
      </node>
      <node id="31">
        <label>src/include/serif/geometry/deformation/surface_embedding.hpp</label>
        <link refid="surface__embedding_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="32" relation="include">
        </childnode>
        <childnode refid="27" relation="include">
        </childnode>
      </node>
      <node id="14">
        <label>src/lib/serif/geometry/deformation/backend/mfem/geometry_inspection.cpp</label>
        <link refid="geometry__inspection_8cpp"/>
      </node>
      <node id="19">
        <label>src/lib/serif/geometry/deformation/backend/mfem/geometry_step.cpp</label>
        <link refid="geometry__step_8cpp"/>
      </node>
      <node id="10">
        <label>src/lib/serif/geometry/deformation/backend/mfem/inputs.cpp</label>
        <link refid="inputs_8cpp"/>
      </node>
      <node id="16">
        <label>src/lib/serif/geometry/deformation/backend/mfem/radial_interpolation.cpp</label>
        <link refid="backend_2mfem_2radial__interpolation_8cpp"/>
      </node>
      <node id="17">
        <label>src/lib/serif/geometry/deformation/backend/mfem/radial_locator.cpp</label>
        <link refid="radial__locator_8cpp"/>
      </node>
      <node id="22">
        <label>src/lib/serif/geometry/deformation/backend/mfem/reference_geometry.cpp</label>
        <link refid="reference__geometry_8cpp"/>
      </node>
      <node id="23">
        <label>src/lib/serif/geometry/deformation/backend/mfem/surface_metric.cpp</label>
        <link refid="surface__metric_8cpp"/>
      </node>
      <node id="33">
        <label>src/lib/serif/geometry/deformation/harmonics.cpp</label>
        <link refid="harmonics_8cpp"/>
      </node>
      <node id="26">
        <label>src/lib/serif/geometry/deformation/radial_extension.cpp</label>
        <link refid="radial__extension_8cpp"/>
      </node>
      <node id="30">
        <label>src/lib/serif/geometry/deformation/radial_interpolation.cpp</label>
        <link refid="radial__interpolation_8cpp"/>
      </node>
      <node id="27">
        <label>src/lib/serif/geometry/deformation/surface_embedding.cpp</label>
        <link refid="surface__embedding_8cpp"/>
      </node>
    </invincdepgraph>
    <innerclass refid="structserif_1_1geometry_1_1deformation_1_1_deformation_failure" prot="public">serif::geometry::deformation::DeformationFailure</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;expected&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;string&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><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><sp/>{</highlight></codeline>
<codeline lineno="7"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">enum<sp/>class</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1abff36c0dd3d8b9c916a2e928ab69a871" kindref="member">DeformationFailureReason</ref><sp/>{</highlight></codeline>
<codeline lineno="8"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1abff36c0dd3d8b9c916a2e928ab69a871a9cc57114b319994e90322314a00521d4" kindref="member">invalid_configuration</ref>,</highlight></codeline>
<codeline lineno="9"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1abff36c0dd3d8b9c916a2e928ab69a871ad73416fa06a45d748a7c8d4349054cbb" kindref="member">incompatible_discretization</ref>,</highlight></codeline>
<codeline lineno="10"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1abff36c0dd3d8b9c916a2e928ab69a871a0181b84c792eb178181854d09c8fe7b9" kindref="member">invalid_size</ref>,</highlight></codeline>
<codeline lineno="11"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1abff36c0dd3d8b9c916a2e928ab69a871a4013d0a2d04acba5257678a15922a094" kindref="member">non_finite</ref>,</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1abff36c0dd3d8b9c916a2e928ab69a871a9a8a2ae86e6fce17b9be87ec37249370" kindref="member">unresolved_surface</ref>,</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1abff36c0dd3d8b9c916a2e928ab69a871a146816aaee11d5a21b09baac60c9812e" kindref="member">invalid_geometry</ref></highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="15"><highlight class="normal"></highlight></codeline>
<codeline lineno="17" refid="structserif_1_1geometry_1_1deformation_1_1_deformation_failure" 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_deformation_failure" kindref="compound">DeformationFailure</ref><sp/>{</highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1abff36c0dd3d8b9c916a2e928ab69a871" kindref="member">DeformationFailureReason</ref><sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1_deformation_failure_1a2eeff73cedb8a83360918741db064ac0" kindref="member">reason</ref>;</highlight></codeline>
<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::string<sp/><ref refid="structserif_1_1geometry_1_1deformation_1_1_deformation_failure_1abf81bab9e7aa03e650af4ff00f95cd8d" kindref="member">message</ref>;</highlight></codeline>
<codeline lineno="20"><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_1_deformation_failure_1ab8b08f64bda4b66c66a5f3b05d7d6f0d" kindref="member">element</ref>{-1};</highlight></codeline>
<codeline lineno="21"><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_1_deformation_failure_1a37e16469c596cb498a0f6d3704951b17" kindref="member">point</ref>{-1};</highlight></codeline>
<codeline lineno="22"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="23"><highlight class="normal"></highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1geometry_1_1deformation_1a08306ee593c172f4877facc061e98f97" kindref="member">DeformationStatus</ref><sp/>=<sp/>std::expected&lt;void,<sp/>DeformationFailure&gt;;</highlight></codeline>
<codeline lineno="25"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="src/include/serif/geometry/deformation/failure.hpp"/>
  </compounddef>
</doxygen>