Inheritance diagram for PyTrilinos.Epetra.RowMatrix:

Collaboration diagram for PyTrilinos.Epetra.RowMatrix:

Public Member Functions
def	NumMyRowEntries
def	MaxNumEntries
def	ExtractMyRowCopy
def	ExtractDiagonalCopy
def	Multiply
def	Solve
def	InvRowSums
def	LeftScale
def	InvColSums
def	RightScale
def	Filled
def	NormInf
def	NormOne
def	NumGlobalNonzeros
def	NumGlobalNonzeros64
def	NumGlobalRows
def	NumGlobalRows64
def	NumGlobalCols
def	NumGlobalCols64
def	NumGlobalDiagonals
def	NumGlobalDiagonals64
def	NumMyNonzeros
def	NumMyRows
def	NumMyCols
def	NumMyDiagonals
def	LowerTriangular
def	UpperTriangular
def	RowMatrixRowMap
def	RowMatrixColMap
def	RowMatrixImporter
def	__init__
def	__disown__
Public Attributes
	this

Detailed Description

Epetra_RowMatrix: A pure virtual class for using real-valued double-
precision row matrices.

The Epetra_RowMatrix class is a pure virtual class (specifies
interface only) that enable the use of real-valued double-precision
sparse matrices where matrix entries are intended for row access. It
is currently implemented by both the Epetra_CrsMatrix and
Epetra_VbrMatrix classes.

C++ includes: Epetra_RowMatrix.h

Constructor & Destructor Documentation

def PyTrilinos.Epetra.RowMatrix.__init__	(	self,
		args
	)

__init__(Epetra_RowMatrix self) -> RowMatrix

Reimplemented from PyTrilinos.Epetra.Operator.

Reimplemented in PyTrilinos.Epetra.JadMatrix, PyTrilinos.Epetra.FEVbrMatrix, PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.FECrsMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

Member Function Documentation

def PyTrilinos.Epetra.RowMatrix.ExtractDiagonalCopy	(	self,
		args
	)

ExtractDiagonalCopy(Vector diagonal) -> int

Argument diagonal is provided to you as a numpy-hybrid Epetra.Vector,
giving you access to the numpy interface in addition to the
Epetra_Vector C++ interface.

virtual
int Epetra_RowMatrix::ExtractDiagonalCopy(Epetra_Vector &Diagonal)
const =0

Returns a copy of the main diagonal in a user-provided vector.

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

Out:  Diagonal - Extracted main diagonal.

Integer error code, set to 0 if successful.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.ExtractMyRowCopy	(	self,
		args
	)

ExtractMyRowCopy(int myRow, int length, numpy.ndarray numEntries,
    numpy.ndarray values, numpy.ndarray indices) -> int

In C++, numEntries in an int&.  In python, it is provided to you as a
numpy array of length one so that you can set its value in-place using
numEntries[0] = ....

Arguments values and indices are double* and int*, respectively, in
C++.  In python, these are provided to you as numpy arrays of the
given length, so that you may alter their entries in-place.

virtual
int Epetra_RowMatrix::ExtractMyRowCopy(int MyRow, int Length, int
&NumEntries, double *Values, int *Indices) const =0

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

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

In:  MyRow - Local row to extract.

In:  Length - Length of Values and Indices.

Out:  NumEntries - Number of nonzero entries extracted.

Out:  Values - Extracted values for this row.

Out:  Indices - Extracted local column indices for the corresponding
values.

Integer error code, set to 0 if successful.

Reimplemented in PyTrilinos.Epetra.JadMatrix, PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.Filled	(	self,
		args
	)

Filled(RowMatrix self) -> bool

virtual bool
Epetra_RowMatrix::Filled() const =0

If FillComplete() has been called, this query returns true, otherwise
it returns false.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.InvColSums	(	self,
		args
	)

InvColSums(Vector x) -> int

Argument x is provided to you as a numpy-hybrid Epetra.Vector, giving
you access to the numpy interface in addition to the Epetra_Vector C++
interface.

virtual int
Epetra_RowMatrix::InvColSums(Epetra_Vector &x) const =0

Computes the sum of absolute values of the columns of the
Epetra_RowMatrix, results returned in x.

The vector x will return such that x[j] will contain the inverse of
sum of the absolute values of the this matrix will be sca such that
A(i,j) = x(j)*A(i,j) where i denotes the global row number of A and j
denotes the global column number of A. Using the resulting vector from
this function as input to RighttScale() will make the one norm of the
resulting matrix exactly 1.

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

Out:  x -A Epetra_Vector containing the column sums of the this
matrix.

WARNING:  It is assumed that the distribution of x is the same as the
rows of this.

Integer error code, set to 0 if successful.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.InvRowSums	(	self,
		args
	)

InvRowSums(Vector x) -> int

Argument x is provided to you as a numpy-hybrid Epetra.Vector, giving
you access to the numpy interface in addition to the Epetra_Vector C++
interface.

virtual int
Epetra_RowMatrix::InvRowSums(Epetra_Vector &x) const =0

Computes the sum of absolute values of the rows of the
Epetra_RowMatrix, results returned in x.

The vector x will return such that x[i] will contain the inverse of
sum of the absolute values of the this matrix will be scaled such that
A(i,j) = x(i)*A(i,j) where i denotes the global row number of A and j
denotes the global column number of A. Using the resulting vector from
this function as input to LeftScale() will make the infinity norm of
the resulting matrix exactly 1.

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

Out:  x -A Epetra_Vector containing the row sums of the this matrix.

WARNING:  It is assumed that the distribution of x is the same as the
rows of this.

Integer error code, set to 0 if successful.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.LeftScale	(	self,
		args
	)

LeftScale(Vector x) -> int

Argument x is provided to you as a numpy-hybrid Epetra.Vector, giving
you access to the numpy interface in addition to the Epetra_Vector C++
interface.

virtual int
Epetra_RowMatrix::LeftScale(const Epetra_Vector &x)=0

Scales the Epetra_RowMatrix on the left with a Epetra_Vector x.

The this matrix will be scaled such that A(i,j) = x(i)*A(i,j) where i
denotes the row number of A and j denotes the column number of A.

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

In:  x -A Epetra_Vector to solve for.

Integer error code, set to 0 if successful.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.LowerTriangular	(	self,
		args
	)

LowerTriangular(RowMatrix self) -> bool

virtual
bool Epetra_RowMatrix::LowerTriangular() const =0

If matrix is lower triangular in local index space, this query returns
true, otherwise it returns false.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.MaxNumEntries	(	self,
		args
	)

MaxNumEntries(RowMatrix self) -> int

virtual int
Epetra_RowMatrix::MaxNumEntries() const =0

Returns the maximum of NumMyRowEntries() over all rows.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.Multiply	(	self,
		args
	)

Multiply(bool useTranspose, MultiVector x, MultiVector y) -> int

In C++, arguments x and y are Epetra_MultiVectors.  In python, they
are provided to you as numpy-hybrid Epetra.MultiVectors, giving you
access to the numpy interface in addition to the Epetra_MultiVector
C++ interface.

