geosx::LinearSolverResult Struct Reference

Results/stats of a linear solve. More...

#include <LinearSolverResult.hpp>

Public Types
enum	Status { InProgress, Success, NotConverged, Breakdown }
	Status of the linear solve.

Public Member Functions
bool	success () const
	Check whether the last solve was successful. More...
bool	breakdown () const
	Check whether the last solve brokedown. More...

Public Attributes
Status	status = Status::InProgress
	convergence flag
integer	numIterations = 0
	Number of solver iterations performed.
real64	residualReduction = 0.0
	Final relative residual norm.
real64	setupTime = 0.0
	Setup time (in seconds) for preconditioners and/or direct factorizations.
real64	solveTime = 0.0
	Solve time (in seconds) exclusive of setup costs.

Detailed Description

Results/stats of a linear solve.

Lightweight struct to hold stats of a linear solve, such as convergence flag, number of iterations and residual norms.

Definition at line 35 of file LinearSolverResult.hpp.

Member Function Documentation

breakdown()

bool geosx::LinearSolverResult::breakdown ( ) const

inline

Check whether the last solve brokedown.

Returns

true if last solve brokedown, false otherwise

Definition at line 76 of file LinearSolverResult.hpp.

success()

bool geosx::LinearSolverResult::success ( ) const

inline

Check whether the last solve was successful.

Returns

true if last solve was successful, false otherwise

Definition at line 67 of file LinearSolverResult.hpp.

---

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

• coreComponents/linearAlgebra/utilities/LinearSolverResult.hpp