Inheritance diagram for PyTrilinos.Amesos.Klu:

Collaboration diagram for PyTrilinos.Amesos.Klu:

Public Member Functions
def	__init__
def	SymbolicFactorization
def	NumericFactorization
def	Solve
def	GetProblem
def	MatrixShapeOK
def	SetUseTranspose
def	UseTranspose
def	Comm
def	SetParameters
def	NumSymbolicFact
def	NumNumericFact
def	NumSolve
def	PrintTiming
def	PrintStatus
def	GetTiming
Public Attributes
	this

Detailed Description

Interface to KLU internal solver.

Interface to UMFPACK.

C++ includes: Amesos_Umfpack.h

Constructor & Destructor Documentation

def PyTrilinos.Amesos.Klu.__init__	(	self,
		args
	)

__init__(Amesos_Klu self, LinearProblem LinearProblem) -> Klu

Amesos_Klu::Amesos_Klu(const Epetra_LinearProblem &LinearProblem)

Amesos_Klu Constructor.

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

Note: The operator in LinearProblem must be an Epetra_RowMatrix.

Member Function Documentation

def PyTrilinos.Amesos.Klu.Comm	(	self,
		args
	)

Comm(Klu self) -> Comm

const Epetra_Comm&
Amesos_Klu::Comm() const

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

Reimplemented from PyTrilinos.Amesos.BaseSolver.

def PyTrilinos.Amesos.Klu.GetProblem	(	self,
		args
	)

GetProblem(Klu self) -> LinearProblem

const
Epetra_LinearProblem* Amesos_Klu::GetProblem() const

Get a pointer to the Problem.

Reimplemented from PyTrilinos.Amesos.BaseSolver.

def PyTrilinos.Amesos.Klu.GetTiming	(	self,
		args
	)

GetTiming(Klu self, ParameterList TimingParameterList)

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

Extracts timing information and places in parameter list.

Reimplemented from PyTrilinos.Amesos.BaseSolver.

def PyTrilinos.Amesos.Klu.MatrixShapeOK	(	self,
		args
	)

MatrixShapeOK(Klu self) -> bool

bool
Amesos_Klu::MatrixShapeOK() const

Returns true if KLU can handle this matrix shape.

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

Reimplemented from PyTrilinos.Amesos.BaseSolver.

def PyTrilinos.Amesos.Klu.NumericFactorization	(	self,
		args
	)

NumericFactorization(Klu self) -> int

int
Amesos_Klu::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.Klu.NumNumericFact	(	self,
		args
	)

NumNumericFact(Klu self) -> int

int
Amesos_Klu::NumNumericFact() const

Returns the number of numeric factorizations performed by this object.

Reimplemented from PyTrilinos.Amesos.BaseSolver.

def PyTrilinos.Amesos.Klu.NumSolve	(	self,
		args
	)

NumSolve(Klu self) -> int

int
Amesos_Klu::NumSolve() const

Returns the number of solves performed by this object.

Reimplemented from PyTrilinos.Amesos.BaseSolver.

def PyTrilinos.Amesos.Klu.NumSymbolicFact	(	self,
		args
	)

NumSymbolicFact(Klu self) -> int

int
Amesos_Klu::NumSymbolicFact() const

Returns the number of symbolic factorizations performed by this
object.

Reimplemented from PyTrilinos.Amesos.BaseSolver.

def PyTrilinos.Amesos.Klu.PrintStatus	(	self,
		args
	)

PrintStatus(Klu self)

void
Amesos_Klu::PrintStatus() const

Prints information about the factorization and solution phases.

Reimplemented from PyTrilinos.Amesos.BaseSolver.

def PyTrilinos.Amesos.Klu.PrintTiming	(	self,
		args
	)

PrintTiming(Klu self)

void
Amesos_Klu::PrintTiming() const

Prints timing information.

Reimplemented from PyTrilinos.Amesos.BaseSolver.

def PyTrilinos.Amesos.Klu.SetParameters	(	self,
		args
	)

SetParameters(Klu self, ParameterList ParameterList) -> int

int
Amesos_Klu::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.Klu.SetUseTranspose	(	self,
		args
	)

SetUseTranspose(Klu self, bool UseTranspose_in) -> int

int
Amesos_Klu::SetUseTranspose(bool UseTranspose_in)

SetUseTranpose(true) is more efficient in Amesos_Klu.

If SetUseTranspose() is set to true, $A^T X = B$ is computed.

Reimplemented from PyTrilinos.Amesos.BaseSolver.

def PyTrilinos.Amesos.Klu.Solve	(	self,
		args
	)

Solve(Klu self) -> int

int Amesos_Klu::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.Klu.SymbolicFactorization	(	self,
		args
	)

SymbolicFactorization(Klu self) -> int

int
Amesos_Klu::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.Klu.UseTranspose	(	self,
		args
	)

UseTranspose(Klu self) -> bool

bool
Amesos_Klu::UseTranspose() const

Returns the current UseTranspose setting.

Reimplemented from PyTrilinos.Amesos.BaseSolver.

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

Amesos.py

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation