tboudreaux/MeanField_SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): built docs

Browse Source 
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)
This commit is contained in:
Emily Boudreaux
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

147
docs/xml/structserif_1_1solver_1_1_backtracking.xml Normal file
View File

@@ -0,0 +1,147 @@
<?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="structserif_1_1solver_1_1_backtracking" kind="struct" language="C++" prot="public">
<compoundname>serif::solver::Backtracking</compoundname>
<includes local="no">options.hpp</includes>
<sectiondef kind="public-attrib">
<memberdef kind="variable" id="structserif_1_1solver_1_1_backtracking_1aebcf24ae783fc9ff3ad60d99a2ec6c66" prot="public" static="no" mutable="no">
<type>double</type>
<definition>double serif::solver::Backtracking::initial_step</definition>
<argsstring></argsstring>
<name>initial_step</name>
<qualifiedname>serif::solver::Backtracking::initial_step</qualifiedname>
<initializer>{1.0}</initializer>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/solver/nonlinear/options.hpp" line="29" column="16" bodyfile="src/include/serif/solver/nonlinear/options.hpp" bodystart="29" bodyend="29"/>
</memberdef>
<memberdef kind="variable" id="structserif_1_1solver_1_1_backtracking_1a7911ba8308c60432c6de212dfd695e8f" prot="public" static="no" mutable="no">
<type>double</type>
<definition>double serif::solver::Backtracking::contraction</definition>
<argsstring></argsstring>
<name>contraction</name>
<qualifiedname>serif::solver::Backtracking::contraction</qualifiedname>
<initializer>{0.5}</initializer>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/solver/nonlinear/options.hpp" line="30" column="16" bodyfile="src/include/serif/solver/nonlinear/options.hpp" bodystart="30" bodyend="30"/>
</memberdef>
<memberdef kind="variable" id="structserif_1_1solver_1_1_backtracking_1a367c1a51e0b8d12774708d13c9094a8a" prot="public" static="no" mutable="no">
<type>double</type>
<definition>double serif::solver::Backtracking::fraction_to_boundary</definition>
<argsstring></argsstring>
<name>fraction_to_boundary</name>
<qualifiedname>serif::solver::Backtracking::fraction_to_boundary</qualifiedname>
<initializer>{0.9}</initializer>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/solver/nonlinear/options.hpp" line="31" column="16" bodyfile="src/include/serif/solver/nonlinear/options.hpp" bodystart="31" bodyend="31"/>
</memberdef>
<memberdef kind="variable" id="structserif_1_1solver_1_1_backtracking_1abf45ecd4ec4a59442d45bca50a8d10ef" prot="public" static="no" mutable="no">
<type>double</type>
<definition>double serif::solver::Backtracking::sufficient_decrease</definition>
<argsstring></argsstring>
<name>sufficient_decrease</name>
<qualifiedname>serif::solver::Backtracking::sufficient_decrease</qualifiedname>
<initializer>{1.0e-4}</initializer>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/solver/nonlinear/options.hpp" line="32" column="16" bodyfile="src/include/serif/solver/nonlinear/options.hpp" bodystart="32" bodyend="32"/>
</memberdef>
<memberdef kind="variable" id="structserif_1_1solver_1_1_backtracking_1a53406b3dd0cdd6e269f8e7269ec02d03" prot="public" static="no" mutable="no">
<type>double</type>
<definition>double serif::solver::Backtracking::minimum_step</definition>
<argsstring></argsstring>
<name>minimum_step</name>
<qualifiedname>serif::solver::Backtracking::minimum_step</qualifiedname>
<initializer>{1.0e-8}</initializer>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/solver/nonlinear/options.hpp" line="33" column="16" bodyfile="src/include/serif/solver/nonlinear/options.hpp" bodystart="33" bodyend="33"/>
</memberdef>
<memberdef kind="variable" id="structserif_1_1solver_1_1_backtracking_1aeaad4d74cf2435b028349a8fee1d2710" prot="public" static="no" mutable="no">
<type>int</type>
<definition>int serif::solver::Backtracking::maximum_trials</definition>
<argsstring></argsstring>
<name>maximum_trials</name>
<qualifiedname>serif::solver::Backtracking::maximum_trials</qualifiedname>
<initializer>{20}</initializer>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/solver/nonlinear/options.hpp" line="34" column="13" bodyfile="src/include/serif/solver/nonlinear/options.hpp" bodystart="34" bodyend="34"/>
</memberdef>
<memberdef kind="variable" id="structserif_1_1solver_1_1_backtracking_1aa74244d42ad42a75376e4d647c983d93" prot="public" static="no" mutable="no">
<type>bool</type>
<definition>bool serif::solver::Backtracking::geometry_preflight</definition>
<argsstring></argsstring>
<name>geometry_preflight</name>
<qualifiedname>serif::solver::Backtracking::geometry_preflight</qualifiedname>
<initializer>{true}</initializer>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/solver/nonlinear/options.hpp" line="35" column="14" bodyfile="src/include/serif/solver/nonlinear/options.hpp" bodystart="35" bodyend="35"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-func">
<memberdef kind="function" id="structserif_1_1solver_1_1_backtracking_1abf0928f3cb06fbb4b5449d795b0d49f0" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void serif::solver::Backtracking::validate</definition>
<argsstring>() const</argsstring>
<name>validate</name>
<qualifiedname>serif::solver::Backtracking::validate</qualifiedname>
<briefdescription>
<para>Require a decreasing, finite sequence of positive trial lengths. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/solver/nonlinear/options.hpp" line="38" column="14" bodyfile="src/lib/serif/solver/nonlinear/options.cpp" bodystart="24" bodyend="32"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>Shorten a <ref refid="structserif_1_1solver_1_1_newton" kindref="compound">Newton</ref> step until the complete residual merit decreases sufficiently. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<location file="src/include/serif/solver/nonlinear/options.hpp" line="28" column="5" bodyfile="src/include/serif/solver/nonlinear/options.hpp" bodystart="28" bodyend="39"/>
<listofallmembers>
<member refid="structserif_1_1solver_1_1_backtracking_1a7911ba8308c60432c6de212dfd695e8f" prot="public" virt="non-virtual"><scope>serif::solver::Backtracking</scope><name>contraction</name></member>
<member refid="structserif_1_1solver_1_1_backtracking_1a367c1a51e0b8d12774708d13c9094a8a" prot="public" virt="non-virtual"><scope>serif::solver::Backtracking</scope><name>fraction_to_boundary</name></member>
<member refid="structserif_1_1solver_1_1_backtracking_1aa74244d42ad42a75376e4d647c983d93" prot="public" virt="non-virtual"><scope>serif::solver::Backtracking</scope><name>geometry_preflight</name></member>
<member refid="structserif_1_1solver_1_1_backtracking_1aebcf24ae783fc9ff3ad60d99a2ec6c66" prot="public" virt="non-virtual"><scope>serif::solver::Backtracking</scope><name>initial_step</name></member>
<member refid="structserif_1_1solver_1_1_backtracking_1aeaad4d74cf2435b028349a8fee1d2710" prot="public" virt="non-virtual"><scope>serif::solver::Backtracking</scope><name>maximum_trials</name></member>
<member refid="structserif_1_1solver_1_1_backtracking_1a53406b3dd0cdd6e269f8e7269ec02d03" prot="public" virt="non-virtual"><scope>serif::solver::Backtracking</scope><name>minimum_step</name></member>
<member refid="structserif_1_1solver_1_1_backtracking_1abf45ecd4ec4a59442d45bca50a8d10ef" prot="public" virt="non-virtual"><scope>serif::solver::Backtracking</scope><name>sufficient_decrease</name></member>
<member refid="structserif_1_1solver_1_1_backtracking_1abf0928f3cb06fbb4b5449d795b0d49f0" prot="public" virt="non-virtual"><scope>serif::solver::Backtracking</scope><name>validate</name></member>
</listofallmembers>
</compounddef>
</doxygen>