A container class for products of Epetra_Vector's. More...

#include <Stokhos_ProductEpetraOperator.hpp>

Inheritance diagram for Stokhos::ProductEpetraOperator:

Public Types
typedef double	value_type
	Typename of values. More...

typedef int	ordinal_type
	Typename of ordinals. More...

Public Types inherited from Stokhos::ProductContainer< Epetra_Operator >
typedef Stokhos::ProductContainerTraits < Epetra_Operator >	traits_type
	Typename of traits. More...

typedef traits_type::value_type	value_type
	Typename of values. More...

typedef traits_type::ordinal_type	ordinal_type
	Typename of ordinals. More...

Public Member Functions
	ProductEpetraOperator (const Teuchos::RCP< const Epetra_BlockMap > &block_map, const Teuchos::RCP< const Epetra_Map > &domain_base_map, const Teuchos::RCP< const Epetra_Map > &range_base_map, const Teuchos::RCP< const EpetraExt::MultiComm > &product_comm)
	Create a container with container map `block_map` where each coefficient is generated from the supplied coefficient map `coeff_map`. More...

	ProductEpetraOperator (const Teuchos::RCP< const Epetra_BlockMap > &block_map, const Teuchos::RCP< const Epetra_Map > &domain_base_map, const Teuchos::RCP< const Epetra_Map > &range_base_map, const Teuchos::RCP< const Epetra_Map > &range_product_map, const Teuchos::RCP< const EpetraExt::MultiComm > &product_comm)
	Create a container with container map `block_map` where each coefficient is generated from the supplied coefficient map `coeff_map`. More...

	ProductEpetraOperator (const ProductEpetraOperator &v)
	Copy constructor. More...

virtual	~ProductEpetraOperator ()
	Destructor. More...

ProductEpetraOperator &	operator= (const ProductEpetraOperator &v)
	Assignment. More...

Teuchos::RCP< const EpetraExt::MultiComm >	productComm () const
	Get product comm. More...

Public Member Functions inherited from Stokhos::ProductContainer< Epetra_Operator >
	ProductContainer ()
	Default constructor. More...

	ProductContainer (const Teuchos::RCP< const Epetra_BlockMap > &map)
	Create a container with container map `map`. More...

	ProductContainer (const Teuchos::RCP< const Epetra_BlockMap > &map, const typename traits_type::cloner_type &cloner)
	Create a container container map `map` where each coefficient is generated through a clone operation as implemented by the traits class for the coefficient. More...

	ProductContainer (const ProductContainer &)
	Copy constructor. More...

virtual	~ProductContainer ()
	Destructor. More...

ProductContainer &	operator= (const ProductContainer &)
	Assignment. More...

void	reset (const Teuchos::RCP< const Epetra_BlockMap > &map)
	Resize to new map `map`. More...

void	reset (const Teuchos::RCP< const Epetra_BlockMap > &map, const typename traits_type::cloner_type &cloner)
	Resize to new map `map` and create coefficients from `cloner`. More...

void	resize (const Teuchos::RCP< const Epetra_BlockMap > &map)
	Resize to map `map`. More...

void	reserve (ordinal_type sz)
	Reserve space for a size `sz` container. More...

ordinal_type	size () const
	Return size. More...

Teuchos::RCP< const Epetra_BlockMap >	map () const
	Return container map. More...

const Teuchos::Array < Teuchos::RCP < Epetra_Operator > > &	getCoefficients () const
	Return array of coefficients. More...

Teuchos::Array< Teuchos::RCP < Epetra_Operator > > &	getCoefficients ()
	Return array of coefficients. More...

Teuchos::RCP< Epetra_Operator >	getCoeffPtr (ordinal_type i)
	Return ref-count pointer to coefficient `i`. More...

Teuchos::RCP< const Epetra_Operator >	getCoeffPtr (ordinal_type i) const
	Return ref-count pointer to constant coefficient `i`. More...

void	setCoeffPtr (ordinal_type i, const Teuchos::RCP< Epetra_Operator > &c)
	Set coefficient `i` to `c`. More...

Epetra_Operator &	operator[] (ordinal_type i)
	Array access. More...

const Epetra_Operator &	operator[] (ordinal_type i) const
	Array access. More...

void	init (const value_type &val)
	Initialize coefficients. More...

bool	myGID (int i) const
	Return whether global index i resides on this processor. More...

std::ostream &	print (std::ostream &os) const
	Print polynomial. More...

Protected Member Functions
	ProductEpetraOperator (const Teuchos::RCP< const Epetra_BlockMap > &block_map, const Teuchos::RCP< const EpetraExt::MultiComm > &product_comm)
	Protected constructor to allow 2-stage derived setup. More...

void	setup (const Teuchos::RCP< const Epetra_Map > &domain_base_map, const Teuchos::RCP< const Epetra_Map > &range_base_map)
	Second stage of setup. More...

Protected Attributes
Teuchos::RCP< const Epetra_Map >	domain_base_map
	Domain map of each coefficient. More...

Teuchos::RCP< const Epetra_Map >	range_base_map
	Range map of each coefficient. More...

Teuchos::RCP< const Epetra_Map >	product_range_map
	Product range map. More...

Teuchos::RCP< const EpetraExt::MultiComm >	product_comm
	Product multi-level communicator. More...

bool	useTranspose
	Whether to use transpose in Apply() More...

Protected Attributes inherited from Stokhos::ProductContainer< Epetra_Operator >
Teuchos::RCP< const Epetra_BlockMap >	map_
	Container map. More...

Teuchos::Array< Teuchos::RCP < Epetra_Operator > >	coeff_
	Array of polynomial coefficients. 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 container class for products of Epetra_Vector's.

Definition at line 23 of file Stokhos_ProductEpetraOperator.hpp.

Member Typedef Documentation

typedef double Stokhos::ProductEpetraOperator::value_type

Typename of values.

Definition at line 29 of file Stokhos_ProductEpetraOperator.hpp.

typedef int Stokhos::ProductEpetraOperator::ordinal_type

Typename of ordinals.

Definition at line 32 of file Stokhos_ProductEpetraOperator.hpp.

Constructor & Destructor Documentation

Stokhos::ProductEpetraOperator::ProductEpetraOperator	(	const Teuchos::RCP< const Epetra_BlockMap > &	block_map,
		const Teuchos::RCP< const Epetra_Map > &	domain_base_map,
		const Teuchos::RCP< const Epetra_Map > &	range_base_map,
		const Teuchos::RCP< const EpetraExt::MultiComm > &	product_comm
	)

Create a container with container map block_map where each coefficient is generated from the supplied coefficient map coeff_map.

Definition at line 15 of file Stokhos_ProductEpetraOperator.cpp.

Stokhos::ProductEpetraOperator::ProductEpetraOperator	(	const Teuchos::RCP< const Epetra_BlockMap > &	block_map,
		const Teuchos::RCP< const Epetra_Map > &	domain_base_map,
		const Teuchos::RCP< const Epetra_Map > &	range_base_map,
		const Teuchos::RCP< const Epetra_Map > &	range_product_map,
		const Teuchos::RCP< const EpetraExt::MultiComm > &	product_comm
	)

Create a container with container map block_map where each coefficient is generated from the supplied coefficient map coeff_map.

Definition at line 30 of file Stokhos_ProductEpetraOperator.cpp.

Stokhos::ProductEpetraOperator::ProductEpetraOperator ( const ProductEpetraOperator & v )

Copy constructor.

NOTE: This is a shallow copy

Definition at line 46 of file Stokhos_ProductEpetraOperator.cpp.

Stokhos::ProductEpetraOperator::~ProductEpetraOperator ( )

virtual

Destructor.

Definition at line 57 of file Stokhos_ProductEpetraOperator.cpp.

Stokhos::ProductEpetraOperator::ProductEpetraOperator	(	const Teuchos::RCP< const Epetra_BlockMap > &	block_map,
		const Teuchos::RCP< const EpetraExt::MultiComm > &	product_comm
	)

protected

Protected constructor to allow 2-stage derived setup.

Definition at line 173 of file Stokhos_ProductEpetraOperator.cpp.

Member Function Documentation

Stokhos::ProductEpetraOperator & Stokhos::ProductEpetraOperator::operator= ( const ProductEpetraOperator & v )

Assignment.

NOTE: This is a shallow copy

Definition at line 61 of file Stokhos_ProductEpetraOperator.cpp.

Teuchos::RCP< const EpetraExt::MultiComm > Stokhos::ProductEpetraOperator::productComm ( ) const

Get product comm.

Definition at line 73 of file Stokhos_ProductEpetraOperator.cpp.

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

virtual

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

Implements Epetra_Operator.

Definition at line 79 of file Stokhos_ProductEpetraOperator.cpp.

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

int Stokhos::ProductEpetraOperator::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 112 of file Stokhos_ProductEpetraOperator.cpp.

double Stokhos::ProductEpetraOperator::NormInf ( ) const

virtual

Returns an approximate infinity norm of the operator matrix.

Implements Epetra_Operator.

Definition at line 121 of file Stokhos_ProductEpetraOperator.cpp.

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

virtual

Returns a character string describing the operator.

Implements Epetra_Operator.

Definition at line 129 of file Stokhos_ProductEpetraOperator.cpp.

bool Stokhos::ProductEpetraOperator::UseTranspose ( ) const

virtual

Returns the current UseTranspose setting.

Implements Epetra_Operator.

Definition at line 136 of file Stokhos_ProductEpetraOperator.cpp.

bool Stokhos::ProductEpetraOperator::HasNormInf ( ) const

virtual

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

Implements Epetra_Operator.

Definition at line 143 of file Stokhos_ProductEpetraOperator.cpp.

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

virtual

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

Implements Epetra_Operator.

Definition at line 150 of file Stokhos_ProductEpetraOperator.cpp.

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

virtual

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

Implements Epetra_Operator.

Definition at line 156 of file Stokhos_ProductEpetraOperator.cpp.

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

virtual

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

Implements Epetra_Operator.

Definition at line 165 of file Stokhos_ProductEpetraOperator.cpp.

void Stokhos::ProductEpetraOperator::setup	(	const Teuchos::RCP< const Epetra_Map > &	domain_base_map,
		const Teuchos::RCP< const Epetra_Map > &	range_base_map
	)