xref: /petsc/src/mat/impls/htool/htool.cxx (revision 8b8ddd11208960f17ab493a4b3eccc5bd1d88bb1)
1c7a4214aSPierre Jolivet #include <../src/mat/impls/htool/htool.hpp> /*I "petscmat.h" I*/
2c7a4214aSPierre Jolivet #include <petscblaslapack.h>
3c7a4214aSPierre Jolivet #include <set>
4c7a4214aSPierre Jolivet 
598e73e17SPierre Jolivet #define ALEN(a) (sizeof(a)/sizeof((a)[0]))
6c7a4214aSPierre Jolivet const char *const MatHtoolCompressorTypes[] = { "sympartialACA", "fullACA", "SVD" };
798e73e17SPierre Jolivet const char *const MatHtoolClusteringTypes[] = { "PCARegular", "PCAGeometric", "BoundingBox1Regular", "BoundingBox1Geometric" };
8c7a4214aSPierre Jolivet const char HtoolCitation[] = "@article{marchand2020two,\n"
9c7a4214aSPierre Jolivet "  Author = {Marchand, Pierre and Claeys, Xavier and Jolivet, Pierre and Nataf, Fr\\'ed\\'eric and Tournier, Pierre-Henri},\n"
10c7a4214aSPierre Jolivet "  Title = {Two-level preconditioning for $h$-version boundary element approximation of hypersingular operator with {GenEO}},\n"
11c7a4214aSPierre Jolivet "  Year = {2020},\n"
12c7a4214aSPierre Jolivet "  Publisher = {Elsevier},\n"
13c7a4214aSPierre Jolivet "  Journal = {Numerische Mathematik},\n"
14c7a4214aSPierre Jolivet "  Volume = {146},\n"
15c7a4214aSPierre Jolivet "  Pages = {597--628},\n"
16c7a4214aSPierre Jolivet "  Url = {https://github.com/htool-ddm/htool}\n"
17c7a4214aSPierre Jolivet "}\n";
18c7a4214aSPierre Jolivet static PetscBool HtoolCite = PETSC_FALSE;
19c7a4214aSPierre Jolivet 
20c7a4214aSPierre Jolivet static PetscErrorCode MatGetDiagonal_Htool(Mat A,Vec v)
21c7a4214aSPierre Jolivet {
22c7a4214aSPierre Jolivet   Mat_Htool      *a = (Mat_Htool*)A->data;
23c7a4214aSPierre Jolivet   PetscScalar    *x;
24c7a4214aSPierre Jolivet   PetscBool      flg;
25c7a4214aSPierre Jolivet   PetscErrorCode ierr;
26c7a4214aSPierre Jolivet 
27c7a4214aSPierre Jolivet   PetscFunctionBegin;
28c7a4214aSPierre Jolivet   ierr = MatHasCongruentLayouts(A,&flg);CHKERRQ(ierr);
29c7a4214aSPierre Jolivet   if (!flg) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Only congruent layouts supported");
30c7a4214aSPierre Jolivet   ierr = VecGetArrayWrite(v,&x);CHKERRQ(ierr);
31c7a4214aSPierre Jolivet   a->hmatrix->copy_local_diagonal(x);
32c7a4214aSPierre Jolivet   ierr = VecRestoreArrayWrite(v,&x);CHKERRQ(ierr);
33c7a4214aSPierre Jolivet   ierr = VecScale(v,a->s);CHKERRQ(ierr);
34c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
35c7a4214aSPierre Jolivet }
36c7a4214aSPierre Jolivet 
37c7a4214aSPierre Jolivet static PetscErrorCode MatGetDiagonalBlock_Htool(Mat A,Mat *b)
38c7a4214aSPierre Jolivet {
39c7a4214aSPierre Jolivet   Mat_Htool      *a = (Mat_Htool*)A->data;
40c7a4214aSPierre Jolivet   Mat            B;
41c7a4214aSPierre Jolivet   PetscScalar    *ptr;
42c7a4214aSPierre Jolivet   PetscBool      flg;
43c7a4214aSPierre Jolivet   PetscErrorCode ierr;
44c7a4214aSPierre Jolivet 
45c7a4214aSPierre Jolivet   PetscFunctionBegin;
46c7a4214aSPierre Jolivet   ierr = MatHasCongruentLayouts(A,&flg);CHKERRQ(ierr);
47c7a4214aSPierre Jolivet   if (!flg) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Only congruent layouts supported");
48c7a4214aSPierre Jolivet   ierr = PetscObjectQuery((PetscObject)A,"DiagonalBlock",(PetscObject*)&B);CHKERRQ(ierr); /* same logic as in MatGetDiagonalBlock_MPIDense() */
49c7a4214aSPierre Jolivet   if (!B) {
50c7a4214aSPierre Jolivet     ierr = MatCreateDense(PETSC_COMM_SELF,A->rmap->n,A->rmap->n,A->rmap->n,A->rmap->n,NULL,&B);CHKERRQ(ierr);
51c7a4214aSPierre Jolivet     ierr = MatDenseGetArrayWrite(B,&ptr);CHKERRQ(ierr);
52c7a4214aSPierre Jolivet     a->hmatrix->copy_local_diagonal_block(ptr);
53c7a4214aSPierre Jolivet     ierr = MatDenseRestoreArrayWrite(B,&ptr);CHKERRQ(ierr);
54c7a4214aSPierre Jolivet     ierr = MatPropagateSymmetryOptions(A,B);CHKERRQ(ierr);
55c7a4214aSPierre Jolivet     ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
56c7a4214aSPierre Jolivet     ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
57c7a4214aSPierre Jolivet     ierr = MatScale(B,a->s);CHKERRQ(ierr);
58c7a4214aSPierre Jolivet     ierr = PetscObjectCompose((PetscObject)A,"DiagonalBlock",(PetscObject)B);CHKERRQ(ierr);
59c7a4214aSPierre Jolivet     *b   = B;
60c7a4214aSPierre Jolivet     ierr = MatDestroy(&B);CHKERRQ(ierr);
61c7a4214aSPierre Jolivet   } else *b = B;
62c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
63c7a4214aSPierre Jolivet }
64c7a4214aSPierre Jolivet 
65c7a4214aSPierre Jolivet static PetscErrorCode MatMult_Htool(Mat A,Vec x,Vec y)
66c7a4214aSPierre Jolivet {
67c7a4214aSPierre Jolivet   Mat_Htool         *a = (Mat_Htool*)A->data;
68c7a4214aSPierre Jolivet   const PetscScalar *in;
69c7a4214aSPierre Jolivet   PetscScalar       *out;
70c7a4214aSPierre Jolivet   PetscErrorCode    ierr;
71c7a4214aSPierre Jolivet 
72c7a4214aSPierre Jolivet   PetscFunctionBegin;
73c7a4214aSPierre Jolivet   ierr = VecGetArrayRead(x,&in);CHKERRQ(ierr);
74c7a4214aSPierre Jolivet   ierr = VecGetArrayWrite(y,&out);CHKERRQ(ierr);
75c7a4214aSPierre Jolivet   a->hmatrix->mvprod_local_to_local(in,out);
76c7a4214aSPierre Jolivet   ierr = VecRestoreArrayRead(x,&in);CHKERRQ(ierr);
77c7a4214aSPierre Jolivet   ierr = VecRestoreArrayWrite(y,&out);CHKERRQ(ierr);
78c7a4214aSPierre Jolivet   ierr = VecScale(y,a->s);CHKERRQ(ierr);
79c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
80c7a4214aSPierre Jolivet }
81c7a4214aSPierre Jolivet 
82c7a4214aSPierre Jolivet /* naive implementation of MatMultAdd() needed for FEM-BEM coupling via MATNEST */
83c7a4214aSPierre Jolivet static PetscErrorCode MatMultAdd_Htool(Mat A,Vec v1,Vec v2,Vec v3)
84c7a4214aSPierre Jolivet {
85c7a4214aSPierre Jolivet   Mat_Htool         *a = (Mat_Htool*)A->data;
86c7a4214aSPierre Jolivet   Vec               tmp;
87c7a4214aSPierre Jolivet   const PetscScalar scale = a->s;
88c7a4214aSPierre Jolivet   PetscErrorCode    ierr;
89c7a4214aSPierre Jolivet 
90c7a4214aSPierre Jolivet   PetscFunctionBegin;
91c7a4214aSPierre Jolivet   ierr = VecDuplicate(v2,&tmp);CHKERRQ(ierr);
92c7a4214aSPierre Jolivet   ierr = VecCopy(v2,v3);CHKERRQ(ierr); /* no-op in MatMultAdd(bA->m[i][j],bx[j],by[i],by[i]) since VecCopy() checks for x == y */
93c7a4214aSPierre Jolivet   a->s = 1.0; /* set s to 1.0 since VecAXPY() may be used to scale the MatMult() output Vec */
94c7a4214aSPierre Jolivet   ierr = MatMult_Htool(A,v1,tmp);CHKERRQ(ierr);
95c7a4214aSPierre Jolivet   ierr = VecAXPY(v3,scale,tmp);CHKERRQ(ierr);
96c7a4214aSPierre Jolivet   ierr = VecDestroy(&tmp);CHKERRQ(ierr);
97c7a4214aSPierre Jolivet   a->s = scale; /* set s back to its original value */
98c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
99c7a4214aSPierre Jolivet }
100c7a4214aSPierre Jolivet 
101*8b8ddd11SPierre Jolivet static PetscErrorCode MatMultTranspose_Htool(Mat A,Vec x,Vec y)
102*8b8ddd11SPierre Jolivet {
103*8b8ddd11SPierre Jolivet   Mat_Htool         *a = (Mat_Htool*)A->data;
104*8b8ddd11SPierre Jolivet   const PetscScalar *in;
105*8b8ddd11SPierre Jolivet   PetscScalar       *out;
106*8b8ddd11SPierre Jolivet   PetscErrorCode    ierr;
107*8b8ddd11SPierre Jolivet 
108*8b8ddd11SPierre Jolivet   PetscFunctionBegin;
109*8b8ddd11SPierre Jolivet   ierr = VecGetArrayRead(x,&in);CHKERRQ(ierr);
110*8b8ddd11SPierre Jolivet   ierr = VecGetArrayWrite(y,&out);CHKERRQ(ierr);
111*8b8ddd11SPierre Jolivet   a->hmatrix->mvprod_transp_local_to_local(in,out);
112*8b8ddd11SPierre Jolivet   ierr = VecRestoreArrayRead(x,&in);CHKERRQ(ierr);
113*8b8ddd11SPierre Jolivet   ierr = VecRestoreArrayWrite(y,&out);CHKERRQ(ierr);
114*8b8ddd11SPierre Jolivet   ierr = VecScale(y,a->s);CHKERRQ(ierr);
115*8b8ddd11SPierre Jolivet   PetscFunctionReturn(0);
116*8b8ddd11SPierre Jolivet }
117*8b8ddd11SPierre Jolivet 
118c7a4214aSPierre Jolivet static PetscErrorCode MatIncreaseOverlap_Htool(Mat A,PetscInt is_max,IS is[],PetscInt ov)
119c7a4214aSPierre Jolivet {
120c7a4214aSPierre Jolivet   std::set<PetscInt> set;
121c7a4214aSPierre Jolivet   const PetscInt     *idx;
122c7a4214aSPierre Jolivet   PetscInt           *oidx,size;
123c7a4214aSPierre Jolivet   PetscMPIInt        csize;
124c7a4214aSPierre Jolivet   PetscErrorCode     ierr;
125c7a4214aSPierre Jolivet 
126c7a4214aSPierre Jolivet   PetscFunctionBegin;
127c7a4214aSPierre Jolivet   for (PetscInt i=0; i<is_max; ++i) {
128c7a4214aSPierre Jolivet     /* basic implementation that adds indices by shifting an IS by -ov, -ov+1..., -1, 1..., ov-1, ov */
129c7a4214aSPierre Jolivet     /* needed to avoid subdomain matrices to replicate A since it is dense                           */
130c7a4214aSPierre Jolivet     ierr = MPI_Comm_size(PetscObjectComm((PetscObject)is[i]),&csize);CHKERRMPI(ierr);
131c7a4214aSPierre Jolivet     if (csize != 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unsupported parallel IS");
132c7a4214aSPierre Jolivet     ierr = ISGetSize(is[i],&size);CHKERRQ(ierr);
133c7a4214aSPierre Jolivet     ierr = ISGetIndices(is[i],&idx);CHKERRQ(ierr);
134c7a4214aSPierre Jolivet     for (PetscInt j=0; j<size; ++j) {
135c7a4214aSPierre Jolivet       set.insert(idx[j]);
136c7a4214aSPierre Jolivet       for (PetscInt k=1; k<=ov; ++k) {               /* for each layer of overlap      */
137c7a4214aSPierre Jolivet         if (idx[j] - k >= 0) set.insert(idx[j] - k); /* do not insert negative indices */
138c7a4214aSPierre Jolivet         if (idx[j] + k < A->rmap->N && idx[j] + k < A->cmap->N) set.insert(idx[j] + k); /* do not insert indices greater than the dimension of A */
139c7a4214aSPierre Jolivet       }
140c7a4214aSPierre Jolivet     }
141c7a4214aSPierre Jolivet     ierr = ISRestoreIndices(is[i],&idx);CHKERRQ(ierr);
142c7a4214aSPierre Jolivet     ierr = ISDestroy(is+i);CHKERRQ(ierr);
143c7a4214aSPierre Jolivet     size = set.size(); /* size with overlap */
144c7a4214aSPierre Jolivet     ierr = PetscMalloc1(size,&oidx);CHKERRQ(ierr);
145c7a4214aSPierre Jolivet     for (const PetscInt j : set) *oidx++ = j;
146c7a4214aSPierre Jolivet     oidx -= size;
147c7a4214aSPierre Jolivet     ierr = ISCreateGeneral(PETSC_COMM_SELF,size,oidx,PETSC_OWN_POINTER,is+i);CHKERRQ(ierr);
148c7a4214aSPierre Jolivet   }
149c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
150c7a4214aSPierre Jolivet }
151c7a4214aSPierre Jolivet 
152c7a4214aSPierre Jolivet static PetscErrorCode MatCreateSubMatrices_Htool(Mat A,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[])
153c7a4214aSPierre Jolivet {
154c7a4214aSPierre Jolivet   Mat_Htool         *a = (Mat_Htool*)A->data;
155c7a4214aSPierre Jolivet   Mat               D,B,BT;
156c7a4214aSPierre Jolivet   const PetscScalar *copy;
157c7a4214aSPierre Jolivet   PetscScalar       *ptr;
158c7a4214aSPierre Jolivet   const PetscInt    *idxr,*idxc,*it;
159c7a4214aSPierre Jolivet   PetscInt          nrow,m,i;
160c7a4214aSPierre Jolivet   PetscBool         flg;
161c7a4214aSPierre Jolivet   PetscErrorCode    ierr;
162c7a4214aSPierre Jolivet 
163c7a4214aSPierre Jolivet   PetscFunctionBegin;
164c7a4214aSPierre Jolivet   if (scall != MAT_REUSE_MATRIX) {
165c7a4214aSPierre Jolivet     ierr = PetscCalloc1(n,submat);CHKERRQ(ierr);
166c7a4214aSPierre Jolivet   }
167c7a4214aSPierre Jolivet   for (i=0; i<n; ++i) {
168c7a4214aSPierre Jolivet     ierr = ISGetLocalSize(irow[i],&nrow);CHKERRQ(ierr);
169c7a4214aSPierre Jolivet     ierr = ISGetLocalSize(icol[i],&m);CHKERRQ(ierr);
170c7a4214aSPierre Jolivet     ierr = ISGetIndices(irow[i],&idxr);CHKERRQ(ierr);
171c7a4214aSPierre Jolivet     ierr = ISGetIndices(icol[i],&idxc);CHKERRQ(ierr);
172c7a4214aSPierre Jolivet     if (scall != MAT_REUSE_MATRIX) {
173c7a4214aSPierre Jolivet       ierr = MatCreateDense(PETSC_COMM_SELF,nrow,m,nrow,m,NULL,(*submat)+i);CHKERRQ(ierr);
174c7a4214aSPierre Jolivet     }
175c7a4214aSPierre Jolivet     ierr = MatDenseGetArrayWrite((*submat)[i],&ptr);CHKERRQ(ierr);
176c7a4214aSPierre Jolivet     if (irow[i] == icol[i]) { /* same row and column IS? */
177c7a4214aSPierre Jolivet       ierr = MatHasCongruentLayouts(A,&flg);CHKERRQ(ierr);
178c7a4214aSPierre Jolivet       if (flg) {
179c7a4214aSPierre Jolivet         ierr = ISSorted(irow[i],&flg);CHKERRQ(ierr);
180c7a4214aSPierre Jolivet         if (flg) { /* sorted IS? */
181c7a4214aSPierre Jolivet           it = std::lower_bound(idxr,idxr+nrow,A->rmap->rstart);
182c7a4214aSPierre Jolivet           if (it != idxr+nrow && *it == A->rmap->rstart) { /* rmap->rstart in IS? */
183c7a4214aSPierre Jolivet             if (std::distance(idxr,it) + A->rmap->n <= nrow) { /* long enough IS to store the local diagonal block? */
184c7a4214aSPierre Jolivet               for (PetscInt j=0; j<A->rmap->n && flg; ++j) if (PetscUnlikely(it[j] != A->rmap->rstart+j)) flg = PETSC_FALSE;
185c7a4214aSPierre Jolivet               if (flg) { /* complete local diagonal block in IS? */
186c7a4214aSPierre Jolivet                 /* fast extraction when the local diagonal block is part of the submatrix, e.g., for PCASM or PCHPDDM
187c7a4214aSPierre Jolivet                  *      [   B   C   E   ]
188c7a4214aSPierre Jolivet                  *  A = [   B   D   E   ]
189c7a4214aSPierre Jolivet                  *      [   B   F   E   ]
190c7a4214aSPierre Jolivet                  */
191c7a4214aSPierre Jolivet                 m = std::distance(idxr,it); /* shift of the coefficient (0,0) of block D from above */
192c7a4214aSPierre Jolivet                 ierr = MatGetDiagonalBlock_Htool(A,&D);CHKERRQ(ierr);
193c7a4214aSPierre Jolivet                 ierr = MatDenseGetArrayRead(D,&copy);CHKERRQ(ierr);
194c7a4214aSPierre Jolivet                 for (PetscInt k=0; k<A->rmap->n; ++k) {
195c7a4214aSPierre Jolivet                   ierr = PetscArraycpy(ptr+(m+k)*nrow+m,copy+k*A->rmap->n,A->rmap->n);CHKERRQ(ierr); /* block D from above */
196c7a4214aSPierre Jolivet                 }
197c7a4214aSPierre Jolivet                 ierr = MatDenseRestoreArrayRead(D,&copy);CHKERRQ(ierr);
198c7a4214aSPierre Jolivet                 if (m) {
199c7a4214aSPierre Jolivet                   a->wrapper->copy_submatrix(nrow,m,idxr,idxc,ptr); /* vertical block B from above */
200c7a4214aSPierre Jolivet                   /* entry-wise assembly may be costly, so transpose already-computed entries when possible */
201c7a4214aSPierre Jolivet                   if (A->symmetric || A->hermitian) {
202c7a4214aSPierre Jolivet                     ierr = MatCreateDense(PETSC_COMM_SELF,A->rmap->n,m,A->rmap->n,m,ptr+m,&B);CHKERRQ(ierr);
203c7a4214aSPierre Jolivet                     ierr = MatDenseSetLDA(B,nrow);CHKERRQ(ierr);
204c7a4214aSPierre Jolivet                     ierr = MatCreateDense(PETSC_COMM_SELF,m,A->rmap->n,m,A->rmap->n,ptr+m*nrow,&BT);CHKERRQ(ierr);
205c7a4214aSPierre Jolivet                     ierr = MatDenseSetLDA(BT,nrow);CHKERRQ(ierr);
206c7a4214aSPierre Jolivet                     if (A->hermitian && PetscDefined(USE_COMPLEX)) {
207c7a4214aSPierre Jolivet                       ierr = MatHermitianTranspose(B,MAT_REUSE_MATRIX,&BT);CHKERRQ(ierr);
208c7a4214aSPierre Jolivet                     } else {
209c7a4214aSPierre Jolivet                       ierr = MatTranspose(B,MAT_REUSE_MATRIX,&BT);CHKERRQ(ierr);
210c7a4214aSPierre Jolivet                     }
211c7a4214aSPierre Jolivet                     ierr = MatDestroy(&B);CHKERRQ(ierr);
212c7a4214aSPierre Jolivet                     ierr = MatDestroy(&BT);CHKERRQ(ierr);
213c7a4214aSPierre Jolivet                   } else {
214c7a4214aSPierre Jolivet                     for (PetscInt k=0; k<A->rmap->n; ++k) { /* block C from above */
215c7a4214aSPierre Jolivet                       a->wrapper->copy_submatrix(m,1,idxr,idxc+m+k,ptr+(m+k)*nrow);
216c7a4214aSPierre Jolivet                     }
217c7a4214aSPierre Jolivet                   }
218c7a4214aSPierre Jolivet                 }
219c7a4214aSPierre Jolivet                 if (m+A->rmap->n != nrow) {
220c7a4214aSPierre Jolivet                   a->wrapper->copy_submatrix(nrow,std::distance(it+A->rmap->n,idxr+nrow),idxr,idxc+m+A->rmap->n,ptr+(m+A->rmap->n)*nrow); /* vertical block E from above */
221c7a4214aSPierre Jolivet                   /* entry-wise assembly may be costly, so transpose already-computed entries when possible */
222c7a4214aSPierre Jolivet                   if (A->symmetric || A->hermitian) {
223c7a4214aSPierre Jolivet                     ierr = MatCreateDense(PETSC_COMM_SELF,A->rmap->n,nrow-(m+A->rmap->n),A->rmap->n,nrow-(m+A->rmap->n),ptr+(m+A->rmap->n)*nrow+m,&B);CHKERRQ(ierr);
224c7a4214aSPierre Jolivet                     ierr = MatDenseSetLDA(B,nrow);CHKERRQ(ierr);
225c7a4214aSPierre Jolivet                     ierr = MatCreateDense(PETSC_COMM_SELF,nrow-(m+A->rmap->n),A->rmap->n,nrow-(m+A->rmap->n),A->rmap->n,ptr+m*nrow+m+A->rmap->n,&BT);CHKERRQ(ierr);
226c7a4214aSPierre Jolivet                     ierr = MatDenseSetLDA(BT,nrow);CHKERRQ(ierr);
227c7a4214aSPierre Jolivet                     if (A->hermitian && PetscDefined(USE_COMPLEX)) {
228c7a4214aSPierre Jolivet                       ierr = MatHermitianTranspose(B,MAT_REUSE_MATRIX,&BT);CHKERRQ(ierr);
229c7a4214aSPierre Jolivet                     } else {
230c7a4214aSPierre Jolivet                       ierr = MatTranspose(B,MAT_REUSE_MATRIX,&BT);CHKERRQ(ierr);
231c7a4214aSPierre Jolivet                     }
232c7a4214aSPierre Jolivet                     ierr = MatDestroy(&B);CHKERRQ(ierr);
233c7a4214aSPierre Jolivet                     ierr = MatDestroy(&BT);CHKERRQ(ierr);
234c7a4214aSPierre Jolivet                   } else {
235c7a4214aSPierre Jolivet                     for (PetscInt k=0; k<A->rmap->n; ++k) { /* block F from above */
236c7a4214aSPierre Jolivet                       a->wrapper->copy_submatrix(std::distance(it+A->rmap->n,idxr+nrow),1,it+A->rmap->n,idxc+m+k,ptr+(m+k)*nrow+m+A->rmap->n);
237c7a4214aSPierre Jolivet                     }
238c7a4214aSPierre Jolivet                   }
239c7a4214aSPierre Jolivet                 }
240c7a4214aSPierre Jolivet               } /* complete local diagonal block not in IS */
241c7a4214aSPierre Jolivet             } else flg = PETSC_FALSE; /* IS not long enough to store the local diagonal block */
242c7a4214aSPierre Jolivet           } else flg = PETSC_FALSE; /* rmap->rstart not in IS */
243c7a4214aSPierre Jolivet         } /* unsorted IS */
244c7a4214aSPierre Jolivet       }
245c7a4214aSPierre Jolivet     } else flg = PETSC_FALSE; /* different row and column IS */
246c7a4214aSPierre Jolivet     if (!flg) a->wrapper->copy_submatrix(nrow,m,idxr,idxc,ptr); /* reassemble everything */
247c7a4214aSPierre Jolivet     ierr = ISRestoreIndices(irow[i],&idxr);CHKERRQ(ierr);
248c7a4214aSPierre Jolivet     ierr = ISRestoreIndices(icol[i],&idxc);CHKERRQ(ierr);
249c7a4214aSPierre Jolivet     ierr = MatDenseRestoreArrayWrite((*submat)[i],&ptr);CHKERRQ(ierr);
250c7a4214aSPierre Jolivet     ierr = MatAssemblyBegin((*submat)[i],MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
251c7a4214aSPierre Jolivet     ierr = MatAssemblyEnd((*submat)[i],MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
252c7a4214aSPierre Jolivet     ierr = MatScale((*submat)[i],a->s);CHKERRQ(ierr);
253c7a4214aSPierre Jolivet   }
254c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
255c7a4214aSPierre Jolivet }
256c7a4214aSPierre Jolivet 
257c7a4214aSPierre Jolivet static PetscErrorCode MatDestroy_Htool(Mat A)
258c7a4214aSPierre Jolivet {
259c7a4214aSPierre Jolivet   Mat_Htool               *a = (Mat_Htool*)A->data;
260c7a4214aSPierre Jolivet   PetscContainer          container;
261c7a4214aSPierre Jolivet   MatHtoolKernelTranspose *kernelt;
262c7a4214aSPierre Jolivet   PetscErrorCode          ierr;
263c7a4214aSPierre Jolivet 
264c7a4214aSPierre Jolivet   PetscFunctionBegin;
265c7a4214aSPierre Jolivet   ierr = PetscObjectChangeTypeName((PetscObject)A,NULL);CHKERRQ(ierr);
266c7a4214aSPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatProductSetFromOptions_htool_seqdense_C",NULL);CHKERRQ(ierr);
267c7a4214aSPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatProductSetFromOptions_htool_mpidense_C",NULL);CHKERRQ(ierr);
268c7a4214aSPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatConvert_htool_seqdense_C",NULL);CHKERRQ(ierr);
269c7a4214aSPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatConvert_htool_mpidense_C",NULL);CHKERRQ(ierr);
270c7a4214aSPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatHtoolGetHierarchicalMat_C",NULL);CHKERRQ(ierr);
271c7a4214aSPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatHtoolSetKernel_C",NULL);CHKERRQ(ierr);
27298e73e17SPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatHtoolGetPermutationSource_C",NULL);CHKERRQ(ierr);
27398e73e17SPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatHtoolGetPermutationTarget_C",NULL);CHKERRQ(ierr);
27498e73e17SPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatHtoolUsePermutation_C",NULL);CHKERRQ(ierr);
275c7a4214aSPierre Jolivet   ierr = PetscObjectQuery((PetscObject)A,"KernelTranspose",(PetscObject*)&container);CHKERRQ(ierr);
276c7a4214aSPierre Jolivet   if (container) { /* created in MatTranspose_Htool() */
277c7a4214aSPierre Jolivet     ierr = PetscContainerGetPointer(container,(void**)&kernelt);CHKERRQ(ierr);
278c7a4214aSPierre Jolivet     ierr = MatDestroy(&kernelt->A);CHKERRQ(ierr);
279c7a4214aSPierre Jolivet     ierr = PetscFree(kernelt);CHKERRQ(ierr);
280c7a4214aSPierre Jolivet     ierr = PetscContainerDestroy(&container);CHKERRQ(ierr);
281c7a4214aSPierre Jolivet     ierr = PetscObjectCompose((PetscObject)A,"KernelTranspose",NULL);CHKERRQ(ierr);
282c7a4214aSPierre Jolivet   }
283c7a4214aSPierre Jolivet   if (a->gcoords_source != a->gcoords_target) {
284c7a4214aSPierre Jolivet     ierr = PetscFree(a->gcoords_source);CHKERRQ(ierr);
285c7a4214aSPierre Jolivet   }
286c7a4214aSPierre Jolivet   ierr = PetscFree(a->gcoords_target);CHKERRQ(ierr);
287c7a4214aSPierre Jolivet   ierr = PetscFree2(a->work_source,a->work_target);CHKERRQ(ierr);
288c7a4214aSPierre Jolivet   delete a->wrapper;
289c7a4214aSPierre Jolivet   delete a->hmatrix;
290c7a4214aSPierre Jolivet   ierr = PetscFree(A->data);CHKERRQ(ierr);
291c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
292c7a4214aSPierre Jolivet }
293c7a4214aSPierre Jolivet 
294c7a4214aSPierre Jolivet static PetscErrorCode MatView_Htool(Mat A,PetscViewer pv)
295c7a4214aSPierre Jolivet {
296c7a4214aSPierre Jolivet   Mat_Htool      *a = (Mat_Htool*)A->data;
297c7a4214aSPierre Jolivet   PetscBool      flg;
298c7a4214aSPierre Jolivet   PetscErrorCode ierr;
299c7a4214aSPierre Jolivet 
300c7a4214aSPierre Jolivet   PetscFunctionBegin;
301c7a4214aSPierre Jolivet   ierr = PetscObjectTypeCompare((PetscObject)pv,PETSCVIEWERASCII,&flg);CHKERRQ(ierr);
302c7a4214aSPierre Jolivet   if (flg) {
303c7a4214aSPierre Jolivet     ierr = PetscViewerASCIIPrintf(pv,"symmetry: %c\n",a->hmatrix->get_symmetry_type());CHKERRQ(ierr);
304c7a4214aSPierre Jolivet     if (PetscAbsScalar(a->s-1.0) > PETSC_MACHINE_EPSILON) {
305c7a4214aSPierre Jolivet #if defined(PETSC_USE_COMPLEX)
306c7a4214aSPierre Jolivet       ierr = PetscViewerASCIIPrintf(pv,"scaling: %g+%gi\n",(double)PetscRealPart(a->s),(double)PetscImaginaryPart(a->s));CHKERRQ(ierr);
307c7a4214aSPierre Jolivet #else
308c7a4214aSPierre Jolivet       ierr = PetscViewerASCIIPrintf(pv,"scaling: %g\n",(double)a->s);CHKERRQ(ierr);
309c7a4214aSPierre Jolivet #endif
310c7a4214aSPierre Jolivet     }
311c0aa6a63SJacob Faibussowitsch     ierr = PetscViewerASCIIPrintf(pv,"minimum cluster size: %" PetscInt_FMT "\n",a->bs[0]);CHKERRQ(ierr);
312c0aa6a63SJacob Faibussowitsch     ierr = PetscViewerASCIIPrintf(pv,"maximum block size: %" PetscInt_FMT "\n",a->bs[1]);CHKERRQ(ierr);
313c7a4214aSPierre Jolivet     ierr = PetscViewerASCIIPrintf(pv,"epsilon: %g\n",(double)a->epsilon);CHKERRQ(ierr);
314c7a4214aSPierre Jolivet     ierr = PetscViewerASCIIPrintf(pv,"eta: %g\n",(double)a->eta);CHKERRQ(ierr);
315c0aa6a63SJacob Faibussowitsch     ierr = PetscViewerASCIIPrintf(pv,"minimum target depth: %" PetscInt_FMT "\n",a->depth[0]);CHKERRQ(ierr);
316c0aa6a63SJacob Faibussowitsch     ierr = PetscViewerASCIIPrintf(pv,"minimum source depth: %" PetscInt_FMT "\n",a->depth[1]);CHKERRQ(ierr);
317c7a4214aSPierre Jolivet     ierr = PetscViewerASCIIPrintf(pv,"compressor: %s\n",MatHtoolCompressorTypes[a->compressor]);CHKERRQ(ierr);
31898e73e17SPierre Jolivet     ierr = PetscViewerASCIIPrintf(pv,"clustering: %s\n",MatHtoolClusteringTypes[a->clustering]);CHKERRQ(ierr);
319cab00e0dSPierre Jolivet     ierr = PetscViewerASCIIPrintf(pv,"compression ratio: %s\n",a->hmatrix->get_infos("Compression_ratio").c_str());CHKERRQ(ierr);
320cab00e0dSPierre Jolivet     ierr = PetscViewerASCIIPrintf(pv,"space saving: %s\n",a->hmatrix->get_infos("Space_saving").c_str());CHKERRQ(ierr);
321c7a4214aSPierre Jolivet     ierr = PetscViewerASCIIPrintf(pv,"number of dense (resp. low rank) matrices: %s (resp. %s)\n",a->hmatrix->get_infos("Number_of_dmat").c_str(),a->hmatrix->get_infos("Number_of_lrmat").c_str());CHKERRQ(ierr);
322c7a4214aSPierre Jolivet     ierr = PetscViewerASCIIPrintf(pv,"(minimum, mean, maximum) dense block sizes: (%s, %s, %s)\n",a->hmatrix->get_infos("Dense_block_size_min").c_str(),a->hmatrix->get_infos("Dense_block_size_mean").c_str(),a->hmatrix->get_infos("Dense_block_size_max").c_str());CHKERRQ(ierr);
323c7a4214aSPierre Jolivet     ierr = PetscViewerASCIIPrintf(pv,"(minimum, mean, maximum) low rank block sizes: (%s, %s, %s)\n",a->hmatrix->get_infos("Low_rank_block_size_min").c_str(),a->hmatrix->get_infos("Low_rank_block_size_mean").c_str(),a->hmatrix->get_infos("Low_rank_block_size_max").c_str());CHKERRQ(ierr);
324c7a4214aSPierre Jolivet     ierr = PetscViewerASCIIPrintf(pv,"(minimum, mean, maximum) ranks: (%s, %s, %s)\n",a->hmatrix->get_infos("Rank_min").c_str(),a->hmatrix->get_infos("Rank_mean").c_str(),a->hmatrix->get_infos("Rank_max").c_str());CHKERRQ(ierr);
325c7a4214aSPierre Jolivet   }
326c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
327c7a4214aSPierre Jolivet }
328c7a4214aSPierre Jolivet 
329c7a4214aSPierre Jolivet static PetscErrorCode MatScale_Htool(Mat A,PetscScalar s)
330c7a4214aSPierre Jolivet {
331c7a4214aSPierre Jolivet   Mat_Htool *a = (Mat_Htool*)A->data;
332c7a4214aSPierre Jolivet 
333c7a4214aSPierre Jolivet   PetscFunctionBegin;
334c7a4214aSPierre Jolivet   a->s *= s;
335c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
336c7a4214aSPierre Jolivet }
337c7a4214aSPierre Jolivet 
338c7a4214aSPierre Jolivet /* naive implementation of MatGetRow() needed for MatConvert_Nest_AIJ() */
339c7a4214aSPierre Jolivet static PetscErrorCode MatGetRow_Htool(Mat A,PetscInt row,PetscInt *nz,PetscInt **idx,PetscScalar **v)
340c7a4214aSPierre Jolivet {
341c7a4214aSPierre Jolivet   Mat_Htool      *a = (Mat_Htool*)A->data;
342c7a4214aSPierre Jolivet   PetscInt       *idxc;
343c7a4214aSPierre Jolivet   PetscBLASInt   one = 1,bn;
344c7a4214aSPierre Jolivet   PetscErrorCode ierr;
345c7a4214aSPierre Jolivet 
346c7a4214aSPierre Jolivet   PetscFunctionBegin;
347c7a4214aSPierre Jolivet   if (nz) *nz = A->cmap->N;
348c7a4214aSPierre Jolivet   if (idx || v) { /* even if !idx, need to set idxc for htool::copy_submatrix() */
349c7a4214aSPierre Jolivet     ierr = PetscMalloc1(A->cmap->N,&idxc);CHKERRQ(ierr);
350c7a4214aSPierre Jolivet     for (PetscInt i=0; i<A->cmap->N; ++i) idxc[i] = i;
351c7a4214aSPierre Jolivet   }
352c7a4214aSPierre Jolivet   if (idx) *idx = idxc;
353c7a4214aSPierre Jolivet   if (v) {
354c7a4214aSPierre Jolivet     ierr = PetscMalloc1(A->cmap->N,v);CHKERRQ(ierr);
355c7a4214aSPierre Jolivet     if (a->wrapper) a->wrapper->copy_submatrix(1,A->cmap->N,&row,idxc,*v);
356cab00e0dSPierre Jolivet     else reinterpret_cast<htool::VirtualGenerator<PetscScalar>*>(a->kernelctx)->copy_submatrix(1,A->cmap->N,&row,idxc,*v);
357c7a4214aSPierre Jolivet     ierr = PetscBLASIntCast(A->cmap->N,&bn);CHKERRQ(ierr);
358c7a4214aSPierre Jolivet     PetscStackCallBLAS("BLASscal",BLASscal_(&bn,&a->s,*v,&one));
359c7a4214aSPierre Jolivet   }
360c7a4214aSPierre Jolivet   if (!idx) {
361c7a4214aSPierre Jolivet     ierr = PetscFree(idxc);CHKERRQ(ierr);
362c7a4214aSPierre Jolivet   }
363c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
364c7a4214aSPierre Jolivet }
365c7a4214aSPierre Jolivet 
366c7a4214aSPierre Jolivet static PetscErrorCode MatRestoreRow_Htool(Mat A,PetscInt row,PetscInt *nz,PetscInt **idx,PetscScalar **v)
367c7a4214aSPierre Jolivet {
368c7a4214aSPierre Jolivet   PetscErrorCode ierr;
369c7a4214aSPierre Jolivet 
370c7a4214aSPierre Jolivet   PetscFunctionBegin;
371c7a4214aSPierre Jolivet   if (nz) *nz = 0;
372c7a4214aSPierre Jolivet   if (idx) {
373c7a4214aSPierre Jolivet     ierr = PetscFree(*idx);CHKERRQ(ierr);
374c7a4214aSPierre Jolivet   }
375c7a4214aSPierre Jolivet   if (v) {
376c7a4214aSPierre Jolivet     ierr = PetscFree(*v);CHKERRQ(ierr);
377c7a4214aSPierre Jolivet   }
378c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
379c7a4214aSPierre Jolivet }
380c7a4214aSPierre Jolivet 
381c7a4214aSPierre Jolivet static PetscErrorCode MatSetFromOptions_Htool(PetscOptionItems *PetscOptionsObject,Mat A)
382c7a4214aSPierre Jolivet {
383c7a4214aSPierre Jolivet   Mat_Htool      *a = (Mat_Htool*)A->data;
384c7a4214aSPierre Jolivet   PetscInt       n;
385c7a4214aSPierre Jolivet   PetscBool      flg;
386c7a4214aSPierre Jolivet   PetscErrorCode ierr;
387c7a4214aSPierre Jolivet 
388c7a4214aSPierre Jolivet   PetscFunctionBegin;
389c7a4214aSPierre Jolivet   ierr = PetscOptionsHead(PetscOptionsObject,"Htool options");CHKERRQ(ierr);
390c7a4214aSPierre Jolivet   ierr = PetscOptionsInt("-mat_htool_min_cluster_size","Minimal leaf size in cluster tree",NULL,a->bs[0],a->bs,NULL);CHKERRQ(ierr);
391c7a4214aSPierre Jolivet   ierr = PetscOptionsInt("-mat_htool_max_block_size","Maximal number of coefficients in a dense block",NULL,a->bs[1],a->bs + 1,NULL);CHKERRQ(ierr);
392c7a4214aSPierre Jolivet   ierr = PetscOptionsReal("-mat_htool_epsilon","Relative error in Frobenius norm when approximating a block",NULL,a->epsilon,&a->epsilon,NULL);CHKERRQ(ierr);
393c7a4214aSPierre Jolivet   ierr = PetscOptionsReal("-mat_htool_eta","Admissibility condition tolerance",NULL,a->eta,&a->eta,NULL);CHKERRQ(ierr);
394c7a4214aSPierre Jolivet   ierr = PetscOptionsInt("-mat_htool_min_target_depth","Minimal cluster tree depth associated with the rows",NULL,a->depth[0],a->depth,NULL);CHKERRQ(ierr);
395c7a4214aSPierre Jolivet   ierr = PetscOptionsInt("-mat_htool_min_source_depth","Minimal cluster tree depth associated with the columns",NULL,a->depth[1],a->depth + 1,NULL);CHKERRQ(ierr);
396c7a4214aSPierre Jolivet   n = 0;
39798e73e17SPierre Jolivet   ierr = PetscOptionsEList("-mat_htool_compressor","Type of compression","MatHtoolCompressorType",MatHtoolCompressorTypes,ALEN(MatHtoolCompressorTypes),MatHtoolCompressorTypes[MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA],&n,&flg);CHKERRQ(ierr);
398c7a4214aSPierre Jolivet   if (flg) a->compressor = MatHtoolCompressorType(n);
39998e73e17SPierre Jolivet   n = 0;
40098e73e17SPierre Jolivet   ierr = PetscOptionsEList("-mat_htool_clustering","Type of clustering","MatHtoolClusteringType",MatHtoolClusteringTypes,ALEN(MatHtoolClusteringTypes),MatHtoolClusteringTypes[MAT_HTOOL_CLUSTERING_PCA_REGULAR],&n,&flg);CHKERRQ(ierr);
40198e73e17SPierre Jolivet   if (flg) a->clustering = MatHtoolClusteringType(n);
402c7a4214aSPierre Jolivet   ierr = PetscOptionsTail();CHKERRQ(ierr);
403c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
404c7a4214aSPierre Jolivet }
405c7a4214aSPierre Jolivet 
406c7a4214aSPierre Jolivet static PetscErrorCode MatAssemblyEnd_Htool(Mat A,MatAssemblyType type)
407c7a4214aSPierre Jolivet {
408c7a4214aSPierre Jolivet   Mat_Htool                                                    *a = (Mat_Htool*)A->data;
409c7a4214aSPierre Jolivet   const PetscInt                                               *ranges;
410c7a4214aSPierre Jolivet   PetscInt                                                     *offset;
411c7a4214aSPierre Jolivet   PetscMPIInt                                                  size;
412c7a4214aSPierre Jolivet   char                                                         S = PetscDefined(USE_COMPLEX) && A->hermitian ? 'H' : (A->symmetric ? 'S' : 'N'),uplo = S == 'N' ? 'N' : 'U';
413cab00e0dSPierre Jolivet   htool::VirtualGenerator<PetscScalar>                         *generator = nullptr;
41498e73e17SPierre Jolivet   std::shared_ptr<htool::VirtualCluster>                       t,s = nullptr;
4153b9338faSPierre Jolivet   std::shared_ptr<htool::VirtualLowRankGenerator<PetscScalar>> compressor = nullptr;
416c7a4214aSPierre Jolivet   PetscErrorCode                                               ierr;
417c7a4214aSPierre Jolivet 
418c7a4214aSPierre Jolivet   PetscFunctionBegin;
419c7a4214aSPierre Jolivet   ierr = PetscCitationsRegister(HtoolCitation,&HtoolCite);CHKERRQ(ierr);
420c7a4214aSPierre Jolivet   delete a->wrapper;
421c7a4214aSPierre Jolivet   delete a->hmatrix;
422c7a4214aSPierre Jolivet   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRMPI(ierr);
423c7a4214aSPierre Jolivet   ierr = PetscMalloc1(2*size,&offset);CHKERRQ(ierr);
424c7a4214aSPierre Jolivet   ierr = MatGetOwnershipRanges(A,&ranges);CHKERRQ(ierr);
425c7a4214aSPierre Jolivet   for (PetscInt i=0; i<size; ++i) {
426c7a4214aSPierre Jolivet     offset[2*i] = ranges[i];
427c7a4214aSPierre Jolivet     offset[2*i+1] = ranges[i+1] - ranges[i];
428c7a4214aSPierre Jolivet   }
42998e73e17SPierre Jolivet   switch (a->clustering) {
43098e73e17SPierre Jolivet   case MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC:
43198e73e17SPierre Jolivet     t = std::make_shared<htool::Cluster<htool::PCA<htool::SplittingTypes::GeometricSplitting>>>(a->dim);
43298e73e17SPierre Jolivet     break;
43398e73e17SPierre Jolivet   case MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC:
43498e73e17SPierre Jolivet     t = std::make_shared<htool::Cluster<htool::BoundingBox1<htool::SplittingTypes::GeometricSplitting>>>(a->dim);
43598e73e17SPierre Jolivet     break;
43698e73e17SPierre Jolivet   case MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR:
43798e73e17SPierre Jolivet     t = std::make_shared<htool::Cluster<htool::BoundingBox1<htool::SplittingTypes::RegularSplitting>>>(a->dim);
43898e73e17SPierre Jolivet     break;
43998e73e17SPierre Jolivet   default:
44098e73e17SPierre Jolivet     t = std::make_shared<htool::Cluster<htool::PCA<htool::SplittingTypes::RegularSplitting>>>(a->dim);
44198e73e17SPierre Jolivet   }
442c7a4214aSPierre Jolivet   t->set_minclustersize(a->bs[0]);
44398e73e17SPierre Jolivet   t->build(A->rmap->N,a->gcoords_target,offset);
444c7a4214aSPierre Jolivet   if (a->kernel) a->wrapper = new WrapperHtool(A->rmap->N,A->cmap->N,a->dim,a->kernel,a->kernelctx);
445c7a4214aSPierre Jolivet   else {
446c7a4214aSPierre Jolivet     a->wrapper = NULL;
447cab00e0dSPierre Jolivet     generator = reinterpret_cast<htool::VirtualGenerator<PetscScalar>*>(a->kernelctx);
448c7a4214aSPierre Jolivet   }
449c7a4214aSPierre Jolivet   if (a->gcoords_target != a->gcoords_source) {
450c7a4214aSPierre Jolivet     ierr = MatGetOwnershipRangesColumn(A,&ranges);CHKERRQ(ierr);
451c7a4214aSPierre Jolivet     for (PetscInt i=0; i<size; ++i) {
452c7a4214aSPierre Jolivet       offset[2*i] = ranges[i];
453c7a4214aSPierre Jolivet       offset[2*i+1] = ranges[i+1] - ranges[i];
454c7a4214aSPierre Jolivet     }
45598e73e17SPierre Jolivet     switch (a->clustering) {
45698e73e17SPierre Jolivet     case MAT_HTOOL_CLUSTERING_PCA_GEOMETRIC:
45798e73e17SPierre Jolivet       s = std::make_shared<htool::Cluster<htool::PCA<htool::SplittingTypes::GeometricSplitting>>>(a->dim);
45898e73e17SPierre Jolivet       break;
45998e73e17SPierre Jolivet     case MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_GEOMETRIC:
46098e73e17SPierre Jolivet       s = std::make_shared<htool::Cluster<htool::BoundingBox1<htool::SplittingTypes::GeometricSplitting>>>(a->dim);
46198e73e17SPierre Jolivet       break;
46298e73e17SPierre Jolivet     case MAT_HTOOL_CLUSTERING_BOUNDING_BOX_1_REGULAR:
46398e73e17SPierre Jolivet       s = std::make_shared<htool::Cluster<htool::BoundingBox1<htool::SplittingTypes::RegularSplitting>>>(a->dim);
46498e73e17SPierre Jolivet       break;
46598e73e17SPierre Jolivet     default:
46698e73e17SPierre Jolivet       s = std::make_shared<htool::Cluster<htool::PCA<htool::SplittingTypes::RegularSplitting>>>(a->dim);
46798e73e17SPierre Jolivet     }
468c7a4214aSPierre Jolivet     s->set_minclustersize(a->bs[0]);
46998e73e17SPierre Jolivet     s->build(A->cmap->N,a->gcoords_source,offset);
470c7a4214aSPierre Jolivet     S = uplo = 'N';
471c7a4214aSPierre Jolivet   }
472c7a4214aSPierre Jolivet   ierr = PetscFree(offset);CHKERRQ(ierr);
473c7a4214aSPierre Jolivet   switch (a->compressor) {
474c7a4214aSPierre Jolivet   case MAT_HTOOL_COMPRESSOR_FULL_ACA:
4753b9338faSPierre Jolivet     compressor = std::make_shared<htool::fullACA<PetscScalar>>();
476c7a4214aSPierre Jolivet     break;
477c7a4214aSPierre Jolivet   case MAT_HTOOL_COMPRESSOR_SVD:
4783b9338faSPierre Jolivet     compressor = std::make_shared<htool::SVD<PetscScalar>>();
479c7a4214aSPierre Jolivet     break;
480c7a4214aSPierre Jolivet   default:
4813b9338faSPierre Jolivet     compressor = std::make_shared<htool::sympartialACA<PetscScalar>>();
482c7a4214aSPierre Jolivet   }
4833b9338faSPierre Jolivet   a->hmatrix = dynamic_cast<htool::VirtualHMatrix<PetscScalar>*>(new htool::HMatrix<PetscScalar>(t,s ? s : t,a->epsilon,a->eta,S,uplo));
4843b9338faSPierre Jolivet   a->hmatrix->set_compression(compressor);
485c7a4214aSPierre Jolivet   a->hmatrix->set_maxblocksize(a->bs[1]);
486c7a4214aSPierre Jolivet   a->hmatrix->set_mintargetdepth(a->depth[0]);
487c7a4214aSPierre Jolivet   a->hmatrix->set_minsourcedepth(a->depth[1]);
4883b9338faSPierre Jolivet   if (s) a->hmatrix->build(a->wrapper ? *a->wrapper : *generator,a->gcoords_target,a->gcoords_source);
4893b9338faSPierre Jolivet   else   a->hmatrix->build(a->wrapper ? *a->wrapper : *generator,a->gcoords_target);
490c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
491c7a4214aSPierre Jolivet }
492c7a4214aSPierre Jolivet 
493c7a4214aSPierre Jolivet static PetscErrorCode MatProductNumeric_Htool(Mat C)
494c7a4214aSPierre Jolivet {
495c7a4214aSPierre Jolivet   Mat_Product       *product = C->product;
496c7a4214aSPierre Jolivet   Mat_Htool         *a = (Mat_Htool*)product->A->data;
497c7a4214aSPierre Jolivet   const PetscScalar *in;
498c7a4214aSPierre Jolivet   PetscScalar       *out;
499*8b8ddd11SPierre Jolivet   PetscInt          N,lda;
500c7a4214aSPierre Jolivet   PetscErrorCode    ierr;
501c7a4214aSPierre Jolivet 
502c7a4214aSPierre Jolivet   PetscFunctionBegin;
503c7a4214aSPierre Jolivet   MatCheckProduct(C,1);
504c7a4214aSPierre Jolivet   ierr = MatGetSize(C,NULL,&N);CHKERRQ(ierr);
505c7a4214aSPierre Jolivet   ierr = MatDenseGetLDA(C,&lda);CHKERRQ(ierr);
506c0aa6a63SJacob Faibussowitsch   if (lda != C->rmap->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unsupported leading dimension (%" PetscInt_FMT " != %" PetscInt_FMT ")",lda,C->rmap->n);
507c7a4214aSPierre Jolivet   ierr = MatDenseGetArrayRead(product->B,&in);CHKERRQ(ierr);
508c7a4214aSPierre Jolivet   ierr = MatDenseGetArrayWrite(C,&out);CHKERRQ(ierr);
509*8b8ddd11SPierre Jolivet   switch (product->type) {
510*8b8ddd11SPierre Jolivet   case MATPRODUCT_AB:
511c7a4214aSPierre Jolivet     a->hmatrix->mvprod_local_to_local(in,out,N);
512*8b8ddd11SPierre Jolivet     break;
513*8b8ddd11SPierre Jolivet   case MATPRODUCT_AtB:
514*8b8ddd11SPierre Jolivet     a->hmatrix->mvprod_transp_local_to_local(in,out,N);
515c7a4214aSPierre Jolivet     break;
516c7a4214aSPierre Jolivet   default:
517c7a4214aSPierre Jolivet     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"MatProductType %s is not supported",MatProductTypes[product->type]);
518c7a4214aSPierre Jolivet   }
519*8b8ddd11SPierre Jolivet   ierr = MatDenseRestoreArrayWrite(C,&out);CHKERRQ(ierr);
520*8b8ddd11SPierre Jolivet   ierr = MatDenseRestoreArrayRead(product->B,&in);CHKERRQ(ierr);
521*8b8ddd11SPierre Jolivet   ierr = MatScale(C,a->s);CHKERRQ(ierr);
522c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
523c7a4214aSPierre Jolivet }
524c7a4214aSPierre Jolivet 
525c7a4214aSPierre Jolivet static PetscErrorCode MatProductSymbolic_Htool(Mat C)
526c7a4214aSPierre Jolivet {
527c7a4214aSPierre Jolivet   Mat_Product    *product = C->product;
528c7a4214aSPierre Jolivet   Mat            A,B;
529c7a4214aSPierre Jolivet   PetscBool      flg;
530c7a4214aSPierre Jolivet   PetscErrorCode ierr;
531c7a4214aSPierre Jolivet 
532c7a4214aSPierre Jolivet   PetscFunctionBegin;
533c7a4214aSPierre Jolivet   MatCheckProduct(C,1);
534c7a4214aSPierre Jolivet   A = product->A;
535c7a4214aSPierre Jolivet   B = product->B;
536c7a4214aSPierre Jolivet   ierr = PetscObjectTypeCompareAny((PetscObject)B,&flg,MATSEQDENSE,MATMPIDENSE,"");CHKERRQ(ierr);
537c7a4214aSPierre Jolivet   if (!flg) SETERRQ1(PetscObjectComm((PetscObject)B),PETSC_ERR_SUP,"MatProduct_AB not supported for %s",((PetscObject)product->B)->type_name);
538c7a4214aSPierre Jolivet   switch (product->type) {
539c7a4214aSPierre Jolivet   case MATPRODUCT_AB:
540c7a4214aSPierre Jolivet     if (C->rmap->n == PETSC_DECIDE || C->cmap->n == PETSC_DECIDE || C->rmap->N == PETSC_DECIDE || C->cmap->N == PETSC_DECIDE) {
541c7a4214aSPierre Jolivet       ierr = MatSetSizes(C,A->rmap->n,B->cmap->n,A->rmap->N,B->cmap->N);CHKERRQ(ierr);
542c7a4214aSPierre Jolivet     }
543*8b8ddd11SPierre Jolivet     break;
544*8b8ddd11SPierre Jolivet   case MATPRODUCT_AtB:
545*8b8ddd11SPierre Jolivet     if (C->rmap->n == PETSC_DECIDE || C->cmap->n == PETSC_DECIDE || C->rmap->N == PETSC_DECIDE || C->cmap->N == PETSC_DECIDE) {
546*8b8ddd11SPierre Jolivet       ierr = MatSetSizes(C,A->cmap->n,B->cmap->n,A->cmap->N,B->cmap->N);CHKERRQ(ierr);
547*8b8ddd11SPierre Jolivet     }
548*8b8ddd11SPierre Jolivet     break;
549*8b8ddd11SPierre Jolivet   default:
550*8b8ddd11SPierre Jolivet     SETERRQ1(PetscObjectComm((PetscObject)B),PETSC_ERR_SUP,"ProductType %s is not supported",MatProductTypes[product->type]);
551*8b8ddd11SPierre Jolivet   }
552c7a4214aSPierre Jolivet   ierr = MatSetType(C,MATDENSE);CHKERRQ(ierr);
553c7a4214aSPierre Jolivet   ierr = MatSetUp(C);CHKERRQ(ierr);
554c7a4214aSPierre Jolivet   ierr = MatSetOption(C,MAT_NO_OFF_PROC_ENTRIES,PETSC_TRUE);CHKERRQ(ierr);
555c7a4214aSPierre Jolivet   ierr = MatAssemblyBegin(C,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
556c7a4214aSPierre Jolivet   ierr = MatAssemblyEnd(C,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
557c7a4214aSPierre Jolivet   C->ops->productsymbolic = NULL;
558c7a4214aSPierre Jolivet   C->ops->productnumeric = MatProductNumeric_Htool;
559c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
560c7a4214aSPierre Jolivet }
561c7a4214aSPierre Jolivet 
562c7a4214aSPierre Jolivet static PetscErrorCode MatProductSetFromOptions_Htool(Mat C)
563c7a4214aSPierre Jolivet {
564c7a4214aSPierre Jolivet   PetscFunctionBegin;
565c7a4214aSPierre Jolivet   MatCheckProduct(C,1);
566*8b8ddd11SPierre Jolivet   if (C->product->type == MATPRODUCT_AB || C->product->type == MATPRODUCT_AtB) C->ops->productsymbolic = MatProductSymbolic_Htool;
567c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
568c7a4214aSPierre Jolivet }
569c7a4214aSPierre Jolivet 
57098e73e17SPierre Jolivet static PetscErrorCode MatHtoolGetHierarchicalMat_Htool(Mat A,const htool::VirtualHMatrix<PetscScalar> **hmatrix)
571c7a4214aSPierre Jolivet {
572c7a4214aSPierre Jolivet   Mat_Htool *a = (Mat_Htool*)A->data;
573c7a4214aSPierre Jolivet 
574c7a4214aSPierre Jolivet   PetscFunctionBegin;
575c7a4214aSPierre Jolivet   *hmatrix = a->hmatrix;
576c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
577c7a4214aSPierre Jolivet }
578c7a4214aSPierre Jolivet 
579c7a4214aSPierre Jolivet /*@C
580c7a4214aSPierre Jolivet      MatHtoolGetHierarchicalMat - Retrieves the opaque pointer to a Htool virtual matrix stored in a MATHTOOL.
581c7a4214aSPierre Jolivet 
582c7a4214aSPierre Jolivet    Input Parameter:
583c7a4214aSPierre Jolivet .     A - hierarchical matrix
584c7a4214aSPierre Jolivet 
585c7a4214aSPierre Jolivet    Output Parameter:
586c7a4214aSPierre Jolivet .     hmatrix - opaque pointer to a Htool virtual matrix
587c7a4214aSPierre Jolivet 
588c7a4214aSPierre Jolivet    Level: advanced
589c7a4214aSPierre Jolivet 
590c7a4214aSPierre Jolivet .seealso:  MATHTOOL
591c7a4214aSPierre Jolivet @*/
59298e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolGetHierarchicalMat(Mat A,const htool::VirtualHMatrix<PetscScalar> **hmatrix)
593c7a4214aSPierre Jolivet {
594c7a4214aSPierre Jolivet   PetscErrorCode ierr;
595c7a4214aSPierre Jolivet 
596c7a4214aSPierre Jolivet   PetscFunctionBegin;
597c7a4214aSPierre Jolivet   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
598c7a4214aSPierre Jolivet   PetscValidPointer(hmatrix,2);
59998e73e17SPierre Jolivet   ierr = PetscTryMethod(A,"MatHtoolGetHierarchicalMat_C",(Mat,const htool::VirtualHMatrix<PetscScalar>**),(A,hmatrix));CHKERRQ(ierr);
600c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
601c7a4214aSPierre Jolivet }
602c7a4214aSPierre Jolivet 
603c7a4214aSPierre Jolivet static PetscErrorCode MatHtoolSetKernel_Htool(Mat A,MatHtoolKernel kernel,void *kernelctx)
604c7a4214aSPierre Jolivet {
605c7a4214aSPierre Jolivet   Mat_Htool *a = (Mat_Htool*)A->data;
606c7a4214aSPierre Jolivet 
607c7a4214aSPierre Jolivet   PetscFunctionBegin;
608c7a4214aSPierre Jolivet   a->kernel    = kernel;
609c7a4214aSPierre Jolivet   a->kernelctx = kernelctx;
610c7a4214aSPierre Jolivet   delete a->wrapper;
611c7a4214aSPierre Jolivet   if (a->kernel) a->wrapper = new WrapperHtool(A->rmap->N,A->cmap->N,a->dim,a->kernel,a->kernelctx);
612c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
613c7a4214aSPierre Jolivet }
614c7a4214aSPierre Jolivet 
615c7a4214aSPierre Jolivet /*@C
61698e73e17SPierre Jolivet      MatHtoolSetKernel - Sets the kernel and context used for the assembly of a MATHTOOL.
617c7a4214aSPierre Jolivet 
618c7a4214aSPierre Jolivet    Input Parameters:
619c7a4214aSPierre Jolivet +     A - hierarchical matrix
620c7a4214aSPierre Jolivet .     kernel - computational kernel (or NULL)
621cab00e0dSPierre Jolivet -     kernelctx - kernel context (if kernel is NULL, the pointer must be of type htool::VirtualGenerator<PetscScalar>*)
622c7a4214aSPierre Jolivet 
623c7a4214aSPierre Jolivet    Level: advanced
624c7a4214aSPierre Jolivet 
625c7a4214aSPierre Jolivet .seealso:  MATHTOOL, MatCreateHtoolFromKernel()
626c7a4214aSPierre Jolivet @*/
627c7a4214aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolSetKernel(Mat A,MatHtoolKernel kernel,void *kernelctx)
628c7a4214aSPierre Jolivet {
629c7a4214aSPierre Jolivet   PetscErrorCode ierr;
630c7a4214aSPierre Jolivet 
631c7a4214aSPierre Jolivet   PetscFunctionBegin;
632c7a4214aSPierre Jolivet   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
633c7a4214aSPierre Jolivet   if (!kernelctx) PetscValidFunction(kernel,2);
634c7a4214aSPierre Jolivet   if (!kernel)    PetscValidPointer(kernelctx,3);
635c7a4214aSPierre Jolivet   ierr = PetscTryMethod(A,"MatHtoolSetKernel_C",(Mat,MatHtoolKernel,void*),(A,kernel,kernelctx));CHKERRQ(ierr);
636c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
637c7a4214aSPierre Jolivet }
638c7a4214aSPierre Jolivet 
63998e73e17SPierre Jolivet static PetscErrorCode MatHtoolGetPermutationSource_Htool(Mat A,IS* is)
64098e73e17SPierre Jolivet {
64198e73e17SPierre Jolivet   Mat_Htool             *a = (Mat_Htool*)A->data;
64298e73e17SPierre Jolivet   std::vector<PetscInt> source;
64398e73e17SPierre Jolivet   PetscErrorCode        ierr;
64498e73e17SPierre Jolivet 
64598e73e17SPierre Jolivet   PetscFunctionBegin;
646a9918087SPierre Jolivet   source = a->hmatrix->get_source_cluster()->get_local_perm();
64798e73e17SPierre Jolivet   ierr = ISCreateGeneral(PetscObjectComm((PetscObject)A),source.size(),source.data(),PETSC_COPY_VALUES,is);CHKERRQ(ierr);
64898e73e17SPierre Jolivet   ierr = ISSetPermutation(*is);CHKERRQ(ierr);
64998e73e17SPierre Jolivet   PetscFunctionReturn(0);
65098e73e17SPierre Jolivet }
65198e73e17SPierre Jolivet 
65298e73e17SPierre Jolivet /*@C
65398e73e17SPierre Jolivet      MatHtoolGetPermutationSource - Gets the permutation associated to the source cluster.
65498e73e17SPierre Jolivet 
65598e73e17SPierre Jolivet    Input Parameter:
65698e73e17SPierre Jolivet .     A - hierarchical matrix
65798e73e17SPierre Jolivet 
65898e73e17SPierre Jolivet    Output Parameter:
65998e73e17SPierre Jolivet .     is - permutation
66098e73e17SPierre Jolivet 
66198e73e17SPierre Jolivet    Level: advanced
66298e73e17SPierre Jolivet 
66398e73e17SPierre Jolivet .seealso:  MATHTOOL, MatHtoolGetPermutationTarget(), MatHtoolUsePermutation()
66498e73e17SPierre Jolivet @*/
66598e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationSource(Mat A,IS* is)
66698e73e17SPierre Jolivet {
66798e73e17SPierre Jolivet   PetscErrorCode ierr;
66898e73e17SPierre Jolivet 
66998e73e17SPierre Jolivet   PetscFunctionBegin;
67098e73e17SPierre Jolivet   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
67198e73e17SPierre Jolivet   if (!is) PetscValidPointer(is,2);
67298e73e17SPierre Jolivet   ierr = PetscTryMethod(A,"MatHtoolGetPermutationSource_C",(Mat,IS*),(A,is));CHKERRQ(ierr);
67398e73e17SPierre Jolivet   PetscFunctionReturn(0);
67498e73e17SPierre Jolivet }
67598e73e17SPierre Jolivet 
67698e73e17SPierre Jolivet static PetscErrorCode MatHtoolGetPermutationTarget_Htool(Mat A,IS* is)
67798e73e17SPierre Jolivet {
67898e73e17SPierre Jolivet   Mat_Htool             *a = (Mat_Htool*)A->data;
67998e73e17SPierre Jolivet   std::vector<PetscInt> target;
68098e73e17SPierre Jolivet   PetscErrorCode        ierr;
68198e73e17SPierre Jolivet 
68298e73e17SPierre Jolivet   PetscFunctionBegin;
683a9918087SPierre Jolivet   target = a->hmatrix->get_target_cluster()->get_local_perm();
68498e73e17SPierre Jolivet   ierr = ISCreateGeneral(PetscObjectComm((PetscObject)A),target.size(),target.data(),PETSC_COPY_VALUES,is);CHKERRQ(ierr);
68598e73e17SPierre Jolivet   ierr = ISSetPermutation(*is);CHKERRQ(ierr);
68698e73e17SPierre Jolivet   PetscFunctionReturn(0);
68798e73e17SPierre Jolivet }
68898e73e17SPierre Jolivet 
68998e73e17SPierre Jolivet /*@C
69098e73e17SPierre Jolivet      MatHtoolGetPermutationTarget - Gets the permutation associated to the target cluster.
69198e73e17SPierre Jolivet 
69298e73e17SPierre Jolivet    Input Parameter:
69398e73e17SPierre Jolivet .     A - hierarchical matrix
69498e73e17SPierre Jolivet 
69598e73e17SPierre Jolivet    Output Parameter:
69698e73e17SPierre Jolivet .     is - permutation
69798e73e17SPierre Jolivet 
69898e73e17SPierre Jolivet    Level: advanced
69998e73e17SPierre Jolivet 
70098e73e17SPierre Jolivet .seealso:  MATHTOOL, MatHtoolGetPermutationSource(), MatHtoolUsePermutation()
70198e73e17SPierre Jolivet @*/
70298e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolGetPermutationTarget(Mat A,IS* is)
70398e73e17SPierre Jolivet {
70498e73e17SPierre Jolivet   PetscErrorCode ierr;
70598e73e17SPierre Jolivet 
70698e73e17SPierre Jolivet   PetscFunctionBegin;
70798e73e17SPierre Jolivet   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
70898e73e17SPierre Jolivet   if (!is) PetscValidPointer(is,2);
70998e73e17SPierre Jolivet   ierr = PetscTryMethod(A,"MatHtoolGetPermutationTarget_C",(Mat,IS*),(A,is));CHKERRQ(ierr);
71098e73e17SPierre Jolivet   PetscFunctionReturn(0);
71198e73e17SPierre Jolivet }
71298e73e17SPierre Jolivet 
71398e73e17SPierre Jolivet static PetscErrorCode MatHtoolUsePermutation_Htool(Mat A,PetscBool use)
71498e73e17SPierre Jolivet {
71598e73e17SPierre Jolivet   Mat_Htool *a = (Mat_Htool*)A->data;
71698e73e17SPierre Jolivet 
71798e73e17SPierre Jolivet   PetscFunctionBegin;
71898e73e17SPierre Jolivet   a->hmatrix->set_use_permutation(use);
71998e73e17SPierre Jolivet   PetscFunctionReturn(0);
72098e73e17SPierre Jolivet }
72198e73e17SPierre Jolivet 
72298e73e17SPierre Jolivet /*@C
72398e73e17SPierre Jolivet      MatHtoolUsePermutation - Sets whether MATHTOOL should permute input (resp. output) vectors following its internal source (resp. target) permutation.
72498e73e17SPierre Jolivet 
72598e73e17SPierre Jolivet    Input Parameters:
72698e73e17SPierre Jolivet +     A - hierarchical matrix
72798e73e17SPierre Jolivet -     use - Boolean value
72898e73e17SPierre Jolivet 
72998e73e17SPierre Jolivet    Level: advanced
73098e73e17SPierre Jolivet 
73198e73e17SPierre Jolivet .seealso:  MATHTOOL, MatHtoolGetPermutationSource(), MatHtoolGetPermutationTarget()
73298e73e17SPierre Jolivet @*/
73398e73e17SPierre Jolivet PETSC_EXTERN PetscErrorCode MatHtoolUsePermutation(Mat A,PetscBool use)
73498e73e17SPierre Jolivet {
73598e73e17SPierre Jolivet   PetscErrorCode ierr;
73698e73e17SPierre Jolivet 
73798e73e17SPierre Jolivet   PetscFunctionBegin;
73898e73e17SPierre Jolivet   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
73998e73e17SPierre Jolivet   PetscValidLogicalCollectiveBool(A,use,2);
74098e73e17SPierre Jolivet   ierr = PetscTryMethod(A,"MatHtoolUsePermutation_C",(Mat,PetscBool),(A,use));CHKERRQ(ierr);
74198e73e17SPierre Jolivet   PetscFunctionReturn(0);
74298e73e17SPierre Jolivet }
74398e73e17SPierre Jolivet 
744c7a4214aSPierre Jolivet static PetscErrorCode MatConvert_Htool_Dense(Mat A,MatType newtype,MatReuse reuse,Mat *B)
745c7a4214aSPierre Jolivet {
746c7a4214aSPierre Jolivet   Mat            C;
747c7a4214aSPierre Jolivet   Mat_Htool      *a = (Mat_Htool*)A->data;
748c7a4214aSPierre Jolivet   PetscInt       lda;
749c7a4214aSPierre Jolivet   PetscScalar    *array;
750c7a4214aSPierre Jolivet   PetscErrorCode ierr;
751c7a4214aSPierre Jolivet 
752c7a4214aSPierre Jolivet   PetscFunctionBegin;
753c7a4214aSPierre Jolivet   if (reuse == MAT_REUSE_MATRIX) {
754c7a4214aSPierre Jolivet     C = *B;
755c7a4214aSPierre Jolivet     if (C->rmap->n != A->rmap->n || C->cmap->N != A->cmap->N) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_SIZ,"Incompatible dimensions");
756c7a4214aSPierre Jolivet     ierr = MatDenseGetLDA(C,&lda);CHKERRQ(ierr);
757c0aa6a63SJacob Faibussowitsch     if (lda != C->rmap->n) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_SUP,"Unsupported leading dimension (%" PetscInt_FMT " != %" PetscInt_FMT ")",lda,C->rmap->n);
758c7a4214aSPierre Jolivet   } else {
759c7a4214aSPierre Jolivet     ierr = MatCreate(PetscObjectComm((PetscObject)A),&C);CHKERRQ(ierr);
760c7a4214aSPierre Jolivet     ierr = MatSetSizes(C,A->rmap->n,A->cmap->n,A->rmap->N,A->cmap->N);CHKERRQ(ierr);
761c7a4214aSPierre Jolivet     ierr = MatSetType(C,MATDENSE);CHKERRQ(ierr);
762c7a4214aSPierre Jolivet     ierr = MatSetUp(C);CHKERRQ(ierr);
763c7a4214aSPierre Jolivet     ierr = MatSetOption(C,MAT_NO_OFF_PROC_ENTRIES,PETSC_TRUE);CHKERRQ(ierr);
764c7a4214aSPierre Jolivet   }
765c7a4214aSPierre Jolivet   ierr = MatAssemblyBegin(C,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
766c7a4214aSPierre Jolivet   ierr = MatAssemblyEnd(C,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
767c7a4214aSPierre Jolivet   ierr = MatDenseGetArrayWrite(C,&array);CHKERRQ(ierr);
768c7a4214aSPierre Jolivet   a->hmatrix->copy_local_dense_perm(array);
769c7a4214aSPierre Jolivet   ierr = MatDenseRestoreArrayWrite(C,&array);CHKERRQ(ierr);
770c7a4214aSPierre Jolivet   ierr = MatScale(C,a->s);CHKERRQ(ierr);
771c7a4214aSPierre Jolivet   if (reuse == MAT_INPLACE_MATRIX) {
772c7a4214aSPierre Jolivet     ierr = MatHeaderReplace(A,&C);CHKERRQ(ierr);
773c7a4214aSPierre Jolivet   } else *B = C;
774c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
775c7a4214aSPierre Jolivet }
776c7a4214aSPierre Jolivet 
77798e73e17SPierre Jolivet static PetscErrorCode GenEntriesTranspose(PetscInt sdim,PetscInt M,PetscInt N,const PetscInt *rows,const PetscInt *cols,PetscScalar *ptr,void *ctx)
778c7a4214aSPierre Jolivet {
779c7a4214aSPierre Jolivet   MatHtoolKernelTranspose *generator = (MatHtoolKernelTranspose*)ctx;
78098e73e17SPierre Jolivet   PetscScalar             *tmp;
78198e73e17SPierre Jolivet   PetscErrorCode          ierr;
78298e73e17SPierre Jolivet 
78398e73e17SPierre Jolivet   PetscFunctionBegin;
78498e73e17SPierre Jolivet   generator->kernel(sdim,N,M,cols,rows,ptr,generator->kernelctx);
78598e73e17SPierre Jolivet   ierr = PetscMalloc1(M*N,&tmp);CHKERRQ(ierr);
78698e73e17SPierre Jolivet   ierr = PetscArraycpy(tmp,ptr,M*N);CHKERRQ(ierr);
78798e73e17SPierre Jolivet   for (PetscInt i=0; i<M; ++i) {
78898e73e17SPierre Jolivet     for (PetscInt j=0; j<N; ++j) ptr[i+j*M] = tmp[j+i*N];
78998e73e17SPierre Jolivet   }
79098e73e17SPierre Jolivet   ierr = PetscFree(tmp);CHKERRQ(ierr);
79198e73e17SPierre Jolivet   PetscFunctionReturn(0);
792c7a4214aSPierre Jolivet }
793c7a4214aSPierre Jolivet 
794c7a4214aSPierre Jolivet /* naive implementation which keeps a reference to the original Mat */
795c7a4214aSPierre Jolivet static PetscErrorCode MatTranspose_Htool(Mat A,MatReuse reuse,Mat *B)
796c7a4214aSPierre Jolivet {
797c7a4214aSPierre Jolivet   Mat                     C;
798c7a4214aSPierre Jolivet   Mat_Htool               *a = (Mat_Htool*)A->data,*c;
799c7a4214aSPierre Jolivet   PetscInt                M = A->rmap->N,N = A->cmap->N,m = A->rmap->n,n = A->cmap->n;
800c7a4214aSPierre Jolivet   PetscContainer          container;
801c7a4214aSPierre Jolivet   MatHtoolKernelTranspose *kernelt;
802c7a4214aSPierre Jolivet   PetscErrorCode          ierr;
803c7a4214aSPierre Jolivet 
804c7a4214aSPierre Jolivet   PetscFunctionBegin;
805c7a4214aSPierre Jolivet   if (reuse == MAT_INPLACE_MATRIX) SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MatTranspose() with MAT_INPLACE_MATRIX not supported");
806c7a4214aSPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
807c7a4214aSPierre Jolivet     ierr = MatCreate(PetscObjectComm((PetscObject)A),&C);CHKERRQ(ierr);
808c7a4214aSPierre Jolivet     ierr = MatSetSizes(C,n,m,N,M);CHKERRQ(ierr);
809c7a4214aSPierre Jolivet     ierr = MatSetType(C,((PetscObject)A)->type_name);CHKERRQ(ierr);
810c7a4214aSPierre Jolivet     ierr = MatSetUp(C);CHKERRQ(ierr);
811c7a4214aSPierre Jolivet     ierr = PetscContainerCreate(PetscObjectComm((PetscObject)C),&container);CHKERRQ(ierr);
812c7a4214aSPierre Jolivet     ierr = PetscNew(&kernelt);CHKERRQ(ierr);
813c7a4214aSPierre Jolivet     ierr = PetscContainerSetPointer(container,kernelt);CHKERRQ(ierr);
814c7a4214aSPierre Jolivet     ierr = PetscObjectCompose((PetscObject)C,"KernelTranspose",(PetscObject)container);CHKERRQ(ierr);
815c7a4214aSPierre Jolivet   } else {
816c7a4214aSPierre Jolivet     C = *B;
817c7a4214aSPierre Jolivet     ierr = PetscObjectQuery((PetscObject)C,"KernelTranspose",(PetscObject*)&container);CHKERRQ(ierr);
818c7a4214aSPierre Jolivet     if (!container) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call MatTranspose() with MAT_INITIAL_MATRIX first");
819c7a4214aSPierre Jolivet     ierr = PetscContainerGetPointer(container,(void**)&kernelt);CHKERRQ(ierr);
820c7a4214aSPierre Jolivet   }
821c7a4214aSPierre Jolivet   c                  = (Mat_Htool*)C->data;
822c7a4214aSPierre Jolivet   c->dim             = a->dim;
823c7a4214aSPierre Jolivet   c->s               = a->s;
82498e73e17SPierre Jolivet   c->kernel          = GenEntriesTranspose;
825c7a4214aSPierre Jolivet   if (kernelt->A != A) {
826c7a4214aSPierre Jolivet     ierr = MatDestroy(&kernelt->A);CHKERRQ(ierr);
827c7a4214aSPierre Jolivet     kernelt->A       = A;
828c7a4214aSPierre Jolivet     ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
829c7a4214aSPierre Jolivet   }
830c7a4214aSPierre Jolivet   kernelt->kernel    = a->kernel;
831c7a4214aSPierre Jolivet   kernelt->kernelctx = a->kernelctx;
832c7a4214aSPierre Jolivet   c->kernelctx       = kernelt;
833c7a4214aSPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
834c7a4214aSPierre Jolivet     ierr = PetscMalloc1(N*c->dim,&c->gcoords_target);CHKERRQ(ierr);
835c7a4214aSPierre Jolivet     ierr = PetscArraycpy(c->gcoords_target,a->gcoords_source,N*c->dim);CHKERRQ(ierr);
836c7a4214aSPierre Jolivet     if (a->gcoords_target != a->gcoords_source) {
837c7a4214aSPierre Jolivet       ierr = PetscMalloc1(M*c->dim,&c->gcoords_source);CHKERRQ(ierr);
838c7a4214aSPierre Jolivet       ierr = PetscArraycpy(c->gcoords_source,a->gcoords_target,M*c->dim);CHKERRQ(ierr);
839c7a4214aSPierre Jolivet     } else c->gcoords_source = c->gcoords_target;
840c7a4214aSPierre Jolivet     ierr = PetscCalloc2(M,&c->work_source,N,&c->work_target);CHKERRQ(ierr);
841c7a4214aSPierre Jolivet   }
842c7a4214aSPierre Jolivet   ierr = MatAssemblyBegin(C,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
843c7a4214aSPierre Jolivet   ierr = MatAssemblyEnd(C,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
844c7a4214aSPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) *B = C;
845c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
846c7a4214aSPierre Jolivet }
847c7a4214aSPierre Jolivet 
848c7a4214aSPierre Jolivet /*@C
849c7a4214aSPierre Jolivet      MatCreateHtoolFromKernel - Creates a MATHTOOL from a user-supplied kernel.
850c7a4214aSPierre Jolivet 
851c7a4214aSPierre Jolivet    Input Parameters:
852c7a4214aSPierre Jolivet +     comm - MPI communicator
853c7a4214aSPierre Jolivet .     m - number of local rows (or PETSC_DECIDE to have calculated if M is given)
854c7a4214aSPierre Jolivet .     n - number of local columns (or PETSC_DECIDE to have calculated if N is given)
855c7a4214aSPierre Jolivet .     M - number of global rows (or PETSC_DETERMINE to have calculated if m is given)
856c7a4214aSPierre Jolivet .     N - number of global columns (or PETSC_DETERMINE to have calculated if n is given)
857c7a4214aSPierre Jolivet .     spacedim - dimension of the space coordinates
858c7a4214aSPierre Jolivet .     coords_target - coordinates of the target
859c7a4214aSPierre Jolivet .     coords_source - coordinates of the source
860c7a4214aSPierre Jolivet .     kernel - computational kernel (or NULL)
861cab00e0dSPierre Jolivet -     kernelctx - kernel context (if kernel is NULL, the pointer must be of type htool::VirtualGenerator<PetscScalar>*)
862c7a4214aSPierre Jolivet 
863c7a4214aSPierre Jolivet    Output Parameter:
864c7a4214aSPierre Jolivet .     B - matrix
865c7a4214aSPierre Jolivet 
866c7a4214aSPierre Jolivet    Options Database Keys:
867c7a4214aSPierre Jolivet +     -mat_htool_min_cluster_size <PetscInt> - minimal leaf size in cluster tree
868c7a4214aSPierre Jolivet .     -mat_htool_max_block_size <PetscInt> - maximal number of coefficients in a dense block
869c7a4214aSPierre Jolivet .     -mat_htool_epsilon <PetscReal> - relative error in Frobenius norm when approximating a block
870c7a4214aSPierre Jolivet .     -mat_htool_eta <PetscReal> - admissibility condition tolerance
871c7a4214aSPierre Jolivet .     -mat_htool_min_target_depth <PetscInt> - minimal cluster tree depth associated with the rows
872c7a4214aSPierre Jolivet .     -mat_htool_min_source_depth <PetscInt> - minimal cluster tree depth associated with the columns
87398e73e17SPierre Jolivet .     -mat_htool_compressor <sympartialACA, fullACA, SVD> - type of compression
87498e73e17SPierre Jolivet -     -mat_htool_clustering <PCARegular, PCAGeometric, BounbingBox1Regular, BoundingBox1Geometric> - type of clustering
875c7a4214aSPierre Jolivet 
876c7a4214aSPierre Jolivet    Level: intermediate
877c7a4214aSPierre Jolivet 
87853022affSStefano Zampini .seealso:  MatCreate(), MATHTOOL, PCSetCoordinates(), MatHtoolSetKernel(), MatHtoolCompressorType, MATH2OPUS, MatCreateH2OpusFromKernel()
879c7a4214aSPierre Jolivet @*/
880c7a4214aSPierre Jolivet PetscErrorCode MatCreateHtoolFromKernel(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt spacedim,const PetscReal coords_target[],const PetscReal coords_source[],MatHtoolKernel kernel,void *kernelctx,Mat *B)
881c7a4214aSPierre Jolivet {
882c7a4214aSPierre Jolivet   Mat            A;
883c7a4214aSPierre Jolivet   Mat_Htool      *a;
884c7a4214aSPierre Jolivet   PetscErrorCode ierr;
885c7a4214aSPierre Jolivet 
886c7a4214aSPierre Jolivet   PetscFunctionBegin;
887c7a4214aSPierre Jolivet   ierr = MatCreate(comm,&A);CHKERRQ(ierr);
888c7a4214aSPierre Jolivet   PetscValidLogicalCollectiveInt(A,spacedim,6);
889c7a4214aSPierre Jolivet   PetscValidRealPointer(coords_target,7);
890c7a4214aSPierre Jolivet   PetscValidRealPointer(coords_source,8);
891c7a4214aSPierre Jolivet   if (!kernelctx) PetscValidFunction(kernel,9);
892c7a4214aSPierre Jolivet   if (!kernel)    PetscValidPointer(kernelctx,10);
893c7a4214aSPierre Jolivet   ierr = MatSetSizes(A,m,n,M,N);CHKERRQ(ierr);
894c7a4214aSPierre Jolivet   ierr = MatSetType(A,MATHTOOL);CHKERRQ(ierr);
895c7a4214aSPierre Jolivet   ierr = MatSetUp(A);CHKERRQ(ierr);
896c7a4214aSPierre Jolivet   a            = (Mat_Htool*)A->data;
897c7a4214aSPierre Jolivet   a->dim       = spacedim;
898c7a4214aSPierre Jolivet   a->s         = 1.0;
899c7a4214aSPierre Jolivet   a->kernel    = kernel;
900c7a4214aSPierre Jolivet   a->kernelctx = kernelctx;
901c7a4214aSPierre Jolivet   ierr = PetscCalloc1(A->rmap->N*spacedim,&a->gcoords_target);CHKERRQ(ierr);
902c7a4214aSPierre Jolivet   ierr = PetscArraycpy(a->gcoords_target+A->rmap->rstart*spacedim,coords_target,A->rmap->n*spacedim);CHKERRQ(ierr);
903c7a4214aSPierre Jolivet   ierr = MPIU_Allreduce(MPI_IN_PLACE,a->gcoords_target,A->rmap->N*spacedim,MPIU_REAL,MPI_SUM,PetscObjectComm((PetscObject)A));CHKERRMPI(ierr); /* global target coordinates */
904c7a4214aSPierre Jolivet   if (coords_target != coords_source) {
905c7a4214aSPierre Jolivet     ierr = PetscCalloc1(A->cmap->N*spacedim,&a->gcoords_source);CHKERRQ(ierr);
906c7a4214aSPierre Jolivet     ierr = PetscArraycpy(a->gcoords_source+A->cmap->rstart*spacedim,coords_source,A->cmap->n*spacedim);CHKERRQ(ierr);
907c7a4214aSPierre Jolivet     ierr = MPIU_Allreduce(MPI_IN_PLACE,a->gcoords_source,A->cmap->N*spacedim,MPIU_REAL,MPI_SUM,PetscObjectComm((PetscObject)A));CHKERRMPI(ierr); /* global source coordinates */
908c7a4214aSPierre Jolivet   } else a->gcoords_source = a->gcoords_target;
909c7a4214aSPierre Jolivet   ierr = PetscCalloc2(A->cmap->N,&a->work_source,A->rmap->N,&a->work_target);CHKERRQ(ierr);
910c7a4214aSPierre Jolivet   *B = A;
911c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
912c7a4214aSPierre Jolivet }
913c7a4214aSPierre Jolivet 
914c7a4214aSPierre Jolivet /*MC
915c7a4214aSPierre Jolivet      MATHTOOL = "htool" - A matrix type for hierarchical matrices using the Htool package.
916c7a4214aSPierre Jolivet 
917c7a4214aSPierre Jolivet   Use ./configure --download-htool to install PETSc to use Htool.
918c7a4214aSPierre Jolivet 
919c7a4214aSPierre Jolivet    Options Database Keys:
920e85a1b63SPatrick Sanan .     -mat_type htool - matrix type to "htool" during a call to MatSetFromOptions()
921c7a4214aSPierre Jolivet 
922c7a4214aSPierre Jolivet    Level: beginner
923c7a4214aSPierre Jolivet 
92453022affSStefano Zampini .seealso: MATH2OPUS, MATDENSE, MatCreateHtoolFromKernel(), MatHtoolSetKernel()
925c7a4214aSPierre Jolivet M*/
926c7a4214aSPierre Jolivet PETSC_EXTERN PetscErrorCode MatCreate_Htool(Mat A)
927c7a4214aSPierre Jolivet {
928c7a4214aSPierre Jolivet   Mat_Htool      *a;
929c7a4214aSPierre Jolivet   PetscErrorCode ierr;
930c7a4214aSPierre Jolivet 
931c7a4214aSPierre Jolivet   PetscFunctionBegin;
932c7a4214aSPierre Jolivet   ierr = PetscNewLog(A,&a);CHKERRQ(ierr);
933c7a4214aSPierre Jolivet   A->data = (void*)a;
934c7a4214aSPierre Jolivet   ierr = PetscObjectChangeTypeName((PetscObject)A,MATHTOOL);CHKERRQ(ierr);
935c7a4214aSPierre Jolivet   ierr = PetscMemzero(A->ops,sizeof(struct _MatOps));CHKERRQ(ierr);
936c7a4214aSPierre Jolivet   A->ops->getdiagonal       = MatGetDiagonal_Htool;
937c7a4214aSPierre Jolivet   A->ops->getdiagonalblock  = MatGetDiagonalBlock_Htool;
938c7a4214aSPierre Jolivet   A->ops->mult              = MatMult_Htool;
939c7a4214aSPierre Jolivet   A->ops->multadd           = MatMultAdd_Htool;
940*8b8ddd11SPierre Jolivet   A->ops->multtranspose     = MatMultTranspose_Htool;
941*8b8ddd11SPierre Jolivet   if (!PetscDefined(USE_COMPLEX)) A->ops->multhermitiantranspose = MatMultTranspose_Htool;
942c7a4214aSPierre Jolivet   A->ops->increaseoverlap   = MatIncreaseOverlap_Htool;
943c7a4214aSPierre Jolivet   A->ops->createsubmatrices = MatCreateSubMatrices_Htool;
944c7a4214aSPierre Jolivet   A->ops->transpose         = MatTranspose_Htool;
945c7a4214aSPierre Jolivet   A->ops->destroy           = MatDestroy_Htool;
946c7a4214aSPierre Jolivet   A->ops->view              = MatView_Htool;
947c7a4214aSPierre Jolivet   A->ops->setfromoptions    = MatSetFromOptions_Htool;
948c7a4214aSPierre Jolivet   A->ops->scale             = MatScale_Htool;
949c7a4214aSPierre Jolivet   A->ops->getrow            = MatGetRow_Htool;
950c7a4214aSPierre Jolivet   A->ops->restorerow        = MatRestoreRow_Htool;
951c7a4214aSPierre Jolivet   A->ops->assemblyend       = MatAssemblyEnd_Htool;
952c7a4214aSPierre Jolivet   a->dim                    = 0;
953c7a4214aSPierre Jolivet   a->gcoords_target         = NULL;
954c7a4214aSPierre Jolivet   a->gcoords_source         = NULL;
955c7a4214aSPierre Jolivet   a->s                      = 1.0;
956c7a4214aSPierre Jolivet   a->bs[0]                  = 10;
957c7a4214aSPierre Jolivet   a->bs[1]                  = 1000000;
958c7a4214aSPierre Jolivet   a->epsilon                = PetscSqrtReal(PETSC_SMALL);
959c7a4214aSPierre Jolivet   a->eta                    = 10.0;
960c7a4214aSPierre Jolivet   a->depth[0]               = 0;
961c7a4214aSPierre Jolivet   a->depth[1]               = 0;
962c7a4214aSPierre Jolivet   a->compressor             = MAT_HTOOL_COMPRESSOR_SYMPARTIAL_ACA;
963c7a4214aSPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatProductSetFromOptions_htool_seqdense_C",MatProductSetFromOptions_Htool);CHKERRQ(ierr);
964c7a4214aSPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatProductSetFromOptions_htool_mpidense_C",MatProductSetFromOptions_Htool);CHKERRQ(ierr);
965c7a4214aSPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatConvert_htool_seqdense_C",MatConvert_Htool_Dense);CHKERRQ(ierr);
966c7a4214aSPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatConvert_htool_mpidense_C",MatConvert_Htool_Dense);CHKERRQ(ierr);
967c7a4214aSPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatHtoolGetHierarchicalMat_C",MatHtoolGetHierarchicalMat_Htool);CHKERRQ(ierr);
968c7a4214aSPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatHtoolSetKernel_C",MatHtoolSetKernel_Htool);CHKERRQ(ierr);
96998e73e17SPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatHtoolGetPermutationSource_C",MatHtoolGetPermutationSource_Htool);CHKERRQ(ierr);
97098e73e17SPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatHtoolGetPermutationTarget_C",MatHtoolGetPermutationTarget_Htool);CHKERRQ(ierr);
97198e73e17SPierre Jolivet   ierr = PetscObjectComposeFunction((PetscObject)A,"MatHtoolUsePermutation_C",MatHtoolUsePermutation_Htool);CHKERRQ(ierr);
972c7a4214aSPierre Jolivet   PetscFunctionReturn(0);
973c7a4214aSPierre Jolivet }
974