Thyra Version of the Day
Thyra_DefaultMultiVectorLinearOpWithSolve_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_MULTI_VECTOR_LINEAR_OP_WITH_SOLVE_DECL_HPP
00043 #define THYRA_MULTI_VECTOR_LINEAR_OP_WITH_SOLVE_DECL_HPP
00044 
00045 
00046 #include "Thyra_LinearOpWithSolveBase.hpp"
00047 #include "Thyra_DefaultDiagonalLinearOp.hpp"
00048 #include "Thyra_LinearOpWithSolveBase.hpp"
00049 #include "Thyra_DefaultMultiVectorProductVectorSpace.hpp"
00050 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00051 
00052 
00053 namespace Thyra {
00054 
00055 
00061 template<class Scalar>
00062 class DefaultMultiVectorLinearOpWithSolve
00063   : virtual public LinearOpWithSolveBase<Scalar>
00064 {
00065 public:
00066 
00069 
00071   DefaultMultiVectorLinearOpWithSolve();
00072 
00074   void nonconstInitialize(
00075     const RCP<LinearOpWithSolveBase<Scalar> > &lows,
00076     const RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > &multiVecRange,
00077     const RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > &multiVecDomain
00078     );
00079 
00081   void initialize(
00082     const RCP<const LinearOpWithSolveBase<Scalar> > &lows,
00083     const RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > &multiVecRange,
00084     const RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > &multiVecDomain
00085     );
00086   
00088   RCP<LinearOpWithSolveBase<Scalar> >
00089   getNonconstLinearOpWithSolve();
00090   
00092   RCP<const LinearOpWithSolveBase<Scalar> >
00093   getLinearOpWithSolve() const;
00094 
00095   // 2007/05/24: rabartl: ToDo: Add a const version of the above function once
00096   // needed
00097 
00099   void uninitialize();
00100 
00102 
00105 
00107   RCP< const VectorSpaceBase<Scalar> > range() const;
00108 
00110   RCP< const VectorSpaceBase<Scalar> > domain() const;
00111 
00113   RCP<const LinearOpBase<Scalar> > clone() const;
00114 
00116 
00117 protected:
00118 
00122   bool opSupportedImpl(EOpTransp M_trans) const;
00124   void applyImpl(
00125     const EOpTransp M_trans,
00126     const MultiVectorBase<Scalar> &X,
00127     const Ptr<MultiVectorBase<Scalar> > &Y,
00128     const Scalar alpha,
00129     const Scalar beta
00130     ) const;
00132 
00136   bool solveSupportsImpl(EOpTransp M_trans) const;
00138   bool solveSupportsSolveMeasureTypeImpl(
00139     EOpTransp M_trans, const SolveMeasureType& solveMeasureType) const;
00141   SolveStatus<Scalar> solveImpl(
00142     const EOpTransp transp,
00143     const MultiVectorBase<Scalar> &B,
00144     const Ptr<MultiVectorBase<Scalar> > &X,
00145     const Ptr<const SolveCriteria<Scalar> > solveCriteria
00146     ) const;
00148 
00149 private:
00150 
00151   // //////////////////////////////
00152   // Private types
00153 
00154   typedef Teuchos::ConstNonconstObjectContainer<LinearOpWithSolveBase<Scalar> > CNLOWS;
00155 
00156   // //////////////////////////////
00157   // Private data members
00158 
00159   CNLOWS lows_;
00160   RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > multiVecRange_;
00161   RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > multiVecDomain_;
00162 
00163   // //////////////////////////////
00164   // Private member functions
00165 
00166   static void validateInitialize(
00167     const RCP<const LinearOpWithSolveBase<Scalar> > &lows,
00168     const RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > &multiVecRange,
00169     const RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > &multiVecDomain
00170     );
00171   
00172 
00173 };
00174 
00175 
00180 template<class Scalar>
00181 RCP<DefaultMultiVectorLinearOpWithSolve<Scalar> >
00182 multiVectorLinearOpWithSolve()
00183 {
00184   return Teuchos::rcp(new DefaultMultiVectorLinearOpWithSolve<Scalar>());
00185 }
00186 
00187 
00192 template<class Scalar>
00193 RCP<DefaultMultiVectorLinearOpWithSolve<Scalar> >
00194 nonconstMultiVectorLinearOpWithSolve(
00195   const RCP<LinearOpWithSolveBase<Scalar> > &lows,
00196   const RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > &multiVecRange,
00197   const RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > &multiVecDomain
00198   )
00199 {
00200   RCP<DefaultMultiVectorLinearOpWithSolve<Scalar> >
00201     mvlows = Teuchos::rcp(new DefaultMultiVectorLinearOpWithSolve<Scalar>());
00202   mvlows->initialize(lows,multiVecRange,multiVecDomain);
00203   return mvlows;
00204 }
00205 
00206 
00211 template<class Scalar>
00212 RCP<DefaultMultiVectorLinearOpWithSolve<Scalar> >
00213 multiVectorLinearOpWithSolve(
00214   const RCP<const LinearOpWithSolveBase<Scalar> > &lows,
00215   const RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > &multiVecRange,
00216   const RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > &multiVecDomain
00217   )
00218 {
00219   RCP<DefaultMultiVectorLinearOpWithSolve<Scalar> >
00220     mvlows = Teuchos::rcp(new DefaultMultiVectorLinearOpWithSolve<Scalar>());
00221   mvlows->initialize(lows,multiVecRange,multiVecDomain);
00222   return mvlows;
00223 }
00224 
00225 
00226 } // end namespace Thyra
00227 
00228 
00229 #endif  // THYRA_MULTI_VECTOR_LINEAR_OP_WITH_SOLVE_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines