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
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
63namespace Amesos2 {
64
72template <class Matrix,class Vector>
73class Basker : public SolverCore<Amesos2::Basker, Matrix, Vector>
74{
75 friend class SolverCore<Amesos2::Basker,Matrix,Vector>; // Give our base access
76 // to our private
77 // implementation funcs
78public:
79
81 static const char* name; // declaration. Initialization outside.
82
83
84 typedef Amesos2::Basker<Matrix,Vector> type;
85
86 typedef SolverCore<Amesos2::Basker,Matrix,Vector> super_type;
87
88 // Since typedef's are not inheritted, go grab them
89 typedef typename super_type::scalar_type scalar_type;
90 typedef typename super_type::local_ordinal_type local_ordinal_type;
91 typedef typename super_type::global_ordinal_type global_ordinal_type;
92 typedef typename super_type::global_size_type global_size_type;
93 typedef typename super_type::node_type node_type;
94
95 typedef TypeMap<Amesos2::Basker,scalar_type> type_map;
96
97 typedef typename type_map::type basker_type;
98
99 typedef typename type_map::dtype basker_dtype;
100
101 typedef FunctionMap<Amesos2::Basker,basker_type> function_map;
102
103 typedef Matrix matrix_type;
104 typedef MatrixAdapter<matrix_type> matrix_adapter_type;
105
106
107 Basker( Teuchos::RCP<const Matrix> A,
108 Teuchos::RCP<Vector> X,
109 Teuchos::RCP<const Vector> B);
110 ~Basker( );
111
112
113private:
114
119 bool single_proc_optimization() const;
120
126 int preOrdering_impl();
127
128
129 int symbolicFactorization_impl();
130
131
138
139
151 int solve_impl(const Teuchos::Ptr<MultiVecAdapter<Vector> > X,
152 const Teuchos::Ptr<const MultiVecAdapter<Vector> > B) const;
153
154
158 bool matrixShapeOK_impl() const;
159
160
161 void setParameters_impl(
162 const Teuchos::RCP<Teuchos::ParameterList> & parameterList );
163
164
171 Teuchos::RCP<const Teuchos::ParameterList> getValidParameters_impl() const;
172
173
182 bool loadA_impl(EPhase current_phase);
183
184
185 // Members
186 int num_threads;
187
188 typedef Kokkos::DefaultHostExecutionSpace HostSpaceType;
189 typedef Kokkos::View<local_ordinal_type*, HostSpaceType> host_ordinal_type_array;
190
191 typedef Kokkos::View<basker_type*, HostSpaceType> host_value_type_array;
192
193 // The following Views are persisting storage arrays for A, X, and B
195 host_value_type_array host_nzvals_view_;
197 host_ordinal_type_array host_rows_view_;
199 host_ordinal_type_array host_col_ptr_view_;
200
201 bool is_contiguous_;
202
203 typedef typename Kokkos::View<basker_type**, Kokkos::LayoutLeft, HostSpaceType>
204 host_solve_array_t;
205
207 mutable host_solve_array_t xValues_;
208
210 mutable host_solve_array_t bValues_;
211
212 /*Handle for Basker object*/
213 mutable ::BaskerClassicNS::BaskerClassic<local_ordinal_type,basker_dtype> basker;
214
215}; // End class Basker
216
217
218// Specialize solver_traits struct for Basker
219// TODO
220template <>
221struct solver_traits<Basker> {
222#ifdef HAVE_TEUCHOS_COMPLEX
223 typedef Meta::make_list6<float,
224 double,
225 Kokkos::complex<float>,
226 Kokkos::complex<double>,
227 std::complex<float>,
228 std::complex<double> > supported_scalars;
229#else
230 typedef Meta::make_list2<float, double> supported_scalars;
231#endif
232};
233
234template <typename Scalar, typename LocalOrdinal, typename ExecutionSpace>
235struct solver_supports_matrix<Basker,
236 KokkosSparse::CrsMatrix<Scalar, LocalOrdinal, ExecutionSpace>> {
237 static const bool value = true;
238};
239
240} // end namespace Amesos2
241
242#endif // AMESOS2_BASKER_DECL_HPP
Provides access to interesting solver traits.
Amesos2 interface to the Baker package.
Definition: Amesos2_Basker_decl.hpp:74
int preOrdering_impl()
Performs pre-ordering on the matrix to increase efficiency.
Definition: Amesos2_Basker_def.hpp:91
bool matrixShapeOK_impl() const
Determines whether the shape of the matrix is OK for this solver.
Definition: Amesos2_Basker_def.hpp:262
host_ordinal_type_array host_rows_view_
Stores the location in Ai_ and Aval_ that starts row j.
Definition: Amesos2_Basker_decl.hpp:197
bool loadA_impl(EPhase current_phase)
Reads matrix data into internal structures.
Definition: Amesos2_Basker_def.hpp:308
host_solve_array_t bValues_
Persisting 1D store for B.
Definition: Amesos2_Basker_decl.hpp:210
host_solve_array_t xValues_
Persisting 1D store for X.
Definition: Amesos2_Basker_decl.hpp:207
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:166
bool single_proc_optimization() const
can we optimize size_type and ordinal_type for straight pass through,
Definition: Amesos2_Basker_def.hpp:85
host_ordinal_type_array host_col_ptr_view_
Stores the row indices of the nonzero entries.
Definition: Amesos2_Basker_decl.hpp:199
host_value_type_array host_nzvals_view_
Stores the values of the nonzero entries for CHOLMOD.
Definition: Amesos2_Basker_decl.hpp:195
int numericFactorization_impl()
Basker specific numeric factorization.
Definition: Amesos2_Basker_def.hpp:114
static const char * name
Name of this solver interface.
Definition: Amesos2_Basker_decl.hpp:81
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters_impl() const
Definition: Amesos2_Basker_def.hpp:288
A Matrix adapter interface for Amesos2.
Definition: Amesos2_MatrixAdapter_decl.hpp:76
Amesos2::SolverCore: A templated interface for interaction with third-party direct sparse solvers.
Definition: Amesos2_SolverCore_decl.hpp:106
Passes functions to TPL functions based on type.
Definition: Amesos2_FunctionMap.hpp:77
Map types to solver-specific data-types and enums.
Definition: Amesos2_TypeMap.hpp:82
Provides traits about solvers.
Definition: Amesos2_SolverTraits.hpp:71