MFEM  v4.6.0
Finite element discretization library
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 IterativeSolver::SetMonitor, informing the monitor which IterativeSolver is using it. More...
 

Protected Attributes

const 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 36 of file solvers.hpp.

Constructor & Destructor Documentation

◆ IterativeSolverMonitor()

mfem::IterativeSolverMonitor::IterativeSolverMonitor ( )
inline

Definition at line 43 of file solvers.hpp.

◆ ~IterativeSolverMonitor()

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

Definition at line 45 of file solvers.hpp.

Member Function Documentation

◆ MonitorResidual()

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 48 of file solvers.hpp.

◆ MonitorSolution()

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

Monitor the solution vector x.

Definition at line 54 of file solvers.hpp.

◆ SetIterativeSolver()

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

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

Definition at line 61 of file solvers.hpp.

Member Data Documentation

◆ iter_solver

const class IterativeSolver* mfem::IterativeSolverMonitor::iter_solver
protected

The last IterativeSolver to which this monitor was attached.

Definition at line 40 of file solvers.hpp.


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