Files
MeanField_SERiF/docs/xml/namespaceserif_1_1solver_1_1linear.xml

84 lines
4.6 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_1solver_1_1linear" kind="namespace" language="C++">
<compoundname>serif::solver::linear</compoundname>
<innerclass refid="classserif_1_1solver_1_1linear_1_1_application_failure" prot="public">serif::solver::linear::ApplicationFailure</innerclass>
<innerclass refid="structserif_1_1solver_1_1linear_1_1_control" prot="public">serif::solver::linear::Control</innerclass>
<innerclass refid="structserif_1_1solver_1_1linear_1_1_f_g_m_r_e_s" prot="public">serif::solver::linear::FGMRES</innerclass>
<innerclass refid="structserif_1_1solver_1_1linear_1_1_report" prot="public">serif::solver::linear::Report</innerclass>
<innernamespace refid="namespaceserif_1_1solver_1_1linear_1_1backend">serif::solver::linear::backend</innernamespace>
<sectiondef kind="enum">
<memberdef kind="enum" id="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569d" prot="public" static="no" strong="yes">
<type></type>
<name>Status</name>
<qualifiedname>serif::solver::linear::Status</qualifiedname>
<enumvalue id="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569da7de33615d7fbc1cb7bc608d12f1993d2" prot="public">
<name>converged</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569daf9cc715fb6ecde5fea080ac57ad0dfaf" prot="public">
<name>maximum_iterations</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569da0c465cebd957857d21f91945cc2127ee" prot="public">
<name>breakdown</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569da4013d0a2d04acba5257678a15922a094" prot="public">
<name>non_finite</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<enumvalue id="namespaceserif_1_1solver_1_1linear_1aae6664ea4d061abc041271ec48bd569da4012827e4f1918f330f4ffc6d03858ef" prot="public">
<name>backend_failure</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
</enumvalue>
<briefdescription>
<para>Numerical termination of a checked Krylov solve. Invalid configuration remains a programming error. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/solver/linear/linear.hpp" line="7" column="5" bodyfile="src/include/serif/solver/linear/linear.hpp" bodystart="7" bodyend="7"/>
</memberdef>
</sectiondef>
<sectiondef kind="typedef">
<memberdef kind="typedef" id="namespaceserif_1_1solver_1_1linear_1a502304092898f6a1cc0ea79444451050" prot="public" static="no">
<type><ref refid="classserif_1_1utils_1_1errors_1_1_non_finite_value" kindref="compound">utils::errors::NonFiniteValue</ref></type>
<definition>using serif::solver::linear::NonFiniteApplication = utils::errors::NonFiniteValue</definition>
<argsstring></argsstring>
<name>NonFiniteApplication</name>
<qualifiedname>serif::solver::linear::NonFiniteApplication</qualifiedname>
<briefdescription>
<para>Stop Krylov before a nonfinite application reaches MFEM internal arithmetic assertions. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/solver/linear/failure.hpp" line="18" column="5" bodyfile="src/include/serif/solver/linear/failure.hpp" bodystart="18" bodyend="-1"/>
</memberdef>
</sectiondef>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<location file="src/include/serif/backend/mfem/solver/linear/solve.hpp" line="11" column="1"/>
</compounddef>
</doxygen>