MueLu  Version of the Day
MueLu_TwoLevelFactoryBase.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_TWOLEVELFACTORY_HPP
47 #define MUELU_TWOLEVELFACTORY_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 
51 #include "MueLu_Factory.hpp"
52 #include "MueLu_Level.hpp"
53 #include "MueLu_TimeMonitor.hpp"
54 #include "MueLu_Utilities.hpp"
55 
56 namespace MueLu {
57 
67  class TwoLevelFactoryBase : public Factory {
68 
69  public:
70 
72 
73 
76 
79  { }
80 
82 
84 
85 
91  virtual void DeclareInput(Level &fineLevel, Level &coarseLevel) const = 0;
92 
94  virtual void CallDeclareInput(Level & requestedLevel) const {
95  if (requestedLevel.GetPreviousLevel() == Teuchos::null) {
96  std::ostringstream errStr;
97  errStr << "LevelID = " << requestedLevel.GetLevelID();
98  throw Exceptions::DependencyError(errStr.str());
99  }
100  DeclareInput(*requestedLevel.GetPreviousLevel(), requestedLevel);
101  }
102 
104 
106 
107 
108 
110  virtual void Build(Level & fineLevel, Level & coarseLevel) const = 0;
111 
113  virtual void CallBuild(Level& requestedLevel) const {
114  int levelID = requestedLevel.GetLevelID();
115 
116 #ifdef HAVE_MUELU_DEBUG
117  // We cannot call Build method twice for the same level, but we can call it multiple times for different levels
118  TEUCHOS_TEST_FOR_EXCEPTION((multipleCallCheck_ == ENABLED) && (multipleCallCheckGlobal_ == ENABLED) && (lastLevelID_ == levelID),
120  this->ShortClassName() << "::Build() called twice for the same level (levelID=" << levelID
121  << "). This is likely due to a configuration error, or calling hierarchy setup multiple times "
122  << "without resetting debug info through FactoryManager::ResetDebugData().");
123  if (multipleCallCheck_ == FIRSTCALL)
124  multipleCallCheck_ = ENABLED;
125 
126  lastLevelID_ = levelID;
127 #endif
128  TEUCHOS_TEST_FOR_EXCEPTION(requestedLevel.GetPreviousLevel() == Teuchos::null, Exceptions::RuntimeError, "LevelID = " << levelID);
129 
130  RCP<const Teuchos::Comm<int> > comm = requestedLevel.GetComm();
131  if (comm.is_null()) {
132  // Some factories are called before we constructed Ac, and therefore,
133  // before we set the level communicator. For such factories we can get
134  // the comm from the previous level, as all processes go there
135  RCP<Level>& prevLevel = requestedLevel.GetPreviousLevel();
136  if (!prevLevel.is_null())
137  comm = prevLevel->GetComm();
138  }
139 
140  int oldRank = -1;
141  if (!comm.is_null())
142  oldRank = SetProcRankVerbose(comm->getRank());
143 
144 #ifdef HAVE_MUELU_TIMER_SYNCHRONIZATION
145  // Synchronization timer
146  std::string syncTimer = this->ShortClassName() + ": Build sync (level=" + toString(requestedLevel.GetLevelID()) + ")";
147  if (!comm.is_null()) {
148  TimeMonitor timer(*this, syncTimer);
149  comm->barrier();
150  }
151 #endif
152 
153  Build(*requestedLevel.GetPreviousLevel(), requestedLevel);
154 
155 #ifdef HAVE_MUELU_TIMER_SYNCHRONIZATION
156  // Synchronization timer
157  if (!comm.is_null()) {
158  TimeMonitor timer(*this, syncTimer);
159  comm->barrier();
160  }
161 #endif
162 
164 
165  if (oldRank != -1)
166  SetProcRankVerbose(oldRank);
167  }
168 
170 
171  }; //class TwoLevelFactoryBase
172 
173 
174 } //namespace MueLu
175 
176 #define MUELU_TWOLEVELFACTORY_SHORT
177 #endif //ifndef MUELU_TWOLEVELFACTORY_HPP
RCP< Level > & GetPreviousLevel()
Previous level.
std::string toString(const T &what)
Little helper function to convert non-string types to strings.
Teuchos::FancyOStream & GetOStream(MsgType type, int thisProcRankOnly=0) const
Get an output stream for outputting the input message type.
virtual std::string ShortClassName() const
Return the class name of the object, without template parameters and without namespace.
RCP< ParameterList > RemoveFactoriesFromList(const ParameterList &list) const
Base class for factories that use two levels (fineLevel and coarseLevel).
Namespace for MueLu classes and methods.
Integrates Teuchos::TimeMonitor with MueLu verbosity system.
Print skeleton for the run, i.e. factory calls and used parameters.
int SetProcRankVerbose(int procRank) const
Set proc rank used for printing.
int GetLevelID() const
Return level number.
Definition: MueLu_Level.cpp:76
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
RCP< const Teuchos::Comm< int > > GetComm() const
virtual ~TwoLevelFactoryBase()
Destructor.
virtual const Teuchos::ParameterList & GetParameterList() const
virtual void Build(Level &fineLevel, Level &coarseLevel) const =0
Build an object with this factory.
virtual void CallDeclareInput(Level &requestedLevel) const
Exception throws to report errors in the internal logical of the program.
virtual void DeclareInput(Level &fineLevel, Level &coarseLevel) const =0
Input.
virtual void CallBuild(Level &requestedLevel) const
Exception throws to report data dependency problems between factories.