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

#include <Stokhos_ApproxGaussSeidelPreconditioner.hpp>

Inheritance diagram for Stokhos::ApproxGaussSeidelPreconditioner:

Collaboration diagram for Stokhos::ApproxGaussSeidelPreconditioner:

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.
Stokhos::SGPreconditioner methods
virtual void	setupPreconditioner (const Teuchos::RCP< Stokhos::SGOperator > &sg_op, const Epetra_Vector &x)
	Setup preconditioner.
Public Member Functions inherited from Stokhos::SGPreconditioner
	SGPreconditioner ()
	Constructor.
virtual	~SGPreconditioner ()
	Destructor.

Epetra_Operator methods
typedef Stokhos::Sparse3Tensor< int, double >	Cijk_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::EpetraSparse3Tensor >	epetraCijk
	Stores Epetra Cijk tensor.
Teuchos::RCP< const Epetra_Map >	base_map
	Stores base map.
Teuchos::RCP< const Epetra_Map >	sg_map
	Stores SG map.
Teuchos::RCP< Stokhos::AbstractPreconditionerFactory >	prec_factory
	Stores factory for building mean preconditioner.
Teuchos::RCP< Epetra_Operator >	mean_prec
	Stores mean preconditioner.
bool	useTranspose
	Flag indicating whether transpose was selected.
Teuchos::RCP< Stokhos::SGOperator >	sg_op
	Pointer to the SG operator.
Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly >	sg_poly
	Pointer to the PCE expansion of Jacobian.
Teuchos::RCP< const Cijk_type >	Cijk
	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_MultiVector >	mat_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_Comm &	Comm () const
	Returns a reference to the Epetra_Comm communicator associated with this operator.
virtual const Epetra_Map &	OperatorDomainMap () const
	Returns the Epetra_Map object associated with the domain of this matrix operator.
virtual const Epetra_Map &	OperatorRangeMap () const
	Returns the Epetra_Map object associated with the range of this matrix operator.

Detailed Description

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

Constructor & Destructor Documentation

◆ ApproxGaussSeidelPreconditioner()

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.

References base_map, Cijk, epetraCijk, label, mat_vec_tmp, mean_prec, only_use_linear, prec_factory, rhs_block, scale_op, sg_basis, sg_comm, sg_map, sg_op, sg_poly, symmetric, and useTranspose.

Member Function Documentation

◆ 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.

References sg_op.

◆ 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.

References base_map, Cijk, epetraCijk, mat_vec_tmp, mean_prec, only_use_linear, rhs_block, scale_op, sg_basis, sg_map, sg_poly, symmetric, and useTranspose.

◆ Comm()

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

virtual

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

References sg_comm.

◆ HasNormInf()

bool Stokhos::ApproxGaussSeidelPreconditioner::HasNormInf ( ) const

virtual

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

References sg_op.

◆ Label()

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

virtual

Returns a character string describing the operator.

References label.

◆ NormInf()

double Stokhos::ApproxGaussSeidelPreconditioner::NormInf ( ) const

virtual

Returns an approximate infinity norm of the operator matrix.

References sg_op.

◆ OperatorDomainMap()

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

virtual

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

References sg_map.

◆ OperatorRangeMap()

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

virtual

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

References sg_map.

◆ setupPreconditioner()

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

virtual

Setup preconditioner.

Implements Stokhos::SGPreconditioner.

References label, mean_prec, prec_factory, sg_op, and sg_poly.

◆ SetUseTranspose()

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

virtual

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

References mean_prec, sg_op, and useTranspose.

◆ UseTranspose()

bool Stokhos::ApproxGaussSeidelPreconditioner::UseTranspose ( ) const

virtual

Returns the current UseTranspose setting.

References useTranspose.

Member Data Documentation

◆ base_map

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

protected

Stores base map.

Referenced by ApplyInverse(), and ApproxGaussSeidelPreconditioner().

◆ Cijk

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

protected

Pointer to triple product.

Referenced by ApplyInverse(), and ApproxGaussSeidelPreconditioner().

◆ epetraCijk

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

protected

Stores Epetra Cijk tensor.

Referenced by ApplyInverse(), and ApproxGaussSeidelPreconditioner().

◆ label

std::string Stokhos::ApproxGaussSeidelPreconditioner::label

protected

Label for operator.

Referenced by ApproxGaussSeidelPreconditioner(), Label(), and setupPreconditioner().

◆ mat_vec_tmp

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

mutableprotected

Temporary vector for storing matrix-vector products.

Referenced by ApplyInverse(), and ApproxGaussSeidelPreconditioner().

◆ mean_prec

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

protected

Stores mean preconditioner.

Referenced by ApplyInverse(), ApproxGaussSeidelPreconditioner(), setupPreconditioner(), and SetUseTranspose().

◆ only_use_linear

bool Stokhos::ApproxGaussSeidelPreconditioner::only_use_linear

protected

Limit Gauss-Seidel loop to linear terms.

Referenced by ApplyInverse(), and ApproxGaussSeidelPreconditioner().

◆ prec_factory

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

protected

Stores factory for building mean preconditioner.

Referenced by ApproxGaussSeidelPreconditioner(), and setupPreconditioner().

◆ rhs_block

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

mutableprotected

Temporary vector for storing rhs in Gauss-Seidel loop.

Referenced by ApplyInverse(), and ApproxGaussSeidelPreconditioner().

◆ scale_op

bool Stokhos::ApproxGaussSeidelPreconditioner::scale_op

protected

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

Referenced by ApplyInverse(), and ApproxGaussSeidelPreconditioner().

◆ sg_basis

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

protected

Stochastic Galerking basis.

Referenced by ApplyInverse(), and ApproxGaussSeidelPreconditioner().

◆ sg_comm

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

protected

Stores SG parallel communicator.

Referenced by ApproxGaussSeidelPreconditioner(), and Comm().

◆ sg_map

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

protected

Stores SG map.

Referenced by ApplyInverse(), ApproxGaussSeidelPreconditioner(), OperatorDomainMap(), and OperatorRangeMap().

◆ sg_op

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

protected

Pointer to the SG operator.

Referenced by Apply(), ApproxGaussSeidelPreconditioner(), HasNormInf(), NormInf(), setupPreconditioner(), and SetUseTranspose().

◆ sg_poly

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

protected

Pointer to the PCE expansion of Jacobian.

Referenced by ApplyInverse(), ApproxGaussSeidelPreconditioner(), and setupPreconditioner().

◆ symmetric

bool Stokhos::ApproxGaussSeidelPreconditioner::symmetric

protected

Use symmetric Gauss-Seidel.

Referenced by ApplyInverse(), and ApproxGaussSeidelPreconditioner().

◆ useTranspose

bool Stokhos::ApproxGaussSeidelPreconditioner::useTranspose

protected

Flag indicating whether transpose was selected.

Referenced by ApplyInverse(), ApproxGaussSeidelPreconditioner(), SetUseTranspose(), and UseTranspose().

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

Stokhos_ApproxGaussSeidelPreconditioner.hpp
Stokhos_ApproxGaussSeidelPreconditioner.cpp

Public Member Functions

Epetra_Operator methods

Detailed Description

Constructor & Destructor Documentation

◆ ApproxGaussSeidelPreconditioner()

Member Function Documentation

◆ Apply()

◆ ApplyInverse()

◆ Comm()

◆ HasNormInf()

◆ Label()

◆ NormInf()

◆ OperatorDomainMap()

◆ OperatorRangeMap()

◆ setupPreconditioner()

◆ SetUseTranspose()

◆ UseTranspose()

Member Data Documentation

◆ base_map

◆ Cijk

◆ epetraCijk

◆ label

◆ mat_vec_tmp

◆ mean_prec

◆ only_use_linear

◆ prec_factory

◆ rhs_block

◆ scale_op

◆ sg_basis

◆ sg_comm

◆ sg_map

◆ sg_op

◆ sg_poly

◆ symmetric

◆ useTranspose