A stochastic preconditioner based on applying a preconditioner to the fully assembled operator. More...

#include <Stokhos_FullyAssembledPreconditioner.hpp>

Inheritance diagram for Stokhos::FullyAssembledPreconditioner:

Public Member Functions
	FullyAssembledPreconditioner (const Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > &prec_factory, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
	Constructor. More...

virtual	~FullyAssembledPreconditioner ()
	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< Stokhos::AbstractPreconditionerFactory >	prec_factory
	Stores factory for building preconditioner. More...

Teuchos::RCP< Epetra_Operator >	prec
	Stores preconditioner. More...

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

FullyAssembledPreconditioner &	operator= (const FullyAssembledPreconditioner &)
	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 a preconditioner to the fully assembled operator.

Definition at line 57 of file Stokhos_FullyAssembledPreconditioner.hpp.

Constructor & Destructor Documentation

◆ FullyAssembledPreconditioner() [1/2]

Stokhos::FullyAssembledPreconditioner::FullyAssembledPreconditioner	(	const Teuchos::RCP< Stokhos::AbstractPreconditionerFactory > &	prec_factory,
		const Teuchos::RCP< Teuchos::ParameterList > &	params = `Teuchos::null`
	)

Constructor.

Definition at line 46 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ ~FullyAssembledPreconditioner()

Stokhos::FullyAssembledPreconditioner::~FullyAssembledPreconditioner ( )

virtual

Destructor.

Definition at line 56 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ FullyAssembledPreconditioner() [2/2]

Stokhos::FullyAssembledPreconditioner::FullyAssembledPreconditioner ( const FullyAssembledPreconditioner & )

private

Private to prohibit copying.

Member Function Documentation

◆ setupPreconditioner()

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

virtual

Setup preconditioner.

Implements Stokhos::SGPreconditioner.

Definition at line 62 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ SetUseTranspose()

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

virtual

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

Definition at line 76 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ Apply()

int Stokhos::FullyAssembledPreconditioner::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 83 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ ApplyInverse()

int Stokhos::FullyAssembledPreconditioner::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 90 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ NormInf()

double Stokhos::FullyAssembledPreconditioner::NormInf ( ) const

virtual

Returns an approximate infinity norm of the operator matrix.

Definition at line 97 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ Label()

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

virtual

Returns a character string describing the operator.

Definition at line 105 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ UseTranspose()

bool Stokhos::FullyAssembledPreconditioner::UseTranspose ( ) const

virtual

Returns the current UseTranspose setting.

Definition at line 112 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ HasNormInf()

bool Stokhos::FullyAssembledPreconditioner::HasNormInf ( ) const

virtual

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

Definition at line 119 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ Comm()

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

virtual

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

Definition at line 126 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ OperatorDomainMap()

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

virtual

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

Definition at line 132 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ OperatorRangeMap()

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

virtual

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

Definition at line 139 of file Stokhos_FullyAssembledPreconditioner.cpp.

◆ operator=()

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

private

Private to prohibit copying.

Member Data Documentation

◆ label

std::string Stokhos::FullyAssembledPreconditioner::label

protected

Label for operator.

Definition at line 145 of file Stokhos_FullyAssembledPreconditioner.hpp.

◆ prec_factory

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

protected

Stores factory for building preconditioner.

Definition at line 148 of file Stokhos_FullyAssembledPreconditioner.hpp.

◆ prec

Teuchos::RCP<Epetra_Operator> Stokhos::FullyAssembledPreconditioner::prec

protected

Stores preconditioner.

Definition at line 151 of file Stokhos_FullyAssembledPreconditioner.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

◆ FullyAssembledPreconditioner() [1/2]

◆ ~FullyAssembledPreconditioner()

◆ FullyAssembledPreconditioner() [2/2]

Member Function Documentation

◆ setupPreconditioner()

◆ SetUseTranspose()

◆ Apply()

◆ ApplyInverse()

◆ NormInf()

◆ Label()

◆ UseTranspose()

◆ HasNormInf()

◆ Comm()

◆ OperatorDomainMap()

◆ OperatorRangeMap()

◆ operator=()

Member Data Documentation

◆ label

◆ prec_factory

◆ prec