Thyra_DefaultSpmdVector_decl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_DEFAULT_SPMD_VECTOR_DECL_HPP
#define THYRA_DEFAULT_SPMD_VECTOR_DECL_HPP


#include "Thyra_SpmdVectorBase_decl.hpp"


namespace Thyra {


template<class Scalar>
class DefaultSpmdVector : virtual public SpmdVectorBase<Scalar> {
public:



  DefaultSpmdVector();

  DefaultSpmdVector(
    const RCP<const SpmdVectorSpaceBase<Scalar> > &spmdSpace
    ,const ArrayRCP<Scalar> &localValues
    ,const Ordinal stride
    );

  void initialize(
    const RCP<const SpmdVectorSpaceBase<Scalar> > &spmdSpace
    ,const ArrayRCP<Scalar> &localValues
    ,const Ordinal stride
    );

  void uninitialize(
    RCP<const SpmdVectorSpaceBase<Scalar> > *spmdSpace = NULL
    ,ArrayRCP<Scalar> *localValues = NULL
    ,Ordinal *stride = NULL
    );



  ArrayRCP<Scalar> getRCPtr();
  ArrayRCP<const Scalar> getRCPtr() const;
  Scalar* getPtr();
  const Scalar* getPtr() const;
  Ordinal getStride() const;
  


  RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const;
  void getNonconstLocalDataImpl(const Ptr<ArrayRCP<Scalar> > &localValues);
  void getLocalDataImpl(const Ptr<ArrayRCP<const Scalar> > &localValues) const;


private:

  // ///////////////////////////////////////
  // Private data members
  
  RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpace_;
  ArrayRCP<Scalar> localValues_;
  Ordinal stride_;

};


// /////////////////////////////////////////////////////
// Inline members


template<class Scalar>
inline
ArrayRCP<Scalar>
DefaultSpmdVector<Scalar>::getRCPtr()
{
  return localValues_;
}


template<class Scalar>
inline
ArrayRCP<const Scalar>
DefaultSpmdVector<Scalar>::getRCPtr() const
{
  return localValues_;
}


template<class Scalar>
inline
Scalar* DefaultSpmdVector<Scalar>::getPtr()
{
  return localValues_.get();
}


template<class Scalar>
inline
const Scalar* DefaultSpmdVector<Scalar>::getPtr() const
{
  return localValues_.get();
}


template<class Scalar>
inline
Ordinal DefaultSpmdVector<Scalar>::getStride() const
{
  return stride_;
} 


} // end namespace Thyra


#endif // THYRA_DEFAULT_SPMD_VECTOR_DECL_HPP