MeanField_SERiF/docs/xml/forms_8cpp.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="forms_8cpp" kind="file" language="C++">
    <compoundname>forms.cpp</compoundname>
    <includes local="no">type_traits</includes>
    <includes refid="discretization_2forms_2runtime_8hpp" local="yes">serif/discretization/forms/runtime.hpp</includes>
    <includes refid="concept_8hpp" local="yes">serif/discretization/forms/concept.hpp</includes>
    <includes refid="forms_8hpp" local="yes">serif/discretization/forms/forms.hpp</includes>
    <incdepgraph>
      <node id="1">
        <label>src/compile_time_checks/serif/discretization/forms/forms.cpp</label>
        <link refid="forms_8cpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="32" relation="include">
        </childnode>
        <childnode refid="33" relation="include">
        </childnode>
      </node>
      <node id="10">
        <label>serif/dimensions/dimensions.hpp</label>
        <link refid="dimensions_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="11">
        <label>serif/dimensions/quantities.hpp</label>
        <link refid="quantities_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
      </node>
      <node id="17">
        <label>serif/discretization/blocks/base.hpp</label>
        <link refid="base_8hpp"/>
      </node>
      <node id="7">
        <label>serif/discretization/blocks/concepts.hpp</label>
        <link refid="discretization_2blocks_2concepts_8hpp"/>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>serif/discretization/blocks/fields.hpp</label>
        <link refid="fields_8hpp"/>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
        <childnode refid="28" relation="include">
        </childnode>
        <childnode refid="29" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>serif/discretization/blocks/runtime.hpp</label>
        <link refid="discretization_2blocks_2runtime_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="22">
        <label>serif/discretization/domain/concepts.hpp</label>
        <link refid="discretization_2domain_2concepts_8hpp"/>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="27" relation="include">
        </childnode>
      </node>
      <node id="28">
        <label>serif/discretization/domain/physical_domains.hpp</label>
        <link refid="physical__domains_8hpp"/>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
      </node>
      <node id="26">
        <label>serif/discretization/domain/types.hpp</label>
        <link refid="discretization_2domain_2types_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="32">
        <label>serif/discretization/forms/concept.hpp</label>
        <link refid="concept_8hpp"/>
        <childnode refid="33" relation="include">
        </childnode>
      </node>
      <node id="33">
        <label>serif/discretization/forms/forms.hpp</label>
        <link refid="forms_8hpp"/>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="34" relation="include">
        </childnode>
        <childnode refid="29" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
      </node>
      <node id="34">
        <label>serif/discretization/forms/operands.hpp</label>
        <link refid="operands_8hpp"/>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="3">
        <label>serif/discretization/forms/runtime.hpp</label>
        <link refid="discretization_2forms_2runtime_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="32" relation="include">
        </childnode>
      </node>
      <node id="18">
        <label>serif/discretization/functional_space/space.hpp</label>
        <link refid="space_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
      </node>
      <node id="19">
        <label>serif/meta/enums.hpp</label>
        <link refid="enums_8hpp"/>
        <childnode refid="20" relation="include">
        </childnode>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
      </node>
      <node id="30">
        <label>serif/meta/names.hpp</label>
        <link refid="names_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="31" relation="include">
        </childnode>
      </node>
      <node id="16">
        <label>serif/utils/misc/concepts/numeric.hpp</label>
        <link refid="numeric_8hpp"/>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="2" relation="include">
        </childnode>
      </node>
      <node id="15">
        <label>serif/utils/misc/std_helper/cleaning.hpp</label>
        <link refid="cleaning_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
      </node>
      <node id="27">
        <label>serif/utils/misc/std_helper/variadic_cleaning.hpp</label>
        <link refid="variadic__cleaning_8hpp"/>
        <childnode refid="23" relation="include">
        </childnode>
      </node>
      <node id="29">
        <label>serif/utils/types/type_list.hpp</label>
        <link refid="type__list_8hpp"/>
      </node>
      <node id="9">
        <label>array</label>
      </node>
      <node id="12">
        <label>compare</label>
      </node>
      <node id="13">
        <label>concepts</label>
      </node>
      <node id="23">
        <label>cstddef</label>
      </node>
      <node id="5">
        <label>format</label>
      </node>
      <node id="21">
        <label>magic_enum/magic_enum_all.hpp</label>
      </node>
      <node id="31">
        <label>nameof.hpp</label>
      </node>
      <node id="25">
        <label>numeric</label>
      </node>
      <node id="24">
        <label>span</label>
      </node>
      <node id="4">
        <label>string_view</label>
      </node>
      <node id="14">
        <label>tuple</label>
      </node>
      <node id="2">
        <label>type_traits</label>
      </node>
      <node id="20">
        <label>unordered_map</label>
      </node>
    </incdepgraph>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <programlisting>
<codeline lineno="1"><highlight class="preprocessor">#include<sp/>&lt;type_traits&gt;</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/>&quot;<ref refid="discretization_2forms_2runtime_8hpp" kindref="compound">serif/discretization/forms/runtime.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="concept_8hpp" kindref="compound">serif/discretization/forms/concept.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="forms_8hpp" kindref="compound">serif/discretization/forms/forms.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight><highlight class="comment">//<sp/>These<sp/>are<sp/>left<sp/>in<sp/>an<sp/>anonymous<sp/>namespace<sp/>to<sp/>avoid<sp/>polluting<sp/>the<sp/>global<sp/>namespace<sp/>with<sp/>these<sp/>symbols<sp/>at<sp/>link<sp/>time.</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="8"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal">{</highlight></codeline>
<codeline lineno="9"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/>namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1discretization_1_1forms" kindref="compound">serif::discretization::forms</ref>;</highlight></codeline>
<codeline lineno="10"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/>namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1discretization_1_1blocks" kindref="compound">serif::discretization::blocks</ref>;</highlight></codeline>
<codeline lineno="11"><highlight class="normal"></highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>Note<sp/>we<sp/>define<sp/>custom<sp/>versions<sp/>of<sp/>forms<sp/>that<sp/>likely<sp/>exist<sp/>in<sp/>the<sp/>codebase.<sp/>We<sp/>are<sp/>not<sp/>here<sp/>testing<sp/>that<sp/>the</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>forms<sp/>have<sp/>a<sp/>particular<sp/>structure;<sp/>rather,<sp/>we<sp/>are<sp/>testing<sp/>that<sp/>given<sp/>some<sp/>known<sp/>structure</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="comment">//<sp/>the<sp/>form<sp/>system<sp/>behaves<sp/>as<sp/>we<sp/>expect<sp/>it<sp/>to.</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal">HypotheticalTestingDisplacementMass<sp/>=<sp/><ref refid="structserif_1_1discretization_1_1forms_1_1mass" kindref="compound">mass&lt;displacement::vector, displacement::vector&gt;</ref>;</highlight></codeline>
<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal">HypotheticalTestingDisplacementDivergence<sp/>=<sp/><ref refid="structserif_1_1discretization_1_1forms_1_1divergence" kindref="compound">divergence&lt;displacement::vector, gravity::potential&gt;</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">static_assert</highlight><highlight class="normal">(Form&lt;HypotheticalTestingDisplacementMass&gt;,<sp/></highlight><highlight class="stringliteral">&quot;DisplacementMass<sp/>should<sp/>satisfy<sp/>the<sp/>Form<sp/>concept.<sp/>A<sp/>failure<sp/>here<sp/>indicates<sp/>that<sp/>the<sp/>mass<sp/>form<sp/>is<sp/>not<sp/>properly<sp/>defined<sp/>for<sp/>a<sp/>vector<sp/>field.<sp/>Please<sp/>check<sp/>out<sp/>the<sp/>forms<sp/>submodule&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(Form&lt;HypotheticalTestingDisplacementDivergence&gt;,<sp/></highlight><highlight class="stringliteral">&quot;DisplacementDivergence<sp/>should<sp/>satisfy<sp/>the<sp/>Form<sp/>concept.<sp/>A<sp/>failure<sp/>here<sp/>indicates<sp/>that<sp/>the<sp/>divergence<sp/>form<sp/>is<sp/>not<sp/>properly<sp/>defined<sp/>for<sp/>a<sp/>vector<sp/>field.<sp/>Please<sp/>check<sp/>out<sp/>the<sp/>forms<sp/>submodule&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="20"><highlight class="normal"></highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::same_as&lt;HypotheticalTestingDisplacementMass::test_type,<sp/>displacement::vector&gt;,<sp/></highlight><highlight class="stringliteral">&quot;DisplacementMass::test_type<sp/>should<sp/>be<sp/>displacement::vector.<sp/>A<sp/>failure<sp/>here<sp/>indicates<sp/>that<sp/>the<sp/>mass<sp/>form<sp/>is<sp/>not<sp/>properly<sp/>defined<sp/>for<sp/>a<sp/>vector<sp/>field.<sp/>Please<sp/>check<sp/>out<sp/>the<sp/>forms<sp/>submodule&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="22"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::same_as&lt;HypotheticalTestingDisplacementMass::trial_type,<sp/>displacement::vector&gt;,<sp/></highlight><highlight class="stringliteral">&quot;DisplacementMass::trial_type<sp/>should<sp/>be<sp/>displacement::vector.<sp/>A<sp/>failure<sp/>here<sp/>indicates<sp/>that<sp/>the<sp/>mass<sp/>form<sp/>is<sp/>not<sp/>properly<sp/>defined<sp/>for<sp/>a<sp/>vector<sp/>field.<sp/>Please<sp/>check<sp/>out<sp/>the<sp/>forms<sp/>submodule&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="23"><highlight class="normal"></highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::same_as&lt;HypotheticalTestingDisplacementDivergence::trial_type,<sp/>displacement::vector&gt;,<sp/></highlight><highlight class="stringliteral">&quot;DisplacementDivergence::trial_type<sp/>should<sp/>be<sp/>displacement::vector.<sp/>A<sp/>failure<sp/>here<sp/>indicates<sp/>that<sp/>the<sp/>divergence<sp/>form<sp/>is<sp/>not<sp/>properly<sp/>defined<sp/>for<sp/>a<sp/>vector<sp/>field.<sp/>Please<sp/>check<sp/>out<sp/>the<sp/>forms<sp/>submodule&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::same_as&lt;HypotheticalTestingDisplacementDivergence::test_type,<sp/>gravity::potential&gt;,<sp/></highlight><highlight class="stringliteral">&quot;DisplacementDivergence::test_type<sp/>should<sp/>be<sp/>gravity::potential.<sp/>A<sp/>failure<sp/>here<sp/>indicates<sp/>that<sp/>the<sp/>divergence<sp/>form<sp/>is<sp/>not<sp/>properly<sp/>defined<sp/>for<sp/>a<sp/>vector<sp/>field.<sp/>Please<sp/>check<sp/>out<sp/>the<sp/>forms<sp/>submodule&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="26"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="src/compile_time_checks/serif/discretization/forms/forms.cpp"/>
  </compounddef>
</doxygen>