MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_AvatarInterface.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_AVATARINTERFACE_HPP
47 #define MUELU_AVATARINTERFACE_HPP
48 
49 #include <string>
50 #include "Teuchos_Comm.hpp"
51 #include "Teuchos_RCP.hpp"
52 #include "Teuchos_ArrayRCP.hpp"
54 #include "MueLu_BaseClass.hpp"
55 
56 
57 #ifdef HAVE_MUELU_AVATAR
58 
59 
60 // Forward declaration
61 struct Avatar_struct;
62 typedef struct Avatar_struct Avatar_handle;
63 
64 namespace MueLu {
65 
72  class AvatarInterface : public BaseClass {
73 
74  public:
75 
76  AvatarInterface(Teuchos::RCP<const Teuchos::Comm<int> >& comm ):comm_(comm) {}
77 
78  AvatarInterface(Teuchos::RCP<const Teuchos::Comm<int> >& comm, Teuchos::ParameterList& inParams):comm_(comm),params_(inParams){};
79 
80  Teuchos::RCP<const Teuchos::ParameterList> GetValidParameterList() const;
81 
82  // Sets the input parameters for the AvatarInterface
83  void SetParameterList(Teuchos::ParameterList& inParams) {params_ = inParams;}
84 
85  // Sets up Avatar
86  void Setup();
87 
88  // Calls Avatar to set MueLu Parameters
89  void SetMueLuParameters(const Teuchos::ParameterList & problemFeatures, Teuchos::ParameterList & mueluParams, bool overwrite=true) const;
90 
91  // Clean up the handle
92  void Cleanup();
93 
94  // Returns 1 if the given parameters are within same
95  // same domain as training data, 0 otherwise
96  int checkBounds(std::string trialString, Teuchos::ArrayRCP<std::string> boundsString) const;
97 
98  int hybrid(float * probabilities, std::vector<int> acceptableCombos) const;
99 
100  int highProb(float * probabilities, std::vector<int> acceptableCombos) const;
101 
102  int lowCrash(float * probabilities, std::vector<int> acceptableCombos) const;
103 
104  int weighted(float * probabilities, std::vector<int> acceptableCombos) const;
105 
106  private:
107  // Utility functions
108  Teuchos::ArrayRCP<std::string> ReadFromFiles(const char * param_name) const;
109  void GenerateFeatureString(const Teuchos::ParameterList & problemFeatures, std::string & featureString) const;
110  std::string ParamsToString(const std::vector<int> & indices) const;
111  void SetIndices(int id,std::vector<int> & indices) const;
112  void GenerateMueLuParametersFromIndex(int id,Teuchos::ParameterList & pl) const;
113  void UnpackMueLuMapping();
114 
115  // Cached data
117  mutable Teuchos::ParameterList params_; // The mutable is a hack to deal with issues in Teuchos
118  Teuchos::ArrayRCP<std::string> avatarStrings_;
119  Teuchos::ArrayRCP<std::string> namesStrings_;
120  Teuchos::Array<std::string> filestem_;
121  Teuchos::ArrayRCP<std::string> boundsString_;
122  int avatarGoodClass_;
123  int heuristicToUse_;
124 
125  // RCP's don't handle opaque pointers well
126  Avatar_handle * avatarHandle_;
127 
128  Teuchos::Array<std::string> mueluParameterName_;
129  Teuchos::Array<std::string> avatarParameterName_;
130 
131  Teuchos::ArrayRCP<Teuchos::Array<double> > mueluParameterValues_;
132  Teuchos::ArrayRCP<Teuchos::Array<double> > avatarParameterValues_;
133 
134  };
135 
136 
137 } // namespace MueLu
138 
139 #endif// HAVE_MUELU_AVATAR
140 
141 #endif // MUELU_AVATARINTERFACE_HPP