Amesos2 - Direct Sparse Solver Interfaces  Version of the Day
Amesos2_MUMPS_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_MUMPS_DECL_HPP
53 #define AMESOS2_MUMPS_DECL_HPP
54 
55 #include "Amesos2_SolverTraits.hpp"
56 #include "Amesos2_SolverCore.hpp"
58 
59 
60 namespace Amesos2 {
61 
62 
77 template <class Matrix,class Vector>
78 class MUMPS : public SolverCore<Amesos2::MUMPS, Matrix, Vector>
79 {
80  friend class SolverCore<Amesos2::MUMPS,Matrix,Vector>; // Give our base access
81  // to our private
82  // implementation funcs
83 public:
84 
86  static const char* name; // declaration. Initialization outside.
87 
88  typedef MUMPS<Matrix,Vector> type;
89  typedef SolverCore<Amesos2::MUMPS,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 
97  typedef TypeMap<Amesos2::MUMPS,scalar_type> type_map;
98 
99  typedef typename type_map::type slu_type;
100  typedef typename type_map::magnitude_type magnitude_type;
101  typedef typename type_map::MUMPS_STRUC_C MUMPS_STRUC_C;
102 
103  typedef FunctionMap<Amesos2::MUMPS,slu_type> function_map;
104 
105  MUMPS(Teuchos::RCP<const Matrix> A,
106  Teuchos::RCP<Vector> X,
107  Teuchos::RCP<const Vector> B);
108  ~MUMPS( );
109 
110 
111 private:
112 
118  int preOrdering_impl();
119 
120 
121  int symbolicFactorization_impl();
122 
123 
130 
131 
143  int solve_impl(const Teuchos::Ptr<MultiVecAdapter<Vector> > X,
144  const Teuchos::Ptr<const MultiVecAdapter<Vector> > B) const;
145 
146 
150  bool matrixShapeOK_impl() const;
151 
167  void setParameters_impl(
168  const Teuchos::RCP<Teuchos::ParameterList> & parameterList );
169 
170 
177  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters_impl() const;
178 
179 
188  bool loadA_impl(EPhase current_phase);
189 
190 
191  int ConvertToTriplet();
192 
193  void MUMPS_ERROR() const;
194 
195 #ifdef HAVE_MPI
196  MPI_Comm MUMPSComm;
197 #endif
198 
199 
200  bool MUMPS_MATRIX_LOAD;
201  bool MUMPS_STRUCT;
202 
203  // The following Arrays are persisting storage arrays for A, X, and B
205  Teuchos::Array<slu_type> nzvals_;
207  Teuchos::Array<local_ordinal_type> rowind_;
209  Teuchos::Array<local_ordinal_type> colptr_;
210 
212  mutable Teuchos::Array<slu_type> xvals_; local_ordinal_type ldx_;
214  mutable Teuchos::Array<slu_type> bvals_; local_ordinal_type ldb_;
215 
216  mutable MUMPS_STRUC_C mumps_par;
217 
218 }; // End class MUMPS
219 
220 
221 template <class Matrix,class Vector>
222 class MUMPSNS : public SolverCore<Amesos2::MUMPS, Matrix, Vector>
223 {
224  friend class SolverCore<Amesos2::MUMPS,Matrix,Vector>; // Give our base access
225  // to our private
226  // implementation funcs
227 public:
228 
229 
230  MUMPSNS(Teuchos::RCP<const Matrix> A,
231  Teuchos::RCP<Vector> X,
232  Teuchos::RCP<const Vector> B);
233  /*
234  {
235  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
236  "This solver is not support for these types.");
237 
238  }
239 
240  */
241  ~MUMPSNS( )
242  {}
243 
244 
245 private:
246 
247  int preOrdering_impl()
248  {
249 
250  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
251  "This solver is not support for these types.");
252 
253  }
254 
255  int symbolicFactorization_impl()
256  {
257 
258  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
259  "This solver is not support for these types.");
260 
261  }
262 
264  {
265 
266  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
267  "This solver is not support for these types.");
268 
269  }
270 
271  int solve_impl(const Teuchos::Ptr<MultiVecAdapter<Vector> > X,
272  const Teuchos::Ptr<const MultiVecAdapter<Vector> > B) const
273  {
274 
275  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
276  "This solver is not support for these types.");
277 
278  }
279 
280  bool matrixShapeOK_impl() const
281  {
282 
283  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
284  "This solver is not support for these types.");
285 
286  }
287 
288  void setParameters_impl(
289  const Teuchos::RCP<Teuchos::ParameterList> & parameterList )
290  {
291 
292  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
293  "This solver is not support for these types.");
294 
295  }
296 
297  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters_impl() const
298  {
299 
300  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
301  "This solver is not support for these types.");
302 
303  }
304 
305 
306  bool loadA_impl(EPhase current_phase)
307  {
308 
309  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
310  "This solver is not support for these types.");
311 
312  }
313 
314 
315  int ConvertToTriplet()
316  {
317 
318  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
319  "This solver is not support for these types.");
320 
321  }
322 
323 
324  void MUMPS_ERROR() const
325  {
326 
327  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
328  "This solver is not support for these types.");
329 
330  }
331 
332 
333 #ifdef HAVE_MPI
334  MPI_Comm MUMPSComm;
335 #endif
336 
337 
338 };
339 
340 
341 
342 // Specialize solver_traits struct for MUMPS
343 // TODO
344 template <>
345 struct solver_traits<MUMPS> {
346 #ifdef HAVE_TEUCHOS_COMPLEX
347  typedef Meta::make_list4<float,
348  double,
349  std::complex<float>,
350  std::complex<double> > supported_scalars;
351 #else
352  typedef Meta::make_list2<float, double> supported_scalars;
353 #endif
354 };
355 
356 } // end namespace Amesos2
357 
358 #endif // AMESOS2_MUMPS_DECL_HPP
Provides a mechanism to map function calls to the correct Solver function based on the scalar type of...
Amesos2::SolverCore: A templated interface for interaction with third-party direct sparse solvers...
Definition: Amesos2_SolverCore_decl.hpp:105
int numericFactorization_impl()
Basker specific numeric factorization.
Definition: Amesos2_MUMPS_def.hpp:195
EPhase
Used to indicate a phase in the direct solution.
Definition: Amesos2_TypeDecl.hpp:65
Map types to solver-specific data-types and enums.
Definition: Amesos2_TypeMap.hpp:82
Teuchos::Array< local_ordinal_type > rowind_
Stores the location in Ai_ and Aval_ that starts row j.
Definition: Amesos2_MUMPS_decl.hpp:207
std::string name() const
Return the name of this solver.
int preOrdering_impl()
Performs pre-ordering on the matrix to increase efficiency.
Definition: Amesos2_MUMPS_def.hpp:166
Provides traits about solvers.
Definition: Amesos2_SolverTraits.hpp:70
Definition: Amesos2_AbstractConcreteMatrixAdapter.hpp:48
int solve_impl(const Teuchos::Ptr< MultiVecAdapter< Vector > > X, const Teuchos::Ptr< const MultiVecAdapter< Vector > > B) const
MUMPS specific solve.
Definition: Amesos2_MUMPS_def.hpp:225
bool matrixShapeOK_impl() const
Determines whether the shape of the matrix is OK for this solver.
Definition: Amesos2_MUMPS_def.hpp:284
bool loadA_impl(EPhase current_phase)
Reads matrix data into internal structures.
Definition: Amesos2_MUMPS_def.hpp:368
Amesos2 interface to the MUMPS package.
Definition: Amesos2_MUMPS_decl.hpp:78
Teuchos::Array< slu_type > xvals_
Persisting 1D store for X.
Definition: Amesos2_MUMPS_decl.hpp:212
Teuchos::Array< slu_type > bvals_
Persisting 1D store for B.
Definition: Amesos2_MUMPS_decl.hpp:214
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters_impl() const
Definition: Amesos2_MUMPS_def.hpp:342
void setParameters_impl(const Teuchos::RCP< Teuchos::ParameterList > &parameterList)
Definition: Amesos2_MUMPS_def.hpp:293
Passes functions to TPL functions based on type.
Definition: Amesos2_FunctionMap.hpp:76
Provides access to interesting solver traits.
Teuchos::Array< slu_type > nzvals_
Stores the values of the nonzero entries for MUMPS.
Definition: Amesos2_MUMPS_decl.hpp:205
Teuchos::Array< local_ordinal_type > colptr_
Stores the row indices of the nonzero entries.
Definition: Amesos2_MUMPS_decl.hpp:209
A templated MultiVector class adapter for Amesos2.
Definition: Amesos2_MultiVecAdapter_decl.hpp:175