MeanField_SERiF/docs/xml/checks_2finite_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="checks_2finite_8hpp" kind="file" language="C++">
    <compoundname>finite.hpp</compoundname>
    <includes local="no">cmath</includes>
    <includes local="yes">mfem/linalg/vector.hpp</includes>
    <includes local="yes">mfem/linalg/densemat.hpp</includes>
    <includes refid="numeric_8hpp" local="yes">serif/utils/misc/concepts/numeric.hpp</includes>
    <includedby refid="boundary__computations_8hpp" local="yes">src/include/serif/geometry/surface/backend/mfem/boundary_computations.hpp</includedby>
    <includedby refid="boundary__rows_8hpp" local="yes">src/include/serif/geometry/surface/backend/mfem/boundary_rows.hpp</includedby>
    <includedby refid="equilibrium_8hpp" local="yes">src/include/serif/model/backend/mfem/equilibrium.hpp</includedby>
    <includedby refid="invertible_8hpp" local="yes">src/include/serif/utils/checks/invertible.hpp</includedby>
    <includedby refid="geometry__inspection_8cpp" local="yes">src/lib/serif/geometry/deformation/backend/mfem/geometry_inspection.cpp</includedby>
    <includedby refid="geometry__step_8cpp" local="yes">src/lib/serif/geometry/deformation/backend/mfem/geometry_step.cpp</includedby>
    <includedby refid="kelvin_8cpp" local="yes">src/lib/serif/mapping/compactification/kelvin.cpp</includedby>
    <includedby refid="domain__mapper_8cpp" local="yes">src/lib/serif/mapping/domain_mapper.cpp</includedby>
    <includedby refid="transformations_8cpp" local="yes">src/lib/serif/mapping/transformations.cpp</includedby>
    <includedby refid="actions_8cpp" local="yes">src/lib/serif/model/backend/mfem/actions.cpp</includedby>
    <includedby refid="radial_8cpp" local="yes">src/lib/serif/utils/projection/radial.cpp</includedby>
    <incdepgraph>
      <node id="1">
        <label>src/include/serif/utils/checks/finite.hpp</label>
        <link refid="checks_2finite_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>
      </node>
      <node id="5">
        <label>serif/utils/misc/concepts/numeric.hpp</label>
        <link refid="numeric_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>cmath</label>
      </node>
      <node id="6">
        <label>concepts</label>
      </node>
      <node id="4">
        <label>mfem/linalg/densemat.hpp</label>
      </node>
      <node id="3">
        <label>mfem/linalg/vector.hpp</label>
      </node>
      <node id="7">
        <label>type_traits</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="3">
        <label>src/compile_time_checks/serif/geometry/surface_boundary.cpp</label>
        <link refid="surface__boundary_8cpp"/>
      </node>
      <node id="2">
        <label>src/include/serif/geometry/surface/backend/mfem/boundary_computations.hpp</label>
        <link refid="boundary__computations_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>src/include/serif/geometry/surface/backend/mfem/boundary_rows.hpp</label>
        <link refid="boundary__rows_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>src/include/serif/geometry/surface/backend/mfem/pressure_boundary.hpp</label>
        <link refid="geometry_2surface_2backend_2mfem_2pressure__boundary_8hpp"/>
        <childnode refid="5" relation="include">
        </childnode>
      </node>
      <node id="5">
        <label>src/include/serif/model/backend/mfem/binding.hpp</label>
        <link refid="model_2backend_2mfem_2binding_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>src/include/serif/model/backend/mfem/equilibrium.hpp</label>
        <link refid="equilibrium_8hpp"/>
      </node>
      <node id="10">
        <label>src/include/serif/model/computations/pressure_boundary.hpp</label>
        <link refid="model_2computations_2pressure__boundary_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="7">
        <label>src/include/serif/model/graph.hpp</label>
        <link refid="model_2graph_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="9">
        <label>src/include/serif/operators/backend/mfem/pressure_field_block.hpp</label>
        <link refid="pressure__field__block_8hpp"/>
        <childnode refid="10" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/utils/checks/finite.hpp</label>
        <link refid="checks_2finite_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
      </node>
      <node id="11">
        <label>src/include/serif/utils/checks/invertible.hpp</label>
        <link refid="invertible_8hpp"/>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
      </node>
      <node id="12">
        <label>src/lib/serif/geometry/deformation/backend/mfem/geometry_inspection.cpp</label>
        <link refid="geometry__inspection_8cpp"/>
      </node>
      <node id="14">
        <label>src/lib/serif/geometry/deformation/backend/mfem/geometry_step.cpp</label>
        <link refid="geometry__step_8cpp"/>
      </node>
      <node id="15">
        <label>src/lib/serif/mapping/compactification/kelvin.cpp</label>
        <link refid="kelvin_8cpp"/>
      </node>
      <node id="13">
        <label>src/lib/serif/mapping/domain_mapper.cpp</label>
        <link refid="domain__mapper_8cpp"/>
      </node>
      <node id="16">
        <label>src/lib/serif/mapping/transformations.cpp</label>
        <link refid="transformations_8cpp"/>
      </node>
      <node id="17">
        <label>src/lib/serif/model/backend/mfem/actions.cpp</label>
        <link refid="actions_8cpp"/>
      </node>
      <node id="18">
        <label>src/lib/serif/utils/projection/radial.cpp</label>
        <link refid="radial_8cpp"/>
      </node>
    </invincdepgraph>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1utils">serif::utils</innernamespace>
    <innernamespace refid="namespaceserif_1_1utils_1_1checks">serif::utils::checks</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;cmath&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;mfem/linalg/vector.hpp&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;mfem/linalg/densemat.hpp&quot;</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;<ref refid="numeric_8hpp" kindref="compound">serif/utils/misc/concepts/numeric.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="9"><highlight class="normal"></highlight></codeline>
