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 = Import<>::local_ordinal_type,
65  class GlobalOrdinal = typename Import<LocalOrdinal>::global_ordinal_type,
67  class ImportFactory {
68  private:
71 
72  public:
73 
76  XPETRA_MONITOR("ImportFactory::Build");
77 
78  TEUCHOS_TEST_FOR_EXCEPTION(source->lib() != target->lib(), Xpetra::Exceptions::RuntimeError, "");
79 
80 #ifdef HAVE_XPETRA_TPETRA
81  if (source->lib() == UseTpetra)
82  return rcp( new TpetraImport<LocalOrdinal, GlobalOrdinal, Node>(source, target));
83 #endif
84 
85  XPETRA_FACTORY_ERROR_IF_EPETRA(source->lib());
87  }
88 
89  };
90 
91  template <>
92  class ImportFactory<int, int> {
93 
94  typedef int LocalOrdinal;
95  typedef int GlobalOrdinal;
97 
98  private:
101 
102  public:
103 
105  XPETRA_MONITOR("ImportFactory::Build");
106  TEUCHOS_TEST_FOR_EXCEPTION(source->lib() != target->lib(), Xpetra::Exceptions::RuntimeError, "");
107 
108 #ifdef HAVE_XPETRA_TPETRA
109  if (source->lib() == UseTpetra)
110  return rcp( new TpetraImport<LocalOrdinal, GlobalOrdinal, Node>(source, target));
111 #endif
112 
113 #ifdef HAVE_XPETRA_EPETRA
114 #ifndef XPETRA_EPETRA_NO_32BIT_GLOBAL_INDICES
115  if (source->lib() == UseEpetra)
116  return rcp( new EpetraImportT<int>(source, target));
117 #endif
118 #endif
119 
121  }
122 
123  };
124 
125 #ifdef HAVE_XPETRA_INT_LONG_LONG
126  template <>
127  class ImportFactory<int, long long> {
128 
129  typedef int LocalOrdinal;
130  typedef long long GlobalOrdinal;
132 
133  private:
135  ImportFactory() {}
136 
137  public:
138 
140  XPETRA_MONITOR("ImportFactory::Build");
141  TEUCHOS_TEST_FOR_EXCEPTION(source->lib() != target->lib(), Xpetra::Exceptions::RuntimeError, "");
142 
143 #ifdef HAVE_XPETRA_TPETRA
144  if (source->lib() == UseTpetra)
145  return rcp( new TpetraImport<LocalOrdinal, GlobalOrdinal, Node>(source, target));
146 #endif
147 
148 #ifdef HAVE_XPETRA_EPETRA
149 #ifndef XPETRA_EPETRA_NO_64BIT_GLOBAL_INDICES
150  if (source->lib() == UseEpetra)
151  return rcp( new EpetraImportT<long long>(source, target));
152 #endif
153 #endif
154 
156  }
157 
158  };
159 #endif // HAVE_XPETRA_INT_LONG_LONG
160 
161 }
162 
163 #define XPETRA_IMPORTFACTORY_SHORT
164 #endif
static RCP< Import< LocalOrdinal, GlobalOrdinal, Node > > Build(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &source, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &target)
Constructor specifying the number of non-zeros for all rows.
Import< int, GlobalOrdinal >::node_type Node
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Xpetra namespace
Exception throws to report errors in the internal logical of the program.
#define XPETRA_FACTORY_ERROR_IF_EPETRA(lib)
static RCP< Import< LocalOrdinal, GlobalOrdinal, Node > > Build(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &source, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &target)
GlobalOrdinal global_ordinal_type
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
#define XPETRA_FACTORY_END
ImportFactory()
Private constructor. This is a static class.
#define XPETRA_MONITOR(funcName)
ImportFactory()
Private constructor. This is a static class.