Files
MeanField_SERiF/docs/xml/block_8hpp.xml

373 lines
18 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="block_8hpp" kind="file" language="C++">
<compoundname>block.hpp</compoundname>
<includes local="no">utility</includes>
<includes refid="solver_2preconditioner_2keys_8hpp" local="yes">serif/solver/preconditioner/keys.hpp</includes>
<includedby refid="normalization_8cpp" local="yes">src/compile_time_checks/serif/model/normalization.cpp</includedby>
<includedby refid="computations_2inverse_8hpp" local="yes">src/include/serif/backend/mfem/solver/preconditioner/computations/inverse.hpp</includedby>
<includedby refid="default__preconditioners_8hpp" local="yes">src/include/serif/solver/preconditioner/default_preconditioners.hpp</includedby>
<incdepgraph>
<node id="10">
<label>serif/discretization/blocks/base.hpp</label>
<link refid="base_8hpp"/>
</node>
<node id="6">
<label>serif/discretization/blocks/system_layout.hpp</label>
<link refid="system__layout_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
</node>
<node id="4">
<label>serif/operators/linearized_system_view.hpp</label>
<link refid="linearized__system__view_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="18" relation="include">
</childnode>
</node>
<node id="3">
<label>serif/solver/preconditioner/keys.hpp</label>
<link refid="solver_2preconditioner_2keys_8hpp"/>
<childnode refid="4" relation="include">
</childnode>
</node>
<node id="1">
<label>src/include/serif/solver/preconditioner/recipes/block.hpp</label>
<link refid="block_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
</node>
<node id="14">
<label>serif/utils/dependencies/binding.hpp</label>
<link refid="utils_2dependencies_2binding_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
</node>
<node id="18">
<label>serif/utils/dependencies/dependency_context.hpp</label>
<link refid="dependency__context_8hpp"/>
<childnode refid="19" relation="include">
</childnode>
<childnode refid="20" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="21" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
</node>
<node id="12">
<label>serif/utils/dependencies/detail/type_lists.hpp</label>
<link refid="type__lists_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="13">
<label>serif/utils/dependencies/key_list.hpp</label>
<link refid="key__list_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
</node>
<node id="11">
<label>serif/utils/dependencies/key_list_operations.hpp</label>
<link refid="key__list__operations_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
</node>
<node id="21">
<label>serif/utils/dependencies/resource.hpp</label>
<link refid="resource_8hpp"/>
<childnode refid="22" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="23" relation="include">
</childnode>
</node>
<node id="23">
<label>serif/utils/dependencies/snapshot.hpp</label>
<link refid="snapshot_8hpp"/>
<childnode refid="19" relation="include">
</childnode>
<childnode refid="22" relation="include">
</childnode>
<childnode refid="24" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="2" relation="include">
</childnode>
</node>
<node id="25">
<label>serif/utils/misc/concepts/concat.hpp</label>
<link refid="concat_8hpp"/>
<childnode refid="17" relation="include">
</childnode>
</node>
<node id="16">
<label>serif/utils/misc/std_helper/cleaning.hpp</label>
<link refid="cleaning_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="15">
<label>serif/utils/misc/traits/type_uniqueness.hpp</label>
<link refid="traits_2type__uniqueness_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
</node>
<node id="17">
<label>serif/utils/types/type_list.hpp</label>
<link refid="type__list_8hpp"/>
</node>
<node id="7">
<label>array</label>
</node>
<node id="19">
<label>concepts</label>
</node>
<node id="8">
<label>cstddef</label>
</node>
<node id="22">
<label>functional</label>
</node>
<node id="24">
<label>memory</label>
</node>
<node id="9">
<label>span</label>
</node>
<node id="20">
<label>tuple</label>
</node>
<node id="5">
<label>type_traits</label>
</node>
<node id="2">
<label>utility</label>
</node>
</incdepgraph>
<invincdepgraph>
<node id="16">
<label>src/compile_time_checks/serif/backend_independent.cpp</label>
<link refid="backend__independent_8cpp"/>
</node>
<node id="2">
<label>src/compile_time_checks/serif/model/normalization.cpp</label>
<link refid="normalization_8cpp"/>
</node>
<node id="8">
<label>src/compile_time_checks/serif/model/state.cpp</label>
<link refid="state_8cpp"/>
</node>
<node id="17">
<label>src/compile_time_checks/serif/solver/preconditioner/layout.cpp</label>
<link refid="layout_8cpp"/>
</node>
<node id="7">
<label>src/include/serif/backend/mfem/model/equilibrium.hpp</label>
<link refid="backend_2mfem_2model_2equilibrium_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="6">
<label>src/include/serif/backend/mfem/model/equilibrium_evaluator.hpp</label>
<link refid="equilibrium__evaluator_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
</node>
<node id="5">
<label>src/include/serif/backend/mfem/model/preconditioning/computations.hpp</label>
<link refid="backend_2mfem_2model_2preconditioning_2computations_8hpp"/>
<childnode refid="6" relation="include">
</childnode>
</node>
<node id="19">
<label>src/include/serif/backend/mfem/serialize/configuration.hpp</label>
<link refid="backend_2mfem_2serialize_2configuration_8hpp"/>
</node>
<node id="20">
<label>src/include/serif/backend/mfem/serialize/options.hpp</label>
<link refid="backend_2mfem_2serialize_2options_8hpp"/>
</node>
<node id="10">
<label>src/include/serif/backend/mfem/solver/equilibrium.hpp</label>
<link refid="backend_2mfem_2solver_2equilibrium_8hpp"/>
<childnode refid="11" relation="include">
</childnode>
</node>
<node id="9">
<label>src/include/serif/backend/mfem/solver/nonlinear/stellar_problem.hpp</label>
<link refid="stellar__problem_8hpp"/>
<childnode refid="10" relation="include">
</childnode>
</node>
<node id="3">
<label>src/include/serif/backend/mfem/solver/preconditioner/computations/inverse.hpp</label>
<link refid="computations_2inverse_8hpp"/>
<childnode refid="4" relation="include">
</childnode>
</node>
<node id="4">
<label>src/include/serif/backend/mfem/solver/preconditioner/graph.hpp</label>
<link refid="backend_2mfem_2solver_2preconditioner_2graph_8hpp"/>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
</node>
<node id="12">
<label>src/include/serif/solver/continuation/equilibrium.hpp</label>
<link refid="solver_2continuation_2equilibrium_8hpp"/>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="11">
<label>src/include/serif/solver/equilibrium.hpp</label>
<link refid="solver_2equilibrium_8hpp"/>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="15">
<label>src/include/serif/solver/preconditioner/default_preconditioners.hpp</label>
<link refid="default__preconditioners_8hpp"/>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
<childnode refid="18" relation="include">
</childnode>
</node>
<node id="14">
<label>src/include/serif/solver/preconditioner/preconditioner.hpp</label>
<link refid="preconditioner_8hpp"/>
<childnode refid="13" relation="include">
</childnode>
</node>
<node id="1">
<label>src/include/serif/solver/preconditioner/recipes/block.hpp</label>
<link refid="block_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
</node>
<node id="13">
<label>src/include/serif/solver/solver.hpp</label>
<link refid="solver_2solver_8hpp"/>
</node>
<node id="18">
<label>src/include/serif/utils/serialize/numerics.hpp</label>
<link refid="numerics_8hpp"/>
<childnode refid="19" relation="include">
</childnode>
<childnode refid="20" relation="include">
</childnode>
<childnode refid="21" relation="include">
</childnode>
</node>
<node id="22">
<label>src/include/serif/utils/serialize/serialize.hpp</label>
<link refid="serialize_8hpp"/>
<childnode refid="16" relation="include">
</childnode>
</node>
<node id="21">
<label>src/include/serif/utils/serialize/solver.hpp</label>
<link refid="utils_2serialize_2solver_8hpp"/>
<childnode refid="22" relation="include">
</childnode>
</node>
</invincdepgraph>
<innerclass refid="structserif_1_1solver_1_1preconditioner_1_1_block_preconditioner" prot="public">serif::solver::preconditioner::BlockPreconditioner</innerclass>
<innernamespace refid="namespaceserif">serif</innernamespace>
<innernamespace refid="namespaceserif_1_1solver">serif::solver</innernamespace>
<innernamespace refid="namespaceserif_1_1solver_1_1preconditioner">serif::solver::preconditioner</innernamespace>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<programlisting>
<codeline lineno="1"><highlight class="preprocessor">#pragma<sp/>once</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="2"><highlight class="normal"></highlight></codeline>
<codeline lineno="3"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;utility&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="4"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="solver_2preconditioner_2keys_8hpp" kindref="compound">serif/solver/preconditioner/keys.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="5"><highlight class="normal"></highlight></codeline>
<codeline lineno="6"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1solver_1_1preconditioner" kindref="compound">serif::solver::preconditioner</ref></highlight></codeline>
<codeline lineno="7"><highlight class="normal">{</highlight></codeline>
<codeline lineno="9"><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/>Row,<sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Field,<sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Strategy&gt;</highlight></codeline>
<codeline lineno="10" refid="structserif_1_1solver_1_1preconditioner_1_1_block_preconditioner" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">struct<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1preconditioner_1_1_block_preconditioner" kindref="compound">BlockPreconditioner</ref><sp/>final</highlight></codeline>
<codeline lineno="11"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1preconditioner_1_1_block_preconditioner_1a9fc28a291fffe457dad8215ae720b9a6" kindref="member">Rows</ref><sp/>=<sp/><ref refid="structserif_1_1utils_1_1dependencies_1_1_key_list" kindref="compound">utils::dependencies::KeyList&lt;Row&gt;</ref>;</highlight></codeline>
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1preconditioner_1_1_block_preconditioner_1a2ac65df6e3ba50bcdac2f879134aba62" kindref="member">Values</ref><sp/>=<sp/><ref refid="structserif_1_1utils_1_1dependencies_1_1_key_list" kindref="compound">utils::dependencies::KeyList&lt;Field&gt;</ref>;</highlight></codeline>
<codeline lineno="14"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">using<sp/></highlight><highlight class="normal"><ref refid="structserif_1_1solver_1_1preconditioner_1_1_block_preconditioner_1a20012e23e5bf807e213d85fc25819c05" kindref="member">Result</ref><sp/>=<sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1keys_1_1_inverse" kindref="compound">keys::Inverse&lt;Rows, Values&gt;</ref>;</highlight></codeline>
<codeline lineno="15"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>Strategy<sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1_block_preconditioner_1a86797f12ecaca6b79df1e2e0514021bd" kindref="member">inverse</ref>;</highlight></codeline>
<codeline lineno="16"><highlight class="normal"><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="17"><highlight class="normal"></highlight></codeline>
<codeline lineno="19"><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/>Field,<sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Row<sp/>=<sp/>Field,<sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>Strategy&gt;</highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/>[[nodiscard]]<sp/></highlight><highlight class="keyword">auto</highlight><highlight class="normal"><sp/><ref refid="namespaceserif_1_1solver_1_1preconditioner_1afd31d14cec3f663d8ed9c51d6fbc8fc7" kindref="member">make_preconditioner</ref>(Strategy<sp/>inverse)</highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
<codeline lineno="22"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keywordflow">return</highlight><highlight class="normal"><sp/><ref refid="structserif_1_1solver_1_1preconditioner_1_1_block_preconditioner" kindref="compound">BlockPreconditioner&lt;Row, Field, Strategy&gt;</ref>{.inverse<sp/>=<sp/>std::move(inverse)};</highlight></codeline>
<codeline lineno="23"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
<codeline lineno="24"><highlight class="normal"></highlight></codeline>
<codeline lineno="25"><highlight class="normal">}<sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>serif::solver::preconditioner</highlight><highlight class="normal"></highlight></codeline>
</programlisting>
<location file="src/include/serif/solver/preconditioner/recipes/block.hpp"/>
</compounddef>
</doxygen>