Files
MeanField_SERiF/docs/xml/concept_8hpp.xml

665 lines
27 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="concept_8hpp" kind="file" language="C++">
<compoundname>concept.hpp</compoundname>
<includes refid="forms_8hpp" local="yes">serif/discretization/forms/forms.hpp</includes>
<includedby refid="forms_8cpp" local="yes">src/compile_time_checks/serif/discretization/forms/forms.cpp</includedby>
<includedby refid="mfem__static__order_8hpp" local="yes">src/include/serif/backend/mfem/discretization/quadrature/mfem_static_order.hpp</includedby>
<includedby refid="form__traits_8hpp" local="yes">src/include/serif/discretization/forms/form_traits.hpp</includedby>
<includedby refid="discretization_2forms_2runtime_8hpp" local="yes">src/include/serif/discretization/forms/runtime.hpp</includedby>
<incdepgraph>
<node id="9">
<label>serif/dimensions/dimensions.hpp</label>
<link refid="dimensions_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
</node>
<node id="10">
<label>serif/dimensions/quantities.hpp</label>
<link refid="quantities_8hpp"/>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
</node>
<node id="15">
<label>serif/discretization/blocks/base.hpp</label>
<link refid="base_8hpp"/>
</node>
<node id="5">
<label>serif/discretization/blocks/concepts.hpp</label>
<link refid="discretization_2blocks_2concepts_8hpp"/>
<childnode refid="6" relation="include">
</childnode>
</node>
<node id="6">
<label>serif/discretization/blocks/fields.hpp</label>
<link refid="fields_8hpp"/>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="21" relation="include">
</childnode>
<childnode refid="27" relation="include">
</childnode>
<childnode refid="28" relation="include">
</childnode>
<childnode refid="29" relation="include">
</childnode>
</node>
<node id="21">
<label>serif/discretization/domain/concepts.hpp</label>
<link refid="discretization_2domain_2concepts_8hpp"/>
<childnode refid="22" relation="include">
</childnode>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="23" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
<childnode refid="24" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
<childnode refid="13" relation="include">
</childnode>
<childnode refid="26" relation="include">
</childnode>
</node>
<node id="27">
<label>serif/discretization/domain/physical_domains.hpp</label>
<link refid="physical__domains_8hpp"/>
<childnode refid="25" relation="include">
</childnode>
<childnode refid="21" relation="include">
</childnode>
</node>
<node id="25">
<label>serif/discretization/domain/types.hpp</label>
<link refid="discretization_2domain_2types_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
</node>
<node id="1">
<label>src/include/serif/discretization/forms/concept.hpp</label>
<link refid="concept_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
</node>
<node id="2">
<label>serif/discretization/forms/forms.hpp</label>
<link refid="forms_8hpp"/>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="31" relation="include">
</childnode>
<childnode refid="28" relation="include">
</childnode>
<childnode refid="29" relation="include">
</childnode>
</node>
<node id="31">
<label>serif/discretization/forms/operands.hpp</label>
<link refid="operands_8hpp"/>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
</node>
<node id="16">
<label>serif/discretization/functional_space/space.hpp</label>
<link refid="space_8hpp"/>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
<childnode refid="18" relation="include">
</childnode>
</node>
<node id="18">
<label>serif/meta/enums.hpp</label>
<link refid="enums_8hpp"/>
<childnode refid="19" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="20" relation="include">
</childnode>
</node>
<node id="29">
<label>serif/meta/names.hpp</label>
<link refid="names_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="30" relation="include">
</childnode>
</node>
<node id="14">
<label>serif/utils/misc/concepts/numeric.hpp</label>
<link refid="numeric_8hpp"/>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="4" relation="include">
</childnode>
</node>
<node id="13">
<label>serif/utils/misc/std_helper/cleaning.hpp</label>
<link refid="cleaning_8hpp"/>
<childnode refid="4" relation="include">
</childnode>
</node>
<node id="26">
<label>serif/utils/misc/std_helper/variadic_cleaning.hpp</label>
<link refid="variadic__cleaning_8hpp"/>
<childnode refid="22" relation="include">
</childnode>
</node>
<node id="28">
<label>serif/utils/types/type_list.hpp</label>
<link refid="type__list_8hpp"/>
</node>
<node id="7">
<label>array</label>
</node>
<node id="11">
<label>compare</label>
</node>
<node id="3">
<label>concepts</label>
</node>
<node id="22">
<label>cstddef</label>
</node>
<node id="17">
<label>format</label>
</node>
<node id="20">
<label>magic_enum/magic_enum_all.hpp</label>
</node>
<node id="30">
<label>nameof.hpp</label>
</node>
<node id="24">
<label>numeric</label>
</node>
<node id="23">
<label>span</label>
</node>
<node id="8">
<label>string_view</label>
</node>
<node id="12">
<label>tuple</label>
</node>
<node id="4">
<label>type_traits</label>
</node>
<node id="19">
<label>unordered_map</label>
</node>
</incdepgraph>
<invincdepgraph>
<node id="4">
<label>src/compile_time_checks/serif/backend/mfem/discretization/quadrature/mfem_resolver.cpp</label>
<link refid="mfem__resolver_8cpp"/>
</node>
<node id="5">
<label>src/compile_time_checks/serif/backend/mfem/discretization/quadrature/mfem_static_order.cpp</label>
<link refid="mfem__static__order_8cpp"/>
</node>
<node id="55">
<label>src/compile_time_checks/serif/backend_independent.cpp</label>
<link refid="backend__independent_8cpp"/>
</node>
<node id="58">
<label>src/compile_time_checks/serif/discretization/fields_meanfield.cpp</label>
<link refid="fields__meanfield_8cpp"/>
</node>
<node id="2">
<label>src/compile_time_checks/serif/discretization/forms/forms.cpp</label>
<link refid="forms_8cpp"/>
</node>
<node id="31">
<label>src/compile_time_checks/serif/model/finite_elements.cpp</label>
<link refid="compile__time__checks_2serif_2model_2finite__elements_8cpp"/>
</node>
<node id="26">
<label>src/compile_time_checks/serif/model/scalar_row.cpp</label>
<link refid="compile__time__checks_2serif_2model_2scalar__row_8cpp"/>
</node>
<node id="16">
<label>src/compile_time_checks/serif/model/state.cpp</label>
<link refid="state_8cpp"/>
</node>
<node id="11">
<label>src/compile_time_checks/serif/operators/computation_owners.cpp</label>
<link refid="computation__owners_8cpp"/>
</node>
<node id="6">
<label>src/include/serif/backend/mfem/discretization/quadrature/mfem_resolver.hpp</label>
<link refid="mfem__resolver_8hpp"/>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="7" relation="include">
</childnode>
</node>
<node id="3">
<label>src/include/serif/backend/mfem/discretization/quadrature/mfem_static_order.hpp</label>
<link refid="mfem__static__order_8hpp"/>
<childnode refid="4" relation="include">
</childnode>
<childnode refid="5" relation="include">
</childnode>
<childnode refid="6" relation="include">
</childnode>
</node>
<node id="37">
<label>src/include/serif/backend/mfem/model/binding.hpp</label>
<link refid="backend_2mfem_2model_2binding_8hpp"/>
<childnode refid="38" relation="include">
</childnode>
<childnode refid="39" relation="include">
</childnode>
</node>
<node id="12">
<label>src/include/serif/backend/mfem/model/computations/interior.hpp</label>
<link refid="interior_8hpp"/>
<childnode refid="13" relation="include">
</childnode>
<childnode refid="23" relation="include">
</childnode>
<childnode refid="24" relation="include">
</childnode>
<childnode refid="14" relation="include">
</childnode>
</node>
<node id="13">
<label>src/include/serif/backend/mfem/model/computations/potential_infinity.hpp</label>
<link refid="potential__infinity_8hpp"/>
<childnode refid="14" relation="include">
</childnode>
</node>
<node id="23">
<label>src/include/serif/backend/mfem/model/computations/pressure_boundary.hpp</label>
<link refid="model_2computations_2pressure__boundary_8hpp"/>
<childnode refid="14" relation="include">
</childnode>
</node>
<node id="25">
<label>src/include/serif/backend/mfem/model/computations/scalar_row.hpp</label>
<link refid="computations_2scalar__row_8hpp"/>
<childnode refid="26" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
</node>
<node id="24">
<label>src/include/serif/backend/mfem/model/computations/surface_potential.hpp</label>
<link refid="backend_2mfem_2model_2computations_2surface__potential_8hpp"/>
<childnode refid="14" relation="include">
</childnode>
</node>
<node id="28">
<label>src/include/serif/backend/mfem/model/discretization.hpp</label>
<link refid="model_2discretization_8hpp"/>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="29" relation="include">
</childnode>
<childnode refid="33" relation="include">
</childnode>
</node>
<node id="15">
<label>src/include/serif/backend/mfem/model/equilibrium.hpp</label>
<link refid="backend_2mfem_2model_2equilibrium_8hpp"/>
<childnode refid="16" relation="include">
</childnode>
<childnode refid="17" relation="include">
</childnode>
</node>
<node id="38">
<label>src/include/serif/backend/mfem/model/equilibrium_evaluator.hpp</label>
<link refid="equilibrium__evaluator_8hpp"/>
<childnode refid="15" relation="include">
</childnode>
</node>
<node id="29">
<label>src/include/serif/backend/mfem/model/finite_elements.hpp</label>
<link refid="backend_2mfem_2model_2finite__elements_8hpp"/>
<childnode refid="30" relation="include">
</childnode>
<childnode refid="32" relation="include">
</childnode>
</node>
<node id="14">
<label>src/include/serif/backend/mfem/model/graph.hpp</label>
<link refid="backend_2mfem_2model_2graph_8hpp"/>
<childnode refid="15" relation="include">
</childnode>
<childnode refid="22" relation="include">
</childnode>
</node>
<node id="36">
<label>src/include/serif/backend/mfem/model/inputs.hpp</label>
<link refid="model_2inputs_8hpp"/>
<childnode refid="37" relation="include">
</childnode>
</node>
<node id="43">
<label>src/include/serif/backend/mfem/model/volume.hpp</label>
<link refid="volume_8hpp"/>
<childnode refid="12" relation="include">
</childnode>
</node>
<node id="44">
<label>src/include/serif/backend/mfem/model/volume_actions.hpp</label>
<link refid="volume__actions_8hpp"/>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
</node>
<node id="41">
<label>src/include/serif/backend/mfem/model/volume_displacement.hpp</label>
<link refid="volume__displacement_8hpp"/>
<childnode refid="14" relation="include">
</childnode>
</node>
<node id="8">
<label>src/include/serif/backend/mfem/operators/element_preparation.hpp</label>
<link refid="element__preparation_8hpp"/>
<childnode refid="9" relation="include">
</childnode>
</node>
<node id="45">
<label>src/include/serif/backend/mfem/operators/jacobian_operator.hpp</label>
<link refid="jacobian__operator_8hpp"/>
<childnode refid="11" relation="include">
</childnode>
</node>
<node id="7">
<label>src/include/serif/backend/mfem/operators/quadrature.hpp</label>
<link refid="quadrature_8hpp"/>
<childnode refid="8" relation="include">
</childnode>
<childnode refid="27" relation="include">
</childnode>
</node>
<node id="42">
<label>src/include/serif/backend/mfem/operators/volume_application.hpp</label>
<link refid="volume__application_8hpp"/>
<childnode refid="43" relation="include">
</childnode>
<childnode refid="44" relation="include">
</childnode>
<childnode refid="45" relation="include">
</childnode>
<childnode refid="46" relation="include">
</childnode>
</node>
<node id="10">
<label>src/include/serif/backend/mfem/operators/volume_computations.hpp</label>
<link refid="volume__computations_8hpp"/>
<childnode refid="11" relation="include">
</childnode>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="25" relation="include">
</childnode>
</node>
<node id="27">
<label>src/include/serif/backend/mfem/operators/volume_data.hpp</label>
<link refid="volume__data_8hpp"/>
<childnode refid="28" relation="include">
</childnode>
<childnode refid="35" relation="include">
</childnode>
<childnode refid="9" relation="include">
</childnode>
<childnode refid="48" relation="include">
</childnode>
</node>
<node id="46">
<label>src/include/serif/backend/mfem/operators/volume_field_block.hpp</label>
<link refid="volume__field__block_8hpp"/>
<childnode refid="12" relation="include">
</childnode>
<childnode refid="47" relation="include">
</childnode>
</node>
<node id="35">
<label>src/include/serif/backend/mfem/operators/volume_inputs.hpp</label>
<link refid="volume__inputs_8hpp"/>
<childnode refid="36" relation="include">
</childnode>
<childnode refid="41" relation="include">
</childnode>
<childnode refid="42" relation="include">
</childnode>
<childnode refid="10" relation="include">
</childnode>
</node>
<node id="9">
<label>src/include/serif/backend/mfem/operators/volume_stages.hpp</label>
<link refid="volume__stages_8hpp"/>
<childnode refid="10" relation="include">
</childnode>
</node>
<node id="34">
<label>src/include/serif/backend/mfem/serialize/configuration.hpp</label>
<link refid="backend_2mfem_2serialize_2configuration_8hpp"/>
</node>
<node id="33">
<label>src/include/serif/backend/mfem/serialize/discretization.hpp</label>
<link refid="serialize_2discretization_8hpp"/>
<childnode refid="34" relation="include">
</childnode>
</node>
<node id="48">
<label>src/include/serif/backend/mfem/serialize/options.hpp</label>
<link refid="backend_2mfem_2serialize_2options_8hpp"/>
</node>
<node id="22">
<label>src/include/serif/backend/mfem/solver/admissibility/geometry.hpp</label>
<link refid="geometry_8hpp"/>
<childnode refid="17" relation="include">
</childnode>
</node>
<node id="18">
<label>src/include/serif/backend/mfem/solver/equilibrium.hpp</label>
<link refid="backend_2mfem_2solver_2equilibrium_8hpp"/>
<childnode refid="19" relation="include">
</childnode>
</node>
<node id="17">
<label>src/include/serif/backend/mfem/solver/nonlinear/stellar_problem.hpp</label>
<link refid="stellar__problem_8hpp"/>
<childnode refid="18" relation="include">
</childnode>
</node>
<node id="39">
<label>src/include/serif/backend/mfem/solver/seed/state.hpp</label>
<link refid="backend_2mfem_2solver_2seed_2state_8hpp"/>
<childnode refid="40" relation="include">
</childnode>
</node>
<node id="1">
<label>src/include/serif/discretization/forms/concept.hpp</label>
<link refid="concept_8hpp"/>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="3" relation="include">
</childnode>
<childnode refid="49" relation="include">
</childnode>
<childnode refid="57" relation="include">
</childnode>
</node>
<node id="49">
<label>src/include/serif/discretization/forms/form_traits.hpp</label>
<link refid="form__traits_8hpp"/>
<childnode refid="50" relation="include">
</childnode>
</node>
<node id="57">
<label>src/include/serif/discretization/forms/runtime.hpp</label>
<link refid="discretization_2forms_2runtime_8hpp"/>
<childnode refid="58" relation="include">
</childnode>
<childnode refid="2" relation="include">
</childnode>
<childnode refid="50" relation="include">
</childnode>
<childnode refid="59" relation="include">
</childnode>
</node>
<node id="51">
<label>src/include/serif/discretization/quadrature/policy.hpp</label>
<link refid="policy_8hpp"/>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="52" relation="include">
</childnode>
<childnode refid="56" relation="include">
</childnode>
</node>
<node id="50">
<label>src/include/serif/discretization/quadrature/query.hpp</label>
<link refid="query_8hpp"/>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="51" relation="include">
</childnode>
</node>
<node id="59">
<label>src/include/serif/discretization/quadrature/rules.hpp</label>
<link refid="rules_8hpp"/>
<childnode refid="6" relation="include">
</childnode>
<childnode refid="51" relation="include">
</childnode>
<childnode refid="50" relation="include">
</childnode>
</node>
<node id="30">
<label>src/include/serif/model/finite_elements.hpp</label>
<link refid="model_2finite__elements_8hpp"/>
<childnode refid="31" relation="include">
</childnode>
<childnode refid="19" relation="include">
</childnode>
</node>
<node id="20">
<label>src/include/serif/solver/continuation/equilibrium.hpp</label>
<link refid="solver_2continuation_2equilibrium_8hpp"/>
<childnode refid="21" relation="include">
</childnode>
</node>
<node id="19">
<label>src/include/serif/solver/equilibrium.hpp</label>
<link refid="solver_2equilibrium_8hpp"/>
<childnode refid="20" relation="include">
</childnode>
<childnode refid="21" relation="include">
</childnode>
</node>
<node id="40">
<label>src/include/serif/solver/seed/state.hpp</label>
<link refid="solver_2seed_2state_8hpp"/>
<childnode refid="21" relation="include">
</childnode>
</node>
<node id="21">
<label>src/include/serif/solver/solver.hpp</label>
<link refid="solver_2solver_8hpp"/>
</node>
<node id="52">
<label>src/include/serif/utils/serialize/numerics.hpp</label>
<link refid="numerics_8hpp"/>
<childnode refid="34" relation="include">
</childnode>
<childnode refid="48" relation="include">
</childnode>
<childnode refid="53" relation="include">
</childnode>
</node>
<node id="54">
<label>src/include/serif/utils/serialize/serialize.hpp</label>
<link refid="serialize_8hpp"/>
<childnode refid="55" relation="include">
</childnode>
</node>
<node id="53">
<label>src/include/serif/utils/serialize/solver.hpp</label>
<link refid="utils_2serialize_2solver_8hpp"/>
<childnode refid="54" relation="include">
</childnode>
</node>
<node id="32">
<label>src/lib/serif/backend/mfem/model/finite_elements.cpp</label>
<link refid="lib_2serif_2backend_2mfem_2model_2finite__elements_8cpp"/>
</node>
<node id="47">
<label>src/lib/serif/backend/mfem/model/system_selection.cpp</label>
<link refid="system__selection_8cpp"/>
</node>
<node id="56">
<label>src/lib/serif/discretization/quadrature/policy.cpp</label>
<link refid="policy_8cpp"/>
</node>
</invincdepgraph>
<innernamespace refid="namespaceserif">serif</innernamespace>
<innernamespace refid="namespaceserif_1_1discretization">serif::discretization</innernamespace>
<innernamespace refid="namespaceserif_1_1discretization_1_1forms">serif::discretization::forms</innernamespace>
<briefdescription>
<para>This file defines concepts for forms in the discretization framework. </para>
</briefdescription>
<detaileddescription>
<para><simplesect kind="author"><para>Emily M. Boudreaux </para>
</simplesect>
</para>
</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="8"><highlight class="normal"></highlight></codeline>
<codeline lineno="9"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&quot;<ref refid="forms_8hpp" kindref="compound">serif/discretization/forms/forms.hpp</ref>&quot;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="10"><highlight class="normal"></highlight></codeline>
<codeline lineno="11" refid="namespaceserif_1_1discretization_1_1forms" refkind="compound"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceserif_1_1discretization_1_1forms" kindref="compound">serif::discretization::forms</ref><sp/>{</highlight></codeline>
<codeline lineno="17"><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/>FormCand</highlight><highlight class="keywordtype">id</highlight><highlight class="normal">ate&gt;</highlight></codeline>
<codeline lineno="18" refid="conceptserif_1_1discretization_1_1forms_1_1_form" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">concept<sp/></highlight><highlight class="normal"><ref refid="conceptserif_1_1discretization_1_1forms_1_1_form" kindref="compound">Form</ref><sp/>=<sp/>std::derived_from&lt;std::remove_cvref_t&lt;FormCandidate&gt;,<sp/><ref refid="structserif_1_1discretization_1_1forms_1_1form" kindref="compound">form</ref>&gt;<sp/>&amp;&amp;<sp/></highlight><highlight class="comment">//<sp/>A<sp/>form<sp/>must<sp/>derive<sp/>from<sp/>form</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="19"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">requires</highlight><highlight class="normal"><sp/>{</highlight></codeline>
<codeline lineno="20"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">typename</highlight><highlight class="normal"><sp/>std::remove_cvref_t&lt;FormCandidate&gt;::operand_types;<sp/></highlight><highlight class="comment">//<sp/>a<sp/>form<sp/>must<sp/>define<sp/>a<sp/>type<sp/>list<sp/>of<sp/>operand<sp/>types<sp/>for<sp/>the<sp/>trial<sp/>and<sp/>test<sp/>terms</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="21"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>};</highlight></codeline>
<codeline lineno="22"><highlight class="normal">}</highlight></codeline>
</programlisting>
<location file="src/include/serif/discretization/forms/concept.hpp"/>
</compounddef>
</doxygen>