MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_ZoltanInterface_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_ZOLTANINTERFACE_DECL_HPP
47 #define MUELU_ZOLTANINTERFACE_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 
51 #if defined(HAVE_MUELU_ZOLTAN) && defined(HAVE_MPI)
52 
53 #include <zoltan_cpp.h>
54 
55 #include <Xpetra_Matrix.hpp>
57 #include <Xpetra_VectorFactory.hpp>
58 
61 
62 #include "MueLu_Level_fwd.hpp"
64 #include "MueLu_Utilities_fwd.hpp"
65 
66 namespace MueLu {
67 
110  //FIXME: this class should not be templated
111  template <class Scalar,
112  class LocalOrdinal = typename Xpetra::Matrix<double>::local_ordinal_type,
113  class GlobalOrdinal = typename Xpetra::Matrix<double, LocalOrdinal>::global_ordinal_type,
116 #undef MUELU_ZOLTANINTERFACE_SHORT
117 #include "MueLu_UseShortNames.hpp"
118 
119  public:
120 
122 
123 
126 
128  virtual ~ZoltanInterface() { }
130 
132 
134 
135  void DeclareInput(Level& level) const;
137 
139 
140  void Build(Level& level) const;
141 
143 
145 
146 
154  static int GetLocalNumberOfRows(void *data, int *ierr);
155 
164  static void GetLocalNumberOfNonzeros(void *data, int NumGidEntries, int NumLidEntries, ZOLTAN_ID_PTR gids,
165  ZOLTAN_ID_PTR lids, int wgtDim, float *weights, int *ierr);
166 
172  static int GetProblemDimension(void *data, int *ierr);
173 
174 
183  static void GetProblemGeometry(void *data, int numGIDEntries, int numLIDEntries, int numObjectIDs,
184  ZOLTAN_ID_PTR gids, ZOLTAN_ID_PTR lids, int dim, double *coordinates, int *ierr);
185 
187 
188  private:
189 
191 
192  }; //class ZoltanInterface
193 
194 } //namespace MueLu
195 
196 #define MUELU_ZOLTANINTERFACE_SHORT
197 #endif //if defined(HAVE_MUELU_ZOLTAN) && defined(HAVE_MPI)
198 
199 #endif // MUELU_ZOLTANINTERFACE_DECL_HPP
static ArrayRCP< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > coalesceCoordinates(ArrayRCP< typename Teuchos::ScalarTraits< Scalar >::magnitudeType > coord, LocalOrdinal blksize)
static int GetProblemDimension(void *data, int *ierr)
static void GetProblemGeometry(void *data, int numGIDEntries, int numLIDEntries, int numObjectIDs, ZOLTAN_ID_PTR gids, ZOLTAN_ID_PTR lids, int dim, double *coordinates, int *ierr)
Interface to Zoltan library.This interface provides access to partitioning methods in Zoltan...
void Build(Level &level) const
Build an object with this factory.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
virtual ~ZoltanInterface()
Destructor.
static void GetLocalNumberOfNonzeros(void *data, int NumGidEntries, int NumLidEntries, ZOLTAN_ID_PTR gids, ZOLTAN_ID_PTR lids, int wgtDim, float *weights, int *ierr)
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.
Base class for factories that use one level (currentLevel).
static int GetLocalNumberOfRows(void *data, int *ierr)