xref: /petsc/src/ksp/pc/impls/hpddm/pchpddm.cxx (revision 0307214f099b3c7cba5b1b7be21e2b917e9f0500)
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;
1124f1580f4eSBarry Smith   PetscCall(ISSorted(is, &sorted));
1125f1580f4eSBarry Smith   if (!sorted) {
1126f1580f4eSBarry Smith     PetscCall(ISGetLocalSize(is, &size));
1127f1580f4eSBarry Smith     PetscCall(ISGetIndices(is, &ptr));
1128b07dfdedSPierre Jolivet     PetscCall(ISGetBlockSize(is, &bs));
1129f1580f4eSBarry Smith     /* MatCreateSubMatrices(), called by PCASM, follows the global numbering of Pmat */
1130b07dfdedSPierre Jolivet     for (n = 0; n < size; n += bs) order.insert(std::make_pair(ptr[n] / bs, n / bs));
1131f1580f4eSBarry Smith     PetscCall(ISRestoreIndices(is, &ptr));
1132b07dfdedSPierre Jolivet     size /= bs;
1133f1580f4eSBarry Smith     if (out_C) {
1134f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1135f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.second;
1136f1580f4eSBarry Smith       concatenate -= size;
1137b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_C), bs, size, concatenate, PETSC_OWN_POINTER, &perm));
1138f1580f4eSBarry Smith       PetscCall(ISSetPermutation(perm));
1139f1580f4eSBarry Smith       /* permute user-provided Mat so that it matches with MatCreateSubMatrices() numbering */
1140f1580f4eSBarry Smith       PetscCall(MatPermute(in_C, perm, perm, out_C));
1141f1580f4eSBarry Smith       if (p) *p = perm;
1142f1580f4eSBarry Smith       else PetscCall(ISDestroy(&perm)); /* no need to save the permutation */
1143f1580f4eSBarry Smith     }
1144f1580f4eSBarry Smith     if (out_is) {
1145f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1146f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.first;
1147f1580f4eSBarry Smith       concatenate -= size;
1148f1580f4eSBarry Smith       /* permute user-provided IS so that it matches with MatCreateSubMatrices() numbering */
1149b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_is), bs, size, concatenate, PETSC_OWN_POINTER, out_is));
1150f1580f4eSBarry Smith     }
1151f1580f4eSBarry Smith   } else { /* input IS is sorted, nothing to permute, simply duplicate inputs when needed */
1152f1580f4eSBarry Smith     if (out_C) PetscCall(MatDuplicate(in_C, MAT_COPY_VALUES, out_C));
1153f1580f4eSBarry Smith     if (out_is) PetscCall(ISDuplicate(in_is, out_is));
1154f1580f4eSBarry Smith   }
11553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1156f1580f4eSBarry Smith }
1157f1580f4eSBarry Smith 
11585e642048SPierre Jolivet static PetscErrorCode PCHPDDMCheckSymmetry_Private(PC pc, Mat A01, Mat A10)
115913044ca3SPierre Jolivet {
116013044ca3SPierre Jolivet   Mat       T, U = nullptr, B = nullptr;
116113044ca3SPierre Jolivet   IS        z;
116213044ca3SPierre Jolivet   PetscBool flg[2];
116313044ca3SPierre Jolivet 
116413044ca3SPierre Jolivet   PetscFunctionBegin;
116513044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, flg));
116613044ca3SPierre Jolivet   if (flg[0]) PetscCall(MatTransposeGetMat(A10, &U));
116713044ca3SPierre Jolivet   else {
116813044ca3SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, flg + 1));
116913044ca3SPierre Jolivet     if (flg[1]) PetscCall(MatHermitianTransposeGetMat(A10, &U));
117013044ca3SPierre Jolivet   }
117113044ca3SPierre Jolivet   if (U) PetscCall(MatDuplicate(U, MAT_COPY_VALUES, &T));
117213044ca3SPierre Jolivet   else PetscCall(MatHermitianTranspose(A10, MAT_INITIAL_MATRIX, &T));
117313044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATTRANSPOSEVIRTUAL, flg));
117413044ca3SPierre Jolivet   if (flg[0]) {
117513044ca3SPierre Jolivet     PetscCall(MatTransposeGetMat(A01, &A01));
117613044ca3SPierre Jolivet     PetscCall(MatTranspose(A01, MAT_INITIAL_MATRIX, &B));
117713044ca3SPierre Jolivet     A01 = B;
117813044ca3SPierre Jolivet   } else {
117913044ca3SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATHERMITIANTRANSPOSEVIRTUAL, flg));
118013044ca3SPierre Jolivet     if (flg[0]) {
118113044ca3SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A01, &A01));
118213044ca3SPierre Jolivet       PetscCall(MatHermitianTranspose(A01, MAT_INITIAL_MATRIX, &B));
118313044ca3SPierre Jolivet       A01 = B;
118413044ca3SPierre Jolivet     }
118513044ca3SPierre Jolivet   }
118613044ca3SPierre Jolivet   PetscCall(PetscLayoutCompare(T->rmap, A01->rmap, flg));
118713044ca3SPierre Jolivet   if (flg[0]) {
118813044ca3SPierre Jolivet     PetscCall(PetscLayoutCompare(T->cmap, A01->cmap, flg));
118913044ca3SPierre Jolivet     if (flg[0]) {
119013044ca3SPierre Jolivet       PetscCall(MatFindZeroRows(A01, &z)); /* for essential boundary conditions, some implementations will */
119113044ca3SPierre Jolivet       if (z) {                             /*  zero rows in [P00 A01] except for the diagonal of P00       */
119213044ca3SPierre Jolivet         PetscCall(MatSetOption(T, MAT_NO_OFF_PROC_ZERO_ROWS, PETSC_TRUE));
119313044ca3SPierre Jolivet         PetscCall(MatZeroRowsIS(T, z, 0.0, nullptr, nullptr)); /* corresponding zero rows from A01 */
119413044ca3SPierre Jolivet         PetscCall(ISDestroy(&z));
119513044ca3SPierre Jolivet       }
119613044ca3SPierre Jolivet       PetscCall(MatMultEqual(A01, T, 20, flg));
119713044ca3SPierre Jolivet       PetscCheck(flg[0], PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "A01 != A10^T");
119813044ca3SPierre Jolivet     } else PetscCall(PetscInfo(pc, "A01 and A10^T have non-congruent column layouts, cannot test for equality\n"));
119913044ca3SPierre Jolivet   }
120013044ca3SPierre Jolivet   PetscCall(MatDestroy(&B));
120113044ca3SPierre Jolivet   PetscCall(MatDestroy(&T));
120213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
120313044ca3SPierre Jolivet }
120413044ca3SPierre Jolivet 
1205d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMDestroySubMatrices_Private(PetscBool flg, PetscBool algebraic, Mat *sub)
1206d71ae5a4SJacob Faibussowitsch {
1207f1580f4eSBarry Smith   IS is;
1208f1580f4eSBarry Smith 
1209f1580f4eSBarry Smith   PetscFunctionBegin;
1210f1580f4eSBarry Smith   if (!flg) {
1211f1580f4eSBarry Smith     if (algebraic) {
1212f1580f4eSBarry Smith       PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Embed", (PetscObject *)&is));
1213f1580f4eSBarry Smith       PetscCall(ISDestroy(&is));
1214db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Embed", nullptr));
1215db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Compact", nullptr));
1216f1580f4eSBarry Smith     }
1217f1580f4eSBarry Smith     PetscCall(MatDestroySubMatrices(algebraic ? 2 : 1, &sub));
1218f1580f4eSBarry Smith   }
12193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1220f1580f4eSBarry Smith }
1221f1580f4eSBarry Smith 
1222d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMAlgebraicAuxiliaryMat_Private(Mat P, IS *is, Mat *sub[], PetscBool block)
1223d71ae5a4SJacob Faibussowitsch {
1224f1580f4eSBarry Smith   IS         icol[3], irow[2];
1225f1580f4eSBarry Smith   Mat       *M, Q;
1226f1580f4eSBarry Smith   PetscReal *ptr;
1227f1580f4eSBarry Smith   PetscInt  *idx, p = 0, n, bs = PetscAbs(P->cmap->bs);
1228f1580f4eSBarry Smith   PetscBool  flg;
1229f1580f4eSBarry Smith 
1230f1580f4eSBarry Smith   PetscFunctionBegin;
1231f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, P->cmap->N, 0, 1, icol + 2));
1232f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(icol[2], bs));
1233f1580f4eSBarry Smith   PetscCall(ISSetIdentity(icol[2]));
1234f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1235f1580f4eSBarry Smith   if (flg) {
1236f1580f4eSBarry Smith     /* MatCreateSubMatrices() does not handle MATMPISBAIJ properly when iscol != isrow, so convert first to MATMPIBAIJ */
1237f1580f4eSBarry Smith     PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &Q));
1238f1580f4eSBarry Smith     std::swap(P, Q);
1239f1580f4eSBarry Smith   }
1240f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(P, 1, is, icol + 2, MAT_INITIAL_MATRIX, &M));
1241f1580f4eSBarry Smith   if (flg) {
1242f1580f4eSBarry Smith     std::swap(P, Q);
1243f1580f4eSBarry Smith     PetscCall(MatDestroy(&Q));
1244f1580f4eSBarry Smith   }
1245f1580f4eSBarry Smith   PetscCall(ISDestroy(icol + 2));
1246f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, M[0]->rmap->N, 0, 1, irow));
1247f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(irow[0], bs));
1248f1580f4eSBarry Smith   PetscCall(ISSetIdentity(irow[0]));
1249f1580f4eSBarry Smith   if (!block) {
1250b07dfdedSPierre Jolivet     PetscCall(PetscMalloc2(P->cmap->N, &ptr, P->cmap->N / bs, &idx));
1251f1580f4eSBarry Smith     PetscCall(MatGetColumnNorms(M[0], NORM_INFINITY, ptr));
1252f1580f4eSBarry Smith     /* check for nonzero columns so that M[0] may be expressed in compact form */
1253b07dfdedSPierre Jolivet     for (n = 0; n < P->cmap->N; n += bs) {
1254b07dfdedSPierre Jolivet       if (std::find_if(ptr + n, ptr + n + bs, [](PetscReal v) { return v > PETSC_MACHINE_EPSILON; }) != ptr + n + bs) idx[p++] = n / bs;
1255f1580f4eSBarry Smith     }
1256b07dfdedSPierre Jolivet     PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, p, idx, PETSC_USE_POINTER, icol + 1));
1257f1580f4eSBarry Smith     PetscCall(ISSetInfo(icol[1], IS_SORTED, IS_GLOBAL, PETSC_TRUE, PETSC_TRUE));
1258f1580f4eSBarry Smith     PetscCall(ISEmbed(*is, icol[1], PETSC_FALSE, icol + 2));
1259f1580f4eSBarry Smith     irow[1] = irow[0];
1260f1580f4eSBarry 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 */
1261f1580f4eSBarry Smith     icol[0] = is[0];
1262f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 2, irow, icol, MAT_INITIAL_MATRIX, sub));
1263f1580f4eSBarry Smith     PetscCall(ISDestroy(icol + 1));
1264f1580f4eSBarry Smith     PetscCall(PetscFree2(ptr, idx));
1265f1580f4eSBarry Smith     /* IS used to go back and forth between the augmented and the original local linear system, see eq. (3.4) of [2022b] */
1266f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Embed", (PetscObject)icol[2]));
1267f1580f4eSBarry Smith     /* Mat used in eq. (3.1) of [2022b] */
1268f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Compact", (PetscObject)(*sub)[1]));
1269f1580f4eSBarry Smith   } else {
1270f1580f4eSBarry Smith     Mat aux;
1271f1580f4eSBarry Smith     PetscCall(MatSetOption(M[0], MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1272f1580f4eSBarry Smith     /* diagonal block of the overlapping rows */
1273f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 1, irow, is, MAT_INITIAL_MATRIX, sub));
1274f1580f4eSBarry Smith     PetscCall(MatDuplicate((*sub)[0], MAT_COPY_VALUES, &aux));
1275f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1276f1580f4eSBarry Smith     if (bs == 1) { /* scalar case */
1277f1580f4eSBarry Smith       Vec sum[2];
1278f1580f4eSBarry Smith       PetscCall(MatCreateVecs(aux, sum, sum + 1));
1279f1580f4eSBarry Smith       PetscCall(MatGetRowSum(M[0], sum[0]));
1280f1580f4eSBarry Smith       PetscCall(MatGetRowSum(aux, sum[1]));
1281f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1282f1580f4eSBarry Smith       PetscCall(VecAXPY(sum[0], -1.0, sum[1]));
1283f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1284f1580f4eSBarry Smith       PetscCall(MatDiagonalSet(aux, sum[0], ADD_VALUES));
1285f1580f4eSBarry Smith       PetscCall(VecDestroy(sum));
1286f1580f4eSBarry Smith       PetscCall(VecDestroy(sum + 1));
1287f1580f4eSBarry Smith     } else { /* vectorial case */
1288f1580f4eSBarry Smith       /* TODO: missing MatGetValuesBlocked(), so the code below is     */
1289f1580f4eSBarry Smith       /* an extension of the scalar case for when bs > 1, but it could */
1290f1580f4eSBarry Smith       /* be more efficient by avoiding all these MatMatMult()          */
1291f1580f4eSBarry Smith       Mat          sum[2], ones;
1292f1580f4eSBarry Smith       PetscScalar *ptr;
1293f1580f4eSBarry Smith       PetscCall(PetscCalloc1(M[0]->cmap->n * bs, &ptr));
1294f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, M[0]->cmap->n, bs, M[0]->cmap->n, bs, ptr, &ones));
1295f1580f4eSBarry Smith       for (n = 0; n < M[0]->cmap->n; n += bs) {
1296f1580f4eSBarry Smith         for (p = 0; p < bs; ++p) ptr[n + p * (M[0]->cmap->n + 1)] = 1.0;
1297f1580f4eSBarry Smith       }
1298f1580f4eSBarry Smith       PetscCall(MatMatMult(M[0], ones, MAT_INITIAL_MATRIX, PETSC_DEFAULT, sum));
1299f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1300f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, aux->cmap->n, bs, aux->cmap->n, bs, ptr, &ones));
1301f1580f4eSBarry Smith       PetscCall(MatDenseSetLDA(ones, M[0]->cmap->n));
1302f1580f4eSBarry Smith       PetscCall(MatMatMult(aux, ones, MAT_INITIAL_MATRIX, PETSC_DEFAULT, sum + 1));
1303f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1304f1580f4eSBarry Smith       PetscCall(PetscFree(ptr));
1305f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1306f1580f4eSBarry Smith       PetscCall(MatAXPY(sum[0], -1.0, sum[1], SAME_NONZERO_PATTERN));
1307f1580f4eSBarry Smith       PetscCall(MatDestroy(sum + 1));
1308f1580f4eSBarry Smith       /* re-order values to be consistent with MatSetValuesBlocked()           */
1309f1580f4eSBarry Smith       /* equivalent to MatTranspose() which does not truly handle              */
1310f1580f4eSBarry Smith       /* MAT_INPLACE_MATRIX in the rectangular case, as it calls PetscMalloc() */
1311f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(sum[0], &ptr));
1312f1580f4eSBarry Smith       HPDDM::Wrapper<PetscScalar>::imatcopy<'T'>(bs, sum[0]->rmap->n, ptr, sum[0]->rmap->n, bs);
1313f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1314f1580f4eSBarry Smith       for (n = 0; n < aux->cmap->n / bs; ++n) PetscCall(MatSetValuesBlocked(aux, 1, &n, 1, &n, ptr + n * bs * bs, ADD_VALUES));
1315f1580f4eSBarry Smith       PetscCall(MatAssemblyBegin(aux, MAT_FINAL_ASSEMBLY));
1316f1580f4eSBarry Smith       PetscCall(MatAssemblyEnd(aux, MAT_FINAL_ASSEMBLY));
1317f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(sum[0], &ptr));
1318f1580f4eSBarry Smith       PetscCall(MatDestroy(sum));
1319f1580f4eSBarry Smith     }
1320f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
1321f1580f4eSBarry Smith     /* left-hand side of GenEO, with the same sparsity pattern as PCASM subdomain solvers  */
1322f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Neumann_Mat", (PetscObject)aux));
1323f1580f4eSBarry Smith   }
1324f1580f4eSBarry Smith   PetscCall(ISDestroy(irow));
1325f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &M));
13263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1327f1580f4eSBarry Smith }
1328f1580f4eSBarry Smith 
132913044ca3SPierre Jolivet static PetscErrorCode PCApply_Nest(PC pc, Vec x, Vec y)
133013044ca3SPierre Jolivet {
133113044ca3SPierre Jolivet   Mat                    A;
133213044ca3SPierre Jolivet   MatSolverType          type;
133313044ca3SPierre Jolivet   IS                     is[2];
133413044ca3SPierre Jolivet   PetscBool              flg;
133513044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
133613044ca3SPierre Jolivet 
133713044ca3SPierre Jolivet   PetscFunctionBegin;
133813044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
133913044ca3SPierre Jolivet   PetscCall(PCGetOperators(p->first, &A, nullptr));
134013044ca3SPierre Jolivet   PetscCall(MatNestGetISs(A, is, nullptr));
134113044ca3SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(p->first, &type));
134213044ca3SPierre Jolivet   PetscCall(PCFactorGetMatrix(p->first, &A));
134313044ca3SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
134424ddd604SPierre Jolivet   if (flg && A->schur) {
134513044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
134613044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 1)); /* reduction/condensation phase followed by Schur complement solve */
134713044ca3SPierre Jolivet #endif
134813044ca3SPierre Jolivet   }
134913044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[0], is[1], SCATTER_FORWARD, x)); /* assign the RHS associated to the Schur complement */
135013044ca3SPierre Jolivet   PetscCall(PCApply(p->first, p->second[0], p->second[1]));
135113044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[1], is[1], SCATTER_REVERSE, y)); /* retrieve the partial solution associated to the Schur complement */
135213044ca3SPierre Jolivet   if (flg) {
135313044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
135413044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1)); /* default ICNTL(26) value in PETSc */
135513044ca3SPierre Jolivet #endif
135613044ca3SPierre Jolivet   }
135713044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
135813044ca3SPierre Jolivet }
135913044ca3SPierre Jolivet 
136013044ca3SPierre Jolivet static PetscErrorCode PCView_Nest(PC pc, PetscViewer viewer)
136113044ca3SPierre Jolivet {
136213044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
136313044ca3SPierre Jolivet 
136413044ca3SPierre Jolivet   PetscFunctionBegin;
136513044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
136613044ca3SPierre Jolivet   PetscCall(PCView(p->first, viewer));
136713044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
136813044ca3SPierre Jolivet }
136913044ca3SPierre Jolivet 
137013044ca3SPierre Jolivet static PetscErrorCode PCDestroy_Nest(PC pc)
137113044ca3SPierre Jolivet {
137213044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
137313044ca3SPierre Jolivet 
137413044ca3SPierre Jolivet   PetscFunctionBegin;
137513044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
137613044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second));
137713044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second + 1));
137813044ca3SPierre Jolivet   PetscCall(PCDestroy(&p->first));
137913044ca3SPierre Jolivet   PetscCall(PetscFree(p));
138013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
138113044ca3SPierre Jolivet }
138213044ca3SPierre Jolivet 
138313044ca3SPierre Jolivet template <bool T = false>
138413044ca3SPierre Jolivet static PetscErrorCode MatMult_Schur(Mat A, Vec x, Vec y)
138513044ca3SPierre Jolivet {
138601e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
138713044ca3SPierre Jolivet 
138813044ca3SPierre Jolivet   PetscFunctionBegin;
138913044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
139013044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD)); /* local Vec with overlap */
139113044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD));
139213044ca3SPierre Jolivet   if (!T) PetscCall(MatMult(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1])); /* local Schur complement */
139313044ca3SPierre Jolivet   else PetscCall(MatMultTranspose(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1]));
139413044ca3SPierre Jolivet   PetscCall(VecSet(y, 0.0));
139513044ca3SPierre 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 */
139613044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE));
139713044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
139813044ca3SPierre Jolivet }
139913044ca3SPierre Jolivet 
140013044ca3SPierre Jolivet static PetscErrorCode MatDestroy_Schur(Mat A)
140113044ca3SPierre Jolivet {
140201e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
140313044ca3SPierre Jolivet 
140413044ca3SPierre Jolivet   PetscFunctionBegin;
140513044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
140613044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx)));
140713044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx) + 1));
140813044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
140913044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
141013044ca3SPierre Jolivet }
141113044ca3SPierre Jolivet 
141213044ca3SPierre Jolivet static PetscErrorCode MatMult_SchurCorrection(Mat A, Vec x, Vec y)
141313044ca3SPierre Jolivet {
141413044ca3SPierre Jolivet   PC                                         pc;
141513044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
141613044ca3SPierre Jolivet 
141713044ca3SPierre Jolivet   PetscFunctionBegin;
141813044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
141913044ca3SPierre Jolivet   pc = ((PC_HPDDM *)std::get<0>(*ctx)[0]->data)->levels[0]->ksp->pc;
142013044ca3SPierre 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 */
142113044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], x, std::get<3>(*ctx)[1]));                    /*     A_01 x                 */
142213044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 x             */
142313044ca3SPierre 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        */
142413044ca3SPierre 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 */
142513044ca3SPierre Jolivet   } else {
142613044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[0]));                    /*     M_S^-1 x               */
142713044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], std::get<3>(*ctx)[0], std::get<3>(*ctx)[1])); /*     A_01 M_S^-1 x          */
142813044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 M_S^-1 x      */
142913044ca3SPierre 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 */
143013044ca3SPierre Jolivet   }
143113044ca3SPierre Jolivet   PetscCall(VecAXPY(y, -1.0, x)); /* y -= x, preconditioned eq. (24) of https://hal.science/hal-02343808v6/document (with a sign flip) */
143213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
143313044ca3SPierre Jolivet }
143413044ca3SPierre Jolivet 
143513044ca3SPierre Jolivet static PetscErrorCode MatView_SchurCorrection(Mat A, PetscViewer viewer)
143613044ca3SPierre Jolivet {
143713044ca3SPierre Jolivet   PetscBool                                  ascii;
143813044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
143913044ca3SPierre Jolivet 
144013044ca3SPierre Jolivet   PetscFunctionBegin;
144113044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &ascii));
144213044ca3SPierre Jolivet   if (ascii) {
144313044ca3SPierre Jolivet     PetscCall(MatShellGetContext(A, &ctx));
144413044ca3SPierre 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)"));
144513044ca3SPierre Jolivet     PetscCall(PCView(std::get<0>(*ctx)[1], viewer)); /* no need to PCView(Q_0) since it will be done by PCFIELDSPLIT */
144613044ca3SPierre Jolivet   }
144713044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
144813044ca3SPierre Jolivet }
144913044ca3SPierre Jolivet 
145013044ca3SPierre Jolivet static PetscErrorCode MatDestroy_SchurCorrection(Mat A)
145113044ca3SPierre Jolivet {
145213044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
145313044ca3SPierre Jolivet 
145413044ca3SPierre Jolivet   PetscFunctionBegin;
145513044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
145613044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx)));
145713044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 1));
145813044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 2));
145913044ca3SPierre Jolivet   PetscCall(PCDestroy(std::get<0>(*ctx) + 1));
146013044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
146113044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
146213044ca3SPierre Jolivet }
146313044ca3SPierre Jolivet 
146413044ca3SPierre Jolivet static PetscErrorCode KSPPreSolve_SchurCorrection(KSP, Vec b, Vec, void *context)
146513044ca3SPierre Jolivet {
146613044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
146713044ca3SPierre Jolivet 
1468a6b3e571SPierre Jolivet   PetscFunctionBegin;
146913044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
147013044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], b, std::get<3>(*ctx)[2]));
147113044ca3SPierre 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 */
147213044ca3SPierre Jolivet   }
147313044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
147413044ca3SPierre Jolivet }
147513044ca3SPierre Jolivet 
147613044ca3SPierre Jolivet static PetscErrorCode KSPPostSolve_SchurCorrection(KSP, Vec b, Vec x, void *context)
147713044ca3SPierre Jolivet {
147813044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
147913044ca3SPierre Jolivet 
1480a6b3e571SPierre Jolivet   PetscFunctionBegin;
148113044ca3SPierre 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 */
148213044ca3SPierre Jolivet   else {
148313044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[2]));
148413044ca3SPierre Jolivet     PetscCall(VecCopy(std::get<3>(*ctx)[2], x)); /* replace x by M^-1 x */
148513044ca3SPierre Jolivet   }
148613044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
148713044ca3SPierre Jolivet }
148813044ca3SPierre Jolivet 
14899bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat, Vec, Vec);
14909bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat, Vec, Vec);
14919bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat, Mat, Mat, void *);
14929bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat);
14939bb5c669SPierre Jolivet 
1494d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDM(PC pc)
1495d71ae5a4SJacob Faibussowitsch {
1496f1580f4eSBarry Smith   PC_HPDDM                                  *data = (PC_HPDDM *)pc->data;
1497f1580f4eSBarry Smith   PC                                         inner;
1498f1580f4eSBarry Smith   KSP                                       *ksp;
149913044ca3SPierre Jolivet   Mat                                       *sub, A, P, N, C = nullptr, uaux = nullptr, weighted, subA[2], S;
1500f1580f4eSBarry Smith   Vec                                        xin, v;
1501f1580f4eSBarry Smith   std::vector<Vec>                           initial;
1502db4a47b3SPierre Jolivet   IS                                         is[1], loc, uis = data->is, unsorted = nullptr;
1503f1580f4eSBarry Smith   ISLocalToGlobalMapping                     l2g;
1504f1580f4eSBarry Smith   char                                       prefix[256];
1505f1580f4eSBarry Smith   const char                                *pcpre;
1506f1580f4eSBarry Smith   const PetscScalar *const                  *ev;
15079bb5c669SPierre Jolivet   PetscInt                                   n, requested = data->N, reused = 0, overlap = -1;
1508f1580f4eSBarry Smith   MatStructure                               structure  = UNKNOWN_NONZERO_PATTERN;
1509f1580f4eSBarry Smith   PetscBool                                  subdomains = PETSC_FALSE, flg = PETSC_FALSE, ismatis, swap = PETSC_FALSE, algebraic = PETSC_FALSE, block = PETSC_FALSE;
1510f1580f4eSBarry Smith   DM                                         dm;
151113044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = nullptr;
1512398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1513db4a47b3SPierre Jolivet   IS  dis  = nullptr;
1514db4a47b3SPierre Jolivet   Mat daux = nullptr;
1515398c7888SPierre Jolivet #endif
1516f1580f4eSBarry Smith 
1517f1580f4eSBarry Smith   PetscFunctionBegin;
1518f1580f4eSBarry Smith   PetscCheck(data->levels && data->levels[0], PETSC_COMM_SELF, PETSC_ERR_PLIB, "Not a single level allocated");
1519f1580f4eSBarry Smith   PetscCall(PCGetOptionsPrefix(pc, &pcpre));
1520f1580f4eSBarry Smith   PetscCall(PCGetOperators(pc, &A, &P));
1521f1580f4eSBarry Smith   if (!data->levels[0]->ksp) {
1522f1580f4eSBarry Smith     PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->ksp));
15233821be0aSBarry Smith     PetscCall(KSPSetNestLevel(data->levels[0]->ksp, pc->kspnestlevel));
1524f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_%s_", pcpre ? pcpre : "", data->N > 1 ? "levels_1" : "coarse"));
1525f1580f4eSBarry Smith     PetscCall(KSPSetOptionsPrefix(data->levels[0]->ksp, prefix));
1526f1580f4eSBarry Smith     PetscCall(KSPSetType(data->levels[0]->ksp, KSPPREONLY));
1527f1580f4eSBarry Smith   } else if (data->levels[0]->ksp->pc && data->levels[0]->ksp->pc->setupcalled == 1 && data->levels[0]->ksp->pc->reusepreconditioner) {
1528f1580f4eSBarry Smith     /* if the fine-level PCSHELL exists, its setup has succeeded, and one wants to reuse it, */
1529f1580f4eSBarry Smith     /* then just propagate the appropriate flag to the coarser levels                        */
1530f1580f4eSBarry Smith     for (n = 0; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1531f1580f4eSBarry Smith       /* the following KSP and PC may be NULL for some processes, hence the check            */
1532f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetReusePreconditioner(data->levels[n]->ksp, PETSC_TRUE));
1533f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
1534f1580f4eSBarry Smith     }
1535f1580f4eSBarry Smith     /* early bail out because there is nothing to do */
15363ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1537f1580f4eSBarry Smith   } else {
1538f1580f4eSBarry Smith     /* reset coarser levels */
1539f1580f4eSBarry Smith     for (n = 1; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1540f1580f4eSBarry 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) {
1541f1580f4eSBarry Smith         reused = data->N - n;
1542f1580f4eSBarry Smith         break;
1543f1580f4eSBarry Smith       }
1544f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[n]->ksp));
1545f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[n]->pc));
1546f1580f4eSBarry Smith     }
1547f1580f4eSBarry Smith     /* check if some coarser levels are being reused */
1548f1580f4eSBarry Smith     PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &reused, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)pc)));
1549f1580f4eSBarry Smith     const int *addr = data->levels[0]->P ? data->levels[0]->P->getAddrLocal() : &HPDDM::i__0;
1550f1580f4eSBarry Smith 
1551f1580f4eSBarry Smith     if (addr != &HPDDM::i__0 && reused != data->N - 1) {
1552f1580f4eSBarry Smith       /* reuse previously computed eigenvectors */
1553f1580f4eSBarry Smith       ev = data->levels[0]->P->getVectors();
1554f1580f4eSBarry Smith       if (ev) {
1555f1580f4eSBarry Smith         initial.reserve(*addr);
1556f1580f4eSBarry Smith         PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, data->levels[0]->P->getDof(), ev[0], &xin));
1557f1580f4eSBarry Smith         for (n = 0; n < *addr; ++n) {
1558f1580f4eSBarry Smith           PetscCall(VecDuplicate(xin, &v));
1559f1580f4eSBarry Smith           PetscCall(VecPlaceArray(xin, ev[n]));
1560f1580f4eSBarry Smith           PetscCall(VecCopy(xin, v));
1561f1580f4eSBarry Smith           initial.emplace_back(v);
1562f1580f4eSBarry Smith           PetscCall(VecResetArray(xin));
1563f1580f4eSBarry Smith         }
1564f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
1565f1580f4eSBarry Smith       }
1566f1580f4eSBarry Smith     }
1567f1580f4eSBarry Smith   }
1568f1580f4eSBarry Smith   data->N -= reused;
1569f1580f4eSBarry Smith   PetscCall(KSPSetOperators(data->levels[0]->ksp, A, P));
1570f1580f4eSBarry Smith 
1571f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATIS, &ismatis));
1572f1580f4eSBarry Smith   if (!data->is && !ismatis) {
1573db4a47b3SPierre Jolivet     PetscErrorCode (*create)(DM, IS *, Mat *, PetscErrorCode (**)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void **) = nullptr;
1574db4a47b3SPierre Jolivet     PetscErrorCode (*usetup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *)                                                = nullptr;
1575db4a47b3SPierre Jolivet     void *uctx                                                                                                               = nullptr;
1576f1580f4eSBarry Smith 
1577f1580f4eSBarry Smith     /* first see if we can get the data from the DM */
1578f1580f4eSBarry Smith     PetscCall(MatGetDM(P, &dm));
1579f1580f4eSBarry Smith     if (!dm) PetscCall(MatGetDM(A, &dm));
1580f1580f4eSBarry Smith     if (!dm) PetscCall(PCGetDM(pc, &dm));
1581907a3e9cSStefano Zampini     if (dm) { /* this is the hook for DMPLEX for which the auxiliary Mat is the local Neumann matrix */
1582f1580f4eSBarry Smith       PetscCall(PetscObjectQueryFunction((PetscObject)dm, "DMCreateNeumannOverlap_C", &create));
1583f1580f4eSBarry Smith       if (create) {
1584f1580f4eSBarry Smith         PetscCall((*create)(dm, &uis, &uaux, &usetup, &uctx));
1585c8ea6600SPierre 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 */
1586f1580f4eSBarry Smith       }
1587f1580f4eSBarry Smith     }
1588f1580f4eSBarry Smith     if (!create) {
1589f1580f4eSBarry Smith       if (!uis) {
1590f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1591f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1592f1580f4eSBarry Smith       }
1593f1580f4eSBarry Smith       if (!uaux) {
1594f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1595f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1596f1580f4eSBarry Smith       }
1597f1580f4eSBarry Smith       /* look inside the Pmat instead of the PC, needed for MatSchurComplementComputeExplicitOperator() */
1598f1580f4eSBarry Smith       if (!uis) {
1599f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1600f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1601f1580f4eSBarry Smith       }
1602f1580f4eSBarry Smith       if (!uaux) {
1603f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1604f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1605f1580f4eSBarry Smith       }
1606f1580f4eSBarry Smith     }
1607f1580f4eSBarry Smith     PetscCall(PCHPDDMSetAuxiliaryMat(pc, uis, uaux, usetup, uctx));
1608f1580f4eSBarry Smith     PetscCall(MatDestroy(&uaux));
1609f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
1610f1580f4eSBarry Smith   }
1611f1580f4eSBarry Smith 
1612f1580f4eSBarry Smith   if (!ismatis) {
1613f1580f4eSBarry Smith     PetscCall(PCHPDDMSetUpNeumannOverlap_Private(pc));
1614db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_block_splitting", &block, nullptr));
16159bb5c669SPierre Jolivet     PetscCall(PetscOptionsGetInt(nullptr, pcpre, "-pc_hpddm_harmonic_overlap", &overlap, nullptr));
16165e642048SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
16175e642048SPierre Jolivet     if (data->is || (data->N > 1 && flg)) {
16189bb5c669SPierre Jolivet       if (block || overlap != -1) {
161902800ff6SPierre Jolivet         PetscCall(ISDestroy(&data->is));
162002800ff6SPierre Jolivet         PetscCall(MatDestroy(&data->aux));
16215e642048SPierre Jolivet       } else if (data->N > 1 && flg) {
162213044ca3SPierre Jolivet         PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_GENEO;
162313044ca3SPierre Jolivet 
162413044ca3SPierre Jolivet         PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
162513044ca3SPierre Jolivet         if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
162613044ca3SPierre Jolivet           PetscCall(ISDestroy(&data->is)); /* destroy any previously user-set objects since they will be set automatically */
162713044ca3SPierre Jolivet           PetscCall(MatDestroy(&data->aux));
162813044ca3SPierre Jolivet         } else if (type == PC_HPDDM_SCHUR_PRE_GENEO) {
162913044ca3SPierre Jolivet           PetscContainer container = nullptr;
163013044ca3SPierre Jolivet 
163113044ca3SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Schur", (PetscObject *)&container));
163213044ca3SPierre Jolivet           if (!container) { /* first call to PCSetUp() on the PC associated to the Schur complement */
163313044ca3SPierre Jolivet             PC_HPDDM *data_00;
163413044ca3SPierre Jolivet             KSP       ksp, inner_ksp;
163513044ca3SPierre Jolivet             PC        pc_00;
163613044ca3SPierre Jolivet             char     *prefix;
163713044ca3SPierre Jolivet             PetscReal norm;
163813044ca3SPierre Jolivet 
163913044ca3SPierre Jolivet             PetscCall(MatSchurComplementGetKSP(P, &ksp));
164013044ca3SPierre Jolivet             PetscCall(KSPGetPC(ksp, &pc_00));
164113044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)pc_00, PCHPDDM, &flg));
1642fd310a01SPierre 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 : "",
164313044ca3SPierre Jolivet                        ((PetscObject)pc_00)->type_name, PCHPDDM);
164413044ca3SPierre Jolivet             data_00 = (PC_HPDDM *)pc_00->data;
1645fd310a01SPierre 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],
1646fd310a01SPierre Jolivet                        data_00->N, data_00->N > 1 ? "s" : "", ((PetscObject)pc_00)->prefix);
164713044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)data_00->levels[0]->pc, PCASM, &flg));
1648fd310a01SPierre 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,
164913044ca3SPierre Jolivet                        ((PetscObject)data_00->levels[0]->pc)->type_name, PCASM);
1650fd310a01SPierre Jolivet             PetscCheck(data->Neumann == PETSC_BOOL3_TRUE, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition %s and -%spc_hpddm_has_neumann != true", pcpre ? pcpre : "", PCHPDDMSchurPreTypes[type], pcpre ? pcpre : "");
16515e642048SPierre Jolivet             if (PetscDefined(USE_DEBUG) || !data->is) {
16525e642048SPierre Jolivet               Mat A01, A10, B = nullptr, C = nullptr, *sub;
165313044ca3SPierre Jolivet 
16545e642048SPierre Jolivet               PetscCall(MatSchurComplementGetSubMatrices(P, &A, nullptr, &A01, &A10, nullptr));
16555e642048SPierre Jolivet               PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
16565e642048SPierre Jolivet               if (flg) {
16575e642048SPierre Jolivet                 PetscCall(MatTransposeGetMat(A10, &C));
16585e642048SPierre Jolivet                 PetscCall(MatTranspose(C, MAT_INITIAL_MATRIX, &B));
16595e642048SPierre Jolivet               } else {
16605e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
16615e642048SPierre Jolivet                 if (flg) {
16625e642048SPierre Jolivet                   PetscCall(MatHermitianTransposeGetMat(A10, &C));
16635e642048SPierre Jolivet                   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &B));
16645e642048SPierre Jolivet                 }
16655e642048SPierre Jolivet               }
16665e642048SPierre Jolivet               if (!B) {
16675e642048SPierre Jolivet                 B = A10;
16685e642048SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)B));
16695e642048SPierre Jolivet               } else if (!data->is) {
16705e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompareAny((PetscObject)A01, &flg, MATTRANSPOSEVIRTUAL, MATHERMITIANTRANSPOSEVIRTUAL, ""));
16715e642048SPierre Jolivet                 if (!flg) C = A01;
16725e642048SPierre Jolivet               }
167313044ca3SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, B->rmap->N, 0, 1, &uis));
16745e642048SPierre Jolivet               PetscCall(ISSetIdentity(uis));
16755e642048SPierre Jolivet               if (!data->is) {
16765e642048SPierre Jolivet                 if (C) PetscCall(PetscObjectReference((PetscObject)C));
16775e642048SPierre Jolivet                 else PetscCall(MatTranspose(B, MAT_INITIAL_MATRIX, &C));
16785e642048SPierre Jolivet                 PetscCall(ISDuplicate(data_00->is, is));
16795e642048SPierre Jolivet                 PetscCall(MatIncreaseOverlap(A, 1, is, 1));
16805e642048SPierre Jolivet                 PetscCall(MatSetOption(C, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
16815e642048SPierre Jolivet                 PetscCall(MatCreateSubMatrices(C, 1, is, &uis, MAT_INITIAL_MATRIX, &sub));
16825e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
16835e642048SPierre Jolivet                 PetscCall(MatTranspose(sub[0], MAT_INITIAL_MATRIX, &C));
16845e642048SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
16855e642048SPierre Jolivet                 PetscCall(MatFindNonzeroRows(C, &data->is));
16865e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
16875e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
16885e642048SPierre Jolivet               }
16895e642048SPierre Jolivet               if (PetscDefined(USE_DEBUG)) {
16905e642048SPierre Jolivet                 PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
169113044ca3SPierre 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 */
169213044ca3SPierre Jolivet                 PetscCall(ISDestroy(&uis));
169313044ca3SPierre Jolivet                 PetscCall(ISDuplicate(data->is, &uis));
169413044ca3SPierre Jolivet                 PetscCall(ISSort(uis));
16955e642048SPierre Jolivet                 PetscCall(ISComplement(uis, 0, B->rmap->N, is));
169613044ca3SPierre Jolivet                 PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &C));
16975e642048SPierre Jolivet                 PetscCall(MatZeroRowsIS(C, is[0], 0.0, nullptr, nullptr));
16985e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
169913044ca3SPierre Jolivet                 PetscCall(MatMultEqual(sub[0], C, 20, &flg));
170013044ca3SPierre 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 */
170113044ca3SPierre Jolivet                 PetscCall(MatDestroy(&C));
170213044ca3SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
170313044ca3SPierre Jolivet               }
17045e642048SPierre Jolivet               PetscCall(ISDestroy(&uis));
17055e642048SPierre Jolivet               PetscCall(MatDestroy(&B));
17065e642048SPierre Jolivet             }
170713044ca3SPierre Jolivet             if (data->aux) PetscCall(MatNorm(data->aux, NORM_FROBENIUS, &norm));
170813044ca3SPierre Jolivet             else norm = 0.0;
170913044ca3SPierre Jolivet             PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &norm, 1, MPIU_REAL, MPI_MAX, PetscObjectComm((PetscObject)P)));
17100594bca0SPierre Jolivet             if (norm < PETSC_MACHINE_EPSILON * static_cast<PetscReal>(10.0)) { /* if A11 is near zero, e.g., Stokes equation, build a diagonal auxiliary (Neumann) Mat which is just a small diagonal weighted by the inverse of the multiplicity */
171101e3c840SPierre Jolivet               PetscSF            scatter;
171213044ca3SPierre Jolivet               Vec                x;
171313044ca3SPierre Jolivet               const PetscScalar *read;
171413044ca3SPierre Jolivet               PetscScalar       *write;
171513044ca3SPierre Jolivet 
171613044ca3SPierre Jolivet               PetscCall(MatDestroy(&data->aux));
171713044ca3SPierre Jolivet               PetscCall(ISGetLocalSize(data->is, &n));
171813044ca3SPierre Jolivet               PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &x));
171913044ca3SPierre Jolivet               PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &v));
172013044ca3SPierre Jolivet               PetscCall(VecScatterCreate(x, data->is, v, nullptr, &scatter));
172113044ca3SPierre Jolivet               PetscCall(VecSet(v, 1.0));
172213044ca3SPierre Jolivet               PetscCall(VecSet(x, 1.0));
172313044ca3SPierre Jolivet               PetscCall(VecScatterBegin(scatter, v, x, ADD_VALUES, SCATTER_REVERSE));
172413044ca3SPierre Jolivet               PetscCall(VecScatterEnd(scatter, v, x, ADD_VALUES, SCATTER_REVERSE)); /* v has the multiplicity of all unknowns on the overlap */
172513044ca3SPierre Jolivet               PetscCall(VecScatterDestroy(&scatter));
172613044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
172713044ca3SPierre Jolivet               PetscCall(VecCreateSeq(PETSC_COMM_SELF, n, &v));
172813044ca3SPierre Jolivet               PetscCall(VecGetArrayRead(x, &read));
172913044ca3SPierre Jolivet               PetscCall(VecGetArrayWrite(v, &write));
17300594bca0SPierre Jolivet               PetscCallCXX(std::transform(read, read + n, write, [](const PetscScalar &m) { return PETSC_SMALL / (static_cast<PetscReal>(1000.0) * m); }));
173113044ca3SPierre Jolivet               PetscCall(VecRestoreArrayRead(x, &read));
173213044ca3SPierre Jolivet               PetscCall(VecRestoreArrayWrite(v, &write));
173313044ca3SPierre Jolivet               PetscCall(VecDestroy(&x));
1734c3e1b152SPierre Jolivet               PetscCall(MatCreateDiagonal(v, &data->aux));
173513044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
173613044ca3SPierre Jolivet             }
173713044ca3SPierre Jolivet             uis  = data->is;
173813044ca3SPierre Jolivet             uaux = data->aux;
173913044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uis));
174013044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uaux));
174113044ca3SPierre Jolivet             PetscCall(PetscStrallocpy(pcpre, &prefix));
174213044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(pc, nullptr));
174313044ca3SPierre Jolivet             PetscCall(PCSetType(pc, PCKSP));                                    /* replace the PC associated to the Schur complement by PCKSP */
174413044ca3SPierre Jolivet             PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &inner_ksp)); /* new KSP that will be attached to the previously set PC */
174573329a61SPierre Jolivet             pc->ops->setup = PCSetUp_KSP;
174613044ca3SPierre Jolivet             PetscCall(PetscObjectGetTabLevel((PetscObject)pc, &n));
174713044ca3SPierre Jolivet             PetscCall(PetscObjectSetTabLevel((PetscObject)inner_ksp, n + 2));
174813044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, pc->mat, pc->pmat));
174913044ca3SPierre Jolivet             PetscCall(KSPSetOptionsPrefix(inner_ksp, std::string(std::string(prefix) + "pc_hpddm_").c_str()));
175013044ca3SPierre Jolivet             PetscCall(KSPSetSkipPCSetFromOptions(inner_ksp, PETSC_TRUE));
175113044ca3SPierre Jolivet             PetscCall(KSPSetFromOptions(inner_ksp));
175213044ca3SPierre Jolivet             PetscCall(KSPGetPC(inner_ksp, &inner));
175313044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(inner, nullptr));
175413044ca3SPierre Jolivet             PetscCall(PCSetType(inner, PCNONE)); /* no preconditioner since the action of M^-1 A or A M^-1 will be computed by the Amat */
175513044ca3SPierre Jolivet             PetscCall(PCKSPSetKSP(pc, inner_ksp));
175613044ca3SPierre Jolivet             PetscCall(PetscContainerCreate(PetscObjectComm((PetscObject)pc), &container));
175713044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx)); /* context to pass data around for the inner-most PC, which will be a proper PCHPDDM */
175813044ca3SPierre Jolivet             PetscCall(PetscContainerSetPointer(container, ctx));
175913044ca3SPierre Jolivet             std::get<0>(*ctx)[0] = pc_00; /* for coarse correction on the primal (e.g., velocity) space */
176013044ca3SPierre Jolivet             PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &std::get<0>(*ctx)[1]));
176113044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(std::get<0>(*ctx)[1], prefix));
176213044ca3SPierre Jolivet             PetscCall(PetscFree(prefix));
176313044ca3SPierre Jolivet             PetscCall(PCSetOperators(std::get<0>(*ctx)[1], pc->mat, pc->pmat));
176413044ca3SPierre Jolivet             PetscCall(PCSetType(std::get<0>(*ctx)[1], PCHPDDM));
176513044ca3SPierre 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 */
176613044ca3SPierre Jolivet             PetscCall(PCSetFromOptions(std::get<0>(*ctx)[1]));
176713044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uis));
176813044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uaux));
176913044ca3SPierre 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 */
177013044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_MULT, (void (*)(void))MatMult_SchurCorrection));
177113044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_VIEW, (void (*)(void))MatView_SchurCorrection));
177213044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_DESTROY, (void (*)(void))MatDestroy_SchurCorrection));
177313044ca3SPierre Jolivet             PetscCall(KSPGetPCSide(inner_ksp, &(std::get<2>(*ctx))));
177413044ca3SPierre Jolivet             if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
177513044ca3SPierre Jolivet               PetscCall(KSPSetPreSolve(inner_ksp, KSPPreSolve_SchurCorrection, ctx));
177613044ca3SPierre Jolivet             } else { /* no support for PC_SYMMETRIC */
177713044ca3SPierre 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]);
177813044ca3SPierre Jolivet             }
177913044ca3SPierre Jolivet             PetscCall(KSPSetPostSolve(inner_ksp, KSPPostSolve_SchurCorrection, ctx));
178013044ca3SPierre Jolivet             PetscCall(PetscObjectCompose((PetscObject)(std::get<0>(*ctx)[1]), "_PCHPDDM_Schur", (PetscObject)container));
178113044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)container));
178213044ca3SPierre Jolivet             PetscCall(PCSetUp(std::get<0>(*ctx)[1]));
178313044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, S, S));
178413044ca3SPierre Jolivet             PetscCall(MatCreateVecs(std::get<1>(*ctx)[0], std::get<3>(*ctx), std::get<3>(*ctx) + 1));
178513044ca3SPierre Jolivet             PetscCall(VecDuplicate(std::get<3>(*ctx)[0], std::get<3>(*ctx) + 2));
178613044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)inner_ksp));
178713044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)S));
1788*0307214fSPierre Jolivet             for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
178913044ca3SPierre Jolivet             PetscFunctionReturn(PETSC_SUCCESS);
179013044ca3SPierre Jolivet           } else { /* second call to PCSetUp() on the PC associated to the Schur complement, retrieve previously set context */
179113044ca3SPierre Jolivet             PetscCall(PetscContainerGetPointer(container, (void **)&ctx));
179213044ca3SPierre Jolivet           }
179313044ca3SPierre Jolivet         }
179413044ca3SPierre Jolivet       }
179513044ca3SPierre Jolivet     }
1796f1580f4eSBarry Smith     if (!data->is && data->N > 1) {
1797f1580f4eSBarry Smith       char type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
1798f1580f4eSBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
1799f1580f4eSBarry Smith       if (flg || (A->rmap->N != A->cmap->N && P->rmap->N == P->cmap->N && P->rmap->N == A->cmap->N)) {
1800f1580f4eSBarry Smith         Mat B;
1801f1580f4eSBarry Smith         PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, A, P, &B, pcpre));
1802f1580f4eSBarry Smith         if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) data->correction = PC_HPDDM_COARSE_CORRECTION_BALANCED;
1803f1580f4eSBarry Smith         PetscCall(MatDestroy(&B));
1804f1580f4eSBarry Smith       } else {
1805f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
1806f1580f4eSBarry Smith         if (flg) {
1807f1580f4eSBarry Smith           Mat                 A00, P00, A01, A10, A11, B, N;
180813044ca3SPierre Jolivet           PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_LEAST_SQUARES;
180913044ca3SPierre Jolivet 
181013044ca3SPierre Jolivet           PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, &A01, &A10, &A11));
181113044ca3SPierre Jolivet           if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
181213044ca3SPierre Jolivet           PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
181313044ca3SPierre Jolivet           if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
18143df4cd7bSPierre Jolivet             Vec                        diagonal = nullptr;
1815f1580f4eSBarry Smith             const PetscScalar         *array;
1816f1580f4eSBarry Smith             MatSchurComplementAinvType type;
1817f1580f4eSBarry Smith 
1818f1580f4eSBarry Smith             if (A11) {
18193df4cd7bSPierre Jolivet               PetscCall(MatCreateVecs(A11, &diagonal, nullptr));
18203df4cd7bSPierre Jolivet               PetscCall(MatGetDiagonal(A11, diagonal));
1821f1580f4eSBarry Smith             }
1822db4a47b3SPierre Jolivet             PetscCall(MatCreateVecs(P00, &v, nullptr));
1823f1580f4eSBarry Smith             PetscCall(MatSchurComplementGetAinvType(P, &type));
1824f1580f4eSBarry 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]);
1825f1580f4eSBarry Smith             if (type == MAT_SCHUR_COMPLEMENT_AINV_LUMP) {
1826f1580f4eSBarry Smith               PetscCall(MatGetRowSum(P00, v));
1827f1580f4eSBarry Smith               if (A00 == P00) PetscCall(PetscObjectReference((PetscObject)A00));
1828f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1829f1580f4eSBarry Smith               PetscCall(VecGetArrayRead(v, &array));
1830db4a47b3SPierre Jolivet               PetscCall(MatCreateAIJ(PetscObjectComm((PetscObject)A00), A00->rmap->n, A00->cmap->n, A00->rmap->N, A00->cmap->N, 1, nullptr, 0, nullptr, &P00));
1831f1580f4eSBarry Smith               PetscCall(MatSetOption(P00, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
1832f1580f4eSBarry Smith               for (n = A00->rmap->rstart; n < A00->rmap->rend; ++n) PetscCall(MatSetValue(P00, n, n, array[n - A00->rmap->rstart], INSERT_VALUES));
1833f1580f4eSBarry Smith               PetscCall(MatAssemblyBegin(P00, MAT_FINAL_ASSEMBLY));
1834f1580f4eSBarry Smith               PetscCall(MatAssemblyEnd(P00, MAT_FINAL_ASSEMBLY));
1835f1580f4eSBarry Smith               PetscCall(VecRestoreArrayRead(v, &array));
1836f1580f4eSBarry Smith               PetscCall(MatSchurComplementUpdateSubMatrices(P, A00, P00, A01, A10, A11)); /* replace P00 by diag(sum of each row of P00) */
1837f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1838f1580f4eSBarry Smith             } else PetscCall(MatGetDiagonal(P00, v));
1839f1580f4eSBarry Smith             PetscCall(VecReciprocal(v)); /* inv(diag(P00))       */
1840f1580f4eSBarry Smith             PetscCall(VecSqrtAbs(v));    /* sqrt(inv(diag(P00))) */
1841f1580f4eSBarry Smith             PetscCall(MatDuplicate(A01, MAT_COPY_VALUES, &B));
1842db4a47b3SPierre Jolivet             PetscCall(MatDiagonalScale(B, v, nullptr));
1843f1580f4eSBarry Smith             PetscCall(VecDestroy(&v));
1844f1580f4eSBarry Smith             PetscCall(MatCreateNormalHermitian(B, &N));
18453df4cd7bSPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, B, N, &P, pcpre, &diagonal));
1846f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
1847f1580f4eSBarry Smith             if (!flg) {
1848f1580f4eSBarry Smith               PetscCall(MatDestroy(&P));
1849f1580f4eSBarry Smith               P = N;
1850f1580f4eSBarry Smith               PetscCall(PetscObjectReference((PetscObject)P));
1851f1580f4eSBarry Smith             } else PetscCall(MatScale(P, -1.0));
18523df4cd7bSPierre Jolivet             if (diagonal) {
18533df4cd7bSPierre Jolivet               PetscCall(MatDiagonalSet(P, diagonal, ADD_VALUES));
1854aa21023fSPierre Jolivet               PetscCall(PCSetOperators(pc, P, P)); /* replace P by diag(P11) - A01^T inv(diag(P00)) A01 */
18553df4cd7bSPierre Jolivet               PetscCall(VecDestroy(&diagonal));
18563df4cd7bSPierre Jolivet             } else {
1857f1580f4eSBarry Smith               PetscCall(MatScale(N, -1.0));
1858aa21023fSPierre Jolivet               PetscCall(PCSetOperators(pc, N, P)); /* replace P by - A01^T inv(diag(P00)) A01 */
18593df4cd7bSPierre Jolivet             }
1860f1580f4eSBarry Smith             PetscCall(MatDestroy(&N));
1861f1580f4eSBarry Smith             PetscCall(MatDestroy(&P));
1862f1580f4eSBarry Smith             PetscCall(MatDestroy(&B));
186313044ca3SPierre Jolivet           } else
1864fd310a01SPierre 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 : "");
1865*0307214fSPierre Jolivet           for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
18663ba16761SJacob Faibussowitsch           PetscFunctionReturn(PETSC_SUCCESS);
1867f1580f4eSBarry Smith         } else {
1868db4a47b3SPierre Jolivet           PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_st_pc_type", type, sizeof(type), nullptr));
1869f1580f4eSBarry Smith           PetscCall(PetscStrcmp(type, PCMAT, &algebraic));
1870b07dfdedSPierre Jolivet           PetscCheck(!algebraic || !block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_block_splitting");
18719bb5c669SPierre Jolivet           if (overlap != -1) {
18729bb5c669SPierre 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");
18739bb5c669SPierre Jolivet             PetscCheck(overlap >= 1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_WRONG, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " < 1", overlap);
18749bb5c669SPierre Jolivet           }
18759bb5c669SPierre Jolivet           if (block || overlap != -1) algebraic = PETSC_TRUE;
1876f1580f4eSBarry Smith           if (algebraic) {
1877f1580f4eSBarry Smith             PetscCall(ISCreateStride(PETSC_COMM_SELF, P->rmap->n, P->rmap->rstart, 1, &data->is));
1878f1580f4eSBarry Smith             PetscCall(MatIncreaseOverlap(P, 1, &data->is, 1));
1879f1580f4eSBarry Smith             PetscCall(ISSort(data->is));
18809bb5c669SPierre Jolivet           } else
18819bb5c669SPierre 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 : ""));
1882f1580f4eSBarry Smith         }
1883f1580f4eSBarry Smith       }
1884f1580f4eSBarry Smith     }
1885f1580f4eSBarry Smith   }
1886398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1887398c7888SPierre Jolivet   if (data->is) PetscCall(ISDuplicate(data->is, &dis));
1888398c7888SPierre Jolivet   if (data->aux) PetscCall(MatDuplicate(data->aux, MAT_COPY_VALUES, &daux));
1889398c7888SPierre Jolivet #endif
1890f1580f4eSBarry Smith   if (data->is || (ismatis && data->N > 1)) {
1891f1580f4eSBarry Smith     if (ismatis) {
1892f1580f4eSBarry Smith       std::initializer_list<std::string> list = {MATSEQBAIJ, MATSEQSBAIJ};
1893f1580f4eSBarry Smith       PetscCall(MatISGetLocalMat(P, &N));
1894f1580f4eSBarry Smith       std::initializer_list<std::string>::const_iterator it = std::find(list.begin(), list.end(), ((PetscObject)N)->type_name);
1895f1580f4eSBarry Smith       PetscCall(MatISRestoreLocalMat(P, &N));
1896f1580f4eSBarry Smith       switch (std::distance(list.begin(), it)) {
1897d71ae5a4SJacob Faibussowitsch       case 0:
1898d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
1899d71ae5a4SJacob Faibussowitsch         break;
1900f1580f4eSBarry Smith       case 1:
1901f1580f4eSBarry Smith         /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIBAIJ */
1902f1580f4eSBarry Smith         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
1903f1580f4eSBarry Smith         PetscCall(MatSetOption(C, MAT_SYMMETRIC, PETSC_TRUE));
1904f1580f4eSBarry Smith         break;
1905d71ae5a4SJacob Faibussowitsch       default:
1906d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, &C));
1907f1580f4eSBarry Smith       }
1908db4a47b3SPierre Jolivet       PetscCall(MatISGetLocalToGlobalMapping(P, &l2g, nullptr));
1909f1580f4eSBarry Smith       PetscCall(PetscObjectReference((PetscObject)P));
1910f1580f4eSBarry Smith       PetscCall(KSPSetOperators(data->levels[0]->ksp, A, C));
1911f1580f4eSBarry Smith       std::swap(C, P);
1912f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingGetSize(l2g, &n));
1913f1580f4eSBarry Smith       PetscCall(ISCreateStride(PETSC_COMM_SELF, n, 0, 1, &loc));
1914f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingApplyIS(l2g, loc, &is[0]));
1915f1580f4eSBarry Smith       PetscCall(ISDestroy(&loc));
1916f1580f4eSBarry Smith       /* the auxiliary Mat is _not_ the local Neumann matrix                                */
1917f1580f4eSBarry Smith       /* it is the local Neumann matrix augmented (with zeros) through MatIncreaseOverlap() */
1918c8ea6600SPierre Jolivet       data->Neumann = PETSC_BOOL3_FALSE;
1919f1580f4eSBarry Smith       structure     = SAME_NONZERO_PATTERN;
1920f1580f4eSBarry Smith     } else {
1921f1580f4eSBarry Smith       is[0] = data->is;
192213044ca3SPierre Jolivet       if (algebraic || ctx) subdomains = PETSC_TRUE;
1923db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_define_subdomains", &subdomains, nullptr));
192413044ca3SPierre 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);
1925c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann)) {
1926b07dfdedSPierre Jolivet         PetscCheck(!block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_block_splitting and -pc_hpddm_has_neumann");
19279bb5c669SPierre Jolivet         PetscCheck(overlap == -1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " and -pc_hpddm_has_neumann", overlap);
1928b07dfdedSPierre Jolivet         PetscCheck(!algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_has_neumann");
1929f1580f4eSBarry Smith       }
1930c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann) || block) structure = SAME_NONZERO_PATTERN;
1931f1580f4eSBarry Smith       PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), P->rmap->n, P->rmap->rstart, 1, &loc));
1932f1580f4eSBarry Smith     }
1933f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
1934db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetEnum(nullptr, prefix, "-st_matstructure", MatStructures, (PetscEnum *)&structure, &flg)); /* if not user-provided, force its value when possible */
1935f1580f4eSBarry Smith     if (!flg && structure == SAME_NONZERO_PATTERN) {                                                                   /* cannot call STSetMatStructure() yet, insert the appropriate option in the database, parsed by STSetFromOptions() */
1936f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-%spc_hpddm_levels_1_st_matstructure", pcpre ? pcpre : ""));
1937db4a47b3SPierre Jolivet       PetscCall(PetscOptionsSetValue(nullptr, prefix, MatStructures[structure]));
1938f1580f4eSBarry Smith     }
1939398c7888SPierre Jolivet     flg = PETSC_FALSE;
1940b07dfdedSPierre Jolivet     if (data->share) {
1941398c7888SPierre Jolivet       data->share = PETSC_FALSE; /* will be reset to PETSC_TRUE if none of the conditions below are true */
1942398c7888SPierre 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 : ""));
1943398c7888SPierre Jolivet       else if (data->deflation) PetscCall(PetscInfo(pc, "Nothing to share since PCHPDDMSetDeflationMat() has been called\n"));
1944398c7888SPierre Jolivet       else if (ismatis) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc with a Pmat of type MATIS\n"));
1945b07dfdedSPierre Jolivet       else if (!algebraic && structure != SAME_NONZERO_PATTERN)
1946398c7888SPierre 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]));
1947398c7888SPierre Jolivet       else data->share = PETSC_TRUE;
1948398c7888SPierre Jolivet     }
1949398c7888SPierre Jolivet     if (!ismatis) {
1950398c7888SPierre Jolivet       if (data->share || (!PetscBool3ToBool(data->Neumann) && subdomains)) PetscCall(ISDuplicate(is[0], &unsorted));
1951398c7888SPierre Jolivet       else unsorted = is[0];
1952398c7888SPierre Jolivet     }
1953f1580f4eSBarry Smith     if (data->N > 1 && (data->aux || ismatis || algebraic)) {
1954f1580f4eSBarry Smith       PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "HPDDM library not loaded, cannot use more than one level");
1955f1580f4eSBarry Smith       PetscCall(MatSetOption(P, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1956f1580f4eSBarry Smith       if (ismatis) {
1957f1580f4eSBarry Smith         /* needed by HPDDM (currently) so that the partition of unity is 0 on subdomain interfaces */
1958f1580f4eSBarry Smith         PetscCall(MatIncreaseOverlap(P, 1, is, 1));
1959f1580f4eSBarry Smith         PetscCall(ISDestroy(&data->is));
1960f1580f4eSBarry Smith         data->is = is[0];
1961f1580f4eSBarry Smith       } else {
1962f1580f4eSBarry Smith         if (PetscDefined(USE_DEBUG)) {
1963f1580f4eSBarry Smith           PetscBool equal;
1964f1580f4eSBarry Smith           IS        intersect;
1965f1580f4eSBarry Smith 
1966f1580f4eSBarry Smith           PetscCall(ISIntersect(data->is, loc, &intersect));
1967f1580f4eSBarry Smith           PetscCall(ISEqualUnsorted(loc, intersect, &equal));
1968f1580f4eSBarry Smith           PetscCall(ISDestroy(&intersect));
1969f1580f4eSBarry Smith           PetscCheck(equal, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "IS of the auxiliary Mat does not include all local rows of A");
1970f1580f4eSBarry Smith         }
19719bb5c669SPierre Jolivet         if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", PCHPDDMAlgebraicAuxiliaryMat_Private));
19729bb5c669SPierre Jolivet         if (!PetscBool3ToBool(data->Neumann) && (!algebraic || overlap != -1)) {
1973f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1974f1580f4eSBarry Smith           if (flg) {
1975f1580f4eSBarry Smith             /* maybe better to ISSort(is[0]), MatCreateSubMatrices(), and then MatPermute() */
1976f1580f4eSBarry Smith             /* but there is no MatPermute_SeqSBAIJ(), so as before, just use MATMPIBAIJ     */
1977f1580f4eSBarry Smith             PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &uaux));
1978f1580f4eSBarry Smith             flg = PETSC_FALSE;
1979f1580f4eSBarry Smith           }
1980f1580f4eSBarry Smith         }
1981f1580f4eSBarry Smith       }
19829bb5c669SPierre Jolivet       if (algebraic && overlap == -1) {
1983f1580f4eSBarry Smith         PetscUseMethod(pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", (Mat, IS *, Mat *[], PetscBool), (P, is, &sub, block));
1984f1580f4eSBarry Smith         if (block) {
1985f1580f4eSBarry Smith           PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", (PetscObject *)&data->aux));
1986db4a47b3SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", nullptr));
1987f1580f4eSBarry Smith         }
19889bb5c669SPierre Jolivet       } else if (!uaux || overlap != -1) {
198913044ca3SPierre Jolivet         if (!ctx) {
1990c8ea6600SPierre Jolivet           if (PetscBool3ToBool(data->Neumann)) sub = &data->aux;
19919bb5c669SPierre Jolivet           else {
1992df21ef68SPierre Jolivet             PetscBool flg;
19939bb5c669SPierre Jolivet             if (overlap != -1) {
19949bb5c669SPierre Jolivet               Harmonic              h;
19959bb5c669SPierre Jolivet               Mat                   A0, *a;                           /* with an SVD: [ A_00  A_01       ] */
19969bb5c669SPierre Jolivet               IS                    ov[2], rows, cols, stride;        /*              [ A_10  A_11  A_12 ] */
19979bb5c669SPierre Jolivet               const PetscInt       *i[2], bs = PetscAbs(P->cmap->bs); /* with a GEVP: [ A_00  A_01       ] */
19989bb5c669SPierre Jolivet               PetscInt              n[2];                             /*              [ A_10  A_11  A_12 ] */
19999bb5c669SPierre Jolivet               std::vector<PetscInt> v[2];                             /*              [       A_21  A_22 ] */
20009bb5c669SPierre Jolivet 
20019bb5c669SPierre Jolivet               PetscCall(ISDuplicate(data->is, ov));
20029bb5c669SPierre Jolivet               if (overlap > 1) PetscCall(MatIncreaseOverlap(P, 1, ov, overlap - 1));
20039bb5c669SPierre Jolivet               PetscCall(ISDuplicate(ov[0], ov + 1));
20049bb5c669SPierre Jolivet               PetscCall(MatIncreaseOverlap(P, 1, ov + 1, 1));
20059bb5c669SPierre Jolivet               PetscCall(PetscNew(&h));
20069bb5c669SPierre Jolivet               h->ksp = nullptr;
20079bb5c669SPierre Jolivet               PetscCall(PetscCalloc1(2, &h->A));
20083a60673dSPierre Jolivet               PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_nsv", &flg));
20099bb5c669SPierre Jolivet               if (!flg) PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_relative_threshold", &flg));
20109bb5c669SPierre Jolivet               PetscCall(ISSort(ov[0]));
20119bb5c669SPierre Jolivet               if (!flg) PetscCall(ISSort(ov[1]));
20129bb5c669SPierre Jolivet               PetscCall(PetscMalloc1(!flg ? 5 : 3, &h->is));
20139bb5c669SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, ov + !flg, ov + 1, MAT_INITIAL_MATRIX, &a)); /* submatrix from above, either square (!flg) or rectangular (flg) */
20149bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) {
20159bb5c669SPierre Jolivet                 PetscCall(ISGetIndices(ov[j], i + j));
20169bb5c669SPierre Jolivet                 PetscCall(ISGetLocalSize(ov[j], n + j));
20179bb5c669SPierre Jolivet               }
20189bb5c669SPierre Jolivet               v[1].reserve((n[1] - n[0]) / bs);
20199bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[1]; j += bs) { /* indices of the (2,2) block */
20209bb5c669SPierre Jolivet                 PetscInt location;
20219bb5c669SPierre Jolivet                 PetscCall(ISLocate(ov[0], i[1][j], &location));
20229bb5c669SPierre Jolivet                 if (location < 0) v[1].emplace_back(j / bs);
20239bb5c669SPierre Jolivet               }
20249bb5c669SPierre Jolivet               if (!flg) {
20259bb5c669SPierre Jolivet                 h->A[1] = a[0];
20269bb5c669SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)h->A[1]));
20279bb5c669SPierre Jolivet                 v[0].reserve((n[0] - P->rmap->n) / bs);
20289bb5c669SPierre Jolivet                 for (PetscInt j = 0; j < n[1]; j += bs) { /* row indices of the (1,2) block */
20299bb5c669SPierre Jolivet                   PetscInt location;
20309bb5c669SPierre Jolivet                   PetscCall(ISLocate(loc, i[1][j], &location));
20319bb5c669SPierre Jolivet                   if (location < 0) {
20329bb5c669SPierre Jolivet                     PetscCall(ISLocate(ov[0], i[1][j], &location));
20339bb5c669SPierre Jolivet                     if (location >= 0) v[0].emplace_back(j / bs);
20349bb5c669SPierre Jolivet                   }
20359bb5c669SPierre Jolivet                 }
20369bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
20379bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_COPY_VALUES, h->is + 4));
20389bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, h->is[4], MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
20399bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
20409bb5c669SPierre 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 */
20419bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &rows));
20429bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols = rows, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
20439bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
20449bb5c669SPierre Jolivet                 v[0].clear();
20459bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, ov[1], PETSC_TRUE, h->is + 3));
20469bb5c669SPierre Jolivet                 PetscCall(ISEmbed(data->is, ov[1], PETSC_TRUE, h->is + 2));
20479bb5c669SPierre Jolivet               }
20489bb5c669SPierre Jolivet               v[0].reserve((n[0] - P->rmap->n) / bs);
20499bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[0]; j += bs) {
20509bb5c669SPierre Jolivet                 PetscInt location;
20519bb5c669SPierre Jolivet                 PetscCall(ISLocate(loc, i[0][j], &location));
20529bb5c669SPierre Jolivet                 if (location < 0) v[0].emplace_back(j / bs);
20539bb5c669SPierre Jolivet               }
20549bb5c669SPierre Jolivet               PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
20559bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISRestoreIndices(ov[j], i + j));
20569bb5c669SPierre Jolivet               if (flg) {
20579bb5c669SPierre Jolivet                 IS is;
20589bb5c669SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, a[0]->rmap->n, 0, 1, &is));
20599bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &cols));
20609bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], is, cols, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
20619bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
20629bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&is));
20639bb5c669SPierre 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 */
20649bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, data->is, PETSC_TRUE, h->is + 2));
20659bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_USE_POINTER, &cols));
20669bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols, MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
20679bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
20689bb5c669SPierre Jolivet               }
20699bb5c669SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, A0->rmap->n, 0, 1, &stride));
20709bb5c669SPierre Jolivet               PetscCall(ISEmbed(rows, stride, PETSC_TRUE, h->is));
20719bb5c669SPierre Jolivet               PetscCall(ISDestroy(&stride));
20729bb5c669SPierre Jolivet               PetscCall(ISDestroy(&rows));
20739bb5c669SPierre Jolivet               PetscCall(ISEmbed(loc, ov[0], PETSC_TRUE, h->is + 1));
20749bb5c669SPierre Jolivet               if (subdomains) {
20759bb5c669SPierre Jolivet                 if (!data->levels[0]->pc) {
20769bb5c669SPierre Jolivet                   PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
20779bb5c669SPierre Jolivet                   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
20789bb5c669SPierre Jolivet                   PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
20799bb5c669SPierre Jolivet                   PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
20809bb5c669SPierre Jolivet                 }
20819bb5c669SPierre Jolivet                 PetscCall(PCSetType(data->levels[0]->pc, PCASM));
20829bb5c669SPierre Jolivet                 if (!data->levels[0]->pc->setupcalled) PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, ov + !flg, &loc));
20839bb5c669SPierre Jolivet                 PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, flg ? A0 : a[0], PETSC_TRUE));
20849bb5c669SPierre Jolivet                 if (!flg) ++overlap;
20859bb5c669SPierre Jolivet                 if (data->share) {
20869bb5c669SPierre Jolivet                   PetscInt n = -1;
20879bb5c669SPierre Jolivet                   PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
20889bb5c669SPierre Jolivet                   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
20899bb5c669SPierre Jolivet                   if (flg) {
20909bb5c669SPierre Jolivet                     h->ksp = ksp[0];
20919bb5c669SPierre Jolivet                     PetscCall(PetscObjectReference((PetscObject)h->ksp));
20929bb5c669SPierre Jolivet                   }
20939bb5c669SPierre Jolivet                 }
20949bb5c669SPierre Jolivet               }
20959bb5c669SPierre Jolivet               if (!h->ksp) {
20969bb5c669SPierre Jolivet                 PetscBool share = data->share;
20979bb5c669SPierre Jolivet                 PetscCall(KSPCreate(PETSC_COMM_SELF, &h->ksp));
20989bb5c669SPierre Jolivet                 PetscCall(KSPSetType(h->ksp, KSPPREONLY));
20999bb5c669SPierre Jolivet                 PetscCall(KSPSetOperators(h->ksp, A0, A0));
21009bb5c669SPierre Jolivet                 do {
21019bb5c669SPierre Jolivet                   if (!data->share) {
21029bb5c669SPierre Jolivet                     share = PETSC_FALSE;
21039bb5c669SPierre Jolivet                     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_%s", pcpre ? pcpre : "", flg ? "svd_" : "eps_"));
21049bb5c669SPierre Jolivet                     PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
21059bb5c669SPierre Jolivet                     PetscCall(KSPSetFromOptions(h->ksp));
21069bb5c669SPierre Jolivet                   } else {
21079bb5c669SPierre Jolivet                     MatSolverType type;
21089bb5c669SPierre Jolivet                     PetscCall(KSPGetPC(ksp[0], &pc));
21099bb5c669SPierre Jolivet                     PetscCall(PetscObjectTypeCompareAny((PetscObject)pc, &data->share, PCLU, PCCHOLESKY, ""));
21109bb5c669SPierre Jolivet                     if (data->share) {
21119bb5c669SPierre Jolivet                       PetscCall(PCFactorGetMatSolverType(pc, &type));
21129bb5c669SPierre Jolivet                       if (!type) {
21139bb5c669SPierre Jolivet                         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMUMPS));
21149bb5c669SPierre Jolivet                         else if (PetscDefined(HAVE_MKL_PARDISO)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMKL_PARDISO));
21159bb5c669SPierre Jolivet                         else data->share = PETSC_FALSE;
21169bb5c669SPierre Jolivet                         if (data->share) PetscCall(PCSetFromOptions(pc));
21179bb5c669SPierre Jolivet                       } else {
21189bb5c669SPierre Jolivet                         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &data->share));
21199bb5c669SPierre Jolivet                         if (!data->share) PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &data->share));
21209bb5c669SPierre Jolivet                       }
21219bb5c669SPierre Jolivet                       if (data->share) {
21229bb5c669SPierre Jolivet                         std::tuple<KSP, IS, Vec[2]> *p;
21239bb5c669SPierre Jolivet                         PetscCall(PCFactorGetMatrix(pc, &A));
21249bb5c669SPierre Jolivet                         PetscCall(MatFactorSetSchurIS(A, h->is[4]));
21259bb5c669SPierre Jolivet                         PetscCall(KSPSetUp(ksp[0]));
21269bb5c669SPierre Jolivet                         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_eps_shell_", pcpre ? pcpre : ""));
21279bb5c669SPierre Jolivet                         PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
21289bb5c669SPierre Jolivet                         PetscCall(KSPSetFromOptions(h->ksp));
21299bb5c669SPierre Jolivet                         PetscCall(KSPGetPC(h->ksp, &pc));
21309bb5c669SPierre Jolivet                         PetscCall(PCSetType(pc, PCSHELL));
21319bb5c669SPierre Jolivet                         PetscCall(PetscNew(&p));
21329bb5c669SPierre Jolivet                         std::get<0>(*p) = ksp[0];
21339bb5c669SPierre Jolivet                         PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &std::get<1>(*p)));
21349bb5c669SPierre Jolivet                         PetscCall(MatCreateVecs(A, std::get<2>(*p), std::get<2>(*p) + 1));
21359bb5c669SPierre Jolivet                         PetscCall(PCShellSetContext(pc, p));
21369bb5c669SPierre Jolivet                         PetscCall(PCShellSetApply(pc, PCApply_Schur));
21379bb5c669SPierre Jolivet                         PetscCall(PCShellSetApplyTranspose(pc, PCApply_Schur<Vec, true>));
21389bb5c669SPierre Jolivet                         PetscCall(PCShellSetMatApply(pc, PCApply_Schur<Mat>));
21399bb5c669SPierre Jolivet                         PetscCall(PCShellSetDestroy(pc, PCDestroy_Schur));
21409bb5c669SPierre Jolivet                       }
21419bb5c669SPierre Jolivet                     }
21429bb5c669SPierre Jolivet                     if (!data->share) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since neither MUMPS nor MKL PARDISO is used\n"));
21439bb5c669SPierre Jolivet                   }
21449bb5c669SPierre 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 */
21459bb5c669SPierre Jolivet               }
21469bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov));
21479bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov + 1));
21489bb5c669SPierre Jolivet               if (overlap == 1 && subdomains && flg) {
21499bb5c669SPierre Jolivet                 *subA = A0;
21509bb5c669SPierre Jolivet                 sub   = subA;
21519bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatDestroy(&uaux));
21529bb5c669SPierre Jolivet               } else PetscCall(MatDestroy(&A0));
21539bb5c669SPierre Jolivet               PetscCall(MatCreateShell(PETSC_COMM_SELF, P->rmap->n, n[1] - n[0], P->rmap->n, n[1] - n[0], h, &data->aux));
21549bb5c669SPierre Jolivet               PetscCall(MatCreateVecs(h->ksp->pc->pmat, &h->v, nullptr));
21559bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT, (void (*)(void))MatMult_Harmonic));
21569bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMultTranspose_Harmonic));
21579bb5c669SPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AB, nullptr, MatProduct_AB_Harmonic, nullptr, MATDENSE, MATDENSE));
21589bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_DESTROY, (void (*)(void))MatDestroy_Harmonic));
21599bb5c669SPierre Jolivet               PetscCall(MatDestroySubMatrices(1, &a));
21609bb5c669SPierre Jolivet             }
2161df21ef68SPierre Jolivet             if (overlap != 1 || !subdomains) {
2162df21ef68SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2163df21ef68SPierre Jolivet               if (ismatis) {
2164df21ef68SPierre Jolivet                 PetscCall(MatISGetLocalMat(C, &N));
2165df21ef68SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)N, MATSEQSBAIJ, &flg));
2166df21ef68SPierre Jolivet                 if (flg) PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2167df21ef68SPierre Jolivet                 PetscCall(MatISRestoreLocalMat(C, &N));
2168df21ef68SPierre Jolivet               }
2169df21ef68SPierre Jolivet             }
21709bb5c669SPierre Jolivet             if (uaux) {
21719bb5c669SPierre Jolivet               PetscCall(MatDestroy(&uaux));
21729bb5c669SPierre Jolivet               PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
21739bb5c669SPierre Jolivet             }
21749bb5c669SPierre Jolivet           }
217513044ca3SPierre Jolivet         }
2176f1580f4eSBarry Smith       } else {
2177f1580f4eSBarry Smith         PetscCall(MatCreateSubMatrices(uaux, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2178f1580f4eSBarry Smith         PetscCall(MatDestroy(&uaux));
2179f1580f4eSBarry Smith         PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2180f1580f4eSBarry Smith       }
2181f1580f4eSBarry Smith       /* Vec holding the partition of unity */
2182f1580f4eSBarry Smith       if (!data->levels[0]->D) {
2183f1580f4eSBarry Smith         PetscCall(ISGetLocalSize(data->is, &n));
2184f1580f4eSBarry Smith         PetscCall(VecCreateMPI(PETSC_COMM_SELF, n, PETSC_DETERMINE, &data->levels[0]->D));
2185f1580f4eSBarry Smith       }
21869bb5c669SPierre Jolivet       if (data->share && overlap == -1) {
2187f1580f4eSBarry Smith         Mat      D;
2188db4a47b3SPierre Jolivet         IS       perm = nullptr;
2189f1580f4eSBarry Smith         PetscInt size = -1;
2190398c7888SPierre Jolivet         if (!data->levels[0]->pc) {
2191398c7888SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2192398c7888SPierre Jolivet           PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
2193398c7888SPierre Jolivet           PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
2194398c7888SPierre Jolivet           PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
2195398c7888SPierre Jolivet         }
2196398c7888SPierre Jolivet         PetscCall(PCSetType(data->levels[0]->pc, PCASM));
219713044ca3SPierre Jolivet         if (!ctx) {
2198398c7888SPierre Jolivet           if (!data->levels[0]->pc->setupcalled) {
2199398c7888SPierre Jolivet             IS sorted; /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2200398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2201398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &sorted, &loc));
2202398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2203398c7888SPierre Jolivet           }
2204398c7888SPierre Jolivet           PetscCall(PCSetFromOptions(data->levels[0]->pc));
2205398c7888SPierre Jolivet           if (block) {
2206398c7888SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, sub[0], &C, &perm));
2207398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, C, algebraic));
2208398c7888SPierre Jolivet           } else PetscCall(PCSetUp(data->levels[0]->pc));
2209db4a47b3SPierre Jolivet           PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &size, nullptr, &ksp));
2210398c7888SPierre Jolivet           if (size != 1) {
2211398c7888SPierre Jolivet             data->share = PETSC_FALSE;
2212398c7888SPierre Jolivet             PetscCheck(size == -1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", size);
2213398c7888SPierre Jolivet             PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since PCASMGetSubKSP() not found in fine-level PC\n"));
2214398c7888SPierre Jolivet             PetscCall(ISDestroy(&unsorted));
2215398c7888SPierre Jolivet             unsorted = is[0];
2216398c7888SPierre Jolivet           } else {
221713044ca3SPierre Jolivet             if (!block && !ctx) PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, PetscBool3ToBool(data->Neumann) ? sub[0] : data->aux, &C, &perm));
2218c8ea6600SPierre Jolivet             if (!PetscBool3ToBool(data->Neumann) && !block) {
2219f1580f4eSBarry Smith               PetscCall(MatPermute(sub[0], perm, perm, &D)); /* permute since PCASM will call ISSort() */
2220f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(sub[0], &D));
2221f1580f4eSBarry Smith             }
2222f1580f4eSBarry Smith             if (data->B) { /* see PCHPDDMSetRHSMat() */
2223f1580f4eSBarry Smith               PetscCall(MatPermute(data->B, perm, perm, &D));
2224f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(data->B, &D));
2225f1580f4eSBarry Smith             }
2226f1580f4eSBarry Smith             PetscCall(ISDestroy(&perm));
2227f1580f4eSBarry Smith             const char *matpre;
2228f1580f4eSBarry Smith             PetscBool   cmp[4];
2229f1580f4eSBarry Smith             PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
2230*0307214fSPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)subA[0]));
2231f1580f4eSBarry Smith             PetscCall(MatDuplicate(subA[1], MAT_SHARE_NONZERO_PATTERN, &D));
2232f1580f4eSBarry Smith             PetscCall(MatGetOptionsPrefix(subA[1], &matpre));
2233f1580f4eSBarry Smith             PetscCall(MatSetOptionsPrefix(D, matpre));
2234f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMAL, cmp));
2235f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMAL, cmp + 1));
2236f1580f4eSBarry Smith             if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMALHERMITIAN, cmp + 2));
2237f1580f4eSBarry Smith             else cmp[2] = PETSC_FALSE;
2238f1580f4eSBarry Smith             if (!cmp[1]) PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMALHERMITIAN, cmp + 3));
2239f1580f4eSBarry Smith             else cmp[3] = PETSC_FALSE;
2240f1580f4eSBarry 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);
2241f1580f4eSBarry Smith             if (!cmp[0] && !cmp[2]) {
2242f1580f4eSBarry Smith               if (!block) PetscCall(MatAXPY(D, 1.0, C, SUBSET_NONZERO_PATTERN));
22435c7345deSPierre Jolivet               else {
2244db4a47b3SPierre Jolivet                 PetscCall(MatMissingDiagonal(D, cmp, nullptr));
22455c7345deSPierre Jolivet                 if (cmp[0]) structure = DIFFERENT_NONZERO_PATTERN; /* data->aux has no missing diagonal entry */
22465c7345deSPierre Jolivet                 PetscCall(MatAXPY(D, 1.0, data->aux, structure));
22475c7345deSPierre Jolivet               }
2248f1580f4eSBarry Smith             } else {
2249f1580f4eSBarry Smith               Mat mat[2];
2250f1580f4eSBarry Smith               if (cmp[0]) {
2251f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(D, mat));
2252f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(C, mat + 1));
2253f1580f4eSBarry Smith               } else {
2254f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(D, mat));
2255f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(C, mat + 1));
2256f1580f4eSBarry Smith               }
2257f1580f4eSBarry Smith               PetscCall(MatAXPY(mat[0], 1.0, mat[1], SUBSET_NONZERO_PATTERN));
2258f1580f4eSBarry Smith             }
2259f1580f4eSBarry Smith             PetscCall(MatPropagateSymmetryOptions(C, D));
2260f1580f4eSBarry Smith             PetscCall(MatDestroy(&C));
2261f1580f4eSBarry Smith             C = D;
2262f1580f4eSBarry Smith             /* swap pointers so that variables stay consistent throughout PCSetUp() */
2263f1580f4eSBarry Smith             std::swap(C, data->aux);
2264f1580f4eSBarry Smith             std::swap(uis, data->is);
2265f1580f4eSBarry Smith             swap = PETSC_TRUE;
2266f1580f4eSBarry Smith           }
2267f1580f4eSBarry Smith         }
226813044ca3SPierre Jolivet       }
226913044ca3SPierre Jolivet       if (ctx) {
227013044ca3SPierre Jolivet         PC_HPDDM              *data_00 = (PC_HPDDM *)std::get<0>(*ctx)[0]->data;
227113044ca3SPierre Jolivet         PC                     s;
227200b491fbSPierre Jolivet         Mat                    A00, P00, A01 = nullptr, A10, A11, N, b[4];
227313044ca3SPierre Jolivet         IS                     sorted, is[2];
227413044ca3SPierre Jolivet         MatSolverType          type;
227513044ca3SPierre Jolivet         std::pair<PC, Vec[2]> *p;
227613044ca3SPierre Jolivet 
227713044ca3SPierre Jolivet         PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, data->aux, &C, nullptr)); /* permute since PCASM works with a sorted IS */
227813044ca3SPierre Jolivet         std::swap(C, data->aux);
227913044ca3SPierre Jolivet         std::swap(uis, data->is);
228013044ca3SPierre Jolivet         swap = PETSC_TRUE;
228113044ca3SPierre Jolivet         PetscCall(PCASMSetType(data->levels[0]->pc, PC_ASM_NONE)); /* "Neumann--Neumann" preconditioning with overlap and a Boolean partition of unity */
228213044ca3SPierre Jolivet         PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &data->is, &loc));
228313044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(data->levels[0]->pc)); /* action of eq. (15) of https://hal.science/hal-02343808v6/document (with a sign flip) */
228413044ca3SPierre Jolivet         PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, std::get<1>(*ctx), &A10, &A11));
228513044ca3SPierre Jolivet         std::get<1>(*ctx)[1] = A10;
228613044ca3SPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
228713044ca3SPierre Jolivet         if (flg) PetscCall(MatTransposeGetMat(A10, &A01));
228813044ca3SPierre Jolivet         else {
228913044ca3SPierre Jolivet           PetscBool flg;
229013044ca3SPierre Jolivet 
229113044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
229213044ca3SPierre Jolivet           if (flg) PetscCall(MatHermitianTransposeGetMat(A10, &A01));
229313044ca3SPierre Jolivet         }
229413044ca3SPierre Jolivet         PetscCall(ISDuplicate(data_00->is, &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 */
229513044ca3SPierre Jolivet         PetscCall(ISSort(sorted));                    /* this is to avoid changing users inputs, but it requires a new call to ISSort() here                                                                                               */
229600b491fbSPierre Jolivet         if (!A01) {
229700b491fbSPierre Jolivet           PetscCall(MatSetOption(A10, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
229800b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A10, 1, &data->is, &sorted, MAT_INITIAL_MATRIX, &sub));
229900b491fbSPierre Jolivet           b[2] = sub[0];
230000b491fbSPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
230100b491fbSPierre Jolivet           PetscCall(MatDestroySubMatrices(1, &sub));
230200b491fbSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATTRANSPOSEVIRTUAL, &flg));
230300b491fbSPierre Jolivet           A10 = nullptr;
230400b491fbSPierre Jolivet           if (flg) PetscCall(MatTransposeGetMat(std::get<1>(*ctx)[0], &A10));
230513044ca3SPierre Jolivet           else {
230600b491fbSPierre Jolivet             PetscBool flg;
230700b491fbSPierre Jolivet 
230800b491fbSPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)(PetscObject)std::get<1>(*ctx)[0], MATHERMITIANTRANSPOSEVIRTUAL, &flg));
230900b491fbSPierre Jolivet             if (flg) PetscCall(MatHermitianTransposeGetMat(std::get<1>(*ctx)[0], &A10));
231013044ca3SPierre Jolivet           }
231100b491fbSPierre Jolivet           if (!A10) {
231200b491fbSPierre Jolivet             PetscCall(MatCreateSubMatrices(std::get<1>(*ctx)[0], 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
231300b491fbSPierre Jolivet             b[1] = sub[0];
231400b491fbSPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)sub[0]));
231500b491fbSPierre Jolivet           }
231600b491fbSPierre Jolivet         } else {
231700b491fbSPierre Jolivet           PetscCall(MatSetOption(A01, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
231800b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A01, 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
231900b491fbSPierre Jolivet           if (flg) PetscCall(MatTranspose(*sub, MAT_INITIAL_MATRIX, b + 2));
232000b491fbSPierre Jolivet           else PetscCall(MatHermitianTranspose(*sub, MAT_INITIAL_MATRIX, b + 2));
232100b491fbSPierre Jolivet         }
232200b491fbSPierre Jolivet         PetscCall(MatDestroySubMatrices(1, &sub));
232313044ca3SPierre Jolivet         PetscCall(ISDestroy(&sorted));
232413044ca3SPierre Jolivet         n = -1;
232513044ca3SPierre Jolivet         PetscTryMethod(data_00->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data_00->levels[0]->pc, &n, nullptr, &ksp));
232613044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
232713044ca3SPierre Jolivet         PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
232813044ca3SPierre Jolivet         PetscCall(ISGetLocalSize(data_00->is, &n));
232913044ca3SPierre 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);
233000b491fbSPierre Jolivet         if (A01 || A10) {
233100b491fbSPierre Jolivet           if (flg) PetscCall(MatTranspose(b[2], MAT_INITIAL_MATRIX, b + 1));
233200b491fbSPierre Jolivet           else PetscCall(MatHermitianTranspose(b[2], MAT_INITIAL_MATRIX, b + 1));
233300b491fbSPierre Jolivet         }
233400b491fbSPierre Jolivet         PetscCall(MatCreateSchurComplement(subA[0], subA[1], b[1], b[2], data->aux, &S));
233513044ca3SPierre Jolivet         PetscCall(MatSchurComplementSetKSP(S, ksp[0]));
233613044ca3SPierre 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 */
233713044ca3SPierre Jolivet         PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
233813044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
233913044ca3SPierre Jolivet         PetscCall(KSPGetPC(ksp[0], &inner));
234013044ca3SPierre Jolivet         PetscCall(PCSetType(inner, PCSHELL)); /* compute the action of the inverse of the local Schur complement with a PCSHELL */
234113044ca3SPierre Jolivet         b[0] = subA[0];
234213044ca3SPierre Jolivet         b[3] = data->aux;
234313044ca3SPierre 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 */
234400b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[1]));
234500b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[2]));
234613044ca3SPierre Jolivet         PetscCall(PCCreate(PETSC_COMM_SELF, &s));
234713044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(s, ((PetscObject)inner)->prefix));
234813044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(inner, nullptr));
234913044ca3SPierre Jolivet         PetscCall(KSPSetSkipPCSetFromOptions(ksp[0], PETSC_TRUE));
235013044ca3SPierre Jolivet         PetscCall(PCSetType(s, PCLU));
235113044ca3SPierre Jolivet         if (PetscDefined(HAVE_MUMPS)) { /* only MATSOLVERMUMPS handles MATNEST, so for the others, e.g., MATSOLVERPETSC or MATSOLVERMKL_PARDISO, convert to plain MATAIJ */
235213044ca3SPierre Jolivet           PetscCall(PCFactorSetMatSolverType(s, MATSOLVERMUMPS));
235313044ca3SPierre Jolivet         }
235413044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(s));
235513044ca3SPierre Jolivet         PetscCall(PCFactorGetMatSolverType(s, &type));
235613044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
235713044ca3SPierre Jolivet         if (flg) {
235813044ca3SPierre Jolivet           PetscCall(PCSetOperators(s, N, N));
235900b491fbSPierre Jolivet           PetscCall(PCFactorGetMatrix(s, b));
236000b491fbSPierre Jolivet           PetscCall(MatSetOptionsPrefix(*b, ((PetscObject)s)->prefix));
236124ddd604SPierre Jolivet           n = -1;
236224ddd604SPierre Jolivet           PetscCall(PetscOptionsGetInt(nullptr, ((PetscObject)s)->prefix, "-mat_mumps_icntl_26", &n, nullptr));
2363f45b553cSPierre Jolivet           if (n == 1) {                                /* allocates a square MatDense of size is[1]->map->n, so one */
2364f45b553cSPierre Jolivet             PetscCall(MatNestGetISs(N, is, nullptr));  /*  needs to be able to deactivate this path when dealing    */
2365f45b553cSPierre Jolivet             PetscCall(MatFactorSetSchurIS(*b, is[1])); /*  with a large constraint space in order to avoid OOM      */
2366f45b553cSPierre Jolivet           }
236713044ca3SPierre Jolivet         } else {
236800b491fbSPierre Jolivet           PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, b));
236900b491fbSPierre Jolivet           PetscCall(PCSetOperators(s, N, *b));
237000b491fbSPierre Jolivet           PetscCall(PetscObjectDereference((PetscObject)*b));
237100b491fbSPierre 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 */
237213044ca3SPierre Jolivet         }
237313044ca3SPierre Jolivet         PetscCall(PetscNew(&p));
237413044ca3SPierre Jolivet         p->first = s;
237500b491fbSPierre Jolivet         PetscCall(MatCreateVecs(*b, p->second, p->second + 1));
237613044ca3SPierre Jolivet         PetscCall(PCShellSetContext(inner, p));
237713044ca3SPierre Jolivet         PetscCall(PCShellSetApply(inner, PCApply_Nest));
237813044ca3SPierre Jolivet         PetscCall(PCShellSetView(inner, PCView_Nest));
237913044ca3SPierre Jolivet         PetscCall(PCShellSetDestroy(inner, PCDestroy_Nest));
238013044ca3SPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)N));
238113044ca3SPierre Jolivet       }
2382f1580f4eSBarry Smith       if (!data->levels[0]->scatter) {
2383db4a47b3SPierre Jolivet         PetscCall(MatCreateVecs(P, &xin, nullptr));
2384f1580f4eSBarry Smith         if (ismatis) PetscCall(MatDestroy(&P));
2385db4a47b3SPierre Jolivet         PetscCall(VecScatterCreate(xin, data->is, data->levels[0]->D, nullptr, &data->levels[0]->scatter));
2386f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
2387f1580f4eSBarry Smith       }
2388f1580f4eSBarry Smith       if (data->levels[0]->P) {
2389f1580f4eSBarry Smith         /* if the pattern is the same and PCSetUp() has previously succeeded, reuse HPDDM buffers and connectivity */
2390f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[0], pc->setupcalled < 1 || pc->flag == DIFFERENT_NONZERO_PATTERN ? PETSC_TRUE : PETSC_FALSE));
2391f1580f4eSBarry Smith       }
2392f1580f4eSBarry Smith       if (!data->levels[0]->P) data->levels[0]->P = new HPDDM::Schwarz<PetscScalar>();
2393db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2394db4a47b3SPierre Jolivet       else PetscCall(PetscLogEventBegin(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2395f1580f4eSBarry Smith       /* HPDDM internal data structure */
239613044ca3SPierre Jolivet       PetscCall(data->levels[0]->P->structure(loc, data->is, !ctx ? sub[0] : nullptr, ismatis ? C : data->aux, data->levels));
2397db4a47b3SPierre Jolivet       if (!data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2398f1580f4eSBarry Smith       /* matrix pencil of the generalized eigenvalue problem on the overlap (GenEO) */
239913044ca3SPierre Jolivet       if (!ctx) {
24009bb5c669SPierre Jolivet         if (data->deflation || overlap != -1) weighted = data->aux;
2401f1580f4eSBarry Smith         else if (!data->B) {
2402e2b46ddfSPierre Jolivet           PetscBool cmp;
2403f1580f4eSBarry Smith           PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &weighted));
2404e2b46ddfSPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)weighted, &cmp, MATNORMAL, MATNORMALHERMITIAN, ""));
2405e2b46ddfSPierre Jolivet           if (cmp) flg = PETSC_FALSE;
2406e2b46ddfSPierre Jolivet           PetscCall(MatDiagonalScale(weighted, data->levels[0]->D, data->levels[0]->D));
24075b0bb9f2SPierre Jolivet           /* neither MatDuplicate() nor MatDiagonalScale() handles the symmetry options, so propagate the options explicitly */
2408f1580f4eSBarry Smith           /* only useful for -mat_type baij -pc_hpddm_levels_1_st_pc_type cholesky (no problem with MATAIJ or MATSBAIJ)      */
2409f1580f4eSBarry Smith           PetscCall(MatPropagateSymmetryOptions(sub[0], weighted));
2410f1580f4eSBarry Smith         } else weighted = data->B;
241113044ca3SPierre Jolivet       } else weighted = nullptr;
2412f1580f4eSBarry Smith       /* SLEPc is used inside the loaded symbol */
24139bb5c669SPierre 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));
24149bb5c669SPierre Jolivet       if (!ctx && data->share && overlap == -1) {
2415f1580f4eSBarry Smith         Mat st[2];
2416f1580f4eSBarry Smith         PetscCall(KSPGetOperators(ksp[0], st, st + 1));
24175c7345deSPierre Jolivet         PetscCall(MatCopy(subA[0], st[0], structure));
2418f1580f4eSBarry Smith         if (subA[1] != subA[0] || st[1] != st[0]) PetscCall(MatCopy(subA[1], st[1], SAME_NONZERO_PATTERN));
2419*0307214fSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)subA[0]));
2420f1580f4eSBarry Smith       }
2421db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2422f1580f4eSBarry Smith       if (ismatis) PetscCall(MatISGetLocalMat(C, &N));
2423f1580f4eSBarry Smith       else N = data->aux;
242413044ca3SPierre Jolivet       if (!ctx) P = sub[0];
242513044ca3SPierre Jolivet       else P = S;
2426f1580f4eSBarry Smith       /* going through the grid hierarchy */
2427f1580f4eSBarry Smith       for (n = 1; n < data->N; ++n) {
2428db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2429f1580f4eSBarry Smith         /* method composed in the loaded symbol since there, SLEPc is used as well */
2430f1580f4eSBarry 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));
2431db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2432f1580f4eSBarry Smith       }
2433f1580f4eSBarry Smith       /* reset to NULL to avoid any faulty use */
2434db4a47b3SPierre Jolivet       PetscCall(PetscObjectComposeFunction((PetscObject)data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", nullptr));
2435db4a47b3SPierre Jolivet       if (!ismatis) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_C", nullptr));
2436f1580f4eSBarry Smith       else PetscCall(PetscObjectDereference((PetscObject)C)); /* matching PetscObjectReference() above */
2437f1580f4eSBarry Smith       for (n = 0; n < data->N - 1; ++n)
2438f1580f4eSBarry Smith         if (data->levels[n]->P) {
2439f1580f4eSBarry Smith           /* HPDDM internal work buffers */
2440f1580f4eSBarry Smith           data->levels[n]->P->setBuffer();
2441f1580f4eSBarry Smith           data->levels[n]->P->super::start();
2442f1580f4eSBarry Smith         }
24439bb5c669SPierre Jolivet       if (ismatis || !subdomains) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
2444db4a47b3SPierre Jolivet       if (ismatis) data->is = nullptr;
2445f1580f4eSBarry Smith       for (n = 0; n < data->N - 1 + (reused > 0); ++n) {
2446f1580f4eSBarry Smith         if (data->levels[n]->P) {
2447f1580f4eSBarry Smith           PC spc;
2448f1580f4eSBarry Smith 
2449f1580f4eSBarry Smith           /* force the PC to be PCSHELL to do the coarse grid corrections */
2450f1580f4eSBarry Smith           PetscCall(KSPSetSkipPCSetFromOptions(data->levels[n]->ksp, PETSC_TRUE));
2451f1580f4eSBarry Smith           PetscCall(KSPGetPC(data->levels[n]->ksp, &spc));
2452f1580f4eSBarry Smith           PetscCall(PCSetType(spc, PCSHELL));
2453f1580f4eSBarry Smith           PetscCall(PCShellSetContext(spc, data->levels[n]));
2454f1580f4eSBarry Smith           PetscCall(PCShellSetSetUp(spc, PCSetUp_HPDDMShell));
2455f1580f4eSBarry Smith           PetscCall(PCShellSetApply(spc, PCApply_HPDDMShell));
2456f1580f4eSBarry Smith           PetscCall(PCShellSetMatApply(spc, PCMatApply_HPDDMShell));
245713044ca3SPierre Jolivet           if (ctx && n == 0) {
245813044ca3SPierre Jolivet             Mat                               Amat, Pmat;
245913044ca3SPierre Jolivet             PetscInt                          m, M;
246001e3c840SPierre Jolivet             std::tuple<Mat, PetscSF, Vec[2]> *ctx;
246113044ca3SPierre Jolivet 
246213044ca3SPierre Jolivet             PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &Pmat));
246313044ca3SPierre Jolivet             PetscCall(MatGetLocalSize(Pmat, &m, nullptr));
246413044ca3SPierre Jolivet             PetscCall(MatGetSize(Pmat, &M, nullptr));
246513044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));
246613044ca3SPierre Jolivet             std::get<0>(*ctx) = S;
246713044ca3SPierre Jolivet             std::get<1>(*ctx) = data->levels[n]->scatter;
246813044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)data->levels[n]->ksp), m, m, M, M, ctx, &Amat));
246913044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT, (void (*)(void))MatMult_Schur<false>));
247013044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMult_Schur<true>));
247113044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_DESTROY, (void (*)(void))MatDestroy_Schur));
247213044ca3SPierre Jolivet             PetscCall(MatCreateVecs(S, std::get<2>(*ctx), std::get<2>(*ctx) + 1));
247313044ca3SPierre Jolivet             PetscCall(KSPSetOperators(data->levels[n]->ksp, Amat, Pmat));
247413044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)Amat));
247513044ca3SPierre Jolivet           }
2476f1580f4eSBarry Smith           PetscCall(PCShellSetDestroy(spc, PCDestroy_HPDDMShell));
2477f1580f4eSBarry Smith           if (!data->levels[n]->pc) PetscCall(PCCreate(PetscObjectComm((PetscObject)data->levels[n]->ksp), &data->levels[n]->pc));
2478f1580f4eSBarry Smith           if (n < reused) {
2479f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(spc, PETSC_TRUE));
2480f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
2481f1580f4eSBarry Smith           }
2482f1580f4eSBarry Smith           PetscCall(PCSetUp(spc));
2483f1580f4eSBarry Smith         }
2484f1580f4eSBarry Smith       }
248513044ca3SPierre Jolivet       if (ctx) PetscCall(MatDestroy(&S));
24869bb5c669SPierre Jolivet       if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", nullptr));
2487f1580f4eSBarry Smith     } else flg = reused ? PETSC_FALSE : PETSC_TRUE;
2488f1580f4eSBarry Smith     if (!ismatis && subdomains) {
2489f1580f4eSBarry Smith       if (flg) PetscCall(KSPGetPC(data->levels[0]->ksp, &inner));
2490f1580f4eSBarry Smith       else inner = data->levels[0]->pc;
2491f1580f4eSBarry Smith       if (inner) {
2492398c7888SPierre Jolivet         if (!inner->setupcalled) PetscCall(PCSetType(inner, PCASM));
2493398c7888SPierre Jolivet         PetscCall(PCSetFromOptions(inner));
2494398c7888SPierre Jolivet         PetscCall(PetscStrcmp(((PetscObject)inner)->type_name, PCASM, &flg));
2495398c7888SPierre Jolivet         if (flg) {
2496f1580f4eSBarry Smith           if (!inner->setupcalled) { /* evaluates to PETSC_FALSE when -pc_hpddm_block_splitting */
2497398c7888SPierre Jolivet             IS sorted;               /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2498398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2499398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(inner, 1, &sorted, &loc));
2500398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2501398c7888SPierre Jolivet           }
2502c8ea6600SPierre Jolivet           if (!PetscBool3ToBool(data->Neumann) && data->N > 1) { /* subdomain matrices are already created for the eigenproblem, reuse them for the fine-level PC */
2503db4a47b3SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(*is, nullptr, nullptr, sub[0], &P, nullptr));
2504398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(inner, P, algebraic));
2505398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)P));
2506f1580f4eSBarry Smith           }
2507f1580f4eSBarry Smith         }
2508f1580f4eSBarry Smith       }
25099bb5c669SPierre Jolivet       if (data->N > 1) {
25109bb5c669SPierre Jolivet         if (overlap != 1) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
25119bb5c669SPierre Jolivet         if (overlap == 1) PetscCall(MatDestroy(subA));
25129bb5c669SPierre Jolivet       }
2513f1580f4eSBarry Smith     }
2514f1580f4eSBarry Smith     PetscCall(ISDestroy(&loc));
2515f1580f4eSBarry Smith   } else data->N = 1 + reused; /* enforce this value to 1 + reused if there is no way to build another level */
2516f1580f4eSBarry Smith   if (requested != data->N + reused) {
2517f1580f4eSBarry 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,
2518f1580f4eSBarry Smith                         data->N, pcpre ? pcpre : ""));
2519f1580f4eSBarry 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));
2520f1580f4eSBarry Smith     /* cannot use PCDestroy_HPDDMShell() because PCSHELL not set for unassembled levels */
2521f1580f4eSBarry Smith     for (n = data->N - 1; n < requested - 1; ++n) {
2522f1580f4eSBarry Smith       if (data->levels[n]->P) {
2523f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[n], PETSC_TRUE));
2524f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(1, &data->levels[n]->v[0]));
2525f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(2, &data->levels[n]->v[1]));
2526f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V));
2527f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 1));
2528f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 2));
2529f1580f4eSBarry Smith         PetscCall(VecDestroy(&data->levels[n]->D));
253001e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&data->levels[n]->scatter));
2531f1580f4eSBarry Smith       }
2532f1580f4eSBarry Smith     }
2533f1580f4eSBarry Smith     if (reused) {
2534f1580f4eSBarry Smith       for (n = reused; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
2535f1580f4eSBarry Smith         PetscCall(KSPDestroy(&data->levels[n]->ksp));
2536f1580f4eSBarry Smith         PetscCall(PCDestroy(&data->levels[n]->pc));
2537f1580f4eSBarry Smith       }
2538f1580f4eSBarry Smith     }
2539f1580f4eSBarry 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,
2540f1580f4eSBarry Smith                data->N, reused, data->N, pcpre ? pcpre : "", pcpre ? pcpre : "", data->N);
2541f1580f4eSBarry Smith   }
2542f1580f4eSBarry Smith   /* these solvers are created after PCSetFromOptions() is called */
2543f1580f4eSBarry Smith   if (pc->setfromoptionscalled) {
2544f1580f4eSBarry Smith     for (n = 0; n < data->N; ++n) {
2545f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetFromOptions(data->levels[n]->ksp));
2546f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetFromOptions(data->levels[n]->pc));
2547f1580f4eSBarry Smith     }
2548f1580f4eSBarry Smith     pc->setfromoptionscalled = 0;
2549f1580f4eSBarry Smith   }
2550f1580f4eSBarry Smith   data->N += reused;
2551f1580f4eSBarry Smith   if (data->share && swap) {
2552f1580f4eSBarry Smith     /* swap back pointers so that variables follow the user-provided numbering */
2553f1580f4eSBarry Smith     std::swap(C, data->aux);
2554f1580f4eSBarry Smith     std::swap(uis, data->is);
2555f1580f4eSBarry Smith     PetscCall(MatDestroy(&C));
2556f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
2557f1580f4eSBarry Smith   }
2558398c7888SPierre Jolivet   if (algebraic) PetscCall(MatDestroy(&data->aux));
255938fb34a1SPierre Jolivet   if (unsorted && unsorted != is[0]) {
2560398c7888SPierre Jolivet     PetscCall(ISCopy(unsorted, data->is));
2561398c7888SPierre Jolivet     PetscCall(ISDestroy(&unsorted));
2562398c7888SPierre Jolivet   }
2563398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2564398c7888SPierre 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);
2565398c7888SPierre Jolivet   if (data->is) {
2566398c7888SPierre Jolivet     PetscCall(ISEqualUnsorted(data->is, dis, &flg));
2567398c7888SPierre Jolivet     PetscCall(ISDestroy(&dis));
2568398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input IS and output IS are not equal");
2569398c7888SPierre Jolivet   }
2570398c7888SPierre 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);
2571398c7888SPierre Jolivet   if (data->aux) {
2572398c7888SPierre Jolivet     PetscCall(MatMultEqual(data->aux, daux, 20, &flg));
2573398c7888SPierre Jolivet     PetscCall(MatDestroy(&daux));
2574398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input Mat and output Mat are not equal");
2575398c7888SPierre Jolivet   }
2576398c7888SPierre Jolivet #endif
25773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2578f1580f4eSBarry Smith }
2579f1580f4eSBarry Smith 
2580f1580f4eSBarry Smith /*@
2581f1580f4eSBarry Smith   PCHPDDMSetCoarseCorrectionType - Sets the coarse correction type.
2582f1580f4eSBarry Smith 
2583c3339decSBarry Smith   Collective
2584f1580f4eSBarry Smith 
2585f1580f4eSBarry Smith   Input Parameters:
2586f1580f4eSBarry Smith + pc   - preconditioner context
2587aa1539e9SPierre Jolivet - type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2588f1580f4eSBarry Smith 
2589f1580f4eSBarry Smith   Options Database Key:
2590aa1539e9SPierre Jolivet . -pc_hpddm_coarse_correction <deflated, additive, balanced, none> - type of coarse correction to apply
2591f1580f4eSBarry Smith 
2592f1580f4eSBarry Smith   Level: intermediate
2593f1580f4eSBarry Smith 
2594562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2595f1580f4eSBarry Smith @*/
2596d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType type)
2597d71ae5a4SJacob Faibussowitsch {
2598f1580f4eSBarry Smith   PetscFunctionBegin;
2599f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2600f1580f4eSBarry Smith   PetscValidLogicalCollectiveEnum(pc, type, 2);
2601f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMSetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType), (pc, type));
26023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2603f1580f4eSBarry Smith }
2604f1580f4eSBarry Smith 
2605f1580f4eSBarry Smith /*@
2606f1580f4eSBarry Smith   PCHPDDMGetCoarseCorrectionType - Gets the coarse correction type.
2607f1580f4eSBarry Smith 
2608f1580f4eSBarry Smith   Input Parameter:
2609f1580f4eSBarry Smith . pc - preconditioner context
2610f1580f4eSBarry Smith 
2611f1580f4eSBarry Smith   Output Parameter:
2612aa1539e9SPierre Jolivet . type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2613f1580f4eSBarry Smith 
2614f1580f4eSBarry Smith   Level: intermediate
2615f1580f4eSBarry Smith 
2616562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2617f1580f4eSBarry Smith @*/
2618d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType *type)
2619d71ae5a4SJacob Faibussowitsch {
2620f1580f4eSBarry Smith   PetscFunctionBegin;
2621f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2622f1580f4eSBarry Smith   if (type) {
26234f572ea9SToby Isaac     PetscAssertPointer(type, 2);
2624f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType *), (pc, type));
2625f1580f4eSBarry Smith   }
26263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2627f1580f4eSBarry Smith }
2628f1580f4eSBarry Smith 
2629d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType type)
2630d71ae5a4SJacob Faibussowitsch {
2631f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2632f1580f4eSBarry Smith 
2633f1580f4eSBarry Smith   PetscFunctionBegin;
2634f1580f4eSBarry Smith   data->correction = type;
26353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2636f1580f4eSBarry Smith }
2637f1580f4eSBarry Smith 
2638d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType *type)
2639d71ae5a4SJacob Faibussowitsch {
2640f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2641f1580f4eSBarry Smith 
2642f1580f4eSBarry Smith   PetscFunctionBegin;
2643f1580f4eSBarry Smith   *type = data->correction;
26443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2645f1580f4eSBarry Smith }
2646f1580f4eSBarry Smith 
2647f1580f4eSBarry Smith /*@
2648e31fc274SPierre Jolivet   PCHPDDMSetSTShareSubKSP - Sets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver should be shared.
2649e31fc274SPierre Jolivet 
2650e31fc274SPierre Jolivet   Input Parameters:
2651e31fc274SPierre Jolivet + pc    - preconditioner context
2652e31fc274SPierre Jolivet - share - whether the `KSP` should be shared or not
2653e31fc274SPierre Jolivet 
2654e31fc274SPierre Jolivet   Note:
2655e31fc274SPierre Jolivet   This is not the same as `PCSetReusePreconditioner()`. Given certain conditions (visible using -info), a symbolic factorization can be skipped
2656e31fc274SPierre Jolivet   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2657e31fc274SPierre Jolivet 
2658e31fc274SPierre Jolivet   Level: advanced
2659e31fc274SPierre Jolivet 
2660562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMGetSTShareSubKSP()`
2661e31fc274SPierre Jolivet @*/
2662e31fc274SPierre Jolivet PetscErrorCode PCHPDDMSetSTShareSubKSP(PC pc, PetscBool share)
2663e31fc274SPierre Jolivet {
2664e31fc274SPierre Jolivet   PetscFunctionBegin;
2665e31fc274SPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2666e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetSTShareSubKSP_C", (PC, PetscBool), (pc, share));
26673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2668e31fc274SPierre Jolivet }
2669e31fc274SPierre Jolivet 
2670e31fc274SPierre Jolivet /*@
2671f1580f4eSBarry Smith   PCHPDDMGetSTShareSubKSP - Gets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver is shared.
2672f1580f4eSBarry Smith 
2673f1580f4eSBarry Smith   Input Parameter:
2674f1580f4eSBarry Smith . pc - preconditioner context
2675f1580f4eSBarry Smith 
2676f1580f4eSBarry Smith   Output Parameter:
2677f1580f4eSBarry Smith . share - whether the `KSP` is shared or not
2678f1580f4eSBarry Smith 
2679f1580f4eSBarry Smith   Note:
2680f1580f4eSBarry 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
2681f1580f4eSBarry Smith   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2682f1580f4eSBarry Smith 
2683f1580f4eSBarry Smith   Level: advanced
2684f1580f4eSBarry Smith 
2685562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetSTShareSubKSP()`
2686f1580f4eSBarry Smith @*/
2687d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetSTShareSubKSP(PC pc, PetscBool *share)
2688d71ae5a4SJacob Faibussowitsch {
2689f1580f4eSBarry Smith   PetscFunctionBegin;
2690f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2691f1580f4eSBarry Smith   if (share) {
26924f572ea9SToby Isaac     PetscAssertPointer(share, 2);
2693f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetSTShareSubKSP_C", (PC, PetscBool *), (pc, share));
2694f1580f4eSBarry Smith   }
26953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2696f1580f4eSBarry Smith }
2697f1580f4eSBarry Smith 
2698e31fc274SPierre Jolivet static PetscErrorCode PCHPDDMSetSTShareSubKSP_HPDDM(PC pc, PetscBool share)
2699e31fc274SPierre Jolivet {
2700e31fc274SPierre Jolivet   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2701e31fc274SPierre Jolivet 
2702e31fc274SPierre Jolivet   PetscFunctionBegin;
2703e31fc274SPierre Jolivet   data->share = share;
27043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2705e31fc274SPierre Jolivet }
2706e31fc274SPierre Jolivet 
2707d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetSTShareSubKSP_HPDDM(PC pc, PetscBool *share)
2708d71ae5a4SJacob Faibussowitsch {
2709f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2710f1580f4eSBarry Smith 
2711f1580f4eSBarry Smith   PetscFunctionBegin;
2712f1580f4eSBarry Smith   *share = data->share;
27133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2714f1580f4eSBarry Smith }
2715f1580f4eSBarry Smith 
2716f1580f4eSBarry Smith /*@
2717f1580f4eSBarry Smith   PCHPDDMSetDeflationMat - Sets the deflation space used to assemble a coarser operator.
2718f1580f4eSBarry Smith 
2719f1580f4eSBarry Smith   Input Parameters:
2720f1580f4eSBarry Smith + pc - preconditioner context
2721f1580f4eSBarry Smith . is - index set of the local deflation matrix
2722f1580f4eSBarry Smith - U  - deflation sequential matrix stored as a `MATSEQDENSE`
2723f1580f4eSBarry Smith 
2724f1580f4eSBarry Smith   Level: advanced
2725f1580f4eSBarry Smith 
2726562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCDeflationSetSpace()`, `PCMGSetRestriction()`
2727f1580f4eSBarry Smith @*/
2728d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetDeflationMat(PC pc, IS is, Mat U)
2729d71ae5a4SJacob Faibussowitsch {
2730f1580f4eSBarry Smith   PetscFunctionBegin;
2731f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2732f1580f4eSBarry Smith   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
2733f1580f4eSBarry Smith   PetscValidHeaderSpecific(U, MAT_CLASSID, 3);
2734e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetDeflationMat_C", (PC, IS, Mat), (pc, is, U));
27353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2736f1580f4eSBarry Smith }
2737f1580f4eSBarry Smith 
2738d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetDeflationMat_HPDDM(PC pc, IS is, Mat U)
2739d71ae5a4SJacob Faibussowitsch {
2740f1580f4eSBarry Smith   PetscFunctionBegin;
2741f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, U, PETSC_TRUE));
27423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2743f1580f4eSBarry Smith }
2744f1580f4eSBarry Smith 
2745d71ae5a4SJacob Faibussowitsch PetscErrorCode HPDDMLoadDL_Private(PetscBool *found)
2746d71ae5a4SJacob Faibussowitsch {
2747605ad303SPierre Jolivet   PetscBool flg;
2748f1580f4eSBarry Smith   char      lib[PETSC_MAX_PATH_LEN], dlib[PETSC_MAX_PATH_LEN], dir[PETSC_MAX_PATH_LEN];
2749f1580f4eSBarry Smith 
2750f1580f4eSBarry Smith   PetscFunctionBegin;
27514f572ea9SToby Isaac   PetscAssertPointer(found, 1);
2752c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(dir, "${PETSC_LIB_DIR}", sizeof(dir)));
2753db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, nullptr, "-hpddm_dir", dir, sizeof(dir), nullptr));
2754f1580f4eSBarry Smith   PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2755f1580f4eSBarry Smith   PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2756605ad303SPierre Jolivet #if defined(SLEPC_LIB_DIR) /* this variable is passed during SLEPc ./configure when PETSc has not been configured   */
2757605ad303SPierre Jolivet   if (!*found) {           /* with --download-hpddm since slepcconf.h is not yet built (and thus can't be included) */
2758c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(dir, HPDDM_STR(SLEPC_LIB_DIR), sizeof(dir)));
2759f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2760f1580f4eSBarry Smith     PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2761f1580f4eSBarry Smith   }
2762f1580f4eSBarry Smith #endif
2763605ad303SPierre 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 */
2764605ad303SPierre Jolivet     PetscCall(PetscOptionsGetenv(PETSC_COMM_SELF, "SLEPC_DIR", dir, sizeof(dir), &flg));
2765605ad303SPierre 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 */
2766605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libslepc", dir));
2767605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2768605ad303SPierre Jolivet       PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found but SLEPC_DIR=%s", lib, dir);
2769605ad303SPierre Jolivet       PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
2770605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libhpddm_petsc", dir)); /* libhpddm_petsc is always in the same directory as libslepc */
2771605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2772605ad303SPierre Jolivet     }
2773605ad303SPierre Jolivet   }
2774f1580f4eSBarry Smith   PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found", lib);
2775f1580f4eSBarry Smith   PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
27763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2777f1580f4eSBarry Smith }
2778f1580f4eSBarry Smith 
2779f1580f4eSBarry Smith /*MC
2780f1580f4eSBarry Smith    PCHPDDM - Interface with the HPDDM library.
2781f1580f4eSBarry Smith 
27821d27aa22SBarry Smith    This `PC` may be used to build multilevel spectral domain decomposition methods based on the GenEO framework {cite}`spillane2011robust` {cite}`al2021multilevel`.
27831d27aa22SBarry Smith    It may be viewed as an alternative to spectral
27841d27aa22SBarry Smith    AMGe or `PCBDDC` with adaptive selection of constraints. The interface is explained in details in {cite}`jolivetromanzampini2020`
2785f1580f4eSBarry Smith 
2786e7593814SPierre 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`).
2787f1580f4eSBarry Smith 
2788f1580f4eSBarry Smith    For multilevel preconditioning, when using an assembled or hierarchical Pmat, one must provide an auxiliary local `Mat` (unassembled local operator for GenEO) using
2789f1580f4eSBarry Smith    `PCHPDDMSetAuxiliaryMat()`. Calling this routine is not needed when using a `MATIS` Pmat, assembly is done internally using `MatConvert()`.
2790f1580f4eSBarry Smith 
2791f1580f4eSBarry Smith    Options Database Keys:
2792f1580f4eSBarry Smith +   -pc_hpddm_define_subdomains <true, default=false>    - on the finest level, calls `PCASMSetLocalSubdomains()` with the `IS` supplied in `PCHPDDMSetAuxiliaryMat()`
2793f1580f4eSBarry Smith                                                          (not relevant with an unassembled Pmat)
2794f1580f4eSBarry Smith .   -pc_hpddm_has_neumann <true, default=false>          - on the finest level, informs the `PC` that the local Neumann matrix is supplied in `PCHPDDMSetAuxiliaryMat()`
2795f1580f4eSBarry Smith -   -pc_hpddm_coarse_correction <type, default=deflated> - determines the `PCHPDDMCoarseCorrectionType` when calling `PCApply()`
2796f1580f4eSBarry Smith 
279738bf2a8cSPierre Jolivet    Options for subdomain solvers, subdomain eigensolvers (for computing deflation vectors), and the coarse solver can be set using the following options database prefixes.
2798f1580f4eSBarry Smith .vb
2799f1580f4eSBarry Smith       -pc_hpddm_levels_%d_pc_
2800f1580f4eSBarry Smith       -pc_hpddm_levels_%d_ksp_
2801f1580f4eSBarry Smith       -pc_hpddm_levels_%d_eps_
2802f1580f4eSBarry Smith       -pc_hpddm_levels_%d_p
28034ec2a359SPierre Jolivet       -pc_hpddm_levels_%d_mat_type
2804f1580f4eSBarry Smith       -pc_hpddm_coarse_
2805f1580f4eSBarry Smith       -pc_hpddm_coarse_p
28064ec2a359SPierre Jolivet       -pc_hpddm_coarse_mat_type
28072ce66baaSPierre Jolivet       -pc_hpddm_coarse_mat_filter
2808f1580f4eSBarry Smith .ve
2809f1580f4eSBarry Smith 
281038bf2a8cSPierre 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
2811f1580f4eSBarry Smith     -pc_hpddm_coarse_p 2 -pc_hpddm_coarse_mat_type baij will use 10 deflation vectors per subdomain on the fine "level 1",
2812f1580f4eSBarry Smith     aggregate the fine subdomains into 4 "level 2" subdomains, then use 10 deflation vectors per subdomain on "level 2",
28137eb095acSPierre Jolivet     and assemble the coarse matrix (of dimension 4 x 10 = 40) on two processes as a `MATBAIJ` (default is `MATSBAIJ`).
2814f1580f4eSBarry Smith 
2815f1580f4eSBarry 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.
2816f1580f4eSBarry Smith 
28171d27aa22SBarry Smith    Level: intermediate
28181d27aa22SBarry Smith 
28191d27aa22SBarry Smith    Notes:
28201d27aa22SBarry Smith    This preconditioner requires that PETSc is built with SLEPc (``--download-slepc``).
28211d27aa22SBarry Smith 
28221d27aa22SBarry Smith    By default, the underlying concurrent eigenproblems
28231d27aa22SBarry Smith    are solved using SLEPc shift-and-invert spectral transformation. This is usually what gives the best performance for GenEO, cf.
28241d27aa22SBarry Smith    {cite}`spillane2011robust` {cite}`jolivet2013scalabledd`. As
282538bf2a8cSPierre 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
282638bf2a8cSPierre 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
282738bf2a8cSPierre Jolivet    SLEPc documentation since they are specific to `PCHPDDM`.
282838bf2a8cSPierre Jolivet .vb
282938bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_st_share_sub_ksp
283038bf2a8cSPierre Jolivet       -pc_hpddm_levels_%d_eps_threshold
283138bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_eps_use_inertia
283238bf2a8cSPierre Jolivet .ve
283338bf2a8cSPierre Jolivet 
283438bf2a8cSPierre Jolivet    The first option from the list only applies to the fine-level eigensolver, see `PCHPDDMSetSTShareSubKSP()`. The second option from the list is
283538bf2a8cSPierre Jolivet    used to filter eigenmodes retrieved after convergence of `EPSSolve()` at "level N" such that eigenvectors used to define a "level N+1" coarse
283638bf2a8cSPierre 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
283738bf2a8cSPierre 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
283838bf2a8cSPierre 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
283938bf2a8cSPierre Jolivet    to supply -pc_hpddm_levels_1_eps_nev. This last option also only applies to the fine-level (N = 1) eigensolver.
2840f1580f4eSBarry Smith 
28411d27aa22SBarry Smith    See also {cite}`dolean2015introduction`, {cite}`al2022robust`, {cite}`al2022robustpd`, and {cite}`nataf2022recent`
2842f1580f4eSBarry Smith 
2843562efe2eSBarry Smith .seealso: [](ch_ksp), `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetAuxiliaryMat()`, `MATIS`, `PCBDDC`, `PCDEFLATION`, `PCTELESCOPE`, `PCASM`,
2844e31fc274SPierre Jolivet           `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDMHasNeumannMat()`, `PCHPDDMSetRHSMat()`, `PCHPDDMSetDeflationMat()`, `PCHPDDMSetSTShareSubKSP()`,
2845e31fc274SPierre Jolivet           `PCHPDDMGetSTShareSubKSP()`, `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDMGetComplexities()`
2846f1580f4eSBarry Smith M*/
2847d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_HPDDM(PC pc)
2848d71ae5a4SJacob Faibussowitsch {
2849f1580f4eSBarry Smith   PC_HPDDM *data;
2850f1580f4eSBarry Smith   PetscBool found;
2851f1580f4eSBarry Smith 
2852f1580f4eSBarry Smith   PetscFunctionBegin;
2853f1580f4eSBarry Smith   if (!loadedSym) {
2854f1580f4eSBarry Smith     PetscCall(HPDDMLoadDL_Private(&found));
2855db4a47b3SPierre Jolivet     if (found) PetscCall(PetscDLLibrarySym(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, nullptr, "PCHPDDM_Internal", (void **)&loadedSym));
2856f1580f4eSBarry Smith   }
2857f1580f4eSBarry Smith   PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCHPDDM_Internal symbol not found in loaded libhpddm_petsc");
28584dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&data));
2859f1580f4eSBarry Smith   pc->data                = data;
2860c8ea6600SPierre Jolivet   data->Neumann           = PETSC_BOOL3_UNKNOWN;
2861f1580f4eSBarry Smith   pc->ops->reset          = PCReset_HPDDM;
2862f1580f4eSBarry Smith   pc->ops->destroy        = PCDestroy_HPDDM;
2863f1580f4eSBarry Smith   pc->ops->setfromoptions = PCSetFromOptions_HPDDM;
2864f1580f4eSBarry Smith   pc->ops->setup          = PCSetUp_HPDDM;
2865f1580f4eSBarry Smith   pc->ops->apply          = PCApply_HPDDM;
2866f1580f4eSBarry Smith   pc->ops->matapply       = PCMatApply_HPDDM;
2867f1580f4eSBarry Smith   pc->ops->view           = PCView_HPDDM;
2868f1580f4eSBarry Smith   pc->ops->presolve       = PCPreSolve_HPDDM;
2869f1580f4eSBarry Smith 
2870f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", PCHPDDMSetAuxiliaryMat_HPDDM));
2871f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", PCHPDDMHasNeumannMat_HPDDM));
2872f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", PCHPDDMSetRHSMat_HPDDM));
2873f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", PCHPDDMSetCoarseCorrectionType_HPDDM));
2874f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", PCHPDDMGetCoarseCorrectionType_HPDDM));
2875e31fc274SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", PCHPDDMSetSTShareSubKSP_HPDDM));
2876f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", PCHPDDMGetSTShareSubKSP_HPDDM));
2877f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", PCHPDDMSetDeflationMat_HPDDM));
28783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2879f1580f4eSBarry Smith }
2880f1580f4eSBarry Smith 
2881f1580f4eSBarry Smith /*@C
2882f1580f4eSBarry Smith   PCHPDDMInitializePackage - This function initializes everything in the `PCHPDDM` package. It is called from `PCInitializePackage()`.
2883f1580f4eSBarry Smith 
2884f1580f4eSBarry Smith   Level: developer
2885f1580f4eSBarry Smith 
2886562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscInitialize()`
2887f1580f4eSBarry Smith @*/
2888d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMInitializePackage(void)
2889d71ae5a4SJacob Faibussowitsch {
2890f1580f4eSBarry Smith   char     ename[32];
2891f1580f4eSBarry Smith   PetscInt i;
2892f1580f4eSBarry Smith 
2893f1580f4eSBarry Smith   PetscFunctionBegin;
28943ba16761SJacob Faibussowitsch   if (PCHPDDMPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
2895f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_TRUE;
2896f1580f4eSBarry Smith   PetscCall(PetscRegisterFinalize(PCHPDDMFinalizePackage));
2897f1580f4eSBarry Smith   /* general events registered once during package initialization */
2898f1580f4eSBarry Smith   /* some of these events are not triggered in libpetsc,          */
2899f1580f4eSBarry Smith   /* but rather directly in libhpddm_petsc,                       */
2900f1580f4eSBarry Smith   /* which is in charge of performing the following operations    */
2901f1580f4eSBarry Smith 
2902f1580f4eSBarry Smith   /* domain decomposition structure from Pmat sparsity pattern    */
2903f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMStrc", PC_CLASSID, &PC_HPDDM_Strc));
2904f1580f4eSBarry Smith   /* Galerkin product, redistribution, and setup (not triggered in libpetsc)                */
2905f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtAP", PC_CLASSID, &PC_HPDDM_PtAP));
2906f1580f4eSBarry Smith   /* Galerkin product with summation, redistribution, and setup (not triggered in libpetsc) */
2907f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtBP", PC_CLASSID, &PC_HPDDM_PtBP));
2908f1580f4eSBarry Smith   /* next level construction using PtAP and PtBP (not triggered in libpetsc)                */
2909f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMNext", PC_CLASSID, &PC_HPDDM_Next));
2910f1580f4eSBarry Smith   static_assert(PETSC_PCHPDDM_MAXLEVELS <= 9, "PETSC_PCHPDDM_MAXLEVELS value is too high");
2911f1580f4eSBarry Smith   for (i = 1; i < PETSC_PCHPDDM_MAXLEVELS; ++i) {
2912f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSetUp L%1" PetscInt_FMT, i));
2913f1580f4eSBarry Smith     /* events during a PCSetUp() at level #i _except_ the assembly */
2914f1580f4eSBarry Smith     /* of the Galerkin operator of the coarser level #(i + 1)      */
2915f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_SetUp[i - 1]));
2916f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSolve L%1" PetscInt_FMT, i));
2917f1580f4eSBarry Smith     /* events during a PCApply() at level #i _except_              */
2918f1580f4eSBarry Smith     /* the KSPSolve() of the coarser level #(i + 1)                */
2919f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_Solve[i - 1]));
2920f1580f4eSBarry Smith   }
29213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2922f1580f4eSBarry Smith }
2923f1580f4eSBarry Smith 
2924f1580f4eSBarry Smith /*@C
2925f1580f4eSBarry Smith   PCHPDDMFinalizePackage - This function frees everything from the `PCHPDDM` package. It is called from `PetscFinalize()`.
2926f1580f4eSBarry Smith 
2927f1580f4eSBarry Smith   Level: developer
2928f1580f4eSBarry Smith 
2929562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscFinalize()`
2930f1580f4eSBarry Smith @*/
2931d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMFinalizePackage(void)
2932d71ae5a4SJacob Faibussowitsch {
2933f1580f4eSBarry Smith   PetscFunctionBegin;
2934f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_FALSE;
29353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2936f1580f4eSBarry Smith }
29379bb5c669SPierre Jolivet 
29389bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat A, Vec x, Vec y)
29399bb5c669SPierre Jolivet {
29409bb5c669SPierre Jolivet   Harmonic h; /* [ A_00  A_01       ], furthermore, A_00 = [ A_loc,loc  A_loc,ovl ], thus, A_01 = [         ] */
29419bb5c669SPierre Jolivet               /* [ A_10  A_11  A_12 ]                      [ A_ovl,loc  A_ovl,ovl ]               [ A_ovl,1 ] */
29429bb5c669SPierre Jolivet   Vec sub;    /*  y = A x = R_loc R_0 [ A_00  A_01 ]^-1                                   R_loc = [  I_loc  ] */
29439bb5c669SPierre Jolivet               /*                      [ A_10  A_11 ]    R_1^T A_12 x                              [         ] */
29449bb5c669SPierre Jolivet   PetscFunctionBegin;
29459bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
29469bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
29479bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
29489bb5c669SPierre Jolivet   PetscCall(MatMult(h->A[0], x, sub));
29499bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
29509bb5c669SPierre Jolivet   PetscCall(KSPSolve(h->ksp, h->v, h->v));
29519bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_REVERSE, y));
29529bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
29539bb5c669SPierre Jolivet }
29549bb5c669SPierre Jolivet 
29559bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat A, Vec y, Vec x)
29569bb5c669SPierre Jolivet {
29579bb5c669SPierre Jolivet   Harmonic h;   /* x = A^T y =            [ A_00  A_01 ]^-T R_0^T R_loc^T y */
29589bb5c669SPierre Jolivet   Vec      sub; /*             A_12^T R_1 [ A_10  A_11 ]                    */
29599bb5c669SPierre Jolivet 
29609bb5c669SPierre Jolivet   PetscFunctionBegin;
29619bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
29629bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
29639bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_FORWARD, y));
29649bb5c669SPierre Jolivet   PetscCall(KSPSolveTranspose(h->ksp, h->v, h->v));
29659bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
29669bb5c669SPierre Jolivet   PetscCall(MatMultTranspose(h->A[0], sub, x));
29679bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
29689bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
29699bb5c669SPierre Jolivet }
29709bb5c669SPierre Jolivet 
29719bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat S, Mat X, Mat Y, void *)
29729bb5c669SPierre Jolivet {
29739bb5c669SPierre Jolivet   Harmonic h;
29749bb5c669SPierre Jolivet   Mat      A, B;
29759bb5c669SPierre Jolivet   Vec      a, b;
29769bb5c669SPierre Jolivet 
29779bb5c669SPierre Jolivet   PetscFunctionBegin;
29789bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
29799bb5c669SPierre Jolivet   PetscCall(MatMatMult(h->A[0], X, MAT_INITIAL_MATRIX, PETSC_DEFAULT, &A));
29809bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
29819bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
29829bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
29839bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B, i, &b));
29849bb5c669SPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_FORWARD, a));
29859bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B, i, &b));
29869bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
29879bb5c669SPierre Jolivet   }
29889bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
29899bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, B->cmap->n, nullptr, &A));
29909bb5c669SPierre Jolivet   PetscCall(KSPMatSolve(h->ksp, B, A));
29919bb5c669SPierre Jolivet   PetscCall(MatDestroy(&B));
29929bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
29939bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
29949bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &b));
29959bb5c669SPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_REVERSE, b));
29969bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &b));
29979bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
29989bb5c669SPierre Jolivet   }
29999bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
30009bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30019bb5c669SPierre Jolivet }
30029bb5c669SPierre Jolivet 
30039bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat A)
30049bb5c669SPierre Jolivet {
30059bb5c669SPierre Jolivet   Harmonic h;
30069bb5c669SPierre Jolivet 
30079bb5c669SPierre Jolivet   PetscFunctionBegin;
30089bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
30099bb5c669SPierre Jolivet   for (PetscInt i = 0; i < (h->A[1] ? 5 : 3); ++i) PetscCall(ISDestroy(h->is + i));
30109bb5c669SPierre Jolivet   PetscCall(PetscFree(h->is));
30119bb5c669SPierre Jolivet   PetscCall(VecDestroy(&h->v));
30129bb5c669SPierre Jolivet   for (PetscInt i = 0; i < 2; ++i) PetscCall(MatDestroy(h->A + i));
30139bb5c669SPierre Jolivet   PetscCall(PetscFree(h->A));
30149bb5c669SPierre Jolivet   PetscCall(KSPDestroy(&h->ksp));
30159bb5c669SPierre Jolivet   PetscCall(PetscFree(h));
30169bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30179bb5c669SPierre Jolivet }
3018