Files
MeanField_SERiF/docs/xml/reference__geometry_8hpp.xml

341 lines
22 KiB
XML
Raw Permalink 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="reference__geometry_8hpp" kind="file" language="C++">
<compoundname>reference_geometry.hpp</compoundname>
<includes local="no">array</includes>
<includes local="no">vector</includes>
<includes refid="geometry_2deformation_2failure_8hpp" local="yes">serif/geometry/deformation/failure.hpp</includes>
<includes refid="reference__surface_8hpp" local="yes">serif/geometry/deformation/reference_surface.hpp</includes>
<includes refid="surface__embedding_8hpp" local="yes">serif/geometry/deformation/surface_embedding.hpp</includes>
<includedby refid="backend_2mfem_2geometry_2deformation_2radial__interpolation_8hpp" local="yes">src/include/serif/backend/mfem/geometry/deformation/radial_interpolation.hpp</includedby>
<includedby refid="volume__displacement_8hpp" local="yes">src/include/serif/backend/mfem/model/volume_displacement.hpp</includedby>
<includedby refid="reference__geometry_8cpp" local="yes">src/lib/serif/backend/mfem/geometry/deformation/reference_geometry.cpp</includedby>
<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>
<includedby refid="resources_8cpp" local="yes">src/lib/serif/backend/mfem/serialize/resources.cpp</includedby>
<incdepgraph>
<node id="1">
<label>src/include/serif/backend/mfem/geometry/deformation/reference_geometry.hpp</label>
<link refid="reference__geometry_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="8" 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="11">
<label>serif/geometry/deformation/models.hpp</label>
<link refid="models_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
</node>
<node id="7">
<label>serif/geometry/deformation/reference_surface.hpp</label>
<link refid="reference__surface_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
</node>
<node id="13">
<label>serif/geometry/deformation/spaces.hpp</label>
<link refid="spaces_8hpp"/>
</node>
<node id="8">
<label>serif/geometry/deformation/surface_embedding.hpp</label>
<link refid="surface__embedding_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
</node>
<node id="14">
<label>serif/geometry/deformation/workspace.hpp</label>
<link refid="geometry_2deformation_2workspace_8hpp"/>
</node>
<node id="2">
<label>array</label>
</node>
<node id="9">
<label>cstddef</label>
</node>
<node id="5">
<label>expected</label>
</node>
<node id="12">
<label>optional</label>
</node>
<node id="10">
<label>span</label>
</node>
<node id="6">
<label>string</label>
</node>
<node id="3">
<label>vector</label>
</node>
</incdepgraph>
<invincdepgraph>
<node id="6">
<label>src/compile_time_checks/serif/model/state.cpp</label>
<link refid="state_8cpp"/>
</node>
<node id="3">
<label>src/include/serif/backend/mfem/geometry/deformation/computations.hpp</label>
<link refid="backend_2mfem_2geometry_2deformation_2computations_8hpp"/>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="18" relation="include">
</childnode>
<childnode refid="21" relation="include">
</childnode>
</node>
<node id="2">
<label>src/include/serif/backend/mfem/geometry/deformation/radial_interpolation.hpp</label>
<link refid="backend_2mfem_2geometry_2deformation_2radial__interpolation_8hpp"/>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="22" relation="include">
</childnode>
</node>
<node id="1">
<label>src/include/serif/backend/mfem/geometry/deformation/reference_geometry.hpp</label>
<link refid="reference__geometry_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="23" relation="include">
</childnode>
<childnode refid="24" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
<childnode refid="26" relation="include">
</childnode>
<childnode refid="27" relation="include">
</childnode>
</node>
<node id="5">
<label>src/include/serif/backend/mfem/model/equilibrium.hpp</label>
<link refid="backend_2mfem_2model_2equilibrium_8hpp"/>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
</node>
<node id="15">
<label>src/include/serif/backend/mfem/model/equilibrium_evaluator.hpp</label>
<link refid="equilibrium__evaluator_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="4">
<label>src/include/serif/backend/mfem/model/graph.hpp</label>
<link refid="backend_2mfem_2model_2graph_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
</node>
<node id="13">
<label>src/include/serif/backend/mfem/model/normalization/computations.hpp</label>
<link refid="backend_2mfem_2model_2normalization_2computations_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="14">
<label>src/include/serif/backend/mfem/model/preconditioning/computations.hpp</label>
<link refid="backend_2mfem_2model_2preconditioning_2computations_8hpp"/>
<childnode refid="15" relation="include">
</childnode>
</node>
<node id="23">
<label>src/include/serif/backend/mfem/model/volume_displacement.hpp</label>
<link refid="volume__displacement_8hpp"/>
<childnode refid="4" relation="include">
</childnode>
</node>
<node id="16">
<label>src/include/serif/backend/mfem/serialize/top.hpp</label>
<link refid="backend_2mfem_2serialize_2top_8hpp"/>
<childnode refid="17" relation="include">
</childnode>
</node>
<node id="12">
<label>src/include/serif/backend/mfem/solver/admissibility/geometry.hpp</label>
<link refid="geometry_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
</node>
<node id="8">
<label>src/include/serif/backend/mfem/solver/equilibrium.hpp</label>
<link refid="backend_2mfem_2solver_2equilibrium_8hpp"/>
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="7">
<label>src/include/serif/backend/mfem/solver/nonlinear/stellar_problem.hpp</label>
<link refid="stellar__problem_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
</node>
<node id="18">
<label>src/include/serif/backend/mfem/solver/seed/fitted.hpp</label>
<link refid="backend_2mfem_2solver_2seed_2fitted_8hpp"/>
<childnode refid="19" relation="include">
</childnode>
<childnode refid="20" relation="include">
</childnode>
</node>
<node id="19">
<label>src/include/serif/backend/mfem/solver/seed/state.hpp</label>
<link refid="backend_2mfem_2solver_2seed_2state_8hpp"/>
<childnode refid="20" relation="include">
</childnode>
</node>
<node id="21">
<label>src/include/serif/geometry/deformation/finite_elements.hpp</label>
<link refid="geometry_2deformation_2finite__elements_8hpp"/>
</node>
<node id="10">
<label>src/include/serif/solver/continuation/equilibrium.hpp</label>
<link refid="solver_2continuation_2equilibrium_8hpp"/>
<childnode refid="11" relation="include">
</childnode>
</node>
<node id="9">
<label>src/include/serif/solver/equilibrium.hpp</label>
<link refid="solver_2equilibrium_8hpp"/>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
</node>
<node id="20">
<label>src/include/serif/solver/seed/state.hpp</label>
<link refid="solver_2seed_2state_8hpp"/>
<childnode refid="11" relation="include">
</childnode>
</node>
<node id="11">
<label>src/include/serif/solver/solver.hpp</label>
<link refid="solver_2solver_8hpp"/>
</node>
<node id="22">
<label>src/lib/serif/backend/mfem/geometry/deformation/radial_interpolation.cpp</label>
<link refid="backend_2mfem_2geometry_2deformation_2radial__interpolation_8cpp"/>
</node>
<node id="24">
<label>src/lib/serif/backend/mfem/geometry/deformation/reference_geometry.cpp</label>
<link refid="reference__geometry_8cpp"/>
</node>
<node id="25">
<label>src/lib/serif/backend/mfem/geometry/deformation/surface_metric.cpp</label>
<link refid="surface__metric_8cpp"/>
</node>
<node id="26">
<label>src/lib/serif/backend/mfem/model/surface_potential.cpp</label>
<link refid="surface__potential_8cpp"/>
</node>
<node id="27">
<label>src/lib/serif/backend/mfem/serialize/resources.cpp</label>
<link refid="resources_8cpp"/>
</node>
<node id="17">
<label>src/lib/serif/backend/mfem/serialize/top.cpp</label>
<link refid="backend_2mfem_2serialize_2top_8cpp"/>
</node>
</invincdepgraph>
<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>
</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;array&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;vector&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><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="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="reference__surface_8hpp" kindref="compound">serif/geometry/deformation/reference_surface.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="surface__embedding_8hpp" kindref="compound">serif/geometry/deformation/surface_embedding.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></highlight></codeline>
<codeline lineno="10"><highlight class="normal">{</highlight></codeline>
<codeline lineno="11"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal">FiniteElementSpace;</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal">Mesh;</highlight></codeline>
<codeline lineno="13"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>mfem</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="14"><highlight class="normal"></highlight></codeline>
<codeline lineno="15"><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="16"><highlight class="normal">{</highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1a08306ee593c172f4877facc061e98f97" kindref="member">DeformationStatus</ref><sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1ada3115889de638fd7892b4d74eb432ae" kindref="member">validate_scalar_reference_space</ref>(const<sp/>::mfem::FiniteElementSpace&amp;<sp/>scalar_space);</highlight></codeline>
<codeline lineno="19"><highlight class="normal"></highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1a08306ee593c172f4877facc061e98f97" kindref="member">DeformationStatus</ref><sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1a7fe84828c675f4c83ac0bb7103bc3cf4" kindref="member">validate_companion_numbering</ref>(</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>const<sp/>::mfem::FiniteElementSpace&amp;<sp/>reference_space,</highlight></codeline>
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>const<sp/>::mfem::FiniteElementSpace&amp;<sp/>companion_space);</highlight></codeline>
<codeline lineno="27"><highlight class="normal"></highlight></codeline>
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;std::vector&lt;std::array&lt;double,<sp/>3&gt;&gt;,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1a7822df6f7b1454b7618b7051bb61d7fd" kindref="member">sample_reference_positions</ref>(</highlight></codeline>
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>const<sp/>::mfem::FiniteElementSpace&amp;<sp/>scalar_space,</highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>::mfem::Mesh&amp;<sp/>reference_mesh);</highlight></codeline>
<codeline lineno="32"><highlight class="normal"></highlight></codeline>
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;std::vector&lt;int&gt;,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1abcf256861277cffe0fd07385c3426e47" kindref="member">select_surface_scalar_dofs</ref>(</highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>const<sp/>::mfem::FiniteElementSpace&amp;<sp/>scalar_space,</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>surface_attribute);</highlight></codeline>
<codeline lineno="37"><highlight class="normal"></highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;ReferenceSurface,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1a25c220c2bc5a2bdcc208064fa07981d0" kindref="member">sample_reference_surface</ref>(</highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>const<sp/>::mfem::FiniteElementSpace&amp;<sp/>scalar_space,</highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>surface_attribute);</highlight></codeline>
<codeline lineno="42"><highlight class="normal"></highlight></codeline>
<codeline lineno="44"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1a08306ee593c172f4877facc061e98f97" kindref="member">DeformationStatus</ref><sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1a43e3d620d26756172e5752be4a6a2249" kindref="member">validate_surface_trace</ref>(const<sp/>::mfem::FiniteElementSpace&amp;<sp/>scalar_space,<sp/></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/>surface_attribute,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>ReferenceSurface&amp;<sp/>reference_surface,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>SurfaceEmbedding&amp;<sp/>embedding);</highlight></codeline>
<codeline lineno="45"><highlight class="normal"></highlight></codeline>
<codeline lineno="46"><highlight class="normal"><sp/><sp/><sp/><sp/></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">detail</ref></highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="49"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;std::vector&lt;std::array&lt;double,<sp/>3&gt;&gt;,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_1ae99ccf822100c094a42a76f1c02dc2b2" kindref="member">sample_reference_positions</ref>(const<sp/>::mfem::FiniteElementSpace&amp;<sp/>scalar_space,<sp/>::mfem::Mesh&amp;<sp/>reference_mesh);</highlight></codeline>
<codeline lineno="51"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;ReferenceSurface,<sp/>DeformationFailure&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1deformation_1_1backend_1_1mfem_1_1detail_1a3954d96a884f6b832684654551467bdf" kindref="member">sample_reference_surface</ref>(const<sp/>::mfem::FiniteElementSpace&amp;<sp/>scalar_space,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::vector&lt;int&gt;&amp;<sp/>selected);</highlight></codeline>
<codeline lineno="52"><highlight class="normal"><sp/><sp/><sp/><sp/>}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>detail</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="53"><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/backend/mfem/geometry/deformation/reference_geometry.hpp"/>
</compounddef>
</doxygen>