MeanField_SERiF/docs/xml/centering_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="centering_8hpp" kind="file" language="C++">
    <compoundname>centering.hpp</compoundname>
    <includes local="no">array</includes>
    <includes local="no">string_view</includes>
    <includes refid="equations_2contributions_8hpp" local="yes">serif/equations/contributions.hpp</includes>
    <includes refid="point_8hpp" local="yes">serif/equations/point.hpp</includes>
    <includedby refid="computation__owners_8cpp" local="yes">src/compile_time_checks/serif/operators/computation_owners.cpp</includedby>
    <includedby refid="serial__backend_8cpp" local="yes">src/compile_time_checks/serif/operators/serial_backend.cpp</includedby>
    <includedby refid="equations_8hpp" local="yes">src/include/serif/equations/equations.hpp</includedby>
    <incdepgraph>
      <node id="11">
        <label>serif/dimensions/dimensions.hpp</label>
        <link refid="dimensions_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
      </node>
      <node id="12">
        <label>serif/dimensions/quantities.hpp</label>
        <link refid="quantities_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="5" 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="9">
        <label>serif/discretization/blocks/concepts.hpp</label>
        <link refid="discretization_2blocks_2concepts_8hpp"/>
        <childnode refid="10" relation="include">
        </childnode>
      </node>
      <node id="10">
        <label>serif/discretization/blocks/fields.hpp</label>
        <link refid="fields_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="29" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
        <childnode refid="31" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>serif/discretization/blocks/traits.hpp</label>
        <link refid="discretization_2blocks_2traits_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="23">
        <label>serif/discretization/domain/concepts.hpp</label>
        <link refid="discretization_2domain_2concepts_8hpp"/>
        <childnode refid="24" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="27" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="28" relation="include">
        </childnode>
      </node>
      <node id="29">
        <label>serif/discretization/domain/physical_domains.hpp</label>
        <link refid="physical__domains_8hpp"/>
        <childnode refid="27" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
      </node>
      <node id="27">
        <label>serif/discretization/domain/types.hpp</label>
        <link refid="types_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
      </node>
      <node id="33">
        <label>serif/discretization/forms/operands.hpp</label>
        <link refid="operands_8hpp"/>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="35">
        <label>serif/discretization/forms/value.hpp</label>
        <link refid="value_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="33" relation="include">
        </childnode>
      </node>
      <node id="18">
        <label>serif/discretization/functional_space/space.hpp</label>
        <link refid="space_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/equations/centering.hpp</label>
        <link refid="centering_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="34" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>serif/equations/contributions.hpp</label>
        <link refid="equations_2contributions_8hpp"/>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="33" relation="include">
        </childnode>
      </node>
      <node id="34">
        <label>serif/equations/point.hpp</label>
        <link refid="point_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="35" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
      </node>
      <node id="20">
        <label>serif/meta/enums.hpp</label>
        <link refid="enums_8hpp"/>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
      </node>
      <node id="31">
        <label>serif/meta/names.hpp</label>
        <link refid="names_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="32" relation="include">
        </childnode>
      </node>
      <node id="16">
        <label>serif/utils/misc/concepts/numeric.hpp</label>
        <link refid="numeric_8hpp"/>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="15">
        <label>serif/utils/misc/std_helper/cleaning.hpp</label>
        <link refid="cleaning_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="28">
        <label>serif/utils/misc/std_helper/variadic_cleaning.hpp</label>
        <link refid="variadic__cleaning_8hpp"/>
        <childnode refid="24" relation="include">
        </childnode>
      </node>
      <node id="30">
        <label>serif/utils/types/type_list.hpp</label>
        <link refid="type__list_8hpp"/>
      </node>
      <node id="2">
        <label>array</label>
      </node>
      <node id="13">
        <label>compare</label>
      </node>
      <node id="14">
        <label>concepts</label>
      </node>
      <node id="24">
        <label>cstddef</label>
      </node>
      <node id="19">
        <label>format</label>
      </node>
      <node id="22">
        <label>magic_enum/magic_enum_all.hpp</label>
      </node>
      <node id="32">
        <label>nameof.hpp</label>
      </node>
      <node id="26">
        <label>numeric</label>
      </node>
      <node id="25">
        <label>span</label>
      </node>
      <node id="3">
        <label>string_view</label>
      </node>
      <node id="5">
        <label>tuple</label>
      </node>
      <node id="6">
        <label>type_traits</label>
      </node>
      <node id="21">
        <label>unordered_map</label>
      </node>
      <node id="7">
        <label>utility</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="2">
        <label>src/compile_time_checks/serif/operators/computation_owners.cpp</label>
        <link refid="computation__owners_8cpp"/>
      </node>
      <node id="3">
        <label>src/compile_time_checks/serif/operators/serial_backend.cpp</label>
        <link refid="serial__backend_8cpp"/>
      </node>
      <node id="1">
        <label>src/include/serif/equations/centering.hpp</label>
        <link refid="centering_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>src/include/serif/equations/equations.hpp</label>
        <link refid="equations_8hpp"/>
      </node>
    </invincdepgraph>
    <innerclass refid="structserif_1_1equations_1_1_centering_constraint" prot="public">serif::equations::CenteringConstraint</innerclass>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1equations">serif::equations</innernamespace>
    <briefdescription>
