Parallel smoothers in hypre. More...

#include <hypre.hpp>

Inheritance diagram for mfem::HypreSmoother:

Collaboration diagram for mfem::HypreSmoother:

Public Types
enum	Type { Jacobi = 0, l1Jacobi = 1, l1GS = 2, l1GStr = 4, lumpedJacobi = 5, GS = 6, Chebyshev = 16, Taubin = 1001, FIR = 1002 }

Public Member Functions
	HypreSmoother ()

	HypreSmoother (HypreParMatrix &_A, int type=l1GS, int relax_times=1, double relax_weight=1.0, double omega=1.0, int poly_order=2, double poly_fraction=.3)

void	SetType (HypreSmoother::Type type, int relax_times=1)
	Set the relaxation type and number of sweeps. More...

void	SetSOROptions (double relax_weight, double omega)
	Set SOR-related parameters. More...

void	SetPolyOptions (int poly_order, double poly_fraction)
	Set parameters for polynomial smoothing. More...

void	SetTaubinOptions (double lambda, double mu, int iter)
	Set parameters for Taubin's lambda-mu method. More...

void	SetWindowByName (const char *window_name)
	Convenience function for setting canonical windowing parameters. More...

void	SetWindowParameters (double a, double b, double c)
	Set parameters for windowing function for FIR smoother. More...

void	SetFIRCoefficients (double max_eig)
	Compute window and Chebyshev coefficients for given polynomial order. More...

virtual void	SetOperator (const Operator &op)

virtual void	Mult (const HypreParVector &b, HypreParVector &x) const
	Relax the linear system Ax=b. More...

virtual void	Mult (const Vector &b, Vector &x) const
	Operator application. More...

virtual	~HypreSmoother ()

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 Operator &	GetGradient (const Vector &x) const
	Evaluate the gradient operator at the point x. 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 ()

Protected Attributes
HypreParMatrix *	A
	The linear system matrix. More...

HypreParVector *	B
	Right-hand side and solution vectors. More...

HypreParVector *	X

HypreParVector *	V
	Temporary vectors. More...

HypreParVector *	Z

HypreParVector *	X0
	FIR Filter Temporary Vectors. More...

HypreParVector *	X1

int	type

int	relax_times
	Number of relaxation sweeps. More...

double	relax_weight
	Damping coefficient (usually <= 1) More...

double	omega
	SOR parameter (usually in (0,2)) More...

int	poly_order
	Order of the smoothing polynomial. More...

double	poly_fraction
	Fraction of spectrum to smooth for polynomial relaxation. More...

int	poly_scale
	Apply the polynomial smoother to A or D^{-1/2} A D^{-1/2}. More...

double	lambda
	Taubin's lambda-mu method parameters. More...

double	mu

int	taubin_iter

double *	l1_norms
	l1 norms of the rows of A More...

double	max_eig_est
	Maximal eigenvalue estimate for polynomial smoothing. More...

double	min_eig_est
	Minimal eigenvalue estimate for polynomial smoothing. More...

double	window_params [3]
	Parameters for windowing function of FIR filter. More...

double *	fir_coeffs
	Combined coefficients for windowing and Chebyshev polynomials. More...

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

Parallel smoothers in hypre.

Definition at line 433 of file hypre.hpp.

Member Enumeration Documentation

enum mfem::HypreSmoother::Type

Hypre smoother types: 0 = Jacobi 1 = l1-scaled Jacobi 2 = l1-scaled block Gauss-Seidel/SSOR 4 = truncated l1-scaled block Gauss-Seidel/SSOR 5 = lumped Jacobi 6 = Gauss-Seidel 16 = Chebyshev 1001 = Taubin polynomial smoother 1002 = FIR polynomial smoother.

Enumerator
Jacobi
l1Jacobi
l1GS
l1GStr
lumpedJacobi
GS
Chebyshev
Taubin
FIR

Definition at line 489 of file hypre.hpp.

Constructor & Destructor Documentation

mfem::HypreSmoother::HypreSmoother ( )

Definition at line 1580 of file hypre.cpp.

mfem::HypreSmoother::HypreSmoother	(	HypreParMatrix &	_A,
		int	type = `l1GS`,
		int	relax_times = `1`,
		double	relax_weight = `1.0`,
		double	omega = `1.0`,
		int	poly_order = `2`,
		double	poly_fraction = `.3`
	)

Definition at line 1598 of file hypre.cpp.

mfem::HypreSmoother::~HypreSmoother ( )

virtual

Definition at line 1865 of file hypre.cpp.

Member Function Documentation

void mfem::HypreSmoother::Mult	(	const HypreParVector &	b,
		HypreParVector &	x
	)		const

virtual

Relax the linear system Ax=b.

Definition at line 1775 of file hypre.cpp.

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

virtual

Operator application.

Implements mfem::Operator.

Definition at line 1838 of file hypre.cpp.

