Thyra  Version of the Day
Thyra_TpetraMultiVector_decl.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Thyra: Interfaces and Support for Abstract Numerical Algorithms
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef THYRA_TPETRA_MULTIVECTOR_DECL_HPP
43 #define THYRA_TPETRA_MULTIVECTOR_DECL_HPP
44 
45 #include "Thyra_SpmdMultiVectorDefaultBase.hpp"
46 #include "Thyra_TpetraVectorSpace_decl.hpp"
47 #include "Tpetra_MultiVector.hpp"
48 #include "Teuchos_ConstNonconstObjectContainer.hpp"
49 
50 
51 namespace Thyra {
52 
53 
61 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
63  : virtual public SpmdMultiVectorDefaultBase<Scalar>
64 {
65 public:
66 
69 
72 
75  void initialize(
76  const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
77  const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
78  const RCP<Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector
79  );
80 
83  void constInitialize(
84  const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
85  const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
86  const RCP<const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector
87  );
88 
90  RCP<Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
92 
94  RCP<const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
96 
98 
102  RCP< const ScalarProdVectorSpaceBase<Scalar> >
103  domainScalarProdVecSpc() const;
105 
106 protected:
107 
111  void assignImpl(Scalar alpha);
113  RCP<const VectorBase<Scalar> > colImpl(Ordinal j) const;
115  RCP<VectorBase<Scalar> > nonconstColImpl(Ordinal j);
116 
118  RCP<const MultiVectorBase<Scalar> >
119  contigSubViewImpl( const Range1D& colRng ) const;
121  RCP<MultiVectorBase<Scalar> >
122  nonconstContigSubViewImpl( const Range1D& colRng );
123 // /** \brief . */
124 // RCP<const MultiVectorBase<Scalar> >
125 // nonContigSubViewImpl( const ArrayView<const int> &cols ) const;
126 // /** \brief . */
127 // RCP<MultiVectorBase<Scalar> >
128 // nonconstNonContigSubViewImpl( const ArrayView<const int> &cols );
130 
134  RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpaceImpl() const;
137  const Ptr<ArrayRCP<Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
138  );
141  const Ptr<ArrayRCP<const Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
142  ) const;
144 
145 private:
146 
147  // ///////////////////////////////////////
148  // Private data members
149 
150  RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tpetraVectorSpace_;
151  RCP<const ScalarProdVectorSpaceBase<Scalar> > domainSpace_;
152  Teuchos::ConstNonconstObjectContainer<Tpetra::MultiVector<Scalar, LocalOrdinal,GlobalOrdinal,Node> >
153  tpetraMultiVector_;
154 
155  // ////////////////////////////////////
156  // Private member functions
157 
158  template<class TpetraMultiVector_t>
159  void initializeImpl(
160  const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
161  const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
162  const RCP<TpetraMultiVector_t> &tpetraMultiVector
163  );
164 
165 };
166 
167 
172 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
173 RCP<TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
175  const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
176  const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
177  const RCP<Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector
178  )
179 {
180  RCP<TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tmv =
182  tmv->initialize(tpetraVectorSpace, domainSpace, tpetraMultiVector);
183  return tmv;
184 }
185 
186 
191 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
192 RCP<const TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
194  const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
195  const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
196  const RCP<const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector
197  )
198 {
199  RCP<TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tmv =
201  tmv->constInitialize(tpetraVectorSpace, domainSpace, tpetraMultiVector);
202  return tmv;
203 }
204 
205 
206 } // end namespace Thyra
207 
208 
209 #endif // THYRA_TPETRA_MULTIVECTOR_DECL_HPP
Concrete implementation of Thyra::MultiVector in terms of Tpetra::MultiVector.
RCP< const ScalarProdVectorSpaceBase< Scalar > > domainScalarProdVecSpc() const
TpetraMultiVector()
Construct to uninitialized.
void getNonconstLocalMultiVectorDataImpl(const Ptr< ArrayRCP< Scalar > > &localValues, const Ptr< Ordinal > &leadingDim)
Concrete implementation of an SPMD vector space for Tpetra.
RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getTpetraMultiVector()
Extract the underlying non-const Tpetra::MultiVector object.
RCP< const SpmdVectorSpaceBase< Scalar > > spmdSpaceImpl() const
RCP< MultiVectorBase< Scalar > > nonconstContigSubViewImpl(const Range1D &colRng)
void getLocalMultiVectorDataImpl(const Ptr< ArrayRCP< const Scalar > > &localValues, const Ptr< Ordinal > &leadingDim) const
Base node implementation class for SPMD multi-vectors.
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.
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.
RCP< const MultiVectorBase< Scalar > > contigSubViewImpl(const Range1D &colRng) const
Teuchos::Ordinal Ordinal
Type for the dimension of a vector space. `*.
RCP< const VectorBase< Scalar > > colImpl(Ordinal j) const
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.
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< VectorBase< Scalar > > nonconstColImpl(Ordinal j)
RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getConstTpetraMultiVector() const
Extract the underlying const Tpetra::MultiVector object.
Teuchos::Range1D Range1D