5#ifndef DUNE_ISTL_UMFPACK_HH
6#define DUNE_ISTL_UMFPACK_HH
8#if HAVE_SUITESPARSE_UMFPACK || defined DOXYGEN
15#include<dune/common/exceptions.hh>
16#include<dune/common/fmatrix.hh>
17#include<dune/common/fvector.hh>
39 template<
class M,
class T,
class TM,
class TD,
class TA>
40 class SeqOverlappingSchwarz;
42 template<
class T,
bool tag>
43 struct SeqOverlappingSchwarzAssemblerHelper;
50 static constexpr bool valid = false ;
56 static constexpr bool valid = true ;
58 template<
typename... A>
61 umfpack_dl_defaults(args...);
63 template<
typename... A>
66 umfpack_dl_free_numeric(args...);
68 template<
typename... A>
71 umfpack_dl_free_symbolic(args...);
73 template<
typename... A>
76 return umfpack_dl_load_numeric(args...);
78 template<
typename... A>
81 umfpack_dl_numeric(args...);
83 template<
typename... A>
86 umfpack_dl_report_info(args...);
88 template<
typename... A>
91 umfpack_dl_report_status(args...);
93 template<
typename... A>
96 return umfpack_dl_save_numeric(args...);
98 template<
typename... A>
101 umfpack_dl_solve(args...);
103 template<
typename... A>
106 umfpack_dl_symbolic(args...);
113 static constexpr bool valid = true ;
116 template<
typename... A>
119 umfpack_zl_defaults(args...);
121 template<
typename... A>
124 umfpack_zl_free_numeric(args...);
126 template<
typename... A>
129 umfpack_zl_free_symbolic(args...);
131 template<
typename... A>
134 return umfpack_zl_load_numeric(args...);
136 template<
typename... A>
139 umfpack_zl_numeric(cs,ri,val,NULL,args...);
141 template<
typename... A>
144 umfpack_zl_report_info(args...);
146 template<
typename... A>
149 umfpack_zl_report_status(args...);
151 template<
typename... A>
154 return umfpack_zl_save_numeric(args...);
156 template<
typename... A>
159 const double* cval =
reinterpret_cast<const double*
>(val);
160 umfpack_zl_solve(m,cs,ri,cval,NULL,x,NULL,b,NULL,args...);
162 template<
typename... A>
165 umfpack_zl_symbolic(m,n,cs,ri,val,NULL,args...);
172 struct UMFPackVectorChooser
175 template<
typename T,
typename A,
int n,
int m>
176 struct UMFPackVectorChooser<BCRSMatrix<FieldMatrix<T,n,m>,A > >
179 using domain_type = BlockVector<
181 typename std::allocator_traits<A>::template rebind_alloc<FieldVector<T,m> > >;
183 using range_type = BlockVector<
185 typename std::allocator_traits<A>::template rebind_alloc<FieldVector<T,n> > >;
188 template<
typename T,
typename A>
189 struct UMFPackVectorChooser<BCRSMatrix<T,A> >
192 using domain_type = BlockVector<T, A>;
194 using range_type = BlockVector<T, A>;
214 typename Impl::UMFPackVectorChooser<M>::domain_type,
215 typename Impl::UMFPackVectorChooser<M>::range_type >
217 using T =
typename M::field_type;
227 using UMFPackMatrix = ISTL::Impl::BCCSMatrix<typename Matrix::field_type, size_type>;
231 using domain_type =
typename Impl::UMFPackVectorChooser<M>::domain_type;
233 using range_type =
typename Impl::UMFPackVectorChooser<M>::range_type;
252 static_assert((std::is_same<T,double>::value) || (std::is_same<T,std::complex<double> >::value),
253 "Unsupported Type in UMFPack (only double and std::complex<double> supported)");
254 Caller::defaults(UMF_Control);
270 static_assert((std::is_same<T,double>::value) || (std::is_same<T,std::complex<double> >::value),
271 "Unsupported Type in UMFPack (only double and std::complex<double> supported)");
272 Caller::defaults(UMF_Control);
287 :
UMFPack(mat_, config.
get<int>(
"verbose", 0))
292 UMFPack() : matrixIsLoaded_(false), verbosity_(0)
295 static_assert((std::is_same<T,double>::value) || (std::is_same<T,std::complex<double> >::value),
296 "Unsupported Type in UMFPack (only double and std::complex<double> supported)");
297 Caller::defaults(UMF_Control);
313 static_assert((std::is_same<T,double>::value) || (std::is_same<T,std::complex<double> >::value),
314 "Unsupported Type in UMFPack (only double and std::complex<double> supported)");
315 Caller::defaults(UMF_Control);
317 int errcode = Caller::load_numeric(&UMF_Numeric,
const_cast<char*
>(file));
318 if ((errcode == UMFPACK_ERROR_out_of_memory) || (errcode == UMFPACK_ERROR_file_IO))
320 matrixIsLoaded_ =
false;
326 matrixIsLoaded_ =
true;
327 std::cout <<
"UMFPack decomposition successfully loaded from " << file << std::endl;
340 static_assert((std::is_same<T,double>::value) || (std::is_same<T,std::complex<double> >::value),
341 "Unsupported Type in UMFPack (only double and std::complex<double> supported)");
342 Caller::defaults(UMF_Control);
343 int errcode = Caller::load_numeric(&UMF_Numeric,
const_cast<char*
>(file));
344 if (errcode == UMFPACK_ERROR_out_of_memory)
345 DUNE_THROW(Dune::Exception,
"ran out of memory while loading UMFPack decomposition");
346 if (errcode == UMFPACK_ERROR_file_IO)
347 DUNE_THROW(Dune::Exception,
"IO error while loading UMFPack decomposition");
348 matrixIsLoaded_ =
true;
349 std::cout <<
"UMFPack decomposition successfully loaded from " << file << std::endl;
355 if ((umfpackMatrix_.N() + umfpackMatrix_.M() > 0) || matrixIsLoaded_)
364 if (umfpackMatrix_.N() != b.dim())
365 DUNE_THROW(
Dune::ISTLError,
"Size of right-hand-side vector b does not match the number of matrix rows!");
366 if (umfpackMatrix_.M() != x.dim())
367 DUNE_THROW(
Dune::ISTLError,
"Size of solution vector x does not match the number of matrix columns!");
371 double UMF_Apply_Info[UMFPACK_INFO];
372 Caller::solve(UMFPACK_A,
373 umfpackMatrix_.getColStart(),
374 umfpackMatrix_.getRowIndex(),
375 umfpackMatrix_.getValues(),
376 reinterpret_cast<double*
>(&x[0]),
377 reinterpret_cast<double*
>(&b[0]),
385 res.
elapsed = UMF_Apply_Info[UMFPACK_SOLVE_WALLTIME];
387 printOnApply(UMF_Apply_Info);
405 double UMF_Apply_Info[UMFPACK_INFO];
406 Caller::solve(UMFPACK_A,
407 umfpackMatrix_.getColStart(),
408 umfpackMatrix_.getRowIndex(),
409 umfpackMatrix_.getValues(),
415 printOnApply(UMF_Apply_Info);
431 if (option >= UMFPACK_CONTROL)
432 DUNE_THROW(RangeError,
"Requested non-existing UMFPack option");
434 UMF_Control[option] = value;
442 int errcode = Caller::save_numeric(UMF_Numeric,
const_cast<char*
>(file));
443 if (errcode != UMFPACK_OK)
444 DUNE_THROW(Dune::Exception,
"IO ERROR while trying to save UMFPack decomposition");
450 if ((umfpackMatrix_.N() + umfpackMatrix_.M() > 0) || matrixIsLoaded_)
452 if (matrix.N() == 0 or matrix.M() == 0)
455 if (umfpackMatrix_.N() + umfpackMatrix_.M() + umfpackMatrix_.nonzeroes() != 0)
456 umfpackMatrix_.free();
459 ISTL::Impl::BCCSMatrixInitializer<Matrix, size_type> initializer(umfpackMatrix_);
461 copyToBCCSMatrix(initializer, matrix);
469 if ((umfpackMatrix_.N() + umfpackMatrix_.M() > 0) || matrixIsLoaded_)
472 if (umfpackMatrix_.N() + umfpackMatrix_.M() + umfpackMatrix_.nonzeroes() != 0)
473 umfpackMatrix_.free();
477 ISTL::Impl::BCCSMatrixInitializer<Matrix, SuiteSparse_long> initializer(umfpackMatrix_);
479 copyToBCCSMatrix(initializer, ISTL::Impl::MatrixRowSubset<
Matrix,std::set<std::size_t> >(_mat,rowIndexSet));
496 UMF_Control[UMFPACK_PRL] = 1;
498 UMF_Control[UMFPACK_PRL] = 2;
500 UMF_Control[UMFPACK_PRL] = 4;
518 return umfpackMatrix_;
527 if (!matrixIsLoaded_)
529 Caller::free_symbolic(&UMF_Symbolic);
530 umfpackMatrix_.free();
532 Caller::free_numeric(&UMF_Numeric);
533 matrixIsLoaded_ =
false;
536 const char*
name() {
return "UMFPACK"; }
541 template<
class Mat,
class X,
class TM,
class TD,
class T1>
548 double UMF_Decomposition_Info[UMFPACK_INFO];
549 Caller::symbolic(
static_cast<SuiteSparse_long
>(umfpackMatrix_.N()),
550 static_cast<SuiteSparse_long
>(umfpackMatrix_.N()),
551 umfpackMatrix_.getColStart(),
552 umfpackMatrix_.getRowIndex(),
553 reinterpret_cast<double*
>(umfpackMatrix_.getValues()),
556 UMF_Decomposition_Info);
557 Caller::numeric(umfpackMatrix_.getColStart(),
558 umfpackMatrix_.getRowIndex(),
559 reinterpret_cast<double*
>(umfpackMatrix_.getValues()),
563 UMF_Decomposition_Info);
564 Caller::report_status(UMF_Control,UMF_Decomposition_Info[UMFPACK_STATUS]);
567 std::cout <<
"[UMFPack Decomposition]" << std::endl;
568 std::cout <<
"Wallclock Time taken: " << UMF_Decomposition_Info[UMFPACK_NUMERIC_WALLTIME] <<
" (CPU Time: " << UMF_Decomposition_Info[UMFPACK_NUMERIC_TIME] <<
")" << std::endl;
569 std::cout <<
"Flops taken: " << UMF_Decomposition_Info[UMFPACK_FLOPS] << std::endl;
570 std::cout <<
"Peak Memory Usage: " << UMF_Decomposition_Info[UMFPACK_PEAK_MEMORY]*UMF_Decomposition_Info[UMFPACK_SIZE_OF_UNIT] <<
" bytes" << std::endl;
571 std::cout <<
"Condition number estimate: " << 1./UMF_Decomposition_Info[UMFPACK_RCOND] << std::endl;
572 std::cout <<
"Numbers of non-zeroes in decomposition: L: " << UMF_Decomposition_Info[UMFPACK_LNZ] <<
" U: " << UMF_Decomposition_Info[UMFPACK_UNZ] << std::endl;
576 Caller::report_info(UMF_Control,UMF_Decomposition_Info);
580 void printOnApply(
double* UMF_Info)
582 Caller::report_status(UMF_Control,UMF_Info[UMFPACK_STATUS]);
585 std::cout <<
"[UMFPack Solve]" << std::endl;
586 std::cout <<
"Wallclock Time: " << UMF_Info[UMFPACK_SOLVE_WALLTIME] <<
" (CPU Time: " << UMF_Info[UMFPACK_SOLVE_TIME] <<
")" << std::endl;
587 std::cout <<
"Flops Taken: " << UMF_Info[UMFPACK_SOLVE_FLOPS] << std::endl;
588 std::cout <<
"Iterative Refinement steps taken: " << UMF_Info[UMFPACK_IR_TAKEN] << std::endl;
589 std::cout <<
"Error Estimate: " << UMF_Info[UMFPACK_OMEGA1] <<
" resp. " << UMF_Info[UMFPACK_OMEGA2] << std::endl;
594 bool matrixIsLoaded_;
598 double UMF_Control[UMFPACK_CONTROL];
601 template<
typename T,
typename A,
int n,
int m>
607 template<
typename T,
typename A>
615 template<
class B>
struct isValidBlock<B,
std::enable_if_t<std::is_same<typename FieldTraits<B>::real_type,double>::value>> : std::true_type {};
617 template<
typename TL,
typename M>
618 std::shared_ptr<Dune::InverseOperator<typename Dune::TypeListElement<1, TL>::type,
619 typename Dune::TypeListElement<2, TL>::type>>
622 isValidBlock<
typename Dune::TypeListElement<1, TL>::type::block_type>::value,
int> = 0)
const
624 int verbose = config.get(
"verbose", 0);
625 return std::make_shared<Dune::UMFPack<M>>(
mat,verbose);
629 template<
typename TL,
typename M>
630 std::shared_ptr<Dune::InverseOperator<typename Dune::TypeListElement<1, TL>::type,
631 typename Dune::TypeListElement<2, TL>::type>>
634 !
isValidBlock<
typename Dune::TypeListElement<1, TL>::type::block_type>::value,
int> = 0)
const
637 "Unsupported Type in UMFPack (only double and std::complex<double> supported)");
Templates characterizing the type of a solver.
#define DUNE_REGISTER_DIRECT_SOLVER(name,...)
Definition solverregistry.hh:13
Implementations of the inverse operator interface.
Implementation of the BCRSMatrix class.
void free()
free allocated space.
Definition umfpack.hh:525
virtual void apply(domain_type &x, range_type &b, InverseOperatorResult &res)
Apply inverse operator,.
Definition umfpack.hh:362
SuiteSparse_long size_type
Definition umfpack.hh:221
static void symbolic(size_type m, size_type n, const size_type *cs, const size_type *ri, const double *val, A... args)
Definition umfpack.hh:163
static void solve(size_type m, const size_type *cs, const size_type *ri, std::complex< double > *val, double *x, const double *b, A... args)
Definition umfpack.hh:157
virtual SolverCategory::Category category() const
Category of the solver (see SolverCategory::Category)
Definition umfpack.hh:236
M matrix_type
Definition umfpack.hh:225
static void numeric(const size_type *cs, const size_type *ri, const double *val, A... args)
Definition umfpack.hh:137
void setMatrix(const Matrix &matrix)
Initialize data from given matrix.
Definition umfpack.hh:448
static void report_info(A... args)
Definition umfpack.hh:142
UMFPack(const Matrix &mat_, const ParameterTree &config)
Construct a solver object from a matrix.
Definition umfpack.hh:286
static int load_numeric(A... args)
Definition umfpack.hh:132
static int load_numeric(A... args)
Definition umfpack.hh:74
std::shared_ptr< Dune::InverseOperator< typename Dune::TypeListElement< 1, TL >::type, typename Dune::TypeListElement< 2, TL >::type > > operator()(TL, const M &mat, const Dune::ParameterTree &config, std::enable_if_t< isValidBlock< typename Dune::TypeListElement< 1, TL >::type::block_type >::value, int >=0) const
Definition umfpack.hh:620
static void report_status(A... args)
Definition umfpack.hh:89
UMFPack(const Matrix &mat_, const char *file, int verbose=0)
Try loading a decomposition from file and do a decomposition if unsuccessful.
Definition umfpack.hh:310
typename Impl::UMFPackVectorChooser< M >::range_type range_type
The type of the range of the solver.
Definition umfpack.hh:233
UMFPack()
default constructor
Definition umfpack.hh:292
static void symbolic(A... args)
Definition umfpack.hh:104
static void report_info(A... args)
Definition umfpack.hh:84
static void free_symbolic(A... args)
Definition umfpack.hh:69
static int save_numeric(A... args)
Definition umfpack.hh:152
static void free_numeric(A... args)
Definition umfpack.hh:122
void setSubMatrix(const Matrix &_mat, const S &rowIndexSet)
Definition umfpack.hh:467
static int save_numeric(A... args)
Definition umfpack.hh:94
static void report_status(A... args)
Definition umfpack.hh:147
void apply(T *x, T *b)
additional apply method with c-arrays in analogy to superlu
Definition umfpack.hh:403
static void defaults(A... args)
Definition umfpack.hh:117
static void free_numeric(A... args)
Definition umfpack.hh:64
void setVerbosity(int v)
sets the verbosity level for the UMFPack solver
Definition umfpack.hh:491
UMFPack(const char *file, int verbose=0)
try loading a decomposition from file
Definition umfpack.hh:337
static void numeric(A... args)
Definition umfpack.hh:79
static constexpr bool valid
Definition umfpack.hh:50
virtual ~UMFPack()
Definition umfpack.hh:353
const char * name()
Definition umfpack.hh:536
void saveDecomposition(const char *file)
saves a decomposition to a file
Definition umfpack.hh:440
UMFPackMatrix & getInternalMatrix()
Return the column compress matrix from UMFPack.
Definition umfpack.hh:516
SuiteSparse_long size_type
Definition umfpack.hh:114
typename Impl::UMFPackVectorChooser< M >::domain_type domain_type
The type of the domain of the solver.
Definition umfpack.hh:231
UMFPack(const Matrix &matrix, int verbose=0)
Construct a solver object from a matrix.
Definition umfpack.hh:249
ISTL::Impl::BCCSMatrixInitializer< M, size_type > MatrixInitializer
Type of an associated initializer class.
Definition umfpack.hh:229
virtual void apply(domain_type &x, range_type &b, double reduction, InverseOperatorResult &res)
apply inverse operator, with given convergence criteria.
Definition umfpack.hh:393
ISTL::Impl::BCCSMatrix< typename Matrix::field_type, size_type > UMFPackMatrix
The corresponding UMFPack matrix type.
Definition umfpack.hh:227
void setOption(unsigned int option, double value)
Set UMFPack-specific options.
Definition umfpack.hh:429
static void free_symbolic(A... args)
Definition umfpack.hh:127
M Matrix
The matrix type.
Definition umfpack.hh:224
static void defaults(A... args)
Definition umfpack.hh:59
static void solve(A... args)
Definition umfpack.hh:99
UMFPack(const Matrix &matrix, int verbose, bool)
Constructor for compatibility with SuperLU standard constructor.
Definition umfpack.hh:267
void * getFactorization()
Return the matrix factorization.
Definition umfpack.hh:507
Matrix & mat
Definition matrixmatrix.hh:347
Definition allocator.hh:11
PropertyMapTypeSelector< Amg::VertexVisitedTag, Amg::PropertiesGraph< G, Amg::VertexProperties, EP, VM, EM > >::Type get(const Amg::VertexVisitedTag &tag, Amg::PropertiesGraph< G, Amg::VertexProperties, EP, VM, EM > &graph)
Definition dependency.hh:293
Definition matrixutils.hh:211
A sparse block matrix with compressed row storage.
Definition bcrsmatrix.hh:466
derive error class from the base class in common
Definition istlexception.hh:19
Sequential overlapping Schwarz preconditioner.
Definition overlappingschwarz.hh:755
Definition overlappingschwarz.hh:694
Definition matrixutils.hh:27
Statistics about the application of an inverse operator.
Definition solver.hh:48
double elapsed
Elapsed time in seconds.
Definition solver.hh:82
int iterations
Number of iterations.
Definition solver.hh:67
bool converged
True if convergence criterion has been met.
Definition solver.hh:73
Abstract base class for all solvers.
Definition solver.hh:99
Category
Definition solvercategory.hh:23
@ sequential
Category for sequential solvers.
Definition solvercategory.hh:25
Definition solverregistry.hh:77
Definition solvertype.hh:16
@ value
Whether this is a direct solver.
Definition solvertype.hh:24
Definition solvertype.hh:30
@ value
whether the solver internally uses column compressed storage
Definition solvertype.hh:36
The UMFPack direct sparse solver.
Definition umfpack.hh:216
Definition umfpack.hh:613
Definition umfpack.hh:614