Files
MeanField_SERiF/docs/xml/namespaceserif_1_1discretization_1_1domain.xml

179 lines
12 KiB
XML
Raw Normal View History

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.13.2" xml:lang="en-US">
<compounddef id="namespaceserif_1_1discretization_1_1domain" kind="namespace" language="C++">
<compoundname>serif::discretization::domain</compoundname>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_boundary" prot="public">serif::discretization::domain::Boundary</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_boundary_i_d_resolver" prot="public">serif::discretization::domain::BoundaryIDResolver</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_boundary_i_d_resolver_3_01_boundary_set_3_01_boundardf0745416ccea48cae2813336cb4fa51" prot="public">serif::discretization::domain::BoundaryIDResolver&lt; BoundarySet&lt; BoundaryTs... &gt;, ids::lists::BoundaryIDList&lt; BoundaryIDTs... &gt; &gt;</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_boundary_i_d_resolver_3_01_boundary_t_00_01ids_1_1li2689267af648404251e26798b0b9b3b9" prot="public">serif::discretization::domain::BoundaryIDResolver&lt; BoundaryT, ids::lists::BoundaryIDList&lt; BoundaryIDTs... &gt; &gt;</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_boundary_set" prot="public">serif::discretization::domain::BoundarySet</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_core_domain" prot="public">serif::discretization::domain::CoreDomain</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_domain" prot="public">serif::discretization::domain::Domain</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_domain_i_d_resolver" prot="public">serif::discretization::domain::DomainIDResolver</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_domain_i_d_resolver_3_01_domain_set_3_01_domain_ts_87d2a0f186034cba3e08f075159f6c5aa" prot="public">serif::discretization::domain::DomainIDResolver&lt; DomainSet&lt; DomainTs... &gt;, ids::lists::DomainIDList&lt; DomainIDTs... &gt; &gt;</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_domain_i_d_resolver_3_01_domain_t_00_01ids_1_1lists_691dc5cdd5bb726ea229a1452241f3d6" prot="public">serif::discretization::domain::DomainIDResolver&lt; DomainT, ids::lists::DomainIDList&lt; DomainIDTs... &gt; &gt;</innerclass>
<innerclass refid="classserif_1_1discretization_1_1domain_1_1_domain_or_set" prot="public">serif::discretization::domain::DomainOrSet</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_domain_or_set_list" prot="public">serif::discretization::domain::DomainOrSetList</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_domain_set" prot="public">serif::discretization::domain::DomainSet</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_envelope_domain" prot="public">serif::discretization::domain::EnvelopeDomain</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_infinity_surface_boundary" prot="public">serif::discretization::domain::InfinitySurfaceBoundary</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_stellar_surface_boundary" prot="public">serif::discretization::domain::StellarSurfaceBoundary</innerclass>
<innerclass refid="structserif_1_1discretization_1_1domain_1_1_vacuum_domain" prot="public">serif::discretization::domain::VacuumDomain</innerclass>
<innernamespace refid="namespaceserif_1_1discretization_1_1domain_1_1ids">serif::discretization::domain::ids</innernamespace>
<innernamespace refid="namespaceserif_1_1discretization_1_1domain_1_1mesh">serif::discretization::domain::mesh</innernamespace>
<innernamespace refid="namespaceserif_1_1discretization_1_1domain_1_1relation">serif::discretization::domain::relation</innernamespace>
<innernamespace refid="namespaceserif_1_1discretization_1_1domain_1_1schema">serif::discretization::domain::schema</innernamespace>
<sectiondef kind="typedef">
<memberdef kind="typedef" id="namespaceserif_1_1discretization_1_1domain_1aa2fd687c5f7b8750fd6980f2a7a77652" prot="public" static="no">
<type><ref refid="structserif_1_1discretization_1_1domain_1_1_domain_set" kindref="compound">DomainSet</ref>&lt; <ref refid="structserif_1_1discretization_1_1domain_1_1_core_domain" kindref="compound">CoreDomain</ref>, <ref refid="structserif_1_1discretization_1_1domain_1_1_envelope_domain" kindref="compound">EnvelopeDomain</ref> &gt;</type>
<definition>using serif::discretization::domain::StellarDomains = DomainSet&lt;CoreDomain, EnvelopeDomain&gt;</definition>
<argsstring></argsstring>
<name>StellarDomains</name>
<qualifiedname>serif::discretization::domain::StellarDomains</qualifiedname>
<briefdescription>
<para>The set of domains that make up the stellar region of the mesh. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/discretization/domain/physical_domains.hpp" line="21" column="5" bodyfile="src/include/serif/discretization/domain/physical_domains.hpp" bodystart="21" bodyend="-1"/>
</memberdef>
<memberdef kind="typedef" id="namespaceserif_1_1discretization_1_1domain_1a46dfe7f95e0184edff495bd82e3d7b5d" prot="public" static="no">
<type><ref refid="structserif_1_1discretization_1_1domain_1_1_domain_set" kindref="compound">DomainSet</ref>&lt; <ref refid="structserif_1_1discretization_1_1domain_1_1_core_domain" kindref="compound">CoreDomain</ref>, <ref refid="structserif_1_1discretization_1_1domain_1_1_envelope_domain" kindref="compound">EnvelopeDomain</ref>, <ref refid="structserif_1_1discretization_1_1domain_1_1_vacuum_domain" kindref="compound">VacuumDomain</ref> &gt;</type>
<definition>using serif::discretization::domain::AllDomains = DomainSet&lt;CoreDomain, EnvelopeDomain, VacuumDomain&gt;</definition>
<argsstring></argsstring>
<name>AllDomains</name>
<qualifiedname>serif::discretization::domain::AllDomains</qualifiedname>
<briefdescription>
<para>The set of all domains in the mesh. </para>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/discretization/domain/physical_domains.hpp" line="22" column="5" bodyfile="src/include/serif/discretization/domain/physical_domains.hpp" bodystart="22" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="var">
<memberdef kind="variable" id="namespaceserif_1_1discretization_1_1domain_1af79faa141025275717dc28e8b3244c31" prot="public" static="no" constexpr="yes" mutable="no">
<templateparamlist>
<param>
<type>typename T</type>
</param>
</templateparamlist>
<type>bool</type>
<definition>bool serif::discretization::domain::is_domain_set_v</definition>
<argsstring></argsstring>
<name>is_domain_set_v</name>
<qualifiedname>serif::discretization::domain::is_domain_set_v</qualifiedname>
<initializer>= false</initializer>
<briefdescription>
<para>A trait to determine if a type is a <ref refid="structserif_1_1discretization_1_1domain_1_1_domain_set" kindref="compound">DomainSet</ref>. This is the default false specialization. </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="templateparam"><parameteritem>
<parameternamelist>
<parametername>T</parametername>
</parameternamelist>
<parameterdescription>
<para>Candidate type to check. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/discretization/domain/concepts.hpp" line="95" column="20" bodyfile="src/include/serif/discretization/domain/concepts.hpp" bodystart="95" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="namespaceserif_1_1discretization_1_1domain_1af8cecaf8fc81e98a8e5fb613c8eca8be" prot="public" static="no" constexpr="yes" mutable="no">
<templateparamlist>
<param>
<type>IsDomain...</type>
<declname>DomainTs</declname>
<defname>DomainTs</defname>
</param>
</templateparamlist>
<type>bool</type>
<definition>bool serif::discretization::domain::is_domain_set_v&lt; DomainSet&lt; DomainTs... &gt; &gt;</definition>
<argsstring></argsstring>
<name>is_domain_set_v&lt; DomainSet&lt; DomainTs... &gt; &gt;</name>
<qualifiedname>serif::discretization::domain::is_domain_set_v&lt; DomainSet&lt; DomainTs... &gt; &gt;</qualifiedname>
<initializer>= true</initializer>
<briefdescription>
<para>A trait to determine if a type is a <ref refid="structserif_1_1discretization_1_1domain_1_1_domain_set" kindref="compound">DomainSet</ref>. This is the true specialization for <ref refid="structserif_1_1discretization_1_1domain_1_1_domain_set" kindref="compound">DomainSet</ref> types. </para>
</briefdescription>
<detaileddescription>
<para><parameterlist kind="templateparam"><parameteritem>
<parameternamelist>
<parametername>DomainTs</parametername>
</parameternamelist>
<parameterdescription>
<para>The domain types that make up the set. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/discretization/domain/concepts.hpp" line="102" column="15" bodyfile="src/include/serif/discretization/domain/concepts.hpp" bodystart="102" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="namespaceserif_1_1discretization_1_1domain_1a5e9d22ad04a3b00122f90cb5ceea35e9" prot="public" static="no" constexpr="yes" mutable="no">
<templateparamlist>
<param>
<type>class Child</type>
</param>
<param>
<type>class Parent</type>
</param>
</templateparamlist>
<type>bool</type>
<definition>bool serif::utils::misc::std_helper::AIsBaseClassOfB</definition>
<argsstring></argsstring>
<name>AIsBaseClassOfB</name>
<qualifiedname>serif::discretization::domain::AIsBaseClassOfB</qualifiedname>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/discretization/domain/concepts.hpp" line="21" column="5" bodyfile="src/include/serif/utils/misc/std_helper/cleaning.hpp" bodystart="13" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="func">
<memberdef kind="function" id="namespaceserif_1_1discretization_1_1domain_1a1b57d195e9d643b262222f5d50ed1dd0" prot="public" static="no" nodiscard="yes" consteval="yes" const="no" explicit="no" inline="no" noexcept="yes" virt="non-virtual">
<templateparamlist>
<param>
<type>typename...</type>
<declname>Ts</declname>
<defname>Ts</defname>
</param>
</templateparamlist>
<type>std::size_t</type>
<definition>std::size_t serif::utils::misc::std_helper::CountVariadicArguments</definition>
<argsstring>() noexcept</argsstring>
<name>CountVariadicArguments</name>
<qualifiedname>serif::discretization::domain::CountVariadicArguments</qualifiedname>
<briefdescription>
<para>&lt; </para>
</briefdescription>
<detaileddescription>
<para><xrefsect id="todo_1_todo000020"><xreftitle>Todo</xreftitle><xrefdescription><para>remove this and just use the raw std::is_base_of_v </para>
</xrefdescription></xrefsect></para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="src/include/serif/discretization/domain/concepts.hpp" line="22" column="5" bodyfile="src/include/serif/utils/misc/std_helper/variadic_cleaning.hpp" bodystart="6" bodyend="8"/>
</memberdef>
</sectiondef>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<location file="src/include/serif/discretization/domain/concepts.hpp" line="20" column="1"/>
</compounddef>
</doxygen>