virtual int
Epetra_RowMatrix::Multiply(bool TransA, const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const =0

Returns the result of a Epetra_RowMatrix 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 in PyTrilinos.Epetra.JadMatrix, PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NormInf	(	self,
		args
	)

NormInf(RowMatrix self) -> double

virtual double
Epetra_RowMatrix::NormInf() const =0

Returns the infinity norm of the global matrix.

Reimplemented from PyTrilinos.Epetra.Operator.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NormOne	(	self,
		args
	)

NormOne(RowMatrix self) -> double

virtual double
Epetra_RowMatrix::NormOne() const =0

Returns the one norm of the global matrix.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumGlobalCols	(	self,
		args
	)

NumGlobalCols(RowMatrix self) -> int

virtual int
Epetra_RowMatrix::NumGlobalCols() const =0

Returns the number of global matrix columns.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumGlobalCols64	(	self,
		args
	)

NumGlobalCols64(RowMatrix self) -> long long

virtual
long long Epetra_RowMatrix::NumGlobalCols64() const =0

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumGlobalDiagonals	(	self,
		args
	)

NumGlobalDiagonals(RowMatrix self) -> int

virtual
int Epetra_RowMatrix::NumGlobalDiagonals() const =0

Returns the number of global nonzero diagonal entries, based on global
row/column index comparisons.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumGlobalDiagonals64	(	self,
		args
	)

NumGlobalDiagonals64(RowMatrix self) -> long long

virtual long long Epetra_RowMatrix::NumGlobalDiagonals64() const =0

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumGlobalNonzeros	(	self,
		args
	)

NumGlobalNonzeros(RowMatrix self) -> int

virtual
int Epetra_RowMatrix::NumGlobalNonzeros() const =0

Returns the number of nonzero entries in the global matrix.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumGlobalNonzeros64	(	self,
		args
	)

NumGlobalNonzeros64(RowMatrix self) -> long long

virtual
long long Epetra_RowMatrix::NumGlobalNonzeros64() const =0

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumGlobalRows	(	self,
		args
	)

NumGlobalRows(RowMatrix self) -> int

virtual int
Epetra_RowMatrix::NumGlobalRows() const =0

Returns the number of global matrix rows.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumGlobalRows64	(	self,
		args
	)

NumGlobalRows64(RowMatrix self) -> long long

virtual
long long Epetra_RowMatrix::NumGlobalRows64() const =0

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumMyCols	(	self,
		args
	)

NumMyCols(RowMatrix self) -> int

virtual int
Epetra_RowMatrix::NumMyCols() const =0

Returns the number of matrix columns owned by the calling processor.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumMyDiagonals	(	self,
		args
	)

NumMyDiagonals(RowMatrix self) -> int

virtual int
Epetra_RowMatrix::NumMyDiagonals() const =0

Returns the number of local nonzero diagonal entries, based on global
row/column index comparisons.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumMyNonzeros	(	self,
		args
	)

NumMyNonzeros(RowMatrix self) -> int

virtual int
Epetra_RowMatrix::NumMyNonzeros() const =0

Returns the number of nonzero entries in the calling processor's
portion of the matrix.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumMyRowEntries	(	self,
		args
	)

NumMyRowEntries(int myRow, numpy.ndarray numEntries) -> int

In C++, numEntries in an int&.  In python, it is provided to you as a
numpy array of length one so that you can set its value in-place using
numEntries[0] = ....

virtual int
Epetra_RowMatrix::NumMyRowEntries(int MyRow, int &NumEntries) const =0

Returns the number of nonzero entries in MyRow.

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

In:  MyRow - Local row.

Out:  NumEntries - Number of nonzero values present.

Integer error code, set to 0 if successful.

Reimplemented in PyTrilinos.Epetra.JadMatrix, PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.NumMyRows	(	self,
		args
	)

NumMyRows(RowMatrix self) -> int

virtual int
Epetra_RowMatrix::NumMyRows() const =0

Returns the number of matrix rows owned by the calling processor.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.RightScale	(	self,
		args
	)

RightScale(Vector x) -> int

Argument x is provided to you as a numpy-hybrid Epetra.Vector, giving
you access to the numpy interface in addition to the Epetra_Vector C++
interface.

virtual int
Epetra_RowMatrix::RightScale(const Epetra_Vector &x)=0

Scales the Epetra_RowMatrix on the right with a Epetra_Vector x.

The this matrix will be scaled such that A(i,j) = x(j)*A(i,j) where i
denotes the global row number of A and j denotes the global column
number of A.

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

In:  x -The Epetra_Vector used for scaling this.

Integer error code, set to 0 if successful.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.RowMatrixColMap	(	self,
		args
	)

RowMatrixColMap(RowMatrix self) -> Map

virtual
const Epetra_Map& Epetra_RowMatrix::RowMatrixColMap() const =0

Returns the Epetra_Map object associated with the columns of this
matrix.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.RowMatrixImporter	(	self,
		args
	)

RowMatrixImporter(RowMatrix self) -> Import

virtual
const Epetra_Import* Epetra_RowMatrix::RowMatrixImporter() const =0

Returns the Epetra_Import object that contains the import operations
for distributed operations.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.RowMatrixRowMap	(	self,
		args
	)

RowMatrixRowMap(RowMatrix self) -> Map

virtual
const Epetra_Map& Epetra_RowMatrix::RowMatrixRowMap() const =0

Returns the Epetra_Map object associated with the rows of this matrix.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.Solve	(	self,
		args
	)

Solve((bool upper, bool trans, bool unitDiagonal, MultiVector x,
    MultiVector y) -> int

In C++, arguments x and y are Epetra_MultiVectors.  In python, they
are provided to you as numpy-hybrid Epetra.MultiVectors, giving you
access to the numpy interface in addition to the Epetra_MultiVector
C++ interface.

virtual int
Epetra_RowMatrix::Solve(bool Upper, bool Trans, bool UnitDiagonal,
const Epetra_MultiVector &X, Epetra_MultiVector &Y) const =0

Returns result of a local-only solve using a triangular
Epetra_RowMatrix with Epetra_MultiVectors X and Y.

This method will perform a triangular solve independently on each
processor of the parallel machine. No communication is performed.

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 in PyTrilinos.Epetra.JadMatrix, PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.RowMatrix.UpperTriangular	(	self,
		args
	)

UpperTriangular(RowMatrix self) -> bool

virtual
bool Epetra_RowMatrix::UpperTriangular() const =0

If matrix is upper triangular in local index space, this query returns
true, otherwise it returns false.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

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

Epetra.py

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation