Thyra Version of the Day
Thyra_DefaultSpmdMultiVector_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_STD_DECL_HPP
00043 #define THYRA_Spmd_MULTI_VECTOR_STD_DECL_HPP
00044 
00045 #include "Thyra_SpmdMultiVectorBase_decl.hpp"
00046 
00047 
00048 namespace Thyra {
00049 
00050 
00067 template<class Scalar>
00068 class DefaultSpmdMultiVector : virtual public SpmdMultiVectorBase<Scalar> {
00069 public:
00070 
00073 
00075   DefaultSpmdMultiVector();
00076 
00078   DefaultSpmdMultiVector(
00079     const RCP<const SpmdVectorSpaceBase<Scalar> > &spmdRangeSpace,
00080     const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace
00081     );
00082 
00084   DefaultSpmdMultiVector(
00085     const RCP<const SpmdVectorSpaceBase<Scalar> > &spmdRangeSpace,
00086     const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00087     const ArrayRCP<Scalar> &localValues,
00088     const Ordinal leadingDim = -1
00089     );
00090 
00106   void initialize(
00107     const RCP<const SpmdVectorSpaceBase<Scalar> > &spmdRangeSpace,
00108     const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace
00109     );
00110 
00139   void initialize(
00140     const RCP<const SpmdVectorSpaceBase<Scalar> > &spmdRangeSpace,
00141     const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00142     const ArrayRCP<Scalar> &localValues,
00143     const Ordinal leadingDim = -1
00144     );
00145 
00151   void uninitialize(
00152     RCP<const SpmdVectorSpaceBase<Scalar> > *spmdRangeSpace = NULL,
00153     RCP<const ScalarProdVectorSpaceBase<Scalar> > *domainSpace = NULL,
00154     ArrayRCP<Scalar> *localValues = NULL,
00155     Ordinal *leadingDim = NULL
00156     );
00157 
00159   RCP< const ScalarProdVectorSpaceBase<Scalar> >
00160   domainScalarProdVecSpc() const;
00161 
00163 
00167   RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const;
00169 
00170 protected:
00171 
00175   RCP<VectorBase<Scalar> > nonconstColImpl(Ordinal j);
00177   RCP<const MultiVectorBase<Scalar> >
00178   contigSubViewImpl(const Range1D& colRng) const;
00180   RCP<MultiVectorBase<Scalar> >
00181   nonconstContigSubViewImpl(const Range1D& colRng);
00183   RCP<const MultiVectorBase<Scalar> >
00184   nonContigSubViewImpl(const ArrayView<const int> &cols) const;
00186   RCP<MultiVectorBase<Scalar> >
00187   nonconstNonContigSubViewImpl(const ArrayView<const int> &cols);
00189 
00193   void getNonconstLocalDataImpl(
00194     const Ptr<ArrayRCP<Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
00195     );
00197   void getLocalDataImpl(
00198     const Ptr<ArrayRCP<const Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
00199     ) const;
00201   
00202 private:
00203   
00204   // ///////////////////////////////////////
00205   // Private data members
00206 
00207   RCP<const SpmdVectorSpaceBase<Scalar> > spmdRangeSpace_;
00208   RCP<const ScalarProdVectorSpaceBase<Scalar> > domainSpace_;
00209   ArrayRCP<Scalar> localValues_;
00210   Ordinal leadingDim_;
00211   
00212   // ///////////////////////////////////////
00213   // Private member functions
00214 
00215   ArrayRCP<Scalar> createContiguousCopy(const ArrayView<const int> &cols) const;
00216 
00217 public:
00218 
00219 #ifdef THYRA_DEBUG
00220   // Unit testing sensing varaible
00221   static int numSkipCopyBack;
00222 #endif
00223   
00224 }; // end class DefaultSpmdMultiVector
00225 
00226 
00227 template<class Scalar>
00228 RCP<DefaultSpmdMultiVector<Scalar> >
00229 defaultSpmdMultiVector(
00230   const RCP<const SpmdVectorSpaceBase<Scalar> > &spmdRangeSpace,
00231   const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00232   const ArrayRCP<Scalar> &localValues,
00233   const Ordinal leadingDim = -1
00234   )
00235 {
00236   return Teuchos::rcp(
00237     new DefaultSpmdMultiVector<Scalar>(
00238       spmdRangeSpace, domainSpace, localValues, leadingDim
00239       )
00240     );
00241 }
00242 
00243 
00244 } // end namespace Thyra
00245 
00246 
00247 #endif // THYRA_Spmd_MULTI_VECTOR_STD_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines