MFEM  v3.4
Finite element discretization library
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)
 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 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...
 
Type GetType () const
 Return the type ID of the Operator class. More...
 

Protected Attributes

int type
 
int iterations
 
- Protected Attributes inherited from mfem::SparseSmoother
const SparseMatrixoper
 
- 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 {
  ANY_TYPE, MFEM_SPARSEMAT, Hypre_ParCSR, PETSC_MATAIJ,
  PETSC_MATIS, PETSC_MATSHELL, PETSC_MATNEST, PETSC_MATHYPRE,
  PETSC_MATGENERIC
}
 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

Data type for Gauss-Seidel smoother of sparse matrix.

Definition at line 36 of file sparsesmoothers.hpp.

Constructor & Destructor Documentation

◆ GSSmoother() [1/2]

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

Create GSSmoother.

Definition at line 44 of file sparsesmoothers.hpp.

◆ GSSmoother() [2/2]

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

◆ Mult()

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

◆ iterations

int mfem::GSSmoother::iterations
protected

Definition at line 40 of file sparsesmoothers.hpp.

◆ type

int mfem::GSSmoother::type
protected

Definition at line 39 of file sparsesmoothers.hpp.


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