Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_DiagonalPreconditionerOp.cpp
1 /*
2 // @HEADER
3 //
4 // ***********************************************************************
5 //
6 // Teko: A package for block and physics based preconditioning
7 // Copyright 2010 Sandia Corporation
8 //
9 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
10 // the U.S. Government retains certain rights in this software.
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are
14 // met:
15 //
16 // 1. Redistributions of source code must retain the above copyright
17 // notice, this list of conditions and the following disclaimer.
18 //
19 // 2. Redistributions in binary form must reproduce the above copyright
20 // notice, this list of conditions and the following disclaimer in the
21 // documentation and/or other materials provided with the distribution.
22 //
23 // 3. Neither the name of the Corporation nor the names of the
24 // contributors may be used to endorse or promote products derived from
25 // this software without specific prior written permission.
26 //
27 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 //
39 // Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
40 //
41 // ***********************************************************************
42 //
43 // @HEADER
44 
45 */
46 
47 #include "Teko_DiagonalPreconditionerOp.hpp"
48 #include "Thyra_EpetraThyraWrappers.hpp"
49 #include "EpetraExt_PointToBlockDiagPermute.h"
50 #include "Epetra_MultiVector.h"
51 
52 using Teuchos::rcpFromRef;
53 using Teuchos::rcp_dynamic_cast;
54 using Teuchos::rcp_const_cast;
55 using Teuchos::RCP;
56 
57 using Thyra::MultiVectorBase;
58 
59 namespace Teko {
60 
61 DiagonalPreconditionerOp::DiagonalPreconditionerOp(Teuchos::RCP<EpetraExt_PointToBlockDiagPermute> BDP, const VectorSpace range, const VectorSpace domain):
62  BDP_(BDP),
63  range_(range),
64  domain_(domain)
65 {}
66 
67 void DiagonalPreconditionerOp::implicitApply(const MultiVector & x, MultiVector & y,
68  const double alpha, const double beta) const
69 {
70  // Get the Multivectors into Epetra land
71  // NTS: Thyra inexplicably wants maps, even when they are completely unecessary.
72  const Epetra_Map & rangemap_=BDP_->OperatorRangeMap();
73  const Epetra_Map & domainmap_=BDP_->OperatorDomainMap();
74 
75  RCP<const Epetra_MultiVector> x_=Thyra::get_Epetra_MultiVector(domainmap_,x);
76  RCP<Epetra_MultiVector> y_=Thyra::get_Epetra_MultiVector(rangemap_,y);
77  TEUCHOS_ASSERT(x_!=Teuchos::null);
78  TEUCHOS_ASSERT(y_!=Teuchos::null);
79 
80 
81  // y = \alpha M x + \beta y $
82  if(beta==0.0){
83  BDP_->ApplyInverse(*x_,*y_);
84  scale(alpha,y);
85  }
86  else{
87  MultiVector y0=deepcopy(y);
88  BDP_->ApplyInverse(*x_,*y_);
89  update(alpha,y,beta,y0);
90  }
91 }
92 
93 void DiagonalPreconditionerOp::describe(Teuchos::FancyOStream & out_arg,
94  const Teuchos::EVerbosityLevel verbLevel) const
95 {
96  using Teuchos::OSTab;
97 
98  switch(verbLevel) {
99  case Teuchos::VERB_DEFAULT:
100  case Teuchos::VERB_LOW:
101  out_arg << this->description() << std::endl;
102  break;
103  case Teuchos::VERB_MEDIUM:
104  case Teuchos::VERB_HIGH:
105  case Teuchos::VERB_EXTREME:
106  if(BDP_!=Teuchos::null)
107  BDP_->Print(out_arg);
108  break;
109  default:
110  TEUCHOS_TEST_FOR_EXCEPT(true); // Should never get here!
111  }
112 }
113 
114 } // end namespace Teko