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 
72 template <class Matrix,class Vector>
73 class 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
78 public:
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 slu_type;
98  typedef typename type_map::magnitude_type magnitude_type;
99 
100  typedef FunctionMap<Amesos2::Basker,slu_type> function_map;
101 
102  typedef Matrix matrix_type;
103  typedef MatrixAdapter<matrix_type> matrix_adapter_type;
104 
105 
106  Basker( Teuchos::RCP<const Matrix> A,
107  Teuchos::RCP<Vector> X,
108  Teuchos::RCP<const Vector> B);
109  ~Basker( );
110 
111 
112 private:
113 
118  bool single_proc_optimization() const;
119 
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  // The following Arrays are persisting storage arrays for A, X, and B
190  Teuchos::Array<slu_type> nzvals_;
192  Teuchos::Array<local_ordinal_type> rowind_;
194  Teuchos::Array<local_ordinal_type> colptr_;
195 
196  bool is_contiguous_;
197 
198 
200  mutable Teuchos::Array<slu_type> xvals_; local_ordinal_type ldx_;
202  mutable Teuchos::Array<slu_type> bvals_; local_ordinal_type ldb_;
203 
204  /*Handle for Basker object*/
205  mutable ::BaskerClassicNS::BaskerClassic<local_ordinal_type,slu_type> basker;
206 
207 }; // End class Basker
208 
209 
210 // Specialize solver_traits struct for Basker
211 // TODO
212 template <>
213 struct solver_traits<Basker> {
214 #ifdef HAVE_TEUCHOS_COMPLEX
215  typedef Meta::make_list4<float,
216  double,
217  std::complex<float>,
218  std::complex<double> > supported_scalars;
219 #else
220  typedef Meta::make_list2<float, double> supported_scalars;
221 #endif
222 };
223 
224 } // end namespace Amesos2
225 
226 #endif // AMESOS2_BASKER_DECL_HPP
Amesos2::SolverCore: A templated interface for interaction with third-party direct sparse solvers...
Definition: Amesos2_SolverCore_decl.hpp:105
Map types to solver-specific data-types and enums.
Definition: Amesos2_TypeMap.hpp:82
Teuchos::Array< slu_type > bvals_
Persisting 1D store for B.
Definition: Amesos2_Basker_decl.hpp:202
bool loadA_impl(EPhase current_phase)
Reads matrix data into internal structures.
Definition: Amesos2_Basker_def.hpp:336
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters_impl() const
Definition: Amesos2_Basker_def.hpp:316
std::string name() const
Return the name of this solver.
Definition: Amesos2_SolverCore_def.hpp:509
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:194
Amesos2 interface to the Baker package.
Definition: Amesos2_Basker_decl.hpp:73
Teuchos::Array< local_ordinal_type > rowind_
Stores the location in Ai_ and Aval_ that starts row j.
Definition: Amesos2_Basker_decl.hpp:192
Teuchos::Array< slu_type > xvals_
Persisting 1D store for X.
Definition: Amesos2_Basker_decl.hpp:200
bool single_proc_optimization() const
can we optimize size_type and ordinal_type for straight pass through, also check that is_contiguous_ ...
Definition: Amesos2_Basker_def.hpp:88
A Matrix adapter interface for Amesos2.
Definition: Amesos2_MatrixAdapter_decl.hpp:76
Teuchos::Array< slu_type > nzvals_
Stores the values of the nonzero entries for Basker.
Definition: Amesos2_Basker_decl.hpp:190
bool matrixShapeOK_impl() const
Determines whether the shape of the matrix is OK for this solver.
Definition: Amesos2_Basker_def.hpp:290
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:94
Provides access to interesting solver traits.
int numericFactorization_impl()
Basker specific numeric factorization.
Definition: Amesos2_Basker_def.hpp:117
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:168