3 #ifndef DUNE_ISTL_SPQR_HH
4 #define DUNE_ISTL_SPQR_HH
6 #if HAVE_SUITESPARSE_SPQR || defined DOXYGEN
11 #include <SuiteSparseQR.hpp>
13 #include <dune/common/exceptions.hh>
14 #include <dune/common/unused.hh>
34 template<
class M,
class T,
class TM,
class TD,
class TA>
35 class SeqOverlappingSchwarz;
37 template<
class T,
bool tag>
38 struct SeqOverlappingSchwarzAssemblerHelper;
45 template<
class Matrix>
62 template<
typename T,
typename A,
int n,
int m>
64 :
public InverseOperator<BlockVector<FieldVector<T,m>, typename std::allocator_traits<A>::template rebind_alloc<FieldVector<T,m> > >,
65 BlockVector<FieldVector<T,n>, typename std::allocator_traits<A>::template rebind_alloc<FieldVector<T,n> > > >
83 return SolverCategory::Category::sequential;
94 SPQR(
const Matrix& matrix,
int verbose=0) : matrixIsLoaded_(false), verbose_(verbose)
97 static_assert((std::is_same<T,double>::value) || (std::is_same<T,std::complex<double> >::value),
98 "Unsupported Type in SPQR (only double and std::complex<double> supported)");
99 cc_ =
new cholmod_common();
100 cholmod_l_start(cc_);
112 SPQR(
const Matrix& matrix,
int verbose,
bool) : matrixIsLoaded_(false), verbose_(verbose)
115 static_assert((std::is_same<T,double>::value) || (std::is_same<T,std::complex<double> >::value),
116 "Unsupported Type in SPQR (only double and std::complex<double> supported)");
117 cc_ =
new cholmod_common();
118 cholmod_l_start(cc_);
123 SPQR() : matrixIsLoaded_(false), verbose_(0)
126 static_assert((std::is_same<T,double>::value) || (std::is_same<T,std::complex<double> >::value),
127 "Unsupported Type in SPQR (only double and std::complex<double> supported)");
128 cc_ =
new cholmod_common();
129 cholmod_l_start(cc_);
135 if ((spqrMatrix_.N() + spqrMatrix_.M() > 0) || matrixIsLoaded_)
137 cholmod_l_finish(cc_);
143 const std::size_t dimMat(spqrMatrix_.N());
145 for(std::size_t k = 0; k != dimMat; ++k)
146 (
static_cast<T*
>(B_->x))[k] = b[k];
147 cholmod_dense* BTemp = B_;
148 B_ = SuiteSparseQR_qmult<T>(0, spqrfactorization_, B_, cc_);
149 cholmod_dense* X = SuiteSparseQR_solve<T>(1, spqrfactorization_, B_, cc_);
150 cholmod_l_free_dense(&BTemp, cc_);
152 for(std::size_t k = 0; k != dimMat; ++k)
153 x [k] = (
static_cast<T*
>(X->x))[k];
154 cholmod_l_free_dense(&X, cc_);
160 std::cout<<std::endl<<
"Solving with SuiteSparseQR"<<std::endl;
161 std::cout<<
"Flops Taken: "<<cc_->SPQR_flopcount<<std::endl;
162 std::cout<<
"Analysis Time: "<<cc_->SPQR_analyze_time<<
" s"<<std::endl;
163 std::cout<<
"Factorize Time: "<<cc_->SPQR_factorize_time<<
" s"<<std::endl;
164 std::cout<<
"Backsolve Time: "<<cc_->SPQR_solve_time<<
" s"<<std::endl;
165 std::cout<<
"Peak Memory Usage: "<<cc_->memory_usage<<
" bytes"<<std::endl;
166 std::cout<<
"Rank Estimate: "<<cc_->SPQR_istat[4]<<std::endl<<std::endl;
173 DUNE_UNUSED_PARAMETER(reduction);
179 DUNE_UNUSED_PARAMETER(option);
180 DUNE_UNUSED_PARAMETER(value);
186 if ((spqrMatrix_.N() + spqrMatrix_.M() > 0) || matrixIsLoaded_)
188 spqrMatrix_ = matrix;
195 if ((spqrMatrix_.N() + spqrMatrix_.M() > 0) || matrixIsLoaded_)
197 spqrMatrix_.setMatrix(matrix,rowIndexSet);
216 return spqrfactorization_;
234 cholmod_l_free_sparse(&A_, cc_);
235 cholmod_l_free_dense(&B_, cc_);
236 SuiteSparseQR_free<T>(&spqrfactorization_, cc_);
238 matrixIsLoaded_ =
false;
248 template<
class M,
class X,
class TM,
class TD,
class T1>
256 const std::size_t dimMat(spqrMatrix_.N());
257 const std::size_t nnz(spqrMatrix_.getColStart()[dimMat]);
259 A_ = cholmod_l_allocate_sparse(dimMat, dimMat, nnz, 1, 1, 0, 1, cc_);
261 for(std::size_t k = 0; k != (dimMat+1); ++k)
262 (
static_cast<long int *
>(A_->p))[k] = spqrMatrix_.getColStart()[k];
263 for(std::size_t k = 0; k != nnz; ++k)
265 (
static_cast<long int*
>(A_->i))[k] = spqrMatrix_.getRowIndex()[k];
266 (
static_cast<T*
>(A_->x))[k] = spqrMatrix_.getValues()[k];
269 B_ = cholmod_l_allocate_dense(dimMat, 1, dimMat, A_->xtype, cc_);
271 spqrfactorization_=SuiteSparseQR_factorize<T>(SPQR_ORDERING_DEFAULT,SPQR_DEFAULT_TOL,A_,cc_);
274 SPQRMatrix spqrMatrix_;
275 bool matrixIsLoaded_;
280 SuiteSparseQR_factorization<T>* spqrfactorization_;
283 template<
typename T,
typename A>
289 template<
typename T,
typename A>
298 template<
typename TL,
typename M>
299 std::shared_ptr<Dune::InverseOperator<typename Dune::TypeListElement<1, TL>::type,
300 typename Dune::TypeListElement<2, TL>::type>>
303 isValidBlock<
typename Dune::TypeListElement<1, TL>::type::block_type>::value,
int> = 0)
const
305 int verbose = config.get(
"verbose", 0);
306 return std::make_shared<Dune::SPQR<M>>(
mat,verbose);
310 template<
typename TL,
typename M>
311 std::shared_ptr<Dune::InverseOperator<typename Dune::TypeListElement<1, TL>::type,
312 typename Dune::TypeListElement<2, TL>::type>>
314 std::enable_if_t<!
isValidBlock<
typename Dune::TypeListElement<1, TL>::type::block_type>::value,
int> = 0)
const
317 "Unsupported Type in SPQR (only double and std::complex<double> supported)");
Implementations of the inverse operator interface.
Templates characterizing the type of a solver.
virtual ~SPQR()
Destructor.
Definition: spqr.hh:133
SPQRMatrix & getInternalMatrix()
Return the column coppressed matrix.
Definition: spqr.hh:223
const char * name()
Get method name.
Definition: spqr.hh:242
SPQR(const Matrix &matrix, int verbose, bool)
Constructor for compatibility with SuperLU standard constructor.
Definition: spqr.hh:112
virtual SolverCategory::Category category() const
Category of the solver (see SolverCategory::Category)
Definition: spqr.hh:81
void setMatrix(const Matrix &matrix)
Initialize data from given matrix.
Definition: spqr.hh:184
SuiteSparseQR_factorization< T > * getFactorization()
Return the matrix factorization.
Definition: spqr.hh:214
SPQR()
Default constructor.
Definition: spqr.hh:123
void setVerbosity(int v)
Sets the verbosity level for the solver.
Definition: spqr.hh:205
Dune::ColCompMatrix< Matrix > SPQRMatrix
The corresponding SuperLU Matrix type.
Definition: spqr.hh:72
virtual void apply(domain_type &x, range_type &b, double reduction, InverseOperatorResult &res)
apply inverse operator, with given convergence criteria.
Definition: spqr.hh:171
void free()
Free allocated space.
Definition: spqr.hh:232
Dune::BlockVector< FieldVector< T, n >, typename std::allocator_traits< A >::template rebind_alloc< FieldVector< T, n > > > range_type
The type of the range of the solver.
Definition: spqr.hh:78
void setSubMatrix(const Matrix &matrix, const S &rowIndexSet)
Definition: spqr.hh:193
Dune::BlockVector< FieldVector< T, m >, typename std::allocator_traits< A >::template rebind_alloc< FieldVector< T, m > > > domain_type
The type of the domain of the solver.
Definition: spqr.hh:76
virtual void apply(domain_type &x, range_type &b, InverseOperatorResult &res)
Apply inverse operator,.
Definition: spqr.hh:141
void setOption(unsigned int option, double value)
Definition: spqr.hh:177
SPQR(const Matrix &matrix, int verbose=0)
Construct a solver object from a BCRSMatrix.
Definition: spqr.hh:94
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: spqr.hh:301
Matrix & mat
Definition: matrixmatrix.hh:345
Definition: allocator.hh:7
DUNE_REGISTER_DIRECT_SOLVER("cholmod", Dune::CholmodCreator())
A sparse block matrix with compressed row storage.
Definition: bcrsmatrix.hh:426
A vector of blocks with memory management.
Definition: bvector.hh:403
Inititializer for the ColCompMatrix as needed by OverlappingSchwarz.
Definition: colcompmatrix.hh:255
Sequential overlapping Schwarz preconditioner.
Definition: overlappingschwarz.hh:752
Definition: overlappingschwarz.hh:691
Definition: matrixutils.hh:26
Statistics about the application of an inverse operator.
Definition: solver.hh:46
int iterations
Number of iterations.
Definition: solver.hh:65
bool converged
True if convergence criterion has been met.
Definition: solver.hh:71
Abstract base class for all solvers.
Definition: solver.hh:97
Category
Definition: solvercategory.hh:21
Definition: solverfactory.hh:124
Definition: solvertype.hh:14
@ value
Whether this is a direct solver.
Definition: solvertype.hh:22
Definition: solvertype.hh:28
@ value
whether the solver internally uses column compressed storage
Definition: solvertype.hh:34
Use the SPQR package to directly solve linear systems – empty default class.
Definition: spqr.hh:47