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)
35 lines
975 B
Groff
35 lines
975 B
Groff
.TH "serif::solver::preconditioner::Failure" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::preconditioner::Failure \- A recoverable preparation failure, including the numerical reason and how to correct it\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <failure\&.hpp>\fP
|
|
.SS "Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fButils::errors::SERiFErrorCode\fP \fBcode\fP {\fButils::errors::SERiFErrorCode::PRECONDITIONER_ERROR\fP}"
|
|
.br
|
|
.ti -1c
|
|
.RI "std::string \fBmessage\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
A recoverable preparation failure, including the numerical reason and how to correct it\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "\fButils::errors::SERiFErrorCode\fP serif::solver::preconditioner::Failure::code {\fButils::errors::SERiFErrorCode::PRECONDITIONER_ERROR\fP}"
|
|
|
|
.SS "std::string serif::solver::preconditioner::Failure::message"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|