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 
83 template <class Matrix,class Vector>
84 class MUMPS : public SolverCore<Amesos2::MUMPS, Matrix, Vector>
85 {
86  friend class SolverCore<Amesos2::MUMPS,Matrix,Vector>; // Give our base access
87  // to our private
88  // implementation funcs
89 public:
90 
92  static const char* name; // declaration. Initialization outside.
93 
94  typedef MUMPS<Matrix,Vector> type;
95  typedef SolverCore<Amesos2::MUMPS,Matrix,Vector> super_type;
96 
97  // Since typedef's are not inheritted, go grab them
98  typedef typename super_type::scalar_type scalar_type;
99  typedef typename super_type::local_ordinal_type local_ordinal_type;
100  typedef typename super_type::global_ordinal_type global_ordinal_type;
101  typedef typename super_type::global_size_type global_size_type;
102 
103  typedef TypeMap<Amesos2::MUMPS,scalar_type> type_map;
104 
105  typedef typename type_map::type slu_type;
106  typedef typename type_map::magnitude_type magnitude_type;
107  typedef typename type_map::MUMPS_STRUC_C MUMPS_STRUC_C;
108 
109  typedef FunctionMap<Amesos2::MUMPS,slu_type> function_map;
110 
111  MUMPS(Teuchos::RCP<const Matrix> A,
112  Teuchos::RCP<Vector> X,
113  Teuchos::RCP<const Vector> B);
114  ~MUMPS( );
115 
116 
117 private:
118 
124  int preOrdering_impl();
125 
126 
127  int symbolicFactorization_impl();
128 
129 
136 
137 
149  int solve_impl(const Teuchos::Ptr<MultiVecAdapter<Vector> > X,
150  const Teuchos::Ptr<const MultiVecAdapter<Vector> > B) const;
151 
152 
156  bool matrixShapeOK_impl() const;
157 
173  void setParameters_impl(
174  const Teuchos::RCP<Teuchos::ParameterList> & parameterList );
175 
176 
183  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters_impl() const;
184 
185 
194  bool loadA_impl(EPhase current_phase);
195 
196 
197  int ConvertToTriplet();
198 
199  void MUMPS_ERROR() const;
200 
201 #ifdef HAVE_MPI
202  MPI_Comm MUMPSComm;
203 #endif
204 
205 
206  bool MUMPS_MATRIX_LOAD;
207  bool MUMPS_STRUCT;
208 
209  // The following Arrays are persisting storage arrays for A, X, and B
211  Teuchos::Array<slu_type> nzvals_;
213  Teuchos::Array<local_ordinal_type> rowind_;
215  Teuchos::Array<local_ordinal_type> colptr_;
216 
218  mutable Teuchos::Array<slu_type> xvals_; local_ordinal_type ldx_;
220  mutable Teuchos::Array<slu_type> bvals_; local_ordinal_type ldb_;
221 
222  mutable MUMPS_STRUC_C mumps_par;
223 
224 }; // End class MUMPS
225 
226 
227 template <class Matrix,class Vector>
228 class MUMPSNS : public SolverCore<Amesos2::MUMPS, Matrix, Vector>
229 {
230  friend class SolverCore<Amesos2::MUMPS,Matrix,Vector>; // Give our base access
231  // to our private
232  // implementation funcs
233 public:
234 
235 
236  MUMPSNS(Teuchos::RCP<const Matrix> A,
237  Teuchos::RCP<Vector> X,
238  Teuchos::RCP<const Vector> B);
239  /*
240  {
241  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
242  "This solver is not support for these types.");
243 
244  }
245 
246  */
247  ~MUMPSNS( )
248  {}
249 
250 
251 private:
252 
253  int preOrdering_impl()
254  {
255 
256  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
257  "This solver is not support for these types.");
258 
259  }
260 
261  int symbolicFactorization_impl()
262  {
263 
264  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
265  "This solver is not support for these types.");
266 
267  }
268 
270  {
271 
272  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
273  "This solver is not support for these types.");
274 
275  }
276 
277  int solve_impl(const Teuchos::Ptr<MultiVecAdapter<Vector> > X,
278  const Teuchos::Ptr<const MultiVecAdapter<Vector> > B) const
279  {
280 
281  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
282  "This solver is not support for these types.");
283 
284  }
285 
286  bool matrixShapeOK_impl() const
287  {
288 
289  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
290  "This solver is not support for these types.");
291 
292  }
293 
294  void setParameters_impl(
295  const Teuchos::RCP<Teuchos::ParameterList> & parameterList )
296  {
297 
298  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
299  "This solver is not support for these types.");
300 
301  }
302 
303  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters_impl() const
304  {
305 
306  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
307  "This solver is not support for these types.");
308 
309  }
310 
311 
312  bool loadA_impl(EPhase current_phase)
313  {
314 
315  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
316  "This solver is not support for these types.");
317 
318  }
319 
320 
321  int ConvertToTriplet()
322  {
323 
324  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
325  "This solver is not support for these types.");
326 
327  }
328 
329 
330  void MUMPS_ERROR() const
331  {
332 
333  TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
334  "This solver is not support for these types.");
335 
336  }
337 
338 
339 #ifdef HAVE_MPI
340  MPI_Comm MUMPSComm;
341 #endif
342 
343 
344 };
345 
346 
347 
348 // Specialize solver_traits struct for MUMPS
349 // TODO
350 template <>
351 struct solver_traits<MUMPS> {
352 #ifdef HAVE_TEUCHOS_COMPLEX
353  typedef Meta::make_list4<float,
354  double,
355  std::complex<float>,
356  std::complex<double> > supported_scalars;
357 #else
358  typedef Meta::make_list2<float, double> supported_scalars;
359 #endif
360 };
361 
362 } // end namespace Amesos2
363 
364 #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:196
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:213
int preOrdering_impl()
Performs pre-ordering on the matrix to increase efficiency.
Definition: Amesos2_MUMPS_def.hpp:167
Provides traits about solvers.
Definition: Amesos2_SolverTraits.hpp:70
Definition: Amesos2_AbstractConcreteMatrixAdapter.hpp:48
bool loadA_impl(EPhase current_phase)
Reads matrix data into internal structures.
Definition: Amesos2_MUMPS_def.hpp:369
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters_impl() const
Definition: Amesos2_MUMPS_def.hpp:343
Amesos2 interface to the MUMPS package.
Definition: Amesos2_MUMPS_decl.hpp:84
bool matrixShapeOK_impl() const
Determines whether the shape of the matrix is OK for this solver.
Definition: Amesos2_MUMPS_def.hpp:285
Teuchos::Array< slu_type > xvals_
Persisting 1D store for X.
Definition: Amesos2_MUMPS_decl.hpp:218
Teuchos::Array< slu_type > bvals_
Persisting 1D store for B.
Definition: Amesos2_MUMPS_decl.hpp:220
void setParameters_impl(const Teuchos::RCP< Teuchos::ParameterList > &parameterList)
Definition: Amesos2_MUMPS_def.hpp:294
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:226
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
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:211
Teuchos::Array< local_ordinal_type > colptr_
Stores the row indices of the nonzero entries.
Definition: Amesos2_MUMPS_decl.hpp:215
A templated MultiVector class adapter for Amesos2.
Definition: Amesos2_MultiVecAdapter_decl.hpp:175