Discontinuous Galerkin Library
#include "dg/algorithm.h"
dg::Fail Struct Reference

Indicate failure to converge. More...

Inheritance diagram for dg::Fail:
[legend]

Public Member Functions

 Fail (double eps)
 Construct from error limit. More...
 
 Fail (double eps, const Message &m)
 Construct from error limit. More...
 
double epsilon () const
 Return error limit. More...
 
virtual ~Fail () throw ()
 
- Public Member Functions inherited from dg::Error
 Error (const Message &message)
 Constructor. More...
 
std::string get_message () const
 
void append (const Message &message)
 Appends a message verbatim to the what string. More...
 
void append_line (const Message &message)
 Appends a newline and a message verbatim to the what string. More...
 
virtual const char * what () const throw ()
 
virtual ~Error () throw ()
 

Detailed Description

Indicate failure to converge.

Constructor & Destructor Documentation

◆ Fail() [1/2]

dg::Fail::Fail ( double  eps)
inline

Construct from error limit.

Parameters
epsaccuracy not reached

◆ Fail() [2/2]

dg::Fail::Fail ( double  eps,
const Message m 
)
inline

Construct from error limit.

Parameters
epsaccuracy not reached
madditional message

◆ ~Fail()

virtual dg::Fail::~Fail ( )
throw (
)
inlinevirtual

Member Function Documentation

◆ epsilon()

double dg::Fail::epsilon ( ) const
inline

Return error limit.

Returns
eps

The documentation for this struct was generated from the following file: