Xpetra Version of the Day
Loading...
Searching...
No Matches
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
65namespace Xpetra {
66
83template<class Scalar,
84 class LocalOrdinal,
85 class GlobalOrdinal,
88{
89 private:
90
93
94 public:
95
98 Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& map, size_t NumVectors, bool zeroOut = true);
99
104 size_t NumVectors);
105
108 Teuchos::DataAccess copyOrView);
109};
110
111
112
113// we need the Epetra specialization only if Epetra is enabled
114#if defined(HAVE_XPETRA_EPETRA)
115
116#if !defined(XPETRA_EPETRA_NO_32BIT_GLOBAL_INDICES)
117
118
119// Specialization for Scalar=double, LO=GO=int and Serial node
120// Used both for Epetra and Tpetra
121// For any other node definition the general default implementation is used which allows Tpetra only
122template<>
123class MultiVectorFactory<double, int, int, EpetraNode>
124{
125
126 typedef double Scalar;
127 typedef int LocalOrdinal;
128 typedef int GlobalOrdinal;
130
131 private:
132
135
136 public:
137
139 Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& map, size_t NumVectors, bool zeroOut = true);
140
145 size_t NumVectors);
146
149 Teuchos::DataAccess copyOrView);
150};
151
152
153
154template<>
155class MultiVectorFactory<int, int, int, EpetraNode>
156{
157
158 typedef int Scalar;
159 typedef int LocalOrdinal;
160 typedef int GlobalOrdinal;
162
163 private:
164
167
168 public:
169
171 Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node>>& map, size_t NumVectors, bool zeroOut = true);
172
177 size_t NumVectors);
178
181 Teuchos::DataAccess copyOrView);
182};
183
184
185// we need the Epetra specialization only if Epetra is enabled
186#if !defined(XPETRA_EPETRA_NO_64BIT_GLOBAL_INDICES)
187
188
189template <>
190class MultiVectorFactory<double, int, long long, EpetraNode>
191{
192 typedef double Scalar;
193 typedef int LocalOrdinal;
194 typedef long long GlobalOrdinal;
196
197private:
198
201
202public:
203
206 size_t NumVectors,
207 bool zeroOut = true);
208
212 const Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > &ArrayOfPtrs,
213 size_t NumVectors);
214
217 Teuchos::DataAccess copyOrView);
218
219};
220
221
222template <>
223class MultiVectorFactory<int, int, long long, EpetraNode>
224{
225
226 typedef int Scalar;
227 typedef int LocalOrdinal;
228 typedef long long GlobalOrdinal;
230
231private:
232
235
236public:
237
240 size_t NumVectors,
241 bool zeroOut = true);
242
246 const Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > &ArrayOfPtrs,
247 size_t NumVectors);
248
251 Teuchos::DataAccess copyOrView);
252
253};
254
255
256#endif // END !defined(XPETRA_EPETRA_NO_64BIT_GLOBAL_INDICES)
257
258#endif // END !defined(XPETRA_EPETRA_NO_32BIT_GLOBAL_INDICES)
259
260#endif // END HAVE_XPETRA_EPETRA
261
262
263} // namespace Xpetra
264
265#define XPETRA_MULTIVECTORFACTORY_SHORT
266#endif
static RCP< MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Build(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, size_t NumVectors, bool zeroOut=true)
static Teuchos::RCP< MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Build(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, const Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > &ArrayOfPtrs, size_t NumVectors)
Set multi-vector values from array of pointers using Teuchos memory management classes....
MultiVectorFactory()
Private constructor. This is a static class.
static Teuchos::RCP< MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Build(const Teuchos::RCP< const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &source, Teuchos::DataAccess copyOrView)
static RCP< MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Build(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, size_t NumVectors, bool zeroOut=true)
static Teuchos::RCP< MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Build(const Teuchos::RCP< const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &source, Teuchos::DataAccess copyOrView)
MultiVectorFactory()
Private constructor. This is a static class.
static Teuchos::RCP< MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Build(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, const Teuchos::ArrayView< const Teuchos::ArrayView< const Scalar > > &ArrayOfPtrs, size_t NumVectors)
Set multi-vector values from array of pointers using Teuchos memory management classes....
Factory for any type of Xpetra::MultiVector and its derived classes.
MultiVectorFactory()
Private constructor. This is a static class.
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.
Xpetra namespace