Thyra Version of the Day
Thyra_SpmdMultiVectorBase_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_SPMD_MULTI_VECTOR_BASE_DECL_HPP
00043 #define THYRA_SPMD_MULTI_VECTOR_BASE_DECL_HPP
00044 
00045 #include "Thyra_MultiVectorAdapterBase_decl.hpp"
00046 #include "Teuchos_BLAS.hpp"
00047 
00048 
00049 namespace Thyra {
00050 
00051 
00053 template<class Scalar> class SpmdVectorSpaceBase;
00054 
00055 
00112 template<class Scalar>
00113 class SpmdMultiVectorBase
00114   : virtual public MultiVectorAdapterBase<Scalar>
00115 {
00116 public:
00117 
00120 
00122   SpmdMultiVectorBase();
00123 
00125 
00128 
00132   virtual RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const = 0;
00133 
00157   void getNonconstLocalData(
00158     const Ptr<ArrayRCP<Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
00159     )
00160     {
00161       getNonconstLocalDataImpl(localValues, leadingDim);
00162     }
00163 
00184   void getLocalData(
00185     const Ptr<ArrayRCP<const Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
00186     ) const
00187     {
00188       getLocalDataImpl(localValues, leadingDim);
00189     }
00190 
00192 
00195 
00197   RCP< const ScalarProdVectorSpaceBase<Scalar> > rangeScalarProdVecSpc() const;
00198 
00200 
00203 
00205   THYRA_DEPRECATED void getLocalData( Scalar **localValues_out, Ordinal *leadingDim_out )
00206     {
00207       using Teuchos::outArg;
00208       ArrayRCP<Scalar> localValues;
00209       this->getNonconstLocalData(outArg(localValues), outArg(*leadingDim_out));
00210       *localValues_out = localValues.getRawPtr();
00211     }
00212   
00214   THYRA_DEPRECATED void commitLocalData( Scalar *localValues )
00215     {
00216       // Do nothing!
00217     }
00218 
00220   THYRA_DEPRECATED void getLocalData(
00221     const Scalar **localValues_out, Ordinal *leadingDim_out
00222     ) const
00223     {
00224       using Teuchos::outArg;
00225       ArrayRCP<const Scalar> localValues;
00226       this->getLocalData(outArg(localValues), outArg(*leadingDim_out));
00227       *localValues_out = localValues.getRawPtr();
00228 
00229     }
00230 
00232   THYRA_DEPRECATED void freeLocalData( const Scalar *localValues ) const
00233     {
00234       // Do nothing!
00235     }
00236 
00238 
00239 protected:
00240 
00243 
00245   virtual void getNonconstLocalDataImpl(
00246     const Ptr<ArrayRCP<Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
00247     ) = 0;
00248 
00250   virtual void getLocalDataImpl(
00251     const Ptr<ArrayRCP<const Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
00252     ) const = 0;
00253 
00255 
00259   void mvMultiReductApplyOpImpl(
00260     const RTOpPack::RTOpT<Scalar> &primary_op,
00261     const ArrayView<const Ptr<const MultiVectorBase<Scalar> > > &multi_vecs,
00262     const ArrayView<const Ptr<MultiVectorBase<Scalar> > > &targ_multi_vecs,
00263     const ArrayView<const Ptr<RTOpPack::ReductTarget> > &reduct_objs,
00264     const Ordinal primary_global_offset
00265     ) const;
00267   void acquireDetachedMultiVectorViewImpl(
00268     const Range1D &rowRng,
00269     const Range1D &colRng
00270     ,RTOpPack::ConstSubMultiVectorView<Scalar> *sub_mv
00271     ) const;
00273   void releaseDetachedMultiVectorViewImpl(
00274     RTOpPack::ConstSubMultiVectorView<Scalar>* sub_mv
00275     ) const;
00277   void acquireNonconstDetachedMultiVectorViewImpl(
00278     const Range1D &rowRng,
00279     const Range1D &colRng,
00280     RTOpPack::SubMultiVectorView<Scalar> *sub_mv
00281     );
00283   void commitNonconstDetachedMultiVectorViewImpl(
00284     RTOpPack::SubMultiVectorView<Scalar>* sub_mv
00285     );
00287 
00290 
00296   void euclideanApply(
00297     const EOpTransp M_trans,
00298     const MultiVectorBase<Scalar> &X,
00299     const Ptr<MultiVectorBase<Scalar> > &Y,
00300     const Scalar alpha,
00301     const Scalar beta
00302     ) const;
00303 
00305 
00308 
00317   virtual void updateSpmdSpace();
00318 
00323   Range1D validateRowRange( const Range1D& rowRng ) const;
00324 
00329   Range1D validateColRange( const Range1D& rowCol ) const;
00330 
00332   
00333 private:
00334   
00335   // ///////////////////////////////////////
00336   // Private data members
00337   
00338   mutable bool in_applyOp_;
00339 
00340   mutable Teuchos::BLAS<int,Scalar> blas_;
00341 
00342   // cached
00343   Ordinal  globalDim_;
00344   Ordinal  localOffset_;
00345   Ordinal  localSubDim_;
00346   Ordinal  numCols_;
00347   
00348 }; // end class SpmdMultiVectorBase
00349 
00350 } // end namespace Thyra
00351 
00352 #endif // THYRA_SPMD_MULTI_VECTOR_BASE_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines