MFEM  v3.1
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::GSSmoother Class Reference

Data type for Gauss-Seidel smoother of sparse matrix. More...

#include <sparsesmoothers.hpp>

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

Public Member Functions

 GSSmoother (int t=0, int it=1)
 Create GSSmoother. More...
 
 GSSmoother (const SparseMatrix &a, int t=0, int it=1)
 Create GSSmoother. More...
 
virtual void Mult (const Vector &x, Vector &y) const
 Matrix vector multiplication with GS Smoother. More...
 
- Public Member Functions inherited from mfem::SparseSmoother
 SparseSmoother ()
 
 SparseSmoother (const SparseMatrix &a)
 
virtual void SetOperator (const Operator &a)
 Set/update the solver for the given operator. More...
 
- Public Member Functions inherited from mfem::MatrixInverse
 MatrixInverse ()
 
 MatrixInverse (const Matrix &mat)
 Creates approximation of the inverse of square matrix. 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 Attributes

int type
 
int iterations
 
- Protected Attributes inherited from mfem::SparseSmoother
const SparseMatrixoper
 
- 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

Data type for Gauss-Seidel smoother of sparse matrix.

Definition at line 36 of file sparsesmoothers.hpp.

Constructor & Destructor Documentation

mfem::GSSmoother::GSSmoother ( int  t = 0,
int  it = 1 
)
inline

Create GSSmoother.

Definition at line 44 of file sparsesmoothers.hpp.

mfem::GSSmoother::GSSmoother ( const SparseMatrix a,
int  t = 0,
int  it = 1 
)
inline

Create GSSmoother.

Definition at line 47 of file sparsesmoothers.hpp.

Member Function Documentation

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

Matrix vector multiplication with GS Smoother.

Implements mfem::Operator.

Definition at line 35 of file sparsesmoothers.cpp.

Member Data Documentation

int mfem::GSSmoother::iterations
protected

Definition at line 40 of file sparsesmoothers.hpp.

int mfem::GSSmoother::type
protected

Definition at line 39 of file sparsesmoothers.hpp.


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