Files
MeanField_SERiF/docs/xml/backend_2mfem_2radial_8hpp.xml

165 lines
18 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_2radial_8hpp" kind="file" language="C++">
<compoundname>radial.hpp</compoundname>
<includes local="no">array</includes>
<includes local="no">expected</includes>
<includes local="no">functional</includes>
<includes local="no">string</includes>
<includes local="yes">mfem/fem/gridfunc.hpp</includes>
<includes refid="radial_8hpp" local="yes">serif/utils/projection/radial.hpp</includes>
<includedby refid="projection_8cpp" local="yes">src/compile_time_checks/serif/utils/projection.cpp</includedby>
<includedby refid="projection_8hpp" local="yes">src/include/serif/utils/projection/projection.hpp</includedby>
<includedby refid="radial_8cpp" local="yes">src/lib/serif/utils/projection/radial.cpp</includedby>
<incdepgraph>
<node id="1">
<label>src/include/serif/utils/projection/backend/mfem/radial.hpp</label>
<link refid="backend_2mfem_2radial_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="7" relation="include">
</childnode>
</node>
<node id="7">
<label>serif/utils/projection/radial.hpp</label>
<link refid="radial_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="2">
<label>array</label>
</node>
<node id="8">
<label>concepts</label>
</node>
<node id="3">
<label>expected</label>
</node>
<node id="4">
<label>functional</label>
</node>
<node id="6">
<label>mfem/fem/gridfunc.hpp</label>
</node>
<node id="5">
<label>string</label>
</node>
<node id="9">
<label>type_traits</label>
</node>
</incdepgraph>
<invincdepgraph>
<node id="2">
<label>src/compile_time_checks/serif/utils/projection.cpp</label>
<link refid="projection_8cpp"/>
</node>
<node id="1">
<label>src/include/serif/utils/projection/backend/mfem/radial.hpp</label>
<link refid="backend_2mfem_2radial_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
</node>
<node id="3">
<label>src/include/serif/utils/projection/projection.hpp</label>
<link refid="projection_8hpp"/>
</node>
<node id="4">
<label>src/lib/serif/utils/projection/radial.cpp</label>
<link refid="radial_8cpp"/>
</node>
</invincdepgraph>
<innerclass refid="structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options" prot="public">serif::utils::projection::backend::mfem::RadialProjectionOptions</innerclass>
<innernamespace refid="namespaceserif">serif</innernamespace>
<innernamespace refid="namespaceserif_1_1mapping">serif::mapping</innernamespace>
<innernamespace refid="namespaceserif_1_1utils">serif::utils</innernamespace>
<innernamespace refid="namespaceserif_1_1utils_1_1projection">serif::utils::projection</innernamespace>
<innernamespace refid="namespaceserif_1_1utils_1_1projection_1_1backend">serif::utils::projection::backend</innernamespace>
<innernamespace refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem">serif::utils::projection::backend::mfem</innernamespace>
<innernamespace refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1detail">serif::utils::projection::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;expected&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;functional&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;string&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight></codeline>
<codeline lineno="8"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;mfem/fem/gridfunc.hpp&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="9"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="radial_8hpp" kindref="compound">serif/utils/projection/radial.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_1mapping" kindref="compound">serif::mapping</ref><sp/>{</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1mapping_1_1_grid_function_mapping_evaluator" kindref="compound">GridFunctionMappingEvaluator</ref>;</highlight></codeline>
<codeline lineno="13"><highlight class="normal">}</highlight></codeline>
<codeline lineno="14"><highlight class="normal"></highlight></codeline>
<codeline lineno="15" refid="namespaceserif_1_1utils_1_1projection" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem" kindref="compound">serif::utils::projection::backend::mfem</ref><sp/>{</highlight></codeline>
<codeline lineno="20" refid="structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options" kindref="compound">RadialProjectionOptions</ref><sp/>{</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::array&lt;double,<sp/>3&gt;<sp/><ref refid="structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options_1ac93e71f47cee2289941e9c68a7e500ea" kindref="member">center</ref>{};</highlight></codeline>
<codeline lineno="22"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1mapping_1_1_grid_function_mapping_evaluator" kindref="compound">mapping::GridFunctionMappingEvaluator</ref>*<sp/><ref refid="structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options_1a18faa116273c47aa844219c3457dc5d1" kindref="member">mapping</ref>{</highlight><highlight class="keyword">nullptr</highlight><highlight class="normal">};</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>Infinity<sp/>callbacks<sp/>return<sp/>limiting<sp/>values<sp/>already<sp/>pulled<sp/>back<sp/>to<sp/>mesh<sp/>coordinates.</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::function&lt;<ref refid="namespaceserif_1_1utils_1_1projection_1a99762ff1a5fff68c72feccd85e3976b5" kindref="member">RadialValue</ref>(const<sp/>::mfem::Vector&amp;)&gt;<sp/><ref refid="structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options_1a0c813feb7feecb0371c2fd6786bfbf94" kindref="member">scalar_at_infinity</ref>{};</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::function&lt;std::expected&lt;::mfem::Vector,<sp/>std::string&gt;(const<sp/>::mfem::Vector&amp;)&gt;<sp/><ref refid="structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options_1a2c0e361a88d72f913de82a87841709d7" kindref="member">vector_at_infinity</ref>{};</highlight></codeline>
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="27"><highlight class="normal"></highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1a1c5d8756e8611ea09e6cab5dd2ef69f0" kindref="member">ProjectionResult</ref><sp/>=<sp/>std::expected&lt;::mfem::GridFunction,<sp/>std::string&gt;;</highlight></codeline>
<codeline lineno="29"><highlight class="normal"></highlight></codeline>
<codeline lineno="30" refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1detail" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1detail" kindref="compound">detail</ref><sp/>{</highlight></codeline>
<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1a1c5d8756e8611ea09e6cab5dd2ef69f0" kindref="member">ProjectionResult</ref><sp/><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1detail_1a4fdd9524c9c445deaeb098443c5dfd79" kindref="member">project_scalar</ref>(</highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>::mfem::FiniteElementSpace&amp;<sp/>space,</highlight></codeline>
<codeline lineno="34"><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/>std::function&lt;<ref refid="namespaceserif_1_1utils_1_1projection_1a99762ff1a5fff68c72feccd85e3976b5" kindref="member">RadialValue</ref>(</highlight><highlight class="keywordtype">double</highlight><highlight class="normal">)&gt;&amp;<sp/>profile,</highlight></codeline>
<codeline lineno="35"><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_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options" kindref="compound">RadialProjectionOptions</ref>&amp;<sp/>options</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>);</highlight></codeline>
<codeline lineno="37"><highlight class="normal"></highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1a1c5d8756e8611ea09e6cab5dd2ef69f0" kindref="member">ProjectionResult</ref><sp/><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1detail_1a25ea05cf65248e096bc22ea1e6003ffb" kindref="member">project_vector</ref>(</highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>::mfem::FiniteElementSpace&amp;<sp/>space,</highlight></codeline>
<codeline lineno="41"><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/>std::function&lt;<ref refid="namespaceserif_1_1utils_1_1projection_1a99762ff1a5fff68c72feccd85e3976b5" kindref="member">RadialValue</ref>(</highlight><highlight class="keywordtype">double</highlight><highlight class="normal">)&gt;&amp;<sp/>radial_amplitude,</highlight></codeline>
<codeline lineno="42"><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_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options" kindref="compound">RadialProjectionOptions</ref>&amp;<sp/>options</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>);</highlight></codeline>
<codeline lineno="44"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="45"><highlight class="normal"></highlight></codeline>
<codeline lineno="58"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;RadialFunction<sp/>Function&gt;</highlight></codeline>
<codeline lineno="59"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1a1c5d8756e8611ea09e6cab5dd2ef69f0" kindref="member">ProjectionResult</ref><sp/><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1ae1cf810eb1d200398cab121763e6bb1f" kindref="member">project_scalar</ref>(</highlight></codeline>
<codeline lineno="60"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>::mfem::FiniteElementSpace&amp;<sp/>space,</highlight></codeline>
<codeline lineno="61"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>Function&amp;<sp/>profile,</highlight></codeline>
<codeline lineno="62"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1_radial_projection_options" kindref="compound">RadialProjectionOptions</ref>&amp;<sp/>options<sp/>=<sp/>{}</highlight></codeline>
<codeline lineno="63"><highlight class="normal"><sp/><sp/><sp/><sp/>)<sp/>{</highlight></codeline>
<codeline lineno="64"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1detail_1a4fdd9524c9c445deaeb098443c5dfd79" kindref="member">detail::project_scalar</ref>(space,<sp/><ref refid="namespaceserif_1_1utils_1_1projection_1_1detail_1a34c090e126e0b0cee7f0ee69c99959c0" kindref="member">projection::detail::checked_profile</ref>(profile),<sp/>options);</highlight></codeline>
<codeline lineno="65"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="66"><highlight class="normal"></highlight></codeline>
<codeline lineno="79"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;RadialFunction<sp/>Function&gt;</highlight></codeline>
<codeline lineno="80"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1a1c5d8756e8611ea09e6cab5dd2ef69f0" kindref="member">ProjectionResult</ref><sp/><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1ab646c4bfdd5381fd0bbc83b61537cb7e" kindref="member">project_vector</ref>(</highlight></codeline>
<codeline lineno="81"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>::mfem::FiniteElementSpace&amp;<sp/>space,</highlight></codeline>
<codeline lineno="82"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>Function&amp;<sp/>radial_amplitude,</highlight></codeline>
<codeline lineno="83"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>RadialProjectionOptions&amp;<sp/>options<sp/>=<sp/>{}</highlight></codeline>
<codeline lineno="84"><highlight class="normal"><sp/><sp/><sp/><sp/>)<sp/>{</highlight></codeline>
<codeline lineno="85"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1utils_1_1projection_1_1backend_1_1mfem_1_1detail_1a25ea05cf65248e096bc22ea1e6003ffb" kindref="member">detail::project_vector</ref>(space,<sp/><ref refid="namespaceserif_1_1utils_1_1projection_1_1detail_1a34c090e126e0b0cee7f0ee69c99959c0" kindref="member">projection::detail::checked_profile</ref>(radial_amplitude),<sp/>options);</highlight></codeline>
<codeline lineno="86"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="87"><highlight class="normal">}</highlight></codeline>
</programlisting>
<location file="src/include/serif/utils/projection/backend/mfem/radial.hpp"/>
</compounddef>
</doxygen>