PyTrilinos::Amesos::Umfpack Class Reference

Inheritance diagram for PyTrilinos::Amesos::Umfpack:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::Amesos::Umfpack:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def SymbolicFactorization
def NumericFactorization
def Solve
def GetProblem
def MatrixShapeOK
def SetUseTranspose
def UseTranspose
def Comm
def GetRcond
def SetParameters
def NumSymbolicFact
def NumNumericFact
def NumSolve
def PrintTiming
def PrintStatus
def GetTiming
def __init__
def SymbolicFactorization
def NumericFactorization
def Solve
def GetProblem
def MatrixShapeOK
def SetUseTranspose
def UseTranspose
def Comm
def GetRcond
def SetParameters
def NumSymbolicFact
def NumNumericFact
def NumSolve
def PrintTiming
def PrintStatus
def GetTiming

Public Attributes

 this


Detailed Description

Class Amesos_Umfpack: An object-oriented wrapper for UMFPACK.

Amesos_Umfpack will solve a linear systems of equations: A X = B using
Epetra objects and the UMFPACK solver library, where A is an
Epetra_RowMatrix and X and B are Epetra_MultiVector objects.

C++ includes: Amesos_Umfpack.h 

Member Function Documentation

def PyTrilinos::Amesos::Umfpack::__init__ (   self,
  args 
)

__init__(self, LinearProblem LinearProblem) -> Umfpack

Amesos_Umfpack::Amesos_Umfpack(const Epetra_LinearProblem
&LinearProblem)

Amesos_Umfpack Constructor.

Creates an Amesos_Umfpack instance, using an Epetra_LinearProblem,
passing in an already- defined Epetra_LinearProblem object.

Note: The operator in LinearProblem must be an Epetra_RowMatrix. 

def PyTrilinos::Amesos::Umfpack::__init__ (   self,
  args 
)

__init__(self, LinearProblem LinearProblem) -> Umfpack

Amesos_Umfpack::Amesos_Umfpack(const Epetra_LinearProblem
&LinearProblem)

Amesos_Umfpack Constructor.

Creates an Amesos_Umfpack instance, using an Epetra_LinearProblem,
passing in an already- defined Epetra_LinearProblem object.

Note: The operator in LinearProblem must be an Epetra_RowMatrix. 

def PyTrilinos::Amesos::Umfpack::Comm (   self,
  args 
)

Comm(self) -> Comm

const Epetra_Comm&
Amesos_Umfpack::Comm() const

Returns a pointer to the Epetra_Comm communicator associated with this
operator. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::Comm (   self,
  args 
)

Comm(self) -> Comm

const Epetra_Comm&
Amesos_Umfpack::Comm() const

Returns a pointer to the Epetra_Comm communicator associated with this
operator. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::GetProblem (   self,
  args 
)

GetProblem(self) -> LinearProblem

const
Epetra_LinearProblem* Amesos_Umfpack::GetProblem() const

Returns the Epetra_LinearProblem.

Warning! Do not call return->SetOperator(...) to attempt to change the
Epetra_Operator object (even if the new matrix has the same
structure). This new operator matrix will be ignored! 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::GetProblem (   self,
  args 
)

GetProblem(self) -> LinearProblem

const
Epetra_LinearProblem* Amesos_Umfpack::GetProblem() const

Returns the Epetra_LinearProblem.

Warning! Do not call return->SetOperator(...) to attempt to change the
Epetra_Operator object (even if the new matrix has the same
structure). This new operator matrix will be ignored! 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::GetRcond (   self,
  args 
)

GetRcond(self) -> double

double
Amesos_Umfpack::GetRcond() const

Returns an estimate of the reciprocal of the condition number. 

def PyTrilinos::Amesos::Umfpack::GetRcond (   self,
  args 
)

GetRcond(self) -> double

double
Amesos_Umfpack::GetRcond() const

Returns an estimate of the reciprocal of the condition number. 

