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

Concrete implementation of a product vector. More...

#include <Thyra_DefaultProductVector_decl.hpp>

Inheritance diagram for Thyra::DefaultProductVector< Scalar >:

[legend]List of all members.

Constructors/initializers/accessors
	DefaultProductVector ()
	Construct to uninitialized.
	DefaultProductVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace)
	Constructs to initialized (calls initialize()).
void	initialize (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace)
	Initialize.
void	initialize (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< VectorBase< Scalar > > > &vecs)
	Initialize.
void	initialize (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< const VectorBase< Scalar > > > &vecs)
	Initialize.
void	uninitialize ()
	Uninitialize.
Overridden from Teuchos::Describable
std::string	description () const
void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
Extensions to ProductVectorBase suitable for physically-blocked vectors
void	setBlock (int i, const RCP< const VectorBase< Scalar > > &b)
void	setNonconstBlock (int i, const RCP< VectorBase< Scalar > > &b)
Overridden from ProductVectorBase
RCP< VectorBase< Scalar > >	getNonconstVectorBlock (const int k)
RCP< const VectorBase< Scalar > >	getVectorBlock (const int k) 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
Overridden public functions from VectorBase
RCP< const VectorSpaceBase< Scalar > >	space () const
Deprecated
	DefaultProductVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace_in, const RCP< VectorBase< Scalar > > vecs[])
	Deprecated.
void	initialize (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace_in, const RCP< VectorBase< Scalar > > vecs[])
	Deprecated.
void	initialize (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace_in, const RCP< const VectorBase< Scalar > > vecs[])
	Deprecated.
Overridden protected functions from VectorBase
void	applyOpImpl (const RTOpPack::RTOpT< Scalar > &op, const ArrayView< const Ptr< const VectorBase< Scalar > > > &vecs, const ArrayView< const Ptr< VectorBase< Scalar > > > &targ_vecs, const Ptr< RTOpPack::ReductTarget > &reduct_obj, const Index first_ele_offset, const Index sub_dim, const Index global_offset) const
void	acquireDetachedVectorViewImpl (const Range1D &rng, RTOpPack::ConstSubVectorView< Scalar > *sub_vec) const
void	releaseDetachedVectorViewImpl (RTOpPack::ConstSubVectorView< Scalar > *sub_vec) const
void	acquireNonconstDetachedVectorViewImpl (const Range1D &rng, RTOpPack::SubVectorView< Scalar > *sub_vec)
void	commitNonconstDetachedVectorViewImpl (RTOpPack::SubVectorView< Scalar > *sub_vec)
void	setSubVectorImpl (const RTOpPack::SparseSubVectorT< Scalar > &sub_vec)
Related Functions
(Note that these are not member functions.)
RCP< DefaultProductVector< Scalar > >	defaultProductVector ()
	Nonmember constructor.
RCP< DefaultProductVector< Scalar > >	defaultProductVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace)
	Nonmember constructor.
RCP< DefaultProductVector< Scalar > >	defaultProductVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< VectorBase< Scalar > > > &vecs)
	Nonmember constructor.
RCP< DefaultProductVector< Scalar > >	defaultProductVector (const RCP< const DefaultProductVectorSpace< Scalar > > &productSpace, const ArrayView< const RCP< const VectorBase< Scalar > > > &vecs)
	Nonmember constructor.

---

Detailed Description

template<class Scalar>
class Thyra::DefaultProductVector< Scalar >

Concrete implementation of a product 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_DefaultProductVector_decl.hpp.

---

Constructor & Destructor Documentation

template<class Scalar>

Thyra::DefaultProductVector< Scalar >::DefaultProductVector

(

)

Construct to uninitialized.

Definition at line 45 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

Thyra::DefaultProductVector< Scalar >::DefaultProductVector

(

const RCP< const DefaultProductVectorSpace< Scalar > > &

productSpace

)

Constructs to initialized (calls initialize()).

Definition at line 53 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

Thyra::DefaultProductVector< Scalar >::DefaultProductVector	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace_in,
		const RCP< VectorBase< Scalar > >	vecs[]
	)			[inline]

Deprecated.

Definition at line 211 of file Thyra_DefaultProductVector_decl.hpp.

---

Member Function Documentation

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::initialize

(

const RCP< const DefaultProductVectorSpace< Scalar > > &

productSpace

)

Initialize.

ToDo: Finish documentation.

Definition at line 63 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::initialize	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace,
		const ArrayView< const RCP< VectorBase< Scalar > > > &	vecs
	)

Initialize.

ToDo: Finish documentation.

Definition at line 77 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::initialize	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace,
		const ArrayView< const RCP< const VectorBase< Scalar > > > &	vecs
	)

Initialize.

ToDo: Finish documentation.

Definition at line 96 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::uninitialize

(

)

Uninitialize.

ToDo: Finish documentation.

Definition at line 115 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

std::string Thyra::DefaultProductVector< Scalar >::description

(

)

const [virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 127 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

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

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 141 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::setBlock	(	int	i,
		const RCP< const VectorBase< Scalar > > &	b
	)

Definition at line 187 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::setNonconstBlock	(	int	i,
		const RCP< VectorBase< Scalar > > &	b
	)

Definition at line 200 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

RCP< VectorBase< Scalar > > Thyra::DefaultProductVector< Scalar >::getNonconstVectorBlock

(

const int

k

)

[virtual]

Implements Thyra::ProductVectorBase< Scalar >.

Definition at line 217 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

RCP< const VectorBase< Scalar > > Thyra::DefaultProductVector< Scalar >::getVectorBlock

(

const int

k

)

const [virtual]

Implements Thyra::ProductVectorBase< Scalar >.

Definition at line 228 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

RCP< const ProductVectorSpaceBase< Scalar > > Thyra::DefaultProductVector< Scalar >::productSpace

(

)

const [virtual]

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 242 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

bool Thyra::DefaultProductVector< Scalar >::blockIsConst

(

const int

k

)

const [virtual]

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 249 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

RCP< MultiVectorBase< Scalar > > Thyra::DefaultProductVector< Scalar >::getNonconstMultiVectorBlock

(

const int

k

)

[virtual]

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 260 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

RCP< const MultiVectorBase< Scalar > > Thyra::DefaultProductVector< Scalar >::getMultiVectorBlock

(

const int

k

)

const [virtual]

Implements Thyra::ProductMultiVectorBase< Scalar >.

Definition at line 268 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultProductVector< Scalar >::space

(

)

const [virtual]

Implements Thyra::VectorBase< Scalar >.

Definition at line 279 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::applyOpImpl	(	const RTOpPack::RTOpT< Scalar > &	op,
		const ArrayView< const Ptr< const VectorBase< Scalar > > > &	vecs,
		const ArrayView< const Ptr< VectorBase< Scalar > > > &	targ_vecs,
		const Ptr< RTOpPack::ReductTarget > &	reduct_obj,
		const Index	first_ele_offset,
		const Index	sub_dim,
		const Index	global_offset
	)			const [protected, virtual]

Implements Thyra::VectorBase< Scalar >.

Definition at line 286 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::acquireDetachedVectorViewImpl	(	const Range1D &	rng,
		RTOpPack::ConstSubVectorView< Scalar > *	sub_vec
	)			const [protected, virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 488 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::releaseDetachedVectorViewImpl

(

RTOpPack::ConstSubVectorView< Scalar > *

sub_vec

)

const [protected, virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 523 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::acquireNonconstDetachedVectorViewImpl	(	const Range1D &	rng,
		RTOpPack::SubVectorView< Scalar > *	sub_vec
	)			[protected, virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 551 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::commitNonconstDetachedVectorViewImpl

(

RTOpPack::SubVectorView< Scalar > *

sub_vec

)

[protected, virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 586 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::setSubVectorImpl

(

const RTOpPack::SparseSubVectorT< Scalar > &

sub_vec

)

[protected, virtual]

Reimplemented from Thyra::VectorDefaultBase< Scalar >.

Definition at line 614 of file Thyra_DefaultProductVector_def.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::initialize	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace_in,
		const RCP< VectorBase< Scalar > >	vecs[]
	)			[inline]

Deprecated.

Definition at line 219 of file Thyra_DefaultProductVector_decl.hpp.

template<class Scalar>

void Thyra::DefaultProductVector< Scalar >::initialize	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace_in,
		const RCP< const VectorBase< Scalar > >	vecs[]
	)			[inline]

Deprecated.

Definition at line 226 of file Thyra_DefaultProductVector_decl.hpp.

---

Friends And Related Function Documentation

template<class Scalar>

RCP< DefaultProductVector< Scalar > > defaultProductVector

(

)

[related]

Nonmember constructor.

Definition at line 259 of file Thyra_DefaultProductVector_decl.hpp.

template<class Scalar>

RCP< DefaultProductVector< Scalar > > defaultProductVector

(

const RCP< const DefaultProductVectorSpace< Scalar > > &

productSpace

)

[related]

Nonmember constructor.

Definition at line 272 of file Thyra_DefaultProductVector_decl.hpp.

template<class Scalar>

RCP< DefaultProductVector< Scalar > > defaultProductVector	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace,
		const ArrayView< const RCP< VectorBase< Scalar > > > &	vecs
	)			[related]

Nonmember constructor.

Definition at line 288 of file Thyra_DefaultProductVector_decl.hpp.

template<class Scalar>

RCP< DefaultProductVector< Scalar > > defaultProductVector	(	const RCP< const DefaultProductVectorSpace< Scalar > > &	productSpace,
		const ArrayView< const RCP< const VectorBase< Scalar > > > &	vecs
	)			[related]

Nonmember constructor.

Definition at line 305 of file Thyra_DefaultProductVector_decl.hpp.

---

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

• Thyra_DefaultProductVector_decl.hpp
• Thyra_DefaultProductVector_def.hpp

---