MeanField_SERiF/docs/xml/geometry_2surface_2evaluation_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="geometry_2surface_2evaluation_8hpp" kind="file" language="C++">
    <compoundname>evaluation.hpp</compoundname>
    <includes refid="geometry_2surface_2detail_2evaluation_8hpp" local="yes">serif/geometry/surface/detail/evaluation.hpp</includes>
    <includedby refid="surface_8hpp" local="yes">src/include/serif/geometry/surface/surface.hpp</includedby>
    <incdepgraph>
      <node id="25">
        <label>serif/dimensions/dimensions.hpp</label>
        <link refid="dimensions_8hpp"/>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="15">
        <label>serif/dimensions/partial.hpp</label>
        <link refid="partial_8hpp"/>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="14" 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="56">
        <label>serif/dimensions/type_alias.hpp</label>
        <link refid="type__alias_8hpp"/>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
      </node>
      <node id="34">
        <label>serif/discretization/blocks/base.hpp</label>
        <link refid="base_8hpp"/>
      </node>
      <node id="32">
        <label>serif/discretization/blocks/concepts.hpp</label>
        <link refid="discretization_2blocks_2concepts_8hpp"/>
        <childnode refid="33" relation="include">
        </childnode>
      </node>
      <node id="33">
        <label>serif/discretization/blocks/fields.hpp</label>
        <link refid="fields_8hpp"/>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
        <childnode refid="34" relation="include">
        </childnode>
        <childnode refid="35" relation="include">
        </childnode>
        <childnode refid="40" relation="include">
        </childnode>
        <childnode refid="44" relation="include">
        </childnode>
        <childnode refid="45" relation="include">
        </childnode>
        <childnode refid="46" relation="include">
        </childnode>
      </node>
      <node id="31">
        <label>serif/discretization/blocks/traits.hpp</label>
        <link refid="discretization_2blocks_2traits_8hpp"/>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="32" relation="include">
        </childnode>
      </node>
      <node id="40">
        <label>serif/discretization/domain/concepts.hpp</label>
        <link refid="discretization_2domain_2concepts_8hpp"/>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="41" relation="include">
        </childnode>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="36" relation="include">
        </childnode>
        <childnode refid="42" relation="include">
        </childnode>
        <childnode refid="43" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
      </node>
      <node id="44">
        <label>serif/discretization/domain/physical_domains.hpp</label>
        <link refid="physical__domains_8hpp"/>
        <childnode refid="43" relation="include">
        </childnode>
        <childnode refid="40" relation="include">
        </childnode>
      </node>
      <node id="43">
        <label>serif/discretization/domain/types.hpp</label>
        <link refid="discretization_2domain_2types_8hpp"/>
        <childnode refid="26" relation="include">
        </childnode>
      </node>
      <node id="48">
        <label>serif/discretization/forms/operands.hpp</label>
        <link refid="operands_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="32" relation="include">
        </childnode>
      </node>
      <node id="30">
        <label>serif/discretization/forms/value.hpp</label>
        <link refid="value_8hpp"/>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="31" relation="include">
        </childnode>
        <childnode refid="48" relation="include">
        </childnode>
      </node>
      <node id="35">
        <label>serif/discretization/functional_space/space.hpp</label>
        <link refid="space_8hpp"/>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="36" relation="include">
        </childnode>
        <childnode refid="37" relation="include">
        </childnode>
      </node>
      <node id="5">
        <label>serif/eos/evaluation.hpp</label>
        <link refid="eos_2evaluation_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="6">
        <label>serif/eos/models/concepts.hpp</label>
        <link refid="eos_2models_2concepts_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="24" relation="include">
        </childnode>
      </node>
      <node id="7">
        <label>serif/eos/models/traits.hpp</label>
        <link refid="eos_2models_2traits_8hpp"/>
        <childnode refid="8" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="16" relation="include">
        </childnode>
      </node>
      <node id="18">
        <label>serif/eos/relations/catalog.hpp</label>
        <link refid="catalog_8hpp"/>
        <childnode refid="19" relation="include">
        </childnode>
        <childnode refid="22" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="16">
        <label>serif/eos/relations/concepts.hpp</label>
        <link refid="eos_2relations_2concepts_8hpp"/>
        <childnode refid="17" relation="include">
        </childnode>
      </node>
      <node id="24">
        <label>serif/eos/relations/relations.hpp</label>
        <link refid="eos_2relations_2relations_8hpp"/>
        <childnode refid="18" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
      </node>
      <node id="17">
        <label>serif/eos/relations/traits.hpp</label>
        <link refid="eos_2relations_2traits_8hpp"/>
        <childnode refid="18" relation="include">
        </childnode>
      </node>
      <node id="29">
        <label>serif/equations/point.hpp</label>
        <link refid="point_8hpp"/>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
        <childnode refid="45" relation="include">
        </childnode>
      </node>
      <node id="49">
        <label>serif/geometry/surface/compilation.hpp</label>
        <link refid="compilation_8hpp"/>
        <childnode refid="50" relation="include">
        </childnode>
        <childnode refid="55" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>serif/geometry/surface/detail/evaluation.hpp</label>
        <link refid="geometry_2surface_2detail_2evaluation_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="27" relation="include">
        </childnode>
      </node>
      <node id="50">
        <label>serif/geometry/surface/detail/relations.hpp</label>
        <link refid="geometry_2surface_2detail_2relations_8hpp"/>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="30" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="51" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/geometry/surface/evaluation.hpp</label>
        <link refid="geometry_2surface_2evaluation_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
      </node>
      <node id="55">
        <label>serif/geometry/surface/isobaric.hpp</label>
        <link refid="isobaric_8hpp"/>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="25" relation="include">
        </childnode>
        <childnode refid="56" relation="include">
        </childnode>
      </node>
      <node id="27">
        <label>serif/geometry/surface/linearization.hpp</label>
        <link refid="surface_2linearization_8hpp"/>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="28" relation="include">
        </childnode>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="29" relation="include">
        </childnode>
        <childnode refid="49" 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="46">
        <label>serif/meta/names.hpp</label>
        <link refid="names_8hpp"/>
        <childnode refid="26" relation="include">
        </childnode>
        <childnode refid="47" relation="include">
        </childnode>
      </node>
      <node id="54">
        <label>serif/utils/dependencies/binding.hpp</label>
        <link refid="utils_2dependencies_2binding_8hpp"/>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
      </node>
      <node id="52">
        <label>serif/utils/dependencies/detail/type_lists.hpp</label>
        <link refid="type__lists_8hpp"/>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="53" relation="include">
        </childnode>
      </node>
      <node id="53">
        <label>serif/utils/dependencies/key_list.hpp</label>
        <link refid="key__list_8hpp"/>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="54" relation="include">
        </childnode>
        <childnode refid="20" relation="include">
        </childnode>
        <childnode refid="45" relation="include">
        </childnode>
      </node>
      <node id="51">
        <label>serif/utils/dependencies/key_list_operations.hpp</label>
        <link refid="key__list__operations_8hpp"/>
        <childnode refid="23" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
        <childnode refid="52" 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="19">
        <label>serif/utils/misc/concepts/type_uniqueness.hpp</label>
        <link refid="concepts_2type__uniqueness_8hpp"/>
        <childnode refid="20" 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="22">
        <label>serif/utils/misc/std_helper/variadic_cleaning.hpp</label>
        <link refid="variadic__cleaning_8hpp"/>
        <childnode refid="23" relation="include">
        </childnode>
      </node>
      <node id="20">
        <label>serif/utils/misc/traits/type_uniqueness.hpp</label>
        <link refid="traits_2type__uniqueness_8hpp"/>
        <childnode refid="21" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
      </node>
      <node id="45">
        <label>serif/utils/types/type_list.hpp</label>
        <link refid="type__list_8hpp"/>
      </node>
      <node id="21">
        <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="23">
        <label>cstddef</label>
      </node>
      <node id="4">
        <label>expected</label>
      </node>
      <node id="36">
        <label>format</label>
      </node>
      <node id="28">
        <label>limits</label>
      </node>
      <node id="39">
        <label>magic_enum/magic_enum_all.hpp</label>
      </node>
      <node id="47">
        <label>nameof.hpp</label>
      </node>
      <node id="42">
        <label>numeric</label>
      </node>
      <node id="41">
        <label>span</label>
      </node>
      <node id="26">
        <label>string_view</label>
      </node>
      <node id="12">
        <label>tuple</label>
      </node>
      <node id="9">
        <label>type_traits</label>
      </node>
      <node id="38">
        <label>unordered_map</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="3">
        <label>src/compile_time_checks/serif/geometry/surface.cpp</label>
        <link refid="surface_8cpp"/>
      </node>
      <node id="1">
        <label>src/include/serif/geometry/surface/evaluation.hpp</label>
        <link refid="geometry_2surface_2evaluation_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
      </node>
      <node id="2">
        <label>src/include/serif/geometry/surface/surface.hpp</label>
        <link refid="surface_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
      </node>
    </invincdepgraph>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1geometry">serif::geometry</innernamespace>
    <innernamespace refid="namespaceserif_1_1geometry_1_1surface">serif::geometry::surface</innernamespace>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </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="3"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="geometry_2surface_2detail_2evaluation_8hpp" kindref="compound">serif/geometry/surface/detail/evaluation.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1geometry_1_1surface" kindref="compound">serif::geometry::surface</ref><sp/>{</highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;PressureSurfaceFormulationType<sp/>Formulation&gt;</highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/>std::expected&lt;SurfaceLinearization&lt;Formulation&gt;,<sp/><ref refid="structserif_1_1geometry_1_1surface_1_1_surface_failure" kindref="compound">SurfaceFailure</ref>&gt;<sp/><ref refid="namespaceserif_1_1geometry_1_1surface_1a4cdea9db2006b47252ed75446fd9c5d1" kindref="member">evaluate_pressure_surface</ref>(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Formulation::EquationOfState&amp;<sp/>equation_of_state,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1geometry_1_1surface_1_1_isobaric_surface" kindref="compound">IsobaricSurface</ref>&amp;<sp/>condition,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1geometry_1_1surface_1aac7a93b7163561a9bfbf7c7447eeebfe" kindref="member">SurfacePoint&lt;Formulation&gt;</ref>&amp;<sp/>point)<sp/>{</highlight></codeline>
<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(!<ref refid="namespaceserif_1_1geometry_1_1surface_1_1detail_1ae06b817a237df48fe4fc5740fac4f0ea" kindref="member">detail::finite_state&lt;Formulation&gt;</ref>(point,<sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Formulation::StateQuantities{}))<sp/>{</highlight></codeline>
<codeline lineno="17"><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/>std::unexpected(<ref refid="structserif_1_1geometry_1_1surface_1_1_surface_failure" kindref="compound">SurfaceFailure</ref>{.reason<sp/>=<sp/><ref refid="namespaceserif_1_1geometry_1_1surface_1a54b9db77caf2af1870677a91cfc70026a9ae4e64d7f01a1eb9df10b8fe9738de2" kindref="member">SurfaceFailureReason::non_finite_state</ref>,<sp/>.message<sp/>=<sp/></highlight><highlight class="stringliteral">&quot;The<sp/>surface<sp/>state<sp/>must<sp/>be<sp/>finite;<sp/>supply<sp/>finite<sp/>values<sp/>for<sp/>every<sp/>required<sp/>thermodynamic<sp/>quantity.&quot;</highlight><highlight class="normal">});</highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="19"><highlight class="normal"></highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/>response<sp/>=<sp/><ref refid="namespaceserif_1_1geometry_1_1surface_1_1detail_1a0ed025267a4b81a4d5f9c2d7f8929cd0" kindref="member">detail::evaluate_surface_response&lt;Formulation&gt;</ref>(equation_of_state,<sp/>condition.target_pressure(),<sp/>point);</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">if</highlight><highlight class="normal"><sp/>(!response)<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/>std::unexpected(response.error());</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/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1geometry_1_1surface_1_1detail_1a5dd1679de9226d8f2f5bf03d2548c0bc" kindref="member">detail::checked_linearization&lt;Formulation&gt;</ref>(condition.target_pressure(),<sp/>point,<sp/>*response);</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="26"><highlight class="normal">}</highlight></codeline>
    </programlisting>
    <location file="src/include/serif/geometry/surface/evaluation.hpp"/>
  </compounddef>
</doxygen>