def PyTrilinos::Amesos::Umfpack::GetTiming (   self,
  args 
)

GetTiming(self, ParameterList TimingParameterList)

void
Amesos_Umfpack::GetTiming(Teuchos::ParameterList &TimingParameterList)
const

Extracts timing information from the current solver and places it in
the parameter list. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::GetTiming (   self,
  args 
)

GetTiming(self, ParameterList TimingParameterList)

void
Amesos_Umfpack::GetTiming(Teuchos::ParameterList &TimingParameterList)
const

Extracts timing information from the current solver and places it in
the parameter list. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::MatrixShapeOK (   self,
  args 
)

MatrixShapeOK(self) -> bool

bool
Amesos_Umfpack::MatrixShapeOK() const

Returns true if UMFPACK can handle this matrix shape.

Returns true if the matrix shape is one that UMFPACK can handle.
UMFPACK only works with square matrices. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::MatrixShapeOK (   self,
  args 
)

MatrixShapeOK(self) -> bool

bool
Amesos_Umfpack::MatrixShapeOK() const

Returns true if UMFPACK can handle this matrix shape.

Returns true if the matrix shape is one that UMFPACK can handle.
UMFPACK only works with square matrices. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::NumericFactorization (   self,
  args 
)

NumericFactorization(self) -> int

int
Amesos_Umfpack::NumericFactorization()

Performs NumericFactorization on the matrix A.

In addition to performing numeric factorization on the matrix A, the
call to NumericFactorization() implies that no change will be made to
the underlying matrix without a subsequent call to
NumericFactorization().

<br >Preconditions:  GetProblem().GetOperator() != 0 (return -1)

MatrixShapeOk( GetProblem().GetOperator()) == true (return -6)

The non-zero structure of the matrix should not have changed since the
last call to SymbolicFactorization(). (return -2 if the number of non-
zeros changes) Other changes can have arbitrary consequences.

The distribution of the matrix should not have changed since the last
call to SymbolicFactorization()

The matrix should be indexed from 0 to n-1, unless the parameter
"Reindex" was set to "true" prior to the call to
SymbolicFactorization(). (return -3 - if caught)

The paremeter "Reindex" should not be set to "true" except on
CrsMatrices. (return -4)

The paremeter "Reindex" should not be set to "true" unless Amesos
was built with EpetraExt, i.e. with --enable-epetraext on the
configure line. (return -4)

Internal errors retur -5.

<br >Postconditions: Numeric Factorization will be performed (or
marked to be performed) allowing Solve() to be performed correctly
despite a potential change in in the matrix values (though not in the
non-zero structure).

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::NumericFactorization (   self,
  args 
)

NumericFactorization(self) -> int

int
Amesos_Umfpack::NumericFactorization()

Performs NumericFactorization on the matrix A.

In addition to performing numeric factorization on the matrix A, the
call to NumericFactorization() implies that no change will be made to
the underlying matrix without a subsequent call to
NumericFactorization().

<br >Preconditions:  GetProblem().GetOperator() != 0 (return -1)

MatrixShapeOk( GetProblem().GetOperator()) == true (return -6)

The non-zero structure of the matrix should not have changed since the
last call to SymbolicFactorization(). (return -2 if the number of non-
zeros changes) Other changes can have arbitrary consequences.

The distribution of the matrix should not have changed since the last
call to SymbolicFactorization()

The matrix should be indexed from 0 to n-1, unless the parameter
"Reindex" was set to "true" prior to the call to
SymbolicFactorization(). (return -3 - if caught)

The paremeter "Reindex" should not be set to "true" except on
CrsMatrices. (return -4)

The paremeter "Reindex" should not be set to "true" unless Amesos
was built with EpetraExt, i.e. with --enable-epetraext on the
configure line. (return -4)

Internal errors retur -5.

<br >Postconditions: Numeric Factorization will be performed (or
marked to be performed) allowing Solve() to be performed correctly
despite a potential change in in the matrix values (though not in the
non-zero structure).

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::NumNumericFact (   self,
  args 
)

NumNumericFact(self) -> int

int
Amesos_Umfpack::NumNumericFact() const

Returns the number of numeric factorizations performed by this object.

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::NumNumericFact (   self,
  args 
)

NumNumericFact(self) -> int

int
Amesos_Umfpack::NumNumericFact() const

Returns the number of numeric factorizations performed by this object.

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::NumSolve (   self,
  args 
)

NumSolve(self) -> int

int
Amesos_Umfpack::NumSolve() const

Returns the number of solves performed by this object. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::NumSolve (   self,
  args 
)

NumSolve(self) -> int

int
Amesos_Umfpack::NumSolve() const

Returns the number of solves performed by this object. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::NumSymbolicFact (   self,
  args 
)

NumSymbolicFact(self) -> int

int
Amesos_Umfpack::NumSymbolicFact() const

Returns the number of symbolic factorizations performed by this
object. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::NumSymbolicFact (   self,
  args 
)

NumSymbolicFact(self) -> int

int
Amesos_Umfpack::NumSymbolicFact() const

Returns the number of symbolic factorizations performed by this
object. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::PrintStatus (   self,
  args 
)

PrintStatus(self)

void
Amesos_Umfpack::PrintStatus() const

Prints information about the factorization and solution phases. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::PrintStatus (   self,
  args 
)

PrintStatus(self)

void
Amesos_Umfpack::PrintStatus() const

Prints information about the factorization and solution phases. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::PrintTiming (   self,
  args 
)

PrintTiming(self)

void
Amesos_Umfpack::PrintTiming() const

Prints timing information. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::PrintTiming (   self,
  args 
)

PrintTiming(self)

void
Amesos_Umfpack::PrintTiming() const

Prints timing information. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::SetParameters (   self,
  args 
)

SetParameters(self, ParameterList ParameterList) -> int

int
Amesos_Umfpack::SetParameters(Teuchos::ParameterList &ParameterList)

Updates internal variables.

<br >Preconditions: None.

<br >Postconditions: Internal variables controlling the factorization
and solve will be updated and take effect on all subseuent calls to
NumericFactorization() and Solve().

All parameters whose value are to differ from the default values must
be included in ParameterList. Parameters not specified in
ParameterList revert to their default values.

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::SetParameters (   self,
  args 
)

SetParameters(self, ParameterList ParameterList) -> int

int
Amesos_Umfpack::SetParameters(Teuchos::ParameterList &ParameterList)

Updates internal variables.

<br >Preconditions: None.

<br >Postconditions: Internal variables controlling the factorization
and solve will be updated and take effect on all subseuent calls to
NumericFactorization() and Solve().

All parameters whose value are to differ from the default values must
be included in ParameterList. Parameters not specified in
ParameterList revert to their default values.

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::SetUseTranspose (   self,
  args 
)

SetUseTranspose(self, bool UseTranspose_in) -> int

int
Amesos_Umfpack::SetUseTranspose(bool UseTranspose_in)

If set true, X will be set to the solution of AT X = B (not A X = B).

If the implementation of this interface does not support transpose
use, this method should return a value of -1.

<br >Preconditions:  SetUseTranspose() should be called prior to the
call to SymbolicFactorization() If NumericFactorization() or Solve()
is called after SetUseTranspose() without an intervening call to
SymbolicFactorization() the result is implementation dependent.

<br >Postconditions: The next factorization and solve will be
performed with the new value of UseTranspose.

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

UseTranspose:  -- (In) If true, solve AT X = B, otherwise solve A X =
B.

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

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::SetUseTranspose (   self,
  args 
)

SetUseTranspose(self, bool UseTranspose_in) -> int

int
Amesos_Umfpack::SetUseTranspose(bool UseTranspose_in)

If set true, X will be set to the solution of AT X = B (not A X = B).

If the implementation of this interface does not support transpose
use, this method should return a value of -1.

