Thyra Version of the Day
Thyra_DefaultDiagonalLinearOpWithSolve_decl.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //    Thyra: Interfaces and Support for Abstract Numerical Algorithms
00005 //                 Copyright (2004) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_DIAGONAL_LINEAR_OP_WITH_SOLVE_DECL_HPP
00043 #define THYRA_DIAGONAL_LINEAR_OP_WITH_SOLVE_DECL_HPP
00044 
00045 #include "Thyra_DefaultDiagonalLinearOp.hpp"
00046 #include "Thyra_LinearOpWithSolveBase.hpp"
00047 
00048 
00049 namespace Thyra {
00050 
00051 
00091 template<class Scalar>
00092 class DefaultDiagonalLinearOpWithSolve
00093   : virtual public DefaultDiagonalLinearOp<Scalar>,
00094     virtual public LinearOpWithSolveBase<Scalar>
00095 {
00096 public:
00097 
00100 
00107   DefaultDiagonalLinearOpWithSolve();
00108 
00110   DefaultDiagonalLinearOpWithSolve(
00111     const RCP<const VectorBase<Scalar> >   &diag
00112     );
00113 
00114 protected:
00115 
00119   bool solveSupportsImpl(EOpTransp M_trans) const;
00121   bool solveSupportsSolveMeasureTypeImpl(
00122     EOpTransp M_trans, const SolveMeasureType& solveMeasureType) const;
00124   SolveStatus<Scalar> solveImpl(
00125     const EOpTransp transp,
00126     const MultiVectorBase<Scalar> &B,
00127     const Ptr<MultiVectorBase<Scalar> > &X,
00128     const Ptr<const SolveCriteria<Scalar> > solveCriteria
00129     ) const;
00131 
00132 };
00133 
00134 
00139 template<class Scalar>
00140 RCP<DefaultDiagonalLinearOpWithSolve<Scalar> >
00141 defaultDiagonalLinearOpWithSolve()
00142 {
00143   return Teuchos::rcp(new DefaultDiagonalLinearOpWithSolve<Scalar>);
00144 }
00145 
00146 
00151 template<class Scalar>
00152 RCP<DefaultDiagonalLinearOpWithSolve<Scalar> >
00153 defaultDiagonalLinearOpWithSolve(
00154   const RCP<const VectorBase<Scalar> >   &diag
00155   )
00156 {
00157   RCP<DefaultDiagonalLinearOpWithSolve<Scalar> > ddlows =
00158     defaultDiagonalLinearOpWithSolve<Scalar>();
00159   ddlows->initialize(diag);
00160   return ddlows;
00161 }
00162 
00163 
00164 
00165 } // end namespace Thyra
00166 
00167 
00168 #endif  // THYRA_DIAGONAL_LINEAR_OP_WITH_SOLVE_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines