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

A stochastic preconditioner based on applying one iteration of approximate Gauss-Seidel. More...

#include <Stokhos_ApproxGaussSeidelPreconditioner.hpp>

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

Public Member Functions

 ApproxGaussSeidelPreconditioner (const Teuchos::RCP< const EpetraExt::MultiComm > &sg_comm, const Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > &sg_basis, const Teuchos::RCP< const Stokhos::EpetraSparse3Tensor > &epetraCijk, const Teuchos::RCP< const Epetra_Map > &base_map, const Teuchos::RCP< const Epetra_Map > &sg_map, const Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > &prec_factory, const Teuchos::RCP< Teuchos::ParameterList > &params)
 Constructor.
 
virtual ~ApproxGaussSeidelPreconditioner ()
 Destructor.
 
- Public Member Functions inherited from Stokhos::SGPreconditioner
 SGPreconditioner ()
 Constructor.
 
virtual ~SGPreconditioner ()
 Destructor.
 
virtual void setupPreconditioner (const Teuchos::RCP< Stokhos::SGOperator > &sg_op, const Epetra_Vector &x)=0
 Setup preconditioner.
 
- Public Member Functions inherited from Epetra_Operator
virtual ~Epetra_Operator ()
 
virtual int SetUseTranspose (bool UseTranspose)=0
 
virtual int Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const=0
 
virtual int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const=0
 
virtual double NormInf () const=0
 
virtual const char * Label () const=0
 
virtual bool UseTranspose () const=0
 
virtual bool HasNormInf () const=0
 
virtual const Epetra_CommComm () const=0
 
virtual const Epetra_MapOperatorDomainMap () const=0
 
virtual const Epetra_MapOperatorRangeMap () const=0
 

Epetra_Operator methods

typedef Stokhos::Sparse3Tensor< int, doubleCijk_type
 Short-hand for Cijk.
 
std::string label
 Label for operator.
 
Teuchos::RCP< const EpetraExt::MultiComm > sg_comm
 Stores SG parallel communicator.
 
Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > sg_basis
 Stochastic Galerking basis.
 
Teuchos::RCP< const Stokhos::EpetraSparse3TensorepetraCijk
 Stores Epetra Cijk tensor.
 
Teuchos::RCP< const Epetra_Mapbase_map
 Stores base map.
 
Teuchos::RCP< const Epetra_Mapsg_map
 Stores SG map.
 
Teuchos::RCP< Stokhos::AbstractPreconditionerFactoryprec_factory
 Stores factory for building mean preconditioner.
 
Teuchos::RCP< Epetra_Operatormean_prec
 Stores mean preconditioner.
 
bool useTranspose
 Flag indicating whether transpose was selected.
 
Teuchos::RCP< Stokhos::SGOperatorsg_op
 Pointer to the SG operator.
 
Teuchos::RCP< Stokhos::EpetraOperatorOrthogPolysg_poly
 Pointer to the PCE expansion of Jacobian.
 
Teuchos::RCP< const Cijk_typeCijk
 Pointer to triple product.
 
bool scale_op
 Flag indicating whether operator be scaled with <\psi_i^2>
 
bool symmetric
 Use symmetric Gauss-Seidel.
 
bool only_use_linear
 Limit Gauss-Seidel loop to linear terms.
 
Teuchos::RCP< Epetra_MultiVectormat_vec_tmp
 Temporary vector for storing matrix-vector products.
 
Teuchos::RCP< EpetraExt::BlockMultiVector > rhs_block
 Temporary vector for storing rhs in Gauss-Seidel loop.
 
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.
 
 ApproxGaussSeidelPreconditioner (const ApproxGaussSeidelPreconditioner &)
 Private to prohibit copying.
 
ApproxGaussSeidelPreconditioneroperator= (const ApproxGaussSeidelPreconditioner &)
 Private to prohibit copying.
 

Stokhos::SGPreconditioner methods

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

Detailed Description

A stochastic preconditioner based on applying one iteration of approximate Gauss-Seidel.

Definition at line 62 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

Member Typedef Documentation

◆ Cijk_type

Short-hand for Cijk.

Definition at line 188 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

Constructor & Destructor Documentation

◆ ApproxGaussSeidelPreconditioner() [1/2]

Stokhos::ApproxGaussSeidelPreconditioner::ApproxGaussSeidelPreconditioner ( const Teuchos::RCP< const EpetraExt::MultiComm > &  sg_comm,
const Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > > &  sg_basis,
const Teuchos::RCP< const Stokhos::EpetraSparse3Tensor > &  epetraCijk,
const Teuchos::RCP< const Epetra_Map > &  base_map,
const Teuchos::RCP< const Epetra_Map > &  sg_map,
const Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > &  prec_factory,
const Teuchos::RCP< Teuchos::ParameterList > &  params 
)

Constructor.

Definition at line 45 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ ~ApproxGaussSeidelPreconditioner()

Stokhos::ApproxGaussSeidelPreconditioner::~ApproxGaussSeidelPreconditioner ( )
virtual

Destructor.

Definition at line 77 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ ApproxGaussSeidelPreconditioner() [2/2]

Stokhos::ApproxGaussSeidelPreconditioner::ApproxGaussSeidelPreconditioner ( const ApproxGaussSeidelPreconditioner )
private

Private to prohibit copying.

Member Function Documentation

◆ setupPreconditioner()

void Stokhos::ApproxGaussSeidelPreconditioner::setupPreconditioner ( const Teuchos::RCP< Stokhos::SGOperator > &  sg_op,
const Epetra_Vector x 
)
virtual

Setup preconditioner.

Implements Stokhos::SGPreconditioner.

Definition at line 83 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ SetUseTranspose()

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

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

Implements Epetra_Operator.

Definition at line 96 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ Apply()

int Stokhos::ApproxGaussSeidelPreconditioner::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 107 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ ApplyInverse()

int Stokhos::ApproxGaussSeidelPreconditioner::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_ApproxGaussSeidelPreconditioner.cpp.

◆ NormInf()

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

Returns an approximate infinity norm of the operator matrix.

Implements Epetra_Operator.

Definition at line 269 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ Label()

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

Returns a character string describing the operator.

Implements Epetra_Operator.

Definition at line 277 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ UseTranspose()

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

Returns the current UseTranspose setting.

Implements Epetra_Operator.

Definition at line 284 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ HasNormInf()

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

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

Implements Epetra_Operator.

Definition at line 291 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ Comm()

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

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

Implements Epetra_Operator.

Definition at line 298 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ OperatorDomainMap()

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

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

Implements Epetra_Operator.

Definition at line 304 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ OperatorRangeMap()

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

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

Implements Epetra_Operator.

Definition at line 311 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ operator=()

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

Private to prohibit copying.

Member Data Documentation

◆ label

std::string Stokhos::ApproxGaussSeidelPreconditioner::label
protected

Label for operator.

Definition at line 155 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ sg_comm

Teuchos::RCP<const EpetraExt::MultiComm> Stokhos::ApproxGaussSeidelPreconditioner::sg_comm
protected

Stores SG parallel communicator.

Definition at line 158 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ sg_basis

Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> > Stokhos::ApproxGaussSeidelPreconditioner::sg_basis
protected

Stochastic Galerking basis.

Definition at line 161 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ epetraCijk

Teuchos::RCP<const Stokhos::EpetraSparse3Tensor> Stokhos::ApproxGaussSeidelPreconditioner::epetraCijk
protected

Stores Epetra Cijk tensor.

Definition at line 164 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ base_map

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

Stores base map.

Definition at line 167 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ sg_map

Teuchos::RCP<const Epetra_Map> Stokhos::ApproxGaussSeidelPreconditioner::sg_map
protected

Stores SG map.

Definition at line 170 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ prec_factory

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

Stores factory for building mean preconditioner.

Definition at line 173 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ mean_prec

Teuchos::RCP<Epetra_Operator> Stokhos::ApproxGaussSeidelPreconditioner::mean_prec
protected

Stores mean preconditioner.

Definition at line 176 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ useTranspose

bool Stokhos::ApproxGaussSeidelPreconditioner::useTranspose
protected

Flag indicating whether transpose was selected.

Definition at line 179 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ sg_op

Teuchos::RCP<Stokhos::SGOperator> Stokhos::ApproxGaussSeidelPreconditioner::sg_op
protected

Pointer to the SG operator.

Definition at line 182 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ sg_poly

Teuchos::RCP<Stokhos::EpetraOperatorOrthogPoly > Stokhos::ApproxGaussSeidelPreconditioner::sg_poly
protected

Pointer to the PCE expansion of Jacobian.

Definition at line 185 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ Cijk

Teuchos::RCP<const Cijk_type > Stokhos::ApproxGaussSeidelPreconditioner::Cijk
protected

Pointer to triple product.

Definition at line 191 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ scale_op

bool Stokhos::ApproxGaussSeidelPreconditioner::scale_op
protected

Flag indicating whether operator be scaled with <\psi_i^2>

Definition at line 194 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ symmetric

bool Stokhos::ApproxGaussSeidelPreconditioner::symmetric
protected

Use symmetric Gauss-Seidel.

Definition at line 197 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ only_use_linear

bool Stokhos::ApproxGaussSeidelPreconditioner::only_use_linear
protected

Limit Gauss-Seidel loop to linear terms.

Definition at line 200 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ mat_vec_tmp

Teuchos::RCP<Epetra_MultiVector> Stokhos::ApproxGaussSeidelPreconditioner::mat_vec_tmp
mutableprotected

Temporary vector for storing matrix-vector products.

Definition at line 203 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.

◆ rhs_block

Teuchos::RCP<EpetraExt::BlockMultiVector> Stokhos::ApproxGaussSeidelPreconditioner::rhs_block
mutableprotected

Temporary vector for storing rhs in Gauss-Seidel loop.

Definition at line 206 of file Stokhos_ApproxGaussSeidelPreconditioner.hpp.


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