Teko Version of the Day
Loading...
Searching...
No Matches
Teko_Preconditioner.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_Preconditioner_hpp__
48#define __Teko_Preconditioner_hpp__
49
50// Thyra includes
51#include "Thyra_DefaultPreconditioner.hpp"
52
53// Teko includes
54#include "Teko_Utilities.hpp"
55#include "Teko_PreconditionerState.hpp"
56
57namespace Teko {
58
59using Thyra::LinearOpBase;
60using Thyra::DefaultPreconditioner;
61using Teuchos::RCP;
62
70class Preconditioner : public DefaultPreconditioner<double> {
71public:
73
75 : DefaultPreconditioner<double>() {}
76 Preconditioner(const RCP<LinearOpBase<double> > & leftPrecOp,
77 const RCP<LinearOpBase<double> > & rightPrecOp)
78 : DefaultPreconditioner<double>(leftPrecOp,rightPrecOp) {}
79 Preconditioner(const RCP<const LinearOpBase<double> > & leftPrecOp,
80 const RCP<const LinearOpBase<double> > & rightPrecOp)
81 : DefaultPreconditioner<double>(leftPrecOp,rightPrecOp) {}
82 Preconditioner(const RCP<LinearOpBase<double> > & unspecifiedPrecOp)
83 : DefaultPreconditioner<double>(unspecifiedPrecOp) {}
84 Preconditioner(const RCP<const LinearOpBase<double> > & unspecifiedPrecOp)
85 : DefaultPreconditioner<double>(unspecifiedPrecOp) {}
87
92 virtual void setSourceVector(const RCP<Thyra::MultiVectorBase<double> > & srcVec)
93 { if(srcVec!=Teuchos::null) state_->setSourceVector(srcVec);
94 else state_->setSourceVector(Teuchos::null); }
95
100 virtual void setStateObject(const RCP<PreconditionerState> & state)
101 { state_ = state; }
102
107 virtual const RCP<PreconditionerState> getStateObject()
108 { return state_; }
109
114 virtual const RCP<const PreconditionerState> getStateObject() const
115 { return state_; }
116
122 virtual void mergeStateObject(const PreconditionerState & state)
123 { state_->merge(state); }
124
125protected:
127 RCP<PreconditionerState> state_;
128};
129
130} // end namespace Teko
131
132#endif
An implementation of a state object preconditioners.
An extension of the Thyra::DefaultPreconditioner class with some specializations useful for use withi...
virtual void setSourceVector(const RCP< Thyra::MultiVectorBase< double > > &srcVec)
virtual void mergeStateObject(const PreconditionerState &state)
RCP< PreconditionerState > state_
User defined state for this preconditioner.
virtual const RCP< PreconditionerState > getStateObject()
virtual const RCP< const PreconditionerState > getStateObject() const
virtual void setStateObject(const RCP< PreconditionerState > &state)