PyTrilinos::Epetra::LinearProblem Class Reference

Inheritance diagram for PyTrilinos::Epetra::LinearProblem:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::Epetra::LinearProblem:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def CheckInput
def AssertSymmetric
def SetPDL
def SetOperator
def SetLHS
def SetRHS
def LeftScale
def RightScale
def GetOperator
def GetMatrix
def GetLHS
def GetRHS
def GetPDL
def IsOperatorSymmetric
def __init__
def CheckInput
def AssertSymmetric
def SetPDL
def SetOperator
def SetLHS
def SetRHS
def LeftScale
def RightScale
def GetOperator
def GetMatrix
def GetLHS
def GetRHS
def GetPDL
def IsOperatorSymmetric

Public Attributes

 this


Detailed Description

Epetra_LinearProblem: The Epetra Linear Problem Class.

The Epetra_LinearProblem class is a wrapper that encapsulates the
general information needed for solving a linear system of equations.
Currently it accepts a Epetra matrix, initial guess and RHS and
returns the solution. the elapsed time for each calling processor.

C++ includes: Epetra_LinearProblem.h 

Member Function Documentation

def PyTrilinos::Epetra::LinearProblem::__init__ (   self,
  args 
)

__init__(self) -> LinearProblem
__init__(self, RowMatrix A, Epetra_MultiVector X, Epetra_MultiVector B) -> LinearProblem
__init__(self, Operator A, Epetra_MultiVector X, Epetra_MultiVector B) -> LinearProblem
__init__(self, LinearProblem Problem) -> LinearProblem

Epetra_LinearProblem::Epetra_LinearProblem(const Epetra_LinearProblem
&Problem)

Epetra_LinearProblem Copy Constructor.

Makes copy of an existing Epetra_LinearProblem instance. 

def PyTrilinos::Epetra::LinearProblem::__init__ (   self,
  args 
)

__init__(self) -> LinearProblem
__init__(self, RowMatrix A, Epetra_MultiVector X, Epetra_MultiVector B) -> LinearProblem
__init__(self, Operator A, Epetra_MultiVector X, Epetra_MultiVector B) -> LinearProblem
__init__(self, LinearProblem Problem) -> LinearProblem

Epetra_LinearProblem::Epetra_LinearProblem(const Epetra_LinearProblem
&Problem)

Epetra_LinearProblem Copy Constructor.

Makes copy of an existing Epetra_LinearProblem instance. 

def PyTrilinos::Epetra::LinearProblem::AssertSymmetric (   self,
  args 
)

AssertSymmetric(self)

void
Epetra_LinearProblem::AssertSymmetric() 

def PyTrilinos::Epetra::LinearProblem::AssertSymmetric (   self,
  args 
)

AssertSymmetric(self)

void
Epetra_LinearProblem::AssertSymmetric() 

def PyTrilinos::Epetra::LinearProblem::CheckInput (   self,
  args 
)

CheckInput(self) -> int

int
Epetra_LinearProblem::CheckInput() const

Check input parameters for existence and size consistency.

Returns 0 if all input parameters are valid. Returns +1 if operator is
not a matrix. This is not necessarily an error, but no scaling can be
done if the user passes in an Epetra_Operator that is not an
Epetra_Matrix 

def PyTrilinos::Epetra::LinearProblem::CheckInput (   self,
  args 
)

CheckInput(self) -> int

int
Epetra_LinearProblem::CheckInput() const

Check input parameters for existence and size consistency.

Returns 0 if all input parameters are valid. Returns +1 if operator is
not a matrix. This is not necessarily an error, but no scaling can be
done if the user passes in an Epetra_Operator that is not an
Epetra_Matrix 

def PyTrilinos::Epetra::LinearProblem::GetLHS (   self,
  args 
)

GetLHS(self) -> Epetra_MultiVector

Epetra_MultiVector* Epetra_LinearProblem::GetLHS() const

Get a pointer to the left-hand-side X. 

def PyTrilinos::Epetra::LinearProblem::GetLHS (   self,
  args 
)

GetLHS(self) -> Epetra_MultiVector

Epetra_MultiVector* Epetra_LinearProblem::GetLHS() const

Get a pointer to the left-hand-side X. 

def PyTrilinos::Epetra::LinearProblem::GetMatrix (   self,
  args 
)

GetMatrix(self) -> RowMatrix

Epetra_RowMatrix* Epetra_LinearProblem::GetMatrix() const

Get a pointer to the matrix A. 

def PyTrilinos::Epetra::LinearProblem::GetMatrix (   self,
  args 
)

GetMatrix(self) -> RowMatrix

Epetra_RowMatrix* Epetra_LinearProblem::GetMatrix() const

Get a pointer to the matrix A. 

def PyTrilinos::Epetra::LinearProblem::GetOperator (   self,
  args 
)

GetOperator(self) -> Operator

Epetra_Operator* Epetra_LinearProblem::GetOperator() const

Get a pointer to the operator A. 

def PyTrilinos::Epetra::LinearProblem::GetOperator (   self,
  args 
)

GetOperator(self) -> Operator

Epetra_Operator* Epetra_LinearProblem::GetOperator() const

Get a pointer to the operator A. 

def PyTrilinos::Epetra::LinearProblem::GetPDL (   self,
  args 
)

GetPDL(self) -> ProblemDifficultyLevel

ProblemDifficultyLevel Epetra_LinearProblem::GetPDL() const

Get problem difficulty level. 

def PyTrilinos::Epetra::LinearProblem::GetPDL (   self,
  args 
)

GetPDL(self) -> ProblemDifficultyLevel

ProblemDifficultyLevel Epetra_LinearProblem::GetPDL() const

Get problem difficulty level. 

def PyTrilinos::Epetra::LinearProblem::GetRHS (   self,
  args 
)

GetRHS(self) -> Epetra_MultiVector

Epetra_MultiVector* Epetra_LinearProblem::GetRHS() const

Get a pointer to the right-hand-side B. 

def PyTrilinos::Epetra::LinearProblem::GetRHS (   self,
  args 
)

GetRHS(self) -> Epetra_MultiVector

Epetra_MultiVector* Epetra_LinearProblem::GetRHS() const

Get a pointer to the right-hand-side B. 

def PyTrilinos::Epetra::LinearProblem::IsOperatorSymmetric (   self,
  args 
)

IsOperatorSymmetric(self) -> bool

bool Epetra_LinearProblem::IsOperatorSymmetric() const

Get operator symmetry bool. 

def PyTrilinos::Epetra::LinearProblem::IsOperatorSymmetric (   self,
  args 
)

IsOperatorSymmetric(self) -> bool

bool Epetra_LinearProblem::IsOperatorSymmetric() const

Get operator symmetry bool. 

def PyTrilinos::Epetra::LinearProblem::LeftScale (   self,
  args 
)

LeftScale(self, Epetra_Vector D) -> int

int
Epetra_LinearProblem::LeftScale(const Epetra_Vector &D)

Perform left scaling of a linear problem.

Applies the scaling vector D to the left side of the matrix A() and to
the right hand side B(). Note that the operator must be an
Epetra_RowMatrix, not just an Epetra_Operator (the base class of
Epetra_RowMatrix).

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

In:  D - Vector containing scaling values. D[i] will be applied to the
ith row of A() and B().

Integer error code, set to 0 if successful. Return -1 if operator is
not a matrix. 

def PyTrilinos::Epetra::LinearProblem::LeftScale (   self,
  args 
)

LeftScale(self, Epetra_Vector D) -> int

int
Epetra_LinearProblem::LeftScale(const Epetra_Vector &D)

Perform left scaling of a linear problem.

Applies the scaling vector D to the left side of the matrix A() and to
the right hand side B(). Note that the operator must be an
Epetra_RowMatrix, not just an Epetra_Operator (the base class of
Epetra_RowMatrix).

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

In:  D - Vector containing scaling values. D[i] will be applied to the
ith row of A() and B().

Integer error code, set to 0 if successful. Return -1 if operator is
not a matrix. 

def PyTrilinos::Epetra::LinearProblem::RightScale (   self,
  args 
)

RightScale(self, Epetra_Vector D) -> int

int
Epetra_LinearProblem::RightScale(const Epetra_Vector &D)

Perform right scaling of a linear problem.

Applies the scaling vector D to the right side of the matrix A().
Apply the inverse of D to the initial guess. Note that the operator
must be an Epetra_RowMatrix, not just an Epetra_Operator (the base
class of Epetra_RowMatrix).

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

