Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Belos::CGIterationInitFailure Class Reference

CGIterationInitFailure is thrown when the CGIteration object is unable to generate an initial iterate in the CGIteration::initialize() routine. More...

#include <BelosCGIteration.hpp>

Inheritance diagram for Belos::CGIterationInitFailure:
Inheritance graph
[legend]

Public Member Functions

 CGIterationInitFailure (const std::string &what_arg)
 
- Public Member Functions inherited from Belos::BelosError
 BelosError (const std::string &what_arg)
 

Detailed Description

CGIterationInitFailure is thrown when the CGIteration object is unable to generate an initial iterate in the CGIteration::initialize() routine.

This std::exception is thrown from the CGIteration::initialize() method, which is called by the user or from the CGIteration::iterate() method if isInitialized() == false.

In the case that this std::exception is thrown, CGIteration::isInitialized() will be false and the user will need to provide a new initial iterate to the iteration.

Definition at line 96 of file BelosCGIteration.hpp.

Constructor & Destructor Documentation

Belos::CGIterationInitFailure::CGIterationInitFailure ( const std::string &  what_arg)
inline

Definition at line 97 of file BelosCGIteration.hpp.


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

Generated on Mon Nov 4 2024 09:26:15 for Belos by doxygen 1.8.5