Files

58 lines
2.9 KiB
TeX
Raw Permalink Normal View History

\doxysection{src/include/serif/equations/point.hpp File Reference}
\hypertarget{point_8hpp}{}\label{point_8hpp}\index{src/include/serif/equations/point.hpp@{src/include/serif/equations/point.hpp}}
File containing the definitions of the Equation\+Point and Point\+Linearization structs, which are used to represent the values and derivatives of operands at a given point in space.
{\ttfamily \#include $<$array$>$}\newline
{\ttfamily \#include $<$concepts$>$}\newline
{\ttfamily \#include $<$cstddef$>$}\newline
{\ttfamily \#include $<$tuple$>$}\newline
{\ttfamily \#include $<$type\+\_\+traits$>$}\newline
{\ttfamily \#include "{}serif/discretization/forms/value.\+hpp"{}}\newline
{\ttfamily \#include "{}serif/utils/types/type\+\_\+list.\+hpp"{}}\newline
Include dependency graph for point.\+hpp\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{point_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]{point_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item
struct \mbox{\hyperlink{structserif_1_1equations_1_1_operand_values_3_01utils_1_1types_1_1_type_list_3_01_operands_8_8_8_01_4_00_01_output_t_01_4}{serif\+::equations\+::\+Operand\+Values$<$ utils\+::types\+::\+Type\+List$<$ Operands... $>$, Output\+T $>$}}
\item
struct \mbox{\hyperlink{structserif_1_1equations_1_1_equation_point}{serif\+::equations\+::\+Equation\+Point$<$ Operands\+T $>$}}
\begin{DoxyCompactList}\small\item\em A struct to represent the values of operands at a given point in space. \end{DoxyCompactList}\item
struct \mbox{\hyperlink{structserif_1_1equations_1_1_point_linearization}{serif\+::equations\+::\+Point\+Linearization$<$ Operands\+T, Result\+T $>$}}
\begin{DoxyCompactList}\small\item\em A struct to represent the linearization of a pointwise equation at a given point in space. This includes the residual and the local derivatives of the operands with respect to the test operand value, as well as the local derivative of the test operand value with respect to position. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1equations}{serif\+::equations}}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
File containing the definitions of the Equation\+Point and Point\+Linearization structs, which are used to represent the values and derivatives of operands at a given point in space.
\begin{DoxyAuthor}{Author}
Emily M. Boudreaux
\end{DoxyAuthor}
Effectively every equation returns a Point\+Linearization from evaluate. Generally, you likely do not need to touch this file if you are trying to just add new physics.