A container class storing products of Epetra_MultiVector's. More...

#include <Stokhos_ProductEpetraMultiVector.hpp>

Inheritance diagram for Stokhos::ProductEpetraMultiVector:

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_MultiVector >
typedef Stokhos::ProductContainerTraits < Epetra_MultiVector >	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
	ProductEpetraMultiVector ()
	Default constructor. More...

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

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

	ProductEpetraMultiVector (const Teuchos::RCP< const Epetra_BlockMap > &block_map, const Teuchos::RCP< const Epetra_BlockMap > &coeff_map, const Teuchos::RCP< const Epetra_BlockMap > &product_map, const Teuchos::RCP< const EpetraExt::MultiComm > &product_comm, int num_vectors)
	Create a container with container map `block_map` where each coefficient is generated from the supplied coefficient map `coeff_map`. More...

	ProductEpetraMultiVector (const Teuchos::RCP< const Epetra_BlockMap > &block_map, const Teuchos::RCP< const Epetra_BlockMap > &coeff_map, const Teuchos::RCP< const Epetra_BlockMap > &product_map, const Teuchos::RCP< const EpetraExt::MultiComm > &product_comm, Epetra_DataAccess CV, const Epetra_MultiVector &block_vector)
	Create a container with container map `block_map` where each coefficient is given by the supplied block vector. More...

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

virtual	~ProductEpetraMultiVector ()
	Destructor. More...

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

ProductEpetraMultiVector &	operator= (const Epetra_MultiVector &v)
	Assignment. More...

void	assignToBlockMultiVector (Epetra_MultiVector &v) const
	Assignment. More...

void	assignFromBlockMultiVector (const Epetra_MultiVector &v)
	Assignment. More...

Teuchos::RCP< const Epetra_BlockMap >	coefficientMap () const
	Get coefficient map. More...

Teuchos::RCP< const Epetra_BlockMap >	productMap () const
	Get product map. More...

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

int	numVectors () const
	Get number of vectors. More...

void	reset (const Teuchos::RCP< const Epetra_BlockMap > &block_map, const Teuchos::RCP< const Epetra_BlockMap > &coeff_map, const Teuchos::RCP< const EpetraExt::MultiComm > &product_comm, int num_vectors)
	Reset to a new size. More...

void	reset (const Teuchos::RCP< const Epetra_BlockMap > &block_map, const Teuchos::RCP< const Epetra_BlockMap > &coeff_map, const Teuchos::RCP< const Epetra_BlockMap > &product_map, const Teuchos::RCP< const EpetraExt::MultiComm > &product_comm, int num_vectors)
	Reset to a new size. More...

void	resetCoefficients (Epetra_DataAccess CV, const Epetra_MultiVector &block_vector)
	Reset vector cofficients. More...

Teuchos::RCP < EpetraExt::BlockMultiVector >	getBlockMultiVector ()
	Get block vector. More...

Teuchos::RCP< const EpetraExt::BlockMultiVector >	getBlockMultiVector () const
	Get block vector. More...

void	setBlockMultiVector (const Teuchos::RCP< EpetraExt::BlockMultiVector > &block_vec)
	Set block vector. More...

Public Member Functions inherited from Stokhos::ProductContainer< Epetra_MultiVector >
	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_MultiVector > > &	getCoefficients () const
	Return array of coefficients. More...

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

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

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

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

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

const Epetra_MultiVector &	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 Attributes
Teuchos::RCP< const Epetra_BlockMap >	coeff_map
	Product map of block vector. More...

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

Teuchos::RCP< const Epetra_BlockMap >	product_map
	Product map of block vector. More...

Teuchos::RCP < EpetraExt::BlockMultiVector >	bv
	Block vector storing coefficients. More...

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

Teuchos::Array< Teuchos::RCP < Epetra_MultiVector > >	coeff_
	Array of polynomial coefficients. More...

Detailed Description

A container class storing products of Epetra_MultiVector's.

