IFPACK: Ifpack_DiagPreconditioner Class Reference

IFPACK Development

Loading...

Searching...

No Matches

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

#include <Ifpack_DiagPreconditioner.h>

Inheritance diagram for Ifpack_DiagPreconditioner:

Inheritance graph

[legend]

Collaboration diagram for Ifpack_DiagPreconditioner:

Collaboration graph

[legend]

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

	~Ifpack_DiagPreconditioner ()
	dtor

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

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::Ifpack_DiagPreconditioner	(	const Epetra_Map &	DomainMap,
		const Epetra_Map &	RangeMap,
		const Epetra_Vector &	diag
	)

ctor

Definition at line 52 of file Ifpack_DiagPreconditioner.cpp.

◆ ~Ifpack_DiagPreconditioner()

Ifpack_DiagPreconditioner::~Ifpack_DiagPreconditioner ( )

dtor

Definition at line 63 of file Ifpack_DiagPreconditioner.cpp.

Member Function Documentation

◆ Apply()

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.

◆ ApplyInverse()

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.

References Epetra_MultiVector::MyLength(), and Epetra_MultiVector::NumVectors().

◆ Comm()

const Epetra_Comm & Ifpack_DiagPreconditioner::Comm ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 115 of file Ifpack_DiagPreconditioner.h.

◆ HasNormInf()

bool Ifpack_DiagPreconditioner::HasNormInf ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 110 of file Ifpack_DiagPreconditioner.h.

◆ Label()

const char * Ifpack_DiagPreconditioner::Label ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 100 of file Ifpack_DiagPreconditioner.h.

◆ Map()

const Epetra_BlockMap & Ifpack_DiagPreconditioner::Map ( ) const

inline

Definition at line 130 of file Ifpack_DiagPreconditioner.h.

◆ NormInf()

double Ifpack_DiagPreconditioner::NormInf ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 95 of file Ifpack_DiagPreconditioner.h.

◆ OperatorDomainMap()

const Epetra_Map & Ifpack_DiagPreconditioner::OperatorDomainMap ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 120 of file Ifpack_DiagPreconditioner.h.

◆ OperatorRangeMap()

const Epetra_Map & Ifpack_DiagPreconditioner::OperatorRangeMap ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 125 of file Ifpack_DiagPreconditioner.h.

◆ SetUseTranspose()

int Ifpack_DiagPreconditioner::SetUseTranspose ( bool UseTranspose_in )

inlinevirtual

Implements Epetra_Operator.

Definition at line 85 of file Ifpack_DiagPreconditioner.h.

◆ UseTranspose()

bool Ifpack_DiagPreconditioner::UseTranspose ( ) const

inlinevirtual

Implements Epetra_Operator.

Definition at line 105 of file Ifpack_DiagPreconditioner.h.

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