Thyra Version of the Day
Thyra_DefaultSpmdVector_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_DEFAULT_SPMD_VECTOR_DECL_HPP
00043 #define THYRA_DEFAULT_SPMD_VECTOR_DECL_HPP
00044 
00045 
00046 #include "Thyra_SpmdVectorBase_decl.hpp"
00047 
00048 
00049 namespace Thyra {
00050 
00051 
00068 template<class Scalar>
00069 class DefaultSpmdVector : virtual public SpmdVectorBase<Scalar> {
00070 public:
00071 
00074 
00075 
00077   DefaultSpmdVector();
00078 
00080   DefaultSpmdVector(
00081     const RCP<const SpmdVectorSpaceBase<Scalar> > &spmdSpace
00082     ,const ArrayRCP<Scalar> &localValues
00083     ,const Ordinal stride
00084     );
00085 
00111   void initialize(
00112     const RCP<const SpmdVectorSpaceBase<Scalar> > &spmdSpace
00113     ,const ArrayRCP<Scalar> &localValues
00114     ,const Ordinal stride
00115     );
00116 
00122   void uninitialize(
00123     RCP<const SpmdVectorSpaceBase<Scalar> > *spmdSpace = NULL
00124     ,ArrayRCP<Scalar> *localValues = NULL
00125     ,Ordinal *stride = NULL
00126     );
00127 
00129 
00132 
00134   ArrayRCP<Scalar> getRCPtr();
00136   ArrayRCP<const Scalar> getRCPtr() const;
00138   Scalar* getPtr();
00140   const Scalar* getPtr() const;
00142   Ordinal getStride() const;
00143   
00145 
00148 
00150   RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const;
00152   void getNonconstLocalDataImpl(const Ptr<ArrayRCP<Scalar> > &localValues);
00154   void getLocalDataImpl(const Ptr<ArrayRCP<const Scalar> > &localValues) const;
00155 
00157 
00158 private:
00159 
00160   // ///////////////////////////////////////
00161   // Private data members
00162   
00163   RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpace_;
00164   ArrayRCP<Scalar> localValues_;
00165   Ordinal stride_;
00166 
00167 };
00168 
00169 
00170 // /////////////////////////////////////////////////////
00171 // Inline members
00172 
00173 
00174 template<class Scalar>
00175 inline
00176 ArrayRCP<Scalar>
00177 DefaultSpmdVector<Scalar>::getRCPtr()
00178 {
00179   return localValues_;
00180 }
00181 
00182 
00183 template<class Scalar>
00184 inline
00185 ArrayRCP<const Scalar>
00186 DefaultSpmdVector<Scalar>::getRCPtr() const
00187 {
00188   return localValues_;
00189 }
00190 
00191 
00192 template<class Scalar>
00193 inline
00194 Scalar* DefaultSpmdVector<Scalar>::getPtr()
00195 {
00196   return localValues_.get();
00197 }
00198 
00199 
00200 template<class Scalar>
00201 inline
00202 const Scalar* DefaultSpmdVector<Scalar>::getPtr() const
00203 {
00204   return localValues_.get();
00205 }
00206 
00207 
00208 template<class Scalar>
00209 inline
00210 Ordinal DefaultSpmdVector<Scalar>::getStride() const
00211 {
00212   return stride_;
00213 } 
00214 
00215 
00216 } // end namespace Thyra
00217 
00218 
00219 #endif // THYRA_DEFAULT_SPMD_VECTOR_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines