xref: /petsc/src/mat/impls/normal/normm.c (revision a29b93af14c8cd8444aaaea91c6f829c7cf01058)
127d8b95cSPierre Jolivet #include <../src/mat/impls/shell/shell.h> /*I "petscmat.h" I*/
2c8a8475eSBarry Smith 
3c8a8475eSBarry Smith typedef struct {
47cfd0b8cSBarry Smith   Mat A;
5a48507d3SJose E. Roman   Mat D; /* local submatrix for diagonal part */
627d8b95cSPierre Jolivet   Vec w;
7c8a8475eSBarry Smith } Mat_Normal;
8c8a8475eSBarry Smith 
966976f2fSJacob Faibussowitsch static PetscErrorCode MatIncreaseOverlap_Normal(Mat A, PetscInt is_max, IS is[], PetscInt ov)
10d71ae5a4SJacob Faibussowitsch {
1127d8b95cSPierre Jolivet   Mat_Normal *a;
12fa80d070SPierre Jolivet   Mat         pattern;
13fa80d070SPierre Jolivet 
14fa80d070SPierre Jolivet   PetscFunctionBegin;
1508401ef6SPierre Jolivet   PetscCheck(ov >= 0, PetscObjectComm((PetscObject)A), PETSC_ERR_ARG_OUTOFRANGE, "Negative overlap specified");
1627d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(A, &a));
179566063dSJacob Faibussowitsch   PetscCall(MatProductCreate(a->A, a->A, NULL, &pattern));
189566063dSJacob Faibussowitsch   PetscCall(MatProductSetType(pattern, MATPRODUCT_AtB));
199566063dSJacob Faibussowitsch   PetscCall(MatProductSetFromOptions(pattern));
209566063dSJacob Faibussowitsch   PetscCall(MatProductSymbolic(pattern));
219566063dSJacob Faibussowitsch   PetscCall(MatIncreaseOverlap(pattern, is_max, is, ov));
229566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&pattern));
233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24fa80d070SPierre Jolivet }
25fa80d070SPierre Jolivet 
2666976f2fSJacob Faibussowitsch static PetscErrorCode MatCreateSubMatrices_Normal(Mat mat, PetscInt n, const IS irow[], const IS icol[], MatReuse scall, Mat *submat[])
27d71ae5a4SJacob Faibussowitsch {
2827d8b95cSPierre Jolivet   Mat_Normal *a;
2927d8b95cSPierre Jolivet   Mat         B, *suba;
30fa80d070SPierre Jolivet   IS         *row;
31fa80d070SPierre Jolivet   PetscInt    M;
32fa80d070SPierre Jolivet 
33fa80d070SPierre Jolivet   PetscFunctionBegin;
3427d8b95cSPierre Jolivet   PetscCheck(!((Mat_Shell *)mat->data)->zrows && !((Mat_Shell *)mat->data)->zcols, PetscObjectComm((PetscObject)mat), PETSC_ERR_SUP, "Cannot call MatCreateSubMatrices() if MatZeroRows() or MatZeroRowsColumns() has been called on the input Mat"); // TODO FIXME: lift this limitation by calling MatZeroRows()/MatZeroRowsColumns() after the SubMatrices creation
3527d8b95cSPierre Jolivet   PetscCheck(!((Mat_Shell *)mat->data)->axpy, PetscObjectComm((PetscObject)mat), PETSC_ERR_SUP, "Cannot call MatCreateSubMatrices() if MatAXPY() has been called on the input Mat"); // TODO FIXME: lift this limitation by calling MatAXPY() after the SubMatrices creation
3627d8b95cSPierre Jolivet   PetscCheck(!((Mat_Shell *)mat->data)->left && !((Mat_Shell *)mat->data)->right, PetscObjectComm((PetscObject)mat), PETSC_ERR_SUP, "Cannot call MatCreateSubMatrices() if MatDiagonalScale() has been called on the input Mat"); // TODO FIXME: lift this limitation by calling MatDiagonalScale() after the SubMatrices creation with a SubVector
3727d8b95cSPierre Jolivet   PetscCheck(!((Mat_Shell *)mat->data)->dshift, PetscObjectComm((PetscObject)mat), PETSC_ERR_SUP, "Cannot call MatCreateSubMatrices() if MatDiagonalSet() has been called on the input Mat"); // TODO FIXME: lift this limitation by calling MatDiagonalSet() after the SubMatrices creation with a SubVector
3827d8b95cSPierre Jolivet   PetscCheck(irow == icol, PetscObjectComm((PetscObject)mat), PETSC_ERR_SUP, "Not implemented");
3927d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(mat, &a));
4027d8b95cSPierre Jolivet   B = a->A;
4148a46eb9SPierre Jolivet   if (scall != MAT_REUSE_MATRIX) PetscCall(PetscCalloc1(n, submat));
429566063dSJacob Faibussowitsch   PetscCall(MatGetSize(B, &M, NULL));
439566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &row));
449566063dSJacob Faibussowitsch   PetscCall(ISCreateStride(PETSC_COMM_SELF, M, 0, 1, &row[0]));
459566063dSJacob Faibussowitsch   PetscCall(ISSetIdentity(row[0]));
46fa80d070SPierre Jolivet   for (M = 1; M < n; ++M) row[M] = row[0];
479566063dSJacob Faibussowitsch   PetscCall(MatCreateSubMatrices(B, n, row, icol, MAT_INITIAL_MATRIX, &suba));
48fa80d070SPierre Jolivet   for (M = 0; M < n; ++M) {
499566063dSJacob Faibussowitsch     PetscCall(MatCreateNormal(suba[M], *submat + M));
5027d8b95cSPierre Jolivet     ((Mat_Shell *)(*submat)[M]->data)->vscale = ((Mat_Shell *)mat->data)->vscale;
5127d8b95cSPierre Jolivet     ((Mat_Shell *)(*submat)[M]->data)->vshift = ((Mat_Shell *)mat->data)->vshift;
52fa80d070SPierre Jolivet   }
539566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&row[0]));
549566063dSJacob Faibussowitsch   PetscCall(PetscFree(row));
559566063dSJacob Faibussowitsch   PetscCall(MatDestroySubMatrices(n, &suba));
563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
57fa80d070SPierre Jolivet }
58fa80d070SPierre Jolivet 
5966976f2fSJacob Faibussowitsch static PetscErrorCode MatPermute_Normal(Mat A, IS rowp, IS colp, Mat *B)
60d71ae5a4SJacob Faibussowitsch {
6127d8b95cSPierre Jolivet   Mat_Normal *a;
6227d8b95cSPierre Jolivet   Mat         C, Aa;
63fa80d070SPierre Jolivet   IS          row;
64fa80d070SPierre Jolivet 
65fa80d070SPierre Jolivet   PetscFunctionBegin;
6627d8b95cSPierre Jolivet   PetscCheck(!((Mat_Shell *)A->data)->zrows && !((Mat_Shell *)A->data)->zcols, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Cannot call MatPermute() if MatZeroRows() or MatZeroRowsColumns() has been called on the input Mat"); // TODO FIXME: lift this limitation by calling MatZeroRows()/MatZeroRowsColumns() after the permutation with a permuted zrows and zcols
6727d8b95cSPierre Jolivet   PetscCheck(!((Mat_Shell *)A->data)->axpy, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Cannot call MatPermute() if MatAXPY() has been called on the input Mat"); // TODO FIXME: lift this limitation by calling MatAXPY() after the permutation with a permuted axpy
6827d8b95cSPierre Jolivet   PetscCheck(!((Mat_Shell *)A->data)->left && !((Mat_Shell *)A->data)->right, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Cannot call MatPermute() if MatDiagonalScale() has been called on the input Mat"); // TODO FIXME: lift this limitation by calling MatDiagonalScale() after the permutation with a permuted left and right
6927d8b95cSPierre Jolivet   PetscCheck(!((Mat_Shell *)A->data)->dshift, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Cannot call MatPermute() if MatDiagonalSet() has been called on the input Mat"); // TODO FIXME: lift this limitation by calling MatDiagonalSet() after the permutation with a permuted dshift
7008401ef6SPierre Jolivet   PetscCheck(rowp == colp, PetscObjectComm((PetscObject)A), PETSC_ERR_ARG_INCOMP, "Row permutation and column permutation must be the same");
7127d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(A, &a));
7227d8b95cSPierre Jolivet   Aa = a->A;
739566063dSJacob Faibussowitsch   PetscCall(ISCreateStride(PetscObjectComm((PetscObject)Aa), Aa->rmap->n, Aa->rmap->rstart, 1, &row));
749566063dSJacob Faibussowitsch   PetscCall(ISSetIdentity(row));
759566063dSJacob Faibussowitsch   PetscCall(MatPermute(Aa, row, colp, &C));
769566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&row));
779566063dSJacob Faibussowitsch   PetscCall(MatCreateNormal(C, B));
789566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&C));
7927d8b95cSPierre Jolivet   ((Mat_Shell *)(*B)->data)->vscale = ((Mat_Shell *)A->data)->vscale;
8027d8b95cSPierre Jolivet   ((Mat_Shell *)(*B)->data)->vshift = ((Mat_Shell *)A->data)->vshift;
813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
82fa80d070SPierre Jolivet }
83fa80d070SPierre Jolivet 
8466976f2fSJacob Faibussowitsch static PetscErrorCode MatDuplicate_Normal(Mat A, MatDuplicateOption op, Mat *B)
85d71ae5a4SJacob Faibussowitsch {
8627d8b95cSPierre Jolivet   Mat_Normal *a;
87fa80d070SPierre Jolivet   Mat         C;
88fa80d070SPierre Jolivet 
89fa80d070SPierre Jolivet   PetscFunctionBegin;
9027d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(A, &a));
919566063dSJacob Faibussowitsch   PetscCall(MatDuplicate(a->A, op, &C));
929566063dSJacob Faibussowitsch   PetscCall(MatCreateNormal(C, B));
939566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&C));
9427d8b95cSPierre Jolivet   if (op == MAT_COPY_VALUES) PetscCall(MatCopy(A, *B, SAME_NONZERO_PATTERN));
953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
96fa80d070SPierre Jolivet }
97fa80d070SPierre Jolivet 
9866976f2fSJacob Faibussowitsch static PetscErrorCode MatCopy_Normal(Mat A, Mat B, MatStructure str)
99d71ae5a4SJacob Faibussowitsch {
10027d8b95cSPierre Jolivet   Mat_Normal *a, *b;
101fa80d070SPierre Jolivet 
102fa80d070SPierre Jolivet   PetscFunctionBegin;
10327d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(A, &a));
10427d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(B, &b));
1059566063dSJacob Faibussowitsch   PetscCall(MatCopy(a->A, b->A, str));
1063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
107fa80d070SPierre Jolivet }
108fa80d070SPierre Jolivet 
10966976f2fSJacob Faibussowitsch static PetscErrorCode MatMult_Normal(Mat N, Vec x, Vec y)
110d71ae5a4SJacob Faibussowitsch {
11127d8b95cSPierre Jolivet   Mat_Normal *Na;
112c8a8475eSBarry Smith 
113c8a8475eSBarry Smith   PetscFunctionBegin;
11427d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(N, &Na));
11527d8b95cSPierre Jolivet   PetscCall(MatMult(Na->A, x, Na->w));
1169566063dSJacob Faibussowitsch   PetscCall(MatMultTranspose(Na->A, Na->w, y));
1173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
118db090513SMatthew Knepley }
119db090513SMatthew Knepley 
12066976f2fSJacob Faibussowitsch static PetscErrorCode MatDestroy_Normal(Mat N)
121d71ae5a4SJacob Faibussowitsch {
12227d8b95cSPierre Jolivet   Mat_Normal *Na;
123c8a8475eSBarry Smith 
124c8a8475eSBarry Smith   PetscFunctionBegin;
12527d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(N, &Na));
1269566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&Na->A));
127a48507d3SJose E. Roman   PetscCall(MatDestroy(&Na->D));
1289566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&Na->w));
12927d8b95cSPierre Jolivet   PetscCall(PetscFree(Na));
1309566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)N, "MatNormalGetMat_C", NULL));
1319566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)N, "MatConvert_normal_seqaij_C", NULL));
1329566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)N, "MatConvert_normal_mpiaij_C", NULL));
1332f0a5c5aSJose E. Roman #if defined(PETSC_HAVE_HYPRE)
1342f0a5c5aSJose E. Roman   PetscCall(PetscObjectComposeFunction((PetscObject)N, "MatConvert_normal_hypre_C", NULL));
1352f0a5c5aSJose E. Roman #endif
1369566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)N, "MatProductSetFromOptions_normal_seqdense_C", NULL));
1379566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)N, "MatProductSetFromOptions_normal_mpidense_C", NULL));
13827d8b95cSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)N, "MatShellSetContext_C", NULL));
1393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
140c8a8475eSBarry Smith }
141c8a8475eSBarry Smith 
14217a6fd94SBarry Smith /*
14317a6fd94SBarry Smith       Slow, nonscalable version
14417a6fd94SBarry Smith */
14566976f2fSJacob Faibussowitsch static PetscErrorCode MatGetDiagonal_Normal(Mat N, Vec v)
146d71ae5a4SJacob Faibussowitsch {
14727d8b95cSPierre Jolivet   Mat_Normal        *Na;
14827d8b95cSPierre Jolivet   Mat                A;
149b24ad042SBarry Smith   PetscInt           i, j, rstart, rend, nnz;
150b24ad042SBarry Smith   const PetscInt    *cols;
15117a6fd94SBarry Smith   PetscScalar       *diag, *work, *values;
152b3cc6726SBarry Smith   const PetscScalar *mvalues;
15317a6fd94SBarry Smith 
15417a6fd94SBarry Smith   PetscFunctionBegin;
15527d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(N, &Na));
15627d8b95cSPierre Jolivet   A = Na->A;
1579566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(A->cmap->N, &diag, A->cmap->N, &work));
1589566063dSJacob Faibussowitsch   PetscCall(PetscArrayzero(work, A->cmap->N));
1599566063dSJacob Faibussowitsch   PetscCall(MatGetOwnershipRange(A, &rstart, &rend));
16017a6fd94SBarry Smith   for (i = rstart; i < rend; i++) {
1619566063dSJacob Faibussowitsch     PetscCall(MatGetRow(A, i, &nnz, &cols, &mvalues));
162ad540459SPierre Jolivet     for (j = 0; j < nnz; j++) work[cols[j]] += mvalues[j] * mvalues[j];
1639566063dSJacob Faibussowitsch     PetscCall(MatRestoreRow(A, i, &nnz, &cols, &mvalues));
16417a6fd94SBarry Smith   }
1651c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(work, diag, A->cmap->N, MPIU_SCALAR, MPIU_SUM, PetscObjectComm((PetscObject)N)));
166d0f46423SBarry Smith   rstart = N->cmap->rstart;
167d0f46423SBarry Smith   rend   = N->cmap->rend;
1689566063dSJacob Faibussowitsch   PetscCall(VecGetArray(v, &values));
1699566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(values, diag + rstart, rend - rstart));
1709566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(v, &values));
1719566063dSJacob Faibussowitsch   PetscCall(PetscFree2(diag, work));
1723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
17317a6fd94SBarry Smith }
174c8a8475eSBarry Smith 
17566976f2fSJacob Faibussowitsch static PetscErrorCode MatGetDiagonalBlock_Normal(Mat N, Mat *D)
176d71ae5a4SJacob Faibussowitsch {
17727d8b95cSPierre Jolivet   Mat_Normal *Na;
17827d8b95cSPierre Jolivet   Mat         M, A;
179a48507d3SJose E. Roman 
180a48507d3SJose E. Roman   PetscFunctionBegin;
18127d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(N, &Na));
18227d8b95cSPierre Jolivet   A = Na->A;
183a48507d3SJose E. Roman   PetscCall(MatGetDiagonalBlock(A, &M));
184a48507d3SJose E. Roman   PetscCall(MatCreateNormal(M, &Na->D));
185a48507d3SJose E. Roman   *D = Na->D;
1863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
187a48507d3SJose E. Roman }
188a48507d3SJose E. Roman 
18966976f2fSJacob Faibussowitsch static PetscErrorCode MatNormalGetMat_Normal(Mat A, Mat *M)
190d71ae5a4SJacob Faibussowitsch {
19127d8b95cSPierre Jolivet   Mat_Normal *Aa;
192fa80d070SPierre Jolivet 
193fa80d070SPierre Jolivet   PetscFunctionBegin;
19427d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(A, &Aa));
195fa80d070SPierre Jolivet   *M = Aa->A;
1963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
197fa80d070SPierre Jolivet }
198fa80d070SPierre Jolivet 
199fa80d070SPierre Jolivet /*@
20011a5261eSBarry Smith   MatNormalGetMat - Gets the `Mat` object stored inside a `MATNORMAL`
201fa80d070SPierre Jolivet 
2022ef1f0ffSBarry Smith   Logically Collective
203fa80d070SPierre Jolivet 
204fa80d070SPierre Jolivet   Input Parameter:
20511a5261eSBarry Smith . A - the `MATNORMAL` matrix
206fa80d070SPierre Jolivet 
207fa80d070SPierre Jolivet   Output Parameter:
2082ef1f0ffSBarry Smith . M - the matrix object stored inside `A`
209fa80d070SPierre Jolivet 
210fa80d070SPierre Jolivet   Level: intermediate
211fa80d070SPierre Jolivet 
2121cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MATNORMAL`, `MATNORMALHERMITIAN`, `MatCreateNormal()`
213fa80d070SPierre Jolivet @*/
214d71ae5a4SJacob Faibussowitsch PetscErrorCode MatNormalGetMat(Mat A, Mat *M)
215d71ae5a4SJacob Faibussowitsch {
216fa80d070SPierre Jolivet   PetscFunctionBegin;
217fa80d070SPierre Jolivet   PetscValidHeaderSpecific(A, MAT_CLASSID, 1);
218fa80d070SPierre Jolivet   PetscValidType(A, 1);
2194f572ea9SToby Isaac   PetscAssertPointer(M, 2);
220cac4c232SBarry Smith   PetscUseMethod(A, "MatNormalGetMat_C", (Mat, Mat *), (A, M));
2213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
222fa80d070SPierre Jolivet }
223fa80d070SPierre Jolivet 
22466976f2fSJacob Faibussowitsch static PetscErrorCode MatConvert_Normal_AIJ(Mat A, MatType newtype, MatReuse reuse, Mat *newmat)
225d71ae5a4SJacob Faibussowitsch {
22627d8b95cSPierre Jolivet   Mat_Normal *Aa;
227fa80d070SPierre Jolivet   Mat         B;
228fa80d070SPierre Jolivet   PetscInt    m, n, M, N;
229fa80d070SPierre Jolivet 
230fa80d070SPierre Jolivet   PetscFunctionBegin;
23127d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(A, &Aa));
2329566063dSJacob Faibussowitsch   PetscCall(MatGetSize(A, &M, &N));
2339566063dSJacob Faibussowitsch   PetscCall(MatGetLocalSize(A, &m, &n));
234fa80d070SPierre Jolivet   if (reuse == MAT_REUSE_MATRIX) {
235fa80d070SPierre Jolivet     B = *newmat;
2369566063dSJacob Faibussowitsch     PetscCall(MatProductReplaceMats(Aa->A, Aa->A, NULL, B));
237fa80d070SPierre Jolivet   } else {
2389566063dSJacob Faibussowitsch     PetscCall(MatProductCreate(Aa->A, Aa->A, NULL, &B));
2399566063dSJacob Faibussowitsch     PetscCall(MatProductSetType(B, MATPRODUCT_AtB));
2409566063dSJacob Faibussowitsch     PetscCall(MatProductSetFromOptions(B));
2419566063dSJacob Faibussowitsch     PetscCall(MatProductSymbolic(B));
2429566063dSJacob Faibussowitsch     PetscCall(MatSetOption(B, MAT_SYMMETRIC, PETSC_TRUE));
243fa80d070SPierre Jolivet   }
2449566063dSJacob Faibussowitsch   PetscCall(MatProductNumeric(B));
245fa80d070SPierre Jolivet   if (reuse == MAT_INPLACE_MATRIX) {
2469566063dSJacob Faibussowitsch     PetscCall(MatHeaderReplace(A, &B));
247fa80d070SPierre Jolivet   } else if (reuse == MAT_INITIAL_MATRIX) *newmat = B;
2489566063dSJacob Faibussowitsch   PetscCall(MatConvert(*newmat, MATAIJ, MAT_INPLACE_MATRIX, newmat));
2493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
250fa80d070SPierre Jolivet }
251fa80d070SPierre Jolivet 
2522f0a5c5aSJose E. Roman #if defined(PETSC_HAVE_HYPRE)
25366976f2fSJacob Faibussowitsch static PetscErrorCode MatConvert_Normal_HYPRE(Mat A, MatType type, MatReuse reuse, Mat *B)
2542f0a5c5aSJose E. Roman {
2552f0a5c5aSJose E. Roman   PetscFunctionBegin;
2562f0a5c5aSJose E. Roman   if (reuse == MAT_INITIAL_MATRIX) {
2572f0a5c5aSJose E. Roman     PetscCall(MatConvert(A, MATAIJ, reuse, B));
2582f0a5c5aSJose E. Roman     PetscCall(MatConvert(*B, type, MAT_INPLACE_MATRIX, B));
2592f0a5c5aSJose E. Roman   } else PetscCall(MatConvert_Basic(A, type, reuse, B)); /* fall back to basic convert */
2603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2612f0a5c5aSJose E. Roman }
2622f0a5c5aSJose E. Roman #endif
2632f0a5c5aSJose E. Roman 
264fa80d070SPierre Jolivet typedef struct {
265fa80d070SPierre Jolivet   Mat work[2];
266fa80d070SPierre Jolivet } Normal_Dense;
267fa80d070SPierre Jolivet 
26866976f2fSJacob Faibussowitsch static PetscErrorCode MatProductNumeric_Normal_Dense(Mat C)
269d71ae5a4SJacob Faibussowitsch {
270fa80d070SPierre Jolivet   Mat           A, B;
271fa80d070SPierre Jolivet   Normal_Dense *contents;
272fa80d070SPierre Jolivet   Mat_Normal   *a;
273fa80d070SPierre Jolivet   PetscScalar  *array;
274fa80d070SPierre Jolivet 
275fa80d070SPierre Jolivet   PetscFunctionBegin;
2768f83a4d9SJacob Faibussowitsch   MatCheckProduct(C, 1);
277fa80d070SPierre Jolivet   A = C->product->A;
278fa80d070SPierre Jolivet   B = C->product->B;
27927d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(A, &a));
280fa80d070SPierre Jolivet   contents = (Normal_Dense *)C->product->data;
28128b400f6SJacob Faibussowitsch   PetscCheck(contents, PetscObjectComm((PetscObject)C), PETSC_ERR_PLIB, "Product data empty");
28227d8b95cSPierre Jolivet   if (((Mat_Shell *)A->data)->right) {
2839566063dSJacob Faibussowitsch     PetscCall(MatCopy(B, C, SAME_NONZERO_PATTERN));
28427d8b95cSPierre Jolivet     PetscCall(MatDiagonalScale(C, ((Mat_Shell *)A->data)->right, NULL));
285fa80d070SPierre Jolivet   }
2869566063dSJacob Faibussowitsch   PetscCall(MatProductNumeric(contents->work[0]));
2879566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArrayWrite(C, &array));
2889566063dSJacob Faibussowitsch   PetscCall(MatDensePlaceArray(contents->work[1], array));
2899566063dSJacob Faibussowitsch   PetscCall(MatProductNumeric(contents->work[1]));
2909566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArrayWrite(C, &array));
2919566063dSJacob Faibussowitsch   PetscCall(MatDenseResetArray(contents->work[1]));
2929566063dSJacob Faibussowitsch   PetscCall(MatSetOption(C, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
2939566063dSJacob Faibussowitsch   PetscCall(MatAssemblyBegin(C, MAT_FINAL_ASSEMBLY));
2949566063dSJacob Faibussowitsch   PetscCall(MatAssemblyEnd(C, MAT_FINAL_ASSEMBLY));
29527d8b95cSPierre Jolivet   PetscCall(MatScale(C, ((Mat_Shell *)A->data)->vscale));
2963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
297fa80d070SPierre Jolivet }
298fa80d070SPierre Jolivet 
29966976f2fSJacob Faibussowitsch static PetscErrorCode MatNormal_DenseDestroy(void *ctx)
300d71ae5a4SJacob Faibussowitsch {
301fa80d070SPierre Jolivet   Normal_Dense *contents = (Normal_Dense *)ctx;
302fa80d070SPierre Jolivet 
303fa80d070SPierre Jolivet   PetscFunctionBegin;
3049566063dSJacob Faibussowitsch   PetscCall(MatDestroy(contents->work));
3059566063dSJacob Faibussowitsch   PetscCall(MatDestroy(contents->work + 1));
3069566063dSJacob Faibussowitsch   PetscCall(PetscFree(contents));
3073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
308fa80d070SPierre Jolivet }
309fa80d070SPierre Jolivet 
31066976f2fSJacob Faibussowitsch static PetscErrorCode MatProductSymbolic_Normal_Dense(Mat C)
311d71ae5a4SJacob Faibussowitsch {
312fa80d070SPierre Jolivet   Mat           A, B;
313fa80d070SPierre Jolivet   Normal_Dense *contents = NULL;
314fa80d070SPierre Jolivet   Mat_Normal   *a;
315fa80d070SPierre Jolivet   PetscScalar  *array;
316fa80d070SPierre Jolivet   PetscInt      n, N, m, M;
317fa80d070SPierre Jolivet 
318fa80d070SPierre Jolivet   PetscFunctionBegin;
3198f83a4d9SJacob Faibussowitsch   MatCheckProduct(C, 1);
32028b400f6SJacob Faibussowitsch   PetscCheck(!C->product->data, PetscObjectComm((PetscObject)C), PETSC_ERR_PLIB, "Product data not empty");
321fa80d070SPierre Jolivet   A = C->product->A;
322fa80d070SPierre Jolivet   B = C->product->B;
32327d8b95cSPierre Jolivet   PetscCall(MatShellGetContext(A, &a));
32427d8b95cSPierre Jolivet   PetscCheck(!((Mat_Shell *)A->data)->zrows && !((Mat_Shell *)A->data)->zcols, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Cannot call MatProductSymbolic() if MatZeroRows() or MatZeroRowsColumns() has been called on the input Mat"); // TODO FIXME
32527d8b95cSPierre Jolivet   PetscCheck(!((Mat_Shell *)A->data)->axpy, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Cannot call MatProductSymbolic() if MatAXPY() has been called on the input Mat");          // TODO FIXME
32627d8b95cSPierre Jolivet   PetscCheck(!((Mat_Shell *)A->data)->left, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Cannot call MatProductSymbolic() if MatDiagonalScale() has been called on the input Mat"); // TODO FIXME
32727d8b95cSPierre Jolivet   PetscCheck(!((Mat_Shell *)A->data)->dshift, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Cannot call MatProductSymbolic() if MatDiagonalSet() has been called on the input Mat"); // TODO FIXME
3289566063dSJacob Faibussowitsch   PetscCall(MatGetLocalSize(C, &m, &n));
3299566063dSJacob Faibussowitsch   PetscCall(MatGetSize(C, &M, &N));
330fa80d070SPierre Jolivet   if (m == PETSC_DECIDE || n == PETSC_DECIDE || M == PETSC_DECIDE || N == PETSC_DECIDE) {
3319566063dSJacob Faibussowitsch     PetscCall(MatGetLocalSize(B, NULL, &n));
3329566063dSJacob Faibussowitsch     PetscCall(MatGetSize(B, NULL, &N));
3339566063dSJacob Faibussowitsch     PetscCall(MatGetLocalSize(A, &m, NULL));
3349566063dSJacob Faibussowitsch     PetscCall(MatGetSize(A, &M, NULL));
3359566063dSJacob Faibussowitsch     PetscCall(MatSetSizes(C, m, n, M, N));
336fa80d070SPierre Jolivet   }
3379566063dSJacob Faibussowitsch   PetscCall(MatSetType(C, ((PetscObject)B)->type_name));
3389566063dSJacob Faibussowitsch   PetscCall(MatSetUp(C));
3399566063dSJacob Faibussowitsch   PetscCall(PetscNew(&contents));
340fa80d070SPierre Jolivet   C->product->data    = contents;
341fa80d070SPierre Jolivet   C->product->destroy = MatNormal_DenseDestroy;
34227d8b95cSPierre Jolivet   if (((Mat_Shell *)A->data)->right) {
3439566063dSJacob Faibussowitsch     PetscCall(MatProductCreate(a->A, C, NULL, contents->work));
344fa80d070SPierre Jolivet   } else {
3459566063dSJacob Faibussowitsch     PetscCall(MatProductCreate(a->A, B, NULL, contents->work));
346fa80d070SPierre Jolivet   }
3479566063dSJacob Faibussowitsch   PetscCall(MatProductSetType(contents->work[0], MATPRODUCT_AB));
3489566063dSJacob Faibussowitsch   PetscCall(MatProductSetFromOptions(contents->work[0]));
3499566063dSJacob Faibussowitsch   PetscCall(MatProductSymbolic(contents->work[0]));
3509566063dSJacob Faibussowitsch   PetscCall(MatProductCreate(a->A, contents->work[0], NULL, contents->work + 1));
3519566063dSJacob Faibussowitsch   PetscCall(MatProductSetType(contents->work[1], MATPRODUCT_AtB));
3529566063dSJacob Faibussowitsch   PetscCall(MatProductSetFromOptions(contents->work[1]));
3539566063dSJacob Faibussowitsch   PetscCall(MatProductSymbolic(contents->work[1]));
3549566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArrayWrite(C, &array));
3559566063dSJacob Faibussowitsch   PetscCall(MatSeqDenseSetPreallocation(contents->work[1], array));
3569566063dSJacob Faibussowitsch   PetscCall(MatMPIDenseSetPreallocation(contents->work[1], array));
3579566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArrayWrite(C, &array));
358fa80d070SPierre Jolivet   C->ops->productnumeric = MatProductNumeric_Normal_Dense;
3593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
360fa80d070SPierre Jolivet }
361fa80d070SPierre Jolivet 
36266976f2fSJacob Faibussowitsch static PetscErrorCode MatProductSetFromOptions_Normal_Dense_AB(Mat C)
363d71ae5a4SJacob Faibussowitsch {
364fa80d070SPierre Jolivet   PetscFunctionBegin;
365fa80d070SPierre Jolivet   C->ops->productsymbolic = MatProductSymbolic_Normal_Dense;
3663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
367fa80d070SPierre Jolivet }
368fa80d070SPierre Jolivet 
36966976f2fSJacob Faibussowitsch static PetscErrorCode MatProductSetFromOptions_Normal_Dense(Mat C)
370d71ae5a4SJacob Faibussowitsch {
371fa80d070SPierre Jolivet   Mat_Product *product = C->product;
372fa80d070SPierre Jolivet 
373fa80d070SPierre Jolivet   PetscFunctionBegin;
37448a46eb9SPierre Jolivet   if (product->type == MATPRODUCT_AB) PetscCall(MatProductSetFromOptions_Normal_Dense_AB(C));
3753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
376fa80d070SPierre Jolivet }
377fa80d070SPierre Jolivet 
3782ef1f0ffSBarry Smith /*MC
3792ef1f0ffSBarry Smith   MATNORMAL - a matrix that behaves like A'*A for `MatMult()` while only containing A
3802ef1f0ffSBarry Smith 
3812ef1f0ffSBarry Smith   Level: intermediate
3822ef1f0ffSBarry Smith 
38327d8b95cSPierre Jolivet   Developer Notes:
38427d8b95cSPierre Jolivet   This is implemented on top of `MATSHELL` to get support for scaling and shifting without requiring duplicate code
38527d8b95cSPierre Jolivet 
38627d8b95cSPierre Jolivet   Users can not call `MatShellSetOperation()` operations on this class, there is some error checking for that incorrect usage
38727d8b95cSPierre Jolivet 
3881cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatCreateNormal()`, `MatMult()`, `MatNormalGetMat()`, `MATNORMALHERMITIAN`, `MatCreateNormalHermitian()`
3892ef1f0ffSBarry Smith M*/
3902ef1f0ffSBarry Smith 
391c8a8475eSBarry Smith /*@
39211a5261eSBarry Smith   MatCreateNormal - Creates a new `MATNORMAL` matrix object that behaves like A'*A.
393c8a8475eSBarry Smith 
394c3339decSBarry Smith   Collective
395c8a8475eSBarry Smith 
396c8a8475eSBarry Smith   Input Parameter:
397c8a8475eSBarry Smith . A - the (possibly rectangular) matrix
398c8a8475eSBarry Smith 
399c8a8475eSBarry Smith   Output Parameter:
400c8a8475eSBarry Smith . N - the matrix that represents A'*A
401c8a8475eSBarry Smith 
402c30e7cdbSSatish Balay   Level: intermediate
403c30e7cdbSSatish Balay 
40495452b02SPatrick Sanan   Notes:
40595452b02SPatrick Sanan   The product A'*A is NOT actually formed! Rather the new matrix
40611a5261eSBarry Smith   object performs the matrix-vector product, `MatMult()`, by first multiplying by
407c8a8475eSBarry Smith   A and then A'
40811a5261eSBarry Smith 
4091cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MATNORMAL`, `MatMult()`, `MatNormalGetMat()`, `MATNORMALHERMITIAN`, `MatCreateNormalHermitian()`
410c8a8475eSBarry Smith @*/
411d71ae5a4SJacob Faibussowitsch PetscErrorCode MatCreateNormal(Mat A, Mat *N)
412d71ae5a4SJacob Faibussowitsch {
413c8a8475eSBarry Smith   Mat_Normal *Na;
4149ca0e1b6SStefano Zampini   VecType     vtype;
415c8a8475eSBarry Smith 
416c8a8475eSBarry Smith   PetscFunctionBegin;
4179566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), N));
4189566063dSJacob Faibussowitsch   PetscCall(PetscLayoutReference(A->cmap, &(*N)->rmap));
4199566063dSJacob Faibussowitsch   PetscCall(PetscLayoutReference(A->cmap, &(*N)->cmap));
42027d8b95cSPierre Jolivet   PetscCall(MatSetType(*N, MATSHELL));
4214dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&Na));
42227d8b95cSPierre Jolivet   PetscCall(MatShellSetContext(*N, Na));
4239566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)A));
424c3122656SLisandro Dalcin   Na->A = A;
4259566063dSJacob Faibussowitsch   PetscCall(MatCreateVecs(A, NULL, &Na->w));
4262205254eSKarl Rupp 
42727d8b95cSPierre Jolivet   PetscCall(MatSetBlockSizes(*N, PetscAbs(A->cmap->bs), PetscAbs(A->rmap->bs)));
42827d8b95cSPierre Jolivet   PetscCall(MatShellSetOperation(*N, MATOP_DESTROY, (void (*)(void))MatDestroy_Normal));
42927d8b95cSPierre Jolivet   PetscCall(MatShellSetOperation(*N, MATOP_MULT, (void (*)(void))MatMult_Normal));
43027d8b95cSPierre Jolivet   PetscCall(MatShellSetOperation(*N, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMult_Normal));
43127d8b95cSPierre Jolivet   PetscCall(MatShellSetOperation(*N, MATOP_DUPLICATE, (void (*)(void))MatDuplicate_Normal));
43227d8b95cSPierre Jolivet   PetscCall(MatShellSetOperation(*N, MATOP_GET_DIAGONAL, (void (*)(void))MatGetDiagonal_Normal));
433*a29b93afSAudic XU   PetscCall(MatShellSetOperation(*N, MATOP_GET_DIAGONAL_BLOCK, (void (*)(void))MatGetDiagonalBlock_Normal));
43427d8b95cSPierre Jolivet   PetscCall(MatShellSetOperation(*N, MATOP_COPY, (void (*)(void))MatCopy_Normal));
435fa80d070SPierre Jolivet   (*N)->ops->increaseoverlap   = MatIncreaseOverlap_Normal;
436fa80d070SPierre Jolivet   (*N)->ops->createsubmatrices = MatCreateSubMatrices_Normal;
437fa80d070SPierre Jolivet   (*N)->ops->permute           = MatPermute_Normal;
4389ca0e1b6SStefano Zampini 
43927d8b95cSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatNormalGetMat_C", MatNormalGetMat_Normal));
44027d8b95cSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatConvert_normal_seqaij_C", MatConvert_Normal_AIJ));
44127d8b95cSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatConvert_normal_mpiaij_C", MatConvert_Normal_AIJ));
4422f0a5c5aSJose E. Roman #if defined(PETSC_HAVE_HYPRE)
44327d8b95cSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatConvert_normal_hypre_C", MatConvert_Normal_HYPRE));
4442f0a5c5aSJose E. Roman #endif
44527d8b95cSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatProductSetFromOptions_normal_seqdense_C", MatProductSetFromOptions_Normal_Dense));
44627d8b95cSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatProductSetFromOptions_normal_mpidense_C", MatProductSetFromOptions_Normal_Dense));
44727d8b95cSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatShellSetContext_C", MatShellSetContext_Immutable));
44827d8b95cSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatShellSetContextDestroy_C", MatShellSetContextDestroy_Immutable));
44927d8b95cSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)*N, "MatShellSetManageScalingShifts_C", MatShellSetManageScalingShifts_Immutable));
4509566063dSJacob Faibussowitsch   PetscCall(MatSetOption(*N, MAT_SYMMETRIC, PETSC_TRUE));
4519566063dSJacob Faibussowitsch   PetscCall(MatGetVecType(A, &vtype));
4529566063dSJacob Faibussowitsch   PetscCall(MatSetVecType(*N, vtype));
4539ca0e1b6SStefano Zampini #if defined(PETSC_HAVE_DEVICE)
4549566063dSJacob Faibussowitsch   PetscCall(MatBindToCPU(*N, A->boundtocpu));
4559ca0e1b6SStefano Zampini #endif
45627d8b95cSPierre Jolivet   PetscCall(MatSetUp(*N));
45727d8b95cSPierre Jolivet   PetscCall(PetscObjectChangeTypeName((PetscObject)*N, MATNORMAL));
4583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
459c8a8475eSBarry Smith }
460