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)
63 lines
3.3 KiB
XML
63 lines
3.3 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_1preconditioning" kind="namespace" language="C++">
|
|
<compoundname>serif::model::preconditioning</compoundname>
|
|
<innerclass refid="structserif_1_1model_1_1preconditioning_1_1_none" prot="public">serif::model::preconditioning::None</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1preconditioning_1_1_prepared_system" prot="public">serif::model::preconditioning::PreparedSystem</innerclass>
|
|
<innernamespace refid="namespaceserif_1_1model_1_1preconditioning_1_1detail">serif::model::preconditioning::detail</innernamespace>
|
|
<sectiondef kind="func">
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1preconditioning_1a36fd24993a4ac4e599ef61b9dfb6d776" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename ResultKey</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Recipe</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Layout</type>
|
|
</param>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Existing</declname>
|
|
<defname>Existing</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>auto</type>
|
|
<definition>auto serif::model::preconditioning::make_computations</definition>
|
|
<argsstring>(const Recipe &recipe, const Layout &layout, const std::tuple< Existing... > &existing)</argsstring>
|
|
<name>make_computations</name>
|
|
<qualifiedname>serif::model::preconditioning::make_computations</qualifiedname>
|
|
<param>
|
|
<type>const Recipe &</type>
|
|
<declname>recipe</declname>
|
|
</param>
|
|
<param>
|
|
<type>const Layout &</type>
|
|
<declname>layout</declname>
|
|
</param>
|
|
<param>
|
|
<type>const std::tuple< Existing... > &</type>
|
|
<declname>existing</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Connect a recipe to the same physical root, layout and reference geometry as model evaluation. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
<para><simplesect kind="note"><para>Merely adding these computations does not prepare an inverse. Only requesting <ref refid="structserif_1_1model_1_1preconditioning_1_1_prepared_system" kindref="compound">PreparedSystem</ref> reaches this branch, so line-search evaluations can reuse the physical graph without inverse setup. </para>
|
|
</simplesect>
|
|
</para>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/model/preconditioning/computations.hpp" line="37" column="11" bodyfile="src/include/serif/backend/mfem/model/preconditioning/computations.hpp" bodystart="37" bodyend="55"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<location file="src/include/serif/backend/mfem/model/preconditioning/computations.hpp" line="15" column="1"/>
|
|
</compounddef>
|
|
</doxygen>
|