MueLu  Version of the Day
MueLu_RepartitionFactory_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_REPARTITIONFACTORY_DECL_HPP
47 #define MUELU_REPARTITIONFACTORY_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 #ifdef HAVE_MPI
51 
52 // Some classes are only used in the definition (_def.hpp) of this class
53 // but forward declarations are needed here to enable the UseShortNames mechanism.
54 #include <Xpetra_Map_fwd.hpp>
55 #include <Xpetra_MapFactory_fwd.hpp>
56 #include <Xpetra_Import_fwd.hpp>
57 #include <Xpetra_ImportFactory_fwd.hpp>
58 #include <Xpetra_Export_fwd.hpp>
59 #include <Xpetra_ExportFactory_fwd.hpp>
60 #include <Xpetra_Vector_fwd.hpp>
61 #include <Xpetra_Matrix_fwd.hpp>
62 #include <Xpetra_MatrixFactory_fwd.hpp>
63 
66 #include "MueLu_Utilities_fwd.hpp"
67 
68 namespace MueLu {
69 
78  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
80 #undef MUELU_REPARTITIONFACTORY_SHORT
81 #include "MueLu_UseShortNames.hpp"
82 
83  public:
85 
86 
89 
91  virtual ~RepartitionFactory() { }
92 
93  RCP<const ParameterList> GetValidParameterList() const;
94 
96 
98 
99 
105  void DeclareInput(Level& currentLevel) const;
106 
108 
110 
111 
113  void Build(Level& currentLevel) const;
114 
116 
118 
119 
126  void DeterminePartitionPlacement(const Matrix& A, GOVector& decomposition, GO numPartitions) const;
127 
128  }; // class RepartitionFactory
129 
130 } // namespace MueLu
131 
132 #define MUELU_REPARTITIONFACTORY_SHORT
133 
134 #endif //ifdef HAVE_MPI
135 #endif // MUELU_REPARTITIONFACTORY_DECL_HPP
void Build(Level &currentLevel) const
Build an object with this factory.
Factory for building permutation matrix that can be be used to shuffle data (matrices, vectors) among processes.
Namespace for MueLu classes and methods.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void DeclareInput(Level &currentLevel) const
Determines the data that RepartitionFactory 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.
void DeterminePartitionPlacement(const Matrix &A, GOVector &decomposition, GO numPartitions) const
Determine which process should own each partition.
Base class for factories that use one level (currentLevel).