Xpetra_CrsGraphFactory.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_CRSGRAPHFACTORY_HPP
47 #define XPETRA_CRSGRAPHFACTORY_HPP
48 
49 #include "Xpetra_ConfigDefs.hpp"
50 
51 #include "Xpetra_CrsGraph.hpp"
52 
53 #ifdef HAVE_XPETRA_TPETRA
55 #endif
56 
57 #ifdef HAVE_XPETRA_EPETRA
59 #endif
60 
61 #include "Xpetra_Exceptions.hpp"
62 
63 namespace Xpetra {
64 
65  template <class LocalOrdinal/* = CrsGraph<>::local_ordinal_type*/,
66  class GlobalOrdinal/* =
67  typename CrsGraph<LocalOrdinal>::global_ordinal_type*/,
68  class Node/* =
69  typename CrsGraph<LocalOrdinal, GlobalOrdinal>::node_type*/>
71  private:
74 
75  public:
77  static Teuchos::RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> >
78  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &map, size_t NumVectors, ProfileType pftype=DynamicProfile) {
79  XPETRA_MONITOR("CrsGraphFactory::Build");
80 
81 #ifdef HAVE_XPETRA_TPETRA
82  if (map->lib() == UseTpetra)
83  return rcp( new TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node> (map, NumVectors, pftype) );
84 #endif
85 
88  return null;
89  }
90  };
91 
92 // we need the Epetra specialization only if Epetra is enabled
93 #if (defined(HAVE_XPETRA_EPETRA) && !defined(XPETRA_EPETRA_NO_32BIT_GLOBAL_INDICES))
94 
95  template <>
96  class CrsGraphFactory<int, int, EpetraNode> {
97 
98  typedef int LocalOrdinal;
99  typedef int GlobalOrdinal;
100  typedef EpetraNode Node;
101 
102  private:
105 
106  public:
107 
108  static RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> >
109  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &map, size_t NumVectors, ProfileType pftype=DynamicProfile) {
110  XPETRA_MONITOR("CrsGraphFactory::Build");
111 
112 #ifdef HAVE_XPETRA_TPETRA
113  if (map->lib() == UseTpetra)
114  return rcp( new TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node> (map, NumVectors, pftype) );
115 #endif
116 
117  if (map->lib() == UseEpetra)
118  return rcp( new EpetraCrsGraphT<int, Node>(map, NumVectors, pftype) );
119 
121  return null;
122  }
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 
130  template <>
131  class CrsGraphFactory<int, long long, EpetraNode> {
132 
133  typedef int LocalOrdinal;
134  typedef long long GlobalOrdinal;
135  typedef EpetraNode Node;
136 
137  private:
140 
141  public:
142 
143  static RCP<CrsGraph<LocalOrdinal, GlobalOrdinal, Node> >
144  Build(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &map, size_t NumVectors, ProfileType pftype=DynamicProfile) {
145  XPETRA_MONITOR("CrsGraphFactory::Build");
146 
147 #ifdef HAVE_XPETRA_TPETRA
148  if (map->lib() == UseTpetra)
149  return rcp( new TpetraCrsGraph<LocalOrdinal, GlobalOrdinal, Node> (map, NumVectors, pftype) );
150 #endif
151 
152  if (map->lib() == UseEpetra)
153  return rcp( new EpetraCrsGraphT<long long, Node>(map, NumVectors, pftype) );
154 
156  return null;
157  }
158 
159  };
160 #endif
161 }
162 
163 #define XPETRA_CRSGRAPHFACTORY_SHORT
164 #endif
static Teuchos::RCP< CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > Build(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, size_t NumVectors, ProfileType pftype=DynamicProfile)
Constructor specifying the number of non-zeros for all rows.
Xpetra namespace
static RCP< CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > Build(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, size_t NumVectors, ProfileType pftype=DynamicProfile)
#define XPETRA_FACTORY_ERROR_IF_EPETRA(lib)
static RCP< CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > Build(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, size_t NumVectors, ProfileType pftype=DynamicProfile)
#define XPETRA_FACTORY_END
CrsGraphFactory()
Private constructor. This is a static class.
#define XPETRA_MONITOR(funcName)
CrsGraphFactory()
Private constructor. This is a static class.
CrsGraphFactory()
Private constructor. This is a static class.