Files
MeanField_SERiF/docs/xml/public__contracts_8cpp.xml

650 lines
32 KiB
XML
Raw Permalink 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="public__contracts_8cpp" kind="file" language="C++">
<compoundname>public_contracts.cpp</compoundname>
<includes local="no">concepts</includes>
<includes local="no">utility</includes>
<includes refid="types_8hpp" local="yes">serif/types.hpp</includes>
<includes refid="solver_2nonlinear_2result_8hpp" local="yes">serif/solver/nonlinear/result.hpp</includes>
<includes refid="newton_8hpp" local="yes">serif/solver/nonlinear/newton.hpp</includes>
<includes refid="polytrope_8hpp" local="yes">serif/solver/seed/polytrope.hpp</includes>
<incdepgraph>
<node id="1">
<label>src/compile_time_checks/serif/solver/public_contracts.cpp</label>
<link refid="public__contracts_8cpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="43" relation="include">
</childnode>
<childnode refid="50" relation="include">
</childnode>
</node>
<node id="5">
<label>serif/backend/mfem/types.hpp</label>
<link refid="backend_2mfem_2types_8hpp"/>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="61">
<label>serif/dimensions/dimensions.hpp</label>
<link refid="dimensions_8hpp"/>
<childnode refid="26" relation="include">
</childnode>
<childnode refid="59" relation="include">
</childnode>
</node>
<node id="63">
<label>serif/dimensions/partial.hpp</label>
<link refid="partial_8hpp"/>
<childnode refid="59" relation="include">
</childnode>
<childnode refid="36" relation="include">
</childnode>
</node>
<node id="59">
<label>serif/dimensions/quantities.hpp</label>
<link refid="quantities_8hpp"/>
<childnode refid="35" relation="include">
</childnode>
<childnode refid="60" relation="include">
</childnode>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="22" relation="include">
</childnode>
<childnode refid="57" relation="include">
</childnode>
<childnode refid="36" relation="include">
</childnode>
</node>
<node id="62">
<label>serif/dimensions/type_alias.hpp</label>
<link refid="type__alias_8hpp"/>
<childnode refid="59" relation="include">
</childnode>
<childnode refid="61" relation="include">
</childnode>
</node>
<node id="52">
<label>serif/eos/models/polytropic.hpp</label>
<link refid="eos_2models_2polytropic_8hpp"/>
<childnode refid="53" relation="include">
</childnode>
<childnode refid="62" relation="include">
</childnode>
<childnode refid="63" relation="include">
</childnode>
</node>
<node id="54">
<label>serif/eos/relations/catalog.hpp</label>
<link refid="catalog_8hpp"/>
<childnode refid="55" relation="include">
</childnode>
<childnode refid="58" relation="include">
</childnode>
<childnode refid="59" relation="include">
</childnode>
</node>
<node id="53">
<label>serif/eos/relations/relations.hpp</label>
<link refid="eos_2relations_2relations_8hpp"/>
<childnode refid="54" relation="include">
</childnode>
<childnode refid="61" relation="include">
</childnode>
</node>
<node id="17">
<label>serif/geometry/deformation/geometry_step.hpp</label>
<link refid="geometry_2deformation_2geometry__step_8hpp"/>
<childnode refid="18" relation="include">
</childnode>
<childnode refid="19" relation="include">
</childnode>
</node>
<node id="38">
<label>serif/meta/enums.hpp</label>
<link refid="enums_8hpp"/>
<childnode refid="39" relation="include">
</childnode>
<childnode refid="35" relation="include">
</childnode>
<childnode refid="40" relation="include">
</childnode>
</node>
<node id="65">
<label>serif/model/detail/specification_list.hpp</label>
<link refid="specification__list_8hpp"/>
<childnode refid="22" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="66" relation="include">
</childnode>
<childnode refid="68" relation="include">
</childnode>
</node>
<node id="69">
<label>serif/model/equilibrium_equations.hpp</label>
<link refid="equilibrium__equations_8hpp"/>
<childnode refid="46" relation="include">
</childnode>
<childnode refid="22" relation="include">
</childnode>
<childnode refid="35" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
</node>
<node id="66">
<label>serif/model/specification.hpp</label>
<link refid="specification_8hpp"/>
<childnode refid="51" relation="include">
</childnode>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="19" relation="include">
</childnode>
<childnode refid="26" relation="include">
</childnode>
<childnode refid="35" relation="include">
</childnode>
<childnode refid="59" relation="include">
</childnode>
<childnode refid="41" relation="include">
</childnode>
<childnode refid="67" relation="include">
</childnode>
</node>
<node id="72">
<label>serif/model/specifications/fixed_angular_momentum.hpp</label>
<link refid="fixed__angular__momentum_8hpp"/>
<childnode refid="51" relation="include">
</childnode>
<childnode refid="62" relation="include">
</childnode>
<childnode refid="66" relation="include">
</childnode>
<childnode refid="71" relation="include">
</childnode>
</node>
<node id="70">
<label>serif/model/specifications/fixed_total_mass.hpp</label>
<link refid="fixed__total__mass_8hpp"/>
<childnode refid="62" relation="include">
</childnode>
<childnode refid="66" relation="include">
</childnode>
<childnode refid="71" relation="include">
</childnode>
</node>
<node id="71">
<label>serif/model/specifications/physical_names.hpp</label>
<link refid="physical__names_8hpp"/>
</node>
<node id="64">
<label>serif/model/stellar_model.hpp</label>
<link refid="stellar__model_8hpp"/>
<childnode refid="46" relation="include">
</childnode>
<childnode refid="21" relation="include">
</childnode>
<childnode refid="22" relation="include">
</childnode>
<childnode refid="35" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="65" relation="include">
</childnode>
<childnode refid="69" relation="include">
</childnode>
</node>
<node id="23">
<label>serif/solver/linear/linear.hpp</label>
<link refid="linear_8hpp"/>
<childnode refid="24" relation="include">
</childnode>
</node>
<node id="43">
<label>serif/solver/nonlinear/newton.hpp</label>
<link refid="newton_8hpp"/>
<childnode refid="44" relation="include">
</childnode>
<childnode refid="47" relation="include">
</childnode>
</node>
<node id="44">
<label>serif/solver/nonlinear/observers.hpp</label>
<link refid="solver_2nonlinear_2observers_8hpp"/>
<childnode refid="45" relation="include">
</childnode>
<childnode refid="46" relation="include">
</childnode>
<childnode refid="35" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
</node>
<node id="20">
<label>serif/solver/nonlinear/options.hpp</label>
<link refid="solver_2nonlinear_2options_8hpp"/>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="21" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="22" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="23" relation="include">
</childnode>
</node>
<node id="48">
<label>serif/solver/nonlinear/qualification.hpp</label>
<link refid="qualification_8hpp"/>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="49" relation="include">
</childnode>
<childnode refid="21" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
</node>
<node id="10">
<label>serif/solver/nonlinear/result.hpp</label>
<link refid="solver_2nonlinear_2result_8hpp"/>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
<childnode refid="20" relation="include">
</childnode>
<childnode refid="23" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
</node>
<node id="47">
<label>serif/solver/nonlinear/steps.hpp</label>
<link refid="steps_8hpp"/>
<childnode refid="19" relation="include">
</childnode>
<childnode refid="48" relation="include">
</childnode>
</node>
<node id="50">
<label>serif/solver/seed/polytrope.hpp</label>
<link refid="polytrope_8hpp"/>
<childnode refid="51" relation="include">
</childnode>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="49" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="52" relation="include">
</childnode>
<childnode refid="64" relation="include">
</childnode>
<childnode refid="70" relation="include">
</childnode>
<childnode refid="72" relation="include">
</childnode>
<childnode refid="73" relation="include">
</childnode>
</node>
<node id="4">
<label>serif/types.hpp</label>
<link refid="types_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="37">
<label>serif/utils/error/codes.hpp</label>
<link refid="codes_8hpp"/>
<childnode refid="24" relation="include">
</childnode>
<childnode refid="38" relation="include">
</childnode>
</node>
<node id="25">
<label>serif/utils/error/errors.hpp</label>
<link refid="errors_8hpp"/>
<childnode refid="26" relation="include">
</childnode>
<childnode refid="27" relation="include">
</childnode>
<childnode refid="28" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="24" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="29" relation="include">
</childnode>
<childnode refid="30" relation="include">
</childnode>
<childnode refid="33" relation="include">
</childnode>
<childnode refid="37" relation="include">
</childnode>
<childnode refid="41" relation="include">
</childnode>
</node>
<node id="73">
<label>serif/utils/laneemden/laneemden.hpp</label>
<link refid="laneemden_8hpp"/>
<childnode refid="74" relation="include">
</childnode>
<childnode refid="75" relation="include">
</childnode>
</node>
<node id="75">
<label>serif/utils/laneemden/scaling.hpp</label>
<link refid="scaling_8hpp"/>
<childnode refid="49" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="61" relation="include">
</childnode>
<childnode refid="74" relation="include">
</childnode>
</node>
<node id="74">
<label>serif/utils/laneemden/solution.hpp</label>
<link refid="solution_8hpp"/>
<childnode refid="18" relation="include">
</childnode>
<childnode refid="49" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="26" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="27" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
</node>
<node id="33">
<label>serif/utils/misc/concepts/exceptions.hpp</label>
<link refid="utils_2misc_2concepts_2exceptions_8hpp"/>
<childnode refid="34" relation="include">
</childnode>
<childnode refid="35" relation="include">
</childnode>
<childnode refid="36" relation="include">
</childnode>
</node>
<node id="68">
<label>serif/utils/misc/concepts/filter.hpp</label>
<link refid="filter_8hpp"/>
<childnode refid="35" relation="include">
</childnode>
<childnode refid="67" relation="include">
</childnode>
</node>
<node id="36">
<label>serif/utils/misc/concepts/numeric.hpp</label>
<link refid="numeric_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="35" relation="include">
</childnode>
</node>
<node id="55">
<label>serif/utils/misc/concepts/type_uniqueness.hpp</label>
<link refid="concepts_2type__uniqueness_8hpp"/>
<childnode refid="56" relation="include">
</childnode>
</node>
<node id="57">
<label>serif/utils/misc/std_helper/cleaning.hpp</label>
<link refid="cleaning_8hpp"/>
<childnode refid="35" relation="include">
</childnode>
</node>
<node id="58">
<label>serif/utils/misc/std_helper/variadic_cleaning.hpp</label>
<link refid="variadic__cleaning_8hpp"/>
<childnode refid="18" relation="include">
</childnode>
</node>
<node id="30">
<label>serif/utils/misc/terminal/colors.hpp</label>
<link refid="colors_8hpp"/>
<childnode refid="26" relation="include">
</childnode>
<childnode refid="28" relation="include">
</childnode>
<childnode refid="31" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="32" relation="include">
</childnode>
</node>
<node id="56">
<label>serif/utils/misc/traits/type_uniqueness.hpp</label>
<link refid="traits_2type__uniqueness_8hpp"/>
<childnode refid="51" relation="include">
</childnode>
<childnode refid="57" relation="include">
</childnode>
</node>
<node id="41">
<label>serif/utils/types/strings.hpp</label>
<link refid="types_2strings_8hpp"/>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="42" relation="include">
</childnode>
<childnode refid="26" relation="include">
</childnode>
</node>
<node id="67">
<label>serif/utils/types/type_list.hpp</label>
<link refid="type__list_8hpp"/>
</node>
<node id="11">
<label>algorithm</label>
</node>
<node id="51">
<label>array</label>
</node>
<node id="45">
<label>chrono</label>
</node>
<node id="12">
<label>cmath</label>
</node>
<node id="60">
<label>compare</label>
</node>
<node id="2">
<label>concepts</label>
</node>
<node id="18">
<label>cstddef</label>
</node>
<node id="24">
<label>cstdint</label>
</node>
<node id="28">
<label>cstdio</label>
</node>
<node id="31">
<label>cstdlib</label>
</node>
<node id="34">
<label>exception</label>
</node>
<node id="49">
<label>expected</label>
</node>
<node id="27">
<label>format</label>
</node>
<node id="46">
<label>functional</label>
</node>
<node id="42">
<label>iostream</label>
</node>
<node id="19">
<label>limits</label>
</node>
<node id="40">
<label>magic_enum/magic_enum_all.hpp</label>
</node>
<node id="13">
<label>memory</label>
</node>
<node id="7">
<label>mfem/linalg/densemat.hpp</label>
</node>
<node id="9">
<label>mfem/linalg/operator.hpp</label>
</node>
<node id="8">
<label>mfem/linalg/sparsemat.hpp</label>
</node>
<node id="6">
<label>mfem/linalg/vector.hpp</label>
</node>
<node id="14">
<label>optional</label>
</node>
<node id="21">
<label>span</label>
</node>
<node id="15">
<label>string</label>
</node>
<node id="26">
<label>string_view</label>
</node>
<node id="22">
<label>tuple</label>
</node>
<node id="35">
<label>type_traits</label>
</node>
<node id="32">
<label>unistd.h</label>
</node>
<node id="39">
<label>unordered_map</label>
</node>
<node id="3">
<label>utility</label>
</node>
<node id="16">
<label>vector</label>
</node>
<node id="29">
<label>version</label>
</node>
</incdepgraph>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<programlisting>
<codeline lineno="1"><highlight class="preprocessor">#include<sp/>&lt;concepts&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="2"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;utility&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="3"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="types_8hpp" kindref="compound">serif/types.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="solver_2nonlinear_2result_8hpp" kindref="compound">serif/solver/nonlinear/result.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="newton_8hpp" kindref="compound">serif/solver/nonlinear/newton.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="7"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="polytrope_8hpp" kindref="compound">serif/solver/seed/polytrope.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="8"><highlight class="normal"></highlight></codeline>
<codeline lineno="9"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal">{</highlight></codeline>
<codeline lineno="10"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal">solver<sp/>=<sp/><ref refid="namespaceserif_1_1solver" kindref="compound">serif::solver</ref>;</highlight></codeline>
<codeline lineno="11"><highlight class="normal"></highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::same_as&lt;serif::Vector,<sp/>mfem::Vector&gt;);</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::same_as&lt;serif::DenseMatrix,<sp/>mfem::DenseMatrix&gt;);</highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::same_as&lt;serif::SparseMatrix,<sp/>mfem::SparseMatrix&gt;);</highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::same_as&lt;serif::LinearOperator,<sp/>mfem::Operator&gt;);</highlight></codeline>
<codeline lineno="16"><highlight class="normal"></highlight></codeline>
<codeline lineno="17"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal">EquationDefinition<sp/>{};</highlight></codeline>
<codeline lineno="18"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal">MassModel<sp/>=<sp/></highlight><highlight class="keyword">decltype</highlight><highlight class="normal">(<ref refid="namespaceserif_1_1model_1abd082b1964d28e91b8eb1da4ffdf22ee" kindref="member">serif::model::make_stellar_model</ref>(std::declval&lt;serif::eos::models::Polytrope&gt;(),<sp/>EquationDefinition{},</highlight></codeline>
<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::declval&lt;serif::model::FixedTotalMass&gt;()));</highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal">UnspecifiedMass<sp/>=<sp/></highlight><highlight class="keyword">decltype</highlight><highlight class="normal">(<ref refid="namespaceserif_1_1model_1abd082b1964d28e91b8eb1da4ffdf22ee" kindref="member">serif::model::make_stellar_model</ref>(std::declval&lt;serif::eos::models::Polytrope&gt;(),<sp/>EquationDefinition{}));</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">template</highlight><highlight class="normal"><sp/>&lt;</highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Model&gt;</highlight></codeline>
<codeline lineno="22" refid="concept_0d157116114150123267120271363131113324057353033032_1_1_default_radial_seed" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">concept<sp/></highlight><highlight class="normal"><ref refid="concept_0d157116114150123267120271363131113324057353033032_1_1_default_radial_seed" kindref="compound">DefaultRadialSeed</ref><sp/>=<sp/></highlight><highlight class="keyword">requires</highlight><highlight class="normal">(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>Model&amp;<sp/>model)<sp/>{<sp/>solver::seed::make_polytropic_seed(model);<sp/>};</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(<ref refid="concept_0d157116114150123267120271363131113324057353033032_1_1_default_radial_seed" kindref="compound">DefaultRadialSeed&lt;MassModel&gt;</ref>);</highlight></codeline>
<codeline lineno="24"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(!<ref refid="concept_0d157116114150123267120271363131113324057353033032_1_1_default_radial_seed" kindref="compound">DefaultRadialSeed&lt;UnspecifiedMass&gt;</ref>);</highlight></codeline>
<codeline lineno="25"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(!<ref refid="concept_0d157116114150123267120271363131113324057353033032_1_1_default_radial_seed" kindref="compound">DefaultRadialSeed&lt;int&gt;</ref>);</highlight></codeline>
<codeline lineno="26"><highlight class="normal"></highlight></codeline>
<codeline lineno="27"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal">State<sp/>{};</highlight></codeline>
<codeline lineno="28"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal">System<sp/>{};</highlight></codeline>
<codeline lineno="29"><highlight class="normal"></highlight></codeline>
<codeline lineno="30"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal">Problem<sp/>{</highlight></codeline>
<codeline lineno="31"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal">Vector<sp/>=<sp/><ref refid="namespaceserif_1ab7690da8665e9d9bd2fa8e8534cd6e57" kindref="member">serif::Vector</ref>;</highlight></codeline>
<codeline lineno="32"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::expected&lt;std::shared_ptr&lt;const<sp/>System&gt;,<sp/>std::string&gt;<sp/>prepare(</highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>State&amp;);</highlight></codeline>
<codeline lineno="33"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="34"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal">InvalidSolve<sp/>:<sp/>solver::StandardNewton<sp/>{</highlight></codeline>
<codeline lineno="35"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>solver::linear::Report<sp/><ref refid="namespaceserif_1_1solver_1_1linear_1_1backend_1_1mfem_1a048c6be0b47ff070d1ce8165ed857051" kindref="member">solve</ref>(</highlight><highlight class="keywordtype">int</highlight><highlight class="normal">);</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="37"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal">DirectionOnly<sp/>:<sp/>solver::StandardNewton<sp/>{</highlight></codeline>
<codeline lineno="38"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>solver::DirectionAssessment<sp/>direction(</highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;,<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal">&amp;)<sp/>{<sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/>{};<sp/>}</highlight></codeline>
<codeline lineno="39"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="40"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(solver::detail::NewtonStrategyFor&lt;Problem,<sp/>State,<sp/>solver::SolverOptions&lt;&gt;&gt;);</highlight></codeline>
<codeline lineno="41"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(solver::detail::NewtonStrategyFor&lt;Problem,<sp/>State,<sp/>solver::SolverOptions&lt;solver::NormalizedResidualMetric,<sp/>DirectionOnly&gt;&gt;);</highlight></codeline>
<codeline lineno="42"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(!solver::detail::NewtonStrategyFor&lt;Problem,<sp/>State,<sp/>solver::SolverOptions&lt;solver::NormalizedResidualMetric,<sp/>InvalidSolve&gt;&gt;);</highlight></codeline>
<codeline lineno="43"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1utils_1_1serialize_1ace9e0af29889a767ef1c95a09a4b7265" kindref="member">Result</ref><sp/>=<sp/>solver::SolveResult&lt;State,<sp/>System&gt;;</highlight></codeline>
<codeline lineno="44"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::same_as&lt;decltype(std::declval&lt;Result&amp;&gt;().state()),<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>State&amp;&gt;);</highlight></codeline>
<codeline lineno="45"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::same_as&lt;decltype(std::declval&lt;Result&amp;&gt;().system()),<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::shared_ptr&lt;const<sp/>System&gt;&amp;&gt;);</highlight></codeline>
<codeline lineno="46"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">static_assert</highlight><highlight class="normal">(std::same_as&lt;decltype(std::declval&lt;Result&amp;&gt;().diagnostics()),<sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>solver::SolveDiagnostics&amp;&gt;);</highlight></codeline>
<codeline lineno="47"><highlight class="normal">}</highlight></codeline>
</programlisting>
<location file="src/compile_time_checks/serif/solver/public_contracts.cpp"/>
</compounddef>
</doxygen>