Thyra Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Related Symbols | List of all members
Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Concrete implementation of Thyra::MultiVector in terms of Tpetra::MultiVector. More...

#include <Thyra_TpetraMultiVector_decl.hpp>

Inherits SpmdMultiVectorDefaultBase< Scalar >.

Related Symbols

(Note that these are not member symbols.)

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > tpetraMultiVector (const RCP< const TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraVectorSpace, const RCP< const ScalarProdVectorSpaceBase< Scalar > > &domainSpace, const RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraMultiVector)
 Nonmember constructor for TpetraMultiVector.
 
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > constTpetraMultiVector (const RCP< const TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraVectorSpace, const RCP< const ScalarProdVectorSpaceBase< Scalar > > &domainSpace, const RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraMultiVector)
 Nonmember constructor for TpetraMultiVector.
 

Overridden protected functions from MultiVectorAdapterBase

RCP< const TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > tpetraVectorSpace_
 
RCP< const ScalarProdVectorSpaceBase< Scalar > > domainSpace_
 
Teuchos::ConstNonconstObjectContainer< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > tpetraMultiVector_
 
virtual void euclideanApply (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const
 
template<class TpetraMultiVector_t >
void initializeImpl (const RCP< const TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraVectorSpace, const RCP< const ScalarProdVectorSpaceBase< Scalar > > &domainSpace, const RCP< TpetraMultiVector_t > &tpetraMultiVector)
 
RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getTpetraMultiVector (const RCP< MultiVectorBase< Scalar > > &mv) const
 
RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getConstTpetraMultiVector (const RCP< const MultiVectorBase< Scalar > > &mv) const
 

Constructors/initializers/accessors

 TpetraMultiVector ()
 Construct to uninitialized.
 
void initialize (const RCP< const TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraVectorSpace, const RCP< const ScalarProdVectorSpaceBase< Scalar > > &domainSpace, const RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraMultiVector)
 Initialize.
 
void constInitialize (const RCP< const TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraVectorSpace, const RCP< const ScalarProdVectorSpaceBase< Scalar > > &domainSpace, const RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraMultiVector)
 Initialize.
 
RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getTpetraMultiVector ()
 Extract the underlying non-const Tpetra::MultiVector object.
 
RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getConstTpetraMultiVector () const
 Extract the underlying const Tpetra::MultiVector object.
 

Overridden public functions form MultiVectorAdapterBase

RCP< const ScalarProdVectorSpaceBase< Scalar > > domainScalarProdVecSpc () const
 

Overridden protected functions from MultiVectorBase

virtual void assignImpl (Scalar alpha)
 
virtual void assignMultiVecImpl (const MultiVectorBase< Scalar > &mv)
 
virtual void scaleImpl (Scalar alpha)
 
virtual void updateImpl (Scalar alpha, const MultiVectorBase< Scalar > &mv)
 
virtual void linearCombinationImpl (const ArrayView< const Scalar > &alpha, const ArrayView< const Ptr< const MultiVectorBase< Scalar > > > &mv, const Scalar &beta)
 
virtual void dotsImpl (const MultiVectorBase< Scalar > &mv, const ArrayView< Scalar > &prods) const
 
virtual void norms1Impl (const ArrayView< typename ScalarTraits< Scalar >::magnitudeType > &norms) const
 
virtual void norms2Impl (const ArrayView< typename ScalarTraits< Scalar >::magnitudeType > &norms) const
 
virtual void normsInfImpl (const ArrayView< typename ScalarTraits< Scalar >::magnitudeType > &norms) const
 
RCP< const VectorBase< Scalar > > colImpl (Ordinal j) const
 
RCP< VectorBase< Scalar > > nonconstColImpl (Ordinal 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_in) const
 
RCP< MultiVectorBase< Scalar > > nonconstNonContigSubViewImpl (const ArrayView< const int > &cols_in)
 
virtual 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 Ordinal primary_global_offset) const
 
