Files
MeanField_SERiF/docs/xml/namespaceserif_1_1eos_1_1relations.xml

301 lines
20 KiB
XML
Raw Normal View History

<?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="namespaceserif_1_1eos_1_1relations" kind="namespace" language="C++">
<compoundname>serif::eos::relations</compoundname>
<innerclass refid="structserif_1_1eos_1_1relations_1_1_catalog_contains_relation" prot="public">serif::eos::relations::CatalogContainsRelation</innerclass>
<innerclass refid="structserif_1_1eos_1_1relations_1_1_catalog_contains_relation_3_01_relation_catalog_3_01_relatiof166251502ef7194950babe717df3f53" prot="public">serif::eos::relations::CatalogContainsRelation&lt; RelationCatalog&lt; Relations... &gt;, RelationT &gt;</innerclass>
<innerclass refid="structserif_1_1eos_1_1relations_1_1_is_thermodynamic_relation" prot="public">serif::eos::relations::IsThermodynamicRelation</innerclass>
<innerclass refid="structserif_1_1eos_1_1relations_1_1_is_thermodynamic_relation_3_01_relation_3_01_output_00_01_inputs_8_8_8_01_4_01_4" prot="public">serif::eos::relations::IsThermodynamicRelation&lt; Relation&lt; Output, Inputs... &gt; &gt;</innerclass>
<innerclass refid="structserif_1_1eos_1_1relations_1_1_is_valid_relation_catalog" prot="public">serif::eos::relations::IsValidRelationCatalog</innerclass>
<innerclass refid="structserif_1_1eos_1_1relations_1_1_is_valid_relation_catalog_3_01_relation_catalog_3_01_relations_8_8_8_01_4_01_4" prot="public">serif::eos::relations::IsValidRelationCatalog&lt; RelationCatalog&lt; Relations... &gt; &gt;</innerclass>
<innerclass refid="structserif_1_1eos_1_1relations_1_1_relation" prot="public">serif::eos::relations::Relation</innerclass>
<innerclass refid="structserif_1_1eos_1_1relations_1_1_relation_catalog" prot="public">serif::eos::relations::RelationCatalog</innerclass>
<innerclass refid="structserif_1_1eos_1_1relations_1_1_relation_contains_input" prot="public">serif::eos::relations::RelationContainsInput</innerclass>
<innerclass refid="structserif_1_1eos_1_1relations_1_1_relation_contains_input_3_01_relation_3_01_output_00_01_inpu428eb9fbaac87b867ddc49c3b87f5f48" prot="public">serif::eos::relations::RelationContainsInput&lt; Relation&lt; Output, Inputs... &gt;, Quantity &gt;</innerclass>
<sectiondef kind="typedef">
<memberdef kind="typedef" id="namespaceserif_1_1eos_1_1relations_1ac555319520c74d14fb945024aefe4dfd" prot="public" static="no">
<type><ref refid="structserif_1_1eos_1_1relations_1_1_relation" kindref="compound">Relation</ref>&lt; <ref refid="structserif_1_1dimensions_1_1_pressure" kindref="compound">dimensions::Pressure</ref>, <ref refid="structserif_1_1dimensions_1_1_mass_density" kindref="compound">dimensions::MassDensity</ref> &gt;</type>
<definition>using serif::eos::relations::PressureFromDensity = Relation&lt;dimensions::Pressure, dimensions::MassDensity&gt;</definition>
<argsstring></argsstring>
<name>PressureFromDensity</name>
<qualifiedname>serif::eos::relations::PressureFromDensity</qualifiedname>
<briefdescription>
<para>A relation to compute pressure from density. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/eos/relations/relations.hpp" line="14" column="5" bodyfile="src/include/serif/eos/relations/relations.hpp" bodystart="14" bodyend="-1"/>
</memberdef>
<memberdef kind="typedef" id="namespaceserif_1_1eos_1_1relations_1a8b0ab5938c9b254628f6acb2c84389f5" prot="public" static="no">
<type><ref refid="structserif_1_1eos_1_1relations_1_1_relation" kindref="compound">Relation</ref>&lt; <ref refid="structserif_1_1dimensions_1_1_mass_density" kindref="compound">dimensions::MassDensity</ref>, <ref refid="structserif_1_1dimensions_1_1_pressure" kindref="compound">dimensions::Pressure</ref> &gt;</type>
<definition>using serif::eos::relations::DensityFromPressure = Relation&lt;dimensions::MassDensity, dimensions::Pressure&gt;</definition>
<argsstring></argsstring>
<name>DensityFromPressure</name>
<qualifiedname>serif::eos::relations::DensityFromPressure</qualifiedname>
<briefdescription>
<para>A relation to compute density at a prescribed pressure. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/eos/relations/relations.hpp" line="15" column="5" bodyfile="src/include/serif/eos/relations/relations.hpp" bodystart="15" bodyend="-1"/>
</memberdef>
<memberdef kind="typedef" id="namespaceserif_1_1eos_1_1relations_1a43e126ea01a149f642ba5e3c6aebf4f3" prot="public" static="no">
<type><ref refid="structserif_1_1eos_1_1relations_1_1_relation" kindref="compound">Relation</ref>&lt; <ref refid="structserif_1_1dimensions_1_1_barotropic_pressure_potential" kindref="compound">dimensions::BarotropicPressurePotential</ref>, <ref refid="structserif_1_1dimensions_1_1_mass_density" kindref="compound">dimensions::MassDensity</ref> &gt;</type>
<definition>using serif::eos::relations::PressurePotentialFromDensity = Relation&lt;dimensions::BarotropicPressurePotential, dimensions::MassDensity&gt;</definition>
<argsstring></argsstring>
<name>PressurePotentialFromDensity</name>
<qualifiedname>serif::eos::relations::PressurePotentialFromDensity</qualifiedname>
<briefdescription>
<para>Evaluate A(density), whose derivative on the positive barotropic branch is (dP/density)/density. </para>
</briefdescription>
<detaileddescription>
<para>An additive constant is arbitrary. A finite surface value is required when a consumer subtracts A at a prescribed pressure. This mechanical primitive need not be thermodynamic enthalpy. </para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/eos/relations/relations.hpp" line="22" column="5" bodyfile="src/include/serif/eos/relations/relations.hpp" bodystart="22" bodyend="-1"/>
</memberdef>
<memberdef kind="typedef" id="namespaceserif_1_1eos_1_1relations_1ae7cf9462c33962f4ade777ea5a560670" prot="public" static="no">
<type><ref refid="structserif_1_1eos_1_1relations_1_1_relation" kindref="compound">Relation</ref>&lt; <ref refid="structserif_1_1dimensions_1_1_pressure" kindref="compound">dimensions::Pressure</ref>, <ref refid="structserif_1_1dimensions_1_1_specific_enthalpy" kindref="compound">dimensions::SpecificEnthalpy</ref> &gt;</type>
<definition>using serif::eos::relations::PressureFromSpecificEnthalpy = Relation&lt;dimensions::Pressure, dimensions::SpecificEnthalpy&gt;</definition>
<argsstring></argsstring>
<name>PressureFromSpecificEnthalpy</name>
<qualifiedname>serif::eos::relations::PressureFromSpecificEnthalpy</qualifiedname>
<briefdescription>
<para>A relation to compute pressure from specific enthalpy. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/eos/relations/relations.hpp" line="23" column="5" bodyfile="src/include/serif/eos/relations/relations.hpp" bodystart="23" bodyend="-1"/>
</memberdef>
<memberdef kind="typedef" id="namespaceserif_1_1eos_1_1relations_1ad3bc12d4673999d6b90a6c3d9838ae52" prot="public" static="no">
<type><ref refid="structserif_1_1eos_1_1relations_1_1_relation" kindref="compound">Relation</ref>&lt; <ref refid="structserif_1_1dimensions_1_1_specific_enthalpy" kindref="compound">dimensions::SpecificEnthalpy</ref>, <ref refid="structserif_1_1dimensions_1_1_mass_density" kindref="compound">dimensions::MassDensity</ref> &gt;</type>
<definition>using serif::eos::relations::SpecificEnthalpyFromDensity = Relation&lt;dimensions::SpecificEnthalpy, dimensions::MassDensity&gt;</definition>
<argsstring></argsstring>
<name>SpecificEnthalpyFromDensity</name>
<qualifiedname>serif::eos::relations::SpecificEnthalpyFromDensity</qualifiedname>
<briefdescription>
<para>A relation to compute specific enthalpy from density. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/eos/relations/relations.hpp" line="24" column="5" bodyfile="src/include/serif/eos/relations/relations.hpp" bodystart="24" bodyend="-1"/>
</memberdef>
<memberdef kind="typedef" id="namespaceserif_1_1eos_1_1relations_1aaf50999b585768be908f8da3e50fcea9" prot="public" static="no">
<type><ref refid="structserif_1_1eos_1_1relations_1_1_relation" kindref="compound">Relation</ref>&lt; <ref refid="structserif_1_1dimensions_1_1_specific_enthalpy" kindref="compound">dimensions::SpecificEnthalpy</ref>, <ref refid="structserif_1_1dimensions_1_1_pressure" kindref="compound">dimensions::Pressure</ref> &gt;</type>
<definition>using serif::eos::relations::SpecificEnthalpyFromPressure = Relation&lt;dimensions::SpecificEnthalpy, dimensions::Pressure&gt;</definition>
<argsstring></argsstring>
<name>SpecificEnthalpyFromPressure</name>
<qualifiedname>serif::eos::relations::SpecificEnthalpyFromPressure</qualifiedname>
<briefdescription>
<para>A relation to compute specific enthalpy from pressure. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/eos/relations/relations.hpp" line="25" column="5" bodyfile="src/include/serif/eos/relations/relations.hpp" bodystart="25" bodyend="-1"/>
</memberdef>
<memberdef kind="typedef" id="namespaceserif_1_1eos_1_1relations_1a537de2b3f7c974159bc5639b831117c4" prot="public" static="no">
<type><ref refid="structserif_1_1eos_1_1relations_1_1_relation" kindref="compound">Relation</ref>&lt; <ref refid="structserif_1_1dimensions_1_1_mass_density" kindref="compound">dimensions::MassDensity</ref>, <ref refid="structserif_1_1dimensions_1_1_specific_enthalpy" kindref="compound">dimensions::SpecificEnthalpy</ref> &gt;</type>
<definition>using serif::eos::relations::DensityFromSpecificEnthalpy = Relation&lt;dimensions::MassDensity, dimensions::SpecificEnthalpy&gt;</definition>
<argsstring></argsstring>
<name>DensityFromSpecificEnthalpy</name>
<qualifiedname>serif::eos::relations::DensityFromSpecificEnthalpy</qualifiedname>
<briefdescription>
<para>A relation to compute density from specific enthalpy. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/eos/relations/relations.hpp" line="26" column="5" bodyfile="src/include/serif/eos/relations/relations.hpp" bodystart="26" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="var">
<memberdef kind="variable" id="namespaceserif_1_1eos_1_1relations_1ad1657a018022b22d497bc6d9f7870fe3" prot="public" static="no" constexpr="yes" mutable="no">
<templateparamlist>
<param>
<type>typename Catalog</type>
</param>
<param>
<type>typename RelationT</type>
</param>
</templateparamlist>
<type>bool</type>
<definition>bool serif::eos::relations::relation_catalog_contains_relation_v</definition>
<argsstring></argsstring>
<name>relation_catalog_contains_relation_v</name>
<qualifiedname>serif::eos::relations::relation_catalog_contains_relation_v</qualifiedname>
<initializer>= <ref refid="structserif_1_1eos_1_1relations_1_1_catalog_contains_relation" kindref="compound">CatalogContainsRelation</ref>&lt;std::remove_cv_t&lt;Catalog&gt;, std::remove_cv_t&lt;RelationT&gt;&gt;::value</initializer>
<briefdescription>
<para>A trait to determine if a catalog contains a given relation. This is a helper variable template that simplifies the usage of the <ref refid="structserif_1_1eos_1_1relations_1_1_catalog_contains_relation" kindref="compound">CatalogContainsRelation</ref> trait. </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="templateparam"><parameteritem>
<parameternamelist>
<parametername>Catalog</parametername>
</parameternamelist>
<parameterdescription>
<para>The catalog type to check. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>RelationT</parametername>
</parameternamelist>
<parameterdescription>
<para>The relation type to check for. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/eos/relations/traits.hpp" line="96" column="27" bodyfile="src/include/serif/eos/relations/traits.hpp" bodystart="96" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="namespaceserif_1_1eos_1_1relations_1a9d99a6a6d3edf16e9a3d33f6b6c5a88e" prot="public" static="no" constexpr="yes" mutable="no">
<templateparamlist>
<param>
<type>typename RelationT</type>
</param>
<param>
<type>typename Quantity</type>
</param>
</templateparamlist>
<type>bool</type>
<definition>bool serif::eos::relations::relation_contains_input_v</definition>
<argsstring></argsstring>
<name>relation_contains_input_v</name>
<qualifiedname>serif::eos::relations::relation_contains_input_v</qualifiedname>
<initializer>= <ref refid="structserif_1_1eos_1_1relations_1_1_relation_contains_input" kindref="compound">RelationContainsInput</ref>&lt;std::remove_cv_t&lt;RelationT&gt;, std::remove_cv_t&lt;Quantity&gt;&gt;::value</initializer>
<briefdescription>
<para>A trait to determine if a relation contains a given input quantity. This is a helper variable template that simplifies the usage of the <ref refid="structserif_1_1eos_1_1relations_1_1_relation_contains_input" kindref="compound">RelationContainsInput</ref> trait. </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="templateparam"><parameteritem>
<parameternamelist>
<parametername>RelationT</parametername>
</parameternamelist>
<parameterdescription>
<para>The relation type to check. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>Quantity</parametername>
</parameternamelist>
<parameterdescription>
<para>The quantity type to check for. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/eos/relations/traits.hpp" line="104" column="27" bodyfile="src/include/serif/eos/relations/traits.hpp" bodystart="104" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="namespaceserif_1_1eos_1_1relations_1a3371acb573f6f7cbd3183f83e4e01267" prot="public" static="no" constexpr="yes" mutable="no">
<templateparamlist>
<param>
<type>typename RelationCandidate</type>
</param>
</templateparamlist>
<type>bool</type>
<definition>bool serif::eos::relations::is_thermodynamic_relation_v</definition>
<argsstring></argsstring>
<name>is_thermodynamic_relation_v</name>
<qualifiedname>serif::eos::relations::is_thermodynamic_relation_v</qualifiedname>
<initializer>= <ref refid="structserif_1_1eos_1_1relations_1_1_is_thermodynamic_relation" kindref="compound">IsThermodynamicRelation</ref>&lt;RelationCandidate&gt;::value</initializer>
<briefdescription>
<para>A trait to determine if a relation is a valid thermodynamic relation. This is a helper variable template that simplifies the usage of the <ref refid="structserif_1_1eos_1_1relations_1_1_is_thermodynamic_relation" kindref="compound">IsThermodynamicRelation</ref> trait. </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="templateparam"><parameteritem>
<parameternamelist>
<parametername>RelationCandidate</parametername>
</parameternamelist>
<parameterdescription>
<para>The relation type to check. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/eos/relations/traits.hpp" line="111" column="20" bodyfile="src/include/serif/eos/relations/traits.hpp" bodystart="111" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="namespaceserif_1_1eos_1_1relations_1adf6db0c674d98babbb9ea510c92a7eef" prot="public" static="no" constexpr="yes" mutable="no">
<templateparamlist>
<param>
<type>typename CatalogCandidate</type>
</param>
</templateparamlist>
<type>bool</type>
<definition>bool serif::eos::relations::is_valid_relation_catalog_v</definition>
<argsstring></argsstring>
<name>is_valid_relation_catalog_v</name>
<qualifiedname>serif::eos::relations::is_valid_relation_catalog_v</qualifiedname>
<initializer>= <ref refid="structserif_1_1eos_1_1relations_1_1_is_valid_relation_catalog" kindref="compound">IsValidRelationCatalog</ref>&lt;CatalogCandidate&gt;::value</initializer>
<briefdescription>
<para>A trait to determine if a catalog is a valid relation catalog. This is a helper variable template that simplifies the usage of the <ref refid="structserif_1_1eos_1_1relations_1_1_is_valid_relation_catalog" kindref="compound">IsValidRelationCatalog</ref> trait. </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="templateparam"><parameteritem>
<parameternamelist>
<parametername>CatalogCandidate</parametername>
</parameternamelist>
<parameterdescription>
<para>The catalog type to check. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/eos/relations/traits.hpp" line="118" column="20" bodyfile="src/include/serif/eos/relations/traits.hpp" bodystart="118" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="func">
<memberdef kind="function" id="namespaceserif_1_1eos_1_1relations_1a1b57d195e9d643b262222f5d50ed1dd0" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" noexcept="yes" virt="non-virtual">
<templateparamlist>
<param>
<type>typename...</type>
<declname>Ts</declname>
<defname>Ts</defname>
</param>
</templateparamlist>
<type>std::size_t</type>
<definition>std::size_t serif::utils::misc::std_helper::CountVariadicArguments</definition>
<argsstring>() noexcept</argsstring>
<name>CountVariadicArguments</name>
<qualifiedname>serif::eos::relations::CountVariadicArguments</qualifiedname>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/eos/relations/catalog.hpp" line="15" column="5" bodyfile="src/include/serif/utils/misc/std_helper/variadic_cleaning.hpp" bodystart="6" bodyend="8"/>
</memberdef>
</sectiondef>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<location file="src/include/serif/eos/relations/catalog.hpp" line="14" column="1"/>
</compounddef>
</doxygen>