Files
MeanField_SERiF/docs/xml/backend_2mfem_2geometry__inspection_8hpp.xml

236 lines
21 KiB
XML
Raw Normal View History

<?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__inspection_8hpp" kind="file" language="C++">
<compoundname>geometry_inspection.hpp</compoundname>
<includes local="no">expected</includes>
<includes local="no">span</includes>
<includes local="no">utility</includes>
<includes local="yes">mfem/fem/fespace.hpp</includes>
<includes refid="geometry__inspection_8hpp" local="yes">serif/geometry/deformation/geometry_inspection.hpp</includes>
<includes refid="deformation_2linearization_8hpp" local="yes">serif/geometry/deformation/linearization.hpp</includes>
<includedby refid="compile__time__checks_2serif_2geometry_2deformation_8cpp" local="yes">src/compile_time_checks/serif/geometry/deformation.cpp</includedby>
<includedby refid="geometry__inspection_8cpp" local="yes">src/lib/serif/geometry/deformation/backend/mfem/geometry_inspection.cpp</includedby>
<incdepgraph>
<node id="13">
<label>serif/geometry/deformation/actions.hpp</label>
<link refid="geometry_2deformation_2actions_8hpp"/>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="18" relation="include">
</childnode>
<childnode refid="21" relation="include">
</childnode>
<childnode refid="22" relation="include">
</childnode>
</node>
<node id="1">
<label>src/include/serif/geometry/deformation/backend/mfem/geometry_inspection.hpp</label>
<link refid="backend_2mfem_2geometry__inspection_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
</node>
<node id="18">
<label>serif/geometry/deformation/detail/action_storage.hpp</label>
<link refid="action__storage_8hpp"/>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="19" relation="include">
</childnode>
<childnode refid="20" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
</node>
<node id="16">
<label>serif/geometry/deformation/failure.hpp</label>
<link refid="geometry_2deformation_2failure_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
</node>
<node id="6">
<label>serif/geometry/deformation/geometry_inspection.hpp</label>
<link refid="geometry__inspection_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
</node>
<node id="11">
<label>serif/geometry/deformation/linearization.hpp</label>
<link refid="deformation_2linearization_8hpp"/>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="21">
<label>serif/geometry/deformation/spaces.hpp</label>
<link refid="spaces_8hpp"/>
</node>
<node id="22">
<label>serif/geometry/deformation/workspace.hpp</label>
<link refid="geometry_2deformation_2workspace_8hpp"/>
</node>
<node id="14">
<label>algorithm</label>
</node>
<node id="7">
<label>cmath</label>
</node>
<node id="15">
<label>concepts</label>
</node>
<node id="8">
<label>cstddef</label>
</node>
<node id="2">
<label>expected</label>
</node>
<node id="19">
<label>functional</label>
</node>
<node id="20">
<label>initializer_list</label>
</node>
<node id="9">
<label>limits</label>
</node>
<node id="12">
<label>memory</label>
</node>
<node id="5">
<label>mfem/fem/fespace.hpp</label>
</node>
<node id="3">
<label>span</label>
</node>
<node id="17">
<label>string</label>
</node>
<node id="4">
<label>utility</label>
</node>
<node id="10">
<label>vector</label>
</node>
</incdepgraph>
<invincdepgraph>
<node id="2">
<label>src/compile_time_checks/serif/geometry/deformation.cpp</label>
<link refid="compile__time__checks_2serif_2geometry_2deformation_8cpp"/>
</node>
<node id="1">
<label>src/include/serif/geometry/deformation/backend/mfem/geometry_inspection.hpp</label>
<link refid="backend_2mfem_2geometry__inspection_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
</node>
<node id="3">
<label>src/lib/serif/geometry/deformation/backend/mfem/geometry_inspection.cpp</label>
<link refid="geometry__inspection_8cpp"/>
</node>
</invincdepgraph>
<innernamespace refid="namespaceserif">serif</innernamespace>
<innernamespace refid="namespaceserif_1_1discretization">serif::discretization</innernamespace>
<innernamespace refid="namespaceserif_1_1discretization_1_1backend">serif::discretization::backend</innernamespace>
<innernamespace refid="namespaceserif_1_1discretization_1_1backend_1_1mfem">serif::discretization::backend::mfem</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><highlight class="preprocessor">#include<sp/>&lt;utility&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;mfem/fem/fespace.hpp&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="8"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="geometry__inspection_8hpp" kindref="compound">serif/geometry/deformation/geometry_inspection.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="9"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="deformation_2linearization_8hpp" kindref="compound">serif/geometry/deformation/linearization.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="10"><highlight class="normal"></highlight></codeline>
<codeline lineno="11"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1discretization_1_1backend_1_1mfem" kindref="compound">serif::discretization::backend::mfem</ref></highlight></codeline>
<codeline lineno="12"><highlight class="normal">{</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1discretization_1_1backend_1_1mfem_1_1_tensor_basis_cache" kindref="compound">TensorBasisCache</ref>;</highlight></codeline>
<codeline lineno="14"><highlight class="normal">}</highlight></codeline>
<codeline lineno="15"><highlight class="normal"></highlight></codeline>
<codeline lineno="16" refid="namespaceserif_1_1mapping" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1mapping" kindref="compound">serif::mapping</ref></highlight></codeline>
<codeline lineno="17"><highlight class="normal">{</highlight></codeline>
<codeline lineno="18"><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="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" kindref="compound">serif::geometry::deformation::backend::mfem</ref></highlight></codeline>
<codeline lineno="22"><highlight class="normal">{</highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;DeformationGeometryReport,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1aef20e8c17f47349faa80aa0b85575842" kindref="member">inspect_deformation_geometry</ref>(const<sp/>::mfem::FiniteElementSpace&amp;<sp/>displacement_space,<sp/>const<sp/>::mfem::Vector&amp;<sp/>displacement);</highlight></codeline>
<codeline lineno="32"><highlight class="normal"></highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;DeformationGeometryReport,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1aef20e8c17f47349faa80aa0b85575842" kindref="member">inspect_deformation_geometry</ref>(const<sp/>::mfem::FiniteElementSpace&amp;<sp/>displacement_space,<sp/>const<sp/>::mfem::Vector&amp;<sp/>displacement,<sp/><ref refid="classserif_1_1discretization_1_1backend_1_1mfem_1_1_tensor_basis_cache" kindref="compound">discretization::backend::mfem::TensorBasisCache</ref>&amp;<sp/>basis_cache,<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>*<sp/>reference_geometry<sp/>=<sp/></highlight><highlight class="keyword">nullptr</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="40"><highlight class="normal"></highlight></codeline>
<codeline lineno="42"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;DeformationGeometryReport,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1aef20e8c17f47349faa80aa0b85575842" kindref="member">inspect_deformation_geometry</ref>(const<sp/>::mfem::FiniteElementSpace&amp;<sp/>displacement_space,<sp/>std::span&lt;const<sp/>double&gt;<sp/>displacement,<sp/>::mfem::Ordering::Type<sp/>coefficient_ordering);</highlight></codeline>
<codeline lineno="43"><highlight class="normal"></highlight></codeline>
<codeline lineno="45"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;DeformationGeometryReport,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1aef20e8c17f47349faa80aa0b85575842" kindref="member">inspect_deformation_geometry</ref>(const<sp/>::mfem::FiniteElementSpace&amp;<sp/>displacement_space,<sp/>std::span&lt;const<sp/>double&gt;<sp/>displacement,<sp/>::mfem::Ordering::Type<sp/>coefficient_ordering,<sp/><ref refid="classserif_1_1discretization_1_1backend_1_1mfem_1_1_tensor_basis_cache" kindref="compound">discretization::backend::mfem::TensorBasisCache</ref>&amp;<sp/>basis_cache,<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>*<sp/>reference_geometry<sp/>=<sp/></highlight><highlight class="keyword">nullptr</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="46"><highlight class="normal"></highlight></codeline>
<codeline lineno="52"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;DeformationMap<sp/>Map&gt;</highlight></codeline>
<codeline lineno="53"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">requires</highlight><highlight class="normal"><sp/>std::same_as&lt;typename<sp/>Map::OutputSpace,<sp/>spaces::VolumeDisplacement&gt;</highlight></codeline>
<codeline lineno="54"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;ValidatedDisplacement,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1a609b4d83a3a4476e889a5e7613e8d556" kindref="member">build_validated_displacement</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>Map&amp;<sp/>map,<sp/>std::span&lt;const<sp/>double&gt;<sp/>parameters,<sp/>const<sp/>::mfem::FiniteElementSpace&amp;<sp/>displacement_space,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>determinant_floor<sp/>=<sp/>0.0)</highlight></codeline>
<codeline lineno="55"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="56"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(!std::isfinite(determinant_floor)<sp/>||<sp/>determinant_floor<sp/>&lt;<sp/>0.0)</highlight></codeline>
<codeline lineno="57"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="58"><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(DeformationFailure{.reason<sp/>=<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1abff36c0dd3d8b9c916a2e928ab69a871a9cc57114b319994e90322314a00521d4" kindref="member">DeformationFailureReason::invalid_configuration</ref>,<sp/>.message<sp/>=<sp/></highlight><highlight class="stringliteral">&quot;Deformation<sp/>geometry<sp/>validation<sp/>requires<sp/>a<sp/>finite,<sp/>nonnegative<sp/>determinant<sp/>floor.&quot;</highlight><highlight class="normal">});</highlight></codeline>
<codeline lineno="59"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="60"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/>displacement<sp/>=<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1a7c97f13afaf99ecbde93c21ab3f9f771" kindref="member">evaluate_displacement</ref>(map,<sp/>parameters);</highlight></codeline>
<codeline lineno="61"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(!displacement)</highlight></codeline>
<codeline lineno="62"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="63"><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(displacement.error());</highlight></codeline>
<codeline lineno="64"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="65"><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/>geometry<sp/>=<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1aef20e8c17f47349faa80aa0b85575842" kindref="member">inspect_deformation_geometry</ref>(displacement_space,<sp/>*displacement,<sp/>::mfem::Ordering::byNODES);</highlight></codeline>
<codeline lineno="66"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(!geometry)</highlight></codeline>
<codeline lineno="67"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="68"><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(geometry.error());</highlight></codeline>
<codeline lineno="69"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="70"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(!geometry-&gt;is_orientation_preserving(determinant_floor))</highlight></codeline>
<codeline lineno="71"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="72"><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(DeformationFailure{.reason<sp/>=<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1abff36c0dd3d8b9c916a2e928ab69a871a146816aaee11d5a21b09baac60c9812e" kindref="member">DeformationFailureReason::invalid_geometry</ref>,<sp/>.message<sp/>=<sp/></highlight><highlight class="stringliteral">&quot;The<sp/>generated<sp/>displacement<sp/>does<sp/>not<sp/>remain<sp/>strictly<sp/>above<sp/>the<sp/>determinant<sp/>floor<sp/>at<sp/>every<sp/>sampled<sp/>volume<sp/>point.&quot;</highlight><highlight class="normal">,<sp/>.element<sp/>=<sp/>geometry-&gt;minimum_element,<sp/>.point<sp/>=<sp/>geometry-&gt;minimum_point});</highlight></codeline>
<codeline lineno="73"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="74"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>ValidatedDisplacement{.displacement<sp/>=<sp/>std::move(*displacement),<sp/>.geometry<sp/>=<sp/>*geometry};</highlight></codeline>
<codeline lineno="75"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="76"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>serif::geometry::deformation::backend::mfem</highlight><highlight class="normal"></highlight></codeline>
</programlisting>
<location file="src/include/serif/geometry/deformation/backend/mfem/geometry_inspection.hpp"/>
</compounddef>
</doxygen>