#include <Ifpack_Amesos.h>
Public Member Functions | |
Ifpack_Amesos (Epetra_RowMatrix *Matrix) | |
Constructor. | |
Ifpack_Amesos (const Ifpack_Amesos &rhs) | |
Copy constructor. | |
Ifpack_Amesos & | operator= (const Ifpack_Amesos &rhs) |
Operator=. | |
virtual | ~Ifpack_Amesos () |
Destructor. | |
virtual int | SetUseTranspose (bool UseTranspose_in) |
If set true, transpose of this operator will be applied (not implemented). | |
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). | |
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. | |
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. | |
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_in=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 | |
void | SetLabel (const char *Label_in) |
Sets the label. | |
void | SetIsInitialized (const bool IsInitialized_in) |
Sets IsInitialized_ . | |
void | SetIsComputed (const int IsComputed_in) |
Sets IsComputed_ . | |
void | SetNumInitialize (const int NumInitialize_in) |
Sets NumInitialize_ . | |
void | SetNumCompute (const int NumCompute_in) |
Sets NumCompute_ . | |
void | SetNumApplyInverse (const int NumApplyInverse_in) |
Sets NumApplyInverse_ . | |
void | SetInitializeTime (const double InitializeTime_in) |
Sets InitializeTime_ . | |
void | SetComputeTime (const double ComputeTime_in) |
Sets ComputeTime_ . | |
void | SetApplyInverseTime (const double ApplyInverseTime_in) |
Sets ApplyInverseTime_ . | |
void | SetComputeFlops (const double ComputeFlops_in) |
Sets ComputeFlops_ . | |
void | SetApplyInverseFlops (const double ApplyInverseFlops_in) |
Sets ComputeFlops_ . | |
void | SetList (const Teuchos::ParameterList &List_in) |
Set List_ . |
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.
Ifpack_Amesos::Ifpack_Amesos | ( | Epetra_RowMatrix * | Matrix | ) |
Constructor.
Ifpack_Amesos::Ifpack_Amesos | ( | const Ifpack_Amesos & | rhs | ) |
Copy constructor.
virtual Ifpack_Amesos::~Ifpack_Amesos | ( | ) | [inline, virtual] |
Destructor.
virtual int Ifpack_Amesos::Apply | ( | const Epetra_MultiVector & | X, | |
Epetra_MultiVector & | Y | |||
) | const [virtual] |
Applies the matrix to an Epetra_MultiVector.
X | - (In) A Epetra_MultiVector of dimension NumVectors to multiply with matrix. | |
Y | - (Out) A Epetra_MultiVector of dimension NumVectors containing the result. |
virtual int Ifpack_Amesos::ApplyInverse | ( | const Epetra_MultiVector & | X, | |
Epetra_MultiVector & | Y | |||
) | const [virtual] |
Applies the preconditioner to X, returns the result in Y.
X | - (In) A Epetra_MultiVector of dimension NumVectors to be preconditioned. | |
Y | - (Out) A Epetra_MultiVector of dimension NumVectors containing result. |
Implements Ifpack_Preconditioner.
virtual double Ifpack_Amesos::ApplyInverseFlops | ( | ) | const [inline, virtual] |
virtual double Ifpack_Amesos::ApplyInverseTime | ( | ) | const [inline, virtual] |
virtual const Epetra_Comm& Ifpack_Amesos::Comm | ( | ) | const [virtual] |
Returns a pointer to the Epetra_Comm communicator associated with this operator.
virtual int Ifpack_Amesos::Compute | ( | ) | [virtual] |
Computes the preconditioners.
Implements Ifpack_Preconditioner.
virtual double Ifpack_Amesos::ComputeFlops | ( | ) | const [inline, virtual] |
Returns the total number of flops to computate the preconditioner.
Implements Ifpack_Preconditioner.
virtual double Ifpack_Amesos::ComputeTime | ( | ) | const [inline, virtual] |
virtual double Ifpack_Amesos::Condest | ( | ) | const [inline, virtual] |
virtual double Ifpack_Amesos::Condest | ( | const Ifpack_CondestType | CT = Ifpack_Cheap , |
|
const int | MaxIters = 1550 , |
|||
const double | Tol = 1e-9 , |
|||
Epetra_RowMatrix * | Matrix_in = 0 | |||
) | [virtual] |
virtual bool Ifpack_Amesos::HasNormInf | ( | ) | const [virtual] |
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
virtual int Ifpack_Amesos::Initialize | ( | ) | [virtual] |
Initializes the preconditioners.
Implements Ifpack_Preconditioner.
virtual double Ifpack_Amesos::InitializeFlops | ( | ) | const [inline, virtual] |
virtual double Ifpack_Amesos::InitializeTime | ( | ) | const [inline, virtual] |
virtual bool Ifpack_Amesos::IsComputed | ( | ) | const [inline, virtual] |
Returns true
if the preconditioner has been successfully computed.
Implements Ifpack_Preconditioner.
virtual bool Ifpack_Amesos::IsInitialized | ( | ) | const [inline, virtual] |
Returns true
is the preconditioner has been successfully initialized.
Implements Ifpack_Preconditioner.
virtual const char* Ifpack_Amesos::Label | ( | ) | const [virtual] |
Returns a character string describing the operator.
virtual const Teuchos::ParameterList& Ifpack_Amesos::List | ( | ) | const [inline, virtual] |
virtual const Epetra_RowMatrix& Ifpack_Amesos::Matrix | ( | ) | const [inline, virtual] |
virtual double Ifpack_Amesos::NormInf | ( | ) | const [virtual] |
Returns the infinity norm of the global matrix (not implemented).
virtual int Ifpack_Amesos::NumApplyInverse | ( | ) | const [inline, virtual] |
virtual int Ifpack_Amesos::NumCompute | ( | ) | const [inline, virtual] |
virtual int Ifpack_Amesos::NumInitialize | ( | ) | const [inline, virtual] |
Ifpack_Amesos& Ifpack_Amesos::operator= | ( | const Ifpack_Amesos & | rhs | ) |
Operator=.
virtual const Epetra_Map& Ifpack_Amesos::OperatorDomainMap | ( | ) | const [virtual] |
Returns the Epetra_Map object associated with the domain of this operator.
virtual const Epetra_Map& Ifpack_Amesos::OperatorRangeMap | ( | ) | const [virtual] |
Returns the Epetra_Map object associated with the range of this operator.
virtual std::ostream& Ifpack_Amesos::Print | ( | std::ostream & | os | ) | const [virtual] |
void Ifpack_Amesos::SetApplyInverseFlops | ( | const double | ApplyInverseFlops_in | ) | [inline, protected] |
Sets ComputeFlops_
.
void Ifpack_Amesos::SetApplyInverseTime | ( | const double | ApplyInverseTime_in | ) | [inline, protected] |
Sets ApplyInverseTime_
.
void Ifpack_Amesos::SetComputeFlops | ( | const double | ComputeFlops_in | ) | [inline, protected] |
Sets ComputeFlops_
.
void Ifpack_Amesos::SetComputeTime | ( | const double | ComputeTime_in | ) | [inline, protected] |
Sets ComputeTime_
.
void Ifpack_Amesos::SetInitializeTime | ( | const double | InitializeTime_in | ) | [inline, protected] |
Sets InitializeTime_
.
void Ifpack_Amesos::SetIsComputed | ( | const int | IsComputed_in | ) | [inline, protected] |
Sets IsComputed_
.
void Ifpack_Amesos::SetIsInitialized | ( | const bool | IsInitialized_in | ) | [inline, protected] |
Sets IsInitialized_
.
void Ifpack_Amesos::SetLabel | ( | const char * | Label_in | ) | [inline, protected] |
Sets the label.
void Ifpack_Amesos::SetList | ( | const Teuchos::ParameterList & | List_in | ) | [inline, protected] |
Set List_
.
void Ifpack_Amesos::SetNumApplyInverse | ( | const int | NumApplyInverse_in | ) | [inline, protected] |
Sets NumApplyInverse_
.
void Ifpack_Amesos::SetNumCompute | ( | const int | NumCompute_in | ) | [inline, protected] |
Sets NumCompute_
.
void Ifpack_Amesos::SetNumInitialize | ( | const int | NumInitialize_in | ) | [inline, protected] |
Sets NumInitialize_
.
virtual 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.
virtual int Ifpack_Amesos::SetUseTranspose | ( | bool | UseTranspose_in | ) | [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.
UseTranspose_in | - (In) If true, multiply by the transpose of operator, otherwise just use operator. |
virtual bool Ifpack_Amesos::UseTranspose | ( | ) | const [virtual] |
Returns the current UseTranspose setting.