<br >Preconditions:  SetUseTranspose() should be called prior to the
call to SymbolicFactorization() If NumericFactorization() or Solve()
is called after SetUseTranspose() without an intervening call to
SymbolicFactorization() the result is implementation dependent.

<br >Postconditions: The next factorization and solve will be
performed with the new value of UseTranspose.

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

UseTranspose:  -- (In) If true, solve AT X = B, otherwise solve A X =
B.

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

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::Solve (   self,
  args 
)

Solve(self) -> int

int
Amesos_Umfpack::Solve()

Solves A X = B (or AT x = B).

<br >Preconditions:  GetProblem().GetOperator() != 0 (return -1)

MatrixShapeOk( GetProblem().GetOperator()) == true (return -6)

GetProblem()->CheckInput (see Epetra_LinearProblem::CheckInput() for
return values)

The non-zero structure of the matrix should not have changed since the
last call to SymbolicFactorization().

The distribution of the matrix should not have changed since the last
call to SymbolicFactorization()

The matrix should not have changed since the last call to
NumericFactorization().

<br >Postconditions: X will be set such that A X = B (or AT X = B),
within the limits of the accuracy of the underlying solver.

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::Solve (   self,
  args 
)

Solve(self) -> int

int
Amesos_Umfpack::Solve()

Solves A X = B (or AT x = B).

<br >Preconditions:  GetProblem().GetOperator() != 0 (return -1)

MatrixShapeOk( GetProblem().GetOperator()) == true (return -6)

GetProblem()->CheckInput (see Epetra_LinearProblem::CheckInput() for
return values)

The non-zero structure of the matrix should not have changed since the
last call to SymbolicFactorization().

The distribution of the matrix should not have changed since the last
call to SymbolicFactorization()

The matrix should not have changed since the last call to
NumericFactorization().

<br >Postconditions: X will be set such that A X = B (or AT X = B),
within the limits of the accuracy of the underlying solver.

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::SymbolicFactorization (   self,
  args 
)

SymbolicFactorization(self) -> int

int
Amesos_Umfpack::SymbolicFactorization()

Performs SymbolicFactorization on the matrix A.

In addition to performing symbolic factorization on the matrix A, the
call to SymbolicFactorization() implies that no change will be made to
the non-zero structure of the underlying matrix without a subsequent
call to SymbolicFactorization().

<br >Preconditions:  GetProblem().GetOperator() != 0 (return -1)

MatrixShapeOk( GetProblem().GetOperator()) == true (return -6)

<br >Postconditions: Symbolic Factorization will be performed (or
marked to be performed) allowing NumericFactorization() and Solve() to
be called.

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::SymbolicFactorization (   self,
  args 
)

SymbolicFactorization(self) -> int

int
Amesos_Umfpack::SymbolicFactorization()

Performs SymbolicFactorization on the matrix A.

In addition to performing symbolic factorization on the matrix A, the
call to SymbolicFactorization() implies that no change will be made to
the non-zero structure of the underlying matrix without a subsequent
call to SymbolicFactorization().

<br >Preconditions:  GetProblem().GetOperator() != 0 (return -1)

MatrixShapeOk( GetProblem().GetOperator()) == true (return -6)

<br >Postconditions: Symbolic Factorization will be performed (or
marked to be performed) allowing NumericFactorization() and Solve() to
be called.

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::UseTranspose (   self,
  args 
)

UseTranspose(self) -> bool

bool
Amesos_Umfpack::UseTranspose() const

Returns the current UseTranspose setting. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Amesos::Umfpack::UseTranspose (   self,
  args 
)

UseTranspose(self) -> bool

bool
Amesos_Umfpack::UseTranspose() const

Returns the current UseTranspose setting. 

Reimplemented from PyTrilinos::Amesos::BaseSolver.


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

Generated on Thu Dec 17 11:00:19 2009 for PyTrilinos by  doxygen 1.5.9