Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Stokhos::MPBlockDiagonalPreconditioner Class Reference

A multi-point preconditioner based on applying the inverse of the diagonal. More...

#include <Stokhos_MPBlockDiagonalPreconditioner.hpp>

Inheritance diagram for Stokhos::MPBlockDiagonalPreconditioner:
Inheritance graph
[legend]

Public Member Functions

 MPBlockDiagonalPreconditioner (const Teuchos::RCP< const EpetraExt::MultiComm > &mp_comm, int num_mp_blocks, const Teuchos::RCP< const Epetra_Map > &base_map, const Teuchos::RCP< const Epetra_Map > &mp_map, const Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > &prec_factory, const Teuchos::RCP< Teuchos::ParameterList > &params)
 Constructor.
 
virtual ~MPBlockDiagonalPreconditioner ()
 Destructor.
 
- Public Member Functions inherited from Stokhos::MPPreconditioner
 MPPreconditioner ()
 Constructor.
 
virtual ~MPPreconditioner ()
 Destructor.
 
- Public Member Functions inherited from Epetra_Operator
virtual ~Epetra_Operator ()
 

Epetra_Operator methods

std::string label
 Label for operator.
 
Teuchos::RCP< const EpetraExt::MultiComm > mp_comm
 Stores MP parallel communicator.
 
int num_mp_blocks
 Number of mp blocks.
 
Teuchos::RCP< const Epetra_Mapbase_map
 Stores base map.
 
Teuchos::RCP< const Epetra_Mapmp_map
 Stores MP map.
 
Teuchos::RCP< Stokhos::AbstractPreconditionerFactoryprec_factory
 Stores factory for building mean preconditioner.
 
Teuchos::Array< Teuchos::RCP< Epetra_Operator > > block_precs
 Stores preconditioner for each block.
 
bool useTranspose
 Flag indicating whether transpose was selected.
 
virtual int SetUseTranspose (bool UseTranspose)
 Set to true if the transpose of the operator is requested.
 
virtual int Apply (const Epetra_MultiVector &Input, Epetra_MultiVector &Result) const
 Returns the result of a Epetra_Operator applied to a Epetra_MultiVector Input in Result as described above.
 
virtual int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns the result of the inverse of the operator applied to a Epetra_MultiVector Input in Result as described above.
 
virtual double NormInf () const
 Returns an approximate infinity norm of the operator matrix.
 
virtual const char * Label () const
 Returns a character string describing the operator.
 
virtual bool UseTranspose () const
 Returns the current UseTranspose setting.
 
virtual bool HasNormInf () const
 Returns true if the this object can provide an approximate Inf-norm, false otherwise.
 
virtual const Epetra_CommComm () const
 Returns a reference to the Epetra_Comm communicator associated with this operator.
 
virtual const Epetra_MapOperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this matrix operator.
 
virtual const Epetra_MapOperatorRangeMap () const
 Returns the Epetra_Map object associated with the range of this matrix operator.
 
 MPBlockDiagonalPreconditioner (const MPBlockDiagonalPreconditioner &)
 Private to prohibit copying.
 
MPBlockDiagonalPreconditioneroperator= (const MPBlockDiagonalPreconditioner &)
 Private to prohibit copying.
 

Stokhos::MPPreconditioner methods

virtual void setupPreconditioner (const Teuchos::RCP< Stokhos::BlockDiagonalOperator > &mp_op, const Epetra_Vector &x)
 Setup preconditioner.
 

Detailed Description

A multi-point preconditioner based on applying the inverse of the diagonal.

Definition at line 60 of file Stokhos_MPBlockDiagonalPreconditioner.hpp.

Constructor & Destructor Documentation

◆ MPBlockDiagonalPreconditioner() [1/2]

Stokhos::MPBlockDiagonalPreconditioner::MPBlockDiagonalPreconditioner ( const Teuchos::RCP< const EpetraExt::MultiComm > & mp_comm,
int num_mp_blocks,
const Teuchos::RCP< const Epetra_Map > & base_map,
const Teuchos::RCP< const Epetra_Map > & mp_map,
const Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > & prec_factory,
const Teuchos::RCP< Teuchos::ParameterList > & params )

Constructor.

Definition at line 45 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ ~MPBlockDiagonalPreconditioner()

Stokhos::MPBlockDiagonalPreconditioner::~MPBlockDiagonalPreconditioner ( )
virtual

Destructor.

Definition at line 64 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ MPBlockDiagonalPreconditioner() [2/2]

Stokhos::MPBlockDiagonalPreconditioner::MPBlockDiagonalPreconditioner ( const MPBlockDiagonalPreconditioner & )
private

Private to prohibit copying.

Member Function Documentation

◆ setupPreconditioner()

void Stokhos::MPBlockDiagonalPreconditioner::setupPreconditioner ( const Teuchos::RCP< Stokhos::BlockDiagonalOperator > & mp_op,
const Epetra_Vector & x )
virtual

Setup preconditioner.

Implements Stokhos::MPPreconditioner.

Definition at line 70 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ SetUseTranspose()

int Stokhos::MPBlockDiagonalPreconditioner::SetUseTranspose ( bool UseTranspose)
virtual

Set to true if the transpose of the operator is requested.

Implements Epetra_Operator.

Definition at line 90 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ Apply()

int Stokhos::MPBlockDiagonalPreconditioner::Apply ( const Epetra_MultiVector & Input,
Epetra_MultiVector & Result ) const
virtual

Returns the result of a Epetra_Operator applied to a Epetra_MultiVector Input in Result as described above.

Implements Epetra_Operator.

Definition at line 101 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ ApplyInverse()

int Stokhos::MPBlockDiagonalPreconditioner::ApplyInverse ( const Epetra_MultiVector & X,
Epetra_MultiVector & Y ) const
virtual

Returns the result of the inverse of the operator applied to a Epetra_MultiVector Input in Result as described above.

Implements Epetra_Operator.

Definition at line 114 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ NormInf()

double Stokhos::MPBlockDiagonalPreconditioner::NormInf ( ) const
virtual

Returns an approximate infinity norm of the operator matrix.

Implements Epetra_Operator.

Definition at line 128 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ Label()

const char * Stokhos::MPBlockDiagonalPreconditioner::Label ( ) const
virtual

Returns a character string describing the operator.

Implements Epetra_Operator.

Definition at line 143 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ UseTranspose()

bool Stokhos::MPBlockDiagonalPreconditioner::UseTranspose ( ) const
virtual

Returns the current UseTranspose setting.

Implements Epetra_Operator.

Definition at line 150 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ HasNormInf()

bool Stokhos::MPBlockDiagonalPreconditioner::HasNormInf ( ) const
virtual

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

Implements Epetra_Operator.

Definition at line 157 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ Comm()

const Epetra_Comm & Stokhos::MPBlockDiagonalPreconditioner::Comm ( ) const
virtual

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

Implements Epetra_Operator.

Definition at line 166 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ OperatorDomainMap()

const Epetra_Map & Stokhos::MPBlockDiagonalPreconditioner::OperatorDomainMap ( ) const
virtual

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

Implements Epetra_Operator.

Definition at line 172 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ OperatorRangeMap()

const Epetra_Map & Stokhos::MPBlockDiagonalPreconditioner::OperatorRangeMap ( ) const
virtual

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

Implements Epetra_Operator.

Definition at line 179 of file Stokhos_MPBlockDiagonalPreconditioner.cpp.

◆ operator=()

MPBlockDiagonalPreconditioner & Stokhos::MPBlockDiagonalPreconditioner::operator= ( const MPBlockDiagonalPreconditioner & )
private

Private to prohibit copying.

Member Data Documentation

◆ label

std::string Stokhos::MPBlockDiagonalPreconditioner::label
protected

Label for operator.

Definition at line 153 of file Stokhos_MPBlockDiagonalPreconditioner.hpp.

◆ mp_comm

Teuchos::RCP<const EpetraExt::MultiComm> Stokhos::MPBlockDiagonalPreconditioner::mp_comm
protected

Stores MP parallel communicator.

Definition at line 156 of file Stokhos_MPBlockDiagonalPreconditioner.hpp.

◆ num_mp_blocks

int Stokhos::MPBlockDiagonalPreconditioner::num_mp_blocks
protected

Number of mp blocks.

Definition at line 159 of file Stokhos_MPBlockDiagonalPreconditioner.hpp.

◆ base_map

Teuchos::RCP<const Epetra_Map> Stokhos::MPBlockDiagonalPreconditioner::base_map
protected

Stores base map.

Definition at line 162 of file Stokhos_MPBlockDiagonalPreconditioner.hpp.

◆ mp_map

Teuchos::RCP<const Epetra_Map> Stokhos::MPBlockDiagonalPreconditioner::mp_map
protected

Stores MP map.

Definition at line 165 of file Stokhos_MPBlockDiagonalPreconditioner.hpp.

◆ prec_factory

Teuchos::RCP<Stokhos::AbstractPreconditionerFactory> Stokhos::MPBlockDiagonalPreconditioner::prec_factory
protected

Stores factory for building mean preconditioner.

Definition at line 168 of file Stokhos_MPBlockDiagonalPreconditioner.hpp.

◆ block_precs

Teuchos::Array< Teuchos::RCP<Epetra_Operator> > Stokhos::MPBlockDiagonalPreconditioner::block_precs
protected

Stores preconditioner for each block.

Definition at line 171 of file Stokhos_MPBlockDiagonalPreconditioner.hpp.

◆ useTranspose

bool Stokhos::MPBlockDiagonalPreconditioner::useTranspose
protected

Flag indicating whether transpose was selected.

Definition at line 174 of file Stokhos_MPBlockDiagonalPreconditioner.hpp.


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