Ifpack_Polynomial: class for preconditioning with least squares polynomials in Ifpack. More...

#include <Ifpack_Polynomial.h>

Inheritance diagram for Ifpack_Polynomial:

Collaboration diagram for Ifpack_Polynomial:

Public Member Functions
virtual int	SetUseTranspose (bool UseTranspose_in)


	Ifpack_Polynomial (const Epetra_Operator *Matrix)
	Ifpack_Polynomial constructor with given Epetra_Operator/Epetra_RowMatrix. More...

	Ifpack_Polynomial (const Epetra_RowMatrix *Matrix)
	Ifpack_Polynomial constructor with given Epetra_Operator/Epetra_RowMatrix. More...

virtual	~Ifpack_Polynomial ()
	Destructor.


virtual int	Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Applies the matrix to an Epetra_MultiVector. More...

virtual int	ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Applies the preconditioner to X, returns the result in Y. More...

virtual double	NormInf () const
	Returns the infinity norm of the global matrix (not implemented)


virtual const char *	Label () const

virtual bool	UseTranspose () const
	Returns the current UseTranspose setting.

virtual bool	HasNormInf () const
	Returns true if the this object can provide an approximate Inf-norm, false otherwise.

virtual const Epetra_Comm &	Comm () const
	Returns a pointer to the Epetra_Comm communicator associated with this operator.

virtual const Epetra_Map &	OperatorDomainMap () const
	Returns the Epetra_Map object associated with the domain of this operator.

virtual const Epetra_Map &	OperatorRangeMap () const
	Returns the Epetra_Map object associated with the range of this operator.

virtual int	Initialize ()
	Computes all it is necessary to initialize the preconditioner.

virtual bool	IsInitialized () const
	Returns true if the preconditioner has been successfully initialized, false otherwise.

virtual bool	IsComputed () const
	Returns `true` if the preconditioner has been successfully computed.

virtual int	Compute ()
	Computes the preconditioners.

virtual const Epetra_RowMatrix &	Matrix () const
	Returns a pointer to the matrix to be preconditioned.

virtual double	Condest (const Ifpack_CondestType CT=Ifpack_Cheap, const int MaxIters=1550, const double Tol=1e-9, Epetra_RowMatrix *Matrix_in=0)
	Computes the condition number estimates and returns the value.

virtual double	Condest () const
	Returns the condition number estimate, or -1.0 if not computed.

virtual int	SetParameters (Teuchos::ParameterList &List)
	Sets all the parameters for the preconditioner.

virtual std::ostream &	Print (std::ostream &os) const
	Prints object to an output stream.


virtual int	NumInitialize () const
	Returns the number of calls to Initialize().

virtual int	NumCompute () const
	Returns the number of calls to Compute().

virtual int	NumApplyInverse () const
	Returns the number of calls to ApplyInverse().

virtual double	InitializeTime () const
	Returns the time spent in Initialize().

virtual double	ComputeTime () const
	Returns the time spent in Compute().

virtual double	ApplyInverseTime () const
	Returns the time spent in ApplyInverse().

virtual double	InitializeFlops () const
	Returns the number of flops in the initialization phase.

virtual double	ComputeFlops () const
	Returns the number of flops in the computation phase.

virtual double	ApplyInverseFlops () const
	Returns the number of flops for the application of the preconditioner.

int	GMRES (const Epetra_Operator &Operator, const Epetra_Vector &InvPointDiagonal, const int MaximumIterations, double &lambda_real_min, double &lambda_real_max, double &lambda_imag_min, double &lambda_imag_max)
	Uses AztecOO's GMRES to estimate the height and width of the spectrum.

static int	PowerMethod (const Epetra_Operator &Operator, const Epetra_Vector &InvPointDiagonal, const int MaximumIterations, double &LambdaMax)
	Simple power method to compute lambda_max.

static int	CG (const Epetra_Operator &Operator, const Epetra_Vector &InvPointDiagonal, const int MaximumIterations, double &lambda_min, double &lambda_max)
	Uses AztecOO's CG to estimate lambda_min and lambda_max.

Detailed Description

Ifpack_Polynomial: class for preconditioning with least squares polynomials in Ifpack.

The Ifpack_Polynomial class enables the construction of preconditioners based on least squares polynomials for an Epetra_RowMatrix. Similar to Ifpack_Chebyshev, Ifpack_Polynomial is designed for indefinite linear systems.

The list of parameters is

RealEigRatio_ = List.get("polynomial: real eigenvalue ratio", RealEigRatio_);
ImagEigRatio_ = List.get("polynomial: imag eigenvalue ratio", ImagEigRatio_); these are the ratios to estimate the bounds on the spectrum (if the eigenvalue bounds aren't already given)
LambdaRealMin_ = List.get("polynomial: min real part", LambdaRealMin_);
LambdaRealMax_ = List.get("polynomial: max real part", LambdaRealMax_);
LambdaImagMin_ = List.get("polynomial: min imag part", LambdaImagMin_);
LambdaImagMax_ = List.get("polynomial: max imag part", LambdaImagMax_); these values define the rectangular region on which the polynomial will be minimized.
PolyDegree_ = List.get("polynomial: degree",PolyDegree_); this is the polynomial degree.
LSPointsReal_ = List.get("polynomial: real interp points",LSPointsReal_);
LSPointsImag_ = List.get("polynomial: imag interp points",LSPointsImag_); these are the number of points used in real and imaginary directions which will be used in the least squares problem.
MinDiagonalValue_ = List.get("polynomial: min diagonal value", MinDiagonalValue_); this defines the threshold for diagonal values under which they are not inverted
ZeroStartingSolution_ = List.get("polynomial: zero starting solution", ZeroStartingSolution_); this flag allows to set a non-zero initial guess.

Author: Paul Tsuji, May 2013.

Definition at line 99 of file Ifpack_Polynomial.h.

Constructor & Destructor Documentation

Ifpack_Polynomial::Ifpack_Polynomial ( const Epetra_Operator * Matrix )

Ifpack_Polynomial constructor with given Epetra_Operator/Epetra_RowMatrix.

Creates an instance of Ifpack_Polynomial class.

Parameters

Matrix - (In) Pointer to the operator to precondition.

Definition at line 86 of file Ifpack_Polynomial.cpp.

Ifpack_Polynomial::Ifpack_Polynomial ( const Epetra_RowMatrix * Matrix )

Ifpack_Polynomial constructor with given Epetra_Operator/Epetra_RowMatrix.

Creates an instance of Ifpack_Polynomial class.

Parameters

Matrix - (In) Pointer to the matrix to precondition.

Definition at line 135 of file Ifpack_Polynomial.cpp.

Member Function Documentation

int Ifpack_Polynomial::Apply	(	const Epetra_MultiVector &	X,
		Epetra_MultiVector &	Y
	)		const

inlinevirtual

Applies the matrix to an Epetra_MultiVector.

Parameters

X	- (In) A Epetra_MultiVector of dimension NumVectors to multiply with matrix.
Y	- (Out) A Epetra_MultiVector of dimension NumVectors containing the result.

Returns: Integer error code, set to 0 if successful.

Implements Epetra_Operator.

Definition at line 252 of file Ifpack_Polynomial.cpp.

References IsComputed(), and UseTranspose().

int Ifpack_Polynomial::ApplyInverse	(	const Epetra_MultiVector &	X,
		Epetra_MultiVector &	Y
	)		const

virtual

Applies the preconditioner to X, returns the result in Y.

Parameters

X	- (In) A Epetra_MultiVector of dimension NumVectors to be preconditioned.
Y	- (InOut) A Epetra_MultiVector of dimension NumVectors containing result.

Returns: Integer error code, set to 0 if successful.

Warning: This routine is NOT AztecOO complaint.

Implements Ifpack_Preconditioner.

Definition at line 628 of file Ifpack_Polynomial.cpp.

References IsComputed().

virtual int Ifpack_Polynomial::SetUseTranspose ( bool UseTranspose_in )

inlinevirtual

This flag can be used to apply the preconditioner to the transpose of the input operator.

Returns: Integer error code, set to 0 if successful. Set to -1 if this implementation does not support transpose.

Implements Epetra_Operator.

Definition at line 131 of file Ifpack_Polynomial.h.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation