Thyra Version of the Day
Thyra_TpetraVector_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 Michael A. Heroux (maherou@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_TPETRA_VECTOR_DECL_HPP
00043 #define THYRA_TPETRA_VECTOR_DECL_HPP
00044 
00045 
00046 #include "Thyra_SpmdVectorBase_decl.hpp"
00047 #include "Thyra_TpetraVectorSpace_decl.hpp"
00048 #include "Tpetra_Vector.hpp"
00049 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00050 
00051 
00052 namespace Thyra {
00053 
00054 
00059 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00060 class TpetraVector : virtual public SpmdVectorBase<Scalar> {
00061 public:
00062 
00065 
00067   TpetraVector();
00068 
00070   void initialize(
00071     const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00072     const RCP<Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVector
00073     );
00074 
00076   void constInitialize(
00077     const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00078     const RCP<const Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVector
00079     );
00080 
00082   RCP<Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00083   getTpetraVector();
00084 
00086   RCP<const Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00087   getConstTpetraVector() const;
00088 
00090 
00093 
00095   RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const;
00097   void getNonconstLocalDataImpl(const Ptr<ArrayRCP<Scalar> > &localValues);
00099   void getLocalDataImpl(const Ptr<ArrayRCP<const Scalar> > &localValues) const;
00100 
00102 
00103 private:
00104 
00105   // ///////////////////////////////////////
00106   // Private data members
00107   
00108   RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00109   tpetraVectorSpace_;
00110   
00111   Teuchos::ConstNonconstObjectContainer<Tpetra::Vector<Scalar, LocalOrdinal,GlobalOrdinal,Node> >
00112   tpetraVector_;
00113 
00114   typedef Tpetra::MultiVector<Scalar, LocalOrdinal,GlobalOrdinal,Node> TpetraMultiVector_t;
00115 
00116   // ////////////////////////////////////
00117   // Private member functions
00118 
00119   template<class TpetraVector_t>
00120   void initializeImpl(
00121     const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00122     const RCP<TpetraVector_t> &tpetraVector
00123     );
00124 
00125 };
00126 
00127 
00132 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00133 inline
00134 RCP<TpetraVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00135 tpetraVector(
00136   const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00137   const RCP<Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVector
00138   )
00139 {
00140   RCP<TpetraVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > v =
00141     Teuchos::rcp(new TpetraVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>);
00142   v->initialize(tpetraVectorSpace, tpetraVector);
00143   return v;
00144 }
00145 
00146 
00151 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00152 inline
00153 RCP<const TpetraVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
00154 constTpetraVector(
00155   const RCP<const TpetraVectorSpace<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVectorSpace,
00156   const RCP<const Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &tpetraVector
00157   )
00158 {
00159   RCP<TpetraVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > v =
00160     Teuchos::rcp(new TpetraVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>);
00161   v->constInitialize(tpetraVectorSpace, tpetraVector);
00162   return v;
00163 }
00164 
00165 
00166 } // end namespace Thyra
00167 
00168 
00169 #endif // THYRA_TPETRA_VECTOR_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines