A stochastic preconditioner based on applying the inverse of the mean. More...

#include <Stokhos_MeanBasedPreconditioner.hpp>

Inheritance diagram for Stokhos::MeanBasedPreconditioner:

Public Member Functions
	MeanBasedPreconditioner (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	~MeanBasedPreconditioner ()
	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...

int	num_blocks
	Number of blocks. 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...

bool	use_block_apply
	Flag indicating whether to use apply all vectors simultaneously. More...

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

MeanBasedPreconditioner &	operator= (const MeanBasedPreconditioner &)
	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 the inverse of the mean.

Definition at line 29 of file Stokhos_MeanBasedPreconditioner.hpp.

Constructor & Destructor Documentation

Stokhos::MeanBasedPreconditioner::MeanBasedPreconditioner	(	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 14 of file Stokhos_MeanBasedPreconditioner.cpp.

Stokhos::MeanBasedPreconditioner::~MeanBasedPreconditioner ( )

virtual

Destructor.

Definition at line 38 of file Stokhos_MeanBasedPreconditioner.cpp.

Stokhos::MeanBasedPreconditioner::MeanBasedPreconditioner ( const MeanBasedPreconditioner & )

private

Private to prohibit copying.

Member Function Documentation

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

virtual

Setup preconditioner.

Implements Stokhos::SGPreconditioner.

Definition at line 44 of file Stokhos_MeanBasedPreconditioner.cpp.

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

virtual

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

Implements Epetra_Operator.

Definition at line 62 of file Stokhos_MeanBasedPreconditioner.cpp.

int Stokhos::MeanBasedPreconditioner::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 72 of file Stokhos_MeanBasedPreconditioner.cpp.

int Stokhos::MeanBasedPreconditioner::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 100 of file Stokhos_MeanBasedPreconditioner.cpp.

double Stokhos::MeanBasedPreconditioner::NormInf ( ) const

virtual

Returns an approximate infinity norm of the operator matrix.

Implements Epetra_Operator.

Definition at line 129 of file Stokhos_MeanBasedPreconditioner.cpp.

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

virtual

Returns a character string describing the operator.

Implements Epetra_Operator.

Definition at line 137 of file Stokhos_MeanBasedPreconditioner.cpp.

bool Stokhos::MeanBasedPreconditioner::UseTranspose ( ) const

virtual

Returns the current UseTranspose setting.

Implements Epetra_Operator.

Definition at line 144 of file Stokhos_MeanBasedPreconditioner.cpp.

bool Stokhos::MeanBasedPreconditioner::HasNormInf ( ) const

virtual

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

Implements Epetra_Operator.

Definition at line 151 of file Stokhos_MeanBasedPreconditioner.cpp.

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

virtual

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

Implements Epetra_Operator.

Definition at line 158 of file Stokhos_MeanBasedPreconditioner.cpp.

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

virtual

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

Implements Epetra_Operator.

Definition at line 164 of file Stokhos_MeanBasedPreconditioner.cpp.

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

virtual

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

Implements Epetra_Operator.

Definition at line 171 of file Stokhos_MeanBasedPreconditioner.cpp.

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

private

Private to prohibit copying.

Member Data Documentation

std::string Stokhos::MeanBasedPreconditioner::label

protected

Label for operator.

Definition at line 122 of file Stokhos_MeanBasedPreconditioner.hpp.

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

protected

Stores SG parallel communicator.

Definition at line 125 of file Stokhos_MeanBasedPreconditioner.hpp.

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

protected

Stochastic Galerking basis.

Definition at line 128 of file Stokhos_MeanBasedPreconditioner.hpp.

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

protected

Stores Epetra Cijk tensor.

Definition at line 131 of file Stokhos_MeanBasedPreconditioner.hpp.

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

protected

Stores base map.

Definition at line 134 of file Stokhos_MeanBasedPreconditioner.hpp.

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

protected

Stores SG map.

Definition at line 137 of file Stokhos_MeanBasedPreconditioner.hpp.

int Stokhos::MeanBasedPreconditioner::num_blocks

protected

Number of blocks.

Definition at line 140 of file Stokhos_MeanBasedPreconditioner.hpp.

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

protected

Stores factory for building mean preconditioner.

Definition at line 143 of file Stokhos_MeanBasedPreconditioner.hpp.

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

protected

Stores mean preconditioner.

Definition at line 146 of file Stokhos_MeanBasedPreconditioner.hpp.

bool Stokhos::MeanBasedPreconditioner::useTranspose

protected

Flag indicating whether transpose was selected.

Definition at line 149 of file Stokhos_MeanBasedPreconditioner.hpp.

bool Stokhos::MeanBasedPreconditioner::use_block_apply

protected

Flag indicating whether to use apply all vectors simultaneously.

Definition at line 152 of file Stokhos_MeanBasedPreconditioner.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