Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Xpetra_MultiVectorFactory_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // Xpetra: A linear algebra interface package
6 // Copyright 2012 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact
39 // Jonathan Hu (jhu@sandia.gov)
40 // Andrey Prokopenko (aprokop@sandia.gov)
41 // Ray Tuminaro (rstumin@sandia.gov)
42 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 #ifndef XPETRA_MULTIVECTORFACTORY_DECL_HPP
47 #define XPETRA_MULTIVECTORFACTORY_DECL_HPP
48 
49 #include "Xpetra_ConfigDefs.hpp"
51 
52 #ifdef HAVE_XPETRA_TPETRA
53 #include "Xpetra_TpetraMultiVector.hpp"
54 #endif
55 
56 #ifdef HAVE_XPETRA_EPETRA
59 #endif
60 
61 // #include "Xpetra_BlockedMap.hpp"
62 #include "Xpetra_Exceptions.hpp"
63 
64 namespace Xpetra {
65 
82 template <class Scalar,
83  class LocalOrdinal,
84  class GlobalOrdinal,
85  class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
87  private:
90 
91  public:
93  static Teuchos::RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
94  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &map, size_t NumVectors, bool zeroOut = true);
95 
97  static Teuchos::RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
98  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &map,
99  const Teuchos::ArrayView<const Teuchos::ArrayView<const Scalar>> &ArrayOfPtrs,
100  size_t NumVectors);
101 
102  static Teuchos::RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
103  Build(const Teuchos::RCP<const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> &source,
104  Teuchos::DataAccess copyOrView);
105 };
106 
107 // we need the Epetra specialization only if Epetra is enabled
108 #if defined(HAVE_XPETRA_EPETRA)
109 
110 #if !defined(XPETRA_EPETRA_NO_32BIT_GLOBAL_INDICES)
111 
112 // Specialization for Scalar=double, LO=GO=int and Serial node
113 // Used both for Epetra and Tpetra
114 // For any other node definition the general default implementation is used which allows Tpetra only
115 template <>
116 class MultiVectorFactory<double, int, int, EpetraNode> {
117  typedef double Scalar;
118  typedef int LocalOrdinal;
119  typedef int GlobalOrdinal;
120  typedef EpetraNode Node;
121 
122  private:
125 
126  public:
127  static RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
128  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &map, size_t NumVectors, bool zeroOut = true);
129 
131  static Teuchos::RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
132  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &map,
133  const Teuchos::ArrayView<const Teuchos::ArrayView<const Scalar>> &ArrayOfPtrs,
134  size_t NumVectors);
135 
136  static Teuchos::RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
137  Build(const Teuchos::RCP<const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> &source,
138  Teuchos::DataAccess copyOrView);
139 };
140 
141 template <>
142 class MultiVectorFactory<int, int, int, EpetraNode> {
143  typedef int Scalar;
144  typedef int LocalOrdinal;
145  typedef int GlobalOrdinal;
146  typedef EpetraNode Node;
147 
148  private:
151 
152  public:
153  static RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
154  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &map, size_t NumVectors, bool zeroOut = true);
155 
157  static Teuchos::RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
158  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &map,
159  const Teuchos::ArrayView<const Teuchos::ArrayView<const Scalar>> &ArrayOfPtrs,
160  size_t NumVectors);
161 
162  static Teuchos::RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
163  Build(const Teuchos::RCP<const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> &source,
164  Teuchos::DataAccess copyOrView);
165 };
166 
167 // we need the Epetra specialization only if Epetra is enabled
168 #if !defined(XPETRA_EPETRA_NO_64BIT_GLOBAL_INDICES)
169 
170 template <>
171 class MultiVectorFactory<double, int, long long, EpetraNode> {
172  typedef double Scalar;
173  typedef int LocalOrdinal;
174  typedef long long GlobalOrdinal;
175  typedef EpetraNode Node;
176 
177  private:
180 
181  public:
182  static RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
183  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &map,
184  size_t NumVectors,
185  bool zeroOut = true);
186 
188  static Teuchos::RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
189  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &map,
190  const Teuchos::ArrayView<const Teuchos::ArrayView<const Scalar>> &ArrayOfPtrs,
191  size_t NumVectors);
192 
193  static Teuchos::RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
194  Build(const Teuchos::RCP<const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> &source,
195  Teuchos::DataAccess copyOrView);
196 };
197 
198 template <>
199 class MultiVectorFactory<int, int, long long, EpetraNode> {
200  typedef int Scalar;
201  typedef int LocalOrdinal;
202  typedef long long GlobalOrdinal;
203  typedef EpetraNode Node;
204 
205  private:
208 
209  public:
210  static RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
211  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &map,
212  size_t NumVectors,
213  bool zeroOut = true);
214 
216  static Teuchos::RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
217  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>> &map,
218  const Teuchos::ArrayView<const Teuchos::ArrayView<const Scalar>> &ArrayOfPtrs,
219  size_t NumVectors);
220 
221  static Teuchos::RCP<MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>>
222  Build(const Teuchos::RCP<const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node>> &source,
223  Teuchos::DataAccess copyOrView);
224 };
225 
226 #endif // END !defined(XPETRA_EPETRA_NO_64BIT_GLOBAL_INDICES)
227 
228 #endif // END !defined(XPETRA_EPETRA_NO_32BIT_GLOBAL_INDICES)
229 
230 #endif // END HAVE_XPETRA_EPETRA
231 
232 } // namespace Xpetra
233 
234 #define XPETRA_MULTIVECTORFACTORY_SHORT
235 #endif
static Teuchos::RCP< MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Build(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node >> &map, size_t NumVectors, bool zeroOut=true)
Constructor specifying the number of non-zeros for all rows.
Factory for any type of Xpetra::MultiVector and its derived classes.
MultiVectorFactory()
Private constructor. This is a static class.
Tpetra::KokkosCompat::KokkosSerialWrapperNode EpetraNode