Thyra Version of the Day
Thyra_LinearOpBase_def.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_BASE_DEF_HPP
00043 #define THYRA_LINEAR_OP_BASE_DEF_HPP
00044 
00045 #include "Thyra_LinearOpBase_decl.hpp"
00046 #include "Thyra_MultiVectorBase.hpp"
00047 #include "Thyra_VectorSpaceBase.hpp"
00048 
00049 
00050 namespace Thyra {
00051 
00052 
00053 // Public interface functions
00054 
00055 
00056 template<class Scalar>
00057 RCP<const LinearOpBase<Scalar> > 
00058 LinearOpBase<Scalar>::clone() const
00059 {
00060   return Teuchos::null;
00061 }
00062 
00063 
00064 // Deprecated
00065 
00066 
00067 template<class Scalar>
00068 bool LinearOpBase<Scalar>::applySupports(
00069   const EConj conj
00070   ) const
00071 {
00072   return Thyra::opSupported(*this, applyConjToTrans(conj));
00073 }
00074 
00075 template<class Scalar>
00076 void LinearOpBase<Scalar>::apply(
00077   const EConj conj,
00078   const MultiVectorBase<Scalar> &X,
00079   MultiVectorBase<Scalar> *Y,
00080   const Scalar alpha,
00081   const Scalar beta
00082   ) const
00083 {
00084   Thyra::apply(*this, applyConjToTrans(conj), X, Teuchos::ptr(Y), alpha, beta);
00085 }
00086 
00087 
00088 template<class Scalar>
00089 bool LinearOpBase<Scalar>::applyTransposeSupports(
00090   const EConj conj
00091   ) const
00092 {
00093   return Thyra::opSupported(*this, applyTransposeConjToTrans(conj));
00094 }
00095 
00096 
00097 template<class Scalar>
00098 void LinearOpBase<Scalar>::applyTranspose(
00099   const EConj conj,
00100   const MultiVectorBase<Scalar> &X,
00101   MultiVectorBase<Scalar> *Y,
00102   const Scalar alpha,
00103   const Scalar beta
00104   ) const
00105 {
00106   Thyra::apply(*this, applyTransposeConjToTrans(conj), X, Teuchos::ptr(Y), alpha, beta);
00107 }
00108 
00109 
00110 } // end namespace Thyra
00111 
00112 
00113 // ToDo: You can move this back to the decl file after you have refactored
00114 // apply(...) to not use raw pointers.  Otherwise the Y.ptr() call needs to have
00115 // the definition of MultiVectorBase.
00116 
00117 
00118 template<class Scalar>
00119 void Thyra::apply(
00120   const LinearOpBase<Scalar> &M,
00121   const EOpTransp M_trans,
00122   const MultiVectorBase<Scalar> &X,
00123   const Ptr<MultiVectorBase<Scalar> > &Y,
00124   const Scalar alpha,
00125   const Scalar beta
00126   )
00127 {
00128   M.apply(M_trans, X, Y, alpha, beta);
00129 }
00130 
00131 
00132 //
00133 // Explicit instantiation macro
00134 //
00135 
00136 #define THYRA_LINEAR_OP_BASE_INSTANT(SCALAR) \
00137   \
00138   template class LinearOpBase<SCALAR >; \
00139   \
00140   template void apply(  \
00141     const LinearOpBase<SCALAR > &M,  \
00142     const EOpTransp M_trans,  \
00143     const MultiVectorBase<SCALAR > &X,  \
00144     const Ptr<MultiVectorBase<SCALAR > > &Y,  \
00145     const SCALAR alpha,  \
00146     const SCALAR beta  \
00147     );
00148 
00149 
00150 #endif // THYRA_LINEAR_OP_BASE_DEF_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines