A class to handle errors in the Newton solver. More...
#include <problem.h>
Inheritance diagram for oomph::NewtonSolverError:
Public Member Functions | |
| NewtonSolverError () | |
| Default constructor, does nothing. More... | |
| NewtonSolverError (const bool &Passed_linear_failure) | |
| Constructor that passes a failure of the linear solver. More... | |
| NewtonSolverError (unsigned Passed_iterations, double Passed_maxres) | |
| Constructor that passes number of iterations and residuals. More... | |
| bool | linear_solver_error () |
| Access function to the error in the linear solver. More... | |
| unsigned | iterations () |
| Access function to Max. # of iterations performed when the Newton solver died. More... | |
| double | maxres () |
| Access function to Max. residual when Newton solver died. More... | |
| Public Member Functions inherited from oomph::OomphLibError | |
| OomphLibError (const std::string &error_description, const std::string &function_name, const char *location) | |
| Constructor requires the error description and the function in which the error occured and the location provided by the OOMPH_EXCEPTION_LOCATION macro. More... | |
| Public Member Functions inherited from oomph::OomphLibException | |
| void | disable_error_message () |
| Suppress issueing of the error message in destructor (useful if error is caught successfully!) More... | |
Private Attributes | |
| bool | Linear_solver_error |
| Error in the linear solver. More... | |
| unsigned | Iterations |
| Max. # of iterations performed when the Newton solver died. More... | |
| double | Maxres |
| Max. residual when Newton solver died. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from oomph::OomphLibError | |
| static void | set_stream_pt (std::ostream *const &stream_pt) |
| Static member function used to specify the error stream, which must be passed as a pointer because streams cannot be copied. More... | |
| static void | set_output_width (const unsigned &output_width) |
| Static member function used to specify the width (in characters) of the error stream. More... | |
| Protected Member Functions inherited from oomph::OomphLibException | |
| OomphLibException (const std::string &error_description, const std::string &function_name, const char *location, const std::string &exception_type, std::ostream &exception_stream, const unsigned &output_width, bool list_trace_back) | |
| Constructor takes the error description, function name and a location string provided by the OOMPH_EXCEPTION_LOCATION macro and combines them into a standard header. The exception type will be the string "WARNING" or "ERROR" and the message is written to the exception_stream, with a specified output_width. Optionally provide a traceback of the function calls. More... | |
| ~OomphLibException () throw () | |
| The destructor cannot throw an exception (C++ STL standard) More... | |
| Protected Attributes inherited from oomph::OomphLibException | |
| std::ostream * | Exception_stream_pt |
| Exception stream to which we write message in destructor. More... | |
| std::stringstream * | Exception_stringstream_pt |
| String stream that records the error message. More... | |
| bool | Suppress_error_message |
| Boolean to suppress issuing of the error message in destructor (useful if error is caught successfully!) More... | |
Detailed Description
Constructor & Destructor Documentation
◆ NewtonSolverError() [1/3]
|
inline |
◆ NewtonSolverError() [2/3]
|
inline |
◆ NewtonSolverError() [3/3]
|
inline |
Member Function Documentation
◆ iterations()
|
inline |
Access function to Max. # of iterations performed when the Newton solver died.
Definition at line 3110 of file problem.h.
References Iterations.
Referenced by oomph::Problem::newton_solve(), oomph::Problem::steady_newton_solve(), and oomph::Problem::unsteady_newton_solve().
◆ linear_solver_error()
|
inline |
Access function to the error in the linear solver.
Definition at line 3103 of file problem.h.
References Linear_solver_error.
Referenced by oomph::Problem::adaptive_unsteady_newton_solve(), oomph::Problem::arc_length_step_solve_helper(), oomph::Problem::steady_newton_solve(), and oomph::Problem::unsteady_newton_solve().
◆ maxres()
|
inline |
Access function to Max. residual when Newton solver died.
Definition at line 3116 of file problem.h.
References Maxres.
Referenced by oomph::Problem::newton_solve(), oomph::Problem::steady_newton_solve(), and oomph::Problem::unsteady_newton_solve().
Member Data Documentation
◆ Iterations
|
private |
Max. # of iterations performed when the Newton solver died.
Definition at line 3063 of file problem.h.
Referenced by iterations().
◆ Linear_solver_error
|
private |
Error in the linear solver.
Definition at line 3060 of file problem.h.
Referenced by linear_solver_error().
◆ Maxres
|
private |
The documentation for this class was generated from the following file: