225 lines
8.4 KiB
Groff
225 lines
8.4 KiB
Groff
|
.TH "serif::utils::errors" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::utils::errors
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "class \fBNonFiniteValue\fP"
|
||
|
|
.br
|
||
|
|
.RI "A numerical action produced a nonfinite coefficient, distinguishable from a broken API contract\&. Most numerical interfaces report rejection as a value\&. MFEM operator applications return void, so their checked caller intercepts this specific bridge while other exceptions propagate\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBserif_error_printer\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Enumerations"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "enum class \fBSERiFErrorCode\fP : uint16_t { \fBUNKNOWN_ERROR\fP = 0, \fBINVALID_ARGUMENT\fP = 100, \fBINVALID_QUADRATURE_ORDER\fP, \fBINVALID_DOMAIN_ERROR\fP =110, \fBNEGATIVE_VALUE_ERROR\fP, \fBNON_FINITE_VALUE_ERROR\fP, \fBJACOBIAN_ERROR\fP = 200, \fBINVERTED_JACOBIAN\fP, \fBNON_FINITE_DETERMINATE\fP, \fBEOS_ERROR\fP = 300, \fBEOS_UNSUPPORTED_RELATION\fP, \fBEOS_UNSUPPORTED_DERIVATIVE\fP, \fBEOS_WRONG_INPUT_COUNT\fP, \fBEOS_WRONG_INPUT_QUANTITY\fP, \fBEOS_NONFINITE_INPUT\fP, \fBEOS_OUTSIDE_DOMAIN\fP, \fBEOS_NONFINITE_RESULT\fP, \fBEOS_INVALID_THERMODYNAMIC_INPUT\fP, \fBINVALID_DIMENSION\fP = 400, \fBNON_FINITE_MAPPING_INPUT\fP, \fBINVALID_REFERENCE_RADIUS\fP, \fBAT_COMPACTIFIED_INFINITY\fP, \fBOUTSIDE_REFERENCE_DOMAIN\fP, \fBNON_FINITE_MAPPING_RESULT\fP, \fBNON_POSITIVE_DETERMINATE\fP, \fBINVALID_MAPPING\fP, \fBMISC_MAPPING_ERROR\fP =410, \fBINVALID_DOF_COUNT\fP, \fBINVALID_ELEMENT_GEOMETRY\fP, \fBINVALID_DOF_ORDERING\fP, \fBINVALID_COMPACTIFICATION_RANK\fP, \fBINVALID_COMPACTIFICATION_TYPE\fP, \fBINVALID_COMPACTIFICATION_DERIVATIVE_TYPE\fP, \fBINVALID_VACUUM_ELEMENT_ATTRIBUTE_ID\fP, \fBMISSING_EXTERIOR_MAP\fP, \fBCOMPACTIFICATION_MISMATCH\fP, \fBMISSING_FACE_ELEMENT\fP, \fBJACOBIAN_SHAPE_ERROR\fP, \fBMISSING_DISPLACEMENT_FINITE_ELEMENT_SPACE\fP, \fBMISMATCHED_MESHING_MAPS\fP, \fBIMPROPERLY_ORDERED_REFERENCE_RADII\fP = 450, \fBINVALID_COORDINATE_TOLERANCE\fP, \fBEVALUATOR_ERROR\fP =460, \fBCACHE_FE_BINDING_ERROR\fP, \fBINVALID_ELEMENT_ID_ERROR\fP, \fBELEMENT_NULLPTR_ERROR\fP, \fBDISCRETIZATION_ERROR\fP = 500, \fBSCHEMA_ERROR\fP = 510, \fBINVALID_SCHEMA_ARGUMENTS\fP = 512, \fBMATRIX_SHAPE_ERROR\fP = 600, \fBOUT_OF_RANGE_ERROR\fP, \fBSOLVER_ERROR\fP = 700, \fBNORMALIZATION_ERROR\fP = 730, \fBNORMALIZATION_VECTOR_SIZE_MISMATCH\fP, \fBNORMALIZATION_BUFFER_OVERLAP\fP, \fBPRECONDITIONER_ERROR\fP = 750, \fBPRECONDITIONER_INVALID_OPTIONS\fP, \fBPRECONDITIONER_INVALID_OPERATOR\fP, \fBPRECONDITIONER_SIZE_MISMATCH\fP, \fBPRECONDITIONER_NONFINITE_VALUE\fP, \fBPRECONDITIONER_SINGULAR_OPERATOR\fP, \fBPRECONDITIONER_ILL_CONDITIONED_OPERATOR\fP, \fBPRECONDITIONER_STALE_LINEARIZATION\fP, \fBPRECONDITIONER_INCOMPATIBLE_STRATEGY\fP, \fBPRECONDITIONER_UNPREPARED\fP, \fBPRECONDITIONER_INVALID_CALIBRATION\fP, \fBEQUATION_ERROR\fP = 800, \fBFAILED_TYPE_INVARIANT\fP = 1000 }"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<\fBSERiFErrorCode\fP code> std::string \fBformat_error_message\fP (const std::string_view message, auto\&.\&.\&. args)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<misc::concepts::IsException ExceptionT, \fBSERiFErrorCode\fP code> void \fBserif_error\fP (const std::string_view message, auto\&.\&.\&. args)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<\fBSERiFErrorCode\fP code, bool condition, \fBtypes::FixedString\fP message> constexpr void \fBserif_assert\fP ()"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<\fBSERiFErrorCode\fP code, misc::concepts::IsException ExceptionT = std::logic_error> void \fBserif_assert\fP (const bool condition, const std::string_view message, auto &&\&.\&.\&. args)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<\fBSERiFErrorCode\fP code, misc::concepts::IsException ExceptionT = std::logic_error> void \fBserif_ensure\fP (const bool condition, const std::string_view message, auto\&.\&.\&. args)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<\fBSERiFErrorCode\fP code, bool condition, \fBtypes::CTString\fP message> constexpr void \fBserif_ensure\fP ()"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Variables"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "auto \fBSERiFErrorCodeNameToTypeMap\fP = \fBmeta::enum_to_string_enum_map\fP<\fBSERiFErrorCode\fP>()"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "auto \fBSERiFErrorCodeTypeToNameMap\fP = \fBmeta::enum_to_enum_string_map\fP<\fBSERiFErrorCode\fP>()"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Enumeration Type Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "enum class \fBserif::utils::errors::SERiFErrorCode\fP : uint16_t\fR [strong]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
\fBEnumerator\fP
|
||
|
|
.in +1c
|
||
|
|
.TP
|
||
|
|
\f(BIUNKNOWN_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_ARGUMENT \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_QUADRATURE_ORDER \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_DOMAIN_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BINEGATIVE_VALUE_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BINON_FINITE_VALUE_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIJACOBIAN_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVERTED_JACOBIAN \fP
|
||
|
|
.TP
|
||
|
|
\f(BINON_FINITE_DETERMINATE \fP
|
||
|
|
.TP
|
||
|
|
\f(BIEOS_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIEOS_UNSUPPORTED_RELATION \fP
|
||
|
|
.TP
|
||
|
|
\f(BIEOS_UNSUPPORTED_DERIVATIVE \fP
|
||
|
|
.TP
|
||
|
|
\f(BIEOS_WRONG_INPUT_COUNT \fP
|
||
|
|
.TP
|
||
|
|
\f(BIEOS_WRONG_INPUT_QUANTITY \fP
|
||
|
|
.TP
|
||
|
|
\f(BIEOS_NONFINITE_INPUT \fP
|
||
|
|
.TP
|
||
|
|
\f(BIEOS_OUTSIDE_DOMAIN \fP
|
||
|
|
.TP
|
||
|
|
\f(BIEOS_NONFINITE_RESULT \fP
|
||
|
|
.TP
|
||
|
|
\f(BIEOS_INVALID_THERMODYNAMIC_INPUT \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_DIMENSION \fP
|
||
|
|
.TP
|
||
|
|
\f(BINON_FINITE_MAPPING_INPUT \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_REFERENCE_RADIUS \fP
|
||
|
|
.TP
|
||
|
|
\f(BIAT_COMPACTIFIED_INFINITY \fP
|
||
|
|
.TP
|
||
|
|
\f(BIOUTSIDE_REFERENCE_DOMAIN \fP
|
||
|
|
.TP
|
||
|
|
\f(BINON_FINITE_MAPPING_RESULT \fP
|
||
|
|
.TP
|
||
|
|
\f(BINON_POSITIVE_DETERMINATE \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_MAPPING \fP
|
||
|
|
.TP
|
||
|
|
\f(BIMISC_MAPPING_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_DOF_COUNT \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_ELEMENT_GEOMETRY \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_DOF_ORDERING \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_COMPACTIFICATION_RANK \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_COMPACTIFICATION_TYPE \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_COMPACTIFICATION_DERIVATIVE_TYPE \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_VACUUM_ELEMENT_ATTRIBUTE_ID \fP
|
||
|
|
.TP
|
||
|
|
\f(BIMISSING_EXTERIOR_MAP \fP
|
||
|
|
.TP
|
||
|
|
\f(BICOMPACTIFICATION_MISMATCH \fP
|
||
|
|
.TP
|
||
|
|
\f(BIMISSING_FACE_ELEMENT \fP
|
||
|
|
.TP
|
||
|
|
\f(BIJACOBIAN_SHAPE_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIMISSING_DISPLACEMENT_FINITE_ELEMENT_SPACE \fP
|
||
|
|
.TP
|
||
|
|
\f(BIMISMATCHED_MESHING_MAPS \fP
|
||
|
|
.TP
|
||
|
|
\f(BIIMPROPERLY_ORDERED_REFERENCE_RADII \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_COORDINATE_TOLERANCE \fP
|
||
|
|
.TP
|
||
|
|
\f(BIEVALUATOR_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BICACHE_FE_BINDING_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_ELEMENT_ID_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIELEMENT_NULLPTR_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIDISCRETIZATION_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BISCHEMA_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIINVALID_SCHEMA_ARGUMENTS \fP
|
||
|
|
.TP
|
||
|
|
\f(BIMATRIX_SHAPE_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIOUT_OF_RANGE_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BISOLVER_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BINORMALIZATION_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BINORMALIZATION_VECTOR_SIZE_MISMATCH \fP
|
||
|
|
.TP
|
||
|
|
\f(BINORMALIZATION_BUFFER_OVERLAP \fP
|
||
|
|
.TP
|
||
|
|
\f(BIPRECONDITIONER_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIPRECONDITIONER_INVALID_OPTIONS \fP
|
||
|
|
.TP
|
||
|
|
\f(BIPRECONDITIONER_INVALID_OPERATOR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIPRECONDITIONER_SIZE_MISMATCH \fP
|
||
|
|
.TP
|
||
|
|
\f(BIPRECONDITIONER_NONFINITE_VALUE \fP
|
||
|
|
.TP
|
||
|
|
\f(BIPRECONDITIONER_SINGULAR_OPERATOR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIPRECONDITIONER_ILL_CONDITIONED_OPERATOR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIPRECONDITIONER_STALE_LINEARIZATION \fP
|
||
|
|
.TP
|
||
|
|
\f(BIPRECONDITIONER_INCOMPATIBLE_STRATEGY \fP
|
||
|
|
.TP
|
||
|
|
\f(BIPRECONDITIONER_UNPREPARED \fP
|
||
|
|
.TP
|
||
|
|
\f(BIPRECONDITIONER_INVALID_CALIBRATION \fP
|
||
|
|
.TP
|
||
|
|
\f(BIEQUATION_ERROR \fP
|
||
|
|
.TP
|
||
|
|
\f(BIFAILED_TYPE_INVARIANT \fP
|
||
|
|
.SH "Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<\fBSERiFErrorCode\fP code> std::string serif::utils::errors::format_error_message (const std::string_view message, auto\&.\&.\&. args)"
|
||
|
|
|
||
|
|
.SS "template<\fBSERiFErrorCode\fP code, bool condition, \fBtypes::FixedString\fP message> void serif::utils::errors::serif_assert ()\fR [constexpr]\fP"
|
||
|
|
This is the feature flag for C++26 user defined static_assert messages\&.
|
||
|
|
.SS "template<\fBSERiFErrorCode\fP code, misc::concepts::IsException ExceptionT = std::logic_error> void serif::utils::errors::serif_assert (const bool condition, const std::string_view message, auto &&\&.\&.\&. args)"
|
||
|
|
|
||
|
|
.SS "template<\fBSERiFErrorCode\fP code, bool condition, \fBtypes::CTString\fP message> void serif::utils::errors::serif_ensure ()\fR [constexpr]\fP"
|
||
|
|
This is the feature flag for C++26 user defined static_assert messages\&.
|
||
|
|
.SS "template<\fBSERiFErrorCode\fP code, misc::concepts::IsException ExceptionT = std::logic_error> void serif::utils::errors::serif_ensure (const bool condition, const std::string_view message, auto\&.\&.\&. args)"
|
||
|
|
|
||
|
|
.SS "template<misc::concepts::IsException ExceptionT, \fBSERiFErrorCode\fP code> void serif::utils::errors::serif_error (const std::string_view message, auto\&.\&.\&. args)"
|
||
|
|
|
||
|
|
.SH "Variable Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "auto serif::utils::errors::SERiFErrorCodeNameToTypeMap = \fBmeta::enum_to_string_enum_map\fP<\fBSERiFErrorCode\fP>()\fR [inline]\fP"
|
||
|
|
|
||
|
|
.SS "auto serif::utils::errors::SERiFErrorCodeTypeToNameMap = \fBmeta::enum_to_enum_string_map\fP<\fBSERiFErrorCode\fP>()\fR [inline]\fP"
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|