Thyra Version of the Day
Thyra_DefaultIdentityLinearOp_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_DEFAULT_IDENTITY_LINEAR_OP_DEF_HPP
00043 #define THYRA_DEFAULT_IDENTITY_LINEAR_OP_DEF_HPP
00044 
00045 #include "Thyra_DefaultIdentityLinearOp_decl.hpp"
00046 #include "Thyra_MultiVectorStdOps.hpp"
00047 #include "Thyra_AssertOp.hpp"
00048 
00049 
00050 namespace Thyra {
00051 
00052 
00053 // Constructors/initializers/accessors
00054 
00055 
00056 template<class Scalar>
00057 DefaultIdentityLinearOp<Scalar>::DefaultIdentityLinearOp()
00058 {}
00059 
00060 
00061 template<class Scalar>
00062 DefaultIdentityLinearOp<Scalar>::DefaultIdentityLinearOp(
00063   const Teuchos::RCP<const VectorSpaceBase<Scalar> >   &space
00064   )
00065 {
00066   initialize(space);
00067 }
00068 
00069 
00070 template<class Scalar>
00071 void DefaultIdentityLinearOp<Scalar>::initialize(
00072   const Teuchos::RCP<const VectorSpaceBase<Scalar> >   &space
00073   )
00074 {
00075   space_ = space.assert_not_null();
00076 }
00077 
00078 
00079 template<class Scalar>
00080 void DefaultIdentityLinearOp<Scalar>::uninitialize()
00081 {
00082   space_ = Teuchos::null;
00083 }
00084 
00085 
00086 // Overridden from LinearOpBase
00087 
00088   
00089 template<class Scalar>
00090 Teuchos::RCP< const VectorSpaceBase<Scalar> >
00091 DefaultIdentityLinearOp<Scalar>::range() const
00092 {
00093   return space_;
00094 }
00095 
00096 
00097 template<class Scalar>
00098 Teuchos::RCP< const VectorSpaceBase<Scalar> >
00099 DefaultIdentityLinearOp<Scalar>::domain() const
00100 {
00101   return space_;
00102 }
00103 
00104   
00105 template<class Scalar>
00106 Teuchos::RCP<const LinearOpBase<Scalar> >
00107 DefaultIdentityLinearOp<Scalar>::clone() const
00108 {
00109   typedef DefaultIdentityLinearOp<Scalar> this_t;
00110   if(space_.get())
00111     return Teuchos::rcp(new this_t(space_));
00112   return Teuchos::rcp(new this_t());
00113 }
00114 
00115   
00116 // Overridden from Teuchos::Describable
00117 
00118 
00119 template<class Scalar>
00120 std::string DefaultIdentityLinearOp<Scalar>::description() const
00121 {
00122   typedef Teuchos::ScalarTraits<Scalar>  ST;
00123   std::ostringstream oss;
00124   oss
00125     << "Thyra::DefaultIdentityLinearOp<" << ST::name() << ">{"
00126     << "space="<<(space_.get()?space_->description():"NULL")
00127     << "}";
00128   return oss.str();
00129 }
00130 
00131 
00132 // protected
00133 
00134 
00135 // Overridden from LinearOpBase
00136 
00137 
00138 template<class Scalar>
00139 bool DefaultIdentityLinearOp<Scalar>::opSupportedImpl(EOpTransp M_trans) const
00140 {
00141   return true;
00142 }
00143 
00144 
00145 template<class Scalar>
00146 void DefaultIdentityLinearOp<Scalar>::applyImpl(
00147   const EOpTransp M_trans,
00148   const MultiVectorBase<Scalar> &X,
00149   const Ptr<MultiVectorBase<Scalar> > &Y,
00150   const Scalar alpha,
00151   const Scalar beta
00152   ) const
00153 {
00154   using Teuchos::tuple;
00155   using Teuchos::ptrFromRef;
00156 #ifdef TEUCHOS_DEBUG
00157   THYRA_ASSERT_LINEAR_OP_MULTIVEC_APPLY_SPACES(
00158     "DefaultIdentityLinearOp<Scalar>::apply(...)", *this, M_trans, X, &*Y
00159     );
00160 #endif // TEUCHOS_DEBUG  
00161   Thyra::linear_combination<Scalar>(
00162     tuple<Scalar>(alpha)(),
00163     tuple<Ptr<const MultiVectorBase<Scalar> > >(ptrFromRef(X))(),
00164     beta, Y
00165     );
00166 }
00167 
00168 
00169 } // end namespace Thyra
00170 
00171 
00172 template<class Scalar>
00173 Teuchos::RCP<const Thyra::LinearOpBase<Scalar> >
00174 Thyra::identity(
00175   const Teuchos::RCP<const VectorSpaceBase<Scalar> > &space,
00176   const std::string &label
00177   )
00178 {
00179   RCP<Thyra::LinearOpBase<Scalar> > ilo =
00180     Teuchos::rcp(new DefaultIdentityLinearOp<Scalar>(space));
00181   if (label.length())
00182     ilo->setObjectLabel(label);
00183   return ilo;
00184 }
00185 
00186 
00187 //
00188 // Explicit instantaition
00189 //
00190 
00191 
00192 #define THYRA_DEFAULT_IDENTITY_LINEAR_OP_INSTANT(SCALAR) \
00193   \
00194   template class DefaultIdentityLinearOp<SCALAR >; \
00195   \
00196   template RCP<const LinearOpBase<SCALAR > > \
00197   identity( \
00198     const RCP<const VectorSpaceBase<SCALAR > > &space, \
00199     const std::string &label \
00200     ); \
00201 
00202 
00203 #endif  // THYRA_DEFAULT_IDENTITY_LINEAR_OP_DEF_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines