Stokhos Package Browser (Single Doxygen Collection)
Version of the Day
|
A multi-point preconditioner based on applying the inverse of the mean. More...
#include <Stokhos_MPMeanBasedPreconditioner.hpp>
Public Member Functions | |
MPMeanBasedPreconditioner (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 > ¶ms) | |
Constructor. More... | |
virtual | ~MPMeanBasedPreconditioner () |
Destructor. More... | |
Public Member Functions inherited from Stokhos::MPPreconditioner | |
MPPreconditioner () | |
Constructor. More... | |
virtual | ~MPPreconditioner () |
Destructor. More... | |
Protected Attributes | |
std::string | label |
Label for operator. More... | |
Teuchos::RCP< const EpetraExt::MultiComm > | mp_comm |
Stores MP parallel communicator. More... | |
int | num_mp_blocks |
Number of mp blocks. More... | |
Teuchos::RCP< const Epetra_Map > | base_map |
Stores base map. More... | |
Teuchos::RCP< const Epetra_Map > | mp_map |
Stores MP map. More... | |
Teuchos::RCP < Stokhos::AbstractPreconditionerFactory > | prec_factory |
Stores factory for building mean preconditioner. More... | |
Teuchos::RCP< Epetra_Operator > | mean_prec |
Stores preconditioner for each block. More... | |
bool | useTranspose |
Flag indicating whether transpose was selected. More... | |
Private Member Functions | |
MPMeanBasedPreconditioner (const MPMeanBasedPreconditioner &) | |
Private to prohibit copying. More... | |
MPMeanBasedPreconditioner & | operator= (const MPMeanBasedPreconditioner &) |
Private to prohibit copying. More... | |
Stokhos::MPPreconditioner methods | |
virtual void | setupPreconditioner (const Teuchos::RCP< Stokhos::BlockDiagonalOperator > &mp_op, const Epetra_Vector &x) |
Setup preconditioner. More... | |
Epetra_Operator methods | |
virtual int | SetUseTranspose (bool UseTranspose) |
Set to true if the transpose of the operator is requested. More... | |
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. More... | |
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. More... | |
virtual double | NormInf () const |
Returns an approximate infinity norm of the operator matrix. More... | |
virtual const char * | Label () const |
Returns a character string describing the operator. More... | |
virtual bool | UseTranspose () const |
Returns the current UseTranspose setting. More... | |
virtual bool | HasNormInf () const |
Returns true if the this object can provide an approximate Inf-norm, false otherwise. More... | |
virtual const Epetra_Comm & | Comm () const |
Returns a reference to the Epetra_Comm communicator associated with this operator. More... | |
virtual const Epetra_Map & | OperatorDomainMap () const |
Returns the Epetra_Map object associated with the domain of this matrix operator. More... | |
virtual const Epetra_Map & | OperatorRangeMap () const |
Returns the Epetra_Map object associated with the range of this matrix operator. More... | |
A multi-point preconditioner based on applying the inverse of the mean.
Definition at line 28 of file Stokhos_MPMeanBasedPreconditioner.hpp.
Stokhos::MPMeanBasedPreconditioner::MPMeanBasedPreconditioner | ( | 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 14 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
virtual |
Destructor.
Definition at line 33 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
private |
Private to prohibit copying.
|
virtual |
Setup preconditioner.
Implements Stokhos::MPPreconditioner.
Definition at line 39 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
virtual |
Set to true if the transpose of the operator is requested.
Implements Epetra_Operator.
Definition at line 58 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
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 68 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
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 81 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
virtual |
Returns an approximate infinity norm of the operator matrix.
Implements Epetra_Operator.
Definition at line 94 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
virtual |
Returns a character string describing the operator.
Implements Epetra_Operator.
Definition at line 102 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
virtual |
Returns the current UseTranspose setting.
Implements Epetra_Operator.
Definition at line 109 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
virtual |
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Implements Epetra_Operator.
Definition at line 116 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
virtual |
Returns a reference to the Epetra_Comm communicator associated with this operator.
Implements Epetra_Operator.
Definition at line 123 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
virtual |
Returns the Epetra_Map object associated with the domain of this matrix operator.
Implements Epetra_Operator.
Definition at line 129 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
virtual |
Returns the Epetra_Map object associated with the range of this matrix operator.
Implements Epetra_Operator.
Definition at line 136 of file Stokhos_MPMeanBasedPreconditioner.cpp.
|
private |
Private to prohibit copying.
|
protected |
Label for operator.
Definition at line 121 of file Stokhos_MPMeanBasedPreconditioner.hpp.
|
protected |
Stores MP parallel communicator.
Definition at line 124 of file Stokhos_MPMeanBasedPreconditioner.hpp.
|
protected |
Number of mp blocks.
Definition at line 127 of file Stokhos_MPMeanBasedPreconditioner.hpp.
|
protected |
Stores base map.
Definition at line 130 of file Stokhos_MPMeanBasedPreconditioner.hpp.
|
protected |
Stores MP map.
Definition at line 133 of file Stokhos_MPMeanBasedPreconditioner.hpp.
|
protected |
Stores factory for building mean preconditioner.
Definition at line 136 of file Stokhos_MPMeanBasedPreconditioner.hpp.
|
protected |
Stores preconditioner for each block.
Definition at line 139 of file Stokhos_MPMeanBasedPreconditioner.hpp.
|
protected |
Flag indicating whether transpose was selected.
Definition at line 142 of file Stokhos_MPMeanBasedPreconditioner.hpp.