xref: /petsc/src/ksp/pc/impls/hpddm/pchpddm.cxx (revision d16c0b941c679d6ed4658ce69e8b9f9ef1665a01)
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   PetscInt  i;
27f1580f4eSBarry Smith 
28f1580f4eSBarry Smith   PetscFunctionBegin;
29f1580f4eSBarry Smith   if (data->levels) {
30f1580f4eSBarry Smith     for (i = 0; i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]; ++i) {
31f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[i]->ksp));
32f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[i]->pc));
33f1580f4eSBarry Smith       PetscCall(PetscFree(data->levels[i]));
34f1580f4eSBarry Smith     }
35f1580f4eSBarry Smith     PetscCall(PetscFree(data->levels));
36f1580f4eSBarry Smith   }
37f1580f4eSBarry Smith 
38f1580f4eSBarry Smith   PetscCall(ISDestroy(&data->is));
39f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->aux));
40f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->B));
41f1580f4eSBarry Smith   PetscCall(VecDestroy(&data->normal));
42f1580f4eSBarry Smith   data->correction = PC_HPDDM_COARSE_CORRECTION_DEFLATED;
43c8ea6600SPierre Jolivet   data->Neumann    = PETSC_BOOL3_UNKNOWN;
44f1580f4eSBarry Smith   data->deflation  = PETSC_FALSE;
45db4a47b3SPierre Jolivet   data->setup      = nullptr;
46db4a47b3SPierre Jolivet   data->setup_ctx  = nullptr;
473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
48f1580f4eSBarry Smith }
49f1580f4eSBarry Smith 
50d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDM(PC pc)
51d71ae5a4SJacob Faibussowitsch {
52f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
53f1580f4eSBarry Smith 
54f1580f4eSBarry Smith   PetscFunctionBegin;
55f1580f4eSBarry Smith   PetscCall(PCReset_HPDDM(pc));
56f1580f4eSBarry Smith   PetscCall(PetscFree(data));
57db4a47b3SPierre Jolivet   PetscCall(PetscObjectChangeTypeName((PetscObject)pc, nullptr));
58db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", nullptr));
59db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", nullptr));
60db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", nullptr));
61db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", nullptr));
62db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", nullptr));
63db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", nullptr));
64db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", nullptr));
65db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", nullptr));
6613044ca3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc, "_PCHPDDM_Schur", nullptr));
673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
68f1580f4eSBarry Smith }
69f1580f4eSBarry Smith 
70d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMSetAuxiliaryMat_Private(PC pc, IS is, Mat A, PetscBool deflation)
71d71ae5a4SJacob Faibussowitsch {
72f1580f4eSBarry Smith   PC_HPDDM                   *data = (PC_HPDDM *)pc->data;
73cdbd50ebSPierre Jolivet   PCHPDDMCoarseCorrectionType type = data->correction;
74f1580f4eSBarry Smith 
75f1580f4eSBarry Smith   PetscFunctionBegin;
76f1580f4eSBarry Smith   if (is) {
77f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)is));
78f1580f4eSBarry Smith     if (data->is) { /* new overlap definition resets the PC */
79f1580f4eSBarry Smith       PetscCall(PCReset_HPDDM(pc));
80f1580f4eSBarry Smith       pc->setfromoptionscalled = 0;
81b853e353SPierre Jolivet       pc->setupcalled          = 0;
82cdbd50ebSPierre Jolivet       data->correction         = type;
83f1580f4eSBarry Smith     }
84f1580f4eSBarry Smith     PetscCall(ISDestroy(&data->is));
85f1580f4eSBarry Smith     data->is = is;
86f1580f4eSBarry Smith   }
87f1580f4eSBarry Smith   if (A) {
88f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)A));
89f1580f4eSBarry Smith     PetscCall(MatDestroy(&data->aux));
90f1580f4eSBarry Smith     data->aux = A;
91f1580f4eSBarry Smith   }
92f1580f4eSBarry Smith   data->deflation = deflation;
933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
94f1580f4eSBarry Smith }
95f1580f4eSBarry Smith 
963df4cd7bSPierre Jolivet static inline PetscErrorCode PCHPDDMSetAuxiliaryMatNormal_Private(PC pc, Mat A, Mat N, Mat *B, const char *pcpre, Vec *diagonal = nullptr)
97d71ae5a4SJacob Faibussowitsch {
98f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
99f1580f4eSBarry Smith   Mat      *splitting, *sub, aux;
1003df4cd7bSPierre Jolivet   Vec       d;
101f1580f4eSBarry Smith   IS        is, cols[2], rows;
102f1580f4eSBarry Smith   PetscReal norm;
103f1580f4eSBarry Smith   PetscBool flg;
104f1580f4eSBarry Smith   char      type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
105f1580f4eSBarry Smith 
106f1580f4eSBarry Smith   PetscFunctionBegin;
107f1580f4eSBarry Smith   PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, B));
108f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, cols));
109f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->rmap->N, 0, 1, &rows));
110f1580f4eSBarry Smith   PetscCall(MatSetOption(A, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
111f1580f4eSBarry Smith   PetscCall(MatIncreaseOverlap(*B, 1, cols, 1));
112f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(A, 1, &rows, cols, MAT_INITIAL_MATRIX, &splitting));
113f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, &is));
114f1580f4eSBarry Smith   PetscCall(ISEmbed(*cols, is, PETSC_TRUE, cols + 1));
115f1580f4eSBarry Smith   PetscCall(ISDestroy(&is));
116f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(*splitting, 1, &rows, cols + 1, MAT_INITIAL_MATRIX, &sub));
117f1580f4eSBarry Smith   PetscCall(ISDestroy(cols + 1));
118f1580f4eSBarry Smith   PetscCall(MatFindZeroRows(*sub, &is));
119f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &sub));
120f1580f4eSBarry Smith   PetscCall(ISDestroy(&rows));
121f1580f4eSBarry Smith   PetscCall(MatSetOption(*splitting, MAT_KEEP_NONZERO_PATTERN, PETSC_TRUE));
122db4a47b3SPierre Jolivet   PetscCall(MatZeroRowsIS(*splitting, is, 0.0, nullptr, nullptr));
123f1580f4eSBarry Smith   PetscCall(ISDestroy(&is));
124db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_sub_pc_type", type, sizeof(type), nullptr));
125f1580f4eSBarry Smith   PetscCall(PetscStrcmp(type, PCQR, &flg));
126f1580f4eSBarry Smith   if (!flg) {
127f1580f4eSBarry Smith     Mat conjugate = *splitting;
128f1580f4eSBarry Smith     if (PetscDefined(USE_COMPLEX)) {
129f1580f4eSBarry Smith       PetscCall(MatDuplicate(*splitting, MAT_COPY_VALUES, &conjugate));
130f1580f4eSBarry Smith       PetscCall(MatConjugate(conjugate));
131f1580f4eSBarry Smith     }
132f1580f4eSBarry Smith     PetscCall(MatTransposeMatMult(conjugate, *splitting, MAT_INITIAL_MATRIX, PETSC_DEFAULT, &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) {
1373df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1383df4cd7bSPierre Jolivet       if (norm > PETSC_SMALL) {
13901e3c840SPierre Jolivet         PetscSF  scatter;
1403df4cd7bSPierre Jolivet         PetscInt n;
1413df4cd7bSPierre Jolivet         PetscCall(ISGetLocalSize(*cols, &n));
1423df4cd7bSPierre Jolivet         PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)pc), n, PETSC_DECIDE, &d));
1433df4cd7bSPierre Jolivet         PetscCall(VecScatterCreate(*diagonal, *cols, d, nullptr, &scatter));
1443df4cd7bSPierre Jolivet         PetscCall(VecScatterBegin(scatter, *diagonal, d, INSERT_VALUES, SCATTER_FORWARD));
1453df4cd7bSPierre Jolivet         PetscCall(VecScatterEnd(scatter, *diagonal, d, INSERT_VALUES, SCATTER_FORWARD));
14601e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&scatter));
1473df4cd7bSPierre Jolivet         PetscCall(MatScale(aux, -1.0));
1483df4cd7bSPierre Jolivet         PetscCall(MatDiagonalSet(aux, d, ADD_VALUES));
1493df4cd7bSPierre Jolivet         PetscCall(VecDestroy(&d));
1503df4cd7bSPierre Jolivet       } else PetscCall(VecDestroy(diagonal));
1513df4cd7bSPierre Jolivet     }
1523df4cd7bSPierre Jolivet     if (!diagonal) PetscCall(MatShift(aux, PETSC_SMALL * norm));
153f1580f4eSBarry Smith   } else {
154f1580f4eSBarry Smith     PetscBool flg;
1553df4cd7bSPierre Jolivet     if (diagonal) {
1563df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1573df4cd7bSPierre Jolivet       PetscCheck(norm < PETSC_SMALL, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Nonzero diagonal A11 block");
1583df4cd7bSPierre Jolivet       PetscCall(VecDestroy(diagonal));
1593df4cd7bSPierre Jolivet     }
160f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)N, MATNORMAL, &flg));
161f1580f4eSBarry Smith     if (flg) PetscCall(MatCreateNormal(*splitting, &aux));
162f1580f4eSBarry Smith     else PetscCall(MatCreateNormalHermitian(*splitting, &aux));
163f1580f4eSBarry Smith   }
164f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &splitting));
165db4a47b3SPierre Jolivet   PetscCall(PCHPDDMSetAuxiliaryMat(pc, *cols, aux, nullptr, nullptr));
166c8ea6600SPierre Jolivet   data->Neumann = PETSC_BOOL3_TRUE;
167f1580f4eSBarry Smith   PetscCall(ISDestroy(cols));
168f1580f4eSBarry Smith   PetscCall(MatDestroy(&aux));
1693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
170f1580f4eSBarry Smith }
171f1580f4eSBarry Smith 
172d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetAuxiliaryMat_HPDDM(PC pc, IS is, Mat A, PetscErrorCode (*setup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *setup_ctx)
173d71ae5a4SJacob Faibussowitsch {
174f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
175f1580f4eSBarry Smith 
176f1580f4eSBarry Smith   PetscFunctionBegin;
177f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, A, PETSC_FALSE));
178f1580f4eSBarry Smith   if (setup) {
179f1580f4eSBarry Smith     data->setup     = setup;
180f1580f4eSBarry Smith     data->setup_ctx = setup_ctx;
181f1580f4eSBarry Smith   }
1823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
183f1580f4eSBarry Smith }
184f1580f4eSBarry Smith 
18573329a61SPierre Jolivet typedef struct {
18673329a61SPierre Jolivet   KSP      ksp;
18773329a61SPierre Jolivet   PetscInt its;
18873329a61SPierre Jolivet } PC_KSP;
18973329a61SPierre Jolivet 
19073329a61SPierre Jolivet static inline PetscErrorCode PCSetUp_KSP_Private(PC pc)
19173329a61SPierre Jolivet {
19273329a61SPierre Jolivet   PC_KSP           *data   = (PC_KSP *)pc->data;
19373329a61SPierre Jolivet   const std::string prefix = ((PetscObject)data->ksp)->prefix;
19473329a61SPierre Jolivet   std::string       sub;
19573329a61SPierre Jolivet 
19673329a61SPierre Jolivet   PetscFunctionBegin;
19773329a61SPierre 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_");
19873329a61SPierre Jolivet   sub = prefix.substr(0, prefix.size() - 9);
19973329a61SPierre Jolivet   PetscCall(PCSetType(pc, PCHPDDM));
20073329a61SPierre Jolivet   PetscCall(PCSetOptionsPrefix(pc, sub.c_str()));
20173329a61SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
20273329a61SPierre Jolivet }
20373329a61SPierre Jolivet 
20473329a61SPierre Jolivet static PetscErrorCode PCSetUp_KSP(PC pc)
20573329a61SPierre Jolivet {
20673329a61SPierre Jolivet   PetscFunctionBegin;
20773329a61SPierre Jolivet   PetscCall(PCSetUp_KSP_Private(pc));
20873329a61SPierre Jolivet   PetscCall(PCSetFromOptions(pc));
20973329a61SPierre Jolivet   PetscCall(PCSetUp(pc));
21073329a61SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
21173329a61SPierre Jolivet }
21273329a61SPierre Jolivet 
21370009435SPierre Jolivet /*@C
21404c3f3b8SBarry Smith   PCHPDDMSetAuxiliaryMat - Sets the auxiliary matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
215f1580f4eSBarry Smith 
216f1580f4eSBarry Smith   Input Parameters:
217f1580f4eSBarry Smith + pc    - preconditioner context
218f1580f4eSBarry Smith . is    - index set of the local auxiliary, e.g., Neumann, matrix
219f1580f4eSBarry Smith . A     - auxiliary sequential matrix
22004c3f3b8SBarry Smith . setup - function for generating the auxiliary matrix entries, may be `NULL`
22104c3f3b8SBarry Smith - ctx   - context for `setup`, may be `NULL`
22204c3f3b8SBarry Smith 
22304c3f3b8SBarry Smith   Calling sequence of `setup`:
22404c3f3b8SBarry Smith + J   - matrix whose values are to be set
22504c3f3b8SBarry Smith . t   - time
22604c3f3b8SBarry Smith . X   - linearization point
22704c3f3b8SBarry Smith . X_t - time-derivative of the linearization point
22804c3f3b8SBarry Smith . s   - step
22904c3f3b8SBarry Smith . ovl - index set of the local auxiliary, e.g., Neumann, matrix
23004c3f3b8SBarry Smith - ctx - context for `setup`, may be `NULL`
231f1580f4eSBarry Smith 
232f1580f4eSBarry Smith   Level: intermediate
233f1580f4eSBarry Smith 
23404c3f3b8SBarry Smith   Note:
23504c3f3b8SBarry Smith   As an example, in a finite element context with nonoverlapping subdomains plus (overlapping) ghost elements, this could be the unassembled (Neumann)
23604c3f3b8SBarry Smith   local overlapping operator. As opposed to the assembled (Dirichlet) local overlapping operator obtained by summing neighborhood contributions
23704c3f3b8SBarry Smith   at the interface of ghost elements.
23804c3f3b8SBarry Smith 
23970009435SPierre Jolivet   Fortran Notes:
24004c3f3b8SBarry Smith   Only `PETSC_NULL_FUNCTION` is supported for `setup` and `ctx` is never accessed
24170009435SPierre Jolivet 
242562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetRHSMat()`, `MATIS`
243f1580f4eSBarry Smith @*/
24404c3f3b8SBarry 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)
245d71ae5a4SJacob Faibussowitsch {
246f1580f4eSBarry Smith   PetscFunctionBegin;
247f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
248f1580f4eSBarry Smith   if (is) PetscValidHeaderSpecific(is, IS_CLASSID, 2);
249f1580f4eSBarry Smith   if (A) PetscValidHeaderSpecific(A, MAT_CLASSID, 3);
25073329a61SPierre Jolivet   if (pc->ops->setup == PCSetUp_KSP) PetscCall(PCSetUp_KSP_Private(pc));
25104c3f3b8SBarry Smith   PetscTryMethod(pc, "PCHPDDMSetAuxiliaryMat_C", (PC, IS, Mat, PetscErrorCode(*)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *), (pc, is, A, setup, ctx));
2523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
253f1580f4eSBarry Smith }
254f1580f4eSBarry Smith 
255d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMHasNeumannMat_HPDDM(PC pc, PetscBool has)
256d71ae5a4SJacob Faibussowitsch {
257f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
258f1580f4eSBarry Smith 
259f1580f4eSBarry Smith   PetscFunctionBegin;
260c8ea6600SPierre Jolivet   data->Neumann = PetscBoolToBool3(has);
2613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
262f1580f4eSBarry Smith }
263f1580f4eSBarry Smith 
264f1580f4eSBarry Smith /*@
265f1580f4eSBarry Smith   PCHPDDMHasNeumannMat - Informs `PCHPDDM` that the `Mat` passed to `PCHPDDMSetAuxiliaryMat()` is the local Neumann matrix.
266f1580f4eSBarry Smith 
267f1580f4eSBarry Smith   Input Parameters:
268f1580f4eSBarry Smith + pc  - preconditioner context
269f1580f4eSBarry Smith - has - Boolean value
270f1580f4eSBarry Smith 
271f1580f4eSBarry Smith   Level: intermediate
272f1580f4eSBarry Smith 
273f1580f4eSBarry Smith   Notes:
2747eb095acSPierre Jolivet   This may be used to bypass a call to `MatCreateSubMatrices()` and to `MatConvert()` for `MATSBAIJ` matrices.
275f1580f4eSBarry Smith 
276907a3e9cSStefano 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`.
277f1580f4eSBarry Smith 
278562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetAuxiliaryMat()`
279f1580f4eSBarry Smith @*/
280d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMHasNeumannMat(PC pc, PetscBool has)
281d71ae5a4SJacob Faibussowitsch {
282f1580f4eSBarry Smith   PetscFunctionBegin;
283f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
284f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMHasNeumannMat_C", (PC, PetscBool), (pc, has));
2853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
286f1580f4eSBarry Smith }
287f1580f4eSBarry Smith 
288d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetRHSMat_HPDDM(PC pc, Mat B)
289d71ae5a4SJacob Faibussowitsch {
290f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
291f1580f4eSBarry Smith 
292f1580f4eSBarry Smith   PetscFunctionBegin;
293f1580f4eSBarry Smith   PetscCall(PetscObjectReference((PetscObject)B));
294f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->B));
295f1580f4eSBarry Smith   data->B = B;
2963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
297f1580f4eSBarry Smith }
298f1580f4eSBarry Smith 
299f1580f4eSBarry Smith /*@
30004c3f3b8SBarry Smith   PCHPDDMSetRHSMat - Sets the right-hand side matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
301f1580f4eSBarry Smith 
302f1580f4eSBarry Smith   Input Parameters:
303f1580f4eSBarry Smith + pc - preconditioner context
304f1580f4eSBarry Smith - B  - right-hand side sequential matrix
305f1580f4eSBarry Smith 
306f1580f4eSBarry Smith   Level: advanced
307f1580f4eSBarry Smith 
30804c3f3b8SBarry Smith   Note:
30904c3f3b8SBarry Smith   Must be used in conjunction with `PCHPDDMSetAuxiliaryMat`(N), so that Nv = lambda Bv is solved using `EPSSetOperators`(N, B).
31004c3f3b8SBarry 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.
31104c3f3b8SBarry Smith 
312562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetAuxiliaryMat()`, `PCHPDDM`
313f1580f4eSBarry Smith @*/
314d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetRHSMat(PC pc, Mat B)
315d71ae5a4SJacob Faibussowitsch {
316f1580f4eSBarry Smith   PetscFunctionBegin;
317f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
318f1580f4eSBarry Smith   if (B) {
319f1580f4eSBarry Smith     PetscValidHeaderSpecific(B, MAT_CLASSID, 2);
320f1580f4eSBarry Smith     PetscTryMethod(pc, "PCHPDDMSetRHSMat_C", (PC, Mat), (pc, B));
321f1580f4eSBarry Smith   }
3223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
323f1580f4eSBarry Smith }
324f1580f4eSBarry Smith 
325d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_HPDDM(PC pc, PetscOptionItems *PetscOptionsObject)
326d71ae5a4SJacob Faibussowitsch {
327f1580f4eSBarry Smith   PC_HPDDM                   *data   = (PC_HPDDM *)pc->data;
328f1580f4eSBarry Smith   PC_HPDDM_Level            **levels = data->levels;
329f1580f4eSBarry Smith   char                        prefix[256];
330f1580f4eSBarry Smith   int                         i = 1;
331f1580f4eSBarry Smith   PetscMPIInt                 size, previous;
3329bb5c669SPierre Jolivet   PetscInt                    n, overlap = 1;
333f1580f4eSBarry Smith   PCHPDDMCoarseCorrectionType type;
334c8ea6600SPierre Jolivet   PetscBool                   flg = PETSC_TRUE, set;
335f1580f4eSBarry Smith 
336f1580f4eSBarry Smith   PetscFunctionBegin;
337f1580f4eSBarry Smith   if (!data->levels) {
338f1580f4eSBarry Smith     PetscCall(PetscCalloc1(PETSC_PCHPDDM_MAXLEVELS, &levels));
339f1580f4eSBarry Smith     data->levels = levels;
340f1580f4eSBarry Smith   }
341f1580f4eSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "PCHPDDM options");
3429bb5c669SPierre Jolivet   PetscCall(PetscOptionsBoundedInt("-pc_hpddm_harmonic_overlap", "Overlap prior to computing local harmonic extensions", "PCHPDDM", overlap, &overlap, &set, 1));
3439bb5c669SPierre Jolivet   if (!set) overlap = -1;
344f1580f4eSBarry Smith   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
345f1580f4eSBarry Smith   previous = size;
346f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS) {
347f1580f4eSBarry Smith     PetscInt p = 1;
348f1580f4eSBarry Smith 
3494dfa11a4SJacob Faibussowitsch     if (!data->levels[i - 1]) PetscCall(PetscNew(data->levels + i - 1));
350f1580f4eSBarry Smith     data->levels[i - 1]->parent = data;
351f1580f4eSBarry Smith     /* if the previous level has a single process, it is not possible to coarsen further */
352f1580f4eSBarry Smith     if (previous == 1 || !flg) break;
353f1580f4eSBarry Smith     data->levels[i - 1]->nu        = 0;
354f1580f4eSBarry Smith     data->levels[i - 1]->threshold = -1.0;
355f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
356db4a47b3SPierre 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));
357f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold", i));
358db4a47b3SPierre 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));
359f1580f4eSBarry Smith     if (i == 1) {
360aa1539e9SPierre 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");
3619bb5c669SPierre Jolivet       if (overlap != -1) {
3629bb5c669SPierre Jolivet         PetscInt nsv = 0;
3639bb5c669SPierre Jolivet         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_nsv", i));
3649bb5c669SPierre Jolivet         PetscCall(PetscOptionsBoundedInt(prefix, "Local number of deflation vectors computed by SLEPc", "SVDSetDimensions", nsv, &nsv, nullptr, 0));
3659bb5c669SPierre 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");
3669bb5c669SPierre Jolivet         if (nsv) {
3679bb5c669SPierre Jolivet           data->levels[0]->nu = nsv;
3689bb5c669SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_relative_threshold", i));
3699bb5c669SPierre Jolivet         } else PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_relative_threshold", i));
3709bb5c669SPierre Jolivet         PetscCall(PetscOptionsReal(prefix, "Local relative threshold for selecting deflation vectors returned by SLEPc", "PCHPDDM", data->levels[0]->threshold, &data->levels[0]->threshold, nullptr));
3719bb5c669SPierre Jolivet       }
372f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_1_st_share_sub_ksp"));
373db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Shared KSP between SLEPc ST and the fine-level subdomain solver", "PCHPDDMSetSTShareSubKSP", PETSC_FALSE, &data->share, nullptr));
374f1580f4eSBarry Smith     }
375f1580f4eSBarry Smith     /* if there is no prescribed coarsening, just break out of the loop */
3760594bca0SPierre Jolivet     if (data->levels[i - 1]->threshold <= PetscReal() && data->levels[i - 1]->nu <= 0 && !(data->deflation && i == 1)) break;
377f1580f4eSBarry Smith     else {
378f1580f4eSBarry Smith       ++i;
379f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
380f1580f4eSBarry Smith       PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
381f1580f4eSBarry Smith       if (!flg) {
382f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold", i));
383f1580f4eSBarry Smith         PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
384f1580f4eSBarry Smith       }
385f1580f4eSBarry Smith       if (flg) {
386f1580f4eSBarry Smith         /* if there are coarsening options for the next level, then register it  */
387f1580f4eSBarry Smith         /* otherwise, don't to avoid having both options levels_N_p and coarse_p */
388f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_p", i));
389f1580f4eSBarry 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)));
390f1580f4eSBarry Smith         previous = p;
391f1580f4eSBarry Smith       }
392f1580f4eSBarry Smith     }
393f1580f4eSBarry Smith   }
394f1580f4eSBarry Smith   data->N = i;
395f1580f4eSBarry Smith   n       = 1;
396f1580f4eSBarry Smith   if (i > 1) {
397f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_coarse_p"));
398db4a47b3SPierre Jolivet     PetscCall(PetscOptionsRangeInt(prefix, "Number of processes used to assemble the coarsest operator", "PCHPDDM", n, &n, nullptr, 1, PetscMax(1, previous / 2)));
39902800ff6SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
400f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "pc_hpddm_coarse_"));
401db4a47b3SPierre Jolivet     PetscCall(PetscOptionsHasName(nullptr, prefix, "-mat_mumps_use_omp_threads", &flg));
402f1580f4eSBarry Smith     if (flg) {
403f1580f4eSBarry Smith       char type[64];                                                                                                    /* same size as in src/ksp/pc/impls/factor/factimpl.c */
404c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(type, n > 1 && PetscDefined(HAVE_MUMPS) ? MATSOLVERMUMPS : MATSOLVERPETSC, sizeof(type))); /* default solver for a MatMPIAIJ or a MatSeqAIJ */
405db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetString(nullptr, prefix, "-pc_factor_mat_solver_type", type, sizeof(type), nullptr));
4063ce573a3SPierre Jolivet       PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
407f1580f4eSBarry 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);
408f1580f4eSBarry Smith       size = n;
409f1580f4eSBarry Smith       n    = -1;
410db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetInt(nullptr, prefix, "-mat_mumps_use_omp_threads", &n, nullptr));
411f1580f4eSBarry Smith       PetscCheck(n >= 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Need to specify a positive integer for -%smat_mumps_use_omp_threads", prefix);
412f1580f4eSBarry 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" : "");
413f1580f4eSBarry Smith     }
414f1580f4eSBarry Smith #endif
415f1580f4eSBarry Smith     PetscCall(PetscOptionsEnum("-pc_hpddm_coarse_correction", "Type of coarse correction applied each iteration", "PCHPDDMSetCoarseCorrectionType", PCHPDDMCoarseCorrectionTypes, (PetscEnum)data->correction, (PetscEnum *)&type, &flg));
416f1580f4eSBarry Smith     if (flg) PetscCall(PCHPDDMSetCoarseCorrectionType(pc, type));
417f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_has_neumann"));
418c8ea6600SPierre Jolivet     PetscCall(PetscOptionsBool(prefix, "Is the auxiliary Mat the local Neumann matrix?", "PCHPDDMHasNeumannMat", PetscBool3ToBool(data->Neumann), &flg, &set));
419c8ea6600SPierre Jolivet     if (set) data->Neumann = PetscBoolToBool3(flg);
420f1580f4eSBarry Smith     data->log_separate = PETSC_FALSE;
421f1580f4eSBarry Smith     if (PetscDefined(USE_LOG)) {
422f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_log_separate"));
423db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Log events level by level instead of inside PCSetUp()/KSPSolve()", nullptr, data->log_separate, &data->log_separate, nullptr));
424f1580f4eSBarry Smith     }
425f1580f4eSBarry Smith   }
426f1580f4eSBarry Smith   PetscOptionsHeadEnd();
427f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]) PetscCall(PetscFree(data->levels[i++]));
4283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
429f1580f4eSBarry Smith }
430f1580f4eSBarry Smith 
431d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDM(PC pc, Vec x, Vec y)
432d71ae5a4SJacob Faibussowitsch {
433f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
434f1580f4eSBarry Smith 
435f1580f4eSBarry Smith   PetscFunctionBegin;
436f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
437f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
438db4a47b3SPierre 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 */
439f1580f4eSBarry Smith   PetscCall(KSPSolve(data->levels[0]->ksp, x, y));
440db4a47b3SPierre Jolivet   if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
4413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
442f1580f4eSBarry Smith }
443f1580f4eSBarry Smith 
444d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDM(PC pc, Mat X, Mat Y)
445d71ae5a4SJacob Faibussowitsch {
446f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
447f1580f4eSBarry Smith 
448f1580f4eSBarry Smith   PetscFunctionBegin;
449f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
450f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
451f1580f4eSBarry Smith   PetscCall(KSPMatSolve(data->levels[0]->ksp, X, Y));
4523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
453f1580f4eSBarry Smith }
454f1580f4eSBarry Smith 
455cc4c1da9SBarry Smith /*@
456f1580f4eSBarry Smith   PCHPDDMGetComplexities - Computes the grid and operator complexities.
457f1580f4eSBarry Smith 
458f1580f4eSBarry Smith   Input Parameter:
459f1580f4eSBarry Smith . pc - preconditioner context
460f1580f4eSBarry Smith 
461f1580f4eSBarry Smith   Output Parameters:
462cc4c1da9SBarry Smith + gc - grid complexity $ \sum_i m_i / m_1 $
463cc4c1da9SBarry Smith - oc - operator complexity $ \sum_i nnz_i / nnz_1 $
464f1580f4eSBarry Smith 
465f1580f4eSBarry Smith   Level: advanced
466f1580f4eSBarry Smith 
467562efe2eSBarry Smith .seealso: [](ch_ksp), `PCMGGetGridComplexity()`, `PCHPDDM`, `PCHYPRE`, `PCGAMG`
468f1580f4eSBarry Smith @*/
469cc4c1da9SBarry Smith PetscErrorCode PCHPDDMGetComplexities(PC pc, PetscReal *gc, PetscReal *oc)
470d71ae5a4SJacob Faibussowitsch {
471f1580f4eSBarry Smith   PC_HPDDM      *data = (PC_HPDDM *)pc->data;
472f1580f4eSBarry Smith   MatInfo        info;
473f1580f4eSBarry Smith   PetscInt       n, m;
474f1580f4eSBarry Smith   PetscLogDouble accumulate[2]{}, nnz1 = 1.0, m1 = 1.0;
475f1580f4eSBarry Smith 
476f1580f4eSBarry Smith   PetscFunctionBegin;
477f1580f4eSBarry Smith   for (n = 0, *gc = 0, *oc = 0; n < data->N; ++n) {
478f1580f4eSBarry Smith     if (data->levels[n]->ksp) {
47913044ca3SPierre Jolivet       Mat       P, A = nullptr;
48013044ca3SPierre Jolivet       PetscBool flg = PETSC_FALSE;
48113044ca3SPierre Jolivet 
482db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &P));
483db4a47b3SPierre Jolivet       PetscCall(MatGetSize(P, &m, nullptr));
484f1580f4eSBarry Smith       accumulate[0] += m;
485f1580f4eSBarry Smith       if (n == 0) {
486f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
487f1580f4eSBarry Smith         if (flg) {
488f1580f4eSBarry Smith           PetscCall(MatConvert(P, MATAIJ, MAT_INITIAL_MATRIX, &A));
489f1580f4eSBarry Smith           P = A;
49013044ca3SPierre Jolivet         } else {
49113044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
49213044ca3SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)P));
493f1580f4eSBarry Smith         }
49413044ca3SPierre Jolivet       }
49513044ca3SPierre Jolivet       if (!A && flg) accumulate[1] += m * m; /* assumption that a MATSCHURCOMPLEMENT is dense if stored explicitly */
49613044ca3SPierre Jolivet       else if (P->ops->getinfo) {
497f1580f4eSBarry Smith         PetscCall(MatGetInfo(P, MAT_GLOBAL_SUM, &info));
498f1580f4eSBarry Smith         accumulate[1] += info.nz_used;
499f1580f4eSBarry Smith       }
500f1580f4eSBarry Smith       if (n == 0) {
501f1580f4eSBarry Smith         m1 = m;
50213044ca3SPierre Jolivet         if (!A && flg) nnz1 = m * m;
50313044ca3SPierre Jolivet         else if (P->ops->getinfo) nnz1 = info.nz_used;
504f1580f4eSBarry Smith         PetscCall(MatDestroy(&P));
505f1580f4eSBarry Smith       }
506f1580f4eSBarry Smith     }
507f1580f4eSBarry Smith   }
508f1580f4eSBarry Smith   *gc = static_cast<PetscReal>(accumulate[0] / m1);
509f1580f4eSBarry Smith   *oc = static_cast<PetscReal>(accumulate[1] / nnz1);
5103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
511f1580f4eSBarry Smith }
512f1580f4eSBarry Smith 
513d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_HPDDM(PC pc, PetscViewer viewer)
514d71ae5a4SJacob Faibussowitsch {
515f1580f4eSBarry Smith   PC_HPDDM         *data = (PC_HPDDM *)pc->data;
516f1580f4eSBarry Smith   PetscViewer       subviewer;
517aa21023fSPierre Jolivet   PetscViewerFormat format;
518f1580f4eSBarry Smith   PetscSubcomm      subcomm;
519f1580f4eSBarry Smith   PetscReal         oc, gc;
520f1580f4eSBarry Smith   PetscInt          i, tabs;
521f1580f4eSBarry Smith   PetscMPIInt       size, color, rank;
522aa21023fSPierre Jolivet   PetscBool         flg;
523aa21023fSPierre Jolivet   const char       *name;
524f1580f4eSBarry Smith 
525f1580f4eSBarry Smith   PetscFunctionBegin;
526aa21023fSPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &flg));
527aa21023fSPierre Jolivet   if (flg) {
528f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "level%s: %" PetscInt_FMT "\n", data->N > 1 ? "s" : "", data->N));
529f1580f4eSBarry Smith     PetscCall(PCHPDDMGetComplexities(pc, &gc, &oc));
530f1580f4eSBarry Smith     if (data->N > 1) {
531f1580f4eSBarry Smith       if (!data->deflation) {
532c8ea6600SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "Neumann matrix attached? %s\n", PetscBools[PetscBool3ToBool(data->Neumann)]));
533f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, "shared subdomain KSP between SLEPc and PETSc? %s\n", PetscBools[data->share]));
534f1580f4eSBarry Smith       } else PetscCall(PetscViewerASCIIPrintf(viewer, "user-supplied deflation matrix\n"));
535f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "coarse correction: %s\n", PCHPDDMCoarseCorrectionTypes[data->correction]));
536f1580f4eSBarry 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" : ""));
537f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIGetTab(viewer, &tabs));
538f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, 0));
539f1580f4eSBarry Smith       for (i = 1; i < data->N; ++i) {
540f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, data->levels[i - 1]->nu));
5410594bca0SPierre Jolivet         if (data->levels[i - 1]->threshold > static_cast<PetscReal>(-0.1)) PetscCall(PetscViewerASCIIPrintf(viewer, " (%g)", (double)data->levels[i - 1]->threshold));
542f1580f4eSBarry Smith       }
543f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
544f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, tabs));
545f1580f4eSBarry Smith     }
546f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "grid and operator complexities: %g %g\n", (double)gc, (double)oc));
5471fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
5481fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank));
549f1580f4eSBarry Smith     if (data->levels[0]->ksp) {
550f1580f4eSBarry Smith       PetscCall(KSPView(data->levels[0]->ksp, viewer));
551f1580f4eSBarry Smith       if (data->levels[0]->pc) PetscCall(PCView(data->levels[0]->pc, viewer));
552f1580f4eSBarry Smith       for (i = 1; i < data->N; ++i) {
553f1580f4eSBarry Smith         if (data->levels[i]->ksp) color = 1;
554f1580f4eSBarry Smith         else color = 0;
555f1580f4eSBarry Smith         PetscCall(PetscSubcommCreate(PetscObjectComm((PetscObject)pc), &subcomm));
556f1580f4eSBarry Smith         PetscCall(PetscSubcommSetNumber(subcomm, PetscMin(size, 2)));
557f1580f4eSBarry Smith         PetscCall(PetscSubcommSetTypeGeneral(subcomm, color, rank));
558f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPushTab(viewer));
559f1580f4eSBarry Smith         PetscCall(PetscViewerGetSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
560f1580f4eSBarry Smith         if (color == 1) {
561f1580f4eSBarry Smith           PetscCall(KSPView(data->levels[i]->ksp, subviewer));
562f1580f4eSBarry Smith           if (data->levels[i]->pc) PetscCall(PCView(data->levels[i]->pc, subviewer));
563f1580f4eSBarry Smith           PetscCall(PetscViewerFlush(subviewer));
564f1580f4eSBarry Smith         }
565f1580f4eSBarry Smith         PetscCall(PetscViewerRestoreSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
566f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPopTab(viewer));
567f1580f4eSBarry Smith         PetscCall(PetscSubcommDestroy(&subcomm));
568f1580f4eSBarry Smith       }
569f1580f4eSBarry Smith     }
570aa21023fSPierre Jolivet     PetscCall(PetscViewerGetFormat(viewer, &format));
571aa21023fSPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
572aa21023fSPierre Jolivet       PetscCall(PetscViewerFileGetName(viewer, &name));
573aa21023fSPierre Jolivet       if (name) {
574aa21023fSPierre Jolivet         IS          is;
575aa21023fSPierre Jolivet         PetscInt    sizes[4] = {pc->mat->rmap->n, pc->mat->cmap->n, pc->mat->rmap->N, pc->mat->cmap->N};
576aa21023fSPierre Jolivet         char       *tmp;
577aa21023fSPierre Jolivet         std::string prefix, suffix;
578aa21023fSPierre Jolivet         size_t      pos;
579aa21023fSPierre Jolivet 
580aa21023fSPierre Jolivet         PetscCall(PetscStrstr(name, ".", &tmp));
581aa21023fSPierre Jolivet         if (tmp) {
582aa21023fSPierre Jolivet           pos    = std::distance(const_cast<char *>(name), tmp);
583aa21023fSPierre Jolivet           prefix = std::string(name, pos);
584aa21023fSPierre Jolivet           suffix = std::string(name + pos + 1);
585aa21023fSPierre Jolivet         } else prefix = name;
586aa21023fSPierre Jolivet         if (data->aux) {
587aa21023fSPierre 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));
588aa21023fSPierre Jolivet           PetscCall(MatView(data->aux, subviewer));
589aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
590aa21023fSPierre Jolivet         }
591aa21023fSPierre Jolivet         if (data->is) {
592aa21023fSPierre 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));
593aa21023fSPierre Jolivet           PetscCall(ISView(data->is, subviewer));
594aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
595aa21023fSPierre Jolivet         }
596aa21023fSPierre Jolivet         PetscCall(ISCreateGeneral(PETSC_COMM_SELF, PETSC_STATIC_ARRAY_LENGTH(sizes), sizes, PETSC_USE_POINTER, &is));
597aa21023fSPierre 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));
598aa21023fSPierre Jolivet         PetscCall(ISView(is, subviewer));
599aa21023fSPierre Jolivet         PetscCall(PetscViewerDestroy(&subviewer));
600aa21023fSPierre Jolivet         PetscCall(ISDestroy(&is));
601aa21023fSPierre Jolivet       }
602aa21023fSPierre Jolivet     }
603f1580f4eSBarry Smith   }
6043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
605f1580f4eSBarry Smith }
606f1580f4eSBarry Smith 
607d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCPreSolve_HPDDM(PC pc, KSP ksp, Vec, Vec)
608d71ae5a4SJacob Faibussowitsch {
609f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
610f1580f4eSBarry Smith   Mat       A;
611cdbd50ebSPierre Jolivet   PetscBool flg;
612f1580f4eSBarry Smith 
613f1580f4eSBarry Smith   PetscFunctionBegin;
614f1580f4eSBarry Smith   if (ksp) {
615f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPLSQR, &flg));
616f1580f4eSBarry Smith     if (flg && !data->normal) {
617db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(ksp, &A, nullptr));
618db4a47b3SPierre Jolivet       PetscCall(MatCreateVecs(A, nullptr, &data->normal)); /* temporary Vec used in PCApply_HPDDMShell() for coarse grid corrections */
619cdbd50ebSPierre Jolivet     } else if (!flg) {
620cdbd50ebSPierre Jolivet       PetscCall(PetscObjectTypeCompareAny((PetscObject)ksp, &flg, KSPCG, KSPGROPPCG, KSPPIPECG, KSPPIPECGRR, KSPPIPELCG, KSPPIPEPRCG, KSPPIPECG2, KSPSTCG, KSPFCG, KSPPIPEFCG, KSPMINRES, KSPNASH, KSPSYMMLQ, ""));
621cdbd50ebSPierre Jolivet       if (!flg) {
622cdbd50ebSPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPHPDDM, &flg));
623cdbd50ebSPierre Jolivet         if (flg) {
624cdbd50ebSPierre Jolivet           KSPHPDDMType type;
625cdbd50ebSPierre Jolivet           PetscCall(KSPHPDDMGetType(ksp, &type));
626cdbd50ebSPierre Jolivet           flg = (type == KSP_HPDDM_TYPE_CG || type == KSP_HPDDM_TYPE_BCG || type == KSP_HPDDM_TYPE_BFBCG ? PETSC_TRUE : PETSC_FALSE);
627cdbd50ebSPierre Jolivet         }
628cdbd50ebSPierre Jolivet       }
629cdbd50ebSPierre Jolivet     }
630cdbd50ebSPierre Jolivet     if (flg) {
631cdbd50ebSPierre Jolivet       if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) {
632cdbd50ebSPierre Jolivet         PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_hpddm_coarse_correction", &flg));
633cdbd50ebSPierre 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",
634cdbd50ebSPierre Jolivet                    PCHPDDMCoarseCorrectionTypes[data->correction], ((PetscObject)ksp)->type_name, ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", PCHPDDMCoarseCorrectionTypes[data->correction], PCHPDDMCoarseCorrectionTypes[PC_HPDDM_COARSE_CORRECTION_BALANCED]);
635cdbd50ebSPierre Jolivet       }
636cdbd50ebSPierre Jolivet       for (PetscInt n = 0; n < data->N; ++n) {
637cdbd50ebSPierre Jolivet         if (data->levels[n]->pc) {
638cdbd50ebSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)data->levels[n]->pc, PCASM, &flg));
639cdbd50ebSPierre Jolivet           if (flg) {
640cdbd50ebSPierre Jolivet             PCASMType type;
641cdbd50ebSPierre Jolivet             PetscCall(PCASMGetType(data->levels[n]->pc, &type));
642cdbd50ebSPierre Jolivet             if (type == PC_ASM_RESTRICT || type == PC_ASM_INTERPOLATE) {
643cdbd50ebSPierre Jolivet               PetscCall(PetscOptionsHasName(((PetscObject)data->levels[n]->pc)->options, ((PetscObject)data->levels[n]->pc)->prefix, "-pc_asm_type", &flg));
644cdbd50ebSPierre 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],
645cdbd50ebSPierre Jolivet                          ((PetscObject)ksp)->type_name, ((PetscObject)data->levels[n]->pc)->prefix, PCASMTypes[type], PCASMTypes[PC_ASM_BASIC]);
646cdbd50ebSPierre Jolivet             }
647cdbd50ebSPierre Jolivet           }
648cdbd50ebSPierre Jolivet         }
649cdbd50ebSPierre Jolivet       }
650f1580f4eSBarry Smith     }
651f1580f4eSBarry Smith   }
6523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
653f1580f4eSBarry Smith }
654f1580f4eSBarry Smith 
655d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDMShell(PC pc)
656d71ae5a4SJacob Faibussowitsch {
657f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
658f1580f4eSBarry Smith   Mat             A, P;
659f1580f4eSBarry Smith   Vec             x;
660f1580f4eSBarry Smith   const char     *pcpre;
661f1580f4eSBarry Smith 
662f1580f4eSBarry Smith   PetscFunctionBegin;
663f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
664f1580f4eSBarry Smith   PetscCall(KSPGetOptionsPrefix(ctx->ksp, &pcpre));
665f1580f4eSBarry Smith   PetscCall(KSPGetOperators(ctx->ksp, &A, &P));
666f1580f4eSBarry Smith   /* smoother */
667f1580f4eSBarry Smith   PetscCall(PCSetOptionsPrefix(ctx->pc, pcpre));
668f1580f4eSBarry Smith   PetscCall(PCSetOperators(ctx->pc, A, P));
669f1580f4eSBarry Smith   if (!ctx->v[0]) {
670f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(ctx->D, 1, &ctx->v[0]));
671f1580f4eSBarry Smith     if (!std::is_same<PetscScalar, PetscReal>::value) PetscCall(VecDestroy(&ctx->D));
672db4a47b3SPierre Jolivet     PetscCall(MatCreateVecs(A, &x, nullptr));
673f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(x, 2, &ctx->v[1]));
674f1580f4eSBarry Smith     PetscCall(VecDestroy(&x));
675f1580f4eSBarry Smith   }
676f1580f4eSBarry Smith   std::fill_n(ctx->V, 3, nullptr);
6773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
678f1580f4eSBarry Smith }
679f1580f4eSBarry Smith 
680f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
681d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type x, Type y)
682d71ae5a4SJacob Faibussowitsch {
683f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
684f1580f4eSBarry Smith   PetscScalar    *out;
685f1580f4eSBarry Smith 
686f1580f4eSBarry Smith   PetscFunctionBegin;
687f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
688f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
689f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
690f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
691f1580f4eSBarry Smith   PetscCall(VecGetArrayWrite(ctx->v[0][0], &out));
692db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, 1); /* y = Q x */
693f1580f4eSBarry Smith   PetscCall(VecRestoreArrayWrite(ctx->v[0][0], &out));
694f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
695f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
696f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
6973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
698f1580f4eSBarry Smith }
699f1580f4eSBarry Smith 
700f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Mat>::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   Vec             vX, vY, vC;
705f1580f4eSBarry Smith   PetscScalar    *out;
706f1580f4eSBarry Smith   PetscInt        i, N;
707f1580f4eSBarry Smith 
708f1580f4eSBarry Smith   PetscFunctionBegin;
709f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
710db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
711f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
712f1580f4eSBarry Smith   for (i = 0; i < N; ++i) {
713f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(X, i, &vX));
714f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(ctx->V[0], i, &vC));
715f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
716f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
717f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(ctx->V[0], i, &vC));
718f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(X, i, &vX));
719f1580f4eSBarry Smith   }
720f1580f4eSBarry Smith   PetscCall(MatDenseGetArrayWrite(ctx->V[0], &out));
721db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, N); /* Y = Q X */
722f1580f4eSBarry Smith   PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &out));
723f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
724f1580f4eSBarry Smith   for (i = 0; i < N; ++i) {
725f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(ctx->V[0], i, &vC));
726f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(Y, i, &vY));
727f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
728f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
729f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &vY));
730f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(ctx->V[0], i, &vC));
731f1580f4eSBarry Smith   }
7323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
733f1580f4eSBarry Smith }
734f1580f4eSBarry Smith 
735f1580f4eSBarry Smith /*
736aa1539e9SPierre 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.
737f1580f4eSBarry Smith 
738f1580f4eSBarry Smith .vb
739f1580f4eSBarry Smith    (1) y =                Pmat^-1              x + Q x,
740f1580f4eSBarry Smith    (2) y =                Pmat^-1 (I - Amat Q) x + Q x (default),
741aa1539e9SPierre Jolivet    (3) y = (I - Q Amat^T) Pmat^-1 (I - Amat Q) x + Q x,
742aa1539e9SPierre Jolivet    (4) y =                Pmat^-1              x      .
743f1580f4eSBarry Smith .ve
744f1580f4eSBarry Smith 
745f1580f4eSBarry Smith    Input Parameters:
746f1580f4eSBarry Smith +     pc - preconditioner context
747f1580f4eSBarry Smith -     x - input vector
748f1580f4eSBarry Smith 
749f1580f4eSBarry Smith    Output Parameter:
750f1580f4eSBarry Smith .     y - output vector
751f1580f4eSBarry Smith 
752f1580f4eSBarry Smith    Notes:
753f1580f4eSBarry 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.
754f1580f4eSBarry 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.
755f1580f4eSBarry 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.
756f1580f4eSBarry Smith 
757f1580f4eSBarry Smith    Level: advanced
758f1580f4eSBarry Smith 
759f1580f4eSBarry Smith    Developer Note:
760f1580f4eSBarry 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
761f1580f4eSBarry Smith    to trigger it. Likely the manual page is `PCHPDDM`
762f1580f4eSBarry Smith 
763562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
764f1580f4eSBarry Smith */
765d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDMShell(PC pc, Vec x, Vec y)
766d71ae5a4SJacob Faibussowitsch {
767f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
768f1580f4eSBarry Smith   Mat             A;
769f1580f4eSBarry Smith 
770f1580f4eSBarry Smith   PetscFunctionBegin;
771f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
772f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
773db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
774aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApply(ctx->pc, x, y)); /* y = M^-1 x */
775aa1539e9SPierre Jolivet   else {
776f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, x, y)); /* y = Q x */
777f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
778f1580f4eSBarry Smith       if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMult(A, y, ctx->v[1][0])); /* y = A Q x     */
779f1580f4eSBarry Smith       else { /* KSPLSQR and finest level */ PetscCall(MatMult(A, y, ctx->parent->normal));               /* y = A Q x     */
780f1580f4eSBarry Smith         PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][0]));                      /* y = A^T A Q x */
781f1580f4eSBarry Smith       }
782f1580f4eSBarry Smith       PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x)); /* y = (I - A Q) x                             */
783f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, ctx->v[1][1], ctx->v[1][0]));  /* y = M^-1 (I - A Q) x                        */
784f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
785f1580f4eSBarry 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 */
786f1580f4eSBarry Smith         else {
787f1580f4eSBarry Smith           PetscCall(MatMult(A, ctx->v[1][0], ctx->parent->normal));
788f1580f4eSBarry Smith           PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][1])); /* z = A^T A y           */
789f1580f4eSBarry Smith         }
790f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->v[1][1], ctx->v[1][1]));
791f1580f4eSBarry 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      */
792f1580f4eSBarry Smith       } else PetscCall(VecAXPY(y, 1.0, ctx->v[1][0]));                         /* y = Q M^-1 (I - A Q) x + Q x */
793f1580f4eSBarry Smith     } else {
794f1580f4eSBarry 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);
795f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, x, ctx->v[1][0]));
796f1580f4eSBarry Smith       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-1 x + Q x */
797f1580f4eSBarry Smith     }
798aa1539e9SPierre Jolivet   }
7993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
800f1580f4eSBarry Smith }
801f1580f4eSBarry Smith 
802f1580f4eSBarry Smith /*
803f1580f4eSBarry Smith      PCMatApply_HPDDMShell - Variant of PCApply_HPDDMShell() for blocks of vectors.
804f1580f4eSBarry Smith 
805f1580f4eSBarry Smith    Input Parameters:
806f1580f4eSBarry Smith +     pc - preconditioner context
807f1580f4eSBarry Smith -     X - block of input vectors
808f1580f4eSBarry Smith 
809f1580f4eSBarry Smith    Output Parameter:
810f1580f4eSBarry Smith .     Y - block of output vectors
811f1580f4eSBarry Smith 
812f1580f4eSBarry Smith    Level: advanced
813f1580f4eSBarry Smith 
814562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
815f1580f4eSBarry Smith */
816d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDMShell(PC pc, Mat X, Mat Y)
817d71ae5a4SJacob Faibussowitsch {
818f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
819f1580f4eSBarry Smith   Mat             A, *ptr;
820db4a47b3SPierre Jolivet   PetscContainer  container = nullptr;
821f1580f4eSBarry Smith   PetscScalar    *array;
822f1580f4eSBarry Smith   PetscInt        m, M, N, prev = 0;
823f1580f4eSBarry Smith   PetscBool       reset = PETSC_FALSE;
824f1580f4eSBarry Smith 
825f1580f4eSBarry Smith   PetscFunctionBegin;
826f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
827f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
828db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
829db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
830aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApply(ctx->pc, X, Y));
831aa1539e9SPierre Jolivet   else {
832f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)A, "_HPDDM_MatProduct", (PetscObject *)&container));
833f1580f4eSBarry Smith     if (container) { /* MatProduct container already attached */
834f1580f4eSBarry Smith       PetscCall(PetscContainerGetPointer(container, (void **)&ptr));
835f1580f4eSBarry Smith       if (ptr[1] != ctx->V[2]) /* Mat has changed or may have been set first in KSPHPDDM */
836f1580f4eSBarry Smith         for (m = 0; m < 2; ++m) {
837f1580f4eSBarry Smith           PetscCall(MatDestroy(ctx->V + m + 1));
838f1580f4eSBarry Smith           ctx->V[m + 1] = ptr[m];
839f1580f4eSBarry Smith           PetscCall(PetscObjectReference((PetscObject)ctx->V[m + 1]));
840f1580f4eSBarry Smith         }
841f1580f4eSBarry Smith     }
842db4a47b3SPierre Jolivet     if (ctx->V[1]) PetscCall(MatGetSize(ctx->V[1], nullptr, &prev));
843f1580f4eSBarry Smith     if (N != prev || !ctx->V[0]) {
844f1580f4eSBarry Smith       PetscCall(MatDestroy(ctx->V));
845f1580f4eSBarry Smith       PetscCall(VecGetLocalSize(ctx->v[0][0], &m));
846db4a47b3SPierre Jolivet       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, PETSC_DECIDE, N, nullptr, ctx->V));
847f1580f4eSBarry Smith       if (N != prev) {
848f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 1));
849f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 2));
850db4a47b3SPierre Jolivet         PetscCall(MatGetLocalSize(X, &m, nullptr));
851db4a47b3SPierre Jolivet         PetscCall(MatGetSize(X, &M, nullptr));
852f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
853db4a47b3SPierre Jolivet         else array = nullptr;
854f1580f4eSBarry Smith         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, array, ctx->V + 1));
855f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
856db4a47b3SPierre Jolivet         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, nullptr, ctx->V + 2));
857db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, Y, nullptr, ctx->V[1]));
858f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[1], MATPRODUCT_AB));
859f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[1]));
860f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[1]));
861f1580f4eSBarry Smith         if (!container) { /* no MatProduct container attached, create one to be queried in KSPHPDDM or at the next call to PCMatApply() */
862f1580f4eSBarry Smith           PetscCall(PetscContainerCreate(PetscObjectComm((PetscObject)A), &container));
863f1580f4eSBarry Smith           PetscCall(PetscObjectCompose((PetscObject)A, "_HPDDM_MatProduct", (PetscObject)container));
864f1580f4eSBarry Smith         }
8653f68fba4SPierre Jolivet         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 */
866f1580f4eSBarry Smith       }
867f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
868db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, ctx->V[1], nullptr, ctx->V[2]));
869f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[2], MATPRODUCT_AtB));
870f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[2]));
871f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[2]));
872f1580f4eSBarry Smith       }
873f1580f4eSBarry Smith       ctx->P->start(N);
874f1580f4eSBarry Smith     }
875f1580f4eSBarry Smith     if (N == prev || container) { /* when MatProduct container is attached, always need to MatProductReplaceMats() since KSPHPDDM may have replaced the Mat as well */
876db4a47b3SPierre Jolivet       PetscCall(MatProductReplaceMats(nullptr, Y, nullptr, ctx->V[1]));
877f1580f4eSBarry Smith       if (container && ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) {
878f1580f4eSBarry Smith         PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
879f1580f4eSBarry Smith         PetscCall(MatDensePlaceArray(ctx->V[1], array));
880f1580f4eSBarry Smith         PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
881f1580f4eSBarry Smith         reset = PETSC_TRUE;
882f1580f4eSBarry Smith       }
883f1580f4eSBarry Smith     }
884f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, X, Y));
885f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
886f1580f4eSBarry Smith       PetscCall(MatProductNumeric(ctx->V[1]));
887f1580f4eSBarry Smith       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
888f1580f4eSBarry Smith       PetscCall(MatAXPY(ctx->V[2], -1.0, X, SAME_NONZERO_PATTERN));
889f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, ctx->V[2], ctx->V[1]));
890f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
891f1580f4eSBarry Smith         PetscCall(MatProductNumeric(ctx->V[2]));
892f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->V[2], ctx->V[2]));
893f1580f4eSBarry Smith         PetscCall(MatAXPY(ctx->V[1], -1.0, ctx->V[2], SAME_NONZERO_PATTERN));
894f1580f4eSBarry Smith       }
895f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
896f1580f4eSBarry Smith     } else {
897f1580f4eSBarry 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);
898f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, X, ctx->V[1]));
899f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
900f1580f4eSBarry Smith     }
901f1580f4eSBarry Smith     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
902aa1539e9SPierre Jolivet   }
9033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
904f1580f4eSBarry Smith }
905f1580f4eSBarry Smith 
906d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDMShell(PC pc)
907d71ae5a4SJacob Faibussowitsch {
908f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
909f1580f4eSBarry Smith   PetscContainer  container;
910f1580f4eSBarry Smith 
911f1580f4eSBarry Smith   PetscFunctionBegin;
912f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
913f1580f4eSBarry Smith   PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(ctx, PETSC_TRUE));
914f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(1, &ctx->v[0]));
915f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(2, &ctx->v[1]));
916f4f49eeaSPierre Jolivet   PetscCall(PetscObjectQuery((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", (PetscObject *)&container));
917f1580f4eSBarry Smith   PetscCall(PetscContainerDestroy(&container));
918f4f49eeaSPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", nullptr));
919f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V));
920f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 1));
921f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 2));
922f1580f4eSBarry Smith   PetscCall(VecDestroy(&ctx->D));
92301e3c840SPierre Jolivet   PetscCall(PetscSFDestroy(&ctx->scatter));
924f1580f4eSBarry Smith   PetscCall(PCDestroy(&ctx->pc));
9253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
926f1580f4eSBarry Smith }
927f1580f4eSBarry Smith 
9289bb5c669SPierre Jolivet template <class Type, bool T = false, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
9299bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type x, Type y)
9309bb5c669SPierre Jolivet {
9319bb5c669SPierre Jolivet   PetscFunctionBegin;
9329bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[0], std::get<1>(*p), SCATTER_FORWARD, x));
9339bb5c669SPierre Jolivet   if (!T) PetscCall(PCApply(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
9349bb5c669SPierre Jolivet   else PetscCall(PCApplyTranspose(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
9359bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[1], std::get<1>(*p), SCATTER_REVERSE, y));
9369bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9379bb5c669SPierre Jolivet }
9389bb5c669SPierre Jolivet 
9399bb5c669SPierre Jolivet template <class Type, bool = false, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
9409bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type X, Type Y)
9419bb5c669SPierre Jolivet {
9429bb5c669SPierre Jolivet   Mat B[2];
9439bb5c669SPierre Jolivet   Vec x, y;
9449bb5c669SPierre Jolivet 
9459bb5c669SPierre Jolivet   PetscFunctionBegin;
9469bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B));
9479bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B + 1));
9489bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
9499bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(X, i, &x));
9509bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B[0], i, &y));
9519bb5c669SPierre Jolivet     PetscCall(VecISCopy(y, std::get<1>(*p), SCATTER_FORWARD, x));
9529bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B[0], i, &y));
9539bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(X, i, &x));
9549bb5c669SPierre Jolivet   }
9559bb5c669SPierre Jolivet   PetscCall(PCMatApply(factor, B[0], B[1]));
9569bb5c669SPierre Jolivet   PetscCall(MatDestroy(B));
9579bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
9589bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B[1], i, &x));
9599bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &y));
9609bb5c669SPierre Jolivet     PetscCall(VecISCopy(x, std::get<1>(*p), SCATTER_REVERSE, y));
9619bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &y));
9629bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B[1], i, &x));
9639bb5c669SPierre Jolivet   }
9649bb5c669SPierre Jolivet   PetscCall(MatDestroy(B + 1));
9659bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9669bb5c669SPierre Jolivet }
9679bb5c669SPierre Jolivet 
9689bb5c669SPierre Jolivet template <class Type = Vec, bool T = false>
9699bb5c669SPierre Jolivet static PetscErrorCode PCApply_Schur(PC pc, Type x, Type y)
9709bb5c669SPierre Jolivet {
9719bb5c669SPierre Jolivet   PC                           factor;
9729bb5c669SPierre Jolivet   Mat                          A;
9739bb5c669SPierre Jolivet   MatSolverType                type;
9749bb5c669SPierre Jolivet   PetscBool                    flg;
9759bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
9769bb5c669SPierre Jolivet 
9779bb5c669SPierre Jolivet   PetscFunctionBegin;
9789bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
9799bb5c669SPierre Jolivet   PetscCall(KSPGetPC(std::get<0>(*p), &factor));
9809bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(factor, &type));
9819bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatrix(factor, &A));
9829bb5c669SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
9839bb5c669SPierre Jolivet   if (flg) {
9849bb5c669SPierre Jolivet     PetscCheck(PetscDefined(HAVE_MUMPS), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
9859bb5c669SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
9869bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 0));
9879bb5c669SPierre Jolivet #endif
9889bb5c669SPierre Jolivet   } else {
9899bb5c669SPierre Jolivet     PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &flg));
9909bb5c669SPierre Jolivet     PetscCheck(flg && PetscDefined(HAVE_MKL_PARDISO), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
9919bb5c669SPierre Jolivet     flg = PETSC_FALSE;
9929bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
9939bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 1));
9949bb5c669SPierre Jolivet #endif
9959bb5c669SPierre Jolivet   }
9969bb5c669SPierre Jolivet   PetscCall(PCApply_Schur_Private<Type, T>(p, factor, x, y));
9979bb5c669SPierre Jolivet   if (flg) {
9989bb5c669SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
9999bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1));
10009bb5c669SPierre Jolivet #endif
10019bb5c669SPierre Jolivet   } else {
10029bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
10039bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 0));
10049bb5c669SPierre Jolivet #endif
10059bb5c669SPierre Jolivet   }
10069bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10079bb5c669SPierre Jolivet }
10089bb5c669SPierre Jolivet 
10099bb5c669SPierre Jolivet static PetscErrorCode PCDestroy_Schur(PC pc)
10109bb5c669SPierre Jolivet {
10119bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
10129bb5c669SPierre Jolivet 
10139bb5c669SPierre Jolivet   PetscFunctionBegin;
10149bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
10159bb5c669SPierre Jolivet   PetscCall(ISDestroy(&std::get<1>(*p)));
10169bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p)));
10179bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p) + 1));
10189bb5c669SPierre Jolivet   PetscCall(PetscFree(p));
10199bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10209bb5c669SPierre Jolivet }
10219bb5c669SPierre Jolivet 
1022d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSolve_Private(const PC_HPDDM_Level *ctx, PetscScalar *rhs, const unsigned short &mu)
1023d71ae5a4SJacob Faibussowitsch {
1024f1580f4eSBarry Smith   Mat      B, X;
1025f1580f4eSBarry Smith   PetscInt n, N, j = 0;
1026f1580f4eSBarry Smith 
1027f1580f4eSBarry Smith   PetscFunctionBegin;
1028db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &B, nullptr));
1029db4a47b3SPierre Jolivet   PetscCall(MatGetLocalSize(B, &n, nullptr));
1030db4a47b3SPierre Jolivet   PetscCall(MatGetSize(B, &N, nullptr));
1031f1580f4eSBarry Smith   if (ctx->parent->log_separate) {
1032f1580f4eSBarry Smith     j = std::distance(ctx->parent->levels, std::find(ctx->parent->levels, ctx->parent->levels + ctx->parent->N, ctx));
1033db4a47b3SPierre Jolivet     PetscCall(PetscLogEventBegin(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
1034f1580f4eSBarry Smith   }
1035f1580f4eSBarry Smith   if (mu == 1) {
1036f1580f4eSBarry Smith     if (!ctx->ksp->vec_rhs) {
1037db4a47b3SPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ctx->ksp), 1, n, N, nullptr, &ctx->ksp->vec_rhs));
1038f1580f4eSBarry Smith       PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)ctx->ksp), n, N, &ctx->ksp->vec_sol));
1039f1580f4eSBarry Smith     }
1040f1580f4eSBarry Smith     PetscCall(VecPlaceArray(ctx->ksp->vec_rhs, rhs));
1041db4a47b3SPierre Jolivet     PetscCall(KSPSolve(ctx->ksp, nullptr, nullptr));
1042f1580f4eSBarry Smith     PetscCall(VecCopy(ctx->ksp->vec_sol, ctx->ksp->vec_rhs));
1043f1580f4eSBarry Smith     PetscCall(VecResetArray(ctx->ksp->vec_rhs));
1044f1580f4eSBarry Smith   } else {
1045f1580f4eSBarry Smith     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, rhs, &B));
1046db4a47b3SPierre Jolivet     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, nullptr, &X));
1047f1580f4eSBarry Smith     PetscCall(KSPMatSolve(ctx->ksp, B, X));
1048f1580f4eSBarry Smith     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
1049f1580f4eSBarry Smith     PetscCall(MatDestroy(&X));
1050f1580f4eSBarry Smith     PetscCall(MatDestroy(&B));
1051f1580f4eSBarry Smith   }
1052db4a47b3SPierre Jolivet   if (ctx->parent->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
10533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1054f1580f4eSBarry Smith }
1055f1580f4eSBarry Smith 
1056d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetUpNeumannOverlap_Private(PC pc)
1057d71ae5a4SJacob Faibussowitsch {
1058f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
1059f1580f4eSBarry Smith 
1060f1580f4eSBarry Smith   PetscFunctionBegin;
1061f1580f4eSBarry Smith   if (data->setup) {
1062f1580f4eSBarry Smith     Mat       P;
1063db4a47b3SPierre Jolivet     Vec       x, xt = nullptr;
1064f1580f4eSBarry Smith     PetscReal t = 0.0, s = 0.0;
1065f1580f4eSBarry Smith 
1066db4a47b3SPierre Jolivet     PetscCall(PCGetOperators(pc, nullptr, &P));
1067f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)P, "__SNES_latest_X", (PetscObject *)&x));
1068f1580f4eSBarry Smith     PetscCallBack("PCHPDDM Neumann callback", (*data->setup)(data->aux, t, x, xt, s, data->is, data->setup_ctx));
1069f1580f4eSBarry Smith   }
10703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1071f1580f4eSBarry Smith }
1072f1580f4eSBarry Smith 
1073d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCreateSubMatrices_Private(Mat mat, PetscInt n, const IS *, const IS *, MatReuse scall, Mat *submat[])
1074d71ae5a4SJacob Faibussowitsch {
1075f1580f4eSBarry Smith   Mat       A;
107613044ca3SPierre Jolivet   PetscBool flg;
1077f1580f4eSBarry Smith 
1078f1580f4eSBarry Smith   PetscFunctionBegin;
1079f1580f4eSBarry Smith   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatCreateSubMatrices() called to extract %" PetscInt_FMT " submatrices, which is different than 1", n);
1080f1580f4eSBarry Smith   /* previously composed Mat */
1081f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)mat, "_PCHPDDM_SubMatrices", (PetscObject *)&A));
1082f1580f4eSBarry Smith   PetscCheck(A, PETSC_COMM_SELF, PETSC_ERR_PLIB, "SubMatrices not found in Mat");
108313044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSCHURCOMPLEMENT, &flg)); /* MATSCHURCOMPLEMENT has neither a MatDuplicate() nor a MatCopy() implementation */
1084f1580f4eSBarry Smith   if (scall == MAT_INITIAL_MATRIX) {
10856f2c871aSStefano Zampini     PetscCall(PetscCalloc1(2, submat)); /* allocate an extra Mat to avoid errors in MatDestroySubMatrices_Dummy() */
108613044ca3SPierre Jolivet     if (!flg) PetscCall(MatDuplicate(A, MAT_COPY_VALUES, *submat));
108713044ca3SPierre Jolivet   } else if (!flg) PetscCall(MatCopy(A, (*submat)[0], SAME_NONZERO_PATTERN));
108813044ca3SPierre Jolivet   if (flg) {
1089bf583f0cSPierre Jolivet     PetscCall(MatDestroy(*submat)); /* previously created Mat has to be destroyed */
109013044ca3SPierre Jolivet     (*submat)[0] = A;
109113044ca3SPierre Jolivet     PetscCall(PetscObjectReference((PetscObject)A));
109213044ca3SPierre Jolivet   }
10933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1094f1580f4eSBarry Smith }
1095f1580f4eSBarry Smith 
1096d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCommunicationAvoidingPCASM_Private(PC pc, Mat C, PetscBool sorted)
1097d71ae5a4SJacob Faibussowitsch {
1098f1580f4eSBarry Smith   void (*op)(void);
1099f1580f4eSBarry Smith 
1100f1580f4eSBarry Smith   PetscFunctionBegin;
1101f1580f4eSBarry Smith   /* previously-composed Mat */
1102f1580f4eSBarry Smith   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", (PetscObject)C));
1103f1580f4eSBarry Smith   PetscCall(MatGetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, &op));
1104f1580f4eSBarry Smith   /* trick suggested by Barry https://lists.mcs.anl.gov/pipermail/petsc-dev/2020-January/025491.html */
1105f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, (void (*)(void))PCHPDDMCreateSubMatrices_Private));
1106f1580f4eSBarry Smith   if (sorted) PetscCall(PCASMSetSortIndices(pc, PETSC_FALSE)); /* everything is already sorted */
1107f1580f4eSBarry Smith   PetscCall(PCSetFromOptions(pc));                             /* otherwise -pc_hpddm_levels_1_pc_asm_sub_mat_type is not used */
1108f1580f4eSBarry Smith   PetscCall(PCSetUp(pc));
1109f1580f4eSBarry Smith   /* reset MatCreateSubMatrices() */
1110f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, op));
1111db4a47b3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", nullptr));
11123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1113f1580f4eSBarry Smith }
1114f1580f4eSBarry Smith 
1115d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMPermute_Private(IS is, IS in_is, IS *out_is, Mat in_C, Mat *out_C, IS *p)
1116d71ae5a4SJacob Faibussowitsch {
1117f1580f4eSBarry Smith   IS                           perm;
1118f1580f4eSBarry Smith   const PetscInt              *ptr;
1119b07dfdedSPierre Jolivet   PetscInt                    *concatenate, size, n, bs;
1120f1580f4eSBarry Smith   std::map<PetscInt, PetscInt> order;
1121f1580f4eSBarry Smith   PetscBool                    sorted;
1122f1580f4eSBarry Smith 
1123f1580f4eSBarry Smith   PetscFunctionBegin;
1124cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(is, IS_CLASSID, 1);
1125cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(in_C, MAT_CLASSID, 4);
1126f1580f4eSBarry Smith   PetscCall(ISSorted(is, &sorted));
1127f1580f4eSBarry Smith   if (!sorted) {
1128f1580f4eSBarry Smith     PetscCall(ISGetLocalSize(is, &size));
1129f1580f4eSBarry Smith     PetscCall(ISGetIndices(is, &ptr));
1130b07dfdedSPierre Jolivet     PetscCall(ISGetBlockSize(is, &bs));
1131f1580f4eSBarry Smith     /* MatCreateSubMatrices(), called by PCASM, follows the global numbering of Pmat */
1132b07dfdedSPierre Jolivet     for (n = 0; n < size; n += bs) order.insert(std::make_pair(ptr[n] / bs, n / bs));
1133f1580f4eSBarry Smith     PetscCall(ISRestoreIndices(is, &ptr));
1134b07dfdedSPierre Jolivet     size /= bs;
1135f1580f4eSBarry Smith     if (out_C) {
1136f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1137f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.second;
1138f1580f4eSBarry Smith       concatenate -= size;
1139b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_C), bs, size, concatenate, PETSC_OWN_POINTER, &perm));
1140f1580f4eSBarry Smith       PetscCall(ISSetPermutation(perm));
1141f1580f4eSBarry Smith       /* permute user-provided Mat so that it matches with MatCreateSubMatrices() numbering */
1142f1580f4eSBarry Smith       PetscCall(MatPermute(in_C, perm, perm, out_C));
1143f1580f4eSBarry Smith       if (p) *p = perm;
1144f1580f4eSBarry Smith       else PetscCall(ISDestroy(&perm)); /* no need to save the permutation */
1145f1580f4eSBarry Smith     }
1146f1580f4eSBarry Smith     if (out_is) {
1147f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1148f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.first;
1149f1580f4eSBarry Smith       concatenate -= size;
1150f1580f4eSBarry Smith       /* permute user-provided IS so that it matches with MatCreateSubMatrices() numbering */
1151b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_is), bs, size, concatenate, PETSC_OWN_POINTER, out_is));
1152f1580f4eSBarry Smith     }
1153f1580f4eSBarry Smith   } else { /* input IS is sorted, nothing to permute, simply duplicate inputs when needed */
1154f1580f4eSBarry Smith     if (out_C) PetscCall(MatDuplicate(in_C, MAT_COPY_VALUES, out_C));
1155f1580f4eSBarry Smith     if (out_is) PetscCall(ISDuplicate(in_is, out_is));
1156f1580f4eSBarry Smith   }
11573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1158f1580f4eSBarry Smith }
1159f1580f4eSBarry Smith 
11605e642048SPierre Jolivet static PetscErrorCode PCHPDDMCheckSymmetry_Private(PC pc, Mat A01, Mat A10)
116113044ca3SPierre Jolivet {
116213044ca3SPierre Jolivet   Mat       T, U = nullptr, B = nullptr;
116313044ca3SPierre Jolivet   IS        z;
116413044ca3SPierre Jolivet   PetscBool flg[2];
116513044ca3SPierre Jolivet 
116613044ca3SPierre Jolivet   PetscFunctionBegin;
116713044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, flg));
116813044ca3SPierre Jolivet   if (flg[0]) PetscCall(MatTransposeGetMat(A10, &U));
116913044ca3SPierre Jolivet   else {
117013044ca3SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, flg + 1));
117113044ca3SPierre Jolivet     if (flg[1]) PetscCall(MatHermitianTransposeGetMat(A10, &U));
117213044ca3SPierre Jolivet   }
117313044ca3SPierre Jolivet   if (U) PetscCall(MatDuplicate(U, MAT_COPY_VALUES, &T));
117413044ca3SPierre Jolivet   else PetscCall(MatHermitianTranspose(A10, MAT_INITIAL_MATRIX, &T));
117513044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATTRANSPOSEVIRTUAL, flg));
117613044ca3SPierre Jolivet   if (flg[0]) {
117713044ca3SPierre Jolivet     PetscCall(MatTransposeGetMat(A01, &A01));
117813044ca3SPierre Jolivet     PetscCall(MatTranspose(A01, MAT_INITIAL_MATRIX, &B));
117913044ca3SPierre Jolivet     A01 = B;
118013044ca3SPierre Jolivet   } else {
118113044ca3SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATHERMITIANTRANSPOSEVIRTUAL, flg));
118213044ca3SPierre Jolivet     if (flg[0]) {
118313044ca3SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A01, &A01));
118413044ca3SPierre Jolivet       PetscCall(MatHermitianTranspose(A01, MAT_INITIAL_MATRIX, &B));
118513044ca3SPierre Jolivet       A01 = B;
118613044ca3SPierre Jolivet     }
118713044ca3SPierre Jolivet   }
118813044ca3SPierre Jolivet   PetscCall(PetscLayoutCompare(T->rmap, A01->rmap, flg));
118913044ca3SPierre Jolivet   if (flg[0]) {
119013044ca3SPierre Jolivet     PetscCall(PetscLayoutCompare(T->cmap, A01->cmap, flg));
119113044ca3SPierre Jolivet     if (flg[0]) {
119213044ca3SPierre Jolivet       PetscCall(MatFindZeroRows(A01, &z)); /* for essential boundary conditions, some implementations will */
119313044ca3SPierre Jolivet       if (z) {                             /*  zero rows in [P00 A01] except for the diagonal of P00       */
119413044ca3SPierre Jolivet         PetscCall(MatSetOption(T, MAT_NO_OFF_PROC_ZERO_ROWS, PETSC_TRUE));
119513044ca3SPierre Jolivet         PetscCall(MatZeroRowsIS(T, z, 0.0, nullptr, nullptr)); /* corresponding zero rows from A01 */
119613044ca3SPierre Jolivet         PetscCall(ISDestroy(&z));
119713044ca3SPierre Jolivet       }
119813044ca3SPierre Jolivet       PetscCall(MatMultEqual(A01, T, 20, flg));
119913044ca3SPierre Jolivet       PetscCheck(flg[0], PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "A01 != A10^T");
120013044ca3SPierre Jolivet     } else PetscCall(PetscInfo(pc, "A01 and A10^T have non-congruent column layouts, cannot test for equality\n"));
120113044ca3SPierre Jolivet   }
120213044ca3SPierre Jolivet   PetscCall(MatDestroy(&B));
120313044ca3SPierre Jolivet   PetscCall(MatDestroy(&T));
120413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
120513044ca3SPierre Jolivet }
120613044ca3SPierre Jolivet 
1207*d16c0b94SPierre Jolivet static PetscErrorCode PCHPDDMCheckInclusion_Private(PC pc, IS is, IS is_local, PetscBool check)
1208*d16c0b94SPierre Jolivet {
1209*d16c0b94SPierre Jolivet   IS          intersect;
1210*d16c0b94SPierre Jolivet   const char *str = "IS of the auxiliary Mat does not include all local rows of A";
1211*d16c0b94SPierre Jolivet   PetscBool   equal;
1212*d16c0b94SPierre Jolivet 
1213*d16c0b94SPierre Jolivet   PetscFunctionBegin;
1214*d16c0b94SPierre Jolivet   PetscCall(ISIntersect(is, is_local, &intersect));
1215*d16c0b94SPierre Jolivet   PetscCall(ISEqualUnsorted(is_local, intersect, &equal));
1216*d16c0b94SPierre Jolivet   PetscCall(ISDestroy(&intersect));
1217*d16c0b94SPierre Jolivet   if (check) PetscCheck(equal, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "%s", str);
1218*d16c0b94SPierre Jolivet   else if (!equal) PetscCall(PetscInfo(pc, "%s\n", str));
1219*d16c0b94SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1220*d16c0b94SPierre Jolivet }
1221*d16c0b94SPierre Jolivet 
1222d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMDestroySubMatrices_Private(PetscBool flg, PetscBool algebraic, Mat *sub)
1223d71ae5a4SJacob Faibussowitsch {
1224f1580f4eSBarry Smith   IS is;
1225f1580f4eSBarry Smith 
1226f1580f4eSBarry Smith   PetscFunctionBegin;
1227f1580f4eSBarry Smith   if (!flg) {
1228f1580f4eSBarry Smith     if (algebraic) {
1229f1580f4eSBarry Smith       PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Embed", (PetscObject *)&is));
1230f1580f4eSBarry Smith       PetscCall(ISDestroy(&is));
1231db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Embed", nullptr));
1232db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Compact", nullptr));
1233f1580f4eSBarry Smith     }
1234f1580f4eSBarry Smith     PetscCall(MatDestroySubMatrices(algebraic ? 2 : 1, &sub));
1235f1580f4eSBarry Smith   }
12363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1237f1580f4eSBarry Smith }
1238f1580f4eSBarry Smith 
1239d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMAlgebraicAuxiliaryMat_Private(Mat P, IS *is, Mat *sub[], PetscBool block)
1240d71ae5a4SJacob Faibussowitsch {
1241f1580f4eSBarry Smith   IS         icol[3], irow[2];
1242f1580f4eSBarry Smith   Mat       *M, Q;
1243f1580f4eSBarry Smith   PetscReal *ptr;
1244f1580f4eSBarry Smith   PetscInt  *idx, p = 0, n, bs = PetscAbs(P->cmap->bs);
1245f1580f4eSBarry Smith   PetscBool  flg;
1246f1580f4eSBarry Smith 
1247f1580f4eSBarry Smith   PetscFunctionBegin;
1248f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, P->cmap->N, 0, 1, icol + 2));
1249f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(icol[2], bs));
1250f1580f4eSBarry Smith   PetscCall(ISSetIdentity(icol[2]));
1251f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1252f1580f4eSBarry Smith   if (flg) {
1253f1580f4eSBarry Smith     /* MatCreateSubMatrices() does not handle MATMPISBAIJ properly when iscol != isrow, so convert first to MATMPIBAIJ */
1254f1580f4eSBarry Smith     PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &Q));
1255f1580f4eSBarry Smith     std::swap(P, Q);
1256f1580f4eSBarry Smith   }
1257f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(P, 1, is, icol + 2, MAT_INITIAL_MATRIX, &M));
1258f1580f4eSBarry Smith   if (flg) {
1259f1580f4eSBarry Smith     std::swap(P, Q);
1260f1580f4eSBarry Smith     PetscCall(MatDestroy(&Q));
1261f1580f4eSBarry Smith   }
1262f1580f4eSBarry Smith   PetscCall(ISDestroy(icol + 2));
1263f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, M[0]->rmap->N, 0, 1, irow));
1264f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(irow[0], bs));
1265f1580f4eSBarry Smith   PetscCall(ISSetIdentity(irow[0]));
1266f1580f4eSBarry Smith   if (!block) {
1267b07dfdedSPierre Jolivet     PetscCall(PetscMalloc2(P->cmap->N, &ptr, P->cmap->N / bs, &idx));
1268f1580f4eSBarry Smith     PetscCall(MatGetColumnNorms(M[0], NORM_INFINITY, ptr));
1269f1580f4eSBarry Smith     /* check for nonzero columns so that M[0] may be expressed in compact form */
1270b07dfdedSPierre Jolivet     for (n = 0; n < P->cmap->N; n += bs) {
1271b07dfdedSPierre Jolivet       if (std::find_if(ptr + n, ptr + n + bs, [](PetscReal v) { return v > PETSC_MACHINE_EPSILON; }) != ptr + n + bs) idx[p++] = n / bs;
1272f1580f4eSBarry Smith     }
1273b07dfdedSPierre Jolivet     PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, p, idx, PETSC_USE_POINTER, icol + 1));
1274f1580f4eSBarry Smith     PetscCall(ISSetInfo(icol[1], IS_SORTED, IS_GLOBAL, PETSC_TRUE, PETSC_TRUE));
1275f1580f4eSBarry Smith     PetscCall(ISEmbed(*is, icol[1], PETSC_FALSE, icol + 2));
1276f1580f4eSBarry Smith     irow[1] = irow[0];
1277f1580f4eSBarry 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 */
1278f1580f4eSBarry Smith     icol[0] = is[0];
1279f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 2, irow, icol, MAT_INITIAL_MATRIX, sub));
1280f1580f4eSBarry Smith     PetscCall(ISDestroy(icol + 1));
1281f1580f4eSBarry Smith     PetscCall(PetscFree2(ptr, idx));
1282f1580f4eSBarry Smith     /* IS used to go back and forth between the augmented and the original local linear system, see eq. (3.4) of [2022b] */
1283f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Embed", (PetscObject)icol[2]));
1284f1580f4eSBarry Smith     /* Mat used in eq. (3.1) of [2022b] */
1285f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Compact", (PetscObject)(*sub)[1]));
1286f1580f4eSBarry Smith   } else {
1287f1580f4eSBarry Smith     Mat aux;
1288f1580f4eSBarry Smith     PetscCall(MatSetOption(M[0], MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1289f1580f4eSBarry Smith     /* diagonal block of the overlapping rows */
1290f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 1, irow, is, MAT_INITIAL_MATRIX, sub));
1291f1580f4eSBarry Smith     PetscCall(MatDuplicate((*sub)[0], MAT_COPY_VALUES, &aux));
1292f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1293f1580f4eSBarry Smith     if (bs == 1) { /* scalar case */
1294f1580f4eSBarry Smith       Vec sum[2];
1295f1580f4eSBarry Smith       PetscCall(MatCreateVecs(aux, sum, sum + 1));
1296f1580f4eSBarry Smith       PetscCall(MatGetRowSum(M[0], sum[0]));
1297f1580f4eSBarry Smith       PetscCall(MatGetRowSum(aux, sum[1]));
1298f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1299f1580f4eSBarry Smith       PetscCall(VecAXPY(sum[0], -1.0, sum[1]));
1300f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1301f1580f4eSBarry Smith       PetscCall(MatDiagonalSet(aux, sum[0], ADD_VALUES));
1302f1580f4eSBarry Smith       PetscCall(VecDestroy(sum));
1303f1580f4eSBarry Smith       PetscCall(VecDestroy(sum + 1));
1304f1580f4eSBarry Smith     } else { /* vectorial case */
1305f1580f4eSBarry Smith       /* TODO: missing MatGetValuesBlocked(), so the code below is     */
1306f1580f4eSBarry Smith       /* an extension of the scalar case for when bs > 1, but it could */
1307f1580f4eSBarry Smith       /* be more efficient by avoiding all these MatMatMult()          */
1308f1580f4eSBarry Smith       Mat          sum[2], ones;
1309f1580f4eSBarry Smith       PetscScalar *ptr;
1310f1580f4eSBarry Smith       PetscCall(PetscCalloc1(M[0]->cmap->n * bs, &ptr));
1311f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, M[0]->cmap->n, bs, M[0]->cmap->n, bs, ptr, &ones));
1312f1580f4eSBarry Smith       for (n = 0; n < M[0]->cmap->n; n += bs) {
1313f1580f4eSBarry Smith         for (p = 0; p < bs; ++p) ptr[n + p * (M[0]->cmap->n + 1)] = 1.0;
1314f1580f4eSBarry Smith       }
1315f1580f4eSBarry Smith       PetscCall(MatMatMult(M[0], ones, MAT_INITIAL_MATRIX, PETSC_DEFAULT, sum));
1316f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1317f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, aux->cmap->n, bs, aux->cmap->n, bs, ptr, &ones));
1318f1580f4eSBarry Smith       PetscCall(MatDenseSetLDA(ones, M[0]->cmap->n));
1319f1580f4eSBarry Smith       PetscCall(MatMatMult(aux, ones, MAT_INITIAL_MATRIX, PETSC_DEFAULT, sum + 1));
1320f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1321f1580f4eSBarry Smith       PetscCall(PetscFree(ptr));
1322f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1323f1580f4eSBarry Smith       PetscCall(MatAXPY(sum[0], -1.0, sum[1], SAME_NONZERO_PATTERN));
1324f1580f4eSBarry Smith       PetscCall(MatDestroy(sum + 1));
1325f1580f4eSBarry Smith       /* re-order values to be consistent with MatSetValuesBlocked()           */
1326f1580f4eSBarry Smith       /* equivalent to MatTranspose() which does not truly handle              */
1327f1580f4eSBarry Smith       /* MAT_INPLACE_MATRIX in the rectangular case, as it calls PetscMalloc() */
1328f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(sum[0], &ptr));
1329f1580f4eSBarry Smith       HPDDM::Wrapper<PetscScalar>::imatcopy<'T'>(bs, sum[0]->rmap->n, ptr, sum[0]->rmap->n, bs);
1330f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1331f1580f4eSBarry Smith       for (n = 0; n < aux->cmap->n / bs; ++n) PetscCall(MatSetValuesBlocked(aux, 1, &n, 1, &n, ptr + n * bs * bs, ADD_VALUES));
1332f1580f4eSBarry Smith       PetscCall(MatAssemblyBegin(aux, MAT_FINAL_ASSEMBLY));
1333f1580f4eSBarry Smith       PetscCall(MatAssemblyEnd(aux, MAT_FINAL_ASSEMBLY));
1334f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(sum[0], &ptr));
1335f1580f4eSBarry Smith       PetscCall(MatDestroy(sum));
1336f1580f4eSBarry Smith     }
1337f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
1338f1580f4eSBarry Smith     /* left-hand side of GenEO, with the same sparsity pattern as PCASM subdomain solvers  */
1339f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Neumann_Mat", (PetscObject)aux));
1340f1580f4eSBarry Smith   }
1341f1580f4eSBarry Smith   PetscCall(ISDestroy(irow));
1342f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &M));
13433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1344f1580f4eSBarry Smith }
1345f1580f4eSBarry Smith 
134613044ca3SPierre Jolivet static PetscErrorCode PCApply_Nest(PC pc, Vec x, Vec y)
134713044ca3SPierre Jolivet {
134813044ca3SPierre Jolivet   Mat                    A;
134913044ca3SPierre Jolivet   MatSolverType          type;
135013044ca3SPierre Jolivet   IS                     is[2];
135113044ca3SPierre Jolivet   PetscBool              flg;
135213044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
135313044ca3SPierre Jolivet 
135413044ca3SPierre Jolivet   PetscFunctionBegin;
135513044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
135613044ca3SPierre Jolivet   PetscCall(PCGetOperators(p->first, &A, nullptr));
135713044ca3SPierre Jolivet   PetscCall(MatNestGetISs(A, is, nullptr));
135813044ca3SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(p->first, &type));
135913044ca3SPierre Jolivet   PetscCall(PCFactorGetMatrix(p->first, &A));
136013044ca3SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
136124ddd604SPierre Jolivet   if (flg && A->schur) {
136213044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
136313044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 1)); /* reduction/condensation phase followed by Schur complement solve */
136413044ca3SPierre Jolivet #endif
136513044ca3SPierre Jolivet   }
136613044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[0], is[1], SCATTER_FORWARD, x)); /* assign the RHS associated to the Schur complement */
136713044ca3SPierre Jolivet   PetscCall(PCApply(p->first, p->second[0], p->second[1]));
136813044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[1], is[1], SCATTER_REVERSE, y)); /* retrieve the partial solution associated to the Schur complement */
136913044ca3SPierre Jolivet   if (flg) {
137013044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
137113044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1)); /* default ICNTL(26) value in PETSc */
137213044ca3SPierre Jolivet #endif
137313044ca3SPierre Jolivet   }
137413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
137513044ca3SPierre Jolivet }
137613044ca3SPierre Jolivet 
137713044ca3SPierre Jolivet static PetscErrorCode PCView_Nest(PC pc, PetscViewer viewer)
137813044ca3SPierre Jolivet {
137913044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
138013044ca3SPierre Jolivet 
138113044ca3SPierre Jolivet   PetscFunctionBegin;
138213044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
138313044ca3SPierre Jolivet   PetscCall(PCView(p->first, viewer));
138413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
138513044ca3SPierre Jolivet }
138613044ca3SPierre Jolivet 
138713044ca3SPierre Jolivet static PetscErrorCode PCDestroy_Nest(PC pc)
138813044ca3SPierre Jolivet {
138913044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
139013044ca3SPierre Jolivet 
139113044ca3SPierre Jolivet   PetscFunctionBegin;
139213044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
139313044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second));
139413044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second + 1));
139513044ca3SPierre Jolivet   PetscCall(PCDestroy(&p->first));
139613044ca3SPierre Jolivet   PetscCall(PetscFree(p));
139713044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
139813044ca3SPierre Jolivet }
139913044ca3SPierre Jolivet 
140013044ca3SPierre Jolivet template <bool T = false>
140113044ca3SPierre Jolivet static PetscErrorCode MatMult_Schur(Mat A, Vec x, Vec y)
140213044ca3SPierre Jolivet {
140301e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
140413044ca3SPierre Jolivet 
140513044ca3SPierre Jolivet   PetscFunctionBegin;
140613044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
140713044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD)); /* local Vec with overlap */
140813044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD));
140913044ca3SPierre Jolivet   if (!T) PetscCall(MatMult(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1])); /* local Schur complement */
141013044ca3SPierre Jolivet   else PetscCall(MatMultTranspose(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1]));
141113044ca3SPierre Jolivet   PetscCall(VecSet(y, 0.0));
141213044ca3SPierre 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 */
141313044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE));
141413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
141513044ca3SPierre Jolivet }
141613044ca3SPierre Jolivet 
141713044ca3SPierre Jolivet static PetscErrorCode MatDestroy_Schur(Mat A)
141813044ca3SPierre Jolivet {
141901e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
142013044ca3SPierre Jolivet 
142113044ca3SPierre Jolivet   PetscFunctionBegin;
142213044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
142313044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx)));
142413044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx) + 1));
142513044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
142613044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
142713044ca3SPierre Jolivet }
142813044ca3SPierre Jolivet 
142913044ca3SPierre Jolivet static PetscErrorCode MatMult_SchurCorrection(Mat A, Vec x, Vec y)
143013044ca3SPierre Jolivet {
143113044ca3SPierre Jolivet   PC                                         pc;
143213044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
143313044ca3SPierre Jolivet 
143413044ca3SPierre Jolivet   PetscFunctionBegin;
143513044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
143613044ca3SPierre Jolivet   pc = ((PC_HPDDM *)std::get<0>(*ctx)[0]->data)->levels[0]->ksp->pc;
143713044ca3SPierre 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 */
143813044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], x, std::get<3>(*ctx)[1]));                    /*     A_01 x                 */
143913044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 x             */
144013044ca3SPierre 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        */
144113044ca3SPierre 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 */
144213044ca3SPierre Jolivet   } else {
144313044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[0]));                    /*     M_S^-1 x               */
144413044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], std::get<3>(*ctx)[0], std::get<3>(*ctx)[1])); /*     A_01 M_S^-1 x          */
144513044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 M_S^-1 x      */
144613044ca3SPierre 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 */
144713044ca3SPierre Jolivet   }
144813044ca3SPierre Jolivet   PetscCall(VecAXPY(y, -1.0, x)); /* y -= x, preconditioned eq. (24) of https://hal.science/hal-02343808v6/document (with a sign flip) */
144913044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
145013044ca3SPierre Jolivet }
145113044ca3SPierre Jolivet 
145213044ca3SPierre Jolivet static PetscErrorCode MatView_SchurCorrection(Mat A, PetscViewer viewer)
145313044ca3SPierre Jolivet {
145413044ca3SPierre Jolivet   PetscBool                                  ascii;
145513044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
145613044ca3SPierre Jolivet 
145713044ca3SPierre Jolivet   PetscFunctionBegin;
145813044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &ascii));
145913044ca3SPierre Jolivet   if (ascii) {
146013044ca3SPierre Jolivet     PetscCall(MatShellGetContext(A, &ctx));
146113044ca3SPierre 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)"));
146213044ca3SPierre Jolivet     PetscCall(PCView(std::get<0>(*ctx)[1], viewer)); /* no need to PCView(Q_0) since it will be done by PCFIELDSPLIT */
146313044ca3SPierre Jolivet   }
146413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
146513044ca3SPierre Jolivet }
146613044ca3SPierre Jolivet 
146713044ca3SPierre Jolivet static PetscErrorCode MatDestroy_SchurCorrection(Mat A)
146813044ca3SPierre Jolivet {
146913044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
147013044ca3SPierre Jolivet 
147113044ca3SPierre Jolivet   PetscFunctionBegin;
147213044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
147313044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx)));
147413044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 1));
147513044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 2));
147613044ca3SPierre Jolivet   PetscCall(PCDestroy(std::get<0>(*ctx) + 1));
147713044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
147813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
147913044ca3SPierre Jolivet }
148013044ca3SPierre Jolivet 
148113044ca3SPierre Jolivet static PetscErrorCode KSPPreSolve_SchurCorrection(KSP, Vec b, Vec, void *context)
148213044ca3SPierre Jolivet {
148313044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
148413044ca3SPierre Jolivet 
1485a6b3e571SPierre Jolivet   PetscFunctionBegin;
148613044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
148713044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], b, std::get<3>(*ctx)[2]));
148813044ca3SPierre 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 */
148913044ca3SPierre Jolivet   }
149013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
149113044ca3SPierre Jolivet }
149213044ca3SPierre Jolivet 
149313044ca3SPierre Jolivet static PetscErrorCode KSPPostSolve_SchurCorrection(KSP, Vec b, Vec x, void *context)
149413044ca3SPierre Jolivet {
149513044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
149613044ca3SPierre Jolivet 
1497a6b3e571SPierre Jolivet   PetscFunctionBegin;
149813044ca3SPierre 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 */
149913044ca3SPierre Jolivet   else {
150013044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[2]));
150113044ca3SPierre Jolivet     PetscCall(VecCopy(std::get<3>(*ctx)[2], x)); /* replace x by M^-1 x */
150213044ca3SPierre Jolivet   }
150313044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
150413044ca3SPierre Jolivet }
150513044ca3SPierre Jolivet 
15069bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat, Vec, Vec);
15079bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat, Vec, Vec);
15089bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat, Mat, Mat, void *);
15099bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat);
15109bb5c669SPierre Jolivet 
1511d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDM(PC pc)
1512d71ae5a4SJacob Faibussowitsch {
1513f1580f4eSBarry Smith   PC_HPDDM                                  *data = (PC_HPDDM *)pc->data;
1514f1580f4eSBarry Smith   PC                                         inner;
1515f1580f4eSBarry Smith   KSP                                       *ksp;
151613044ca3SPierre Jolivet   Mat                                       *sub, A, P, N, C = nullptr, uaux = nullptr, weighted, subA[2], S;
1517f1580f4eSBarry Smith   Vec                                        xin, v;
1518f1580f4eSBarry Smith   std::vector<Vec>                           initial;
1519db4a47b3SPierre Jolivet   IS                                         is[1], loc, uis = data->is, unsorted = nullptr;
1520f1580f4eSBarry Smith   ISLocalToGlobalMapping                     l2g;
1521f1580f4eSBarry Smith   char                                       prefix[256];
1522f1580f4eSBarry Smith   const char                                *pcpre;
1523f1580f4eSBarry Smith   const PetscScalar *const                  *ev;
15249bb5c669SPierre Jolivet   PetscInt                                   n, requested = data->N, reused = 0, overlap = -1;
1525f1580f4eSBarry Smith   MatStructure                               structure  = UNKNOWN_NONZERO_PATTERN;
1526f1580f4eSBarry Smith   PetscBool                                  subdomains = PETSC_FALSE, flg = PETSC_FALSE, ismatis, swap = PETSC_FALSE, algebraic = PETSC_FALSE, block = PETSC_FALSE;
1527f1580f4eSBarry Smith   DM                                         dm;
152813044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = nullptr;
1529398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1530db4a47b3SPierre Jolivet   IS  dis  = nullptr;
1531db4a47b3SPierre Jolivet   Mat daux = nullptr;
1532398c7888SPierre Jolivet #endif
1533f1580f4eSBarry Smith 
1534f1580f4eSBarry Smith   PetscFunctionBegin;
1535f1580f4eSBarry Smith   PetscCheck(data->levels && data->levels[0], PETSC_COMM_SELF, PETSC_ERR_PLIB, "Not a single level allocated");
1536f1580f4eSBarry Smith   PetscCall(PCGetOptionsPrefix(pc, &pcpre));
1537f1580f4eSBarry Smith   PetscCall(PCGetOperators(pc, &A, &P));
1538f1580f4eSBarry Smith   if (!data->levels[0]->ksp) {
1539f1580f4eSBarry Smith     PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->ksp));
15403821be0aSBarry Smith     PetscCall(KSPSetNestLevel(data->levels[0]->ksp, pc->kspnestlevel));
1541f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_%s_", pcpre ? pcpre : "", data->N > 1 ? "levels_1" : "coarse"));
1542f1580f4eSBarry Smith     PetscCall(KSPSetOptionsPrefix(data->levels[0]->ksp, prefix));
1543f1580f4eSBarry Smith     PetscCall(KSPSetType(data->levels[0]->ksp, KSPPREONLY));
1544f1580f4eSBarry Smith   } else if (data->levels[0]->ksp->pc && data->levels[0]->ksp->pc->setupcalled == 1 && data->levels[0]->ksp->pc->reusepreconditioner) {
1545f1580f4eSBarry Smith     /* if the fine-level PCSHELL exists, its setup has succeeded, and one wants to reuse it, */
1546f1580f4eSBarry Smith     /* then just propagate the appropriate flag to the coarser levels                        */
1547f1580f4eSBarry Smith     for (n = 0; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1548f1580f4eSBarry Smith       /* the following KSP and PC may be NULL for some processes, hence the check            */
1549f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetReusePreconditioner(data->levels[n]->ksp, PETSC_TRUE));
1550f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
1551f1580f4eSBarry Smith     }
1552f1580f4eSBarry Smith     /* early bail out because there is nothing to do */
15533ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1554f1580f4eSBarry Smith   } else {
1555f1580f4eSBarry Smith     /* reset coarser levels */
1556f1580f4eSBarry Smith     for (n = 1; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1557f1580f4eSBarry 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) {
1558f1580f4eSBarry Smith         reused = data->N - n;
1559f1580f4eSBarry Smith         break;
1560f1580f4eSBarry Smith       }
1561f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[n]->ksp));
1562f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[n]->pc));
1563f1580f4eSBarry Smith     }
1564f1580f4eSBarry Smith     /* check if some coarser levels are being reused */
1565f1580f4eSBarry Smith     PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &reused, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)pc)));
1566f1580f4eSBarry Smith     const int *addr = data->levels[0]->P ? data->levels[0]->P->getAddrLocal() : &HPDDM::i__0;
1567f1580f4eSBarry Smith 
1568f1580f4eSBarry Smith     if (addr != &HPDDM::i__0 && reused != data->N - 1) {
1569f1580f4eSBarry Smith       /* reuse previously computed eigenvectors */
1570f1580f4eSBarry Smith       ev = data->levels[0]->P->getVectors();
1571f1580f4eSBarry Smith       if (ev) {
1572f1580f4eSBarry Smith         initial.reserve(*addr);
1573f1580f4eSBarry Smith         PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, data->levels[0]->P->getDof(), ev[0], &xin));
1574f1580f4eSBarry Smith         for (n = 0; n < *addr; ++n) {
1575f1580f4eSBarry Smith           PetscCall(VecDuplicate(xin, &v));
1576f1580f4eSBarry Smith           PetscCall(VecPlaceArray(xin, ev[n]));
1577f1580f4eSBarry Smith           PetscCall(VecCopy(xin, v));
1578f1580f4eSBarry Smith           initial.emplace_back(v);
1579f1580f4eSBarry Smith           PetscCall(VecResetArray(xin));
1580f1580f4eSBarry Smith         }
1581f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
1582f1580f4eSBarry Smith       }
1583f1580f4eSBarry Smith     }
1584f1580f4eSBarry Smith   }
1585f1580f4eSBarry Smith   data->N -= reused;
1586f1580f4eSBarry Smith   PetscCall(KSPSetOperators(data->levels[0]->ksp, A, P));
1587f1580f4eSBarry Smith 
1588f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATIS, &ismatis));
1589f1580f4eSBarry Smith   if (!data->is && !ismatis) {
1590db4a47b3SPierre Jolivet     PetscErrorCode (*create)(DM, IS *, Mat *, PetscErrorCode (**)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void **) = nullptr;
1591db4a47b3SPierre Jolivet     PetscErrorCode (*usetup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *)                                                = nullptr;
1592db4a47b3SPierre Jolivet     void *uctx                                                                                                               = nullptr;
1593f1580f4eSBarry Smith 
1594f1580f4eSBarry Smith     /* first see if we can get the data from the DM */
1595f1580f4eSBarry Smith     PetscCall(MatGetDM(P, &dm));
1596f1580f4eSBarry Smith     if (!dm) PetscCall(MatGetDM(A, &dm));
1597f1580f4eSBarry Smith     if (!dm) PetscCall(PCGetDM(pc, &dm));
1598907a3e9cSStefano Zampini     if (dm) { /* this is the hook for DMPLEX for which the auxiliary Mat is the local Neumann matrix */
1599f1580f4eSBarry Smith       PetscCall(PetscObjectQueryFunction((PetscObject)dm, "DMCreateNeumannOverlap_C", &create));
1600f1580f4eSBarry Smith       if (create) {
1601f1580f4eSBarry Smith         PetscCall((*create)(dm, &uis, &uaux, &usetup, &uctx));
1602c8ea6600SPierre 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 */
1603f1580f4eSBarry Smith       }
1604f1580f4eSBarry Smith     }
1605f1580f4eSBarry Smith     if (!create) {
1606f1580f4eSBarry Smith       if (!uis) {
1607f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1608f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1609f1580f4eSBarry Smith       }
1610f1580f4eSBarry Smith       if (!uaux) {
1611f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1612f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1613f1580f4eSBarry Smith       }
1614f1580f4eSBarry Smith       /* look inside the Pmat instead of the PC, needed for MatSchurComplementComputeExplicitOperator() */
1615f1580f4eSBarry Smith       if (!uis) {
1616f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1617f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1618f1580f4eSBarry Smith       }
1619f1580f4eSBarry Smith       if (!uaux) {
1620f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1621f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1622f1580f4eSBarry Smith       }
1623f1580f4eSBarry Smith     }
1624f1580f4eSBarry Smith     PetscCall(PCHPDDMSetAuxiliaryMat(pc, uis, uaux, usetup, uctx));
1625f1580f4eSBarry Smith     PetscCall(MatDestroy(&uaux));
1626f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
1627f1580f4eSBarry Smith   }
1628f1580f4eSBarry Smith 
1629f1580f4eSBarry Smith   if (!ismatis) {
1630f1580f4eSBarry Smith     PetscCall(PCHPDDMSetUpNeumannOverlap_Private(pc));
1631db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_block_splitting", &block, nullptr));
16329bb5c669SPierre Jolivet     PetscCall(PetscOptionsGetInt(nullptr, pcpre, "-pc_hpddm_harmonic_overlap", &overlap, nullptr));
16335e642048SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
16345e642048SPierre Jolivet     if (data->is || (data->N > 1 && flg)) {
16359bb5c669SPierre Jolivet       if (block || overlap != -1) {
163602800ff6SPierre Jolivet         PetscCall(ISDestroy(&data->is));
163702800ff6SPierre Jolivet         PetscCall(MatDestroy(&data->aux));
16385e642048SPierre Jolivet       } else if (data->N > 1 && flg) {
163913044ca3SPierre Jolivet         PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_GENEO;
164013044ca3SPierre Jolivet 
164113044ca3SPierre Jolivet         PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
164213044ca3SPierre Jolivet         if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
164313044ca3SPierre Jolivet           PetscCall(ISDestroy(&data->is)); /* destroy any previously user-set objects since they will be set automatically */
164413044ca3SPierre Jolivet           PetscCall(MatDestroy(&data->aux));
164513044ca3SPierre Jolivet         } else if (type == PC_HPDDM_SCHUR_PRE_GENEO) {
164613044ca3SPierre Jolivet           PetscContainer container = nullptr;
164713044ca3SPierre Jolivet 
164813044ca3SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Schur", (PetscObject *)&container));
164913044ca3SPierre Jolivet           if (!container) { /* first call to PCSetUp() on the PC associated to the Schur complement */
165013044ca3SPierre Jolivet             PC_HPDDM *data_00;
165113044ca3SPierre Jolivet             KSP       ksp, inner_ksp;
165213044ca3SPierre Jolivet             PC        pc_00;
1653cf67ef9dSPierre Jolivet             Mat       A11 = nullptr;
1654cf67ef9dSPierre Jolivet             Vec       d   = nullptr;
165513044ca3SPierre Jolivet             char     *prefix;
165613044ca3SPierre Jolivet 
165713044ca3SPierre Jolivet             PetscCall(MatSchurComplementGetKSP(P, &ksp));
165813044ca3SPierre Jolivet             PetscCall(KSPGetPC(ksp, &pc_00));
165913044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)pc_00, PCHPDDM, &flg));
1660fd310a01SPierre 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 : "",
166113044ca3SPierre Jolivet                        ((PetscObject)pc_00)->type_name, PCHPDDM);
166213044ca3SPierre Jolivet             data_00 = (PC_HPDDM *)pc_00->data;
1663fd310a01SPierre 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],
1664fd310a01SPierre Jolivet                        data_00->N, data_00->N > 1 ? "s" : "", ((PetscObject)pc_00)->prefix);
166513044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)data_00->levels[0]->pc, PCASM, &flg));
1666fd310a01SPierre 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,
166713044ca3SPierre Jolivet                        ((PetscObject)data_00->levels[0]->pc)->type_name, PCASM);
1668*d16c0b94SPierre Jolivet             PetscCall(MatSchurComplementGetSubMatrices(P, nullptr, nullptr, nullptr, nullptr, &A11));
16695e642048SPierre Jolivet             if (PetscDefined(USE_DEBUG) || !data->is) {
16705e642048SPierre Jolivet               Mat A01, A10, B = nullptr, C = nullptr, *sub;
167113044ca3SPierre Jolivet 
16725e642048SPierre Jolivet               PetscCall(MatSchurComplementGetSubMatrices(P, &A, nullptr, &A01, &A10, nullptr));
16735e642048SPierre Jolivet               PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
16745e642048SPierre Jolivet               if (flg) {
16755e642048SPierre Jolivet                 PetscCall(MatTransposeGetMat(A10, &C));
16765e642048SPierre Jolivet                 PetscCall(MatTranspose(C, MAT_INITIAL_MATRIX, &B));
16775e642048SPierre Jolivet               } else {
16785e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
16795e642048SPierre Jolivet                 if (flg) {
16805e642048SPierre Jolivet                   PetscCall(MatHermitianTransposeGetMat(A10, &C));
16815e642048SPierre Jolivet                   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &B));
16825e642048SPierre Jolivet                 }
16835e642048SPierre Jolivet               }
16845e642048SPierre Jolivet               if (!B) {
16855e642048SPierre Jolivet                 B = A10;
16865e642048SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)B));
16875e642048SPierre Jolivet               } else if (!data->is) {
16885e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompareAny((PetscObject)A01, &flg, MATTRANSPOSEVIRTUAL, MATHERMITIANTRANSPOSEVIRTUAL, ""));
16895e642048SPierre Jolivet                 if (!flg) C = A01;
16905e642048SPierre Jolivet               }
169113044ca3SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, B->rmap->N, 0, 1, &uis));
16925e642048SPierre Jolivet               PetscCall(ISSetIdentity(uis));
16935e642048SPierre Jolivet               if (!data->is) {
16945e642048SPierre Jolivet                 if (C) PetscCall(PetscObjectReference((PetscObject)C));
16955e642048SPierre Jolivet                 else PetscCall(MatTranspose(B, MAT_INITIAL_MATRIX, &C));
16965e642048SPierre Jolivet                 PetscCall(ISDuplicate(data_00->is, is));
16975e642048SPierre Jolivet                 PetscCall(MatIncreaseOverlap(A, 1, is, 1));
16985e642048SPierre Jolivet                 PetscCall(MatSetOption(C, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
16995e642048SPierre Jolivet                 PetscCall(MatCreateSubMatrices(C, 1, is, &uis, MAT_INITIAL_MATRIX, &sub));
17005e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
17015e642048SPierre Jolivet                 PetscCall(MatTranspose(sub[0], MAT_INITIAL_MATRIX, &C));
17025e642048SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
17035e642048SPierre Jolivet                 PetscCall(MatFindNonzeroRows(C, &data->is));
17045e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
17055e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
1706*d16c0b94SPierre Jolivet                 PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), A11->rmap->n, A11->rmap->rstart, 1, &loc));
1707*d16c0b94SPierre Jolivet                 if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_FALSE));
1708*d16c0b94SPierre Jolivet                 PetscCall(ISExpand(data->is, loc, is));
1709*d16c0b94SPierre Jolivet                 PetscCall(ISDestroy(&loc));
1710*d16c0b94SPierre Jolivet                 PetscCall(ISDestroy(&data->is));
1711*d16c0b94SPierre Jolivet                 data->is = is[0];
1712*d16c0b94SPierre Jolivet                 is[0]    = nullptr;
17135e642048SPierre Jolivet               }
17145e642048SPierre Jolivet               if (PetscDefined(USE_DEBUG)) {
17155e642048SPierre Jolivet                 PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
171613044ca3SPierre 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 */
171713044ca3SPierre Jolivet                 PetscCall(ISDestroy(&uis));
171813044ca3SPierre Jolivet                 PetscCall(ISDuplicate(data->is, &uis));
171913044ca3SPierre Jolivet                 PetscCall(ISSort(uis));
17205e642048SPierre Jolivet                 PetscCall(ISComplement(uis, 0, B->rmap->N, is));
172113044ca3SPierre Jolivet                 PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &C));
17225e642048SPierre Jolivet                 PetscCall(MatZeroRowsIS(C, is[0], 0.0, nullptr, nullptr));
17235e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
172413044ca3SPierre Jolivet                 PetscCall(MatMultEqual(sub[0], C, 20, &flg));
172513044ca3SPierre 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 */
172613044ca3SPierre Jolivet                 PetscCall(MatDestroy(&C));
172713044ca3SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
172813044ca3SPierre Jolivet               }
17295e642048SPierre Jolivet               PetscCall(ISDestroy(&uis));
17305e642048SPierre Jolivet               PetscCall(MatDestroy(&B));
17315e642048SPierre Jolivet             }
1732cf67ef9dSPierre Jolivet             flg = PETSC_FALSE;
1733cf67ef9dSPierre Jolivet             if (!data->aux) {
1734cf67ef9dSPierre Jolivet               Mat D;
1735cf67ef9dSPierre Jolivet 
1736cf67ef9dSPierre Jolivet               PetscCall(MatCreateVecs(A11, &d, nullptr));
1737cf67ef9dSPierre Jolivet               PetscCall(MatGetDiagonal(A11, d));
1738cf67ef9dSPierre Jolivet               PetscCall(PetscObjectTypeCompareAny((PetscObject)A11, &flg, MATDIAGONAL, MATCONSTANTDIAGONAL, ""));
1739cf67ef9dSPierre Jolivet               if (!flg) {
1740cf67ef9dSPierre Jolivet                 PetscCall(MatCreateDiagonal(d, &D));
1741cf67ef9dSPierre Jolivet                 PetscCall(MatMultEqual(A11, D, 20, &flg));
1742cf67ef9dSPierre Jolivet                 PetscCall(MatDestroy(&D));
1743cf67ef9dSPierre Jolivet               }
1744cf67ef9dSPierre 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"));
1745cf67ef9dSPierre Jolivet             }
1746cf67ef9dSPierre Jolivet             if (data->Neumann != PETSC_BOOL3_TRUE && !flg && A11) {
1747cf67ef9dSPierre Jolivet               PetscReal norm;
1748cf67ef9dSPierre Jolivet 
1749cf67ef9dSPierre Jolivet               PetscCall(MatNorm(A11, NORM_INFINITY, &norm));
1750cf67ef9dSPierre 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 : "");
1751cf67ef9dSPierre 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"));
1752cf67ef9dSPierre Jolivet               PetscCall(MatDestroy(&data->aux));
1753cf67ef9dSPierre Jolivet               flg = PETSC_TRUE;
1754cf67ef9dSPierre Jolivet             }
1755cf67ef9dSPierre 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 */
175601e3c840SPierre Jolivet               PetscSF            scatter;
175713044ca3SPierre Jolivet               const PetscScalar *read;
1758cf67ef9dSPierre Jolivet               PetscScalar       *write, *diagonal = nullptr;
175913044ca3SPierre Jolivet 
176013044ca3SPierre Jolivet               PetscCall(MatDestroy(&data->aux));
176113044ca3SPierre Jolivet               PetscCall(ISGetLocalSize(data->is, &n));
1762cf67ef9dSPierre Jolivet               PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &xin));
1763cf67ef9dSPierre Jolivet               PetscCall(VecDuplicate(xin, &v));
1764cf67ef9dSPierre Jolivet               PetscCall(VecScatterCreate(xin, data->is, v, nullptr, &scatter));
176513044ca3SPierre Jolivet               PetscCall(VecSet(v, 1.0));
1766cf67ef9dSPierre Jolivet               PetscCall(VecSet(xin, 1.0));
1767cf67ef9dSPierre Jolivet               PetscCall(VecScatterBegin(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE));
1768cf67ef9dSPierre Jolivet               PetscCall(VecScatterEnd(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE)); /* v has the multiplicity of all unknowns on the overlap */
1769cf67ef9dSPierre Jolivet               PetscCall(PetscSFDestroy(&scatter));
1770cf67ef9dSPierre Jolivet               if (d) {
1771cf67ef9dSPierre Jolivet                 PetscCall(VecScatterCreate(d, data->is, v, nullptr, &scatter));
1772cf67ef9dSPierre Jolivet                 PetscCall(VecScatterBegin(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1773cf67ef9dSPierre Jolivet                 PetscCall(VecScatterEnd(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1774cf67ef9dSPierre Jolivet                 PetscCall(PetscSFDestroy(&scatter));
1775cf67ef9dSPierre Jolivet                 PetscCall(VecDestroy(&d));
1776cf67ef9dSPierre Jolivet                 PetscCall(PetscMalloc1(n, &diagonal));
1777cf67ef9dSPierre Jolivet                 PetscCall(VecGetArrayRead(v, &read));
1778cf67ef9dSPierre Jolivet                 PetscCallCXX(std::copy_n(read, n, diagonal));
1779cf67ef9dSPierre Jolivet                 PetscCall(VecRestoreArrayRead(v, &read));
1780cf67ef9dSPierre Jolivet               }
178113044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
178213044ca3SPierre Jolivet               PetscCall(VecCreateSeq(PETSC_COMM_SELF, n, &v));
1783cf67ef9dSPierre Jolivet               PetscCall(VecGetArrayRead(xin, &read));
178413044ca3SPierre Jolivet               PetscCall(VecGetArrayWrite(v, &write));
1785cf67ef9dSPierre 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];
1786cf67ef9dSPierre Jolivet               PetscCall(PetscFree(diagonal));
1787cf67ef9dSPierre Jolivet               PetscCall(VecRestoreArrayRead(xin, &read));
178813044ca3SPierre Jolivet               PetscCall(VecRestoreArrayWrite(v, &write));
1789cf67ef9dSPierre Jolivet               PetscCall(VecDestroy(&xin));
1790c3e1b152SPierre Jolivet               PetscCall(MatCreateDiagonal(v, &data->aux));
179113044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
179213044ca3SPierre Jolivet             }
179313044ca3SPierre Jolivet             uis  = data->is;
179413044ca3SPierre Jolivet             uaux = data->aux;
179513044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uis));
179613044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uaux));
179713044ca3SPierre Jolivet             PetscCall(PetscStrallocpy(pcpre, &prefix));
179813044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(pc, nullptr));
179913044ca3SPierre Jolivet             PetscCall(PCSetType(pc, PCKSP));                                    /* replace the PC associated to the Schur complement by PCKSP */
180013044ca3SPierre Jolivet             PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &inner_ksp)); /* new KSP that will be attached to the previously set PC */
180173329a61SPierre Jolivet             pc->ops->setup = PCSetUp_KSP;
180213044ca3SPierre Jolivet             PetscCall(PetscObjectGetTabLevel((PetscObject)pc, &n));
180313044ca3SPierre Jolivet             PetscCall(PetscObjectSetTabLevel((PetscObject)inner_ksp, n + 2));
180413044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, pc->mat, pc->pmat));
180513044ca3SPierre Jolivet             PetscCall(KSPSetOptionsPrefix(inner_ksp, std::string(std::string(prefix) + "pc_hpddm_").c_str()));
180613044ca3SPierre Jolivet             PetscCall(KSPSetSkipPCSetFromOptions(inner_ksp, PETSC_TRUE));
180713044ca3SPierre Jolivet             PetscCall(KSPSetFromOptions(inner_ksp));
180813044ca3SPierre Jolivet             PetscCall(KSPGetPC(inner_ksp, &inner));
180913044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(inner, nullptr));
181013044ca3SPierre Jolivet             PetscCall(PCSetType(inner, PCNONE)); /* no preconditioner since the action of M^-1 A or A M^-1 will be computed by the Amat */
181113044ca3SPierre Jolivet             PetscCall(PCKSPSetKSP(pc, inner_ksp));
181213044ca3SPierre Jolivet             PetscCall(PetscContainerCreate(PetscObjectComm((PetscObject)pc), &container));
181313044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx)); /* context to pass data around for the inner-most PC, which will be a proper PCHPDDM */
181413044ca3SPierre Jolivet             PetscCall(PetscContainerSetPointer(container, ctx));
181513044ca3SPierre Jolivet             std::get<0>(*ctx)[0] = pc_00; /* for coarse correction on the primal (e.g., velocity) space */
181613044ca3SPierre Jolivet             PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &std::get<0>(*ctx)[1]));
181713044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(std::get<0>(*ctx)[1], prefix));
181813044ca3SPierre Jolivet             PetscCall(PetscFree(prefix));
181913044ca3SPierre Jolivet             PetscCall(PCSetOperators(std::get<0>(*ctx)[1], pc->mat, pc->pmat));
182013044ca3SPierre Jolivet             PetscCall(PCSetType(std::get<0>(*ctx)[1], PCHPDDM));
182113044ca3SPierre 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 */
1822cf67ef9dSPierre Jolivet             if (flg) static_cast<PC_HPDDM *>(std::get<0>(*ctx)[1]->data)->Neumann = PETSC_BOOL3_TRUE;
182313044ca3SPierre Jolivet             PetscCall(PCSetFromOptions(std::get<0>(*ctx)[1]));
182413044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uis));
182513044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uaux));
182613044ca3SPierre 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 */
182713044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_MULT, (void (*)(void))MatMult_SchurCorrection));
182813044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_VIEW, (void (*)(void))MatView_SchurCorrection));
182913044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_DESTROY, (void (*)(void))MatDestroy_SchurCorrection));
183013044ca3SPierre Jolivet             PetscCall(KSPGetPCSide(inner_ksp, &(std::get<2>(*ctx))));
183113044ca3SPierre Jolivet             if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
183213044ca3SPierre Jolivet               PetscCall(KSPSetPreSolve(inner_ksp, KSPPreSolve_SchurCorrection, ctx));
183313044ca3SPierre Jolivet             } else { /* no support for PC_SYMMETRIC */
183413044ca3SPierre 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]);
183513044ca3SPierre Jolivet             }
183613044ca3SPierre Jolivet             PetscCall(KSPSetPostSolve(inner_ksp, KSPPostSolve_SchurCorrection, ctx));
183713044ca3SPierre Jolivet             PetscCall(PetscObjectCompose((PetscObject)(std::get<0>(*ctx)[1]), "_PCHPDDM_Schur", (PetscObject)container));
183813044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)container));
183913044ca3SPierre Jolivet             PetscCall(PCSetUp(std::get<0>(*ctx)[1]));
184013044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, S, S));
184113044ca3SPierre Jolivet             PetscCall(MatCreateVecs(std::get<1>(*ctx)[0], std::get<3>(*ctx), std::get<3>(*ctx) + 1));
184213044ca3SPierre Jolivet             PetscCall(VecDuplicate(std::get<3>(*ctx)[0], std::get<3>(*ctx) + 2));
184313044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)inner_ksp));
184413044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)S));
18450307214fSPierre Jolivet             for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
184613044ca3SPierre Jolivet             PetscFunctionReturn(PETSC_SUCCESS);
184713044ca3SPierre Jolivet           } else { /* second call to PCSetUp() on the PC associated to the Schur complement, retrieve previously set context */
184813044ca3SPierre Jolivet             PetscCall(PetscContainerGetPointer(container, (void **)&ctx));
184913044ca3SPierre Jolivet           }
185013044ca3SPierre Jolivet         }
185113044ca3SPierre Jolivet       }
185213044ca3SPierre Jolivet     }
1853f1580f4eSBarry Smith     if (!data->is && data->N > 1) {
1854f1580f4eSBarry Smith       char type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
1855f1580f4eSBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
1856f1580f4eSBarry Smith       if (flg || (A->rmap->N != A->cmap->N && P->rmap->N == P->cmap->N && P->rmap->N == A->cmap->N)) {
1857f1580f4eSBarry Smith         Mat B;
1858f1580f4eSBarry Smith         PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, A, P, &B, pcpre));
1859f1580f4eSBarry Smith         if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) data->correction = PC_HPDDM_COARSE_CORRECTION_BALANCED;
1860f1580f4eSBarry Smith         PetscCall(MatDestroy(&B));
1861f1580f4eSBarry Smith       } else {
1862f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
1863f1580f4eSBarry Smith         if (flg) {
1864f1580f4eSBarry Smith           Mat                 A00, P00, A01, A10, A11, B, N;
186513044ca3SPierre Jolivet           PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_LEAST_SQUARES;
186613044ca3SPierre Jolivet 
186713044ca3SPierre Jolivet           PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, &A01, &A10, &A11));
186813044ca3SPierre Jolivet           if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
186913044ca3SPierre Jolivet           PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
187013044ca3SPierre Jolivet           if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
18713df4cd7bSPierre Jolivet             Vec                        diagonal = nullptr;
1872f1580f4eSBarry Smith             const PetscScalar         *array;
1873f1580f4eSBarry Smith             MatSchurComplementAinvType type;
1874f1580f4eSBarry Smith 
1875f1580f4eSBarry Smith             if (A11) {
18763df4cd7bSPierre Jolivet               PetscCall(MatCreateVecs(A11, &diagonal, nullptr));
18773df4cd7bSPierre Jolivet               PetscCall(MatGetDiagonal(A11, diagonal));
1878f1580f4eSBarry Smith             }
1879db4a47b3SPierre Jolivet             PetscCall(MatCreateVecs(P00, &v, nullptr));
1880f1580f4eSBarry Smith             PetscCall(MatSchurComplementGetAinvType(P, &type));
1881f1580f4eSBarry 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]);
1882f1580f4eSBarry Smith             if (type == MAT_SCHUR_COMPLEMENT_AINV_LUMP) {
1883f1580f4eSBarry Smith               PetscCall(MatGetRowSum(P00, v));
1884f1580f4eSBarry Smith               if (A00 == P00) PetscCall(PetscObjectReference((PetscObject)A00));
1885f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1886f1580f4eSBarry Smith               PetscCall(VecGetArrayRead(v, &array));
1887db4a47b3SPierre Jolivet               PetscCall(MatCreateAIJ(PetscObjectComm((PetscObject)A00), A00->rmap->n, A00->cmap->n, A00->rmap->N, A00->cmap->N, 1, nullptr, 0, nullptr, &P00));
1888f1580f4eSBarry Smith               PetscCall(MatSetOption(P00, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
1889f1580f4eSBarry Smith               for (n = A00->rmap->rstart; n < A00->rmap->rend; ++n) PetscCall(MatSetValue(P00, n, n, array[n - A00->rmap->rstart], INSERT_VALUES));
1890f1580f4eSBarry Smith               PetscCall(MatAssemblyBegin(P00, MAT_FINAL_ASSEMBLY));
1891f1580f4eSBarry Smith               PetscCall(MatAssemblyEnd(P00, MAT_FINAL_ASSEMBLY));
1892f1580f4eSBarry Smith               PetscCall(VecRestoreArrayRead(v, &array));
1893f1580f4eSBarry Smith               PetscCall(MatSchurComplementUpdateSubMatrices(P, A00, P00, A01, A10, A11)); /* replace P00 by diag(sum of each row of P00) */
1894f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1895f1580f4eSBarry Smith             } else PetscCall(MatGetDiagonal(P00, v));
1896f1580f4eSBarry Smith             PetscCall(VecReciprocal(v)); /* inv(diag(P00))       */
1897f1580f4eSBarry Smith             PetscCall(VecSqrtAbs(v));    /* sqrt(inv(diag(P00))) */
1898f1580f4eSBarry Smith             PetscCall(MatDuplicate(A01, MAT_COPY_VALUES, &B));
1899db4a47b3SPierre Jolivet             PetscCall(MatDiagonalScale(B, v, nullptr));
1900f1580f4eSBarry Smith             PetscCall(VecDestroy(&v));
1901f1580f4eSBarry Smith             PetscCall(MatCreateNormalHermitian(B, &N));
19023df4cd7bSPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, B, N, &P, pcpre, &diagonal));
1903f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
1904f1580f4eSBarry Smith             if (!flg) {
1905f1580f4eSBarry Smith               PetscCall(MatDestroy(&P));
1906f1580f4eSBarry Smith               P = N;
1907f1580f4eSBarry Smith               PetscCall(PetscObjectReference((PetscObject)P));
1908f1580f4eSBarry Smith             } else PetscCall(MatScale(P, -1.0));
19093df4cd7bSPierre Jolivet             if (diagonal) {
19103df4cd7bSPierre Jolivet               PetscCall(MatDiagonalSet(P, diagonal, ADD_VALUES));
1911aa21023fSPierre Jolivet               PetscCall(PCSetOperators(pc, P, P)); /* replace P by diag(P11) - A01^T inv(diag(P00)) A01 */
19123df4cd7bSPierre Jolivet               PetscCall(VecDestroy(&diagonal));
19133df4cd7bSPierre Jolivet             } else {
1914f1580f4eSBarry Smith               PetscCall(MatScale(N, -1.0));
1915aa21023fSPierre Jolivet               PetscCall(PCSetOperators(pc, N, P)); /* replace P by - A01^T inv(diag(P00)) A01 */
19163df4cd7bSPierre Jolivet             }
1917f1580f4eSBarry Smith             PetscCall(MatDestroy(&N));
1918f1580f4eSBarry Smith             PetscCall(MatDestroy(&P));
1919f1580f4eSBarry Smith             PetscCall(MatDestroy(&B));
192013044ca3SPierre Jolivet           } else
1921fd310a01SPierre 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 : "");
19220307214fSPierre Jolivet           for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
19233ba16761SJacob Faibussowitsch           PetscFunctionReturn(PETSC_SUCCESS);
1924f1580f4eSBarry Smith         } else {
1925db4a47b3SPierre Jolivet           PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_st_pc_type", type, sizeof(type), nullptr));
1926f1580f4eSBarry Smith           PetscCall(PetscStrcmp(type, PCMAT, &algebraic));
1927b07dfdedSPierre Jolivet           PetscCheck(!algebraic || !block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_block_splitting");
19289bb5c669SPierre Jolivet           if (overlap != -1) {
19299bb5c669SPierre 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");
19309bb5c669SPierre Jolivet             PetscCheck(overlap >= 1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_WRONG, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " < 1", overlap);
19319bb5c669SPierre Jolivet           }
19329bb5c669SPierre Jolivet           if (block || overlap != -1) algebraic = PETSC_TRUE;
1933f1580f4eSBarry Smith           if (algebraic) {
1934f1580f4eSBarry Smith             PetscCall(ISCreateStride(PETSC_COMM_SELF, P->rmap->n, P->rmap->rstart, 1, &data->is));
1935f1580f4eSBarry Smith             PetscCall(MatIncreaseOverlap(P, 1, &data->is, 1));
1936f1580f4eSBarry Smith             PetscCall(ISSort(data->is));
19379bb5c669SPierre Jolivet           } else
19389bb5c669SPierre 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 : ""));
1939f1580f4eSBarry Smith         }
1940f1580f4eSBarry Smith       }
1941f1580f4eSBarry Smith     }
1942f1580f4eSBarry Smith   }
1943398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1944398c7888SPierre Jolivet   if (data->is) PetscCall(ISDuplicate(data->is, &dis));
1945398c7888SPierre Jolivet   if (data->aux) PetscCall(MatDuplicate(data->aux, MAT_COPY_VALUES, &daux));
1946398c7888SPierre Jolivet #endif
1947f1580f4eSBarry Smith   if (data->is || (ismatis && data->N > 1)) {
1948f1580f4eSBarry Smith     if (ismatis) {
1949f1580f4eSBarry Smith       std::initializer_list<std::string> list = {MATSEQBAIJ, MATSEQSBAIJ};
1950f1580f4eSBarry Smith       PetscCall(MatISGetLocalMat(P, &N));
1951f1580f4eSBarry Smith       std::initializer_list<std::string>::const_iterator it = std::find(list.begin(), list.end(), ((PetscObject)N)->type_name);
1952f1580f4eSBarry Smith       PetscCall(MatISRestoreLocalMat(P, &N));
1953f1580f4eSBarry Smith       switch (std::distance(list.begin(), it)) {
1954d71ae5a4SJacob Faibussowitsch       case 0:
1955d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
1956d71ae5a4SJacob Faibussowitsch         break;
1957f1580f4eSBarry Smith       case 1:
1958f1580f4eSBarry Smith         /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIBAIJ */
1959f1580f4eSBarry Smith         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
1960f1580f4eSBarry Smith         PetscCall(MatSetOption(C, MAT_SYMMETRIC, PETSC_TRUE));
1961f1580f4eSBarry Smith         break;
1962d71ae5a4SJacob Faibussowitsch       default:
1963d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, &C));
1964f1580f4eSBarry Smith       }
1965db4a47b3SPierre Jolivet       PetscCall(MatISGetLocalToGlobalMapping(P, &l2g, nullptr));
1966f1580f4eSBarry Smith       PetscCall(PetscObjectReference((PetscObject)P));
1967f1580f4eSBarry Smith       PetscCall(KSPSetOperators(data->levels[0]->ksp, A, C));
1968f1580f4eSBarry Smith       std::swap(C, P);
1969f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingGetSize(l2g, &n));
1970f1580f4eSBarry Smith       PetscCall(ISCreateStride(PETSC_COMM_SELF, n, 0, 1, &loc));
1971f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingApplyIS(l2g, loc, &is[0]));
1972f1580f4eSBarry Smith       PetscCall(ISDestroy(&loc));
1973f1580f4eSBarry Smith       /* the auxiliary Mat is _not_ the local Neumann matrix                                */
1974f1580f4eSBarry Smith       /* it is the local Neumann matrix augmented (with zeros) through MatIncreaseOverlap() */
1975c8ea6600SPierre Jolivet       data->Neumann = PETSC_BOOL3_FALSE;
1976f1580f4eSBarry Smith       structure     = SAME_NONZERO_PATTERN;
1977f1580f4eSBarry Smith     } else {
1978f1580f4eSBarry Smith       is[0] = data->is;
197913044ca3SPierre Jolivet       if (algebraic || ctx) subdomains = PETSC_TRUE;
1980db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_define_subdomains", &subdomains, nullptr));
198113044ca3SPierre 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);
1982c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann)) {
1983b07dfdedSPierre Jolivet         PetscCheck(!block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_block_splitting and -pc_hpddm_has_neumann");
19849bb5c669SPierre Jolivet         PetscCheck(overlap == -1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " and -pc_hpddm_has_neumann", overlap);
1985b07dfdedSPierre Jolivet         PetscCheck(!algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_has_neumann");
1986f1580f4eSBarry Smith       }
1987c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann) || block) structure = SAME_NONZERO_PATTERN;
1988f1580f4eSBarry Smith       PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), P->rmap->n, P->rmap->rstart, 1, &loc));
1989f1580f4eSBarry Smith     }
1990f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
1991db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetEnum(nullptr, prefix, "-st_matstructure", MatStructures, (PetscEnum *)&structure, &flg)); /* if not user-provided, force its value when possible */
1992f1580f4eSBarry Smith     if (!flg && structure == SAME_NONZERO_PATTERN) {                                                                   /* cannot call STSetMatStructure() yet, insert the appropriate option in the database, parsed by STSetFromOptions() */
1993f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-%spc_hpddm_levels_1_st_matstructure", pcpre ? pcpre : ""));
1994db4a47b3SPierre Jolivet       PetscCall(PetscOptionsSetValue(nullptr, prefix, MatStructures[structure]));
1995f1580f4eSBarry Smith     }
1996398c7888SPierre Jolivet     flg = PETSC_FALSE;
1997b07dfdedSPierre Jolivet     if (data->share) {
1998398c7888SPierre Jolivet       data->share = PETSC_FALSE; /* will be reset to PETSC_TRUE if none of the conditions below are true */
1999398c7888SPierre 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 : ""));
2000398c7888SPierre Jolivet       else if (data->deflation) PetscCall(PetscInfo(pc, "Nothing to share since PCHPDDMSetDeflationMat() has been called\n"));
2001398c7888SPierre Jolivet       else if (ismatis) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc with a Pmat of type MATIS\n"));
2002b07dfdedSPierre Jolivet       else if (!algebraic && structure != SAME_NONZERO_PATTERN)
2003398c7888SPierre 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]));
2004398c7888SPierre Jolivet       else data->share = PETSC_TRUE;
2005398c7888SPierre Jolivet     }
2006398c7888SPierre Jolivet     if (!ismatis) {
2007398c7888SPierre Jolivet       if (data->share || (!PetscBool3ToBool(data->Neumann) && subdomains)) PetscCall(ISDuplicate(is[0], &unsorted));
2008398c7888SPierre Jolivet       else unsorted = is[0];
2009398c7888SPierre Jolivet     }
2010f1580f4eSBarry Smith     if (data->N > 1 && (data->aux || ismatis || algebraic)) {
2011f1580f4eSBarry Smith       PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "HPDDM library not loaded, cannot use more than one level");
2012f1580f4eSBarry Smith       PetscCall(MatSetOption(P, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
2013f1580f4eSBarry Smith       if (ismatis) {
2014f1580f4eSBarry Smith         /* needed by HPDDM (currently) so that the partition of unity is 0 on subdomain interfaces */
2015f1580f4eSBarry Smith         PetscCall(MatIncreaseOverlap(P, 1, is, 1));
2016f1580f4eSBarry Smith         PetscCall(ISDestroy(&data->is));
2017f1580f4eSBarry Smith         data->is = is[0];
2018f1580f4eSBarry Smith       } else {
2019*d16c0b94SPierre Jolivet         if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_TRUE));
20209bb5c669SPierre Jolivet         if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", PCHPDDMAlgebraicAuxiliaryMat_Private));
20219bb5c669SPierre Jolivet         if (!PetscBool3ToBool(data->Neumann) && (!algebraic || overlap != -1)) {
2022f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
2023f1580f4eSBarry Smith           if (flg) {
2024f1580f4eSBarry Smith             /* maybe better to ISSort(is[0]), MatCreateSubMatrices(), and then MatPermute() */
2025f1580f4eSBarry Smith             /* but there is no MatPermute_SeqSBAIJ(), so as before, just use MATMPIBAIJ     */
2026f1580f4eSBarry Smith             PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &uaux));
2027f1580f4eSBarry Smith             flg = PETSC_FALSE;
2028f1580f4eSBarry Smith           }
2029f1580f4eSBarry Smith         }
2030f1580f4eSBarry Smith       }
20319bb5c669SPierre Jolivet       if (algebraic && overlap == -1) {
2032f1580f4eSBarry Smith         PetscUseMethod(pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", (Mat, IS *, Mat *[], PetscBool), (P, is, &sub, block));
2033f1580f4eSBarry Smith         if (block) {
2034f1580f4eSBarry Smith           PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", (PetscObject *)&data->aux));
2035db4a47b3SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", nullptr));
2036f1580f4eSBarry Smith         }
20379bb5c669SPierre Jolivet       } else if (!uaux || overlap != -1) {
203813044ca3SPierre Jolivet         if (!ctx) {
2039c8ea6600SPierre Jolivet           if (PetscBool3ToBool(data->Neumann)) sub = &data->aux;
20409bb5c669SPierre Jolivet           else {
2041df21ef68SPierre Jolivet             PetscBool flg;
20429bb5c669SPierre Jolivet             if (overlap != -1) {
20439bb5c669SPierre Jolivet               Harmonic              h;
20449bb5c669SPierre Jolivet               Mat                   A0, *a;                           /* with an SVD: [ A_00  A_01       ] */
20459bb5c669SPierre Jolivet               IS                    ov[2], rows, cols, stride;        /*              [ A_10  A_11  A_12 ] */
20469bb5c669SPierre Jolivet               const PetscInt       *i[2], bs = PetscAbs(P->cmap->bs); /* with a GEVP: [ A_00  A_01       ] */
20479bb5c669SPierre Jolivet               PetscInt              n[2];                             /*              [ A_10  A_11  A_12 ] */
20489bb5c669SPierre Jolivet               std::vector<PetscInt> v[2];                             /*              [       A_21  A_22 ] */
20499bb5c669SPierre Jolivet 
20509bb5c669SPierre Jolivet               PetscCall(ISDuplicate(data->is, ov));
20519bb5c669SPierre Jolivet               if (overlap > 1) PetscCall(MatIncreaseOverlap(P, 1, ov, overlap - 1));
20529bb5c669SPierre Jolivet               PetscCall(ISDuplicate(ov[0], ov + 1));
20539bb5c669SPierre Jolivet               PetscCall(MatIncreaseOverlap(P, 1, ov + 1, 1));
20549bb5c669SPierre Jolivet               PetscCall(PetscNew(&h));
20559bb5c669SPierre Jolivet               h->ksp = nullptr;
20569bb5c669SPierre Jolivet               PetscCall(PetscCalloc1(2, &h->A));
20573a60673dSPierre Jolivet               PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_nsv", &flg));
20589bb5c669SPierre Jolivet               if (!flg) PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_relative_threshold", &flg));
20599bb5c669SPierre Jolivet               PetscCall(ISSort(ov[0]));
20609bb5c669SPierre Jolivet               if (!flg) PetscCall(ISSort(ov[1]));
20619bb5c669SPierre Jolivet               PetscCall(PetscMalloc1(!flg ? 5 : 3, &h->is));
20629bb5c669SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, ov + !flg, ov + 1, MAT_INITIAL_MATRIX, &a)); /* submatrix from above, either square (!flg) or rectangular (flg) */
20639bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) {
20649bb5c669SPierre Jolivet                 PetscCall(ISGetIndices(ov[j], i + j));
20659bb5c669SPierre Jolivet                 PetscCall(ISGetLocalSize(ov[j], n + j));
20669bb5c669SPierre Jolivet               }
20679bb5c669SPierre Jolivet               v[1].reserve((n[1] - n[0]) / bs);
20689bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[1]; j += bs) { /* indices of the (2,2) block */
20699bb5c669SPierre Jolivet                 PetscInt location;
20709bb5c669SPierre Jolivet                 PetscCall(ISLocate(ov[0], i[1][j], &location));
20719bb5c669SPierre Jolivet                 if (location < 0) v[1].emplace_back(j / bs);
20729bb5c669SPierre Jolivet               }
20739bb5c669SPierre Jolivet               if (!flg) {
20749bb5c669SPierre Jolivet                 h->A[1] = a[0];
20759bb5c669SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)h->A[1]));
20769bb5c669SPierre Jolivet                 v[0].reserve((n[0] - P->rmap->n) / bs);
20779bb5c669SPierre Jolivet                 for (PetscInt j = 0; j < n[1]; j += bs) { /* row indices of the (1,2) block */
20789bb5c669SPierre Jolivet                   PetscInt location;
20799bb5c669SPierre Jolivet                   PetscCall(ISLocate(loc, i[1][j], &location));
20809bb5c669SPierre Jolivet                   if (location < 0) {
20819bb5c669SPierre Jolivet                     PetscCall(ISLocate(ov[0], i[1][j], &location));
20829bb5c669SPierre Jolivet                     if (location >= 0) v[0].emplace_back(j / bs);
20839bb5c669SPierre Jolivet                   }
20849bb5c669SPierre Jolivet                 }
20859bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
20869bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_COPY_VALUES, h->is + 4));
20879bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, h->is[4], MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
20889bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
20899bb5c669SPierre 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 */
20909bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &rows));
20919bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols = rows, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
20929bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
20939bb5c669SPierre Jolivet                 v[0].clear();
20949bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, ov[1], PETSC_TRUE, h->is + 3));
20959bb5c669SPierre Jolivet                 PetscCall(ISEmbed(data->is, ov[1], PETSC_TRUE, h->is + 2));
20969bb5c669SPierre Jolivet               }
20979bb5c669SPierre Jolivet               v[0].reserve((n[0] - P->rmap->n) / bs);
20989bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[0]; j += bs) {
20999bb5c669SPierre Jolivet                 PetscInt location;
21009bb5c669SPierre Jolivet                 PetscCall(ISLocate(loc, i[0][j], &location));
21019bb5c669SPierre Jolivet                 if (location < 0) v[0].emplace_back(j / bs);
21029bb5c669SPierre Jolivet               }
21039bb5c669SPierre Jolivet               PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
21049bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISRestoreIndices(ov[j], i + j));
21059bb5c669SPierre Jolivet               if (flg) {
21069bb5c669SPierre Jolivet                 IS is;
21079bb5c669SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, a[0]->rmap->n, 0, 1, &is));
21089bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &cols));
21099bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], is, cols, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
21109bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
21119bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&is));
21129bb5c669SPierre 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 */
21139bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, data->is, PETSC_TRUE, h->is + 2));
21149bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_USE_POINTER, &cols));
21159bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols, MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
21169bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
21179bb5c669SPierre Jolivet               }
21189bb5c669SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, A0->rmap->n, 0, 1, &stride));
21199bb5c669SPierre Jolivet               PetscCall(ISEmbed(rows, stride, PETSC_TRUE, h->is));
21209bb5c669SPierre Jolivet               PetscCall(ISDestroy(&stride));
21219bb5c669SPierre Jolivet               PetscCall(ISDestroy(&rows));
21229bb5c669SPierre Jolivet               PetscCall(ISEmbed(loc, ov[0], PETSC_TRUE, h->is + 1));
21239bb5c669SPierre Jolivet               if (subdomains) {
21249bb5c669SPierre Jolivet                 if (!data->levels[0]->pc) {
21259bb5c669SPierre Jolivet                   PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
21269bb5c669SPierre Jolivet                   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
21279bb5c669SPierre Jolivet                   PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
21289bb5c669SPierre Jolivet                   PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
21299bb5c669SPierre Jolivet                 }
21309bb5c669SPierre Jolivet                 PetscCall(PCSetType(data->levels[0]->pc, PCASM));
21319bb5c669SPierre Jolivet                 if (!data->levels[0]->pc->setupcalled) PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, ov + !flg, &loc));
21329bb5c669SPierre Jolivet                 PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, flg ? A0 : a[0], PETSC_TRUE));
21339bb5c669SPierre Jolivet                 if (!flg) ++overlap;
21349bb5c669SPierre Jolivet                 if (data->share) {
21359bb5c669SPierre Jolivet                   PetscInt n = -1;
21369bb5c669SPierre Jolivet                   PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
21379bb5c669SPierre Jolivet                   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
21389bb5c669SPierre Jolivet                   if (flg) {
21399bb5c669SPierre Jolivet                     h->ksp = ksp[0];
21409bb5c669SPierre Jolivet                     PetscCall(PetscObjectReference((PetscObject)h->ksp));
21419bb5c669SPierre Jolivet                   }
21429bb5c669SPierre Jolivet                 }
21439bb5c669SPierre Jolivet               }
21449bb5c669SPierre Jolivet               if (!h->ksp) {
21459bb5c669SPierre Jolivet                 PetscBool share = data->share;
21469bb5c669SPierre Jolivet                 PetscCall(KSPCreate(PETSC_COMM_SELF, &h->ksp));
21479bb5c669SPierre Jolivet                 PetscCall(KSPSetType(h->ksp, KSPPREONLY));
21489bb5c669SPierre Jolivet                 PetscCall(KSPSetOperators(h->ksp, A0, A0));
21499bb5c669SPierre Jolivet                 do {
21509bb5c669SPierre Jolivet                   if (!data->share) {
21519bb5c669SPierre Jolivet                     share = PETSC_FALSE;
21529bb5c669SPierre Jolivet                     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_%s", pcpre ? pcpre : "", flg ? "svd_" : "eps_"));
21539bb5c669SPierre Jolivet                     PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
21549bb5c669SPierre Jolivet                     PetscCall(KSPSetFromOptions(h->ksp));
21559bb5c669SPierre Jolivet                   } else {
21569bb5c669SPierre Jolivet                     MatSolverType type;
21579bb5c669SPierre Jolivet                     PetscCall(KSPGetPC(ksp[0], &pc));
21589bb5c669SPierre Jolivet                     PetscCall(PetscObjectTypeCompareAny((PetscObject)pc, &data->share, PCLU, PCCHOLESKY, ""));
21599bb5c669SPierre Jolivet                     if (data->share) {
21609bb5c669SPierre Jolivet                       PetscCall(PCFactorGetMatSolverType(pc, &type));
21619bb5c669SPierre Jolivet                       if (!type) {
21629bb5c669SPierre Jolivet                         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMUMPS));
21639bb5c669SPierre Jolivet                         else if (PetscDefined(HAVE_MKL_PARDISO)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMKL_PARDISO));
21649bb5c669SPierre Jolivet                         else data->share = PETSC_FALSE;
21659bb5c669SPierre Jolivet                         if (data->share) PetscCall(PCSetFromOptions(pc));
21669bb5c669SPierre Jolivet                       } else {
21679bb5c669SPierre Jolivet                         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &data->share));
21689bb5c669SPierre Jolivet                         if (!data->share) PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &data->share));
21699bb5c669SPierre Jolivet                       }
21709bb5c669SPierre Jolivet                       if (data->share) {
21719bb5c669SPierre Jolivet                         std::tuple<KSP, IS, Vec[2]> *p;
21729bb5c669SPierre Jolivet                         PetscCall(PCFactorGetMatrix(pc, &A));
21739bb5c669SPierre Jolivet                         PetscCall(MatFactorSetSchurIS(A, h->is[4]));
21749bb5c669SPierre Jolivet                         PetscCall(KSPSetUp(ksp[0]));
21759bb5c669SPierre Jolivet                         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_eps_shell_", pcpre ? pcpre : ""));
21769bb5c669SPierre Jolivet                         PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
21779bb5c669SPierre Jolivet                         PetscCall(KSPSetFromOptions(h->ksp));
21789bb5c669SPierre Jolivet                         PetscCall(KSPGetPC(h->ksp, &pc));
21799bb5c669SPierre Jolivet                         PetscCall(PCSetType(pc, PCSHELL));
21809bb5c669SPierre Jolivet                         PetscCall(PetscNew(&p));
21819bb5c669SPierre Jolivet                         std::get<0>(*p) = ksp[0];
21829bb5c669SPierre Jolivet                         PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &std::get<1>(*p)));
21839bb5c669SPierre Jolivet                         PetscCall(MatCreateVecs(A, std::get<2>(*p), std::get<2>(*p) + 1));
21849bb5c669SPierre Jolivet                         PetscCall(PCShellSetContext(pc, p));
21859bb5c669SPierre Jolivet                         PetscCall(PCShellSetApply(pc, PCApply_Schur));
21869bb5c669SPierre Jolivet                         PetscCall(PCShellSetApplyTranspose(pc, PCApply_Schur<Vec, true>));
21879bb5c669SPierre Jolivet                         PetscCall(PCShellSetMatApply(pc, PCApply_Schur<Mat>));
21889bb5c669SPierre Jolivet                         PetscCall(PCShellSetDestroy(pc, PCDestroy_Schur));
21899bb5c669SPierre Jolivet                       }
21909bb5c669SPierre Jolivet                     }
21919bb5c669SPierre Jolivet                     if (!data->share) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since neither MUMPS nor MKL PARDISO is used\n"));
21929bb5c669SPierre Jolivet                   }
21939bb5c669SPierre 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 */
21949bb5c669SPierre Jolivet               }
21959bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov));
21969bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov + 1));
21979bb5c669SPierre Jolivet               if (overlap == 1 && subdomains && flg) {
21989bb5c669SPierre Jolivet                 *subA = A0;
21999bb5c669SPierre Jolivet                 sub   = subA;
22009bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatDestroy(&uaux));
22019bb5c669SPierre Jolivet               } else PetscCall(MatDestroy(&A0));
22029bb5c669SPierre Jolivet               PetscCall(MatCreateShell(PETSC_COMM_SELF, P->rmap->n, n[1] - n[0], P->rmap->n, n[1] - n[0], h, &data->aux));
22039bb5c669SPierre Jolivet               PetscCall(MatCreateVecs(h->ksp->pc->pmat, &h->v, nullptr));
22049bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT, (void (*)(void))MatMult_Harmonic));
22059bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMultTranspose_Harmonic));
22069bb5c669SPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AB, nullptr, MatProduct_AB_Harmonic, nullptr, MATDENSE, MATDENSE));
22079bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_DESTROY, (void (*)(void))MatDestroy_Harmonic));
22089bb5c669SPierre Jolivet               PetscCall(MatDestroySubMatrices(1, &a));
22099bb5c669SPierre Jolivet             }
2210df21ef68SPierre Jolivet             if (overlap != 1 || !subdomains) {
2211df21ef68SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2212df21ef68SPierre Jolivet               if (ismatis) {
2213df21ef68SPierre Jolivet                 PetscCall(MatISGetLocalMat(C, &N));
2214df21ef68SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)N, MATSEQSBAIJ, &flg));
2215df21ef68SPierre Jolivet                 if (flg) PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2216df21ef68SPierre Jolivet                 PetscCall(MatISRestoreLocalMat(C, &N));
2217df21ef68SPierre Jolivet               }
2218df21ef68SPierre Jolivet             }
22199bb5c669SPierre Jolivet             if (uaux) {
22209bb5c669SPierre Jolivet               PetscCall(MatDestroy(&uaux));
22219bb5c669SPierre Jolivet               PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
22229bb5c669SPierre Jolivet             }
22239bb5c669SPierre Jolivet           }
222413044ca3SPierre Jolivet         }
2225f1580f4eSBarry Smith       } else {
2226f1580f4eSBarry Smith         PetscCall(MatCreateSubMatrices(uaux, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2227f1580f4eSBarry Smith         PetscCall(MatDestroy(&uaux));
2228f1580f4eSBarry Smith         PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2229f1580f4eSBarry Smith       }
2230f1580f4eSBarry Smith       /* Vec holding the partition of unity */
2231f1580f4eSBarry Smith       if (!data->levels[0]->D) {
2232f1580f4eSBarry Smith         PetscCall(ISGetLocalSize(data->is, &n));
2233f1580f4eSBarry Smith         PetscCall(VecCreateMPI(PETSC_COMM_SELF, n, PETSC_DETERMINE, &data->levels[0]->D));
2234f1580f4eSBarry Smith       }
22359bb5c669SPierre Jolivet       if (data->share && overlap == -1) {
2236f1580f4eSBarry Smith         Mat      D;
2237db4a47b3SPierre Jolivet         IS       perm = nullptr;
2238f1580f4eSBarry Smith         PetscInt size = -1;
2239398c7888SPierre Jolivet         if (!data->levels[0]->pc) {
2240398c7888SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2241398c7888SPierre Jolivet           PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
2242398c7888SPierre Jolivet           PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
2243398c7888SPierre Jolivet           PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
2244398c7888SPierre Jolivet         }
2245398c7888SPierre Jolivet         PetscCall(PCSetType(data->levels[0]->pc, PCASM));
224613044ca3SPierre Jolivet         if (!ctx) {
2247398c7888SPierre Jolivet           if (!data->levels[0]->pc->setupcalled) {
2248398c7888SPierre Jolivet             IS sorted; /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2249398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2250398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &sorted, &loc));
2251398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2252398c7888SPierre Jolivet           }
2253398c7888SPierre Jolivet           PetscCall(PCSetFromOptions(data->levels[0]->pc));
2254398c7888SPierre Jolivet           if (block) {
2255398c7888SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, sub[0], &C, &perm));
2256398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, C, algebraic));
2257398c7888SPierre Jolivet           } else PetscCall(PCSetUp(data->levels[0]->pc));
2258db4a47b3SPierre Jolivet           PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &size, nullptr, &ksp));
2259398c7888SPierre Jolivet           if (size != 1) {
2260398c7888SPierre Jolivet             data->share = PETSC_FALSE;
2261398c7888SPierre Jolivet             PetscCheck(size == -1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", size);
2262398c7888SPierre Jolivet             PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since PCASMGetSubKSP() not found in fine-level PC\n"));
2263398c7888SPierre Jolivet             PetscCall(ISDestroy(&unsorted));
2264398c7888SPierre Jolivet             unsorted = is[0];
2265398c7888SPierre Jolivet           } else {
226613044ca3SPierre Jolivet             if (!block && !ctx) PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, PetscBool3ToBool(data->Neumann) ? sub[0] : data->aux, &C, &perm));
2267c8ea6600SPierre Jolivet             if (!PetscBool3ToBool(data->Neumann) && !block) {
2268f1580f4eSBarry Smith               PetscCall(MatPermute(sub[0], perm, perm, &D)); /* permute since PCASM will call ISSort() */
2269f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(sub[0], &D));
2270f1580f4eSBarry Smith             }
2271f1580f4eSBarry Smith             if (data->B) { /* see PCHPDDMSetRHSMat() */
2272f1580f4eSBarry Smith               PetscCall(MatPermute(data->B, perm, perm, &D));
2273f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(data->B, &D));
2274f1580f4eSBarry Smith             }
2275f1580f4eSBarry Smith             PetscCall(ISDestroy(&perm));
2276f1580f4eSBarry Smith             const char *matpre;
2277f1580f4eSBarry Smith             PetscBool   cmp[4];
2278f1580f4eSBarry Smith             PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
22790307214fSPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)subA[0]));
2280f1580f4eSBarry Smith             PetscCall(MatDuplicate(subA[1], MAT_SHARE_NONZERO_PATTERN, &D));
2281f1580f4eSBarry Smith             PetscCall(MatGetOptionsPrefix(subA[1], &matpre));
2282f1580f4eSBarry Smith             PetscCall(MatSetOptionsPrefix(D, matpre));
2283f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMAL, cmp));
2284f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMAL, cmp + 1));
2285f1580f4eSBarry Smith             if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMALHERMITIAN, cmp + 2));
2286f1580f4eSBarry Smith             else cmp[2] = PETSC_FALSE;
2287f1580f4eSBarry Smith             if (!cmp[1]) PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMALHERMITIAN, cmp + 3));
2288f1580f4eSBarry Smith             else cmp[3] = PETSC_FALSE;
2289f1580f4eSBarry 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);
2290f1580f4eSBarry Smith             if (!cmp[0] && !cmp[2]) {
2291f1580f4eSBarry Smith               if (!block) PetscCall(MatAXPY(D, 1.0, C, SUBSET_NONZERO_PATTERN));
22925c7345deSPierre Jolivet               else {
2293db4a47b3SPierre Jolivet                 PetscCall(MatMissingDiagonal(D, cmp, nullptr));
22945c7345deSPierre Jolivet                 if (cmp[0]) structure = DIFFERENT_NONZERO_PATTERN; /* data->aux has no missing diagonal entry */
22955c7345deSPierre Jolivet                 PetscCall(MatAXPY(D, 1.0, data->aux, structure));
22965c7345deSPierre Jolivet               }
2297f1580f4eSBarry Smith             } else {
2298f1580f4eSBarry Smith               Mat mat[2];
2299f1580f4eSBarry Smith               if (cmp[0]) {
2300f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(D, mat));
2301f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(C, mat + 1));
2302f1580f4eSBarry Smith               } else {
2303f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(D, mat));
2304f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(C, mat + 1));
2305f1580f4eSBarry Smith               }
2306f1580f4eSBarry Smith               PetscCall(MatAXPY(mat[0], 1.0, mat[1], SUBSET_NONZERO_PATTERN));
2307f1580f4eSBarry Smith             }
2308f1580f4eSBarry Smith             PetscCall(MatPropagateSymmetryOptions(C, D));
2309f1580f4eSBarry Smith             PetscCall(MatDestroy(&C));
2310f1580f4eSBarry Smith             C = D;
2311f1580f4eSBarry Smith             /* swap pointers so that variables stay consistent throughout PCSetUp() */
2312f1580f4eSBarry Smith             std::swap(C, data->aux);
2313f1580f4eSBarry Smith             std::swap(uis, data->is);
2314f1580f4eSBarry Smith             swap = PETSC_TRUE;
2315f1580f4eSBarry Smith           }
2316f1580f4eSBarry Smith         }
231713044ca3SPierre Jolivet       }
231813044ca3SPierre Jolivet       if (ctx) {
231913044ca3SPierre Jolivet         PC_HPDDM              *data_00 = (PC_HPDDM *)std::get<0>(*ctx)[0]->data;
232013044ca3SPierre Jolivet         PC                     s;
232100b491fbSPierre Jolivet         Mat                    A00, P00, A01 = nullptr, A10, A11, N, b[4];
232207d8d47fSPierre Jolivet         IS                     sorted, is[2], *is_00;
232313044ca3SPierre Jolivet         MatSolverType          type;
232413044ca3SPierre Jolivet         std::pair<PC, Vec[2]> *p;
232513044ca3SPierre Jolivet 
232607d8d47fSPierre Jolivet         n = -1;
232707d8d47fSPierre Jolivet         PetscTryMethod(data_00->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data_00->levels[0]->pc, &n, nullptr, &ksp));
232807d8d47fSPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
232907d8d47fSPierre Jolivet         PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
233007d8d47fSPierre Jolivet         PetscCall(ISGetLocalSize(data_00->is, &n));
233107d8d47fSPierre Jolivet         if (n != subA[0]->rmap->n || n != subA[0]->cmap->n) {
233207d8d47fSPierre Jolivet           PetscCall(PCASMGetLocalSubdomains(data_00->levels[0]->pc, &n, &is_00, nullptr));
233307d8d47fSPierre Jolivet           PetscCall(ISGetLocalSize(*is_00, &n));
233407d8d47fSPierre 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);
233507d8d47fSPierre Jolivet         } else is_00 = &data_00->is;
233613044ca3SPierre Jolivet         PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, data->aux, &C, nullptr)); /* permute since PCASM works with a sorted IS */
233713044ca3SPierre Jolivet         std::swap(C, data->aux);
233813044ca3SPierre Jolivet         std::swap(uis, data->is);
233913044ca3SPierre Jolivet         swap = PETSC_TRUE;
234013044ca3SPierre Jolivet         PetscCall(PCASMSetType(data->levels[0]->pc, PC_ASM_NONE)); /* "Neumann--Neumann" preconditioning with overlap and a Boolean partition of unity */
234113044ca3SPierre Jolivet         PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &data->is, &loc));
234213044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(data->levels[0]->pc)); /* action of eq. (15) of https://hal.science/hal-02343808v6/document (with a sign flip) */
234313044ca3SPierre Jolivet         PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, std::get<1>(*ctx), &A10, &A11));
234413044ca3SPierre Jolivet         std::get<1>(*ctx)[1] = A10;
234513044ca3SPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
234613044ca3SPierre Jolivet         if (flg) PetscCall(MatTransposeGetMat(A10, &A01));
234713044ca3SPierre Jolivet         else {
234813044ca3SPierre Jolivet           PetscBool flg;
234913044ca3SPierre Jolivet 
235013044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
235113044ca3SPierre Jolivet           if (flg) PetscCall(MatHermitianTransposeGetMat(A10, &A01));
235213044ca3SPierre Jolivet         }
235307d8d47fSPierre 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 */
235413044ca3SPierre Jolivet         PetscCall(ISSort(sorted));               /* this is to avoid changing users inputs, but it requires a new call to ISSort() here                                                                                               */
235500b491fbSPierre Jolivet         if (!A01) {
235600b491fbSPierre Jolivet           PetscCall(MatSetOption(A10, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
235700b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A10, 1, &data->is, &sorted, MAT_INITIAL_MATRIX, &sub));
235800b491fbSPierre Jolivet           b[2] = sub[0];
235900b491fbSPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
236000b491fbSPierre Jolivet           PetscCall(MatDestroySubMatrices(1, &sub));
236100b491fbSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATTRANSPOSEVIRTUAL, &flg));
236200b491fbSPierre Jolivet           A10 = nullptr;
236300b491fbSPierre Jolivet           if (flg) PetscCall(MatTransposeGetMat(std::get<1>(*ctx)[0], &A10));
236413044ca3SPierre Jolivet           else {
236500b491fbSPierre Jolivet             PetscBool flg;
236600b491fbSPierre Jolivet 
236700b491fbSPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)(PetscObject)std::get<1>(*ctx)[0], MATHERMITIANTRANSPOSEVIRTUAL, &flg));
236800b491fbSPierre Jolivet             if (flg) PetscCall(MatHermitianTransposeGetMat(std::get<1>(*ctx)[0], &A10));
236913044ca3SPierre Jolivet           }
237000b491fbSPierre Jolivet           if (!A10) {
237100b491fbSPierre Jolivet             PetscCall(MatCreateSubMatrices(std::get<1>(*ctx)[0], 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
237200b491fbSPierre Jolivet             b[1] = sub[0];
237300b491fbSPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)sub[0]));
237400b491fbSPierre Jolivet           }
237500b491fbSPierre Jolivet         } else {
237600b491fbSPierre Jolivet           PetscCall(MatSetOption(A01, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
237700b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A01, 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
237800b491fbSPierre Jolivet           if (flg) PetscCall(MatTranspose(*sub, MAT_INITIAL_MATRIX, b + 2));
237900b491fbSPierre Jolivet           else PetscCall(MatHermitianTranspose(*sub, MAT_INITIAL_MATRIX, b + 2));
238000b491fbSPierre Jolivet         }
238100b491fbSPierre Jolivet         PetscCall(MatDestroySubMatrices(1, &sub));
238213044ca3SPierre Jolivet         PetscCall(ISDestroy(&sorted));
238300b491fbSPierre Jolivet         if (A01 || A10) {
238400b491fbSPierre Jolivet           if (flg) PetscCall(MatTranspose(b[2], MAT_INITIAL_MATRIX, b + 1));
238500b491fbSPierre Jolivet           else PetscCall(MatHermitianTranspose(b[2], MAT_INITIAL_MATRIX, b + 1));
238600b491fbSPierre Jolivet         }
238700b491fbSPierre Jolivet         PetscCall(MatCreateSchurComplement(subA[0], subA[1], b[1], b[2], data->aux, &S));
238813044ca3SPierre Jolivet         PetscCall(MatSchurComplementSetKSP(S, ksp[0]));
238913044ca3SPierre 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 */
239013044ca3SPierre Jolivet         PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
239113044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
239213044ca3SPierre Jolivet         PetscCall(KSPGetPC(ksp[0], &inner));
239313044ca3SPierre Jolivet         PetscCall(PCSetType(inner, PCSHELL)); /* compute the action of the inverse of the local Schur complement with a PCSHELL */
239413044ca3SPierre Jolivet         b[0] = subA[0];
239513044ca3SPierre Jolivet         b[3] = data->aux;
239613044ca3SPierre 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 */
239700b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[1]));
239800b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[2]));
239913044ca3SPierre Jolivet         PetscCall(PCCreate(PETSC_COMM_SELF, &s));
240013044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(s, ((PetscObject)inner)->prefix));
240113044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(inner, nullptr));
240213044ca3SPierre Jolivet         PetscCall(KSPSetSkipPCSetFromOptions(ksp[0], PETSC_TRUE));
240313044ca3SPierre Jolivet         PetscCall(PCSetType(s, PCLU));
240413044ca3SPierre Jolivet         if (PetscDefined(HAVE_MUMPS)) { /* only MATSOLVERMUMPS handles MATNEST, so for the others, e.g., MATSOLVERPETSC or MATSOLVERMKL_PARDISO, convert to plain MATAIJ */
240513044ca3SPierre Jolivet           PetscCall(PCFactorSetMatSolverType(s, MATSOLVERMUMPS));
240613044ca3SPierre Jolivet         }
240713044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(s));
240813044ca3SPierre Jolivet         PetscCall(PCFactorGetMatSolverType(s, &type));
240913044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
241013044ca3SPierre Jolivet         if (flg) {
241113044ca3SPierre Jolivet           PetscCall(PCSetOperators(s, N, N));
241200b491fbSPierre Jolivet           PetscCall(PCFactorGetMatrix(s, b));
241300b491fbSPierre Jolivet           PetscCall(MatSetOptionsPrefix(*b, ((PetscObject)s)->prefix));
241424ddd604SPierre Jolivet           n = -1;
241524ddd604SPierre Jolivet           PetscCall(PetscOptionsGetInt(nullptr, ((PetscObject)s)->prefix, "-mat_mumps_icntl_26", &n, nullptr));
2416f45b553cSPierre Jolivet           if (n == 1) {                                /* allocates a square MatDense of size is[1]->map->n, so one */
2417f45b553cSPierre Jolivet             PetscCall(MatNestGetISs(N, is, nullptr));  /*  needs to be able to deactivate this path when dealing    */
2418f45b553cSPierre Jolivet             PetscCall(MatFactorSetSchurIS(*b, is[1])); /*  with a large constraint space in order to avoid OOM      */
2419f45b553cSPierre Jolivet           }
242013044ca3SPierre Jolivet         } else {
242100b491fbSPierre Jolivet           PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, b));
242200b491fbSPierre Jolivet           PetscCall(PCSetOperators(s, N, *b));
242300b491fbSPierre Jolivet           PetscCall(PetscObjectDereference((PetscObject)*b));
242400b491fbSPierre 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 */
242513044ca3SPierre Jolivet         }
242613044ca3SPierre Jolivet         PetscCall(PetscNew(&p));
242713044ca3SPierre Jolivet         p->first = s;
242800b491fbSPierre Jolivet         PetscCall(MatCreateVecs(*b, p->second, p->second + 1));
242913044ca3SPierre Jolivet         PetscCall(PCShellSetContext(inner, p));
243013044ca3SPierre Jolivet         PetscCall(PCShellSetApply(inner, PCApply_Nest));
243113044ca3SPierre Jolivet         PetscCall(PCShellSetView(inner, PCView_Nest));
243213044ca3SPierre Jolivet         PetscCall(PCShellSetDestroy(inner, PCDestroy_Nest));
243313044ca3SPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)N));
243413044ca3SPierre Jolivet       }
2435f1580f4eSBarry Smith       if (!data->levels[0]->scatter) {
2436db4a47b3SPierre Jolivet         PetscCall(MatCreateVecs(P, &xin, nullptr));
2437f1580f4eSBarry Smith         if (ismatis) PetscCall(MatDestroy(&P));
2438db4a47b3SPierre Jolivet         PetscCall(VecScatterCreate(xin, data->is, data->levels[0]->D, nullptr, &data->levels[0]->scatter));
2439f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
2440f1580f4eSBarry Smith       }
2441f1580f4eSBarry Smith       if (data->levels[0]->P) {
2442f1580f4eSBarry Smith         /* if the pattern is the same and PCSetUp() has previously succeeded, reuse HPDDM buffers and connectivity */
2443f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[0], pc->setupcalled < 1 || pc->flag == DIFFERENT_NONZERO_PATTERN ? PETSC_TRUE : PETSC_FALSE));
2444f1580f4eSBarry Smith       }
2445f1580f4eSBarry Smith       if (!data->levels[0]->P) data->levels[0]->P = new HPDDM::Schwarz<PetscScalar>();
2446db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2447db4a47b3SPierre Jolivet       else PetscCall(PetscLogEventBegin(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2448f1580f4eSBarry Smith       /* HPDDM internal data structure */
244913044ca3SPierre Jolivet       PetscCall(data->levels[0]->P->structure(loc, data->is, !ctx ? sub[0] : nullptr, ismatis ? C : data->aux, data->levels));
2450db4a47b3SPierre Jolivet       if (!data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2451f1580f4eSBarry Smith       /* matrix pencil of the generalized eigenvalue problem on the overlap (GenEO) */
245213044ca3SPierre Jolivet       if (!ctx) {
24539bb5c669SPierre Jolivet         if (data->deflation || overlap != -1) weighted = data->aux;
2454f1580f4eSBarry Smith         else if (!data->B) {
2455e2b46ddfSPierre Jolivet           PetscBool cmp;
2456f1580f4eSBarry Smith           PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &weighted));
2457e2b46ddfSPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)weighted, &cmp, MATNORMAL, MATNORMALHERMITIAN, ""));
2458e2b46ddfSPierre Jolivet           if (cmp) flg = PETSC_FALSE;
2459e2b46ddfSPierre Jolivet           PetscCall(MatDiagonalScale(weighted, data->levels[0]->D, data->levels[0]->D));
24605b0bb9f2SPierre Jolivet           /* neither MatDuplicate() nor MatDiagonalScale() handles the symmetry options, so propagate the options explicitly */
2461f1580f4eSBarry Smith           /* only useful for -mat_type baij -pc_hpddm_levels_1_st_pc_type cholesky (no problem with MATAIJ or MATSBAIJ)      */
2462f1580f4eSBarry Smith           PetscCall(MatPropagateSymmetryOptions(sub[0], weighted));
2463f1580f4eSBarry Smith         } else weighted = data->B;
246413044ca3SPierre Jolivet       } else weighted = nullptr;
2465f1580f4eSBarry Smith       /* SLEPc is used inside the loaded symbol */
24669bb5c669SPierre 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));
24679bb5c669SPierre Jolivet       if (!ctx && data->share && overlap == -1) {
2468f1580f4eSBarry Smith         Mat st[2];
2469f1580f4eSBarry Smith         PetscCall(KSPGetOperators(ksp[0], st, st + 1));
24705c7345deSPierre Jolivet         PetscCall(MatCopy(subA[0], st[0], structure));
2471f1580f4eSBarry Smith         if (subA[1] != subA[0] || st[1] != st[0]) PetscCall(MatCopy(subA[1], st[1], SAME_NONZERO_PATTERN));
24720307214fSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)subA[0]));
2473f1580f4eSBarry Smith       }
2474db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2475f1580f4eSBarry Smith       if (ismatis) PetscCall(MatISGetLocalMat(C, &N));
2476f1580f4eSBarry Smith       else N = data->aux;
247713044ca3SPierre Jolivet       if (!ctx) P = sub[0];
247813044ca3SPierre Jolivet       else P = S;
2479f1580f4eSBarry Smith       /* going through the grid hierarchy */
2480f1580f4eSBarry Smith       for (n = 1; n < data->N; ++n) {
2481db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2482f1580f4eSBarry Smith         /* method composed in the loaded symbol since there, SLEPc is used as well */
2483f1580f4eSBarry 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));
2484db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2485f1580f4eSBarry Smith       }
2486f1580f4eSBarry Smith       /* reset to NULL to avoid any faulty use */
2487db4a47b3SPierre Jolivet       PetscCall(PetscObjectComposeFunction((PetscObject)data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", nullptr));
2488db4a47b3SPierre Jolivet       if (!ismatis) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_C", nullptr));
2489f1580f4eSBarry Smith       else PetscCall(PetscObjectDereference((PetscObject)C)); /* matching PetscObjectReference() above */
2490f1580f4eSBarry Smith       for (n = 0; n < data->N - 1; ++n)
2491f1580f4eSBarry Smith         if (data->levels[n]->P) {
2492f1580f4eSBarry Smith           /* HPDDM internal work buffers */
2493f1580f4eSBarry Smith           data->levels[n]->P->setBuffer();
2494f1580f4eSBarry Smith           data->levels[n]->P->super::start();
2495f1580f4eSBarry Smith         }
24969bb5c669SPierre Jolivet       if (ismatis || !subdomains) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
2497db4a47b3SPierre Jolivet       if (ismatis) data->is = nullptr;
2498f1580f4eSBarry Smith       for (n = 0; n < data->N - 1 + (reused > 0); ++n) {
2499f1580f4eSBarry Smith         if (data->levels[n]->P) {
2500f1580f4eSBarry Smith           PC spc;
2501f1580f4eSBarry Smith 
2502f1580f4eSBarry Smith           /* force the PC to be PCSHELL to do the coarse grid corrections */
2503f1580f4eSBarry Smith           PetscCall(KSPSetSkipPCSetFromOptions(data->levels[n]->ksp, PETSC_TRUE));
2504f1580f4eSBarry Smith           PetscCall(KSPGetPC(data->levels[n]->ksp, &spc));
2505f1580f4eSBarry Smith           PetscCall(PCSetType(spc, PCSHELL));
2506f1580f4eSBarry Smith           PetscCall(PCShellSetContext(spc, data->levels[n]));
2507f1580f4eSBarry Smith           PetscCall(PCShellSetSetUp(spc, PCSetUp_HPDDMShell));
2508f1580f4eSBarry Smith           PetscCall(PCShellSetApply(spc, PCApply_HPDDMShell));
2509f1580f4eSBarry Smith           PetscCall(PCShellSetMatApply(spc, PCMatApply_HPDDMShell));
251013044ca3SPierre Jolivet           if (ctx && n == 0) {
251113044ca3SPierre Jolivet             Mat                               Amat, Pmat;
251213044ca3SPierre Jolivet             PetscInt                          m, M;
251301e3c840SPierre Jolivet             std::tuple<Mat, PetscSF, Vec[2]> *ctx;
251413044ca3SPierre Jolivet 
251513044ca3SPierre Jolivet             PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &Pmat));
251613044ca3SPierre Jolivet             PetscCall(MatGetLocalSize(Pmat, &m, nullptr));
251713044ca3SPierre Jolivet             PetscCall(MatGetSize(Pmat, &M, nullptr));
251813044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));
251913044ca3SPierre Jolivet             std::get<0>(*ctx) = S;
252013044ca3SPierre Jolivet             std::get<1>(*ctx) = data->levels[n]->scatter;
252113044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)data->levels[n]->ksp), m, m, M, M, ctx, &Amat));
252213044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT, (void (*)(void))MatMult_Schur<false>));
252313044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMult_Schur<true>));
252413044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_DESTROY, (void (*)(void))MatDestroy_Schur));
252513044ca3SPierre Jolivet             PetscCall(MatCreateVecs(S, std::get<2>(*ctx), std::get<2>(*ctx) + 1));
252613044ca3SPierre Jolivet             PetscCall(KSPSetOperators(data->levels[n]->ksp, Amat, Pmat));
252713044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)Amat));
252813044ca3SPierre Jolivet           }
2529f1580f4eSBarry Smith           PetscCall(PCShellSetDestroy(spc, PCDestroy_HPDDMShell));
2530f1580f4eSBarry Smith           if (!data->levels[n]->pc) PetscCall(PCCreate(PetscObjectComm((PetscObject)data->levels[n]->ksp), &data->levels[n]->pc));
2531f1580f4eSBarry Smith           if (n < reused) {
2532f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(spc, PETSC_TRUE));
2533f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
2534f1580f4eSBarry Smith           }
2535f1580f4eSBarry Smith           PetscCall(PCSetUp(spc));
2536f1580f4eSBarry Smith         }
2537f1580f4eSBarry Smith       }
253813044ca3SPierre Jolivet       if (ctx) PetscCall(MatDestroy(&S));
25399bb5c669SPierre Jolivet       if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", nullptr));
2540f1580f4eSBarry Smith     } else flg = reused ? PETSC_FALSE : PETSC_TRUE;
2541f1580f4eSBarry Smith     if (!ismatis && subdomains) {
2542f1580f4eSBarry Smith       if (flg) PetscCall(KSPGetPC(data->levels[0]->ksp, &inner));
2543f1580f4eSBarry Smith       else inner = data->levels[0]->pc;
2544f1580f4eSBarry Smith       if (inner) {
2545398c7888SPierre Jolivet         if (!inner->setupcalled) PetscCall(PCSetType(inner, PCASM));
2546398c7888SPierre Jolivet         PetscCall(PCSetFromOptions(inner));
2547398c7888SPierre Jolivet         PetscCall(PetscStrcmp(((PetscObject)inner)->type_name, PCASM, &flg));
2548398c7888SPierre Jolivet         if (flg) {
2549f1580f4eSBarry Smith           if (!inner->setupcalled) { /* evaluates to PETSC_FALSE when -pc_hpddm_block_splitting */
2550398c7888SPierre Jolivet             IS sorted;               /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2551398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2552398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(inner, 1, &sorted, &loc));
2553398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2554398c7888SPierre Jolivet           }
2555c8ea6600SPierre Jolivet           if (!PetscBool3ToBool(data->Neumann) && data->N > 1) { /* subdomain matrices are already created for the eigenproblem, reuse them for the fine-level PC */
2556db4a47b3SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(*is, nullptr, nullptr, sub[0], &P, nullptr));
2557398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(inner, P, algebraic));
2558398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)P));
2559f1580f4eSBarry Smith           }
2560f1580f4eSBarry Smith         }
2561f1580f4eSBarry Smith       }
25629bb5c669SPierre Jolivet       if (data->N > 1) {
25639bb5c669SPierre Jolivet         if (overlap != 1) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
25649bb5c669SPierre Jolivet         if (overlap == 1) PetscCall(MatDestroy(subA));
25659bb5c669SPierre Jolivet       }
2566f1580f4eSBarry Smith     }
2567f1580f4eSBarry Smith     PetscCall(ISDestroy(&loc));
2568f1580f4eSBarry Smith   } else data->N = 1 + reused; /* enforce this value to 1 + reused if there is no way to build another level */
2569f1580f4eSBarry Smith   if (requested != data->N + reused) {
2570f1580f4eSBarry 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,
2571f1580f4eSBarry Smith                         data->N, pcpre ? pcpre : ""));
2572f1580f4eSBarry 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));
2573f1580f4eSBarry Smith     /* cannot use PCDestroy_HPDDMShell() because PCSHELL not set for unassembled levels */
2574f1580f4eSBarry Smith     for (n = data->N - 1; n < requested - 1; ++n) {
2575f1580f4eSBarry Smith       if (data->levels[n]->P) {
2576f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[n], PETSC_TRUE));
2577f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(1, &data->levels[n]->v[0]));
2578f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(2, &data->levels[n]->v[1]));
2579f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V));
2580f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 1));
2581f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 2));
2582f1580f4eSBarry Smith         PetscCall(VecDestroy(&data->levels[n]->D));
258301e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&data->levels[n]->scatter));
2584f1580f4eSBarry Smith       }
2585f1580f4eSBarry Smith     }
2586f1580f4eSBarry Smith     if (reused) {
2587f1580f4eSBarry Smith       for (n = reused; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
2588f1580f4eSBarry Smith         PetscCall(KSPDestroy(&data->levels[n]->ksp));
2589f1580f4eSBarry Smith         PetscCall(PCDestroy(&data->levels[n]->pc));
2590f1580f4eSBarry Smith       }
2591f1580f4eSBarry Smith     }
2592f1580f4eSBarry 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,
2593f1580f4eSBarry Smith                data->N, reused, data->N, pcpre ? pcpre : "", pcpre ? pcpre : "", data->N);
2594f1580f4eSBarry Smith   }
2595f1580f4eSBarry Smith   /* these solvers are created after PCSetFromOptions() is called */
2596f1580f4eSBarry Smith   if (pc->setfromoptionscalled) {
2597f1580f4eSBarry Smith     for (n = 0; n < data->N; ++n) {
2598f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetFromOptions(data->levels[n]->ksp));
2599f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetFromOptions(data->levels[n]->pc));
2600f1580f4eSBarry Smith     }
2601f1580f4eSBarry Smith     pc->setfromoptionscalled = 0;
2602f1580f4eSBarry Smith   }
2603f1580f4eSBarry Smith   data->N += reused;
2604f1580f4eSBarry Smith   if (data->share && swap) {
2605f1580f4eSBarry Smith     /* swap back pointers so that variables follow the user-provided numbering */
2606f1580f4eSBarry Smith     std::swap(C, data->aux);
2607f1580f4eSBarry Smith     std::swap(uis, data->is);
2608f1580f4eSBarry Smith     PetscCall(MatDestroy(&C));
2609f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
2610f1580f4eSBarry Smith   }
2611398c7888SPierre Jolivet   if (algebraic) PetscCall(MatDestroy(&data->aux));
261238fb34a1SPierre Jolivet   if (unsorted && unsorted != is[0]) {
2613398c7888SPierre Jolivet     PetscCall(ISCopy(unsorted, data->is));
2614398c7888SPierre Jolivet     PetscCall(ISDestroy(&unsorted));
2615398c7888SPierre Jolivet   }
2616398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2617398c7888SPierre 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);
2618398c7888SPierre Jolivet   if (data->is) {
2619398c7888SPierre Jolivet     PetscCall(ISEqualUnsorted(data->is, dis, &flg));
2620398c7888SPierre Jolivet     PetscCall(ISDestroy(&dis));
2621398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input IS and output IS are not equal");
2622398c7888SPierre Jolivet   }
2623398c7888SPierre 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);
2624398c7888SPierre Jolivet   if (data->aux) {
2625398c7888SPierre Jolivet     PetscCall(MatMultEqual(data->aux, daux, 20, &flg));
2626398c7888SPierre Jolivet     PetscCall(MatDestroy(&daux));
2627398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input Mat and output Mat are not equal");
2628398c7888SPierre Jolivet   }
2629398c7888SPierre Jolivet #endif
26303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2631f1580f4eSBarry Smith }
2632f1580f4eSBarry Smith 
2633f1580f4eSBarry Smith /*@
2634f1580f4eSBarry Smith   PCHPDDMSetCoarseCorrectionType - Sets the coarse correction type.
2635f1580f4eSBarry Smith 
2636c3339decSBarry Smith   Collective
2637f1580f4eSBarry Smith 
2638f1580f4eSBarry Smith   Input Parameters:
2639f1580f4eSBarry Smith + pc   - preconditioner context
2640aa1539e9SPierre Jolivet - type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2641f1580f4eSBarry Smith 
2642f1580f4eSBarry Smith   Options Database Key:
2643aa1539e9SPierre Jolivet . -pc_hpddm_coarse_correction <deflated, additive, balanced, none> - type of coarse correction to apply
2644f1580f4eSBarry Smith 
2645f1580f4eSBarry Smith   Level: intermediate
2646f1580f4eSBarry Smith 
2647562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2648f1580f4eSBarry Smith @*/
2649d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType type)
2650d71ae5a4SJacob Faibussowitsch {
2651f1580f4eSBarry Smith   PetscFunctionBegin;
2652f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2653f1580f4eSBarry Smith   PetscValidLogicalCollectiveEnum(pc, type, 2);
2654f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMSetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType), (pc, type));
26553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2656f1580f4eSBarry Smith }
2657f1580f4eSBarry Smith 
2658f1580f4eSBarry Smith /*@
2659f1580f4eSBarry Smith   PCHPDDMGetCoarseCorrectionType - Gets the coarse correction type.
2660f1580f4eSBarry Smith 
2661f1580f4eSBarry Smith   Input Parameter:
2662f1580f4eSBarry Smith . pc - preconditioner context
2663f1580f4eSBarry Smith 
2664f1580f4eSBarry Smith   Output Parameter:
2665aa1539e9SPierre Jolivet . type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2666f1580f4eSBarry Smith 
2667f1580f4eSBarry Smith   Level: intermediate
2668f1580f4eSBarry Smith 
2669562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2670f1580f4eSBarry Smith @*/
2671d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType *type)
2672d71ae5a4SJacob Faibussowitsch {
2673f1580f4eSBarry Smith   PetscFunctionBegin;
2674f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2675f1580f4eSBarry Smith   if (type) {
26764f572ea9SToby Isaac     PetscAssertPointer(type, 2);
2677f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType *), (pc, type));
2678f1580f4eSBarry Smith   }
26793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2680f1580f4eSBarry Smith }
2681f1580f4eSBarry Smith 
2682d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType type)
2683d71ae5a4SJacob Faibussowitsch {
2684f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2685f1580f4eSBarry Smith 
2686f1580f4eSBarry Smith   PetscFunctionBegin;
2687f1580f4eSBarry Smith   data->correction = type;
26883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2689f1580f4eSBarry Smith }
2690f1580f4eSBarry Smith 
2691d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType *type)
2692d71ae5a4SJacob Faibussowitsch {
2693f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2694f1580f4eSBarry Smith 
2695f1580f4eSBarry Smith   PetscFunctionBegin;
2696f1580f4eSBarry Smith   *type = data->correction;
26973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2698f1580f4eSBarry Smith }
2699f1580f4eSBarry Smith 
2700f1580f4eSBarry Smith /*@
2701e31fc274SPierre Jolivet   PCHPDDMSetSTShareSubKSP - Sets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver should be shared.
2702e31fc274SPierre Jolivet 
2703e31fc274SPierre Jolivet   Input Parameters:
2704e31fc274SPierre Jolivet + pc    - preconditioner context
2705e31fc274SPierre Jolivet - share - whether the `KSP` should be shared or not
2706e31fc274SPierre Jolivet 
2707e31fc274SPierre Jolivet   Note:
2708e31fc274SPierre Jolivet   This is not the same as `PCSetReusePreconditioner()`. Given certain conditions (visible using -info), a symbolic factorization can be skipped
2709e31fc274SPierre Jolivet   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2710e31fc274SPierre Jolivet 
2711e31fc274SPierre Jolivet   Level: advanced
2712e31fc274SPierre Jolivet 
2713562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMGetSTShareSubKSP()`
2714e31fc274SPierre Jolivet @*/
2715e31fc274SPierre Jolivet PetscErrorCode PCHPDDMSetSTShareSubKSP(PC pc, PetscBool share)
2716e31fc274SPierre Jolivet {
2717e31fc274SPierre Jolivet   PetscFunctionBegin;
2718e31fc274SPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2719e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetSTShareSubKSP_C", (PC, PetscBool), (pc, share));
27203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2721e31fc274SPierre Jolivet }
2722e31fc274SPierre Jolivet 
2723e31fc274SPierre Jolivet /*@
2724f1580f4eSBarry Smith   PCHPDDMGetSTShareSubKSP - Gets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver is shared.
2725f1580f4eSBarry Smith 
2726f1580f4eSBarry Smith   Input Parameter:
2727f1580f4eSBarry Smith . pc - preconditioner context
2728f1580f4eSBarry Smith 
2729f1580f4eSBarry Smith   Output Parameter:
2730f1580f4eSBarry Smith . share - whether the `KSP` is shared or not
2731f1580f4eSBarry Smith 
2732f1580f4eSBarry Smith   Note:
2733f1580f4eSBarry 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
2734f1580f4eSBarry Smith   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2735f1580f4eSBarry Smith 
2736f1580f4eSBarry Smith   Level: advanced
2737f1580f4eSBarry Smith 
2738562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetSTShareSubKSP()`
2739f1580f4eSBarry Smith @*/
2740d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetSTShareSubKSP(PC pc, PetscBool *share)
2741d71ae5a4SJacob Faibussowitsch {
2742f1580f4eSBarry Smith   PetscFunctionBegin;
2743f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2744f1580f4eSBarry Smith   if (share) {
27454f572ea9SToby Isaac     PetscAssertPointer(share, 2);
2746f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetSTShareSubKSP_C", (PC, PetscBool *), (pc, share));
2747f1580f4eSBarry Smith   }
27483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2749f1580f4eSBarry Smith }
2750f1580f4eSBarry Smith 
2751e31fc274SPierre Jolivet static PetscErrorCode PCHPDDMSetSTShareSubKSP_HPDDM(PC pc, PetscBool share)
2752e31fc274SPierre Jolivet {
2753e31fc274SPierre Jolivet   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2754e31fc274SPierre Jolivet 
2755e31fc274SPierre Jolivet   PetscFunctionBegin;
2756e31fc274SPierre Jolivet   data->share = share;
27573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2758e31fc274SPierre Jolivet }
2759e31fc274SPierre Jolivet 
2760d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetSTShareSubKSP_HPDDM(PC pc, PetscBool *share)
2761d71ae5a4SJacob Faibussowitsch {
2762f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2763f1580f4eSBarry Smith 
2764f1580f4eSBarry Smith   PetscFunctionBegin;
2765f1580f4eSBarry Smith   *share = data->share;
27663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2767f1580f4eSBarry Smith }
2768f1580f4eSBarry Smith 
2769f1580f4eSBarry Smith /*@
2770f1580f4eSBarry Smith   PCHPDDMSetDeflationMat - Sets the deflation space used to assemble a coarser operator.
2771f1580f4eSBarry Smith 
2772f1580f4eSBarry Smith   Input Parameters:
2773f1580f4eSBarry Smith + pc - preconditioner context
2774f1580f4eSBarry Smith . is - index set of the local deflation matrix
2775f1580f4eSBarry Smith - U  - deflation sequential matrix stored as a `MATSEQDENSE`
2776f1580f4eSBarry Smith 
2777f1580f4eSBarry Smith   Level: advanced
2778f1580f4eSBarry Smith 
2779562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCDeflationSetSpace()`, `PCMGSetRestriction()`
2780f1580f4eSBarry Smith @*/
2781d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetDeflationMat(PC pc, IS is, Mat U)
2782d71ae5a4SJacob Faibussowitsch {
2783f1580f4eSBarry Smith   PetscFunctionBegin;
2784f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2785f1580f4eSBarry Smith   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
2786f1580f4eSBarry Smith   PetscValidHeaderSpecific(U, MAT_CLASSID, 3);
2787e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetDeflationMat_C", (PC, IS, Mat), (pc, is, U));
27883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2789f1580f4eSBarry Smith }
2790f1580f4eSBarry Smith 
2791d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetDeflationMat_HPDDM(PC pc, IS is, Mat U)
2792d71ae5a4SJacob Faibussowitsch {
2793f1580f4eSBarry Smith   PetscFunctionBegin;
2794f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, U, PETSC_TRUE));
27953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2796f1580f4eSBarry Smith }
2797f1580f4eSBarry Smith 
2798d71ae5a4SJacob Faibussowitsch PetscErrorCode HPDDMLoadDL_Private(PetscBool *found)
2799d71ae5a4SJacob Faibussowitsch {
2800605ad303SPierre Jolivet   PetscBool flg;
2801f1580f4eSBarry Smith   char      lib[PETSC_MAX_PATH_LEN], dlib[PETSC_MAX_PATH_LEN], dir[PETSC_MAX_PATH_LEN];
2802f1580f4eSBarry Smith 
2803f1580f4eSBarry Smith   PetscFunctionBegin;
28044f572ea9SToby Isaac   PetscAssertPointer(found, 1);
2805c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(dir, "${PETSC_LIB_DIR}", sizeof(dir)));
2806db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, nullptr, "-hpddm_dir", dir, sizeof(dir), nullptr));
2807f1580f4eSBarry Smith   PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2808f1580f4eSBarry Smith   PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2809605ad303SPierre Jolivet #if defined(SLEPC_LIB_DIR) /* this variable is passed during SLEPc ./configure when PETSc has not been configured   */
2810605ad303SPierre Jolivet   if (!*found) {           /* with --download-hpddm since slepcconf.h is not yet built (and thus can't be included) */
2811c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(dir, HPDDM_STR(SLEPC_LIB_DIR), sizeof(dir)));
2812f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2813f1580f4eSBarry Smith     PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2814f1580f4eSBarry Smith   }
2815f1580f4eSBarry Smith #endif
2816605ad303SPierre 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 */
2817605ad303SPierre Jolivet     PetscCall(PetscOptionsGetenv(PETSC_COMM_SELF, "SLEPC_DIR", dir, sizeof(dir), &flg));
2818605ad303SPierre 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 */
2819605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libslepc", dir));
2820605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2821605ad303SPierre Jolivet       PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found but SLEPC_DIR=%s", lib, dir);
2822605ad303SPierre Jolivet       PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
2823605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libhpddm_petsc", dir)); /* libhpddm_petsc is always in the same directory as libslepc */
2824605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2825605ad303SPierre Jolivet     }
2826605ad303SPierre Jolivet   }
2827f1580f4eSBarry Smith   PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found", lib);
2828f1580f4eSBarry Smith   PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
28293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2830f1580f4eSBarry Smith }
2831f1580f4eSBarry Smith 
2832f1580f4eSBarry Smith /*MC
2833f1580f4eSBarry Smith    PCHPDDM - Interface with the HPDDM library.
2834f1580f4eSBarry Smith 
28351d27aa22SBarry Smith    This `PC` may be used to build multilevel spectral domain decomposition methods based on the GenEO framework {cite}`spillane2011robust` {cite}`al2021multilevel`.
28361d27aa22SBarry Smith    It may be viewed as an alternative to spectral
28371d27aa22SBarry Smith    AMGe or `PCBDDC` with adaptive selection of constraints. The interface is explained in details in {cite}`jolivetromanzampini2020`
2838f1580f4eSBarry Smith 
2839e7593814SPierre 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`).
2840f1580f4eSBarry Smith 
2841f1580f4eSBarry Smith    For multilevel preconditioning, when using an assembled or hierarchical Pmat, one must provide an auxiliary local `Mat` (unassembled local operator for GenEO) using
2842f1580f4eSBarry Smith    `PCHPDDMSetAuxiliaryMat()`. Calling this routine is not needed when using a `MATIS` Pmat, assembly is done internally using `MatConvert()`.
2843f1580f4eSBarry Smith 
2844f1580f4eSBarry Smith    Options Database Keys:
2845f1580f4eSBarry Smith +   -pc_hpddm_define_subdomains <true, default=false>    - on the finest level, calls `PCASMSetLocalSubdomains()` with the `IS` supplied in `PCHPDDMSetAuxiliaryMat()`
2846f1580f4eSBarry Smith                                                          (not relevant with an unassembled Pmat)
2847f1580f4eSBarry Smith .   -pc_hpddm_has_neumann <true, default=false>          - on the finest level, informs the `PC` that the local Neumann matrix is supplied in `PCHPDDMSetAuxiliaryMat()`
2848f1580f4eSBarry Smith -   -pc_hpddm_coarse_correction <type, default=deflated> - determines the `PCHPDDMCoarseCorrectionType` when calling `PCApply()`
2849f1580f4eSBarry Smith 
285038bf2a8cSPierre Jolivet    Options for subdomain solvers, subdomain eigensolvers (for computing deflation vectors), and the coarse solver can be set using the following options database prefixes.
2851f1580f4eSBarry Smith .vb
2852f1580f4eSBarry Smith       -pc_hpddm_levels_%d_pc_
2853f1580f4eSBarry Smith       -pc_hpddm_levels_%d_ksp_
2854f1580f4eSBarry Smith       -pc_hpddm_levels_%d_eps_
2855f1580f4eSBarry Smith       -pc_hpddm_levels_%d_p
28564ec2a359SPierre Jolivet       -pc_hpddm_levels_%d_mat_type
2857f1580f4eSBarry Smith       -pc_hpddm_coarse_
2858f1580f4eSBarry Smith       -pc_hpddm_coarse_p
28594ec2a359SPierre Jolivet       -pc_hpddm_coarse_mat_type
28602ce66baaSPierre Jolivet       -pc_hpddm_coarse_mat_filter
2861f1580f4eSBarry Smith .ve
2862f1580f4eSBarry Smith 
286338bf2a8cSPierre 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
2864f1580f4eSBarry Smith     -pc_hpddm_coarse_p 2 -pc_hpddm_coarse_mat_type baij will use 10 deflation vectors per subdomain on the fine "level 1",
2865f1580f4eSBarry Smith     aggregate the fine subdomains into 4 "level 2" subdomains, then use 10 deflation vectors per subdomain on "level 2",
28667eb095acSPierre Jolivet     and assemble the coarse matrix (of dimension 4 x 10 = 40) on two processes as a `MATBAIJ` (default is `MATSBAIJ`).
2867f1580f4eSBarry Smith 
2868f1580f4eSBarry 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.
2869f1580f4eSBarry Smith 
28701d27aa22SBarry Smith    Level: intermediate
28711d27aa22SBarry Smith 
28721d27aa22SBarry Smith    Notes:
28731d27aa22SBarry Smith    This preconditioner requires that PETSc is built with SLEPc (``--download-slepc``).
28741d27aa22SBarry Smith 
28751d27aa22SBarry Smith    By default, the underlying concurrent eigenproblems
28761d27aa22SBarry Smith    are solved using SLEPc shift-and-invert spectral transformation. This is usually what gives the best performance for GenEO, cf.
28771d27aa22SBarry Smith    {cite}`spillane2011robust` {cite}`jolivet2013scalabledd`. As
287838bf2a8cSPierre 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
287938bf2a8cSPierre 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
288038bf2a8cSPierre Jolivet    SLEPc documentation since they are specific to `PCHPDDM`.
288138bf2a8cSPierre Jolivet .vb
288238bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_st_share_sub_ksp
288338bf2a8cSPierre Jolivet       -pc_hpddm_levels_%d_eps_threshold
288438bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_eps_use_inertia
288538bf2a8cSPierre Jolivet .ve
288638bf2a8cSPierre Jolivet 
288738bf2a8cSPierre Jolivet    The first option from the list only applies to the fine-level eigensolver, see `PCHPDDMSetSTShareSubKSP()`. The second option from the list is
288838bf2a8cSPierre Jolivet    used to filter eigenmodes retrieved after convergence of `EPSSolve()` at "level N" such that eigenvectors used to define a "level N+1" coarse
288938bf2a8cSPierre 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
289038bf2a8cSPierre 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
289138bf2a8cSPierre 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
289238bf2a8cSPierre Jolivet    to supply -pc_hpddm_levels_1_eps_nev. This last option also only applies to the fine-level (N = 1) eigensolver.
2893f1580f4eSBarry Smith 
28941d27aa22SBarry Smith    See also {cite}`dolean2015introduction`, {cite}`al2022robust`, {cite}`al2022robustpd`, and {cite}`nataf2022recent`
2895f1580f4eSBarry Smith 
2896562efe2eSBarry Smith .seealso: [](ch_ksp), `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetAuxiliaryMat()`, `MATIS`, `PCBDDC`, `PCDEFLATION`, `PCTELESCOPE`, `PCASM`,
2897e31fc274SPierre Jolivet           `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDMHasNeumannMat()`, `PCHPDDMSetRHSMat()`, `PCHPDDMSetDeflationMat()`, `PCHPDDMSetSTShareSubKSP()`,
2898e31fc274SPierre Jolivet           `PCHPDDMGetSTShareSubKSP()`, `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDMGetComplexities()`
2899f1580f4eSBarry Smith M*/
2900d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_HPDDM(PC pc)
2901d71ae5a4SJacob Faibussowitsch {
2902f1580f4eSBarry Smith   PC_HPDDM *data;
2903f1580f4eSBarry Smith   PetscBool found;
2904f1580f4eSBarry Smith 
2905f1580f4eSBarry Smith   PetscFunctionBegin;
2906f1580f4eSBarry Smith   if (!loadedSym) {
2907f1580f4eSBarry Smith     PetscCall(HPDDMLoadDL_Private(&found));
2908db4a47b3SPierre Jolivet     if (found) PetscCall(PetscDLLibrarySym(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, nullptr, "PCHPDDM_Internal", (void **)&loadedSym));
2909f1580f4eSBarry Smith   }
2910f1580f4eSBarry Smith   PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCHPDDM_Internal symbol not found in loaded libhpddm_petsc");
29114dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&data));
2912f1580f4eSBarry Smith   pc->data                = data;
2913c8ea6600SPierre Jolivet   data->Neumann           = PETSC_BOOL3_UNKNOWN;
2914f1580f4eSBarry Smith   pc->ops->reset          = PCReset_HPDDM;
2915f1580f4eSBarry Smith   pc->ops->destroy        = PCDestroy_HPDDM;
2916f1580f4eSBarry Smith   pc->ops->setfromoptions = PCSetFromOptions_HPDDM;
2917f1580f4eSBarry Smith   pc->ops->setup          = PCSetUp_HPDDM;
2918f1580f4eSBarry Smith   pc->ops->apply          = PCApply_HPDDM;
2919f1580f4eSBarry Smith   pc->ops->matapply       = PCMatApply_HPDDM;
2920f1580f4eSBarry Smith   pc->ops->view           = PCView_HPDDM;
2921f1580f4eSBarry Smith   pc->ops->presolve       = PCPreSolve_HPDDM;
2922f1580f4eSBarry Smith 
2923f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", PCHPDDMSetAuxiliaryMat_HPDDM));
2924f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", PCHPDDMHasNeumannMat_HPDDM));
2925f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", PCHPDDMSetRHSMat_HPDDM));
2926f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", PCHPDDMSetCoarseCorrectionType_HPDDM));
2927f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", PCHPDDMGetCoarseCorrectionType_HPDDM));
2928e31fc274SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", PCHPDDMSetSTShareSubKSP_HPDDM));
2929f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", PCHPDDMGetSTShareSubKSP_HPDDM));
2930f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", PCHPDDMSetDeflationMat_HPDDM));
29313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2932f1580f4eSBarry Smith }
2933f1580f4eSBarry Smith 
2934f1580f4eSBarry Smith /*@C
2935f1580f4eSBarry Smith   PCHPDDMInitializePackage - This function initializes everything in the `PCHPDDM` package. It is called from `PCInitializePackage()`.
2936f1580f4eSBarry Smith 
2937f1580f4eSBarry Smith   Level: developer
2938f1580f4eSBarry Smith 
2939562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscInitialize()`
2940f1580f4eSBarry Smith @*/
2941d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMInitializePackage(void)
2942d71ae5a4SJacob Faibussowitsch {
2943f1580f4eSBarry Smith   char     ename[32];
2944f1580f4eSBarry Smith   PetscInt i;
2945f1580f4eSBarry Smith 
2946f1580f4eSBarry Smith   PetscFunctionBegin;
29473ba16761SJacob Faibussowitsch   if (PCHPDDMPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
2948f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_TRUE;
2949f1580f4eSBarry Smith   PetscCall(PetscRegisterFinalize(PCHPDDMFinalizePackage));
2950f1580f4eSBarry Smith   /* general events registered once during package initialization */
2951f1580f4eSBarry Smith   /* some of these events are not triggered in libpetsc,          */
2952f1580f4eSBarry Smith   /* but rather directly in libhpddm_petsc,                       */
2953f1580f4eSBarry Smith   /* which is in charge of performing the following operations    */
2954f1580f4eSBarry Smith 
2955f1580f4eSBarry Smith   /* domain decomposition structure from Pmat sparsity pattern    */
2956f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMStrc", PC_CLASSID, &PC_HPDDM_Strc));
2957f1580f4eSBarry Smith   /* Galerkin product, redistribution, and setup (not triggered in libpetsc)                */
2958f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtAP", PC_CLASSID, &PC_HPDDM_PtAP));
2959f1580f4eSBarry Smith   /* Galerkin product with summation, redistribution, and setup (not triggered in libpetsc) */
2960f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtBP", PC_CLASSID, &PC_HPDDM_PtBP));
2961f1580f4eSBarry Smith   /* next level construction using PtAP and PtBP (not triggered in libpetsc)                */
2962f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMNext", PC_CLASSID, &PC_HPDDM_Next));
2963f1580f4eSBarry Smith   static_assert(PETSC_PCHPDDM_MAXLEVELS <= 9, "PETSC_PCHPDDM_MAXLEVELS value is too high");
2964f1580f4eSBarry Smith   for (i = 1; i < PETSC_PCHPDDM_MAXLEVELS; ++i) {
2965f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSetUp L%1" PetscInt_FMT, i));
2966f1580f4eSBarry Smith     /* events during a PCSetUp() at level #i _except_ the assembly */
2967f1580f4eSBarry Smith     /* of the Galerkin operator of the coarser level #(i + 1)      */
2968f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_SetUp[i - 1]));
2969f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSolve L%1" PetscInt_FMT, i));
2970f1580f4eSBarry Smith     /* events during a PCApply() at level #i _except_              */
2971f1580f4eSBarry Smith     /* the KSPSolve() of the coarser level #(i + 1)                */
2972f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_Solve[i - 1]));
2973f1580f4eSBarry Smith   }
29743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2975f1580f4eSBarry Smith }
2976f1580f4eSBarry Smith 
2977f1580f4eSBarry Smith /*@C
2978f1580f4eSBarry Smith   PCHPDDMFinalizePackage - This function frees everything from the `PCHPDDM` package. It is called from `PetscFinalize()`.
2979f1580f4eSBarry Smith 
2980f1580f4eSBarry Smith   Level: developer
2981f1580f4eSBarry Smith 
2982562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscFinalize()`
2983f1580f4eSBarry Smith @*/
2984d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMFinalizePackage(void)
2985d71ae5a4SJacob Faibussowitsch {
2986f1580f4eSBarry Smith   PetscFunctionBegin;
2987f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_FALSE;
29883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2989f1580f4eSBarry Smith }
29909bb5c669SPierre Jolivet 
29919bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat A, Vec x, Vec y)
29929bb5c669SPierre Jolivet {
29939bb5c669SPierre Jolivet   Harmonic h; /* [ A_00  A_01       ], furthermore, A_00 = [ A_loc,loc  A_loc,ovl ], thus, A_01 = [         ] */
29949bb5c669SPierre Jolivet               /* [ A_10  A_11  A_12 ]                      [ A_ovl,loc  A_ovl,ovl ]               [ A_ovl,1 ] */
29959bb5c669SPierre Jolivet   Vec sub;    /*  y = A x = R_loc R_0 [ A_00  A_01 ]^-1                                   R_loc = [  I_loc  ] */
29969bb5c669SPierre Jolivet               /*                      [ A_10  A_11 ]    R_1^T A_12 x                              [         ] */
29979bb5c669SPierre Jolivet   PetscFunctionBegin;
29989bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
29999bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
30009bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
30019bb5c669SPierre Jolivet   PetscCall(MatMult(h->A[0], x, sub));
30029bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
30039bb5c669SPierre Jolivet   PetscCall(KSPSolve(h->ksp, h->v, h->v));
30049bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_REVERSE, y));
30059bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30069bb5c669SPierre Jolivet }
30079bb5c669SPierre Jolivet 
30089bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat A, Vec y, Vec x)
30099bb5c669SPierre Jolivet {
30109bb5c669SPierre Jolivet   Harmonic h;   /* x = A^T y =            [ A_00  A_01 ]^-T R_0^T R_loc^T y */
30119bb5c669SPierre Jolivet   Vec      sub; /*             A_12^T R_1 [ A_10  A_11 ]                    */
30129bb5c669SPierre Jolivet 
30139bb5c669SPierre Jolivet   PetscFunctionBegin;
30149bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
30159bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
30169bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_FORWARD, y));
30179bb5c669SPierre Jolivet   PetscCall(KSPSolveTranspose(h->ksp, h->v, h->v));
30189bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
30199bb5c669SPierre Jolivet   PetscCall(MatMultTranspose(h->A[0], sub, x));
30209bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
30219bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30229bb5c669SPierre Jolivet }
30239bb5c669SPierre Jolivet 
30249bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat S, Mat X, Mat Y, void *)
30259bb5c669SPierre Jolivet {
30269bb5c669SPierre Jolivet   Harmonic h;
30279bb5c669SPierre Jolivet   Mat      A, B;
30289bb5c669SPierre Jolivet   Vec      a, b;
30299bb5c669SPierre Jolivet 
30309bb5c669SPierre Jolivet   PetscFunctionBegin;
30319bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
30329bb5c669SPierre Jolivet   PetscCall(MatMatMult(h->A[0], X, MAT_INITIAL_MATRIX, PETSC_DEFAULT, &A));
30339bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
30349bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
30359bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
30369bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B, i, &b));
30379bb5c669SPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_FORWARD, a));
30389bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B, i, &b));
30399bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
30409bb5c669SPierre Jolivet   }
30419bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
30429bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, B->cmap->n, nullptr, &A));
30439bb5c669SPierre Jolivet   PetscCall(KSPMatSolve(h->ksp, B, A));
30449bb5c669SPierre Jolivet   PetscCall(MatDestroy(&B));
30459bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
30469bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
30479bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &b));
30489bb5c669SPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_REVERSE, b));
30499bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &b));
30509bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
30519bb5c669SPierre Jolivet   }
30529bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
30539bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30549bb5c669SPierre Jolivet }
30559bb5c669SPierre Jolivet 
30569bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat A)
30579bb5c669SPierre Jolivet {
30589bb5c669SPierre Jolivet   Harmonic h;
30599bb5c669SPierre Jolivet 
30609bb5c669SPierre Jolivet   PetscFunctionBegin;
30619bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
30629bb5c669SPierre Jolivet   for (PetscInt i = 0; i < (h->A[1] ? 5 : 3); ++i) PetscCall(ISDestroy(h->is + i));
30639bb5c669SPierre Jolivet   PetscCall(PetscFree(h->is));
30649bb5c669SPierre Jolivet   PetscCall(VecDestroy(&h->v));
30659bb5c669SPierre Jolivet   for (PetscInt i = 0; i < 2; ++i) PetscCall(MatDestroy(h->A + i));
30669bb5c669SPierre Jolivet   PetscCall(PetscFree(h->A));
30679bb5c669SPierre Jolivet   PetscCall(KSPDestroy(&h->ksp));
30689bb5c669SPierre Jolivet   PetscCall(PetscFree(h));
30699bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30709bb5c669SPierre Jolivet }
3071