MeanField_SERiF/docs/xml/laneemden_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="laneemden_8cpp" kind="file" language="C++">
    <compoundname>laneemden.cpp</compoundname>
    <includes local="no">concepts</includes>
    <includes local="no">expected</includes>
    <includes local="no">format</includes>
    <includes local="no">string</includes>
    <includes refid="laneemden_8hpp" local="yes">serif/utils/laneemden/laneemden.hpp</includes>
    <incdepgraph>
      <node id="1">
        <label>src/compile_time_checks/serif/utils/laneemden.cpp</label>
        <link refid="laneemden_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="6" relation="include">
        </childnode>
      </node>
      <node id="32">
        <label>serif/dimensions/dimensions.hpp</label>
        <link refid="dimensions_8hpp"/>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="33" relation="include">
        </childnode>
      </node>
      <node id="33">
        <label>serif/dimensions/quantities.hpp</label>
        <link refid="quantities_8hpp"/>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="34" relation="include">
        </childnode>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="35" relation="include">
        </childnode>
        <childnode refid="36" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
      </node>
      <node id="26">
        <label>serif/meta/enums.hpp</label>
        <link refid="enums_8hpp"/>
        <childnode refid="27" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="28" relation="include">
        </childnode>
      </node>
      <node id="25">
        <label>serif/utils/error/codes.hpp</label>
        <link refid="codes_8hpp"/>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="26" relation="include">
        </childnode>
      </node>
      <node id="12">
        <label>serif/utils/error/errors.hpp</label>
        <link refid="errors_8hpp"/>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
        <childnode refid="29" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>serif/utils/laneemden/laneemden.hpp</label>
        <link refid="laneemden_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="31" relation="include">
        </childnode>
      </node>
      <node id="31">
        <label>serif/utils/laneemden/scaling.hpp</label>
        <link refid="scaling_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="32" relation="include">
        </childnode>
        <childnode refid="7" relation="include">
        </childnode>
      </node>
      <node id="7">
        <label>serif/utils/laneemden/solution.hpp</label>
        <link refid="solution_8hpp"/>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
      </node>
      <node id="21">
        <label>serif/utils/misc/concepts/exceptions.hpp</label>
        <link refid="utils_2misc_2concepts_2exceptions_8hpp"/>
        <childnode refid="22" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
      </node>
      <node id="24">
        <label>serif/utils/misc/concepts/numeric.hpp</label>
        <link refid="numeric_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
      </node>
      <node id="36">
        <label>serif/utils/misc/std_helper/cleaning.hpp</label>
        <link refid="cleaning_8hpp"/>
        <childnode refid="23" relation="include">
        </childnode>
      </node>
      <node id="17">
        <label>serif/utils/misc/terminal/colors.hpp</label>
        <link refid="colors_8hpp"/>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
      </node>
      <node id="29">
        <label>serif/utils/types/strings.hpp</label>
        <link refid="types_2strings_8hpp"/>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
      </node>
      <node id="15">
        <label>algorithm</label>
      </node>
      <node id="34">
        <label>compare</label>
      </node>
      <node id="2">
        <label>concepts</label>
      </node>
      <node id="8">
        <label>cstddef</label>
      </node>
      <node id="14">
        <label>cstdint</label>
      </node>
      <node id="13">
        <label>cstdio</label>
      </node>
      <node id="18">
        <label>cstdlib</label>
      </node>
      <node id="22">
        <label>exception</label>
      </node>
      <node id="3">
        <label>expected</label>
      </node>
      <node id="4">
        <label>format</label>
      </node>
      <node id="30">
        <label>iostream</label>
      </node>
      <node id="28">
        <label>magic_enum/magic_enum_all.hpp</label>
      </node>
      <node id="9">
        <label>optional</label>
      </node>
      <node id="5">
        <label>string</label>
      </node>
      <node id="10">
        <label>string_view</label>
      </node>
      <node id="35">
        <label>tuple</label>
      </node>
      <node id="23">
        <label>type_traits</label>
      </node>
      <node id="20">
        <label>unistd.h</label>
      </node>
      <node id="27">
        <label>unordered_map</label>
      </node>
      <node id="19">
        <label>utility</label>
      </node>
      <node id="11">
        <label>vector</label>
      </node>
      <node id="16">
        <label>version</label>
      </node>
    </incdepgraph>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <programlisting>
<codeline lineno="1"><highlight class="preprocessor">#include<sp/>&lt;concepts&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="2"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;expected&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="3"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;format&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;string&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="laneemden_8hpp" kindref="compound">serif/utils/laneemden/laneemden.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><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">namespace<sp/></highlight><highlight class="normal">laneemden<sp/>=<sp/><ref refid="namespaceserif_1_1utils_1_1laneemden" kindref="compound">serif::utils::laneemden</ref>;</highlight></codeline>
<codeline lineno="10"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal">dimensions<sp/>=<sp/><ref refid="namespaceserif_1_1dimensions" kindref="compound">serif::dimensions</ref>;</highlight></codeline>
<codeline lineno="11"><highlight class="normal"></highlight></codeline>
<codeline lineno="13"><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/>Mass,<sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Density,<sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Gravity&gt;</highlight></codeline>
<codeline lineno="14" refid="concept_0d105303371101360306025050204101312212144366254006_1_1_can_scale_mass" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">concept<sp/></highlight><highlight class="normal"><ref refid="concept_0d105303371101360306025050204101312212144366254006_1_1_can_scale_mass" kindref="compound">CanScaleMass</ref><sp/>=<sp/></highlight><highlight class="keyword">requires</highlight><highlight class="normal">(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>laneemden::Solution<sp/>&amp;solution,<sp/>Mass<sp/>mass,<sp/>Density<sp/>density,<sp/>Gravity<sp/>gravity)<sp/>{</highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{<sp/>laneemden::scale_from_mass(solution,<sp/>mass,<sp/>density,<sp/>gravity)<sp/>}<sp/>-&gt;<sp/>std::same_as&lt;std::expected&lt;laneemden::PhysicalScales,<sp/>std::string&gt;&gt;;</highlight></codeline>
<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/>};</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">(<ref refid="concept_0d105303371101360306025050204101312212144366254006_1_1_can_scale_mass" kindref="compound">CanScaleMass&lt;dimensions::QuantityValue&lt;dimensions::Mass&gt;</ref>,<sp/>dimensions::QuantityValue&lt;dimensions::MassDensity&gt;,<sp/>dimensions::QuantityValue&lt;dimensions::GravitationalConstant&gt;&gt;);</highlight></codeline>
<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(!<ref refid="concept_0d105303371101360306025050204101312212144366254006_1_1_can_scale_mass" kindref="compound">CanScaleMass&lt;double, double, double&gt;</ref>);</highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(!<ref refid="concept_0d105303371101360306025050204101312212144366254006_1_1_can_scale_mass" kindref="compound">CanScaleMass&lt;dimensions::QuantityValue&lt;dimensions::Length&gt;</ref>,<sp/>dimensions::QuantityValue&lt;dimensions::MassDensity&gt;,<sp/>dimensions::QuantityValue&lt;dimensions::GravitationalConstant&gt;&gt;);</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(!<ref refid="concept_0d105303371101360306025050204101312212144366254006_1_1_can_scale_mass" kindref="compound">CanScaleMass&lt;dimensions::QuantityValue&lt;dimensions::Mass&gt;</ref>,<sp/>dimensions::QuantityValue&lt;dimensions::Length&gt;,<sp/>dimensions::QuantityValue&lt;dimensions::GravitationalConstant&gt;&gt;);</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;</highlight><highlight class="keyword">decltype</highlight><highlight class="normal">(laneemden::solve(3.0)),<sp/>std::expected&lt;laneemden::Solution,<sp/>std::string&gt;&gt;);</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::equality_comparable&lt;laneemden::IntegrationOptions&gt;);</highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::formattable&lt;laneemden::Sample,<sp/>char&gt;);</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::formattable&lt;laneemden::Solution,<sp/>char&gt;);</highlight></codeline>
<codeline lineno="26"><highlight class="normal"></highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/>std::format_string&lt;laneemden::Sample,<sp/>laneemden::Sample,<sp/>laneemden::Sample,<sp/>laneemden::Sample,<sp/>laneemden::Sample&gt;</highlight></codeline>
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>sample_formats{</highlight><highlight class="stringliteral">&quot;{}<sp/>{:all}<sp/>{:xi}<sp/>{:theta}<sp/>{:derivative}&quot;</highlight><highlight class="normal">};</highlight></codeline>
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/>std::format_string&lt;laneemden::Solution,<sp/>laneemden::Solution,<sp/>laneemden::Solution,<sp/>laneemden::Solution,<sp/>laneemden::Solution&gt;</highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>solution_formats{</highlight><highlight class="stringliteral">&quot;{}<sp/>{:all}<sp/>{:xi}<sp/>{:theta}<sp/>{:derivative}&quot;</highlight><highlight class="normal">};</highlight></codeline>
<codeline lineno="32"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="src/compile_time_checks/serif/utils/laneemden.cpp"/>
  </compounddef>
</doxygen>