Thyra::DefaultProductMultiVector< Scalar > Class Template Reference
[Development of linear Abstract Numerical Algorithms (ANAs)]

Concrete implementation of a product multi-vector. More...

#include <Thyra_DefaultProductMultiVector_decl.hpp>

Inheritance diagram for Thyra::DefaultProductMultiVector< Scalar >:


Constructors/initializers/accessors
	DefaultProductMultiVector ()
	Construct to uninitialized.
void	initialize (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const int numMembers)

void	initialize (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< MultiVectorBase< Scalar > > > &multiVecs)

void	initialize (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< const MultiVectorBase< Scalar > > > &multiVecs)

void	uninitialize ()
	Uninitialize.
Overridden public functions from Teuchos::Describable
std::string	description () const

void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const

Overridden public functions from ProductMultiVectorBase
RCP< const ProductVectorSpaceBase< Scalar > >	productSpace () const

bool	blockIsConst (const int k) const

RCP< MultiVectorBase< Scalar > >	getNonconstMultiVectorBlock (const int k)

RCP< const MultiVectorBase< Scalar > >	getMultiVectorBlock (const int k) const

Overriden public functions from MultiVectorBase
RCP< MultiVectorBase< Scalar > >	clone_mv () const

Overriden from LinearOpBase
RCP< const VectorSpaceBase< Scalar > >	range () const

RCP< const VectorSpaceBase< Scalar > >	domain () const

Deprecated.
	DefaultProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace_in, const int numMembers)
	Deprecated.
	DefaultProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace_in, const ArrayView< const RCP< MultiVectorBase< Scalar > > > &multiVecs)
	Deprecated.
	DefaultProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace_in, const ArrayView< const RCP< const MultiVectorBase< Scalar > > > &multiVecs)
	Deprecated.
Overriden protected functions from MultiVectorBase
RCP< const VectorBase< Scalar > >	colImpl (Index j) const

RCP< VectorBase< Scalar > >	nonconstColImpl (Index j)

RCP< const MultiVectorBase< Scalar > >	contigSubViewImpl (const Range1D &colRng) const

RCP< MultiVectorBase< Scalar > >	nonconstContigSubViewImpl (const Range1D &colRng)

RCP< const MultiVectorBase< Scalar > >	nonContigSubViewImpl (const ArrayView< const int > &cols) const

RCP< MultiVectorBase< Scalar > >	nonconstNonContigSubViewImpl (const ArrayView< const int > &cols)

void	mvMultiReductApplyOpImpl (const RTOpPack::RTOpT< Scalar > &primary_op, const ArrayView< const Ptr< const MultiVectorBase< Scalar > > > &multi_vecs, const ArrayView< const Ptr< MultiVectorBase< Scalar > > > &targ_multi_vecs, const ArrayView< const Ptr< RTOpPack::ReductTarget > > &reduct_objs, const Index primary_first_ele_offset, const Index primary_sub_dim, const Index primary_global_offset, const Index secondary_first_ele_offset, const Index secondary_sub_dim) const

void	acquireDetachedMultiVectorViewImpl (const Range1D &rowRng, const Range1D &colRng, RTOpPack::ConstSubMultiVectorView< Scalar > *sub_mv) const

void	releaseDetachedMultiVectorViewImpl (RTOpPack::ConstSubMultiVectorView< Scalar > *sub_mv) const

void	acquireNonconstDetachedMultiVectorViewImpl (const Range1D &rowRng, const Range1D &colRng, RTOpPack::SubMultiVectorView< Scalar > *sub_mv)

void	commitNonconstDetachedMultiVectorViewImpl (RTOpPack::SubMultiVectorView< Scalar > *sub_mv)

Overridden from SingleScalarLinearOpBase
bool	opSupported (EOpTransp M_trans) const

void	apply (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, MultiVectorBase< Scalar > *Y, const Scalar alpha, const Scalar beta) const

Related Functions
(Note that these are not member functions.)
RCP< DefaultProductMultiVector< Scalar > >	defaultProductMultiVector ()
	Nonmember constructor.
RCP< DefaultProductMultiVector< Scalar > >	defaultProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const int numMembers)
	Nonmember constructor.
RCP< DefaultProductMultiVector< Scalar > >	defaultProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< MultiVectorBase< Scalar > > > &multiVecs)
	Nonmember constructor.
RCP< DefaultProductMultiVector< Scalar > >	defaultProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< const MultiVectorBase< Scalar > > > &multiVecs)
	Nonmember constructor.
RCP< const ProductMultiVectorBase< Scalar > >	castOrCreateSingleBlockProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const RCP< const MultiVectorBase< Scalar > > &mv)
	Dynamic cast to a const product multi-vector or create a new product multi-vector with one component if the input multi-vector is not a product vector.
RCP< ProductMultiVectorBase< Scalar > >	nonconstCastOrCreateSingleBlockProductMultiVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const RCP< MultiVectorBase< Scalar > > &mv)
	Dynamic cast to a const product multi-vector or create a new product multi-vector with one component if the input multi-vector is not a product vector.

Detailed Description

template<class Scalar>
class Thyra::DefaultProductMultiVector< Scalar >

Concrete implementation of a product multi-vector.

Note that clients should almost never be creating objects of this type explicitly and should instead use DefaultProductVectorSpace as a factory.

ToDo: Finish documentation!

The default constructor is made private to avoid accidental default construction.

Definition at line 59 of file Thyra_DefaultProductMultiVector_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar>

Thyra::DefaultProductMultiVector< Scalar >::DefaultProductMultiVector ( )

Construct to uninitialized.

Definition at line 45 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

Thyra::DefaultProductMultiVector< Scalar >::DefaultProductMultiVector	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace_in,
		const int	numMembers
	)			`[inline]`

Deprecated.

Definition at line 231 of file Thyra_DefaultProductMultiVector_decl.hpp.

template<class Scalar>

Thyra::DefaultProductMultiVector< Scalar >::DefaultProductMultiVector	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace_in,
		const ArrayView< const RCP< MultiVectorBase< Scalar > > > &	multiVecs
	)			`[inline]`

Deprecated.

Definition at line 239 of file Thyra_DefaultProductMultiVector_decl.hpp.

template<class Scalar>

Thyra::DefaultProductMultiVector< Scalar >::DefaultProductMultiVector	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace_in,
		const ArrayView< const RCP< const MultiVectorBase< Scalar > > > &	multiVecs
	)			`[inline]`

Deprecated.

Definition at line 247 of file Thyra_DefaultProductMultiVector_decl.hpp.

Member Function Documentation

template<class Scalar>

void Thyra::DefaultProductMultiVector< Scalar >::initialize	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace,
		const int	numMembers
	)

Definition at line 51 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductMultiVector< Scalar >::initialize	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace,
		const ArrayView< const RCP< MultiVectorBase< Scalar > > > &	multiVecs
	)

Definition at line 69 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductMultiVector< Scalar >::initialize	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace,
		const ArrayView< const RCP< const MultiVectorBase< Scalar > > > &	multiVecs
	)

Definition at line 79 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

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

Uninitialize.

ToDo: Finish documentation.

Definition at line 89 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

std::string Thyra::DefaultProductMultiVector< Scalar >::description ( ) const [virtual]

Reimplemented from Thyra::LinearOpDefaultBase< Scalar >.

Definition at line 101 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductMultiVector< Scalar >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel
	)			const `[virtual]`

Reimplemented from Thyra::LinearOpDefaultBase< Scalar >.

Definition at line 116 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< const ProductVectorSpaceBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::productSpace ( ) const [virtual]

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 166 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

