MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_UserPFactory_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_USERPFACTORY_DEF_HPP
47 #define MUELU_USERPFACTORY_DEF_HPP
48 
50 #include <Xpetra_Matrix.hpp>
51 #include <Xpetra_IO.hpp>
52 
53 #include "MueLu_Monitor.hpp"
54 #include "MueLu_PerfUtils.hpp"
55 #include "MueLu_UserPFactory.hpp"
56 #include "MueLu_Utilities.hpp"
57 
58 namespace MueLu {
59 
60  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
62  RCP<ParameterList> validParamList = rcp(new ParameterList());
63 
64  validParamList->set< RCP<const FactoryBase> >("A", Teuchos::null, "Generating factory of the matrix A");
65  validParamList->set< RCP<const FactoryBase> >("Nullspace", Teuchos::null, "Generating factory of the nullspace");
66  validParamList->set< std::string > ("matrixFileName", "", "File with matrix data");
67  validParamList->set< std::string > ("mapFileName", "", "File with coarse map data");
68 
69  return validParamList;
70  }
71 
72  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
74  Input(fineLevel, "A");
75  Input(fineLevel, "Nullspace");
76  }
77 
78  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
80  return BuildP(fineLevel, coarseLevel);
81  }
82 
83  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
85  FactoryMonitor m(*this, "Build", coarseLevel);
86 
87  RCP<Matrix> A = Get< RCP<Matrix> > (fineLevel, "A");
88  RCP<MultiVector> fineNullspace = Get< RCP<MultiVector> > (fineLevel, "Nullspace");
89 
90  TEUCHOS_TEST_FOR_EXCEPTION(A->GetFixedBlockSize() != 1, Exceptions::RuntimeError, "Block size > 1 has not been implemented");
91 
92  const Teuchos::ParameterList& pL = GetParameterList();
93 
94  std::string mapFile = pL.get<std::string>("mapFileName");
95  RCP<const Map> rowMap = A->getRowMap();
96  RCP<const Map> coarseMap = Xpetra::IO<Scalar, LocalOrdinal, GlobalOrdinal, Node>::ReadMap(mapFile, rowMap->lib(), rowMap->getComm());
97  Set(coarseLevel, "CoarseMap", coarseMap);
98 
99  std::string matrixFile = pL.get<std::string>("matrixFileName");
100  RCP<Matrix> P = Xpetra::IO<Scalar, LocalOrdinal, GlobalOrdinal, Node>::Read(matrixFile, rowMap, coarseMap, coarseMap, rowMap);
101 #if 1
102  Set(coarseLevel, "P", P);
103 #else
104  // Expand column map by 1
106  P = Xpetra::IO<Scalar, LocalOrdinal, GlobalOrdinal, Node>::Read(matrixFile, rowMap, P1->getColMap(), coarseMap, rowMap);
107  Set(coarseLevel, "P", P);
108 #endif
109 
110  RCP<MultiVector> coarseNullspace = MultiVectorFactory::Build(coarseMap, fineNullspace->getNumVectors());
111  P->apply(*fineNullspace, *coarseNullspace, Teuchos::TRANS, Teuchos::ScalarTraits<SC>::one(), Teuchos::ScalarTraits<SC>::zero());
112  Set(coarseLevel, "Nullspace", coarseNullspace);
113 
114  // Coordinates transfer
115  size_t n = Teuchos::as<size_t>(sqrt(coarseMap->getGlobalNumElements()));
116  TEUCHOS_TEST_FOR_EXCEPTION(n*n != coarseMap->getGlobalNumElements(), Exceptions::RuntimeError, "Unfortunately, this is not the case, don't know what to do");
117 
118  RCP<MultiVector> coarseCoords = MultiVectorFactory::Build(coarseMap, 2);
119  ArrayRCP<Scalar> x = coarseCoords->getDataNonConst(0), y = coarseCoords->getDataNonConst(1);
120  for (size_t LID = 0; LID < coarseMap->getNodeNumElements(); ++LID) {
121  GlobalOrdinal GID = coarseMap->getGlobalElement(LID) - coarseMap->getIndexBase();
122  GlobalOrdinal i = GID % n, j = GID/n;
123  x[LID] = i;
124  y[LID] = j;
125  }
126  Set(coarseLevel, "Coordinates", coarseCoords);
127 
128  if (IsPrint(Statistics1)) {
129  RCP<ParameterList> params = rcp(new ParameterList());
130  params->set("printLoadBalancingInfo", true);
131  GetOStream(Statistics1) << PerfUtils::PrintMatrixInfo(*P, "P", params);
132  }
133  }
134 
135 
136 } //namespace MueLu
137 
138 #define MUELU_USERPFACTORY_SHORT
139 #endif // MUELU_USERPFACTORY_DEF_HPP
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
ParameterList & set(std::string const &name, T const &value, std::string const &docString="", RCP< const ParameterEntryValidator > const &validator=null)
Timer to be used in factories. Similar to Monitor but with additional timers.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
Print more statistics.
void BuildP(Level &fineLevel, Level &coarseLevel) const
Abstract Build method.
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
static RCP< const Map > ReadMap(const std::string &fileName, Xpetra::UnderlyingLib lib, const RCP< const Teuchos::Comm< int > > &comm)
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
static std::string PrintMatrixInfo(const Matrix &A, const std::string &msgTag, RCP< const Teuchos::ParameterList > params=Teuchos::null)
static void Multiply(const Matrix &A, bool transposeA, const Matrix &B, bool transposeB, Matrix &C, bool call_FillComplete_on_result=true, bool doOptimizeStorage=true, const std::string &label=std::string(), const RCP< ParameterList > &params=null)
static Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Read(const std::string &fileName, Xpetra::UnderlyingLib lib, const RCP< const Teuchos::Comm< int > > &comm, bool binary=false)
Exception throws to report errors in the internal logical of the program.