Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
261 lines
14 KiB
XML
261 lines
14 KiB
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="namespaceserif_1_1model_1_1normalization" kind="namespace" language="C++">
|
||
<compoundname>serif::model::normalization</compoundname>
|
||
<innerclass refid="structserif_1_1model_1_1normalization_1_1_configuration" prot="public">serif::model::normalization::Configuration</innerclass>
|
||
<innerclass refid="structserif_1_1model_1_1normalization_1_1_infinity_rows" prot="public">serif::model::normalization::InfinityRows</innerclass>
|
||
<innerclass refid="structserif_1_1model_1_1normalization_1_1_prepared_system" prot="public">serif::model::normalization::PreparedSystem</innerclass>
|
||
<innerclass refid="structserif_1_1model_1_1normalization_1_1_surface_rows" prot="public">serif::model::normalization::SurfaceRows</innerclass>
|
||
<innernamespace refid="namespaceserif_1_1model_1_1normalization_1_1detail">serif::model::normalization::detail</innernamespace>
|
||
<sectiondef kind="typedef">
|
||
<memberdef kind="typedef" id="namespaceserif_1_1model_1_1normalization_1a20221d8368d5bf0b36f03e7755fc6d64" prot="public" static="no">
|
||
<templateparamlist>
|
||
<param>
|
||
<type>typename Selection</type>
|
||
</param>
|
||
<param>
|
||
<type>typename Coordinates</type>
|
||
</param>
|
||
<param>
|
||
<type>typename Bound</type>
|
||
</param>
|
||
</templateparamlist>
|
||
<type>typename <ref refid="structserif_1_1model_1_1normalization_1_1detail_1_1_select_plan" kindref="compound">detail::SelectPlan</ref>< Selection, Coordinates, Bound >::Type</type>
|
||
<definition>using serif::model::normalization::PlanFor = typename detail::SelectPlan<Selection, Coordinates, Bound>::Type</definition>
|
||
<argsstring></argsstring>
|
||
<name>PlanFor</name>
|
||
<qualifiedname>serif::model::normalization::PlanFor</qualifiedname>
|
||
<briefdescription>
|
||
<para>Compile automatic physics-aware rules or retain the user's complete explicit plan. </para>
|
||
</briefdescription>
|
||
<detaileddescription>
|
||
</detaileddescription>
|
||
<inbodydescription>
|
||
</inbodydescription>
|
||
<location file="src/include/serif/model/normalization/plan.hpp" line="125" column="5" bodyfile="src/include/serif/model/normalization/plan.hpp" bodystart="125" bodyend="-1"/>
|
||
</memberdef>
|
||
<memberdef kind="typedef" id="namespaceserif_1_1model_1_1normalization_1a9bca7844875f31e08df105bc8da44c69" prot="public" static="no">
|
||
<templateparamlist>
|
||
<param>
|
||
<type>typename Plan</type>
|
||
</param>
|
||
</templateparamlist>
|
||
<type><ref refid="namespaceserif_1_1utils_1_1dependencies_1a4b225a37465f007a877f89860d3627c1" kindref="member">utils::dependencies::CombinedKeyList</ref>< typename <ref refid="structserif_1_1model_1_1normalization_1_1detail_1_1_rule_metrics" kindref="compound">detail::RuleMetrics</ref>< typename Plan::Values >::Type, typename <ref refid="structserif_1_1model_1_1normalization_1_1detail_1_1_rule_metrics" kindref="compound">detail::RuleMetrics</ref>< typename Plan::Residuals >::Type ></type>
|
||
<definition>using serif::model::normalization::MetricsFor = utils::dependencies::CombinedKeyList<typename detail::RuleMetrics<typename Plan::Values>::Type,
|
||
typename detail::RuleMetrics<typename Plan::Residuals>::Type></definition>
|
||
<argsstring></argsstring>
|
||
<name>MetricsFor</name>
|
||
<qualifiedname>serif::model::normalization::MetricsFor</qualifiedname>
|
||
<briefdescription>
|
||
<para>Assemble each metric once even when several state and residual rules share it. </para>
|
||
</briefdescription>
|
||
<detaileddescription>
|
||
</detaileddescription>
|
||
<inbodydescription>
|
||
</inbodydescription>
|
||
<location file="src/include/serif/model/normalization/plan.hpp" line="129" column="5" bodyfile="src/include/serif/model/normalization/plan.hpp" bodystart="129" bodyend="-1"/>
|
||
</memberdef>
|
||
</sectiondef>
|
||
<sectiondef kind="func">
|
||
<memberdef kind="function" id="namespaceserif_1_1model_1_1normalization_1abadff187532235162a96bd1da3f76730" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
||
<templateparamlist>
|
||
<param>
|
||
<type>typename Options</type>
|
||
</param>
|
||
<param>
|
||
<type>typename Discretization</type>
|
||
</param>
|
||
<param>
|
||
<type>typename...</type>
|
||
<declname>Metrics</declname>
|
||
<defname>Metrics</defname>
|
||
</param>
|
||
</templateparamlist>
|
||
<type>auto</type>
|
||
<definition>auto serif::model::normalization::make_inputs</definition>
|
||
<argsstring>(std::shared_ptr< const Options > options, const Discretization &discretization, utils::dependencies::KeyList< Metrics... >)</argsstring>
|
||
<name>make_inputs</name>
|
||
<qualifiedname>serif::model::normalization::make_inputs</qualifiedname>
|
||
<param>
|
||
<type>std::shared_ptr< const Options ></type>
|
||
<declname>options</declname>
|
||
</param>
|
||
<param>
|
||
<type>const Discretization &</type>
|
||
<declname>discretization</declname>
|
||
</param>
|
||
<param>
|
||
<type><ref refid="structserif_1_1utils_1_1dependencies_1_1_key_list" kindref="compound">utils::dependencies::KeyList</ref>< Metrics... ></type>
|
||
</param>
|
||
<briefdescription>
|
||
<para>Keep the immutable configuration alive and reference metrics separate from candidate coefficients. </para>
|
||
</briefdescription>
|
||
<detaileddescription>
|
||
</detaileddescription>
|
||
<inbodydescription>
|
||
</inbodydescription>
|
||
<location file="src/include/serif/backend/mfem/model/normalization/computations.hpp" line="71" column="11" bodyfile="src/include/serif/backend/mfem/model/normalization/computations.hpp" bodystart="71" bodyend="75"/>
|
||
</memberdef>
|
||
<memberdef kind="function" id="namespaceserif_1_1model_1_1normalization_1afa784ae747a3faf8c4b595119d2fb151" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
||
<templateparamlist>
|
||
<param>
|
||
<type>typename NormalizationPlan</type>
|
||
</param>
|
||
<param>
|
||
<type>typename Bound</type>
|
||
</param>
|
||
<param>
|
||
<type>typename Options</type>
|
||
</param>
|
||
<param>
|
||
<type>typename Layout</type>
|
||
</param>
|
||
<param>
|
||
<type>typename...</type>
|
||
<declname>Metrics</declname>
|
||
<defname>Metrics</defname>
|
||
</param>
|
||
</templateparamlist>
|
||
<type>auto</type>
|
||
<definition>auto serif::model::normalization::make_computations</definition>
|
||
<argsstring>(const Bound &bound, const Options &options, const Layout &layout, utils::dependencies::KeyList< Metrics... >)</argsstring>
|
||
<name>make_computations</name>
|
||
<qualifiedname>serif::model::normalization::make_computations</qualifiedname>
|
||
<param>
|
||
<type>const Bound &</type>
|
||
<declname>bound</declname>
|
||
</param>
|
||
<param>
|
||
<type>const Options &</type>
|
||
<declname>options</declname>
|
||
</param>
|
||
<param>
|
||
<type>const Layout &</type>
|
||
<declname>layout</declname>
|
||
</param>
|
||
<param>
|
||
<type><ref refid="structserif_1_1utils_1_1dependencies_1_1_key_list" kindref="compound">utils::dependencies::KeyList</ref>< Metrics... ></type>
|
||
</param>
|
||
<briefdescription>
|
||
<para>Compose normalization into the physical graph, including the selected surface row replacement. </para>
|
||
</briefdescription>
|
||
<detaileddescription>
|
||
</detaileddescription>
|
||
<inbodydescription>
|
||
</inbodydescription>
|
||
<location file="src/include/serif/backend/mfem/model/normalization/computations.hpp" line="79" column="11" bodyfile="src/include/serif/backend/mfem/model/normalization/computations.hpp" bodystart="79" bodyend="116"/>
|
||
</memberdef>
|
||
<memberdef kind="function" id="namespaceserif_1_1model_1_1normalization_1aad8500244bb5debae8de93881311505c" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
||
<templateparamlist>
|
||
<param>
|
||
<type>typename Mass</type>
|
||
</param>
|
||
<param>
|
||
<type>typename Density</type>
|
||
</param>
|
||
<param>
|
||
<type>StellarModelType</type>
|
||
<declname>Model</declname>
|
||
<defname>Model</defname>
|
||
</param>
|
||
</templateparamlist>
|
||
<type>auto</type>
|
||
<definition>auto serif::model::normalization::resolve_reference</definition>
|
||
<argsstring>(const solver::normalization::LaneEmdenApproximation< Mass, Density > &scheme, const Model &model)</argsstring>
|
||
<name>resolve_reference</name>
|
||
<qualifiedname>serif::model::normalization::resolve_reference</qualifiedname>
|
||
<param>
|
||
<type>const <ref refid="structserif_1_1solver_1_1normalization_1_1_lane_emden_approximation" kindref="compound">solver::normalization::LaneEmdenApproximation</ref>< Mass, Density > &</type>
|
||
<declname>scheme</declname>
|
||
</param>
|
||
<param>
|
||
<type>const Model &</type>
|
||
<declname>model</declname>
|
||
</param>
|
||
<requiresclause>detail::ReferenceAvailable<Mass, Model, FixedTotalMass> && std::same_as<Density, dimensions::DensityValue> </requiresclause>
|
||
<briefdescription>
|
||
<para>Resolve the Lane–Emden reference from explicit inputs or the model's mass target; no model prescribes central density. </para>
|
||
</briefdescription>
|
||
<detaileddescription>
|
||
</detaileddescription>
|
||
<inbodydescription>
|
||
</inbodydescription>
|
||
<location file="src/include/serif/model/normalization/reference.hpp" line="29" column="11" bodyfile="src/include/serif/model/normalization/reference.hpp" bodystart="29" bodyend="36"/>
|
||
</memberdef>
|
||
<memberdef kind="function" id="namespaceserif_1_1model_1_1normalization_1af1f75aeb12a566859ea4dbd2ed52cdc4" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
||
<templateparamlist>
|
||
<param>
|
||
<type>solver::normalization::ReferenceScheme</type>
|
||
<declname>Scheme</declname>
|
||
<defname>Scheme</defname>
|
||
</param>
|
||
<param>
|
||
<type>StellarModelType</type>
|
||
<declname>Model</declname>
|
||
<defname>Model</defname>
|
||
</param>
|
||
</templateparamlist>
|
||
<type>Scheme</type>
|
||
<definition>Scheme serif::model::normalization::resolve_reference</definition>
|
||
<argsstring>(const Scheme &scheme, const Model &)</argsstring>
|
||
<name>resolve_reference</name>
|
||
<qualifiedname>serif::model::normalization::resolve_reference</qualifiedname>
|
||
<param>
|
||
<type>const Scheme &</type>
|
||
<declname>scheme</declname>
|
||
</param>
|
||
<param>
|
||
<type>const Model &</type>
|
||
</param>
|
||
<briefdescription>
|
||
<para>Explicit or custom reference schemes need no model-specific defaults. </para>
|
||
</briefdescription>
|
||
<detaileddescription>
|
||
</detaileddescription>
|
||
<inbodydescription>
|
||
</inbodydescription>
|
||
<location file="src/include/serif/model/normalization/reference.hpp" line="40" column="13" bodyfile="src/include/serif/model/normalization/reference.hpp" bodystart="40" bodyend="42"/>
|
||
</memberdef>
|
||
<memberdef kind="function" id="namespaceserif_1_1model_1_1normalization_1a1ed5daad7a452214875d436c7ae8f289" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
||
<templateparamlist>
|
||
<param>
|
||
<type>typename Options</type>
|
||
</param>
|
||
<param>
|
||
<type>StellarModelType</type>
|
||
<declname>Model</declname>
|
||
<defname>Model</defname>
|
||
</param>
|
||
</templateparamlist>
|
||
<type>auto</type>
|
||
<definition>auto serif::model::normalization::resolve_configuration</definition>
|
||
<argsstring>(Options options, const Model &model)</argsstring>
|
||
<name>resolve_configuration</name>
|
||
<qualifiedname>serif::model::normalization::resolve_configuration</qualifiedname>
|
||
<param>
|
||
<type>Options</type>
|
||
<declname>options</declname>
|
||
</param>
|
||
<param>
|
||
<type>const Model &</type>
|
||
<declname>model</declname>
|
||
</param>
|
||
<requiresclause>ReferenceResolvable<Options, Model> </requiresclause>
|
||
<briefdescription>
|
||
<para>Freeze resolved reference choices while retaining the deduced coordinate and plan types. </para>
|
||
</briefdescription>
|
||
<detaileddescription>
|
||
</detaileddescription>
|
||
<inbodydescription>
|
||
</inbodydescription>
|
||
<location file="src/include/serif/model/normalization/reference.hpp" line="53" column="11" bodyfile="src/include/serif/model/normalization/reference.hpp" bodystart="53" bodyend="62"/>
|
||
</memberdef>
|
||
</sectiondef>
|
||
<briefdescription>
|
||
</briefdescription>
|
||
<detaileddescription>
|
||
</detaileddescription>
|
||
<location file="src/include/serif/backend/mfem/model/normalization/computations.hpp" line="18" column="1"/>
|
||
</compounddef>
|
||
</doxygen>
|