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.

Constructor & Destructor Documentation

NewtonSolverError() [1/3]

oomph::NewtonSolverError::NewtonSolverError ( )

inline

Default constructor, does nothing.

                        : linear_solver_error(false), iterations(0), maxres(0.0)
    {
    }

NewtonSolverError() [2/3]

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

inline

Constructor that passes a failure of the linear solver.

      : linear_solver_error(Passed_linear_failure), iterations(0), maxres(0.0)
    {
    }

NewtonSolverError() [3/3]

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

inline

Constructor that passes number of iterations and residuals.

      : linear_solver_error(false),
        iterations(Passed_iterations),
        maxres(Passed_maxres)
    {
    }

Member Data Documentation

iterations

unsigned oomph::NewtonSolverError::iterations

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

linear_solver_error

bool oomph::NewtonSolverError::linear_solver_error

Error in the linear solver.

maxres

double oomph::NewtonSolverError::maxres

Max. residual when Newton solver died.

---

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

• problem.h