MFEM  v3.3
Finite element discretization library
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mfem::IterativeSolver Class Reference

Abstract base class for iterative solver. More...

#include <solvers.hpp>

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

Public Member Functions

 IterativeSolver ()
 
 IterativeSolver (MPI_Comm _comm)
 
void SetRelTol (double rtol)
 
void SetAbsTol (double atol)
 
void SetMaxIter (int max_it)
 
void SetPrintLevel (int print_lvl)
 
int GetNumIterations () const
 
int GetConverged () const
 
double GetFinalNorm () const
 
virtual void SetPreconditioner (Solver &pr)
 This should be called before SetOperator. More...
 
virtual void SetOperator (const Operator &op)
 Also calls SetOperator for the preconditioner if there is one. More...
 
- Public Member Functions inherited from mfem::Solver
 Solver (int s=0, bool iter_mode=false)
 Initialize a square Solver with size s. More...
 
 Solver (int h, int w, bool iter_mode=false)
 Initialize a Solver with height h and width w. More...
 
- Public Member Functions inherited from mfem::Operator
 Operator (int s=0)
 Construct a square Operator with given size s (default 0). More...
 
 Operator (int h, int w)
 Construct an Operator with the given height (output size) and width (input size). More...
 
int Height () const
 Get the height (size of output) of the Operator. Synonym with NumRows(). More...
 
int NumRows () const
 Get the number of rows (size of output) of the Operator. Synonym with Height(). More...
 
int Width () const
 Get the width (size of input) of the Operator. Synonym with NumCols(). More...
 
int NumCols () const
 Get the number of columns (size of input) of the Operator. Synonym with Width(). More...
 
virtual void Mult (const Vector &x, Vector &y) const =0
 Operator application: y=A(x). More...
 
virtual void MultTranspose (const Vector &x, Vector &y) const
 Action of the transpose operator: y=A^t(x). The default behavior in class Operator is to generate an error. More...
 
virtual OperatorGetGradient (const Vector &x) const
 Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error. More...
 
virtual const OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More...
 
void FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B, int copy_interior=0)
 Form a constrained linear system using a matrix-free approach. More...
 
virtual void RecoverFEMSolution (const Vector &X, const Vector &b, Vector &x)
 Reconstruct a solution vector x (e.g. a GridFunction) from the solution X of a constrained linear system obtained from Operator::FormLinearSystem(). More...
 
void PrintMatlab (std::ostream &out, int n=0, int m=0) const
 Prints operator with input size n and output size m in Matlab format. More...
 
virtual ~Operator ()
 Virtual destructor. More...
 

Protected Member Functions

double Dot (const Vector &x, const Vector &y) const
 
double Norm (const Vector &x) const
 

Protected Attributes

const Operatoroper
 
Solverprec
 
int max_iter
 
int print_level
 
double rel_tol
 
double abs_tol
 
int final_iter
 
int converged
 
double final_norm
 
- Protected Attributes inherited from mfem::Operator
int height
 Dimension of the output / number of rows in the matrix. More...
 
int width
 Dimension of the input / number of columns in the matrix. More...
 

Additional Inherited Members

- Public Types inherited from mfem::Operator
enum  Type {
  MFEM_SPARSEMAT, HYPRE_PARCSR, PETSC_MATAIJ, PETSC_MATIS,
  PETSC_MATSHELL, PETSC_MATNEST
}
 Enumeration defining IDs for some classes derived from Operator. More...
 
- Public Attributes inherited from mfem::Solver
bool iterative_mode
 If true, use the second argument of Mult() as an initial guess. More...
 

Detailed Description

Abstract base class for iterative solver.

Definition at line 32 of file solvers.hpp.

Constructor & Destructor Documentation

mfem::IterativeSolver::IterativeSolver ( )

Definition at line 23 of file solvers.cpp.

mfem::IterativeSolver::IterativeSolver ( MPI_Comm  _comm)

Definition at line 37 of file solvers.cpp.

Member Function Documentation

double mfem::IterativeSolver::Dot ( const Vector x,
const Vector y 
) const
protected

Definition at line 50 of file solvers.cpp.

int mfem::IterativeSolver::GetConverged ( ) const
inline

Definition at line 67 of file solvers.hpp.

double mfem::IterativeSolver::GetFinalNorm ( ) const
inline

Definition at line 68 of file solvers.hpp.

int mfem::IterativeSolver::GetNumIterations ( ) const
inline

Definition at line 66 of file solvers.hpp.

double mfem::IterativeSolver::Norm ( const Vector x) const
inlineprotected

Definition at line 52 of file solvers.hpp.

void mfem::IterativeSolver::SetAbsTol ( double  atol)
inline

Definition at line 62 of file solvers.hpp.

void mfem::IterativeSolver::SetMaxIter ( int  max_it)
inline

Definition at line 63 of file solvers.hpp.

void mfem::IterativeSolver::SetOperator ( const Operator op)
virtual

Also calls SetOperator for the preconditioner if there is one.

Implements mfem::Solver.

Reimplemented in mfem::KinSolver, mfem::SLBQPOptimizer, mfem::NewtonSolver, mfem::MINRESSolver, mfem::BiCGSTABSolver, mfem::CGSolver, and mfem::SLISolver.

Definition at line 98 of file solvers.cpp.

void mfem::IterativeSolver::SetPreconditioner ( Solver pr)
virtual

This should be called before SetOperator.

Reimplemented in mfem::KinSolver, mfem::SLBQPOptimizer, and mfem::MINRESSolver.

Definition at line 92 of file solvers.cpp.

void mfem::IterativeSolver::SetPrintLevel ( int  print_lvl)

Definition at line 71 of file solvers.cpp.

void mfem::IterativeSolver::SetRelTol ( double  rtol)
inline

Definition at line 61 of file solvers.hpp.

Member Data Documentation

double mfem::IterativeSolver::abs_tol
protected

Definition at line 45 of file solvers.hpp.

int mfem::IterativeSolver::converged
mutableprotected

Definition at line 48 of file solvers.hpp.

int mfem::IterativeSolver::final_iter
mutableprotected

Definition at line 48 of file solvers.hpp.

double mfem::IterativeSolver::final_norm
mutableprotected

Definition at line 49 of file solvers.hpp.

int mfem::IterativeSolver::max_iter
protected

Definition at line 44 of file solvers.hpp.

const Operator* mfem::IterativeSolver::oper
protected

Definition at line 41 of file solvers.hpp.

Solver* mfem::IterativeSolver::prec
protected

Definition at line 42 of file solvers.hpp.

int mfem::IterativeSolver::print_level
protected

Definition at line 44 of file solvers.hpp.

double mfem::IterativeSolver::rel_tol
protected

Definition at line 45 of file solvers.hpp.


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