Amesos2_ShyLUBasker_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//           Amesos2: Templated Direct Sparse Solver Package
//
// Copyright 2011 NTESS and the Amesos2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef AMESOS2_SHYLUBASKER_DECL_HPP
#define AMESOS2_SHYLUBASKER_DECL_HPP

#include "Amesos2_SolverTraits.hpp"
#include "Amesos2_SolverCore.hpp"
#include "Amesos2_ShyLUBasker_FunctionMap.hpp"

#include "shylubasker_decl.hpp"
#include "shylubasker_def.hpp"
#include "shylubasker_trilinos_decl.hpp"


namespace Amesos2 {

template <class Matrix,class Vector>
class ShyLUBasker : public SolverCore<Amesos2::ShyLUBasker, Matrix, Vector>
{
  friend class SolverCore<Amesos2::ShyLUBasker,Matrix,Vector>; // Give our base access
                                                          // to our private
                                                          // implementation funcs
public:

  static const char* name;      // declaration. Initialization outside.


  typedef ShyLUBasker<Matrix,Vector>                           type;

  typedef SolverCore<Amesos2::ShyLUBasker,Matrix,Vector>       super_type;

  // Since typedef's are not inheritted, go grab them
  typedef typename VectorTraits<Vector>::scalar_t       vector_scalar_type;
  typedef typename super_type::scalar_type                     scalar_type;
  typedef typename super_type::local_ordinal_type              local_ordinal_type;
  typedef typename super_type::global_ordinal_type             global_ordinal_type;
  typedef typename super_type::global_size_type                global_size_type;
  typedef typename super_type::node_type                       node_type;

  typedef TypeMap<Amesos2::ShyLUBasker,scalar_type>            type_map;
  typedef typename type_map::type                              shylubasker_type;
  typedef typename type_map::dtype                             shylubasker_dtype;

  typedef typename type_map::type                              slu_type;

  typedef FunctionMap<Amesos2::ShyLUBasker,shylubasker_type>   function_map;

  typedef Matrix                                               matrix_type;
  typedef MatrixAdapter<matrix_type>                           matrix_adapter_type;

  typedef Kokkos::DefaultHostExecutionSpace                    HostExecSpaceType;
//  typedef Kokkos::View<local_ordinal_type*, HostExecSpaceType> host_size_type_array;
  typedef Kokkos::View<local_ordinal_type*, HostExecSpaceType> host_ordinal_type_array;
  typedef Kokkos::View<shylubasker_type*, HostExecSpaceType>   host_value_type_array;


  ShyLUBasker( Teuchos::RCP<const Matrix> A,
          Teuchos::RCP<Vector>       X,
          Teuchos::RCP<const Vector> B);
   ~ShyLUBasker( );


private:

  bool single_proc_optimization() const;


  int preOrdering_impl();


  int symbolicFactorization_impl();


  int numericFactorization_impl();


  int solve_impl(const Teuchos::Ptr<MultiVecAdapter<Vector> >       X,
                 const Teuchos::Ptr<const MultiVecAdapter<Vector> > B) const;


  bool matrixShapeOK_impl() const;


  void setParameters_impl(
    const Teuchos::RCP<Teuchos::ParameterList> & parameterList );


  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters_impl() const;


  bool loadA_impl(EPhase current_phase);


  // Members
  int num_threads;

  // The following Kokkos::View's are persisting storage for A's CCS arrays
  host_value_type_array nzvals_view_;
  host_ordinal_type_array rowind_view_;
  host_ordinal_type_array colptr_view_;


  bool is_contiguous_;
  bool use_gather_;

  typedef typename Kokkos::View<shylubasker_type**, Kokkos::LayoutLeft, 
                                typename HostExecSpaceType::memory_space> host_solve_array_t;

  mutable host_solve_array_t xValues_;
  int ldx_;

  mutable host_solve_array_t bValues_;
  int ldb_;

  /*Handle for ShyLUBasker object*/
#if defined( HAVE_AMESOS2_KOKKOS )
  /*
  typedef typename node_type::device_type  kokkos_device;
  typedef typename kokkos_device::execution_space kokkos_exe;
  static_assert(std::is_same<kokkos_exe,Kokkos::OpenMP>::value,
  "Kokkos node type not support by experimental ShyLUBasker Amesos2");
  */
  typedef Kokkos::DefaultHostExecutionSpace Exe_Space;
   ::BaskerNS::BaskerTrilinosInterface<local_ordinal_type, shylubasker_dtype, Exe_Space> *ShyLUbasker;
#else
  #pragma message("Amesos_ShyLUBasker_decl Error: ENABLED SHYLU_NODEBASKER BUT NOT KOKKOS!")
#endif

}; // End class ShyLUBasker


// Specialize solver_traits struct for ShyLUBasker
// TODO
template <>
struct solver_traits<ShyLUBasker> {
#ifdef HAVE_TEUCHOS_COMPLEX
/*
  typedef Meta::make_list4<float,
                           double,
                           std::complex<float>,
                           std::complex<double> > supported_scalars;
*/
  typedef Meta::make_list6<float,
                           double,
                           Kokkos::complex<float>,
                           Kokkos::complex<double>,
                           std::complex<float>,
                           std::complex<double> > supported_scalars;
#else
  typedef Meta::make_list2<float, double> supported_scalars;
#endif
};

template <typename Scalar, typename LocalOrdinal, typename ExecutionSpace>
struct solver_supports_matrix<ShyLUBasker,
  KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, ExecutionSpace>> {
  static const bool value = true;
};

} // end namespace Amesos2

#endif  // AMESOS2_SHYLUBASKER_DECL_HPP