MueLu  Version of the Day
MueLu_IndefBlockedDiagonalSmoother_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_IndefBlockedDiagonalSmoother_def.hpp
48  *
49  * Created on: 13 May 2014
50  * Author: wiesner
51  */
52 
53 #ifndef MUELU_INDEFBLOCKEDDIAGONALSMOOTHER_DEF_HPP_
54 #define MUELU_INDEFBLOCKEDDIAGONALSMOOTHER_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_("IndefiniteBlockDiagonalSmoother"), 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 (must be a 2x2 block matrix)");
97  validParamList->set< Scalar > ("Damping factor", 1.0, "Damping/Scaling factor");
98  validParamList->set< LocalOrdinal > ("Sweeps", 1, "Number of SIMPLE sweeps (default = 1)");
99  //validParamList->set< bool > ("UseSIMPLEC", false, "Use SIMPLEC instead of SIMPLE (default = false)");
100 
101  return validParamList;
102  }
103 
105  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
107  TEUCHOS_TEST_FOR_EXCEPTION(pos < 0, Exceptions::RuntimeError, "MueLu::IndefBlockedDiagonalSmoother::AddFactoryManager: parameter \'pos\' must not be negative! error.");
108 
109  size_t myPos = Teuchos::as<size_t>(pos);
110 
111  if (myPos < FactManager_.size()) {
112  // replace existing entris in FactManager_ vector
113  FactManager_.at(myPos) = FactManager;
114  } else if( myPos == FactManager_.size()) {
115  // add new Factory manager in the end of the vector
116  FactManager_.push_back(FactManager);
117  } else { // if(myPos > FactManager_.size())
118  RCP<Teuchos::FancyOStream> out = Teuchos::fancyOStream(Teuchos::rcpFromRef(std::cout));
119  *out << "Warning: cannot add new FactoryManager at proper position " << pos << ". The FactoryManager is just appended to the end. Check this!" << std::endl;
120 
121  // add new Factory manager in the end of the vector
122  FactManager_.push_back(FactManager);
123  }
124  }
125 
126  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
128  currentLevel.DeclareInput("A",this->GetFactory("A").get());
129 
130  TEUCHOS_TEST_FOR_EXCEPTION(FactManager_.size() != 2, Exceptions::RuntimeError,"MueLu::IndefBlockedDiagonalSmoother::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\"!");
131 
132  // loop over all factory managers for the subblocks of blocked operator A
133  std::vector<Teuchos::RCP<const FactoryManagerBase> >::const_iterator it;
134  for(it = FactManager_.begin(); it!=FactManager_.end(); ++it) {
135  SetFactoryManager currentSFM (rcpFromRef(currentLevel), *it);
136 
137  // request "Smoother" for current subblock row.
138  currentLevel.DeclareInput("PreSmoother",(*it)->GetFactory("Smoother").get());
139  }
140 
141  }
142 
143  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
145  FactoryMonitor m(*this, "Setup for indefinite blocked diagonal smoother", currentLevel);
146 
147  if (SmootherPrototype::IsSetup() == true)
148  this->GetOStream(Warnings0) << "MueLu::IndefBlockedDiagonalSmoother::Setup(): Setup() has already been called";
149 
150  // extract blocked operator A from current level
151  A_ = Factory::Get<RCP<Matrix> > (currentLevel, "A");
152 
153  RCP<BlockedCrsMatrix> bA = Teuchos::rcp_dynamic_cast<BlockedCrsMatrix>(A_);
154  TEUCHOS_TEST_FOR_EXCEPTION(bA == Teuchos::null, Exceptions::BadCast, "MueLu::IndefBlockedDiagonalSmoother::Setup: input matrix A is not of type BlockedCrsMatrix! error.");
155 
156  // store map extractors
157  rangeMapExtractor_ = bA->getRangeMapExtractor();
158  domainMapExtractor_ = bA->getDomainMapExtractor();
159 
160  // Store the blocks in local member variables
161  Teuchos::RCP<CrsMatrix> A00 = bA->getMatrix(0, 0);
162  Teuchos::RCP<CrsMatrix> A01 = bA->getMatrix(0, 1);
163  Teuchos::RCP<CrsMatrix> A10 = bA->getMatrix(1, 0);
164  Teuchos::RCP<CrsMatrix> A11 = bA->getMatrix(1, 1);
165 
166  Teuchos::RCP<CrsMatrixWrap> Op00 = Teuchos::rcp(new CrsMatrixWrap(A00));
167  Teuchos::RCP<CrsMatrixWrap> Op01 = Teuchos::rcp(new CrsMatrixWrap(A01));
168  Teuchos::RCP<CrsMatrixWrap> Op10 = Teuchos::rcp(new CrsMatrixWrap(A10));
169  Teuchos::RCP<CrsMatrixWrap> Op11 = Teuchos::rcp(new CrsMatrixWrap(A11));
170 
171  F_ = Teuchos::rcp_dynamic_cast<Matrix>(Op00);
172  //G_ = Teuchos::rcp_dynamic_cast<Matrix>(Op01);
173  //D_ = Teuchos::rcp_dynamic_cast<Matrix>(Op10);
174  Z_ = Teuchos::rcp_dynamic_cast<Matrix>(Op11);
175 
176  // TODO move this to BlockedCrsMatrix->getMatrix routine...
177  F_->CreateView("stridedMaps", bA->getRangeMap(0), bA->getDomainMap(0));
178  //G_->CreateView("stridedMaps", bA->getRangeMap(0), bA->getDomainMap(1));
179  //D_->CreateView("stridedMaps", bA->getRangeMap(1), bA->getDomainMap(0));
180  Z_->CreateView("stridedMaps", bA->getRangeMap(1), bA->getDomainMap(1));
181 
182  /*const ParameterList & pL = Factory::GetParameterList();
183  bool bSIMPLEC = pL.get<bool>("UseSIMPLEC");
184 
185  // Create the inverse of the diagonal of F
186  RCP<Vector> diagFVector = VectorFactory::Build(F_->getRowMap());
187  if(!bSIMPLEC) {
188  F_->getLocalDiagCopy(*diagFVector); // extract diagonal of F
189  diagFVector->reciprocal(*diagFVector); // build reciprocal
190  } else {
191  const RCP<const Map> rowmap = F_->getRowMap();
192  size_t locSize = rowmap->getNodeNumElements();
193  Teuchos::ArrayRCP<SC> diag = diagFVector->getDataNonConst(0);
194  Teuchos::ArrayView<const LO> cols;
195  Teuchos::ArrayView<const SC> vals;
196  for (size_t i=0; i<locSize; ++i) { // loop over rows
197  F_->getLocalRowView(i,cols,vals);
198  Scalar absRowSum = Teuchos::ScalarTraits<Scalar>::zero();
199  for (LO j=0; j<cols.size(); ++j) { // loop over cols
200  absRowSum += Teuchos::ScalarTraits<Scalar>::magnitude(vals[j]);
201  }
202  diag[i] = absRowSum;
203  }
204  diagFVector->reciprocal(*diagFVector); // build reciprocal
205  }
206  diagFinv_ = diagFVector;*/
207 
208  // Set the Smoother
209  // carefully switch to the SubFactoryManagers (defined by the users)
210  {
211  RCP<const FactoryManagerBase> velpredictFactManager = FactManager_.at(0);
212  SetFactoryManager currentSFM (rcpFromRef(currentLevel), velpredictFactManager);
213  velPredictSmoo_ = currentLevel.Get< RCP<SmootherBase> >("PreSmoother",velpredictFactManager->GetFactory("Smoother").get());
214  }
215  {
216  RCP<const FactoryManagerBase> schurFactManager = FactManager_.at(1);
217  SetFactoryManager currentSFM (rcpFromRef(currentLevel), schurFactManager);
218  schurCompSmoo_ = currentLevel.Get< RCP<SmootherBase> >("PreSmoother", schurFactManager->GetFactory("Smoother").get());
219  }
221  }
222 
223  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
224  void IndefBlockedDiagonalSmoother<Scalar, LocalOrdinal, GlobalOrdinal, Node>::Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero) const
225  {
226  TEUCHOS_TEST_FOR_EXCEPTION(SmootherPrototype::IsSetup() == false, Exceptions::RuntimeError, "MueLu::IndefBlockedDiagonalSmoother::Apply(): Setup() has not been called");
227 
228  Teuchos::RCP<Teuchos::FancyOStream> fos = Teuchos::getFancyOStream(Teuchos::rcpFromRef(std::cout));
229 
230  SC zero = Teuchos::ScalarTraits<SC>::zero(), one = Teuchos::ScalarTraits<SC>::one();
231 
232  // extract parameters from internal parameter list
233  const ParameterList & pL = Factory::GetParameterList();
234  LocalOrdinal nSweeps = pL.get<LocalOrdinal>("Sweeps");
235  Scalar omega = pL.get<Scalar>("Damping factor");
236 
237  // wrap current solution vector in RCP
238  RCP<MultiVector> rcpX = Teuchos::rcpFromRef(X);
239 
240  // create residual vector
241  // contains current residual of current solution X with rhs B
242  RCP<MultiVector> residual = MultiVectorFactory::Build(B.getMap(), B.getNumVectors());
243 
244  // incrementally improve solution vector X
245  for (LocalOrdinal run = 0; run < nSweeps; ++run) {
246  // 1) calculate current residual
247  residual->update(one,B,zero); // residual = B
248  A_->apply(*rcpX, *residual, Teuchos::NO_TRANS, -one, one);
249 
250  // split residual vector
251  Teuchos::RCP<MultiVector> r1 = rangeMapExtractor_->ExtractVector(residual, 0);
252  Teuchos::RCP<MultiVector> r2 = rangeMapExtractor_->ExtractVector(residual, 1);
253 
254  // 2) solve F * \Delta \tilde{x}_1 = r_1
255  // start with zero guess \Delta \tilde{x}_1
256  RCP<MultiVector> xtilde1 = MultiVectorFactory::Build(F_->getRowMap(),1);
257  xtilde1->putScalar(zero);
258  velPredictSmoo_->Apply(*xtilde1,*r1);
259 
260  // 3) solve SchurComp equation
261  // start with zero guess \Delta \tilde{x}_2
262  RCP<MultiVector> xtilde2 = MultiVectorFactory::Build(Z_->getRowMap(),1);
263  xtilde2->putScalar(zero);
264  schurCompSmoo_->Apply(*xtilde2,*r2);
265 
266  // 4) extract parts of solution vector X
267  Teuchos::RCP<MultiVector> x1 = domainMapExtractor_->ExtractVector(rcpX, 0);
268  Teuchos::RCP<MultiVector> x2 = domainMapExtractor_->ExtractVector(rcpX, 1);
269 
270  // 5) update solution vector with increments xhat1 and xhat2
271  // rescale increment for x2 with omega_
272  x1->update(omega,*xtilde1,one); // x1 = x1_old + omega xtilde1
273  x2->update(omega,*xtilde2,one); // x2 = x2_old + omega xtilde2
274 
275  // write back solution in global vector X
276  domainMapExtractor_->InsertVector(x1, 0, rcpX);
277  domainMapExtractor_->InsertVector(x2, 1, rcpX);
278 
279  }
280 
281  }
282 
283  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
284  RCP<MueLu::SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal, Node> >
286  return rcp( new IndefBlockedDiagonalSmoother(*this) );
287  }
288 
289  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
291  std::ostringstream out;
293  out << "{type = " << type_ << "}";
294  return out.str();
295  }
296 
297  template <class Scalar,class LocalOrdinal, class GlobalOrdinal, class Node>
298  void IndefBlockedDiagonalSmoother<Scalar, LocalOrdinal, GlobalOrdinal, Node>::print(Teuchos::FancyOStream &out, const VerbLevel verbLevel) const {
300 
301  if (verbLevel & Parameters0) {
302  out0 << "Prec. type: " << type_ << /*" Sweeps: " << nSweeps_ << " damping: " << omega_ <<*/ std::endl;
303  }
304 
305  if (verbLevel & Debug) {
306  out0 << "IsSetup: " << Teuchos::toString(SmootherPrototype::IsSetup()) << std::endl;
307  }
308  }
309 
310 } // namespace MueLu
311 
312 #endif /* MUELU_INDEFBLOCKEDDIAGONALSMOOTHER_DEF_HPP_ */
Important warning messages (one line)
Exception indicating invalid cast attempted.
std::string description() const
Return a simple one-line description of this object.
std::vector< Teuchos::RCP< const FactoryManagerBase > > FactManager_
vector of factory managers
std::string toString(const T &what)
Little helper function to convert non-string types to strings.
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply the Braess Sarazin smoother.
Timer to be used in factories. Similar to Monitor but with additional timers.
Print additional debugging information.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
Namespace for MueLu classes and methods.
virtual const Teuchos::ParameterList & GetParameterList() const
void DeclareInput(Level &currentLevel) const
Input.
RCP< const MapExtractorClass > rangeMapExtractor_
range map extractor (from A_ generated by AFact)
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
RCP< const ParameterList > GetValidParameterList() const
Input.
bool IsSetup() const
Get the state of a smoother prototype.
RCP< Matrix > Z_
pressure stabilization term or null block
#define MUELU_DESCRIBE
Helper macro for implementing Describable::describe() for BaseClass objects.
Teuchos::FancyOStream & GetOStream(MsgType type, int thisProcRankOnly=0) const
Get an output stream for outputting the input message type.
Print class parameters.
Teuchos::RCP< SmootherBase > velPredictSmoo_
Block smoothers.
Teuchos::RCP< SmootherBase > schurCompSmoo_
smoother for SchurComplement equation
void AddFactoryManager(RCP< const FactoryManagerBase > FactManager, int pos=0)
Add a factory manager for BraessSarazin internal SchurComplement handling.
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()
RCP< const MapExtractorClass > domainMapExtractor_
domain map extractor (from A_ generated by AFact)
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()