Thyra_DefaultSpmdVectorDecl.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_SPMD_VECTOR_STD_DECL_HPP
#define THYRA_SPMD_VECTOR_STD_DECL_HPP

#include "Thyra_SpmdVectorBaseDecl.hpp"

namespace Thyra {

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



  DefaultSpmdVector();

  DefaultSpmdVector(
    const Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >   &spmdSpace
    ,const Teuchos::RefCountPtr<Scalar>                              &localValues
    ,const Index                                                     stride
    );

  void initialize(
    const Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >   &spmdSpace
    ,const Teuchos::RefCountPtr<Scalar>                              &localValues
    ,const Index                                                     stride
    );

  void uninitialize(
    Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >    *spmdSpace     = NULL
    ,Teuchos::RefCountPtr<Scalar>                               *localValues   = NULL
    ,Index                                                      *stride        = NULL
    );



  Teuchos::RefCountPtr<Scalar> getRCPtr();
  Teuchos::RefCountPtr<const Scalar> getRCPtr() const;
  Scalar* getPtr();
  const Scalar* getPtr() const;
  Index getStride() const;
  

  std::string description() const;


  Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const;
  void getLocalData( Scalar** localValues, Index* stride );
  void commitLocalData( Scalar* localValues );
  void getLocalData( const Scalar** localValues, Index* stride ) const;
  void freeLocalData( const Scalar* localValues ) const;


private:

  // ///////////////////////////////////////
  // Private data members
  
  Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >  spmdSpace_;
  Teuchos::RefCountPtr<Scalar>                              localValues_;
  Index                                                     stride_;

}; // end class DefaultSpmdVector

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

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

template<class Scalar>
inline
Teuchos::RefCountPtr<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
Index DefaultSpmdVector<Scalar>::getStride() const
{
  return stride_;
} 

} // end namespace Thyra

#endif // THYRA_SPMD_VECTOR_STD_DECL_HPP

---