xref: /petsc/src/ksp/pc/impls/hpddm/pchpddm.cxx (revision feebddf47d36da24135e99b5528ab26f55c0a365)
101e3c840SPierre Jolivet #include <petscsf.h>
213044ca3SPierre Jolivet #include <petsc/private/vecimpl.h>
3f1580f4eSBarry Smith #include <petsc/private/matimpl.h>
4f1580f4eSBarry Smith #include <petsc/private/petschpddm.h> /*I "petscpc.h" I*/
5e905f78bSJacob Faibussowitsch #include <petsc/private/pcimpl.h>
6e905f78bSJacob Faibussowitsch #include <petsc/private/dmimpl.h> /* this must be included after petschpddm.h so that DM_MAX_WORK_VECTORS is not defined  */
7f1580f4eSBarry Smith                                   /* otherwise, it is assumed that one is compiling libhpddm_petsc => circular dependency */
8f1580f4eSBarry Smith 
9db4a47b3SPierre Jolivet static PetscErrorCode (*loadedSym)(HPDDM::Schwarz<PetscScalar> *const, IS, Mat, Mat, Mat, std::vector<Vec>, PC_HPDDM_Level **const) = nullptr;
10f1580f4eSBarry Smith 
11f1580f4eSBarry Smith static PetscBool PCHPDDMPackageInitialized = PETSC_FALSE;
12f1580f4eSBarry Smith 
13f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_Strc;
14f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_PtAP;
15f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_PtBP;
16f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_Next;
17f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_SetUp[PETSC_PCHPDDM_MAXLEVELS];
18f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_Solve[PETSC_PCHPDDM_MAXLEVELS];
19f1580f4eSBarry Smith 
20aa1539e9SPierre Jolivet const char *const PCHPDDMCoarseCorrectionTypes[] = {"DEFLATED", "ADDITIVE", "BALANCED", "NONE", "PCHPDDMCoarseCorrectionType", "PC_HPDDM_COARSE_CORRECTION_", nullptr};
2113044ca3SPierre Jolivet const char *const PCHPDDMSchurPreTypes[]         = {"LEAST_SQUARES", "GENEO", "PCHPDDMSchurPreType", "PC_HPDDM_SCHUR_PRE", nullptr};
22f1580f4eSBarry Smith 
23d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_HPDDM(PC pc)
24d71ae5a4SJacob Faibussowitsch {
25f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
26f1580f4eSBarry Smith 
27f1580f4eSBarry Smith   PetscFunctionBegin;
28f1580f4eSBarry Smith   if (data->levels) {
29811e8887SPierre Jolivet     for (PetscInt i = 0; i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]; ++i) {
30f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[i]->ksp));
31f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[i]->pc));
32f1580f4eSBarry Smith       PetscCall(PetscFree(data->levels[i]));
33f1580f4eSBarry Smith     }
34f1580f4eSBarry Smith     PetscCall(PetscFree(data->levels));
35f1580f4eSBarry Smith   }
36f1580f4eSBarry Smith   PetscCall(ISDestroy(&data->is));
37f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->aux));
38f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->B));
39f1580f4eSBarry Smith   PetscCall(VecDestroy(&data->normal));
40f1580f4eSBarry Smith   data->correction = PC_HPDDM_COARSE_CORRECTION_DEFLATED;
41c8ea6600SPierre Jolivet   data->Neumann    = PETSC_BOOL3_UNKNOWN;
42f1580f4eSBarry Smith   data->deflation  = PETSC_FALSE;
43db4a47b3SPierre Jolivet   data->setup      = nullptr;
44db4a47b3SPierre Jolivet   data->setup_ctx  = nullptr;
453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
46f1580f4eSBarry Smith }
47f1580f4eSBarry Smith 
48d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDM(PC pc)
49d71ae5a4SJacob Faibussowitsch {
50f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
51f1580f4eSBarry Smith 
52f1580f4eSBarry Smith   PetscFunctionBegin;
53f1580f4eSBarry Smith   PetscCall(PCReset_HPDDM(pc));
54f1580f4eSBarry Smith   PetscCall(PetscFree(data));
55db4a47b3SPierre Jolivet   PetscCall(PetscObjectChangeTypeName((PetscObject)pc, nullptr));
56db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", nullptr));
57db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", nullptr));
58db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", nullptr));
59db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", nullptr));
60db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", nullptr));
61db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", nullptr));
62db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", nullptr));
63db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", nullptr));
6413044ca3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc, "_PCHPDDM_Schur", nullptr));
653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
66f1580f4eSBarry Smith }
67f1580f4eSBarry Smith 
68d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMSetAuxiliaryMat_Private(PC pc, IS is, Mat A, PetscBool deflation)
69d71ae5a4SJacob Faibussowitsch {
70f1580f4eSBarry Smith   PC_HPDDM                   *data = (PC_HPDDM *)pc->data;
71cdbd50ebSPierre Jolivet   PCHPDDMCoarseCorrectionType type = data->correction;
72f1580f4eSBarry Smith 
73f1580f4eSBarry Smith   PetscFunctionBegin;
74f1580f4eSBarry Smith   if (is) {
75f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)is));
76f1580f4eSBarry Smith     if (data->is) { /* new overlap definition resets the PC */
77f1580f4eSBarry Smith       PetscCall(PCReset_HPDDM(pc));
78f1580f4eSBarry Smith       pc->setfromoptionscalled = 0;
79b853e353SPierre Jolivet       pc->setupcalled          = 0;
80cdbd50ebSPierre Jolivet       data->correction         = type;
81f1580f4eSBarry Smith     }
82f1580f4eSBarry Smith     PetscCall(ISDestroy(&data->is));
83f1580f4eSBarry Smith     data->is = is;
84f1580f4eSBarry Smith   }
85f1580f4eSBarry Smith   if (A) {
86f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)A));
87f1580f4eSBarry Smith     PetscCall(MatDestroy(&data->aux));
88f1580f4eSBarry Smith     data->aux = A;
89f1580f4eSBarry Smith   }
90f1580f4eSBarry Smith   data->deflation = deflation;
913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
92f1580f4eSBarry Smith }
93f1580f4eSBarry Smith 
943df4cd7bSPierre Jolivet static inline PetscErrorCode PCHPDDMSetAuxiliaryMatNormal_Private(PC pc, Mat A, Mat N, Mat *B, const char *pcpre, Vec *diagonal = nullptr)
95d71ae5a4SJacob Faibussowitsch {
96f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
97f1580f4eSBarry Smith   Mat      *splitting, *sub, aux;
983df4cd7bSPierre Jolivet   Vec       d;
99*feebddf4SPierre Jolivet   IS        cols[2], rows;
100f1580f4eSBarry Smith   PetscReal norm;
101f1580f4eSBarry Smith   PetscBool flg;
102f1580f4eSBarry Smith   char      type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
103f1580f4eSBarry Smith 
104f1580f4eSBarry Smith   PetscFunctionBegin;
105f1580f4eSBarry Smith   PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, B));
106*feebddf4SPierre Jolivet   PetscCall(MatEliminateZeros(*B, PETSC_TRUE));
107f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, cols));
108*feebddf4SPierre Jolivet   PetscCall(MatIncreaseOverlap(*B, 1, cols, 1));
109*feebddf4SPierre Jolivet   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, &rows));
110*feebddf4SPierre Jolivet   PetscCall(ISEmbed(*cols, rows, PETSC_TRUE, cols + 1));
111*feebddf4SPierre Jolivet   PetscCall(ISDestroy(&rows));
112f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->rmap->N, 0, 1, &rows));
113f1580f4eSBarry Smith   PetscCall(MatSetOption(A, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
114f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(A, 1, &rows, cols, MAT_INITIAL_MATRIX, &splitting));
115f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(*splitting, 1, &rows, cols + 1, MAT_INITIAL_MATRIX, &sub));
116f1580f4eSBarry Smith   PetscCall(ISDestroy(cols + 1));
117f1580f4eSBarry Smith   PetscCall(ISDestroy(&rows));
118*feebddf4SPierre Jolivet   PetscCall(MatFindZeroRows(*sub, &rows));
119*feebddf4SPierre Jolivet   PetscCall(MatDestroySubMatrices(1, &sub));
120f1580f4eSBarry Smith   PetscCall(MatSetOption(*splitting, MAT_KEEP_NONZERO_PATTERN, PETSC_TRUE));
121*feebddf4SPierre Jolivet   PetscCall(MatZeroRowsIS(*splitting, rows, 0.0, nullptr, nullptr));
122*feebddf4SPierre Jolivet   PetscCall(ISDestroy(&rows));
123db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_sub_pc_type", type, sizeof(type), nullptr));
124f1580f4eSBarry Smith   PetscCall(PetscStrcmp(type, PCQR, &flg));
125f1580f4eSBarry Smith   if (!flg) {
126f1580f4eSBarry Smith     Mat conjugate = *splitting;
127811e8887SPierre Jolivet 
128f1580f4eSBarry Smith     if (PetscDefined(USE_COMPLEX)) {
129f1580f4eSBarry Smith       PetscCall(MatDuplicate(*splitting, MAT_COPY_VALUES, &conjugate));
130f1580f4eSBarry Smith       PetscCall(MatConjugate(conjugate));
131f1580f4eSBarry Smith     }
132fb842aefSJose E. Roman     PetscCall(MatTransposeMatMult(conjugate, *splitting, MAT_INITIAL_MATRIX, PETSC_DETERMINE, &aux));
133f1580f4eSBarry Smith     if (PetscDefined(USE_COMPLEX)) PetscCall(MatDestroy(&conjugate));
134f1580f4eSBarry Smith     PetscCall(MatNorm(aux, NORM_FROBENIUS, &norm));
135f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1363df4cd7bSPierre Jolivet     if (diagonal) {
137811e8887SPierre Jolivet       PetscReal norm;
138811e8887SPierre Jolivet 
139*feebddf4SPierre Jolivet       PetscCall(VecScale(*diagonal, -1.0));
1403df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1413df4cd7bSPierre Jolivet       if (norm > PETSC_SMALL) {
14201e3c840SPierre Jolivet         PetscSF  scatter;
1433df4cd7bSPierre Jolivet         PetscInt n;
144811e8887SPierre Jolivet 
1453df4cd7bSPierre Jolivet         PetscCall(ISGetLocalSize(*cols, &n));
1463df4cd7bSPierre Jolivet         PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)pc), n, PETSC_DECIDE, &d));
1473df4cd7bSPierre Jolivet         PetscCall(VecScatterCreate(*diagonal, *cols, d, nullptr, &scatter));
1483df4cd7bSPierre Jolivet         PetscCall(VecScatterBegin(scatter, *diagonal, d, INSERT_VALUES, SCATTER_FORWARD));
1493df4cd7bSPierre Jolivet         PetscCall(VecScatterEnd(scatter, *diagonal, d, INSERT_VALUES, SCATTER_FORWARD));
15001e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&scatter));
1513df4cd7bSPierre Jolivet         PetscCall(MatDiagonalSet(aux, d, ADD_VALUES));
1523df4cd7bSPierre Jolivet         PetscCall(VecDestroy(&d));
1533df4cd7bSPierre Jolivet       } else PetscCall(VecDestroy(diagonal));
1543df4cd7bSPierre Jolivet     }
1553df4cd7bSPierre Jolivet     if (!diagonal) PetscCall(MatShift(aux, PETSC_SMALL * norm));
156f1580f4eSBarry Smith   } else {
157f1580f4eSBarry Smith     PetscBool flg;
158811e8887SPierre Jolivet 
1593df4cd7bSPierre Jolivet     if (diagonal) {
1603df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1613df4cd7bSPierre Jolivet       PetscCheck(norm < PETSC_SMALL, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Nonzero diagonal A11 block");
1623df4cd7bSPierre Jolivet       PetscCall(VecDestroy(diagonal));
1633df4cd7bSPierre Jolivet     }
164f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)N, MATNORMAL, &flg));
165f1580f4eSBarry Smith     if (flg) PetscCall(MatCreateNormal(*splitting, &aux));
166f1580f4eSBarry Smith     else PetscCall(MatCreateNormalHermitian(*splitting, &aux));
167f1580f4eSBarry Smith   }
168f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &splitting));
169db4a47b3SPierre Jolivet   PetscCall(PCHPDDMSetAuxiliaryMat(pc, *cols, aux, nullptr, nullptr));
170c8ea6600SPierre Jolivet   data->Neumann = PETSC_BOOL3_TRUE;
171f1580f4eSBarry Smith   PetscCall(ISDestroy(cols));
172f1580f4eSBarry Smith   PetscCall(MatDestroy(&aux));
1733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
174f1580f4eSBarry Smith }
175f1580f4eSBarry Smith 
176d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetAuxiliaryMat_HPDDM(PC pc, IS is, Mat A, PetscErrorCode (*setup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *setup_ctx)
177d71ae5a4SJacob Faibussowitsch {
178f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
179f1580f4eSBarry Smith 
180f1580f4eSBarry Smith   PetscFunctionBegin;
181f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, A, PETSC_FALSE));
182f1580f4eSBarry Smith   if (setup) {
183f1580f4eSBarry Smith     data->setup     = setup;
184f1580f4eSBarry Smith     data->setup_ctx = setup_ctx;
185f1580f4eSBarry Smith   }
1863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
187f1580f4eSBarry Smith }
188f1580f4eSBarry Smith 
18973329a61SPierre Jolivet typedef struct {
19073329a61SPierre Jolivet   KSP      ksp;
19173329a61SPierre Jolivet   PetscInt its;
19273329a61SPierre Jolivet } PC_KSP;
19373329a61SPierre Jolivet 
19473329a61SPierre Jolivet static inline PetscErrorCode PCSetUp_KSP_Private(PC pc)
19573329a61SPierre Jolivet {
19673329a61SPierre Jolivet   PC_KSP           *data   = (PC_KSP *)pc->data;
19773329a61SPierre Jolivet   const std::string prefix = ((PetscObject)data->ksp)->prefix;
19873329a61SPierre Jolivet   std::string       sub;
19973329a61SPierre Jolivet 
20073329a61SPierre Jolivet   PetscFunctionBegin;
20173329a61SPierre Jolivet   PetscCheck(prefix.size() >= 9, PETSC_COMM_SELF, PETSC_ERR_PLIB, "The prefix of this PCKSP should be of length at least 9 to hold the suffix pc_hpddm_");
20273329a61SPierre Jolivet   sub = prefix.substr(0, prefix.size() - 9);
20373329a61SPierre Jolivet   PetscCall(PCSetType(pc, PCHPDDM));
20473329a61SPierre Jolivet   PetscCall(PCSetOptionsPrefix(pc, sub.c_str()));
20573329a61SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
20673329a61SPierre Jolivet }
20773329a61SPierre Jolivet 
20873329a61SPierre Jolivet static PetscErrorCode PCSetUp_KSP(PC pc)
20973329a61SPierre Jolivet {
21073329a61SPierre Jolivet   PetscFunctionBegin;
21173329a61SPierre Jolivet   PetscCall(PCSetUp_KSP_Private(pc));
21273329a61SPierre Jolivet   PetscCall(PCSetFromOptions(pc));
21373329a61SPierre Jolivet   PetscCall(PCSetUp(pc));
21473329a61SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
21573329a61SPierre Jolivet }
21673329a61SPierre Jolivet 
21770009435SPierre Jolivet /*@C
21804c3f3b8SBarry Smith   PCHPDDMSetAuxiliaryMat - Sets the auxiliary matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
219f1580f4eSBarry Smith 
220f1580f4eSBarry Smith   Input Parameters:
221f1580f4eSBarry Smith + pc    - preconditioner context
222f1580f4eSBarry Smith . is    - index set of the local auxiliary, e.g., Neumann, matrix
223f1580f4eSBarry Smith . A     - auxiliary sequential matrix
22404c3f3b8SBarry Smith . setup - function for generating the auxiliary matrix entries, may be `NULL`
22504c3f3b8SBarry Smith - ctx   - context for `setup`, may be `NULL`
22604c3f3b8SBarry Smith 
22704c3f3b8SBarry Smith   Calling sequence of `setup`:
22804c3f3b8SBarry Smith + J   - matrix whose values are to be set
22904c3f3b8SBarry Smith . t   - time
23004c3f3b8SBarry Smith . X   - linearization point
23104c3f3b8SBarry Smith . X_t - time-derivative of the linearization point
23204c3f3b8SBarry Smith . s   - step
23304c3f3b8SBarry Smith . ovl - index set of the local auxiliary, e.g., Neumann, matrix
23404c3f3b8SBarry Smith - ctx - context for `setup`, may be `NULL`
235f1580f4eSBarry Smith 
236f1580f4eSBarry Smith   Level: intermediate
237f1580f4eSBarry Smith 
23804c3f3b8SBarry Smith   Note:
23904c3f3b8SBarry Smith   As an example, in a finite element context with nonoverlapping subdomains plus (overlapping) ghost elements, this could be the unassembled (Neumann)
24004c3f3b8SBarry Smith   local overlapping operator. As opposed to the assembled (Dirichlet) local overlapping operator obtained by summing neighborhood contributions
24104c3f3b8SBarry Smith   at the interface of ghost elements.
24204c3f3b8SBarry Smith 
24370009435SPierre Jolivet   Fortran Notes:
24404c3f3b8SBarry Smith   Only `PETSC_NULL_FUNCTION` is supported for `setup` and `ctx` is never accessed
24570009435SPierre Jolivet 
246562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetRHSMat()`, `MATIS`
247f1580f4eSBarry Smith @*/
24804c3f3b8SBarry Smith PetscErrorCode PCHPDDMSetAuxiliaryMat(PC pc, IS is, Mat A, PetscErrorCode (*setup)(Mat J, PetscReal t, Vec X, Vec X_t, PetscReal s, IS ovl, void *ctx), void *ctx)
249d71ae5a4SJacob Faibussowitsch {
250f1580f4eSBarry Smith   PetscFunctionBegin;
251f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
252f1580f4eSBarry Smith   if (is) PetscValidHeaderSpecific(is, IS_CLASSID, 2);
253f1580f4eSBarry Smith   if (A) PetscValidHeaderSpecific(A, MAT_CLASSID, 3);
25473329a61SPierre Jolivet   if (pc->ops->setup == PCSetUp_KSP) PetscCall(PCSetUp_KSP_Private(pc));
25504c3f3b8SBarry Smith   PetscTryMethod(pc, "PCHPDDMSetAuxiliaryMat_C", (PC, IS, Mat, PetscErrorCode (*)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *), (pc, is, A, setup, ctx));
2563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
257f1580f4eSBarry Smith }
258f1580f4eSBarry Smith 
259d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMHasNeumannMat_HPDDM(PC pc, PetscBool has)
260d71ae5a4SJacob Faibussowitsch {
261f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
262f1580f4eSBarry Smith 
263f1580f4eSBarry Smith   PetscFunctionBegin;
264c8ea6600SPierre Jolivet   data->Neumann = PetscBoolToBool3(has);
2653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
266f1580f4eSBarry Smith }
267f1580f4eSBarry Smith 
268f1580f4eSBarry Smith /*@
269f1580f4eSBarry Smith   PCHPDDMHasNeumannMat - Informs `PCHPDDM` that the `Mat` passed to `PCHPDDMSetAuxiliaryMat()` is the local Neumann matrix.
270f1580f4eSBarry Smith 
271f1580f4eSBarry Smith   Input Parameters:
272f1580f4eSBarry Smith + pc  - preconditioner context
273f1580f4eSBarry Smith - has - Boolean value
274f1580f4eSBarry Smith 
275f1580f4eSBarry Smith   Level: intermediate
276f1580f4eSBarry Smith 
277f1580f4eSBarry Smith   Notes:
2787eb095acSPierre Jolivet   This may be used to bypass a call to `MatCreateSubMatrices()` and to `MatConvert()` for `MATSBAIJ` matrices.
279f1580f4eSBarry Smith 
280907a3e9cSStefano Zampini   If a function is composed with DMCreateNeumannOverlap_C implementation is available in the `DM` attached to the Pmat, or the Amat, or the `PC`, the flag is internally set to `PETSC_TRUE`. Its default value is otherwise `PETSC_FALSE`.
281f1580f4eSBarry Smith 
282562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetAuxiliaryMat()`
283f1580f4eSBarry Smith @*/
284d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMHasNeumannMat(PC pc, PetscBool has)
285d71ae5a4SJacob Faibussowitsch {
286f1580f4eSBarry Smith   PetscFunctionBegin;
287f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
288f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMHasNeumannMat_C", (PC, PetscBool), (pc, has));
2893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
290f1580f4eSBarry Smith }
291f1580f4eSBarry Smith 
292d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetRHSMat_HPDDM(PC pc, Mat B)
293d71ae5a4SJacob Faibussowitsch {
294f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
295f1580f4eSBarry Smith 
296f1580f4eSBarry Smith   PetscFunctionBegin;
297f1580f4eSBarry Smith   PetscCall(PetscObjectReference((PetscObject)B));
298f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->B));
299f1580f4eSBarry Smith   data->B = B;
3003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
301f1580f4eSBarry Smith }
302f1580f4eSBarry Smith 
303f1580f4eSBarry Smith /*@
30404c3f3b8SBarry Smith   PCHPDDMSetRHSMat - Sets the right-hand side matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
305f1580f4eSBarry Smith 
306f1580f4eSBarry Smith   Input Parameters:
307f1580f4eSBarry Smith + pc - preconditioner context
308f1580f4eSBarry Smith - B  - right-hand side sequential matrix
309f1580f4eSBarry Smith 
310f1580f4eSBarry Smith   Level: advanced
311f1580f4eSBarry Smith 
31204c3f3b8SBarry Smith   Note:
31304c3f3b8SBarry Smith   Must be used in conjunction with `PCHPDDMSetAuxiliaryMat`(N), so that Nv = lambda Bv is solved using `EPSSetOperators`(N, B).
31404c3f3b8SBarry Smith   It is assumed that N and `B` are provided using the same numbering. This provides a means to try more advanced methods such as GenEO-II or H-GenEO.
31504c3f3b8SBarry Smith 
316562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetAuxiliaryMat()`, `PCHPDDM`
317f1580f4eSBarry Smith @*/
318d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetRHSMat(PC pc, Mat B)
319d71ae5a4SJacob Faibussowitsch {
320f1580f4eSBarry Smith   PetscFunctionBegin;
321f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
322f1580f4eSBarry Smith   if (B) {
323f1580f4eSBarry Smith     PetscValidHeaderSpecific(B, MAT_CLASSID, 2);
324f1580f4eSBarry Smith     PetscTryMethod(pc, "PCHPDDMSetRHSMat_C", (PC, Mat), (pc, B));
325f1580f4eSBarry Smith   }
3263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
327f1580f4eSBarry Smith }
328f1580f4eSBarry Smith 
329d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_HPDDM(PC pc, PetscOptionItems *PetscOptionsObject)
330d71ae5a4SJacob Faibussowitsch {
331f1580f4eSBarry Smith   PC_HPDDM                   *data   = (PC_HPDDM *)pc->data;
332f1580f4eSBarry Smith   PC_HPDDM_Level            **levels = data->levels;
333f1580f4eSBarry Smith   char                        prefix[256];
334f1580f4eSBarry Smith   int                         i = 1;
335f1580f4eSBarry Smith   PetscMPIInt                 size, previous;
3369bb5c669SPierre Jolivet   PetscInt                    n, overlap = 1;
337f1580f4eSBarry Smith   PCHPDDMCoarseCorrectionType type;
338c8ea6600SPierre Jolivet   PetscBool                   flg = PETSC_TRUE, set;
339f1580f4eSBarry Smith 
340f1580f4eSBarry Smith   PetscFunctionBegin;
341f1580f4eSBarry Smith   if (!data->levels) {
342f1580f4eSBarry Smith     PetscCall(PetscCalloc1(PETSC_PCHPDDM_MAXLEVELS, &levels));
343f1580f4eSBarry Smith     data->levels = levels;
344f1580f4eSBarry Smith   }
345f1580f4eSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "PCHPDDM options");
3469bb5c669SPierre Jolivet   PetscCall(PetscOptionsBoundedInt("-pc_hpddm_harmonic_overlap", "Overlap prior to computing local harmonic extensions", "PCHPDDM", overlap, &overlap, &set, 1));
3479bb5c669SPierre Jolivet   if (!set) overlap = -1;
348f1580f4eSBarry Smith   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
349f1580f4eSBarry Smith   previous = size;
350f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS) {
351f1580f4eSBarry Smith     PetscInt p = 1;
352f1580f4eSBarry Smith 
3534dfa11a4SJacob Faibussowitsch     if (!data->levels[i - 1]) PetscCall(PetscNew(data->levels + i - 1));
354f1580f4eSBarry Smith     data->levels[i - 1]->parent = data;
355f1580f4eSBarry Smith     /* if the previous level has a single process, it is not possible to coarsen further */
356f1580f4eSBarry Smith     if (previous == 1 || !flg) break;
357f1580f4eSBarry Smith     data->levels[i - 1]->nu        = 0;
358f1580f4eSBarry Smith     data->levels[i - 1]->threshold = -1.0;
359f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
360db4a47b3SPierre Jolivet     PetscCall(PetscOptionsBoundedInt(prefix, "Local number of deflation vectors computed by SLEPc", "EPSSetDimensions", data->levels[i - 1]->nu, &data->levels[i - 1]->nu, nullptr, 0));
361f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold", i));
362db4a47b3SPierre Jolivet     PetscCall(PetscOptionsReal(prefix, "Local threshold for selecting deflation vectors returned by SLEPc", "PCHPDDM", data->levels[i - 1]->threshold, &data->levels[i - 1]->threshold, nullptr));
363f1580f4eSBarry Smith     if (i == 1) {
364aa1539e9SPierre Jolivet       PetscCheck(overlap == -1 || PetscAbsReal(data->levels[i - 1]->threshold + static_cast<PetscReal>(1.0)) < PETSC_MACHINE_EPSILON, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot supply both -pc_hpddm_levels_1_eps_threshold and -pc_hpddm_harmonic_overlap");
3659bb5c669SPierre Jolivet       if (overlap != -1) {
3669bb5c669SPierre Jolivet         PetscInt nsv = 0;
367811e8887SPierre Jolivet 
3689bb5c669SPierre Jolivet         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_nsv", i));
3699bb5c669SPierre Jolivet         PetscCall(PetscOptionsBoundedInt(prefix, "Local number of deflation vectors computed by SLEPc", "SVDSetDimensions", nsv, &nsv, nullptr, 0));
3709bb5c669SPierre Jolivet         PetscCheck(bool(data->levels[0]->nu) != bool(nsv), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot supply %s -pc_hpddm_levels_1_eps_nev %s -pc_hpddm_levels_1_svd_nsv", nsv ? "both" : "neither", nsv ? "and" : "nor");
3719bb5c669SPierre Jolivet         if (nsv) {
3729bb5c669SPierre Jolivet           data->levels[0]->nu = nsv;
3739bb5c669SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_relative_threshold", i));
3749bb5c669SPierre Jolivet         } else PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_relative_threshold", i));
3759bb5c669SPierre Jolivet         PetscCall(PetscOptionsReal(prefix, "Local relative threshold for selecting deflation vectors returned by SLEPc", "PCHPDDM", data->levels[0]->threshold, &data->levels[0]->threshold, nullptr));
3769bb5c669SPierre Jolivet       }
377f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_1_st_share_sub_ksp"));
378db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Shared KSP between SLEPc ST and the fine-level subdomain solver", "PCHPDDMSetSTShareSubKSP", PETSC_FALSE, &data->share, nullptr));
379f1580f4eSBarry Smith     }
380f1580f4eSBarry Smith     /* if there is no prescribed coarsening, just break out of the loop */
3810594bca0SPierre Jolivet     if (data->levels[i - 1]->threshold <= PetscReal() && data->levels[i - 1]->nu <= 0 && !(data->deflation && i == 1)) break;
382f1580f4eSBarry Smith     else {
383f1580f4eSBarry Smith       ++i;
384f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
385f1580f4eSBarry Smith       PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
386f1580f4eSBarry Smith       if (!flg) {
387f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold", i));
388f1580f4eSBarry Smith         PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
389f1580f4eSBarry Smith       }
390f1580f4eSBarry Smith       if (flg) {
391f1580f4eSBarry Smith         /* if there are coarsening options for the next level, then register it  */
392f1580f4eSBarry Smith         /* otherwise, don't to avoid having both options levels_N_p and coarse_p */
393f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_p", i));
394f1580f4eSBarry Smith         PetscCall(PetscOptionsRangeInt(prefix, "Number of processes used to assemble the coarse operator at this level", "PCHPDDM", p, &p, &flg, 1, PetscMax(1, previous / 2)));
395f1580f4eSBarry Smith         previous = p;
396f1580f4eSBarry Smith       }
397f1580f4eSBarry Smith     }
398f1580f4eSBarry Smith   }
399f1580f4eSBarry Smith   data->N = i;
400f1580f4eSBarry Smith   n       = 1;
401f1580f4eSBarry Smith   if (i > 1) {
402f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_coarse_p"));
403db4a47b3SPierre Jolivet     PetscCall(PetscOptionsRangeInt(prefix, "Number of processes used to assemble the coarsest operator", "PCHPDDM", n, &n, nullptr, 1, PetscMax(1, previous / 2)));
40402800ff6SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
405f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "pc_hpddm_coarse_"));
406db4a47b3SPierre Jolivet     PetscCall(PetscOptionsHasName(nullptr, prefix, "-mat_mumps_use_omp_threads", &flg));
407f1580f4eSBarry Smith     if (flg) {
408f1580f4eSBarry Smith       char type[64]; /* same size as in src/ksp/pc/impls/factor/factimpl.c */
409811e8887SPierre Jolivet 
410c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(type, n > 1 && PetscDefined(HAVE_MUMPS) ? MATSOLVERMUMPS : MATSOLVERPETSC, sizeof(type))); /* default solver for a MatMPIAIJ or a MatSeqAIJ */
411db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetString(nullptr, prefix, "-pc_factor_mat_solver_type", type, sizeof(type), nullptr));
4123ce573a3SPierre Jolivet       PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
413f1580f4eSBarry Smith       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "-%smat_mumps_use_omp_threads and -%spc_factor_mat_solver_type != %s", prefix, prefix, MATSOLVERMUMPS);
414f1580f4eSBarry Smith       size = n;
415f1580f4eSBarry Smith       n    = -1;
416db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetInt(nullptr, prefix, "-mat_mumps_use_omp_threads", &n, nullptr));
417f1580f4eSBarry Smith       PetscCheck(n >= 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Need to specify a positive integer for -%smat_mumps_use_omp_threads", prefix);
418f1580f4eSBarry Smith       PetscCheck(n * size <= previous, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "%d MPI process%s x %d OpenMP thread%s greater than %d available MPI process%s for the coarsest operator", (int)size, size > 1 ? "es" : "", (int)n, n > 1 ? "s" : "", (int)previous, previous > 1 ? "es" : "");
419f1580f4eSBarry Smith     }
420f1580f4eSBarry Smith #endif
421f1580f4eSBarry Smith     PetscCall(PetscOptionsEnum("-pc_hpddm_coarse_correction", "Type of coarse correction applied each iteration", "PCHPDDMSetCoarseCorrectionType", PCHPDDMCoarseCorrectionTypes, (PetscEnum)data->correction, (PetscEnum *)&type, &flg));
422f1580f4eSBarry Smith     if (flg) PetscCall(PCHPDDMSetCoarseCorrectionType(pc, type));
423f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_has_neumann"));
424c8ea6600SPierre Jolivet     PetscCall(PetscOptionsBool(prefix, "Is the auxiliary Mat the local Neumann matrix?", "PCHPDDMHasNeumannMat", PetscBool3ToBool(data->Neumann), &flg, &set));
425c8ea6600SPierre Jolivet     if (set) data->Neumann = PetscBoolToBool3(flg);
426f1580f4eSBarry Smith     data->log_separate = PETSC_FALSE;
427f1580f4eSBarry Smith     if (PetscDefined(USE_LOG)) {
428f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_log_separate"));
429db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Log events level by level instead of inside PCSetUp()/KSPSolve()", nullptr, data->log_separate, &data->log_separate, nullptr));
430f1580f4eSBarry Smith     }
431f1580f4eSBarry Smith   }
432f1580f4eSBarry Smith   PetscOptionsHeadEnd();
433f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]) PetscCall(PetscFree(data->levels[i++]));
4343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
435f1580f4eSBarry Smith }
436f1580f4eSBarry Smith 
437d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDM(PC pc, Vec x, Vec y)
438d71ae5a4SJacob Faibussowitsch {
439f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
440f1580f4eSBarry Smith 
441f1580f4eSBarry Smith   PetscFunctionBegin;
442f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
443f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
444db4a47b3SPierre Jolivet   if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_Solve[0], data->levels[0]->ksp, nullptr, nullptr, nullptr)); /* coarser-level events are directly triggered in HPDDM */
445f1580f4eSBarry Smith   PetscCall(KSPSolve(data->levels[0]->ksp, x, y));
446db4a47b3SPierre Jolivet   if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
4473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
448f1580f4eSBarry Smith }
449f1580f4eSBarry Smith 
450d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDM(PC pc, Mat X, Mat Y)
451d71ae5a4SJacob Faibussowitsch {
452f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
453f1580f4eSBarry Smith 
454f1580f4eSBarry Smith   PetscFunctionBegin;
455f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
456f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
457f1580f4eSBarry Smith   PetscCall(KSPMatSolve(data->levels[0]->ksp, X, Y));
4583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
459f1580f4eSBarry Smith }
460f1580f4eSBarry Smith 
461cc4c1da9SBarry Smith /*@
462f1580f4eSBarry Smith   PCHPDDMGetComplexities - Computes the grid and operator complexities.
463f1580f4eSBarry Smith 
464c71f06a7SPierre Jolivet   Collective
465c71f06a7SPierre Jolivet 
466f1580f4eSBarry Smith   Input Parameter:
467f1580f4eSBarry Smith . pc - preconditioner context
468f1580f4eSBarry Smith 
469f1580f4eSBarry Smith   Output Parameters:
470cc4c1da9SBarry Smith + gc - grid complexity $ \sum_i m_i / m_1 $
471cc4c1da9SBarry Smith - oc - operator complexity $ \sum_i nnz_i / nnz_1 $
472f1580f4eSBarry Smith 
473f1580f4eSBarry Smith   Level: advanced
474f1580f4eSBarry Smith 
475562efe2eSBarry Smith .seealso: [](ch_ksp), `PCMGGetGridComplexity()`, `PCHPDDM`, `PCHYPRE`, `PCGAMG`
476f1580f4eSBarry Smith @*/
477cc4c1da9SBarry Smith PetscErrorCode PCHPDDMGetComplexities(PC pc, PetscReal *gc, PetscReal *oc)
478d71ae5a4SJacob Faibussowitsch {
479f1580f4eSBarry Smith   PC_HPDDM      *data = (PC_HPDDM *)pc->data;
480f1580f4eSBarry Smith   MatInfo        info;
481f1580f4eSBarry Smith   PetscLogDouble accumulate[2]{}, nnz1 = 1.0, m1 = 1.0;
482f1580f4eSBarry Smith 
483f1580f4eSBarry Smith   PetscFunctionBegin;
484715c1178SPierre Jolivet   if (gc) {
485715c1178SPierre Jolivet     PetscAssertPointer(gc, 2);
486715c1178SPierre Jolivet     *gc = 0;
487715c1178SPierre Jolivet   }
488715c1178SPierre Jolivet   if (oc) {
489715c1178SPierre Jolivet     PetscAssertPointer(oc, 3);
490715c1178SPierre Jolivet     *oc = 0;
491715c1178SPierre Jolivet   }
492715c1178SPierre Jolivet   for (PetscInt n = 0; n < data->N; ++n) {
493f1580f4eSBarry Smith     if (data->levels[n]->ksp) {
49413044ca3SPierre Jolivet       Mat       P, A = nullptr;
495715c1178SPierre Jolivet       PetscInt  m;
49613044ca3SPierre Jolivet       PetscBool flg = PETSC_FALSE;
49713044ca3SPierre Jolivet 
498db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &P));
499db4a47b3SPierre Jolivet       PetscCall(MatGetSize(P, &m, nullptr));
500f1580f4eSBarry Smith       accumulate[0] += m;
501f1580f4eSBarry Smith       if (n == 0) {
502f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
503f1580f4eSBarry Smith         if (flg) {
504f1580f4eSBarry Smith           PetscCall(MatConvert(P, MATAIJ, MAT_INITIAL_MATRIX, &A));
505f1580f4eSBarry Smith           P = A;
50613044ca3SPierre Jolivet         } else {
50713044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
50813044ca3SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)P));
509f1580f4eSBarry Smith         }
51013044ca3SPierre Jolivet       }
51113044ca3SPierre Jolivet       if (!A && flg) accumulate[1] += m * m; /* assumption that a MATSCHURCOMPLEMENT is dense if stored explicitly */
51213044ca3SPierre Jolivet       else if (P->ops->getinfo) {
513f1580f4eSBarry Smith         PetscCall(MatGetInfo(P, MAT_GLOBAL_SUM, &info));
514f1580f4eSBarry Smith         accumulate[1] += info.nz_used;
515f1580f4eSBarry Smith       }
516f1580f4eSBarry Smith       if (n == 0) {
517f1580f4eSBarry Smith         m1 = m;
51813044ca3SPierre Jolivet         if (!A && flg) nnz1 = m * m;
51913044ca3SPierre Jolivet         else if (P->ops->getinfo) nnz1 = info.nz_used;
520f1580f4eSBarry Smith         PetscCall(MatDestroy(&P));
521f1580f4eSBarry Smith       }
522f1580f4eSBarry Smith     }
523f1580f4eSBarry Smith   }
524715c1178SPierre Jolivet   /* only process #0 has access to the full hierarchy by construction, so broadcast to ensure consistent outputs */
525715c1178SPierre Jolivet   PetscCallMPI(MPI_Bcast(accumulate, 2, MPIU_PETSCLOGDOUBLE, 0, PetscObjectComm((PetscObject)pc)));
526715c1178SPierre Jolivet   if (gc) *gc = static_cast<PetscReal>(accumulate[0] / m1);
527715c1178SPierre Jolivet   if (oc) *oc = static_cast<PetscReal>(accumulate[1] / nnz1);
5283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
529f1580f4eSBarry Smith }
530f1580f4eSBarry Smith 
531d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_HPDDM(PC pc, PetscViewer viewer)
532d71ae5a4SJacob Faibussowitsch {
533f1580f4eSBarry Smith   PC_HPDDM         *data = (PC_HPDDM *)pc->data;
534f1580f4eSBarry Smith   PetscViewer       subviewer;
535aa21023fSPierre Jolivet   PetscViewerFormat format;
536f1580f4eSBarry Smith   PetscSubcomm      subcomm;
537f1580f4eSBarry Smith   PetscReal         oc, gc;
538811e8887SPierre Jolivet   PetscInt          tabs;
539f1580f4eSBarry Smith   PetscMPIInt       size, color, rank;
540aa21023fSPierre Jolivet   PetscBool         flg;
541aa21023fSPierre Jolivet   const char       *name;
542f1580f4eSBarry Smith 
543f1580f4eSBarry Smith   PetscFunctionBegin;
544aa21023fSPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &flg));
545aa21023fSPierre Jolivet   if (flg) {
546f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "level%s: %" PetscInt_FMT "\n", data->N > 1 ? "s" : "", data->N));
547f1580f4eSBarry Smith     PetscCall(PCHPDDMGetComplexities(pc, &gc, &oc));
548f1580f4eSBarry Smith     if (data->N > 1) {
549f1580f4eSBarry Smith       if (!data->deflation) {
550c8ea6600SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "Neumann matrix attached? %s\n", PetscBools[PetscBool3ToBool(data->Neumann)]));
551f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, "shared subdomain KSP between SLEPc and PETSc? %s\n", PetscBools[data->share]));
552f1580f4eSBarry Smith       } else PetscCall(PetscViewerASCIIPrintf(viewer, "user-supplied deflation matrix\n"));
553f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "coarse correction: %s\n", PCHPDDMCoarseCorrectionTypes[data->correction]));
554f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "on process #0, value%s (+ threshold%s if available) for selecting deflation vectors:", data->N > 2 ? "s" : "", data->N > 2 ? "s" : ""));
555f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIGetTab(viewer, &tabs));
556f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, 0));
557811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
558f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, data->levels[i - 1]->nu));
5590594bca0SPierre Jolivet         if (data->levels[i - 1]->threshold > static_cast<PetscReal>(-0.1)) PetscCall(PetscViewerASCIIPrintf(viewer, " (%g)", (double)data->levels[i - 1]->threshold));
560f1580f4eSBarry Smith       }
561f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
562f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, tabs));
563f1580f4eSBarry Smith     }
564f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "grid and operator complexities: %g %g\n", (double)gc, (double)oc));
5651fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
5661fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank));
567f1580f4eSBarry Smith     if (data->levels[0]->ksp) {
568f1580f4eSBarry Smith       PetscCall(KSPView(data->levels[0]->ksp, viewer));
569f1580f4eSBarry Smith       if (data->levels[0]->pc) PetscCall(PCView(data->levels[0]->pc, viewer));
570811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
571f1580f4eSBarry Smith         if (data->levels[i]->ksp) color = 1;
572f1580f4eSBarry Smith         else color = 0;
573f1580f4eSBarry Smith         PetscCall(PetscSubcommCreate(PetscObjectComm((PetscObject)pc), &subcomm));
574f1580f4eSBarry Smith         PetscCall(PetscSubcommSetNumber(subcomm, PetscMin(size, 2)));
575f1580f4eSBarry Smith         PetscCall(PetscSubcommSetTypeGeneral(subcomm, color, rank));
576f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPushTab(viewer));
577f1580f4eSBarry Smith         PetscCall(PetscViewerGetSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
578f1580f4eSBarry Smith         if (color == 1) {
579f1580f4eSBarry Smith           PetscCall(KSPView(data->levels[i]->ksp, subviewer));
580f1580f4eSBarry Smith           if (data->levels[i]->pc) PetscCall(PCView(data->levels[i]->pc, subviewer));
581f1580f4eSBarry Smith           PetscCall(PetscViewerFlush(subviewer));
582f1580f4eSBarry Smith         }
583f1580f4eSBarry Smith         PetscCall(PetscViewerRestoreSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
584f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPopTab(viewer));
585f1580f4eSBarry Smith         PetscCall(PetscSubcommDestroy(&subcomm));
586f1580f4eSBarry Smith       }
587f1580f4eSBarry Smith     }
588aa21023fSPierre Jolivet     PetscCall(PetscViewerGetFormat(viewer, &format));
589aa21023fSPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
590aa21023fSPierre Jolivet       PetscCall(PetscViewerFileGetName(viewer, &name));
591aa21023fSPierre Jolivet       if (name) {
592aa21023fSPierre Jolivet         IS          is;
593aa21023fSPierre Jolivet         PetscInt    sizes[4] = {pc->mat->rmap->n, pc->mat->cmap->n, pc->mat->rmap->N, pc->mat->cmap->N};
594aa21023fSPierre Jolivet         char       *tmp;
595aa21023fSPierre Jolivet         std::string prefix, suffix;
596aa21023fSPierre Jolivet         size_t      pos;
597aa21023fSPierre Jolivet 
598aa21023fSPierre Jolivet         PetscCall(PetscStrstr(name, ".", &tmp));
599aa21023fSPierre Jolivet         if (tmp) {
600aa21023fSPierre Jolivet           pos    = std::distance(const_cast<char *>(name), tmp);
601aa21023fSPierre Jolivet           prefix = std::string(name, pos);
602aa21023fSPierre Jolivet           suffix = std::string(name + pos + 1);
603aa21023fSPierre Jolivet         } else prefix = name;
604aa21023fSPierre Jolivet         if (data->aux) {
605aa21023fSPierre Jolivet           PetscCall(PetscViewerBinaryOpen(PETSC_COMM_SELF, std::string(prefix + "_aux_" + std::to_string(rank) + "_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
606aa21023fSPierre Jolivet           PetscCall(MatView(data->aux, subviewer));
607aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
608aa21023fSPierre Jolivet         }
609aa21023fSPierre Jolivet         if (data->is) {
610aa21023fSPierre Jolivet           PetscCall(PetscViewerBinaryOpen(PETSC_COMM_SELF, std::string(prefix + "_is_" + std::to_string(rank) + "_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
611aa21023fSPierre Jolivet           PetscCall(ISView(data->is, subviewer));
612aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
613aa21023fSPierre Jolivet         }
614aa21023fSPierre Jolivet         PetscCall(ISCreateGeneral(PETSC_COMM_SELF, PETSC_STATIC_ARRAY_LENGTH(sizes), sizes, PETSC_USE_POINTER, &is));
615aa21023fSPierre Jolivet         PetscCall(PetscViewerBinaryOpen(PETSC_COMM_SELF, std::string(prefix + "_sizes_" + std::to_string(rank) + "_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
616aa21023fSPierre Jolivet         PetscCall(ISView(is, subviewer));
617aa21023fSPierre Jolivet         PetscCall(PetscViewerDestroy(&subviewer));
618aa21023fSPierre Jolivet         PetscCall(ISDestroy(&is));
619aa21023fSPierre Jolivet       }
620aa21023fSPierre Jolivet     }
621f1580f4eSBarry Smith   }
6223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
623f1580f4eSBarry Smith }
624f1580f4eSBarry Smith 
625d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCPreSolve_HPDDM(PC pc, KSP ksp, Vec, Vec)
626d71ae5a4SJacob Faibussowitsch {
627f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
628f1580f4eSBarry Smith   Mat       A;
629cdbd50ebSPierre Jolivet   PetscBool flg;
630f1580f4eSBarry Smith 
631f1580f4eSBarry Smith   PetscFunctionBegin;
632f1580f4eSBarry Smith   if (ksp) {
633f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPLSQR, &flg));
634f1580f4eSBarry Smith     if (flg && !data->normal) {
635db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(ksp, &A, nullptr));
636db4a47b3SPierre Jolivet       PetscCall(MatCreateVecs(A, nullptr, &data->normal)); /* temporary Vec used in PCApply_HPDDMShell() for coarse grid corrections */
637cdbd50ebSPierre Jolivet     } else if (!flg) {
638cdbd50ebSPierre Jolivet       PetscCall(PetscObjectTypeCompareAny((PetscObject)ksp, &flg, KSPCG, KSPGROPPCG, KSPPIPECG, KSPPIPECGRR, KSPPIPELCG, KSPPIPEPRCG, KSPPIPECG2, KSPSTCG, KSPFCG, KSPPIPEFCG, KSPMINRES, KSPNASH, KSPSYMMLQ, ""));
639cdbd50ebSPierre Jolivet       if (!flg) {
640cdbd50ebSPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPHPDDM, &flg));
641cdbd50ebSPierre Jolivet         if (flg) {
642cdbd50ebSPierre Jolivet           KSPHPDDMType type;
643811e8887SPierre Jolivet 
644cdbd50ebSPierre Jolivet           PetscCall(KSPHPDDMGetType(ksp, &type));
645cdbd50ebSPierre Jolivet           flg = (type == KSP_HPDDM_TYPE_CG || type == KSP_HPDDM_TYPE_BCG || type == KSP_HPDDM_TYPE_BFBCG ? PETSC_TRUE : PETSC_FALSE);
646cdbd50ebSPierre Jolivet         }
647cdbd50ebSPierre Jolivet       }
648cdbd50ebSPierre Jolivet     }
649cdbd50ebSPierre Jolivet     if (flg) {
650cdbd50ebSPierre Jolivet       if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) {
651cdbd50ebSPierre Jolivet         PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_hpddm_coarse_correction", &flg));
652cdbd50ebSPierre Jolivet         PetscCheck(flg, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "PCHPDDMCoarseCorrectionType %s is known to be not symmetric, but KSPType %s requires a symmetric PC, if you insist on using this configuration, use the additional option -%spc_hpddm_coarse_correction %s, or alternatively, switch to a symmetric PCHPDDMCoarseCorrectionType such as %s",
653cdbd50ebSPierre Jolivet                    PCHPDDMCoarseCorrectionTypes[data->correction], ((PetscObject)ksp)->type_name, ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", PCHPDDMCoarseCorrectionTypes[data->correction], PCHPDDMCoarseCorrectionTypes[PC_HPDDM_COARSE_CORRECTION_BALANCED]);
654cdbd50ebSPierre Jolivet       }
655cdbd50ebSPierre Jolivet       for (PetscInt n = 0; n < data->N; ++n) {
656cdbd50ebSPierre Jolivet         if (data->levels[n]->pc) {
657cdbd50ebSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)data->levels[n]->pc, PCASM, &flg));
658cdbd50ebSPierre Jolivet           if (flg) {
659cdbd50ebSPierre Jolivet             PCASMType type;
660811e8887SPierre Jolivet 
661cdbd50ebSPierre Jolivet             PetscCall(PCASMGetType(data->levels[n]->pc, &type));
662cdbd50ebSPierre Jolivet             if (type == PC_ASM_RESTRICT || type == PC_ASM_INTERPOLATE) {
663cdbd50ebSPierre Jolivet               PetscCall(PetscOptionsHasName(((PetscObject)data->levels[n]->pc)->options, ((PetscObject)data->levels[n]->pc)->prefix, "-pc_asm_type", &flg));
664cdbd50ebSPierre Jolivet               PetscCheck(flg, PetscObjectComm((PetscObject)data->levels[n]->pc), PETSC_ERR_ARG_INCOMP, "PCASMType %s is known to be not symmetric, but KSPType %s requires a symmetric PC, if you insist on using this configuration, use the additional option -%spc_asm_type %s, or alternatively, switch to a symmetric PCASMType such as %s", PCASMTypes[type],
665cdbd50ebSPierre Jolivet                          ((PetscObject)ksp)->type_name, ((PetscObject)data->levels[n]->pc)->prefix, PCASMTypes[type], PCASMTypes[PC_ASM_BASIC]);
666cdbd50ebSPierre Jolivet             }
667cdbd50ebSPierre Jolivet           }
668cdbd50ebSPierre Jolivet         }
669cdbd50ebSPierre Jolivet       }
670f1580f4eSBarry Smith     }
671f1580f4eSBarry Smith   }
6723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
673f1580f4eSBarry Smith }
674f1580f4eSBarry Smith 
675d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDMShell(PC pc)
676d71ae5a4SJacob Faibussowitsch {
677f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
678f1580f4eSBarry Smith   Mat             A, P;
679f1580f4eSBarry Smith   Vec             x;
680f1580f4eSBarry Smith   const char     *pcpre;
681f1580f4eSBarry Smith 
682f1580f4eSBarry Smith   PetscFunctionBegin;
683f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
684f1580f4eSBarry Smith   PetscCall(KSPGetOptionsPrefix(ctx->ksp, &pcpre));
685f1580f4eSBarry Smith   PetscCall(KSPGetOperators(ctx->ksp, &A, &P));
686f1580f4eSBarry Smith   /* smoother */
687f1580f4eSBarry Smith   PetscCall(PCSetOptionsPrefix(ctx->pc, pcpre));
688f1580f4eSBarry Smith   PetscCall(PCSetOperators(ctx->pc, A, P));
689f1580f4eSBarry Smith   if (!ctx->v[0]) {
690f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(ctx->D, 1, &ctx->v[0]));
691f1580f4eSBarry Smith     if (!std::is_same<PetscScalar, PetscReal>::value) PetscCall(VecDestroy(&ctx->D));
692db4a47b3SPierre Jolivet     PetscCall(MatCreateVecs(A, &x, nullptr));
693f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(x, 2, &ctx->v[1]));
694f1580f4eSBarry Smith     PetscCall(VecDestroy(&x));
695f1580f4eSBarry Smith   }
696f1580f4eSBarry Smith   std::fill_n(ctx->V, 3, nullptr);
6973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
698f1580f4eSBarry Smith }
699f1580f4eSBarry Smith 
700f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
701d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type x, Type y)
702d71ae5a4SJacob Faibussowitsch {
703f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
704f1580f4eSBarry Smith   PetscScalar    *out;
705f1580f4eSBarry Smith 
706f1580f4eSBarry Smith   PetscFunctionBegin;
707f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
708f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
709f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
710f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
711f1580f4eSBarry Smith   PetscCall(VecGetArrayWrite(ctx->v[0][0], &out));
712db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, 1); /* y = Q x */
713f1580f4eSBarry Smith   PetscCall(VecRestoreArrayWrite(ctx->v[0][0], &out));
714f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
715f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
716f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
7173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
718f1580f4eSBarry Smith }
719f1580f4eSBarry Smith 
720f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
721d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type X, Type Y)
722d71ae5a4SJacob Faibussowitsch {
723f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
724f1580f4eSBarry Smith   Vec             vX, vY, vC;
725f1580f4eSBarry Smith   PetscScalar    *out;
726811e8887SPierre Jolivet   PetscInt        N;
727f1580f4eSBarry Smith 
728f1580f4eSBarry Smith   PetscFunctionBegin;
729f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
730db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
731f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
732811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
733f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(X, i, &vX));
734f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(ctx->V[0], i, &vC));
735f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
736f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
737f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(ctx->V[0], i, &vC));
738f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(X, i, &vX));
739f1580f4eSBarry Smith   }
740f1580f4eSBarry Smith   PetscCall(MatDenseGetArrayWrite(ctx->V[0], &out));
741db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, N); /* Y = Q X */
742f1580f4eSBarry Smith   PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &out));
743f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
744811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
745f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(ctx->V[0], i, &vC));
746f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(Y, i, &vY));
747f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
748f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
749f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &vY));
750f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(ctx->V[0], i, &vC));
751f1580f4eSBarry Smith   }
7523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
753f1580f4eSBarry Smith }
754f1580f4eSBarry Smith 
755f1580f4eSBarry Smith /*
756aa1539e9SPierre Jolivet      PCApply_HPDDMShell - Applies a (2) deflated, (1) additive, (3) balanced, or (4) no coarse correction. In what follows, E = Z Pmat Z^T and Q = Z^T E^-1 Z.
757f1580f4eSBarry Smith 
758f1580f4eSBarry Smith .vb
759f1580f4eSBarry Smith    (1) y =                Pmat^-1              x + Q x,
760f1580f4eSBarry Smith    (2) y =                Pmat^-1 (I - Amat Q) x + Q x (default),
761aa1539e9SPierre Jolivet    (3) y = (I - Q Amat^T) Pmat^-1 (I - Amat Q) x + Q x,
762aa1539e9SPierre Jolivet    (4) y =                Pmat^-1              x      .
763f1580f4eSBarry Smith .ve
764f1580f4eSBarry Smith 
765f1580f4eSBarry Smith    Input Parameters:
766f1580f4eSBarry Smith +     pc - preconditioner context
767f1580f4eSBarry Smith -     x - input vector
768f1580f4eSBarry Smith 
769f1580f4eSBarry Smith    Output Parameter:
770f1580f4eSBarry Smith .     y - output vector
771f1580f4eSBarry Smith 
772f1580f4eSBarry Smith    Notes:
773f1580f4eSBarry Smith      The options of Pmat^1 = pc(Pmat) are prefixed by -pc_hpddm_levels_1_pc_. Z is a tall-and-skiny matrix assembled by HPDDM. The number of processes on which (Z Pmat Z^T) is aggregated is set via -pc_hpddm_coarse_p.
774f1580f4eSBarry Smith      The options of (Z Pmat Z^T)^-1 = ksp(Z Pmat Z^T) are prefixed by -pc_hpddm_coarse_ (`KSPPREONLY` and `PCCHOLESKY` by default), unless a multilevel correction is turned on, in which case, this function is called recursively at each level except the coarsest one.
775f1580f4eSBarry Smith      (1) and (2) visit the "next" level (in terms of coarsening) once per application, while (3) visits it twice, so it is asymptotically twice costlier. (2) is not symmetric even if both Amat and Pmat are symmetric.
776f1580f4eSBarry Smith 
777f1580f4eSBarry Smith    Level: advanced
778f1580f4eSBarry Smith 
779f1580f4eSBarry Smith    Developer Note:
780f1580f4eSBarry Smith    Since this is not an actual manual page the material below should be moved to an appropriate manual page with the appropriate context, i.e. explaining when it is used and how
781f1580f4eSBarry Smith    to trigger it. Likely the manual page is `PCHPDDM`
782f1580f4eSBarry Smith 
783562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
784f1580f4eSBarry Smith */
785d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDMShell(PC pc, Vec x, Vec y)
786d71ae5a4SJacob Faibussowitsch {
787f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
788f1580f4eSBarry Smith   Mat             A;
789f1580f4eSBarry Smith 
790f1580f4eSBarry Smith   PetscFunctionBegin;
791f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
792f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
793db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
794aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApply(ctx->pc, x, y)); /* y = M^-1 x */
795aa1539e9SPierre Jolivet   else {
796f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, x, y)); /* y = Q x */
797f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
798f1580f4eSBarry Smith       if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMult(A, y, ctx->v[1][0])); /* y = A Q x     */
799f1580f4eSBarry Smith       else { /* KSPLSQR and finest level */ PetscCall(MatMult(A, y, ctx->parent->normal));               /* y = A Q x     */
800f1580f4eSBarry Smith         PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][0]));                      /* y = A^T A Q x */
801f1580f4eSBarry Smith       }
802f1580f4eSBarry Smith       PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x)); /* y = (I - A Q) x                             */
803f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, ctx->v[1][1], ctx->v[1][0]));  /* y = M^-1 (I - A Q) x                        */
804f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
805f1580f4eSBarry Smith         if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMultHermitianTranspose(A, ctx->v[1][0], ctx->v[1][1])); /* z = A^T y */
806f1580f4eSBarry Smith         else {
807f1580f4eSBarry Smith           PetscCall(MatMult(A, ctx->v[1][0], ctx->parent->normal));
808f1580f4eSBarry Smith           PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][1])); /* z = A^T A y           */
809f1580f4eSBarry Smith         }
810f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->v[1][1], ctx->v[1][1]));
811f1580f4eSBarry Smith         PetscCall(VecAXPBYPCZ(y, -1.0, 1.0, 1.0, ctx->v[1][1], ctx->v[1][0])); /* y = (I - Q A^T) y + Q x      */
812f1580f4eSBarry Smith       } else PetscCall(VecAXPY(y, 1.0, ctx->v[1][0]));                         /* y = Q M^-1 (I - A Q) x + Q x */
813f1580f4eSBarry Smith     } else {
814f1580f4eSBarry Smith       PetscCheck(ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_ADDITIVE, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with an unknown PCHPDDMCoarseCorrectionType %d", ctx->parent->correction);
815f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, x, ctx->v[1][0]));
816f1580f4eSBarry Smith       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-1 x + Q x */
817f1580f4eSBarry Smith     }
818aa1539e9SPierre Jolivet   }
8193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
820f1580f4eSBarry Smith }
821f1580f4eSBarry Smith 
822f1580f4eSBarry Smith /*
823f1580f4eSBarry Smith      PCMatApply_HPDDMShell - Variant of PCApply_HPDDMShell() for blocks of vectors.
824f1580f4eSBarry Smith 
825f1580f4eSBarry Smith    Input Parameters:
826f1580f4eSBarry Smith +     pc - preconditioner context
827f1580f4eSBarry Smith -     X - block of input vectors
828f1580f4eSBarry Smith 
829f1580f4eSBarry Smith    Output Parameter:
830f1580f4eSBarry Smith .     Y - block of output vectors
831f1580f4eSBarry Smith 
832f1580f4eSBarry Smith    Level: advanced
833f1580f4eSBarry Smith 
834562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
835f1580f4eSBarry Smith */
836d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDMShell(PC pc, Mat X, Mat Y)
837d71ae5a4SJacob Faibussowitsch {
838f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
839f1580f4eSBarry Smith   Mat             A, *ptr;
840db4a47b3SPierre Jolivet   PetscContainer  container = nullptr;
841f1580f4eSBarry Smith   PetscScalar    *array;
842f1580f4eSBarry Smith   PetscInt        m, M, N, prev = 0;
843f1580f4eSBarry Smith   PetscBool       reset = PETSC_FALSE;
844f1580f4eSBarry Smith 
845f1580f4eSBarry Smith   PetscFunctionBegin;
846f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
847f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
848db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
849db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
850aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApply(ctx->pc, X, Y));
851aa1539e9SPierre Jolivet   else {
852f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)A, "_HPDDM_MatProduct", (PetscObject *)&container));
853f1580f4eSBarry Smith     if (container) { /* MatProduct container already attached */
854f1580f4eSBarry Smith       PetscCall(PetscContainerGetPointer(container, (void **)&ptr));
855f1580f4eSBarry Smith       if (ptr[1] != ctx->V[2]) /* Mat has changed or may have been set first in KSPHPDDM */
856f1580f4eSBarry Smith         for (m = 0; m < 2; ++m) {
857f1580f4eSBarry Smith           PetscCall(MatDestroy(ctx->V + m + 1));
858f1580f4eSBarry Smith           ctx->V[m + 1] = ptr[m];
859f1580f4eSBarry Smith           PetscCall(PetscObjectReference((PetscObject)ctx->V[m + 1]));
860f1580f4eSBarry Smith         }
861f1580f4eSBarry Smith     }
862db4a47b3SPierre Jolivet     if (ctx->V[1]) PetscCall(MatGetSize(ctx->V[1], nullptr, &prev));
863f1580f4eSBarry Smith     if (N != prev || !ctx->V[0]) {
864f1580f4eSBarry Smith       PetscCall(MatDestroy(ctx->V));
865f1580f4eSBarry Smith       PetscCall(VecGetLocalSize(ctx->v[0][0], &m));
866db4a47b3SPierre Jolivet       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, PETSC_DECIDE, N, nullptr, ctx->V));
867f1580f4eSBarry Smith       if (N != prev) {
868f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 1));
869f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 2));
870db4a47b3SPierre Jolivet         PetscCall(MatGetLocalSize(X, &m, nullptr));
871db4a47b3SPierre Jolivet         PetscCall(MatGetSize(X, &M, nullptr));
872f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
873db4a47b3SPierre Jolivet         else array = nullptr;
874f1580f4eSBarry Smith         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, array, ctx->V + 1));
875f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
876db4a47b3SPierre Jolivet         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, nullptr, ctx->V + 2));
877db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, Y, nullptr, ctx->V[1]));
878f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[1], MATPRODUCT_AB));
879f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[1]));
880f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[1]));
881715c1178SPierre Jolivet         if (!container) PetscCall(PetscObjectContainerCompose((PetscObject)A, "_HPDDM_MatProduct", ctx->V + 1, nullptr)); /* no MatProduct container attached, create one to be queried in KSPHPDDM or at the next call to PCMatApply() */
882715c1178SPierre Jolivet         else PetscCall(PetscContainerSetPointer(container, ctx->V + 1));                                                  /* need to compose B and D from MatProductCreateWithMat(A, B, NULL, D), which are stored in the contiguous array ctx->V */
883f1580f4eSBarry Smith       }
884f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
885db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, ctx->V[1], nullptr, ctx->V[2]));
886f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[2], MATPRODUCT_AtB));
887f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[2]));
888f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[2]));
889f1580f4eSBarry Smith       }
890f1580f4eSBarry Smith       ctx->P->start(N);
891f1580f4eSBarry Smith     }
892f1580f4eSBarry Smith     if (N == prev || container) { /* when MatProduct container is attached, always need to MatProductReplaceMats() since KSPHPDDM may have replaced the Mat as well */
893db4a47b3SPierre Jolivet       PetscCall(MatProductReplaceMats(nullptr, Y, nullptr, ctx->V[1]));
894f1580f4eSBarry Smith       if (container && ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) {
895f1580f4eSBarry Smith         PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
896f1580f4eSBarry Smith         PetscCall(MatDensePlaceArray(ctx->V[1], array));
897f1580f4eSBarry Smith         PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
898f1580f4eSBarry Smith         reset = PETSC_TRUE;
899f1580f4eSBarry Smith       }
900f1580f4eSBarry Smith     }
901f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, X, Y));
902f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
903f1580f4eSBarry Smith       PetscCall(MatProductNumeric(ctx->V[1]));
904f1580f4eSBarry Smith       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
905f1580f4eSBarry Smith       PetscCall(MatAXPY(ctx->V[2], -1.0, X, SAME_NONZERO_PATTERN));
906f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, ctx->V[2], ctx->V[1]));
907f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
908f1580f4eSBarry Smith         PetscCall(MatProductNumeric(ctx->V[2]));
909f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->V[2], ctx->V[2]));
910f1580f4eSBarry Smith         PetscCall(MatAXPY(ctx->V[1], -1.0, ctx->V[2], SAME_NONZERO_PATTERN));
911f1580f4eSBarry Smith       }
912f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
913f1580f4eSBarry Smith     } else {
914f1580f4eSBarry Smith       PetscCheck(ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_ADDITIVE, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with an unknown PCHPDDMCoarseCorrectionType %d", ctx->parent->correction);
915f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, X, ctx->V[1]));
916f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
917f1580f4eSBarry Smith     }
918f1580f4eSBarry Smith     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
919aa1539e9SPierre Jolivet   }
9203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
921f1580f4eSBarry Smith }
922f1580f4eSBarry Smith 
923d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDMShell(PC pc)
924d71ae5a4SJacob Faibussowitsch {
925f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
926f1580f4eSBarry Smith 
927f1580f4eSBarry Smith   PetscFunctionBegin;
928f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
929f1580f4eSBarry Smith   PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(ctx, PETSC_TRUE));
930f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(1, &ctx->v[0]));
931f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(2, &ctx->v[1]));
932f4f49eeaSPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", nullptr));
933f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V));
934f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 1));
935f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 2));
936f1580f4eSBarry Smith   PetscCall(VecDestroy(&ctx->D));
93701e3c840SPierre Jolivet   PetscCall(PetscSFDestroy(&ctx->scatter));
938f1580f4eSBarry Smith   PetscCall(PCDestroy(&ctx->pc));
9393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
940f1580f4eSBarry Smith }
941f1580f4eSBarry Smith 
9429bb5c669SPierre Jolivet template <class Type, bool T = false, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
9439bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type x, Type y)
9449bb5c669SPierre Jolivet {
9459bb5c669SPierre Jolivet   PetscFunctionBegin;
9469bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[0], std::get<1>(*p), SCATTER_FORWARD, x));
9479bb5c669SPierre Jolivet   if (!T) PetscCall(PCApply(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
9489bb5c669SPierre Jolivet   else PetscCall(PCApplyTranspose(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
9499bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[1], std::get<1>(*p), SCATTER_REVERSE, y));
9509bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9519bb5c669SPierre Jolivet }
9529bb5c669SPierre Jolivet 
9539bb5c669SPierre Jolivet template <class Type, bool = false, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
9549bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type X, Type Y)
9559bb5c669SPierre Jolivet {
9569bb5c669SPierre Jolivet   Mat B[2];
9579bb5c669SPierre Jolivet   Vec x, y;
9589bb5c669SPierre Jolivet 
9599bb5c669SPierre Jolivet   PetscFunctionBegin;
9609bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B));
9619bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B + 1));
9629bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
9639bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(X, i, &x));
9649bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B[0], i, &y));
9659bb5c669SPierre Jolivet     PetscCall(VecISCopy(y, std::get<1>(*p), SCATTER_FORWARD, x));
9669bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B[0], i, &y));
9679bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(X, i, &x));
9689bb5c669SPierre Jolivet   }
9699bb5c669SPierre Jolivet   PetscCall(PCMatApply(factor, B[0], B[1]));
9709bb5c669SPierre Jolivet   PetscCall(MatDestroy(B));
9719bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
9729bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B[1], i, &x));
9739bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &y));
9749bb5c669SPierre Jolivet     PetscCall(VecISCopy(x, std::get<1>(*p), SCATTER_REVERSE, y));
9759bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &y));
9769bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B[1], i, &x));
9779bb5c669SPierre Jolivet   }
9789bb5c669SPierre Jolivet   PetscCall(MatDestroy(B + 1));
9799bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9809bb5c669SPierre Jolivet }
9819bb5c669SPierre Jolivet 
9829bb5c669SPierre Jolivet template <class Type = Vec, bool T = false>
9839bb5c669SPierre Jolivet static PetscErrorCode PCApply_Schur(PC pc, Type x, Type y)
9849bb5c669SPierre Jolivet {
9859bb5c669SPierre Jolivet   PC                           factor;
9869bb5c669SPierre Jolivet   Mat                          A;
9879bb5c669SPierre Jolivet   MatSolverType                type;
9889bb5c669SPierre Jolivet   PetscBool                    flg;
9899bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
9909bb5c669SPierre Jolivet 
9919bb5c669SPierre Jolivet   PetscFunctionBegin;
9929bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
9939bb5c669SPierre Jolivet   PetscCall(KSPGetPC(std::get<0>(*p), &factor));
9949bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(factor, &type));
9959bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatrix(factor, &A));
9969bb5c669SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
9979bb5c669SPierre Jolivet   if (flg) {
9989bb5c669SPierre Jolivet     PetscCheck(PetscDefined(HAVE_MUMPS), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
9999bb5c669SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
10009bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 0));
10019bb5c669SPierre Jolivet #endif
10029bb5c669SPierre Jolivet   } else {
10039bb5c669SPierre Jolivet     PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &flg));
10049bb5c669SPierre Jolivet     PetscCheck(flg && PetscDefined(HAVE_MKL_PARDISO), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
10059bb5c669SPierre Jolivet     flg = PETSC_FALSE;
10069bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
10079bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 1));
10089bb5c669SPierre Jolivet #endif
10099bb5c669SPierre Jolivet   }
10109bb5c669SPierre Jolivet   PetscCall(PCApply_Schur_Private<Type, T>(p, factor, x, y));
10119bb5c669SPierre Jolivet   if (flg) {
10129bb5c669SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
10139bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1));
10149bb5c669SPierre Jolivet #endif
10159bb5c669SPierre Jolivet   } else {
10169bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
10179bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 0));
10189bb5c669SPierre Jolivet #endif
10199bb5c669SPierre Jolivet   }
10209bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10219bb5c669SPierre Jolivet }
10229bb5c669SPierre Jolivet 
10239bb5c669SPierre Jolivet static PetscErrorCode PCDestroy_Schur(PC pc)
10249bb5c669SPierre Jolivet {
10259bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
10269bb5c669SPierre Jolivet 
10279bb5c669SPierre Jolivet   PetscFunctionBegin;
10289bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
10299bb5c669SPierre Jolivet   PetscCall(ISDestroy(&std::get<1>(*p)));
10309bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p)));
10319bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p) + 1));
10329bb5c669SPierre Jolivet   PetscCall(PetscFree(p));
10339bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10349bb5c669SPierre Jolivet }
10359bb5c669SPierre Jolivet 
1036d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSolve_Private(const PC_HPDDM_Level *ctx, PetscScalar *rhs, const unsigned short &mu)
1037d71ae5a4SJacob Faibussowitsch {
1038f1580f4eSBarry Smith   Mat      B, X;
1039f1580f4eSBarry Smith   PetscInt n, N, j = 0;
1040f1580f4eSBarry Smith 
1041f1580f4eSBarry Smith   PetscFunctionBegin;
1042db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &B, nullptr));
1043db4a47b3SPierre Jolivet   PetscCall(MatGetLocalSize(B, &n, nullptr));
1044db4a47b3SPierre Jolivet   PetscCall(MatGetSize(B, &N, nullptr));
1045f1580f4eSBarry Smith   if (ctx->parent->log_separate) {
1046f1580f4eSBarry Smith     j = std::distance(ctx->parent->levels, std::find(ctx->parent->levels, ctx->parent->levels + ctx->parent->N, ctx));
1047db4a47b3SPierre Jolivet     PetscCall(PetscLogEventBegin(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
1048f1580f4eSBarry Smith   }
1049f1580f4eSBarry Smith   if (mu == 1) {
1050f1580f4eSBarry Smith     if (!ctx->ksp->vec_rhs) {
1051db4a47b3SPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ctx->ksp), 1, n, N, nullptr, &ctx->ksp->vec_rhs));
1052f1580f4eSBarry Smith       PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)ctx->ksp), n, N, &ctx->ksp->vec_sol));
1053f1580f4eSBarry Smith     }
1054f1580f4eSBarry Smith     PetscCall(VecPlaceArray(ctx->ksp->vec_rhs, rhs));
1055db4a47b3SPierre Jolivet     PetscCall(KSPSolve(ctx->ksp, nullptr, nullptr));
1056f1580f4eSBarry Smith     PetscCall(VecCopy(ctx->ksp->vec_sol, ctx->ksp->vec_rhs));
1057f1580f4eSBarry Smith     PetscCall(VecResetArray(ctx->ksp->vec_rhs));
1058f1580f4eSBarry Smith   } else {
1059f1580f4eSBarry Smith     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, rhs, &B));
1060db4a47b3SPierre Jolivet     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, nullptr, &X));
1061f1580f4eSBarry Smith     PetscCall(KSPMatSolve(ctx->ksp, B, X));
1062f1580f4eSBarry Smith     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
1063f1580f4eSBarry Smith     PetscCall(MatDestroy(&X));
1064f1580f4eSBarry Smith     PetscCall(MatDestroy(&B));
1065f1580f4eSBarry Smith   }
1066db4a47b3SPierre Jolivet   if (ctx->parent->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
10673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1068f1580f4eSBarry Smith }
1069f1580f4eSBarry Smith 
1070d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetUpNeumannOverlap_Private(PC pc)
1071d71ae5a4SJacob Faibussowitsch {
1072f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
1073f1580f4eSBarry Smith 
1074f1580f4eSBarry Smith   PetscFunctionBegin;
1075f1580f4eSBarry Smith   if (data->setup) {
1076f1580f4eSBarry Smith     Mat       P;
1077db4a47b3SPierre Jolivet     Vec       x, xt = nullptr;
1078f1580f4eSBarry Smith     PetscReal t = 0.0, s = 0.0;
1079f1580f4eSBarry Smith 
1080db4a47b3SPierre Jolivet     PetscCall(PCGetOperators(pc, nullptr, &P));
1081f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)P, "__SNES_latest_X", (PetscObject *)&x));
1082f1580f4eSBarry Smith     PetscCallBack("PCHPDDM Neumann callback", (*data->setup)(data->aux, t, x, xt, s, data->is, data->setup_ctx));
1083f1580f4eSBarry Smith   }
10843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1085f1580f4eSBarry Smith }
1086f1580f4eSBarry Smith 
1087d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCreateSubMatrices_Private(Mat mat, PetscInt n, const IS *, const IS *, MatReuse scall, Mat *submat[])
1088d71ae5a4SJacob Faibussowitsch {
1089f1580f4eSBarry Smith   Mat       A;
109013044ca3SPierre Jolivet   PetscBool flg;
1091f1580f4eSBarry Smith 
1092f1580f4eSBarry Smith   PetscFunctionBegin;
1093f1580f4eSBarry Smith   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatCreateSubMatrices() called to extract %" PetscInt_FMT " submatrices, which is different than 1", n);
1094f1580f4eSBarry Smith   /* previously composed Mat */
1095f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)mat, "_PCHPDDM_SubMatrices", (PetscObject *)&A));
1096f1580f4eSBarry Smith   PetscCheck(A, PETSC_COMM_SELF, PETSC_ERR_PLIB, "SubMatrices not found in Mat");
109713044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSCHURCOMPLEMENT, &flg)); /* MATSCHURCOMPLEMENT has neither a MatDuplicate() nor a MatCopy() implementation */
1098f1580f4eSBarry Smith   if (scall == MAT_INITIAL_MATRIX) {
10996f2c871aSStefano Zampini     PetscCall(PetscCalloc1(2, submat)); /* allocate an extra Mat to avoid errors in MatDestroySubMatrices_Dummy() */
110013044ca3SPierre Jolivet     if (!flg) PetscCall(MatDuplicate(A, MAT_COPY_VALUES, *submat));
110113044ca3SPierre Jolivet   } else if (!flg) PetscCall(MatCopy(A, (*submat)[0], SAME_NONZERO_PATTERN));
110213044ca3SPierre Jolivet   if (flg) {
1103bf583f0cSPierre Jolivet     PetscCall(MatDestroy(*submat)); /* previously created Mat has to be destroyed */
110413044ca3SPierre Jolivet     (*submat)[0] = A;
110513044ca3SPierre Jolivet     PetscCall(PetscObjectReference((PetscObject)A));
110613044ca3SPierre Jolivet   }
11073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1108f1580f4eSBarry Smith }
1109f1580f4eSBarry Smith 
1110d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCommunicationAvoidingPCASM_Private(PC pc, Mat C, PetscBool sorted)
1111d71ae5a4SJacob Faibussowitsch {
1112f1580f4eSBarry Smith   void (*op)(void);
1113f1580f4eSBarry Smith 
1114f1580f4eSBarry Smith   PetscFunctionBegin;
1115f1580f4eSBarry Smith   /* previously-composed Mat */
1116f1580f4eSBarry Smith   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", (PetscObject)C));
1117f1580f4eSBarry Smith   PetscCall(MatGetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, &op));
1118f1580f4eSBarry Smith   /* trick suggested by Barry https://lists.mcs.anl.gov/pipermail/petsc-dev/2020-January/025491.html */
1119f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, (void (*)(void))PCHPDDMCreateSubMatrices_Private));
1120f1580f4eSBarry Smith   if (sorted) PetscCall(PCASMSetSortIndices(pc, PETSC_FALSE)); /* everything is already sorted */
1121f1580f4eSBarry Smith   PetscCall(PCSetFromOptions(pc));                             /* otherwise -pc_hpddm_levels_1_pc_asm_sub_mat_type is not used */
1122f1580f4eSBarry Smith   PetscCall(PCSetUp(pc));
1123f1580f4eSBarry Smith   /* reset MatCreateSubMatrices() */
1124f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, op));
1125db4a47b3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", nullptr));
11263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1127f1580f4eSBarry Smith }
1128f1580f4eSBarry Smith 
1129d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMPermute_Private(IS is, IS in_is, IS *out_is, Mat in_C, Mat *out_C, IS *p)
1130d71ae5a4SJacob Faibussowitsch {
1131f1580f4eSBarry Smith   IS                           perm;
1132f1580f4eSBarry Smith   const PetscInt              *ptr;
1133811e8887SPierre Jolivet   PetscInt                    *concatenate, size, bs;
1134f1580f4eSBarry Smith   std::map<PetscInt, PetscInt> order;
1135f1580f4eSBarry Smith   PetscBool                    sorted;
1136f1580f4eSBarry Smith 
1137f1580f4eSBarry Smith   PetscFunctionBegin;
1138cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(is, IS_CLASSID, 1);
1139cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(in_C, MAT_CLASSID, 4);
1140f1580f4eSBarry Smith   PetscCall(ISSorted(is, &sorted));
1141f1580f4eSBarry Smith   if (!sorted) {
1142f1580f4eSBarry Smith     PetscCall(ISGetLocalSize(is, &size));
1143f1580f4eSBarry Smith     PetscCall(ISGetIndices(is, &ptr));
1144b07dfdedSPierre Jolivet     PetscCall(ISGetBlockSize(is, &bs));
1145f1580f4eSBarry Smith     /* MatCreateSubMatrices(), called by PCASM, follows the global numbering of Pmat */
1146811e8887SPierre Jolivet     for (PetscInt n = 0; n < size; n += bs) order.insert(std::make_pair(ptr[n] / bs, n / bs));
1147f1580f4eSBarry Smith     PetscCall(ISRestoreIndices(is, &ptr));
1148b07dfdedSPierre Jolivet     size /= bs;
1149f1580f4eSBarry Smith     if (out_C) {
1150f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1151f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.second;
1152f1580f4eSBarry Smith       concatenate -= size;
1153b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_C), bs, size, concatenate, PETSC_OWN_POINTER, &perm));
1154f1580f4eSBarry Smith       PetscCall(ISSetPermutation(perm));
1155f1580f4eSBarry Smith       /* permute user-provided Mat so that it matches with MatCreateSubMatrices() numbering */
1156f1580f4eSBarry Smith       PetscCall(MatPermute(in_C, perm, perm, out_C));
1157f1580f4eSBarry Smith       if (p) *p = perm;
1158f1580f4eSBarry Smith       else PetscCall(ISDestroy(&perm)); /* no need to save the permutation */
1159f1580f4eSBarry Smith     }
1160f1580f4eSBarry Smith     if (out_is) {
1161f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1162f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.first;
1163f1580f4eSBarry Smith       concatenate -= size;
1164f1580f4eSBarry Smith       /* permute user-provided IS so that it matches with MatCreateSubMatrices() numbering */
1165b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_is), bs, size, concatenate, PETSC_OWN_POINTER, out_is));
1166f1580f4eSBarry Smith     }
1167f1580f4eSBarry Smith   } else { /* input IS is sorted, nothing to permute, simply duplicate inputs when needed */
1168f1580f4eSBarry Smith     if (out_C) PetscCall(MatDuplicate(in_C, MAT_COPY_VALUES, out_C));
1169f1580f4eSBarry Smith     if (out_is) PetscCall(ISDuplicate(in_is, out_is));
1170f1580f4eSBarry Smith   }
11713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1172f1580f4eSBarry Smith }
1173f1580f4eSBarry Smith 
11745e642048SPierre Jolivet static PetscErrorCode PCHPDDMCheckSymmetry_Private(PC pc, Mat A01, Mat A10)
117513044ca3SPierre Jolivet {
117613044ca3SPierre Jolivet   Mat       T, U = nullptr, B = nullptr;
117713044ca3SPierre Jolivet   IS        z;
117813044ca3SPierre Jolivet   PetscBool flg[2];
117913044ca3SPierre Jolivet 
118013044ca3SPierre Jolivet   PetscFunctionBegin;
118113044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, flg));
1182811e8887SPierre Jolivet   if (flg[0]) {
1183811e8887SPierre Jolivet     PetscCall(MatShellGetScalingShifts(A10, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
1184811e8887SPierre Jolivet     PetscCall(MatTransposeGetMat(A10, &U));
1185811e8887SPierre Jolivet   } else {
118613044ca3SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, flg + 1));
1187811e8887SPierre Jolivet     if (flg[1]) {
1188811e8887SPierre Jolivet       PetscCall(MatShellGetScalingShifts(A10, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
1189811e8887SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A10, &U));
1190811e8887SPierre Jolivet     }
119113044ca3SPierre Jolivet   }
119213044ca3SPierre Jolivet   if (U) PetscCall(MatDuplicate(U, MAT_COPY_VALUES, &T));
119313044ca3SPierre Jolivet   else PetscCall(MatHermitianTranspose(A10, MAT_INITIAL_MATRIX, &T));
119413044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATTRANSPOSEVIRTUAL, flg));
119513044ca3SPierre Jolivet   if (flg[0]) {
1196811e8887SPierre Jolivet     PetscCall(MatShellGetScalingShifts(A01, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
119713044ca3SPierre Jolivet     PetscCall(MatTransposeGetMat(A01, &A01));
119813044ca3SPierre Jolivet     PetscCall(MatTranspose(A01, MAT_INITIAL_MATRIX, &B));
119913044ca3SPierre Jolivet     A01 = B;
120013044ca3SPierre Jolivet   } else {
120113044ca3SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATHERMITIANTRANSPOSEVIRTUAL, flg));
120213044ca3SPierre Jolivet     if (flg[0]) {
1203811e8887SPierre Jolivet       PetscCall(MatShellGetScalingShifts(A01, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
120413044ca3SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A01, &A01));
120513044ca3SPierre Jolivet       PetscCall(MatHermitianTranspose(A01, MAT_INITIAL_MATRIX, &B));
120613044ca3SPierre Jolivet       A01 = B;
120713044ca3SPierre Jolivet     }
120813044ca3SPierre Jolivet   }
120913044ca3SPierre Jolivet   PetscCall(PetscLayoutCompare(T->rmap, A01->rmap, flg));
121013044ca3SPierre Jolivet   if (flg[0]) {
121113044ca3SPierre Jolivet     PetscCall(PetscLayoutCompare(T->cmap, A01->cmap, flg));
121213044ca3SPierre Jolivet     if (flg[0]) {
121313044ca3SPierre Jolivet       PetscCall(MatFindZeroRows(A01, &z)); /* for essential boundary conditions, some implementations will */
121413044ca3SPierre Jolivet       if (z) {                             /*  zero rows in [P00 A01] except for the diagonal of P00       */
121513044ca3SPierre Jolivet         PetscCall(MatSetOption(T, MAT_NO_OFF_PROC_ZERO_ROWS, PETSC_TRUE));
121613044ca3SPierre Jolivet         PetscCall(MatZeroRowsIS(T, z, 0.0, nullptr, nullptr)); /* corresponding zero rows from A01 */
121713044ca3SPierre Jolivet         PetscCall(ISDestroy(&z));
121813044ca3SPierre Jolivet       }
121913044ca3SPierre Jolivet       PetscCall(MatMultEqual(A01, T, 20, flg));
122013044ca3SPierre Jolivet       PetscCheck(flg[0], PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "A01 != A10^T");
122113044ca3SPierre Jolivet     } else PetscCall(PetscInfo(pc, "A01 and A10^T have non-congruent column layouts, cannot test for equality\n"));
122213044ca3SPierre Jolivet   }
122313044ca3SPierre Jolivet   PetscCall(MatDestroy(&B));
122413044ca3SPierre Jolivet   PetscCall(MatDestroy(&T));
122513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
122613044ca3SPierre Jolivet }
122713044ca3SPierre Jolivet 
1228d16c0b94SPierre Jolivet static PetscErrorCode PCHPDDMCheckInclusion_Private(PC pc, IS is, IS is_local, PetscBool check)
1229d16c0b94SPierre Jolivet {
1230d16c0b94SPierre Jolivet   IS          intersect;
1231d16c0b94SPierre Jolivet   const char *str = "IS of the auxiliary Mat does not include all local rows of A";
1232d16c0b94SPierre Jolivet   PetscBool   equal;
1233d16c0b94SPierre Jolivet 
1234d16c0b94SPierre Jolivet   PetscFunctionBegin;
1235d16c0b94SPierre Jolivet   PetscCall(ISIntersect(is, is_local, &intersect));
1236d16c0b94SPierre Jolivet   PetscCall(ISEqualUnsorted(is_local, intersect, &equal));
1237d16c0b94SPierre Jolivet   PetscCall(ISDestroy(&intersect));
1238d16c0b94SPierre Jolivet   if (check) PetscCheck(equal, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "%s", str);
1239d16c0b94SPierre Jolivet   else if (!equal) PetscCall(PetscInfo(pc, "%s\n", str));
1240d16c0b94SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1241d16c0b94SPierre Jolivet }
1242d16c0b94SPierre Jolivet 
1243d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMDestroySubMatrices_Private(PetscBool flg, PetscBool algebraic, Mat *sub)
1244d71ae5a4SJacob Faibussowitsch {
1245f1580f4eSBarry Smith   IS is;
1246f1580f4eSBarry Smith 
1247f1580f4eSBarry Smith   PetscFunctionBegin;
1248f1580f4eSBarry Smith   if (!flg) {
1249f1580f4eSBarry Smith     if (algebraic) {
1250f1580f4eSBarry Smith       PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Embed", (PetscObject *)&is));
1251f1580f4eSBarry Smith       PetscCall(ISDestroy(&is));
1252db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Embed", nullptr));
1253db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Compact", nullptr));
1254f1580f4eSBarry Smith     }
1255f1580f4eSBarry Smith     PetscCall(MatDestroySubMatrices(algebraic ? 2 : 1, &sub));
1256f1580f4eSBarry Smith   }
12573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1258f1580f4eSBarry Smith }
1259f1580f4eSBarry Smith 
1260d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMAlgebraicAuxiliaryMat_Private(Mat P, IS *is, Mat *sub[], PetscBool block)
1261d71ae5a4SJacob Faibussowitsch {
1262f1580f4eSBarry Smith   IS         icol[3], irow[2];
1263f1580f4eSBarry Smith   Mat       *M, Q;
1264f1580f4eSBarry Smith   PetscReal *ptr;
1265811e8887SPierre Jolivet   PetscInt  *idx, p = 0, bs = PetscAbs(P->cmap->bs);
1266f1580f4eSBarry Smith   PetscBool  flg;
1267f1580f4eSBarry Smith 
1268f1580f4eSBarry Smith   PetscFunctionBegin;
1269f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, P->cmap->N, 0, 1, icol + 2));
1270f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(icol[2], bs));
1271f1580f4eSBarry Smith   PetscCall(ISSetIdentity(icol[2]));
1272f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1273f1580f4eSBarry Smith   if (flg) {
1274f1580f4eSBarry Smith     /* MatCreateSubMatrices() does not handle MATMPISBAIJ properly when iscol != isrow, so convert first to MATMPIBAIJ */
1275f1580f4eSBarry Smith     PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &Q));
1276f1580f4eSBarry Smith     std::swap(P, Q);
1277f1580f4eSBarry Smith   }
1278f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(P, 1, is, icol + 2, MAT_INITIAL_MATRIX, &M));
1279f1580f4eSBarry Smith   if (flg) {
1280f1580f4eSBarry Smith     std::swap(P, Q);
1281f1580f4eSBarry Smith     PetscCall(MatDestroy(&Q));
1282f1580f4eSBarry Smith   }
1283f1580f4eSBarry Smith   PetscCall(ISDestroy(icol + 2));
1284f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, M[0]->rmap->N, 0, 1, irow));
1285f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(irow[0], bs));
1286f1580f4eSBarry Smith   PetscCall(ISSetIdentity(irow[0]));
1287f1580f4eSBarry Smith   if (!block) {
1288b07dfdedSPierre Jolivet     PetscCall(PetscMalloc2(P->cmap->N, &ptr, P->cmap->N / bs, &idx));
1289f1580f4eSBarry Smith     PetscCall(MatGetColumnNorms(M[0], NORM_INFINITY, ptr));
1290f1580f4eSBarry Smith     /* check for nonzero columns so that M[0] may be expressed in compact form */
1291811e8887SPierre Jolivet     for (PetscInt n = 0; n < P->cmap->N; n += bs) {
1292b07dfdedSPierre Jolivet       if (std::find_if(ptr + n, ptr + n + bs, [](PetscReal v) { return v > PETSC_MACHINE_EPSILON; }) != ptr + n + bs) idx[p++] = n / bs;
1293f1580f4eSBarry Smith     }
1294b07dfdedSPierre Jolivet     PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, p, idx, PETSC_USE_POINTER, icol + 1));
1295f1580f4eSBarry Smith     PetscCall(ISSetInfo(icol[1], IS_SORTED, IS_GLOBAL, PETSC_TRUE, PETSC_TRUE));
1296f1580f4eSBarry Smith     PetscCall(ISEmbed(*is, icol[1], PETSC_FALSE, icol + 2));
1297f1580f4eSBarry Smith     irow[1] = irow[0];
1298f1580f4eSBarry Smith     /* first Mat will be used in PCASM (if it is used as a PC on this level) and as the left-hand side of GenEO */
1299f1580f4eSBarry Smith     icol[0] = is[0];
1300f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 2, irow, icol, MAT_INITIAL_MATRIX, sub));
1301f1580f4eSBarry Smith     PetscCall(ISDestroy(icol + 1));
1302f1580f4eSBarry Smith     PetscCall(PetscFree2(ptr, idx));
1303f1580f4eSBarry Smith     /* IS used to go back and forth between the augmented and the original local linear system, see eq. (3.4) of [2022b] */
1304f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Embed", (PetscObject)icol[2]));
1305f1580f4eSBarry Smith     /* Mat used in eq. (3.1) of [2022b] */
1306f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Compact", (PetscObject)(*sub)[1]));
1307f1580f4eSBarry Smith   } else {
1308f1580f4eSBarry Smith     Mat aux;
1309811e8887SPierre Jolivet 
1310f1580f4eSBarry Smith     PetscCall(MatSetOption(M[0], MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1311f1580f4eSBarry Smith     /* diagonal block of the overlapping rows */
1312f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 1, irow, is, MAT_INITIAL_MATRIX, sub));
1313f1580f4eSBarry Smith     PetscCall(MatDuplicate((*sub)[0], MAT_COPY_VALUES, &aux));
1314f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1315f1580f4eSBarry Smith     if (bs == 1) { /* scalar case */
1316f1580f4eSBarry Smith       Vec sum[2];
1317811e8887SPierre Jolivet 
1318f1580f4eSBarry Smith       PetscCall(MatCreateVecs(aux, sum, sum + 1));
1319f1580f4eSBarry Smith       PetscCall(MatGetRowSum(M[0], sum[0]));
1320f1580f4eSBarry Smith       PetscCall(MatGetRowSum(aux, sum[1]));
1321f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1322f1580f4eSBarry Smith       PetscCall(VecAXPY(sum[0], -1.0, sum[1]));
1323f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1324f1580f4eSBarry Smith       PetscCall(MatDiagonalSet(aux, sum[0], ADD_VALUES));
1325f1580f4eSBarry Smith       PetscCall(VecDestroy(sum));
1326f1580f4eSBarry Smith       PetscCall(VecDestroy(sum + 1));
1327f1580f4eSBarry Smith     } else { /* vectorial case */
1328f1580f4eSBarry Smith       /* TODO: missing MatGetValuesBlocked(), so the code below is     */
1329f1580f4eSBarry Smith       /* an extension of the scalar case for when bs > 1, but it could */
1330f1580f4eSBarry Smith       /* be more efficient by avoiding all these MatMatMult()          */
1331f1580f4eSBarry Smith       Mat          sum[2], ones;
1332f1580f4eSBarry Smith       PetscScalar *ptr;
1333811e8887SPierre Jolivet 
1334f1580f4eSBarry Smith       PetscCall(PetscCalloc1(M[0]->cmap->n * bs, &ptr));
1335f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, M[0]->cmap->n, bs, M[0]->cmap->n, bs, ptr, &ones));
1336811e8887SPierre Jolivet       for (PetscInt n = 0; n < M[0]->cmap->n; n += bs) {
1337f1580f4eSBarry Smith         for (p = 0; p < bs; ++p) ptr[n + p * (M[0]->cmap->n + 1)] = 1.0;
1338f1580f4eSBarry Smith       }
1339fb842aefSJose E. Roman       PetscCall(MatMatMult(M[0], ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum));
1340f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1341f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, aux->cmap->n, bs, aux->cmap->n, bs, ptr, &ones));
1342f1580f4eSBarry Smith       PetscCall(MatDenseSetLDA(ones, M[0]->cmap->n));
1343fb842aefSJose E. Roman       PetscCall(MatMatMult(aux, ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum + 1));
1344f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1345f1580f4eSBarry Smith       PetscCall(PetscFree(ptr));
1346f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1347f1580f4eSBarry Smith       PetscCall(MatAXPY(sum[0], -1.0, sum[1], SAME_NONZERO_PATTERN));
1348f1580f4eSBarry Smith       PetscCall(MatDestroy(sum + 1));
1349f1580f4eSBarry Smith       /* re-order values to be consistent with MatSetValuesBlocked()           */
1350f1580f4eSBarry Smith       /* equivalent to MatTranspose() which does not truly handle              */
1351f1580f4eSBarry Smith       /* MAT_INPLACE_MATRIX in the rectangular case, as it calls PetscMalloc() */
1352f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(sum[0], &ptr));
1353f1580f4eSBarry Smith       HPDDM::Wrapper<PetscScalar>::imatcopy<'T'>(bs, sum[0]->rmap->n, ptr, sum[0]->rmap->n, bs);
1354f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1355811e8887SPierre Jolivet       for (PetscInt n = 0; n < aux->cmap->n / bs; ++n) PetscCall(MatSetValuesBlocked(aux, 1, &n, 1, &n, ptr + n * bs * bs, ADD_VALUES));
1356f1580f4eSBarry Smith       PetscCall(MatAssemblyBegin(aux, MAT_FINAL_ASSEMBLY));
1357f1580f4eSBarry Smith       PetscCall(MatAssemblyEnd(aux, MAT_FINAL_ASSEMBLY));
1358f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(sum[0], &ptr));
1359f1580f4eSBarry Smith       PetscCall(MatDestroy(sum));
1360f1580f4eSBarry Smith     }
1361f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
1362f1580f4eSBarry Smith     /* left-hand side of GenEO, with the same sparsity pattern as PCASM subdomain solvers  */
1363f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Neumann_Mat", (PetscObject)aux));
1364f1580f4eSBarry Smith   }
1365f1580f4eSBarry Smith   PetscCall(ISDestroy(irow));
1366f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &M));
13673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1368f1580f4eSBarry Smith }
1369f1580f4eSBarry Smith 
137013044ca3SPierre Jolivet static PetscErrorCode PCApply_Nest(PC pc, Vec x, Vec y)
137113044ca3SPierre Jolivet {
137213044ca3SPierre Jolivet   Mat                    A;
137313044ca3SPierre Jolivet   MatSolverType          type;
137413044ca3SPierre Jolivet   IS                     is[2];
137513044ca3SPierre Jolivet   PetscBool              flg;
137613044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
137713044ca3SPierre Jolivet 
137813044ca3SPierre Jolivet   PetscFunctionBegin;
137913044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
138013044ca3SPierre Jolivet   PetscCall(PCGetOperators(p->first, &A, nullptr));
138113044ca3SPierre Jolivet   PetscCall(MatNestGetISs(A, is, nullptr));
138213044ca3SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(p->first, &type));
138313044ca3SPierre Jolivet   PetscCall(PCFactorGetMatrix(p->first, &A));
138413044ca3SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
138524ddd604SPierre Jolivet   if (flg && A->schur) {
138613044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
138713044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 1)); /* reduction/condensation phase followed by Schur complement solve */
138813044ca3SPierre Jolivet #endif
138913044ca3SPierre Jolivet   }
139013044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[0], is[1], SCATTER_FORWARD, x)); /* assign the RHS associated to the Schur complement */
139113044ca3SPierre Jolivet   PetscCall(PCApply(p->first, p->second[0], p->second[1]));
139213044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[1], is[1], SCATTER_REVERSE, y)); /* retrieve the partial solution associated to the Schur complement */
139313044ca3SPierre Jolivet   if (flg) {
139413044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
139513044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1)); /* default ICNTL(26) value in PETSc */
139613044ca3SPierre Jolivet #endif
139713044ca3SPierre Jolivet   }
139813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
139913044ca3SPierre Jolivet }
140013044ca3SPierre Jolivet 
140113044ca3SPierre Jolivet static PetscErrorCode PCView_Nest(PC pc, PetscViewer viewer)
140213044ca3SPierre Jolivet {
140313044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
140413044ca3SPierre Jolivet 
140513044ca3SPierre Jolivet   PetscFunctionBegin;
140613044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
140713044ca3SPierre Jolivet   PetscCall(PCView(p->first, viewer));
140813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
140913044ca3SPierre Jolivet }
141013044ca3SPierre Jolivet 
141113044ca3SPierre Jolivet static PetscErrorCode PCDestroy_Nest(PC pc)
141213044ca3SPierre Jolivet {
141313044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
141413044ca3SPierre Jolivet 
141513044ca3SPierre Jolivet   PetscFunctionBegin;
141613044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
141713044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second));
141813044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second + 1));
141913044ca3SPierre Jolivet   PetscCall(PCDestroy(&p->first));
142013044ca3SPierre Jolivet   PetscCall(PetscFree(p));
142113044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
142213044ca3SPierre Jolivet }
142313044ca3SPierre Jolivet 
142413044ca3SPierre Jolivet template <bool T = false>
142513044ca3SPierre Jolivet static PetscErrorCode MatMult_Schur(Mat A, Vec x, Vec y)
142613044ca3SPierre Jolivet {
142701e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
142813044ca3SPierre Jolivet 
142913044ca3SPierre Jolivet   PetscFunctionBegin;
143013044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
143113044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD)); /* local Vec with overlap */
143213044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD));
143313044ca3SPierre Jolivet   if (!T) PetscCall(MatMult(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1])); /* local Schur complement */
143413044ca3SPierre Jolivet   else PetscCall(MatMultTranspose(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1]));
143513044ca3SPierre Jolivet   PetscCall(VecSet(y, 0.0));
143613044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE)); /* global Vec with summed up contributions on the overlap */
143713044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE));
143813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
143913044ca3SPierre Jolivet }
144013044ca3SPierre Jolivet 
144113044ca3SPierre Jolivet static PetscErrorCode MatDestroy_Schur(Mat A)
144213044ca3SPierre Jolivet {
144301e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
144413044ca3SPierre Jolivet 
144513044ca3SPierre Jolivet   PetscFunctionBegin;
144613044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
144713044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx)));
144813044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx) + 1));
144913044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
145013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
145113044ca3SPierre Jolivet }
145213044ca3SPierre Jolivet 
145313044ca3SPierre Jolivet static PetscErrorCode MatMult_SchurCorrection(Mat A, Vec x, Vec y)
145413044ca3SPierre Jolivet {
145513044ca3SPierre Jolivet   PC                                         pc;
145613044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
145713044ca3SPierre Jolivet 
145813044ca3SPierre Jolivet   PetscFunctionBegin;
145913044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
146013044ca3SPierre Jolivet   pc = ((PC_HPDDM *)std::get<0>(*ctx)[0]->data)->levels[0]->ksp->pc;
146113044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {             /* Q_0 is the coarse correction associated to the A00 block from PCFIELDSPLIT */
146213044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], x, std::get<3>(*ctx)[1]));                    /*     A_01 x                 */
146313044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 x             */
146413044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[1], std::get<3>(*ctx)[1], std::get<3>(*ctx)[0])); /*     A_10 Q_0 A_01 x        */
146513044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], std::get<3>(*ctx)[0], y));                    /* y = M_S^-1 A_10 Q_0 A_01 x */
146613044ca3SPierre Jolivet   } else {
146713044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[0]));                    /*     M_S^-1 x               */
146813044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], std::get<3>(*ctx)[0], std::get<3>(*ctx)[1])); /*     A_01 M_S^-1 x          */
146913044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 M_S^-1 x      */
147013044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[1], std::get<3>(*ctx)[1], y));                    /* y = A_10 Q_0 A_01 M_S^-1 x */
147113044ca3SPierre Jolivet   }
147213044ca3SPierre Jolivet   PetscCall(VecAXPY(y, -1.0, x)); /* y -= x, preconditioned eq. (24) of https://hal.science/hal-02343808v6/document (with a sign flip) */
147313044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
147413044ca3SPierre Jolivet }
147513044ca3SPierre Jolivet 
147613044ca3SPierre Jolivet static PetscErrorCode MatView_SchurCorrection(Mat A, PetscViewer viewer)
147713044ca3SPierre Jolivet {
147813044ca3SPierre Jolivet   PetscBool                                  ascii;
147913044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
148013044ca3SPierre Jolivet 
148113044ca3SPierre Jolivet   PetscFunctionBegin;
148213044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &ascii));
148313044ca3SPierre Jolivet   if (ascii) {
148413044ca3SPierre Jolivet     PetscCall(MatShellGetContext(A, &ctx));
148513044ca3SPierre Jolivet     PetscCall(PetscViewerASCIIPrintf(viewer, "action of %s\n", std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT ? "(I - M_S^-1 A_10 Q_0 A_01)" : "(I - A_10 Q_0 A_01 M_S^-1)"));
148613044ca3SPierre Jolivet     PetscCall(PCView(std::get<0>(*ctx)[1], viewer)); /* no need to PCView(Q_0) since it will be done by PCFIELDSPLIT */
148713044ca3SPierre Jolivet   }
148813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
148913044ca3SPierre Jolivet }
149013044ca3SPierre Jolivet 
149113044ca3SPierre Jolivet static PetscErrorCode MatDestroy_SchurCorrection(Mat A)
149213044ca3SPierre Jolivet {
149313044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
149413044ca3SPierre Jolivet 
149513044ca3SPierre Jolivet   PetscFunctionBegin;
149613044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
149713044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx)));
149813044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 1));
149913044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 2));
150013044ca3SPierre Jolivet   PetscCall(PCDestroy(std::get<0>(*ctx) + 1));
150113044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
150213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
150313044ca3SPierre Jolivet }
150413044ca3SPierre Jolivet 
1505*feebddf4SPierre Jolivet static PetscErrorCode PCPostSolve_SchurPreLeastSquares(PC, KSP, Vec, Vec x)
1506*feebddf4SPierre Jolivet {
1507*feebddf4SPierre Jolivet   PetscFunctionBegin;
1508*feebddf4SPierre Jolivet   PetscCall(VecScale(x, -1.0));
1509*feebddf4SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1510*feebddf4SPierre Jolivet }
1511*feebddf4SPierre Jolivet 
151213044ca3SPierre Jolivet static PetscErrorCode KSPPreSolve_SchurCorrection(KSP, Vec b, Vec, void *context)
151313044ca3SPierre Jolivet {
151413044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
151513044ca3SPierre Jolivet 
1516a6b3e571SPierre Jolivet   PetscFunctionBegin;
151713044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
151813044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], b, std::get<3>(*ctx)[2]));
151913044ca3SPierre Jolivet     std::swap(*b, *std::get<3>(*ctx)[2]); /* replace b by M^-1 b, but need to keep a copy of the original RHS, so swap it with the work Vec */
152013044ca3SPierre Jolivet   }
152113044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
152213044ca3SPierre Jolivet }
152313044ca3SPierre Jolivet 
152413044ca3SPierre Jolivet static PetscErrorCode KSPPostSolve_SchurCorrection(KSP, Vec b, Vec x, void *context)
152513044ca3SPierre Jolivet {
152613044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
152713044ca3SPierre Jolivet 
1528a6b3e571SPierre Jolivet   PetscFunctionBegin;
152913044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) std::swap(*b, *std::get<3>(*ctx)[2]); /* put back the original RHS where it belongs */
153013044ca3SPierre Jolivet   else {
153113044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[2]));
153213044ca3SPierre Jolivet     PetscCall(VecCopy(std::get<3>(*ctx)[2], x)); /* replace x by M^-1 x */
153313044ca3SPierre Jolivet   }
153413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
153513044ca3SPierre Jolivet }
153613044ca3SPierre Jolivet 
15379bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat, Vec, Vec);
15389bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat, Vec, Vec);
15399bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat, Mat, Mat, void *);
15409bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat);
15419bb5c669SPierre Jolivet 
1542d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDM(PC pc)
1543d71ae5a4SJacob Faibussowitsch {
1544f1580f4eSBarry Smith   PC_HPDDM                                  *data = (PC_HPDDM *)pc->data;
1545f1580f4eSBarry Smith   PC                                         inner;
1546f1580f4eSBarry Smith   KSP                                       *ksp;
154713044ca3SPierre Jolivet   Mat                                       *sub, A, P, N, C = nullptr, uaux = nullptr, weighted, subA[2], S;
1548f1580f4eSBarry Smith   Vec                                        xin, v;
1549f1580f4eSBarry Smith   std::vector<Vec>                           initial;
1550db4a47b3SPierre Jolivet   IS                                         is[1], loc, uis = data->is, unsorted = nullptr;
1551f1580f4eSBarry Smith   ISLocalToGlobalMapping                     l2g;
1552f1580f4eSBarry Smith   char                                       prefix[256];
1553f1580f4eSBarry Smith   const char                                *pcpre;
1554f1580f4eSBarry Smith   const PetscScalar *const                  *ev;
15559bb5c669SPierre Jolivet   PetscInt                                   n, requested = data->N, reused = 0, overlap = -1;
1556f1580f4eSBarry Smith   MatStructure                               structure  = UNKNOWN_NONZERO_PATTERN;
1557f1580f4eSBarry Smith   PetscBool                                  subdomains = PETSC_FALSE, flg = PETSC_FALSE, ismatis, swap = PETSC_FALSE, algebraic = PETSC_FALSE, block = PETSC_FALSE;
1558f1580f4eSBarry Smith   DM                                         dm;
155913044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = nullptr;
1560398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1561db4a47b3SPierre Jolivet   IS  dis  = nullptr;
1562db4a47b3SPierre Jolivet   Mat daux = nullptr;
1563398c7888SPierre Jolivet #endif
1564f1580f4eSBarry Smith 
1565f1580f4eSBarry Smith   PetscFunctionBegin;
1566f1580f4eSBarry Smith   PetscCheck(data->levels && data->levels[0], PETSC_COMM_SELF, PETSC_ERR_PLIB, "Not a single level allocated");
1567f1580f4eSBarry Smith   PetscCall(PCGetOptionsPrefix(pc, &pcpre));
1568f1580f4eSBarry Smith   PetscCall(PCGetOperators(pc, &A, &P));
1569f1580f4eSBarry Smith   if (!data->levels[0]->ksp) {
1570f1580f4eSBarry Smith     PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->ksp));
15713821be0aSBarry Smith     PetscCall(KSPSetNestLevel(data->levels[0]->ksp, pc->kspnestlevel));
1572f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_%s_", pcpre ? pcpre : "", data->N > 1 ? "levels_1" : "coarse"));
1573f1580f4eSBarry Smith     PetscCall(KSPSetOptionsPrefix(data->levels[0]->ksp, prefix));
1574f1580f4eSBarry Smith     PetscCall(KSPSetType(data->levels[0]->ksp, KSPPREONLY));
1575f1580f4eSBarry Smith   } else if (data->levels[0]->ksp->pc && data->levels[0]->ksp->pc->setupcalled == 1 && data->levels[0]->ksp->pc->reusepreconditioner) {
1576f1580f4eSBarry Smith     /* if the fine-level PCSHELL exists, its setup has succeeded, and one wants to reuse it, */
1577f1580f4eSBarry Smith     /* then just propagate the appropriate flag to the coarser levels                        */
1578f1580f4eSBarry Smith     for (n = 0; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1579f1580f4eSBarry Smith       /* the following KSP and PC may be NULL for some processes, hence the check            */
1580f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetReusePreconditioner(data->levels[n]->ksp, PETSC_TRUE));
1581f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
1582f1580f4eSBarry Smith     }
1583f1580f4eSBarry Smith     /* early bail out because there is nothing to do */
15843ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1585f1580f4eSBarry Smith   } else {
1586f1580f4eSBarry Smith     /* reset coarser levels */
1587f1580f4eSBarry Smith     for (n = 1; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1588f1580f4eSBarry Smith       if (data->levels[n]->ksp && data->levels[n]->ksp->pc && data->levels[n]->ksp->pc->setupcalled == 1 && data->levels[n]->ksp->pc->reusepreconditioner && n < data->N) {
1589f1580f4eSBarry Smith         reused = data->N - n;
1590f1580f4eSBarry Smith         break;
1591f1580f4eSBarry Smith       }
1592f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[n]->ksp));
1593f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[n]->pc));
1594f1580f4eSBarry Smith     }
1595f1580f4eSBarry Smith     /* check if some coarser levels are being reused */
1596462c564dSBarry Smith     PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &reused, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)pc)));
1597f1580f4eSBarry Smith     const int *addr = data->levels[0]->P ? data->levels[0]->P->getAddrLocal() : &HPDDM::i__0;
1598f1580f4eSBarry Smith 
1599f1580f4eSBarry Smith     if (addr != &HPDDM::i__0 && reused != data->N - 1) {
1600f1580f4eSBarry Smith       /* reuse previously computed eigenvectors */
1601f1580f4eSBarry Smith       ev = data->levels[0]->P->getVectors();
1602f1580f4eSBarry Smith       if (ev) {
1603f1580f4eSBarry Smith         initial.reserve(*addr);
1604f1580f4eSBarry Smith         PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, data->levels[0]->P->getDof(), ev[0], &xin));
1605f1580f4eSBarry Smith         for (n = 0; n < *addr; ++n) {
1606f1580f4eSBarry Smith           PetscCall(VecDuplicate(xin, &v));
1607f1580f4eSBarry Smith           PetscCall(VecPlaceArray(xin, ev[n]));
1608f1580f4eSBarry Smith           PetscCall(VecCopy(xin, v));
1609f1580f4eSBarry Smith           initial.emplace_back(v);
1610f1580f4eSBarry Smith           PetscCall(VecResetArray(xin));
1611f1580f4eSBarry Smith         }
1612f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
1613f1580f4eSBarry Smith       }
1614f1580f4eSBarry Smith     }
1615f1580f4eSBarry Smith   }
1616f1580f4eSBarry Smith   data->N -= reused;
1617f1580f4eSBarry Smith   PetscCall(KSPSetOperators(data->levels[0]->ksp, A, P));
1618f1580f4eSBarry Smith 
1619f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATIS, &ismatis));
1620f1580f4eSBarry Smith   if (!data->is && !ismatis) {
1621db4a47b3SPierre Jolivet     PetscErrorCode (*create)(DM, IS *, Mat *, PetscErrorCode (**)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void **) = nullptr;
1622db4a47b3SPierre Jolivet     PetscErrorCode (*usetup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *)                                                = nullptr;
1623db4a47b3SPierre Jolivet     void *uctx                                                                                                               = nullptr;
1624f1580f4eSBarry Smith 
1625f1580f4eSBarry Smith     /* first see if we can get the data from the DM */
1626f1580f4eSBarry Smith     PetscCall(MatGetDM(P, &dm));
1627f1580f4eSBarry Smith     if (!dm) PetscCall(MatGetDM(A, &dm));
1628f1580f4eSBarry Smith     if (!dm) PetscCall(PCGetDM(pc, &dm));
1629907a3e9cSStefano Zampini     if (dm) { /* this is the hook for DMPLEX for which the auxiliary Mat is the local Neumann matrix */
1630f1580f4eSBarry Smith       PetscCall(PetscObjectQueryFunction((PetscObject)dm, "DMCreateNeumannOverlap_C", &create));
1631f1580f4eSBarry Smith       if (create) {
1632f1580f4eSBarry Smith         PetscCall((*create)(dm, &uis, &uaux, &usetup, &uctx));
1633c8ea6600SPierre Jolivet         if (data->Neumann == PETSC_BOOL3_UNKNOWN) data->Neumann = PETSC_BOOL3_TRUE; /* set the value only if it was not already provided by the user */
1634f1580f4eSBarry Smith       }
1635f1580f4eSBarry Smith     }
1636f1580f4eSBarry Smith     if (!create) {
1637f1580f4eSBarry Smith       if (!uis) {
1638f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1639f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1640f1580f4eSBarry Smith       }
1641f1580f4eSBarry Smith       if (!uaux) {
1642f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1643f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1644f1580f4eSBarry Smith       }
1645f1580f4eSBarry Smith       /* look inside the Pmat instead of the PC, needed for MatSchurComplementComputeExplicitOperator() */
1646f1580f4eSBarry Smith       if (!uis) {
1647f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1648f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1649f1580f4eSBarry Smith       }
1650f1580f4eSBarry Smith       if (!uaux) {
1651f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1652f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1653f1580f4eSBarry Smith       }
1654f1580f4eSBarry Smith     }
1655f1580f4eSBarry Smith     PetscCall(PCHPDDMSetAuxiliaryMat(pc, uis, uaux, usetup, uctx));
1656f1580f4eSBarry Smith     PetscCall(MatDestroy(&uaux));
1657f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
1658f1580f4eSBarry Smith   }
1659f1580f4eSBarry Smith 
1660f1580f4eSBarry Smith   if (!ismatis) {
1661f1580f4eSBarry Smith     PetscCall(PCHPDDMSetUpNeumannOverlap_Private(pc));
1662db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_block_splitting", &block, nullptr));
16639bb5c669SPierre Jolivet     PetscCall(PetscOptionsGetInt(nullptr, pcpre, "-pc_hpddm_harmonic_overlap", &overlap, nullptr));
16645e642048SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
16655e642048SPierre Jolivet     if (data->is || (data->N > 1 && flg)) {
16669bb5c669SPierre Jolivet       if (block || overlap != -1) {
166702800ff6SPierre Jolivet         PetscCall(ISDestroy(&data->is));
166802800ff6SPierre Jolivet         PetscCall(MatDestroy(&data->aux));
16695e642048SPierre Jolivet       } else if (data->N > 1 && flg) {
167013044ca3SPierre Jolivet         PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_GENEO;
167113044ca3SPierre Jolivet 
167213044ca3SPierre Jolivet         PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
167313044ca3SPierre Jolivet         if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
167413044ca3SPierre Jolivet           PetscCall(ISDestroy(&data->is)); /* destroy any previously user-set objects since they will be set automatically */
167513044ca3SPierre Jolivet           PetscCall(MatDestroy(&data->aux));
167613044ca3SPierre Jolivet         } else if (type == PC_HPDDM_SCHUR_PRE_GENEO) {
167713044ca3SPierre Jolivet           PetscContainer container = nullptr;
167813044ca3SPierre Jolivet 
167913044ca3SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Schur", (PetscObject *)&container));
168013044ca3SPierre Jolivet           if (!container) { /* first call to PCSetUp() on the PC associated to the Schur complement */
168113044ca3SPierre Jolivet             PC_HPDDM *data_00;
168213044ca3SPierre Jolivet             KSP       ksp, inner_ksp;
168313044ca3SPierre Jolivet             PC        pc_00;
1684cf67ef9dSPierre Jolivet             Mat       A11 = nullptr;
1685cf67ef9dSPierre Jolivet             Vec       d   = nullptr;
168613044ca3SPierre Jolivet             char     *prefix;
168713044ca3SPierre Jolivet 
168813044ca3SPierre Jolivet             PetscCall(MatSchurComplementGetKSP(P, &ksp));
168913044ca3SPierre Jolivet             PetscCall(KSPGetPC(ksp, &pc_00));
169013044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)pc_00, PCHPDDM, &flg));
1691fd310a01SPierre Jolivet             PetscCheck(flg, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition %s and -%spc_type %s (!= %s)", pcpre ? pcpre : "", PCHPDDMSchurPreTypes[type], ((PetscObject)pc_00)->prefix ? ((PetscObject)pc_00)->prefix : "",
169213044ca3SPierre Jolivet                        ((PetscObject)pc_00)->type_name, PCHPDDM);
169313044ca3SPierre Jolivet             data_00 = (PC_HPDDM *)pc_00->data;
1694fd310a01SPierre Jolivet             PetscCheck(data_00->N == 2, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition %s and %" PetscInt_FMT " level%s instead of 2 for the A00 block -%s", pcpre ? pcpre : "", PCHPDDMSchurPreTypes[type],
1695fd310a01SPierre Jolivet                        data_00->N, data_00->N > 1 ? "s" : "", ((PetscObject)pc_00)->prefix);
169613044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)data_00->levels[0]->pc, PCASM, &flg));
1697fd310a01SPierre Jolivet             PetscCheck(flg, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition %s and -%spc_type %s (!= %s)", pcpre ? pcpre : "", PCHPDDMSchurPreTypes[type], ((PetscObject)data_00->levels[0]->pc)->prefix,
169813044ca3SPierre Jolivet                        ((PetscObject)data_00->levels[0]->pc)->type_name, PCASM);
1699d16c0b94SPierre Jolivet             PetscCall(MatSchurComplementGetSubMatrices(P, nullptr, nullptr, nullptr, nullptr, &A11));
17005e642048SPierre Jolivet             if (PetscDefined(USE_DEBUG) || !data->is) {
17015e642048SPierre Jolivet               Mat A01, A10, B = nullptr, C = nullptr, *sub;
170213044ca3SPierre Jolivet 
17035e642048SPierre Jolivet               PetscCall(MatSchurComplementGetSubMatrices(P, &A, nullptr, &A01, &A10, nullptr));
17045e642048SPierre Jolivet               PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
17055e642048SPierre Jolivet               if (flg) {
17065e642048SPierre Jolivet                 PetscCall(MatTransposeGetMat(A10, &C));
17075e642048SPierre Jolivet                 PetscCall(MatTranspose(C, MAT_INITIAL_MATRIX, &B));
17085e642048SPierre Jolivet               } else {
17095e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
17105e642048SPierre Jolivet                 if (flg) {
17115e642048SPierre Jolivet                   PetscCall(MatHermitianTransposeGetMat(A10, &C));
17125e642048SPierre Jolivet                   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &B));
17135e642048SPierre Jolivet                 }
17145e642048SPierre Jolivet               }
1715811e8887SPierre Jolivet               if (flg)
1716811e8887SPierre Jolivet                 PetscCall(MatShellGetScalingShifts(A10, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
17175e642048SPierre Jolivet               if (!B) {
17185e642048SPierre Jolivet                 B = A10;
17195e642048SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)B));
17205e642048SPierre Jolivet               } else if (!data->is) {
17215e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompareAny((PetscObject)A01, &flg, MATTRANSPOSEVIRTUAL, MATHERMITIANTRANSPOSEVIRTUAL, ""));
17225e642048SPierre Jolivet                 if (!flg) C = A01;
1723811e8887SPierre Jolivet                 else
1724811e8887SPierre Jolivet                   PetscCall(MatShellGetScalingShifts(A01, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
17255e642048SPierre Jolivet               }
172613044ca3SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, B->rmap->N, 0, 1, &uis));
17275e642048SPierre Jolivet               PetscCall(ISSetIdentity(uis));
17285e642048SPierre Jolivet               if (!data->is) {
17295e642048SPierre Jolivet                 if (C) PetscCall(PetscObjectReference((PetscObject)C));
17305e642048SPierre Jolivet                 else PetscCall(MatTranspose(B, MAT_INITIAL_MATRIX, &C));
17315e642048SPierre Jolivet                 PetscCall(ISDuplicate(data_00->is, is));
17325e642048SPierre Jolivet                 PetscCall(MatIncreaseOverlap(A, 1, is, 1));
17335e642048SPierre Jolivet                 PetscCall(MatSetOption(C, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
17345e642048SPierre Jolivet                 PetscCall(MatCreateSubMatrices(C, 1, is, &uis, MAT_INITIAL_MATRIX, &sub));
17355e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
17365e642048SPierre Jolivet                 PetscCall(MatTranspose(sub[0], MAT_INITIAL_MATRIX, &C));
17375e642048SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
17385e642048SPierre Jolivet                 PetscCall(MatFindNonzeroRows(C, &data->is));
17395e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
17405e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
1741d16c0b94SPierre Jolivet                 PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), A11->rmap->n, A11->rmap->rstart, 1, &loc));
1742d16c0b94SPierre Jolivet                 if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_FALSE));
1743d16c0b94SPierre Jolivet                 PetscCall(ISExpand(data->is, loc, is));
1744d16c0b94SPierre Jolivet                 PetscCall(ISDestroy(&loc));
1745d16c0b94SPierre Jolivet                 PetscCall(ISDestroy(&data->is));
1746d16c0b94SPierre Jolivet                 data->is = is[0];
1747d16c0b94SPierre Jolivet                 is[0]    = nullptr;
17485e642048SPierre Jolivet               }
17495e642048SPierre Jolivet               if (PetscDefined(USE_DEBUG)) {
17505e642048SPierre Jolivet                 PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
175113044ca3SPierre Jolivet                 PetscCall(MatCreateSubMatrices(B, 1, &uis, &data_00->is, MAT_INITIAL_MATRIX, &sub)); /* expensive check since all processes fetch all rows (but only some columns) of the constraint matrix */
175213044ca3SPierre Jolivet                 PetscCall(ISDestroy(&uis));
175313044ca3SPierre Jolivet                 PetscCall(ISDuplicate(data->is, &uis));
175413044ca3SPierre Jolivet                 PetscCall(ISSort(uis));
17555e642048SPierre Jolivet                 PetscCall(ISComplement(uis, 0, B->rmap->N, is));
175613044ca3SPierre Jolivet                 PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &C));
17575e642048SPierre Jolivet                 PetscCall(MatZeroRowsIS(C, is[0], 0.0, nullptr, nullptr));
17585e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
175913044ca3SPierre Jolivet                 PetscCall(MatMultEqual(sub[0], C, 20, &flg));
176013044ca3SPierre Jolivet                 PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "The image of A_10 (R_i^p)^T from the local primal (e.g., velocity) space to the full dual (e.g., pressure) space is not restricted to the local dual space: A_10 (R_i^p)^T != R_i^d (R_i^d)^T A_10 (R_i^p)^T"); /* cf. eq. (9) of https://hal.science/hal-02343808v6/document */
176113044ca3SPierre Jolivet                 PetscCall(MatDestroy(&C));
176213044ca3SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
176313044ca3SPierre Jolivet               }
17645e642048SPierre Jolivet               PetscCall(ISDestroy(&uis));
17655e642048SPierre Jolivet               PetscCall(MatDestroy(&B));
17665e642048SPierre Jolivet             }
1767cf67ef9dSPierre Jolivet             flg = PETSC_FALSE;
1768cf67ef9dSPierre Jolivet             if (!data->aux) {
1769cf67ef9dSPierre Jolivet               Mat D;
1770cf67ef9dSPierre Jolivet 
1771cf67ef9dSPierre Jolivet               PetscCall(MatCreateVecs(A11, &d, nullptr));
1772cf67ef9dSPierre Jolivet               PetscCall(MatGetDiagonal(A11, d));
1773cf67ef9dSPierre Jolivet               PetscCall(PetscObjectTypeCompareAny((PetscObject)A11, &flg, MATDIAGONAL, MATCONSTANTDIAGONAL, ""));
1774cf67ef9dSPierre Jolivet               if (!flg) {
1775cf67ef9dSPierre Jolivet                 PetscCall(MatCreateDiagonal(d, &D));
1776cf67ef9dSPierre Jolivet                 PetscCall(MatMultEqual(A11, D, 20, &flg));
1777cf67ef9dSPierre Jolivet                 PetscCall(MatDestroy(&D));
1778cf67ef9dSPierre Jolivet               }
1779cf67ef9dSPierre Jolivet               if (flg) PetscCall(PetscInfo(pc, "A11 block is likely diagonal so the PC will build an auxiliary Mat (which was not initially provided by the user)\n"));
1780cf67ef9dSPierre Jolivet             }
1781cf67ef9dSPierre Jolivet             if (data->Neumann != PETSC_BOOL3_TRUE && !flg && A11) {
1782cf67ef9dSPierre Jolivet               PetscReal norm;
1783cf67ef9dSPierre Jolivet 
1784cf67ef9dSPierre Jolivet               PetscCall(MatNorm(A11, NORM_INFINITY, &norm));
1785cf67ef9dSPierre Jolivet               PetscCheck(norm < PETSC_MACHINE_EPSILON * static_cast<PetscReal>(10.0), PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition geneo and -%spc_hpddm_has_neumann != true with a nonzero or non-diagonal A11 block", pcpre ? pcpre : "", pcpre ? pcpre : "");
1786cf67ef9dSPierre Jolivet               PetscCall(PetscInfo(pc, "A11 block is likely zero so the PC will build an auxiliary Mat (which was%s initially provided by the user)\n", data->aux ? "" : " not"));
1787cf67ef9dSPierre Jolivet               PetscCall(MatDestroy(&data->aux));
1788cf67ef9dSPierre Jolivet               flg = PETSC_TRUE;
1789cf67ef9dSPierre Jolivet             }
1790cf67ef9dSPierre Jolivet             if (!data->aux) { /* if A11 is near zero, e.g., Stokes equation, or diagonal, build an auxiliary (Neumann) Mat which is a (possibly slightly shifted) diagonal weighted by the inverse of the multiplicity */
179101e3c840SPierre Jolivet               PetscSF            scatter;
179213044ca3SPierre Jolivet               const PetscScalar *read;
1793cf67ef9dSPierre Jolivet               PetscScalar       *write, *diagonal = nullptr;
179413044ca3SPierre Jolivet 
179513044ca3SPierre Jolivet               PetscCall(MatDestroy(&data->aux));
179613044ca3SPierre Jolivet               PetscCall(ISGetLocalSize(data->is, &n));
1797cf67ef9dSPierre Jolivet               PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &xin));
1798cf67ef9dSPierre Jolivet               PetscCall(VecDuplicate(xin, &v));
1799cf67ef9dSPierre Jolivet               PetscCall(VecScatterCreate(xin, data->is, v, nullptr, &scatter));
180013044ca3SPierre Jolivet               PetscCall(VecSet(v, 1.0));
1801cf67ef9dSPierre Jolivet               PetscCall(VecSet(xin, 1.0));
1802cf67ef9dSPierre Jolivet               PetscCall(VecScatterBegin(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE));
1803cf67ef9dSPierre Jolivet               PetscCall(VecScatterEnd(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE)); /* v has the multiplicity of all unknowns on the overlap */
1804cf67ef9dSPierre Jolivet               PetscCall(PetscSFDestroy(&scatter));
1805cf67ef9dSPierre Jolivet               if (d) {
1806cf67ef9dSPierre Jolivet                 PetscCall(VecScatterCreate(d, data->is, v, nullptr, &scatter));
1807cf67ef9dSPierre Jolivet                 PetscCall(VecScatterBegin(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1808cf67ef9dSPierre Jolivet                 PetscCall(VecScatterEnd(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1809cf67ef9dSPierre Jolivet                 PetscCall(PetscSFDestroy(&scatter));
1810cf67ef9dSPierre Jolivet                 PetscCall(VecDestroy(&d));
1811cf67ef9dSPierre Jolivet                 PetscCall(PetscMalloc1(n, &diagonal));
1812cf67ef9dSPierre Jolivet                 PetscCall(VecGetArrayRead(v, &read));
1813cf67ef9dSPierre Jolivet                 PetscCallCXX(std::copy_n(read, n, diagonal));
1814cf67ef9dSPierre Jolivet                 PetscCall(VecRestoreArrayRead(v, &read));
1815cf67ef9dSPierre Jolivet               }
181613044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
181713044ca3SPierre Jolivet               PetscCall(VecCreateSeq(PETSC_COMM_SELF, n, &v));
1818cf67ef9dSPierre Jolivet               PetscCall(VecGetArrayRead(xin, &read));
181913044ca3SPierre Jolivet               PetscCall(VecGetArrayWrite(v, &write));
1820cf67ef9dSPierre Jolivet               for (PetscInt i = 0; i < n; ++i) write[i] = (!diagonal || std::abs(diagonal[i]) < PETSC_MACHINE_EPSILON) ? PETSC_SMALL / (static_cast<PetscReal>(1000.0) * read[i]) : diagonal[i] / read[i];
1821cf67ef9dSPierre Jolivet               PetscCall(PetscFree(diagonal));
1822cf67ef9dSPierre Jolivet               PetscCall(VecRestoreArrayRead(xin, &read));
182313044ca3SPierre Jolivet               PetscCall(VecRestoreArrayWrite(v, &write));
1824cf67ef9dSPierre Jolivet               PetscCall(VecDestroy(&xin));
1825c3e1b152SPierre Jolivet               PetscCall(MatCreateDiagonal(v, &data->aux));
182613044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
182713044ca3SPierre Jolivet             }
182813044ca3SPierre Jolivet             uis  = data->is;
182913044ca3SPierre Jolivet             uaux = data->aux;
183013044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uis));
183113044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uaux));
183213044ca3SPierre Jolivet             PetscCall(PetscStrallocpy(pcpre, &prefix));
183313044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(pc, nullptr));
183413044ca3SPierre Jolivet             PetscCall(PCSetType(pc, PCKSP));                                    /* replace the PC associated to the Schur complement by PCKSP */
183513044ca3SPierre Jolivet             PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &inner_ksp)); /* new KSP that will be attached to the previously set PC */
183673329a61SPierre Jolivet             pc->ops->setup = PCSetUp_KSP;
183713044ca3SPierre Jolivet             PetscCall(PetscObjectGetTabLevel((PetscObject)pc, &n));
183813044ca3SPierre Jolivet             PetscCall(PetscObjectSetTabLevel((PetscObject)inner_ksp, n + 2));
183913044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, pc->mat, pc->pmat));
184013044ca3SPierre Jolivet             PetscCall(KSPSetOptionsPrefix(inner_ksp, std::string(std::string(prefix) + "pc_hpddm_").c_str()));
184113044ca3SPierre Jolivet             PetscCall(KSPSetSkipPCSetFromOptions(inner_ksp, PETSC_TRUE));
184213044ca3SPierre Jolivet             PetscCall(KSPSetFromOptions(inner_ksp));
184313044ca3SPierre Jolivet             PetscCall(KSPGetPC(inner_ksp, &inner));
184413044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(inner, nullptr));
184513044ca3SPierre Jolivet             PetscCall(PCSetType(inner, PCNONE)); /* no preconditioner since the action of M^-1 A or A M^-1 will be computed by the Amat */
184613044ca3SPierre Jolivet             PetscCall(PCKSPSetKSP(pc, inner_ksp));
184713044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));    /* context to pass data around for the inner-most PC, which will be a proper PCHPDDM */
184813044ca3SPierre Jolivet             std::get<0>(*ctx)[0] = pc_00; /* for coarse correction on the primal (e.g., velocity) space */
184913044ca3SPierre Jolivet             PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &std::get<0>(*ctx)[1]));
185013044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(std::get<0>(*ctx)[1], prefix));
185113044ca3SPierre Jolivet             PetscCall(PetscFree(prefix));
185213044ca3SPierre Jolivet             PetscCall(PCSetOperators(std::get<0>(*ctx)[1], pc->mat, pc->pmat));
185313044ca3SPierre Jolivet             PetscCall(PCSetType(std::get<0>(*ctx)[1], PCHPDDM));
185413044ca3SPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMat(std::get<0>(*ctx)[1], uis, uaux, nullptr, nullptr)); /* transfer ownership of the auxiliary inputs from the inner (PCKSP) to the inner-most (PCHPDDM) PC */
1855cf67ef9dSPierre Jolivet             if (flg) static_cast<PC_HPDDM *>(std::get<0>(*ctx)[1]->data)->Neumann = PETSC_BOOL3_TRUE;
185613044ca3SPierre Jolivet             PetscCall(PCSetFromOptions(std::get<0>(*ctx)[1]));
185713044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uis));
185813044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uaux));
185913044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)pc), inner->mat->rmap->n, inner->mat->cmap->n, inner->mat->rmap->N, inner->mat->cmap->N, ctx, &S)); /* MatShell computing the action of M^-1 A or A M^-1 */
186013044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_MULT, (void (*)(void))MatMult_SchurCorrection));
186113044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_VIEW, (void (*)(void))MatView_SchurCorrection));
186213044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_DESTROY, (void (*)(void))MatDestroy_SchurCorrection));
186313044ca3SPierre Jolivet             PetscCall(KSPGetPCSide(inner_ksp, &(std::get<2>(*ctx))));
186413044ca3SPierre Jolivet             if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
186513044ca3SPierre Jolivet               PetscCall(KSPSetPreSolve(inner_ksp, KSPPreSolve_SchurCorrection, ctx));
186613044ca3SPierre Jolivet             } else { /* no support for PC_SYMMETRIC */
186713044ca3SPierre Jolivet               PetscCheck(std::get<2>(*ctx) == PC_RIGHT, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "PCSide %s (!= %s or %s or %s)", PCSides[std::get<2>(*ctx)], PCSides[PC_SIDE_DEFAULT], PCSides[PC_LEFT], PCSides[PC_RIGHT]);
186813044ca3SPierre Jolivet             }
186913044ca3SPierre Jolivet             PetscCall(KSPSetPostSolve(inner_ksp, KSPPostSolve_SchurCorrection, ctx));
1870715c1178SPierre Jolivet             PetscCall(PetscObjectContainerCompose((PetscObject)std::get<0>(*ctx)[1], "_PCHPDDM_Schur", ctx, nullptr));
187113044ca3SPierre Jolivet             PetscCall(PCSetUp(std::get<0>(*ctx)[1]));
187213044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, S, S));
187313044ca3SPierre Jolivet             PetscCall(MatCreateVecs(std::get<1>(*ctx)[0], std::get<3>(*ctx), std::get<3>(*ctx) + 1));
187413044ca3SPierre Jolivet             PetscCall(VecDuplicate(std::get<3>(*ctx)[0], std::get<3>(*ctx) + 2));
187513044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)inner_ksp));
187613044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)S));
18770307214fSPierre Jolivet             for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
187813044ca3SPierre Jolivet             PetscFunctionReturn(PETSC_SUCCESS);
187913044ca3SPierre Jolivet           } else { /* second call to PCSetUp() on the PC associated to the Schur complement, retrieve previously set context */
188013044ca3SPierre Jolivet             PetscCall(PetscContainerGetPointer(container, (void **)&ctx));
188113044ca3SPierre Jolivet           }
188213044ca3SPierre Jolivet         }
188313044ca3SPierre Jolivet       }
188413044ca3SPierre Jolivet     }
1885f1580f4eSBarry Smith     if (!data->is && data->N > 1) {
1886f1580f4eSBarry Smith       char type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
1887811e8887SPierre Jolivet 
1888f1580f4eSBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
1889f1580f4eSBarry Smith       if (flg || (A->rmap->N != A->cmap->N && P->rmap->N == P->cmap->N && P->rmap->N == A->cmap->N)) {
1890f1580f4eSBarry Smith         Mat B;
1891811e8887SPierre Jolivet 
1892f1580f4eSBarry Smith         PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, A, P, &B, pcpre));
1893f1580f4eSBarry Smith         if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) data->correction = PC_HPDDM_COARSE_CORRECTION_BALANCED;
1894f1580f4eSBarry Smith         PetscCall(MatDestroy(&B));
1895f1580f4eSBarry Smith       } else {
1896f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
1897f1580f4eSBarry Smith         if (flg) {
1898f1580f4eSBarry Smith           Mat                 A00, P00, A01, A10, A11, B, N;
189913044ca3SPierre Jolivet           PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_LEAST_SQUARES;
190013044ca3SPierre Jolivet 
190113044ca3SPierre Jolivet           PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, &A01, &A10, &A11));
190213044ca3SPierre Jolivet           if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
190313044ca3SPierre Jolivet           PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
190413044ca3SPierre Jolivet           if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
19053df4cd7bSPierre Jolivet             Vec                        diagonal = nullptr;
1906f1580f4eSBarry Smith             const PetscScalar         *array;
1907f1580f4eSBarry Smith             MatSchurComplementAinvType type;
1908f1580f4eSBarry Smith 
1909f1580f4eSBarry Smith             if (A11) {
19103df4cd7bSPierre Jolivet               PetscCall(MatCreateVecs(A11, &diagonal, nullptr));
19113df4cd7bSPierre Jolivet               PetscCall(MatGetDiagonal(A11, diagonal));
1912f1580f4eSBarry Smith             }
1913db4a47b3SPierre Jolivet             PetscCall(MatCreateVecs(P00, &v, nullptr));
1914f1580f4eSBarry Smith             PetscCall(MatSchurComplementGetAinvType(P, &type));
1915f1580f4eSBarry Smith             PetscCheck(type == MAT_SCHUR_COMPLEMENT_AINV_DIAG || type == MAT_SCHUR_COMPLEMENT_AINV_LUMP, PetscObjectComm((PetscObject)P), PETSC_ERR_SUP, "-%smat_schur_complement_ainv_type %s", ((PetscObject)P)->prefix ? ((PetscObject)P)->prefix : "", MatSchurComplementAinvTypes[type]);
1916f1580f4eSBarry Smith             if (type == MAT_SCHUR_COMPLEMENT_AINV_LUMP) {
1917f1580f4eSBarry Smith               PetscCall(MatGetRowSum(P00, v));
1918f1580f4eSBarry Smith               if (A00 == P00) PetscCall(PetscObjectReference((PetscObject)A00));
1919f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1920f1580f4eSBarry Smith               PetscCall(VecGetArrayRead(v, &array));
1921db4a47b3SPierre Jolivet               PetscCall(MatCreateAIJ(PetscObjectComm((PetscObject)A00), A00->rmap->n, A00->cmap->n, A00->rmap->N, A00->cmap->N, 1, nullptr, 0, nullptr, &P00));
1922f1580f4eSBarry Smith               PetscCall(MatSetOption(P00, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
1923f1580f4eSBarry Smith               for (n = A00->rmap->rstart; n < A00->rmap->rend; ++n) PetscCall(MatSetValue(P00, n, n, array[n - A00->rmap->rstart], INSERT_VALUES));
1924f1580f4eSBarry Smith               PetscCall(MatAssemblyBegin(P00, MAT_FINAL_ASSEMBLY));
1925f1580f4eSBarry Smith               PetscCall(MatAssemblyEnd(P00, MAT_FINAL_ASSEMBLY));
1926f1580f4eSBarry Smith               PetscCall(VecRestoreArrayRead(v, &array));
1927f1580f4eSBarry Smith               PetscCall(MatSchurComplementUpdateSubMatrices(P, A00, P00, A01, A10, A11)); /* replace P00 by diag(sum of each row of P00) */
1928f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1929f1580f4eSBarry Smith             } else PetscCall(MatGetDiagonal(P00, v));
1930f1580f4eSBarry Smith             PetscCall(VecReciprocal(v)); /* inv(diag(P00))       */
1931f1580f4eSBarry Smith             PetscCall(VecSqrtAbs(v));    /* sqrt(inv(diag(P00))) */
1932f1580f4eSBarry Smith             PetscCall(MatDuplicate(A01, MAT_COPY_VALUES, &B));
1933db4a47b3SPierre Jolivet             PetscCall(MatDiagonalScale(B, v, nullptr));
1934f1580f4eSBarry Smith             PetscCall(VecDestroy(&v));
1935f1580f4eSBarry Smith             PetscCall(MatCreateNormalHermitian(B, &N));
19363df4cd7bSPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, B, N, &P, pcpre, &diagonal));
1937f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
1938f1580f4eSBarry Smith             if (!flg) {
1939f1580f4eSBarry Smith               PetscCall(MatDestroy(&P));
1940f1580f4eSBarry Smith               P = N;
1941f1580f4eSBarry Smith               PetscCall(PetscObjectReference((PetscObject)P));
1942*feebddf4SPierre Jolivet             }
19433df4cd7bSPierre Jolivet             if (diagonal) {
19443df4cd7bSPierre Jolivet               PetscCall(MatDiagonalSet(P, diagonal, ADD_VALUES));
1945*feebddf4SPierre Jolivet               PetscCall(PCSetOperators(pc, P, P)); /* replace P by A01^T inv(diag(P00)) A01 - diag(P11) */
19463df4cd7bSPierre Jolivet               PetscCall(VecDestroy(&diagonal));
1947*feebddf4SPierre Jolivet             } else PetscCall(PCSetOperators(pc, N, P));            /* replace P by A01^T inv(diag(P00)) A01                         */
1948*feebddf4SPierre Jolivet             pc->ops->postsolve = PCPostSolve_SchurPreLeastSquares; /*  PCFIELDSPLIT expect a KSP for (P11 - A10 inv(diag(P00)) A01) */
1949*feebddf4SPierre Jolivet             PetscCall(MatDestroy(&N));                             /*  but a PC for (A10 inv(diag(P00)) A10 - P11) is setup instead */
1950*feebddf4SPierre Jolivet             PetscCall(MatDestroy(&P));                             /*  so the sign of the solution must be flipped                  */
1951f1580f4eSBarry Smith             PetscCall(MatDestroy(&B));
195213044ca3SPierre Jolivet           } else
1953fd310a01SPierre Jolivet             PetscCheck(type != PC_HPDDM_SCHUR_PRE_GENEO, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition %s without a prior call to PCHPDDMSetAuxiliaryMat() on the A11 block%s%s", pcpre ? pcpre : "", PCHPDDMSchurPreTypes[type], pcpre ? " -" : "", pcpre ? pcpre : "");
19540307214fSPierre Jolivet           for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
19553ba16761SJacob Faibussowitsch           PetscFunctionReturn(PETSC_SUCCESS);
1956f1580f4eSBarry Smith         } else {
1957db4a47b3SPierre Jolivet           PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_st_pc_type", type, sizeof(type), nullptr));
1958f1580f4eSBarry Smith           PetscCall(PetscStrcmp(type, PCMAT, &algebraic));
1959b07dfdedSPierre Jolivet           PetscCheck(!algebraic || !block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_block_splitting");
19609bb5c669SPierre Jolivet           if (overlap != -1) {
19619bb5c669SPierre Jolivet             PetscCheck(!block && !algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_%s and -pc_hpddm_harmonic_overlap", block ? "block_splitting" : "levels_1_st_pc_type mat");
19629bb5c669SPierre Jolivet             PetscCheck(overlap >= 1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_WRONG, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " < 1", overlap);
19639bb5c669SPierre Jolivet           }
19649bb5c669SPierre Jolivet           if (block || overlap != -1) algebraic = PETSC_TRUE;
1965f1580f4eSBarry Smith           if (algebraic) {
1966f1580f4eSBarry Smith             PetscCall(ISCreateStride(PETSC_COMM_SELF, P->rmap->n, P->rmap->rstart, 1, &data->is));
1967f1580f4eSBarry Smith             PetscCall(MatIncreaseOverlap(P, 1, &data->is, 1));
1968f1580f4eSBarry Smith             PetscCall(ISSort(data->is));
19699bb5c669SPierre Jolivet           } else
19709bb5c669SPierre Jolivet             PetscCall(PetscInfo(pc, "Cannot assemble a fully-algebraic coarse operator with an assembled Pmat and -%spc_hpddm_levels_1_st_pc_type != mat and -%spc_hpddm_block_splitting != true and -%spc_hpddm_harmonic_overlap < 1\n", pcpre ? pcpre : "", pcpre ? pcpre : "", pcpre ? pcpre : ""));
1971f1580f4eSBarry Smith         }
1972f1580f4eSBarry Smith       }
1973f1580f4eSBarry Smith     }
1974f1580f4eSBarry Smith   }
1975398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1976398c7888SPierre Jolivet   if (data->is) PetscCall(ISDuplicate(data->is, &dis));
1977398c7888SPierre Jolivet   if (data->aux) PetscCall(MatDuplicate(data->aux, MAT_COPY_VALUES, &daux));
1978398c7888SPierre Jolivet #endif
1979f1580f4eSBarry Smith   if (data->is || (ismatis && data->N > 1)) {
1980f1580f4eSBarry Smith     if (ismatis) {
1981f1580f4eSBarry Smith       std::initializer_list<std::string> list = {MATSEQBAIJ, MATSEQSBAIJ};
1982f1580f4eSBarry Smith       PetscCall(MatISGetLocalMat(P, &N));
1983f1580f4eSBarry Smith       std::initializer_list<std::string>::const_iterator it = std::find(list.begin(), list.end(), ((PetscObject)N)->type_name);
1984f1580f4eSBarry Smith       PetscCall(MatISRestoreLocalMat(P, &N));
1985f1580f4eSBarry Smith       switch (std::distance(list.begin(), it)) {
1986d71ae5a4SJacob Faibussowitsch       case 0:
1987d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
1988d71ae5a4SJacob Faibussowitsch         break;
1989f1580f4eSBarry Smith       case 1:
1990f1580f4eSBarry Smith         /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIBAIJ */
1991f1580f4eSBarry Smith         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
1992f1580f4eSBarry Smith         PetscCall(MatSetOption(C, MAT_SYMMETRIC, PETSC_TRUE));
1993f1580f4eSBarry Smith         break;
1994d71ae5a4SJacob Faibussowitsch       default:
1995d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, &C));
1996f1580f4eSBarry Smith       }
1997db4a47b3SPierre Jolivet       PetscCall(MatISGetLocalToGlobalMapping(P, &l2g, nullptr));
1998f1580f4eSBarry Smith       PetscCall(PetscObjectReference((PetscObject)P));
1999f1580f4eSBarry Smith       PetscCall(KSPSetOperators(data->levels[0]->ksp, A, C));
2000f1580f4eSBarry Smith       std::swap(C, P);
2001f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingGetSize(l2g, &n));
2002f1580f4eSBarry Smith       PetscCall(ISCreateStride(PETSC_COMM_SELF, n, 0, 1, &loc));
2003f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingApplyIS(l2g, loc, &is[0]));
2004f1580f4eSBarry Smith       PetscCall(ISDestroy(&loc));
2005f1580f4eSBarry Smith       /* the auxiliary Mat is _not_ the local Neumann matrix                                */
2006f1580f4eSBarry Smith       /* it is the local Neumann matrix augmented (with zeros) through MatIncreaseOverlap() */
2007c8ea6600SPierre Jolivet       data->Neumann = PETSC_BOOL3_FALSE;
2008f1580f4eSBarry Smith       structure     = SAME_NONZERO_PATTERN;
2009f1580f4eSBarry Smith     } else {
2010f1580f4eSBarry Smith       is[0] = data->is;
201113044ca3SPierre Jolivet       if (algebraic || ctx) subdomains = PETSC_TRUE;
2012db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_define_subdomains", &subdomains, nullptr));
201313044ca3SPierre Jolivet       if (ctx) PetscCheck(subdomains, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition geneo and -%spc_hpddm_define_subdomains false", pcpre, pcpre);
2014c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann)) {
2015b07dfdedSPierre Jolivet         PetscCheck(!block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_block_splitting and -pc_hpddm_has_neumann");
20169bb5c669SPierre Jolivet         PetscCheck(overlap == -1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " and -pc_hpddm_has_neumann", overlap);
2017b07dfdedSPierre Jolivet         PetscCheck(!algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_has_neumann");
2018f1580f4eSBarry Smith       }
2019c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann) || block) structure = SAME_NONZERO_PATTERN;
2020f1580f4eSBarry Smith       PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), P->rmap->n, P->rmap->rstart, 1, &loc));
2021f1580f4eSBarry Smith     }
2022f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2023db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetEnum(nullptr, prefix, "-st_matstructure", MatStructures, (PetscEnum *)&structure, &flg)); /* if not user-provided, force its value when possible */
2024f1580f4eSBarry Smith     if (!flg && structure == SAME_NONZERO_PATTERN) {                                                                   /* cannot call STSetMatStructure() yet, insert the appropriate option in the database, parsed by STSetFromOptions() */
2025f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-%spc_hpddm_levels_1_st_matstructure", pcpre ? pcpre : ""));
2026db4a47b3SPierre Jolivet       PetscCall(PetscOptionsSetValue(nullptr, prefix, MatStructures[structure]));
2027f1580f4eSBarry Smith     }
2028398c7888SPierre Jolivet     flg = PETSC_FALSE;
2029b07dfdedSPierre Jolivet     if (data->share) {
2030398c7888SPierre Jolivet       data->share = PETSC_FALSE; /* will be reset to PETSC_TRUE if none of the conditions below are true */
2031398c7888SPierre Jolivet       if (!subdomains) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since -%spc_hpddm_define_subdomains is not true\n", pcpre ? pcpre : ""));
2032398c7888SPierre Jolivet       else if (data->deflation) PetscCall(PetscInfo(pc, "Nothing to share since PCHPDDMSetDeflationMat() has been called\n"));
2033398c7888SPierre Jolivet       else if (ismatis) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc with a Pmat of type MATIS\n"));
2034b07dfdedSPierre Jolivet       else if (!algebraic && structure != SAME_NONZERO_PATTERN)
2035398c7888SPierre Jolivet         PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since -%spc_hpddm_levels_1_st_matstructure %s (!= %s)\n", pcpre ? pcpre : "", MatStructures[structure], MatStructures[SAME_NONZERO_PATTERN]));
2036398c7888SPierre Jolivet       else data->share = PETSC_TRUE;
2037398c7888SPierre Jolivet     }
2038398c7888SPierre Jolivet     if (!ismatis) {
2039398c7888SPierre Jolivet       if (data->share || (!PetscBool3ToBool(data->Neumann) && subdomains)) PetscCall(ISDuplicate(is[0], &unsorted));
2040398c7888SPierre Jolivet       else unsorted = is[0];
2041398c7888SPierre Jolivet     }
2042f1580f4eSBarry Smith     if (data->N > 1 && (data->aux || ismatis || algebraic)) {
2043f1580f4eSBarry Smith       PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "HPDDM library not loaded, cannot use more than one level");
2044f1580f4eSBarry Smith       PetscCall(MatSetOption(P, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
2045f1580f4eSBarry Smith       if (ismatis) {
2046f1580f4eSBarry Smith         /* needed by HPDDM (currently) so that the partition of unity is 0 on subdomain interfaces */
2047f1580f4eSBarry Smith         PetscCall(MatIncreaseOverlap(P, 1, is, 1));
2048f1580f4eSBarry Smith         PetscCall(ISDestroy(&data->is));
2049f1580f4eSBarry Smith         data->is = is[0];
2050f1580f4eSBarry Smith       } else {
2051d16c0b94SPierre Jolivet         if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_TRUE));
20529bb5c669SPierre Jolivet         if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", PCHPDDMAlgebraicAuxiliaryMat_Private));
20539bb5c669SPierre Jolivet         if (!PetscBool3ToBool(data->Neumann) && (!algebraic || overlap != -1)) {
2054f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
2055f1580f4eSBarry Smith           if (flg) {
2056f1580f4eSBarry Smith             /* maybe better to ISSort(is[0]), MatCreateSubMatrices(), and then MatPermute() */
2057f1580f4eSBarry Smith             /* but there is no MatPermute_SeqSBAIJ(), so as before, just use MATMPIBAIJ     */
2058f1580f4eSBarry Smith             PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &uaux));
2059f1580f4eSBarry Smith             flg = PETSC_FALSE;
2060f1580f4eSBarry Smith           }
2061f1580f4eSBarry Smith         }
2062f1580f4eSBarry Smith       }
20639bb5c669SPierre Jolivet       if (algebraic && overlap == -1) {
2064f1580f4eSBarry Smith         PetscUseMethod(pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", (Mat, IS *, Mat *[], PetscBool), (P, is, &sub, block));
2065f1580f4eSBarry Smith         if (block) {
2066f1580f4eSBarry Smith           PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", (PetscObject *)&data->aux));
2067db4a47b3SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", nullptr));
2068f1580f4eSBarry Smith         }
20699bb5c669SPierre Jolivet       } else if (!uaux || overlap != -1) {
207013044ca3SPierre Jolivet         if (!ctx) {
2071c8ea6600SPierre Jolivet           if (PetscBool3ToBool(data->Neumann)) sub = &data->aux;
20729bb5c669SPierre Jolivet           else {
2073df21ef68SPierre Jolivet             PetscBool flg;
20749bb5c669SPierre Jolivet             if (overlap != -1) {
20759bb5c669SPierre Jolivet               Harmonic              h;
20769bb5c669SPierre Jolivet               Mat                   A0, *a;                           /* with an SVD: [ A_00  A_01       ] */
20779bb5c669SPierre Jolivet               IS                    ov[2], rows, cols, stride;        /*              [ A_10  A_11  A_12 ] */
20789bb5c669SPierre Jolivet               const PetscInt       *i[2], bs = PetscAbs(P->cmap->bs); /* with a GEVP: [ A_00  A_01       ] */
20799bb5c669SPierre Jolivet               PetscInt              n[2];                             /*              [ A_10  A_11  A_12 ] */
20809bb5c669SPierre Jolivet               std::vector<PetscInt> v[2];                             /*              [       A_21  A_22 ] */
20819bb5c669SPierre Jolivet 
20829bb5c669SPierre Jolivet               PetscCall(ISDuplicate(data->is, ov));
20839bb5c669SPierre Jolivet               if (overlap > 1) PetscCall(MatIncreaseOverlap(P, 1, ov, overlap - 1));
20849bb5c669SPierre Jolivet               PetscCall(ISDuplicate(ov[0], ov + 1));
20859bb5c669SPierre Jolivet               PetscCall(MatIncreaseOverlap(P, 1, ov + 1, 1));
20869bb5c669SPierre Jolivet               PetscCall(PetscNew(&h));
20879bb5c669SPierre Jolivet               h->ksp = nullptr;
20889bb5c669SPierre Jolivet               PetscCall(PetscCalloc1(2, &h->A));
20893a60673dSPierre Jolivet               PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_nsv", &flg));
20909bb5c669SPierre Jolivet               if (!flg) PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_relative_threshold", &flg));
20919bb5c669SPierre Jolivet               PetscCall(ISSort(ov[0]));
20929bb5c669SPierre Jolivet               if (!flg) PetscCall(ISSort(ov[1]));
209332603206SJames Wright               PetscCall(PetscCalloc1(5, &h->is));
20949bb5c669SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, ov + !flg, ov + 1, MAT_INITIAL_MATRIX, &a)); /* submatrix from above, either square (!flg) or rectangular (flg) */
20959bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) {
20969bb5c669SPierre Jolivet                 PetscCall(ISGetIndices(ov[j], i + j));
20979bb5c669SPierre Jolivet                 PetscCall(ISGetLocalSize(ov[j], n + j));
20989bb5c669SPierre Jolivet               }
20999bb5c669SPierre Jolivet               v[1].reserve((n[1] - n[0]) / bs);
21009bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[1]; j += bs) { /* indices of the (2,2) block */
21019bb5c669SPierre Jolivet                 PetscInt location;
21029bb5c669SPierre Jolivet                 PetscCall(ISLocate(ov[0], i[1][j], &location));
21039bb5c669SPierre Jolivet                 if (location < 0) v[1].emplace_back(j / bs);
21049bb5c669SPierre Jolivet               }
21059bb5c669SPierre Jolivet               if (!flg) {
21069bb5c669SPierre Jolivet                 h->A[1] = a[0];
21079bb5c669SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)h->A[1]));
21089bb5c669SPierre Jolivet                 v[0].reserve((n[0] - P->rmap->n) / bs);
21099bb5c669SPierre Jolivet                 for (PetscInt j = 0; j < n[1]; j += bs) { /* row indices of the (1,2) block */
21109bb5c669SPierre Jolivet                   PetscInt location;
21119bb5c669SPierre Jolivet                   PetscCall(ISLocate(loc, i[1][j], &location));
21129bb5c669SPierre Jolivet                   if (location < 0) {
21139bb5c669SPierre Jolivet                     PetscCall(ISLocate(ov[0], i[1][j], &location));
21149bb5c669SPierre Jolivet                     if (location >= 0) v[0].emplace_back(j / bs);
21159bb5c669SPierre Jolivet                   }
21169bb5c669SPierre Jolivet                 }
21179bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
21189bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_COPY_VALUES, h->is + 4));
21199bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, h->is[4], MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
21209bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
21219bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatConvert(a[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, a)); /* initial Pmat was MATSBAIJ, convert back to the same format since the rectangular A_12 submatrix has been created */
21229bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &rows));
21239bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols = rows, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
21249bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
21259bb5c669SPierre Jolivet                 v[0].clear();
21269bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, ov[1], PETSC_TRUE, h->is + 3));
21279bb5c669SPierre Jolivet                 PetscCall(ISEmbed(data->is, ov[1], PETSC_TRUE, h->is + 2));
21289bb5c669SPierre Jolivet               }
21299bb5c669SPierre Jolivet               v[0].reserve((n[0] - P->rmap->n) / bs);
21309bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[0]; j += bs) {
21319bb5c669SPierre Jolivet                 PetscInt location;
21329bb5c669SPierre Jolivet                 PetscCall(ISLocate(loc, i[0][j], &location));
21339bb5c669SPierre Jolivet                 if (location < 0) v[0].emplace_back(j / bs);
21349bb5c669SPierre Jolivet               }
21359bb5c669SPierre Jolivet               PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
21369bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISRestoreIndices(ov[j], i + j));
21379bb5c669SPierre Jolivet               if (flg) {
21389bb5c669SPierre Jolivet                 IS is;
21399bb5c669SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, a[0]->rmap->n, 0, 1, &is));
21409bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &cols));
21419bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], is, cols, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
21429bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
21439bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&is));
21449bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatConvert(A0, MATSEQSBAIJ, MAT_INPLACE_MATRIX, &A0)); /* initial Pmat was MATSBAIJ, convert back to the same format since this submatrix is square */
21459bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, data->is, PETSC_TRUE, h->is + 2));
21469bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_USE_POINTER, &cols));
21479bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols, MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
21489bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
21499bb5c669SPierre Jolivet               }
21509bb5c669SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, A0->rmap->n, 0, 1, &stride));
21519bb5c669SPierre Jolivet               PetscCall(ISEmbed(rows, stride, PETSC_TRUE, h->is));
21529bb5c669SPierre Jolivet               PetscCall(ISDestroy(&stride));
21539bb5c669SPierre Jolivet               PetscCall(ISDestroy(&rows));
21549bb5c669SPierre Jolivet               PetscCall(ISEmbed(loc, ov[0], PETSC_TRUE, h->is + 1));
21559bb5c669SPierre Jolivet               if (subdomains) {
21569bb5c669SPierre Jolivet                 if (!data->levels[0]->pc) {
21579bb5c669SPierre Jolivet                   PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
21589bb5c669SPierre Jolivet                   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
21599bb5c669SPierre Jolivet                   PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
21609bb5c669SPierre Jolivet                   PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
21619bb5c669SPierre Jolivet                 }
21629bb5c669SPierre Jolivet                 PetscCall(PCSetType(data->levels[0]->pc, PCASM));
21639bb5c669SPierre Jolivet                 if (!data->levels[0]->pc->setupcalled) PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, ov + !flg, &loc));
21649bb5c669SPierre Jolivet                 PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, flg ? A0 : a[0], PETSC_TRUE));
21659bb5c669SPierre Jolivet                 if (!flg) ++overlap;
21669bb5c669SPierre Jolivet                 if (data->share) {
21679bb5c669SPierre Jolivet                   PetscInt n = -1;
21689bb5c669SPierre Jolivet                   PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
21699bb5c669SPierre Jolivet                   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
21709bb5c669SPierre Jolivet                   if (flg) {
21719bb5c669SPierre Jolivet                     h->ksp = ksp[0];
21729bb5c669SPierre Jolivet                     PetscCall(PetscObjectReference((PetscObject)h->ksp));
21739bb5c669SPierre Jolivet                   }
21749bb5c669SPierre Jolivet                 }
21759bb5c669SPierre Jolivet               }
21769bb5c669SPierre Jolivet               if (!h->ksp) {
21779bb5c669SPierre Jolivet                 PetscBool share = data->share;
21789bb5c669SPierre Jolivet                 PetscCall(KSPCreate(PETSC_COMM_SELF, &h->ksp));
21799bb5c669SPierre Jolivet                 PetscCall(KSPSetType(h->ksp, KSPPREONLY));
21809bb5c669SPierre Jolivet                 PetscCall(KSPSetOperators(h->ksp, A0, A0));
21819bb5c669SPierre Jolivet                 do {
21829bb5c669SPierre Jolivet                   if (!data->share) {
21839bb5c669SPierre Jolivet                     share = PETSC_FALSE;
21849bb5c669SPierre Jolivet                     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_%s", pcpre ? pcpre : "", flg ? "svd_" : "eps_"));
21859bb5c669SPierre Jolivet                     PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
21869bb5c669SPierre Jolivet                     PetscCall(KSPSetFromOptions(h->ksp));
21879bb5c669SPierre Jolivet                   } else {
21889bb5c669SPierre Jolivet                     MatSolverType type;
21899bb5c669SPierre Jolivet                     PetscCall(KSPGetPC(ksp[0], &pc));
21909bb5c669SPierre Jolivet                     PetscCall(PetscObjectTypeCompareAny((PetscObject)pc, &data->share, PCLU, PCCHOLESKY, ""));
21919bb5c669SPierre Jolivet                     if (data->share) {
21929bb5c669SPierre Jolivet                       PetscCall(PCFactorGetMatSolverType(pc, &type));
21939bb5c669SPierre Jolivet                       if (!type) {
21949bb5c669SPierre Jolivet                         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMUMPS));
21959bb5c669SPierre Jolivet                         else if (PetscDefined(HAVE_MKL_PARDISO)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMKL_PARDISO));
21969bb5c669SPierre Jolivet                         else data->share = PETSC_FALSE;
21979bb5c669SPierre Jolivet                         if (data->share) PetscCall(PCSetFromOptions(pc));
21989bb5c669SPierre Jolivet                       } else {
21999bb5c669SPierre Jolivet                         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &data->share));
22009bb5c669SPierre Jolivet                         if (!data->share) PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &data->share));
22019bb5c669SPierre Jolivet                       }
22029bb5c669SPierre Jolivet                       if (data->share) {
22039bb5c669SPierre Jolivet                         std::tuple<KSP, IS, Vec[2]> *p;
22049bb5c669SPierre Jolivet                         PetscCall(PCFactorGetMatrix(pc, &A));
22059bb5c669SPierre Jolivet                         PetscCall(MatFactorSetSchurIS(A, h->is[4]));
22069bb5c669SPierre Jolivet                         PetscCall(KSPSetUp(ksp[0]));
22079bb5c669SPierre Jolivet                         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_eps_shell_", pcpre ? pcpre : ""));
22089bb5c669SPierre Jolivet                         PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
22099bb5c669SPierre Jolivet                         PetscCall(KSPSetFromOptions(h->ksp));
22109bb5c669SPierre Jolivet                         PetscCall(KSPGetPC(h->ksp, &pc));
22119bb5c669SPierre Jolivet                         PetscCall(PCSetType(pc, PCSHELL));
22129bb5c669SPierre Jolivet                         PetscCall(PetscNew(&p));
22139bb5c669SPierre Jolivet                         std::get<0>(*p) = ksp[0];
22149bb5c669SPierre Jolivet                         PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &std::get<1>(*p)));
22159bb5c669SPierre Jolivet                         PetscCall(MatCreateVecs(A, std::get<2>(*p), std::get<2>(*p) + 1));
22169bb5c669SPierre Jolivet                         PetscCall(PCShellSetContext(pc, p));
22179bb5c669SPierre Jolivet                         PetscCall(PCShellSetApply(pc, PCApply_Schur));
22189bb5c669SPierre Jolivet                         PetscCall(PCShellSetApplyTranspose(pc, PCApply_Schur<Vec, true>));
22199bb5c669SPierre Jolivet                         PetscCall(PCShellSetMatApply(pc, PCApply_Schur<Mat>));
22209bb5c669SPierre Jolivet                         PetscCall(PCShellSetDestroy(pc, PCDestroy_Schur));
22219bb5c669SPierre Jolivet                       }
22229bb5c669SPierre Jolivet                     }
22239bb5c669SPierre Jolivet                     if (!data->share) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since neither MUMPS nor MKL PARDISO is used\n"));
22249bb5c669SPierre Jolivet                   }
22259bb5c669SPierre Jolivet                 } while (!share != !data->share); /* if data->share is initially PETSC_TRUE, but then reset to PETSC_FALSE, then go back to the beginning of the do loop */
22269bb5c669SPierre Jolivet               }
22279bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov));
22289bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov + 1));
22299bb5c669SPierre Jolivet               if (overlap == 1 && subdomains && flg) {
22309bb5c669SPierre Jolivet                 *subA = A0;
22319bb5c669SPierre Jolivet                 sub   = subA;
22329bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatDestroy(&uaux));
22339bb5c669SPierre Jolivet               } else PetscCall(MatDestroy(&A0));
22349bb5c669SPierre Jolivet               PetscCall(MatCreateShell(PETSC_COMM_SELF, P->rmap->n, n[1] - n[0], P->rmap->n, n[1] - n[0], h, &data->aux));
2235bdcd51b8SPierre Jolivet               PetscCall(KSPSetErrorIfNotConverged(h->ksp, PETSC_TRUE)); /* bail out as early as possible to avoid (apparently) unrelated error messages */
22369bb5c669SPierre Jolivet               PetscCall(MatCreateVecs(h->ksp->pc->pmat, &h->v, nullptr));
22379bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT, (void (*)(void))MatMult_Harmonic));
22389bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMultTranspose_Harmonic));
22399bb5c669SPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AB, nullptr, MatProduct_AB_Harmonic, nullptr, MATDENSE, MATDENSE));
22409bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_DESTROY, (void (*)(void))MatDestroy_Harmonic));
22419bb5c669SPierre Jolivet               PetscCall(MatDestroySubMatrices(1, &a));
22429bb5c669SPierre Jolivet             }
2243df21ef68SPierre Jolivet             if (overlap != 1 || !subdomains) {
2244df21ef68SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2245df21ef68SPierre Jolivet               if (ismatis) {
2246df21ef68SPierre Jolivet                 PetscCall(MatISGetLocalMat(C, &N));
2247df21ef68SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)N, MATSEQSBAIJ, &flg));
2248df21ef68SPierre Jolivet                 if (flg) PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2249df21ef68SPierre Jolivet                 PetscCall(MatISRestoreLocalMat(C, &N));
2250df21ef68SPierre Jolivet               }
2251df21ef68SPierre Jolivet             }
22529bb5c669SPierre Jolivet             if (uaux) {
22539bb5c669SPierre Jolivet               PetscCall(MatDestroy(&uaux));
22549bb5c669SPierre Jolivet               PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
22559bb5c669SPierre Jolivet             }
22569bb5c669SPierre Jolivet           }
225713044ca3SPierre Jolivet         }
2258f1580f4eSBarry Smith       } else {
2259f1580f4eSBarry Smith         PetscCall(MatCreateSubMatrices(uaux, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2260f1580f4eSBarry Smith         PetscCall(MatDestroy(&uaux));
2261f1580f4eSBarry Smith         PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2262f1580f4eSBarry Smith       }
2263f1580f4eSBarry Smith       /* Vec holding the partition of unity */
2264f1580f4eSBarry Smith       if (!data->levels[0]->D) {
2265f1580f4eSBarry Smith         PetscCall(ISGetLocalSize(data->is, &n));
2266f1580f4eSBarry Smith         PetscCall(VecCreateMPI(PETSC_COMM_SELF, n, PETSC_DETERMINE, &data->levels[0]->D));
2267f1580f4eSBarry Smith       }
22689bb5c669SPierre Jolivet       if (data->share && overlap == -1) {
2269f1580f4eSBarry Smith         Mat      D;
2270db4a47b3SPierre Jolivet         IS       perm = nullptr;
2271f1580f4eSBarry Smith         PetscInt size = -1;
2272811e8887SPierre Jolivet 
2273398c7888SPierre Jolivet         if (!data->levels[0]->pc) {
2274398c7888SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2275398c7888SPierre Jolivet           PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
2276398c7888SPierre Jolivet           PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
2277398c7888SPierre Jolivet           PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
2278398c7888SPierre Jolivet         }
2279398c7888SPierre Jolivet         PetscCall(PCSetType(data->levels[0]->pc, PCASM));
228013044ca3SPierre Jolivet         if (!ctx) {
2281398c7888SPierre Jolivet           if (!data->levels[0]->pc->setupcalled) {
2282398c7888SPierre Jolivet             IS sorted; /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2283398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2284398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &sorted, &loc));
2285398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2286398c7888SPierre Jolivet           }
2287398c7888SPierre Jolivet           PetscCall(PCSetFromOptions(data->levels[0]->pc));
2288398c7888SPierre Jolivet           if (block) {
2289398c7888SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, sub[0], &C, &perm));
2290398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, C, algebraic));
2291398c7888SPierre Jolivet           } else PetscCall(PCSetUp(data->levels[0]->pc));
2292db4a47b3SPierre Jolivet           PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &size, nullptr, &ksp));
2293398c7888SPierre Jolivet           if (size != 1) {
2294398c7888SPierre Jolivet             data->share = PETSC_FALSE;
2295398c7888SPierre Jolivet             PetscCheck(size == -1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", size);
2296398c7888SPierre Jolivet             PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since PCASMGetSubKSP() not found in fine-level PC\n"));
2297398c7888SPierre Jolivet             PetscCall(ISDestroy(&unsorted));
2298398c7888SPierre Jolivet             unsorted = is[0];
2299398c7888SPierre Jolivet           } else {
2300811e8887SPierre Jolivet             const char *matpre;
2301811e8887SPierre Jolivet             PetscBool   cmp[4];
2302811e8887SPierre Jolivet 
230313044ca3SPierre Jolivet             if (!block && !ctx) PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, PetscBool3ToBool(data->Neumann) ? sub[0] : data->aux, &C, &perm));
2304c8ea6600SPierre Jolivet             if (!PetscBool3ToBool(data->Neumann) && !block) {
2305f1580f4eSBarry Smith               PetscCall(MatPermute(sub[0], perm, perm, &D)); /* permute since PCASM will call ISSort() */
2306f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(sub[0], &D));
2307f1580f4eSBarry Smith             }
2308f1580f4eSBarry Smith             if (data->B) { /* see PCHPDDMSetRHSMat() */
2309f1580f4eSBarry Smith               PetscCall(MatPermute(data->B, perm, perm, &D));
2310f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(data->B, &D));
2311f1580f4eSBarry Smith             }
2312f1580f4eSBarry Smith             PetscCall(ISDestroy(&perm));
2313f1580f4eSBarry Smith             PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
23140307214fSPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)subA[0]));
2315f1580f4eSBarry Smith             PetscCall(MatDuplicate(subA[1], MAT_SHARE_NONZERO_PATTERN, &D));
2316f1580f4eSBarry Smith             PetscCall(MatGetOptionsPrefix(subA[1], &matpre));
2317f1580f4eSBarry Smith             PetscCall(MatSetOptionsPrefix(D, matpre));
2318f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMAL, cmp));
2319f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMAL, cmp + 1));
2320f1580f4eSBarry Smith             if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMALHERMITIAN, cmp + 2));
2321f1580f4eSBarry Smith             else cmp[2] = PETSC_FALSE;
2322f1580f4eSBarry Smith             if (!cmp[1]) PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMALHERMITIAN, cmp + 3));
2323f1580f4eSBarry Smith             else cmp[3] = PETSC_FALSE;
2324f1580f4eSBarry Smith             PetscCheck(cmp[0] == cmp[1] && cmp[2] == cmp[3], PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_levels_1_pc_asm_sub_mat_type %s and auxiliary Mat of type %s", pcpre ? pcpre : "", ((PetscObject)D)->type_name, ((PetscObject)C)->type_name);
2325f1580f4eSBarry Smith             if (!cmp[0] && !cmp[2]) {
2326f1580f4eSBarry Smith               if (!block) PetscCall(MatAXPY(D, 1.0, C, SUBSET_NONZERO_PATTERN));
23275c7345deSPierre Jolivet               else {
2328db4a47b3SPierre Jolivet                 PetscCall(MatMissingDiagonal(D, cmp, nullptr));
23295c7345deSPierre Jolivet                 if (cmp[0]) structure = DIFFERENT_NONZERO_PATTERN; /* data->aux has no missing diagonal entry */
23305c7345deSPierre Jolivet                 PetscCall(MatAXPY(D, 1.0, data->aux, structure));
23315c7345deSPierre Jolivet               }
2332f1580f4eSBarry Smith             } else {
2333f1580f4eSBarry Smith               Mat mat[2];
2334811e8887SPierre Jolivet 
2335f1580f4eSBarry Smith               if (cmp[0]) {
2336f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(D, mat));
2337f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(C, mat + 1));
2338f1580f4eSBarry Smith               } else {
2339f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(D, mat));
2340f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(C, mat + 1));
2341f1580f4eSBarry Smith               }
2342f1580f4eSBarry Smith               PetscCall(MatAXPY(mat[0], 1.0, mat[1], SUBSET_NONZERO_PATTERN));
2343f1580f4eSBarry Smith             }
2344f1580f4eSBarry Smith             PetscCall(MatPropagateSymmetryOptions(C, D));
2345f1580f4eSBarry Smith             PetscCall(MatDestroy(&C));
2346f1580f4eSBarry Smith             C = D;
2347f1580f4eSBarry Smith             /* swap pointers so that variables stay consistent throughout PCSetUp() */
2348f1580f4eSBarry Smith             std::swap(C, data->aux);
2349f1580f4eSBarry Smith             std::swap(uis, data->is);
2350f1580f4eSBarry Smith             swap = PETSC_TRUE;
2351f1580f4eSBarry Smith           }
2352f1580f4eSBarry Smith         }
235313044ca3SPierre Jolivet       }
235413044ca3SPierre Jolivet       if (ctx) {
235513044ca3SPierre Jolivet         PC_HPDDM              *data_00 = (PC_HPDDM *)std::get<0>(*ctx)[0]->data;
235613044ca3SPierre Jolivet         PC                     s;
235700b491fbSPierre Jolivet         Mat                    A00, P00, A01 = nullptr, A10, A11, N, b[4];
235807d8d47fSPierre Jolivet         IS                     sorted, is[2], *is_00;
235913044ca3SPierre Jolivet         MatSolverType          type;
236013044ca3SPierre Jolivet         std::pair<PC, Vec[2]> *p;
236113044ca3SPierre Jolivet 
236207d8d47fSPierre Jolivet         n = -1;
236307d8d47fSPierre Jolivet         PetscTryMethod(data_00->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data_00->levels[0]->pc, &n, nullptr, &ksp));
236407d8d47fSPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
236507d8d47fSPierre Jolivet         PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
236607d8d47fSPierre Jolivet         PetscCall(ISGetLocalSize(data_00->is, &n));
236707d8d47fSPierre Jolivet         if (n != subA[0]->rmap->n || n != subA[0]->cmap->n) {
236807d8d47fSPierre Jolivet           PetscCall(PCASMGetLocalSubdomains(data_00->levels[0]->pc, &n, &is_00, nullptr));
236907d8d47fSPierre Jolivet           PetscCall(ISGetLocalSize(*is_00, &n));
237007d8d47fSPierre Jolivet           PetscCheck(n == subA[0]->rmap->n && n == subA[0]->cmap->n, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition geneo and -%spc_hpddm_define_subdomains false", pcpre ? pcpre : "", ((PetscObject)pc)->prefix);
237107d8d47fSPierre Jolivet         } else is_00 = &data_00->is;
237213044ca3SPierre Jolivet         PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, data->aux, &C, nullptr)); /* permute since PCASM works with a sorted IS */
237313044ca3SPierre Jolivet         std::swap(C, data->aux);
237413044ca3SPierre Jolivet         std::swap(uis, data->is);
237513044ca3SPierre Jolivet         swap = PETSC_TRUE;
237613044ca3SPierre Jolivet         PetscCall(PCASMSetType(data->levels[0]->pc, PC_ASM_NONE)); /* "Neumann--Neumann" preconditioning with overlap and a Boolean partition of unity */
237713044ca3SPierre Jolivet         PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &data->is, &loc));
237813044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(data->levels[0]->pc)); /* action of eq. (15) of https://hal.science/hal-02343808v6/document (with a sign flip) */
237913044ca3SPierre Jolivet         PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, std::get<1>(*ctx), &A10, &A11));
238013044ca3SPierre Jolivet         std::get<1>(*ctx)[1] = A10;
238113044ca3SPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
238213044ca3SPierre Jolivet         if (flg) PetscCall(MatTransposeGetMat(A10, &A01));
238313044ca3SPierre Jolivet         else {
238413044ca3SPierre Jolivet           PetscBool flg;
238513044ca3SPierre Jolivet 
238613044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
238713044ca3SPierre Jolivet           if (flg) PetscCall(MatHermitianTransposeGetMat(A10, &A01));
238813044ca3SPierre Jolivet         }
238907d8d47fSPierre Jolivet         PetscCall(ISDuplicate(*is_00, &sorted)); /* during setup of the PC associated to the A00 block, this IS has already been sorted, but it's put back to its original state at the end of PCSetUp_HPDDM(), which may be unsorted */
239013044ca3SPierre Jolivet         PetscCall(ISSort(sorted));               /* this is to avoid changing users inputs, but it requires a new call to ISSort() here                                                                                               */
239100b491fbSPierre Jolivet         if (!A01) {
239200b491fbSPierre Jolivet           PetscCall(MatSetOption(A10, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
239300b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A10, 1, &data->is, &sorted, MAT_INITIAL_MATRIX, &sub));
239400b491fbSPierre Jolivet           b[2] = sub[0];
239500b491fbSPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
239600b491fbSPierre Jolivet           PetscCall(MatDestroySubMatrices(1, &sub));
239700b491fbSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATTRANSPOSEVIRTUAL, &flg));
239800b491fbSPierre Jolivet           A10 = nullptr;
239900b491fbSPierre Jolivet           if (flg) PetscCall(MatTransposeGetMat(std::get<1>(*ctx)[0], &A10));
240013044ca3SPierre Jolivet           else {
240100b491fbSPierre Jolivet             PetscBool flg;
240200b491fbSPierre Jolivet 
2403c71f06a7SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATHERMITIANTRANSPOSEVIRTUAL, &flg));
240400b491fbSPierre Jolivet             if (flg) PetscCall(MatHermitianTransposeGetMat(std::get<1>(*ctx)[0], &A10));
240513044ca3SPierre Jolivet           }
2406811e8887SPierre Jolivet           if (!A10) PetscCall(MatCreateSubMatrices(std::get<1>(*ctx)[0], 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2407811e8887SPierre Jolivet           else {
2408811e8887SPierre Jolivet             if (flg) PetscCall(MatCreateTranspose(b[2], b + 1));
2409811e8887SPierre Jolivet             else PetscCall(MatCreateHermitianTranspose(b[2], b + 1));
241000b491fbSPierre Jolivet           }
241100b491fbSPierre Jolivet         } else {
241200b491fbSPierre Jolivet           PetscCall(MatSetOption(A01, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
241300b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A01, 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2414811e8887SPierre Jolivet           if (flg) PetscCall(MatCreateTranspose(*sub, b + 2));
2415811e8887SPierre Jolivet           else PetscCall(MatCreateHermitianTranspose(*sub, b + 2));
2416811e8887SPierre Jolivet         }
2417811e8887SPierre Jolivet         if (A01 || !A10) {
2418811e8887SPierre Jolivet           b[1] = sub[0];
2419811e8887SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
242000b491fbSPierre Jolivet         }
242100b491fbSPierre Jolivet         PetscCall(MatDestroySubMatrices(1, &sub));
242213044ca3SPierre Jolivet         PetscCall(ISDestroy(&sorted));
242300b491fbSPierre Jolivet         PetscCall(MatCreateSchurComplement(subA[0], subA[1], b[1], b[2], data->aux, &S));
242413044ca3SPierre Jolivet         PetscCall(MatSchurComplementSetKSP(S, ksp[0]));
242513044ca3SPierre Jolivet         PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, S, PETSC_TRUE)); /* the subdomain Mat is already known and the input IS of PCASMSetLocalSubdomains() is already sorted */
242613044ca3SPierre Jolivet         PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
242713044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
242813044ca3SPierre Jolivet         PetscCall(KSPGetPC(ksp[0], &inner));
242913044ca3SPierre Jolivet         PetscCall(PCSetType(inner, PCSHELL)); /* compute the action of the inverse of the local Schur complement with a PCSHELL */
243013044ca3SPierre Jolivet         b[0] = subA[0];
243113044ca3SPierre Jolivet         b[3] = data->aux;
243213044ca3SPierre Jolivet         PetscCall(MatCreateNest(PETSC_COMM_SELF, 2, nullptr, 2, nullptr, b, &N)); /* instead of computing inv(A11 - A10 inv(A00) A01), compute inv([A00, A01; A10, A11]) followed by a partial solution associated to the A11 block */
243300b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[1]));
243400b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[2]));
243513044ca3SPierre Jolivet         PetscCall(PCCreate(PETSC_COMM_SELF, &s));
243613044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(s, ((PetscObject)inner)->prefix));
243713044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(inner, nullptr));
243813044ca3SPierre Jolivet         PetscCall(KSPSetSkipPCSetFromOptions(ksp[0], PETSC_TRUE));
243913044ca3SPierre Jolivet         PetscCall(PCSetType(s, PCLU));
244013044ca3SPierre Jolivet         if (PetscDefined(HAVE_MUMPS)) { /* only MATSOLVERMUMPS handles MATNEST, so for the others, e.g., MATSOLVERPETSC or MATSOLVERMKL_PARDISO, convert to plain MATAIJ */
244113044ca3SPierre Jolivet           PetscCall(PCFactorSetMatSolverType(s, MATSOLVERMUMPS));
244213044ca3SPierre Jolivet         }
244313044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(s));
244413044ca3SPierre Jolivet         PetscCall(PCFactorGetMatSolverType(s, &type));
244513044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
244613044ca3SPierre Jolivet         if (flg) {
244713044ca3SPierre Jolivet           PetscCall(PCSetOperators(s, N, N));
244800b491fbSPierre Jolivet           PetscCall(PCFactorGetMatrix(s, b));
244900b491fbSPierre Jolivet           PetscCall(MatSetOptionsPrefix(*b, ((PetscObject)s)->prefix));
245024ddd604SPierre Jolivet           n = -1;
245124ddd604SPierre Jolivet           PetscCall(PetscOptionsGetInt(nullptr, ((PetscObject)s)->prefix, "-mat_mumps_icntl_26", &n, nullptr));
2452f45b553cSPierre Jolivet           if (n == 1) {                                /* allocates a square MatDense of size is[1]->map->n, so one */
2453f45b553cSPierre Jolivet             PetscCall(MatNestGetISs(N, is, nullptr));  /*  needs to be able to deactivate this path when dealing    */
2454f45b553cSPierre Jolivet             PetscCall(MatFactorSetSchurIS(*b, is[1])); /*  with a large constraint space in order to avoid OOM      */
2455f45b553cSPierre Jolivet           }
245613044ca3SPierre Jolivet         } else {
245700b491fbSPierre Jolivet           PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, b));
245800b491fbSPierre Jolivet           PetscCall(PCSetOperators(s, N, *b));
245900b491fbSPierre Jolivet           PetscCall(PetscObjectDereference((PetscObject)*b));
246000b491fbSPierre Jolivet           PetscCall(PCFactorGetMatrix(s, b)); /* MATSOLVERMKL_PARDISO cannot compute in PETSc (yet) a partial solution associated to the A11 block, only partial solution associated to the A00 block or full solution */
246113044ca3SPierre Jolivet         }
246213044ca3SPierre Jolivet         PetscCall(PetscNew(&p));
246313044ca3SPierre Jolivet         p->first = s;
246400b491fbSPierre Jolivet         PetscCall(MatCreateVecs(*b, p->second, p->second + 1));
246513044ca3SPierre Jolivet         PetscCall(PCShellSetContext(inner, p));
246613044ca3SPierre Jolivet         PetscCall(PCShellSetApply(inner, PCApply_Nest));
246713044ca3SPierre Jolivet         PetscCall(PCShellSetView(inner, PCView_Nest));
246813044ca3SPierre Jolivet         PetscCall(PCShellSetDestroy(inner, PCDestroy_Nest));
246913044ca3SPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)N));
247013044ca3SPierre Jolivet       }
2471f1580f4eSBarry Smith       if (!data->levels[0]->scatter) {
2472db4a47b3SPierre Jolivet         PetscCall(MatCreateVecs(P, &xin, nullptr));
2473f1580f4eSBarry Smith         if (ismatis) PetscCall(MatDestroy(&P));
2474db4a47b3SPierre Jolivet         PetscCall(VecScatterCreate(xin, data->is, data->levels[0]->D, nullptr, &data->levels[0]->scatter));
2475f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
2476f1580f4eSBarry Smith       }
2477f1580f4eSBarry Smith       if (data->levels[0]->P) {
2478f1580f4eSBarry Smith         /* if the pattern is the same and PCSetUp() has previously succeeded, reuse HPDDM buffers and connectivity */
2479f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[0], pc->setupcalled < 1 || pc->flag == DIFFERENT_NONZERO_PATTERN ? PETSC_TRUE : PETSC_FALSE));
2480f1580f4eSBarry Smith       }
2481f1580f4eSBarry Smith       if (!data->levels[0]->P) data->levels[0]->P = new HPDDM::Schwarz<PetscScalar>();
2482db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2483db4a47b3SPierre Jolivet       else PetscCall(PetscLogEventBegin(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2484f1580f4eSBarry Smith       /* HPDDM internal data structure */
248513044ca3SPierre Jolivet       PetscCall(data->levels[0]->P->structure(loc, data->is, !ctx ? sub[0] : nullptr, ismatis ? C : data->aux, data->levels));
2486db4a47b3SPierre Jolivet       if (!data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2487f1580f4eSBarry Smith       /* matrix pencil of the generalized eigenvalue problem on the overlap (GenEO) */
248813044ca3SPierre Jolivet       if (!ctx) {
24899bb5c669SPierre Jolivet         if (data->deflation || overlap != -1) weighted = data->aux;
2490f1580f4eSBarry Smith         else if (!data->B) {
2491e2b46ddfSPierre Jolivet           PetscBool cmp;
2492811e8887SPierre Jolivet 
2493f1580f4eSBarry Smith           PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &weighted));
2494e2b46ddfSPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)weighted, &cmp, MATNORMAL, MATNORMALHERMITIAN, ""));
2495e2b46ddfSPierre Jolivet           if (cmp) flg = PETSC_FALSE;
2496e2b46ddfSPierre Jolivet           PetscCall(MatDiagonalScale(weighted, data->levels[0]->D, data->levels[0]->D));
24975b0bb9f2SPierre Jolivet           /* neither MatDuplicate() nor MatDiagonalScale() handles the symmetry options, so propagate the options explicitly */
2498f1580f4eSBarry Smith           /* only useful for -mat_type baij -pc_hpddm_levels_1_st_pc_type cholesky (no problem with MATAIJ or MATSBAIJ)      */
2499f1580f4eSBarry Smith           PetscCall(MatPropagateSymmetryOptions(sub[0], weighted));
2500f1580f4eSBarry Smith         } else weighted = data->B;
250113044ca3SPierre Jolivet       } else weighted = nullptr;
2502f1580f4eSBarry Smith       /* SLEPc is used inside the loaded symbol */
25039bb5c669SPierre Jolivet       PetscCall((*loadedSym)(data->levels[0]->P, data->is, ismatis ? C : (algebraic && !block && overlap == -1 ? sub[0] : (!ctx ? data->aux : S)), weighted, data->B, initial, data->levels));
25049bb5c669SPierre Jolivet       if (!ctx && data->share && overlap == -1) {
2505f1580f4eSBarry Smith         Mat st[2];
2506f1580f4eSBarry Smith         PetscCall(KSPGetOperators(ksp[0], st, st + 1));
25075c7345deSPierre Jolivet         PetscCall(MatCopy(subA[0], st[0], structure));
2508f1580f4eSBarry Smith         if (subA[1] != subA[0] || st[1] != st[0]) PetscCall(MatCopy(subA[1], st[1], SAME_NONZERO_PATTERN));
25090307214fSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)subA[0]));
2510f1580f4eSBarry Smith       }
2511db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2512f1580f4eSBarry Smith       if (ismatis) PetscCall(MatISGetLocalMat(C, &N));
2513f1580f4eSBarry Smith       else N = data->aux;
251413044ca3SPierre Jolivet       if (!ctx) P = sub[0];
251513044ca3SPierre Jolivet       else P = S;
2516f1580f4eSBarry Smith       /* going through the grid hierarchy */
2517f1580f4eSBarry Smith       for (n = 1; n < data->N; ++n) {
2518db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2519f1580f4eSBarry Smith         /* method composed in the loaded symbol since there, SLEPc is used as well */
2520f1580f4eSBarry Smith         PetscTryMethod(data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", (Mat *, Mat *, PetscInt, PetscInt *const, PC_HPDDM_Level **const), (&P, &N, n, &data->N, data->levels));
2521db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2522f1580f4eSBarry Smith       }
2523f1580f4eSBarry Smith       /* reset to NULL to avoid any faulty use */
2524db4a47b3SPierre Jolivet       PetscCall(PetscObjectComposeFunction((PetscObject)data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", nullptr));
2525db4a47b3SPierre Jolivet       if (!ismatis) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_C", nullptr));
2526f1580f4eSBarry Smith       else PetscCall(PetscObjectDereference((PetscObject)C)); /* matching PetscObjectReference() above */
2527f1580f4eSBarry Smith       for (n = 0; n < data->N - 1; ++n)
2528f1580f4eSBarry Smith         if (data->levels[n]->P) {
2529f1580f4eSBarry Smith           /* HPDDM internal work buffers */
2530f1580f4eSBarry Smith           data->levels[n]->P->setBuffer();
2531f1580f4eSBarry Smith           data->levels[n]->P->super::start();
2532f1580f4eSBarry Smith         }
25339bb5c669SPierre Jolivet       if (ismatis || !subdomains) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
2534db4a47b3SPierre Jolivet       if (ismatis) data->is = nullptr;
2535f1580f4eSBarry Smith       for (n = 0; n < data->N - 1 + (reused > 0); ++n) {
2536f1580f4eSBarry Smith         if (data->levels[n]->P) {
2537f1580f4eSBarry Smith           PC spc;
2538f1580f4eSBarry Smith 
2539f1580f4eSBarry Smith           /* force the PC to be PCSHELL to do the coarse grid corrections */
2540f1580f4eSBarry Smith           PetscCall(KSPSetSkipPCSetFromOptions(data->levels[n]->ksp, PETSC_TRUE));
2541f1580f4eSBarry Smith           PetscCall(KSPGetPC(data->levels[n]->ksp, &spc));
2542f1580f4eSBarry Smith           PetscCall(PCSetType(spc, PCSHELL));
2543f1580f4eSBarry Smith           PetscCall(PCShellSetContext(spc, data->levels[n]));
2544f1580f4eSBarry Smith           PetscCall(PCShellSetSetUp(spc, PCSetUp_HPDDMShell));
2545f1580f4eSBarry Smith           PetscCall(PCShellSetApply(spc, PCApply_HPDDMShell));
2546f1580f4eSBarry Smith           PetscCall(PCShellSetMatApply(spc, PCMatApply_HPDDMShell));
254713044ca3SPierre Jolivet           if (ctx && n == 0) {
254813044ca3SPierre Jolivet             Mat                               Amat, Pmat;
254913044ca3SPierre Jolivet             PetscInt                          m, M;
255001e3c840SPierre Jolivet             std::tuple<Mat, PetscSF, Vec[2]> *ctx;
255113044ca3SPierre Jolivet 
255213044ca3SPierre Jolivet             PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &Pmat));
255313044ca3SPierre Jolivet             PetscCall(MatGetLocalSize(Pmat, &m, nullptr));
255413044ca3SPierre Jolivet             PetscCall(MatGetSize(Pmat, &M, nullptr));
255513044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));
255613044ca3SPierre Jolivet             std::get<0>(*ctx) = S;
255713044ca3SPierre Jolivet             std::get<1>(*ctx) = data->levels[n]->scatter;
255813044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)data->levels[n]->ksp), m, m, M, M, ctx, &Amat));
255913044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT, (void (*)(void))MatMult_Schur<false>));
256013044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMult_Schur<true>));
256113044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_DESTROY, (void (*)(void))MatDestroy_Schur));
256213044ca3SPierre Jolivet             PetscCall(MatCreateVecs(S, std::get<2>(*ctx), std::get<2>(*ctx) + 1));
256313044ca3SPierre Jolivet             PetscCall(KSPSetOperators(data->levels[n]->ksp, Amat, Pmat));
256413044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)Amat));
256513044ca3SPierre Jolivet           }
2566f1580f4eSBarry Smith           PetscCall(PCShellSetDestroy(spc, PCDestroy_HPDDMShell));
2567f1580f4eSBarry Smith           if (!data->levels[n]->pc) PetscCall(PCCreate(PetscObjectComm((PetscObject)data->levels[n]->ksp), &data->levels[n]->pc));
2568f1580f4eSBarry Smith           if (n < reused) {
2569f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(spc, PETSC_TRUE));
2570f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
2571f1580f4eSBarry Smith           }
2572f1580f4eSBarry Smith           PetscCall(PCSetUp(spc));
2573f1580f4eSBarry Smith         }
2574f1580f4eSBarry Smith       }
257513044ca3SPierre Jolivet       if (ctx) PetscCall(MatDestroy(&S));
25769bb5c669SPierre Jolivet       if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", nullptr));
2577f1580f4eSBarry Smith     } else flg = reused ? PETSC_FALSE : PETSC_TRUE;
2578f1580f4eSBarry Smith     if (!ismatis && subdomains) {
2579f1580f4eSBarry Smith       if (flg) PetscCall(KSPGetPC(data->levels[0]->ksp, &inner));
2580f1580f4eSBarry Smith       else inner = data->levels[0]->pc;
2581f1580f4eSBarry Smith       if (inner) {
2582398c7888SPierre Jolivet         if (!inner->setupcalled) PetscCall(PCSetType(inner, PCASM));
2583398c7888SPierre Jolivet         PetscCall(PCSetFromOptions(inner));
2584398c7888SPierre Jolivet         PetscCall(PetscStrcmp(((PetscObject)inner)->type_name, PCASM, &flg));
2585398c7888SPierre Jolivet         if (flg) {
2586f1580f4eSBarry Smith           if (!inner->setupcalled) { /* evaluates to PETSC_FALSE when -pc_hpddm_block_splitting */
2587398c7888SPierre Jolivet             IS sorted;               /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2588811e8887SPierre Jolivet 
2589398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2590398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(inner, 1, &sorted, &loc));
2591398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2592398c7888SPierre Jolivet           }
2593c8ea6600SPierre Jolivet           if (!PetscBool3ToBool(data->Neumann) && data->N > 1) { /* subdomain matrices are already created for the eigenproblem, reuse them for the fine-level PC */
2594db4a47b3SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(*is, nullptr, nullptr, sub[0], &P, nullptr));
2595398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(inner, P, algebraic));
2596398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)P));
2597f1580f4eSBarry Smith           }
2598f1580f4eSBarry Smith         }
2599f1580f4eSBarry Smith       }
26009bb5c669SPierre Jolivet       if (data->N > 1) {
26019bb5c669SPierre Jolivet         if (overlap != 1) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
26029bb5c669SPierre Jolivet         if (overlap == 1) PetscCall(MatDestroy(subA));
26039bb5c669SPierre Jolivet       }
2604f1580f4eSBarry Smith     }
2605f1580f4eSBarry Smith     PetscCall(ISDestroy(&loc));
2606f1580f4eSBarry Smith   } else data->N = 1 + reused; /* enforce this value to 1 + reused if there is no way to build another level */
2607f1580f4eSBarry Smith   if (requested != data->N + reused) {
2608f1580f4eSBarry Smith     PetscCall(PetscInfo(pc, "%" PetscInt_FMT " levels requested, only %" PetscInt_FMT " built + %" PetscInt_FMT " reused. Options for level(s) > %" PetscInt_FMT ", including -%spc_hpddm_coarse_ will not be taken into account\n", requested, data->N, reused,
2609f1580f4eSBarry Smith                         data->N, pcpre ? pcpre : ""));
2610f1580f4eSBarry Smith     PetscCall(PetscInfo(pc, "It is best to tune parameters, e.g., a higher value for -%spc_hpddm_levels_%" PetscInt_FMT "_eps_threshold so that at least one local deflation vector will be selected\n", pcpre ? pcpre : "", data->N));
2611f1580f4eSBarry Smith     /* cannot use PCDestroy_HPDDMShell() because PCSHELL not set for unassembled levels */
2612f1580f4eSBarry Smith     for (n = data->N - 1; n < requested - 1; ++n) {
2613f1580f4eSBarry Smith       if (data->levels[n]->P) {
2614f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[n], PETSC_TRUE));
2615f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(1, &data->levels[n]->v[0]));
2616f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(2, &data->levels[n]->v[1]));
2617f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V));
2618f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 1));
2619f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 2));
2620f1580f4eSBarry Smith         PetscCall(VecDestroy(&data->levels[n]->D));
262101e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&data->levels[n]->scatter));
2622f1580f4eSBarry Smith       }
2623f1580f4eSBarry Smith     }
2624f1580f4eSBarry Smith     if (reused) {
2625f1580f4eSBarry Smith       for (n = reused; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
2626f1580f4eSBarry Smith         PetscCall(KSPDestroy(&data->levels[n]->ksp));
2627f1580f4eSBarry Smith         PetscCall(PCDestroy(&data->levels[n]->pc));
2628f1580f4eSBarry Smith       }
2629f1580f4eSBarry Smith     }
2630f1580f4eSBarry Smith     PetscCheck(!PetscDefined(USE_DEBUG), PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "%" PetscInt_FMT " levels requested, only %" PetscInt_FMT " built + %" PetscInt_FMT " reused. Options for level(s) > %" PetscInt_FMT ", including -%spc_hpddm_coarse_ will not be taken into account. It is best to tune parameters, e.g., a higher value for -%spc_hpddm_levels_%" PetscInt_FMT "_eps_threshold so that at least one local deflation vector will be selected. If you don't want this to error out, compile --with-debugging=0", requested,
2631f1580f4eSBarry Smith                data->N, reused, data->N, pcpre ? pcpre : "", pcpre ? pcpre : "", data->N);
2632f1580f4eSBarry Smith   }
2633f1580f4eSBarry Smith   /* these solvers are created after PCSetFromOptions() is called */
2634f1580f4eSBarry Smith   if (pc->setfromoptionscalled) {
2635f1580f4eSBarry Smith     for (n = 0; n < data->N; ++n) {
2636f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetFromOptions(data->levels[n]->ksp));
2637f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetFromOptions(data->levels[n]->pc));
2638f1580f4eSBarry Smith     }
2639f1580f4eSBarry Smith     pc->setfromoptionscalled = 0;
2640f1580f4eSBarry Smith   }
2641f1580f4eSBarry Smith   data->N += reused;
2642f1580f4eSBarry Smith   if (data->share && swap) {
2643f1580f4eSBarry Smith     /* swap back pointers so that variables follow the user-provided numbering */
2644f1580f4eSBarry Smith     std::swap(C, data->aux);
2645f1580f4eSBarry Smith     std::swap(uis, data->is);
2646f1580f4eSBarry Smith     PetscCall(MatDestroy(&C));
2647f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
2648f1580f4eSBarry Smith   }
2649398c7888SPierre Jolivet   if (algebraic) PetscCall(MatDestroy(&data->aux));
265038fb34a1SPierre Jolivet   if (unsorted && unsorted != is[0]) {
2651398c7888SPierre Jolivet     PetscCall(ISCopy(unsorted, data->is));
2652398c7888SPierre Jolivet     PetscCall(ISDestroy(&unsorted));
2653398c7888SPierre Jolivet   }
2654398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2655398c7888SPierre Jolivet   PetscCheck((data->is && dis) || (!data->is && !dis), PETSC_COMM_SELF, PETSC_ERR_PLIB, "An IS pointer is NULL but not the other: input IS pointer (%p) v. output IS pointer (%p)", (void *)dis, (void *)data->is);
2656398c7888SPierre Jolivet   if (data->is) {
2657398c7888SPierre Jolivet     PetscCall(ISEqualUnsorted(data->is, dis, &flg));
2658398c7888SPierre Jolivet     PetscCall(ISDestroy(&dis));
2659398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input IS and output IS are not equal");
2660398c7888SPierre Jolivet   }
2661398c7888SPierre Jolivet   PetscCheck((data->aux && daux) || (!data->aux && !daux), PETSC_COMM_SELF, PETSC_ERR_PLIB, "A Mat pointer is NULL but not the other: input Mat pointer (%p) v. output Mat pointer (%p)", (void *)daux, (void *)data->aux);
2662398c7888SPierre Jolivet   if (data->aux) {
2663398c7888SPierre Jolivet     PetscCall(MatMultEqual(data->aux, daux, 20, &flg));
2664398c7888SPierre Jolivet     PetscCall(MatDestroy(&daux));
2665398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input Mat and output Mat are not equal");
2666398c7888SPierre Jolivet   }
2667398c7888SPierre Jolivet #endif
26683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2669f1580f4eSBarry Smith }
2670f1580f4eSBarry Smith 
2671f1580f4eSBarry Smith /*@
2672f1580f4eSBarry Smith   PCHPDDMSetCoarseCorrectionType - Sets the coarse correction type.
2673f1580f4eSBarry Smith 
2674c3339decSBarry Smith   Collective
2675f1580f4eSBarry Smith 
2676f1580f4eSBarry Smith   Input Parameters:
2677f1580f4eSBarry Smith + pc   - preconditioner context
2678aa1539e9SPierre Jolivet - type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2679f1580f4eSBarry Smith 
2680f1580f4eSBarry Smith   Options Database Key:
2681aa1539e9SPierre Jolivet . -pc_hpddm_coarse_correction <deflated, additive, balanced, none> - type of coarse correction to apply
2682f1580f4eSBarry Smith 
2683f1580f4eSBarry Smith   Level: intermediate
2684f1580f4eSBarry Smith 
2685562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2686f1580f4eSBarry Smith @*/
2687d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType type)
2688d71ae5a4SJacob Faibussowitsch {
2689f1580f4eSBarry Smith   PetscFunctionBegin;
2690f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2691f1580f4eSBarry Smith   PetscValidLogicalCollectiveEnum(pc, type, 2);
2692f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMSetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType), (pc, type));
26933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2694f1580f4eSBarry Smith }
2695f1580f4eSBarry Smith 
2696f1580f4eSBarry Smith /*@
2697f1580f4eSBarry Smith   PCHPDDMGetCoarseCorrectionType - Gets the coarse correction type.
2698f1580f4eSBarry Smith 
2699f1580f4eSBarry Smith   Input Parameter:
2700f1580f4eSBarry Smith . pc - preconditioner context
2701f1580f4eSBarry Smith 
2702f1580f4eSBarry Smith   Output Parameter:
2703aa1539e9SPierre Jolivet . type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2704f1580f4eSBarry Smith 
2705f1580f4eSBarry Smith   Level: intermediate
2706f1580f4eSBarry Smith 
2707562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2708f1580f4eSBarry Smith @*/
2709d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType *type)
2710d71ae5a4SJacob Faibussowitsch {
2711f1580f4eSBarry Smith   PetscFunctionBegin;
2712f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2713f1580f4eSBarry Smith   if (type) {
27144f572ea9SToby Isaac     PetscAssertPointer(type, 2);
2715f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType *), (pc, type));
2716f1580f4eSBarry Smith   }
27173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2718f1580f4eSBarry Smith }
2719f1580f4eSBarry Smith 
2720d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType type)
2721d71ae5a4SJacob Faibussowitsch {
2722f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2723f1580f4eSBarry Smith 
2724f1580f4eSBarry Smith   PetscFunctionBegin;
2725f1580f4eSBarry Smith   data->correction = type;
27263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2727f1580f4eSBarry Smith }
2728f1580f4eSBarry Smith 
2729d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType *type)
2730d71ae5a4SJacob Faibussowitsch {
2731f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2732f1580f4eSBarry Smith 
2733f1580f4eSBarry Smith   PetscFunctionBegin;
2734f1580f4eSBarry Smith   *type = data->correction;
27353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2736f1580f4eSBarry Smith }
2737f1580f4eSBarry Smith 
2738f1580f4eSBarry Smith /*@
2739e31fc274SPierre Jolivet   PCHPDDMSetSTShareSubKSP - Sets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver should be shared.
2740e31fc274SPierre Jolivet 
2741e31fc274SPierre Jolivet   Input Parameters:
2742e31fc274SPierre Jolivet + pc    - preconditioner context
2743e31fc274SPierre Jolivet - share - whether the `KSP` should be shared or not
2744e31fc274SPierre Jolivet 
2745e31fc274SPierre Jolivet   Note:
2746e31fc274SPierre Jolivet   This is not the same as `PCSetReusePreconditioner()`. Given certain conditions (visible using -info), a symbolic factorization can be skipped
2747e31fc274SPierre Jolivet   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2748e31fc274SPierre Jolivet 
2749e31fc274SPierre Jolivet   Level: advanced
2750e31fc274SPierre Jolivet 
2751562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMGetSTShareSubKSP()`
2752e31fc274SPierre Jolivet @*/
2753e31fc274SPierre Jolivet PetscErrorCode PCHPDDMSetSTShareSubKSP(PC pc, PetscBool share)
2754e31fc274SPierre Jolivet {
2755e31fc274SPierre Jolivet   PetscFunctionBegin;
2756e31fc274SPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2757e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetSTShareSubKSP_C", (PC, PetscBool), (pc, share));
27583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2759e31fc274SPierre Jolivet }
2760e31fc274SPierre Jolivet 
2761e31fc274SPierre Jolivet /*@
2762f1580f4eSBarry Smith   PCHPDDMGetSTShareSubKSP - Gets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver is shared.
2763f1580f4eSBarry Smith 
2764f1580f4eSBarry Smith   Input Parameter:
2765f1580f4eSBarry Smith . pc - preconditioner context
2766f1580f4eSBarry Smith 
2767f1580f4eSBarry Smith   Output Parameter:
2768f1580f4eSBarry Smith . share - whether the `KSP` is shared or not
2769f1580f4eSBarry Smith 
2770f1580f4eSBarry Smith   Note:
2771f1580f4eSBarry Smith   This is not the same as `PCGetReusePreconditioner()`. The return value is unlikely to be true, but when it is, a symbolic factorization can be skipped
2772f1580f4eSBarry Smith   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2773f1580f4eSBarry Smith 
2774f1580f4eSBarry Smith   Level: advanced
2775f1580f4eSBarry Smith 
2776562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetSTShareSubKSP()`
2777f1580f4eSBarry Smith @*/
2778d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetSTShareSubKSP(PC pc, PetscBool *share)
2779d71ae5a4SJacob Faibussowitsch {
2780f1580f4eSBarry Smith   PetscFunctionBegin;
2781f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2782f1580f4eSBarry Smith   if (share) {
27834f572ea9SToby Isaac     PetscAssertPointer(share, 2);
2784f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetSTShareSubKSP_C", (PC, PetscBool *), (pc, share));
2785f1580f4eSBarry Smith   }
27863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2787f1580f4eSBarry Smith }
2788f1580f4eSBarry Smith 
2789e31fc274SPierre Jolivet static PetscErrorCode PCHPDDMSetSTShareSubKSP_HPDDM(PC pc, PetscBool share)
2790e31fc274SPierre Jolivet {
2791e31fc274SPierre Jolivet   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2792e31fc274SPierre Jolivet 
2793e31fc274SPierre Jolivet   PetscFunctionBegin;
2794e31fc274SPierre Jolivet   data->share = share;
27953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2796e31fc274SPierre Jolivet }
2797e31fc274SPierre Jolivet 
2798d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetSTShareSubKSP_HPDDM(PC pc, PetscBool *share)
2799d71ae5a4SJacob Faibussowitsch {
2800f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2801f1580f4eSBarry Smith 
2802f1580f4eSBarry Smith   PetscFunctionBegin;
2803f1580f4eSBarry Smith   *share = data->share;
28043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2805f1580f4eSBarry Smith }
2806f1580f4eSBarry Smith 
2807f1580f4eSBarry Smith /*@
2808f1580f4eSBarry Smith   PCHPDDMSetDeflationMat - Sets the deflation space used to assemble a coarser operator.
2809f1580f4eSBarry Smith 
2810f1580f4eSBarry Smith   Input Parameters:
2811f1580f4eSBarry Smith + pc - preconditioner context
2812f1580f4eSBarry Smith . is - index set of the local deflation matrix
2813f1580f4eSBarry Smith - U  - deflation sequential matrix stored as a `MATSEQDENSE`
2814f1580f4eSBarry Smith 
2815f1580f4eSBarry Smith   Level: advanced
2816f1580f4eSBarry Smith 
2817562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCDeflationSetSpace()`, `PCMGSetRestriction()`
2818f1580f4eSBarry Smith @*/
2819d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetDeflationMat(PC pc, IS is, Mat U)
2820d71ae5a4SJacob Faibussowitsch {
2821f1580f4eSBarry Smith   PetscFunctionBegin;
2822f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2823f1580f4eSBarry Smith   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
2824f1580f4eSBarry Smith   PetscValidHeaderSpecific(U, MAT_CLASSID, 3);
2825e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetDeflationMat_C", (PC, IS, Mat), (pc, is, U));
28263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2827f1580f4eSBarry Smith }
2828f1580f4eSBarry Smith 
2829d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetDeflationMat_HPDDM(PC pc, IS is, Mat U)
2830d71ae5a4SJacob Faibussowitsch {
2831f1580f4eSBarry Smith   PetscFunctionBegin;
2832f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, U, PETSC_TRUE));
28333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2834f1580f4eSBarry Smith }
2835f1580f4eSBarry Smith 
2836d71ae5a4SJacob Faibussowitsch PetscErrorCode HPDDMLoadDL_Private(PetscBool *found)
2837d71ae5a4SJacob Faibussowitsch {
2838605ad303SPierre Jolivet   PetscBool flg;
2839f1580f4eSBarry Smith   char      lib[PETSC_MAX_PATH_LEN], dlib[PETSC_MAX_PATH_LEN], dir[PETSC_MAX_PATH_LEN];
2840f1580f4eSBarry Smith 
2841f1580f4eSBarry Smith   PetscFunctionBegin;
28424f572ea9SToby Isaac   PetscAssertPointer(found, 1);
2843c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(dir, "${PETSC_LIB_DIR}", sizeof(dir)));
2844db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, nullptr, "-hpddm_dir", dir, sizeof(dir), nullptr));
2845f1580f4eSBarry Smith   PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2846f1580f4eSBarry Smith   PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2847605ad303SPierre Jolivet #if defined(SLEPC_LIB_DIR) /* this variable is passed during SLEPc ./configure when PETSc has not been configured   */
2848605ad303SPierre Jolivet   if (!*found) {           /* with --download-hpddm since slepcconf.h is not yet built (and thus can't be included) */
2849c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(dir, HPDDM_STR(SLEPC_LIB_DIR), sizeof(dir)));
2850f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2851f1580f4eSBarry Smith     PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2852f1580f4eSBarry Smith   }
2853f1580f4eSBarry Smith #endif
2854605ad303SPierre Jolivet   if (!*found) { /* probable options for this to evaluate to PETSC_TRUE: system inconsistency (libhpddm_petsc moved by user?) or PETSc configured without --download-slepc */
2855605ad303SPierre Jolivet     PetscCall(PetscOptionsGetenv(PETSC_COMM_SELF, "SLEPC_DIR", dir, sizeof(dir), &flg));
2856605ad303SPierre Jolivet     if (flg) { /* if both PETSc and SLEPc are configured with --download-hpddm but PETSc has been configured without --download-slepc, one must ensure that libslepc is loaded before libhpddm_petsc */
2857605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libslepc", dir));
2858605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2859605ad303SPierre Jolivet       PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found but SLEPC_DIR=%s", lib, dir);
2860605ad303SPierre Jolivet       PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
2861605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libhpddm_petsc", dir)); /* libhpddm_petsc is always in the same directory as libslepc */
2862605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2863605ad303SPierre Jolivet     }
2864605ad303SPierre Jolivet   }
2865f1580f4eSBarry Smith   PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found", lib);
2866f1580f4eSBarry Smith   PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
28673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2868f1580f4eSBarry Smith }
2869f1580f4eSBarry Smith 
2870f1580f4eSBarry Smith /*MC
2871f1580f4eSBarry Smith    PCHPDDM - Interface with the HPDDM library.
2872f1580f4eSBarry Smith 
28731d27aa22SBarry Smith    This `PC` may be used to build multilevel spectral domain decomposition methods based on the GenEO framework {cite}`spillane2011robust` {cite}`al2021multilevel`.
28741d27aa22SBarry Smith    It may be viewed as an alternative to spectral
28751d27aa22SBarry Smith    AMGe or `PCBDDC` with adaptive selection of constraints. The interface is explained in details in {cite}`jolivetromanzampini2020`
2876f1580f4eSBarry Smith 
2877e7593814SPierre Jolivet    The matrix used for building the preconditioner (Pmat) may be unassembled (`MATIS`), assembled (`MATAIJ`, `MATBAIJ`, or `MATSBAIJ`), hierarchical (`MATHTOOL`), `MATNORMAL`, `MATNORMALHERMITIAN`, or `MATSCHURCOMPLEMENT` (when `PCHPDDM` is used as part of an outer `PCFIELDSPLIT`).
2878f1580f4eSBarry Smith 
2879f1580f4eSBarry Smith    For multilevel preconditioning, when using an assembled or hierarchical Pmat, one must provide an auxiliary local `Mat` (unassembled local operator for GenEO) using
2880f1580f4eSBarry Smith    `PCHPDDMSetAuxiliaryMat()`. Calling this routine is not needed when using a `MATIS` Pmat, assembly is done internally using `MatConvert()`.
2881f1580f4eSBarry Smith 
2882f1580f4eSBarry Smith    Options Database Keys:
2883f1580f4eSBarry Smith +   -pc_hpddm_define_subdomains <true, default=false>    - on the finest level, calls `PCASMSetLocalSubdomains()` with the `IS` supplied in `PCHPDDMSetAuxiliaryMat()`
2884f1580f4eSBarry Smith                                                          (not relevant with an unassembled Pmat)
2885f1580f4eSBarry Smith .   -pc_hpddm_has_neumann <true, default=false>          - on the finest level, informs the `PC` that the local Neumann matrix is supplied in `PCHPDDMSetAuxiliaryMat()`
2886f1580f4eSBarry Smith -   -pc_hpddm_coarse_correction <type, default=deflated> - determines the `PCHPDDMCoarseCorrectionType` when calling `PCApply()`
2887f1580f4eSBarry Smith 
288838bf2a8cSPierre Jolivet    Options for subdomain solvers, subdomain eigensolvers (for computing deflation vectors), and the coarse solver can be set using the following options database prefixes.
2889f1580f4eSBarry Smith .vb
2890f1580f4eSBarry Smith       -pc_hpddm_levels_%d_pc_
2891f1580f4eSBarry Smith       -pc_hpddm_levels_%d_ksp_
2892f1580f4eSBarry Smith       -pc_hpddm_levels_%d_eps_
2893f1580f4eSBarry Smith       -pc_hpddm_levels_%d_p
28944ec2a359SPierre Jolivet       -pc_hpddm_levels_%d_mat_type
2895f1580f4eSBarry Smith       -pc_hpddm_coarse_
2896f1580f4eSBarry Smith       -pc_hpddm_coarse_p
28974ec2a359SPierre Jolivet       -pc_hpddm_coarse_mat_type
28982ce66baaSPierre Jolivet       -pc_hpddm_coarse_mat_filter
2899f1580f4eSBarry Smith .ve
2900f1580f4eSBarry Smith 
290138bf2a8cSPierre Jolivet    E.g., -pc_hpddm_levels_1_sub_pc_type lu -pc_hpddm_levels_1_eps_nev 10 -pc_hpddm_levels_2_p 4 -pc_hpddm_levels_2_sub_pc_type lu -pc_hpddm_levels_2_eps_nev 10
2902f1580f4eSBarry Smith     -pc_hpddm_coarse_p 2 -pc_hpddm_coarse_mat_type baij will use 10 deflation vectors per subdomain on the fine "level 1",
2903f1580f4eSBarry Smith     aggregate the fine subdomains into 4 "level 2" subdomains, then use 10 deflation vectors per subdomain on "level 2",
29047eb095acSPierre Jolivet     and assemble the coarse matrix (of dimension 4 x 10 = 40) on two processes as a `MATBAIJ` (default is `MATSBAIJ`).
2905f1580f4eSBarry Smith 
2906f1580f4eSBarry Smith    In order to activate a "level N+1" coarse correction, it is mandatory to call -pc_hpddm_levels_N_eps_nev <nu> or -pc_hpddm_levels_N_eps_threshold <val>. The default -pc_hpddm_coarse_p value is 1, meaning that the coarse operator is aggregated on a single process.
2907f1580f4eSBarry Smith 
29081d27aa22SBarry Smith    Level: intermediate
29091d27aa22SBarry Smith 
29101d27aa22SBarry Smith    Notes:
29111d27aa22SBarry Smith    This preconditioner requires that PETSc is built with SLEPc (``--download-slepc``).
29121d27aa22SBarry Smith 
29131d27aa22SBarry Smith    By default, the underlying concurrent eigenproblems
29141d27aa22SBarry Smith    are solved using SLEPc shift-and-invert spectral transformation. This is usually what gives the best performance for GenEO, cf.
29151d27aa22SBarry Smith    {cite}`spillane2011robust` {cite}`jolivet2013scalabledd`. As
291638bf2a8cSPierre Jolivet    stated above, SLEPc options are available through -pc_hpddm_levels_%d_, e.g., -pc_hpddm_levels_1_eps_type arpack -pc_hpddm_levels_1_eps_nev 10
291738bf2a8cSPierre Jolivet    -pc_hpddm_levels_1_st_type sinvert. There are furthermore three options related to the (subdomain-wise local) eigensolver that are not described in
291838bf2a8cSPierre Jolivet    SLEPc documentation since they are specific to `PCHPDDM`.
291938bf2a8cSPierre Jolivet .vb
292038bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_st_share_sub_ksp
292138bf2a8cSPierre Jolivet       -pc_hpddm_levels_%d_eps_threshold
292238bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_eps_use_inertia
292338bf2a8cSPierre Jolivet .ve
292438bf2a8cSPierre Jolivet 
292538bf2a8cSPierre Jolivet    The first option from the list only applies to the fine-level eigensolver, see `PCHPDDMSetSTShareSubKSP()`. The second option from the list is
292638bf2a8cSPierre Jolivet    used to filter eigenmodes retrieved after convergence of `EPSSolve()` at "level N" such that eigenvectors used to define a "level N+1" coarse
292738bf2a8cSPierre Jolivet    correction are associated to eigenvalues whose magnitude are lower or equal than -pc_hpddm_levels_N_eps_threshold. When using an `EPS` which cannot
292838bf2a8cSPierre Jolivet    determine a priori the proper -pc_hpddm_levels_N_eps_nev such that all wanted eigenmodes are retrieved, it is possible to get an estimation of the
292938bf2a8cSPierre Jolivet    correct value using the third option from the list, -pc_hpddm_levels_1_eps_use_inertia, see `MatGetInertia()`. In that case, there is no need
293038bf2a8cSPierre Jolivet    to supply -pc_hpddm_levels_1_eps_nev. This last option also only applies to the fine-level (N = 1) eigensolver.
2931f1580f4eSBarry Smith 
29321d27aa22SBarry Smith    See also {cite}`dolean2015introduction`, {cite}`al2022robust`, {cite}`al2022robustpd`, and {cite}`nataf2022recent`
2933f1580f4eSBarry Smith 
2934562efe2eSBarry Smith .seealso: [](ch_ksp), `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetAuxiliaryMat()`, `MATIS`, `PCBDDC`, `PCDEFLATION`, `PCTELESCOPE`, `PCASM`,
2935e31fc274SPierre Jolivet           `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDMHasNeumannMat()`, `PCHPDDMSetRHSMat()`, `PCHPDDMSetDeflationMat()`, `PCHPDDMSetSTShareSubKSP()`,
2936e31fc274SPierre Jolivet           `PCHPDDMGetSTShareSubKSP()`, `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDMGetComplexities()`
2937f1580f4eSBarry Smith M*/
2938d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_HPDDM(PC pc)
2939d71ae5a4SJacob Faibussowitsch {
2940f1580f4eSBarry Smith   PC_HPDDM *data;
2941f1580f4eSBarry Smith   PetscBool found;
2942f1580f4eSBarry Smith 
2943f1580f4eSBarry Smith   PetscFunctionBegin;
2944f1580f4eSBarry Smith   if (!loadedSym) {
2945f1580f4eSBarry Smith     PetscCall(HPDDMLoadDL_Private(&found));
2946db4a47b3SPierre Jolivet     if (found) PetscCall(PetscDLLibrarySym(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, nullptr, "PCHPDDM_Internal", (void **)&loadedSym));
2947f1580f4eSBarry Smith   }
2948f1580f4eSBarry Smith   PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCHPDDM_Internal symbol not found in loaded libhpddm_petsc");
29494dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&data));
2950f1580f4eSBarry Smith   pc->data                = data;
2951c8ea6600SPierre Jolivet   data->Neumann           = PETSC_BOOL3_UNKNOWN;
2952f1580f4eSBarry Smith   pc->ops->reset          = PCReset_HPDDM;
2953f1580f4eSBarry Smith   pc->ops->destroy        = PCDestroy_HPDDM;
2954f1580f4eSBarry Smith   pc->ops->setfromoptions = PCSetFromOptions_HPDDM;
2955f1580f4eSBarry Smith   pc->ops->setup          = PCSetUp_HPDDM;
2956f1580f4eSBarry Smith   pc->ops->apply          = PCApply_HPDDM;
2957f1580f4eSBarry Smith   pc->ops->matapply       = PCMatApply_HPDDM;
2958f1580f4eSBarry Smith   pc->ops->view           = PCView_HPDDM;
2959f1580f4eSBarry Smith   pc->ops->presolve       = PCPreSolve_HPDDM;
2960f1580f4eSBarry Smith 
2961f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", PCHPDDMSetAuxiliaryMat_HPDDM));
2962f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", PCHPDDMHasNeumannMat_HPDDM));
2963f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", PCHPDDMSetRHSMat_HPDDM));
2964f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", PCHPDDMSetCoarseCorrectionType_HPDDM));
2965f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", PCHPDDMGetCoarseCorrectionType_HPDDM));
2966e31fc274SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", PCHPDDMSetSTShareSubKSP_HPDDM));
2967f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", PCHPDDMGetSTShareSubKSP_HPDDM));
2968f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", PCHPDDMSetDeflationMat_HPDDM));
29693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2970f1580f4eSBarry Smith }
2971f1580f4eSBarry Smith 
2972f1580f4eSBarry Smith /*@C
2973f1580f4eSBarry Smith   PCHPDDMInitializePackage - This function initializes everything in the `PCHPDDM` package. It is called from `PCInitializePackage()`.
2974f1580f4eSBarry Smith 
2975f1580f4eSBarry Smith   Level: developer
2976f1580f4eSBarry Smith 
2977562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscInitialize()`
2978f1580f4eSBarry Smith @*/
2979d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMInitializePackage(void)
2980d71ae5a4SJacob Faibussowitsch {
2981f1580f4eSBarry Smith   char ename[32];
2982f1580f4eSBarry Smith 
2983f1580f4eSBarry Smith   PetscFunctionBegin;
29843ba16761SJacob Faibussowitsch   if (PCHPDDMPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
2985f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_TRUE;
2986f1580f4eSBarry Smith   PetscCall(PetscRegisterFinalize(PCHPDDMFinalizePackage));
2987f1580f4eSBarry Smith   /* general events registered once during package initialization */
2988f1580f4eSBarry Smith   /* some of these events are not triggered in libpetsc,          */
2989f1580f4eSBarry Smith   /* but rather directly in libhpddm_petsc,                       */
2990f1580f4eSBarry Smith   /* which is in charge of performing the following operations    */
2991f1580f4eSBarry Smith 
2992f1580f4eSBarry Smith   /* domain decomposition structure from Pmat sparsity pattern    */
2993f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMStrc", PC_CLASSID, &PC_HPDDM_Strc));
2994f1580f4eSBarry Smith   /* Galerkin product, redistribution, and setup (not triggered in libpetsc)                */
2995f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtAP", PC_CLASSID, &PC_HPDDM_PtAP));
2996f1580f4eSBarry Smith   /* Galerkin product with summation, redistribution, and setup (not triggered in libpetsc) */
2997f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtBP", PC_CLASSID, &PC_HPDDM_PtBP));
2998f1580f4eSBarry Smith   /* next level construction using PtAP and PtBP (not triggered in libpetsc)                */
2999f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMNext", PC_CLASSID, &PC_HPDDM_Next));
3000f1580f4eSBarry Smith   static_assert(PETSC_PCHPDDM_MAXLEVELS <= 9, "PETSC_PCHPDDM_MAXLEVELS value is too high");
3001811e8887SPierre Jolivet   for (PetscInt i = 1; i < PETSC_PCHPDDM_MAXLEVELS; ++i) {
3002f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSetUp L%1" PetscInt_FMT, i));
3003f1580f4eSBarry Smith     /* events during a PCSetUp() at level #i _except_ the assembly */
3004f1580f4eSBarry Smith     /* of the Galerkin operator of the coarser level #(i + 1)      */
3005f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_SetUp[i - 1]));
3006f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSolve L%1" PetscInt_FMT, i));
3007f1580f4eSBarry Smith     /* events during a PCApply() at level #i _except_              */
3008f1580f4eSBarry Smith     /* the KSPSolve() of the coarser level #(i + 1)                */
3009f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_Solve[i - 1]));
3010f1580f4eSBarry Smith   }
30113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3012f1580f4eSBarry Smith }
3013f1580f4eSBarry Smith 
3014f1580f4eSBarry Smith /*@C
3015f1580f4eSBarry Smith   PCHPDDMFinalizePackage - This function frees everything from the `PCHPDDM` package. It is called from `PetscFinalize()`.
3016f1580f4eSBarry Smith 
3017f1580f4eSBarry Smith   Level: developer
3018f1580f4eSBarry Smith 
3019562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscFinalize()`
3020f1580f4eSBarry Smith @*/
3021d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMFinalizePackage(void)
3022d71ae5a4SJacob Faibussowitsch {
3023f1580f4eSBarry Smith   PetscFunctionBegin;
3024f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_FALSE;
30253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3026f1580f4eSBarry Smith }
30279bb5c669SPierre Jolivet 
30289bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat A, Vec x, Vec y)
30299bb5c669SPierre Jolivet {
30309bb5c669SPierre Jolivet   Harmonic h; /* [ A_00  A_01       ], furthermore, A_00 = [ A_loc,loc  A_loc,ovl ], thus, A_01 = [         ] */
30319bb5c669SPierre Jolivet               /* [ A_10  A_11  A_12 ]                      [ A_ovl,loc  A_ovl,ovl ]               [ A_ovl,1 ] */
30329bb5c669SPierre Jolivet   Vec sub;    /*  y = A x = R_loc R_0 [ A_00  A_01 ]^-1                                   R_loc = [  I_loc  ] */
30339bb5c669SPierre Jolivet               /*                      [ A_10  A_11 ]    R_1^T A_12 x                              [         ] */
30349bb5c669SPierre Jolivet   PetscFunctionBegin;
30359bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
30369bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
30379bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
30389bb5c669SPierre Jolivet   PetscCall(MatMult(h->A[0], x, sub));
30399bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
30409bb5c669SPierre Jolivet   PetscCall(KSPSolve(h->ksp, h->v, h->v));
30419bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_REVERSE, y));
30429bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30439bb5c669SPierre Jolivet }
30449bb5c669SPierre Jolivet 
30459bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat A, Vec y, Vec x)
30469bb5c669SPierre Jolivet {
30479bb5c669SPierre Jolivet   Harmonic h;   /* x = A^T y =            [ A_00  A_01 ]^-T R_0^T R_loc^T y */
30489bb5c669SPierre Jolivet   Vec      sub; /*             A_12^T R_1 [ A_10  A_11 ]                    */
30499bb5c669SPierre Jolivet 
30509bb5c669SPierre Jolivet   PetscFunctionBegin;
30519bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
30529bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
30539bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_FORWARD, y));
30549bb5c669SPierre Jolivet   PetscCall(KSPSolveTranspose(h->ksp, h->v, h->v));
30559bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
30569bb5c669SPierre Jolivet   PetscCall(MatMultTranspose(h->A[0], sub, x));
30579bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
30589bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30599bb5c669SPierre Jolivet }
30609bb5c669SPierre Jolivet 
30619bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat S, Mat X, Mat Y, void *)
30629bb5c669SPierre Jolivet {
30639bb5c669SPierre Jolivet   Harmonic h;
30649bb5c669SPierre Jolivet   Mat      A, B;
30659bb5c669SPierre Jolivet   Vec      a, b;
30669bb5c669SPierre Jolivet 
30679bb5c669SPierre Jolivet   PetscFunctionBegin;
30689bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
3069fb842aefSJose E. Roman   PetscCall(MatMatMult(h->A[0], X, MAT_INITIAL_MATRIX, PETSC_CURRENT, &A));
30709bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
30719bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
30729bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
30739bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B, i, &b));
30749bb5c669SPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_FORWARD, a));
30759bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B, i, &b));
30769bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
30779bb5c669SPierre Jolivet   }
30789bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
30799bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, B->cmap->n, nullptr, &A));
30809bb5c669SPierre Jolivet   PetscCall(KSPMatSolve(h->ksp, B, A));
30819bb5c669SPierre Jolivet   PetscCall(MatDestroy(&B));
30829bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
30839bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
30849bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &b));
30859bb5c669SPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_REVERSE, b));
30869bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &b));
30879bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
30889bb5c669SPierre Jolivet   }
30899bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
30909bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30919bb5c669SPierre Jolivet }
30929bb5c669SPierre Jolivet 
30939bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat A)
30949bb5c669SPierre Jolivet {
30959bb5c669SPierre Jolivet   Harmonic h;
30969bb5c669SPierre Jolivet 
30979bb5c669SPierre Jolivet   PetscFunctionBegin;
30989bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
309932603206SJames Wright   for (PetscInt i = 0; i < 5; ++i) PetscCall(ISDestroy(h->is + i));
31009bb5c669SPierre Jolivet   PetscCall(PetscFree(h->is));
31019bb5c669SPierre Jolivet   PetscCall(VecDestroy(&h->v));
31029bb5c669SPierre Jolivet   for (PetscInt i = 0; i < 2; ++i) PetscCall(MatDestroy(h->A + i));
31039bb5c669SPierre Jolivet   PetscCall(PetscFree(h->A));
31049bb5c669SPierre Jolivet   PetscCall(KSPDestroy(&h->ksp));
31059bb5c669SPierre Jolivet   PetscCall(PetscFree(h));
31069bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
31079bb5c669SPierre Jolivet }
3108