Thyra_DefaultSpmdVectorDecl.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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef THYRA_SPMD_VECTOR_STD_DECL_HPP
00030 #define THYRA_SPMD_VECTOR_STD_DECL_HPP
00031 
00032 #include "Thyra_SpmdVectorBaseDecl.hpp"
00033 
00034 namespace Thyra {
00035 
00053 template<class Scalar>
00054 class DefaultSpmdVector : virtual public SpmdVectorBase<Scalar> {
00055 public:
00056 
00059 
00060 
00062   DefaultSpmdVector();
00063 
00065   DefaultSpmdVector(
00066     const Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >   &spmdSpace
00067     ,const Teuchos::RefCountPtr<Scalar>                              &localValues
00068     ,const Index                                                     stride
00069     );
00070 
00096   void initialize(
00097     const Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >   &spmdSpace
00098     ,const Teuchos::RefCountPtr<Scalar>                              &localValues
00099     ,const Index                                                     stride
00100     );
00101 
00107   void uninitialize(
00108     Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >    *spmdSpace     = NULL
00109     ,Teuchos::RefCountPtr<Scalar>                               *localValues   = NULL
00110     ,Index                                                      *stride        = NULL
00111     );
00112 
00114 
00117 
00119   Teuchos::RefCountPtr<Scalar> getRCPtr();
00121   Teuchos::RefCountPtr<const Scalar> getRCPtr() const;
00123   Scalar* getPtr();
00125   const Scalar* getPtr() const;
00127   Index getStride() const;
00128   
00130 
00134   std::string description() const;
00136 
00139 
00141   Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const;
00143   void getLocalData( Scalar** localValues, Index* stride );
00145   void commitLocalData( Scalar* localValues );
00147   void getLocalData( const Scalar** localValues, Index* stride ) const;
00149   void freeLocalData( const Scalar* localValues ) const;
00150 
00152 
00153 private:
00154 
00155   // ///////////////////////////////////////
00156   // Private data members
00157   
00158   Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >  spmdSpace_;
00159   Teuchos::RefCountPtr<Scalar>                              localValues_;
00160   Index                                                     stride_;
00161 
00162 }; // end class DefaultSpmdVector
00163 
00164 // /////////////////////////////////////////////////////
00165 // Inline members
00166 
00167 template<class Scalar>
00168 inline
00169 Teuchos::RefCountPtr<Scalar>
00170 DefaultSpmdVector<Scalar>::getRCPtr()
00171 {
00172   return localValues_;
00173 }
00174 
00175 template<class Scalar>
00176 inline
00177 Teuchos::RefCountPtr<const Scalar>
00178 DefaultSpmdVector<Scalar>::getRCPtr() const
00179 {
00180   return localValues_;
00181 }
00182 
00183 template<class Scalar>
00184 inline
00185 Scalar* DefaultSpmdVector<Scalar>::getPtr()
00186 {
00187   return localValues_.get();
00188 }
00189 
00190 template<class Scalar>
00191 inline
00192 const Scalar* DefaultSpmdVector<Scalar>::getPtr() const
00193 {
00194   return localValues_.get();
00195 }
00196 
00197 template<class Scalar>
00198 inline
00199 Index DefaultSpmdVector<Scalar>::getStride() const
00200 {
00201   return stride_;
00202 } 
00203 
00204 } // end namespace Thyra
00205 
00206 #endif // THYRA_SPMD_VECTOR_STD_DECL_HPP

Generated on Thu Sep 18 12:33:02 2008 for Thyra Package Browser (Single Doxygen Collection) by doxygen 1.3.9.1