Thyra Version of the Day
Thyra_VectorDefaultBase_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_VECTOR_DEFAULT_BASE_DECL_HPP
00043 #define THYRA_VECTOR_DEFAULT_BASE_DECL_HPP
00044 
00045 #include "Thyra_VectorBase.hpp"
00046 #include "Thyra_MultiVectorDefaultBase_decl.hpp"
00047 
00048 
00049 namespace Thyra {
00050 
00051 
00072 template<class Scalar>
00073 class VectorDefaultBase
00074   : virtual public VectorBase<Scalar>,
00075     virtual protected MultiVectorDefaultBase<Scalar>
00076 {
00077 public:
00078 
00081 
00083   virtual std::string description() const;
00084 
00107   virtual void describe(
00108     Teuchos::FancyOStream                &out
00109     ,const Teuchos::EVerbosityLevel      verbLevel
00110     ) const;
00111 
00113 
00116 
00118   virtual RCP< const VectorSpaceBase<Scalar> > range() const;
00122   virtual RCP< const VectorSpaceBase<Scalar> > domain() const;
00123 
00125 
00128 
00130   RCP<MultiVectorBase<Scalar> > clone_mv() const;
00131 
00133 
00136 
00140   RCP<VectorBase<Scalar> > clone_v() const;
00141 
00143 
00144 protected:
00145 
00148 
00150   virtual RCP<VectorBase<Scalar> > nonconstColImpl(Ordinal j);
00152   virtual RCP<const MultiVectorBase<Scalar> >
00153   contigSubViewImpl( const Range1D& col_rng ) const;
00155   virtual RCP<MultiVectorBase<Scalar> >
00156   nonconstContigSubViewImpl( const Range1D& col_rng );
00158   virtual RCP<const MultiVectorBase<Scalar> >
00159   nonContigSubViewImpl( const ArrayView<const int> &cols ) const;
00161   virtual RCP<MultiVectorBase<Scalar> >
00162   nonconstNonContigSubViewImpl( const ArrayView<const int> &cols );
00164   virtual void acquireDetachedMultiVectorViewImpl(
00165     const Range1D &rowRng,
00166     const Range1D &colRng,
00167     RTOpPack::ConstSubMultiVectorView<Scalar> *sub_mv
00168     ) const;
00170   virtual void releaseDetachedMultiVectorViewImpl(
00171     RTOpPack::ConstSubMultiVectorView<Scalar>* sub_mv
00172     ) const;
00174   virtual void acquireNonconstDetachedMultiVectorViewImpl(
00175     const Range1D &rowRng,
00176     const Range1D &colRng,
00177     RTOpPack::SubMultiVectorView<Scalar> *sub_mv
00178     );
00180   virtual void commitNonconstDetachedMultiVectorViewImpl(
00181     RTOpPack::SubMultiVectorView<Scalar>* sub_mv
00182     );
00183 
00185 
00188 
00203   virtual void acquireDetachedVectorViewImpl(
00204     const Range1D& rng, RTOpPack::ConstSubVectorView<Scalar>* sub_vec
00205     ) const;
00213   virtual void releaseDetachedVectorViewImpl(
00214     RTOpPack::ConstSubVectorView<Scalar>* sub_vec
00215     ) const;
00229   virtual void acquireNonconstDetachedVectorViewImpl(
00230     const Range1D& rng, RTOpPack::SubVectorView<Scalar>* sub_vec
00231     );
00238   virtual void commitNonconstDetachedVectorViewImpl(
00239     RTOpPack::SubVectorView<Scalar>* sub_vec
00240     );
00250   virtual void setSubVectorImpl( const RTOpPack::SparseSubVectorT<Scalar>& sub_vec );
00251 
00253 
00256 
00261   bool opSupportedImpl(EOpTransp M_trans) const;
00262 
00266   void applyImpl(
00267     const EOpTransp M_trans,
00268     const MultiVectorBase<Scalar> &X,
00269     const Ptr<MultiVectorBase<Scalar> > &Y,
00270     const Scalar alpha,
00271     const Scalar beta
00272     ) const;
00273 
00275 
00276 private:
00277 
00278   // /////////////////////////////////////
00279   // Private data members
00280 
00281   mutable RCP<const VectorSpaceBase<Scalar> > domain_;
00282   // Above only initialized if *this is used as a MultiVectorBase
00283 
00284   // /////////////////////////////////////
00285   // Private member functions
00286 
00287   void validateColRng( const Range1D &rowRng ) const;
00288   void validateColIndexes( const ArrayView<const int> &cols ) const;
00289 
00290 };
00291 
00292 
00293 } // end namespace Thyra
00294 
00295 
00296 #endif  // THYRA_VECTOR_DEFAULT_BASE_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines