Amesos2 - Direct Sparse Solver Interfaces  Version of the Day
Amesos2_KLU2_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Amesos2: Templated Direct Sparse Solver Package
4 //
5 // Copyright 2011 NTESS and the Amesos2 contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
18 #ifndef AMESOS2_KLU2_DECL_HPP
19 #define AMESOS2_KLU2_DECL_HPP
20 
21 #include "Amesos2_SolverTraits.hpp"
22 #include "Amesos2_SolverCore.hpp"
24 
25 
26 namespace Amesos2 {
27 
28 
36 template <class Matrix,
37  class Vector>
38 class KLU2 : public SolverCore<Amesos2::KLU2, Matrix, Vector>
39 {
40  friend class SolverCore<Amesos2::KLU2,Matrix,Vector>; // Give our base access
41  // to our private
42  // implementation funcs
43 public:
44 
46  static const char* name; // declaration. Initialization outside.
47 
48  typedef KLU2<Matrix,Vector> type;
49  typedef SolverCore<Amesos2::KLU2,Matrix,Vector> super_type;
50 
51  // Since typedef's are not inheritted, go grab them
52  typedef typename VectorTraits<Vector>::scalar_t vector_scalar_type;
53  typedef typename super_type::scalar_type scalar_type;
54  typedef typename super_type::local_ordinal_type local_ordinal_type;
55  typedef typename super_type::global_ordinal_type global_ordinal_type;
56  typedef typename super_type::global_size_type global_size_type;
57 
58  typedef TypeMap<Amesos2::KLU2,scalar_type> type_map;
59 
60  /*
61  * The KLU2 interface will need two other typedef's, which are:
62  * - the KLU2 type that corresponds to scalar_type and
63  * - the corresponding type to use for magnitude
64  */
65  typedef typename type_map::type klu2_type;
66  typedef typename type_map::dtype klu2_dtype;
67 
68  typedef FunctionMap<Amesos2::KLU2,klu2_type> function_map;
69 
70  typedef Matrix matrix_type;
71  typedef MatrixAdapter<matrix_type> matrix_adapter_type;
72 
74 
75 
82  KLU2(Teuchos::RCP<const Matrix> A,
83  Teuchos::RCP<Vector> X,
84  Teuchos::RCP<const Vector> B);
85 
86 
88  ~KLU2( );
89 
91 
92 private:
93 
98  bool single_proc_optimization() const;
99 
105  int preOrdering_impl();
106 
107 
116 
117 
124 
125 
137  int solve_impl(const Teuchos::Ptr<MultiVecAdapter<Vector> > X,
138  const Teuchos::Ptr<const MultiVecAdapter<Vector> > B) const;
139 
140 
144  bool matrixShapeOK_impl() const;
145 
146 
174  void setParameters_impl(
175  const Teuchos::RCP<Teuchos::ParameterList> & parameterList );
176 
177 
184  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters_impl() const;
185 
186 
195  bool loadA_impl(EPhase current_phase);
196 
197  // struct holds all data necessary for KLU2 factorization or solve call
198  mutable struct KLU2Data {
199  ::KLU2::klu_symbolic<klu2_dtype, local_ordinal_type> *symbolic_;
200  ::KLU2::klu_numeric<klu2_dtype, local_ordinal_type> *numeric_;
201  ::KLU2::klu_common<klu2_dtype, local_ordinal_type> common_;
202  } data_ ;
203 
204  typedef Kokkos::DefaultHostExecutionSpace HostSpaceType;
205  typedef Kokkos::View<local_ordinal_type*, HostSpaceType> host_ordinal_type_array;
206 
207  typedef Kokkos::View<klu2_type*, HostSpaceType> host_value_type_array;
208 
209  // The following Views are persisting storage arrays for A, X, and B
211  host_value_type_array host_nzvals_view_;
212 
214  host_ordinal_type_array host_rows_view_;
216  host_ordinal_type_array host_col_ptr_view_;
217 
218  typedef typename Kokkos::View<klu2_type**, Kokkos::LayoutLeft, HostSpaceType>
219  host_solve_array_t;
220 
222  mutable host_solve_array_t xValues_;
223 
225  mutable host_solve_array_t bValues_;
226 
230 
231  bool is_contiguous_;
232  bool use_gather_;
233 }; // End class KLU2
234 
235 
236 // Specialize solver_traits struct for KLU2
237 template <>
238 struct solver_traits<KLU2> {
239 #ifdef HAVE_TEUCHOS_COMPLEX
240  typedef Meta::make_list6<float,
241  double,
242  Kokkos::complex<float>,
243  Kokkos::complex<double>,
244  std::complex<float>,
245  std::complex<double> > supported_scalars;
246 #else
247  typedef Meta::make_list2<float, double> supported_scalars;
248 #endif
249 };
250 
251 template <typename Scalar, typename LocalOrdinal, typename ExecutionSpace>
252 struct solver_supports_matrix<KLU2,
253  KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, ExecutionSpace>> {
254  static const bool value = true;
255 };
256 
257 } // end namespace Amesos2
258 
259 #endif // AMESOS2_KLU2_DECL_HPP
Amesos2::SolverCore: A templated interface for interaction with third-party direct sparse solvers...
Definition: Amesos2_SolverCore_decl.hpp:71
int solve_impl(const Teuchos::Ptr< MultiVecAdapter< Vector > > X, const Teuchos::Ptr< const MultiVecAdapter< Vector > > B) const
KLU2 specific solve.
Definition: Amesos2_KLU2_def.hpp:196
bool loadA_impl(EPhase current_phase)
Reads matrix data into internal structures.
Definition: Amesos2_KLU2_def.hpp:456
Map types to solver-specific data-types and enums.
Definition: Amesos2_TypeMap.hpp:48
host_solve_array_t bValues_
Persisting 1D store for B.
Definition: Amesos2_KLU2_decl.hpp:225
host_solve_array_t xValues_
Persisting 1D store for X.
Definition: Amesos2_KLU2_decl.hpp:222
host_ordinal_type_array host_rows_view_
Stores the location in Ai_ and Aval_ that starts row j.
Definition: Amesos2_KLU2_decl.hpp:214
Provides a mechanism to map function calls to the correct Solver function based on the scalar type of...
Provides traits about solvers.
Definition: Amesos2_SolverTraits.hpp:37
host_ordinal_type_array host_col_ptr_view_
Stores the row indices of the nonzero entries.
Definition: Amesos2_KLU2_decl.hpp:216
void setParameters_impl(const Teuchos::RCP< Teuchos::ParameterList > &parameterList)
Definition: Amesos2_KLU2_def.hpp:394
int symbolicFactorization_impl()
Perform symbolic factorization of the matrix using KLU2.
Definition: Amesos2_KLU2_def.hpp:98
int preOrdering_impl()
Performs pre-ordering on the matrix to increase efficiency.
Definition: Amesos2_KLU2_def.hpp:84
bool matrixShapeOK_impl() const
Determines whether the shape of the matrix is OK for this solver.
Definition: Amesos2_KLU2_def.hpp:383
A Matrix adapter interface for Amesos2.
Definition: Amesos2_MatrixAdapter_decl.hpp:42
std::string name() const override
Return the name of this solver.
Definition: Amesos2_SolverCore_def.hpp:738
int numericFactorization_impl()
KLU2 specific numeric factorization.
Definition: Amesos2_KLU2_def.hpp:128
Amesos2 interface to the KLU2 package.
Definition: Amesos2_KLU2_decl.hpp:38
Passes functions to TPL functions based on type.
Definition: Amesos2_FunctionMap.hpp:42
bool single_proc_optimization() const
can we optimize size_type and ordinal_type for straight pass through, also check that is_contiguous_ ...
Definition: Amesos2_KLU2_def.hpp:78
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters_impl() const
Definition: Amesos2_KLU2_def.hpp:422
host_value_type_array host_nzvals_view_
Stores the values of the nonzero entries for CHOLMOD.
Definition: Amesos2_KLU2_decl.hpp:211
Provides access to interesting solver traits.
int transFlag_
Definition: Amesos2_KLU2_decl.hpp:229