MueLu  Version of the Day
MueLu_UzawaSmoother_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 /*
47  * MueLu_UzawaSmoother_def.hpp
48  *
49  * Created on: 13 May 2014
50  * Author: wiesner
51  */
52 
53 #ifndef MUELU_UZAWASMOOTHER_DEF_HPP_
54 #define MUELU_UZAWASMOOTHER_DEF_HPP_
55 
56 #include "Teuchos_ArrayViewDecl.hpp"
57 #include "Teuchos_ScalarTraits.hpp"
58 
59 #include "MueLu_ConfigDefs.hpp"
60 
61 #include <Xpetra_Matrix.hpp>
62 #include <Xpetra_CrsMatrixWrap.hpp>
63 #include <Xpetra_BlockedCrsMatrix.hpp>
64 #include <Xpetra_MultiVectorFactory.hpp>
65 #include <Xpetra_VectorFactory.hpp>
66 
68 #include "MueLu_Level.hpp"
69 #include "MueLu_Utilities.hpp"
70 #include "MueLu_Monitor.hpp"
71 #include "MueLu_HierarchyHelpers.hpp"
72 #include "MueLu_SmootherBase.hpp"
73 #include "MueLu_SubBlockAFactory.hpp"
74 
75 // include files for default FactoryManager
76 #include "MueLu_SchurComplementFactory.hpp"
77 #include "MueLu_DirectSolver.hpp"
78 #include "MueLu_SmootherFactory.hpp"
79 #include "MueLu_FactoryManager.hpp"
80 
81 namespace MueLu {
82 
83  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
85  : type_("Uzawa"), A_(Teuchos::null)
86  {
87  }
88 
89  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
91 
92  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
94  RCP<ParameterList> validParamList = rcp(new ParameterList());
95 
96  validParamList->set< RCP<const FactoryBase> >("A", Teuchos::null, "Generating factory of the matrix A");
97  validParamList->set< Scalar > ("Damping factor", 1.0, "Damping/Scaling factor in SIMPLE");
98  validParamList->set< LocalOrdinal > ("Sweeps", 1, "Number of SIMPLE sweeps (default = 1)");
99 
100  return validParamList;
101  }
102 
104  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
105  void UzawaSmoother<Scalar, LocalOrdinal, GlobalOrdinal, Node>::AddFactoryManager(RCP<const FactoryManagerBase> FactManager, int pos) {
106  TEUCHOS_TEST_FOR_EXCEPTION(pos < 0, Exceptions::RuntimeError, "MueLu::UzawaSmoother::AddFactoryManager: parameter \'pos\' must not be negative! error.");
107 
108  size_t myPos = Teuchos::as<size_t>(pos);
109 
110  if (myPos < FactManager_.size()) {
111  // replace existing entris in FactManager_ vector
112  FactManager_.at(myPos) = FactManager;
113  } else if( myPos == FactManager_.size()) {
114  // add new Factory manager in the end of the vector
115  FactManager_.push_back(FactManager);
116  } else { // if(myPos > FactManager_.size())
117  RCP<Teuchos::FancyOStream> out = Teuchos::fancyOStream(Teuchos::rcpFromRef(std::cout));
118  *out << "Warning: cannot add new FactoryManager at proper position " << pos << ". The FactoryManager is just appended to the end. Check this!" << std::endl;
119 
120  // add new Factory manager in the end of the vector
121  FactManager_.push_back(FactManager);
122  }
123 
124  }
125 
126 
127  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
129  AddFactoryManager(FactManager, 0); // overwrite factory manager for predicting the primary variable
130  }
131 
132  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
134  AddFactoryManager(FactManager, 1); // overwrite factory manager for SchurComplement
135  }
136 
137  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
139  currentLevel.DeclareInput("A",this->GetFactory("A").get());
140 
141  TEUCHOS_TEST_FOR_EXCEPTION(FactManager_.size() != 2, Exceptions::RuntimeError,"MueLu::UzawaSmoother::DeclareInput: You have to declare two FactoryManagers with a \"Smoother\" object: One for predicting the primary variable and one for the SchurComplement system. The smoother for the SchurComplement system needs a SchurComplementFactory as input for variable \"A\". make sure that you use the same proper damping factors for omega both in the SchurComplementFactory and in the SIMPLE smoother!");
142 
143  // loop over all factory managers for the subblocks of blocked operator A
144  std::vector<Teuchos::RCP<const FactoryManagerBase> >::const_iterator it;
145  for(it = FactManager_.begin(); it!=FactManager_.end(); ++it) {
146  SetFactoryManager currentSFM (rcpFromRef(currentLevel), *it);
147 
148  // request "Smoother" for current subblock row.
149  currentLevel.DeclareInput("PreSmoother",(*it)->GetFactory("Smoother").get());
150  }
151  }
152 
153  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
155 
156  FactoryMonitor m(*this, "Setup blocked Uzawa Smoother", currentLevel);
157 
158  if (SmootherPrototype::IsSetup() == true)
159  this->GetOStream(Warnings0) << "MueLu::UzawaSmoother::Setup(): Setup() has already been called";
160 
161  // extract blocked operator A from current level
162  A_ = Factory::Get<RCP<Matrix> > (currentLevel, "A");
163 
164  RCP<BlockedCrsMatrix> bA = Teuchos::rcp_dynamic_cast<BlockedCrsMatrix>(A_);
165  TEUCHOS_TEST_FOR_EXCEPTION(bA == Teuchos::null, Exceptions::BadCast, "MueLu::UzawaSmoother::Setup: input matrix A is not of type BlockedCrsMatrix! error.");
166 
167  // store map extractors
168  rangeMapExtractor_ = bA->getRangeMapExtractor();
169  domainMapExtractor_ = bA->getDomainMapExtractor();
170 
171  // Store the blocks in local member variables
172  Teuchos::RCP<CrsMatrix> A00 = bA->getMatrix(0, 0);
173  Teuchos::RCP<CrsMatrix> A01 = bA->getMatrix(0, 1);
174  Teuchos::RCP<CrsMatrix> A10 = bA->getMatrix(1, 0);
175  Teuchos::RCP<CrsMatrix> A11 = bA->getMatrix(1, 1);
176 
177  Teuchos::RCP<CrsMatrixWrap> Op00 = Teuchos::rcp(new CrsMatrixWrap(A00));
178  Teuchos::RCP<CrsMatrixWrap> Op01 = Teuchos::rcp(new CrsMatrixWrap(A01));
179  Teuchos::RCP<CrsMatrixWrap> Op10 = Teuchos::rcp(new CrsMatrixWrap(A10));
180  Teuchos::RCP<CrsMatrixWrap> Op11 = Teuchos::rcp(new CrsMatrixWrap(A11));
181 
182  F_ = Teuchos::rcp_dynamic_cast<Matrix>(Op00);
183  G_ = Teuchos::rcp_dynamic_cast<Matrix>(Op01);
184  D_ = Teuchos::rcp_dynamic_cast<Matrix>(Op10);
185  Z_ = Teuchos::rcp_dynamic_cast<Matrix>(Op11);
186 
187  // TODO move this to BlockedCrsMatrix->getMatrix routine...
188  F_->CreateView("stridedMaps", bA->getRangeMap(0), bA->getDomainMap(0));
189  G_->CreateView("stridedMaps", bA->getRangeMap(0), bA->getDomainMap(1));
190  D_->CreateView("stridedMaps", bA->getRangeMap(1), bA->getDomainMap(0));
191  Z_->CreateView("stridedMaps", bA->getRangeMap(1), bA->getDomainMap(1));
192 
193  // Set the Smoother
194  // carefully switch to the SubFactoryManagers (defined by the users)
195  {
196  RCP<const FactoryManagerBase> velpredictFactManager = FactManager_.at(0);
197  SetFactoryManager currentSFM (rcpFromRef(currentLevel), velpredictFactManager);
198  velPredictSmoo_ = currentLevel.Get< RCP<SmootherBase> >("PreSmoother",velpredictFactManager->GetFactory("Smoother").get());
199  }
200  {
201  RCP<const FactoryManagerBase> schurFactManager = FactManager_.at(1);
202  SetFactoryManager currentSFM (rcpFromRef(currentLevel), schurFactManager);
203  schurCompSmoo_ = currentLevel.Get< RCP<SmootherBase> >("PreSmoother", schurFactManager->GetFactory("Smoother").get());
204  }
205 
207  }
208 
209  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
210  void UzawaSmoother<Scalar, LocalOrdinal, GlobalOrdinal, Node>::Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero) const
211  {
212  TEUCHOS_TEST_FOR_EXCEPTION(SmootherPrototype::IsSetup() == false, Exceptions::RuntimeError, "MueLu::UzawaSmoother::Apply(): Setup() has not been called");
213 
214  Teuchos::RCP<Teuchos::FancyOStream> fos = Teuchos::getFancyOStream(Teuchos::rcpFromRef(std::cout));
215 
216  SC zero = Teuchos::ScalarTraits<SC>::zero(), one = Teuchos::ScalarTraits<SC>::one();
217 
218  // extract parameters from internal parameter list
219  const ParameterList & pL = Factory::GetParameterList();
220  LocalOrdinal nSweeps = pL.get<LocalOrdinal>("Sweeps");
221  Scalar omega = pL.get<Scalar>("Damping factor");
222 
223  // wrap current solution vector in RCP
224  RCP<MultiVector> rcpX = Teuchos::rcpFromRef(X);
225 
226  // create residual vector
227  // contains current residual of current solution X with rhs B
228  RCP<MultiVector> residual = MultiVectorFactory::Build(B.getMap(), B.getNumVectors());
229 
230  // incrementally improve solution vector X
231  for (LocalOrdinal run = 0; run < nSweeps; ++run) {
232  // 1) calculate current residual
233  residual->update(one,B,zero); // residual = B
234  A_->apply(*rcpX, *residual, Teuchos::NO_TRANS, -one, one);
235 
236  // split residual vector
237  Teuchos::RCP<MultiVector> r1 = rangeMapExtractor_->ExtractVector(residual, 0);
238  Teuchos::RCP<MultiVector> r2 = rangeMapExtractor_->ExtractVector(residual, 1);
239 
240  // 2) solve F * \Delta \tilde{x}_1 = r_1
241  // start with zero guess \Delta \tilde{x}_1
242  RCP<MultiVector> xtilde1 = MultiVectorFactory::Build(F_->getRowMap(),1);
243  xtilde1->putScalar(zero);
244  velPredictSmoo_->Apply(*xtilde1,*r1);
245 
246  // 3) calculate rhs for SchurComp equation
247  // r_2 - D \Delta \tilde{x}_1
248  RCP<MultiVector> schurCompRHS = MultiVectorFactory::Build(Z_->getRowMap(),1);
249  D_->apply(*xtilde1,*schurCompRHS);
250  schurCompRHS->update(one,*r2,-one);
251 
252  // 4) solve SchurComp equation
253  // start with zero guess \Delta \tilde{x}_2
254  RCP<MultiVector> xtilde2 = MultiVectorFactory::Build(Z_->getRowMap(),1);
255  xtilde2->putScalar(zero);
256  schurCompSmoo_->Apply(*xtilde2,*schurCompRHS);
257 
258  // 5) extract parts of solution vector X
259  Teuchos::RCP<MultiVector> x1 = domainMapExtractor_->ExtractVector(rcpX, 0);
260  Teuchos::RCP<MultiVector> x2 = domainMapExtractor_->ExtractVector(rcpX, 1);
261 
262  // 6) update solution vector with increments xhat1 and xhat2
263  // rescale increment for x2 with omega_
264  x1->update(omega,*xtilde1,one); // x1 = x1_old + omega xtilde1
265  x2->update(omega,*xtilde2,one); // x2 = x2_old + omega xtilde2
266 
267  // write back solution in global vector X
268  domainMapExtractor_->InsertVector(x1, 0, rcpX);
269  domainMapExtractor_->InsertVector(x2, 1, rcpX);
270 
271  }
272  }
273 
274  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
275  RCP<MueLu::SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
277  return rcp( new UzawaSmoother(*this) );
278  }
279 
280  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
282  std::ostringstream out;
284  out << "{type = " << type_ << "}";
285  return out.str();
286  }
287 
288  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
289  void UzawaSmoother<Scalar, LocalOrdinal, GlobalOrdinal, Node>::print(Teuchos::FancyOStream &out, const VerbLevel verbLevel) const {
291 
292  if (verbLevel & Parameters0) {
293  out0 << "Prec. type: " << type_ << /*" Sweeps: " << nSweeps_ << " damping: " << omega_ <<*/ std::endl;
294  }
295 
296  if (verbLevel & Debug) {
297  out0 << "IsSetup: " << Teuchos::toString(SmootherPrototype::IsSetup()) << std::endl;
298  }
299  }
300 
301 } // namespace MueLu
302 
303 
304 #endif /* MUELU_UZAWASMOOTHER_DEF_HPP_ */
Important warning messages (one line)
Exception indicating invalid cast attempted.
void Setup(Level &currentLevel)
Setup routine.
std::string toString(const T &what)
Little helper function to convert non-string types to strings.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
Timer to be used in factories. Similar to Monitor but with additional timers.
Print additional debugging information.
Teuchos::RCP< Matrix > D_
divergence operator
RCP< const MapExtractorClass > domainMapExtractor_
domain map extractor (from A_ generated by AFact)
Namespace for MueLu classes and methods.
virtual const Teuchos::ParameterList & GetParameterList() const
void DeclareInput(Level &currentLevel) const
Input.
void Apply(MultiVector &X, MultiVector const &B, bool InitialGuessIsZero=false) const
Apply the Braess Sarazin smoother.
RCP< const ParameterList > GetValidParameterList() const
Input.
RCP< const MapExtractorClass > rangeMapExtractor_
range map extractor (from A_ generated by AFact)
void SetVelocityPredictionFactoryManager(RCP< FactoryManager > FactManager)
Teuchos::RCP< Matrix > F_
fluid operator
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
RCP< Matrix > A_
block operator
std::string description() const
Return a simple one-line description of this object.
RCP< SmootherPrototype > Copy() const
bool IsSetup() const
Get the state of a smoother prototype.
Teuchos::RCP< Matrix > Z_
pressure stabilization term or null block
#define MUELU_DESCRIBE
Helper macro for implementing Describable::describe() for BaseClass objects.
std::vector< Teuchos::RCP< const FactoryManagerBase > > FactManager_
vector of factory managers
Teuchos::RCP< SmootherBase > schurCompSmoo_
smoother for SchurComplement equation
Teuchos::FancyOStream & GetOStream(MsgType type, int thisProcRankOnly=0) const
Get an output stream for outputting the input message type.
Print class parameters.
void SetSchurCompFactoryManager(RCP< FactoryManager > FactManager)
Teuchos::RCP< Matrix > G_
pressure gradient operator
Teuchos::RCP< SmootherBase > velPredictSmoo_
smoother for velocity prediction
std::string type_
smoother type
void AddFactoryManager(RCP< const FactoryManagerBase > FactManager, int pos)
Add a factory manager at a specific position.
Exception throws to report errors in the internal logical of the program.
An exception safe way to call the method &#39;Level::SetFactoryManager()&#39;.
void DeclareInput(const std::string &ename, const FactoryBase *factory, const FactoryBase *requestedBy=NoFactory::get())
Callback from FactoryBase::CallDeclareInput() and FactoryBase::DeclareInput()
virtual ~UzawaSmoother()
Destructor.
virtual std::string description() const
Return a simple one-line description of this object.
const RCP< const FactoryBase > GetFactory(const std::string &varName) const
Default implementation of FactoryAcceptor::GetFactory()