Files
MeanField_SERiF/docs/xml/boundary__elements_8hpp.xml

139 lines
20 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="boundary__elements_8hpp" kind="file" language="C++">
<compoundname>boundary_elements.hpp</compoundname>
<includes local="no">expected</includes>
<includes local="no">span</includes>
<includes local="no">string</includes>
<includes local="no">vector</includes>
<includes local="yes">mfem/fem/fespace.hpp</includes>
<includedby refid="surface__metric_8cpp" local="yes">src/lib/serif/backend/mfem/geometry/deformation/surface_metric.cpp</includedby>
<includedby refid="surface__potential_8cpp" local="yes">src/lib/serif/backend/mfem/model/surface_potential.cpp</includedby>
<incdepgraph>
<node id="1">
<label>src/include/serif/backend/mfem/shared/boundary_elements.hpp</label>
<link refid="boundary__elements_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>
</node>
<node id="2">
<label>expected</label>
</node>
<node id="6">
<label>mfem/fem/fespace.hpp</label>
</node>
<node id="3">
<label>span</label>
</node>
<node id="4">
<label>string</label>
</node>
<node id="5">
<label>vector</label>
</node>
</incdepgraph>
<invincdepgraph>
<node id="1">
<label>src/include/serif/backend/mfem/shared/boundary_elements.hpp</label>
<link refid="boundary__elements_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/surface_metric.cpp</label>
<link refid="surface__metric_8cpp"/>
</node>
<node id="3">
<label>src/lib/serif/backend/mfem/model/surface_potential.cpp</label>
<link refid="surface__potential_8cpp"/>
</node>
</invincdepgraph>
<innerclass refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_failure" prot="public">serif::backend::mfem::shared::BoundaryFailure</innerclass>
<innerclass refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_element" prot="public">serif::backend::mfem::shared::BoundaryElement</innerclass>
<innernamespace refid="namespaceserif">serif</innernamespace>
<innernamespace refid="namespaceserif_1_1backend">serif::backend</innernamespace>
<innernamespace refid="namespaceserif_1_1backend_1_1mfem">serif::backend::mfem</innernamespace>
<innernamespace refid="namespaceserif_1_1backend_1_1mfem_1_1shared">serif::backend::mfem::shared</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;string&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;vector&gt;</highlight><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></codeline>
<codeline lineno="9" refid="namespaceserif_1_1backend_1_1mfem_1_1shared" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1backend_1_1mfem_1_1shared" kindref="compound">serif::backend::mfem::shared</ref><sp/>{</highlight></codeline>
<codeline lineno="11" refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_failure" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_failure" kindref="compound">BoundaryFailure</ref><sp/>{</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::string<sp/><ref refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_failure_1ae513edcff76756a87046c57f68fcdaf9" kindref="member">message</ref>;</highlight></codeline>
<codeline lineno="13"><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_1backend_1_1mfem_1_1shared_1_1_boundary_failure_1a90e788aed2ce9acb72341c129d740f25" kindref="member">element</ref>{-1};</highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_failure_1af7517e1961f59999ceb75ee2802bb422" kindref="member">incompatible_coordinates</ref>{</highlight><highlight class="keyword">true</highlight><highlight class="normal">};</highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="16"><highlight class="normal"></highlight></codeline>
<codeline lineno="17"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1backend_1_1mfem_1_1shared_1ac08e31847b8c14df596fc9f042a0ad86" kindref="member">BoundaryStatus</ref><sp/>=<sp/>std::expected&lt;void,<sp/>BoundaryFailure&gt;;</highlight></codeline>
<codeline lineno="18"><highlight class="normal"></highlight></codeline>
<codeline lineno="20" refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_element" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_element" kindref="compound">BoundaryElement</ref><sp/>{</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>const<sp/>::mfem::FiniteElement&amp;<sp/><ref refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_element_1a567ed77e57b22f8e7b25ebfc241e5767" kindref="member">finite_element</ref>;</highlight></codeline>
<codeline lineno="22"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>::mfem::ElementTransformation&amp;<sp/><ref refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_element_1aac1dfcba92803b256e31a3b3a1219347" kindref="member">transformation</ref>;</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::span&lt;const<sp/>int&gt;<sp/><ref refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_element_1a4cce21575398e6f9d79724df7a1fe084" kindref="member">encoded_dofs</ref>;</highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::span&lt;const<sp/>int&gt;<sp/><ref refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_element_1ae978d20351ffd91d8c6fb6f4640024b8" kindref="member">selected_nodes</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="32"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;</highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Visitor&gt;</highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="namespaceserif_1_1backend_1_1mfem_1_1shared_1ac08e31847b8c14df596fc9f042a0ad86" kindref="member">BoundaryStatus</ref><sp/><ref refid="namespaceserif_1_1backend_1_1mfem_1_1shared_1a0b26661efeb53975071cd4a89c916616" kindref="member">for_each_boundary_element</ref>(const<sp/>::mfem::FiniteElementSpace&amp;<sp/>space,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>attribute,<sp/>std::span&lt;const<sp/>int&gt;<sp/>selected_dofs,<sp/>Visitor&amp;&amp;<sp/>visit)<sp/>{</highlight></codeline>
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(space.GetMesh()<sp/>==<sp/></highlight><highlight class="keyword">nullptr</highlight><highlight class="normal">)<sp/>{</highlight></codeline>
<codeline lineno="35"><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(<ref refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_failure" kindref="compound">BoundaryFailure</ref>{.message<sp/>=<sp/></highlight><highlight class="stringliteral">&quot;Boundary<sp/>assembly<sp/>requires<sp/>a<sp/>finite-element<sp/>space<sp/>attached<sp/>to<sp/>a<sp/>mesh.&quot;</highlight><highlight class="normal">});</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;int&gt;<sp/>selected_index(space.GetNDofs(),<sp/>-1);</highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">for</highlight><highlight class="normal"><sp/>(std::size_t<sp/>node<sp/>=<sp/>0;<sp/>node<sp/>&lt;<sp/>selected_dofs.size();<sp/>++node)<sp/>{</highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>dof<sp/>=<sp/>selected_dofs[node];</highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(dof<sp/>&lt;<sp/>0<sp/>||<sp/>dof<sp/>&gt;=<sp/>space.GetNDofs()<sp/>||<sp/>selected_index[dof]<sp/>&gt;=<sp/>0)<sp/>{</highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>std::unexpected(BoundaryFailure{.message<sp/>=<sp/></highlight><highlight class="stringliteral">&quot;Boundary<sp/>assembly<sp/>requires<sp/>distinct<sp/>scalar<sp/>nodes<sp/>belonging<sp/>to<sp/>its<sp/>finite-element<sp/>space.&quot;</highlight><highlight class="normal">});</highlight></codeline>
<codeline lineno="42"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>selected_index[dof]<sp/>=<sp/></highlight><highlight class="keyword">static_cast&lt;</highlight><highlight class="keywordtype">int</highlight><highlight class="keyword">&gt;</highlight><highlight class="normal">(node);</highlight></codeline>
<codeline lineno="44"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="45"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>::mfem::Array&lt;int&gt;<sp/>dofs;</highlight></codeline>
<codeline lineno="46"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::vector&lt;int&gt;<sp/>nodes;</highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">for</highlight><highlight class="normal"><sp/>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>boundary<sp/>=<sp/>0;<sp/>boundary<sp/>&lt;<sp/>space.GetMesh()-&gt;GetNBE();<sp/>++boundary)<sp/>{</highlight></codeline>
<codeline lineno="48"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(space.GetMesh()-&gt;GetBdrAttribute(boundary)<sp/>!=<sp/>attribute)<sp/>{</highlight></codeline>
<codeline lineno="49"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">continue</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="50"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="51"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(space.GetBdrElementDofs(boundary,<sp/>dofs)<sp/>!=<sp/></highlight><highlight class="keyword">nullptr</highlight><highlight class="normal"><sp/>||<sp/>space.GetBE(boundary)-&gt;GetDof()<sp/>!=<sp/>dofs.Size())<sp/>{</highlight></codeline>
<codeline lineno="52"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>std::unexpected(<ref refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_failure" kindref="compound">BoundaryFailure</ref>{.message<sp/>=<sp/></highlight><highlight class="stringliteral">&quot;Boundary<sp/>assembly<sp/>requires<sp/>a<sp/>canonical<sp/>scalar<sp/>nodal<sp/>trace<sp/>without<sp/>additional<sp/>DOF<sp/>transformations.&quot;</highlight><highlight class="normal">,<sp/>.element<sp/>=<sp/>boundary});</highlight></codeline>
<codeline lineno="53"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="54"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>nodes.resize(dofs.Size());</highlight></codeline>
<codeline lineno="55"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">for</highlight><highlight class="normal"><sp/>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>local<sp/>=<sp/>0;<sp/>local<sp/>&lt;<sp/>dofs.Size();<sp/>++local)<sp/>{</highlight></codeline>
<codeline lineno="56"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>dof<sp/>=<sp/>::mfem::FiniteElementSpace::DecodeDof(dofs[local]);</highlight></codeline>
<codeline lineno="57"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(dof<sp/>&lt;<sp/>0<sp/>||<sp/>dof<sp/>&gt;=<sp/>space.GetNDofs()<sp/>||<sp/>selected_index[dof]<sp/>&lt;<sp/>0)<sp/>{</highlight></codeline>
<codeline lineno="58"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>std::unexpected(<ref refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_failure" kindref="compound">BoundaryFailure</ref>{.message<sp/>=<sp/></highlight><highlight class="stringliteral">&quot;A<sp/>boundary<sp/>trace<sp/>node<sp/>is<sp/>missing<sp/>from<sp/>the<sp/>selected<sp/>scalar<sp/>coordinates.&quot;</highlight><highlight class="normal">,<sp/>.element<sp/>=<sp/>boundary});</highlight></codeline>
<codeline lineno="59"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="60"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>nodes[local]<sp/>=<sp/>selected_index[dof];</highlight></codeline>
<codeline lineno="61"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="62"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1backend_1_1mfem_1_1shared_1_1_boundary_element" kindref="compound">BoundaryElement</ref><sp/>element{.finite_element<sp/>=<sp/>*space.GetBE(boundary),<sp/>.transformation<sp/>=<sp/>*space.GetBdrElementTransformation(boundary),<sp/>.encoded_dofs<sp/>=<sp/>{dofs.GetData(),<sp/></highlight><highlight class="keyword">static_cast&lt;</highlight><highlight class="normal">std::size_t</highlight><highlight class="keyword">&gt;</highlight><highlight class="normal">(dofs.Size())},<sp/>.selected_nodes<sp/>=<sp/>nodes};</highlight></codeline>
<codeline lineno="63"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(<ref refid="namespaceserif_1_1backend_1_1mfem_1_1shared_1ac08e31847b8c14df596fc9f042a0ad86" kindref="member">BoundaryStatus</ref><sp/>status<sp/>=<sp/>visit(element);<sp/>!status)<sp/>{</highlight></codeline>
<codeline lineno="64"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>status.error().element<sp/>=<sp/>boundary;</highlight></codeline>
<codeline lineno="65"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>status;</highlight></codeline>
<codeline lineno="66"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</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/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>{};</highlight></codeline>
<codeline lineno="69"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="70"><highlight class="normal">}</highlight></codeline>
</programlisting>
<location file="src/include/serif/backend/mfem/shared/boundary_elements.hpp"/>
</compounddef>
</doxygen>