BlockDiagOperator Class Reference

#include <BlockDiagOperator.h>

List of all members.

Public Member Functions
	BlockDiagOperator (Epetra_CrsMatrix *A)
	~BlockDiagOperator ()
	Destructor.
int	SetUseTranspose (bool UseTranspose)
	If set true, transpose of this operator will be applied.
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.
double	NormInf () const
	Returns the infinity norm of the global matrix.
const char *	Label () const
	Returns a character string describing the operator.
bool	UseTranspose () const
	Returns the current UseTranspose setting.
bool	HasNormInf () const
	Returns true if the this object can provide an approximate Inf-norm, false otherwise.
const Epetra_Comm &	Comm () const
	Returns a pointer to the Epetra_Comm communicator associated with this operator.
const Epetra_Map &	OperatorDomainMap () const
	Returns the Epetra_Map object associated with the domain of this operator.
const Epetra_Map &	OperatorRangeMap () const
	Returns the Epetra_Map object associated with the range of this operator.
Protected Attributes
Epetra_CrsMatrix *	A
int	_NumMyRows
int *	_diag
double *	_temp
bool	_useTranspose

---

Detailed Description

Definition at line 9 of file BlockDiagOperator.h.

---

Constructor & Destructor Documentation

BlockDiagOperator::BlockDiagOperator

(

Epetra_CrsMatrix *

A

)

Definition at line 8 of file BlockDiagOperator.cpp.

References _diag, _NumMyRows, _temp, and A.

BlockDiagOperator::~BlockDiagOperator

(

)

Destructor.

Definition at line 32 of file BlockDiagOperator.cpp.

References _diag, and _temp.

---

Member Function Documentation

int BlockDiagOperator::Apply	(	const Epetra_MultiVector &	X,
		Epetra_MultiVector &	Y
	)			const

Returns the result of a Epetra_Operator applied to a Epetra_MultiVector X in Y.

Parameters:

	In	X - A Epetra_MultiVector of dimension NumVectors to multiply with matrix.
	Out	Y -A Epetra_MultiVector of dimension NumVectors containing result.

Returns:

Integer error code, set to 0 if successful.

Definition at line 43 of file BlockDiagOperator.cpp.

int BlockDiagOperator::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.

Parameters:

	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.

Warning:

In order to work with AztecOO, any implementation of this method must support the case where X and Y are the same object.

Definition at line 49 of file BlockDiagOperator.cpp.

References _diag, _NumMyRows, _temp, and A.

const Epetra_Comm & BlockDiagOperator::Comm

(

)

const

Returns a pointer to the Epetra_Comm communicator associated with this operator.

Definition at line 112 of file BlockDiagOperator.cpp.

References A.

bool BlockDiagOperator::HasNormInf

(

)

const

Returns true if the this object can provide an approximate Inf-norm, false otherwise.

Definition at line 108 of file BlockDiagOperator.cpp.

const char * BlockDiagOperator::Label

(

)

const

Returns a character string describing the operator.

Definition at line 100 of file BlockDiagOperator.cpp.

double BlockDiagOperator::NormInf

(

)

const

Returns the infinity norm of the global matrix.

Definition at line 95 of file BlockDiagOperator.cpp.

const Epetra_Map & BlockDiagOperator::OperatorDomainMap

(

)

const

Returns the Epetra_Map object associated with the domain of this operator.

Definition at line 116 of file BlockDiagOperator.cpp.

References A.

const Epetra_Map & BlockDiagOperator::OperatorRangeMap

(

)

const

Returns the Epetra_Map object associated with the range of this operator.

Definition at line 120 of file BlockDiagOperator.cpp.

References A.

int BlockDiagOperator::SetUseTranspose

(

bool

UseTranspose

)

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:

Integer error code, set to 0 if successful. Set to -1 if this implementation does not support transpose.

Definition at line 37 of file BlockDiagOperator.cpp.

References _useTranspose.

bool BlockDiagOperator::UseTranspose

(

)

const

Returns the current UseTranspose setting.

Definition at line 104 of file BlockDiagOperator.cpp.

---

Member Data Documentation

int* BlockDiagOperator::_diag [protected]

Definition at line 97 of file BlockDiagOperator.h.

Referenced by ApplyInverse(), BlockDiagOperator(), and ~BlockDiagOperator().

int BlockDiagOperator::_NumMyRows [protected]

Definition at line 96 of file BlockDiagOperator.h.

Referenced by ApplyInverse(), and BlockDiagOperator().

double* BlockDiagOperator::_temp [protected]

Definition at line 98 of file BlockDiagOperator.h.

Referenced by ApplyInverse(), BlockDiagOperator(), and ~BlockDiagOperator().

bool BlockDiagOperator::_useTranspose [protected]

Definition at line 99 of file BlockDiagOperator.h.

Referenced by SetUseTranspose().

Epetra_CrsMatrix* BlockDiagOperator::A [protected]

Definition at line 95 of file BlockDiagOperator.h.

Referenced by ApplyInverse(), BlockDiagOperator(), Comm(), OperatorDomainMap(), and OperatorRangeMap().

---

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

• src/eigsolv/BlockDiagOperator.h
• src/eigsolv/BlockDiagOperator.cpp

---