Ifpack Package Browser (Single Doxygen Collection): Ifpack_DiagPreconditioner Class Reference

Ifpack Package Browser (Single Doxygen Collection) Development

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages

Ifpack_DiagPreconditioner: a class for diagonal preconditioning. More...

#include <Ifpack_DiagPreconditioner.h>

Inheritance diagram for Ifpack_DiagPreconditioner:

Inheritance graph

Public Member Functions
	Ifpack_DiagPreconditioner (const Epetra_Map &DomainMap, const Epetra_Map &RangeMap, const Epetra_Vector &diag)
	ctor More...

	~Ifpack_DiagPreconditioner ()
	dtor More...

int	SetUseTranspose (bool UseTranspose_in)

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

int	ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const

double	NormInf () const

const char *	Label () const

bool	UseTranspose () const

bool	HasNormInf () const

const Epetra_Comm &	Comm () const

const Epetra_Map &	OperatorDomainMap () const

const Epetra_Map &	OperatorRangeMap () const

const Epetra_BlockMap &	Map () const

Private Attributes
bool	UseTranspose_

const Epetra_Map &	DomainMap_

const Epetra_Map &	RangeMap_

const Epetra_Vector &	diag_

Detailed Description

Ifpack_DiagPreconditioner: a class for diagonal preconditioning.

Definition at line 73 of file Ifpack_DiagPreconditioner.h.

Constructor & Destructor Documentation

Ifpack_DiagPreconditioner::Ifpack_DiagPreconditioner	(	const Epetra_Map &	DomainMap,
		const Epetra_Map &	RangeMap,
		const Epetra_Vector &	diag
	)

ctor

Definition at line 53 of file Ifpack_DiagPreconditioner.cpp.

Ifpack_DiagPreconditioner::~Ifpack_DiagPreconditioner ( )

dtor

Definition at line 63 of file Ifpack_DiagPreconditioner.cpp.

Member Function Documentation

int Ifpack_DiagPreconditioner::SetUseTranspose ( bool UseTranspose_in )

inlinevirtual

Implements Epetra_Operator.

Definition at line 85 of file Ifpack_DiagPreconditioner.h.

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

virtual

Implements Epetra_Operator.

Definition at line 68 of file Ifpack_DiagPreconditioner.cpp.

int Ifpack_DiagPreconditioner::ApplyInverse	(	const Epetra_MultiVector &	X,
		Epetra_MultiVector &	Y
	)		const

virtual

Y.ReciprocalMultiply(1.0, diag_, X, 0.0);

Implements Epetra_Operator.

Definition at line 74 of file Ifpack_DiagPreconditioner.cpp.

double Ifpack_DiagPreconditioner::NormInf ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 95 of file Ifpack_DiagPreconditioner.h.

const char* Ifpack_DiagPreconditioner::Label ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 100 of file Ifpack_DiagPreconditioner.h.

bool Ifpack_DiagPreconditioner::UseTranspose ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 105 of file Ifpack_DiagPreconditioner.h.

bool Ifpack_DiagPreconditioner::HasNormInf ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 110 of file Ifpack_DiagPreconditioner.h.

const Epetra_Comm& Ifpack_DiagPreconditioner::Comm ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 115 of file Ifpack_DiagPreconditioner.h.

const Epetra_Map& Ifpack_DiagPreconditioner::OperatorDomainMap ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 120 of file Ifpack_DiagPreconditioner.h.

const Epetra_Map& Ifpack_DiagPreconditioner::OperatorRangeMap ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 125 of file Ifpack_DiagPreconditioner.h.

const Epetra_BlockMap& Ifpack_DiagPreconditioner::Map ( ) const

inline

Definition at line 130 of file Ifpack_DiagPreconditioner.h.

Member Data Documentation

bool Ifpack_DiagPreconditioner::UseTranspose_

private

Definition at line 136 of file Ifpack_DiagPreconditioner.h.

const Epetra_Map& Ifpack_DiagPreconditioner::DomainMap_

private

Definition at line 137 of file Ifpack_DiagPreconditioner.h.

const Epetra_Map& Ifpack_DiagPreconditioner::RangeMap_

private

Definition at line 138 of file Ifpack_DiagPreconditioner.h.

const Epetra_Vector& Ifpack_DiagPreconditioner::diag_

private

Definition at line 139 of file Ifpack_DiagPreconditioner.h.

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