void acquireDetachedMultiVectorViewImpl (const Range1D &rowRng, const Range1D &colRng, 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 protected functions from SpmdMultiVectorBase

RCP< const SpmdVectorSpaceBase< Scalar > > spmdSpaceImpl () const
 
void getNonconstLocalMultiVectorDataImpl (const Ptr< ArrayRCP< Scalar > > &localValues, const Ptr< Ordinal > &leadingDim)
 
void getLocalMultiVectorDataImpl (const Ptr< ArrayRCP< const Scalar > > &localValues, const Ptr< Ordinal > &leadingDim) const
 

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
class Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Concrete implementation of Thyra::MultiVector in terms of Tpetra::MultiVector.

Todo
Finish documentation!

Definition at line 62 of file Thyra_TpetraMultiVector_decl.hpp.

Constructor & Destructor Documentation

◆ TpetraMultiVector()

Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraMultiVector ( )

Construct to uninitialized.

Definition at line 58 of file Thyra_TpetraMultiVector_def.hpp.

Member Function Documentation

◆ initialize()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::initialize ( const RCP< const TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & tpetraVectorSpace,
const RCP< const ScalarProdVectorSpaceBase< Scalar > > & domainSpace,
const RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & tpetraMultiVector )

Initialize.

Definition at line 63 of file Thyra_TpetraMultiVector_def.hpp.

◆ constInitialize()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::constInitialize ( const RCP< const TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & tpetraVectorSpace,
const RCP< const ScalarProdVectorSpaceBase< Scalar > > & domainSpace,
const RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & tpetraMultiVector )

Initialize.

Definition at line 74 of file Thyra_TpetraMultiVector_def.hpp.

◆ getTpetraMultiVector() [1/2]

RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getTpetraMultiVector ( )

Extract the underlying non-const Tpetra::MultiVector object.

Definition at line 86 of file Thyra_TpetraMultiVector_def.hpp.

◆ getConstTpetraMultiVector() [1/2]

RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getConstTpetraMultiVector ( ) const

Extract the underlying const Tpetra::MultiVector object.

Definition at line 94 of file Thyra_TpetraMultiVector_def.hpp.

◆ domainScalarProdVecSpc()

RCP< const ScalarProdVectorSpaceBase< Scalar > > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::domainScalarProdVecSpc ( ) const

Definition at line 105 of file Thyra_TpetraMultiVector_def.hpp.

◆ assignImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::assignImpl ( Scalar alpha)
protectedvirtual

Definition at line 116 of file Thyra_TpetraMultiVector_def.hpp.

◆ assignMultiVecImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::assignMultiVecImpl ( const MultiVectorBase< Scalar > & mv)
protectedvirtual

◆ scaleImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scaleImpl ( Scalar alpha)
protectedvirtual

Definition at line 140 of file Thyra_TpetraMultiVector_def.hpp.

◆ updateImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::updateImpl ( Scalar alpha,
const MultiVectorBase< Scalar > & mv )
protectedvirtual

◆ linearCombinationImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::linearCombinationImpl ( const ArrayView< const Scalar > & alpha,
const ArrayView< const Ptr< const MultiVectorBase< Scalar > > > & mv,
const Scalar & beta )
protectedvirtual

◆ dotsImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dotsImpl ( const MultiVectorBase< Scalar > & mv,
const ArrayView< Scalar > & prods ) const
protectedvirtual

◆ norms1Impl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norms1Impl ( const ArrayView< typename ScalarTraits< Scalar >::magnitudeType > & norms) const
protectedvirtual

Definition at line 260 of file Thyra_TpetraMultiVector_def.hpp.

◆ norms2Impl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::norms2Impl ( const ArrayView< typename ScalarTraits< Scalar >::magnitudeType > & norms) const
protectedvirtual

Definition at line 269 of file Thyra_TpetraMultiVector_def.hpp.

◆ normsInfImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::normsInfImpl ( const ArrayView< typename ScalarTraits< Scalar >::magnitudeType > & norms) const
protectedvirtual

Definition at line 278 of file Thyra_TpetraMultiVector_def.hpp.

◆ colImpl()

RCP< const VectorBase< Scalar > > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::colImpl ( Ordinal j) const
protected

◆ nonconstColImpl()

RCP< VectorBase< Scalar > > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nonconstColImpl ( Ordinal j)
protected

◆ contigSubViewImpl()

RCP< const MultiVectorBase< Scalar > > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::contigSubViewImpl ( const Range1D & colRng) const
protected

Definition at line 316 of file Thyra_TpetraMultiVector_def.hpp.

References Teuchos::RCP< class T >::RCP().

◆ nonconstContigSubViewImpl()

RCP< MultiVectorBase< Scalar > > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nonconstContigSubViewImpl ( const Range1D & colRng)
protected

Definition at line 346 of file Thyra_TpetraMultiVector_def.hpp.

References Teuchos::RCP< class T >::RCP().

◆ nonContigSubViewImpl()

RCP< const MultiVectorBase< Scalar > > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nonContigSubViewImpl ( const ArrayView< const int > & cols_in) const
protected

Definition at line 376 of file Thyra_TpetraMultiVector_def.hpp.

References Teuchos::RCP< class T >::RCP().

◆ nonconstNonContigSubViewImpl()

RCP< MultiVectorBase< Scalar > > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nonconstNonContigSubViewImpl ( const ArrayView< const int > & cols_in)
protected

Definition at line 409 of file Thyra_TpetraMultiVector_def.hpp.

References Teuchos::RCP< class T >::RCP().

◆ mvMultiReductApplyOpImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::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 Ordinal primary_global_offset ) const
protectedvirtual

Definition at line 441 of file Thyra_TpetraMultiVector_def.hpp.

◆ acquireDetachedMultiVectorViewImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::acquireDetachedMultiVectorViewImpl ( const Range1D & rowRng,
const Range1D & colRng,
RTOpPack::ConstSubMultiVectorView< Scalar > * sub_mv ) const
protected

Definition at line 457 of file Thyra_TpetraMultiVector_def.hpp.

◆ acquireNonconstDetachedMultiVectorViewImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::acquireNonconstDetachedMultiVectorViewImpl ( const Range1D & rowRng,
const Range1D & colRng,
RTOpPack::SubMultiVectorView< Scalar > * sub_mv )
protected

Definition at line 470 of file Thyra_TpetraMultiVector_def.hpp.

◆ commitNonconstDetachedMultiVectorViewImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::commitNonconstDetachedMultiVectorViewImpl ( RTOpPack::SubMultiVectorView< Scalar > * sub_mv)
protected

Definition at line 483 of file Thyra_TpetraMultiVector_def.hpp.

◆ spmdSpaceImpl()

RCP< const SpmdVectorSpaceBase< Scalar > > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::spmdSpaceImpl ( ) const
protected

Definition at line 543 of file Thyra_TpetraMultiVector_def.hpp.

◆ getNonconstLocalMultiVectorDataImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNonconstLocalMultiVectorDataImpl ( const Ptr< ArrayRCP< Scalar > > & localValues,
const Ptr< Ordinal > & leadingDim )
protected

Definition at line 550 of file Thyra_TpetraMultiVector_def.hpp.

◆ getLocalMultiVectorDataImpl()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getLocalMultiVectorDataImpl ( const Ptr< ArrayRCP< const Scalar > > & localValues,
const Ptr< Ordinal > & leadingDim ) const
protected

Definition at line 560 of file Thyra_TpetraMultiVector_def.hpp.

◆ euclideanApply()

void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::euclideanApply ( const EOpTransp M_trans,
const MultiVectorBase< Scalar > & X,
const Ptr< MultiVectorBase< Scalar > > & Y,
const Scalar alpha,
const Scalar beta ) const
protectedvirtual

◆ initializeImpl()

template<class TpetraMultiVector_t >
void Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::initializeImpl ( const RCP< const TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & tpetraVectorSpace,
const RCP< const ScalarProdVectorSpaceBase< Scalar > > & domainSpace,
const RCP< TpetraMultiVector_t > & tpetraMultiVector )
private

◆ getTpetraMultiVector() [2/2]

RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getTpetraMultiVector ( const RCP< MultiVectorBase< Scalar > > & mv) const
private

◆ getConstTpetraMultiVector() [2/2]

RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getConstTpetraMultiVector ( const RCP< const MultiVectorBase< Scalar > > & mv) const
private

Friends And Related Symbol Documentation

◆ tpetraMultiVector()

RCP< TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > tpetraMultiVector ( const RCP< const TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & tpetraVectorSpace,
const RCP< const ScalarProdVectorSpaceBase< Scalar > > & domainSpace,
const RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & tpetraMultiVector )
related

Nonmember constructor for TpetraMultiVector.

Definition at line 272 of file Thyra_TpetraMultiVector_decl.hpp.

References Teuchos::rcp().

◆ constTpetraMultiVector()

RCP< const TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > constTpetraMultiVector ( const RCP< const TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & tpetraVectorSpace,
const RCP< const ScalarProdVectorSpaceBase< Scalar > > & domainSpace,
const RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & tpetraMultiVector )
related

Nonmember constructor for TpetraMultiVector.

Definition at line 291 of file Thyra_TpetraMultiVector_decl.hpp.

References Teuchos::rcp().

Member Data Documentation

◆ tpetraVectorSpace_

Definition at line 240 of file Thyra_TpetraMultiVector_decl.hpp.

◆ domainSpace_

Definition at line 241 of file Thyra_TpetraMultiVector_decl.hpp.

◆ tpetraMultiVector_

Teuchos::ConstNonconstObjectContainer<Tpetra::MultiVector<Scalar, LocalOrdinal,GlobalOrdinal,Node> > Thyra::TpetraMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node >::tpetraMultiVector_
private

Definition at line 243 of file Thyra_TpetraMultiVector_decl.hpp.


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