Amesos2_PardisoMKL_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_PARDISOMKL_DECL_HPP
#define AMESOS2_PARDISOMKL_DECL_HPP
 
#include <Teuchos_StandardParameterEntryValidators.hpp>
 
#include "Amesos2_SolverTraits.hpp"
#include "Amesos2_SolverCore.hpp"
#include "Amesos2_PardisoMKL_FunctionMap.hpp"
 
 
namespace Amesos2 {
 
 
  template <class Matrix,
            class Vector>
  class PardisoMKL : public SolverCore<Amesos2::PardisoMKL, Matrix, Vector>
  {
    friend class SolverCore<Amesos2::PardisoMKL,Matrix,Vector>; // Give our base access
                                                                // to our private
                                                                // implementation funcs
  public:
 
    static const char* name;    // declaration. Initialization outside.
 
    typedef PardisoMKL<Matrix,Vector>                                       type;
    typedef SolverCore<Amesos2::PardisoMKL,Matrix,Vector>             super_type;
 
    // Since typedef's are not inheritted, go grab them
    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 TypeMap<Amesos2::PardisoMKL,scalar_type>                    type_map;
 
    typedef typename type_map::type                           solver_scalar_type;
    typedef typename type_map::magnitude_type              solver_magnitude_type;
 
    // This may be PMKL::_INTEGER_t or long long int depending on the
    // mapping and input ordinal
    typedef typename TypeMap<Amesos2::PardisoMKL,local_ordinal_type>::type int_t;
 
    /* For PardisoMKL we dispatch based on the integer type instead of
     * the scalar type:
     *   - _INTEGER_t    => use the pardiso(...)    method
     *   - long long int => use the pardiso_64(...) method
     */
    typedef FunctionMap<Amesos2::PardisoMKL,int_t>                  function_map;
 
    typedef Kokkos::DefaultHostExecutionSpace HostExecSpaceType;
    typedef Kokkos::View<int_t*,              HostExecSpaceType>    host_size_type_array;
    typedef Kokkos::View<int_t*,              HostExecSpaceType>    host_ordinal_type_array;
    typedef Kokkos::View<solver_scalar_type*, HostExecSpaceType>    host_value_type_array;
    typedef typename Kokkos::View<solver_scalar_type**, Kokkos::LayoutLeft,
                                  typename HostExecSpaceType::memory_space> host_solver_scalar_view;
 
 
 
    PardisoMKL(Teuchos::RCP<const Matrix> A,
               Teuchos::RCP<Vector>       X,
               Teuchos::RCP<const Vector> B);
 
 
    ~PardisoMKL( );
 
 
  private:
 
    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);
 
 
    void describe_impl(Teuchos::FancyOStream &out,
                       const Teuchos::EVerbosityLevel verbLevel) const;
 
 
 
    void check_pardiso_mkl_error(EPhase phase, int_t error) const;
 
    void set_pardiso_mkl_matrix_type(int_t mtype = 0);
 
 
    /* Declare private variables necessary for interaction with the
     * PardisoMKL TPL.
     *
     * For example, the following Arrays are persisting storage arrays
     * for A, X, and B that can be used with solvers expecting a
     * compressed-row representation of the matrix A.
     */
 
    host_value_type_array nzvals_view_;
    host_ordinal_type_array colind_view_;
    host_size_type_array rowptr_view_;
    mutable host_solver_scalar_view xvals_;
    mutable host_solver_scalar_view bvals_;
 
    mutable void* pt_[64];
    int_t mtype_;
    int_t n_;
    Teuchos::Array<int_t> perm_;
    mutable int_t nrhs_;
 
    // Partial factorization
    size_t schur_size_;
    int_t partial_facto_;
    host_size_type_array  schur_part_;
    host_value_type_array schur_out_;
    scalar_type* schur_out_ptr_;
    mutable host_solver_scalar_view wvals_;
    bool only_forward_solve_;
    bool only_backward_solve_;
 
    int_t iparm_[64];
 
    // We will deal with 1 factor at a time
    static const int_t maxfct_;
    static const int_t mnum_;
 
 
    static const bool complex_
    = Meta::or_<std::is_same_v<solver_scalar_type, PMKL::_MKL_Complex8>,
                std::is_same_v<solver_scalar_type, PMKL::_DOUBLE_COMPLEX_t>>::value;
 
    bool pardiso_initialized_;
    bool is_contiguous_;
 
    int_t msglvl_;
    int debug_level_;
};                              // End class PardisoMKL
 
 
// Specialize the solver_traits struct for PardisoMKL.
template <>
struct solver_traits<PardisoMKL> {
#ifdef HAVE_TEUCHOS_COMPLEX
  typedef Meta::make_list6<float,
                           double,
                           std::complex<float>,
                           std::complex<double>,
                           PMKL::_MKL_Complex8,
                           PMKL::_DOUBLE_COMPLEX_t> supported_scalars;
#else
typedef Meta::make_list2<float,
                         double> supported_scalars;
#endif
};
 
template <typename Scalar, typename LocalOrdinal, typename ExecutionSpace>
struct solver_supports_matrix<PardisoMKL,
  KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, ExecutionSpace>> {
  static const bool value = true;
};
} // end namespace Amesos
 
#endif  // AMESOS2_PARDISOMKL_DECL_HPP