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)
51 lines
3.8 KiB
TeX
51 lines
3.8 KiB
TeX
\doxysection{src/include/serif/model/detail/surface\+\_\+plan.hpp File Reference}
|
|
\hypertarget{surface__plan_8hpp}{}\label{surface__plan_8hpp}\index{src/include/serif/model/detail/surface\_plan.hpp@{src/include/serif/model/detail/surface\_plan.hpp}}
|
|
{\ttfamily \#include "{}serif/geometry/surface/automatic.\+hpp"{}}\newline
|
|
{\ttfamily \#include "{}serif/model/equilibrium\+\_\+equations.\+hpp"{}}\newline
|
|
Include dependency graph for surface\+\_\+plan.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{surface__plan_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]{surface__plan_8hpp__dep__incl}
|
|
\end{center}
|
|
\end{figure}
|
|
\doxysubsubsection*{Classes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_surface_field_hint}{serif\+::model\+::detail\+::\+Surface\+Field\+Hint$<$ Equation, typename $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_surface_field_hint_3_01_equation_00_01std_1_1void__t_3_01type0e58d367727b7b3084f1cfe820566d9f}{serif\+::model\+::detail\+::\+Surface\+Field\+Hint$<$ Equation, std\+::void\+\_\+t$<$ typename Equation\+::\+Isobaric\+Surface\+Field $>$ $>$}}
|
|
\begin{DoxyCompactList}\small\item\em An equation author may disambiguate surface enforcement without changing the physical condition. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_unique_surface_field_3_01utils_1_1dependencies_1_1_key_list_3_4_01_4}{serif\+::model\+::detail\+::\+Unique\+Surface\+Field$<$ utils\+::dependencies\+::\+Key\+List$<$$>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_unique_surface_field_3_01utils_1_1dependencies_1_1_key_list_3f358c046cdb6902eb06450605014909a}{serif\+::model\+::detail\+::\+Unique\+Surface\+Field$<$ utils\+::dependencies\+::\+Key\+List$<$ Field, Others... $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{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}{serif\+::model\+::detail\+::\+Preferred\+Surface\+Field$<$ utils\+::types\+::\+Type\+List$<$ Equations... $>$ $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_selected_surface}{serif\+::model\+::detail\+::\+Selected\+Surface$<$ Selection, Supported $>$}}
|
|
\begin{DoxyCompactList}\small\item\em A disabled or unavailable boundary has no compiled field or row requirements. \end{DoxyCompactList}\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_selected_surface_3_01_selection_00_01true_01_4}{serif\+::model\+::detail\+::\+Selected\+Surface$<$ Selection, true $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_surface_plan_3_01_no_surface_condition_00_01_e_o_s_00_01_fielcaee9a8d3b4dcc205ef196d9b381bcd3}{serif\+::model\+::detail\+::\+Surface\+Plan$<$ No\+Surface\+Condition, EOS, Fields, Rows, Solved, Equations $>$}}
|
|
\item
|
|
struct \mbox{\hyperlink{structserif_1_1model_1_1detail_1_1_surface_plan_3_01geometry_1_1surface_1_1_isobaric_00_01_e_o_sc18450578bb69caecc44a2508508062a}{serif\+::model\+::detail\+::\+Surface\+Plan$<$ geometry\+::surface\+::\+Isobaric, EOS, Fields, Rows, Solved, Equations $>$}}
|
|
\begin{DoxyCompactList}\small\item\em Compile the condition once; planning, graph assembly and validation share the selected formulation. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Namespaces}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif}{serif}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1model}{serif\+::model}}
|
|
\item
|
|
namespace \mbox{\hyperlink{namespaceserif_1_1model_1_1detail}{serif\+::model\+::detail}}
|
|
\end{DoxyCompactItemize}
|