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)
41 lines
1.1 KiB
Groff
41 lines
1.1 KiB
Groff
.TH "serif::eos::EOSEvaluationError" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::eos::EOSEvaluationError \- An exception class to represent errors that occur during the evaluation of an EOS model\&. This class inherits from std::domain_error and is used to provide a more specific exception type for EOS evaluation errors\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <exceptions\&.hpp>\fP
|
|
.PP
|
|
Inherits std::domain_error\&.
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBEOSEvaluationError\fP (std::string message)"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
An exception class to represent errors that occur during the evaluation of an EOS model\&. This class inherits from std::domain_error and is used to provide a more specific exception type for EOS evaluation errors\&.
|
|
|
|
|
|
.PP
|
|
\fBTodo\fP
|
|
.RS 4
|
|
We have moved away from custom error types, this may warrant removal\&.
|
|
.RE
|
|
.PP
|
|
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "serif::eos::EOSEvaluationError::EOSEvaluationError (std::string message)\fR [inline]\fP, \fR [explicit]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|