PyTrilinos  Development
 All Classes Functions
Public Member Functions | Public Attributes
PyTrilinos.IFPACK.ILUT Class Reference
Inheritance diagram for PyTrilinos.IFPACK.ILUT:
Inheritance graph
[legend]
Collaboration diagram for PyTrilinos.IFPACK.ILUT:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def SetParameters
def Initialize
def IsInitialized
def Compute
def IsComputed
def ApplyInverse
def Apply
def Condest
def SetUseTranspose
def NormInf
def HasNormInf
def UseTranspose
def OperatorDomainMap
def OperatorRangeMap
def Comm
def Matrix
def L
def U
def Label
def SetLabel
def NumInitialize
def NumCompute
def NumApplyInverse
def InitializeTime
def ComputeTime
def ApplyInverseTime
def InitializeFlops
def ComputeFlops
def ApplyInverseFlops
def LevelOfFill
def RelaxValue
def AbsoluteThreshold
def RelativeThreshold
def DropTolerance
def NumGlobalNonzeros
def NumMyNonzeros

Public Attributes

 this

Detailed Description

Ifpack_ILUT: A class for constructing and using an incomplete LU
factorization of a given Epetra_RowMatrix.

The Ifpack_ILUT class computes a "Relaxed" ILUT factorization with
dual threshold dropping of small elements of a given Epetra_RowMatrix.

This implementation does not use the algorithm that is described in
ifp_ilu. The algorithm drops entries in a row (i) of matrix A that are
smaller than drop_tolerance even before the factorization of row i
then computes the factorization for that row. This is different than
the usual algorithm where the drop tolerance is applied to the
factored rows.

The complete list of supported parameters is reported in page
ifp_params.

Marzio Sala, SNL 9214.

C++ includes: Ifpack_ILUT.h 

Constructor & Destructor Documentation

def PyTrilinos.IFPACK.ILUT.__init__ (   self,
  args 
)
__init__(Ifpack_ILUT self, RowMatrix A) -> ILUT

Ifpack_ILUT::Ifpack_ILUT(const Epetra_RowMatrix *A)

Ifpack_ILUT constuctor with variable number of indices per row. 

Reimplemented from PyTrilinos.Epetra.Operator.


Member Function Documentation

def PyTrilinos.IFPACK.ILUT.AbsoluteThreshold (   self,
  args 
)
AbsoluteThreshold(ILUT self) -> double

double
Ifpack_ILUT::AbsoluteThreshold() const

