Public Member Functions | Public Attributes | List of all members
oomph::NewtonSolverError Class Reference

A class to handle errors in the Newton solver. More...

#include <problem.h>

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...
 

Public 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...
 

Detailed Description

A class to handle errors in the Newton solver.

Definition at line 3080 of file problem.h.

Constructor & Destructor Documentation

◆ NewtonSolverError() [1/3]

oomph::NewtonSolverError::NewtonSolverError ( )
inline

Default constructor, does nothing.

Definition at line 3093 of file problem.h.

◆ NewtonSolverError() [2/3]

oomph::NewtonSolverError::NewtonSolverError ( const bool &  Passed_linear_failure)
inline

Constructor that passes a failure of the linear solver.

Definition at line 3098 of file problem.h.

◆ NewtonSolverError() [3/3]

oomph::NewtonSolverError::NewtonSolverError ( unsigned  Passed_iterations,
double  Passed_maxres 
)
inline

Constructor that passes number of iterations and residuals.

Definition at line 3104 of file problem.h.

Member Data Documentation

◆ iterations

unsigned oomph::NewtonSolverError::iterations

Max. # of iterations performed when the Newton solver died.

Definition at line 3087 of file problem.h.

Referenced by oomph::Problem::newton_solve(), oomph::Problem::steady_newton_solve(), and oomph::Problem::unsteady_newton_solve().

◆ linear_solver_error

bool oomph::NewtonSolverError::linear_solver_error

Error in the linear solver.

Definition at line 3084 of file problem.h.

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

double oomph::NewtonSolverError::maxres

Max. residual when Newton solver died.

Definition at line 3090 of file problem.h.

Referenced by oomph::Problem::newton_solve(), oomph::Problem::steady_newton_solve(), and oomph::Problem::unsteady_newton_solve().

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