MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_NullspaceFactory_kokkos_def.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_NULLSPACEFACTORY_KOKKOS_DEF_HPP
47 #define MUELU_NULLSPACEFACTORY_KOKKOS_DEF_HPP
48 
49 #ifdef HAVE_MUELU_KOKKOS_REFACTOR
50 
52 
53 #include <Xpetra_Matrix.hpp>
55 
56 #include "MueLu_Level.hpp"
57 #include "MueLu_Monitor.hpp"
58 
59 namespace MueLu {
60 
61  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class DeviceType>
62  RCP<const ParameterList> NullspaceFactory_kokkos<Scalar,LocalOrdinal,GlobalOrdinal,Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType>>::GetValidParameterList() const {
63  RCP<ParameterList> validParamList = rcp(new ParameterList());
64 
65  validParamList->set< RCP<const FactoryBase> >("A", Teuchos::null, "Generating factory of the fine level matrix (only needed if default null space is generated)");
66  validParamList->set< RCP<const FactoryBase> >("Nullspace", Teuchos::null, "Generating factory of the fine level null space");
67 
68  // TODO not very elegant.
69  validParamList->set< std::string >("Fine level nullspace", "Nullspace", "Variable name which is used to store null space multi vector on the finest level (default=\"Nullspace\"). For block matrices also \"Nullspace1\" to \"Nullspace9\" are accepted to describe the null space vectors for the (i,i) block (i=1..9).");
70 
71  // 1/20/2016: we could add a sublist (e.g. "Nullspaces" which is excluded from parameter validation)
72  validParamList->set< RCP<const FactoryBase> >("Nullspace1", Teuchos::null, "Generating factory of the fine level null space associated with the (1,1) block in your n x n block matrix.");
73  validParamList->set< RCP<const FactoryBase> >("Nullspace2", Teuchos::null, "Generating factory of the fine level null space associated with the (2,2) block in your n x n block matrix.");
74  validParamList->set< RCP<const FactoryBase> >("Nullspace3", Teuchos::null, "Generating factory of the fine level null space associated with the (3,3) block in your n x n block matrix.");
75  validParamList->set< RCP<const FactoryBase> >("Nullspace4", Teuchos::null, "Generating factory of the fine level null space associated with the (4,4) block in your n x n block matrix.");
76  validParamList->set< RCP<const FactoryBase> >("Nullspace5", Teuchos::null, "Generating factory of the fine level null space associated with the (5,5) block in your n x n block matrix.");
77  validParamList->set< RCP<const FactoryBase> >("Nullspace6", Teuchos::null, "Generating factory of the fine level null space associated with the (6,6) block in your n x n block matrix.");
78  validParamList->set< RCP<const FactoryBase> >("Nullspace7", Teuchos::null, "Generating factory of the fine level null space associated with the (7,7) block in your n x n block matrix.");
79  validParamList->set< RCP<const FactoryBase> >("Nullspace8", Teuchos::null, "Generating factory of the fine level null space associated with the (8,8) block in your n x n block matrix.");
80  validParamList->set< RCP<const FactoryBase> >("Nullspace9", Teuchos::null, "Generating factory of the fine level null space associated with the (9,9) block in your n x n block matrix.");
81 
82  return validParamList;
83  }
84 
85  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class DeviceType>
86  void NullspaceFactory_kokkos<Scalar,LocalOrdinal,GlobalOrdinal,Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType>>::DeclareInput(Level& currentLevel) const {
87  const ParameterList& pL = GetParameterList();
88  std::string nspName = pL.get<std::string>("Fine level nullspace");
89 
90  // only request "A" in DeclareInput if
91  // 1) there is not nspName (e.g. "Nullspace") is available in Level, AND
92  // 2) it is the finest level (i.e. LevelID == 0)
93  if (currentLevel.IsAvailable(nspName, NoFactory::get()) == false && currentLevel.GetLevelID() == 0)
94  Input(currentLevel, "A");
95 
96  if (currentLevel.GetLevelID() != 0) {
97  // validate nullspaceFact_
98  // 1) The factory for "Nullspace" (or nspName) must not be Teuchos::null, since the default factory
99  // for "Nullspace" is a NullspaceFactory
100  // 2) The factory for "Nullspace" (or nspName) must be a TentativePFactory or any other TwoLevelFactoryBase derived object
101  // which generates the variable "Nullspace" as output
102  TEUCHOS_TEST_FOR_EXCEPTION(GetFactory(nspName).is_null(), Exceptions::RuntimeError,
103  "MueLu::NullspaceFactory::DeclareInput(): You must declare an existing factory which "
104  "produces the variable \"Nullspace\" in the NullspaceFactory (e.g. a TentativePFactory).");
105  currentLevel.DeclareInput("Nullspace", GetFactory(nspName).get(), this); /* ! "Nullspace" and nspName mismatch possible here */
106  }
107  }
108 
109  template<class NullspaceType, class LO>
110  class NullspaceFunctor {
111  private:
112  NullspaceType nullspace;
113  LO numPDEs;
114  typedef typename NullspaceType::value_type SC;
115  typedef Kokkos::ArithTraits<SC> ATS;
116 
117  public:
118  NullspaceFunctor(NullspaceType nullspace_, LO numPDEs_) :
119  nullspace(nullspace_),
120  numPDEs(numPDEs_)
121  { }
122 
123  KOKKOS_INLINE_FUNCTION
124  void operator()(const LO j) const {
125  SC one = ATS::one();
126  for (LO i = 0; i < numPDEs; i++)
127  nullspace(j*numPDEs + i, i) = one;
128  }
129  };
130  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class DeviceType>
131  void NullspaceFactory_kokkos<Scalar,LocalOrdinal,GlobalOrdinal,Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType>>::Build(Level& currentLevel) const {
132  FactoryMonitor m(*this, "Nullspace factory", currentLevel);
133 
134  RCP<MultiVector> nullspace;
135 
136  //TEUCHOS_TEST_FOR_EXCEPTION(currentLevel.GetLevelID() != 0, Exceptions::RuntimeError, "MueLu::NullspaceFactory::Build(): NullspaceFactory can be used for finest level (LevelID == 0) only.");
137  const ParameterList& pL = GetParameterList();
138  std::string nspName = pL.get<std::string>("Fine level nullspace");
139 
140  if (currentLevel.GetLevelID() == 0) {
141  if (currentLevel.IsAvailable(nspName, NoFactory::get())) {
142  // When a fine nullspace have already been defined by user using Set("Nullspace", ...) or
143  // Set("Nullspace1", ...), we use it.
144  nullspace = currentLevel.Get< RCP<MultiVector> >(nspName, NoFactory::get());
145  GetOStream(Runtime1) << "Use user-given nullspace " << nspName << ":"
146  << " nullspace dimension=" << nullspace->getNumVectors()
147  << " nullspace length=" << nullspace->getGlobalLength() << std::endl;
148 
149  } else {
150  // "Nullspace" (nspName) is not available
151  auto A = Get< RCP<Matrix> >(currentLevel, "A");
152 
153  // Determine numPDEs
154  LO numPDEs = 1;
155  if (A->IsView("stridedMaps") == true) {
156  Xpetra::viewLabel_t oldView = A->SwitchToView("stridedMaps"); // note: "stridedMaps are always non-overlapping (correspond to range and domain maps!)
157  TEUCHOS_TEST_FOR_EXCEPTION(rcp_dynamic_cast<const StridedMap>(A->getRowMap()).is_null(), Exceptions::BadCast,
158  "MueLu::CoalesceFactory::Build: cast to strided row map failed.");
159  numPDEs = rcp_dynamic_cast<const StridedMap>(A->getRowMap())->getFixedBlockSize();
160  oldView = A->SwitchToView(oldView);
161  }
162 
163  GetOStream(Runtime1) << "Generating canonical nullspace: dimension = " << numPDEs << std::endl;
164 
165  nullspace = MultiVectorFactory::Build(A->getDomainMap(), numPDEs);
166  auto nullspaceView = nullspace->template getLocalView<DeviceType>();
167 
168  int numBlocks = nullspace->getLocalLength() / numPDEs;
169 
170  NullspaceFunctor<decltype(nullspaceView), LO> nullspaceFunctor(nullspaceView, numPDEs);
171  Kokkos::parallel_for("MueLu:NullspaceF:Build:for", range_type(0,numBlocks), nullspaceFunctor);
172  // TODO extend null space factory for blocked multi vectors
173  }
174 
175  } else {
176  // On coarser levels always use "Nullspace" as variable name, since it is expected by
177  // tentative P factory to be "Nullspace"
178  nullspace = currentLevel.Get< RCP<MultiVector> >("Nullspace", GetFactory(nspName).get()); // NOTE: "Nullspace" and nspName mismatch possible here
179  }
180 
181  // provide "Nullspace" variable on current level (used by TentativePFactory)
182  Set(currentLevel, "Nullspace", nullspace);
183 
184  } // Build
185 
186 } //namespace MueLu
187 
188 #endif // HAVE_MUELU_KOKKOS_REFACTOR
189 #endif // MUELU_NULLSPACEFACTORY_KOKKOS_DEF_HPP
void parallel_for(const ExecPolicy &policy, const FunctorType &functor, const std::string &str="", typename Impl::enable_if< Kokkos::Impl::is_execution_policy< ExecPolicy >::value >::type *=0)
bool is_null(const boost::shared_ptr< T > &p)
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
LocalOrdinal LO
static const NoFactory * get()
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
std::string viewLabel_t
Scalar SC
Description of what is happening (more verbose)