Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_TpetraVectorSpace_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 
43 #ifndef THYRA_TPETRA_VECTOR_SPACE_DECL_HPP
44 #define THYRA_TPETRA_VECTOR_SPACE_DECL_HPP
45 
46 
47 #include "Thyra_SpmdVectorSpaceDefaultBase.hpp"
48 #include "Tpetra_Map.hpp"
49 #include "Tpetra_MultiVector.hpp"
50 
51 
52 namespace Thyra {
53 
54 
59 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
61 {
62 public:
63 
66 
69 
72 
74  void initialize(
75  const RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > &tpetraMap
76  );
77 
79 
85  bool hasInCoreView(
86  const Range1D& rng, const EViewType viewType, const EStrideType strideType
87  ) const;
90 
93  getTpetraMap() const;
94 
96 
97 protected:
98 
101 
104  createMember() const;
107  createMembers(int numMembers) const;
108 
109 public:
110 
113 
116 
118 
119 public:
120 
123 
127  Ordinal localSubDim() const;
128 
130 
131 private:
132 
133  // //////////////////////////////////////
134  // Private data members
135 
139  // The only reason Thyra needs this comm_ object is because Thyra
140  // uses Ordinal as the Comm template parameter, while Tpetra uses
141  // int. Ordinal is some 64-bit type, which doesn't make any sense,
142  // given that MPI implementations currently only allow 32-bit
143  // process ranks. This is why Thyra does not just use the Map's
144  // stored communicator.
146  RCP<this_t> weakSelfPtr_;
147 
148  // /////////////////////////////////////
149  // Private member functions
150 
152 
153 }; // end class TpetraVectorSpace
154 
155 
160 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
163  const RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > &tpetraMap
164  )
165 {
168  vs->initialize(tpetraMap);
169  return vs;
170 }
171 
172 
173 } // end namespace Thyra
174 
175 
176 #endif // THYRA_TPETRA_VECTOR_SPACE_DECL_HPP
Concrete implementation of an SPMD vector space for Tpetra.
RCP< MultiVectorBase< Scalar > > createCachedMembersView(const RTOpPack::SubMultiVectorView< Scalar > &raw_mv) const
Create a (possibly) cached multi-vector member that is a non-const view of raw multi-vector data...
Base VectorSpaceBase class for all SPMD vector spaces with contiguous local-to-global indexing...
RCP< const VectorSpaceBase< Scalar > > clone() const
RCP< TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > tpetraVectorSpace(const RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &tpetraMap)
Nonmember constructor that creats a serial vector space.
static RCP< TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > > create()
Create with weak ownership to self.
void initialize(const RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &tpetraMap)
Initialize a serial space.
EViewType
Determines if a view is a direct view of data or a detached copy of data.
RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getTpetraMap() const
Get the embedded Tpetra::Map.
Teuchos::Ordinal Ordinal
Type for the dimension of a vector space. `*.
TpetraVectorSpace< Scalar, LocalOrdinal, GlobalOrdinal, Node > this_t
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< VectorBase< Scalar > > createMember() const
RCP< MultiVectorBase< Scalar > > createMembers(int numMembers) const
EStrideType
Determine if data is unit stride or non-unit stride.
RCP< const Teuchos::Comm< Ordinal > > getComm() const