<para>File containing the CenteringConstraint equation, which fixes the material point at the computational origin. </para>
    </briefdescription>
    <detaileddescription>
<para><simplesect kind="author"><para>Emily M. Boudreaux</para>
</simplesect>
</para>
<para><simplesect kind="note"><para>This is probably the simplest equation we have right now and therefore may serve as a useful example to learn from. </para>
</simplesect>
</para>
    </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="11"><highlight class="normal"></highlight></codeline>
<codeline lineno="12"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;array&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="13"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;string_view&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="14"><highlight class="normal"></highlight></codeline>
<codeline lineno="15"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="equations_2contributions_8hpp" kindref="compound">serif/equations/contributions.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="16"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="point_8hpp" kindref="compound">serif/equations/point.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="17"><highlight class="normal"></highlight></codeline>
<codeline lineno="18"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1equations" kindref="compound">serif::equations</ref><sp/>{</highlight></codeline>
<codeline lineno="26" refid="structserif_1_1equations_1_1_centering_constraint" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1equations_1_1_centering_constraint" kindref="compound">CenteringConstraint</ref><sp/>final<sp/>:<sp/><ref refid="structserif_1_1equations_1_1_contribution" kindref="compound">Contribution</ref>&lt;discretization::forms::Operand&lt;discretization::blocks::displacement::vector&gt;&gt;<sp/>{</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1equations_1_1_centering_constraint_1acd45027ab10e9ef3bd43b9eb714ee34e" kindref="member">Operands</ref><sp/>=<sp/><ref refid="structserif_1_1utils_1_1types_1_1_type_list" kindref="compound">utils::types::TypeList&lt;TestOperand&gt;</ref>;<sp/><sp/><sp/><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/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/>std::string_view<sp/><ref refid="structserif_1_1equations_1_1_centering_constraint_1adb857024524c537ee6a03c9d9268220a" kindref="member">name</ref><sp/>=<sp/></highlight><highlight class="stringliteral">&quot;centering<sp/>constraint&quot;</highlight><highlight class="normal">;<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><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1equations_1_1_centering_constraint_1a40474bc0fa81c0969253651b05d71af7" kindref="member">position_independent</ref><sp/>=<sp/></highlight><highlight class="keyword">true</highlight><highlight class="normal">;<sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight></codeline>
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/>std::array&lt;double,<sp/>3&gt;<sp/><ref refid="structserif_1_1equations_1_1_centering_constraint_1a2dada941d36edcdb49c4a9577b25c6ba" kindref="member">reference_position</ref>{};<sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight></codeline>
<codeline lineno="31"><highlight class="normal"></highlight></codeline>
<codeline lineno="32"><highlight class="normal"></highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1equations_1_1_point_linearization" kindref="compound">PointLinearization&lt;Operands, discretization::forms::VectorValue&gt;</ref><sp/><ref refid="structserif_1_1equations_1_1_centering_constraint_1a0852997e2cf681146284f03846f80aff" kindref="member">evaluate</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1equations_1_1_equation_point" kindref="compound">EquationPoint&lt;Operands&gt;</ref>&amp;<sp/>point)<sp/>{</highlight></codeline>
<codeline lineno="42"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="structserif_1_1equations_1_1_point_linearization" kindref="compound">PointLinearization&lt;Operands, discretization::forms::VectorValue&gt;</ref><sp/>result;</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>result.<ref refid="structserif_1_1equations_1_1_point_linearization_1a9bc0792fca97f037ddede6adacf0f422" kindref="member">residual</ref><sp/>=<sp/>point.<ref refid="structserif_1_1equations_1_1_equation_point_1a9a3734ccf2487dfccfc2613917f7d4e8" kindref="member">fields</ref>.get&lt;<ref refid="structserif_1_1equations_1_1_contribution_1a6ad0d6daa9f9c3dfb155841cb0a562bc" kindref="member">Test</ref>&gt;();</highlight></codeline>
<codeline lineno="44"><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/>axis<sp/>=<sp/>0;<sp/>axis<sp/>&lt;<sp/>3;<sp/>++axis)<sp/>{</highlight></codeline>
<codeline lineno="45"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>result.<ref refid="structserif_1_1equations_1_1_point_linearization_1a67c6f514532b7eae1456c4f70d964878" kindref="member">field_derivatives</ref>.get&lt;<ref refid="structserif_1_1equations_1_1_contribution_1a6ad0d6daa9f9c3dfb155841cb0a562bc" kindref="member">Test</ref>&gt;()[axis][axis]<sp/>=<sp/>1.0;</highlight></codeline>
<codeline lineno="46"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="47"><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/>result;</highlight></codeline>
<codeline lineno="48"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="49"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="50"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>serif::equations</highlight><highlight class="normal"></highlight></codeline>
    </programlisting>
    <location file="src/include/serif/equations/centering.hpp"/>
  </compounddef>
</doxygen>