MFEM  v3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mfem::CGSolver Class Reference

Conjugate gradient method. More...

#include <solvers.hpp>

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

Public Member Functions

 CGSolver ()
 
 CGSolver (MPI_Comm _comm)
 
virtual void SetOperator (const Operator &op)
 Also calls SetOperator for the preconditioner if there is one. More...
 
virtual void Mult (const Vector &x, Vector &y) const
 Operator application. More...
 
- Public Member Functions inherited from mfem::IterativeSolver
 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 ()
 
int GetConverged ()
 
double GetFinalNorm ()
 
virtual void SetPreconditioner (Solver &pr)
 This should be called before SetOperator. More...
 
- Public Member Functions inherited from mfem::Solver
 Solver (int s=0, bool iter_mode=false)
 
 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)
 
int Height () const
 Get the height (size of output) of the Operator. Synonym with NumRows. More...
 
int NumRows () const
 
int Width () const
 Get the width (size of input) of the Operator. Synonym with NumCols. More...
 
int NumCols () const
 
virtual void MultTranspose (const Vector &x, Vector &y) const
 Action of the transpose operator. More...
 
virtual OperatorGetGradient (const Vector &x) const
 Evaluate the gradient operator at the point x. More...
 
void PrintMatlab (std::ostream &out, int n=0, int m=0)
 Prints operator with input size n and output size m in matlab format. More...
 
virtual ~Operator ()
 

Protected Member Functions

void UpdateVectors ()
 
- Protected Member Functions inherited from mfem::IterativeSolver
double Dot (const Vector &x, const Vector &y) const
 
double Norm (const Vector &x) const
 

Protected Attributes

Vector r
 
Vector d
 
Vector z
 
- Protected Attributes inherited from mfem::IterativeSolver
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
 
int width
 

Additional Inherited Members

- Public Attributes inherited from mfem::Solver
bool iterative_mode
 If true, use the second argument of Mult as an initial guess. More...
 

Detailed Description

Conjugate gradient method.

Definition at line 109 of file solvers.hpp.

Constructor & Destructor Documentation

mfem::CGSolver::CGSolver ( )
inline

Definition at line 117 of file solvers.hpp.

mfem::CGSolver::CGSolver ( MPI_Comm  _comm)
inline

Definition at line 120 of file solvers.hpp.

Member Function Documentation

void mfem::CGSolver::Mult ( const Vector x,
Vector y 
) const
virtual

Operator application.

Implements mfem::Operator.

Definition at line 285 of file solvers.cpp.

virtual void mfem::CGSolver::SetOperator ( const Operator op)
inlinevirtual

Also calls SetOperator for the preconditioner if there is one.

Reimplemented from mfem::IterativeSolver.

Definition at line 123 of file solvers.hpp.

void mfem::CGSolver::UpdateVectors ( )
protected

Definition at line 278 of file solvers.cpp.

Member Data Documentation

Vector mfem::CGSolver::d
mutableprotected

Definition at line 112 of file solvers.hpp.

Vector mfem::CGSolver::r
mutableprotected

Definition at line 112 of file solvers.hpp.

Vector mfem::CGSolver::z
mutableprotected

Definition at line 112 of file solvers.hpp.


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