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)
47 lines
4.6 KiB
Groff
47 lines
4.6 KiB
Groff
.TH "src/include/serif/utils/error/codes.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/utils/error/codes.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <cstdint>\fP
|
|
.br
|
|
\fR#include 'serif/meta/enums\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::utils\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::utils::errors\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Enumerations"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "enum class \fBserif::utils::errors::SERiFErrorCode\fP : uint16_t { \fBserif::utils::errors::UNKNOWN_ERROR\fP = 0, \fBserif::utils::errors::INVALID_ARGUMENT\fP = 100, \fBserif::utils::errors::INVALID_QUADRATURE_ORDER\fP, \fBserif::utils::errors::INVALID_DOMAIN_ERROR\fP =110, \fBserif::utils::errors::NEGATIVE_VALUE_ERROR\fP, \fBserif::utils::errors::NON_FINITE_VALUE_ERROR\fP, \fBserif::utils::errors::JACOBIAN_ERROR\fP = 200, \fBserif::utils::errors::INVERTED_JACOBIAN\fP, \fBserif::utils::errors::NON_FINITE_DETERMINATE\fP, \fBserif::utils::errors::EOS_ERROR\fP = 300, \fBserif::utils::errors::EOS_UNSUPPORTED_RELATION\fP, \fBserif::utils::errors::EOS_UNSUPPORTED_DERIVATIVE\fP, \fBserif::utils::errors::EOS_WRONG_INPUT_COUNT\fP, \fBserif::utils::errors::EOS_WRONG_INPUT_QUANTITY\fP, \fBserif::utils::errors::EOS_NONFINITE_INPUT\fP, \fBserif::utils::errors::EOS_OUTSIDE_DOMAIN\fP, \fBserif::utils::errors::EOS_NONFINITE_RESULT\fP, \fBserif::utils::errors::EOS_INVALID_THERMODYNAMIC_INPUT\fP, \fBserif::utils::errors::INVALID_DIMENSION\fP = 400, \fBserif::utils::errors::NON_FINITE_MAPPING_INPUT\fP, \fBserif::utils::errors::INVALID_REFERENCE_RADIUS\fP, \fBserif::utils::errors::AT_COMPACTIFIED_INFINITY\fP, \fBserif::utils::errors::OUTSIDE_REFERENCE_DOMAIN\fP, \fBserif::utils::errors::NON_FINITE_MAPPING_RESULT\fP, \fBserif::utils::errors::NON_POSITIVE_DETERMINATE\fP, \fBserif::utils::errors::INVALID_MAPPING\fP, \fBserif::utils::errors::MISC_MAPPING_ERROR\fP =410, \fBserif::utils::errors::INVALID_DOF_COUNT\fP, \fBserif::utils::errors::INVALID_ELEMENT_GEOMETRY\fP, \fBserif::utils::errors::INVALID_DOF_ORDERING\fP, \fBserif::utils::errors::INVALID_COMPACTIFICATION_RANK\fP, \fBserif::utils::errors::INVALID_COMPACTIFICATION_TYPE\fP, \fBserif::utils::errors::INVALID_COMPACTIFICATION_DERIVATIVE_TYPE\fP, \fBserif::utils::errors::INVALID_VACUUM_ELEMENT_ATTRIBUTE_ID\fP, \fBserif::utils::errors::MISSING_EXTERIOR_MAP\fP, \fBserif::utils::errors::COMPACTIFICATION_MISMATCH\fP, \fBserif::utils::errors::MISSING_FACE_ELEMENT\fP, \fBserif::utils::errors::JACOBIAN_SHAPE_ERROR\fP, \fBserif::utils::errors::MISSING_DISPLACEMENT_FINITE_ELEMENT_SPACE\fP, \fBserif::utils::errors::MISMATCHED_MESHING_MAPS\fP, \fBserif::utils::errors::IMPROPERLY_ORDERED_REFERENCE_RADII\fP = 450, \fBserif::utils::errors::INVALID_COORDINATE_TOLERANCE\fP, \fBserif::utils::errors::EVALUATOR_ERROR\fP =460, \fBserif::utils::errors::CACHE_FE_BINDING_ERROR\fP, \fBserif::utils::errors::INVALID_ELEMENT_ID_ERROR\fP, \fBserif::utils::errors::ELEMENT_NULLPTR_ERROR\fP, \fBserif::utils::errors::DISCRETIZATION_ERROR\fP = 500, \fBserif::utils::errors::SCHEMA_ERROR\fP = 510, \fBserif::utils::errors::INVALID_SCHEMA_ARGUMENTS\fP = 512, \fBserif::utils::errors::MATRIX_SHAPE_ERROR\fP = 600, \fBserif::utils::errors::OUT_OF_RANGE_ERROR\fP, \fBserif::utils::errors::SOLVER_ERROR\fP = 700, \fBserif::utils::errors::NORMALIZATION_ERROR\fP = 730, \fBserif::utils::errors::NORMALIZATION_VECTOR_SIZE_MISMATCH\fP, \fBserif::utils::errors::NORMALIZATION_BUFFER_OVERLAP\fP, \fBserif::utils::errors::PRECONDITIONER_ERROR\fP = 750, \fBserif::utils::errors::PRECONDITIONER_INVALID_OPTIONS\fP, \fBserif::utils::errors::PRECONDITIONER_INVALID_OPERATOR\fP, \fBserif::utils::errors::PRECONDITIONER_SIZE_MISMATCH\fP, \fBserif::utils::errors::PRECONDITIONER_NONFINITE_VALUE\fP, \fBserif::utils::errors::PRECONDITIONER_SINGULAR_OPERATOR\fP, \fBserif::utils::errors::PRECONDITIONER_ILL_CONDITIONED_OPERATOR\fP, \fBserif::utils::errors::PRECONDITIONER_STALE_LINEARIZATION\fP, \fBserif::utils::errors::PRECONDITIONER_INCOMPATIBLE_STRATEGY\fP, \fBserif::utils::errors::PRECONDITIONER_UNPREPARED\fP, \fBserif::utils::errors::PRECONDITIONER_INVALID_CALIBRATION\fP, \fBserif::utils::errors::EQUATION_ERROR\fP = 800, \fBserif::utils::errors::FAILED_TYPE_INVARIANT\fP = 1000 }"
|
|
.br
|
|
.in -1c
|
|
.SS "Variables"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "auto \fBserif::utils::errors::SERiFErrorCodeNameToTypeMap\fP = \fBmeta::enum_to_string_enum_map\fP<\fBSERiFErrorCode\fP>()"
|
|
.br
|
|
.ti -1c
|
|
.RI "auto \fBserif::utils::errors::SERiFErrorCodeTypeToNameMap\fP = \fBmeta::enum_to_enum_string_map\fP<\fBSERiFErrorCode\fP>()"
|
|
.br
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|