void mfem::HypreSmoother::SetFIRCoefficients ( double max_eig )

Compute window and Chebyshev coefficients for given polynomial order.

Definition at line 1735 of file hypre.cpp.

void mfem::HypreSmoother::SetOperator ( const Operator & op )

virtual

Set/update the associated operator. Must be called after setting the HypreSmoother type and options.

Implements mfem::Solver.

Definition at line 1665 of file hypre.cpp.

void mfem::HypreSmoother::SetPolyOptions	(	int	poly_order,
		double	poly_fraction
	)

Set parameters for polynomial smoothing.

Definition at line 1629 of file hypre.cpp.

void mfem::HypreSmoother::SetSOROptions	(	double	relax_weight,
		double	omega
	)

Set SOR-related parameters.

Definition at line 1623 of file hypre.cpp.

void mfem::HypreSmoother::SetTaubinOptions	(	double	lambda,
		double	mu,
		int	iter
	)

Set parameters for Taubin's lambda-mu method.

Definition at line 1635 of file hypre.cpp.

void mfem::HypreSmoother::SetType	(	HypreSmoother::Type	type,
		int	relax_times = `1`
	)

Set the relaxation type and number of sweeps.

Definition at line 1617 of file hypre.cpp.

void mfem::HypreSmoother::SetWindowByName ( const char * window_name )

Convenience function for setting canonical windowing parameters.

Definition at line 1643 of file hypre.cpp.

void mfem::HypreSmoother::SetWindowParameters	(	double	a,
		double	b,
		double	c
	)

Set parameters for windowing function for FIR smoother.

Definition at line 1658 of file hypre.cpp.

Member Data Documentation

HypreParMatrix* mfem::HypreSmoother::A

protected

The linear system matrix.

Definition at line 437 of file hypre.hpp.

HypreParVector* mfem::HypreSmoother::B

mutableprotected

Right-hand side and solution vectors.

Definition at line 439 of file hypre.hpp.

double* mfem::HypreSmoother::fir_coeffs

protected

Combined coefficients for windowing and Chebyshev polynomials.

Definition at line 476 of file hypre.hpp.

double* mfem::HypreSmoother::l1_norms

protected

l1 norms of the rows of A

Definition at line 467 of file hypre.hpp.

double mfem::HypreSmoother::lambda

protected

Taubin's lambda-mu method parameters.

Definition at line 462 of file hypre.hpp.

double mfem::HypreSmoother::max_eig_est

protected

Maximal eigenvalue estimate for polynomial smoothing.

Definition at line 469 of file hypre.hpp.

double mfem::HypreSmoother::min_eig_est

protected

Minimal eigenvalue estimate for polynomial smoothing.

Definition at line 471 of file hypre.hpp.

double mfem::HypreSmoother::mu

protected

Definition at line 463 of file hypre.hpp.

double mfem::HypreSmoother::omega

protected

SOR parameter (usually in (0,2))

Definition at line 453 of file hypre.hpp.

double mfem::HypreSmoother::poly_fraction

protected

Fraction of spectrum to smooth for polynomial relaxation.

Definition at line 457 of file hypre.hpp.

int mfem::HypreSmoother::poly_order

protected

Order of the smoothing polynomial.

Definition at line 455 of file hypre.hpp.

int mfem::HypreSmoother::poly_scale

protected

Apply the polynomial smoother to A or D^{-1/2} A D^{-1/2}.

Definition at line 459 of file hypre.hpp.

int mfem::HypreSmoother::relax_times

protected

Number of relaxation sweeps.

Definition at line 449 of file hypre.hpp.

double mfem::HypreSmoother::relax_weight

protected

Damping coefficient (usually <= 1)

Definition at line 451 of file hypre.hpp.

int mfem::HypreSmoother::taubin_iter

protected

Definition at line 464 of file hypre.hpp.

int mfem::HypreSmoother::type

protected

Smoother type from hypre_ParCSRRelax() in ams.c plus extensions, see the enumeration Type below.

Definition at line 447 of file hypre.hpp.

HypreParVector* mfem::HypreSmoother::V

mutableprotected

Temporary vectors.

Definition at line 441 of file hypre.hpp.

double mfem::HypreSmoother::window_params[3]

protected

Parameters for windowing function of FIR filter.

Definition at line 473 of file hypre.hpp.

HypreParVector * mfem::HypreSmoother::X

mutableprotected

Definition at line 439 of file hypre.hpp.

HypreParVector* mfem::HypreSmoother::X0

mutableprotected

FIR Filter Temporary Vectors.

Definition at line 443 of file hypre.hpp.

HypreParVector * mfem::HypreSmoother::X1

mutableprotected

Definition at line 443 of file hypre.hpp.

HypreParVector * mfem::HypreSmoother::Z

mutableprotected

Definition at line 441 of file hypre.hpp.

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

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation