A stochastic preconditioner based on applying two iterations of approximate Jacobi. More...

#include <Stokhos_ApproxJacobiPreconditioner.hpp>

Inheritance diagram for Stokhos::ApproxJacobiPreconditioner:

Public Member Functions
	ApproxJacobiPreconditioner (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	~ApproxJacobiPreconditioner ()
	Destructor. More...

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

virtual	~SGPreconditioner ()
	Destructor. 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...

int	num_iter
	Number of Jacobi iterations. 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< Stokhos::SGOperator >	mat_free_op
	SG operator to implement SG mat-vec. More...

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

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

ApproxJacobiPreconditioner &	operator= (const ApproxJacobiPreconditioner &)
	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 two iterations of approximate Jacobi.

Definition at line 31 of file Stokhos_ApproxJacobiPreconditioner.hpp.

Constructor & Destructor Documentation

Stokhos::ApproxJacobiPreconditioner::ApproxJacobiPreconditioner	(	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 15 of file Stokhos_ApproxJacobiPreconditioner.cpp.

Stokhos::ApproxJacobiPreconditioner::~ApproxJacobiPreconditioner ( )

virtual

Destructor.

Definition at line 63 of file Stokhos_ApproxJacobiPreconditioner.cpp.

Stokhos::ApproxJacobiPreconditioner::ApproxJacobiPreconditioner ( const ApproxJacobiPreconditioner & )

private

Private to prohibit copying.

Member Function Documentation

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

virtual

Setup preconditioner.

Implements Stokhos::SGPreconditioner.

Definition at line 69 of file Stokhos_ApproxJacobiPreconditioner.cpp.

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

virtual

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

Implements Epetra_Operator.

Definition at line 83 of file Stokhos_ApproxJacobiPreconditioner.cpp.

int Stokhos::ApproxJacobiPreconditioner::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 95 of file Stokhos_ApproxJacobiPreconditioner.cpp.

int Stokhos::ApproxJacobiPreconditioner::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 102 of file Stokhos_ApproxJacobiPreconditioner.cpp.

double Stokhos::ApproxJacobiPreconditioner::NormInf ( ) const

virtual

Returns an approximate infinity norm of the operator matrix.

Implements Epetra_Operator.

Definition at line 157 of file Stokhos_ApproxJacobiPreconditioner.cpp.

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

virtual

Returns a character string describing the operator.

Implements Epetra_Operator.

Definition at line 165 of file Stokhos_ApproxJacobiPreconditioner.cpp.

bool Stokhos::ApproxJacobiPreconditioner::UseTranspose ( ) const

virtual

Returns the current UseTranspose setting.

Implements Epetra_Operator.

Definition at line 172 of file Stokhos_ApproxJacobiPreconditioner.cpp.

bool Stokhos::ApproxJacobiPreconditioner::HasNormInf ( ) const

virtual

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

Implements Epetra_Operator.

Definition at line 179 of file Stokhos_ApproxJacobiPreconditioner.cpp.

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

virtual

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

Implements Epetra_Operator.

Definition at line 186 of file Stokhos_ApproxJacobiPreconditioner.cpp.

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

virtual

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

Implements Epetra_Operator.

Definition at line 192 of file Stokhos_ApproxJacobiPreconditioner.cpp.

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

virtual

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

Implements Epetra_Operator.

Definition at line 199 of file Stokhos_ApproxJacobiPreconditioner.cpp.

ApproxJacobiPreconditioner& Stokhos::ApproxJacobiPreconditioner::operator= ( const ApproxJacobiPreconditioner & )

private

Private to prohibit copying.

Member Data Documentation

std::string Stokhos::ApproxJacobiPreconditioner::label

protected

Label for operator.

Definition at line 124 of file Stokhos_ApproxJacobiPreconditioner.hpp.

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

protected

Stores SG parallel communicator.

Definition at line 127 of file Stokhos_ApproxJacobiPreconditioner.hpp.

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

protected

Stochastic Galerking basis.

Definition at line 130 of file Stokhos_ApproxJacobiPreconditioner.hpp.

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

protected

Stores Epetra Cijk tensor.

Definition at line 133 of file Stokhos_ApproxJacobiPreconditioner.hpp.

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

protected

Stores base map.

Definition at line 136 of file Stokhos_ApproxJacobiPreconditioner.hpp.

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

protected

Stores SG map.

Definition at line 139 of file Stokhos_ApproxJacobiPreconditioner.hpp.

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

protected

Stores factory for building mean preconditioner.

Definition at line 142 of file Stokhos_ApproxJacobiPreconditioner.hpp.

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

protected

Stores mean preconditioner.

Definition at line 145 of file Stokhos_ApproxJacobiPreconditioner.hpp.

bool Stokhos::ApproxJacobiPreconditioner::useTranspose

protected

Flag indicating whether transpose was selected.

Definition at line 148 of file Stokhos_ApproxJacobiPreconditioner.hpp.

int Stokhos::ApproxJacobiPreconditioner::num_iter

protected

Number of Jacobi iterations.

Definition at line 151 of file Stokhos_ApproxJacobiPreconditioner.hpp.

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

protected

Pointer to the SG operator.

Definition at line 154 of file Stokhos_ApproxJacobiPreconditioner.hpp.

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

protected

Pointer to the PCE expansion of Jacobian.

Definition at line 157 of file Stokhos_ApproxJacobiPreconditioner.hpp.

Teuchos::RCP<Stokhos::SGOperator> Stokhos::ApproxJacobiPreconditioner::mat_free_op

protected

SG operator to implement SG mat-vec.

Definition at line 160 of file Stokhos_ApproxJacobiPreconditioner.hpp.

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

mutableprotected

Temporary vector for storing rhs in Gauss-Seidel loop.

Definition at line 163 of file Stokhos_ApproxJacobiPreconditioner.hpp.

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

Public Member Functions

Protected Attributes

Private Member Functions

Stokhos::SGPreconditioner methods

Epetra_Operator methods

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation