MFEM  v4.2.0
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Attributes | List of all members
mfem::IterativeSolverMonitor Class Reference

Abstract base class for an iterative solver monitor. More...

#include <solvers.hpp>

Inheritance diagram for mfem::IterativeSolverMonitor:
[legend]
Collaboration diagram for mfem::IterativeSolverMonitor:
[legend]

Public Member Functions

 IterativeSolverMonitor ()
 
virtual ~IterativeSolverMonitor ()
 
virtual void MonitorResidual (int it, double norm, const Vector &r, bool final)
 Monitor the residual vector r. More...
 
virtual void MonitorSolution (int it, double norm, const Vector &x, bool final)
 Monitor the solution vector x. More...
 
void SetIterativeSolver (const IterativeSolver &solver)
 This method is invoked by ItertiveSolver::SetMonitor, informing the monitor which IterativeSolver is using it. More...
 

Protected Attributes

class IterativeSolveriter_solver
 The last IterativeSolver to which this monitor was attached. More...
 

Detailed Description

Abstract base class for an iterative solver monitor.

Definition at line 34 of file solvers.hpp.

Constructor & Destructor Documentation

mfem::IterativeSolverMonitor::IterativeSolverMonitor ( )
inline

Definition at line 41 of file solvers.hpp.

virtual mfem::IterativeSolverMonitor::~IterativeSolverMonitor ( )
inlinevirtual

Definition at line 43 of file solvers.hpp.

Member Function Documentation

virtual void mfem::IterativeSolverMonitor::MonitorResidual ( int  it,
double  norm,
const Vector r,
bool  final 
)
inlinevirtual

Monitor the residual vector r.

Reimplemented in mfem::ResidualBCMonitor.

Definition at line 46 of file solvers.hpp.

virtual void mfem::IterativeSolverMonitor::MonitorSolution ( int  it,
double  norm,
const Vector x,
bool  final 
)
inlinevirtual

Monitor the solution vector x.

Definition at line 52 of file solvers.hpp.

void mfem::IterativeSolverMonitor::SetIterativeSolver ( const IterativeSolver solver)
inline

This method is invoked by ItertiveSolver::SetMonitor, informing the monitor which IterativeSolver is using it.

Definition at line 59 of file solvers.hpp.

Member Data Documentation

class IterativeSolver* mfem::IterativeSolverMonitor::iter_solver
protected

The last IterativeSolver to which this monitor was attached.

Definition at line 38 of file solvers.hpp.


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