Amesos2 - Direct Sparse Solver Interfaces  Version of the Day
Amesos2_KLU2_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // Amesos2: Templated Direct Sparse Solver Package
6 // Copyright 2011 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ***********************************************************************
41 //
42 // @HEADER
43 
52 #ifndef AMESOS2_KLU2_DECL_HPP
53 #define AMESOS2_KLU2_DECL_HPP
54 
55 #include "Amesos2_SolverTraits.hpp"
56 #include "Amesos2_SolverCore.hpp"
58 
59 
60 namespace Amesos2 {
61 
62 
70 template <class Matrix,
71  class Vector>
72 class KLU2 : public SolverCore<Amesos2::KLU2, Matrix, Vector>
73 {
74  friend class SolverCore<Amesos2::KLU2,Matrix,Vector>; // Give our base access
75  // to our private
76  // implementation funcs
77 public:
78 
80  static const char* name; // declaration. Initialization outside.
81 
82  typedef KLU2<Matrix,Vector> type;
83  typedef SolverCore<Amesos2::KLU2,Matrix,Vector> super_type;
84 
85  // Since typedef's are not inheritted, go grab them
86  typedef typename super_type::scalar_type scalar_type;
87  typedef typename super_type::local_ordinal_type local_ordinal_type;
88  typedef typename super_type::global_ordinal_type global_ordinal_type;
89  typedef typename super_type::global_size_type global_size_type;
90 
91  typedef TypeMap<Amesos2::KLU2,scalar_type> type_map;
92 
93  /*
94  * The KLU2 interface will need two other typedef's, which are:
95  * - the KLU2 type that corresponds to scalar_type and
96  * - the corresponding type to use for magnitude
97  */
98  typedef typename type_map::type slu_type;
99  typedef typename type_map::magnitude_type magnitude_type;
100 
101  typedef FunctionMap<Amesos2::KLU2,slu_type> function_map;
102 
104 
105 
112  KLU2(Teuchos::RCP<const Matrix> A,
113  Teuchos::RCP<Vector> X,
114  Teuchos::RCP<const Vector> B);
115 
116 
118  ~KLU2( );
119 
121 
122 private:
123 
129  int preOrdering_impl();
130 
131 
140 
141 
148 
149 
161  int solve_impl(const Teuchos::Ptr<MultiVecAdapter<Vector> > X,
162  const Teuchos::Ptr<const MultiVecAdapter<Vector> > B) const;
163 
164 
168  bool matrixShapeOK_impl() const;
169 
170 
198  void setParameters_impl(
199  const Teuchos::RCP<Teuchos::ParameterList> & parameterList );
200 
201 
208  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters_impl() const;
209 
210 
219  bool loadA_impl(EPhase current_phase);
220 
221  // struct holds all data necessary for KLU2 factorization or solve call
222  mutable struct KLU2Data {
223  ::KLU2::klu_symbolic<slu_type, local_ordinal_type> *symbolic_;
224  ::KLU2::klu_numeric<slu_type, local_ordinal_type> *numeric_;
225  ::KLU2::klu_common<slu_type, local_ordinal_type> common_;
226  } data_ ;
227 
228  // The following Arrays are persisting storage arrays for A, X, and B
230  Teuchos::Array<slu_type> nzvals_;
232  Teuchos::Array<local_ordinal_type> rowind_;
234  Teuchos::Array<local_ordinal_type> colptr_;
235 
237  Teuchos::Array<slu_type> xvals_; local_ordinal_type ldx_;
239  Teuchos::Array<slu_type> bvals_; local_ordinal_type ldb_;
240 
241 }; // End class KLU2
242 
243 
244 // Specialize solver_traits struct for KLU2
245 // TODO
246 template <>
247 struct solver_traits<KLU2> {
248 #ifdef HAVE_TEUCHOS_COMPLEX
249  typedef Meta::make_list4<float,
250  double,
251  std::complex<float>,
252  std::complex<double> > supported_scalars;
253 #else
254  typedef Meta::make_list2<float, double> supported_scalars;
255 #endif
256 };
257 
258 } // end namespace Amesos2
259 
260 #endif // AMESOS2_KLU2_DECL_HPP
Teuchos::Array< slu_type > bvals_
Persisting 1D store for B.
Definition: Amesos2_KLU2_decl.hpp:239
Amesos2::SolverCore: A templated interface for interaction with third-party direct sparse solvers...
Definition: Amesos2_SolverCore_decl.hpp:105
Teuchos::Array< slu_type > nzvals_
Stores the values of the nonzero entries for KLU2.
Definition: Amesos2_KLU2_decl.hpp:230
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:191
Teuchos::Array< slu_type > xvals_
Persisting 1D store for X.
Definition: Amesos2_KLU2_decl.hpp:237
bool loadA_impl(EPhase current_phase)
Reads matrix data into internal structures.
Definition: Amesos2_KLU2_def.hpp:328
Map types to solver-specific data-types and enums.
Definition: Amesos2_TypeMap.hpp:82
Provides a mechanism to map function calls to the correct Solver function based on the scalar type of...
std::string name() const
Return the name of this solver.
Definition: Amesos2_SolverCore_def.hpp:502
Provides traits about solvers.
Definition: Amesos2_SolverTraits.hpp:70
Definition: Amesos2_AbstractConcreteMatrixAdapter.hpp:48
void setParameters_impl(const Teuchos::RCP< Teuchos::ParameterList > &parameterList)
Definition: Amesos2_KLU2_def.hpp:281
int symbolicFactorization_impl()
Perform symbolic factorization of the matrix using KLU2.
Definition: Amesos2_KLU2_def.hpp:126
Definition: Amesos2_KLU2_FunctionMap.hpp:67
int preOrdering_impl()
Performs pre-ordering on the matrix to increase efficiency.
Definition: Amesos2_KLU2_def.hpp:112
Teuchos::Array< local_ordinal_type > rowind_
Stores the location in Ai_ and Aval_ that starts row j.
Definition: Amesos2_KLU2_decl.hpp:232
bool matrixShapeOK_impl() const
Determines whether the shape of the matrix is OK for this solver.
Definition: Amesos2_KLU2_def.hpp:270
int numericFactorization_impl()
KLU2 specific numeric factorization.
Definition: Amesos2_KLU2_def.hpp:138
Teuchos::Array< local_ordinal_type > colptr_
Stores the row indices of the nonzero entries.
Definition: Amesos2_KLU2_decl.hpp:234
Amesos2 interface to the KLU2 package.
Definition: Amesos2_KLU2_decl.hpp:72
Passes functions to TPL functions based on type.
Definition: Amesos2_FunctionMap.hpp:76
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters_impl() const
Definition: Amesos2_KLU2_def.hpp:308
Provides access to interesting solver traits.