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)
63 lines
5.4 KiB
TeX
63 lines
5.4 KiB
TeX
\doxysection{src/include/serif/discretization/blocks/concepts.hpp File Reference}
|
|
\hypertarget{discretization_2blocks_2concepts_8hpp}{}\label{discretization_2blocks_2concepts_8hpp}\index{src/include/serif/discretization/blocks/concepts.hpp@{src/include/serif/discretization/blocks/concepts.hpp}}
|
|
|
|
|
|
This file defines concepts for blocks in the discretization framework.
|
|
|
|
|
|
{\ttfamily \#include "{}serif/discretization/blocks/fields.\+hpp"{}}\newline
|
|
Include dependency graph for concepts.\+hpp\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{discretization_2blocks_2concepts_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]{discretization_2blocks_2concepts_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_1blocks}{serif\+::discretization\+::blocks}}
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Concepts}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1blocks_1_1_field}{serif\+::discretization\+::blocks\+::\+Field}}
|
|
\begin{DoxyCompactList}\small\item\em Concept for field types in the discretization framework. To be a field a type must derive from the field base class. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1blocks_1_1_term}{serif\+::discretization\+::blocks\+::\+Term}}
|
|
\begin{DoxyCompactList}\small\item\em Concept for term types in the discretization framework. To be a term a type must derive from term\+\_\+base, must have a field\+\_\+type member, and that field\+\_\+type member must be a valid field. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1blocks_1_1_has_functional_space}{serif\+::discretization\+::blocks\+::\+Has\+Functional\+Space}}
|
|
\begin{DoxyCompactList}\small\item\em Concept for term types that have a functional space. To have a functional space a type must first be a valid \doxylink{conceptserif_1_1discretization_1_1blocks_1_1_term}{Term} and must have a Functional\+Space member type. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1blocks_1_1_has_support}{serif\+::discretization\+::blocks\+::\+Has\+Support}}
|
|
\begin{DoxyCompactList}\small\item\em Concept for term types that have a domain over which they are supported. To have support a type must first be a valid \doxylink{conceptserif_1_1discretization_1_1blocks_1_1_term}{Term} and must have a Support member type. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1blocks_1_1_has_quantity}{serif\+::discretization\+::blocks\+::\+Has\+Quantity}}
|
|
\begin{DoxyCompactList}\small\item\em Concept for term types that have a physical quantity associated with them. To have a quantity a type must first be a valid \doxylink{conceptserif_1_1discretization_1_1blocks_1_1_term}{Term} and must have a Quantity member type. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1blocks_1_1_has_value_block}{serif\+::discretization\+::blocks\+::\+Has\+Value\+Block}}
|
|
\begin{DoxyCompactList}\small\item\em Concept for term types that have a value block associated with them. To have a value block a type must first be a valid \doxylink{conceptserif_1_1discretization_1_1blocks_1_1_term}{Term} and must have a value member type. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1blocks_1_1_has_residual_block}{serif\+::discretization\+::blocks\+::\+Has\+Residual\+Block}}
|
|
\begin{DoxyCompactList}\small\item\em Concept for term types that have a residual block associated with them. To have a residual block a type must first be a valid \doxylink{conceptserif_1_1discretization_1_1blocks_1_1_term}{Term} and must have a residual member type. \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1blocks_1_1_spatial_term}{serif\+::discretization\+::blocks\+::\+Spatial\+Term}}
|
|
\begin{DoxyCompactList}\small\item\em Concept for term types that are spatial terms. A spatial term is a term that has a functional space (\doxylink{conceptserif_1_1discretization_1_1blocks_1_1_has_functional_space}{Has\+Functional\+Space}) and a support (\doxylink{conceptserif_1_1discretization_1_1blocks_1_1_has_support}{Has\+Support}). \end{DoxyCompactList}\item
|
|
concept \mbox{\hyperlink{conceptserif_1_1discretization_1_1blocks_1_1_global_scalar_term}{serif\+::discretization\+::blocks\+::\+Global\+Scalar\+Term}}
|
|
\begin{DoxyCompactList}\small\item\em Concept for term types that are global scalar terms. A global scalar term is a term that has support (\doxylink{conceptserif_1_1discretization_1_1blocks_1_1_has_support}{Has\+Support}) but does not have a functional space (\doxylink{conceptserif_1_1discretization_1_1blocks_1_1_has_functional_space}{Has\+Functional\+Space}) and is derived from the global\+\_\+scalar class. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This file defines concepts for blocks in the discretization framework.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Emily M. Boudreaux
|
|
\end{DoxyAuthor}
|