Epetra_VbrRowMatrix: A class for using an existing Epetra_VbrMatrix object as an Epetra_RowMatrix object. More...

#include <Epetra_VbrRowMatrix.h>

Inheritance diagram for Epetra_VbrRowMatrix:

Collaboration diagram for Epetra_VbrRowMatrix:

Public Member Functions
Constructors/Destructor
	Epetra_VbrRowMatrix (Epetra_VbrMatrix *Matrix)
	Epetra_VbrRowMatrix constuctor.

virtual	~Epetra_VbrRowMatrix ()
	Epetra_VbrRowMatrix Destructor.

Post-construction modifications
int	UpdateMatrix (Epetra_VbrMatrix *Matrix)
	Update the matrix to which this object points.

Methods required for implementing Epetra_BasicRowMatrix
int	ExtractMyRowCopy (int MyRow, int Length, int &NumEntries, double Values, int Indices) const
	Returns a copy of the specified local row in user-provided arrays. More...

int	ExtractMyEntryView (int CurEntry, double *&Value, int &RowIndex, int &ColIndex)
	Returns a reference to the ith entry in the matrix, along with its row and column index. More...

int	ExtractMyEntryView (int CurEntry, double const *&Value, int &RowIndex, int &ColIndex) const
	Returns a const reference to the ith entry in the matrix, along with its row and column index. More...

int	NumMyRowEntries (int MyRow, int &NumEntries) const
	Return the current number of values stored for the specified local row. More...

Computational methods
int	RightScale (const Epetra_Vector &x)
	Scales the Epetra_VbrMatrix on the right with a Epetra_Vector x. More...

int	LeftScale (const Epetra_Vector &x)
	Scales the Epetra_VbrMatrix on the left with a Epetra_Vector x. More...

int	Multiply (bool TransA, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Returns the result of a Epetra_VbrRowMatrix multiplied by a Epetra_MultiVector X in Y. More...

int	Solve (bool Upper, bool Trans, bool UnitDiagonal, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Returns the result of a Epetra_VbrRowMatrix solve with a Epetra_MultiVector X in Y (not implemented). More...

Public Member Functions inherited from Epetra_BasicRowMatrix
	Epetra_BasicRowMatrix (const Epetra_Comm &Comm)
	Epetra_BasicRowMatrix constructor. More...

virtual	~Epetra_BasicRowMatrix ()
	Epetra_BasicRowMatrix Destructor.

void	SetMaps (const Epetra_Map &RowMap, const Epetra_Map &ColMap)
	Set maps (Version 1); call this function or the next, but not both. More...

void	SetMaps (const Epetra_Map &RowMap, const Epetra_Map &ColMap, const Epetra_Map &DomainMap, const Epetra_Map &RangeMap)
	Set maps (Version 2); call this function or the previous, but not both. More...

virtual int	ExtractDiagonalCopy (Epetra_Vector &Diagonal) const
	Returns a copy of the main diagonal in a user-provided vector. More...

virtual int	InvRowSums (Epetra_Vector &x) const
	Computes the sum of absolute values of the rows of the Epetra_BasicRowMatrix, results returned in x. More...

virtual int	InvColSums (Epetra_Vector &x) const
	Computes the sum of absolute values of the columns of the Epetra_BasicRowMatrix, results returned in x. More...

virtual bool	Filled () const
	If FillComplete() has been called, this query returns true, otherwise it returns false, presently always returns true.

bool	LowerTriangular () const
	If matrix is lower triangular, this query returns true, otherwise it returns false.

virtual bool	UpperTriangular () const
	If matrix is upper triangular, this query returns true, otherwise it returns false.

virtual double	NormInf () const
	Returns the infinity norm of the global matrix. More...

virtual double	NormOne () const
	Returns the one norm of the global matrix. More...

virtual int	NumGlobalNonzeros () const
	Returns the number of nonzero entries in the global matrix. More...

virtual long long	NumGlobalNonzeros64 () const

virtual int	NumGlobalRows () const
	Returns the number of global matrix rows.

virtual long long	NumGlobalRows64 () const

virtual int	NumGlobalCols () const
	Returns the number of global matrix columns.

virtual long long	NumGlobalCols64 () const

virtual int	NumGlobalDiagonals () const
	Returns the number of global nonzero diagonal entries.

virtual long long	NumGlobalDiagonals64 () const

virtual int	NumMyNonzeros () const
	Returns the number of nonzero entries in the calling processor's portion of the matrix.

virtual int	NumMyRows () const
	Returns the number of matrix rows owned by the calling processor.

virtual int	NumMyCols () const
	Returns the number of matrix columns owned by the calling processor.

virtual int	NumMyDiagonals () const
	Returns the number of local nonzero diagonal entries.

virtual int	MaxNumEntries () const
	Returns the maximum number of nonzero entries across all rows on this processor.

virtual const Epetra_Map &	OperatorDomainMap () const
	Returns the Epetra_Map object associated with the domain of this operator.

virtual const Epetra_Map &	OperatorRangeMap () const
	Returns the Epetra_Map object associated with the range of this operator (same as domain).

virtual const Epetra_BlockMap &	Map () const
	Implement the Epetra_SrcDistObjec::Map() function.

virtual const Epetra_Map &	RowMatrixRowMap () const
	Returns the Row Map object needed for implementing Epetra_RowMatrix.

virtual const Epetra_Map &	RowMatrixColMap () const
	Returns the Column Map object needed for implementing Epetra_RowMatrix.

virtual const Epetra_Import *	RowMatrixImporter () const
	Returns the Epetra_Import object that contains the import operations for distributed operations.

virtual const Epetra_Comm &	Comm () const
	Returns a pointer to the Epetra_Comm communicator associated with this matrix.

virtual void	Print (std::ostream &os) const
	Print method.

virtual int	SetUseTranspose (bool use_transpose)
	If set true, transpose of this operator will be applied. More...

virtual const char *	Label () const
	Returns a character string describing the operator.

virtual int	Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Returns the result of a Epetra_RowMatrix applied to a Epetra_MultiVector X in Y. More...

virtual int	ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Returns the result of a Epetra_RowMatrix inverse applied to an Epetra_MultiVector X in Y. More...

bool	HasNormInf () const
	Returns true because this class can compute an Inf-norm.

virtual bool	UseTranspose () const
	Returns the current UseTranspose setting.

virtual const Epetra_Import *	Importer () const
	Returns the Epetra_Import object that contains the import operations for distributed operations, returns zero if none. More...

virtual const Epetra_Export *	Exporter () const
	Returns the Epetra_Export object that contains the export operations for distributed operations, returns zero if none. More...

Public Member Functions inherited from Epetra_CompObject
Epetra_CompObject &	operator= (const Epetra_CompObject &src)

	Epetra_CompObject ()
	Basic Epetra_CompObject constuctor.

	Epetra_CompObject (const Epetra_CompObject &Source)
	Epetra_CompObject copy constructor.

virtual	~Epetra_CompObject ()
	Epetra_CompObject destructor.

void	SetFlopCounter (const Epetra_Flops &FlopCounter_in)
	Set the internal Epetra_Flops() pointer.

void	SetFlopCounter (const Epetra_CompObject &CompObject)
	Set the internal Epetra_Flops() pointer to the flop counter of another Epetra_CompObject.

void	UnsetFlopCounter ()
	Set the internal Epetra_Flops() pointer to 0 (no flops counted).

Epetra_Flops *	GetFlopCounter () const
	Get the pointer to the Epetra_Flops() object associated with this object, returns 0 if none.

void	ResetFlops () const
	Resets the number of floating point operations to zero for this multi-vector.

double	Flops () const
	Returns the number of floating point operations with this multi-vector.

void	UpdateFlops (int Flops_in) const
	Increment Flop count for this object.

void	UpdateFlops (long int Flops_in) const
	Increment Flop count for this object.

void	UpdateFlops (long long Flops_in) const
	Increment Flop count for this object.

void	UpdateFlops (double Flops_in) const
	Increment Flop count for this object.

void	UpdateFlops (float Flops_in) const
	Increment Flop count for this object.

Public Member Functions inherited from Epetra_Object
	Epetra_Object (int TracebackModeIn=-1, bool set_label=true)
	Epetra_Object Constructor. More...

	Epetra_Object (const char *const Label, int TracebackModeIn=-1)
	Epetra_Object Constructor. More...

	Epetra_Object (const Epetra_Object &Object)
	Epetra_Object Copy Constructor. More...

virtual	~Epetra_Object ()
	Epetra_Object Destructor. More...

virtual int	ReportError (const std::string Message, int ErrorCode) const
	Error reporting method.

virtual void	SetLabel (const char *const Label)
	Epetra_Object Label definition using char *. More...

Public Member Functions inherited from Epetra_RowMatrix
virtual	~Epetra_RowMatrix ()
	Destructor.

Public Member Functions inherited from Epetra_Operator
virtual	~Epetra_Operator ()
	Destructor.

Public Member Functions inherited from Epetra_SrcDistObject
virtual	~Epetra_SrcDistObject ()
	Epetra_SrcDistObject destructor.

Additional Inherited Members
Static Public Member Functions inherited from Epetra_Object
static void	SetTracebackMode (int TracebackModeValue)
	Set the value of the Epetra_Object error traceback report mode. More...

static int	GetTracebackMode ()
	Get the value of the Epetra_Object error report mode.

static std::ostream &	GetTracebackStream ()
	Get the output stream for error reporting.

Static Public Attributes inherited from Epetra_Object
static int	TracebackMode

Protected Member Functions inherited from Epetra_BasicRowMatrix
void	Setup ()

void	UpdateImportVector (int NumVectors) const

void	UpdateExportVector (int NumVectors) const

void	SetImportExport ()

virtual void	ComputeStructureConstants () const
	Update the constants associated with the structure of the matrix: Call only if structure changes from the initial RowMatrix.

virtual void	ComputeNumericConstants () const
	Update the constants associated with the values of the matrix: Call only if values changes from the initial RowMatrix.

Protected Member Functions inherited from Epetra_Object
std::string	toString (const int &x) const

std::string	toString (const long long &x) const

std::string	toString (const double &x) const

Protected Attributes inherited from Epetra_BasicRowMatrix
Epetra_Comm *	Comm_

Epetra_Map	OperatorDomainMap_

Epetra_Map	OperatorRangeMap_

Epetra_Map	RowMatrixRowMap_

Epetra_Map	RowMatrixColMap_

int	NumMyNonzeros_

long long	NumGlobalNonzeros_

int	MaxNumEntries_

double	NormInf_

double	NormOne_

int	NumMyRows_

int	NumMyCols_

bool	UseTranspose_

bool	HasNormInf_

bool	LowerTriangular_

bool	UpperTriangular_

bool	HaveStructureConstants_

bool	HaveNumericConstants_

bool	HaveMaps_

Epetra_MultiVector *	ImportVector_

Epetra_MultiVector *	ExportVector_

Epetra_Import *	Importer_

Epetra_Export *	Exporter_

Protected Attributes inherited from Epetra_CompObject
Epetra_Flops *	FlopCounter_

Detailed Description

Epetra_VbrRowMatrix: A class for using an existing Epetra_VbrMatrix object as an Epetra_RowMatrix object.

The Epetra_VbrRowMatrix class takes an existing Epetra_VbrMatrix object and allows its use as an Epetra_RowMatrix without allocating additional storage. Although the Epetra_VbrMatrix itself inherits from Epetra_RowMatrix, a design flaw in the inheritance structure of Epetra prohibits the use of an Epetra_VbrMatrix object as an Epetra_RowMatrix in some important situations. Therefore we recommend the use of this class to wrap an Epetra_VbrMatrix object.

Warning: This class takes a pointer to an existing Epetra_VbrMatrix object. It is assumed that the user will pass in a pointer to a valid Epetra_VbrMatrix object, and will retain it throughout the life of the Epetra_VbrRowMatrix object.

Member Function Documentation

int Epetra_VbrRowMatrix::ExtractMyEntryView	(	int	CurEntry,
		double *&	Value,
		int &	RowIndex,
		int &	ColIndex
	)

inlinevirtual

Returns a reference to the ith entry in the matrix, along with its row and column index.

Parameters

CurEntry	(In) - Local entry to extract.
Value	(Out) - Extracted reference to current values.
RowIndex	(Out) - Row index for current entry.
ColIndex	(Out) - Column index for current entry.

Returns: Integer error code, set to 0 if successful, set to -1 if CurEntry not valid.

Implements Epetra_BasicRowMatrix.

int Epetra_VbrRowMatrix::ExtractMyEntryView	(	int	CurEntry,
		double const *&	Value,
		int &	RowIndex,
		int &	ColIndex
	)		const

inlinevirtual

Returns a const reference to the ith entry in the matrix, along with its row and column index.

Parameters

CurEntry	(In) - Local entry to extract.
Value	(Out) - Extracted reference to current values.
RowIndex	(Out) - Row index for current entry.
ColIndex	(Out) - Column index for current entry.

Returns: Integer error code, set to 0 if successful, set to -1 if CurEntry not valid.

Implements Epetra_BasicRowMatrix.

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

inlinevirtual

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.

Returns: 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).

Implements Epetra_BasicRowMatrix.

References Epetra_VbrMatrix::ExtractMyRowCopy().

int Epetra_VbrRowMatrix::LeftScale ( const Epetra_Vector & x )

inlinevirtual

Scales the Epetra_VbrMatrix on the left with a Epetra_Vector x.

The \e 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.

Returns: Integer error code, set to 0 if successful.

Reimplemented from Epetra_BasicRowMatrix.

References Epetra_VbrMatrix::LeftScale(), Epetra_BasicRowMatrix::NumGlobalNonzeros(), and Epetra_CompObject::UpdateFlops().

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

inlinevirtual

Returns the result of a Epetra_VbrRowMatrix 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.

Returns: Integer error code, set to 0 if successful.

Reimplemented from Epetra_BasicRowMatrix.

References Epetra_VbrMatrix::Multiply().

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

inlinevirtual

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.

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

Precondition: None.

Postcondition: Unchanged.

Implements Epetra_BasicRowMatrix.

References Epetra_VbrMatrix::NumMyRowEntries().

int Epetra_VbrRowMatrix::RightScale ( const Epetra_Vector & x )

inlinevirtual

Scales the Epetra_VbrMatrix on the right with a Epetra_Vector x.

The \e 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.

Returns: Integer error code, set to 0 if successful.

Reimplemented from Epetra_BasicRowMatrix.

References Epetra_BasicRowMatrix::NumGlobalNonzeros(), Epetra_VbrMatrix::RightScale(), and Epetra_CompObject::UpdateFlops().

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

inlinevirtual

Returns the result of a Epetra_VbrRowMatrix 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.

Returns: Integer error code, set to 0 if successful.

Reimplemented from Epetra_BasicRowMatrix.

References Epetra_VbrMatrix::Solve().

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

Epetra_VbrRowMatrix.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation