Thyra Version of the Day
Thyra_LinearOpBase_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_LINEAR_OP_DECL_HPP
00043 #define THYRA_LINEAR_OP_DECL_HPP
00044 
00045 #include "Thyra_OperatorVectorTypes.hpp"
00046 #include "Teuchos_Describable.hpp"
00047 #include "Teuchos_ExpandScalarTypeMacros.hpp"
00048 #include "Teuchos_PromotionTraits.hpp"
00049 
00050 
00051 namespace Thyra {
00052 
00053 
00190 template<class Scalar>
00191 class LinearOpBase : virtual public Teuchos::Describable {
00192 public:
00193 
00196 
00212   virtual RCP< const VectorSpaceBase<Scalar> > range() const = 0;
00213 
00229   virtual RCP< const VectorSpaceBase<Scalar> > domain() const = 0;
00230 
00242   bool opSupported(EOpTransp M_trans) const
00243     {
00244       return opSupportedImpl(M_trans);
00245     }
00246 
00292   void apply(
00293     const EOpTransp M_trans,
00294     const MultiVectorBase<Scalar> &X,
00295     const Ptr<MultiVectorBase<Scalar> > &Y,
00296     const Scalar alpha,
00297     const Scalar beta
00298     ) const
00299     {
00300       applyImpl(M_trans, X, Y, alpha, beta);
00301     }
00302 
00315   virtual RCP<const LinearOpBase<Scalar> > clone() const;
00316 
00318 
00319 protected:
00320 
00323 
00325   virtual bool opSupportedImpl(EOpTransp M_trans) const = 0;
00326 
00328   virtual void applyImpl(
00329     const EOpTransp M_trans,
00330     const MultiVectorBase<Scalar> &X,
00331     const Ptr<MultiVectorBase<Scalar> > &Y,
00332     const Scalar alpha,
00333     const Scalar beta
00334     ) const = 0;
00335 
00337 
00338 private:
00339   
00340   // Not defined and not to be called
00341   LinearOpBase<Scalar>&
00342   operator=(const LinearOpBase<Scalar>&);
00343 
00344 };
00345 
00346 
00352 template<class Scalar>
00353 bool isFullyUninitialized( const LinearOpBase<Scalar> &M );
00354 
00355 
00361 template<class Scalar>
00362 bool isPartiallyInitialized( const LinearOpBase<Scalar> &M );
00363 
00364 
00370 template<class Scalar>
00371 bool isFullyInitialized( const LinearOpBase<Scalar> &M );
00372 
00373 
00378 template<class Scalar>
00379 inline
00380 bool opSupported( const LinearOpBase<Scalar> &M, EOpTransp M_trans );
00381 
00382 
00387 template<class Scalar>
00388 void apply(
00389   const LinearOpBase<Scalar> &M,
00390   const EOpTransp M_trans,
00391   const MultiVectorBase<Scalar> &X,
00392   const Ptr<MultiVectorBase<Scalar> > &Y,
00393   const Scalar alpha = static_cast<Scalar>(1.0),
00394   const Scalar beta = static_cast<Scalar>(0.0)
00395   );
00396 
00397 
00404 inline
00405 void apply(
00406   const LinearOpBase<double> &M,
00407   const EOpTransp M_trans,
00408   const MultiVectorBase<double> &X,
00409   const Ptr<MultiVectorBase<double> > &Y,
00410   const double alpha = 1.0,
00411   const double beta = 0.0
00412   );
00413 
00414 
00415 } // end namespace Thyra
00416 
00417 
00418 //
00419 // Inline and other Template Implementations
00420 //
00421 
00422 
00423 template<class Scalar>
00424 inline
00425 bool Thyra::isFullyUninitialized( const LinearOpBase<Scalar> &M )
00426 {
00427   return ( is_null(M.range()) || is_null(M.domain()) );
00428 }
00429 
00430 
00431 template<class Scalar>
00432 bool Thyra::isPartiallyInitialized( const LinearOpBase<Scalar> &M )
00433 {
00434   return
00435     (
00436       ( !is_null(M.range()) && !is_null(M.domain()) )
00437       && 
00438       (
00439         !opSupported(M,NOTRANS) && !opSupported(M,CONJ)
00440         && !opSupported(M,TRANS) && !opSupported(M,CONJTRANS)
00441         )
00442       );
00443 }
00444 
00445 
00446 template<class Scalar>
00447 bool Thyra::isFullyInitialized( const LinearOpBase<Scalar> &M )
00448 {
00449   return
00450     (
00451       ( !is_null(M.range()) && !is_null(M.domain()) )
00452       && 
00453       (
00454         opSupported(M,NOTRANS) || opSupported(M,CONJ)
00455         || opSupported(M,TRANS) || opSupported(M,CONJTRANS)
00456         )
00457       );
00458 }
00459 
00460 
00461 template<class Scalar>
00462 inline
00463 bool Thyra::opSupported( const LinearOpBase<Scalar> &M, EOpTransp M_trans )
00464 {
00465   return M.opSupported(M_trans);
00466 }
00467 
00468 
00469 inline
00470 void Thyra::apply(
00471   const LinearOpBase<double> &M,
00472   const EOpTransp M_trans,
00473   const MultiVectorBase<double> &X,
00474   const Ptr<MultiVectorBase<double> > &Y,
00475   const double alpha,
00476   const double beta
00477   )
00478 {
00479   apply<double>(M, M_trans, X, Y, alpha, beta);
00480 }
00481 
00482 
00483 #endif  // THYRA_LINEAR_OP_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines