Ifpack_Amesos Class Reference

Ifpack_Amesos: a class to use Amesos' factorizations as preconditioners. More...

#include <Ifpack_Amesos.h>

Inheritance diagram for Ifpack_Amesos:

[legend]Collaboration diagram for Ifpack_Amesos:[legend]List of all members.


Public Member Functions
Constructors/Destructors.
	Ifpack_Amesos (Epetra_RowMatrix *Matrix)
	Constructor.
	Ifpack_Amesos (const Ifpack_Amesos &rhs)
	Copy constructor.
Ifpack_Amesos &	operator= (const Ifpack_Amesos &rhs)
	Operator=.
Destructor.
virtual	~Ifpack_Amesos ()
	Destructor.
Atribute set methods.
virtual int	SetUseTranspose (bool UseTranspose)
	If set true, transpose of this operator will be applied (not implemented).
Mathematical functions.
virtual int	Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Applies the matrix to an Epetra_MultiVector.
virtual int	ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Applies the preconditioner to X, returns the result in Y.
virtual double	NormInf () const
	Returns the infinity norm of the global matrix (not implemented).
Atribute access functions
virtual const char *	Label () const
	Returns a character string describing the operator.
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.
Construction and application methods.
virtual bool	IsInitialized () const
	Returns `true` is the preconditioner has been successfully initialized.
virtual int	Initialize ()
	Initializes the preconditioners.
virtual bool	IsComputed () const
	Returns `true` if the preconditioner has been successfully computed.
virtual int	Compute ()
	Computes the preconditioners.
virtual int	SetParameters (Teuchos::ParameterList &List)
	Sets all the parameters for the preconditioner.
Query methods.
virtual const Epetra_RowMatrix &	Matrix () const
	Returns a const reference to the internally stored matrix.
virtual double	Condest (const Ifpack_CondestType CT=Ifpack_Cheap, const int MaxIters=1550, const double Tol=1e-9, Epetra_RowMatrix *Matrix=0)
	Returns the estimated condition number, computes it if necessary.
virtual double	Condest () const
	Returns the estimated condition number, never computes it.
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 total time spent in Initialize().
virtual double	ComputeTime () const
	Returns the total time spent in Compute().
virtual double	ApplyInverseTime () const
	Returns the total time spent in ApplyInverse().
virtual double	InitializeFlops () const
	Returns the number of flops in the initialization phase.
virtual double	ComputeFlops () const
	Returns the total number of flops to computate the preconditioner.
virtual double	ApplyInverseFlops () const
	Returns the total number of flops to apply the preconditioner.
virtual const Teuchos::ParameterList &	List () const
virtual std::ostream &	Print (std::ostream &os) const
	Prints on ostream basic information about `this` object.
Protected Member Functions
Methods to get/set private data
void	SetLabel (const char *Label)
	Sets the label.
void	SetIsInitialized (const bool IsInitialized)
	Sets `IsInitialized_`.
void	SetIsComputed (const int IsComputed)
	Sets `IsComputed_`.
void	SetNumInitialize (const int NumInitialize)
	Sets `NumInitialize_`.
void	SetNumCompute (const int NumCompute)
	Sets `NumCompute_`.
void	SetNumApplyInverse (const int NumApplyInverse)
	Sets `NumApplyInverse_`.
void	SetInitializeTime (const double InitializeTime)
	Sets `InitializeTime_`.
void	SetComputeTime (const double ComputeTime)
	Sets `ComputeTime_`.
void	SetApplyInverseTime (const double ApplyInverseTime)
	Sets `ApplyInverseTime_`.
void	SetComputeFlops (const double ComputeFlops)
	Sets `ComputeFlops_`.
void	SetApplyInverseFlops (const double ApplyInverseFlops)
	Sets `ComputeFlops_`.
void	SetList (const Teuchos::ParameterList &List)
	Set `List_`.

Detailed Description

Ifpack_Amesos: a class to use Amesos' factorizations as preconditioners.

Class Ifpack_Amesos enables the use of Amesos' factorizations as Ifpack_Preconditioners.

Ifpack_Amesos is just a bare-bone wrap to Amesos. Currently, the only parameter required recognized by SetParameters() is "amesos: solver type" (defaulted to "Amesos_Klu"), which defined the Amesos solver. The Teuchos list in input to SetParameters() is copied, then the copied list is used to set the parameters of the Amesos object.

This class works with matrices whose communicator contains only one process, that is, either serial matrices, or Ifpack_LocalFilter'd matrices.

Warning:: The number of flops is NOT updated.

Author:: Marzio Sala, SNL 9214.

Date:: Last update Oct-04.

Definition at line 39 of file Ifpack_Amesos.h.

Member Function Documentation

int Ifpack_Amesos::Apply ( const Epetra_MultiVector & X,

Epetra_MultiVector & Y

) const [virtual]

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 214 of file Ifpack_Amesos.cpp.
References Epetra_Operator::Apply().

int Ifpack_Amesos::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 - (Out) A Epetra_MultiVector of dimension NumVectors containing result.

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

Warning:
In order to work with AztecOO, any implementation of this method must support the case where X and Y are the same object.

Implements Ifpack_Preconditioner.
Definition at line 223 of file Ifpack_Amesos.cpp.
References Epetra_Time::ElapsedTime(), IsComputed(), Epetra_MultiVector::NumVectors(), Epetra_MultiVector::Pointers(), Epetra_Time::ResetStartTime(), Epetra_LinearProblem::SetLHS(), and Epetra_LinearProblem::SetRHS().

int Ifpack_Amesos::Compute ( ) [virtual]

Computes the preconditioners.

Returns:
0 if successful, 1 if problems occurred.

Implements Ifpack_Preconditioner.
Definition at line 180 of file Ifpack_Amesos.cpp.
References Epetra_Time::ElapsedTime(), Initialize(), IsInitialized(), and Epetra_Time::ResetStartTime().
Referenced by Ifpack_Amesos().

int Ifpack_Amesos::Initialize ( ) [virtual]

Initializes the preconditioners.

Returns:
0 if successful, 1 if problems occurred.

Implements Ifpack_Preconditioner.
Definition at line 102 of file Ifpack_Amesos.cpp.
References Comm(), Epetra_Time::ElapsedTime(), Epetra_RowMatrix::NumGlobalCols(), Epetra_RowMatrix::NumGlobalRows(), Epetra_RowMatrix::NumMyNonzeros(), Epetra_Comm::NumProc(), and Epetra_LinearProblem::SetOperator().
Referenced by Compute(), and Ifpack_Amesos().

int Ifpack_Amesos::SetParameters ( Teuchos::ParameterList & List ) [virtual]

Sets all the parameters for the preconditioner.
Parameters currently supported:

"amesos: solver type" : Specifies the solver type for Amesos. Default: Amesos_Klu.

The input list will be copied, then passed to the Amesos object through Amesos::SetParameters().
Implements Ifpack_Preconditioner.
Definition at line 93 of file Ifpack_Amesos.cpp.

int Ifpack_Amesos::SetUseTranspose ( bool UseTranspose ) [virtual]

If set true, transpose of this operator will be applied (not implemented).
This flag allows the transpose of the given operator to be used implicitly.

Parameters:

UseTranspose - (In) If true, multiply by the transpose of operator, otherwise just use 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 201 of file Ifpack_Amesos.cpp.

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

Generated on Thu Sep 18 12:37:08 2008 for IFPACK by

1.3.9.1

Ifpack_Amesos Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation