Teko Version of the Day
Loading...
Searching...
No Matches
Teko_PreconditionerLinearOpDecl.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_PreconditionerLinearOpDecl_hpp__
48#define __Teko_PreconditionerLinearOpDecl_hpp__
49
50#include "Thyra_LinearOpBase.hpp"
51#include "Thyra_PreconditionerBase.hpp"
52#include "Thyra_VectorSpaceBase.hpp"
53
54#include "Teuchos_ConstNonconstObjectContainer.hpp"
55
56namespace Teko {
57
65template <typename ScalarT>
66class PreconditionerLinearOp : public Thyra::LinearOpBase<ScalarT> {
67public:
69 PreconditionerLinearOp(const Teuchos::RCP<Thyra::PreconditionerBase<ScalarT> > & prec);
70 PreconditionerLinearOp(const Teuchos::RCP<const Thyra::PreconditionerBase<ScalarT> > & prec);
71
73 void initialize(const Teuchos::RCP<Thyra::PreconditionerBase<ScalarT> > & prec);
74
76 void initialize(const Teuchos::RCP<const Thyra::PreconditionerBase<ScalarT> > & prec);
77
79 void uninitialize();
80
82 virtual Teuchos::RCP<const Thyra::VectorSpaceBase<ScalarT> > range() const;
83
85 virtual Teuchos::RCP<const Thyra::VectorSpaceBase<ScalarT> > domain() const;
86
87 virtual bool opSupportedImpl(const Thyra::EOpTransp M_trans) const;
88
90 virtual void applyImpl(
91 const Thyra::EOpTransp M_trans,
92 const Thyra::MultiVectorBase<ScalarT> & x,
93 const Teuchos::Ptr<Thyra::MultiVectorBase<ScalarT> > & y,
94 const ScalarT alpha,
95 const ScalarT beta
96 ) const;
97
99 virtual Teuchos::RCP<Thyra::PreconditionerBase<ScalarT> > getNonconstPreconditioner();
100
102 virtual Teuchos::RCP<const Thyra::PreconditionerBase<ScalarT> > getPreconditioner() const;
103
105 Teko::LinearOp getOperator() const { return getOperator_cnoc().getConstObj(); }
106
107 // Inherited from Teuchos::Describable
108 void describe(Teuchos::FancyOStream & out_arg,const Teuchos::EVerbosityLevel verbLevel) const;
109protected:
111 Teuchos::ConstNonconstObjectContainer<Thyra::LinearOpBase<ScalarT> > getOperator_cnoc() const;
112
114 Teuchos::ConstNonconstObjectContainer<Thyra::LinearOpBase<ScalarT> > getOperator_cnoc();
115
116 Teuchos::ConstNonconstObjectContainer<Thyra::PreconditionerBase<ScalarT> > preconditioner_;
117};
118
131inline Teko::LinearOp extractOperatorFromPrecOp(const Teko::LinearOp & lo);
132
133} // end namespace Teko
134
135#endif
Class that wraps a PreconditionerBase object it makes it behave like a linear operator.
virtual Teuchos::RCP< const Thyra::PreconditionerBase< ScalarT > > getPreconditioner() const
Get a constant PreconditionerBase object.
virtual Teuchos::RCP< Thyra::PreconditionerBase< ScalarT > > getNonconstPreconditioner()
Get a nonconstant PreconditionerBase object.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< ScalarT > > range() const
Range space of this operator.
void initialize(const Teuchos::RCP< Thyra::PreconditionerBase< ScalarT > > &prec)
build a linear operator using this preconditioner, this initialization permits changes
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< ScalarT > > domain() const
Domain space of this operator.
virtual void applyImpl(const Thyra::EOpTransp M_trans, const Thyra::MultiVectorBase< ScalarT > &x, const Teuchos::Ptr< Thyra::MultiVectorBase< ScalarT > > &y, const ScalarT alpha, const ScalarT beta) const
Apply operation.
Teko::LinearOp getOperator() const
Get teko linear operator.
void uninitialize()
Disassociate this object with the currently owned preconditioner.
Teuchos::ConstNonconstObjectContainer< Thyra::LinearOpBase< ScalarT > > getOperator_cnoc() const
get operator associated with the preconditioner