Teko Version of the Day
Loading...
Searching...
No Matches
Teko_BlockUpperTriInverseOp.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_BlockUpperTriInverseOp_hpp__
48#define __Teko_BlockUpperTriInverseOp_hpp__
49
50#include "Teko_Utilities.hpp"
51#include "Teko_BlockImplicitLinearOp.hpp"
52
53namespace Teko {
54
64public:
74 BlockUpperTriInverseOp(BlockedLinearOp & U,const std::vector<LinearOp> & invDiag);
75
77
78
80 virtual VectorSpace range() const { return productRange_; }
81
83 virtual VectorSpace domain() const { return productDomain_; }
84
97 virtual void implicitApply(const BlockedMultiVector & x, BlockedMultiVector & y,
98 const double alpha = 1.0, const double beta = 0.0) const;
99
113 virtual void implicitApply(const Thyra::EOpTransp M_trans,
114 const BlockedMultiVector & x, BlockedMultiVector & y,
115 const double alpha = 1.0, const double beta = 0.0) const;
117
118 virtual void describe(Teuchos::FancyOStream &out_arg,
119 const Teuchos::EVerbosityLevel verbLevel) const;
120
121protected:
122 // fundamental operators to use
123 const BlockedLinearOp U_;
124 std::vector<LinearOp> invDiag_;
125
126 Teuchos::RCP<const Thyra::ProductVectorSpaceBase<double> > productRange_;
127 Teuchos::RCP<const Thyra::ProductVectorSpaceBase<double> > productDomain_;
128
129 // scratch space...so we don't have to reallocate
130 mutable BlockedMultiVector srcScrap_;
131 mutable BlockedMultiVector dstScrap_;
132
133private:
134 // hide me!
137};
138
139inline LinearOp createBlockUpperTriInverseOp(BlockedLinearOp & U,const std::vector<LinearOp> & invDiag)
140{
141 return Teuchos::rcp(new BlockUpperTriInverseOp(U,invDiag));
142}
143
144inline LinearOp createBlockUpperTriInverseOp(BlockedLinearOp & U,const std::vector<LinearOp> & invDiag,const std::string & str)
145{
146 Teuchos::RCP<Thyra::LinearOpBase<double> > result = Teuchos::rcp(new BlockUpperTriInverseOp(U,invDiag));
147 result->setObjectLabel(str);
148
149 return result;
150}
151
152} // end namespace Teko
153
154#endif
A virtual class that simplifies the construction of custom operators.
This linear operator computes the inverse of a upper triangular matrix.
Teuchos::RCP< const Thyra::ProductVectorSpaceBase< double > > productDomain_
Domain vector space.
virtual VectorSpace domain() const
Domain space of this operator.
virtual void implicitApply(const BlockedMultiVector &x, BlockedMultiVector &y, const double alpha=1.0, const double beta=0.0) const
Perform a matrix vector multiply with this operator.
Teuchos::RCP< const Thyra::ProductVectorSpaceBase< double > > productRange_
Range vector space.
std::vector< LinearOp > invDiag_
(Approximate) Inverses of the diagonal operators
virtual VectorSpace range() const
Range space of this operator.