Amesos2_KokkosMultiVecAdapter_decl.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//           Amesos2: Templated Direct Sparse Solver Package
//                  Copyright 2011 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 AMESOS2_KOKKOS_MULTIVEC_ADAPTER_DECL_HPP
#define AMESOS2_KOKKOS_MULTIVEC_ADAPTER_DECL_HPP

#include <Teuchos_RCP.hpp>
#include <Teuchos_Array.hpp>
#include <Teuchos_as.hpp>
#include <Tpetra_Core.hpp>

#include "Amesos2_MultiVecAdapter_decl.hpp"
#include "Amesos2_Kokkos_View_Copy_Assign.hpp"

namespace Amesos2 {

  template< typename Scalar,
            typename ExecutionSpace >
  class MultiVecAdapter<Kokkos::View<Scalar**, Kokkos::LayoutLeft, ExecutionSpace> >
  {
  public:
    // public type definitions
    typedef Tpetra::Map<>::node_type                                      node_t;
    typedef Kokkos::View<Scalar**,Kokkos::LayoutLeft, ExecutionSpace> multivec_t;
    typedef int                                                  local_ordinal_t;
    typedef Tpetra::Map<>::global_ordinal_type                  global_ordinal_t;
    typedef size_t                                                 global_size_t;
    typedef Scalar                                                      scalar_t;

    typedef Kokkos::View<scalar_t**, Kokkos::LayoutLeft, ExecutionSpace> kokkos_view_t;

    friend Teuchos::RCP<MultiVecAdapter<multivec_t> > createMultiVecAdapter<> (Teuchos::RCP<multivec_t>);
    friend Teuchos::RCP<const MultiVecAdapter<multivec_t> > createConstMultiVecAdapter<> (Teuchos::RCP<const multivec_t>);

    static const char* name;


  protected:
    // Do not allow direct construction of MultiVecAdapter's.  Only
    // allow construction through the non-member friend functions.

    MultiVecAdapter( const MultiVecAdapter<multivec_t>& adapter );

    MultiVecAdapter( const Teuchos::RCP<multivec_t>& m );


  public:

    ~MultiVecAdapter()
    { }

    bool isLocallyIndexed() const
    {
      if(getComm()->getSize() == 1){
        return true;
      } // There may be other conditions to check
      return false;
    }

    bool isGloballyIndexed() const;

    Teuchos::RCP<const Tpetra::Map<
                         local_ordinal_t,
                         global_ordinal_t,
                         node_t > >
    getMap() const
    {
      return Teuchos::null; // serial only for Kokkos adapter right now
    }

    Teuchos::RCP<const Teuchos::Comm<int> > getComm() const
    {
      return Tpetra::getDefaultComm(); // serial only for Kokkos adapter right now
    }

    size_t getLocalLength() const
    {
      return mv_->extent(0);
    }


    size_t getLocalNumVectors() const
    {
      return mv_->extent(1);
    }


    global_size_t getGlobalLength() const
    {
      return mv_->extent(0);
    }


    global_size_t getGlobalNumVectors() const
    {
      return mv_->extent(1);
    }


    size_t getStride() const
    {
      return mv_->getStride();
    }


    bool isConstantStride() const
    {
      return mv_->isConstantStride();
    }

    Scalar * getMVPointer_impl() const;


    Teuchos::RCP<multivec_t> clone() const;

    void
    get1dCopy ( const Teuchos::ArrayView<scalar_t>& av,
                size_t lda,
                Teuchos::Ptr<
                  const Tpetra::Map<local_ordinal_t,
                  global_ordinal_t,
                  node_t> > distribution_map,
                EDistribution distribution) const;

    template<typename KV>
    bool
    get1dCopy_kokkos_view (
      bool bInitialize, KV& kokkos_view,
      [[maybe_unused]] size_t lda,
      [[maybe_unused]] Teuchos::Ptr<
        const Tpetra::Map<local_ordinal_t,
        global_ordinal_t,
        node_t> 
      > distribution_map,
      [[maybe_unused]] EDistribution distribution
    ) const {
      bool bAssigned; // deep_copy_or_assign_view sets true if assigned (no deep copy)
      deep_copy_or_assign_view(bInitialize, kokkos_view, *mv_, bAssigned);
      return bAssigned;
    }

    Teuchos::ArrayRCP<scalar_t> get1dViewNonConst (bool local = false);

    void
    put1dData (const Teuchos::ArrayView<const scalar_t>& new_data,
              size_t lda,
              Teuchos::Ptr<
                const Tpetra::Map<local_ordinal_t,
                global_ordinal_t,
                node_t> > distribution_map,
              EDistribution) const;

    template<typename KV>
    void
    put1dData_kokkos_view (
      KV& kokkos_new_data,
      [[maybe_unused]] size_t lda,
      [[maybe_unused]] Teuchos::Ptr<
        const Tpetra::Map<local_ordinal_t,
        global_ordinal_t,
        node_t>
      > distribution_map,
      EDistribution
    ) const {
      deep_copy_or_assign_view(*mv_, kokkos_new_data);
    }


    std::string description () const;

    void
    describe (Teuchos::FancyOStream& os,
              const Teuchos::EVerbosityLevel verbLevel =
              Teuchos::Describable::verbLevel_default) const;

  private:

    Teuchos::RCP<multivec_t> mv_;

    typedef Tpetra::Export<local_ordinal_t, global_ordinal_t, node_t> export_type;

    typedef Tpetra::Import<local_ordinal_t, global_ordinal_t, node_t> import_type;

    mutable Teuchos::RCP<export_type> exporter_;

    mutable Teuchos::RCP<import_type> importer_;

  }; // end class MultiVecAdapter<Tpetra::MultiVector>

} // end namespace Amesos2


#endif // AMESOS2_KOKKOS_MULTIVEC_ADAPTER_DECL_HPP