Files
MeanField_SERiF/docs/latex/codes_8hpp.tex
Emily Boudreaux 6b57738330 docs(docs): built docs
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)
2026-11-09 14:09:44 -05:00

126 lines
15 KiB
TeX

\doxysection{src/include/serif/utils/error/codes.hpp File Reference}
\hypertarget{codes_8hpp}{}\label{codes_8hpp}\index{src/include/serif/utils/error/codes.hpp@{src/include/serif/utils/error/codes.hpp}}
{\ttfamily \#include $<$cstdint$>$}\newline
{\ttfamily \#include "{}serif/meta/enums.\+hpp"{}}\newline
Include dependency graph for codes.\+hpp\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{codes_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]{codes_8hpp__dep__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Namespaces}
\begin{DoxyCompactItemize}
\item
namespace \mbox{\hyperlink{namespaceserif}{serif}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1utils}{serif\+::utils}}
\item
namespace \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors}{serif\+::utils\+::errors}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum class \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346}{serif\+::utils\+::errors\+::\+SERi\+FError\+Code}} \+: uint16\+\_\+t \{ \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a9a10f345b0f755d461a8673a5e9ef6b4}{serif\+::utils\+::errors\+::\+UNKNOWN\+\_\+\+ERROR}} = 0
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346af295a0c3e37c94f078e1c5476479132d}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+ARGUMENT}} = 100
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346ab26e430d27d39fcdbc0fe2ea820df3fd}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+QUADRATURE\+\_\+\+ORDER}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346ac212f14cd5a49cbc50455bb4f9c1e84c}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+DOMAIN\+\_\+\+ERROR}} =110
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346ad32f95d919a74607c87d347b0185b92c}{serif\+::utils\+::errors\+::\+NEGATIVE\+\_\+\+VALUE\+\_\+\+ERROR}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a3f458281134cf7e4b19d7c97473cd7ec}{serif\+::utils\+::errors\+::\+NON\+\_\+\+FINITE\+\_\+\+VALUE\+\_\+\+ERROR}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a23c8ae7f26b046be4ca7e274e6ab9020}{serif\+::utils\+::errors\+::\+JACOBIAN\+\_\+\+ERROR}} = 200
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346ac29d8f4f77bbcb5244a6959819e3591d}{serif\+::utils\+::errors\+::\+INVERTED\+\_\+\+JACOBIAN}}
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346ac30ac4ea7e7347d7adc8fb51a060cf22}{serif\+::utils\+::errors\+::\+NON\+\_\+\+FINITE\+\_\+\+DETERMINATE}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a1fdfa3b9c5fc912a083c1a65d4bc7def}{serif\+::utils\+::errors\+::\+EOS\+\_\+\+ERROR}} = 300
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a8e9f88cbd72f5fd2ea30e1a9fc980935}{serif\+::utils\+::errors\+::\+EOS\+\_\+\+UNSUPPORTED\+\_\+\+RELATION}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a7abb36ccb39c78eee29ad309bfc92d83}{serif\+::utils\+::errors\+::\+EOS\+\_\+\+UNSUPPORTED\+\_\+\+DERIVATIVE}}
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a7d6ed736cc71b74321cff4980d0b366a}{serif\+::utils\+::errors\+::\+EOS\+\_\+\+WRONG\+\_\+\+INPUT\+\_\+\+COUNT}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346ab1a09e8dbe875f5042439869cb9c1a44}{serif\+::utils\+::errors\+::\+EOS\+\_\+\+WRONG\+\_\+\+INPUT\+\_\+\+QUANTITY}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a1dad27298692a9beea9d2eb1d4ddad7f}{serif\+::utils\+::errors\+::\+EOS\+\_\+\+NONFINITE\+\_\+\+INPUT}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a4103ab8cd923be43abf99797d43dbdbc}{serif\+::utils\+::errors\+::\+EOS\+\_\+\+OUTSIDE\+\_\+\+DOMAIN}}
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346af2d6f3bb5552a94ca9afc6d116e0156b}{serif\+::utils\+::errors\+::\+EOS\+\_\+\+NONFINITE\+\_\+\+RESULT}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346afdc9ec844f0db8dbde01963b8bd60ef4}{serif\+::utils\+::errors\+::\+EOS\+\_\+\+INVALID\+\_\+\+THERMODYNAMIC\+\_\+\+INPUT}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a6c849957a6a4a88b7fb6fcb716d651f1}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+DIMENSION}} = 400
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a58690190e68105ca9d4c573f113ced94}{serif\+::utils\+::errors\+::\+NON\+\_\+\+FINITE\+\_\+\+MAPPING\+\_\+\+INPUT}}
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a664863abf724900cacb79236732b0d24}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+REFERENCE\+\_\+\+RADIUS}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a64cde656c0dea359e0e048c5b1a45020}{serif\+::utils\+::errors\+::\+AT\+\_\+\+COMPACTIFIED\+\_\+\+INFINITY}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a46b382cdaef0bff17df6f22ed6ac0c80}{serif\+::utils\+::errors\+::\+OUTSIDE\+\_\+\+REFERENCE\+\_\+\+DOMAIN}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346aed5aaccb3615a644e604d2867cb722a5}{serif\+::utils\+::errors\+::\+NON\+\_\+\+FINITE\+\_\+\+MAPPING\+\_\+\+RESULT}}
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a8046940b838d63b536825ef425a6de82}{serif\+::utils\+::errors\+::\+NON\+\_\+\+POSITIVE\+\_\+\+DETERMINATE}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a099ab2aa35e6b3be35ddc36b33360102}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+MAPPING}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a5a8b51f24614b8ba55b97bcac6512bb3}{serif\+::utils\+::errors\+::\+MISC\+\_\+\+MAPPING\+\_\+\+ERROR}} =410
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a9d34d1c93ad6e3f58fd9023c1977cc39}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+DOF\+\_\+\+COUNT}}
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346ac618b9adeda9e855aab839a1046267e2}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+ELEMENT\+\_\+\+GEOMETRY}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a6e7088395a408e24db367b8bf8602fa5}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+DOF\+\_\+\+ORDERING}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a431e11f2136ff582c4c1d2909319a28b}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+COMPACTIFICATION\+\_\+\+RANK}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346af0aa8cd82916235df25802da359563ef}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+COMPACTIFICATION\+\_\+\+TYPE}}
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a622945fe1c39f0b66b63f8b518283802}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+COMPACTIFICATION\+\_\+\+DERIVATIVE\+\_\+\+TYPE}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a204f4389a3812083114bb4f4548ae2e4}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+VACUUM\+\_\+\+ELEMENT\+\_\+\+ATTRIBUTE\+\_\+\+ID}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a79ad977c1f9edca04fb43eb538a8b134}{serif\+::utils\+::errors\+::\+MISSING\+\_\+\+EXTERIOR\+\_\+\+MAP}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a917cf7dd1086e6a331d5359e75736dc8}{serif\+::utils\+::errors\+::\+COMPACTIFICATION\+\_\+\+MISMATCH}}
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a8d659ed8ea04bdf1ed64eecb06dba220}{serif\+::utils\+::errors\+::\+MISSING\+\_\+\+FACE\+\_\+\+ELEMENT}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a7f7f6e0e6fc2c000ab0a8476f4cea12a}{serif\+::utils\+::errors\+::\+JACOBIAN\+\_\+\+SHAPE\+\_\+\+ERROR}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a624b043baa343cb321e202e442461fd5}{serif\+::utils\+::errors\+::\+MISSING\+\_\+\+DISPLACEMENT\+\_\+\+FINITE\+\_\+\+ELEMENT\+\_\+\+SPACE}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a4f4f078704931effa7d820e26dce3454}{serif\+::utils\+::errors\+::\+MISMATCHED\+\_\+\+MESHING\+\_\+\+MAPS}}
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a58a142d4c0001edb06db63564fd9d6af}{serif\+::utils\+::errors\+::\+IMPROPERLY\+\_\+\+ORDERED\+\_\+\+REFERENCE\+\_\+\+RADII}} = 450
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346ad6df09fb432983c68957f902c0157ec3}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+COORDINATE\+\_\+\+TOLERANCE}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a121f6f85b83e9e7bdfed69f6e2663054}{serif\+::utils\+::errors\+::\+EVALUATOR\+\_\+\+ERROR}} =460
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346ac1b1773f74d583c43e3ea9366462f4ee}{serif\+::utils\+::errors\+::\+CACHE\+\_\+\+FE\+\_\+\+BINDING\+\_\+\+ERROR}}
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a35dc50a7205013e2de2b388f944a4673}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+ELEMENT\+\_\+\+ID\+\_\+\+ERROR}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346ac4f686058466ccdea15bb5faef3d5e97}{serif\+::utils\+::errors\+::\+ELEMENT\+\_\+\+NULLPTR\+\_\+\+ERROR}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a33afad1a9fc3288ff00e0d950433ceb4}{serif\+::utils\+::errors\+::\+DISCRETIZATION\+\_\+\+ERROR}} = 500
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a4bc541f8f40c5d80f848cd135bd7d45a}{serif\+::utils\+::errors\+::\+SCHEMA\+\_\+\+ERROR}} = 510
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a94f0b761a1623b1bb4e63f99642ec0f0}{serif\+::utils\+::errors\+::\+INVALID\+\_\+\+SCHEMA\+\_\+\+ARGUMENTS}} = 512
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a638521f48b9ccdc14fbebd29658c9366}{serif\+::utils\+::errors\+::\+MATRIX\+\_\+\+SHAPE\+\_\+\+ERROR}} = 600
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a21e55d5bfa09b9572bd3cf11e0abd4a9}{serif\+::utils\+::errors\+::\+OUT\+\_\+\+OF\+\_\+\+RANGE\+\_\+\+ERROR}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a38e34c32c3cba67bf30e244ef61cc684}{serif\+::utils\+::errors\+::\+SOLVER\+\_\+\+ERROR}} = 700
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a15400f420fff3eb6aef75ff5099547ec}{serif\+::utils\+::errors\+::\+NORMALIZATION\+\_\+\+ERROR}} = 730
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a367b8f40bcb3d5afcbfd2277b1fa6582}{serif\+::utils\+::errors\+::\+NORMALIZATION\+\_\+\+VECTOR\+\_\+\+SIZE\+\_\+\+MISMATCH}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346ab44dc1e8c547259784038bb5a197e85e}{serif\+::utils\+::errors\+::\+NORMALIZATION\+\_\+\+BUFFER\+\_\+\+OVERLAP}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a7628b67e5cb2d4f25b60dfa93582e069}{serif\+::utils\+::errors\+::\+PRECONDITIONER\+\_\+\+ERROR}} = 750
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a6b10c7e7c89ea2b49c0a8aaf1ebc0eac}{serif\+::utils\+::errors\+::\+PRECONDITIONER\+\_\+\+INVALID\+\_\+\+OPTIONS}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a49ead9a31669df283034426e7d90ac61}{serif\+::utils\+::errors\+::\+PRECONDITIONER\+\_\+\+INVALID\+\_\+\+OPERATOR}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a07ade0bcb07c32f51b8b1c81cda05fbe}{serif\+::utils\+::errors\+::\+PRECONDITIONER\+\_\+\+SIZE\+\_\+\+MISMATCH}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a0ce53c151e37e01206ce4111620e2f25}{serif\+::utils\+::errors\+::\+PRECONDITIONER\+\_\+\+NONFINITE\+\_\+\+VALUE}}
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346af48e0181a9931250d9a6a4af4187dac4}{serif\+::utils\+::errors\+::\+PRECONDITIONER\+\_\+\+SINGULAR\+\_\+\+OPERATOR}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a027e24378dc9f89c5c44730686138afc}{serif\+::utils\+::errors\+::\+PRECONDITIONER\+\_\+\+ILL\+\_\+\+CONDITIONED\+\_\+\+OPERATOR}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a4ff26ef5e43141b4040a0f020ef5ea5a}{serif\+::utils\+::errors\+::\+PRECONDITIONER\+\_\+\+STALE\+\_\+\+LINEARIZATION}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346af9a768b24c2e60f744437f97d716757d}{serif\+::utils\+::errors\+::\+PRECONDITIONER\+\_\+\+INCOMPATIBLE\+\_\+\+STRATEGY}}
, \newline
\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a3cbb7648de8d1e097b4dff01727e8a62}{serif\+::utils\+::errors\+::\+PRECONDITIONER\+\_\+\+UNPREPARED}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346aaede09a1ad3463a00f6f7838a941a7f9}{serif\+::utils\+::errors\+::\+PRECONDITIONER\+\_\+\+INVALID\+\_\+\+CALIBRATION}}
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346a46288ff2dd3648953ae84bb04730d3aa}{serif\+::utils\+::errors\+::\+EQUATION\+\_\+\+ERROR}} = 800
, \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346aac8248e8e14d703a968d5094031ba5b9}{serif\+::utils\+::errors\+::\+FAILED\+\_\+\+TYPE\+\_\+\+INVARIANT}} = 1000
\}
\end{DoxyCompactItemize}
\doxysubsubsection*{Variables}
\begin{DoxyCompactItemize}
\item
auto \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_a562f604deccc1abf04ae9efdc7f0ac98}{serif\+::utils\+::errors\+::\+SERi\+FError\+Code\+Name\+To\+Type\+Map}} = \mbox{\hyperlink{namespaceserif_1_1meta_a27a478b13abbbddd3b16dce448ce87fa}{meta\+::enum\+\_\+to\+\_\+string\+\_\+enum\+\_\+map}}$<$\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346}{SERi\+FError\+Code}}$>$()
\item
auto \mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_acdf570b1b41e2bbf923e94a0c689fe5e}{serif\+::utils\+::errors\+::\+SERi\+FError\+Code\+Type\+To\+Name\+Map}} = \mbox{\hyperlink{namespaceserif_1_1meta_a228074fe1d60918db17444e31b601c2f}{meta\+::enum\+\_\+to\+\_\+enum\+\_\+string\+\_\+map}}$<$\mbox{\hyperlink{namespaceserif_1_1utils_1_1errors_ab04484c13887f78337c2331fb2911346}{SERi\+FError\+Code}}$>$()
\end{DoxyCompactItemize}