bool Thyra::DefaultProductMultiVector< Scalar >::blockIsConst ( const int k ) const [virtual]

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 173 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< MultiVectorBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::getNonconstMultiVectorBlock ( const int k ) [virtual]

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 181 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< const MultiVectorBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::getMultiVectorBlock ( const int k ) const [virtual]

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 189 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< MultiVectorBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::clone_mv ( ) const [virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 200 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::range ( ) const [virtual]

Implements Thyra::LinearOpBase< RangeScalar, DomainScalar >.

Definition at line 215 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::domain ( ) const [virtual]

Implements Thyra::LinearOpBase< RangeScalar, DomainScalar >.

Definition at line 223 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< const VectorBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::colImpl ( Index j ) const [protected, virtual]

Reimplemented from Thyra::MultiVectorBase< Scalar >.

Definition at line 239 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< VectorBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::nonconstColImpl ( Index j ) [protected, virtual]

Implements Thyra::MultiVectorBase< Scalar >.

Definition at line 251 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< const MultiVectorBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::contigSubViewImpl ( const Range1D & colRng ) const [protected, virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 263 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< MultiVectorBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::nonconstContigSubViewImpl ( const Range1D & colRng ) [protected, virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 275 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< const MultiVectorBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::nonContigSubViewImpl ( const ArrayView< const int > & cols ) const [protected, virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 287 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< MultiVectorBase< Scalar > > Thyra::DefaultProductMultiVector< Scalar >::nonconstNonContigSubViewImpl ( const ArrayView< const int > & cols ) [protected, virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 301 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductMultiVector< Scalar >::mvMultiReductApplyOpImpl	(	const RTOpPack::RTOpT< Scalar > &	primary_op,
		const ArrayView< const Ptr< const MultiVectorBase< Scalar > > > &	multi_vecs,
		const ArrayView< const Ptr< MultiVectorBase< Scalar > > > &	targ_multi_vecs,
		const ArrayView< const Ptr< RTOpPack::ReductTarget > > &	reduct_objs,
		const Index	primary_first_ele_offset,
		const Index	primary_sub_dim,
		const Index	primary_global_offset,
		const Index	secondary_first_ele_offset,
		const Index	secondary_sub_dim
	)			const `[protected, virtual]`

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 314 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductMultiVector< Scalar >::acquireDetachedMultiVectorViewImpl	(	const Range1D &	rowRng,
		const Range1D &	colRng,
		RTOpPack::ConstSubMultiVectorView< Scalar > *	sub_mv
	)			const `[protected, virtual]`

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 529 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductMultiVector< Scalar >::releaseDetachedMultiVectorViewImpl ( RTOpPack::ConstSubMultiVectorView< Scalar > * sub_mv ) const [protected, virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 542 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductMultiVector< Scalar >::acquireNonconstDetachedMultiVectorViewImpl	(	const Range1D &	rowRng,
		const Range1D &	colRng,
		RTOpPack::SubMultiVectorView< Scalar > *	sub_mv
	)			`[protected, virtual]`

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 553 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductMultiVector< Scalar >::commitNonconstDetachedMultiVectorViewImpl ( RTOpPack::SubMultiVectorView< Scalar > * sub_mv ) [protected, virtual]

Reimplemented from Thyra::MultiVectorDefaultBase< Scalar >.

Definition at line 566 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

bool Thyra::DefaultProductMultiVector< Scalar >::opSupported ( EOpTransp M_trans ) const [protected, virtual]

Implements Thyra::SingleScalarLinearOpBase< Scalar >.

Definition at line 579 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductMultiVector< Scalar >::apply	(	const EOpTransp	M_trans,
		const MultiVectorBase< Scalar > &	X,
		MultiVectorBase< Scalar > *	Y,
		const Scalar	alpha,
		const Scalar	beta
	)			const `[protected, virtual]`

Implements Thyra::SingleScalarLinearOpBase< Scalar >.

Definition at line 586 of file Thyra_DefaultProductMultiVector_def.hpp.

Friends And Related Function Documentation

template<class Scalar>

RCP< DefaultProductMultiVector< Scalar > > defaultProductMultiVector ( ) [related]

Nonmember constructor.

Definition at line 715 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< DefaultProductMultiVector< Scalar > > defaultProductMultiVector	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace,
		const int	numMembers
	)			`[related]`

Nonmember constructor.

Definition at line 723 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< DefaultProductMultiVector< Scalar > > defaultProductMultiVector	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace,
		const ArrayView< const RCP< MultiVectorBase< Scalar > > > &	multiVecs
	)			`[related]`

Nonmember constructor.

Definition at line 736 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< DefaultProductMultiVector< Scalar > > defaultProductMultiVector	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace,
		const ArrayView< const RCP< const MultiVectorBase< Scalar > > > &	multiVecs
	)			`[related]`

Nonmember constructor.

Definition at line 750 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< const ProductMultiVectorBase< Scalar > > castOrCreateSingleBlockProductMultiVector	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace,
		const RCP< const MultiVectorBase< Scalar > > &	mv
	)			`[related]`

Dynamic cast to a const product multi-vector or create a new product multi-vector with one component if the input multi-vector is not a product vector.

Definition at line 764 of file Thyra_DefaultProductMultiVector_def.hpp.

template<class Scalar>

RCP< ProductMultiVectorBase< Scalar > > nonconstCastOrCreateSingleBlockProductMultiVector	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace,
		const RCP< MultiVectorBase< Scalar > > &	mv
	)			`[related]`

Dynamic cast to a const product multi-vector or create a new product multi-vector with one component if the input multi-vector is not a product vector.

Definition at line 779 of file Thyra_DefaultProductMultiVector_def.hpp.

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

Generated on Wed May 12 21:26:59 2010 for Thyra Operator/Vector Support by

1.4.7

Thyra::DefaultProductMultiVector< Scalar > Class Template Reference [Development of linear Abstract Numerical Algorithms (ANAs)]

Constructors/initializers/accessors

Overridden public functions from Teuchos::Describable

Overridden public functions from ProductMultiVectorBase

Overriden public functions from MultiVectorBase

Overriden from LinearOpBase

Deprecated.

Overriden protected functions from MultiVectorBase

Overridden from SingleScalarLinearOpBase

Related Functions

Detailed Description

template<class Scalar> class Thyra::DefaultProductMultiVector< Scalar >

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Thyra::DefaultProductMultiVector< Scalar > Class Template Reference
[Development of linear Abstract Numerical Algorithms (ANAs)]

template<class Scalar>
class Thyra::DefaultProductMultiVector< Scalar >