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)
85 lines
8.8 KiB
TeX
85 lines
8.8 KiB
TeX
\doxysection{src/compile\+\_\+time\+\_\+checks/serif/operators/plan.cpp File Reference}
|
|
\hypertarget{operators_2plan_8cpp}{}\label{operators_2plan_8cpp}\index{src/compile\_time\_checks/serif/operators/plan.cpp@{src/compile\_time\_checks/serif/operators/plan.cpp}}
|
|
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
|
|
{\ttfamily \#include "{}serif/eos/models/polytropic.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/operators/plan.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/registry.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/primal\+\_\+gravity.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/barotropic\+\_\+density.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/operators/operand\+\_\+evaluation.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/backend/mfem/discretization/quadrature/order.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/discretization/domain/schema/schemas.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/mass\+\_\+normalization.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/angular\+\_\+momentum.\+hpp"{}}\newline
|
|
Include dependency graph for plan.\+cpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{operators_2plan_8cpp__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1_discontinuous_scalar}{serif\+::operators\+::\+Discontinuous\+Scalar}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1_discontinuous_scalar_1_1residual}{serif\+::operators\+::\+Discontinuous\+Scalar\+::residual}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1_nodal_request}{serif\+::operators\+::\+Nodal\+Request$<$ Term\+T, Operation\+T, Position\+Independent $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1_gradient_request}{serif\+::operators\+::\+Gradient\+Request}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1_bad_contribution_row}{serif\+::operators\+::\+Bad\+Contribution\+Row}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1_bad_contribution_collection}{serif\+::operators\+::\+Bad\+Contribution\+Collection}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1_nested_bad_collection}{serif\+::operators\+::\+Nested\+Bad\+Collection}}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1operators_1_1_equation_registry}{serif\+::operators\+::\+Equation\+Registry$<$ Equation\+Ts $>$}}
|
|
\begin{DoxyCompactList}\small\item\em A compile-\/time registry of equations. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1_operand_values}{serif\+::operators\+::\+Operand\+Values$<$ Operands\+T, Output\+T $>$}}
|
|
\begin{DoxyCompactList}\small\item\em A helper struct to store the values of operands. There is some convention here, specifically if OutputT is void then this struct represents the values of the operands, otherwise it represents the local derivatives of the operands with respect to OutputT. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1operators}{serif\+::operators}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_ac93808811be69dd6608587eb7b0078e4}{serif\+::operators\+::\+Balance}} = \mbox{\hyperlink{classserif_1_1equations_1_1_barotropic_density_balance}{equations\+::\+Barotropic\+Density\+Balance}}$<$\mbox{\hyperlink{classserif_1_1eos_1_1models_1_1_polytrope}{eos\+::models\+::\+Polytrope}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_add26988897c07a3b976f748f621d779c}{serif\+::operators\+::\+Displacement}} = \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1displacement_1_1vector}{discretization\+::blocks\+::displacement\+::vector}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a1099b4a7d85fb1e9dd496c451f450a6a}{serif\+::operators\+::\+Schema}} = \mbox{\hyperlink{namespaceserif_1_1discretization_1_1domain_1_1schema_abc22bc3b4f40b417480a061162a3dea2}{discretization\+::domain\+::schema\+::\+Core\+Envelope\+Vacuum\+Domain\+Schema}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a1990cb90a24314949bd1b5686d8c95f8}{serif\+::operators\+::\+Boundary\+Value}} = \mbox{\hyperlink{structserif_1_1operators_1_1_nodal_request}{Nodal\+Request}}$<$\mbox{\hyperlink{namespaceserif_1_1operators_a9a98677dd6eb911f3daa5a4173248c93}{Potential}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a84d7e8ff528dc3361769cc6f08e6cd49}{serif\+::operators\+::\+Density\+Value}} = \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operand}{discretization\+::forms\+::\+Operand}}$<$\mbox{\hyperlink{namespaceserif_1_1operators_a8ae759fc718c8ccc0804325b10a03b84}{Density}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a4fddf5444606d22742b6fc341880c05a}{serif\+::operators\+::\+Potential\+Value}} = \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operand}{discretization\+::forms\+::\+Operand}}$<$\mbox{\hyperlink{namespaceserif_1_1operators_a9a98677dd6eb911f3daa5a4173248c93}{Potential}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_ac1416d49e5c3ea87f5a2cdbbf7f6ac1c}{serif\+::operators\+::\+Potential\+Gradient}} = \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operand}{discretization\+::forms\+::\+Operand}}$<$\mbox{\hyperlink{namespaceserif_1_1operators_a9a98677dd6eb911f3daa5a4173248c93}{Potential}}, \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operation_1_1_gradient}{discretization\+::forms\+::\+Operation\+::\+Gradient}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_ac94445fb44b80328f7fd8470ded86ab7}{serif\+::operators\+::\+Displacement\+Divergence}} = \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operand}{discretization\+::forms\+::\+Operand}}$<$\mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1displacement_1_1vector}{discretization\+::blocks\+::displacement\+::vector}}, \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operation_1_1_divergence}{discretization\+::forms\+::\+Operation\+::\+Divergence}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a028bb2043970f34c7f9c4f8f35d2c996}{serif\+::operators\+::\+Displacement\+Value}} = \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operand}{discretization\+::forms\+::\+Operand}}$<$\mbox{\hyperlink{namespaceserif_1_1operators_add26988897c07a3b976f748f621d779c}{Displacement}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_abb7387ce5fc8f06e38655f2abf71a05f}{serif\+::operators\+::\+Displacement\+Gradient}} = \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operand}{discretization\+::forms\+::\+Operand}}$<$\mbox{\hyperlink{namespaceserif_1_1operators_add26988897c07a3b976f748f621d779c}{Displacement}}, \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operation_1_1_gradient}{discretization\+::forms\+::\+Operation\+::\+Gradient}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a67047e978d34c67942594c8633d8dc98}{serif\+::operators\+::\+Vector\+Tensor}} = \mbox{\hyperlink{namespaceserif_1_1discretization_1_1forms_aecbaccd35c1209031d60ea7348d6a452}{discretization\+::forms\+::\+Matrix\+Value}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a6c1bf61c7f8146504e22c9dd5cd214eb}{serif\+::operators\+::\+Cartesian\+Vector}} = \mbox{\hyperlink{namespaceserif_1_1discretization_1_1forms_a19001a41347e243892d7bfef18abd174}{discretization\+::forms\+::\+Vector\+Value}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a5046a40a9062182dcebcff858e5d744e}{serif\+::operators\+::\+Mixed\+Samples}} = \mbox{\hyperlink{structserif_1_1utils_1_1types_1_1_type_list}{utils\+::types\+::\+Type\+List}}$<$\mbox{\hyperlink{namespaceserif_1_1operators_a028bb2043970f34c7f9c4f8f35d2c996}{Displacement\+Value}}, \mbox{\hyperlink{namespaceserif_1_1operators_ac94445fb44b80328f7fd8470ded86ab7}{Displacement\+Divergence}}, \mbox{\hyperlink{namespaceserif_1_1operators_a84d7e8ff528dc3361769cc6f08e6cd49}{Density\+Value}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a9cdb279f42fddc853430bddd6fdefad5}{serif\+::operators\+::\+Mass}} = \mbox{\hyperlink{classserif_1_1equations_1_1_mass_normalization}{equations\+::\+Mass\+Normalization}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_abb1de6ae853e4f3c0ed9604304a375c4}{serif\+::operators\+::\+Omega}} = \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1rotation_1_1angular__velocity}{discretization\+::blocks\+::rotation\+::angular\+\_\+velocity}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a5195fc6ea0fc4a5f67abb26fa627f9ed}{serif\+::operators\+::\+Momentum}} = \mbox{\hyperlink{classserif_1_1equations_1_1_angular_momentum_constraint}{equations\+::\+Angular\+Momentum\+Constraint}}
|
|
\end{DoxyCompactItemize}
|