Concrete implementation of an SPMD vector space subclass which creates DefaultSpmdVector and DefaultSpmdMultiVector objects. More...

#include <Thyra_DefaultSpmdVectorSpace_decl.hpp>

Inheritance diagram for Thyra::DefaultSpmdVectorSpace< Scalar >:

[legend]

List of all members.

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP< DefaultSpmdVectorSpace < Scalar > >	defaultSpmdVectorSpace ()
	Nonmember consturctor that creats an uninitialized vector space.
template<class Scalar >
RCP< DefaultSpmdVectorSpace < Scalar > >	defaultSpmdVectorSpace (const Ordinal dim)
	Nonmember consturctor that creats a serial vector space.
template<class Scalar >
RCP< DefaultSpmdVectorSpace < Scalar > >	defaultSpmdVectorSpace (const RCP< const Teuchos::Comm< Ordinal > > &comm, const Ordinal localSubDim, const Ordinal globalDim)
	Nonmember consturctor function that creates a distributed or locally-replicated parallel vector space.
Constructors and initializers
static RCP < DefaultSpmdVectorSpace < Scalar > >	create ()
	Create with weak ownership to self.
void	initialize (const Ordinal dim)
	Initialize a serial space.
void	initialize (const RCP< const Teuchos::Comm< Ordinal > > &comm, const Ordinal localSubDim, const Ordinal globalDim)
	Initialize an SPMD space.
void	uninitialize ()
	Set to an uninitialized state.
Public overridden from VectorSpaceBase
bool	hasInCoreView (const Range1D &rng, const EViewType viewType, const EStrideType strideType) const
	Returns true if all the elements in `rng` are in this process.
RCP< const VectorSpaceBase < Scalar > >	clone () const

Protected overridden from VectorSpaceBase
RCP< VectorBase< Scalar > >	createMember () const

RCP< MultiVectorBase< Scalar > >	createMembers (int numMembers) const

RCP< VectorBase< Scalar > >	createMemberView (const RTOpPack::SubVectorView< Scalar > &raw_v) const

RCP< const VectorBase< Scalar > >	createMemberView (const RTOpPack::ConstSubVectorView< Scalar > &raw_v) const

RCP< MultiVectorBase< Scalar > >	createMembersView (const RTOpPack::SubMultiVectorView< Scalar > &raw_mv) const

RCP< const MultiVectorBase < Scalar > >	createMembersView (const RTOpPack::ConstSubMultiVectorView< Scalar > &raw_mv) const

Public overridden from SpmdVectorSpaceDefaultBase
RCP< const Teuchos::Comm < Ordinal > >	getComm () const

Ordinal	localSubDim () const

Deprecated
THYRA_DEPRECATED	DefaultSpmdVectorSpace (const Ordinal dim)
	Deprecated.
THYRA_DEPRECATED	DefaultSpmdVectorSpace (const RCP< const Teuchos::Comm< Ordinal > > &comm, const Ordinal localSubDim, const Ordinal globalDim)
	Deprecated.

Detailed Description

template<class Scalar>
class Thyra::DefaultSpmdVectorSpace< Scalar >

Concrete implementation of an SPMD vector space subclass which creates DefaultSpmdVector and DefaultSpmdMultiVector objects.

This is a simple but yet fully general and functional concrete subclass of SpmdVectorSpaceBase that returns DefaultSpmdMultiVector objects from createMembers() and DefaultSpmdVector objects from createMember().

See the function initialize() that describes the different kinds of distributions this class can handle.

Definition at line 69 of file Thyra_DefaultSpmdVectorSpace_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Thyra::DefaultSpmdVectorSpace< Scalar >::DefaultSpmdVectorSpace ( const Ordinal dim )

Deprecated.

Definition at line 275 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

Thyra::DefaultSpmdVectorSpace< Scalar >::DefaultSpmdVectorSpace	(	const RCP< const Teuchos::Comm< Ordinal > > &	comm,
		const Ordinal	localSubDim,
		const Ordinal	globalDim
	)

Deprecated.

Definition at line 285 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

Member Function Documentation

template<class Scalar >

RCP< DefaultSpmdVectorSpace< Scalar > > Thyra::DefaultSpmdVectorSpace< Scalar >::create ( ) [static]

Create with weak ownership to self.

Definition at line 58 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

void Thyra::DefaultSpmdVectorSpace< Scalar >::initialize ( const Ordinal dim )

Initialize a serial space.

Parameters:

dim	[in] Gives the dimension of the vector space.

Equivalent to calling this->initialize(Teuchos::null,dim,dim)

Definition at line 67 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

void Thyra::DefaultSpmdVectorSpace< Scalar >::initialize	(	const RCP< const Teuchos::Comm< Ordinal > > &	comm,
		const Ordinal	localSubDim,
		const Ordinal	globalDim
	)

Initialize an SPMD space.

Parameters:

comm	[in] The communicator. This object must be maintained by the client the entire time that `this` is in use.
localSubDim	[in] The number of elements in the local process. This number can be different in every process.
globalDim	[in] Gives the number of global elements in the vector if `globalDim > 0`. If `globalDim < 0` then the global dimension is determined by the above argument `localSubDim` but requires a global communication to do so (i.e. `Spmd_Allreduce()`).

Preconditions:

localSubDim > 0
globalDim != 0
[comm.get() != NULL && globalDim > 0] globalDim >= localSubDim

Postconditions:




this->getComm().get() == comm.get() 

this->localSubDim() == localSubDim 

[comm.get() == NULL] this->dim() == localSubDim 

[comm.get() != NULL && globalDim > 0] this->dim() == globalDim 

[comm.get() != NULL && globalDim < 0] this->dim() == sum(localSubDim[i],i=0...numProc-1)

This function supports three different types of use-cases:




comm.get()==NULL : Serial (i.e. single process) vectors where this->dim() == localSubDim.



comm.get()!=NULL && globalDim < 0 : Distributed-memory vectors where this->dim() is equal to the sum of the localSubDim arguments in each process. This will result in a call to Spmd_Allreduce() inside of this function.



comm.get()!=NULL && globalDim > 0 : Distributed-memory vectors where this->dim() returns globalDim. This will not result in a call to Teuchos::reduceAll() inside this function and therefore the client had better be sure that globalDim is consistent with localSubDim in each process.



comm.get()!=NULL && globalDim == localSubDim : Locally-replicated distributed-memory vectors where this->dim() == globalDim == localSubDim.

Definition at line 76 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

void Thyra::DefaultSpmdVectorSpace< Scalar >::uninitialize ( )

Set to an uninitialized state.

Postconditions:

this->getComm().get() == NULL
this->localSubDim() == 0
this->dim() == 0

Definition at line 99 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

bool Thyra::DefaultSpmdVectorSpace< Scalar >::hasInCoreView	(	const Range1D &	rng,
		const EViewType	viewType,
		const EStrideType	strideType
	)		const `[virtual]`

Returns true if all the elements in rng are in this process.

Reimplemented from Thyra::VectorSpaceBase< Scalar >.

Definition at line 224 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultSpmdVectorSpace< Scalar >::clone ( ) const [virtual]

Reimplemented from Thyra::VectorSpaceBase< Scalar >.

Definition at line 236 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

RCP< VectorBase< Scalar > > Thyra::DefaultSpmdVectorSpace< Scalar >::createMember ( ) const [protected, virtual]

Implements Thyra::VectorSpaceBase< Scalar >.

Definition at line 111 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

RCP< MultiVectorBase< Scalar > > Thyra::DefaultSpmdVectorSpace< Scalar >::createMembers ( int numMembers ) const [protected, virtual]

Implements Thyra::VectorSpaceBase< Scalar >.

Definition at line 128 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

RCP< VectorBase< Scalar > > Thyra::DefaultSpmdVectorSpace< Scalar >::createMemberView ( const RTOpPack::SubVectorView< Scalar > & raw_v ) const [protected, virtual]

Implements Thyra::VectorSpaceBase< Scalar >.

Definition at line 143 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

RCP< const VectorBase< Scalar > > Thyra::DefaultSpmdVectorSpace< Scalar >::createMemberView ( const RTOpPack::ConstSubVectorView< Scalar > & raw_v ) const [protected, virtual]

Implements Thyra::VectorSpaceBase< Scalar >.

Definition at line 162 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

RCP< MultiVectorBase< Scalar > > Thyra::DefaultSpmdVectorSpace< Scalar >::createMembersView ( const RTOpPack::SubMultiVectorView< Scalar > & raw_mv ) const [protected, virtual]

Implements Thyra::VectorSpaceBase< Scalar >.

Definition at line 181 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

RCP< const MultiVectorBase< Scalar > > Thyra::DefaultSpmdVectorSpace< Scalar >::createMembersView ( const RTOpPack::ConstSubMultiVectorView< Scalar > & raw_mv ) const [protected, virtual]

Implements Thyra::VectorSpaceBase< Scalar >.

Definition at line 202 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

RCP< const Teuchos::Comm< Ordinal > > Thyra::DefaultSpmdVectorSpace< Scalar >::getComm ( ) const [virtual]

Implements Thyra::SpmdVectorSpaceBase< Scalar >.

Definition at line 247 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

template<class Scalar >

Ordinal Thyra::DefaultSpmdVectorSpace< Scalar >::localSubDim ( ) const [virtual]

Implements Thyra::SpmdVectorSpaceBase< Scalar >.

Definition at line 254 of file Thyra_DefaultSpmdVectorSpace_def.hpp.

Friends And Related Function Documentation

template<class Scalar >

RCP< DefaultSpmdVectorSpace< Scalar > > defaultSpmdVectorSpace ( ) [related]

Nonmember consturctor that creats an uninitialized vector space.

Definition at line 255 of file Thyra_DefaultSpmdVectorSpace_decl.hpp.

template<class Scalar >

RCP< DefaultSpmdVectorSpace< Scalar > > defaultSpmdVectorSpace ( const Ordinal dim ) [related]

Nonmember consturctor that creats a serial vector space.

Definition at line 267 of file Thyra_DefaultSpmdVectorSpace_decl.hpp.

template<class Scalar >

RCP< DefaultSpmdVectorSpace< Scalar > > defaultSpmdVectorSpace	(	const RCP< const Teuchos::Comm< Ordinal > > &	comm,
		const Ordinal	localSubDim,
		const Ordinal	globalDim
	)		`[related]`

Nonmember consturctor function that creates a distributed or locally-replicated parallel vector space.

Definition at line 283 of file Thyra_DefaultSpmdVectorSpace_decl.hpp.

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

Related Functions

Constructors and initializers

Public overridden from VectorSpaceBase

Protected overridden from VectorSpaceBase

Public overridden from SpmdVectorSpaceDefaultBase

Deprecated

Detailed Description

template<class Scalar> class Thyra::DefaultSpmdVectorSpace< Scalar >

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<class Scalar>
class Thyra::DefaultSpmdVectorSpace< Scalar >