Amesos2 - Direct Sparse Solver Interfaces  Version of the Day
Amesos2_Basker_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 
53 #ifndef AMESOS2_BASKER_DECL_HPP
54 #define AMESOS2_BASKER_DECL_HPP
55 
56 #include "Amesos2_SolverTraits.hpp"
57 #include "Amesos2_SolverCore.hpp"
58 #include "Amesos2_Basker_FunctionMap.hpp"
59 
60 //Note: We got an error while being a class variable and mutable. Need to comeback and fix!!
61 
62 
63 namespace Amesos2 {
64 
65 
73 template <class Matrix,class Vector>
74 class Basker : public SolverCore<Amesos2::Basker, Matrix, Vector>
75 {
76  friend class SolverCore<Amesos2::Basker,Matrix,Vector>; // Give our base access
77  // to our private
78  // implementation funcs
79 public:
80 
82  static const char* name; // declaration. Initialization outside.
83 
84 
85  typedef Basker<Matrix,Vector> type;
86 
87 
88  typedef SolverCore<Amesos2::Basker,Matrix,Vector> super_type;
89 
90  // Since typedef's are not inheritted, go grab them
91  typedef typename super_type::scalar_type scalar_type;
92  typedef typename super_type::local_ordinal_type local_ordinal_type;
93  typedef typename super_type::global_ordinal_type global_ordinal_type;
94  typedef typename super_type::global_size_type global_size_type;
95  typedef typename super_type::node_type node_type;
96 
97 
98  typedef TypeMap<Amesos2::Basker,scalar_type> type_map;
99 
100 
101  typedef typename type_map::type slu_type;
102  typedef typename type_map::magnitude_type magnitude_type;
103 
104  typedef FunctionMap<Amesos2::Basker,slu_type> function_map;
105 
106 
107  Basker(Teuchos::RCP<const Matrix> A,
108  Teuchos::RCP<Vector> X,
109  Teuchos::RCP<const Vector> B);
110  ~Basker( );
111 
112 
113 private:
114 
120  int preOrdering_impl();
121 
122 
123  int symbolicFactorization_impl();
124 
125 
132 
133 
145  int solve_impl(const Teuchos::Ptr<MultiVecAdapter<Vector> > X,
146  const Teuchos::Ptr<const MultiVecAdapter<Vector> > B) const;
147 
148 
152  bool matrixShapeOK_impl() const;
153 
154 
155  void setParameters_impl(
156  const Teuchos::RCP<Teuchos::ParameterList> & parameterList );
157 
158 
165  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters_impl() const;
166 
167 
176  bool loadA_impl(EPhase current_phase);
177 
178 
179 
180  int num_threads;
181 
182  // The following Arrays are persisting storage arrays for A, X, and B
184  Teuchos::Array<slu_type> nzvals_;
186  Teuchos::Array<local_ordinal_type> rowind_;
188  Teuchos::Array<local_ordinal_type> colptr_;
189 
191  mutable Teuchos::Array<slu_type> xvals_; local_ordinal_type ldx_;
193  mutable Teuchos::Array<slu_type> bvals_; local_ordinal_type ldb_;
194 
195 
196 
197 
198  /*Handle for Basker object*/
199 
200 #ifdef SHYLUBASKER
201 #ifdef HAVE_AMESOS2_KOKKOS
202 #ifdef KOKKOS_HAVE_OPENMP
203  /*
204  typedef typename node_type::device_type kokkos_device;
205  typedef typename kokkos_device::execution_space kokkos_exe;
206  static_assert(std::is_same<kokkos_exe,Kokkos::OpenMP>::value,
207  "Kokkos node type not support by experimental Basker Amesos2");
208  */
209  typedef Kokkos::OpenMP Exe_Space;
210 #elif defined(KOKKOS_HAVE_SERIAL)
211  typedef Kokkos::Serial Exe_Space;
212 #else
213 #pragma message("Kokkos Node type not supported by Basker")
214 #endif // OpenMP vs Serial
215  ::BaskerNS::Basker<local_ordinal_type,slu_type,Exe_Space>
216  *basker;
217 #else
218  #pragma message("HAVE SHYLUBASKER AND NOT KOKKOS! ERROR")
219 #endif
220 #else
221  mutable ::Basker::Basker<local_ordinal_type,slu_type> basker;
222  #endif
223 
224 
225 }; // End class Basker
226 
227 
228 // Specialize solver_traits struct for Basker
229 // TODO
230 template <>
231 struct solver_traits<Basker> {
232 #ifdef HAVE_TEUCHOS_COMPLEX
233  typedef Meta::make_list4<float,
234  double,
235  std::complex<float>,
236  std::complex<double> > supported_scalars;
237 #else
238  typedef Meta::make_list2<float, double> supported_scalars;
239 #endif
240 };
241 
242 } // end namespace Amesos2
243 
244 #endif // AMESOS2_BASKER_DECL_HPP
Amesos2::SolverCore: A templated interface for interaction with third-party direct sparse solvers...
Definition: Amesos2_SolverCore_decl.hpp:105
Definition: basker.cpp:35
Map types to solver-specific data-types and enums.
Definition: Amesos2_TypeMap.hpp:82
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters_impl() const
Definition: Amesos2_Basker_def.hpp:399
Teuchos::Array< slu_type > bvals_
Persisting 1D store for B.
Definition: Amesos2_Basker_decl.hpp:193
bool loadA_impl(EPhase current_phase)
Reads matrix data into internal structures.
Definition: Amesos2_Basker_def.hpp:454
Provides traits about solvers.
Definition: Amesos2_SolverTraits.hpp:70
Teuchos::Array< local_ordinal_type > colptr_
Stores the row indices of the nonzero entries.
Definition: Amesos2_Basker_decl.hpp:188
Definition: Amesos2_AbstractConcreteMatrixAdapter.hpp:48
int solve_impl(const Teuchos::Ptr< MultiVecAdapter< Vector > > X, const Teuchos::Ptr< const MultiVecAdapter< Vector > > B) const
Basker specific solve.
Definition: Amesos2_Basker_def.hpp:253
Amesos2 interface to the Baker package.
Definition: Amesos2_Basker_decl.hpp:74
Teuchos::Array< local_ordinal_type > rowind_
Stores the location in Ai_ and Aval_ that starts row j.
Definition: Amesos2_Basker_decl.hpp:186
Teuchos::Array< slu_type > xvals_
Persisting 1D store for X.
Definition: Amesos2_Basker_decl.hpp:191
Teuchos::Array< slu_type > nzvals_
Stores the values of the nonzero entries for Basker.
Definition: Amesos2_Basker_decl.hpp:184
std::string name() const
Return the name of this solver.
Definition: Amesos2_SolverCore_def.hpp:505
Passes functions to TPL functions based on type.
Definition: Amesos2_FunctionMap.hpp:76
int preOrdering_impl()
Performs pre-ordering on the matrix to increase efficiency.
Definition: Amesos2_Basker_def.hpp:134
Provides access to interesting solver traits.
int numericFactorization_impl()
Basker specific numeric factorization.
Definition: Amesos2_Basker_def.hpp:186
bool matrixShapeOK_impl() const
Determines whether the shape of the matrix is OK for this solver.
Definition: Amesos2_Basker_def.hpp:322