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)
111 lines
12 KiB
TeX
111 lines
12 KiB
TeX
\doxysection{src/compile\+\_\+time\+\_\+checks/serif/operators/plan.cpp File Reference}
|
|
\hypertarget{plan_8cpp}{}\label{plan_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/equations/displacement\+\_\+force.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/barotropic\+\_\+closure.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/hydrostatic\+\_\+equilibrium.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/operators/plan.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/registry.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/mixed\+\_\+gravity.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/gravity\+\_\+force.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/rotational\+\_\+force.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/pressure\+\_\+force.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/equations/pressure\+\_\+surface.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/operators/backend/mfem/operand\+\_\+evaluation.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/discretization/quadrature/backend/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]{plan_8cpp__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\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_barotropic_hydrostatic_equilibrium}{serif\+::operators\+::\+Barotropic\+Hydrostatic\+Equilibrium}}
|
|
\item
|
|
class \mbox{\hyperlink{classserif_1_1operators_1_1_equation_registry}{serif\+::operators\+::\+Equation\+Registry$<$ Equation\+Ts $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1operators_1_1_operand_values}{serif\+::operators\+::\+Operand\+Values$<$ Operands\+T, Output\+T $>$}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1operators}{serif\+::operators}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1operators_1_1_can_sum}{serif\+::operators\+::\+Can\+Sum}}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1operators_1_1_can_subtract}{serif\+::operators\+::\+Can\+Subtract}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Typedefs}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a9da7986dcc8de9ee57a355e4772f691d}{serif\+::operators\+::\+Closure}} = \mbox{\hyperlink{classserif_1_1equations_1_1_barotropic_closure}{equations\+::\+Barotropic\+Closure}}$<$\mbox{\hyperlink{classserif_1_1eos_1_1models_1_1_polytrope}{eos\+::models\+::\+Polytrope}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a16280e0cbcefdad838745dbc8736a0fd}{serif\+::operators\+::\+Density}} = \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1density_1_1mass}{discretization\+::blocks\+::density\+::mass}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a5175f9de6a2232a55de22a8ce0160c87}{serif\+::operators\+::\+Enthalpy}} = \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1enthalpy_1_1specific}{discretization\+::blocks\+::enthalpy\+::specific}}
|
|
\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_adc59dda81092830f279f9c027ff098fc}{serif\+::operators\+::\+Surface\+Pressure}} = \mbox{\hyperlink{classserif_1_1equations_1_1_pressure_surface_constraint}{equations\+::\+Pressure\+Surface\+Constraint}}$<$\mbox{\hyperlink{classserif_1_1eos_1_1models_1_1_polytrope}{eos\+::models\+::\+Polytrope}}$>$
|
|
\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_a16280e0cbcefdad838745dbc8736a0fd}{Density}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a155e50c0dfd1493bd5c4d30cf80f030e}{serif\+::operators\+::\+Enthalpy\+Value}} = \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operand}{discretization\+::forms\+::\+Operand}}$<$\mbox{\hyperlink{namespaceserif_1_1operators_a5175f9de6a2232a55de22a8ce0160c87}{Enthalpy}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a30e1cb63774713068b7fccba16fd2dd5}{serif\+::operators\+::\+Enthalpy\+Gradient}} = \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operand}{discretization\+::forms\+::\+Operand}}$<$\mbox{\hyperlink{namespaceserif_1_1operators_a5175f9de6a2232a55de22a8ce0160c87}{Enthalpy}}, \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operation_1_1_gradient}{discretization\+::forms\+::\+Operation\+::\+Gradient}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_aa9833f136bb30ee4530fc40368fa6519}{serif\+::operators\+::\+Gravity\+Value}} = \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operand}{discretization\+::forms\+::\+Operand}}$<$\mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1gravity_1_1gradient}{discretization\+::blocks\+::gravity\+::gradient}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_aaf6d7331df637442e2f2b6fdd3940d3e}{serif\+::operators\+::\+Gravity\+Divergence}} = \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operand}{discretization\+::forms\+::\+Operand}}$<$\mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1gravity_1_1gradient}{discretization\+::blocks\+::gravity\+::gradient}}, \mbox{\hyperlink{structserif_1_1discretization_1_1forms_1_1_operation_1_1_divergence}{discretization\+::forms\+::\+Operation\+::\+Divergence}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a9be3c608cfa2fdf7f3dca6589bef6b26}{serif\+::operators\+::\+Pressure}} = \mbox{\hyperlink{classserif_1_1equations_1_1_pressure_force}{equations\+::\+Pressure\+Force}}$<$\mbox{\hyperlink{classserif_1_1eos_1_1models_1_1_polytrope}{eos\+::models\+::\+Polytrope}}$>$
|
|
\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_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_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_a50f617c1cc3233995c13b43a5db2b786}{serif\+::operators\+::\+Potential}} = \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1gravity_1_1potential}{discretization\+::blocks\+::gravity\+::potential}}
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a2889e1af4e8d39089daa82023179b8e4}{serif\+::operators\+::\+Mixed\+Samples}} = \mbox{\hyperlink{structserif_1_1utils_1_1types_1_1_type_list}{utils\+::types\+::\+Type\+List}}$<$\mbox{\hyperlink{namespaceserif_1_1operators_aa9833f136bb30ee4530fc40368fa6519}{Gravity\+Value}}, \mbox{\hyperlink{namespaceserif_1_1operators_aaf6d7331df637442e2f2b6fdd3940d3e}{Gravity\+Divergence}}, \mbox{\hyperlink{namespaceserif_1_1operators_a84d7e8ff528dc3361769cc6f08e6cd49}{Density\+Value}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a04e3cf175c7ba8a62aa1b88dd18bb657}{serif\+::operators\+::\+Mechanical}} = \mbox{\hyperlink{classserif_1_1equations_1_1_displacement_force}{equations\+::\+Displacement\+Force}}$<$\mbox{\hyperlink{classserif_1_1eos_1_1models_1_1_polytrope}{eos\+::models\+::\+Polytrope}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a3810d3059725cd464913a4cdcf36bbbc}{serif\+::operators\+::\+Mechanical\+Difference}} = \mbox{\hyperlink{classserif_1_1equations_1_1_equation_difference}{equations\+::\+Equation\+Difference}}$<$\mbox{\hyperlink{namespaceserif_1_1operators_a9be3c608cfa2fdf7f3dca6589bef6b26}{Pressure}}, \mbox{\hyperlink{classserif_1_1equations_1_1_equation_sum}{equations\+::\+Equation\+Sum}}$<$\mbox{\hyperlink{structserif_1_1equations_1_1_gravity_force}{equations\+::\+Gravity\+Force}}, \mbox{\hyperlink{classserif_1_1equations_1_1_rotational_force}{equations\+::\+Rotational\+Force}}$>$$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_a8d7782cb0c4905248c99ba70bb3c8fd2}{serif\+::operators\+::\+Scaled\+Mechanical}} = \mbox{\hyperlink{classserif_1_1equations_1_1_equation_scale}{equations\+::\+Equation\+Scale}}$<$\mbox{\hyperlink{namespaceserif_1_1operators_a3810d3059725cd464913a4cdcf36bbbc}{Mechanical\+Difference}}$>$
|
|
\item
|
|
using \mbox{\hyperlink{namespaceserif_1_1operators_ac99497637375a1b2b89465b1da6b927f}{serif\+::operators\+::\+Scaled\+Poisson}} = \mbox{\hyperlink{classserif_1_1equations_1_1_equation_scale}{equations\+::\+Equation\+Scale}}$<$\mbox{\hyperlink{classserif_1_1equations_1_1_poisson_balance}{equations\+::\+Poisson\+Balance}}$>$
|
|
\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_a372b973d428f4cadd4c876660d22df26}{serif\+::operators\+::\+Constant}} = \mbox{\hyperlink{structserif_1_1discretization_1_1blocks_1_1barotropic__constant_1_1mass__normalization}{discretization\+::blocks\+::barotropic\+\_\+constant\+::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_a5cd72906bc83776f1c8097851b8f5927}{serif\+::operators\+::\+Momentum}} = \mbox{\hyperlink{classserif_1_1equations_1_1_angular_momentum}{equations\+::\+Angular\+Momentum}}
|
|
\end{DoxyCompactItemize}
|