MueLu  Version of the Day
MueLu_TwoLevelMatlabFactory_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_TWOLEVELMATLABFACTORY_DEF_HPP
47 #define MUELU_TWOLEVELMATLABFACTORY_DEF_HPP
48 #include <Xpetra_Matrix.hpp>
49 #include <Xpetra_MultiVector.hpp>
50 
51 #include "MueLu_Monitor.hpp"
52 #include "MueLu_Aggregates.hpp"
53 #include "MueLu_AmalgamationInfo.hpp"
56 
57 #include <iostream>
58 
59 
60 #ifdef HAVE_MUELU_MATLAB
61 #include "mex.h"
62 
63 namespace MueLu {
64 
65  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
67  : hasDeclaredInput_(false) { }
68 
69  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
71  RCP<ParameterList> validParamList = getInputParamList();
72  validParamList->set<std::string>("Provides" , "" ,"A comma-separated list of objects provided on the coarse level by the TwoLevelMatlabFactory");
73  validParamList->set<std::string>("Needs Fine" , "", "A comma-separated list of objects needed on the fine level by the TwoLevelMatlabFactory");
74  validParamList->set<std::string>("Needs Coarse" , "", "A comma-separated list of objects needed on the coarse level by the TwoLevelMatlabFactory");
75  validParamList->set<std::string>("Function" , "" , "The name of the Matlab MEX function to call for Build()");
76  return validParamList;
77  }
78 
79  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
81  using namespace std;
82  const Teuchos::ParameterList& pL = GetParameterList();
83  // Get needs strings
84  const std::string str_nf = pL.get<std::string>("Needs Fine");
85  const std::string str_nc = pL.get<std::string>("Needs Coarse");
86  needsFine_ = tokenizeList(str_nf);
87  needsCoarse_ = tokenizeList(str_nc);
88  for(auto fineNeed : needsFine_)
89  {
90  if(!IsParamMuemexVariable(fineNeed) && fineNeed != "Level")
91  this->Input(fineLevel, fineNeed);
92  }
93  for(auto coarseNeed : needsCoarse_)
94  {
95  if(!IsParamMuemexVariable(coarseNeed) && coarseNeed != "Level")
96  this->Input(coarseLevel, coarseNeed);
97  }
98  hasDeclaredInput_ = true;
99  }
100 
101  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
103  FactoryMonitor m(*this, "Build", coarseLevel);
104 
105  const Teuchos::ParameterList& pL = GetParameterList();
106  using Teuchos::rcp;
107  using Teuchos::RCP;
108  using namespace std;
109  string needsFine = pL.get<string>("Needs Fine");
110  string needsCoarse = pL.get<string>("Needs Coarse");
111  vector<RCP<MuemexArg>> InputArgs = processNeeds<Scalar, LocalOrdinal, GlobalOrdinal, Node>(this, needsFine, fineLevel);
112  vector<RCP<MuemexArg>> InputArgsCoarse = processNeeds<Scalar, LocalOrdinal, GlobalOrdinal, Node>(this, needsCoarse, coarseLevel);
113  //Add coarse args to the end of InputArgs
114  InputArgs.reserve(InputArgs.size() + InputArgsCoarse.size());
115  InputArgs.insert(InputArgs.begin(), InputArgsCoarse.begin(), InputArgsCoarse.end());
116 
117  // Determine output
118  string provides = pL.get<string>("Provides");
119  size_t numProvides = tokenizeList(provides).size();
120  // Call mex function
121  string matlabFunction = pL.get<string>("Function");
122  if(!matlabFunction.length())
123  throw runtime_error("Invalid matlab function name");
124  vector<RCP<MuemexArg>> mexOutput = callMatlab(matlabFunction, numProvides, InputArgs);
125  processProvides<Scalar, LocalOrdinal, GlobalOrdinal, Node>(mexOutput, this, provides, coarseLevel);
126  }
127 
128  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
130  std::ostringstream out;
131  const Teuchos::ParameterList& pL = GetParameterList();
132  out << "TwoLevelMatlabFactory["<<pL.get<std::string>("Function")<<"]";
133  return out.str();
134  }
135 
136 
137 } //namespace MueLu
138 
139 #define MUELU_TWOLEVELMATLABFACTORY_SHORT
140 #endif // HAVE_MUELU_MATLAB
141 
142 #endif // MUELU_TWOLEVELMATLABFACTORY_DEF_HPP
143 
std::vector< std::string > tokenizeList(const std::string &params)
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Timer to be used in factories. Similar to Monitor but with additional timers.
Namespace for MueLu classes and methods.
virtual const Teuchos::ParameterList & GetParameterList() const
bool IsParamMuemexVariable(const std::string &name)
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Teuchos::RCP< Teuchos::ParameterList > getInputParamList()
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
std::string description() const
@ name Description
std::vector< std::string > needsFine_
List of arguments to the MATLAB function, in order. These args must correspond to MueLu "Needs" objec...
std::vector< std::string > needsCoarse_
List of arguments to the MATLAB function, in order. These args must correspond to MueLu "Needs" objec...
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
void Input(Level &level, const std::string &varName) const
std::vector< RCP< MuemexArg > > callMatlab(std::string function, int numOutputs, std::vector< RCP< MuemexArg >> args)