Definition at line 56 of file Stokhos_ProductEpetraMultiVector.hpp.

Member Typedef Documentation

typedef double Stokhos::ProductEpetraMultiVector::value_type

Typename of values.

Definition at line 61 of file Stokhos_ProductEpetraMultiVector.hpp.

typedef int Stokhos::ProductEpetraMultiVector::ordinal_type

Typename of ordinals.

Definition at line 64 of file Stokhos_ProductEpetraMultiVector.hpp.

Constructor & Destructor Documentation

Stokhos::ProductEpetraMultiVector::ProductEpetraMultiVector ( )

Default constructor.

Use with care! Generally you will want to call reset() before using any of the methods on this class.

Definition at line 47 of file Stokhos_ProductEpetraMultiVector.cpp.

Stokhos::ProductEpetraMultiVector::ProductEpetraMultiVector ( const Teuchos::RCP< const Epetra_BlockMap > & block_map )

Create a container with container map block_map.

Definition at line 53 of file Stokhos_ProductEpetraMultiVector.cpp.

Stokhos::ProductEpetraMultiVector::ProductEpetraMultiVector	(	const Teuchos::RCP< const Epetra_BlockMap > &	block_map,
		const Teuchos::RCP< const Epetra_BlockMap > &	coeff_map,
		const Teuchos::RCP< const EpetraExt::MultiComm > &	product_comm,
		int	num_vectors
	)

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

Definition at line 59 of file Stokhos_ProductEpetraMultiVector.cpp.

Stokhos::ProductEpetraMultiVector::ProductEpetraMultiVector	(	const Teuchos::RCP< const Epetra_BlockMap > &	block_map,
		const Teuchos::RCP< const Epetra_BlockMap > &	coeff_map,
		const Teuchos::RCP< const Epetra_BlockMap > &	product_map,
		const Teuchos::RCP< const EpetraExt::MultiComm > &	product_comm,
		int	num_vectors
	)

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

Definition at line 76 of file Stokhos_ProductEpetraMultiVector.cpp.

Stokhos::ProductEpetraMultiVector::ProductEpetraMultiVector	(	const Teuchos::RCP< const Epetra_BlockMap > &	block_map,
		const Teuchos::RCP< const Epetra_BlockMap > &	coeff_map,
		const Teuchos::RCP< const Epetra_BlockMap > &	product_map,
		const Teuchos::RCP< const EpetraExt::MultiComm > &	product_comm,
		Epetra_DataAccess	CV,
		const Epetra_MultiVector &	block_vector
	)

Create a container with container map block_map where each coefficient is given by the supplied block vector.

Definition at line 94 of file Stokhos_ProductEpetraMultiVector.cpp.

Stokhos::ProductEpetraMultiVector::ProductEpetraMultiVector ( const ProductEpetraMultiVector & v )

Copy constructor.

NOTE: This is a shallow copy

Definition at line 113 of file Stokhos_ProductEpetraMultiVector.cpp.

Stokhos::ProductEpetraMultiVector::~ProductEpetraMultiVector ( )

virtual

Destructor.

Definition at line 123 of file Stokhos_ProductEpetraMultiVector.cpp.

Member Function Documentation

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

Assignment.

NOTE: This is a shallow copy

Definition at line 127 of file Stokhos_ProductEpetraMultiVector.cpp.

Stokhos::ProductEpetraMultiVector & Stokhos::ProductEpetraMultiVector::operator= ( const Epetra_MultiVector & v )

Assignment.

Definition at line 138 of file Stokhos_ProductEpetraMultiVector.cpp.

void Stokhos::ProductEpetraMultiVector::assignToBlockMultiVector ( Epetra_MultiVector & v ) const

Assignment.

Definition at line 153 of file Stokhos_ProductEpetraMultiVector.cpp.

void Stokhos::ProductEpetraMultiVector::assignFromBlockMultiVector ( const Epetra_MultiVector & v )

