Ifpack Package Browser (Single Doxygen Collection)  Development
Public Member Functions | Private Attributes | List of all members
Ifpack_DiagPreconditioner Class Reference

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

#include <Ifpack_DiagPreconditioner.h>

Inherits Epetra_Operator.

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 67 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 53 of file Ifpack_DiagPreconditioner.cpp.

◆ ~Ifpack_DiagPreconditioner()

Ifpack_DiagPreconditioner::~Ifpack_DiagPreconditioner ( )

dtor

Definition at line 63 of file Ifpack_DiagPreconditioner.cpp.

Member Function Documentation

◆ SetUseTranspose()

int Ifpack_DiagPreconditioner::SetUseTranspose ( bool  UseTranspose_in)
inline

Definition at line 79 of file Ifpack_DiagPreconditioner.h.

◆ Apply()

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

Definition at line 68 of file Ifpack_DiagPreconditioner.cpp.

◆ ApplyInverse()

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

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

Definition at line 74 of file Ifpack_DiagPreconditioner.cpp.

◆ NormInf()

double Ifpack_DiagPreconditioner::NormInf ( ) const
inline

Definition at line 89 of file Ifpack_DiagPreconditioner.h.

◆ Label()

const char* Ifpack_DiagPreconditioner::Label ( ) const
inline

Definition at line 94 of file Ifpack_DiagPreconditioner.h.

◆ UseTranspose()

bool Ifpack_DiagPreconditioner::UseTranspose ( ) const
inline

Definition at line 99 of file Ifpack_DiagPreconditioner.h.

◆ HasNormInf()

bool Ifpack_DiagPreconditioner::HasNormInf ( ) const
inline

Definition at line 104 of file Ifpack_DiagPreconditioner.h.

◆ Comm()

const Epetra_Comm& Ifpack_DiagPreconditioner::Comm ( ) const
inline

Definition at line 109 of file Ifpack_DiagPreconditioner.h.

◆ OperatorDomainMap()

const Epetra_Map& Ifpack_DiagPreconditioner::OperatorDomainMap ( ) const
inline

Definition at line 114 of file Ifpack_DiagPreconditioner.h.

◆ OperatorRangeMap()

const Epetra_Map& Ifpack_DiagPreconditioner::OperatorRangeMap ( ) const
inline

Definition at line 119 of file Ifpack_DiagPreconditioner.h.

◆ Map()

const Epetra_BlockMap& Ifpack_DiagPreconditioner::Map ( ) const
inline

Definition at line 124 of file Ifpack_DiagPreconditioner.h.

Member Data Documentation

◆ UseTranspose_

bool Ifpack_DiagPreconditioner::UseTranspose_
private

Definition at line 130 of file Ifpack_DiagPreconditioner.h.

◆ DomainMap_

const Epetra_Map& Ifpack_DiagPreconditioner::DomainMap_
private

Definition at line 131 of file Ifpack_DiagPreconditioner.h.

◆ RangeMap_

const Epetra_Map& Ifpack_DiagPreconditioner::RangeMap_
private

Definition at line 132 of file Ifpack_DiagPreconditioner.h.

◆ diag_

const Epetra_Vector& Ifpack_DiagPreconditioner::diag_
private

Definition at line 133 of file Ifpack_DiagPreconditioner.h.


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