Stokhos  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Stokhos::ProductEpetraOperator Class Reference

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

#include <Stokhos_ProductEpetraOperator.hpp>

Inheritance diagram for Stokhos::ProductEpetraOperator:
Inheritance graph
[legend]
Collaboration diagram for Stokhos::ProductEpetraOperator:
Collaboration graph
[legend]

Public Types

typedef double value_type
 Typename of values.
 
typedef int ordinal_type
 Typename of ordinals.
 
- Public Types inherited from Stokhos::ProductContainer< Epetra_Operator >
typedef
Stokhos::ProductContainerTraits
< Epetra_Operator > 
traits_type
 Typename of traits.
 
typedef traits_type::value_type value_type
 Typename of values.
 
typedef traits_type::ordinal_type ordinal_type
 Typename of ordinals.
 

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.
 
 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.
 
 ProductEpetraOperator (const ProductEpetraOperator &v)
 Copy constructor. More...
 
virtual ~ProductEpetraOperator ()
 Destructor.
 
ProductEpetraOperatoroperator= (const ProductEpetraOperator &v)
 Assignment. More...
 
Teuchos::RCP< const
EpetraExt::MultiComm > 
productComm () const
 Get product comm.
 
Epetra_Operator methods
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.
 
- 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.
 
 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.
 
 ProductContainer (const ProductContainer &)
 Copy constructor. More...
 
virtual ~ProductContainer ()
 Destructor.
 
ProductContaineroperator= (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.
 
Teuchos::RCP< const
Epetra_BlockMap > 
map () const
 Return container map.
 
const Teuchos::Array
< Teuchos::RCP
< Epetra_Operator > > & 
getCoefficients () const
 Return array of coefficients.
 
Teuchos::Array< Teuchos::RCP
< Epetra_Operator > > & 
getCoefficients ()
 Return array of coefficients.
 
Teuchos::RCP< Epetra_Operator > getCoeffPtr (ordinal_type i)
 Return ref-count pointer to coefficient i.
 
Teuchos::RCP< const
Epetra_Operator > 
getCoeffPtr (ordinal_type i) const
 Return ref-count pointer to constant coefficient i.
 
void setCoeffPtr (ordinal_type i, const Teuchos::RCP< Epetra_Operator > &c)
 Set coefficient i to c.
 
Epetra_Operator & operator[] (ordinal_type i)
 Array access.
 
const Epetra_Operator & operator[] (ordinal_type i) const
 Array access.
 
void init (const value_type &val)
 Initialize coefficients.
 
bool myGID (int i) const
 Return whether global index i resides on this processor.
 
std::ostream & print (std::ostream &os) const
 Print polynomial.
 

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.
 
void setup (const Teuchos::RCP< const Epetra_Map > &domain_base_map, const Teuchos::RCP< const Epetra_Map > &range_base_map)
 Second stage of setup.
 

Protected Attributes

Teuchos::RCP< const Epetra_Map > domain_base_map
 Domain map of each coefficient.
 
Teuchos::RCP< const Epetra_Map > range_base_map
 Range map of each coefficient.
 
Teuchos::RCP< const Epetra_Map > product_range_map
 Product range map.
 
Teuchos::RCP< const
EpetraExt::MultiComm > 
product_comm
 Product multi-level communicator.
 
bool useTranspose
 Whether to use transpose in Apply()
 
- Protected Attributes inherited from Stokhos::ProductContainer< Epetra_Operator >
Teuchos::RCP< const
Epetra_BlockMap > 
map_
 Container map.
 
Teuchos::Array< Teuchos::RCP
< Epetra_Operator > > 
coeff_
 Array of polynomial coefficients.
 

Detailed Description

A container class for products of Epetra_Vector's.

Constructor & Destructor Documentation

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

Copy constructor.

NOTE: This is a shallow copy

Member Function Documentation

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

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