Thyra Version of the Day
Public Member Functions | Related Functions
Thyra::DefaultSpmdVectorSpaceFactory< Scalar > Class Template Reference

Concrete implementation of a vector-space factory for a locally-replicated distributed DefaultSpmdVectorSpace objects. More...

#include <Thyra_DefaultSpmdVectorSpaceFactory_decl.hpp>

Inheritance diagram for Thyra::DefaultSpmdVectorSpaceFactory< Scalar >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Teuchos::RCP< const
Teuchos::Comm< Ordinal > > 
getComm () const
 Return the Spmd communicator.
 DefaultSpmdVectorSpaceFactory (const Teuchos::RCP< const Teuchos::Comm< Ordinal > > &comm=Teuchos::null)
 Depreciated .

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP
< DefaultSpmdVectorSpaceFactory
< Scalar > > 
defaultSpmdVectorSpaceFactory (const Teuchos::RCP< const Teuchos::Comm< Ordinal > > &comm=Teuchos::null)
 Construct with a Teuchos::Comm object.

Overridden from VectorSpaceFactoryBase

Teuchos::RCP< const
VectorSpaceBase< Scalar > > 
createVecSpc (int dim) const
 Create a new locally-replicated DefaultSpmdVectorSpace object given its dimension!

Detailed Description

template<class Scalar>
class Thyra::DefaultSpmdVectorSpaceFactory< Scalar >

Concrete implementation of a vector-space factory for a locally-replicated distributed DefaultSpmdVectorSpace objects.

This will create either serial independent (comm.get()==NULL) or locally replicated (comm.get()!=NULL) vector space objects (see createVecSpc()). The primary motivation for this subclass is to create locally replicated vector spaces for the domain space of DefaultSpmdMultiVector. In addition, an object of this type is also returned from SpmdVectorSpaceDefaultBase::smallVecSpcFtcy().

Note that the default constructor is not allowed to avoid mistakes in using this class.

Definition at line 67 of file Thyra_DefaultSpmdVectorSpaceFactory_decl.hpp.


Constructor & Destructor Documentation

template<class Scalar >
Thyra::DefaultSpmdVectorSpaceFactory< Scalar >::DefaultSpmdVectorSpaceFactory ( const Teuchos::RCP< const Teuchos::Comm< Ordinal > > &  comm = Teuchos::null)

Depreciated .

Definition at line 52 of file Thyra_DefaultSpmdVectorSpaceFactory_def.hpp.


Member Function Documentation

template<class Scalar >
Teuchos::RCP< const Teuchos::Comm< Ordinal > > Thyra::DefaultSpmdVectorSpaceFactory< Scalar >::getComm ( ) const [inline]

Return the Spmd communicator.

Definition at line 139 of file Thyra_DefaultSpmdVectorSpaceFactory_decl.hpp.

template<class Scalar >
Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultSpmdVectorSpaceFactory< Scalar >::createVecSpc ( int  dim) const [virtual]

Create a new locally-replicated DefaultSpmdVectorSpace object given its dimension!

Parameters:
dim[in] The dimension of the (locally replicated) vector space to create.

This function returns:

   return defaultSpmdVectorSpace(this->getComm(), dim, dim)</tt>

and therefore return->dim()==dim and this implementation fully satisfies the specification of VectorSpaceFactoryBase::createVecSpc().

Implements Thyra::VectorSpaceFactoryBase< Scalar >.

Definition at line 60 of file Thyra_DefaultSpmdVectorSpaceFactory_def.hpp.


Friends And Related Function Documentation

template<class Scalar >
RCP< DefaultSpmdVectorSpaceFactory< Scalar > > defaultSpmdVectorSpaceFactory ( const Teuchos::RCP< const Teuchos::Comm< Ordinal > > &  comm = Teuchos::null) [related]

Construct with a Teuchos::Comm object.

Parameters:
comm[in] The communicator. This object must be maintained by the client the entire time that this is in use. It is allowed for comm.get()==NULL.

Postconditions:

Definition at line 124 of file Thyra_DefaultSpmdVectorSpaceFactory_decl.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines