Files
MeanField_SERiF/docs/latex/physical__domains_8hpp.tex

55 lines
4.0 KiB
TeX
Raw Normal View History

\doxysection{src/include/serif/discretization/domain/physical\+\_\+domains.hpp File Reference}
\hypertarget{physical__domains_8hpp}{}\label{physical__domains_8hpp}\index{src/include/serif/discretization/domain/physical\_domains.hpp@{src/include/serif/discretization/domain/physical\_domains.hpp}}
File containing the physical domain types for SERiF. These are domain sets that are more useful physically since they group together computationally separate domains that may have no physically meaningful distinction. For example, the core and envelope domains are computationally distinct but physically they are both stellar domains.
{\ttfamily \#include "{}serif/discretization/domain/types.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/discretization/domain/concepts.\+hpp"{}}\newline
Include dependency graph for physical\+\_\+domains.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{physical__domains_8hpp__incl}
\end{center}
\end{figure}
This graph shows which files directly or indirectly include this file\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{physical__domains_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization}{serif\+::discretization}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain}{serif\+::discretization\+::domain}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Typedefs}
\begin{DoxyCompactItemize}
\item
using \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_aa2fd687c5f7b8750fd6980f2a7a77652}{serif\+::discretization\+::domain\+::\+Stellar\+Domains}} = \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_domain_set}{Domain\+Set}}$<$\mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_core_domain}{Core\+Domain}}, \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_envelope_domain}{Envelope\+Domain}}$>$
\begin{DoxyCompactList}\small\item\em The set of domains that make up the stellar region of the mesh. \end{DoxyCompactList}\item
using \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_a46dfe7f95e0184edff495bd82e3d7b5d}{serif\+::discretization\+::domain\+::\+All\+Domains}} = \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_domain_set}{Domain\+Set}}$<$\mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_core_domain}{Core\+Domain}}, \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_envelope_domain}{Envelope\+Domain}}, \mbox{\hyperlink{structserif_1_1discretization_1_1domain_1_1_vacuum_domain}{Vacuum\+Domain}}$>$
\begin{DoxyCompactList}\small\item\em The set of all domains in the mesh. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
File containing the physical domain types for SERiF. These are domain sets that are more useful physically since they group together computationally separate domains that may have no physically meaningful distinction. For example, the core and envelope domains are computationally distinct but physically they are both stellar domains.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}
\begin{DoxyNote}{Note}
the core and envelope domains do not necessarily correspond to the physical core and envelope of a star. Rather, this is terminology used to describe the two regions where we orient the mesh differently. Fundamentally we cannot reasonably continue a spherical mesh to the center of a stellar model due to the r=0 singularity. Therefore, the mesh generation program we use (stroid) generates a cartisan mesh embedded within a spherical mesh (there is a bit more to the topology to ensure we have a nicely structured mesh, see stroid for more details). It is this inner cartesian mesh (along with the transition region) that we call the core. The user may need to make choices about where that transition region occurs in their stellar model.
\end{DoxyNote}