Thyra_DefaultSpmdVector_decl.hpp

// @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.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
// 
// ***********************************************************************
// @HEADER
 
#ifndef THYRA_DEFAULT_SPMD_VECTOR_DECL_HPP
#define THYRA_DEFAULT_SPMD_VECTOR_DECL_HPP
 
 
#include "Thyra_SpmdVectorDefaultBase_decl.hpp"
 
 
namespace Thyra {
 

template<class Scalar>
class DefaultSpmdVector : virtual public SpmdVectorDefaultBase<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> > spmdSpaceImpl() const;



  void getNonconstLocalVectorDataImpl(const Ptr<ArrayRCP<Scalar> > &localValues);
  void getLocalVectorDataImpl(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