Emily Boudreaux
6b57738330
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)
930 lines
53 KiB
XML
930 lines
53 KiB
XML
<?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_1model_1_1detail" kind="namespace" language="C++">
|
|
<compoundname>serif::model::detail</compoundname>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_arguments_match" prot="public">serif::model::detail::ArgumentsMatch</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_arguments_match_3_01utils_1_1types_1_1_type_list_3_01_specifi01658b4335377da22d90e0eb31cddca8" prot="public">serif::model::detail::ArgumentsMatch< utils::types::TypeList< Specifications... >, Arguments... ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_canonical_specifications" prot="public">serif::model::detail::CanonicalSpecifications</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_canonical_specifications_3_01_head_00_01_tail_8_8_8_01_4" prot="public">serif::model::detail::CanonicalSpecifications< Head, Tail... ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_canonical_specifications_3_4" prot="public">serif::model::detail::CanonicalSpecifications<></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_cartesian_couplings" prot="public">serif::model::detail::CartesianCouplings</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_cartesian_couplings_3_01utils_1_1dependencies_1_1_key_list_3_1aeac7cb8e4197c8efc3cb5c64082687" prot="public">serif::model::detail::CartesianCouplings< utils::dependencies::KeyList< Rows... >, utils::dependencies::KeyList< Fields... > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_endpoint_owner" prot="public">serif::model::detail::EndpointOwner</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_endpoint_owner_3_01_constraint_of_3_01_specification_01_4_01_4" prot="public">serif::model::detail::EndpointOwner< ConstraintOf< Specification > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_endpoint_owner_3_01_generated_coordinate_of_3_01_specification_01_4_01_4" prot="public">serif::model::detail::EndpointOwner< GeneratedCoordinateOf< Specification > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_enforcement_dependencies" prot="public">serif::model::detail::EnforcementDependencies</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_enforcement_dependencies_3_01_specification_00_01_bindings_00_01true_01_4" prot="public">serif::model::detail::EnforcementDependencies< Specification, Bindings, true ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_equation_couplings" prot="public">serif::model::detail::EquationCouplings</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_equation_couplings_3_01_equation_00_01utils_1_1types_1_1_typef24c48fc52ee458347e39dd0b9bd8b4f" prot="public">serif::model::detail::EquationCouplings< Equation, utils::types::TypeList< Columns... > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_equilibrium_couplings" prot="public">serif::model::detail::EquilibriumCouplings</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_execution_inputs" prot="public">serif::model::detail::ExecutionInputs</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_execution_inputs_3_01_plan_00_01std_1_1void__t_3_01typename_0fa90771a73a9f7619c8ad46d39189df1" prot="public">serif::model::detail::ExecutionInputs< Plan, std::void_t< typename Plan::PhysicalInputs, typename Plan::InactiveRows > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_execution_surface" prot="public">serif::model::detail::ExecutionSurface</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_execution_surface_3_01_plan_00_01std_1_1void__t_3_01typename_01_plan_1_1_surface_01_4_01_4" prot="public">serif::model::detail::ExecutionSurface< Plan, std::void_t< typename Plan::Surface > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_insert_specification" prot="public">serif::model::detail::InsertSpecification</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_insert_specification_3_01_specification_00_01utils_1_1types_1c291e9ffd6f22f760258a73ade9a49a2" prot="public">serif::model::detail::InsertSpecification< Specification, utils::types::TypeList< Head, Tail... > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_insert_specification_3_01_specification_00_01utils_1_1types_1_1_type_list_3_4_01_4" prot="public">serif::model::detail::InsertSpecification< Specification, utils::types::TypeList<> ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_interior_couplings" prot="public">serif::model::detail::InteriorCouplings</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_interior_couplings_3_01equations_1_1_equation_registry_3_01_equations_8_8_8_01_4_01_4" prot="public">serif::model::detail::InteriorCouplings< equations::EquationRegistry< Equations... > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_interior_plan" prot="public">serif::model::detail::InteriorPlan</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_interior_plan_3_01equations_1_1_equation_registry_3_01_equations_8_8_8_01_4_01_4" prot="public">serif::model::detail::InteriorPlan< equations::EquationRegistry< Equations... > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_operand_terms" prot="public">serif::model::detail::OperandTerms</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_operand_terms_3_01utils_1_1types_1_1_type_list_3_01_operands_8_8_8_01_4_01_4" prot="public">serif::model::detail::OperandTerms< utils::types::TypeList< Operands... > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_preferred_surface_field" prot="public">serif::model::detail::PreferredSurfaceField</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_preferred_surface_field_3_01utils_1_1types_1_1_type_list_3_01_equations_8_8_8_01_4_01_4" prot="public">serif::model::detail::PreferredSurfaceField< utils::types::TypeList< Equations... > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_remove_keys" prot="public">serif::model::detail::RemoveKeys</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_remove_keys_3_01utils_1_1dependencies_1_1_key_list_3_01_keys_8_8_8_01_4_00_01_excluded_01_4" prot="public">serif::model::detail::RemoveKeys< utils::dependencies::KeyList< Keys... >, Excluded ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_resolved_endpoints" prot="public">serif::model::detail::ResolvedEndpoints</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_resolved_endpoints_3_01_owner_00_01utils_1_1types_1_1_type_li2430ab0d86fbd9154758559351ff5179" prot="public">serif::model::detail::ResolvedEndpoints< Owner, utils::types::TypeList< Endpoints... >, Bindings ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_resolved_specification" prot="public">serif::model::detail::ResolvedSpecification</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_selected_surface" prot="public">serif::model::detail::SelectedSurface</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_selected_surface_3_01_selection_00_01true_01_4" prot="public">serif::model::detail::SelectedSurface< Selection, true ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_select_role" prot="public">serif::model::detail::SelectRole</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_shape_plan" prot="public">serif::model::detail::ShapePlan</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_shape_plan_3_01equations_1_1_surface_potential_balance_01_4" prot="public">serif::model::detail::ShapePlan< equations::SurfacePotentialBalance ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_shape_plan_3_01_no_shape_force_01_4" prot="public">serif::model::detail::ShapePlan< NoShapeForce ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_surface_field_hint" prot="public">serif::model::detail::SurfaceFieldHint</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_surface_field_hint_3_01_equation_00_01std_1_1void__t_3_01type0e58d367727b7b3084f1cfe820566d9f" prot="public">serif::model::detail::SurfaceFieldHint< Equation, std::void_t< typename Equation::IsobaricSurfaceField > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_surface_plan" prot="public">serif::model::detail::SurfacePlan</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_surface_plan_3_01geometry_1_1surface_1_1_isobaric_00_01_e_o_sc18450578bb69caecc44a2508508062a" prot="public">serif::model::detail::SurfacePlan< geometry::surface::Isobaric, EOS, Fields, Rows, Solved, Equations ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_surface_plan_3_01_no_surface_condition_00_01_e_o_s_00_01_fielcaee9a8d3b4dcc205ef196d9b381bcd3" prot="public">serif::model::detail::SurfacePlan< NoSurfaceCondition, EOS, Fields, Rows, Solved, Equations ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_unique_surface_field" prot="public">serif::model::detail::UniqueSurfaceField</innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_unique_surface_field_3_01utils_1_1dependencies_1_1_key_list_3f358c046cdb6902eb06450605014909a" prot="public">serif::model::detail::UniqueSurfaceField< utils::dependencies::KeyList< Field, Others... > ></innerclass>
|
|
<innerclass refid="structserif_1_1model_1_1detail_1_1_unique_surface_field_3_01utils_1_1dependencies_1_1_key_list_3_4_01_4" prot="public">serif::model::detail::UniqueSurfaceField< utils::dependencies::KeyList<> ></innerclass>
|
|
<sectiondef kind="typedef">
|
|
<memberdef kind="typedef" id="namespaceserif_1_1model_1_1detail_1ae427ccffd89556bd768fed6b07d0172a" prot="public" static="no">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Specification</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>std::bool_constant< Specification::ModelDefinition::generated_state_kind !=<ref refid="namespaceserif_1_1model_1a9dbd561b48b9cbb817a4102517d065caa334c4a4c42fdb79d7ebc3e73b517e6f8" kindref="member">GeneratedStateKind::none</ref> ></type>
|
|
<definition>using serif::model::detail::GeneratesState = std::bool_constant<Specification::ModelDefinition::generated_state_kind != GeneratedStateKind::none></definition>
|
|
<argsstring></argsstring>
|
|
<name>GeneratesState</name>
|
|
<qualifiedname>serif::model::detail::GeneratesState</qualifiedname>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/detail/specification_endpoints.hpp" line="12" column="5" bodyfile="src/include/serif/model/detail/specification_endpoints.hpp" bodystart="12" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="typedef" id="namespaceserif_1_1model_1_1detail_1a7dc206380569e07235666a9efbe09756" prot="public" static="no">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Model</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type><ref refid="namespaceserif_1_1utils_1_1misc_1_1concepts_1a7f4d5acf6ecfec39214a93e40c82bbf7" kindref="member">utils::misc::concepts::FilterT</ref>< typename Model::SpecificationTypes, <ref refid="namespaceserif_1_1model_1_1detail_1ae427ccffd89556bd768fed6b07d0172a" kindref="member">GeneratesState</ref> ></type>
|
|
<definition>using serif::model::detail::GeneratedSpecifications = utils::misc::concepts::FilterT<typename Model::SpecificationTypes, GeneratesState></definition>
|
|
<argsstring></argsstring>
|
|
<name>GeneratedSpecifications</name>
|
|
<qualifiedname>serif::model::detail::GeneratedSpecifications</qualifiedname>
|
|
<briefdescription>
|
|
<para>Numerical checks operate only on prescriptions that introduce a coordinate and equation. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/detail/specification_endpoints.hpp" line="16" column="5" bodyfile="src/include/serif/model/detail/specification_endpoints.hpp" bodystart="16" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="typedef" id="namespaceserif_1_1model_1_1detail_1a47f2eeb5ccf35b63be85b56181ca52f2" prot="public" static="no">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Owner</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Endpoint</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Bindings</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>typename decltype(<ref refid="namespaceserif_1_1model_1_1detail_1a9505ea2d4e0316e88ebfb5b9bed66546" kindref="member">resolved_endpoint</ref>< Owner, Endpoint, Bindings >())::type</type>
|
|
<definition>using serif::model::detail::ResolvedEndpoint = typename decltype(resolved_endpoint<Owner, Endpoint, Bindings>())::type</definition>
|
|
<argsstring></argsstring>
|
|
<name>ResolvedEndpoint</name>
|
|
<qualifiedname>serif::model::detail::ResolvedEndpoint</qualifiedname>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/detail/specification_endpoints.hpp" line="64" column="5" bodyfile="src/include/serif/model/detail/specification_endpoints.hpp" bodystart="64" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="var">
|
|
<memberdef kind="variable" id="namespaceserif_1_1model_1_1detail_1a554c794ba8dc7ba3a4a6e7dffd031515" prot="public" static="no" constexpr="yes" mutable="no">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Candidate</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::is_equilibrium_equations</definition>
|
|
<argsstring></argsstring>
|
|
<name>is_equilibrium_equations</name>
|
|
<qualifiedname>serif::model::detail::is_equilibrium_equations</qualifiedname>
|
|
<initializer>= false</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/equilibrium_equations.hpp" line="45" column="31" bodyfile="src/include/serif/model/equilibrium_equations.hpp" bodystart="45" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="namespaceserif_1_1model_1_1detail_1ac3085cd4e8cd8539adb985bc8c4036ea" prot="public" static="no" constexpr="yes" mutable="no">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Interior</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Shape</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Surface</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::is_equilibrium_equations< EquilibriumEquations< Interior, Shape, Surface > ></definition>
|
|
<argsstring></argsstring>
|
|
<name>is_equilibrium_equations< EquilibriumEquations< Interior, Shape, Surface > ></name>
|
|
<qualifiedname>serif::model::detail::is_equilibrium_equations< EquilibriumEquations< Interior, Shape, Surface > ></qualifiedname>
|
|
<initializer>= true</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/equilibrium_equations.hpp" line="48" column="26" bodyfile="src/include/serif/model/equilibrium_equations.hpp" bodystart="48" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="namespaceserif_1_1model_1_1detail_1a4a7f81eee6f624fa023ae185500c3af7" prot="public" static="no" constexpr="yes" mutable="no">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Candidate</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::is_type_list</definition>
|
|
<argsstring></argsstring>
|
|
<name>is_type_list</name>
|
|
<qualifiedname>serif::model::detail::is_type_list</qualifiedname>
|
|
<initializer>= false</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/specification.hpp" line="83" column="31" bodyfile="src/include/serif/model/specification.hpp" bodystart="83" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="namespaceserif_1_1model_1_1detail_1a326ac931281a47b95c3caabb1698e95a" prot="public" static="no" constexpr="yes" mutable="no">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Types</declname>
|
|
<defname>Types</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::is_type_list< utils::types::TypeList< Types... > ></definition>
|
|
<argsstring></argsstring>
|
|
<name>is_type_list< utils::types::TypeList< Types... > ></name>
|
|
<qualifiedname>serif::model::detail::is_type_list< utils::types::TypeList< Types... > ></qualifiedname>
|
|
<initializer>= true</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/specification.hpp" line="86" column="26" bodyfile="src/include/serif/model/specification.hpp" bodystart="86" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="namespaceserif_1_1model_1_1detail_1a15ddc69724e0cdfa4f5016a76d0a667a" prot="public" static="no" constexpr="yes" mutable="no">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Candidate</type>
|
|
</param>
|
|
<param>
|
|
<type>typename</type>
|
|
<defval>void</defval>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::is_stellar_model</definition>
|
|
<argsstring></argsstring>
|
|
<name>is_stellar_model</name>
|
|
<qualifiedname>serif::model::detail::is_stellar_model</qualifiedname>
|
|
<initializer>= false</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/stellar_model.hpp" line="157" column="31" bodyfile="src/include/serif/model/stellar_model.hpp" bodystart="157" bodyend="-1"/>
|
|
</memberdef>
|
|
<memberdef kind="variable" id="namespaceserif_1_1model_1_1detail_1aa9b201f33788ccc4b6386d76f645e554" prot="public" static="no" constexpr="yes" mutable="no">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename EOS</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Definition</type>
|
|
</param>
|
|
<param>
|
|
<type>typename List</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::is_stellar_model< StellarModel< EOS, Definition, List >, std::void_t< typename StellarModel< EOS, Definition, List >::SpecificationTypes > ></definition>
|
|
<argsstring></argsstring>
|
|
<name>is_stellar_model< StellarModel< EOS, Definition, List >, std::void_t< typename StellarModel< EOS, Definition, List >::SpecificationTypes > ></name>
|
|
<qualifiedname>serif::model::detail::is_stellar_model< StellarModel< EOS, Definition, List >, std::void_t< typename StellarModel< EOS, Definition, List >::SpecificationTypes > ></qualifiedname>
|
|
<initializer>= true</initializer>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/stellar_model.hpp" line="160" column="26" bodyfile="src/include/serif/model/stellar_model.hpp" bodystart="160" bodyend="-1"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<sectiondef kind="func">
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1a1913d9c0eef4efd5fef3eef1c1f097de" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Layout</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Owner</type>
|
|
</param>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>ContributionKeys</declname>
|
|
<defname>ContributionKeys</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>auto</type>
|
|
<definition>auto serif::model::detail::physical_system_computation</definition>
|
|
<argsstring>(Layout layout, std::shared_ptr< const Owner > owner, utils::dependencies::KeyList< ContributionKeys... >)</argsstring>
|
|
<name>physical_system_computation</name>
|
|
<qualifiedname>serif::model::detail::physical_system_computation</qualifiedname>
|
|
<param>
|
|
<type>Layout</type>
|
|
<declname>layout</declname>
|
|
</param>
|
|
<param>
|
|
<type>std::shared_ptr< const Owner ></type>
|
|
<declname>owner</declname>
|
|
</param>
|
|
<param>
|
|
<type><ref refid="structserif_1_1utils_1_1dependencies_1_1_key_list" kindref="compound">utils::dependencies::KeyList</ref>< ContributionKeys... ></type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Collect all additions before applying any boundary replacement. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/model/graph.hpp" line="23" column="15" bodyfile="src/include/serif/backend/mfem/model/graph.hpp" bodystart="23" bodyend="49"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1ae83ec19dfdc74cef1e310754e1fc7d12" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Equations</declname>
|
|
<defname>Equations</defname>
|
|
</param>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Additional</declname>
|
|
<defname>Additional</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>auto</type>
|
|
<definition>auto serif::model::detail::contribution_keys</definition>
|
|
<argsstring>(utils::types::TypeList< Equations... >, utils::dependencies::KeyList< Additional... >)</argsstring>
|
|
<name>contribution_keys</name>
|
|
<qualifiedname>serif::model::detail::contribution_keys</qualifiedname>
|
|
<param>
|
|
<type><ref refid="structserif_1_1utils_1_1types_1_1_type_list" kindref="compound">utils::types::TypeList</ref>< Equations... ></type>
|
|
</param>
|
|
<param>
|
|
<type><ref refid="structserif_1_1utils_1_1dependencies_1_1_key_list" kindref="compound">utils::dependencies::KeyList</ref>< Additional... ></type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Every interior equation contributes once; extension keys identify explicit additions or replacements. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/model/graph.hpp" line="53" column="25" bodyfile="src/include/serif/backend/mfem/model/graph.hpp" bodystart="53" bodyend="55"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1ac05e8685fe7931d74aec47a2fad22331" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Registry</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Discretization</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Layout</type>
|
|
</param>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Equations</declname>
|
|
<defname>Equations</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>auto</type>
|
|
<definition>auto serif::model::detail::interior_computations</definition>
|
|
<argsstring>(const std::shared_ptr< const Registry > &registry, const Discretization &discretization, const Layout &layout, operators::backend::mfem::VolumeOptions options, utils::types::TypeList< Equations... >)</argsstring>
|
|
<name>interior_computations</name>
|
|
<qualifiedname>serif::model::detail::interior_computations</qualifiedname>
|
|
<param>
|
|
<type>const std::shared_ptr< const Registry > &</type>
|
|
<declname>registry</declname>
|
|
</param>
|
|
<param>
|
|
<type>const Discretization &</type>
|
|
<declname>discretization</declname>
|
|
</param>
|
|
<param>
|
|
<type>const Layout &</type>
|
|
<declname>layout</declname>
|
|
</param>
|
|
<param>
|
|
<type><ref refid="structserif_1_1operators_1_1backend_1_1mfem_1_1_volume_options" kindref="compound">operators::backend::mfem::VolumeOptions</ref></type>
|
|
<declname>options</declname>
|
|
</param>
|
|
<param>
|
|
<type><ref refid="structserif_1_1utils_1_1types_1_1_type_list" kindref="compound">utils::types::TypeList</ref>< Equations... ></type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Share each immutable equation with its volume graph, then publish one complete row contribution. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/model/graph.hpp" line="59" column="15" bodyfile="src/include/serif/backend/mfem/model/graph.hpp" bodystart="59" bodyend="65"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1a97a157a31fd3f1ab1b0277bd7f2ebcba" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Bound</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Layout</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>auto</type>
|
|
<definition>auto serif::model::detail::shape_computations</definition>
|
|
<argsstring>(const std::shared_ptr< const Bound > &bound, const Layout &layout)</argsstring>
|
|
<name>shape_computations</name>
|
|
<qualifiedname>serif::model::detail::shape_computations</qualifiedname>
|
|
<param>
|
|
<type>const std::shared_ptr< const Bound > &</type>
|
|
<declname>bound</declname>
|
|
</param>
|
|
<param>
|
|
<type>const Layout &</type>
|
|
<declname>layout</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>One shared deformation feeds all geometry derivatives and the surface-potential shape row. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/model/graph.hpp" line="103" column="15" bodyfile="src/include/serif/backend/mfem/model/graph.hpp" bodystart="103" bodyend="119"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1af3b51c0962e8dfbe23c9f31450df4aee" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Bound</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Layout</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>auto</type>
|
|
<definition>auto serif::model::detail::boundary_computations</definition>
|
|
<argsstring>(const Bound &, const Layout &layout)</argsstring>
|
|
<name>boundary_computations</name>
|
|
<qualifiedname>serif::model::detail::boundary_computations</qualifiedname>
|
|
<param>
|
|
<type>const Bound &</type>
|
|
</param>
|
|
<param>
|
|
<type>const Layout &</type>
|
|
<declname>layout</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Sample the internally selected pressure formulation through its compiled traces. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/model/graph.hpp" line="123" column="15" bodyfile="src/include/serif/backend/mfem/model/graph.hpp" bodystart="123" bodyend="133"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1aabda0aaee8d4b1e56058c6429d72332c" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Plan</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>auto</type>
|
|
<definition>auto serif::model::detail::equilibrium_contribution_keys</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>equilibrium_contribution_keys</name>
|
|
<qualifiedname>serif::model::detail::equilibrium_contribution_keys</qualifiedname>
|
|
<briefdescription>
|
|
<para>Name exactly the explicitly selected non-interior contributions to final assembly. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/backend/mfem/model/graph.hpp" line="137" column="25" bodyfile="src/include/serif/backend/mfem/model/graph.hpp" bodystart="137" bodyend="144"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1a9505ea2d4e0316e88ebfb5b9bed66546" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Owner</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Endpoint</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Bindings</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>auto</type>
|
|
<definition>auto serif::model::detail::resolved_endpoint</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>resolved_endpoint</name>
|
|
<qualifiedname>serif::model::detail::resolved_endpoint</qualifiedname>
|
|
<briefdescription>
|
|
<para>Resolve owned aliases and explicit bindings without merging same-unit identities. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/detail/specification_endpoints.hpp" line="28" column="21" bodyfile="src/include/serif/model/detail/specification_endpoints.hpp" bodystart="28" bodyend="61"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1abfcd2310778365acc2776af95c1e26de" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Model</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Endpoint</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::endpoint_owner_present</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>endpoint_owner_present</name>
|
|
<qualifiedname>serif::model::detail::endpoint_owner_present</qualifiedname>
|
|
<briefdescription>
|
|
<para>A coordinate binding cannot supply an absent or non-generating physical prescription. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/detail/specification_endpoints.hpp" line="68" column="21" bodyfile="src/include/serif/model/detail/specification_endpoints.hpp" bodystart="68" bodyend="75"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1a42e8407c9abb7f9e35c5f78f3f648c10" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>ModelSpecification</type>
|
|
<declname>Left</declname>
|
|
<defname>Left</defname>
|
|
</param>
|
|
<param>
|
|
<type>ModelSpecification</type>
|
|
<declname>Right</declname>
|
|
<defname>Right</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::specification_precedes</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>specification_precedes</name>
|
|
<qualifiedname>serif::model::detail::specification_precedes</qualifiedname>
|
|
<briefdescription>
|
|
<para>Compare physical identities in the historical role, coordinate-kind, stable-name order. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/detail/specification_list.hpp" line="13" column="21" bodyfile="src/include/serif/model/detail/specification_list.hpp" bodystart="13" bodyend="18"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1a8d010db5ddd840267eb5115b39546188" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>ModelSpecification...</type>
|
|
<declname>Specifications</declname>
|
|
<defname>Specifications</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::unique_specification_names</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>unique_specification_names</name>
|
|
<qualifiedname>serif::model::detail::unique_specification_names</qualifiedname>
|
|
<briefdescription>
|
|
<para>Reject semantic collisions even when two prescriptions have different C++ types or scalar kinds. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/detail/specification_list.hpp" line="53" column="21" bodyfile="src/include/serif/model/detail/specification_list.hpp" bodystart="53" bodyend="69"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1ad8854bd3348b3d8bd01f8758adfec8d8" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Specifications</declname>
|
|
<defname>Specifications</defname>
|
|
</param>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Arguments</declname>
|
|
<defname>Arguments</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>std::tuple< Specifications... ></type>
|
|
<definition>std::tuple< Specifications... > serif::model::detail::canonical_specifications</definition>
|
|
<argsstring>(utils::types::TypeList< Specifications... >, Arguments &&... arguments)</argsstring>
|
|
<name>canonical_specifications</name>
|
|
<qualifiedname>serif::model::detail::canonical_specifications</qualifiedname>
|
|
<param>
|
|
<type><ref refid="structserif_1_1utils_1_1types_1_1_type_list" kindref="compound">utils::types::TypeList</ref>< Specifications... ></type>
|
|
</param>
|
|
<param>
|
|
<type>Arguments &&...</type>
|
|
<declname>arguments</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Consume the argument tuple once, moving each specification into its canonical slot once. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/detail/specification_list.hpp" line="92" column="17" bodyfile="src/include/serif/model/detail/specification_list.hpp" bodystart="92" bodyend="96"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1a16f3eb10a3c11e985ea40a4845ab3bdc" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Definition</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Model</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>decltype(auto)</type>
|
|
<definition>decltype(auto) serif::model::detail::resolve_equation_member</definition>
|
|
<argsstring>(Definition &&definition, const Model &model)</argsstring>
|
|
<name>resolve_equation_member</name>
|
|
<qualifiedname>serif::model::detail::resolve_equation_member</qualifiedname>
|
|
<param>
|
|
<type>Definition &&</type>
|
|
<declname>definition</declname>
|
|
</param>
|
|
<param>
|
|
<type>const Model &</type>
|
|
<declname>model</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Evaluate a physical definition or retain its immutable object without requiring a copy. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/equilibrium_equations.hpp" line="52" column="19" bodyfile="src/include/serif/model/equilibrium_equations.hpp" bodystart="52" bodyend="66"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1a7cda9f3b910ea61b555ca6936a8cd3f0" prot="public" static="no" nodiscard="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Definition</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Model</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>auto</type>
|
|
<definition>auto serif::model::detail::resolve_equation_members</definition>
|
|
<argsstring>(Definition &&definition, const Model &model)</argsstring>
|
|
<name>resolve_equation_members</name>
|
|
<qualifiedname>serif::model::detail::resolve_equation_members</qualifiedname>
|
|
<param>
|
|
<type>Definition &&</type>
|
|
<declname>definition</declname>
|
|
</param>
|
|
<param>
|
|
<type>const Model &</type>
|
|
<declname>model</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Resolve each explicit part, owning temporary results and borrowing unchanged model members. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/equilibrium_equations.hpp" line="70" column="15" bodyfile="src/include/serif/model/equilibrium_equations.hpp" bodystart="70" bodyend="81"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1afb30e6c6a4f8c30445f235bba5d44413" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>DimensionalScalarSpecification</type>
|
|
<declname>Specification</declname>
|
|
<defname>Specification</defname>
|
|
</param>
|
|
<param>
|
|
<type>typename Rows</type>
|
|
</param>
|
|
<param>
|
|
<type>typename InactiveRows</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Actual</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Bindings</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::generated_physics_is_present</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>generated_physics_is_present</name>
|
|
<qualifiedname>serif::model::detail::generated_physics_is_present</qualifiedname>
|
|
<briefdescription>
|
|
<para>Demand an explicitly supplied generated equation and effect before inferring closed-row zeros. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/execution_validation.hpp" line="47" column="25" bodyfile="src/include/serif/model/execution_validation.hpp" bodystart="47" bodyend="55"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1a277ce1ffbd3bd2cc6afee1f566484846" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Rows</type>
|
|
</param>
|
|
<param>
|
|
<type>typename InactiveRows</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Actual</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Bindings</type>
|
|
</param>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Specifications</declname>
|
|
<defname>Specifications</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::generated_physics_are_present</definition>
|
|
<argsstring>(utils::types::TypeList< Specifications... >)</argsstring>
|
|
<name>generated_physics_are_present</name>
|
|
<qualifiedname>serif::model::detail::generated_physics_are_present</qualifiedname>
|
|
<param>
|
|
<type><ref refid="structserif_1_1utils_1_1types_1_1_type_list" kindref="compound">utils::types::TypeList</ref>< Specifications... ></type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Check only numerical-provider admission; physical endpoint ownership is checked separately. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/execution_validation.hpp" line="59" column="25" bodyfile="src/include/serif/model/execution_validation.hpp" bodystart="59" bodyend="62"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1adcfc1df7cc2e1114d6d15b41fee9b712" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Rows</type>
|
|
</param>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Required</declname>
|
|
<defname>Required</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::equation_rows_exist</definition>
|
|
<argsstring>(utils::dependencies::KeyList< Required... >)</argsstring>
|
|
<name>equation_rows_exist</name>
|
|
<qualifiedname>serif::model::detail::equation_rows_exist</qualifiedname>
|
|
<param>
|
|
<type><ref refid="structserif_1_1utils_1_1dependencies_1_1_key_list" kindref="compound">utils::dependencies::KeyList</ref>< Required... ></type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Every surface carrier must have an equation row in the selected layout. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/execution_validation.hpp" line="66" column="25" bodyfile="src/include/serif/model/execution_validation.hpp" bodystart="66" bodyend="69"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1a63cb8dc552f2d77e4cd94e95ab5632a1" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::compatible_generated_state</definition>
|
|
<argsstring>(SpecificationRole role, GeneratedStateKind kind)</argsstring>
|
|
<name>compatible_generated_state</name>
|
|
<qualifiedname>serif::model::detail::compatible_generated_state</qualifiedname>
|
|
<param>
|
|
<type><ref refid="namespaceserif_1_1model_1a80cb843c4b97c06905b775aba9d4b813" kindref="member">SpecificationRole</ref></type>
|
|
<declname>role</declname>
|
|
</param>
|
|
<param>
|
|
<type><ref refid="namespaceserif_1_1model_1a9dbd561b48b9cbb817a4102517d065ca" kindref="member">GeneratedStateKind</ref></type>
|
|
<declname>kind</declname>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Reject unknown enums and mismatched physical roles before inspecting optional scalar metadata. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/specification.hpp" line="65" column="25" bodyfile="src/include/serif/model/specification.hpp" bodystart="65" bodyend="80"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1aae26e7579ddb1668e7abef12a8c70067" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>DimensionalScalarSpecification</type>
|
|
<declname>Specification</declname>
|
|
<defname>Specification</defname>
|
|
</param>
|
|
<param>
|
|
<type>typename Model</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Values</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Inputs</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Rows</type>
|
|
</param>
|
|
<param>
|
|
<type>typename InactiveRows</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Bindings</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::valid_specification_endpoints</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>valid_specification_endpoints</name>
|
|
<qualifiedname>serif::model::detail::valid_specification_endpoints</qualifiedname>
|
|
<briefdescription>
|
|
<para>Check physical inputs separately from unknowns and explicitly inactive equations. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/validation.hpp" line="52" column="25" bodyfile="src/include/serif/model/validation.hpp" bodystart="52" bodyend="66"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1ad2113b4e1a949598fc2f7be37f1c0927" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Model</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Values</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Inputs</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Rows</type>
|
|
</param>
|
|
<param>
|
|
<type>typename InactiveRows</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Bindings</type>
|
|
</param>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Specifications</declname>
|
|
<defname>Specifications</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::valid_specifications</definition>
|
|
<argsstring>(utils::types::TypeList< Specifications... >)</argsstring>
|
|
<name>valid_specifications</name>
|
|
<qualifiedname>serif::model::detail::valid_specifications</qualifiedname>
|
|
<param>
|
|
<type><ref refid="structserif_1_1utils_1_1types_1_1_type_list" kindref="compound">utils::types::TypeList</ref>< Specifications... ></type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Fold independent physical declarations; no equation counting or rank inference is involved. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/validation.hpp" line="70" column="25" bodyfile="src/include/serif/model/validation.hpp" bodystart="70" bodyend="89"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1a17b67ad43340da0fcbb5688d6b90e9a1" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>DimensionalScalarSpecification</type>
|
|
<declname>Specification</declname>
|
|
<defname>Specification</defname>
|
|
</param>
|
|
<param>
|
|
<type>typename Couplings</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Bindings</type>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::specification_derivatives_available</definition>
|
|
<argsstring>()</argsstring>
|
|
<name>specification_derivatives_available</name>
|
|
<qualifiedname>serif::model::detail::specification_derivatives_available</qualifiedname>
|
|
<briefdescription>
|
|
<para>Validate declared derivative contracts without inferring zeros from missing providers. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/validation.hpp" line="93" column="25" bodyfile="src/include/serif/model/validation.hpp" bodystart="93" bodyend="105"/>
|
|
</memberdef>
|
|
<memberdef kind="function" id="namespaceserif_1_1model_1_1detail_1a0d6ab5f248c85c95fd813dbb801fe90d" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" virt="non-virtual">
|
|
<templateparamlist>
|
|
<param>
|
|
<type>typename Couplings</type>
|
|
</param>
|
|
<param>
|
|
<type>typename Bindings</type>
|
|
</param>
|
|
<param>
|
|
<type>typename...</type>
|
|
<declname>Specifications</declname>
|
|
<defname>Specifications</defname>
|
|
</param>
|
|
</templateparamlist>
|
|
<type>bool</type>
|
|
<definition>bool serif::model::detail::specification_derivatives_available</definition>
|
|
<argsstring>(utils::types::TypeList< Specifications... >)</argsstring>
|
|
<name>specification_derivatives_available</name>
|
|
<qualifiedname>serif::model::detail::specification_derivatives_available</qualifiedname>
|
|
<param>
|
|
<type><ref refid="structserif_1_1utils_1_1types_1_1_type_list" kindref="compound">utils::types::TypeList</ref>< Specifications... ></type>
|
|
</param>
|
|
<briefdescription>
|
|
<para>Check each prescription against independently supplied derivative registrations. </para>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<inbodydescription>
|
|
</inbodydescription>
|
|
<location file="src/include/serif/model/validation.hpp" line="109" column="25" bodyfile="src/include/serif/model/validation.hpp" bodystart="109" bodyend="112"/>
|
|
</memberdef>
|
|
</sectiondef>
|
|
<briefdescription>
|
|
</briefdescription>
|
|
<detaileddescription>
|
|
</detaileddescription>
|
|
<location file="src/include/serif/backend/mfem/model/graph.hpp" line="20" column="5"/>
|
|
</compounddef>
|
|
</doxygen>
|