Get absolute threshold value. 
def PyTrilinos.IFPACK.ILUT.Apply (   self,
  args 
)
Apply(ILUT self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

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

Reimplemented from PyTrilinos.Epetra.Operator.

def PyTrilinos.IFPACK.ILUT.ApplyInverse (   self,
  args 
)
ApplyInverse(ILUT self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

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

Returns the result of a Ifpack_ILUT forward/back solve on a
Epetra_MultiVector X in Y.

Parameters:
-----------

X:  - (In) A Epetra_MultiVector of dimension NumVectors to solve for.

Y:  - (Out) A Epetra_MultiVector of dimension NumVectorscontaining
result.

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.ApplyInverseFlops (   self,
  args 
)
ApplyInverseFlops(ILUT self) -> double

virtual double
Ifpack_ILUT::ApplyInverseFlops() const

Returns the number of flops in the application of the preconditioner.

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.ApplyInverseTime (   self,
  args 
)
ApplyInverseTime(ILUT self) -> double

virtual double
Ifpack_ILUT::ApplyInverseTime() const

Returns the time spent in ApplyInverse(). 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.Comm (   self,
  args 
)
Comm(ILUT self) -> Comm

const Epetra_Comm&
Ifpack_ILUT::Comm() const

Returns the Epetra_BlockMap object associated with the range of this
matrix operator. 

Reimplemented from PyTrilinos.Epetra.Operator.

def PyTrilinos.IFPACK.ILUT.Compute (   self,
  args 
)
Compute(ILUT self) -> int

int
Ifpack_ILUT::Compute()

Compute IC factor U using the specified graph, diagonal perturbation
thresholds and relaxation parameters.

This function computes the RILU(k) factors L and U using the current:
Ifpack_IlukGraph specifying the structure of L and U.

Value for the RILU(k) relaxation parameter.

Value for the a priori diagonal threshold values.  InitValues() must
be called before the factorization can proceed. 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.ComputeFlops (   self,
  args 
)
ComputeFlops(ILUT self) -> double

virtual double
Ifpack_ILUT::ComputeFlops() const

Returns the number of flops in the computation phase. 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.ComputeTime (   self,
  args 
)
ComputeTime(ILUT self) -> double

virtual double
Ifpack_ILUT::ComputeTime() const

Returns the time spent in Compute(). 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.Condest (   self,
  args 
)
Condest(ILUT self, Ifpack_CondestType const CT=Ifpack_Cheap, int const MaxIters=1550, double const Tol=1e-9, 
    RowMatrix Matrix_in=None) -> double

double
Ifpack_ILUT::Condest() const

Returns the computed estimated condition number, or -1.0 if no
computed. 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.DropTolerance (   self,
  args 
)
DropTolerance(ILUT self) -> double

double
Ifpack_ILUT::DropTolerance() const

Gets the dropping tolerance. 
def PyTrilinos.IFPACK.ILUT.HasNormInf (   self,
  args 
)
HasNormInf(ILUT self) -> bool

bool
Ifpack_ILUT::HasNormInf() const

Returns false because this class cannot compute an Inf-norm. 

Reimplemented from PyTrilinos.Epetra.Operator.

def PyTrilinos.IFPACK.ILUT.Initialize (   self,
  args 
)
Initialize(ILUT self) -> int

int
Ifpack_ILUT::Initialize()

Initialize L and U with values from user matrix A.

Copies values from the user's matrix into the nonzero pattern of L and
U.

Parameters:
-----------

In:  A - User matrix to be factored.

WARNING:  The graph of A must be identical to the graph passed in to
Ifpack_IlukGraph constructor. 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.InitializeFlops (   self,
  args 
)
InitializeFlops(ILUT self) -> double

virtual double
Ifpack_ILUT::InitializeFlops() const

Returns the number of flops in the initialization phase. 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.InitializeTime (   self,
  args 
)
InitializeTime(ILUT self) -> double

virtual double
Ifpack_ILUT::InitializeTime() const

Returns the time spent in Initialize(). 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.IsComputed (   self,
  args 
)
IsComputed(ILUT self) -> bool

bool
Ifpack_ILUT::IsComputed() const

If factor is completed, this query returns true, otherwise it returns
false. 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.IsInitialized (   self,
  args 
)
IsInitialized(ILUT self) -> bool

bool
Ifpack_ILUT::IsInitialized() const

Returns true if the preconditioner has been successfully initialized.

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.L (   self,
  args 
)
L(ILUT self) -> CrsMatrix

const Epetra_CrsMatrix&
Ifpack_ILUT::L() const

Returns a reference to the L factor. 
def PyTrilinos.IFPACK.ILUT.Label (   self,
  args 
)
Label(ILUT self) -> char const *

const char*
Ifpack_ILUT::Label() const

Returns the label of this object. 

Reimplemented from PyTrilinos.Epetra.Operator.

def PyTrilinos.IFPACK.ILUT.LevelOfFill (   self,
  args 
)
LevelOfFill(ILUT self) -> double

double
Ifpack_ILUT::LevelOfFill() const 
def PyTrilinos.IFPACK.ILUT.Matrix (   self,
  args 
)
Matrix(ILUT self) -> RowMatrix

const Epetra_RowMatrix&
Ifpack_ILUT::Matrix() const

Returns a reference to the matrix to be preconditioned. 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.NormInf (   self,
  args 
)
NormInf(ILUT self) -> double

double
Ifpack_ILUT::NormInf() const

Returns 0.0 because this class cannot compute Inf-norm. 

Reimplemented from PyTrilinos.Epetra.Operator.

def PyTrilinos.IFPACK.ILUT.NumApplyInverse (   self,
  args 
)
NumApplyInverse(ILUT self) -> int

virtual int
Ifpack_ILUT::NumApplyInverse() const

Returns the number of calls to ApplyInverse(). 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.NumCompute (   self,
  args 
)
NumCompute(ILUT self) -> int

virtual int
Ifpack_ILUT::NumCompute() const

Returns the number of calls to Compute(). 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.NumGlobalNonzeros (   self,
  args 
)
NumGlobalNonzeros(ILUT self) -> int

int
Ifpack_ILUT::NumGlobalNonzeros() const

Returns the number of nonzero entries in the global graph. 
def PyTrilinos.IFPACK.ILUT.NumInitialize (   self,
  args 
)
NumInitialize(ILUT self) -> int

virtual int
Ifpack_ILUT::NumInitialize() const

Returns the number of calls to Initialize(). 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.NumMyNonzeros (   self,
  args 
)
NumMyNonzeros(ILUT self) -> int

int
Ifpack_ILUT::NumMyNonzeros() const

Returns the number of nonzero entries in the local graph. 
def PyTrilinos.IFPACK.ILUT.OperatorDomainMap (   self,
  args 
)
OperatorDomainMap(ILUT self) -> Map

const
Epetra_Map& Ifpack_ILUT::OperatorDomainMap() const

Returns the Epetra_Map object associated with the domain of this
operator. 

Reimplemented from PyTrilinos.Epetra.Operator.

def PyTrilinos.IFPACK.ILUT.OperatorRangeMap (   self,
  args 
)
OperatorRangeMap(ILUT self) -> Map

const
Epetra_Map& Ifpack_ILUT::OperatorRangeMap() const

Returns the Epetra_Map object associated with the range of this
operator. 

Reimplemented from PyTrilinos.Epetra.Operator.

def PyTrilinos.IFPACK.ILUT.RelativeThreshold (   self,
  args 
)
RelativeThreshold(ILUT self) -> double

double
Ifpack_ILUT::RelativeThreshold() const

Get relative threshold value. 
def PyTrilinos.IFPACK.ILUT.RelaxValue (   self,
  args 
)
RelaxValue(ILUT self) -> double

double
Ifpack_ILUT::RelaxValue() const

Set relative threshold value. 
def PyTrilinos.IFPACK.ILUT.SetLabel (   self,
  args 
)
SetLabel(ILUT self, char const * Label_in) -> int

int
Ifpack_ILUT::SetLabel(const char *Label_in)

Sets the label for this object. 
def PyTrilinos.IFPACK.ILUT.SetParameters (   self,
  args 
)
SetParameters(ILUT self, ParameterList parameterlis) -> int

int
Ifpack_ILUT::SetParameters(Teuchos::ParameterList &parameterlis)

Set parameters using a Teuchos::ParameterList object. 

Reimplemented from PyTrilinos.IFPACK.Preconditioner.

def PyTrilinos.IFPACK.ILUT.SetUseTranspose (   self,
  args 
)
SetUseTranspose(ILUT self, bool UseTranspose_in) -> int

int
Ifpack_ILUT::SetUseTranspose(bool UseTranspose_in)

If set true, transpose of this operator will be applied.

This flag allows the transpose of the given operator to be used
implicitly. Setting this flag affects only the Apply() and
ApplyInverse() methods. If the implementation of this interface does
not support transpose use, this method should return a value of -1.

Parameters:
-----------

UseTranspose_in:  - (In) If true, multiply by the transpose of
operator, otherwise just use operator.

Always returns 0. 

Reimplemented from PyTrilinos.Epetra.Operator.

def PyTrilinos.IFPACK.ILUT.U (   self,
  args 
)
U(ILUT self) -> CrsMatrix

const Epetra_CrsMatrix&
Ifpack_ILUT::U() const

Returns a reference to the U factor. 
def PyTrilinos.IFPACK.ILUT.UseTranspose (   self,
  args 
)
UseTranspose(ILUT self) -> bool

bool
Ifpack_ILUT::UseTranspose() const

Returns the current UseTranspose setting. 

Reimplemented from PyTrilinos.Epetra.Operator.


The documentation for this class was generated from the following file:
 All Classes Functions