Thyra Version of the Day
Thyra_DefaultAdjointLinearOpWithSolve_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 
00043 #ifndef THYRA_DEFAULT_ADJOINT_LINEAR_OP_WITH_SOLVE_DECL_HPP
00044 #define THYRA_DEFAULT_ADJOINT_LINEAR_OP_WITH_SOLVE_DECL_HPP
00045 
00046 
00047 #include "Thyra_LinearOpWithSolveBase.hpp"
00048 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00049 
00050 
00051 namespace Thyra {
00052 
00053 
00059 template<class Scalar>
00060 class DefaultAdjointLinearOpWithSolve : virtual public LinearOpWithSolveBase<Scalar>
00061 {
00062 public:
00063 
00066 
00068   DefaultAdjointLinearOpWithSolve();
00069 
00071   void initialize( const RCP<LinearOpWithSolveBase<Scalar> > &lows,
00072     const EOpTransp transp );
00073 
00075   void initialize( const RCP<const LinearOpWithSolveBase<Scalar> > &lows,
00076     const EOpTransp transp );
00077 
00079   const RCP<LinearOpWithSolveBase<Scalar> > getNonconstOp();
00080 
00082   const RCP<const LinearOpWithSolveBase<Scalar> > getOp() const;
00083 
00085 
00088 
00090   RCP<const VectorSpaceBase<Scalar> > range() const;
00092   RCP<const VectorSpaceBase<Scalar> > domain() const;
00093 
00095 
00096 protected:
00097   
00101   bool opSupportedImpl(EOpTransp M_trans) const;
00103  void applyImpl(
00104    const EOpTransp M_trans,
00105    const MultiVectorBase<Scalar> &X,
00106    const Ptr<MultiVectorBase<Scalar> > &Y,
00107    const Scalar alpha,
00108    const Scalar beta
00109    ) const;
00111 
00115   bool solveSupportsImpl(EOpTransp M_trans) const;
00117   bool solveSupportsSolveMeasureTypeImpl(
00118     EOpTransp M_trans, const SolveMeasureType& solveMeasureType) const;
00120   SolveStatus<Scalar> solveImpl(
00121     const EOpTransp transp,
00122     const MultiVectorBase<Scalar> &B,
00123     const Ptr<MultiVectorBase<Scalar> > &X,
00124     const Ptr<const SolveCriteria<Scalar> > solveCriteria
00125     ) const;
00127 
00128 private:
00129 
00130   // //////////////////////////
00131   // Private types
00132 
00133   typedef Teuchos::ConstNonconstObjectContainer<LinearOpWithSolveBase<Scalar> >
00134   CNCLOWS;
00135 
00136   // /////////////////////////
00137   // Private data members
00138 
00139   CNCLOWS lows_;
00140   EOpTransp transp_;
00141 
00142 };
00143 
00144 
00149 template<class Scalar>
00150 RCP<DefaultAdjointLinearOpWithSolve<Scalar> >
00151 defaultAdjointLinearOpWithSolve(
00152   const RCP<const LinearOpWithSolveBase<Scalar> > &lows,
00153   const EOpTransp transp )
00154 {
00155   RCP<DefaultAdjointLinearOpWithSolve<Scalar> >
00156     dalows = Teuchos::rcp(new DefaultAdjointLinearOpWithSolve<Scalar>);
00157   dalows->initialize(lows, transp);
00158   return dalows;
00159 }
00160 
00161 
00166 template<class Scalar>
00167 RCP<DefaultAdjointLinearOpWithSolve<Scalar> >
00168 defaultAdjointLinearOpWithSolveNonconst(
00169   const RCP<LinearOpWithSolveBase<Scalar> > &lows,
00170   const EOpTransp transp )
00171 {
00172   RCP<DefaultAdjointLinearOpWithSolve<Scalar> >
00173     dalows = Teuchos::rcp(new DefaultAdjointLinearOpWithSolve<Scalar>);
00174   dalows->initialize(lows, transp);
00175   return dalows;
00176 }
00177 
00178 
00183 template<class Scalar>
00184 RCP<const LinearOpWithSolveBase<Scalar> >
00185 adjointLows( const RCP<const LinearOpWithSolveBase<Scalar> > &lows )
00186 {
00187   return defaultAdjointLinearOpWithSolve<Scalar>(lows, CONJTRANS);
00188 }
00189 
00190 
00195 template<class Scalar>
00196 RCP<LinearOpWithSolveBase<Scalar> >
00197 nonconstAdjointLows( const RCP<LinearOpWithSolveBase<Scalar> > &lows )
00198 {
00199   return defaultAdjointLinearOpWithSolveNonconst<Scalar>(lows, CONJTRANS);
00200 }
00201 
00202 
00203 
00204 } // end namespace Thyra
00205 
00206 
00207 #endif  // THYRA_DEFAULT_ADJOINT_LINEAR_OP_WITH_SOLVE_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines