Amesos2 - Direct Sparse Solver Interfaces  Version of the Day
Amesos2_ShyLUBasker_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 
54 #ifndef AMESOS2_SHYLUBASKER_DECL_HPP
55 #define AMESOS2_SHYLUBASKER_DECL_HPP
56 
57 #include "Amesos2_SolverTraits.hpp"
58 #include "Amesos2_SolverCore.hpp"
59 #include "Amesos2_ShyLUBasker_FunctionMap.hpp"
60 
61 #include "shylubasker_decl.hpp"
62 #include "shylubasker_def.hpp"
63 #include "shylubasker_trilinos_decl.hpp"
64 
65 
66 namespace Amesos2 {
67 
75 template <class Matrix,class Vector>
76 class ShyLUBasker : public SolverCore<Amesos2::ShyLUBasker, Matrix, Vector>
77 {
78  friend class SolverCore<Amesos2::ShyLUBasker,Matrix,Vector>; // Give our base access
79  // to our private
80  // implementation funcs
81 public:
82 
84  static const char* name; // declaration. Initialization outside.
85 
86 
87  typedef ShyLUBasker<Matrix,Vector> type;
88 
89  typedef SolverCore<Amesos2::ShyLUBasker,Matrix,Vector> super_type;
90 
91  // Since typedef's are not inheritted, go grab them
92  typedef typename super_type::scalar_type scalar_type;
93  typedef typename super_type::local_ordinal_type local_ordinal_type;
94  typedef typename super_type::global_ordinal_type global_ordinal_type;
95  typedef typename super_type::global_size_type global_size_type;
96  typedef typename super_type::node_type node_type;
97 
98  typedef TypeMap<Amesos2::ShyLUBasker,scalar_type> type_map;
99 
100  typedef typename type_map::type slu_type;
101  typedef typename type_map::magnitude_type magnitude_type;
102 
103  typedef FunctionMap<Amesos2::ShyLUBasker,slu_type> function_map;
104 
105  typedef Matrix matrix_type;
106  typedef MatrixAdapter<matrix_type> matrix_adapter_type;
107 
108 
109  ShyLUBasker( Teuchos::RCP<const Matrix> A,
110  Teuchos::RCP<Vector> X,
111  Teuchos::RCP<const Vector> B);
112  ~ShyLUBasker( );
113 
114 
115 private:
116 
121  bool single_proc_optimization() const;
122 
123 
129  int preOrdering_impl();
130 
131 
132  int symbolicFactorization_impl();
133 
134 
141 
142 
154  int solve_impl(const Teuchos::Ptr<MultiVecAdapter<Vector> > X,
155  const Teuchos::Ptr<const MultiVecAdapter<Vector> > B) const;
156 
157 
161  bool matrixShapeOK_impl() const;
162 
163 
164  void setParameters_impl(
165  const Teuchos::RCP<Teuchos::ParameterList> & parameterList );
166 
167 
174  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters_impl() const;
175 
176 
185  bool loadA_impl(EPhase current_phase);
186 
187 
188  // Members
189  int num_threads;
190 
191  // The following Arrays are persisting storage arrays for A, X, and B
193  Teuchos::Array<slu_type> nzvals_;
195  Teuchos::Array<local_ordinal_type> rowind_;
197  Teuchos::Array<local_ordinal_type> colptr_;
198 
199  bool is_contiguous_;
200 
201 
203  mutable Teuchos::Array<slu_type> xvals_; local_ordinal_type ldx_;
205  mutable Teuchos::Array<slu_type> bvals_; local_ordinal_type ldb_;
206 
207  /*Handle for ShyLUBasker object*/
208 
209 #if defined( HAVE_AMESOS2_KOKKOS ) && defined( KOKKOS_ENABLE_OPENMP )
210  /*
211  typedef typename node_type::device_type kokkos_device;
212  typedef typename kokkos_device::execution_space kokkos_exe;
213  static_assert(std::is_same<kokkos_exe,Kokkos::OpenMP>::value,
214  "Kokkos node type not support by experimental ShyLUBasker Amesos2");
215  */
216  typedef Kokkos::OpenMP Exe_Space;
217  ::BaskerNS::BaskerTrilinosInterface<local_ordinal_type, slu_type, Exe_Space> *ShyLUbasker;
218 #else
219  #pragma message("Amesos_ShyLUBasker_decl Error: ENABLED SHYLU_NODEBASKER BUT NOT KOKKOS or NOT OPENMP!")
220 #endif
221 
222 
223 }; // End class ShyLUBasker
224 
225 
226 // Specialize solver_traits struct for ShyLUBasker
227 // TODO
228 template <>
229 struct solver_traits<ShyLUBasker> {
230 #ifdef HAVE_TEUCHOS_COMPLEX
231  typedef Meta::make_list4<float,
232  double,
233  std::complex<float>,
234  std::complex<double> > supported_scalars;
235 #else
236  typedef Meta::make_list2<float, double> supported_scalars;
237 #endif
238 };
239 
240 } // end namespace Amesos2
241 
242 #endif // AMESOS2_SHYLUBASKER_DECL_HPP
Amesos2::SolverCore: A templated interface for interaction with third-party direct sparse solvers...
Definition: Amesos2_SolverCore_decl.hpp:105
int solve_impl(const Teuchos::Ptr< MultiVecAdapter< Vector > > X, const Teuchos::Ptr< const MultiVecAdapter< Vector > > B) const
ShyLUBasker specific solve.
Definition: Amesos2_ShyLUBasker_def.hpp:319
Map types to solver-specific data-types and enums.
Definition: Amesos2_TypeMap.hpp:82
Teuchos::Array< slu_type > nzvals_
Stores the values of the nonzero entries for ShyLUBasker.
Definition: Amesos2_ShyLUBasker_decl.hpp:193
Amesos2 interface to the Baker package.
Definition: Amesos2_ShyLUBasker_decl.hpp:76
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters_impl() const
Definition: Amesos2_ShyLUBasker_def.hpp:519
Teuchos::Array< slu_type > bvals_
Persisting 1D store for B.
Definition: Amesos2_ShyLUBasker_decl.hpp:205
Teuchos::Array< slu_type > xvals_
Persisting 1D store for X.
Definition: Amesos2_ShyLUBasker_decl.hpp:203
std::string name() const
Return the name of this solver.
Definition: Amesos2_SolverCore_def.hpp:509
int preOrdering_impl()
Performs pre-ordering on the matrix to increase efficiency.
Definition: Amesos2_ShyLUBasker_def.hpp:128
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_ShyLUBasker_decl.hpp:197
bool matrixShapeOK_impl() const
Determines whether the shape of the matrix is OK for this solver.
Definition: Amesos2_ShyLUBasker_def.hpp:439
Teuchos::Array< local_ordinal_type > rowind_
Stores the location in Ai_ and Aval_ that starts row j.
Definition: Amesos2_ShyLUBasker_decl.hpp:195
bool loadA_impl(EPhase current_phase)
Reads matrix data into internal structures.
Definition: Amesos2_ShyLUBasker_def.hpp:564
A Matrix adapter interface for Amesos2.
Definition: Amesos2_MatrixAdapter_decl.hpp:76
int numericFactorization_impl()
ShyLUBasker specific numeric factorization.
Definition: Amesos2_ShyLUBasker_def.hpp:215
Passes functions to TPL functions based on type.
Definition: Amesos2_FunctionMap.hpp:76
Provides access to interesting solver traits.
bool single_proc_optimization() const
can we optimize size_type and ordinal_type for straight pass through, also check that is_contiguous_ ...
Definition: Amesos2_ShyLUBasker_def.hpp:122