Thyra Package Browser (Single Doxygen Collection) Version of the Day
Thyra_TpetraMultiVector_decl.hpp
Go to the documentation of this file.
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_SpmdMultiVectorBase.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 : virtual public SpmdMultiVectorBase<Scalar> {
00062 public:
00063 
00066 
00068   TpetraMultiVector();
00069 
00072   void initialize(
00073     const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00074     const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00075     const RCP<Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector
00076     );
00077 
00080   void constInitialize(
00081     const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00082     const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00083     const RCP<const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector
00084     );
00085 
00087   RCP<Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00088   getTpetraMultiVector();
00089 
00091   RCP<const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00092   getConstTpetraMultiVector() const;
00093 
00095 
00099   RCP< const ScalarProdVectorSpaceBase<Scalar> >
00100   domainScalarProdVecSpc() const;
00102 
00106   RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const;
00108 
00109 protected:
00110 
00114   RCP<const VectorBase<Scalar> > colImpl(Ordinal j) const;
00116   RCP<VectorBase<Scalar> > nonconstColImpl(Ordinal j);
00117 //  /** \brief . */
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   void getNonconstLocalDataImpl(
00132     const Ptr<ArrayRCP<Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
00133     );
00135   void getLocalDataImpl(
00136     const Ptr<ArrayRCP<const Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
00137     ) const;
00139   
00140 private:
00141   
00142   // ///////////////////////////////////////
00143   // Private data members
00144 
00145   RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tpetraVectorSpace_;
00146   RCP<const ScalarProdVectorSpaceBase<Scalar> > domainSpace_;
00147   Teuchos::ConstNonconstObjectContainer<Tpetra::MultiVector<Scalar, LocalOrdinal,GlobalOrdinal,Node> >
00148   tpetraMultiVector_;
00149 
00150   // ////////////////////////////////////
00151   // Private member functions
00152 
00153   template<class TpetraMultiVector_t>
00154   void initializeImpl(
00155     const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00156     const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00157     const RCP<TpetraMultiVector_t> &tpetraMultiVector
00158     );
00159   
00160 };
00161 
00162 
00167 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00168 RCP<TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00169 tpetraMultiVector(
00170   const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00171   const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00172   const RCP<Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector
00173   )
00174 {
00175   RCP<TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tmv =
00176     Teuchos::rcp(new TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>);
00177   tmv->initialize(tpetraVectorSpace, domainSpace, tpetraMultiVector);
00178   return tmv;
00179 }
00180 
00181 
00186 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00187 RCP<const TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00188 constTpetraMultiVector(
00189   const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00190   const RCP<const ScalarProdVectorSpaceBase<Scalar> > &domainSpace,
00191   const RCP<const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraMultiVector
00192   )
00193 {
00194   RCP<TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > tmv =
00195     Teuchos::rcp(new TpetraMultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>);
00196   tmv->constInitialize(tpetraVectorSpace, domainSpace, tpetraMultiVector);
00197   return tmv;
00198 }
00199 
00200 
00201 } // end namespace Thyra
00202 
00203 
00204 #endif // THYRA_TPETRA_MULTIVECTOR_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines