|
PyTrilinos
Development
|
Public Member Functions | |
| def | __init__ |
| def | SetUseTranspose |
| def | Apply |
| def | ApplyInverse |
| def | NormInf |
| def | Label |
| def | UseTranspose |
| def | HasNormInf |
| def | Comm |
| def | OperatorDomainMap |
| def | OperatorRangeMap |
| def | IsInitialized |
| def | Initialize |
| def | IsComputed |
| def | Compute |
| def | SetParameters |
| def | Matrix |
| def | Condest |
| def | NumInitialize |
| def | NumCompute |
| def | NumApplyInverse |
| def | InitializeTime |
| def | ComputeTime |
| def | ApplyInverseTime |
| def | InitializeFlops |
| def | ComputeFlops |
| def | ApplyInverseFlops |
| def | List |
Public Attributes | |
| this | |
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. Marzio Sala, SNL 9214. C++ includes: Ifpack_Amesos.h
| def PyTrilinos.IFPACK.Amesos.__init__ | ( | self, | |
| args | |||
| ) |
__init__(Ifpack_Amesos self, RowMatrix Matrix) -> Amesos __init__(Ifpack_Amesos self, Amesos rhs) -> Amesos Ifpack_Amesos::Ifpack_Amesos(const Ifpack_Amesos &rhs) Copy constructor.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.Amesos.Apply | ( | self, | |
| args | |||
| ) |
Apply(Amesos self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int int Ifpack_Amesos::Apply(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const 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. Integer error code, set to 0 if successful.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.Amesos.ApplyInverse | ( | self, | |
| args | |||
| ) |
ApplyInverse(Amesos self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int int Ifpack_Amesos::ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const 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. 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.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.ApplyInverseFlops | ( | self, | |
| args | |||
| ) |
ApplyInverseFlops(Amesos self) -> double virtual double Ifpack_Amesos::ApplyInverseFlops() const Returns the total number of flops to apply the preconditioner.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.ApplyInverseTime | ( | self, | |
| args | |||
| ) |
ApplyInverseTime(Amesos self) -> double virtual double Ifpack_Amesos::ApplyInverseTime() const Returns the total time spent in ApplyInverse().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.Comm | ( | self, | |
| args | |||
| ) |
Comm(Amesos self) -> Comm const Epetra_Comm & Ifpack_Amesos::Comm() const Returns a pointer to the Epetra_Comm communicator associated with this operator.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.Amesos.Compute | ( | self, | |
| args | |||
| ) |
Compute(Amesos self) -> int int Ifpack_Amesos::Compute() Computes the preconditioners. 0 if successful, 1 if problems occurred.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.ComputeFlops | ( | self, | |
| args | |||
| ) |
ComputeFlops(Amesos self) -> double virtual double Ifpack_Amesos::ComputeFlops() const Returns the total number of flops to computate the preconditioner.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.ComputeTime | ( | self, | |
| args | |||
| ) |
ComputeTime(Amesos self) -> double virtual double Ifpack_Amesos::ComputeTime() const Returns the total time spent in Compute().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.Condest | ( | self, | |
| args | |||
| ) |
Condest(Amesos self, Ifpack_CondestType const CT=Ifpack_Cheap, int const MaxIters=1550, double const Tol=1e-9,
RowMatrix Matrix_in=None) -> double
virtual double
Ifpack_Amesos::Condest() const
Returns the estimated condition number, never computes it.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.HasNormInf | ( | self, | |
| args | |||
| ) |
HasNormInf(Amesos self) -> bool bool Ifpack_Amesos::HasNormInf() const Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.Amesos.Initialize | ( | self, | |
| args | |||
| ) |
Initialize(Amesos self) -> int int Ifpack_Amesos::Initialize() Initializes the preconditioners. 0 if successful, 1 if problems occurred.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.InitializeFlops | ( | self, | |
| args | |||
| ) |
InitializeFlops(Amesos self) -> double virtual double Ifpack_Amesos::InitializeFlops() const Returns the number of flops in the initialization phase.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.InitializeTime | ( | self, | |
| args | |||
| ) |
InitializeTime(Amesos self) -> double virtual double Ifpack_Amesos::InitializeTime() const Returns the total time spent in Initialize().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.IsComputed | ( | self, | |
| args | |||
| ) |
IsComputed(Amesos self) -> bool virtual bool Ifpack_Amesos::IsComputed() const Returns true if the preconditioner has been successfully computed.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.IsInitialized | ( | self, | |
| args | |||
| ) |
IsInitialized(Amesos self) -> bool virtual bool Ifpack_Amesos::IsInitialized() const Returns true is the preconditioner has been successfully initialized.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.Label | ( | self, | |
| args | |||
| ) |
Label(Amesos self) -> char const * const char * Ifpack_Amesos::Label() const Returns a character string describing the operator.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.Amesos.List | ( | self, | |
| args | |||
| ) |
List(Amesos self) -> ParameterList virtual const Teuchos::ParameterList& Ifpack_Amesos::List() const
| def PyTrilinos.IFPACK.Amesos.Matrix | ( | self, | |
| args | |||
| ) |
Matrix(Amesos self) -> RowMatrix virtual const Epetra_RowMatrix& Ifpack_Amesos::Matrix() const Returns a const reference to the internally stored matrix.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.NormInf | ( | self, | |
| args | |||
| ) |
NormInf(Amesos self) -> double double Ifpack_Amesos::NormInf() const Returns the infinity norm of the global matrix (not implemented)
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.Amesos.NumApplyInverse | ( | self, | |
| args | |||
| ) |
NumApplyInverse(Amesos self) -> int virtual int Ifpack_Amesos::NumApplyInverse() const Returns the number of calls to ApplyInverse().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.NumCompute | ( | self, | |
| args | |||
| ) |
NumCompute(Amesos self) -> int virtual int Ifpack_Amesos::NumCompute() const Returns the number of calls to Compute().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.NumInitialize | ( | self, | |
| args | |||
| ) |
NumInitialize(Amesos self) -> int virtual int Ifpack_Amesos::NumInitialize() const Returns the number of calls to Initialize().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.OperatorDomainMap | ( | self, | |
| args | |||
| ) |
OperatorDomainMap(Amesos self) -> Map const Epetra_Map & Ifpack_Amesos::OperatorDomainMap() const Returns the Epetra_Map object associated with the domain of this operator.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.Amesos.OperatorRangeMap | ( | self, | |
| args | |||
| ) |
OperatorRangeMap(Amesos self) -> Map const Epetra_Map & Ifpack_Amesos::OperatorRangeMap() const Returns the Epetra_Map object associated with the range of this operator.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.Amesos.SetParameters | ( | self, | |
| args | |||
| ) |
SetParameters(Amesos self, ParameterList List) -> int int Ifpack_Amesos::SetParameters(Teuchos::ParameterList &List) 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().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.Amesos.SetUseTranspose | ( | self, | |
| args | |||
| ) |
SetUseTranspose(Amesos self, bool UseTranspose_in) -> int int Ifpack_Amesos::SetUseTranspose(bool UseTranspose_in) 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: - (In) If true, multiply by the transpose of operator, otherwise just use operator. Integer error code, set to 0 if successful. Set to -1 if this implementation does not support transpose.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.Amesos.UseTranspose | ( | self, | |
| args | |||
| ) |
UseTranspose(Amesos self) -> bool bool Ifpack_Amesos::UseTranspose() const Returns the current UseTranspose setting.
Reimplemented from PyTrilinos.Epetra.Operator.
1.7.6.1