MeanField_SERiF/docs/xml/fixed__central__density_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="fixed__central__density_8hpp" kind="file" language="C++">
    <compoundname>fixed_central_density.hpp</compoundname>
    <includes refid="type__alias_8hpp" local="yes">serif/dimensions/type_alias.hpp</includes>
    <includes refid="specification_8hpp" local="yes">serif/model/specification.hpp</includes>
    <includes refid="physical__names_8hpp" local="yes">serif/model/specifications/physical_names.hpp</includes>
    <includedby refid="description_8hpp" local="yes">src/include/serif/model/description.hpp</includedby>
    <includedby refid="specifications_8cpp" local="yes">src/lib/serif/model/specifications.cpp</includedby>
    <incdepgraph>
      <node id="10">
        <label>serif/dimensions/dimensions.hpp</label>
        <link refid="dimensions_8hpp"/>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
      </node>
      <node id="3">
        <label>serif/dimensions/quantities.hpp</label>
        <link refid="quantities_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
        <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>
      </node>
      <node id="2">
        <label>serif/dimensions/type_alias.hpp</label>
        <link refid="type__alias_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="10" relation="include">
        </childnode>
      </node>
      <node id="12">
        <label>serif/model/specification.hpp</label>
        <link refid="specification_8hpp"/>
        <childnode refid="13" relation="include">
        </childnode>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="14" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="15" relation="include">
        </childnode>
        <childnode refid="18" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/model/specifications/fixed_central_density.hpp</label>
        <link refid="fixed__central__density_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="19" relation="include">
        </childnode>
      </node>
      <node id="19">
        <label>serif/model/specifications/physical_names.hpp</label>
        <link refid="physical__names_8hpp"/>
      </node>
      <node id="9">
        <label>serif/utils/misc/concepts/numeric.hpp</label>
        <link refid="numeric_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>serif/utils/misc/std_helper/cleaning.hpp</label>
        <link refid="cleaning_8hpp"/>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="15">
        <label>serif/utils/types/strings.hpp</label>
        <link refid="types_2strings_8hpp"/>
        <childnode refid="16" relation="include">
        </childnode>
        <childnode refid="17" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
      </node>
      <node id="18">
        <label>serif/utils/types/type_list.hpp</label>
        <link refid="type__list_8hpp"/>
      </node>
      <node id="16">
        <label>algorithm</label>
      </node>
      <node id="13">
        <label>array</label>
      </node>
      <node id="5">
        <label>compare</label>
      </node>
      <node id="6">
        <label>concepts</label>
      </node>
      <node id="17">
        <label>iostream</label>
      </node>
      <node id="14">
        <label>limits</label>
      </node>
      <node id="11">
        <label>string_view</label>
      </node>
      <node id="7">
        <label>tuple</label>
      </node>
      <node id="4">
        <label>type_traits</label>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="3">
        <label>src/compile_time_checks/serif/model/description.cpp</label>
        <link refid="description_8cpp"/>
      </node>
      <node id="12">
        <label>src/compile_time_checks/serif/model/execution_validation.cpp</label>
        <link refid="execution__validation_8cpp"/>
      </node>
      <node id="7">
        <label>src/compile_time_checks/serif/model/normalization.cpp</label>
        <link refid="normalization_8cpp"/>
      </node>
      <node id="10">
        <label>src/compile_time_checks/serif/model/validation.cpp</label>
        <link refid="compile__time__checks_2serif_2model_2validation_8cpp"/>
      </node>
      <node id="6">
        <label>src/include/serif/model/backend/mfem/configured_discretization.hpp</label>
        <link refid="configured__discretization_8hpp"/>
        <childnode refid="7" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="8">
        <label>src/include/serif/model/backend/mfem/equilibrium.hpp</label>
        <link refid="equilibrium_8hpp"/>
      </node>
      <node id="2">
        <label>src/include/serif/model/description.hpp</label>
        <link refid="description_8hpp"/>
        <childnode refid="3" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
        <childnode refid="5" relation="include">
        </childnode>
        <childnode refid="9" relation="include">
        </childnode>
      </node>
      <node id="11">
        <label>src/include/serif/model/execution_validation.hpp</label>
        <link refid="execution__validation_8hpp"/>
        <childnode refid="12" relation="include">
        </childnode>
        <childnode refid="8" relation="include">
        </childnode>
      </node>
      <node id="4">
        <label>src/include/serif/model/model.hpp</label>
        <link refid="model_8hpp"/>
      </node>
      <node id="5">
        <label>src/include/serif/model/normalization/reference.hpp</label>
        <link refid="reference_8hpp"/>
        <childnode refid="6" relation="include">
        </childnode>
      </node>
      <node id="1">
        <label>src/include/serif/model/specifications/fixed_central_density.hpp</label>
        <link refid="fixed__central__density_8hpp"/>
        <childnode refid="2" relation="include">
        </childnode>
        <childnode refid="13" relation="include">
        </childnode>
      </node>
      <node id="9">
        <label>src/include/serif/model/validation.hpp</label>
        <link refid="model_2validation_8hpp"/>
        <childnode refid="10" relation="include">
        </childnode>
        <childnode refid="11" relation="include">
        </childnode>
        <childnode refid="4" relation="include">
        </childnode>
      </node>
      <node id="13">
        <label>src/lib/serif/model/specifications.cpp</label>
        <link refid="specifications_8cpp"/>
      </node>
    </invincdepgraph>
    <innerclass refid="classserif_1_1model_1_1_fixed_central_density" prot="public">serif::model::FixedCentralDensity</innerclass>
    <innerclass refid="structserif_1_1model_1_1_fixed_central_density_1_1_parameters" prot="public">serif::model::FixedCentralDensity::Parameters</innerclass>
    <innernamespace refid="namespaceserif">serif</innernamespace>
    <innernamespace refid="namespaceserif_1_1model">serif::model</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="type__alias_8hpp" kindref="compound">serif/dimensions/type_alias.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="specification_8hpp" kindref="compound">serif/model/specification.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="physical__names_8hpp" kindref="compound">serif/model/specifications/physical_names.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><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="8"><highlight class="normal">{</highlight></codeline>
<codeline lineno="10" refid="classserif_1_1model_1_1_fixed_central_density" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1model_1_1_fixed_central_density_1abefc7dee50a35d565f4de7efc69ee9b2" kindref="member">FixedCentralDensity</ref><sp/>final</highlight></codeline>
<codeline lineno="11"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal">:</highlight></codeline>
<codeline lineno="13" refid="structserif_1_1model_1_1_fixed_central_density_1_1_parameters" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1model_1_1_fixed_central_density_1_1_parameters" kindref="compound">Parameters</ref></highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="namespaceserif_1_1dimensions_1af7f8c68a704a7bf475c60dbad5f98d78" kindref="member">dimensions::DensityValue</ref><sp/><ref refid="structserif_1_1model_1_1_fixed_central_density_1_1_parameters_1a4ed07c74a55c885d05cf337163ce3ed8" kindref="member">central_density</ref>;</highlight></codeline>
<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="17"><highlight class="normal"></highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1model_1_1_fixed_central_density_1a95c56db53bd062675a74b93acc558f76" kindref="member">ScalarDescription</ref><sp/>=<sp/><ref refid="structserif_1_1model_1_1_scalar_constraint" kindref="compound">ScalarConstraint</ref>&lt;<ref refid="structserif_1_1dimensions_1_1_mass_density" kindref="compound">dimensions::MassDensity</ref>,<sp/><ref refid="structserif_1_1dimensions_1_1_specific_enthalpy" kindref="compound">dimensions::SpecificEnthalpy</ref>,<sp/><ref refid="structserif_1_1dimensions_1_1_specific_enthalpy" kindref="compound">dimensions::SpecificEnthalpy</ref>,</highlight></codeline>
<codeline lineno="19"><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/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="stringliteral">&quot;fixed_central_density.border&quot;</highlight><highlight class="normal">,<sp/></highlight><highlight class="stringliteral">&quot;lambda_rho_c&quot;</highlight><highlight class="normal">,<sp/></highlight><highlight class="stringliteral">&quot;fixed_central_density.residual&quot;</highlight><highlight class="normal">,<sp/></highlight><highlight class="stringliteral">&quot;R_rho_c&quot;</highlight><highlight class="normal">&gt;;</highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1model_1_1_fixed_central_density_1a8c5bc35588579042a1ea934c975f8a4a" kindref="member">TargetValue</ref><sp/>=<sp/><ref refid="structserif_1_1model_1_1_scalar_constraint_1a66c9c68927064cb28732551ccb788a43" kindref="member">ScalarDescription::TargetValue</ref>;</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="classserif_1_1model_1_1_fixed_central_density_1ad54ea7158054f764a6a68735e5a549c9" kindref="member">ModelDefinition</ref><sp/>=<sp/><ref refid="structserif_1_1model_1_1_specification_definition" kindref="compound">SpecificationDefinition</ref>&lt;<ref refid="classserif_1_1model_1_1_fixed_central_density_1abefc7dee50a35d565f4de7efc69ee9b2" kindref="member">FixedCentralDensity</ref>,<sp/></highlight><highlight class="stringliteral">&quot;FixedCentralDensity&quot;</highlight><highlight class="normal">,<sp/><ref refid="namespaceserif_1_1model_1a80cb843c4b97c06905b775aba9d4b813ab55fad3fe78d06b3d481aef2500c784b" kindref="member">SpecificationRole::phase_condition</ref>,<sp/><ref refid="namespaceserif_1_1model_1a9dbd561b48b9cbb817a4102517d065caa2fadfbbb30ccd79bbdcae01edd52f2b5" kindref="member">GeneratedStateKind::solver_border</ref>,</highlight></codeline>
<codeline lineno="22"><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/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1model_1_1_fixed_central_density_1a95c56db53bd062675a74b93acc558f76" kindref="member">ScalarDescription</ref>,<sp/><ref refid="namespaceserif_1_1model_1a251ff98f4ef742b690180c7cb06292bb" kindref="member">Reads&lt;state::SpecificEnthalpy&gt;</ref>,<sp/><ref refid="namespaceserif_1_1model_1a5cbe5c0513a11299350110cee5d31821" kindref="member">Changes&lt;equation::HydrostaticBalance&gt;</ref>&gt;;</highlight></codeline>
<codeline lineno="23"><highlight class="normal"></highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">explicit</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1model_1_1_fixed_central_density_1abefc7dee50a35d565f4de7efc69ee9b2" kindref="member">FixedCentralDensity</ref>(<ref refid="classserif_1_1model_1_1_fixed_central_density_1a8c5bc35588579042a1ea934c975f8a4a" kindref="member">TargetValue</ref><sp/>density);</highlight></codeline>
<codeline lineno="26"><highlight class="normal"></highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">explicit</highlight><highlight class="normal"><sp/><ref refid="classserif_1_1model_1_1_fixed_central_density_1abefc7dee50a35d565f4de7efc69ee9b2" kindref="member">FixedCentralDensity</ref>(<ref refid="structserif_1_1model_1_1_fixed_central_density_1_1_parameters" kindref="compound">Parameters</ref><sp/>parameters);</highlight></codeline>
<codeline lineno="29"><highlight class="normal"></highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/><ref refid="classserif_1_1model_1_1_fixed_central_density_1a8c5bc35588579042a1ea934c975f8a4a" kindref="member">TargetValue</ref><sp/><ref refid="classserif_1_1model_1_1_fixed_central_density_1a55e75cf3f8620580c4ccf73fa4f77688" kindref="member">target</ref>()<sp/>const<sp/>noexcept</highlight></codeline>
<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="33"><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_1model_1_1_fixed_central_density_1a2e91521fba412f396d36198a0b2f9623" kindref="member">m_target</ref>;</highlight></codeline>
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="35"><highlight class="normal"></highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">private</highlight><highlight class="normal">:</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="classserif_1_1model_1_1_fixed_central_density_1a8c5bc35588579042a1ea934c975f8a4a" kindref="member">TargetValue</ref><sp/><ref refid="classserif_1_1model_1_1_fixed_central_density_1a2e91521fba412f396d36198a0b2f9623" kindref="member">m_target</ref>;</highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="39"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>serif::model</highlight><highlight class="normal"></highlight></codeline>
    </programlisting>
    <location file="src/include/serif/model/specifications/fixed_central_density.hpp"/>
  </compounddef>
</doxygen>