Amesos2_EpetraMultiVecAdapter_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_EPETRA_MULTIVEC_ADAPTER_DECL_HPP
#define AMESOS2_EPETRA_MULTIVEC_ADAPTER_DECL_HPP

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

#include <Tpetra_Vector.hpp>
#include <Tpetra_Map.hpp>

#include <Epetra_MultiVector.h>

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

namespace Amesos2 {

  template <>
  class MultiVecAdapter<Epetra_MultiVector>
  {
  public:

    // public type definitions
    typedef double                                                scalar_t;
    typedef int                                            local_ordinal_t;
    typedef Tpetra::Map<>::global_ordinal_type            global_ordinal_t;
    typedef size_t                                           global_size_t;
    typedef Tpetra::Map<>::node_type                                node_t;
    typedef Epetra_MultiVector                                  multivec_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:
    MultiVecAdapter( const MultiVecAdapter<multivec_t>& adapter );

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


  public:

    ~MultiVecAdapter() = default;


    bool isLocallyIndexed() const;

    bool isGloballyIndexed() const;


    Teuchos::RCP<const Tpetra::Map<local_ordinal_t, global_ordinal_t, node_t> >
    getMap() const;

    const Teuchos::RCP<const Teuchos::Comm<int> > getComm() const;


    size_t getLocalLength() const;


    size_t getLocalNumVectors() const;


    global_size_t getGlobalLength() const;


    size_t getGlobalNumVectors() const;


    size_t getStride() const;


    bool isConstantStride() const;


    Teuchos::RCP<const Tpetra::Vector<scalar_t,local_ordinal_t,global_ordinal_t,node_t> >
    getVector( size_t j ) const;


    Teuchos::RCP<Tpetra::Vector<scalar_t,local_ordinal_t,global_ordinal_t,node_t> >
    getVectorNonConst( size_t j );


    double * getMVPointer_impl() const;

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

    template<typename KV>
    void get1dCopy_kokkos_view( KV & A,
                    size_t lda,
                    Teuchos::Ptr<
                      const Tpetra::Map<local_ordinal_t,
                      global_ordinal_t,
                      node_t> > distribution_map,
                    EDistribution distribution) const {
      Kokkos::View<double**, Kokkos::LayoutLeft, Kokkos::HostSpace> host_new_data;
      get1dCopy_kokkos_view_host(host_new_data, lda, distribution_map, distribution);
      deep_copy_or_assign_view(A, host_new_data);
    }

    void get1dCopy_kokkos_view_host(
                    Kokkos::View<scalar_t**, Kokkos::LayoutLeft, Kokkos::HostSpace> & new_data,
                    size_t lda,
                    Teuchos::Ptr<
                      const Tpetra::Map<local_ordinal_t,
                      global_ordinal_t,
                      node_t> > distribution_map,
                    EDistribution) const;

    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> > source_map,
        EDistribution distribution );

    template<typename KV>
    void put1dData_kokkos_view(
                    KV & new_data,
                    size_t lda,
                      Teuchos::Ptr<
                      const Tpetra::Map<local_ordinal_t,
                      global_ordinal_t,
                      node_t> > source_map,
                    EDistribution distribution ) {
      Kokkos::View<scalar_t**, Kokkos::LayoutLeft, Kokkos::HostSpace> host_new_data(
        Kokkos::ViewAllocateWithoutInitializing("host_new_data"),
        new_data.extent(0), new_data.extent(1));
      Kokkos::deep_copy(host_new_data, new_data);
      put1dData_kokkos_view_host(host_new_data, lda, source_map, distribution);
    }

    void put1dData_kokkos_view_host(
                    Kokkos::View<scalar_t**, Kokkos::LayoutLeft, Kokkos::HostSpace> & new_data,
                    size_t lda,
                    Teuchos::Ptr<
                    const Tpetra::Map<local_ordinal_t,
                    global_ordinal_t,
                    node_t> > source_map,
        EDistribution distribution );

    std::string description() const;


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


  private:

    Teuchos::RCP<multivec_t> mv_;

    mutable Teuchos::RCP<Epetra_Import> importer_;
    mutable Teuchos::RCP<Epetra_Export> exporter_;

    mutable Teuchos::RCP<const Epetra_BlockMap> mv_map_;

  };                              // end class MultiVecAdapter<NewMultiVec>

} // end namespace Amesos2


#endif // AMESOS2_EPETRA_MULTIVEC_ADAPTER_DECL_HPP