MueLu  Version of the Day
MueLu_Zoltan2Interface_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // MueLu: A package for multigrid based preconditioning
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 MUELU_ZOLTAN2INTERFACE_DECL_HPP
47 #define MUELU_ZOLTAN2INTERFACE_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 
51 #if defined(HAVE_MUELU_ZOLTAN2) && defined(HAVE_MPI)
52 
53 #include <Xpetra_Matrix.hpp>
54 #include <Xpetra_VectorFactory.hpp>
55 
58 
59 #include "MueLu_Level_fwd.hpp"
61 #include "MueLu_Utilities_fwd.hpp"
62 
63 namespace MueLu {
64 
73  //FIXME: this class should not be templated
74  template <class Scalar,
75  class LocalOrdinal = typename Xpetra::Matrix<Scalar>::local_ordinal_type,
76  class GlobalOrdinal = typename Xpetra::Matrix<Scalar, LocalOrdinal>::global_ordinal_type,
77  class Node = typename Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
79 
80 #undef MUELU_ZOLTAN2INTERFACE_SHORT
81 #include "MueLu_UseShortNames.hpp"
82 
83  public:
84 
86 
87 
90 
92  virtual ~Zoltan2Interface() { }
94 
95  RCP<const ParameterList> GetValidParameterList() const;
96 
98 
99  void DeclareInput(Level & level) const;
101 
103 
104  void Build(Level &level) const;
105 
107 
108  private:
109  RCP<ParameterList> defaultZoltan2Params;
110 
111  }; //class Zoltan2Interface
112 
113 #ifdef HAVE_MUELU_EPETRA
114 
115 #if ((defined(EPETRA_HAVE_OMP) && (!defined(HAVE_TPETRA_INST_OPENMP) || !defined(HAVE_TPETRA_INST_INT_INT))) || \
116  (!defined(EPETRA_HAVE_OMP) && (!defined(HAVE_TPETRA_INST_SERIAL) || !defined(HAVE_TPETRA_INST_INT_INT))))
117  // Stub partial specialization of Zoltan2Interface for EpetraNode
118  template<>
119  class Zoltan2Interface<double,int,int,Xpetra::EpetraNode> : public SingleLevelFactoryBase {
120  public:
121  Zoltan2Interface() { throw Exceptions::RuntimeError("Tpetra does not support <double,int,int,EpetraNode> instantiation"); }
122  virtual ~Zoltan2Interface() { }
123  RCP<const ParameterList> GetValidParameterList() const { return Teuchos::null; };
124  void DeclareInput(Level& level) const {};
125  void Build(Level &level) const {};
126  };
127 #endif
128 
129 #endif // HAVE_MUELU_EPETRA
130 
131 } //namespace MueLu
132 
133 #define MUELU_ZOLTAN2INTERFACE_SHORT
134 #endif //if defined(HAVE_MUELU_ZOLTAN2) && defined(HAVE_MPI)
135 
136 #endif // MUELU_ZOLTAN2INTERFACE_DECL_HPP
void DeclareInput(Level &level) const
Specifies the data that this class needs, and the factories that generate that data.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Namespace for MueLu classes and methods.
virtual ~Zoltan2Interface()
Destructor.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Interface to Zoltan2 library.
void DeclareInput(Level &level) const
Specifies the data that this class needs, and the factories that generate that data.
void Build(Level &level) const
Build an object with this factory.
void Build(Level &level) const
Build an object with this factory.
Exception throws to report errors in the internal logical of the program.
Kokkos::Compat::KokkosSerialWrapperNode EpetraNode
Base class for factories that use one level (currentLevel).
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.