PyTrilinos::Epetra::JadMatrix Class Reference

Inheritance diagram for PyTrilinos::Epetra::JadMatrix:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def UpdateValues
def ExtractMyRowCopy
def NumMyRowEntries
def Multiply
def Solve
def __init__
def UpdateValues
def ExtractMyRowCopy
def NumMyRowEntries
def Multiply
def Solve

Public Attributes

 this


Detailed Description

Epetra_JadMatrix: A class for constructing matrix objects optimized
for common kernels.

The Epetra_JadMatrix class takes an existing Epetra_RowMatrix ojbect,
analyzes it and builds a jagged diagonal equivalent of it. Once
constructed, it is also possible to update the values of the matrix
with values from another Epetra_RowMatrix that has the identical
structure.

C++ includes: Epetra_JadMatrix.h 

Member Function Documentation

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

__init__(self, RowMatrix Matrix) -> JadMatrix

Epetra_JadMatrix::Epetra_JadMatrix(const Epetra_RowMatrix &Matrix)

Epetra_JadMatrix constuctor. 

Reimplemented from PyTrilinos::Epetra::BasicRowMatrix.

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

__init__(self, RowMatrix Matrix) -> JadMatrix

Epetra_JadMatrix::Epetra_JadMatrix(const Epetra_RowMatrix &Matrix)

Epetra_JadMatrix constuctor. 

Reimplemented from PyTrilinos::Epetra::BasicRowMatrix.

def PyTrilinos::Epetra::JadMatrix::ExtractMyRowCopy (   self,
  args 
)

ExtractMyRowCopy(self, int MyRow, int Length, int NumEntries, double Values, 
    int Indices) -> int

int
Epetra_JadMatrix::ExtractMyRowCopy(int MyRow, int Length, int
&NumEntries, double *Values, int *Indices) const

Returns a copy of the specified local row in user-provided arrays.

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

MyRow:  (In) - Local row to extract.

Length:  (In) - Length of Values and Indices.

NumEntries:  (Out) - Number of nonzero entries extracted.

Values:  (Out) - Extracted values for this row.

Indices:  (Out) - Extracted global column indices for the
corresponding values.

Integer error code, set to 0 if successful, set to -1 if MyRow not
valid, -2 if Length is too short (NumEntries will have required
length). 

Reimplemented from PyTrilinos::Epetra::BasicRowMatrix.

def PyTrilinos::Epetra::JadMatrix::ExtractMyRowCopy (   self,
  args 
)

ExtractMyRowCopy(self, int MyRow, int Length, int NumEntries, double Values, 
    int Indices) -> int

int
Epetra_JadMatrix::ExtractMyRowCopy(int MyRow, int Length, int
&NumEntries, double *Values, int *Indices) const

Returns a copy of the specified local row in user-provided arrays.

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

MyRow:  (In) - Local row to extract.

Length:  (In) - Length of Values and Indices.

NumEntries:  (Out) - Number of nonzero entries extracted.

Values:  (Out) - Extracted values for this row.

Indices:  (Out) - Extracted global column indices for the
corresponding values.

Integer error code, set to 0 if successful, set to -1 if MyRow not
valid, -2 if Length is too short (NumEntries will have required
length). 

Reimplemented from PyTrilinos::Epetra::BasicRowMatrix.

def PyTrilinos::Epetra::JadMatrix::Multiply (   self,
  args 
)

Multiply(self, bool TransA, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

int
Epetra_JadMatrix::Multiply(bool TransA, const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const

Returns the result of a Epetra_JadMatrix multiplied by a
Epetra_MultiVector X in Y.

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

In:  TransA -If true, multiply by the transpose of matrix, otherwise
just use matrix.

In:  X - A Epetra_MultiVector of dimension NumVectors to multiply with
matrix.

Out:  Y -A Epetra_MultiVector of dimension NumVectorscontaining
result.

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Epetra::BasicRowMatrix.

def PyTrilinos::Epetra::JadMatrix::Multiply (   self,
  args 
)

Multiply(self, bool TransA, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

int
Epetra_JadMatrix::Multiply(bool TransA, const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const

Returns the result of a Epetra_JadMatrix multiplied by a
Epetra_MultiVector X in Y.

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

In:  TransA -If true, multiply by the transpose of matrix, otherwise
just use matrix.

In:  X - A Epetra_MultiVector of dimension NumVectors to multiply with
matrix.

Out:  Y -A Epetra_MultiVector of dimension NumVectorscontaining
result.

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Epetra::BasicRowMatrix.

def PyTrilinos::Epetra::JadMatrix::NumMyRowEntries (   self,
  args 
)

NumMyRowEntries(self, int MyRow, int NumEntries) -> int

int
Epetra_JadMatrix::NumMyRowEntries(int MyRow, int &NumEntries) const

Return the current number of values stored for the specified local
row.

Similar to NumMyEntries() except NumEntries is returned as an argument
and error checking is done on the input value MyRow.

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

MyRow:  - (In) Local row.

NumEntries:  - (Out) Number of nonzero values.

Integer error code, set to 0 if successful, set to -1 if MyRow not
valid.

None.

Unchanged. 

Reimplemented from PyTrilinos::Epetra::BasicRowMatrix.

def PyTrilinos::Epetra::JadMatrix::NumMyRowEntries (   self,
  args 
)

NumMyRowEntries(self, int MyRow, int NumEntries) -> int

int
Epetra_JadMatrix::NumMyRowEntries(int MyRow, int &NumEntries) const

Return the current number of values stored for the specified local
row.

Similar to NumMyEntries() except NumEntries is returned as an argument
and error checking is done on the input value MyRow.

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

MyRow:  - (In) Local row.

NumEntries:  - (Out) Number of nonzero values.

Integer error code, set to 0 if successful, set to -1 if MyRow not
valid.

None.

Unchanged. 

Reimplemented from PyTrilinos::Epetra::BasicRowMatrix.

def PyTrilinos::Epetra::JadMatrix::Solve (   self,
  args 
)

Solve(self, bool Upper, bool Trans, bool UnitDiagonal, Epetra_MultiVector X, 
    Epetra_MultiVector Y) -> int

int
Epetra_JadMatrix::Solve(bool Upper, bool Trans, bool UnitDiagonal,
const Epetra_MultiVector &X, Epetra_MultiVector &Y) const

Returns the result of a Epetra_JadMatrix solve with a
Epetra_MultiVector X in Y (not implemented).

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

In:  Upper -If true, solve Ux = y, otherwise solve Lx = y.

In:  Trans -If true, solve transpose problem.

In:  UnitDiagonal -If true, assume diagonal is unit (whether it's
stored or not).

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

Out:  Y -A Epetra_MultiVector of dimension NumVectors containing
result.

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Epetra::BasicRowMatrix.

def PyTrilinos::Epetra::JadMatrix::Solve (   self,
  args 
)

Solve(self, bool Upper, bool Trans, bool UnitDiagonal, Epetra_MultiVector X, 
    Epetra_MultiVector Y) -> int

int
Epetra_JadMatrix::Solve(bool Upper, bool Trans, bool UnitDiagonal,
const Epetra_MultiVector &X, Epetra_MultiVector &Y) const

Returns the result of a Epetra_JadMatrix solve with a
Epetra_MultiVector X in Y (not implemented).

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

In:  Upper -If true, solve Ux = y, otherwise solve Lx = y.

In:  Trans -If true, solve transpose problem.

In:  UnitDiagonal -If true, assume diagonal is unit (whether it's
stored or not).

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

Out:  Y -A Epetra_MultiVector of dimension NumVectors containing
result.

Integer error code, set to 0 if successful. 

Reimplemented from PyTrilinos::Epetra::BasicRowMatrix.

def PyTrilinos::Epetra::JadMatrix::UpdateValues (   self,
  args 
)

UpdateValues(self, RowMatrix Matrix, bool CheckStructure = False) -> int

int
Epetra_JadMatrix::UpdateValues(const Epetra_RowMatrix &Matrix, bool
CheckStructure=false)

Update values using a matrix with identical structure. 

def PyTrilinos::Epetra::JadMatrix::UpdateValues (   self,
  args 
)

UpdateValues(self, RowMatrix Matrix, bool CheckStructure = False) -> int

int
Epetra_JadMatrix::UpdateValues(const Epetra_RowMatrix &Matrix, bool
CheckStructure=false)

Update values using a matrix with identical structure. 


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