Epetra_FastCrsOperator Class Reference

Epetra_FastCrsOperator: A class for constructing matrix objects optimized for common kernels. More...

#include <Epetra_FastCrsMatrix.h>

Inheritance diagram for Epetra_FastCrsOperator:

[legend]Collaboration diagram for Epetra_FastCrsOperator:[legend]List of all members.

Public Member Functions
Constructors/Destructor
	Epetra_FastCrsOperator (const Epetra_CrsMatrix &Matrix, bool UseFloats=false)
	Epetra_FastCrsOperator constuctor.
virtual	~Epetra_FastCrsOperator ()
	Epetra_FastCrsOperator Destructor.
Post-construction modifications
int	UpdateValues (const Epetra_CrsMatrix &Matrix)
	Update values using a matrix with identical structure.
Additional methods required to support the Epetra_Operator interface
char *	Label () const
	Returns a character string describing the operator.
int	SetUseTranspose (bool UseTranspose)
	If set true, transpose of this operator will be applied.
double	NormInf () const
	Returns the infinity norm of the global matrix.
const Epetra_Comm &	Comm () const
	Returns a pointer to the Epetra_Comm communicator associated with this matrix.
int	Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Returns the result of a Epetra_Operator applied to a Epetra_MultiVector X in Y.
int	ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Returns the result of a Epetra_Operator inverse applied to an Epetra_MultiVector X in Y.
bool	HasNormInf () const
	Returns true because this class can compute an Inf-norm.
bool	UseTranspose () const
	Returns the current UseTranspose setting.
const Epetra_Map &	OperatorDomainMap () const
	Returns the Epetra_Map object associated with the domain of this matrix operator.
const Epetra_Map &	OperatorRangeMap () const
	Returns the Epetra_Map object associated with the range of this matrix operator.
Protected Member Functions
int	Allocate (bool UseFloats)
Protected Attributes
const Epetra_CrsMatrix &	CrsMatrix_
int	NumMyRows_
int	NumMyNonzeros_
double *	Values_
float *	FloatValues_
int *	Indices_
unsigned short *	ShortIndices_
bool	UsingFloats_
bool	UsingShorts_
bool	ValuesAllocated_
Epetra_MultiVector *	ImportVector_
Epetra_MultiVector *	ExportVector_

---

Detailed Description

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

The Epetra_FastCrsOperator class takes an existing Epetra_CrsMatrix ojbect, analyzes it and build upon it for the purposes of obtaining the best possible performance on basic operations.

---

Member Function Documentation

int Epetra_FastCrsOperator::Apply (  const Epetra_MultiVector &  X, Epetra_MultiVector &  Y )  const [virtual]

Returns the result of a Epetra_Operator applied to a Epetra_MultiVector X in Y. Parameters: X  (In) - A Epetra_MultiVector of dimension NumVectors to multiply with matrix. Y  (Out) - A Epetra_MultiVector of dimension NumVectors containing result. Returns: Integer error code, set to 0 if successful. Implements Epetra_Operator.

int Epetra_FastCrsOperator::ApplyInverse (  const Epetra_MultiVector &  X, Epetra_MultiVector &  Y )  const [virtual]

Returns the result of a Epetra_Operator inverse applied to an Epetra_MultiVector X in Y. Parameters: X  (In) - A Epetra_MultiVector of dimension NumVectors to solve for. Y  (Out) - A Epetra_MultiVector of dimension NumVectors containing result. Returns: Integer error code, set to 0 if successful. Implements Epetra_Operator.

int Epetra_FastCrsOperator::SetUseTranspose (  bool  UseTranspose  )  [inline, virtual]

If set true, transpose of this operator will be applied. This flag allows the transpose of the given operator to be used implicitly. Setting this flag affects only the Apply() and ApplyInverse() methods. If the implementation of this interface does not support transpose use, this method should return a value of -1. Parameters: In  UseTranspose -If true, multiply by the transpose of operator, otherwise just use operator. Returns: Always returns 0. Implements Epetra_Operator.

---

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

• Epetra_FastCrsMatrix.h

---