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

#include <Stokhos_ApproxGaussSeidelPreconditioner.hpp>

Inheritance 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. More...

virtual	~ApproxGaussSeidelPreconditioner ()
	Destructor. More...

Public Member Functions inherited from Stokhos::SGPreconditioner
	SGPreconditioner ()
	Constructor. More...

virtual	~SGPreconditioner ()
	Destructor. More...

Protected Types
typedef Stokhos::Sparse3Tensor< int, double >	Cijk_type
	Short-hand for Cijk. More...

Protected Attributes
std::string	label
	Label for operator. More...

Teuchos::RCP< const EpetraExt::MultiComm >	sg_comm
	Stores SG parallel communicator. More...

Teuchos::RCP< const Stokhos::OrthogPolyBasis< int, double > >	sg_basis
	Stochastic Galerking basis. More...

Teuchos::RCP< const Stokhos::EpetraSparse3Tensor >	epetraCijk
	Stores Epetra Cijk tensor. More...

Teuchos::RCP< const Epetra_Map >	base_map
	Stores base map. More...

Teuchos::RCP< const Epetra_Map >	sg_map
	Stores SG map. More...

Teuchos::RCP< Stokhos::AbstractPreconditionerFactory >	prec_factory
	Stores factory for building mean preconditioner. More...

Teuchos::RCP< Epetra_Operator >	mean_prec
	Stores mean preconditioner. More...

bool	useTranspose
	Flag indicating whether transpose was selected. More...

Teuchos::RCP< Stokhos::SGOperator >	sg_op
	Pointer to the SG operator. More...

Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly >	sg_poly
	Pointer to the PCE expansion of Jacobian. More...

Teuchos::RCP< const Cijk_type >	Cijk
	Pointer to triple product. More...

bool	scale_op
	Flag indicating whether operator be scaled with <^2> More...

bool	symmetric
	Use symmetric Gauss-Seidel. More...

bool	only_use_linear
	Limit Gauss-Seidel loop to linear terms. More...

Teuchos::RCP< Epetra_MultiVector >	mat_vec_tmp
	Temporary vector for storing matrix-vector products. More...

Teuchos::RCP< EpetraExt::BlockMultiVector >	rhs_block
	Temporary vector for storing rhs in Gauss-Seidel loop. More...

Private Member Functions
	ApproxGaussSeidelPreconditioner (const ApproxGaussSeidelPreconditioner &)
	Private to prohibit copying. More...

ApproxGaussSeidelPreconditioner &	operator= (const ApproxGaussSeidelPreconditioner &)
	Private to prohibit copying. More...

Stokhos::SGPreconditioner methods
virtual void	setupPreconditioner (const Teuchos::RCP< Stokhos::SGOperator > &sg_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...

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

typedef Stokhos::Sparse3Tensor<int,double> Stokhos::ApproxGaussSeidelPreconditioner::Cijk_type

protected

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 46 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ ~ApproxGaussSeidelPreconditioner()

Stokhos::ApproxGaussSeidelPreconditioner::~ApproxGaussSeidelPreconditioner ( )

virtual

Destructor.

Definition at line 78 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 84 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ SetUseTranspose()

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

virtual

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

Definition at line 97 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.

Definition at line 108 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.

Definition at line 115 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ NormInf()

double Stokhos::ApproxGaussSeidelPreconditioner::NormInf ( ) const

virtual

Returns an approximate infinity norm of the operator matrix.

Definition at line 270 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ Label()

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

virtual

Returns a character string describing the operator.

Definition at line 278 of file Stokhos_ApproxGaussSeidelPreconditioner.cpp.

◆ UseTranspose()

bool Stokhos::ApproxGaussSeidelPreconditioner::UseTranspose ( ) const

virtual

Returns the current UseTranspose setting.

Definition at line 285 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.

Definition at line 292 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.

Definition at line 299 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.

Definition at line 305 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.

Definition at line 312 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 <^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:

Public Member Functions

Protected Types

Protected Attributes

Private Member Functions

Stokhos::SGPreconditioner methods

Epetra_Operator methods

Detailed Description

Member Typedef Documentation

◆ Cijk_type

Constructor & Destructor Documentation

◆ ApproxGaussSeidelPreconditioner() [1/2]

◆ ~ApproxGaussSeidelPreconditioner()

◆ ApproxGaussSeidelPreconditioner() [2/2]

Member Function Documentation

◆ setupPreconditioner()

◆ SetUseTranspose()

◆ Apply()

◆ ApplyInverse()

◆ NormInf()

◆ Label()

◆ UseTranspose()

◆ HasNormInf()

◆ Comm()

◆ OperatorDomainMap()

◆ OperatorRangeMap()

◆ operator=()

Member Data Documentation

◆ label

◆ sg_comm

◆ sg_basis

◆ epetraCijk

◆ base_map

◆ sg_map

◆ prec_factory

◆ mean_prec

◆ useTranspose

◆ sg_op

◆ sg_poly

◆ Cijk

◆ scale_op

◆ symmetric

◆ only_use_linear

◆ mat_vec_tmp

◆ rhs_block