Data type for scaled Jacobi-type smoother of sparse matrix. More...

#include <sparsesmoothers.hpp>

Inheritance diagram for mfem::DSmoother:

Collaboration diagram for mfem::DSmoother:

Public Member Functions
	DSmoother (int t=0, double s=1., int it=1)
	Create Jacobi smoother. More...

	DSmoother (const SparseMatrix &a, int t=0, double s=1., int it=1)
	Create Jacobi smoother. More...

void	SetPositiveDiagonal (bool pos_diag=true)
	Replace diag entries with their abs values. Relevant only when type = 0. More...

virtual void	Mult (const Vector &x, Vector &y) const
	Matrix vector multiplication with Jacobi 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
void	InitTVectors (const Operator Po, const Operator Ri, const Operator *Pi, Vector &x, Vector &b, Vector &X, Vector &B) const
	Initializes memory for true vectors of linear system. More...

	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 MemoryClass	GetMemoryClass () const
	Return the MemoryClass preferred by the Operator. 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 void	AddMult (const Vector &x, Vector &y, const double a=1.0) const
	Operator application: `y+=A(x)` (default) or `y+=a*A(x)`. More...

virtual void	AddMultTranspose (const Vector &x, Vector &y, const double a=1.0) const
	Operator transpose application: `y+=A^t(x)` (default) or `y+=a*A^t(x)`. More...

virtual void	ArrayMult (const Array< const Vector > &X, Array< Vector > &Y) const
	Operator application on a matrix: `Y=A(X)`. More...

virtual void	ArrayMultTranspose (const Array< const Vector > &X, Array< Vector > &Y) const
	Action of the transpose operator on a matrix: `Y=A^t(X)`. More...

virtual void	ArrayAddMult (const Array< const Vector > &X, Array< Vector > &Y, const double a=1.0) const
	Operator application on a matrix: `Y+=A(X)` (default) or `Y+=a*A(X)`. More...

virtual void	ArrayAddMultTranspose (const Array< const Vector > &X, Array< Vector > &Y, const double a=1.0) const
	Operator transpose application on a matrix: `Y+=A^t(X)` (default) or `Y+=a*A^t(X)`. More...

virtual Operator &	GetGradient (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 void	AssembleDiagonal (Vector &diag) const
	Computes the diagonal entries into diag. Typically, this operation only makes sense for linear Operators. In some cases, only an approximation of the diagonal is computed. More...

virtual const Operator *	GetProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. `NULL` means identity. More...

virtual const Operator *	GetRestriction () const
	Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. `NULL` means identity. More...

virtual const Operator *	GetOutputProlongation () const
	Prolongation operator from linear algebra (linear system) vectors, to output vectors for the operator. `NULL` means identity. More...

virtual const Operator *	GetOutputRestrictionTranspose () const
	Transpose of GetOutputRestriction, directly available in this form to facilitate matrix-free RAP-type operators. More...

virtual const Operator *	GetOutputRestriction () const
	Restriction operator from output 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...

void	FormRectangularLinearSystem (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B)
	Form a column-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() or Operator::FormRectangularLinearSystem(). More...

void	FormSystemOperator (const Array< int > &ess_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this square operator. More...

void	FormRectangularSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator (including constraints). More...

void	FormDiscreteOperator (Operator *&A)
	Return in A a parallel (on truedofs) version of this rectangular operator. More...

void	PrintMatlab (std::ostream &out, int n, int m=0) const
	Prints operator with input size n and output size m in Matlab format. More...

virtual void	PrintMatlab (std::ostream &out) const
	Prints operator 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

double	scale

int	iterations

bool	use_abs_diag = false
	Uses abs values of the diagonal entries. Relevant only when type = 0. More...

Vector	z

Protected Attributes inherited from mfem::SparseSmoother
const SparseMatrix *	oper

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	DiagonalPolicy { DIAG_ZERO, DIAG_ONE, DIAG_KEEP }
	Defines operator diagonal policy upon elimination of rows and/or columns. More...

enum	Type { ANY_TYPE, MFEM_SPARSEMAT, Hypre_ParCSR, PETSC_MATAIJ, PETSC_MATIS, PETSC_MATSHELL, PETSC_MATNEST, PETSC_MATHYPRE, PETSC_MATGENERIC, Complex_Operator, MFEM_ComplexSparseMat, Complex_Hypre_ParCSR, Complex_DenseMat, MFEM_Block_Matrix, MFEM_Block_Operator }
	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...

Protected Member Functions inherited from mfem::Operator
void	FormConstrainedSystemOperator (const Array< int > &ess_tdof_list, ConstrainedOperator *&Aout)
	see FormSystemOperator() More...

void	FormRectangularConstrainedSystemOperator (const Array< int > &trial_tdof_list, const Array< int > &test_tdof_list, RectangularConstrainedOperator *&Aout)
	see FormRectangularSystemOperator() More...

Operator *	SetupRAP (const Operator Pi, const Operator Po)
	Returns RAP Operator of this, using input/output Prolongation matrices Pi corresponds to "P", Po corresponds to "Rt". More...

Detailed Description

Data type for scaled Jacobi-type smoother of sparse matrix.

Definition at line 55 of file sparsesmoothers.hpp.

Constructor & Destructor Documentation

◆ DSmoother() [1/2]

mfem::DSmoother::DSmoother	(	int	t = `0`,
		double	s = `1.`,
		int	it = `1`
	)

inline

Create Jacobi smoother.

Definition at line 68 of file sparsesmoothers.hpp.

◆ DSmoother() [2/2]

mfem::DSmoother::DSmoother	(	const SparseMatrix &	a,
		int	t = `0`,
		double	s = `1.`,
		int	it = `1`
	)

Create Jacobi smoother.

Create the Jacobi smoother.

Definition at line 55 of file sparsesmoothers.cpp.

Member Function Documentation

◆ Mult()

void mfem::DSmoother::Mult	(	const Vector &	x,
		Vector &	y
	)		const

virtual

Matrix vector multiplication with Jacobi smoother.

Implements mfem::Operator.

Definition at line 64 of file sparsesmoothers.cpp.

◆ SetPositiveDiagonal()

void mfem::DSmoother::SetPositiveDiagonal ( bool pos_diag = true )

inline

Replace diag entries with their abs values. Relevant only when type = 0.

Definition at line 75 of file sparsesmoothers.hpp.

Member Data Documentation

◆ iterations

int mfem::DSmoother::iterations

protected

Definition at line 60 of file sparsesmoothers.hpp.

◆ scale

double mfem::DSmoother::scale

protected

Definition at line 59 of file sparsesmoothers.hpp.

◆ type

int mfem::DSmoother::type

protected

Definition at line 58 of file sparsesmoothers.hpp.

◆ use_abs_diag

bool mfem::DSmoother::use_abs_diag = false

protected

Uses abs values of the diagonal entries. Relevant only when type = 0.

Definition at line 62 of file sparsesmoothers.hpp.

◆ z

Vector mfem::DSmoother::z

mutableprotected

Definition at line 64 of file sparsesmoothers.hpp.

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

linalg/sparsesmoothers.hpp
linalg/sparsesmoothers.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DSmoother() [1/2]

◆ DSmoother() [2/2]

Member Function Documentation

◆ Mult()

◆ SetPositiveDiagonal()

Member Data Documentation

◆ iterations

◆ scale

◆ type

◆ use_abs_diag

◆ z