<codeline lineno="10" refid="namespaceserif_1_1utils" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1utils_1_1checks" kindref="compound">serif::utils::checks</ref><sp/>{</highlight></codeline>
<codeline lineno="11"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>If<sp/>we<sp/>have<sp/>a<sp/>new<sp/>backend<sp/>/<sp/>new<sp/>vector<sp/>and<sp/>matrix<sp/>type<sp/>in<sp/>the<sp/>future<sp/>we<sp/>can<sp/>add<sp/>new<sp/>overloads</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1utils_1_1checks_1a4eb8e1d2bdd4bdae0242814f9018537e" kindref="member">is_finite</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>mfem::Vector&amp;<sp/>vector)<sp/>{</highlight></codeline>
<codeline lineno="13"><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/>i<sp/>=<sp/>0;<sp/>i<sp/>&lt;<sp/>vector.Size();<sp/>++i)<sp/>{</highlight></codeline>
<codeline lineno="14"><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/>(!std::isfinite(vector(i)))<sp/>{</highlight></codeline>
<codeline lineno="15"><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/></highlight><highlight class="keyword">false</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="17"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="18"><highlight class="normal"></highlight></codeline>
<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">true</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="21"><highlight class="normal"></highlight></codeline>
<codeline lineno="22"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">inline</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1utils_1_1checks_1a4eb8e1d2bdd4bdae0242814f9018537e" kindref="member">is_finite</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>mfem::DenseMatrix&amp;<sp/>matrix)<sp/>{</highlight></codeline>
<codeline lineno="23"><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/>i<sp/>=<sp/>0;<sp/>i<sp/>&lt;<sp/>matrix.Height();<sp/>++i)<sp/>{</highlight></codeline>
<codeline lineno="24"><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/>j<sp/>=<sp/>0;<sp/>j<sp/>&lt;<sp/>matrix.Width();<sp/>++j)<sp/>{</highlight></codeline>
<codeline lineno="25"><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/>(!std::isfinite(matrix(i,<sp/>j)))<sp/>{</highlight></codeline>
<codeline lineno="26"><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/></highlight><highlight class="keyword">false</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="30"><highlight class="normal"></highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">true</highlight><highlight class="normal">;</highlight></codeline>
<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="33"><highlight class="normal"></highlight></codeline>
<codeline lineno="34"><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/>Scalar&gt;</highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">requires</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">requires</highlight><highlight class="normal"><sp/>(Scalar<sp/>x)<sp/>{{std::isfinite(x)}<sp/>-&gt;<sp/>std::convertible_to&lt;bool&gt;;<sp/>}</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1utils_1_1checks_1a4eb8e1d2bdd4bdae0242814f9018537e" kindref="member">is_finite</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>Scalar<sp/>scalar)<sp/>{</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>std::isfinite(scalar);</highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="39"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="src/include/serif/utils/checks/finite.hpp"/>
  </compounddef>
</doxygen>