Xpetra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Xpetra_ImportFactory.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_IMPORTFACTORY_HPP
47 #define XPETRA_IMPORTFACTORY_HPP
48 
49 #include "Xpetra_ConfigDefs.hpp"
50 
51 #include "Xpetra_Import.hpp"
52 
53 #ifdef HAVE_XPETRA_TPETRA
54 #include "Xpetra_TpetraImport.hpp"
55 #endif
56 #ifdef HAVE_XPETRA_EPETRA
57 #include "Xpetra_EpetraImport.hpp"
58 #endif
59 
60 #include "Xpetra_Exceptions.hpp"
61 
62 namespace Xpetra {
63 
64 template <class LocalOrdinal,
65  class GlobalOrdinal,
66  class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
68  private:
71 
72  public:
74  static RCP<Import<LocalOrdinal, GlobalOrdinal, Node> > Build(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &source,
75  const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &target,
76  const Teuchos::RCP<Teuchos::ParameterList> &plist = Teuchos::null) {
77  XPETRA_MONITOR("ImportFactory::Build");
78 
79  TEUCHOS_TEST_FOR_EXCEPTION(source->lib() != target->lib(), Xpetra::Exceptions::RuntimeError, "");
80 
81 #ifdef HAVE_XPETRA_TPETRA
82  if (source->lib() == UseTpetra)
83  return rcp(new TpetraImport<LocalOrdinal, GlobalOrdinal, Node>(source, target, plist));
84 #endif
85 
86  XPETRA_FACTORY_ERROR_IF_EPETRA(source->lib());
88  }
89 };
90 
91 // we need the Epetra specialization only if Epetra is enabled
92 #if (defined(HAVE_XPETRA_EPETRA) && !defined(XPETRA_EPETRA_NO_32BIT_GLOBAL_INDICES))
93 
94 // Specialization on LO=GO=int with serial node.
95 // Used for Epetra and Tpetra
96 // For any other node definition the general default implementation is used which allows Tpetra only
97 template <>
98 class ImportFactory<int, int, EpetraNode> {
99  typedef int LocalOrdinal;
100  typedef int GlobalOrdinal;
101  typedef EpetraNode Node;
102 
103  private:
106 
107  public:
108  static RCP<Import<LocalOrdinal, GlobalOrdinal, Node> > Build(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &source,
109  const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &target,
110  const Teuchos::RCP<Teuchos::ParameterList> &plist = Teuchos::null) {
111  XPETRA_MONITOR("ImportFactory::Build");
112  TEUCHOS_TEST_FOR_EXCEPTION(source->lib() != target->lib(), Xpetra::Exceptions::RuntimeError, "");
113 
114 #ifdef HAVE_XPETRA_TPETRA
115  if (source->lib() == UseTpetra)
116  return rcp(new TpetraImport<LocalOrdinal, GlobalOrdinal, Node>(source, target, plist));
117 #endif
118 
119  if (source->lib() == UseEpetra)
120  return rcp(new EpetraImportT<int, Node>(source, target));
121 
123  }
124 };
125 #endif
126 
127 // we need the Epetra specialization only if Epetra is enabled
128 #if (defined(HAVE_XPETRA_EPETRA) && !defined(XPETRA_EPETRA_NO_64BIT_GLOBAL_INDICES))
129 template <>
130 class ImportFactory<int, long long, EpetraNode> {
131  typedef int LocalOrdinal;
132  typedef long long GlobalOrdinal;
133  typedef EpetraNode Node;
134 
135  private:
138 
139  public:
140  static RCP<Import<LocalOrdinal, GlobalOrdinal, Node> > Build(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &source,
141  const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &target,
142  const Teuchos::RCP<Teuchos::ParameterList> &plist = Teuchos::null) {
143  XPETRA_MONITOR("ImportFactory::Build");
144  TEUCHOS_TEST_FOR_EXCEPTION(source->lib() != target->lib(), Xpetra::Exceptions::RuntimeError, "");
145 
146 #ifdef HAVE_XPETRA_TPETRA
147  if (source->lib() == UseTpetra)
148  return rcp(new TpetraImport<LocalOrdinal, GlobalOrdinal, Node>(source, target, plist));
149 #endif
150 
151  if (source->lib() == UseEpetra)
152  return rcp(new EpetraImportT<long long, Node>(source, target));
153 
155  }
156 };
157 #endif
158 } // namespace Xpetra
159 
160 #define XPETRA_IMPORTFACTORY_SHORT
161 #endif
Exception throws to report errors in the internal logical of the program.
#define XPETRA_FACTORY_ERROR_IF_EPETRA(lib)
#define XPETRA_FACTORY_END
ImportFactory()
Private constructor. This is a static class.
ImportFactory()
Private constructor. This is a static class.
static RCP< Import< LocalOrdinal, GlobalOrdinal, Node > > Build(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &source, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &target, const Teuchos::RCP< Teuchos::ParameterList > &plist=Teuchos::null)
static RCP< Import< LocalOrdinal, GlobalOrdinal, Node > > Build(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &source, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &target, const Teuchos::RCP< Teuchos::ParameterList > &plist=Teuchos::null)
Tpetra::KokkosCompat::KokkosSerialWrapperNode EpetraNode
#define XPETRA_MONITOR(funcName)
ImportFactory()
Private constructor. This is a static class.
static RCP< Import< LocalOrdinal, GlobalOrdinal, Node > > Build(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &source, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &target, const Teuchos::RCP< Teuchos::ParameterList > &plist=Teuchos::null)
Constructor specifying the number of non-zeros for all rows.