Tpetra_BlockVector_decl.hpp

// @HEADER
// ***********************************************************************
//
//          Tpetra: Templated Linear Algebra Services Package
//                 Copyright (2008) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
// @HEADER

#ifndef TPETRA_BLOCKVECTOR_DECL_HPP
#define TPETRA_BLOCKVECTOR_DECL_HPP

#include "Tpetra_BlockVector_fwd.hpp"
#include "Tpetra_BlockMultiVector.hpp"
#include "Tpetra_Vector.hpp"

namespace Tpetra {

template<class Scalar,
         class LO,
         class GO,
         class Node>
class BlockVector : public BlockMultiVector<Scalar, LO, GO, Node> {
private:
  typedef BlockMultiVector<Scalar, LO, GO, Node> base_type;
  typedef Teuchos::ScalarTraits<Scalar> STS;

public:


  typedef typename base_type::scalar_type scalar_type;
  typedef typename base_type::impl_scalar_type impl_scalar_type;
  typedef typename base_type::local_ordinal_type local_ordinal_type;
  typedef typename base_type::global_ordinal_type global_ordinal_type;
  typedef typename base_type::node_type node_type;
  typedef typename Node::device_type device_type;

  typedef Tpetra::Map<LO, GO, Node> map_type;
  typedef Tpetra::MultiVector<Scalar, LO, GO, Node> mv_type;
  typedef Tpetra::Vector<Scalar, LO, GO, Node> vec_type;

  typedef Kokkos::View<impl_scalar_type*,
                       Kokkos::LayoutRight,
                       device_type,
                       Kokkos::MemoryTraits<Kokkos::Unmanaged> >
          little_vec_type;

  typedef Kokkos::View<const impl_scalar_type*,
                       Kokkos::LayoutRight,
                       device_type,
                       Kokkos::MemoryTraits<Kokkos::Unmanaged> >
          const_little_vec_type;



  BlockVector ();

  BlockVector (const BlockVector<Scalar, LO, GO, Node>&) = default;

  BlockVector (BlockVector<Scalar, LO, GO, Node>&&) = default;

  BlockVector<Scalar, LO, GO, Node>&
  operator= (const BlockVector<Scalar, LO, GO, Node>&) = default;

  BlockVector<Scalar, LO, GO, Node>&
  operator= (BlockVector<Scalar, LO, GO, Node>&&) = default;

  BlockVector (const BlockVector<Scalar, LO, GO, Node>& in,
               const Teuchos::DataAccess copyOrView);

  BlockVector (const map_type& meshMap, const LO blockSize);

  BlockVector (const map_type& meshMap,
               const map_type& pointMap,
               const LO blockSize);

  BlockVector (const mv_type& X_mv,
               const map_type& meshMap,
               const LO blockSize);

  BlockVector (const vec_type& X_vec,
               const map_type& meshMap,
               const LO blockSize);

  BlockVector (const BlockVector<Scalar, LO, GO, Node>& X,
               const map_type& newMeshMap,
               const map_type& newPointMap,
               const size_t offset = 0);

  BlockVector (const BlockVector<Scalar, LO, GO, Node>& X,
               const map_type& newMeshMap,
               const size_t offset = 0);



  vec_type getVectorView ();



  bool replaceLocalValues (const LO localRowIndex, const Scalar vals[]) const;

  bool replaceGlobalValues (const GO globalRowIndex, const Scalar vals[]) const;

  bool sumIntoLocalValues (const LO localRowIndex, const Scalar vals[]) const;

  bool sumIntoGlobalValues (const GO globalRowIndex, const Scalar vals[]) const;

  bool getLocalRowView (const LO localRowIndex, Scalar*& vals) const;

  bool getGlobalRowView (const GO globalRowIndex, Scalar*& vals) const;

  little_vec_type getLocalBlock (const LO localRowIndex) const;
};

} // namespace Tpetra

#endif // TPETRA_BLOCKMULTIVECTOR_DECL_HPP