Files
MeanField_SERiF/docs/xml/namespaceserif_1_1equations.xml

128 lines
8.8 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_1equations" kind="namespace" language="C++">
<compoundname>serif::equations</compoundname>
<innerclass refid="classserif_1_1equations_1_1_angular_momentum_constraint" prot="public">serif::equations::AngularMomentumConstraint</innerclass>
<innerclass refid="classserif_1_1equations_1_1_barotropic_density_balance" prot="public">serif::equations::BarotropicDensityBalance</innerclass>
<innerclass refid="classserif_1_1equations_1_1_barycenter_constraint" prot="public">serif::equations::BarycenterConstraint</innerclass>
<innerclass refid="structserif_1_1equations_1_1_contribution" prot="public">serif::equations::Contribution</innerclass>
<innerclass refid="structserif_1_1equations_1_1_contributions" prot="public">serif::equations::Contributions</innerclass>
<innerclass refid="structserif_1_1equations_1_1_contributions_3_01_t_00_01std_1_1void__t_3_01decltype_07std_1_1decl671b42e5568b3715d07217eb0f34ce32" prot="public">serif::equations::Contributions&lt; T, std::void_t&lt; decltype(std::declval&lt; const T &amp; &gt;().contributions())&gt; &gt;</innerclass>
<innerclass refid="structserif_1_1equations_1_1_contribution_support" prot="public">serif::equations::ContributionSupport</innerclass>
<innerclass refid="structserif_1_1equations_1_1_contribution_support_3_01_t_00_01std_1_1void__t_3_01typename_01_t_1_1_support_01_4_01_4" prot="public">serif::equations::ContributionSupport&lt; T, std::void_t&lt; typename T::Support &gt; &gt;</innerclass>
<innerclass refid="structserif_1_1equations_1_1_contribution_tuple" prot="public">serif::equations::ContributionTuple</innerclass>
<innerclass refid="structserif_1_1equations_1_1_contribution_tuple_3_01std_1_1tuple_3_01_ts_8_8_8_01_4_00_01std_1_1e282a2c4b2ce56d3b5a3d2dda19385da" prot="public">serif::equations::ContributionTuple&lt; std::tuple&lt; Ts... &gt;, std::void_t&lt; decltype(std::tuple_cat(std::declval&lt; typename Contributions&lt; std::remove_cvref_t&lt; Ts &gt; &gt;::type &gt;()...))&gt; &gt;</innerclass>
<innerclass refid="structserif_1_1equations_1_1_equation_point" prot="public">serif::equations::EquationPoint</innerclass>
<innerclass refid="classserif_1_1equations_1_1_equation_registry" prot="public">serif::equations::EquationRegistry</innerclass>
<innerclass refid="classserif_1_1equations_1_1_mass_normalization" prot="public">serif::equations::MassNormalization</innerclass>
<innerclass refid="structserif_1_1equations_1_1_operand_values" prot="public">serif::equations::OperandValues</innerclass>
<innerclass refid="structserif_1_1equations_1_1_operand_values_3_01utils_1_1types_1_1_type_list_3_01_operands_8_8_8_01_4_00_01_output_t_01_4" prot="public">serif::equations::OperandValues&lt; utils::types::TypeList&lt; Operands... &gt;, OutputT &gt;</innerclass>
<innerclass refid="structserif_1_1equations_1_1_point_linearization" prot="public">serif::equations::PointLinearization</innerclass>
<innerclass refid="classserif_1_1equations_1_1_point_mass_companion" prot="public">serif::equations::PointMassCompanion</innerclass>
<innerclass refid="classserif_1_1equations_1_1_primal_poisson_balance" prot="public">serif::equations::PrimalPoissonBalance</innerclass>
<innerclass refid="classserif_1_1equations_1_1_rigid_rotation" prot="public">serif::equations::RigidRotation</innerclass>
<innerclass refid="classserif_1_1equations_1_1_surface_potential_balance" prot="public">serif::equations::SurfacePotentialBalance</innerclass>
<innerclass refid="structserif_1_1equations_1_1_test_operand_traits" prot="public">serif::equations::TestOperandTraits</innerclass>
<innerclass refid="structserif_1_1equations_1_1_test_operand_traits_3_01_t_00_01std_1_1void__t_3_01typename_01_t_1_1_test_operand_01_4_01_4" prot="public">serif::equations::TestOperandTraits&lt; T, std::void_t&lt; typename T::TestOperand &gt; &gt;</innerclass>
<innerclass refid="structserif_1_1equations_1_1_valid_contributions" prot="public">serif::equations::ValidContributions</innerclass>
<innerclass refid="structserif_1_1equations_1_1_valid_contributions_3_01_row_t_00_01std_1_1tuple_3_01_c_8_8_8_01_4_01_4" prot="public">serif::equations::ValidContributions&lt; RowT, std::tuple&lt; C... &gt; &gt;</innerclass>
<sectiondef kind="typedef">
<memberdef kind="typedef" id="namespaceserif_1_1equations_1ab3b0f61ca51136b0ddf4d868ebdfd8df" prot="public" static="no">
<templateparamlist>
<param>
<type>typename T</type>
</param>
</templateparamlist>
<type><ref refid="structserif_1_1equations_1_1_test_operand_traits" kindref="compound">TestOperandTraits</ref>&lt; T &gt;::type</type>
<definition>using serif::equations::TestOperandOf = TestOperandTraits&lt;T&gt;::type</definition>
<argsstring></argsstring>
<name>TestOperandOf</name>
<qualifiedname>serif::equations::TestOperandOf</qualifiedname>
<briefdescription>
<para>Helper alias to extract the test operand type from a contribution or equation. </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="templateparam"><parameteritem>
<parameternamelist>
<parametername>T</parametername>
</parameternamelist>
<parameterdescription>
<para>The type to extract the test operand from </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/equations/contributions.hpp" line="99" column="5" bodyfile="src/include/serif/equations/contributions.hpp" bodystart="99" bodyend="-1"/>
</memberdef>
<memberdef kind="typedef" id="namespaceserif_1_1equations_1a7e2dbba73c1ee1b682885f1c178eb9f6" prot="public" static="no">
<templateparamlist>
<param>
<type>typename T</type>
</param>
</templateparamlist>
<type><ref refid="structserif_1_1equations_1_1_contribution_support" kindref="compound">ContributionSupport</ref>&lt; T &gt;::type</type>
<definition>using serif::equations::SupportOf = ContributionSupport&lt;T&gt;::type</definition>
<argsstring></argsstring>
<name>SupportOf</name>
<qualifiedname>serif::equations::SupportOf</qualifiedname>
<briefdescription>
<para>Helper alias to extract the support type for a given contribution. </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="templateparam"><parameteritem>
<parameternamelist>
<parametername>T</parametername>
</parameternamelist>
<parameterdescription>
<para>The type to extract the support type from </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/equations/contributions.hpp" line="126" column="5" bodyfile="src/include/serif/equations/contributions.hpp" bodystart="126" bodyend="-1"/>
</memberdef>
<memberdef kind="typedef" id="namespaceserif_1_1equations_1a3d8c1500d535f29fe360f0ab31ac55e3" prot="public" static="no">
<templateparamlist>
<param>
<type>typename T</type>
</param>
</templateparamlist>
<type><ref refid="structserif_1_1equations_1_1_contributions" kindref="compound">Contributions</ref>&lt; std::remove_cvref_t&lt; T &gt; &gt;::type</type>
<definition>using serif::equations::ContributionsOf = Contributions&lt;std::remove_cvref_t&lt;T&gt;&gt;::type</definition>
<argsstring></argsstring>
<name>ContributionsOf</name>
<qualifiedname>serif::equations::ContributionsOf</qualifiedname>
<briefdescription>
<para>Helper alias to extract the contributions (<ref refid="structserif_1_1equations_1_1_test_operand_traits" kindref="compound">type</ref>) of some type T. </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="templateparam"><parameteritem>
<parameternamelist>
<parametername>T</parametername>
</parameternamelist>
<parameterdescription>
<para>The type to extract the contributions from </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/equations/contributions.hpp" line="183" column="5" bodyfile="src/include/serif/equations/contributions.hpp" bodystart="183" bodyend="-1"/>
</memberdef>
</sectiondef>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<location file="src/include/serif/equations/angular_momentum.hpp" line="32" column="1"/>
</compounddef>
</doxygen>