MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_SingleLevelMatlabFactory_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_SINGLELEVELMATLABFACTORY_DEF_HPP
47#define MUELU_SINGLELEVELMATLABFACTORY_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
58#ifdef HAVE_MUELU_MATLAB
59#include "mex.h"
60
61namespace MueLu {
62
63 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
65 : hasDeclaredInput_(false) { }
66
67 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
69 {
70 RCP<ParameterList> validParamList = getInputParamList();
71 validParamList->set<std::string>("Provides" , "" ,"A comma-separated list of objects provided by the SingleLevelMatlabFactory");
72 validParamList->set<std::string>("Needs" , "", "A comma-separated list of objects needed by the SingleLevelMatlabFactory");
73 validParamList->set<std::string>("Function" , "" , "The name of the Matlab MEX function to call for Build()");
74 return validParamList;
75 }
76
77 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
79 {
80 const Teuchos::ParameterList& pL = GetParameterList();
81 needs_ = tokenizeList(pL.get<std::string>("Needs"));
82 // Declare inputs
83 for(size_t i = 0; i < needs_.size(); i++)
84 {
85 if(!IsParamMuemexVariable(needs_[i]) && needs_[i] != "Level")
86 this->Input(currentLevel, needs_[i]);
87 }
88 hasDeclaredInput_ = true;
89 }
90
91 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
93 {
94 FactoryMonitor m(*this, "Build", currentLevel);
95
96 const Teuchos::ParameterList& pL = GetParameterList();
97 using Teuchos::rcp;
98 using Teuchos::rcp;
99 using namespace std;
100 // NOTE: mexOutput[0] is the "Provides." Might want to modify to allow for additional outputs
101 string needsList = pL.get<string>("Needs");
102 vector<RCP<MuemexArg>> InputArgs = processNeeds<Scalar, LocalOrdinal, GlobalOrdinal, Node>(this, needsList, currentLevel);
103 string providesList = pL.get<std::string>("Provides");
104 size_t numProvides = tokenizeList(providesList).size();
105 // Call mex function
106 string matlabFunction = pL.get<std::string>("Function");
107 if(!matlabFunction.length())
108 throw std::runtime_error("Invalid matlab function name");
109 vector<Teuchos::RCP<MuemexArg> > mexOutput = callMatlab(matlabFunction, numProvides, InputArgs);
110 // Set output in level
111 processProvides<Scalar, LocalOrdinal, GlobalOrdinal, Node>(mexOutput, this, providesList, currentLevel);
112 }
113
114 template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
116 std::ostringstream out;
117 const Teuchos::ParameterList& pL = GetParameterList();
118 out << "SingleLevelMatlabFactory["<<pL.get<std::string>("Function")<<"]";
119 return out.str();
120 }
121
122
123} //namespace MueLu
124
125#define MUELU_SINGLELEVELMATLABFACTORY_SHORT
126#endif // HAVE_MUELU_MATLAB
127
128#endif // MUELU_SINGLELEVELMATLABFACTORY_DEF_HPP
129
Timer to be used in factories. Similar to Monitor but with additional timers.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
std::string description() const
@ name Description
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
void Build(Level &currentLevel) const
Build an object with this factory.
Namespace for MueLu classes and methods.
bool IsParamMuemexVariable(const std::string &name)
Teuchos::RCP< Teuchos::ParameterList > getInputParamList()
std::vector< RCP< MuemexArg > > callMatlab(std::string function, int numOutputs, std::vector< RCP< MuemexArg > > args)
std::vector< std::string > tokenizeList(const std::string &params)