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

#include <Stokhos_MeanBasedPreconditioner.hpp>

Inheritance diagram for Stokhos::MeanBasedPreconditioner:

Collaboration 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.
virtual	~MeanBasedPreconditioner ()
	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
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.
int	num_blocks
	Number of blocks.
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.
bool	use_block_apply
	Flag indicating whether to use apply all vectors simultaneously.
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 the inverse of the mean.

Constructor & Destructor Documentation

◆ MeanBasedPreconditioner()

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.

References base_map, epetraCijk, label, mean_prec, num_blocks, prec_factory, sg_basis, sg_comm, sg_map, use_block_apply, and useTranspose.

Member Function Documentation

◆ Apply()

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.

References base_map, epetraCijk, mean_prec, and use_block_apply.

◆ ApplyInverse()

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.

References base_map, epetraCijk, mean_prec, and use_block_apply.

◆ Comm()

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

virtual

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

References sg_comm.

◆ Label()

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

virtual

Returns a character string describing the operator.

References label.

◆ NormInf()

double Stokhos::MeanBasedPreconditioner::NormInf ( ) const

virtual

Returns an approximate infinity norm of the operator matrix.

References mean_prec.

◆ OperatorDomainMap()

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

virtual

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

References sg_map.

◆ OperatorRangeMap()

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

virtual

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

References sg_map.

◆ setupPreconditioner()

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

virtual

Setup preconditioner.

Implements Stokhos::SGPreconditioner.

References label, mean_prec, num_blocks, prec_factory, and sg_basis.

◆ SetUseTranspose()

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

virtual

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

References mean_prec, and useTranspose.

◆ UseTranspose()

bool Stokhos::MeanBasedPreconditioner::UseTranspose ( ) const

virtual

Returns the current UseTranspose setting.

References useTranspose.

Member Data Documentation

◆ base_map

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

protected

Stores base map.

Referenced by Apply(), ApplyInverse(), and MeanBasedPreconditioner().

◆ epetraCijk

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

protected

Stores Epetra Cijk tensor.

Referenced by Apply(), ApplyInverse(), and MeanBasedPreconditioner().

◆ label

std::string Stokhos::MeanBasedPreconditioner::label

protected

Label for operator.

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

◆ mean_prec

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

protected

Stores mean preconditioner.

Referenced by Apply(), ApplyInverse(), MeanBasedPreconditioner(), NormInf(), setupPreconditioner(), and SetUseTranspose().

◆ num_blocks

int Stokhos::MeanBasedPreconditioner::num_blocks

protected

Number of blocks.

Referenced by MeanBasedPreconditioner(), and setupPreconditioner().

◆ prec_factory

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

protected

Stores factory for building mean preconditioner.

Referenced by MeanBasedPreconditioner(), and setupPreconditioner().

◆ sg_basis

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

protected

Stochastic Galerking basis.

Referenced by MeanBasedPreconditioner(), and setupPreconditioner().

◆ sg_comm

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

protected

Stores SG parallel communicator.

Referenced by Comm(), and MeanBasedPreconditioner().

◆ sg_map

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

protected

Stores SG map.

Referenced by MeanBasedPreconditioner(), OperatorDomainMap(), and OperatorRangeMap().

◆ use_block_apply

bool Stokhos::MeanBasedPreconditioner::use_block_apply

protected

Flag indicating whether to use apply all vectors simultaneously.

Referenced by Apply(), ApplyInverse(), and MeanBasedPreconditioner().

◆ useTranspose

bool Stokhos::MeanBasedPreconditioner::useTranspose

protected

Flag indicating whether transpose was selected.

Referenced by MeanBasedPreconditioner(), SetUseTranspose(), and UseTranspose().

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

Stokhos_MeanBasedPreconditioner.hpp
Stokhos_MeanBasedPreconditioner.cpp

Public Member Functions

Epetra_Operator methods

Detailed Description

Constructor & Destructor Documentation

◆ MeanBasedPreconditioner()

Member Function Documentation

◆ Apply()

◆ ApplyInverse()

◆ Comm()

◆ Label()

◆ NormInf()

◆ OperatorDomainMap()

◆ OperatorRangeMap()

◆ setupPreconditioner()

◆ SetUseTranspose()

◆ UseTranspose()

Member Data Documentation

◆ base_map

◆ epetraCijk

◆ label

◆ mean_prec

◆ num_blocks

◆ prec_factory

◆ sg_basis

◆ sg_comm

◆ sg_map

◆ use_block_apply

◆ useTranspose