In:  D - Vector containing scaling values. D[i] will be applied to the
ith row of A(). 1/D[i] will be applied to the ith row of B().

Integer error code, set to 0 if successful. Return -1 if operator is
not a matrix. 

def PyTrilinos::Epetra::LinearProblem::RightScale (   self,
  args 
)

RightScale(self, Epetra_Vector D) -> int

int
Epetra_LinearProblem::RightScale(const Epetra_Vector &D)

Perform right scaling of a linear problem.

Applies the scaling vector D to the right side of the matrix A().
Apply the inverse of D to the initial guess. Note that the operator
must be an Epetra_RowMatrix, not just an Epetra_Operator (the base
class of Epetra_RowMatrix).

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

In:  D - Vector containing scaling values. D[i] will be applied to the
ith row of A(). 1/D[i] will be applied to the ith row of B().

Integer error code, set to 0 if successful. Return -1 if operator is
not a matrix. 

def PyTrilinos::Epetra::LinearProblem::SetLHS (   self,
  args 
)

SetLHS(self, Epetra_MultiVector X)

void
Epetra_LinearProblem::SetLHS(Epetra_MultiVector *X)

Set left-hand-side X of linear problem AX = B.

Sets a pointer to a Epetra_MultiVector. No copy of the object is made.

def PyTrilinos::Epetra::LinearProblem::SetLHS (   self,
  args 
)

SetLHS(self, Epetra_MultiVector X)

void
Epetra_LinearProblem::SetLHS(Epetra_MultiVector *X)

Set left-hand-side X of linear problem AX = B.

Sets a pointer to a Epetra_MultiVector. No copy of the object is made.

def PyTrilinos::Epetra::LinearProblem::SetOperator (   self,
  args 
)

SetOperator(self, RowMatrix A)
SetOperator(self, Operator A)

void
Epetra_LinearProblem::SetOperator(Epetra_Operator *A)

Set Operator A of linear problem AX = B using an Epetra_Operator.

Sets a pointer to a Epetra_Operator. No copy of the operator is made.

def PyTrilinos::Epetra::LinearProblem::SetOperator (   self,
  args 
)

SetOperator(self, RowMatrix A)
SetOperator(self, Operator A)

void
Epetra_LinearProblem::SetOperator(Epetra_Operator *A)

Set Operator A of linear problem AX = B using an Epetra_Operator.

Sets a pointer to a Epetra_Operator. No copy of the operator is made.

def PyTrilinos::Epetra::LinearProblem::SetPDL (   self,
  args 
)

SetPDL(self, ProblemDifficultyLevel PDL)

void
Epetra_LinearProblem::SetPDL(ProblemDifficultyLevel PDL)

Set problem difficulty level.

Sets Aztec options and parameters based on a definition of easy
moderate or hard problem. Relieves the user from explicitly setting a
large number of individual parameter values. This function can be used
in conjunction with the SetOptions() and SetParams() functions. 

def PyTrilinos::Epetra::LinearProblem::SetPDL (   self,
  args 
)

SetPDL(self, ProblemDifficultyLevel PDL)

void
Epetra_LinearProblem::SetPDL(ProblemDifficultyLevel PDL)

Set problem difficulty level.

Sets Aztec options and parameters based on a definition of easy
moderate or hard problem. Relieves the user from explicitly setting a
large number of individual parameter values. This function can be used
in conjunction with the SetOptions() and SetParams() functions. 

def PyTrilinos::Epetra::LinearProblem::SetRHS (   self,
  args 
)

SetRHS(self, Epetra_MultiVector B)

void
Epetra_LinearProblem::SetRHS(Epetra_MultiVector *B)

Set right-hand-side B of linear problem AX = B.

Sets a pointer to a Epetra_MultiVector. No copy of the object is made.

def PyTrilinos::Epetra::LinearProblem::SetRHS (   self,
  args 
)

SetRHS(self, Epetra_MultiVector B)

void
Epetra_LinearProblem::SetRHS(Epetra_MultiVector *B)

Set right-hand-side B of linear problem AX = B.

Sets a pointer to a Epetra_MultiVector. No copy of the object is made.


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

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