MeanField_SERiF/docs/xml/specifications_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="specifications_8cpp" kind="file" language="C++">
    <compoundname>specifications.cpp</compoundname>
    <includes local="no">algorithm</includes>
    <includes local="no">cmath</includes>
    <includes local="no">stdexcept</includes>
    <includes refid="fixed__angular__momentum_8hpp" local="yes">serif/model/specifications/fixed_angular_momentum.hpp</includes>
    <includes refid="fixed__total__mass_8hpp" local="yes">serif/model/specifications/fixed_total_mass.hpp</includes>
    <includes refid="errors_8hpp" local="yes">serif/utils/error/errors.hpp</includes>
    <incdepgraph>
      <node id="15">
        <label>serif/dimensions/dimensions.hpp</label>
        <link refid="dimensions_8hpp"/>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>serif/dimensions/quantities.hpp</label>
        <link refid="quantities_8hpp"/>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="7">
        <label>serif/dimensions/type_alias.hpp</label>
        <link refid="type__alias_8hpp"/>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
      </node>
      <node id="37">
        <label>serif/meta/enums.hpp</label>
        <link refid="enums_8hpp"/>
        <childnode refid="38" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="39" relation="include">
        </childnode>
      </node>
      <node id="17">
        <label>serif/model/specification.hpp</label>
        <link refid="specification_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
      </node>
      <node id="5">
        <label>serif/model/specifications/fixed_angular_momentum.hpp</label>
        <link refid="fixed__angular__momentum_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
      </node>
      <node id="23">
        <label>serif/model/specifications/fixed_total_mass.hpp</label>
        <link refid="fixed__total__mass_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
      </node>
      <node id="22">
        <label>serif/model/specifications/physical_names.hpp</label>
        <link refid="physical__names_8hpp"/>
      </node>
      <node id="36">
        <label>serif/utils/error/codes.hpp</label>
        <link refid="codes_8hpp"/>
        <childnode refid="28" relation="include">
        </childnode>
        <childnode refid="37" relation="include">
        </childnode>
      </node>
      <node id="24">
        <label>serif/utils/error/errors.hpp</label>
        <link refid="errors_8hpp"/>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="27" relation="include">
        </childnode>
        <childnode refid="28" relation="include">
        </childnode>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="29" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
        <childnode refid="34" relation="include">
        </childnode>
        <childnode refid="36" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
      </node>
      <node id="34">
        <label>serif/utils/misc/concepts/exceptions.hpp</label>
        <link refid="utils_2misc_2concepts_2exceptions_8hpp"/>
        <childnode refid="35" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="14">
        <label>serif/utils/misc/concepts/numeric.hpp</label>
        <link refid="numeric_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="13">
        <label>serif/utils/misc/std_helper/cleaning.hpp</label>
        <link refid="cleaning_8hpp"/>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="30">
        <label>serif/utils/misc/terminal/colors.hpp</label>
        <link refid="colors_8hpp"/>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="31" relation="include">
        </childnode>
        <childnode refid="32" relation="include">
        </childnode>
        <childnode refid="33" relation="include">
        </childnode>
      </node>
      <node id="19">
        <label>serif/utils/types/strings.hpp</label>
        <link refid="types_2strings_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
      </node>
      <node id="21">
        <label>serif/utils/types/type_list.hpp</label>
        <link refid="type__list_8hpp"/>
      </node>
      <node id="1">
        <label>src/lib/serif/model/specifications.cpp</label>
        <link refid="specifications_8cpp"/>
        <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="23" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>algorithm</label>
      </node>
      <node id="6">
        <label>array</label>
      </node>
      <node id="3">
        <label>cmath</label>
      </node>
      <node id="10">
        <label>compare</label>
      </node>
      <node id="11">
        <label>concepts</label>
      </node>
      <node id="28">
        <label>cstdint</label>
      </node>
      <node id="26">
        <label>cstdio</label>
      </node>
      <node id="31">
        <label>cstdlib</label>
      </node>
      <node id="35">
        <label>exception</label>
      </node>
      <node id="25">
        <label>format</label>
      </node>
      <node id="20">
        <label>iostream</label>
      </node>
      <node id="18">
        <label>limits</label>
      </node>
      <node id="39">
        <label>magic_enum/magic_enum_all.hpp</label>
      </node>
      <node id="4">
        <label>stdexcept</label>
      </node>
      <node id="27">
        <label>string</label>
      </node>
      <node id="16">
        <label>string_view</label>
      </node>
      <node id="12">
        <label>tuple</label>
      </node>
      <node id="9">
        <label>type_traits</label>
      </node>
      <node id="33">
        <label>unistd.h</label>
      </node>
      <node id="38">
        <label>unordered_map</label>
      </node>
      <node id="32">
        <label>utility</label>
      </node>
      <node id="29">
        <label>version</label>
      </node>
    </incdepgraph>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1model">serif::model</innernamespace>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <programlisting>
<codeline lineno="1"><highlight class="preprocessor">#include<sp/>&lt;algorithm&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="2"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;cmath&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="3"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;stdexcept&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;<ref refid="fixed__angular__momentum_8hpp" kindref="compound">serif/model/specifications/fixed_angular_momentum.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="fixed__total__mass_8hpp" kindref="compound">serif/model/specifications/fixed_total_mass.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="errors_8hpp" kindref="compound">serif/utils/error/errors.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="namespaceserif_1_1model" kindref="compound">serif::model</ref></highlight></codeline>
<codeline lineno="10"><highlight class="normal">{</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1model_1a5a76a53b06ed3a20062a609e61848840" kindref="member">validate_target</ref>(</highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>value,<sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/>zero_allowed,<sp/>std::string_view<sp/>name)</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/>namespace<sp/></highlight><highlight class="normal">utils::errors;</highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>serif_ensure&lt;SERiFErrorCode::INVALID_ARGUMENT,<sp/>std::invalid_argument&gt;(std::isfinite(value)<sp/>&amp;&amp;<sp/>(zero_allowed<sp/>?<sp/>value<sp/>&gt;=<sp/>0.0<sp/>:<sp/>value<sp/>&gt;<sp/>0.0),</highlight></codeline>
<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="stringliteral">&quot;The<sp/>{}<sp/>target<sp/>must<sp/>be<sp/>finite<sp/>and<sp/>{};<sp/>received<sp/>{}.<sp/>Supply<sp/>a<sp/>physical<sp/>target<sp/>in<sp/>the<sp/>permitted<sp/>range.&quot;</highlight><highlight class="normal">,<sp/>name,<sp/>zero_allowed<sp/>?<sp/></highlight><highlight class="stringliteral">&quot;nonnegative&quot;</highlight><highlight class="normal"><sp/>:<sp/></highlight><highlight class="stringliteral">&quot;positive&quot;</highlight><highlight class="normal">,<sp/>value);</highlight></codeline>
<codeline lineno="17"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="18"><highlight class="normal"></highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/><ref refid="classserif_1_1model_1_1_fixed_total_mass_1a094eb22b4dcbbdd217d7ef8612266cfb" kindref="member">FixedTotalMass::FixedTotalMass</ref>(TargetValue<sp/>mass)<sp/>:<sp/>m_target(mass)</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="22"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1model_1a5a76a53b06ed3a20062a609e61848840" kindref="member">validate_target</ref>(mass.value(),<sp/></highlight><highlight class="keyword">false</highlight><highlight class="normal">,<sp/></highlight><highlight class="stringliteral">&quot;total<sp/>mass&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="24"><highlight class="normal"></highlight></codeline>
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/>FixedTotalMass::FixedTotalMass(Parameters<sp/>parameters)<sp/>:<sp/>FixedTotalMass(parameters.total_mass)</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="29"><highlight class="normal"></highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/>FixedAngularMomentum::FixedAngularMomentum(TargetValue<sp/>angular_momentum)<sp/>:<sp/>FixedAngularMomentum(Parameters{.angular_momentum<sp/>=<sp/>angular_momentum})</highlight></codeline>
<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="34"><highlight class="normal"></highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/>FixedAngularMomentum::FixedAngularMomentum(Parameters<sp/>parameters)<sp/>:<sp/>m_target(parameters.angular_momentum),<sp/>m_axis(parameters.axis),<sp/>m_center(parameters.center)</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/>namespace<sp/></highlight><highlight class="normal">utils::errors;</highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1model_1a5a76a53b06ed3a20062a609e61848840" kindref="member">validate_target</ref>(m_target.value(),<sp/></highlight><highlight class="keyword">true</highlight><highlight class="normal">,<sp/></highlight><highlight class="stringliteral">&quot;angular<sp/>momentum&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="40"><highlight class="normal"></highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>maximum_component<sp/>=<sp/>0.0;</highlight></codeline>
<codeline lineno="42"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">for</highlight><highlight class="normal"><sp/>(std::size_t<sp/>component<sp/>=<sp/>0;<sp/><ref refid="namespaceserif_1_1discretization_1_1forms_1aa4daa912e2157d80dc731a6ce2349dfe" kindref="member">component</ref><sp/>&lt;<sp/>m_axis.size();<sp/>++<ref refid="namespaceserif_1_1discretization_1_1forms_1aa4daa912e2157d80dc731a6ce2349dfe" kindref="member">component</ref>)</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/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>serif_ensure&lt;SERiFErrorCode::INVALID_ARGUMENT,<sp/>std::invalid_argument&gt;(std::isfinite(m_axis[component])<sp/>&amp;&amp;<sp/>std::isfinite(m_center[component]),</highlight></codeline>
<codeline lineno="45"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="stringliteral">&quot;Rotation<sp/>axis<sp/>and<sp/>center<sp/>components<sp/>must<sp/>be<sp/>finite;<sp/>component<sp/>{}<sp/>contains<sp/>axis<sp/>{}<sp/>and<sp/>center<sp/>{}.<sp/>Supply<sp/>a<sp/>finite<sp/>rotation<sp/>axis<sp/>and<sp/>center.&quot;</highlight><highlight class="normal">,<sp/>component,<sp/>m_axis[component],<sp/>m_center[component]);</highlight></codeline>
<codeline lineno="46"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>maximum_component<sp/>=<sp/>std::max(maximum_component,<sp/>std::abs(m_axis[component]));</highlight></codeline>
<codeline lineno="47"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="48"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>serif_ensure&lt;SERiFErrorCode::INVALID_ARGUMENT,<sp/>std::invalid_argument&gt;(maximum_component<sp/>&gt;<sp/>0.0,<sp/></highlight><highlight class="stringliteral">&quot;A<sp/>rotation<sp/>axis<sp/>must<sp/>be<sp/>nonzero;<sp/>supply<sp/>a<sp/>direction<sp/>such<sp/>as<sp/>(0,<sp/>0,<sp/>1).&quot;</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="49"><highlight class="normal"></highlight></codeline>
<codeline lineno="50"><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">double</highlight><highlight class="normal">&amp;<sp/>component<sp/>:<sp/>m_axis)</highlight></codeline>
<codeline lineno="51"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="52"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1discretization_1_1forms_1aa4daa912e2157d80dc731a6ce2349dfe" kindref="member">component</ref><sp/>/=<sp/>maximum_component;</highlight></codeline>
<codeline lineno="53"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="54"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">double</highlight><highlight class="normal"><sp/>norm<sp/>=<sp/>std::hypot(m_axis[0],<sp/>m_axis[1],<sp/>m_axis[2]);</highlight></codeline>
<codeline lineno="55"><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">double</highlight><highlight class="normal">&amp;<sp/>component<sp/>:<sp/>m_axis)</highlight></codeline>
<codeline lineno="56"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="57"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1discretization_1_1forms_1aa4daa912e2157d80dc731a6ce2349dfe" kindref="member">component</ref><sp/>/=<sp/>norm;</highlight></codeline>
<codeline lineno="58"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="59"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="60"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>serif::model</highlight><highlight class="normal"></highlight></codeline>
    </programlisting>
    <location file="src/lib/serif/model/specifications.cpp"/>
  </compounddef>
</doxygen>