Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_TpetraInverseOpWrapper.hpp
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 #ifndef __Teko_TpetraInverseOpWrapper_hpp__
48 #define __Teko_TpetraInverseOpWrapper_hpp__
49 
50 #include "Teko_TpetraOperatorWrapper.hpp"
51 #include "Teko_ConfigDefs.hpp"
52 #include "Tpetra_MultiVector.hpp"
53 
54 namespace Teko {
55 namespace TpetraHelpers {
56 
57 class TpetraInverseOpWrapper : public TpetraOperatorWrapper {
58  public:
59  TpetraInverseOpWrapper(const RCP<const MappingStrategy>& forwardMaps)
60  : TpetraOperatorWrapper(forwardMaps) {}
61 
62  TpetraInverseOpWrapper(const RCP<const Thyra::LinearOpBase<ST> >& thyraOp)
63  : TpetraOperatorWrapper(thyraOp) {}
64 
66  virtual void apply(const Tpetra::MultiVector<ST, LO, GO, NT>& X,
67  Tpetra::MultiVector<ST, LO, GO, NT>& Y,
68  Teuchos::ETransp mode = Teuchos::NO_TRANS,
69  ST alpha = Teuchos::ScalarTraits<ST>::one(),
70  ST beta = Teuchos::ScalarTraits<ST>::zero()) const;
71 
73  virtual void applyInverse(const Tpetra::MultiVector<ST, LO, GO, NT>& X,
74  Tpetra::MultiVector<ST, LO, GO, NT>& Y,
75  Teuchos::ETransp mode = Teuchos::NO_TRANS,
76  ST alpha = Teuchos::ScalarTraits<ST>::one(),
77  ST beta = Teuchos::ScalarTraits<ST>::zero()) const;
78 
79  // /** */
80  // virtual const Epetra_Map& OperatorDomainMap() const;
81  //
82  // /** */
83  // virtual const Epetra_Map& OperatorRangeMap() const;
84  protected:
85  TpetraInverseOpWrapper() {}
86 };
87 
88 } // namespace TpetraHelpers
89 } // namespace Teko
90 
91 #endif