MeanField_SERiF/docs/xml/consumers__meanfield_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="consumers__meanfield_8cpp" kind="file" language="C++">
    <compoundname>consumers_meanfield.cpp</compoundname>
    <includes refid="eos_2models_2concepts_8hpp" local="yes">serif/eos/models/concepts.hpp</includes>
    <includes refid="eos_2models_2polytropic_8hpp" local="yes">serif/eos/models/polytropic.hpp</includes>
    <incdepgraph>
      <node id="1">
        <label>src/compile_time_checks/serif/eos/consumers_meanfield.cpp</label>
        <link refid="consumers__meanfield_8cpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
      </node>
      <node id="21">
        <label>serif/dimensions/dimensions.hpp</label>
        <link refid="dimensions_8hpp"/>
        <childnode refid="22" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="11">
        <label>serif/dimensions/partial.hpp</label>
        <link refid="partial_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>serif/dimensions/quantities.hpp</label>
        <link refid="quantities_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="9" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
      </node>
      <node id="24">
        <label>serif/dimensions/type_alias.hpp</label>
        <link refid="type__alias_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>serif/eos/models/concepts.hpp</label>
        <link refid="eos_2models_2concepts_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
      </node>
      <node id="23">
        <label>serif/eos/models/polytropic.hpp</label>
        <link refid="eos_2models_2polytropic_8hpp"/>
        <childnode refid="20" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="3">
        <label>serif/eos/models/traits.hpp</label>
        <link refid="eos_2models_2traits_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
      </node>
      <node id="14">
        <label>serif/eos/relations/catalog.hpp</label>
        <link refid="catalog_8hpp"/>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="12">
        <label>serif/eos/relations/concepts.hpp</label>
        <link refid="eos_2relations_2concepts_8hpp"/>
        <childnode refid="13" relation="include">
        </childnode>
      </node>
      <node id="20">
        <label>serif/eos/relations/relations.hpp</label>
        <link refid="eos_2relations_2relations_8hpp"/>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
      </node>
      <node id="13">
        <label>serif/eos/relations/traits.hpp</label>
        <link refid="eos_2relations_2traits_8hpp"/>
        <childnode refid="14" relation="include">
        </childnode>
      </node>
      <node id="10">
        <label>serif/utils/misc/concepts/numeric.hpp</label>
        <link refid="numeric_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
      </node>
      <node id="15">
        <label>serif/utils/misc/concepts/type_uniqueness.hpp</label>
        <link refid="concepts_2type__uniqueness_8hpp"/>
        <childnode refid="16" relation="include">
        </childnode>
      </node>
      <node id="9">
        <label>serif/utils/misc/std_helper/cleaning.hpp</label>
        <link refid="cleaning_8hpp"/>
        <childnode refid="5" relation="include">
        </childnode>
      </node>
      <node id="18">
        <label>serif/utils/misc/std_helper/variadic_cleaning.hpp</label>
        <link refid="variadic__cleaning_8hpp"/>
        <childnode refid="19" relation="include">
        </childnode>
      </node>
      <node id="16">
        <label>serif/utils/misc/traits/type_uniqueness.hpp</label>
        <link refid="traits_2type__uniqueness_8hpp"/>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="17">
        <label>array</label>
      </node>
      <node id="6">
        <label>compare</label>
      </node>
      <node id="7">
        <label>concepts</label>
      </node>
      <node id="19">
        <label>cstddef</label>
      </node>
      <node id="22">
        <label>string_view</label>
      </node>
      <node id="8">
        <label>tuple</label>
      </node>
      <node id="5">
        <label>type_traits</label>
      </node>
    </incdepgraph>
    <innerclass refid="structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s" prot="public">serif::compile_time_checks::eos_meanfield::consumer_contracts::SingleRelationEOS</innerclass>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1compile__time__checks">serif::compile_time_checks</innernamespace>
    <innernamespace refid="namespaceserif_1_1compile__time__checks_1_1eos__meanfield">serif::compile_time_checks::eos_meanfield</innernamespace>
    <innernamespace refid="namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts">serif::compile_time_checks::eos_meanfield::consumer_contracts</innernamespace>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <programlisting>
<codeline lineno="1"><highlight class="preprocessor">#include<sp/>&quot;<ref refid="eos_2models_2concepts_8hpp" kindref="compound">serif/eos/models/concepts.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="2"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="eos_2models_2polytropic_8hpp" kindref="compound">serif/eos/models/polytropic.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="3"><highlight class="normal"></highlight></codeline>
<codeline lineno="4" refid="namespaceserif_1_1compile__time__checks_1_1eos__meanfield" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts" kindref="compound">serif::compile_time_checks::eos_meanfield::consumer_contracts</ref></highlight></codeline>
<codeline lineno="5"><highlight class="normal">{</highlight></codeline>
<codeline lineno="7"><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/>Output,<sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Input,<sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/>HasDerivative&gt;</highlight></codeline>
<codeline lineno="8" refid="structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s" kindref="compound">SingleRelationEOS</ref></highlight></codeline>
<codeline lineno="9"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="10"><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_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s_1a1f47ea8bc9000ef48484f8a1ba16dba3" kindref="member">Relation</ref><sp/>=<sp/><ref refid="structserif_1_1eos_1_1relations_1_1_relation" kindref="compound">eos::relations::Relation&lt;Output, Input&gt;</ref>;</highlight></codeline>
<codeline lineno="11"><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_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s_1a838b622800fd7badc6ca637f2940b61d" kindref="member">Relations</ref><sp/>=<sp/><ref refid="structserif_1_1eos_1_1relations_1_1_relation_catalog" kindref="compound">eos::relations::RelationCatalog&lt;Relation&gt;</ref>;</highlight></codeline>
<codeline lineno="12"><highlight class="normal"></highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1dimensions_1_1_quantity_value" kindref="compound">dimensions::QuantityValue&lt;Output&gt;</ref><sp/><ref refid="structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s_1a4f821daab61d40c03d457994bf10ef67" kindref="member">evaluate</ref>(<ref refid="structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s_1a1f47ea8bc9000ef48484f8a1ba16dba3" kindref="member">Relation</ref>,<sp/><ref refid="classserif_1_1dimensions_1_1_quantity_value" kindref="compound">dimensions::QuantityValue&lt;Input&gt;</ref><sp/>value)</highlight><highlight class="keyword"><sp/>const</highlight></codeline>
<codeline lineno="15"><highlight class="keyword"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></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><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1dimensions_1_1_quantity_value" kindref="compound">dimensions::QuantityValue&lt;Output&gt;</ref>{value.value()};</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="20"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">constexpr</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1dimensions_1_1_partial_derivative" kindref="compound">dimensions::PartialDerivative&lt;Output, Input&gt;</ref><sp/><ref refid="structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s_1a101b65bfb5e8fbb37f179cc932369ddc" kindref="member">partial_derivative</ref>(<ref refid="structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s_1a1f47ea8bc9000ef48484f8a1ba16dba3" kindref="member">Relation</ref>,<sp/><ref refid="structserif_1_1dimensions_1_1_with_respect_to" kindref="compound">dimensions::WithRespectTo&lt;Input&gt;</ref>,<sp/><ref refid="classserif_1_1dimensions_1_1_quantity_value" kindref="compound">dimensions::QuantityValue&lt;Input&gt;</ref>)<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">requires</highlight><highlight class="normal"><sp/>HasDerivative</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="22"><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/><ref refid="classserif_1_1dimensions_1_1_partial_derivative" kindref="compound">dimensions::PartialDerivative&lt;Output, Input&gt;</ref>{1.0};</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="25"><highlight class="normal"></highlight></codeline>
<codeline lineno="26"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1a5f258cc5a4b85dc7a7949e10cad7084b" kindref="member">DensityClosure</ref><sp/>=<sp/><ref refid="structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s" kindref="compound">SingleRelationEOS&lt;dimensions::MassDensity, dimensions::SpecificEnthalpy, true&gt;</ref>;</highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1a75980261f5a0175a1b2c1e780f624d33" kindref="member">DensityWithoutDerivative</ref><sp/>=<sp/><ref refid="structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s" kindref="compound">SingleRelationEOS&lt;dimensions::MassDensity, dimensions::SpecificEnthalpy, false&gt;</ref>;</highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1a019dfbd0bd9705fdee7cc016987a5136" kindref="member">EnthalpyPressure</ref><sp/>=<sp/><ref refid="structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s" kindref="compound">SingleRelationEOS&lt;dimensions::Pressure, dimensions::SpecificEnthalpy, true&gt;</ref>;</highlight></codeline>
<codeline lineno="29"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1adeddbb2f8c97ea992abe15ed82e90600" kindref="member">DensitySeed</ref><sp/>=<sp/><ref refid="structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s" kindref="compound">SingleRelationEOS&lt;dimensions::SpecificEnthalpy, dimensions::MassDensity, false&gt;</ref>;</highlight></codeline>
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1adb153b7d333b7ffe2fab9dfc0fb3912c" kindref="member">GeneralEOS</ref><sp/>=<sp/><ref refid="structserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1_1_single_relation_e_o_s" kindref="compound">SingleRelationEOS&lt;dimensions::SpecificEnthalpy, dimensions::Pressure, false&gt;</ref>;</highlight></codeline>
<codeline lineno="31"><highlight class="normal"></highlight></codeline>
<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1compile__time__checks_1_1eos__meanfield_1_1consumer__contracts_1a8ac71c7158ec3a4593d2ba4dbda594e3" kindref="member">DensityFromEnthalpy</ref><sp/>=<sp/><ref refid="namespaceserif_1_1eos_1_1relations_1a537de2b3f7c974159bc5639b831117c4" kindref="member">eos::relations::DensityFromSpecificEnthalpy</ref>;</highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(<ref refid="conceptserif_1_1eos_1_1models_1_1_e_o_s_supporting_partial_derivative" kindref="compound">eos::models::EOSSupportingPartialDerivative&lt;DensityClosure, DensityFromEnthalpy, dimensions::SpecificEnthalpy&gt;</ref>);</highlight></codeline>
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(<ref refid="conceptserif_1_1eos_1_1models_1_1_e_o_s_model" kindref="compound">eos::models::EOSModel&lt;DensityWithoutDerivative&gt;</ref><sp/>&amp;&amp;<sp/><ref refid="conceptserif_1_1eos_1_1models_1_1_e_o_s_supporting_relation" kindref="compound">eos::models::EOSSupportingRelation&lt;DensityWithoutDerivative, DensityFromEnthalpy&gt;</ref><sp/>&amp;&amp;</highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>!<ref refid="conceptserif_1_1eos_1_1models_1_1_e_o_s_supporting_partial_derivative" kindref="compound">eos::models::EOSSupportingPartialDerivative&lt;DensityWithoutDerivative, DensityFromEnthalpy, dimensions::SpecificEnthalpy&gt;</ref>);</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(!<ref refid="conceptserif_1_1eos_1_1models_1_1_e_o_s_supporting_relation" kindref="compound">eos::models::EOSSupportingRelation&lt;EnthalpyPressure, DensityFromEnthalpy&gt;</ref>);</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(<ref refid="conceptserif_1_1eos_1_1models_1_1_structure_seed_e_o_s" kindref="compound">eos::models::StructureSeedEOS&lt;eos::models::Polytrope&gt;</ref><sp/>&amp;&amp;<sp/><ref refid="conceptserif_1_1eos_1_1models_1_1_structure_seed_e_o_s" kindref="compound">eos::models::StructureSeedEOS&lt;DensitySeed&gt;</ref>);</highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(!<ref refid="conceptserif_1_1eos_1_1models_1_1_structure_seed_e_o_s" kindref="compound">eos::models::StructureSeedEOS&lt;DensityClosure&gt;</ref>);</highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(<ref refid="conceptserif_1_1eos_1_1models_1_1_e_o_s_model" kindref="compound">eos::models::EOSModel&lt;GeneralEOS&gt;</ref>);</highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(!<ref refid="conceptserif_1_1eos_1_1models_1_1_structure_seed_e_o_s" kindref="compound">eos::models::StructureSeedEOS&lt;GeneralEOS&gt;</ref><sp/>&amp;&amp;<sp/>!<ref refid="conceptserif_1_1eos_1_1models_1_1_e_o_s_supporting_relation" kindref="compound">eos::models::EOSSupportingRelation&lt;GeneralEOS, DensityFromEnthalpy&gt;</ref>);</highlight></codeline>
<codeline lineno="41"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>serif::compile_time_checks::eos_meanfield::consumer_contracts</highlight><highlight class="normal"></highlight></codeline>
    </programlisting>
    <location file="src/compile_time_checks/serif/eos/consumers_meanfield.cpp"/>
  </compounddef>
</doxygen>