Assignment.

Definition at line 168 of file Stokhos_ProductEpetraMultiVector.cpp.

Teuchos::RCP< const Epetra_BlockMap > Stokhos::ProductEpetraMultiVector::coefficientMap ( ) const

Get coefficient map.

Definition at line 183 of file Stokhos_ProductEpetraMultiVector.cpp.

Teuchos::RCP< const Epetra_BlockMap > Stokhos::ProductEpetraMultiVector::productMap ( ) const

Get product map.

Definition at line 189 of file Stokhos_ProductEpetraMultiVector.cpp.

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

Get product comm.

Definition at line 195 of file Stokhos_ProductEpetraMultiVector.cpp.

int Stokhos::ProductEpetraMultiVector::numVectors ( ) const

Get number of vectors.

Definition at line 201 of file Stokhos_ProductEpetraMultiVector.cpp.

void Stokhos::ProductEpetraMultiVector::reset	(	const Teuchos::RCP< const Epetra_BlockMap > &	block_map,
		const Teuchos::RCP< const Epetra_BlockMap > &	coeff_map,
		const Teuchos::RCP< const EpetraExt::MultiComm > &	product_comm,
		int	num_vectors
	)

Reset to a new size.

This resizes array to fit new size.

Definition at line 211 of file Stokhos_ProductEpetraMultiVector.cpp.

void Stokhos::ProductEpetraMultiVector::reset	(	const Teuchos::RCP< const Epetra_BlockMap > &	block_map,
		const Teuchos::RCP< const Epetra_BlockMap > &	coeff_map,
		const Teuchos::RCP< const Epetra_BlockMap > &	product_map,
		const Teuchos::RCP< const EpetraExt::MultiComm > &	product_comm,
		int	num_vectors
	)

Reset to a new size.

This resizes array to fit new size.

Definition at line 231 of file Stokhos_ProductEpetraMultiVector.cpp.

void Stokhos::ProductEpetraMultiVector::resetCoefficients	(	Epetra_DataAccess	CV,
		const Epetra_MultiVector &	block_vector
	)

Reset vector cofficients.

Definition at line 249 of file Stokhos_ProductEpetraMultiVector.cpp.

Teuchos::RCP< EpetraExt::BlockMultiVector > Stokhos::ProductEpetraMultiVector::getBlockMultiVector ( )

Get block vector.

Definition at line 260 of file Stokhos_ProductEpetraMultiVector.cpp.

Teuchos::RCP< const EpetraExt::BlockMultiVector > Stokhos::ProductEpetraMultiVector::getBlockMultiVector ( ) const

Get block vector.

Definition at line 267 of file Stokhos_ProductEpetraMultiVector.cpp.

void Stokhos::ProductEpetraMultiVector::setBlockMultiVector ( const Teuchos::RCP< EpetraExt::BlockMultiVector > & block_vec )

Set block vector.

Definition at line 274 of file Stokhos_ProductEpetraMultiVector.cpp.

Member Data Documentation

Teuchos::RCP<const Epetra_BlockMap> Stokhos::ProductEpetraMultiVector::coeff_map

protected

Product map of block vector.

Definition at line 190 of file Stokhos_ProductEpetraMultiVector.hpp.

Teuchos::RCP<const EpetraExt::MultiComm> Stokhos::ProductEpetraMultiVector::product_comm

protected

Product multi-level communicator.

Definition at line 193 of file Stokhos_ProductEpetraMultiVector.hpp.

Teuchos::RCP<const Epetra_BlockMap> Stokhos::ProductEpetraMultiVector::product_map

protected

Product map of block vector.

Definition at line 196 of file Stokhos_ProductEpetraMultiVector.hpp.

Teuchos::RCP<EpetraExt::BlockMultiVector> Stokhos::ProductEpetraMultiVector::bv

protected

Block vector storing coefficients.

Definition at line 199 of file Stokhos_ProductEpetraMultiVector.hpp.

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation