Thyra Version of the Day
Thyra_TpetraMultiVector_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_TPETRA_MULTIVECTOR_DECL_HPP
00043 #define THYRA_TPETRA_MULTIVECTOR_DECL_HPP
00044 
00045 #include "Thyra_SpmdMultiVectorDefaultBase.hpp"
00046 #include "Thyra_TpetraVectorSpace_decl.hpp"
00047 #include "Tpetra_MultiVector.hpp"
00048 
00049 
00050 namespace Thyra {
00051 
00052 
00060 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00061 class TpetraMultiVector
00062   : virtual public SpmdMultiVectorDefaultBase<Scalar>
00063 {
00064 public:
00065 
00068 
00070   TpetraMultiVector();
00071 
00074   void initialize(
00075     const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00076     const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00077     const RCP<Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector
00078     );
00079 
00082   void constInitialize(
00083     const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00084     const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00085     const RCP<const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector
00086     );
00087 
00089   RCP<Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00090   getTpetraMultiVector();
00091 
00093   RCP<const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00094   getConstTpetraMultiVector() const;
00095 
00097 
00101   RCP< const ScalarProdVectorSpaceBase<Scalar> >
00102   domainScalarProdVecSpc() const;
00104 
00105 protected:
00106 
00110   RCP<const VectorBase<Scalar> > colImpl(Ordinal j) const;
00112   RCP<VectorBase<Scalar> > nonconstColImpl(Ordinal j);
00113 
00115   RCP<const MultiVectorBase<Scalar> >
00116   contigSubViewImpl( const Range1D& colRng ) const;
00118   RCP<MultiVectorBase<Scalar> >
00119   nonconstContigSubViewImpl( const Range1D& colRng );
00120 //  /** \brief . */
00121 //  RCP<const MultiVectorBase<Scalar> >
00122 //  nonContigSubViewImpl( const ArrayView<const int> &cols ) const;
00123 //  /** \brief . */
00124 //  RCP<MultiVectorBase<Scalar> >
00125 //  nonconstNonContigSubViewImpl( const ArrayView<const int> &cols );
00127 
00131   RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpaceImpl() const;
00133   void getNonconstLocalMultiVectorDataImpl(
00134     const Ptr<ArrayRCP<Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
00135     );
00137   void getLocalMultiVectorDataImpl(
00138     const Ptr<ArrayRCP<const Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
00139     ) const;
00141 
00142 private:
00143 
00144   // ///////////////////////////////////////
00145   // Private data members
00146 
00147   RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tpetraVectorSpace_;
00148   RCP<const ScalarProdVectorSpaceBase<Scalar> > domainSpace_;
00149   Teuchos::ConstNonconstObjectContainer<Tpetra::MultiVector<Scalar, LocalOrdinal,GlobalOrdinal,Node> >
00150   tpetraMultiVector_;
00151 
00152   // ////////////////////////////////////
00153   // Private member functions
00154 
00155   template<class TpetraMultiVector_t>
00156   void initializeImpl(
00157     const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00158     const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00159     const RCP<TpetraMultiVector_t> &tpetraMultiVector
00160     );
00161 
00162 };
00163 
00164 
00169 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00170 RCP<TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00171 tpetraMultiVector(
00172   const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00173   const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00174   const RCP<Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector
00175   )
00176 {
00177   RCP<TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tmv =
00178     Teuchos::rcp(new TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>);
00179   tmv->initialize(tpetraVectorSpace, domainSpace, tpetraMultiVector);
00180   return tmv;
00181 }
00182 
00183 
00188 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00189 RCP<const TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00190 constTpetraMultiVector(
00191   const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00192   const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00193   const RCP<const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector
00194   )
00195 {
00196   RCP<TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tmv =
00197     Teuchos::rcp(new TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>);
00198   tmv->constInitialize(tpetraVectorSpace, domainSpace, tpetraMultiVector);
00199   return tmv;
00200 }
00201 
00202 
00203 } // end namespace Thyra
00204 
00205 
00206 #endif // THYRA_TPETRA_MULTIVECTOR_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines