xref: /petsc/src/ksp/pc/impls/hpddm/pchpddm.cxx (revision 1d27aa22b2f6148b2c4e3f06a75e0638d6493e09)
113044ca3SPierre Jolivet #include <petsc/private/vecimpl.h>
2f1580f4eSBarry Smith #include <petsc/private/matimpl.h>
3f1580f4eSBarry Smith #include <petsc/private/petschpddm.h> /*I "petscpc.h" I*/
4e905f78bSJacob Faibussowitsch #include <petsc/private/pcimpl.h>
5e905f78bSJacob Faibussowitsch #include <petsc/private/dmimpl.h> /* this must be included after petschpddm.h so that DM_MAX_WORK_VECTORS is not defined  */
6f1580f4eSBarry Smith                                   /* otherwise, it is assumed that one is compiling libhpddm_petsc => circular dependency */
7fbf9dbe5SBarry Smith #if PetscDefined(USE_FORTRAN_BINDINGS)
8f1580f4eSBarry Smith   #include <petsc/private/fortranimpl.h>
9f1580f4eSBarry Smith #endif
10f1580f4eSBarry Smith 
11db4a47b3SPierre Jolivet static PetscErrorCode (*loadedSym)(HPDDM::Schwarz<PetscScalar> *const, IS, Mat, Mat, Mat, std::vector<Vec>, PC_HPDDM_Level **const) = nullptr;
12f1580f4eSBarry Smith 
13f1580f4eSBarry Smith static PetscBool PCHPDDMPackageInitialized = PETSC_FALSE;
14f1580f4eSBarry Smith 
15f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_Strc;
16f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_PtAP;
17f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_PtBP;
18f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_Next;
19f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_SetUp[PETSC_PCHPDDM_MAXLEVELS];
20f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_Solve[PETSC_PCHPDDM_MAXLEVELS];
21f1580f4eSBarry Smith 
22db4a47b3SPierre Jolivet const char *const PCHPDDMCoarseCorrectionTypes[] = {"DEFLATED", "ADDITIVE", "BALANCED", "PCHPDDMCoarseCorrectionType", "PC_HPDDM_COARSE_CORRECTION_", nullptr};
2313044ca3SPierre Jolivet const char *const PCHPDDMSchurPreTypes[]         = {"LEAST_SQUARES", "GENEO", "PCHPDDMSchurPreType", "PC_HPDDM_SCHUR_PRE", nullptr};
24f1580f4eSBarry Smith 
25d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_HPDDM(PC pc)
26d71ae5a4SJacob Faibussowitsch {
27f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
28f1580f4eSBarry Smith   PetscInt  i;
29f1580f4eSBarry Smith 
30f1580f4eSBarry Smith   PetscFunctionBegin;
31f1580f4eSBarry Smith   if (data->levels) {
32f1580f4eSBarry Smith     for (i = 0; i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]; ++i) {
33f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[i]->ksp));
34f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[i]->pc));
35f1580f4eSBarry Smith       PetscCall(PetscFree(data->levels[i]));
36f1580f4eSBarry Smith     }
37f1580f4eSBarry Smith     PetscCall(PetscFree(data->levels));
38f1580f4eSBarry Smith   }
39f1580f4eSBarry Smith 
40f1580f4eSBarry Smith   PetscCall(ISDestroy(&data->is));
41f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->aux));
42f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->B));
43f1580f4eSBarry Smith   PetscCall(VecDestroy(&data->normal));
44f1580f4eSBarry Smith   data->correction = PC_HPDDM_COARSE_CORRECTION_DEFLATED;
45c8ea6600SPierre Jolivet   data->Neumann    = PETSC_BOOL3_UNKNOWN;
46f1580f4eSBarry Smith   data->deflation  = PETSC_FALSE;
47db4a47b3SPierre Jolivet   data->setup      = nullptr;
48db4a47b3SPierre Jolivet   data->setup_ctx  = nullptr;
493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
50f1580f4eSBarry Smith }
51f1580f4eSBarry Smith 
52d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDM(PC pc)
53d71ae5a4SJacob Faibussowitsch {
54f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
55f1580f4eSBarry Smith 
56f1580f4eSBarry Smith   PetscFunctionBegin;
57f1580f4eSBarry Smith   PetscCall(PCReset_HPDDM(pc));
58f1580f4eSBarry Smith   PetscCall(PetscFree(data));
59db4a47b3SPierre Jolivet   PetscCall(PetscObjectChangeTypeName((PetscObject)pc, nullptr));
60db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", nullptr));
61db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", nullptr));
62db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", nullptr));
63db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", nullptr));
64db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", nullptr));
65db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", nullptr));
66db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", nullptr));
67db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", nullptr));
6813044ca3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc, "_PCHPDDM_Schur", nullptr));
693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
70f1580f4eSBarry Smith }
71f1580f4eSBarry Smith 
72d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMSetAuxiliaryMat_Private(PC pc, IS is, Mat A, PetscBool deflation)
73d71ae5a4SJacob Faibussowitsch {
74f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
75f1580f4eSBarry Smith 
76f1580f4eSBarry Smith   PetscFunctionBegin;
77f1580f4eSBarry Smith   if (is) {
78f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)is));
79f1580f4eSBarry Smith     if (data->is) { /* new overlap definition resets the PC */
80f1580f4eSBarry Smith       PetscCall(PCReset_HPDDM(pc));
81f1580f4eSBarry Smith       pc->setfromoptionscalled = 0;
82b853e353SPierre Jolivet       pc->setupcalled          = 0;
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) {
1393df4cd7bSPierre Jolivet         VecScatter 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));
1463df4cd7bSPierre Jolivet         PetscCall(VecScatterDestroy(&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 
276f1580f4eSBarry Smith   If a `DMCreateNeumannOverlap()` 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) {
3609bb5c669SPierre Jolivet       PetscCheck(overlap == -1 || PetscAbsReal(data->levels[i - 1]->threshold + 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 
45504c3f3b8SBarry Smith // PetscClangLinter pragma disable: -fdoc-internal-linkage
456f1580f4eSBarry Smith /*@C
457f1580f4eSBarry Smith      PCHPDDMGetComplexities - Computes the grid and operator complexities.
458f1580f4eSBarry Smith 
459f1580f4eSBarry Smith    Input Parameter:
460f1580f4eSBarry Smith .     pc - preconditioner context
461f1580f4eSBarry Smith 
462f1580f4eSBarry Smith    Output Parameters:
463f1580f4eSBarry Smith +     gc - grid complexity = sum_i(m_i) / m_1
464f1580f4eSBarry Smith -     oc - operator complexity = sum_i(nnz_i) / nnz_1
465f1580f4eSBarry Smith 
466f1580f4eSBarry Smith    Level: advanced
467f1580f4eSBarry Smith 
468562efe2eSBarry Smith .seealso: [](ch_ksp), `PCMGGetGridComplexity()`, `PCHPDDM`, `PCHYPRE`, `PCGAMG`
469f1580f4eSBarry Smith @*/
470d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetComplexities(PC pc, PetscReal *gc, PetscReal *oc)
471d71ae5a4SJacob Faibussowitsch {
472f1580f4eSBarry Smith   PC_HPDDM      *data = (PC_HPDDM *)pc->data;
473f1580f4eSBarry Smith   MatInfo        info;
474f1580f4eSBarry Smith   PetscInt       n, m;
475f1580f4eSBarry Smith   PetscLogDouble accumulate[2]{}, nnz1 = 1.0, m1 = 1.0;
476f1580f4eSBarry Smith 
477f1580f4eSBarry Smith   PetscFunctionBegin;
478f1580f4eSBarry Smith   for (n = 0, *gc = 0, *oc = 0; n < data->N; ++n) {
479f1580f4eSBarry Smith     if (data->levels[n]->ksp) {
48013044ca3SPierre Jolivet       Mat       P, A = nullptr;
48113044ca3SPierre Jolivet       PetscBool flg = PETSC_FALSE;
48213044ca3SPierre Jolivet 
483db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &P));
484db4a47b3SPierre Jolivet       PetscCall(MatGetSize(P, &m, nullptr));
485f1580f4eSBarry Smith       accumulate[0] += m;
486f1580f4eSBarry Smith       if (n == 0) {
487f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
488f1580f4eSBarry Smith         if (flg) {
489f1580f4eSBarry Smith           PetscCall(MatConvert(P, MATAIJ, MAT_INITIAL_MATRIX, &A));
490f1580f4eSBarry Smith           P = A;
49113044ca3SPierre Jolivet         } else {
49213044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
49313044ca3SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)P));
494f1580f4eSBarry Smith         }
49513044ca3SPierre Jolivet       }
49613044ca3SPierre Jolivet       if (!A && flg) accumulate[1] += m * m; /* assumption that a MATSCHURCOMPLEMENT is dense if stored explicitly */
49713044ca3SPierre Jolivet       else if (P->ops->getinfo) {
498f1580f4eSBarry Smith         PetscCall(MatGetInfo(P, MAT_GLOBAL_SUM, &info));
499f1580f4eSBarry Smith         accumulate[1] += info.nz_used;
500f1580f4eSBarry Smith       }
501f1580f4eSBarry Smith       if (n == 0) {
502f1580f4eSBarry Smith         m1 = m;
50313044ca3SPierre Jolivet         if (!A && flg) nnz1 = m * m;
50413044ca3SPierre Jolivet         else if (P->ops->getinfo) nnz1 = info.nz_used;
505f1580f4eSBarry Smith         PetscCall(MatDestroy(&P));
506f1580f4eSBarry Smith       }
507f1580f4eSBarry Smith     }
508f1580f4eSBarry Smith   }
509f1580f4eSBarry Smith   *gc = static_cast<PetscReal>(accumulate[0] / m1);
510f1580f4eSBarry Smith   *oc = static_cast<PetscReal>(accumulate[1] / nnz1);
5113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
512f1580f4eSBarry Smith }
513f1580f4eSBarry Smith 
514d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_HPDDM(PC pc, PetscViewer viewer)
515d71ae5a4SJacob Faibussowitsch {
516f1580f4eSBarry Smith   PC_HPDDM         *data = (PC_HPDDM *)pc->data;
517f1580f4eSBarry Smith   PetscViewer       subviewer;
518aa21023fSPierre Jolivet   PetscViewerFormat format;
519f1580f4eSBarry Smith   PetscSubcomm      subcomm;
520f1580f4eSBarry Smith   PetscReal         oc, gc;
521f1580f4eSBarry Smith   PetscInt          i, tabs;
522f1580f4eSBarry Smith   PetscMPIInt       size, color, rank;
523aa21023fSPierre Jolivet   PetscBool         flg;
524aa21023fSPierre Jolivet   const char       *name;
525f1580f4eSBarry Smith 
526f1580f4eSBarry Smith   PetscFunctionBegin;
527aa21023fSPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &flg));
528aa21023fSPierre Jolivet   if (flg) {
529f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "level%s: %" PetscInt_FMT "\n", data->N > 1 ? "s" : "", data->N));
530f1580f4eSBarry Smith     PetscCall(PCHPDDMGetComplexities(pc, &gc, &oc));
531f1580f4eSBarry Smith     if (data->N > 1) {
532f1580f4eSBarry Smith       if (!data->deflation) {
533c8ea6600SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "Neumann matrix attached? %s\n", PetscBools[PetscBool3ToBool(data->Neumann)]));
534f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, "shared subdomain KSP between SLEPc and PETSc? %s\n", PetscBools[data->share]));
535f1580f4eSBarry Smith       } else PetscCall(PetscViewerASCIIPrintf(viewer, "user-supplied deflation matrix\n"));
536f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "coarse correction: %s\n", PCHPDDMCoarseCorrectionTypes[data->correction]));
537f1580f4eSBarry 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" : ""));
538f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIGetTab(viewer, &tabs));
539f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, 0));
540f1580f4eSBarry Smith       for (i = 1; i < data->N; ++i) {
541f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, data->levels[i - 1]->nu));
5420594bca0SPierre Jolivet         if (data->levels[i - 1]->threshold > static_cast<PetscReal>(-0.1)) PetscCall(PetscViewerASCIIPrintf(viewer, " (%g)", (double)data->levels[i - 1]->threshold));
543f1580f4eSBarry Smith       }
544f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
545f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, tabs));
546f1580f4eSBarry Smith     }
547f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "grid and operator complexities: %g %g\n", (double)gc, (double)oc));
5481fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
5491fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank));
550f1580f4eSBarry Smith     if (data->levels[0]->ksp) {
551f1580f4eSBarry Smith       PetscCall(KSPView(data->levels[0]->ksp, viewer));
552f1580f4eSBarry Smith       if (data->levels[0]->pc) PetscCall(PCView(data->levels[0]->pc, viewer));
553f1580f4eSBarry Smith       for (i = 1; i < data->N; ++i) {
554f1580f4eSBarry Smith         if (data->levels[i]->ksp) color = 1;
555f1580f4eSBarry Smith         else color = 0;
556f1580f4eSBarry Smith         PetscCall(PetscSubcommCreate(PetscObjectComm((PetscObject)pc), &subcomm));
557f1580f4eSBarry Smith         PetscCall(PetscSubcommSetNumber(subcomm, PetscMin(size, 2)));
558f1580f4eSBarry Smith         PetscCall(PetscSubcommSetTypeGeneral(subcomm, color, rank));
559f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPushTab(viewer));
560f1580f4eSBarry Smith         PetscCall(PetscViewerGetSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
561f1580f4eSBarry Smith         if (color == 1) {
562f1580f4eSBarry Smith           PetscCall(KSPView(data->levels[i]->ksp, subviewer));
563f1580f4eSBarry Smith           if (data->levels[i]->pc) PetscCall(PCView(data->levels[i]->pc, subviewer));
564f1580f4eSBarry Smith           PetscCall(PetscViewerFlush(subviewer));
565f1580f4eSBarry Smith         }
566f1580f4eSBarry Smith         PetscCall(PetscViewerRestoreSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
567f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPopTab(viewer));
568f1580f4eSBarry Smith         PetscCall(PetscSubcommDestroy(&subcomm));
569f1580f4eSBarry Smith         PetscCall(PetscViewerFlush(viewer));
570f1580f4eSBarry Smith       }
571f1580f4eSBarry Smith     }
572aa21023fSPierre Jolivet     PetscCall(PetscViewerGetFormat(viewer, &format));
573aa21023fSPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
574aa21023fSPierre Jolivet       PetscCall(PetscViewerFileGetName(viewer, &name));
575aa21023fSPierre Jolivet       if (name) {
576aa21023fSPierre Jolivet         IS          is;
577aa21023fSPierre Jolivet         PetscInt    sizes[4] = {pc->mat->rmap->n, pc->mat->cmap->n, pc->mat->rmap->N, pc->mat->cmap->N};
578aa21023fSPierre Jolivet         char       *tmp;
579aa21023fSPierre Jolivet         std::string prefix, suffix;
580aa21023fSPierre Jolivet         size_t      pos;
581aa21023fSPierre Jolivet 
582aa21023fSPierre Jolivet         PetscCall(PetscStrstr(name, ".", &tmp));
583aa21023fSPierre Jolivet         if (tmp) {
584aa21023fSPierre Jolivet           pos    = std::distance(const_cast<char *>(name), tmp);
585aa21023fSPierre Jolivet           prefix = std::string(name, pos);
586aa21023fSPierre Jolivet           suffix = std::string(name + pos + 1);
587aa21023fSPierre Jolivet         } else prefix = name;
588aa21023fSPierre Jolivet         if (data->aux) {
589aa21023fSPierre 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));
590aa21023fSPierre Jolivet           PetscCall(MatView(data->aux, subviewer));
591aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
592aa21023fSPierre Jolivet         }
593aa21023fSPierre Jolivet         if (data->is) {
594aa21023fSPierre 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));
595aa21023fSPierre Jolivet           PetscCall(ISView(data->is, subviewer));
596aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
597aa21023fSPierre Jolivet         }
598aa21023fSPierre Jolivet         PetscCall(ISCreateGeneral(PETSC_COMM_SELF, PETSC_STATIC_ARRAY_LENGTH(sizes), sizes, PETSC_USE_POINTER, &is));
599aa21023fSPierre 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));
600aa21023fSPierre Jolivet         PetscCall(ISView(is, subviewer));
601aa21023fSPierre Jolivet         PetscCall(PetscViewerDestroy(&subviewer));
602aa21023fSPierre Jolivet         PetscCall(ISDestroy(&is));
603aa21023fSPierre Jolivet       }
604aa21023fSPierre Jolivet     }
605f1580f4eSBarry Smith   }
6063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
607f1580f4eSBarry Smith }
608f1580f4eSBarry Smith 
609d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCPreSolve_HPDDM(PC pc, KSP ksp, Vec, Vec)
610d71ae5a4SJacob Faibussowitsch {
611f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
612f1580f4eSBarry Smith   PetscBool flg;
613f1580f4eSBarry Smith   Mat       A;
614f1580f4eSBarry Smith 
615f1580f4eSBarry Smith   PetscFunctionBegin;
616f1580f4eSBarry Smith   if (ksp) {
617f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPLSQR, &flg));
618f1580f4eSBarry Smith     if (flg && !data->normal) {
619db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(ksp, &A, nullptr));
620db4a47b3SPierre Jolivet       PetscCall(MatCreateVecs(A, nullptr, &data->normal)); /* temporary Vec used in PCApply_HPDDMShell() for coarse grid corrections */
621f1580f4eSBarry Smith     }
622f1580f4eSBarry Smith   }
6233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
624f1580f4eSBarry Smith }
625f1580f4eSBarry Smith 
626d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDMShell(PC pc)
627d71ae5a4SJacob Faibussowitsch {
628f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
629f1580f4eSBarry Smith   Mat             A, P;
630f1580f4eSBarry Smith   Vec             x;
631f1580f4eSBarry Smith   const char     *pcpre;
632f1580f4eSBarry Smith 
633f1580f4eSBarry Smith   PetscFunctionBegin;
634f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
635f1580f4eSBarry Smith   PetscCall(KSPGetOptionsPrefix(ctx->ksp, &pcpre));
636f1580f4eSBarry Smith   PetscCall(KSPGetOperators(ctx->ksp, &A, &P));
637f1580f4eSBarry Smith   /* smoother */
638f1580f4eSBarry Smith   PetscCall(PCSetOptionsPrefix(ctx->pc, pcpre));
639f1580f4eSBarry Smith   PetscCall(PCSetOperators(ctx->pc, A, P));
640f1580f4eSBarry Smith   if (!ctx->v[0]) {
641f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(ctx->D, 1, &ctx->v[0]));
642f1580f4eSBarry Smith     if (!std::is_same<PetscScalar, PetscReal>::value) PetscCall(VecDestroy(&ctx->D));
643db4a47b3SPierre Jolivet     PetscCall(MatCreateVecs(A, &x, nullptr));
644f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(x, 2, &ctx->v[1]));
645f1580f4eSBarry Smith     PetscCall(VecDestroy(&x));
646f1580f4eSBarry Smith   }
647f1580f4eSBarry Smith   std::fill_n(ctx->V, 3, nullptr);
6483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
649f1580f4eSBarry Smith }
650f1580f4eSBarry Smith 
651f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
652d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type x, Type y)
653d71ae5a4SJacob Faibussowitsch {
654f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
655f1580f4eSBarry Smith   PetscScalar    *out;
656f1580f4eSBarry Smith 
657f1580f4eSBarry Smith   PetscFunctionBegin;
658f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
659f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
660f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
661f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
662f1580f4eSBarry Smith   PetscCall(VecGetArrayWrite(ctx->v[0][0], &out));
663db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, 1); /* y = Q x */
664f1580f4eSBarry Smith   PetscCall(VecRestoreArrayWrite(ctx->v[0][0], &out));
665f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
666f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
667f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
6683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
669f1580f4eSBarry Smith }
670f1580f4eSBarry Smith 
671f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
672d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type X, Type Y)
673d71ae5a4SJacob Faibussowitsch {
674f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
675f1580f4eSBarry Smith   Vec             vX, vY, vC;
676f1580f4eSBarry Smith   PetscScalar    *out;
677f1580f4eSBarry Smith   PetscInt        i, N;
678f1580f4eSBarry Smith 
679f1580f4eSBarry Smith   PetscFunctionBegin;
680f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
681db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
682f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
683f1580f4eSBarry Smith   for (i = 0; i < N; ++i) {
684f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(X, i, &vX));
685f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(ctx->V[0], i, &vC));
686f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
687f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
688f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(ctx->V[0], i, &vC));
689f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(X, i, &vX));
690f1580f4eSBarry Smith   }
691f1580f4eSBarry Smith   PetscCall(MatDenseGetArrayWrite(ctx->V[0], &out));
692db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, N); /* Y = Q X */
693f1580f4eSBarry Smith   PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &out));
694f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
695f1580f4eSBarry Smith   for (i = 0; i < N; ++i) {
696f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(ctx->V[0], i, &vC));
697f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(Y, i, &vY));
698f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
699f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
700f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &vY));
701f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(ctx->V[0], i, &vC));
702f1580f4eSBarry Smith   }
7033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
704f1580f4eSBarry Smith }
705f1580f4eSBarry Smith 
706f1580f4eSBarry Smith /*
707f1580f4eSBarry Smith      PCApply_HPDDMShell - Applies a (2) deflated, (1) additive, or (3) balanced coarse correction. In what follows, E = Z Pmat Z^T and Q = Z^T E^-1 Z.
708f1580f4eSBarry Smith 
709f1580f4eSBarry Smith .vb
710f1580f4eSBarry Smith    (1) y =                Pmat^-1              x + Q x,
711f1580f4eSBarry Smith    (2) y =                Pmat^-1 (I - Amat Q) x + Q x (default),
712f1580f4eSBarry Smith    (3) y = (I - Q Amat^T) Pmat^-1 (I - Amat Q) x + Q x.
713f1580f4eSBarry Smith .ve
714f1580f4eSBarry Smith 
715f1580f4eSBarry Smith    Input Parameters:
716f1580f4eSBarry Smith +     pc - preconditioner context
717f1580f4eSBarry Smith -     x - input vector
718f1580f4eSBarry Smith 
719f1580f4eSBarry Smith    Output Parameter:
720f1580f4eSBarry Smith .     y - output vector
721f1580f4eSBarry Smith 
722f1580f4eSBarry Smith    Notes:
723f1580f4eSBarry 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.
724f1580f4eSBarry 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.
725f1580f4eSBarry 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.
726f1580f4eSBarry Smith 
727f1580f4eSBarry Smith    Level: advanced
728f1580f4eSBarry Smith 
729f1580f4eSBarry Smith    Developer Note:
730f1580f4eSBarry 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
731f1580f4eSBarry Smith    to trigger it. Likely the manual page is `PCHPDDM`
732f1580f4eSBarry Smith 
733562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
734f1580f4eSBarry Smith */
735d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDMShell(PC pc, Vec x, Vec y)
736d71ae5a4SJacob Faibussowitsch {
737f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
738f1580f4eSBarry Smith   Mat             A;
739f1580f4eSBarry Smith 
740f1580f4eSBarry Smith   PetscFunctionBegin;
741f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
742f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
743db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
744f1580f4eSBarry Smith   PetscCall(PCHPDDMDeflate_Private(pc, x, y)); /* y = Q x */
745f1580f4eSBarry Smith   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
746f1580f4eSBarry Smith     if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMult(A, y, ctx->v[1][0])); /* y = A Q x     */
747f1580f4eSBarry Smith     else { /* KSPLSQR and finest level */ PetscCall(MatMult(A, y, ctx->parent->normal));               /* y = A Q x     */
748f1580f4eSBarry Smith       PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][0]));                      /* y = A^T A Q x */
749f1580f4eSBarry Smith     }
750f1580f4eSBarry Smith     PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x)); /* y = (I - A Q) x                             */
751f1580f4eSBarry Smith     PetscCall(PCApply(ctx->pc, ctx->v[1][1], ctx->v[1][0]));  /* y = M^-1 (I - A Q) x                        */
752f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
753f1580f4eSBarry 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 */
754f1580f4eSBarry Smith       else {
755f1580f4eSBarry Smith         PetscCall(MatMult(A, ctx->v[1][0], ctx->parent->normal));
756f1580f4eSBarry Smith         PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][1])); /* z = A^T A y           */
757f1580f4eSBarry Smith       }
758f1580f4eSBarry Smith       PetscCall(PCHPDDMDeflate_Private(pc, ctx->v[1][1], ctx->v[1][1]));
759f1580f4eSBarry 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      */
760f1580f4eSBarry Smith     } else PetscCall(VecAXPY(y, 1.0, ctx->v[1][0]));                         /* y = Q M^-1 (I - A Q) x + Q x */
761f1580f4eSBarry Smith   } else {
762f1580f4eSBarry 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);
763f1580f4eSBarry Smith     PetscCall(PCApply(ctx->pc, x, ctx->v[1][0]));
764f1580f4eSBarry Smith     PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-1 x + Q x */
765f1580f4eSBarry Smith   }
7663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
767f1580f4eSBarry Smith }
768f1580f4eSBarry Smith 
769f1580f4eSBarry Smith /*
770f1580f4eSBarry Smith      PCMatApply_HPDDMShell - Variant of PCApply_HPDDMShell() for blocks of vectors.
771f1580f4eSBarry Smith 
772f1580f4eSBarry Smith    Input Parameters:
773f1580f4eSBarry Smith +     pc - preconditioner context
774f1580f4eSBarry Smith -     X - block of input vectors
775f1580f4eSBarry Smith 
776f1580f4eSBarry Smith    Output Parameter:
777f1580f4eSBarry Smith .     Y - block of output vectors
778f1580f4eSBarry Smith 
779f1580f4eSBarry Smith    Level: advanced
780f1580f4eSBarry Smith 
781562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
782f1580f4eSBarry Smith */
783d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDMShell(PC pc, Mat X, Mat Y)
784d71ae5a4SJacob Faibussowitsch {
785f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
786f1580f4eSBarry Smith   Mat             A, *ptr;
787db4a47b3SPierre Jolivet   PetscContainer  container = nullptr;
788f1580f4eSBarry Smith   PetscScalar    *array;
789f1580f4eSBarry Smith   PetscInt        m, M, N, prev = 0;
790f1580f4eSBarry Smith   PetscBool       reset = PETSC_FALSE;
791f1580f4eSBarry Smith 
792f1580f4eSBarry Smith   PetscFunctionBegin;
793f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
794f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
795db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
796db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
797f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)A, "_HPDDM_MatProduct", (PetscObject *)&container));
798f1580f4eSBarry Smith   if (container) { /* MatProduct container already attached */
799f1580f4eSBarry Smith     PetscCall(PetscContainerGetPointer(container, (void **)&ptr));
800f1580f4eSBarry Smith     if (ptr[1] != ctx->V[2]) /* Mat has changed or may have been set first in KSPHPDDM */
801f1580f4eSBarry Smith       for (m = 0; m < 2; ++m) {
802f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + m + 1));
803f1580f4eSBarry Smith         ctx->V[m + 1] = ptr[m];
804f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)ctx->V[m + 1]));
805f1580f4eSBarry Smith       }
806f1580f4eSBarry Smith   }
807db4a47b3SPierre Jolivet   if (ctx->V[1]) PetscCall(MatGetSize(ctx->V[1], nullptr, &prev));
808f1580f4eSBarry Smith   if (N != prev || !ctx->V[0]) {
809f1580f4eSBarry Smith     PetscCall(MatDestroy(ctx->V));
810f1580f4eSBarry Smith     PetscCall(VecGetLocalSize(ctx->v[0][0], &m));
811db4a47b3SPierre Jolivet     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, PETSC_DECIDE, N, nullptr, ctx->V));
812f1580f4eSBarry Smith     if (N != prev) {
813f1580f4eSBarry Smith       PetscCall(MatDestroy(ctx->V + 1));
814f1580f4eSBarry Smith       PetscCall(MatDestroy(ctx->V + 2));
815db4a47b3SPierre Jolivet       PetscCall(MatGetLocalSize(X, &m, nullptr));
816db4a47b3SPierre Jolivet       PetscCall(MatGetSize(X, &M, nullptr));
817f1580f4eSBarry Smith       if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
818db4a47b3SPierre Jolivet       else array = nullptr;
819f1580f4eSBarry Smith       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, array, ctx->V + 1));
820f1580f4eSBarry Smith       if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
821db4a47b3SPierre Jolivet       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, nullptr, ctx->V + 2));
822db4a47b3SPierre Jolivet       PetscCall(MatProductCreateWithMat(A, Y, nullptr, ctx->V[1]));
823f1580f4eSBarry Smith       PetscCall(MatProductSetType(ctx->V[1], MATPRODUCT_AB));
824f1580f4eSBarry Smith       PetscCall(MatProductSetFromOptions(ctx->V[1]));
825f1580f4eSBarry Smith       PetscCall(MatProductSymbolic(ctx->V[1]));
826f1580f4eSBarry Smith       if (!container) { /* no MatProduct container attached, create one to be queried in KSPHPDDM or at the next call to PCMatApply() */
827f1580f4eSBarry Smith         PetscCall(PetscContainerCreate(PetscObjectComm((PetscObject)A), &container));
828f1580f4eSBarry Smith         PetscCall(PetscObjectCompose((PetscObject)A, "_HPDDM_MatProduct", (PetscObject)container));
829f1580f4eSBarry Smith       }
830f1580f4eSBarry Smith       PetscCall(PetscContainerSetPointer(container, ctx->V + 1)); /* need to compose B and D from MatProductCreateWithMath(A, B, NULL, D), which are stored in the contiguous array ctx->V */
831f1580f4eSBarry Smith     }
832f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
833db4a47b3SPierre Jolivet       PetscCall(MatProductCreateWithMat(A, ctx->V[1], nullptr, ctx->V[2]));
834f1580f4eSBarry Smith       PetscCall(MatProductSetType(ctx->V[2], MATPRODUCT_AtB));
835f1580f4eSBarry Smith       PetscCall(MatProductSetFromOptions(ctx->V[2]));
836f1580f4eSBarry Smith       PetscCall(MatProductSymbolic(ctx->V[2]));
837f1580f4eSBarry Smith     }
838f1580f4eSBarry Smith     ctx->P->start(N);
839f1580f4eSBarry Smith   }
840f1580f4eSBarry Smith   if (N == prev || container) { /* when MatProduct container is attached, always need to MatProductReplaceMats() since KSPHPDDM may have replaced the Mat as well */
841db4a47b3SPierre Jolivet     PetscCall(MatProductReplaceMats(nullptr, Y, nullptr, ctx->V[1]));
842f1580f4eSBarry Smith     if (container && ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) {
843f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
844f1580f4eSBarry Smith       PetscCall(MatDensePlaceArray(ctx->V[1], array));
845f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
846f1580f4eSBarry Smith       reset = PETSC_TRUE;
847f1580f4eSBarry Smith     }
848f1580f4eSBarry Smith   }
849f1580f4eSBarry Smith   PetscCall(PCHPDDMDeflate_Private(pc, X, Y));
850f1580f4eSBarry Smith   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
851f1580f4eSBarry Smith     PetscCall(MatProductNumeric(ctx->V[1]));
852f1580f4eSBarry Smith     PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
853f1580f4eSBarry Smith     PetscCall(MatAXPY(ctx->V[2], -1.0, X, SAME_NONZERO_PATTERN));
854f1580f4eSBarry Smith     PetscCall(PCMatApply(ctx->pc, ctx->V[2], ctx->V[1]));
855f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
856f1580f4eSBarry Smith       PetscCall(MatProductNumeric(ctx->V[2]));
857f1580f4eSBarry Smith       PetscCall(PCHPDDMDeflate_Private(pc, ctx->V[2], ctx->V[2]));
858f1580f4eSBarry Smith       PetscCall(MatAXPY(ctx->V[1], -1.0, ctx->V[2], SAME_NONZERO_PATTERN));
859f1580f4eSBarry Smith     }
860f1580f4eSBarry Smith     PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
861f1580f4eSBarry Smith   } else {
862f1580f4eSBarry 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);
863f1580f4eSBarry Smith     PetscCall(PCMatApply(ctx->pc, X, ctx->V[1]));
864f1580f4eSBarry Smith     PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
865f1580f4eSBarry Smith   }
866f1580f4eSBarry Smith   if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
8673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
868f1580f4eSBarry Smith }
869f1580f4eSBarry Smith 
870d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDMShell(PC pc)
871d71ae5a4SJacob Faibussowitsch {
872f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
873f1580f4eSBarry Smith   PetscContainer  container;
874f1580f4eSBarry Smith 
875f1580f4eSBarry Smith   PetscFunctionBegin;
876f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
877f1580f4eSBarry Smith   PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(ctx, PETSC_TRUE));
878f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(1, &ctx->v[0]));
879f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(2, &ctx->v[1]));
880f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)(ctx->pc)->mat, "_HPDDM_MatProduct", (PetscObject *)&container));
881f1580f4eSBarry Smith   PetscCall(PetscContainerDestroy(&container));
882db4a47b3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)(ctx->pc)->mat, "_HPDDM_MatProduct", nullptr));
883f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V));
884f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 1));
885f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 2));
886f1580f4eSBarry Smith   PetscCall(VecDestroy(&ctx->D));
887f1580f4eSBarry Smith   PetscCall(VecScatterDestroy(&ctx->scatter));
888f1580f4eSBarry Smith   PetscCall(PCDestroy(&ctx->pc));
8893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
890f1580f4eSBarry Smith }
891f1580f4eSBarry Smith 
8929bb5c669SPierre Jolivet template <class Type, bool T = false, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
8939bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type x, Type y)
8949bb5c669SPierre Jolivet {
8959bb5c669SPierre Jolivet   PetscFunctionBegin;
8969bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[0], std::get<1>(*p), SCATTER_FORWARD, x));
8979bb5c669SPierre Jolivet   if (!T) PetscCall(PCApply(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
8989bb5c669SPierre Jolivet   else PetscCall(PCApplyTranspose(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
8999bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[1], std::get<1>(*p), SCATTER_REVERSE, y));
9009bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9019bb5c669SPierre Jolivet }
9029bb5c669SPierre Jolivet 
9039bb5c669SPierre Jolivet template <class Type, bool = false, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
9049bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type X, Type Y)
9059bb5c669SPierre Jolivet {
9069bb5c669SPierre Jolivet   Mat B[2];
9079bb5c669SPierre Jolivet   Vec x, y;
9089bb5c669SPierre Jolivet 
9099bb5c669SPierre Jolivet   PetscFunctionBegin;
9109bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B));
9119bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B + 1));
9129bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
9139bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(X, i, &x));
9149bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B[0], i, &y));
9159bb5c669SPierre Jolivet     PetscCall(VecISCopy(y, std::get<1>(*p), SCATTER_FORWARD, x));
9169bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B[0], i, &y));
9179bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(X, i, &x));
9189bb5c669SPierre Jolivet   }
9199bb5c669SPierre Jolivet   PetscCall(PCMatApply(factor, B[0], B[1]));
9209bb5c669SPierre Jolivet   PetscCall(MatDestroy(B));
9219bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
9229bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B[1], i, &x));
9239bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &y));
9249bb5c669SPierre Jolivet     PetscCall(VecISCopy(x, std::get<1>(*p), SCATTER_REVERSE, y));
9259bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &y));
9269bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B[1], i, &x));
9279bb5c669SPierre Jolivet   }
9289bb5c669SPierre Jolivet   PetscCall(MatDestroy(B + 1));
9299bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9309bb5c669SPierre Jolivet }
9319bb5c669SPierre Jolivet 
9329bb5c669SPierre Jolivet template <class Type = Vec, bool T = false>
9339bb5c669SPierre Jolivet static PetscErrorCode PCApply_Schur(PC pc, Type x, Type y)
9349bb5c669SPierre Jolivet {
9359bb5c669SPierre Jolivet   PC                           factor;
9369bb5c669SPierre Jolivet   Mat                          A;
9379bb5c669SPierre Jolivet   MatSolverType                type;
9389bb5c669SPierre Jolivet   PetscBool                    flg;
9399bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
9409bb5c669SPierre Jolivet 
9419bb5c669SPierre Jolivet   PetscFunctionBegin;
9429bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
9439bb5c669SPierre Jolivet   PetscCall(KSPGetPC(std::get<0>(*p), &factor));
9449bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(factor, &type));
9459bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatrix(factor, &A));
9469bb5c669SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
9479bb5c669SPierre Jolivet   if (flg) {
9489bb5c669SPierre Jolivet     PetscCheck(PetscDefined(HAVE_MUMPS), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
9499bb5c669SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
9509bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 0));
9519bb5c669SPierre Jolivet #endif
9529bb5c669SPierre Jolivet   } else {
9539bb5c669SPierre Jolivet     PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &flg));
9549bb5c669SPierre Jolivet     PetscCheck(flg && PetscDefined(HAVE_MKL_PARDISO), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
9559bb5c669SPierre Jolivet     flg = PETSC_FALSE;
9569bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
9579bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 1));
9589bb5c669SPierre Jolivet #endif
9599bb5c669SPierre Jolivet   }
9609bb5c669SPierre Jolivet   PetscCall(PCApply_Schur_Private<Type, T>(p, factor, x, y));
9619bb5c669SPierre Jolivet   if (flg) {
9629bb5c669SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
9639bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1));
9649bb5c669SPierre Jolivet #endif
9659bb5c669SPierre Jolivet   } else {
9669bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
9679bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 0));
9689bb5c669SPierre Jolivet #endif
9699bb5c669SPierre Jolivet   }
9709bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9719bb5c669SPierre Jolivet }
9729bb5c669SPierre Jolivet 
9739bb5c669SPierre Jolivet static PetscErrorCode PCDestroy_Schur(PC pc)
9749bb5c669SPierre Jolivet {
9759bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
9769bb5c669SPierre Jolivet 
9779bb5c669SPierre Jolivet   PetscFunctionBegin;
9789bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
9799bb5c669SPierre Jolivet   PetscCall(ISDestroy(&std::get<1>(*p)));
9809bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p)));
9819bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p) + 1));
9829bb5c669SPierre Jolivet   PetscCall(PetscFree(p));
9839bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9849bb5c669SPierre Jolivet }
9859bb5c669SPierre Jolivet 
986d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSolve_Private(const PC_HPDDM_Level *ctx, PetscScalar *rhs, const unsigned short &mu)
987d71ae5a4SJacob Faibussowitsch {
988f1580f4eSBarry Smith   Mat      B, X;
989f1580f4eSBarry Smith   PetscInt n, N, j = 0;
990f1580f4eSBarry Smith 
991f1580f4eSBarry Smith   PetscFunctionBegin;
992db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &B, nullptr));
993db4a47b3SPierre Jolivet   PetscCall(MatGetLocalSize(B, &n, nullptr));
994db4a47b3SPierre Jolivet   PetscCall(MatGetSize(B, &N, nullptr));
995f1580f4eSBarry Smith   if (ctx->parent->log_separate) {
996f1580f4eSBarry Smith     j = std::distance(ctx->parent->levels, std::find(ctx->parent->levels, ctx->parent->levels + ctx->parent->N, ctx));
997db4a47b3SPierre Jolivet     PetscCall(PetscLogEventBegin(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
998f1580f4eSBarry Smith   }
999f1580f4eSBarry Smith   if (mu == 1) {
1000f1580f4eSBarry Smith     if (!ctx->ksp->vec_rhs) {
1001db4a47b3SPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ctx->ksp), 1, n, N, nullptr, &ctx->ksp->vec_rhs));
1002f1580f4eSBarry Smith       PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)ctx->ksp), n, N, &ctx->ksp->vec_sol));
1003f1580f4eSBarry Smith     }
1004f1580f4eSBarry Smith     PetscCall(VecPlaceArray(ctx->ksp->vec_rhs, rhs));
1005db4a47b3SPierre Jolivet     PetscCall(KSPSolve(ctx->ksp, nullptr, nullptr));
1006f1580f4eSBarry Smith     PetscCall(VecCopy(ctx->ksp->vec_sol, ctx->ksp->vec_rhs));
1007f1580f4eSBarry Smith     PetscCall(VecResetArray(ctx->ksp->vec_rhs));
1008f1580f4eSBarry Smith   } else {
1009f1580f4eSBarry Smith     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, rhs, &B));
1010db4a47b3SPierre Jolivet     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, nullptr, &X));
1011f1580f4eSBarry Smith     PetscCall(KSPMatSolve(ctx->ksp, B, X));
1012f1580f4eSBarry Smith     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
1013f1580f4eSBarry Smith     PetscCall(MatDestroy(&X));
1014f1580f4eSBarry Smith     PetscCall(MatDestroy(&B));
1015f1580f4eSBarry Smith   }
1016db4a47b3SPierre Jolivet   if (ctx->parent->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
10173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1018f1580f4eSBarry Smith }
1019f1580f4eSBarry Smith 
1020d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetUpNeumannOverlap_Private(PC pc)
1021d71ae5a4SJacob Faibussowitsch {
1022f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
1023f1580f4eSBarry Smith 
1024f1580f4eSBarry Smith   PetscFunctionBegin;
1025f1580f4eSBarry Smith   if (data->setup) {
1026f1580f4eSBarry Smith     Mat       P;
1027db4a47b3SPierre Jolivet     Vec       x, xt = nullptr;
1028f1580f4eSBarry Smith     PetscReal t = 0.0, s = 0.0;
1029f1580f4eSBarry Smith 
1030db4a47b3SPierre Jolivet     PetscCall(PCGetOperators(pc, nullptr, &P));
1031f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)P, "__SNES_latest_X", (PetscObject *)&x));
1032f1580f4eSBarry Smith     PetscCallBack("PCHPDDM Neumann callback", (*data->setup)(data->aux, t, x, xt, s, data->is, data->setup_ctx));
1033f1580f4eSBarry Smith   }
10343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1035f1580f4eSBarry Smith }
1036f1580f4eSBarry Smith 
1037d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCreateSubMatrices_Private(Mat mat, PetscInt n, const IS *, const IS *, MatReuse scall, Mat *submat[])
1038d71ae5a4SJacob Faibussowitsch {
1039f1580f4eSBarry Smith   Mat       A;
104013044ca3SPierre Jolivet   PetscBool flg;
1041f1580f4eSBarry Smith 
1042f1580f4eSBarry Smith   PetscFunctionBegin;
1043f1580f4eSBarry Smith   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatCreateSubMatrices() called to extract %" PetscInt_FMT " submatrices, which is different than 1", n);
1044f1580f4eSBarry Smith   /* previously composed Mat */
1045f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)mat, "_PCHPDDM_SubMatrices", (PetscObject *)&A));
1046f1580f4eSBarry Smith   PetscCheck(A, PETSC_COMM_SELF, PETSC_ERR_PLIB, "SubMatrices not found in Mat");
104713044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSCHURCOMPLEMENT, &flg)); /* MATSCHURCOMPLEMENT has neither a MatDuplicate() nor a MatCopy() implementation */
1048f1580f4eSBarry Smith   if (scall == MAT_INITIAL_MATRIX) {
10496f2c871aSStefano Zampini     PetscCall(PetscCalloc1(2, submat)); /* allocate an extra Mat to avoid errors in MatDestroySubMatrices_Dummy() */
105013044ca3SPierre Jolivet     if (!flg) PetscCall(MatDuplicate(A, MAT_COPY_VALUES, *submat));
105113044ca3SPierre Jolivet   } else if (!flg) PetscCall(MatCopy(A, (*submat)[0], SAME_NONZERO_PATTERN));
105213044ca3SPierre Jolivet   if (flg) {
105313044ca3SPierre Jolivet     (*submat)[0] = A;
105413044ca3SPierre Jolivet     PetscCall(PetscObjectReference((PetscObject)A));
105513044ca3SPierre Jolivet   }
10563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1057f1580f4eSBarry Smith }
1058f1580f4eSBarry Smith 
1059d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCommunicationAvoidingPCASM_Private(PC pc, Mat C, PetscBool sorted)
1060d71ae5a4SJacob Faibussowitsch {
1061f1580f4eSBarry Smith   void (*op)(void);
1062f1580f4eSBarry Smith 
1063f1580f4eSBarry Smith   PetscFunctionBegin;
1064f1580f4eSBarry Smith   /* previously-composed Mat */
1065f1580f4eSBarry Smith   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", (PetscObject)C));
1066f1580f4eSBarry Smith   PetscCall(MatGetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, &op));
1067f1580f4eSBarry Smith   /* trick suggested by Barry https://lists.mcs.anl.gov/pipermail/petsc-dev/2020-January/025491.html */
1068f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, (void (*)(void))PCHPDDMCreateSubMatrices_Private));
1069f1580f4eSBarry Smith   if (sorted) PetscCall(PCASMSetSortIndices(pc, PETSC_FALSE)); /* everything is already sorted */
1070f1580f4eSBarry Smith   PetscCall(PCSetFromOptions(pc));                             /* otherwise -pc_hpddm_levels_1_pc_asm_sub_mat_type is not used */
1071f1580f4eSBarry Smith   PetscCall(PCSetUp(pc));
1072f1580f4eSBarry Smith   /* reset MatCreateSubMatrices() */
1073f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, op));
1074db4a47b3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", nullptr));
10753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1076f1580f4eSBarry Smith }
1077f1580f4eSBarry Smith 
1078d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMPermute_Private(IS is, IS in_is, IS *out_is, Mat in_C, Mat *out_C, IS *p)
1079d71ae5a4SJacob Faibussowitsch {
1080f1580f4eSBarry Smith   IS                           perm;
1081f1580f4eSBarry Smith   const PetscInt              *ptr;
1082b07dfdedSPierre Jolivet   PetscInt                    *concatenate, size, n, bs;
1083f1580f4eSBarry Smith   std::map<PetscInt, PetscInt> order;
1084f1580f4eSBarry Smith   PetscBool                    sorted;
1085f1580f4eSBarry Smith 
1086f1580f4eSBarry Smith   PetscFunctionBegin;
1087f1580f4eSBarry Smith   PetscCall(ISSorted(is, &sorted));
1088f1580f4eSBarry Smith   if (!sorted) {
1089f1580f4eSBarry Smith     PetscCall(ISGetLocalSize(is, &size));
1090f1580f4eSBarry Smith     PetscCall(ISGetIndices(is, &ptr));
1091b07dfdedSPierre Jolivet     PetscCall(ISGetBlockSize(is, &bs));
1092f1580f4eSBarry Smith     /* MatCreateSubMatrices(), called by PCASM, follows the global numbering of Pmat */
1093b07dfdedSPierre Jolivet     for (n = 0; n < size; n += bs) order.insert(std::make_pair(ptr[n] / bs, n / bs));
1094f1580f4eSBarry Smith     PetscCall(ISRestoreIndices(is, &ptr));
1095b07dfdedSPierre Jolivet     size /= bs;
1096f1580f4eSBarry Smith     if (out_C) {
1097f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1098f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.second;
1099f1580f4eSBarry Smith       concatenate -= size;
1100b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_C), bs, size, concatenate, PETSC_OWN_POINTER, &perm));
1101f1580f4eSBarry Smith       PetscCall(ISSetPermutation(perm));
1102f1580f4eSBarry Smith       /* permute user-provided Mat so that it matches with MatCreateSubMatrices() numbering */
1103f1580f4eSBarry Smith       PetscCall(MatPermute(in_C, perm, perm, out_C));
1104f1580f4eSBarry Smith       if (p) *p = perm;
1105f1580f4eSBarry Smith       else PetscCall(ISDestroy(&perm)); /* no need to save the permutation */
1106f1580f4eSBarry Smith     }
1107f1580f4eSBarry Smith     if (out_is) {
1108f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1109f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.first;
1110f1580f4eSBarry Smith       concatenate -= size;
1111f1580f4eSBarry Smith       /* permute user-provided IS so that it matches with MatCreateSubMatrices() numbering */
1112b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_is), bs, size, concatenate, PETSC_OWN_POINTER, out_is));
1113f1580f4eSBarry Smith     }
1114f1580f4eSBarry Smith   } else { /* input IS is sorted, nothing to permute, simply duplicate inputs when needed */
1115f1580f4eSBarry Smith     if (out_C) PetscCall(MatDuplicate(in_C, MAT_COPY_VALUES, out_C));
1116f1580f4eSBarry Smith     if (out_is) PetscCall(ISDuplicate(in_is, out_is));
1117f1580f4eSBarry Smith   }
11183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1119f1580f4eSBarry Smith }
1120f1580f4eSBarry Smith 
11215e642048SPierre Jolivet static PetscErrorCode PCHPDDMCheckSymmetry_Private(PC pc, Mat A01, Mat A10)
112213044ca3SPierre Jolivet {
112313044ca3SPierre Jolivet   Mat       T, U = nullptr, B = nullptr;
112413044ca3SPierre Jolivet   IS        z;
112513044ca3SPierre Jolivet   PetscBool flg[2];
112613044ca3SPierre Jolivet 
112713044ca3SPierre Jolivet   PetscFunctionBegin;
112813044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, flg));
112913044ca3SPierre Jolivet   if (flg[0]) PetscCall(MatTransposeGetMat(A10, &U));
113013044ca3SPierre Jolivet   else {
113113044ca3SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, flg + 1));
113213044ca3SPierre Jolivet     if (flg[1]) PetscCall(MatHermitianTransposeGetMat(A10, &U));
113313044ca3SPierre Jolivet   }
113413044ca3SPierre Jolivet   if (U) PetscCall(MatDuplicate(U, MAT_COPY_VALUES, &T));
113513044ca3SPierre Jolivet   else PetscCall(MatHermitianTranspose(A10, MAT_INITIAL_MATRIX, &T));
113613044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATTRANSPOSEVIRTUAL, flg));
113713044ca3SPierre Jolivet   if (flg[0]) {
113813044ca3SPierre Jolivet     PetscCall(MatTransposeGetMat(A01, &A01));
113913044ca3SPierre Jolivet     PetscCall(MatTranspose(A01, MAT_INITIAL_MATRIX, &B));
114013044ca3SPierre Jolivet     A01 = B;
114113044ca3SPierre Jolivet   } else {
114213044ca3SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATHERMITIANTRANSPOSEVIRTUAL, flg));
114313044ca3SPierre Jolivet     if (flg[0]) {
114413044ca3SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A01, &A01));
114513044ca3SPierre Jolivet       PetscCall(MatHermitianTranspose(A01, MAT_INITIAL_MATRIX, &B));
114613044ca3SPierre Jolivet       A01 = B;
114713044ca3SPierre Jolivet     }
114813044ca3SPierre Jolivet   }
114913044ca3SPierre Jolivet   PetscCall(PetscLayoutCompare(T->rmap, A01->rmap, flg));
115013044ca3SPierre Jolivet   if (flg[0]) {
115113044ca3SPierre Jolivet     PetscCall(PetscLayoutCompare(T->cmap, A01->cmap, flg));
115213044ca3SPierre Jolivet     if (flg[0]) {
115313044ca3SPierre Jolivet       PetscCall(MatFindZeroRows(A01, &z)); /* for essential boundary conditions, some implementations will */
115413044ca3SPierre Jolivet       if (z) {                             /*  zero rows in [P00 A01] except for the diagonal of P00       */
115513044ca3SPierre Jolivet         PetscCall(MatSetOption(T, MAT_NO_OFF_PROC_ZERO_ROWS, PETSC_TRUE));
115613044ca3SPierre Jolivet         PetscCall(MatZeroRowsIS(T, z, 0.0, nullptr, nullptr)); /* corresponding zero rows from A01 */
115713044ca3SPierre Jolivet         PetscCall(ISDestroy(&z));
115813044ca3SPierre Jolivet       }
115913044ca3SPierre Jolivet       PetscCall(MatMultEqual(A01, T, 20, flg));
116013044ca3SPierre Jolivet       PetscCheck(flg[0], PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "A01 != A10^T");
116113044ca3SPierre Jolivet     } else PetscCall(PetscInfo(pc, "A01 and A10^T have non-congruent column layouts, cannot test for equality\n"));
116213044ca3SPierre Jolivet   }
116313044ca3SPierre Jolivet   PetscCall(MatDestroy(&B));
116413044ca3SPierre Jolivet   PetscCall(MatDestroy(&T));
116513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
116613044ca3SPierre Jolivet }
116713044ca3SPierre Jolivet 
1168d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMDestroySubMatrices_Private(PetscBool flg, PetscBool algebraic, Mat *sub)
1169d71ae5a4SJacob Faibussowitsch {
1170f1580f4eSBarry Smith   IS is;
1171f1580f4eSBarry Smith 
1172f1580f4eSBarry Smith   PetscFunctionBegin;
1173f1580f4eSBarry Smith   if (!flg) {
1174f1580f4eSBarry Smith     if (algebraic) {
1175f1580f4eSBarry Smith       PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Embed", (PetscObject *)&is));
1176f1580f4eSBarry Smith       PetscCall(ISDestroy(&is));
1177db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Embed", nullptr));
1178db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Compact", nullptr));
1179f1580f4eSBarry Smith     }
1180f1580f4eSBarry Smith     PetscCall(MatDestroySubMatrices(algebraic ? 2 : 1, &sub));
1181f1580f4eSBarry Smith   }
11823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1183f1580f4eSBarry Smith }
1184f1580f4eSBarry Smith 
1185d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMAlgebraicAuxiliaryMat_Private(Mat P, IS *is, Mat *sub[], PetscBool block)
1186d71ae5a4SJacob Faibussowitsch {
1187f1580f4eSBarry Smith   IS         icol[3], irow[2];
1188f1580f4eSBarry Smith   Mat       *M, Q;
1189f1580f4eSBarry Smith   PetscReal *ptr;
1190f1580f4eSBarry Smith   PetscInt  *idx, p = 0, n, bs = PetscAbs(P->cmap->bs);
1191f1580f4eSBarry Smith   PetscBool  flg;
1192f1580f4eSBarry Smith 
1193f1580f4eSBarry Smith   PetscFunctionBegin;
1194f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, P->cmap->N, 0, 1, icol + 2));
1195f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(icol[2], bs));
1196f1580f4eSBarry Smith   PetscCall(ISSetIdentity(icol[2]));
1197f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1198f1580f4eSBarry Smith   if (flg) {
1199f1580f4eSBarry Smith     /* MatCreateSubMatrices() does not handle MATMPISBAIJ properly when iscol != isrow, so convert first to MATMPIBAIJ */
1200f1580f4eSBarry Smith     PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &Q));
1201f1580f4eSBarry Smith     std::swap(P, Q);
1202f1580f4eSBarry Smith   }
1203f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(P, 1, is, icol + 2, MAT_INITIAL_MATRIX, &M));
1204f1580f4eSBarry Smith   if (flg) {
1205f1580f4eSBarry Smith     std::swap(P, Q);
1206f1580f4eSBarry Smith     PetscCall(MatDestroy(&Q));
1207f1580f4eSBarry Smith   }
1208f1580f4eSBarry Smith   PetscCall(ISDestroy(icol + 2));
1209f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, M[0]->rmap->N, 0, 1, irow));
1210f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(irow[0], bs));
1211f1580f4eSBarry Smith   PetscCall(ISSetIdentity(irow[0]));
1212f1580f4eSBarry Smith   if (!block) {
1213b07dfdedSPierre Jolivet     PetscCall(PetscMalloc2(P->cmap->N, &ptr, P->cmap->N / bs, &idx));
1214f1580f4eSBarry Smith     PetscCall(MatGetColumnNorms(M[0], NORM_INFINITY, ptr));
1215f1580f4eSBarry Smith     /* check for nonzero columns so that M[0] may be expressed in compact form */
1216b07dfdedSPierre Jolivet     for (n = 0; n < P->cmap->N; n += bs) {
1217b07dfdedSPierre Jolivet       if (std::find_if(ptr + n, ptr + n + bs, [](PetscReal v) { return v > PETSC_MACHINE_EPSILON; }) != ptr + n + bs) idx[p++] = n / bs;
1218f1580f4eSBarry Smith     }
1219b07dfdedSPierre Jolivet     PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, p, idx, PETSC_USE_POINTER, icol + 1));
1220f1580f4eSBarry Smith     PetscCall(ISSetInfo(icol[1], IS_SORTED, IS_GLOBAL, PETSC_TRUE, PETSC_TRUE));
1221f1580f4eSBarry Smith     PetscCall(ISEmbed(*is, icol[1], PETSC_FALSE, icol + 2));
1222f1580f4eSBarry Smith     irow[1] = irow[0];
1223f1580f4eSBarry 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 */
1224f1580f4eSBarry Smith     icol[0] = is[0];
1225f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 2, irow, icol, MAT_INITIAL_MATRIX, sub));
1226f1580f4eSBarry Smith     PetscCall(ISDestroy(icol + 1));
1227f1580f4eSBarry Smith     PetscCall(PetscFree2(ptr, idx));
1228f1580f4eSBarry Smith     /* IS used to go back and forth between the augmented and the original local linear system, see eq. (3.4) of [2022b] */
1229f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Embed", (PetscObject)icol[2]));
1230f1580f4eSBarry Smith     /* Mat used in eq. (3.1) of [2022b] */
1231f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Compact", (PetscObject)(*sub)[1]));
1232f1580f4eSBarry Smith   } else {
1233f1580f4eSBarry Smith     Mat aux;
1234f1580f4eSBarry Smith     PetscCall(MatSetOption(M[0], MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1235f1580f4eSBarry Smith     /* diagonal block of the overlapping rows */
1236f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 1, irow, is, MAT_INITIAL_MATRIX, sub));
1237f1580f4eSBarry Smith     PetscCall(MatDuplicate((*sub)[0], MAT_COPY_VALUES, &aux));
1238f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1239f1580f4eSBarry Smith     if (bs == 1) { /* scalar case */
1240f1580f4eSBarry Smith       Vec sum[2];
1241f1580f4eSBarry Smith       PetscCall(MatCreateVecs(aux, sum, sum + 1));
1242f1580f4eSBarry Smith       PetscCall(MatGetRowSum(M[0], sum[0]));
1243f1580f4eSBarry Smith       PetscCall(MatGetRowSum(aux, sum[1]));
1244f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1245f1580f4eSBarry Smith       PetscCall(VecAXPY(sum[0], -1.0, sum[1]));
1246f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1247f1580f4eSBarry Smith       PetscCall(MatDiagonalSet(aux, sum[0], ADD_VALUES));
1248f1580f4eSBarry Smith       PetscCall(VecDestroy(sum));
1249f1580f4eSBarry Smith       PetscCall(VecDestroy(sum + 1));
1250f1580f4eSBarry Smith     } else { /* vectorial case */
1251f1580f4eSBarry Smith       /* TODO: missing MatGetValuesBlocked(), so the code below is     */
1252f1580f4eSBarry Smith       /* an extension of the scalar case for when bs > 1, but it could */
1253f1580f4eSBarry Smith       /* be more efficient by avoiding all these MatMatMult()          */
1254f1580f4eSBarry Smith       Mat          sum[2], ones;
1255f1580f4eSBarry Smith       PetscScalar *ptr;
1256f1580f4eSBarry Smith       PetscCall(PetscCalloc1(M[0]->cmap->n * bs, &ptr));
1257f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, M[0]->cmap->n, bs, M[0]->cmap->n, bs, ptr, &ones));
1258f1580f4eSBarry Smith       for (n = 0; n < M[0]->cmap->n; n += bs) {
1259f1580f4eSBarry Smith         for (p = 0; p < bs; ++p) ptr[n + p * (M[0]->cmap->n + 1)] = 1.0;
1260f1580f4eSBarry Smith       }
1261f1580f4eSBarry Smith       PetscCall(MatMatMult(M[0], ones, MAT_INITIAL_MATRIX, PETSC_DEFAULT, sum));
1262f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1263f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, aux->cmap->n, bs, aux->cmap->n, bs, ptr, &ones));
1264f1580f4eSBarry Smith       PetscCall(MatDenseSetLDA(ones, M[0]->cmap->n));
1265f1580f4eSBarry Smith       PetscCall(MatMatMult(aux, ones, MAT_INITIAL_MATRIX, PETSC_DEFAULT, sum + 1));
1266f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1267f1580f4eSBarry Smith       PetscCall(PetscFree(ptr));
1268f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1269f1580f4eSBarry Smith       PetscCall(MatAXPY(sum[0], -1.0, sum[1], SAME_NONZERO_PATTERN));
1270f1580f4eSBarry Smith       PetscCall(MatDestroy(sum + 1));
1271f1580f4eSBarry Smith       /* re-order values to be consistent with MatSetValuesBlocked()           */
1272f1580f4eSBarry Smith       /* equivalent to MatTranspose() which does not truly handle              */
1273f1580f4eSBarry Smith       /* MAT_INPLACE_MATRIX in the rectangular case, as it calls PetscMalloc() */
1274f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(sum[0], &ptr));
1275f1580f4eSBarry Smith       HPDDM::Wrapper<PetscScalar>::imatcopy<'T'>(bs, sum[0]->rmap->n, ptr, sum[0]->rmap->n, bs);
1276f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1277f1580f4eSBarry Smith       for (n = 0; n < aux->cmap->n / bs; ++n) PetscCall(MatSetValuesBlocked(aux, 1, &n, 1, &n, ptr + n * bs * bs, ADD_VALUES));
1278f1580f4eSBarry Smith       PetscCall(MatAssemblyBegin(aux, MAT_FINAL_ASSEMBLY));
1279f1580f4eSBarry Smith       PetscCall(MatAssemblyEnd(aux, MAT_FINAL_ASSEMBLY));
1280f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(sum[0], &ptr));
1281f1580f4eSBarry Smith       PetscCall(MatDestroy(sum));
1282f1580f4eSBarry Smith     }
1283f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
1284f1580f4eSBarry Smith     /* left-hand side of GenEO, with the same sparsity pattern as PCASM subdomain solvers  */
1285f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Neumann_Mat", (PetscObject)aux));
1286f1580f4eSBarry Smith   }
1287f1580f4eSBarry Smith   PetscCall(ISDestroy(irow));
1288f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &M));
12893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1290f1580f4eSBarry Smith }
1291f1580f4eSBarry Smith 
129213044ca3SPierre Jolivet static PetscErrorCode PCApply_Nest(PC pc, Vec x, Vec y)
129313044ca3SPierre Jolivet {
129413044ca3SPierre Jolivet   Mat                    A;
129513044ca3SPierre Jolivet   MatSolverType          type;
129613044ca3SPierre Jolivet   IS                     is[2];
129713044ca3SPierre Jolivet   PetscBool              flg;
129813044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
129913044ca3SPierre Jolivet 
130013044ca3SPierre Jolivet   PetscFunctionBegin;
130113044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
130213044ca3SPierre Jolivet   PetscCall(PCGetOperators(p->first, &A, nullptr));
130313044ca3SPierre Jolivet   PetscCall(MatNestGetISs(A, is, nullptr));
130413044ca3SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(p->first, &type));
130513044ca3SPierre Jolivet   PetscCall(PCFactorGetMatrix(p->first, &A));
130613044ca3SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
130724ddd604SPierre Jolivet   if (flg && A->schur) {
130813044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
130913044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 1)); /* reduction/condensation phase followed by Schur complement solve */
131013044ca3SPierre Jolivet #endif
131113044ca3SPierre Jolivet   }
131213044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[0], is[1], SCATTER_FORWARD, x)); /* assign the RHS associated to the Schur complement */
131313044ca3SPierre Jolivet   PetscCall(PCApply(p->first, p->second[0], p->second[1]));
131413044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[1], is[1], SCATTER_REVERSE, y)); /* retrieve the partial solution associated to the Schur complement */
131513044ca3SPierre Jolivet   if (flg) {
131613044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
131713044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1)); /* default ICNTL(26) value in PETSc */
131813044ca3SPierre Jolivet #endif
131913044ca3SPierre Jolivet   }
132013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
132113044ca3SPierre Jolivet }
132213044ca3SPierre Jolivet 
132313044ca3SPierre Jolivet static PetscErrorCode PCView_Nest(PC pc, PetscViewer viewer)
132413044ca3SPierre Jolivet {
132513044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
132613044ca3SPierre Jolivet 
132713044ca3SPierre Jolivet   PetscFunctionBegin;
132813044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
132913044ca3SPierre Jolivet   PetscCall(PCView(p->first, viewer));
133013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
133113044ca3SPierre Jolivet }
133213044ca3SPierre Jolivet 
133313044ca3SPierre Jolivet static PetscErrorCode PCDestroy_Nest(PC pc)
133413044ca3SPierre Jolivet {
133513044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
133613044ca3SPierre Jolivet 
133713044ca3SPierre Jolivet   PetscFunctionBegin;
133813044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
133913044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second));
134013044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second + 1));
134113044ca3SPierre Jolivet   PetscCall(PCDestroy(&p->first));
134213044ca3SPierre Jolivet   PetscCall(PetscFree(p));
134313044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
134413044ca3SPierre Jolivet }
134513044ca3SPierre Jolivet 
134613044ca3SPierre Jolivet template <bool T = false>
134713044ca3SPierre Jolivet static PetscErrorCode MatMult_Schur(Mat A, Vec x, Vec y)
134813044ca3SPierre Jolivet {
134913044ca3SPierre Jolivet   std::tuple<Mat, VecScatter, Vec[2]> *ctx;
135013044ca3SPierre Jolivet 
135113044ca3SPierre Jolivet   PetscFunctionBegin;
135213044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
135313044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD)); /* local Vec with overlap */
135413044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD));
135513044ca3SPierre Jolivet   if (!T) PetscCall(MatMult(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1])); /* local Schur complement */
135613044ca3SPierre Jolivet   else PetscCall(MatMultTranspose(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1]));
135713044ca3SPierre Jolivet   PetscCall(VecSet(y, 0.0));
135813044ca3SPierre 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 */
135913044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE));
136013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
136113044ca3SPierre Jolivet }
136213044ca3SPierre Jolivet 
136313044ca3SPierre Jolivet static PetscErrorCode MatDestroy_Schur(Mat A)
136413044ca3SPierre Jolivet {
136513044ca3SPierre Jolivet   std::tuple<Mat, VecScatter, Vec[2]> *ctx;
136613044ca3SPierre Jolivet 
136713044ca3SPierre Jolivet   PetscFunctionBegin;
136813044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
136913044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx)));
137013044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx) + 1));
137113044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
137213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
137313044ca3SPierre Jolivet }
137413044ca3SPierre Jolivet 
137513044ca3SPierre Jolivet static PetscErrorCode MatMult_SchurCorrection(Mat A, Vec x, Vec y)
137613044ca3SPierre Jolivet {
137713044ca3SPierre Jolivet   PC                                         pc;
137813044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
137913044ca3SPierre Jolivet 
138013044ca3SPierre Jolivet   PetscFunctionBegin;
138113044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
138213044ca3SPierre Jolivet   pc = ((PC_HPDDM *)std::get<0>(*ctx)[0]->data)->levels[0]->ksp->pc;
138313044ca3SPierre 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 */
138413044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], x, std::get<3>(*ctx)[1]));                    /*     A_01 x                 */
138513044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 x             */
138613044ca3SPierre 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        */
138713044ca3SPierre 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 */
138813044ca3SPierre Jolivet   } else {
138913044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[0]));                    /*     M_S^-1 x               */
139013044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], std::get<3>(*ctx)[0], std::get<3>(*ctx)[1])); /*     A_01 M_S^-1 x          */
139113044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 M_S^-1 x      */
139213044ca3SPierre 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 */
139313044ca3SPierre Jolivet   }
139413044ca3SPierre Jolivet   PetscCall(VecAXPY(y, -1.0, x)); /* y -= x, preconditioned eq. (24) of https://hal.science/hal-02343808v6/document (with a sign flip) */
139513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
139613044ca3SPierre Jolivet }
139713044ca3SPierre Jolivet 
139813044ca3SPierre Jolivet static PetscErrorCode MatView_SchurCorrection(Mat A, PetscViewer viewer)
139913044ca3SPierre Jolivet {
140013044ca3SPierre Jolivet   PetscBool                                  ascii;
140113044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
140213044ca3SPierre Jolivet 
140313044ca3SPierre Jolivet   PetscFunctionBegin;
140413044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &ascii));
140513044ca3SPierre Jolivet   if (ascii) {
140613044ca3SPierre Jolivet     PetscCall(MatShellGetContext(A, &ctx));
140713044ca3SPierre 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)"));
140813044ca3SPierre Jolivet     PetscCall(PCView(std::get<0>(*ctx)[1], viewer)); /* no need to PCView(Q_0) since it will be done by PCFIELDSPLIT */
140913044ca3SPierre Jolivet   }
141013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
141113044ca3SPierre Jolivet }
141213044ca3SPierre Jolivet 
141313044ca3SPierre Jolivet static PetscErrorCode MatDestroy_SchurCorrection(Mat A)
141413044ca3SPierre Jolivet {
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   PetscCall(VecDestroy(std::get<3>(*ctx)));
142013044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 1));
142113044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 2));
142213044ca3SPierre Jolivet   PetscCall(PCDestroy(std::get<0>(*ctx) + 1));
142313044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
142413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
142513044ca3SPierre Jolivet }
142613044ca3SPierre Jolivet 
142713044ca3SPierre Jolivet static PetscErrorCode KSPPreSolve_SchurCorrection(KSP, Vec b, Vec, void *context)
142813044ca3SPierre Jolivet {
142913044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
143013044ca3SPierre Jolivet 
1431a6b3e571SPierre Jolivet   PetscFunctionBegin;
143213044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
143313044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], b, std::get<3>(*ctx)[2]));
143413044ca3SPierre 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 */
143513044ca3SPierre Jolivet   }
143613044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
143713044ca3SPierre Jolivet }
143813044ca3SPierre Jolivet 
143913044ca3SPierre Jolivet static PetscErrorCode KSPPostSolve_SchurCorrection(KSP, Vec b, Vec x, void *context)
144013044ca3SPierre Jolivet {
144113044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
144213044ca3SPierre Jolivet 
1443a6b3e571SPierre Jolivet   PetscFunctionBegin;
144413044ca3SPierre 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 */
144513044ca3SPierre Jolivet   else {
144613044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[2]));
144713044ca3SPierre Jolivet     PetscCall(VecCopy(std::get<3>(*ctx)[2], x)); /* replace x by M^-1 x */
144813044ca3SPierre Jolivet   }
144913044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
145013044ca3SPierre Jolivet }
145113044ca3SPierre Jolivet 
14529bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat, Vec, Vec);
14539bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat, Vec, Vec);
14549bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat, Mat, Mat, void *);
14559bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat);
14569bb5c669SPierre Jolivet 
1457d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDM(PC pc)
1458d71ae5a4SJacob Faibussowitsch {
1459f1580f4eSBarry Smith   PC_HPDDM                                  *data = (PC_HPDDM *)pc->data;
1460f1580f4eSBarry Smith   PC                                         inner;
1461f1580f4eSBarry Smith   KSP                                       *ksp;
146213044ca3SPierre Jolivet   Mat                                       *sub, A, P, N, C = nullptr, uaux = nullptr, weighted, subA[2], S;
1463f1580f4eSBarry Smith   Vec                                        xin, v;
1464f1580f4eSBarry Smith   std::vector<Vec>                           initial;
1465db4a47b3SPierre Jolivet   IS                                         is[1], loc, uis = data->is, unsorted = nullptr;
1466f1580f4eSBarry Smith   ISLocalToGlobalMapping                     l2g;
1467f1580f4eSBarry Smith   char                                       prefix[256];
1468f1580f4eSBarry Smith   const char                                *pcpre;
1469f1580f4eSBarry Smith   const PetscScalar *const                  *ev;
14709bb5c669SPierre Jolivet   PetscInt                                   n, requested = data->N, reused = 0, overlap = -1;
1471f1580f4eSBarry Smith   MatStructure                               structure  = UNKNOWN_NONZERO_PATTERN;
1472f1580f4eSBarry Smith   PetscBool                                  subdomains = PETSC_FALSE, flg = PETSC_FALSE, ismatis, swap = PETSC_FALSE, algebraic = PETSC_FALSE, block = PETSC_FALSE;
1473f1580f4eSBarry Smith   DM                                         dm;
147413044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = nullptr;
1475398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1476db4a47b3SPierre Jolivet   IS  dis  = nullptr;
1477db4a47b3SPierre Jolivet   Mat daux = nullptr;
1478398c7888SPierre Jolivet #endif
1479f1580f4eSBarry Smith 
1480f1580f4eSBarry Smith   PetscFunctionBegin;
1481f1580f4eSBarry Smith   PetscCheck(data->levels && data->levels[0], PETSC_COMM_SELF, PETSC_ERR_PLIB, "Not a single level allocated");
1482f1580f4eSBarry Smith   PetscCall(PCGetOptionsPrefix(pc, &pcpre));
1483f1580f4eSBarry Smith   PetscCall(PCGetOperators(pc, &A, &P));
1484f1580f4eSBarry Smith   if (!data->levels[0]->ksp) {
1485f1580f4eSBarry Smith     PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->ksp));
14863821be0aSBarry Smith     PetscCall(KSPSetNestLevel(data->levels[0]->ksp, pc->kspnestlevel));
1487f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_%s_", pcpre ? pcpre : "", data->N > 1 ? "levels_1" : "coarse"));
1488f1580f4eSBarry Smith     PetscCall(KSPSetOptionsPrefix(data->levels[0]->ksp, prefix));
1489f1580f4eSBarry Smith     PetscCall(KSPSetType(data->levels[0]->ksp, KSPPREONLY));
1490f1580f4eSBarry Smith   } else if (data->levels[0]->ksp->pc && data->levels[0]->ksp->pc->setupcalled == 1 && data->levels[0]->ksp->pc->reusepreconditioner) {
1491f1580f4eSBarry Smith     /* if the fine-level PCSHELL exists, its setup has succeeded, and one wants to reuse it, */
1492f1580f4eSBarry Smith     /* then just propagate the appropriate flag to the coarser levels                        */
1493f1580f4eSBarry Smith     for (n = 0; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1494f1580f4eSBarry Smith       /* the following KSP and PC may be NULL for some processes, hence the check            */
1495f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetReusePreconditioner(data->levels[n]->ksp, PETSC_TRUE));
1496f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
1497f1580f4eSBarry Smith     }
1498f1580f4eSBarry Smith     /* early bail out because there is nothing to do */
14993ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1500f1580f4eSBarry Smith   } else {
1501f1580f4eSBarry Smith     /* reset coarser levels */
1502f1580f4eSBarry Smith     for (n = 1; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1503f1580f4eSBarry 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) {
1504f1580f4eSBarry Smith         reused = data->N - n;
1505f1580f4eSBarry Smith         break;
1506f1580f4eSBarry Smith       }
1507f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[n]->ksp));
1508f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[n]->pc));
1509f1580f4eSBarry Smith     }
1510f1580f4eSBarry Smith     /* check if some coarser levels are being reused */
1511f1580f4eSBarry Smith     PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &reused, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)pc)));
1512f1580f4eSBarry Smith     const int *addr = data->levels[0]->P ? data->levels[0]->P->getAddrLocal() : &HPDDM::i__0;
1513f1580f4eSBarry Smith 
1514f1580f4eSBarry Smith     if (addr != &HPDDM::i__0 && reused != data->N - 1) {
1515f1580f4eSBarry Smith       /* reuse previously computed eigenvectors */
1516f1580f4eSBarry Smith       ev = data->levels[0]->P->getVectors();
1517f1580f4eSBarry Smith       if (ev) {
1518f1580f4eSBarry Smith         initial.reserve(*addr);
1519f1580f4eSBarry Smith         PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, data->levels[0]->P->getDof(), ev[0], &xin));
1520f1580f4eSBarry Smith         for (n = 0; n < *addr; ++n) {
1521f1580f4eSBarry Smith           PetscCall(VecDuplicate(xin, &v));
1522f1580f4eSBarry Smith           PetscCall(VecPlaceArray(xin, ev[n]));
1523f1580f4eSBarry Smith           PetscCall(VecCopy(xin, v));
1524f1580f4eSBarry Smith           initial.emplace_back(v);
1525f1580f4eSBarry Smith           PetscCall(VecResetArray(xin));
1526f1580f4eSBarry Smith         }
1527f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
1528f1580f4eSBarry Smith       }
1529f1580f4eSBarry Smith     }
1530f1580f4eSBarry Smith   }
1531f1580f4eSBarry Smith   data->N -= reused;
1532f1580f4eSBarry Smith   PetscCall(KSPSetOperators(data->levels[0]->ksp, A, P));
1533f1580f4eSBarry Smith 
1534f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATIS, &ismatis));
1535f1580f4eSBarry Smith   if (!data->is && !ismatis) {
1536db4a47b3SPierre Jolivet     PetscErrorCode (*create)(DM, IS *, Mat *, PetscErrorCode (**)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void **) = nullptr;
1537db4a47b3SPierre Jolivet     PetscErrorCode (*usetup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *)                                                = nullptr;
1538db4a47b3SPierre Jolivet     void *uctx                                                                                                               = nullptr;
1539f1580f4eSBarry Smith 
1540f1580f4eSBarry Smith     /* first see if we can get the data from the DM */
1541f1580f4eSBarry Smith     PetscCall(MatGetDM(P, &dm));
1542f1580f4eSBarry Smith     if (!dm) PetscCall(MatGetDM(A, &dm));
1543f1580f4eSBarry Smith     if (!dm) PetscCall(PCGetDM(pc, &dm));
1544f1580f4eSBarry Smith     if (dm) { /* this is the hook for DMPLEX and DMDA for which the auxiliary Mat is the local Neumann matrix */
1545f1580f4eSBarry Smith       PetscCall(PetscObjectQueryFunction((PetscObject)dm, "DMCreateNeumannOverlap_C", &create));
1546f1580f4eSBarry Smith       if (create) {
1547f1580f4eSBarry Smith         PetscCall((*create)(dm, &uis, &uaux, &usetup, &uctx));
1548c8ea6600SPierre 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 */
1549f1580f4eSBarry Smith       }
1550f1580f4eSBarry Smith     }
1551f1580f4eSBarry Smith     if (!create) {
1552f1580f4eSBarry Smith       if (!uis) {
1553f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1554f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1555f1580f4eSBarry Smith       }
1556f1580f4eSBarry Smith       if (!uaux) {
1557f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1558f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1559f1580f4eSBarry Smith       }
1560f1580f4eSBarry Smith       /* look inside the Pmat instead of the PC, needed for MatSchurComplementComputeExplicitOperator() */
1561f1580f4eSBarry Smith       if (!uis) {
1562f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1563f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1564f1580f4eSBarry Smith       }
1565f1580f4eSBarry Smith       if (!uaux) {
1566f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1567f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1568f1580f4eSBarry Smith       }
1569f1580f4eSBarry Smith     }
1570f1580f4eSBarry Smith     PetscCall(PCHPDDMSetAuxiliaryMat(pc, uis, uaux, usetup, uctx));
1571f1580f4eSBarry Smith     PetscCall(MatDestroy(&uaux));
1572f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
1573f1580f4eSBarry Smith   }
1574f1580f4eSBarry Smith 
1575f1580f4eSBarry Smith   if (!ismatis) {
1576f1580f4eSBarry Smith     PetscCall(PCHPDDMSetUpNeumannOverlap_Private(pc));
1577db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_block_splitting", &block, nullptr));
15789bb5c669SPierre Jolivet     PetscCall(PetscOptionsGetInt(nullptr, pcpre, "-pc_hpddm_harmonic_overlap", &overlap, nullptr));
15795e642048SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
15805e642048SPierre Jolivet     if (data->is || (data->N > 1 && flg)) {
15819bb5c669SPierre Jolivet       if (block || overlap != -1) {
158202800ff6SPierre Jolivet         PetscCall(ISDestroy(&data->is));
158302800ff6SPierre Jolivet         PetscCall(MatDestroy(&data->aux));
15845e642048SPierre Jolivet       } else if (data->N > 1 && flg) {
158513044ca3SPierre Jolivet         PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_GENEO;
158613044ca3SPierre Jolivet 
158713044ca3SPierre Jolivet         PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
158813044ca3SPierre Jolivet         if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
158913044ca3SPierre Jolivet           PetscCall(ISDestroy(&data->is)); /* destroy any previously user-set objects since they will be set automatically */
159013044ca3SPierre Jolivet           PetscCall(MatDestroy(&data->aux));
159113044ca3SPierre Jolivet         } else if (type == PC_HPDDM_SCHUR_PRE_GENEO) {
159213044ca3SPierre Jolivet           PetscContainer container = nullptr;
159313044ca3SPierre Jolivet 
159413044ca3SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Schur", (PetscObject *)&container));
159513044ca3SPierre Jolivet           if (!container) { /* first call to PCSetUp() on the PC associated to the Schur complement */
159613044ca3SPierre Jolivet             PC_HPDDM *data_00;
159713044ca3SPierre Jolivet             KSP       ksp, inner_ksp;
159813044ca3SPierre Jolivet             PC        pc_00;
159913044ca3SPierre Jolivet             char     *prefix;
160013044ca3SPierre Jolivet             PetscReal norm;
160113044ca3SPierre Jolivet 
160213044ca3SPierre Jolivet             PetscCall(MatSchurComplementGetKSP(P, &ksp));
160313044ca3SPierre Jolivet             PetscCall(KSPGetPC(ksp, &pc_00));
160413044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)pc_00, PCHPDDM, &flg));
160513044ca3SPierre Jolivet             PetscCheck(flg, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition geneo and -%spc_type %s (!= %s)", pcpre ? pcpre : "", ((PetscObject)pc_00)->prefix ? ((PetscObject)pc_00)->prefix : "",
160613044ca3SPierre Jolivet                        ((PetscObject)pc_00)->type_name, PCHPDDM);
160713044ca3SPierre Jolivet             data_00 = (PC_HPDDM *)pc_00->data;
160813044ca3SPierre Jolivet             PetscCheck(data_00->N == 2, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition geneo and %" PetscInt_FMT " level%s instead of 2 for the A00 block -%s", pcpre ? pcpre : "", data_00->N, data_00->N > 1 ? "s" : "",
160913044ca3SPierre Jolivet                        ((PetscObject)pc_00)->prefix);
161013044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)data_00->levels[0]->pc, PCASM, &flg));
161113044ca3SPierre Jolivet             PetscCheck(flg, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition geneo and -%spc_type %s (!= %s)", pcpre ? pcpre : "", ((PetscObject)data_00->levels[0]->pc)->prefix,
161213044ca3SPierre Jolivet                        ((PetscObject)data_00->levels[0]->pc)->type_name, PCASM);
161313044ca3SPierre Jolivet             PetscCheck(data->Neumann == PETSC_BOOL3_TRUE, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition geneo and -%spc_hpddm_has_neumann != true", pcpre ? pcpre : "", pcpre ? pcpre : "");
16145e642048SPierre Jolivet             if (PetscDefined(USE_DEBUG) || !data->is) {
16155e642048SPierre Jolivet               Mat A01, A10, B = nullptr, C = nullptr, *sub;
161613044ca3SPierre Jolivet 
16175e642048SPierre Jolivet               PetscCall(MatSchurComplementGetSubMatrices(P, &A, nullptr, &A01, &A10, nullptr));
16185e642048SPierre Jolivet               PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
16195e642048SPierre Jolivet               if (flg) {
16205e642048SPierre Jolivet                 PetscCall(MatTransposeGetMat(A10, &C));
16215e642048SPierre Jolivet                 PetscCall(MatTranspose(C, MAT_INITIAL_MATRIX, &B));
16225e642048SPierre Jolivet               } else {
16235e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
16245e642048SPierre Jolivet                 if (flg) {
16255e642048SPierre Jolivet                   PetscCall(MatHermitianTransposeGetMat(A10, &C));
16265e642048SPierre Jolivet                   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &B));
16275e642048SPierre Jolivet                 }
16285e642048SPierre Jolivet               }
16295e642048SPierre Jolivet               if (!B) {
16305e642048SPierre Jolivet                 B = A10;
16315e642048SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)B));
16325e642048SPierre Jolivet               } else if (!data->is) {
16335e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompareAny((PetscObject)A01, &flg, MATTRANSPOSEVIRTUAL, MATHERMITIANTRANSPOSEVIRTUAL, ""));
16345e642048SPierre Jolivet                 if (!flg) C = A01;
16355e642048SPierre Jolivet               }
163613044ca3SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, B->rmap->N, 0, 1, &uis));
16375e642048SPierre Jolivet               PetscCall(ISSetIdentity(uis));
16385e642048SPierre Jolivet               if (!data->is) {
16395e642048SPierre Jolivet                 if (C) PetscCall(PetscObjectReference((PetscObject)C));
16405e642048SPierre Jolivet                 else PetscCall(MatTranspose(B, MAT_INITIAL_MATRIX, &C));
16415e642048SPierre Jolivet                 PetscCall(ISDuplicate(data_00->is, is));
16425e642048SPierre Jolivet                 PetscCall(MatIncreaseOverlap(A, 1, is, 1));
16435e642048SPierre Jolivet                 PetscCall(MatSetOption(C, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
16445e642048SPierre Jolivet                 PetscCall(MatCreateSubMatrices(C, 1, is, &uis, MAT_INITIAL_MATRIX, &sub));
16455e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
16465e642048SPierre Jolivet                 PetscCall(MatTranspose(sub[0], MAT_INITIAL_MATRIX, &C));
16475e642048SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
16485e642048SPierre Jolivet                 PetscCall(MatFindNonzeroRows(C, &data->is));
16495e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
16505e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
16515e642048SPierre Jolivet               }
16525e642048SPierre Jolivet               if (PetscDefined(USE_DEBUG)) {
16535e642048SPierre Jolivet                 PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
165413044ca3SPierre 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 */
165513044ca3SPierre Jolivet                 PetscCall(ISDestroy(&uis));
165613044ca3SPierre Jolivet                 PetscCall(ISDuplicate(data->is, &uis));
165713044ca3SPierre Jolivet                 PetscCall(ISSort(uis));
16585e642048SPierre Jolivet                 PetscCall(ISComplement(uis, 0, B->rmap->N, is));
165913044ca3SPierre Jolivet                 PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &C));
16605e642048SPierre Jolivet                 PetscCall(MatZeroRowsIS(C, is[0], 0.0, nullptr, nullptr));
16615e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
166213044ca3SPierre Jolivet                 PetscCall(MatMultEqual(sub[0], C, 20, &flg));
166313044ca3SPierre 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 */
166413044ca3SPierre Jolivet                 PetscCall(MatDestroy(&C));
166513044ca3SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
166613044ca3SPierre Jolivet               }
16675e642048SPierre Jolivet               PetscCall(ISDestroy(&uis));
16685e642048SPierre Jolivet               PetscCall(MatDestroy(&B));
16695e642048SPierre Jolivet             }
167013044ca3SPierre Jolivet             if (data->aux) PetscCall(MatNorm(data->aux, NORM_FROBENIUS, &norm));
167113044ca3SPierre Jolivet             else norm = 0.0;
167213044ca3SPierre Jolivet             PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &norm, 1, MPIU_REAL, MPI_MAX, PetscObjectComm((PetscObject)P)));
16730594bca0SPierre 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 */
167413044ca3SPierre Jolivet               VecScatter         scatter;
167513044ca3SPierre Jolivet               Vec                x;
167613044ca3SPierre Jolivet               const PetscScalar *read;
167713044ca3SPierre Jolivet               PetscScalar       *write;
167813044ca3SPierre Jolivet 
167913044ca3SPierre Jolivet               PetscCall(MatDestroy(&data->aux));
168013044ca3SPierre Jolivet               PetscCall(ISGetLocalSize(data->is, &n));
168113044ca3SPierre Jolivet               PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &x));
168213044ca3SPierre Jolivet               PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &v));
168313044ca3SPierre Jolivet               PetscCall(VecScatterCreate(x, data->is, v, nullptr, &scatter));
168413044ca3SPierre Jolivet               PetscCall(VecSet(v, 1.0));
168513044ca3SPierre Jolivet               PetscCall(VecSet(x, 1.0));
168613044ca3SPierre Jolivet               PetscCall(VecScatterBegin(scatter, v, x, ADD_VALUES, SCATTER_REVERSE));
168713044ca3SPierre Jolivet               PetscCall(VecScatterEnd(scatter, v, x, ADD_VALUES, SCATTER_REVERSE)); /* v has the multiplicity of all unknowns on the overlap */
168813044ca3SPierre Jolivet               PetscCall(VecScatterDestroy(&scatter));
168913044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
169013044ca3SPierre Jolivet               PetscCall(VecCreateSeq(PETSC_COMM_SELF, n, &v));
169113044ca3SPierre Jolivet               PetscCall(VecGetArrayRead(x, &read));
169213044ca3SPierre Jolivet               PetscCall(VecGetArrayWrite(v, &write));
16930594bca0SPierre Jolivet               PetscCallCXX(std::transform(read, read + n, write, [](const PetscScalar &m) { return PETSC_SMALL / (static_cast<PetscReal>(1000.0) * m); }));
169413044ca3SPierre Jolivet               PetscCall(VecRestoreArrayRead(x, &read));
169513044ca3SPierre Jolivet               PetscCall(VecRestoreArrayWrite(v, &write));
169613044ca3SPierre Jolivet               PetscCall(VecDestroy(&x));
1697c3e1b152SPierre Jolivet               PetscCall(MatCreateDiagonal(v, &data->aux));
169813044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
169913044ca3SPierre Jolivet             }
170013044ca3SPierre Jolivet             uis  = data->is;
170113044ca3SPierre Jolivet             uaux = data->aux;
170213044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uis));
170313044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uaux));
170413044ca3SPierre Jolivet             PetscCall(PetscStrallocpy(pcpre, &prefix));
170513044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(pc, nullptr));
170613044ca3SPierre Jolivet             PetscCall(PCSetType(pc, PCKSP));                                    /* replace the PC associated to the Schur complement by PCKSP */
170713044ca3SPierre Jolivet             PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &inner_ksp)); /* new KSP that will be attached to the previously set PC */
170873329a61SPierre Jolivet             pc->ops->setup = PCSetUp_KSP;
170913044ca3SPierre Jolivet             PetscCall(PetscObjectGetTabLevel((PetscObject)pc, &n));
171013044ca3SPierre Jolivet             PetscCall(PetscObjectSetTabLevel((PetscObject)inner_ksp, n + 2));
171113044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, pc->mat, pc->pmat));
171213044ca3SPierre Jolivet             PetscCall(KSPSetOptionsPrefix(inner_ksp, std::string(std::string(prefix) + "pc_hpddm_").c_str()));
171313044ca3SPierre Jolivet             PetscCall(KSPSetSkipPCSetFromOptions(inner_ksp, PETSC_TRUE));
171413044ca3SPierre Jolivet             PetscCall(KSPSetFromOptions(inner_ksp));
171513044ca3SPierre Jolivet             PetscCall(KSPGetPC(inner_ksp, &inner));
171613044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(inner, nullptr));
171713044ca3SPierre Jolivet             PetscCall(PCSetType(inner, PCNONE)); /* no preconditioner since the action of M^-1 A or A M^-1 will be computed by the Amat */
171813044ca3SPierre Jolivet             PetscCall(PCKSPSetKSP(pc, inner_ksp));
171913044ca3SPierre Jolivet             PetscCall(PetscContainerCreate(PetscObjectComm((PetscObject)pc), &container));
172013044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx)); /* context to pass data around for the inner-most PC, which will be a proper PCHPDDM */
172113044ca3SPierre Jolivet             PetscCall(PetscContainerSetPointer(container, ctx));
172213044ca3SPierre Jolivet             std::get<0>(*ctx)[0] = pc_00; /* for coarse correction on the primal (e.g., velocity) space */
172313044ca3SPierre Jolivet             PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &std::get<0>(*ctx)[1]));
172413044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(std::get<0>(*ctx)[1], prefix));
172513044ca3SPierre Jolivet             PetscCall(PetscFree(prefix));
172613044ca3SPierre Jolivet             PetscCall(PCSetOperators(std::get<0>(*ctx)[1], pc->mat, pc->pmat));
172713044ca3SPierre Jolivet             PetscCall(PCSetType(std::get<0>(*ctx)[1], PCHPDDM));
172813044ca3SPierre 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 */
172913044ca3SPierre Jolivet             PetscCall(PCSetFromOptions(std::get<0>(*ctx)[1]));
173013044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uis));
173113044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uaux));
173213044ca3SPierre 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 */
173313044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_MULT, (void (*)(void))MatMult_SchurCorrection));
173413044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_VIEW, (void (*)(void))MatView_SchurCorrection));
173513044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_DESTROY, (void (*)(void))MatDestroy_SchurCorrection));
173613044ca3SPierre Jolivet             PetscCall(KSPGetPCSide(inner_ksp, &(std::get<2>(*ctx))));
173713044ca3SPierre Jolivet             if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
173813044ca3SPierre Jolivet               PetscCall(KSPSetPreSolve(inner_ksp, KSPPreSolve_SchurCorrection, ctx));
173913044ca3SPierre Jolivet             } else { /* no support for PC_SYMMETRIC */
174013044ca3SPierre 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]);
174113044ca3SPierre Jolivet             }
174213044ca3SPierre Jolivet             PetscCall(KSPSetPostSolve(inner_ksp, KSPPostSolve_SchurCorrection, ctx));
174313044ca3SPierre Jolivet             PetscCall(PetscObjectCompose((PetscObject)(std::get<0>(*ctx)[1]), "_PCHPDDM_Schur", (PetscObject)container));
174413044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)container));
174513044ca3SPierre Jolivet             PetscCall(PCSetUp(std::get<0>(*ctx)[1]));
174613044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, S, S));
174713044ca3SPierre Jolivet             PetscCall(MatCreateVecs(std::get<1>(*ctx)[0], std::get<3>(*ctx), std::get<3>(*ctx) + 1));
174813044ca3SPierre Jolivet             PetscCall(VecDuplicate(std::get<3>(*ctx)[0], std::get<3>(*ctx) + 2));
174913044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)inner_ksp));
175013044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)S));
175113044ca3SPierre Jolivet             PetscFunctionReturn(PETSC_SUCCESS);
175213044ca3SPierre Jolivet           } else { /* second call to PCSetUp() on the PC associated to the Schur complement, retrieve previously set context */
175313044ca3SPierre Jolivet             PetscCall(PetscContainerGetPointer(container, (void **)&ctx));
175413044ca3SPierre Jolivet           }
175513044ca3SPierre Jolivet         }
175613044ca3SPierre Jolivet       }
175713044ca3SPierre Jolivet     }
1758f1580f4eSBarry Smith     if (!data->is && data->N > 1) {
1759f1580f4eSBarry Smith       char type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
1760f1580f4eSBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
1761f1580f4eSBarry Smith       if (flg || (A->rmap->N != A->cmap->N && P->rmap->N == P->cmap->N && P->rmap->N == A->cmap->N)) {
1762f1580f4eSBarry Smith         Mat B;
1763f1580f4eSBarry Smith         PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, A, P, &B, pcpre));
1764f1580f4eSBarry Smith         if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) data->correction = PC_HPDDM_COARSE_CORRECTION_BALANCED;
1765f1580f4eSBarry Smith         PetscCall(MatDestroy(&B));
1766f1580f4eSBarry Smith       } else {
1767f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
1768f1580f4eSBarry Smith         if (flg) {
1769f1580f4eSBarry Smith           Mat                 A00, P00, A01, A10, A11, B, N;
177013044ca3SPierre Jolivet           PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_LEAST_SQUARES;
177113044ca3SPierre Jolivet 
177213044ca3SPierre Jolivet           PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, &A01, &A10, &A11));
177313044ca3SPierre Jolivet           if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
177413044ca3SPierre Jolivet           PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
177513044ca3SPierre Jolivet           if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
17763df4cd7bSPierre Jolivet             Vec                        diagonal = nullptr;
1777f1580f4eSBarry Smith             const PetscScalar         *array;
1778f1580f4eSBarry Smith             MatSchurComplementAinvType type;
1779f1580f4eSBarry Smith 
1780f1580f4eSBarry Smith             if (A11) {
17813df4cd7bSPierre Jolivet               PetscCall(MatCreateVecs(A11, &diagonal, nullptr));
17823df4cd7bSPierre Jolivet               PetscCall(MatGetDiagonal(A11, diagonal));
1783f1580f4eSBarry Smith             }
1784db4a47b3SPierre Jolivet             PetscCall(MatCreateVecs(P00, &v, nullptr));
1785f1580f4eSBarry Smith             PetscCall(MatSchurComplementGetAinvType(P, &type));
1786f1580f4eSBarry 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]);
1787f1580f4eSBarry Smith             if (type == MAT_SCHUR_COMPLEMENT_AINV_LUMP) {
1788f1580f4eSBarry Smith               PetscCall(MatGetRowSum(P00, v));
1789f1580f4eSBarry Smith               if (A00 == P00) PetscCall(PetscObjectReference((PetscObject)A00));
1790f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1791f1580f4eSBarry Smith               PetscCall(VecGetArrayRead(v, &array));
1792db4a47b3SPierre Jolivet               PetscCall(MatCreateAIJ(PetscObjectComm((PetscObject)A00), A00->rmap->n, A00->cmap->n, A00->rmap->N, A00->cmap->N, 1, nullptr, 0, nullptr, &P00));
1793f1580f4eSBarry Smith               PetscCall(MatSetOption(P00, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
1794f1580f4eSBarry Smith               for (n = A00->rmap->rstart; n < A00->rmap->rend; ++n) PetscCall(MatSetValue(P00, n, n, array[n - A00->rmap->rstart], INSERT_VALUES));
1795f1580f4eSBarry Smith               PetscCall(MatAssemblyBegin(P00, MAT_FINAL_ASSEMBLY));
1796f1580f4eSBarry Smith               PetscCall(MatAssemblyEnd(P00, MAT_FINAL_ASSEMBLY));
1797f1580f4eSBarry Smith               PetscCall(VecRestoreArrayRead(v, &array));
1798f1580f4eSBarry Smith               PetscCall(MatSchurComplementUpdateSubMatrices(P, A00, P00, A01, A10, A11)); /* replace P00 by diag(sum of each row of P00) */
1799f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1800f1580f4eSBarry Smith             } else PetscCall(MatGetDiagonal(P00, v));
1801f1580f4eSBarry Smith             PetscCall(VecReciprocal(v)); /* inv(diag(P00))       */
1802f1580f4eSBarry Smith             PetscCall(VecSqrtAbs(v));    /* sqrt(inv(diag(P00))) */
1803f1580f4eSBarry Smith             PetscCall(MatDuplicate(A01, MAT_COPY_VALUES, &B));
1804db4a47b3SPierre Jolivet             PetscCall(MatDiagonalScale(B, v, nullptr));
1805f1580f4eSBarry Smith             PetscCall(VecDestroy(&v));
1806f1580f4eSBarry Smith             PetscCall(MatCreateNormalHermitian(B, &N));
18073df4cd7bSPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, B, N, &P, pcpre, &diagonal));
1808f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
1809f1580f4eSBarry Smith             if (!flg) {
1810f1580f4eSBarry Smith               PetscCall(MatDestroy(&P));
1811f1580f4eSBarry Smith               P = N;
1812f1580f4eSBarry Smith               PetscCall(PetscObjectReference((PetscObject)P));
1813f1580f4eSBarry Smith             } else PetscCall(MatScale(P, -1.0));
18143df4cd7bSPierre Jolivet             if (diagonal) {
18153df4cd7bSPierre Jolivet               PetscCall(MatDiagonalSet(P, diagonal, ADD_VALUES));
1816aa21023fSPierre Jolivet               PetscCall(PCSetOperators(pc, P, P)); /* replace P by diag(P11) - A01^T inv(diag(P00)) A01 */
18173df4cd7bSPierre Jolivet               PetscCall(VecDestroy(&diagonal));
18183df4cd7bSPierre Jolivet             } else {
1819f1580f4eSBarry Smith               PetscCall(MatScale(N, -1.0));
1820aa21023fSPierre Jolivet               PetscCall(PCSetOperators(pc, N, P)); /* replace P by - A01^T inv(diag(P00)) A01 */
18213df4cd7bSPierre Jolivet             }
1822f1580f4eSBarry Smith             PetscCall(MatDestroy(&N));
1823f1580f4eSBarry Smith             PetscCall(MatDestroy(&P));
1824f1580f4eSBarry Smith             PetscCall(MatDestroy(&B));
182513044ca3SPierre Jolivet           } else
182613044ca3SPierre Jolivet             PetscCheck(type != PC_HPDDM_SCHUR_PRE_GENEO, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition geneo without a prior call to PCHPDDMSetAuxiliaryMat() on the A11 block%s%s", pcpre ? pcpre : "", pcpre ? " -" : "", pcpre ? pcpre : "");
18273ba16761SJacob Faibussowitsch           PetscFunctionReturn(PETSC_SUCCESS);
1828f1580f4eSBarry Smith         } else {
1829db4a47b3SPierre Jolivet           PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_st_pc_type", type, sizeof(type), nullptr));
1830f1580f4eSBarry Smith           PetscCall(PetscStrcmp(type, PCMAT, &algebraic));
1831b07dfdedSPierre Jolivet           PetscCheck(!algebraic || !block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_block_splitting");
18329bb5c669SPierre Jolivet           if (overlap != -1) {
18339bb5c669SPierre 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");
18349bb5c669SPierre Jolivet             PetscCheck(overlap >= 1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_WRONG, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " < 1", overlap);
18359bb5c669SPierre Jolivet           }
18369bb5c669SPierre Jolivet           if (block || overlap != -1) algebraic = PETSC_TRUE;
1837f1580f4eSBarry Smith           if (algebraic) {
1838f1580f4eSBarry Smith             PetscCall(ISCreateStride(PETSC_COMM_SELF, P->rmap->n, P->rmap->rstart, 1, &data->is));
1839f1580f4eSBarry Smith             PetscCall(MatIncreaseOverlap(P, 1, &data->is, 1));
1840f1580f4eSBarry Smith             PetscCall(ISSort(data->is));
18419bb5c669SPierre Jolivet           } else
18429bb5c669SPierre 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 : ""));
1843f1580f4eSBarry Smith         }
1844f1580f4eSBarry Smith       }
1845f1580f4eSBarry Smith     }
1846f1580f4eSBarry Smith   }
1847398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1848398c7888SPierre Jolivet   if (data->is) PetscCall(ISDuplicate(data->is, &dis));
1849398c7888SPierre Jolivet   if (data->aux) PetscCall(MatDuplicate(data->aux, MAT_COPY_VALUES, &daux));
1850398c7888SPierre Jolivet #endif
1851f1580f4eSBarry Smith   if (data->is || (ismatis && data->N > 1)) {
1852f1580f4eSBarry Smith     if (ismatis) {
1853f1580f4eSBarry Smith       std::initializer_list<std::string> list = {MATSEQBAIJ, MATSEQSBAIJ};
1854f1580f4eSBarry Smith       PetscCall(MatISGetLocalMat(P, &N));
1855f1580f4eSBarry Smith       std::initializer_list<std::string>::const_iterator it = std::find(list.begin(), list.end(), ((PetscObject)N)->type_name);
1856f1580f4eSBarry Smith       PetscCall(MatISRestoreLocalMat(P, &N));
1857f1580f4eSBarry Smith       switch (std::distance(list.begin(), it)) {
1858d71ae5a4SJacob Faibussowitsch       case 0:
1859d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
1860d71ae5a4SJacob Faibussowitsch         break;
1861f1580f4eSBarry Smith       case 1:
1862f1580f4eSBarry Smith         /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIBAIJ */
1863f1580f4eSBarry Smith         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
1864f1580f4eSBarry Smith         PetscCall(MatSetOption(C, MAT_SYMMETRIC, PETSC_TRUE));
1865f1580f4eSBarry Smith         break;
1866d71ae5a4SJacob Faibussowitsch       default:
1867d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, &C));
1868f1580f4eSBarry Smith       }
1869db4a47b3SPierre Jolivet       PetscCall(MatISGetLocalToGlobalMapping(P, &l2g, nullptr));
1870f1580f4eSBarry Smith       PetscCall(PetscObjectReference((PetscObject)P));
1871f1580f4eSBarry Smith       PetscCall(KSPSetOperators(data->levels[0]->ksp, A, C));
1872f1580f4eSBarry Smith       std::swap(C, P);
1873f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingGetSize(l2g, &n));
1874f1580f4eSBarry Smith       PetscCall(ISCreateStride(PETSC_COMM_SELF, n, 0, 1, &loc));
1875f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingApplyIS(l2g, loc, &is[0]));
1876f1580f4eSBarry Smith       PetscCall(ISDestroy(&loc));
1877f1580f4eSBarry Smith       /* the auxiliary Mat is _not_ the local Neumann matrix                                */
1878f1580f4eSBarry Smith       /* it is the local Neumann matrix augmented (with zeros) through MatIncreaseOverlap() */
1879c8ea6600SPierre Jolivet       data->Neumann = PETSC_BOOL3_FALSE;
1880f1580f4eSBarry Smith       structure     = SAME_NONZERO_PATTERN;
1881f1580f4eSBarry Smith     } else {
1882f1580f4eSBarry Smith       is[0] = data->is;
188313044ca3SPierre Jolivet       if (algebraic || ctx) subdomains = PETSC_TRUE;
1884db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_define_subdomains", &subdomains, nullptr));
188513044ca3SPierre 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);
1886c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann)) {
1887b07dfdedSPierre Jolivet         PetscCheck(!block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_block_splitting and -pc_hpddm_has_neumann");
18889bb5c669SPierre Jolivet         PetscCheck(overlap == -1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " and -pc_hpddm_has_neumann", overlap);
1889b07dfdedSPierre Jolivet         PetscCheck(!algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_has_neumann");
1890f1580f4eSBarry Smith       }
1891c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann) || block) structure = SAME_NONZERO_PATTERN;
1892f1580f4eSBarry Smith       PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), P->rmap->n, P->rmap->rstart, 1, &loc));
1893f1580f4eSBarry Smith     }
1894f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
1895db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetEnum(nullptr, prefix, "-st_matstructure", MatStructures, (PetscEnum *)&structure, &flg)); /* if not user-provided, force its value when possible */
1896f1580f4eSBarry Smith     if (!flg && structure == SAME_NONZERO_PATTERN) {                                                                   /* cannot call STSetMatStructure() yet, insert the appropriate option in the database, parsed by STSetFromOptions() */
1897f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-%spc_hpddm_levels_1_st_matstructure", pcpre ? pcpre : ""));
1898db4a47b3SPierre Jolivet       PetscCall(PetscOptionsSetValue(nullptr, prefix, MatStructures[structure]));
1899f1580f4eSBarry Smith     }
1900398c7888SPierre Jolivet     flg = PETSC_FALSE;
1901b07dfdedSPierre Jolivet     if (data->share) {
1902398c7888SPierre Jolivet       data->share = PETSC_FALSE; /* will be reset to PETSC_TRUE if none of the conditions below are true */
1903398c7888SPierre 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 : ""));
1904398c7888SPierre Jolivet       else if (data->deflation) PetscCall(PetscInfo(pc, "Nothing to share since PCHPDDMSetDeflationMat() has been called\n"));
1905398c7888SPierre Jolivet       else if (ismatis) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc with a Pmat of type MATIS\n"));
1906b07dfdedSPierre Jolivet       else if (!algebraic && structure != SAME_NONZERO_PATTERN)
1907398c7888SPierre 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]));
1908398c7888SPierre Jolivet       else data->share = PETSC_TRUE;
1909398c7888SPierre Jolivet     }
1910398c7888SPierre Jolivet     if (!ismatis) {
1911398c7888SPierre Jolivet       if (data->share || (!PetscBool3ToBool(data->Neumann) && subdomains)) PetscCall(ISDuplicate(is[0], &unsorted));
1912398c7888SPierre Jolivet       else unsorted = is[0];
1913398c7888SPierre Jolivet     }
1914f1580f4eSBarry Smith     if (data->N > 1 && (data->aux || ismatis || algebraic)) {
1915f1580f4eSBarry Smith       PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "HPDDM library not loaded, cannot use more than one level");
1916f1580f4eSBarry Smith       PetscCall(MatSetOption(P, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1917f1580f4eSBarry Smith       if (ismatis) {
1918f1580f4eSBarry Smith         /* needed by HPDDM (currently) so that the partition of unity is 0 on subdomain interfaces */
1919f1580f4eSBarry Smith         PetscCall(MatIncreaseOverlap(P, 1, is, 1));
1920f1580f4eSBarry Smith         PetscCall(ISDestroy(&data->is));
1921f1580f4eSBarry Smith         data->is = is[0];
1922f1580f4eSBarry Smith       } else {
1923f1580f4eSBarry Smith         if (PetscDefined(USE_DEBUG)) {
1924f1580f4eSBarry Smith           PetscBool equal;
1925f1580f4eSBarry Smith           IS        intersect;
1926f1580f4eSBarry Smith 
1927f1580f4eSBarry Smith           PetscCall(ISIntersect(data->is, loc, &intersect));
1928f1580f4eSBarry Smith           PetscCall(ISEqualUnsorted(loc, intersect, &equal));
1929f1580f4eSBarry Smith           PetscCall(ISDestroy(&intersect));
1930f1580f4eSBarry Smith           PetscCheck(equal, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "IS of the auxiliary Mat does not include all local rows of A");
1931f1580f4eSBarry Smith         }
19329bb5c669SPierre Jolivet         if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", PCHPDDMAlgebraicAuxiliaryMat_Private));
19339bb5c669SPierre Jolivet         if (!PetscBool3ToBool(data->Neumann) && (!algebraic || overlap != -1)) {
1934f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1935f1580f4eSBarry Smith           if (flg) {
1936f1580f4eSBarry Smith             /* maybe better to ISSort(is[0]), MatCreateSubMatrices(), and then MatPermute() */
1937f1580f4eSBarry Smith             /* but there is no MatPermute_SeqSBAIJ(), so as before, just use MATMPIBAIJ     */
1938f1580f4eSBarry Smith             PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &uaux));
1939f1580f4eSBarry Smith             flg = PETSC_FALSE;
1940f1580f4eSBarry Smith           }
1941f1580f4eSBarry Smith         }
1942f1580f4eSBarry Smith       }
19439bb5c669SPierre Jolivet       if (algebraic && overlap == -1) {
1944f1580f4eSBarry Smith         PetscUseMethod(pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", (Mat, IS *, Mat *[], PetscBool), (P, is, &sub, block));
1945f1580f4eSBarry Smith         if (block) {
1946f1580f4eSBarry Smith           PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", (PetscObject *)&data->aux));
1947db4a47b3SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", nullptr));
1948f1580f4eSBarry Smith         }
19499bb5c669SPierre Jolivet       } else if (!uaux || overlap != -1) {
195013044ca3SPierre Jolivet         if (!ctx) {
1951c8ea6600SPierre Jolivet           if (PetscBool3ToBool(data->Neumann)) sub = &data->aux;
19529bb5c669SPierre Jolivet           else {
19539bb5c669SPierre Jolivet             if (overlap != -1) {
19549bb5c669SPierre Jolivet               Harmonic              h;
19559bb5c669SPierre Jolivet               Mat                   A0, *a;                           /* with an SVD: [ A_00  A_01       ] */
19569bb5c669SPierre Jolivet               IS                    ov[2], rows, cols, stride;        /*              [ A_10  A_11  A_12 ] */
19579bb5c669SPierre Jolivet               const PetscInt       *i[2], bs = PetscAbs(P->cmap->bs); /* with a GEVP: [ A_00  A_01       ] */
19589bb5c669SPierre Jolivet               PetscInt              n[2];                             /*              [ A_10  A_11  A_12 ] */
19599bb5c669SPierre Jolivet               std::vector<PetscInt> v[2];                             /*              [       A_21  A_22 ] */
19609bb5c669SPierre Jolivet               PetscBool             flg;
19619bb5c669SPierre Jolivet 
19629bb5c669SPierre Jolivet               PetscCall(ISDuplicate(data->is, ov));
19639bb5c669SPierre Jolivet               if (overlap > 1) PetscCall(MatIncreaseOverlap(P, 1, ov, overlap - 1));
19649bb5c669SPierre Jolivet               PetscCall(ISDuplicate(ov[0], ov + 1));
19659bb5c669SPierre Jolivet               PetscCall(MatIncreaseOverlap(P, 1, ov + 1, 1));
19669bb5c669SPierre Jolivet               PetscCall(PetscNew(&h));
19679bb5c669SPierre Jolivet               h->ksp = nullptr;
19689bb5c669SPierre Jolivet               PetscCall(PetscCalloc1(2, &h->A));
19693a60673dSPierre Jolivet               PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_nsv", &flg));
19709bb5c669SPierre Jolivet               if (!flg) PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_relative_threshold", &flg));
19719bb5c669SPierre Jolivet               PetscCall(ISSort(ov[0]));
19729bb5c669SPierre Jolivet               if (!flg) PetscCall(ISSort(ov[1]));
19739bb5c669SPierre Jolivet               PetscCall(PetscMalloc1(!flg ? 5 : 3, &h->is));
19749bb5c669SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, ov + !flg, ov + 1, MAT_INITIAL_MATRIX, &a)); /* submatrix from above, either square (!flg) or rectangular (flg) */
19759bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) {
19769bb5c669SPierre Jolivet                 PetscCall(ISGetIndices(ov[j], i + j));
19779bb5c669SPierre Jolivet                 PetscCall(ISGetLocalSize(ov[j], n + j));
19789bb5c669SPierre Jolivet               }
19799bb5c669SPierre Jolivet               v[1].reserve((n[1] - n[0]) / bs);
19809bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[1]; j += bs) { /* indices of the (2,2) block */
19819bb5c669SPierre Jolivet                 PetscInt location;
19829bb5c669SPierre Jolivet                 PetscCall(ISLocate(ov[0], i[1][j], &location));
19839bb5c669SPierre Jolivet                 if (location < 0) v[1].emplace_back(j / bs);
19849bb5c669SPierre Jolivet               }
19859bb5c669SPierre Jolivet               if (!flg) {
19869bb5c669SPierre Jolivet                 h->A[1] = a[0];
19879bb5c669SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)h->A[1]));
19889bb5c669SPierre Jolivet                 v[0].reserve((n[0] - P->rmap->n) / bs);
19899bb5c669SPierre Jolivet                 for (PetscInt j = 0; j < n[1]; j += bs) { /* row indices of the (1,2) block */
19909bb5c669SPierre Jolivet                   PetscInt location;
19919bb5c669SPierre Jolivet                   PetscCall(ISLocate(loc, i[1][j], &location));
19929bb5c669SPierre Jolivet                   if (location < 0) {
19939bb5c669SPierre Jolivet                     PetscCall(ISLocate(ov[0], i[1][j], &location));
19949bb5c669SPierre Jolivet                     if (location >= 0) v[0].emplace_back(j / bs);
19959bb5c669SPierre Jolivet                   }
19969bb5c669SPierre Jolivet                 }
19979bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
19989bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_COPY_VALUES, h->is + 4));
19999bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, h->is[4], MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
20009bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
20019bb5c669SPierre 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 */
20029bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &rows));
20039bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols = rows, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
20049bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
20059bb5c669SPierre Jolivet                 v[0].clear();
20069bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, ov[1], PETSC_TRUE, h->is + 3));
20079bb5c669SPierre Jolivet                 PetscCall(ISEmbed(data->is, ov[1], PETSC_TRUE, h->is + 2));
20089bb5c669SPierre Jolivet               }
20099bb5c669SPierre Jolivet               v[0].reserve((n[0] - P->rmap->n) / bs);
20109bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[0]; j += bs) {
20119bb5c669SPierre Jolivet                 PetscInt location;
20129bb5c669SPierre Jolivet                 PetscCall(ISLocate(loc, i[0][j], &location));
20139bb5c669SPierre Jolivet                 if (location < 0) v[0].emplace_back(j / bs);
20149bb5c669SPierre Jolivet               }
20159bb5c669SPierre Jolivet               PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
20169bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISRestoreIndices(ov[j], i + j));
20179bb5c669SPierre Jolivet               if (flg) {
20189bb5c669SPierre Jolivet                 IS is;
20199bb5c669SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, a[0]->rmap->n, 0, 1, &is));
20209bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &cols));
20219bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], is, cols, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
20229bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
20239bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&is));
20249bb5c669SPierre 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 */
20259bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, data->is, PETSC_TRUE, h->is + 2));
20269bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_USE_POINTER, &cols));
20279bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols, MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
20289bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
20299bb5c669SPierre Jolivet               }
20309bb5c669SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, A0->rmap->n, 0, 1, &stride));
20319bb5c669SPierre Jolivet               PetscCall(ISEmbed(rows, stride, PETSC_TRUE, h->is));
20329bb5c669SPierre Jolivet               PetscCall(ISDestroy(&stride));
20339bb5c669SPierre Jolivet               PetscCall(ISDestroy(&rows));
20349bb5c669SPierre Jolivet               PetscCall(ISEmbed(loc, ov[0], PETSC_TRUE, h->is + 1));
20359bb5c669SPierre Jolivet               if (subdomains) {
20369bb5c669SPierre Jolivet                 if (!data->levels[0]->pc) {
20379bb5c669SPierre Jolivet                   PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
20389bb5c669SPierre Jolivet                   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
20399bb5c669SPierre Jolivet                   PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
20409bb5c669SPierre Jolivet                   PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
20419bb5c669SPierre Jolivet                 }
20429bb5c669SPierre Jolivet                 PetscCall(PCSetType(data->levels[0]->pc, PCASM));
20439bb5c669SPierre Jolivet                 if (!data->levels[0]->pc->setupcalled) PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, ov + !flg, &loc));
20449bb5c669SPierre Jolivet                 PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, flg ? A0 : a[0], PETSC_TRUE));
20459bb5c669SPierre Jolivet                 if (!flg) ++overlap;
20469bb5c669SPierre Jolivet                 if (data->share) {
20479bb5c669SPierre Jolivet                   PetscInt n = -1;
20489bb5c669SPierre Jolivet                   PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
20499bb5c669SPierre Jolivet                   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
20509bb5c669SPierre Jolivet                   if (flg) {
20519bb5c669SPierre Jolivet                     h->ksp = ksp[0];
20529bb5c669SPierre Jolivet                     PetscCall(PetscObjectReference((PetscObject)h->ksp));
20539bb5c669SPierre Jolivet                   }
20549bb5c669SPierre Jolivet                 }
20559bb5c669SPierre Jolivet               }
20569bb5c669SPierre Jolivet               if (!h->ksp) {
20579bb5c669SPierre Jolivet                 PetscBool share = data->share;
20589bb5c669SPierre Jolivet                 PetscCall(KSPCreate(PETSC_COMM_SELF, &h->ksp));
20599bb5c669SPierre Jolivet                 PetscCall(KSPSetType(h->ksp, KSPPREONLY));
20609bb5c669SPierre Jolivet                 PetscCall(KSPSetOperators(h->ksp, A0, A0));
20619bb5c669SPierre Jolivet                 do {
20629bb5c669SPierre Jolivet                   if (!data->share) {
20639bb5c669SPierre Jolivet                     share = PETSC_FALSE;
20649bb5c669SPierre Jolivet                     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_%s", pcpre ? pcpre : "", flg ? "svd_" : "eps_"));
20659bb5c669SPierre Jolivet                     PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
20669bb5c669SPierre Jolivet                     PetscCall(KSPSetFromOptions(h->ksp));
20679bb5c669SPierre Jolivet                   } else {
20689bb5c669SPierre Jolivet                     MatSolverType type;
20699bb5c669SPierre Jolivet                     PetscCall(KSPGetPC(ksp[0], &pc));
20709bb5c669SPierre Jolivet                     PetscCall(PetscObjectTypeCompareAny((PetscObject)pc, &data->share, PCLU, PCCHOLESKY, ""));
20719bb5c669SPierre Jolivet                     if (data->share) {
20729bb5c669SPierre Jolivet                       PetscCall(PCFactorGetMatSolverType(pc, &type));
20739bb5c669SPierre Jolivet                       if (!type) {
20749bb5c669SPierre Jolivet                         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMUMPS));
20759bb5c669SPierre Jolivet                         else if (PetscDefined(HAVE_MKL_PARDISO)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMKL_PARDISO));
20769bb5c669SPierre Jolivet                         else data->share = PETSC_FALSE;
20779bb5c669SPierre Jolivet                         if (data->share) PetscCall(PCSetFromOptions(pc));
20789bb5c669SPierre Jolivet                       } else {
20799bb5c669SPierre Jolivet                         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &data->share));
20809bb5c669SPierre Jolivet                         if (!data->share) PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &data->share));
20819bb5c669SPierre Jolivet                       }
20829bb5c669SPierre Jolivet                       if (data->share) {
20839bb5c669SPierre Jolivet                         std::tuple<KSP, IS, Vec[2]> *p;
20849bb5c669SPierre Jolivet                         PetscCall(PCFactorGetMatrix(pc, &A));
20859bb5c669SPierre Jolivet                         PetscCall(MatFactorSetSchurIS(A, h->is[4]));
20869bb5c669SPierre Jolivet                         PetscCall(KSPSetUp(ksp[0]));
20879bb5c669SPierre Jolivet                         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_eps_shell_", pcpre ? pcpre : ""));
20889bb5c669SPierre Jolivet                         PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
20899bb5c669SPierre Jolivet                         PetscCall(KSPSetFromOptions(h->ksp));
20909bb5c669SPierre Jolivet                         PetscCall(KSPGetPC(h->ksp, &pc));
20919bb5c669SPierre Jolivet                         PetscCall(PCSetType(pc, PCSHELL));
20929bb5c669SPierre Jolivet                         PetscCall(PetscNew(&p));
20939bb5c669SPierre Jolivet                         std::get<0>(*p) = ksp[0];
20949bb5c669SPierre Jolivet                         PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &std::get<1>(*p)));
20959bb5c669SPierre Jolivet                         PetscCall(MatCreateVecs(A, std::get<2>(*p), std::get<2>(*p) + 1));
20969bb5c669SPierre Jolivet                         PetscCall(PCShellSetContext(pc, p));
20979bb5c669SPierre Jolivet                         PetscCall(PCShellSetApply(pc, PCApply_Schur));
20989bb5c669SPierre Jolivet                         PetscCall(PCShellSetApplyTranspose(pc, PCApply_Schur<Vec, true>));
20999bb5c669SPierre Jolivet                         PetscCall(PCShellSetMatApply(pc, PCApply_Schur<Mat>));
21009bb5c669SPierre Jolivet                         PetscCall(PCShellSetDestroy(pc, PCDestroy_Schur));
21019bb5c669SPierre Jolivet                       }
21029bb5c669SPierre Jolivet                     }
21039bb5c669SPierre Jolivet                     if (!data->share) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since neither MUMPS nor MKL PARDISO is used\n"));
21049bb5c669SPierre Jolivet                   }
21059bb5c669SPierre 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 */
21069bb5c669SPierre Jolivet               }
21079bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov));
21089bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov + 1));
21099bb5c669SPierre Jolivet               if (overlap == 1 && subdomains && flg) {
21109bb5c669SPierre Jolivet                 *subA = A0;
21119bb5c669SPierre Jolivet                 sub   = subA;
21129bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatDestroy(&uaux));
21139bb5c669SPierre Jolivet               } else PetscCall(MatDestroy(&A0));
21149bb5c669SPierre Jolivet               PetscCall(MatCreateShell(PETSC_COMM_SELF, P->rmap->n, n[1] - n[0], P->rmap->n, n[1] - n[0], h, &data->aux));
21159bb5c669SPierre Jolivet               PetscCall(MatCreateVecs(h->ksp->pc->pmat, &h->v, nullptr));
21169bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT, (void (*)(void))MatMult_Harmonic));
21179bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMultTranspose_Harmonic));
21189bb5c669SPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AB, nullptr, MatProduct_AB_Harmonic, nullptr, MATDENSE, MATDENSE));
21199bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_DESTROY, (void (*)(void))MatDestroy_Harmonic));
21209bb5c669SPierre Jolivet               PetscCall(MatDestroySubMatrices(1, &a));
21219bb5c669SPierre Jolivet             }
21229bb5c669SPierre Jolivet             if (overlap != 1 || !subdomains) PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, is, is, MAT_INITIAL_MATRIX, &sub));
21239bb5c669SPierre Jolivet             if (uaux) {
21249bb5c669SPierre Jolivet               PetscCall(MatDestroy(&uaux));
21259bb5c669SPierre Jolivet               PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
21269bb5c669SPierre Jolivet             }
21279bb5c669SPierre Jolivet           }
212813044ca3SPierre Jolivet         }
2129f1580f4eSBarry Smith       } else {
2130f1580f4eSBarry Smith         PetscCall(MatCreateSubMatrices(uaux, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2131f1580f4eSBarry Smith         PetscCall(MatDestroy(&uaux));
2132f1580f4eSBarry Smith         PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2133f1580f4eSBarry Smith       }
2134f1580f4eSBarry Smith       /* Vec holding the partition of unity */
2135f1580f4eSBarry Smith       if (!data->levels[0]->D) {
2136f1580f4eSBarry Smith         PetscCall(ISGetLocalSize(data->is, &n));
2137f1580f4eSBarry Smith         PetscCall(VecCreateMPI(PETSC_COMM_SELF, n, PETSC_DETERMINE, &data->levels[0]->D));
2138f1580f4eSBarry Smith       }
21399bb5c669SPierre Jolivet       if (data->share && overlap == -1) {
2140f1580f4eSBarry Smith         Mat      D;
2141db4a47b3SPierre Jolivet         IS       perm = nullptr;
2142f1580f4eSBarry Smith         PetscInt size = -1;
2143398c7888SPierre Jolivet         if (!data->levels[0]->pc) {
2144398c7888SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2145398c7888SPierre Jolivet           PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
2146398c7888SPierre Jolivet           PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
2147398c7888SPierre Jolivet           PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
2148398c7888SPierre Jolivet         }
2149398c7888SPierre Jolivet         PetscCall(PCSetType(data->levels[0]->pc, PCASM));
215013044ca3SPierre Jolivet         if (!ctx) {
2151398c7888SPierre Jolivet           if (!data->levels[0]->pc->setupcalled) {
2152398c7888SPierre Jolivet             IS sorted; /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2153398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2154398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &sorted, &loc));
2155398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2156398c7888SPierre Jolivet           }
2157398c7888SPierre Jolivet           PetscCall(PCSetFromOptions(data->levels[0]->pc));
2158398c7888SPierre Jolivet           if (block) {
2159398c7888SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, sub[0], &C, &perm));
2160398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, C, algebraic));
2161398c7888SPierre Jolivet           } else PetscCall(PCSetUp(data->levels[0]->pc));
2162db4a47b3SPierre Jolivet           PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &size, nullptr, &ksp));
2163398c7888SPierre Jolivet           if (size != 1) {
2164398c7888SPierre Jolivet             data->share = PETSC_FALSE;
2165398c7888SPierre Jolivet             PetscCheck(size == -1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", size);
2166398c7888SPierre Jolivet             PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since PCASMGetSubKSP() not found in fine-level PC\n"));
2167398c7888SPierre Jolivet             PetscCall(ISDestroy(&unsorted));
2168398c7888SPierre Jolivet             unsorted = is[0];
2169398c7888SPierre Jolivet           } else {
217013044ca3SPierre Jolivet             if (!block && !ctx) PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, PetscBool3ToBool(data->Neumann) ? sub[0] : data->aux, &C, &perm));
2171c8ea6600SPierre Jolivet             if (!PetscBool3ToBool(data->Neumann) && !block) {
2172f1580f4eSBarry Smith               PetscCall(MatPermute(sub[0], perm, perm, &D)); /* permute since PCASM will call ISSort() */
2173f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(sub[0], &D));
2174f1580f4eSBarry Smith             }
2175f1580f4eSBarry Smith             if (data->B) { /* see PCHPDDMSetRHSMat() */
2176f1580f4eSBarry Smith               PetscCall(MatPermute(data->B, perm, perm, &D));
2177f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(data->B, &D));
2178f1580f4eSBarry Smith             }
2179f1580f4eSBarry Smith             PetscCall(ISDestroy(&perm));
2180f1580f4eSBarry Smith             const char *matpre;
2181f1580f4eSBarry Smith             PetscBool   cmp[4];
2182f1580f4eSBarry Smith             PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
2183f1580f4eSBarry Smith             PetscCall(MatDuplicate(subA[1], MAT_SHARE_NONZERO_PATTERN, &D));
2184f1580f4eSBarry Smith             PetscCall(MatGetOptionsPrefix(subA[1], &matpre));
2185f1580f4eSBarry Smith             PetscCall(MatSetOptionsPrefix(D, matpre));
2186f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMAL, cmp));
2187f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMAL, cmp + 1));
2188f1580f4eSBarry Smith             if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMALHERMITIAN, cmp + 2));
2189f1580f4eSBarry Smith             else cmp[2] = PETSC_FALSE;
2190f1580f4eSBarry Smith             if (!cmp[1]) PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMALHERMITIAN, cmp + 3));
2191f1580f4eSBarry Smith             else cmp[3] = PETSC_FALSE;
2192f1580f4eSBarry 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);
2193f1580f4eSBarry Smith             if (!cmp[0] && !cmp[2]) {
2194f1580f4eSBarry Smith               if (!block) PetscCall(MatAXPY(D, 1.0, C, SUBSET_NONZERO_PATTERN));
21955c7345deSPierre Jolivet               else {
2196db4a47b3SPierre Jolivet                 PetscCall(MatMissingDiagonal(D, cmp, nullptr));
21975c7345deSPierre Jolivet                 if (cmp[0]) structure = DIFFERENT_NONZERO_PATTERN; /* data->aux has no missing diagonal entry */
21985c7345deSPierre Jolivet                 PetscCall(MatAXPY(D, 1.0, data->aux, structure));
21995c7345deSPierre Jolivet               }
2200f1580f4eSBarry Smith             } else {
2201f1580f4eSBarry Smith               Mat mat[2];
2202f1580f4eSBarry Smith               if (cmp[0]) {
2203f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(D, mat));
2204f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(C, mat + 1));
2205f1580f4eSBarry Smith               } else {
2206f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(D, mat));
2207f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(C, mat + 1));
2208f1580f4eSBarry Smith               }
2209f1580f4eSBarry Smith               PetscCall(MatAXPY(mat[0], 1.0, mat[1], SUBSET_NONZERO_PATTERN));
2210f1580f4eSBarry Smith             }
2211f1580f4eSBarry Smith             PetscCall(MatPropagateSymmetryOptions(C, D));
2212f1580f4eSBarry Smith             PetscCall(MatDestroy(&C));
2213f1580f4eSBarry Smith             C = D;
2214f1580f4eSBarry Smith             /* swap pointers so that variables stay consistent throughout PCSetUp() */
2215f1580f4eSBarry Smith             std::swap(C, data->aux);
2216f1580f4eSBarry Smith             std::swap(uis, data->is);
2217f1580f4eSBarry Smith             swap = PETSC_TRUE;
2218f1580f4eSBarry Smith           }
2219f1580f4eSBarry Smith         }
222013044ca3SPierre Jolivet       }
222113044ca3SPierre Jolivet       if (ctx) {
222213044ca3SPierre Jolivet         PC_HPDDM              *data_00 = (PC_HPDDM *)std::get<0>(*ctx)[0]->data;
222313044ca3SPierre Jolivet         PC                     s;
222400b491fbSPierre Jolivet         Mat                    A00, P00, A01 = nullptr, A10, A11, N, b[4];
222513044ca3SPierre Jolivet         IS                     sorted, is[2];
222613044ca3SPierre Jolivet         MatSolverType          type;
222713044ca3SPierre Jolivet         std::pair<PC, Vec[2]> *p;
222813044ca3SPierre Jolivet 
222913044ca3SPierre Jolivet         PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, data->aux, &C, nullptr)); /* permute since PCASM works with a sorted IS */
223013044ca3SPierre Jolivet         std::swap(C, data->aux);
223113044ca3SPierre Jolivet         std::swap(uis, data->is);
223213044ca3SPierre Jolivet         swap = PETSC_TRUE;
223313044ca3SPierre Jolivet         PetscCall(PCASMSetType(data->levels[0]->pc, PC_ASM_NONE)); /* "Neumann--Neumann" preconditioning with overlap and a Boolean partition of unity */
223413044ca3SPierre Jolivet         PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &data->is, &loc));
223513044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(data->levels[0]->pc)); /* action of eq. (15) of https://hal.science/hal-02343808v6/document (with a sign flip) */
223613044ca3SPierre Jolivet         PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, std::get<1>(*ctx), &A10, &A11));
223713044ca3SPierre Jolivet         std::get<1>(*ctx)[1] = A10;
223813044ca3SPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
223913044ca3SPierre Jolivet         if (flg) PetscCall(MatTransposeGetMat(A10, &A01));
224013044ca3SPierre Jolivet         else {
224113044ca3SPierre Jolivet           PetscBool flg;
224213044ca3SPierre Jolivet 
224313044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
224413044ca3SPierre Jolivet           if (flg) PetscCall(MatHermitianTransposeGetMat(A10, &A01));
224513044ca3SPierre Jolivet         }
224613044ca3SPierre 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 */
224713044ca3SPierre Jolivet         PetscCall(ISSort(sorted));                    /* this is to avoid changing users inputs, but it requires a new call to ISSort() here                                                                                               */
224800b491fbSPierre Jolivet         if (!A01) {
224900b491fbSPierre Jolivet           PetscCall(MatSetOption(A10, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
225000b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A10, 1, &data->is, &sorted, MAT_INITIAL_MATRIX, &sub));
225100b491fbSPierre Jolivet           b[2] = sub[0];
225200b491fbSPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
225300b491fbSPierre Jolivet           PetscCall(MatDestroySubMatrices(1, &sub));
225400b491fbSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATTRANSPOSEVIRTUAL, &flg));
225500b491fbSPierre Jolivet           A10 = nullptr;
225600b491fbSPierre Jolivet           if (flg) PetscCall(MatTransposeGetMat(std::get<1>(*ctx)[0], &A10));
225713044ca3SPierre Jolivet           else {
225800b491fbSPierre Jolivet             PetscBool flg;
225900b491fbSPierre Jolivet 
226000b491fbSPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)(PetscObject)std::get<1>(*ctx)[0], MATHERMITIANTRANSPOSEVIRTUAL, &flg));
226100b491fbSPierre Jolivet             if (flg) PetscCall(MatHermitianTransposeGetMat(std::get<1>(*ctx)[0], &A10));
226213044ca3SPierre Jolivet           }
226300b491fbSPierre Jolivet           if (!A10) {
226400b491fbSPierre Jolivet             PetscCall(MatCreateSubMatrices(std::get<1>(*ctx)[0], 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
226500b491fbSPierre Jolivet             b[1] = sub[0];
226600b491fbSPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)sub[0]));
226700b491fbSPierre Jolivet           }
226800b491fbSPierre Jolivet         } else {
226900b491fbSPierre Jolivet           PetscCall(MatSetOption(A01, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
227000b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A01, 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
227100b491fbSPierre Jolivet           if (flg) PetscCall(MatTranspose(*sub, MAT_INITIAL_MATRIX, b + 2));
227200b491fbSPierre Jolivet           else PetscCall(MatHermitianTranspose(*sub, MAT_INITIAL_MATRIX, b + 2));
227300b491fbSPierre Jolivet         }
227400b491fbSPierre Jolivet         PetscCall(MatDestroySubMatrices(1, &sub));
227513044ca3SPierre Jolivet         PetscCall(ISDestroy(&sorted));
227613044ca3SPierre Jolivet         n = -1;
227713044ca3SPierre Jolivet         PetscTryMethod(data_00->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data_00->levels[0]->pc, &n, nullptr, &ksp));
227813044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
227913044ca3SPierre Jolivet         PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
228013044ca3SPierre Jolivet         PetscCall(ISGetLocalSize(data_00->is, &n));
228113044ca3SPierre 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);
228200b491fbSPierre Jolivet         if (A01 || A10) {
228300b491fbSPierre Jolivet           if (flg) PetscCall(MatTranspose(b[2], MAT_INITIAL_MATRIX, b + 1));
228400b491fbSPierre Jolivet           else PetscCall(MatHermitianTranspose(b[2], MAT_INITIAL_MATRIX, b + 1));
228500b491fbSPierre Jolivet         }
228600b491fbSPierre Jolivet         PetscCall(MatCreateSchurComplement(subA[0], subA[1], b[1], b[2], data->aux, &S));
228713044ca3SPierre Jolivet         PetscCall(MatSchurComplementSetKSP(S, ksp[0]));
228813044ca3SPierre 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 */
228913044ca3SPierre Jolivet         PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
229013044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
229113044ca3SPierre Jolivet         PetscCall(KSPGetPC(ksp[0], &inner));
229213044ca3SPierre Jolivet         PetscCall(PCSetType(inner, PCSHELL)); /* compute the action of the inverse of the local Schur complement with a PCSHELL */
229313044ca3SPierre Jolivet         b[0] = subA[0];
229413044ca3SPierre Jolivet         b[3] = data->aux;
229513044ca3SPierre 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 */
229600b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[1]));
229700b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[2]));
229813044ca3SPierre Jolivet         PetscCall(PCCreate(PETSC_COMM_SELF, &s));
229913044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(s, ((PetscObject)inner)->prefix));
230013044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(inner, nullptr));
230113044ca3SPierre Jolivet         PetscCall(KSPSetSkipPCSetFromOptions(ksp[0], PETSC_TRUE));
230213044ca3SPierre Jolivet         PetscCall(PCSetType(s, PCLU));
230313044ca3SPierre Jolivet         if (PetscDefined(HAVE_MUMPS)) { /* only MATSOLVERMUMPS handles MATNEST, so for the others, e.g., MATSOLVERPETSC or MATSOLVERMKL_PARDISO, convert to plain MATAIJ */
230413044ca3SPierre Jolivet           PetscCall(PCFactorSetMatSolverType(s, MATSOLVERMUMPS));
230513044ca3SPierre Jolivet         }
230613044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(s));
230713044ca3SPierre Jolivet         PetscCall(PCFactorGetMatSolverType(s, &type));
230813044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
230913044ca3SPierre Jolivet         if (flg) {
231013044ca3SPierre Jolivet           PetscCall(PCSetOperators(s, N, N));
231100b491fbSPierre Jolivet           PetscCall(PCFactorGetMatrix(s, b));
231200b491fbSPierre Jolivet           PetscCall(MatSetOptionsPrefix(*b, ((PetscObject)s)->prefix));
231324ddd604SPierre Jolivet           n = -1;
231424ddd604SPierre Jolivet           PetscCall(PetscOptionsGetInt(nullptr, ((PetscObject)s)->prefix, "-mat_mumps_icntl_26", &n, nullptr));
231524ddd604SPierre Jolivet           if (n == 1) {
231624ddd604SPierre Jolivet             PetscCall(MatNestGetISs(N, is, nullptr));  /* allocates a square MatDense of size is[1]->map->n, so one */
231700b491fbSPierre Jolivet             PetscCall(MatFactorSetSchurIS(*b, is[1])); /*  needs to be able to deactivate this path when dealing    */
231824ddd604SPierre Jolivet           }                                            /*  with a large constraint space in order to avoid OOM      */
231913044ca3SPierre Jolivet         } else {
232000b491fbSPierre Jolivet           PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, b));
232100b491fbSPierre Jolivet           PetscCall(PCSetOperators(s, N, *b));
232200b491fbSPierre Jolivet           PetscCall(PetscObjectDereference((PetscObject)*b));
232300b491fbSPierre 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 */
232413044ca3SPierre Jolivet         }
232513044ca3SPierre Jolivet         PetscCall(PetscNew(&p));
232613044ca3SPierre Jolivet         p->first = s;
232700b491fbSPierre Jolivet         PetscCall(MatCreateVecs(*b, p->second, p->second + 1));
232813044ca3SPierre Jolivet         PetscCall(PCShellSetContext(inner, p));
232913044ca3SPierre Jolivet         PetscCall(PCShellSetApply(inner, PCApply_Nest));
233013044ca3SPierre Jolivet         PetscCall(PCShellSetView(inner, PCView_Nest));
233113044ca3SPierre Jolivet         PetscCall(PCShellSetDestroy(inner, PCDestroy_Nest));
233213044ca3SPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)N));
233313044ca3SPierre Jolivet       }
2334f1580f4eSBarry Smith       if (!data->levels[0]->scatter) {
2335db4a47b3SPierre Jolivet         PetscCall(MatCreateVecs(P, &xin, nullptr));
2336f1580f4eSBarry Smith         if (ismatis) PetscCall(MatDestroy(&P));
2337db4a47b3SPierre Jolivet         PetscCall(VecScatterCreate(xin, data->is, data->levels[0]->D, nullptr, &data->levels[0]->scatter));
2338f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
2339f1580f4eSBarry Smith       }
2340f1580f4eSBarry Smith       if (data->levels[0]->P) {
2341f1580f4eSBarry Smith         /* if the pattern is the same and PCSetUp() has previously succeeded, reuse HPDDM buffers and connectivity */
2342f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[0], pc->setupcalled < 1 || pc->flag == DIFFERENT_NONZERO_PATTERN ? PETSC_TRUE : PETSC_FALSE));
2343f1580f4eSBarry Smith       }
2344f1580f4eSBarry Smith       if (!data->levels[0]->P) data->levels[0]->P = new HPDDM::Schwarz<PetscScalar>();
2345db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2346db4a47b3SPierre Jolivet       else PetscCall(PetscLogEventBegin(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2347f1580f4eSBarry Smith       /* HPDDM internal data structure */
234813044ca3SPierre Jolivet       PetscCall(data->levels[0]->P->structure(loc, data->is, !ctx ? sub[0] : nullptr, ismatis ? C : data->aux, data->levels));
2349db4a47b3SPierre Jolivet       if (!data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2350f1580f4eSBarry Smith       /* matrix pencil of the generalized eigenvalue problem on the overlap (GenEO) */
235113044ca3SPierre Jolivet       if (!ctx) {
23529bb5c669SPierre Jolivet         if (data->deflation || overlap != -1) weighted = data->aux;
2353f1580f4eSBarry Smith         else if (!data->B) {
2354f1580f4eSBarry Smith           PetscBool cmp[2];
2355f1580f4eSBarry Smith           PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &weighted));
2356f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)weighted, MATNORMAL, cmp));
2357f1580f4eSBarry Smith           if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)weighted, MATNORMALHERMITIAN, cmp + 1));
2358f1580f4eSBarry Smith           else cmp[1] = PETSC_FALSE;
2359f1580f4eSBarry Smith           if (!cmp[0] && !cmp[1]) PetscCall(MatDiagonalScale(weighted, data->levels[0]->D, data->levels[0]->D));
2360f1580f4eSBarry Smith           else { /* MATNORMAL applies MatDiagonalScale() in a matrix-free fashion, not what is needed since this won't be passed to SLEPc during the eigensolve */
2361f1580f4eSBarry Smith             if (cmp[0]) PetscCall(MatNormalGetMat(weighted, &data->B));
2362f1580f4eSBarry Smith             else PetscCall(MatNormalHermitianGetMat(weighted, &data->B));
2363db4a47b3SPierre Jolivet             PetscCall(MatDiagonalScale(data->B, nullptr, data->levels[0]->D));
2364db4a47b3SPierre Jolivet             data->B = nullptr;
2365f1580f4eSBarry Smith             flg     = PETSC_FALSE;
2366f1580f4eSBarry Smith           }
2367f1580f4eSBarry Smith           /* neither MatDuplicate() nor MatDiagonaleScale() handles the symmetry options, so propagate the options explicitly */
2368f1580f4eSBarry Smith           /* only useful for -mat_type baij -pc_hpddm_levels_1_st_pc_type cholesky (no problem with MATAIJ or MATSBAIJ)       */
2369f1580f4eSBarry Smith           PetscCall(MatPropagateSymmetryOptions(sub[0], weighted));
2370f1580f4eSBarry Smith         } else weighted = data->B;
237113044ca3SPierre Jolivet       } else weighted = nullptr;
2372f1580f4eSBarry Smith       /* SLEPc is used inside the loaded symbol */
23739bb5c669SPierre 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));
23749bb5c669SPierre Jolivet       if (!ctx && data->share && overlap == -1) {
2375f1580f4eSBarry Smith         Mat st[2];
2376f1580f4eSBarry Smith         PetscCall(KSPGetOperators(ksp[0], st, st + 1));
23775c7345deSPierre Jolivet         PetscCall(MatCopy(subA[0], st[0], structure));
2378f1580f4eSBarry Smith         if (subA[1] != subA[0] || st[1] != st[0]) PetscCall(MatCopy(subA[1], st[1], SAME_NONZERO_PATTERN));
2379f1580f4eSBarry Smith       }
2380db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2381f1580f4eSBarry Smith       if (ismatis) PetscCall(MatISGetLocalMat(C, &N));
2382f1580f4eSBarry Smith       else N = data->aux;
238313044ca3SPierre Jolivet       if (!ctx) P = sub[0];
238413044ca3SPierre Jolivet       else P = S;
2385f1580f4eSBarry Smith       /* going through the grid hierarchy */
2386f1580f4eSBarry Smith       for (n = 1; n < data->N; ++n) {
2387db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2388f1580f4eSBarry Smith         /* method composed in the loaded symbol since there, SLEPc is used as well */
2389f1580f4eSBarry 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));
2390db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2391f1580f4eSBarry Smith       }
2392f1580f4eSBarry Smith       /* reset to NULL to avoid any faulty use */
2393db4a47b3SPierre Jolivet       PetscCall(PetscObjectComposeFunction((PetscObject)data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", nullptr));
2394db4a47b3SPierre Jolivet       if (!ismatis) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_C", nullptr));
2395f1580f4eSBarry Smith       else PetscCall(PetscObjectDereference((PetscObject)C)); /* matching PetscObjectReference() above */
2396f1580f4eSBarry Smith       for (n = 0; n < data->N - 1; ++n)
2397f1580f4eSBarry Smith         if (data->levels[n]->P) {
2398f1580f4eSBarry Smith           /* HPDDM internal work buffers */
2399f1580f4eSBarry Smith           data->levels[n]->P->setBuffer();
2400f1580f4eSBarry Smith           data->levels[n]->P->super::start();
2401f1580f4eSBarry Smith         }
24029bb5c669SPierre Jolivet       if (ismatis || !subdomains) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
2403db4a47b3SPierre Jolivet       if (ismatis) data->is = nullptr;
2404f1580f4eSBarry Smith       for (n = 0; n < data->N - 1 + (reused > 0); ++n) {
2405f1580f4eSBarry Smith         if (data->levels[n]->P) {
2406f1580f4eSBarry Smith           PC spc;
2407f1580f4eSBarry Smith 
2408f1580f4eSBarry Smith           /* force the PC to be PCSHELL to do the coarse grid corrections */
2409f1580f4eSBarry Smith           PetscCall(KSPSetSkipPCSetFromOptions(data->levels[n]->ksp, PETSC_TRUE));
2410f1580f4eSBarry Smith           PetscCall(KSPGetPC(data->levels[n]->ksp, &spc));
2411f1580f4eSBarry Smith           PetscCall(PCSetType(spc, PCSHELL));
2412f1580f4eSBarry Smith           PetscCall(PCShellSetContext(spc, data->levels[n]));
2413f1580f4eSBarry Smith           PetscCall(PCShellSetSetUp(spc, PCSetUp_HPDDMShell));
2414f1580f4eSBarry Smith           PetscCall(PCShellSetApply(spc, PCApply_HPDDMShell));
2415f1580f4eSBarry Smith           PetscCall(PCShellSetMatApply(spc, PCMatApply_HPDDMShell));
241613044ca3SPierre Jolivet           if (ctx && n == 0) {
241713044ca3SPierre Jolivet             Mat                                  Amat, Pmat;
241813044ca3SPierre Jolivet             PetscInt                             m, M;
241913044ca3SPierre Jolivet             std::tuple<Mat, VecScatter, Vec[2]> *ctx;
242013044ca3SPierre Jolivet 
242113044ca3SPierre Jolivet             PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &Pmat));
242213044ca3SPierre Jolivet             PetscCall(MatGetLocalSize(Pmat, &m, nullptr));
242313044ca3SPierre Jolivet             PetscCall(MatGetSize(Pmat, &M, nullptr));
242413044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));
242513044ca3SPierre Jolivet             std::get<0>(*ctx) = S;
242613044ca3SPierre Jolivet             std::get<1>(*ctx) = data->levels[n]->scatter;
242713044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)data->levels[n]->ksp), m, m, M, M, ctx, &Amat));
242813044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT, (void (*)(void))MatMult_Schur<false>));
242913044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMult_Schur<true>));
243013044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_DESTROY, (void (*)(void))MatDestroy_Schur));
243113044ca3SPierre Jolivet             PetscCall(MatCreateVecs(S, std::get<2>(*ctx), std::get<2>(*ctx) + 1));
243213044ca3SPierre Jolivet             PetscCall(KSPSetOperators(data->levels[n]->ksp, Amat, Pmat));
243313044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)Amat));
243413044ca3SPierre Jolivet           }
2435f1580f4eSBarry Smith           PetscCall(PCShellSetDestroy(spc, PCDestroy_HPDDMShell));
2436f1580f4eSBarry Smith           if (!data->levels[n]->pc) PetscCall(PCCreate(PetscObjectComm((PetscObject)data->levels[n]->ksp), &data->levels[n]->pc));
2437f1580f4eSBarry Smith           if (n < reused) {
2438f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(spc, PETSC_TRUE));
2439f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
2440f1580f4eSBarry Smith           }
2441f1580f4eSBarry Smith           PetscCall(PCSetUp(spc));
2442f1580f4eSBarry Smith         }
2443f1580f4eSBarry Smith       }
244413044ca3SPierre Jolivet       if (ctx) PetscCall(MatDestroy(&S));
24459bb5c669SPierre Jolivet       if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", nullptr));
2446f1580f4eSBarry Smith     } else flg = reused ? PETSC_FALSE : PETSC_TRUE;
2447f1580f4eSBarry Smith     if (!ismatis && subdomains) {
2448f1580f4eSBarry Smith       if (flg) PetscCall(KSPGetPC(data->levels[0]->ksp, &inner));
2449f1580f4eSBarry Smith       else inner = data->levels[0]->pc;
2450f1580f4eSBarry Smith       if (inner) {
2451398c7888SPierre Jolivet         if (!inner->setupcalled) PetscCall(PCSetType(inner, PCASM));
2452398c7888SPierre Jolivet         PetscCall(PCSetFromOptions(inner));
2453398c7888SPierre Jolivet         PetscCall(PetscStrcmp(((PetscObject)inner)->type_name, PCASM, &flg));
2454398c7888SPierre Jolivet         if (flg) {
2455f1580f4eSBarry Smith           if (!inner->setupcalled) { /* evaluates to PETSC_FALSE when -pc_hpddm_block_splitting */
2456398c7888SPierre Jolivet             IS sorted;               /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2457398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2458398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(inner, 1, &sorted, &loc));
2459398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2460398c7888SPierre Jolivet           }
2461c8ea6600SPierre Jolivet           if (!PetscBool3ToBool(data->Neumann) && data->N > 1) { /* subdomain matrices are already created for the eigenproblem, reuse them for the fine-level PC */
2462db4a47b3SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(*is, nullptr, nullptr, sub[0], &P, nullptr));
2463398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(inner, P, algebraic));
2464398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)P));
2465f1580f4eSBarry Smith           }
2466f1580f4eSBarry Smith         }
2467f1580f4eSBarry Smith       }
24689bb5c669SPierre Jolivet       if (data->N > 1) {
24699bb5c669SPierre Jolivet         if (overlap != 1) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
24709bb5c669SPierre Jolivet         if (overlap == 1) PetscCall(MatDestroy(subA));
24719bb5c669SPierre Jolivet       }
2472f1580f4eSBarry Smith     }
2473f1580f4eSBarry Smith     PetscCall(ISDestroy(&loc));
2474f1580f4eSBarry Smith   } else data->N = 1 + reused; /* enforce this value to 1 + reused if there is no way to build another level */
2475f1580f4eSBarry Smith   if (requested != data->N + reused) {
2476f1580f4eSBarry 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,
2477f1580f4eSBarry Smith                         data->N, pcpre ? pcpre : ""));
2478f1580f4eSBarry 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));
2479f1580f4eSBarry Smith     /* cannot use PCDestroy_HPDDMShell() because PCSHELL not set for unassembled levels */
2480f1580f4eSBarry Smith     for (n = data->N - 1; n < requested - 1; ++n) {
2481f1580f4eSBarry Smith       if (data->levels[n]->P) {
2482f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[n], PETSC_TRUE));
2483f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(1, &data->levels[n]->v[0]));
2484f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(2, &data->levels[n]->v[1]));
2485f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V));
2486f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 1));
2487f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 2));
2488f1580f4eSBarry Smith         PetscCall(VecDestroy(&data->levels[n]->D));
2489f1580f4eSBarry Smith         PetscCall(VecScatterDestroy(&data->levels[n]->scatter));
2490f1580f4eSBarry Smith       }
2491f1580f4eSBarry Smith     }
2492f1580f4eSBarry Smith     if (reused) {
2493f1580f4eSBarry Smith       for (n = reused; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
2494f1580f4eSBarry Smith         PetscCall(KSPDestroy(&data->levels[n]->ksp));
2495f1580f4eSBarry Smith         PetscCall(PCDestroy(&data->levels[n]->pc));
2496f1580f4eSBarry Smith       }
2497f1580f4eSBarry Smith     }
2498f1580f4eSBarry 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,
2499f1580f4eSBarry Smith                data->N, reused, data->N, pcpre ? pcpre : "", pcpre ? pcpre : "", data->N);
2500f1580f4eSBarry Smith   }
2501f1580f4eSBarry Smith   /* these solvers are created after PCSetFromOptions() is called */
2502f1580f4eSBarry Smith   if (pc->setfromoptionscalled) {
2503f1580f4eSBarry Smith     for (n = 0; n < data->N; ++n) {
2504f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetFromOptions(data->levels[n]->ksp));
2505f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetFromOptions(data->levels[n]->pc));
2506f1580f4eSBarry Smith     }
2507f1580f4eSBarry Smith     pc->setfromoptionscalled = 0;
2508f1580f4eSBarry Smith   }
2509f1580f4eSBarry Smith   data->N += reused;
2510f1580f4eSBarry Smith   if (data->share && swap) {
2511f1580f4eSBarry Smith     /* swap back pointers so that variables follow the user-provided numbering */
2512f1580f4eSBarry Smith     std::swap(C, data->aux);
2513f1580f4eSBarry Smith     std::swap(uis, data->is);
2514f1580f4eSBarry Smith     PetscCall(MatDestroy(&C));
2515f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
2516f1580f4eSBarry Smith   }
2517398c7888SPierre Jolivet   if (algebraic) PetscCall(MatDestroy(&data->aux));
251838fb34a1SPierre Jolivet   if (unsorted && unsorted != is[0]) {
2519398c7888SPierre Jolivet     PetscCall(ISCopy(unsorted, data->is));
2520398c7888SPierre Jolivet     PetscCall(ISDestroy(&unsorted));
2521398c7888SPierre Jolivet   }
2522398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2523398c7888SPierre 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);
2524398c7888SPierre Jolivet   if (data->is) {
2525398c7888SPierre Jolivet     PetscCall(ISEqualUnsorted(data->is, dis, &flg));
2526398c7888SPierre Jolivet     PetscCall(ISDestroy(&dis));
2527398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input IS and output IS are not equal");
2528398c7888SPierre Jolivet   }
2529398c7888SPierre 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);
2530398c7888SPierre Jolivet   if (data->aux) {
2531398c7888SPierre Jolivet     PetscCall(MatMultEqual(data->aux, daux, 20, &flg));
2532398c7888SPierre Jolivet     PetscCall(MatDestroy(&daux));
2533398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input Mat and output Mat are not equal");
2534398c7888SPierre Jolivet   }
2535398c7888SPierre Jolivet #endif
25363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2537f1580f4eSBarry Smith }
2538f1580f4eSBarry Smith 
2539f1580f4eSBarry Smith /*@
2540f1580f4eSBarry Smith   PCHPDDMSetCoarseCorrectionType - Sets the coarse correction type.
2541f1580f4eSBarry Smith 
2542c3339decSBarry Smith   Collective
2543f1580f4eSBarry Smith 
2544f1580f4eSBarry Smith   Input Parameters:
2545f1580f4eSBarry Smith + pc   - preconditioner context
2546f1580f4eSBarry Smith - type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, or `PC_HPDDM_COARSE_CORRECTION_BALANCED`
2547f1580f4eSBarry Smith 
2548f1580f4eSBarry Smith   Options Database Key:
2549f1580f4eSBarry Smith . -pc_hpddm_coarse_correction <deflated, additive, balanced> - type of coarse correction to apply
2550f1580f4eSBarry Smith 
2551f1580f4eSBarry Smith   Level: intermediate
2552f1580f4eSBarry Smith 
2553562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2554f1580f4eSBarry Smith @*/
2555d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType type)
2556d71ae5a4SJacob Faibussowitsch {
2557f1580f4eSBarry Smith   PetscFunctionBegin;
2558f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2559f1580f4eSBarry Smith   PetscValidLogicalCollectiveEnum(pc, type, 2);
2560f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMSetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType), (pc, type));
25613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2562f1580f4eSBarry Smith }
2563f1580f4eSBarry Smith 
2564f1580f4eSBarry Smith /*@
2565f1580f4eSBarry Smith   PCHPDDMGetCoarseCorrectionType - Gets the coarse correction type.
2566f1580f4eSBarry Smith 
2567f1580f4eSBarry Smith   Input Parameter:
2568f1580f4eSBarry Smith . pc - preconditioner context
2569f1580f4eSBarry Smith 
2570f1580f4eSBarry Smith   Output Parameter:
2571f1580f4eSBarry Smith . type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, or `PC_HPDDM_COARSE_CORRECTION_BALANCED`
2572f1580f4eSBarry Smith 
2573f1580f4eSBarry Smith   Level: intermediate
2574f1580f4eSBarry Smith 
2575562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2576f1580f4eSBarry Smith @*/
2577d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType *type)
2578d71ae5a4SJacob Faibussowitsch {
2579f1580f4eSBarry Smith   PetscFunctionBegin;
2580f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2581f1580f4eSBarry Smith   if (type) {
25824f572ea9SToby Isaac     PetscAssertPointer(type, 2);
2583f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType *), (pc, type));
2584f1580f4eSBarry Smith   }
25853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2586f1580f4eSBarry Smith }
2587f1580f4eSBarry Smith 
2588d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType type)
2589d71ae5a4SJacob Faibussowitsch {
2590f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2591f1580f4eSBarry Smith 
2592f1580f4eSBarry Smith   PetscFunctionBegin;
2593f1580f4eSBarry Smith   PetscCheck(type >= 0 && type <= 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown PCHPDDMCoarseCorrectionType %d", type);
2594f1580f4eSBarry Smith   data->correction = type;
25953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2596f1580f4eSBarry Smith }
2597f1580f4eSBarry Smith 
2598d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType *type)
2599d71ae5a4SJacob Faibussowitsch {
2600f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2601f1580f4eSBarry Smith 
2602f1580f4eSBarry Smith   PetscFunctionBegin;
2603f1580f4eSBarry Smith   *type = data->correction;
26043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2605f1580f4eSBarry Smith }
2606f1580f4eSBarry Smith 
2607f1580f4eSBarry Smith /*@
2608e31fc274SPierre Jolivet   PCHPDDMSetSTShareSubKSP - Sets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver should be shared.
2609e31fc274SPierre Jolivet 
2610e31fc274SPierre Jolivet   Input Parameters:
2611e31fc274SPierre Jolivet + pc    - preconditioner context
2612e31fc274SPierre Jolivet - share - whether the `KSP` should be shared or not
2613e31fc274SPierre Jolivet 
2614e31fc274SPierre Jolivet   Note:
2615e31fc274SPierre Jolivet   This is not the same as `PCSetReusePreconditioner()`. Given certain conditions (visible using -info), a symbolic factorization can be skipped
2616e31fc274SPierre Jolivet   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2617e31fc274SPierre Jolivet 
2618e31fc274SPierre Jolivet   Level: advanced
2619e31fc274SPierre Jolivet 
2620562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMGetSTShareSubKSP()`
2621e31fc274SPierre Jolivet @*/
2622e31fc274SPierre Jolivet PetscErrorCode PCHPDDMSetSTShareSubKSP(PC pc, PetscBool share)
2623e31fc274SPierre Jolivet {
2624e31fc274SPierre Jolivet   PetscFunctionBegin;
2625e31fc274SPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2626e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetSTShareSubKSP_C", (PC, PetscBool), (pc, share));
26273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2628e31fc274SPierre Jolivet }
2629e31fc274SPierre Jolivet 
2630e31fc274SPierre Jolivet /*@
2631f1580f4eSBarry Smith   PCHPDDMGetSTShareSubKSP - Gets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver is shared.
2632f1580f4eSBarry Smith 
2633f1580f4eSBarry Smith   Input Parameter:
2634f1580f4eSBarry Smith . pc - preconditioner context
2635f1580f4eSBarry Smith 
2636f1580f4eSBarry Smith   Output Parameter:
2637f1580f4eSBarry Smith . share - whether the `KSP` is shared or not
2638f1580f4eSBarry Smith 
2639f1580f4eSBarry Smith   Note:
2640f1580f4eSBarry 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
2641f1580f4eSBarry Smith   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2642f1580f4eSBarry Smith 
2643f1580f4eSBarry Smith   Level: advanced
2644f1580f4eSBarry Smith 
2645562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetSTShareSubKSP()`
2646f1580f4eSBarry Smith @*/
2647d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetSTShareSubKSP(PC pc, PetscBool *share)
2648d71ae5a4SJacob Faibussowitsch {
2649f1580f4eSBarry Smith   PetscFunctionBegin;
2650f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2651f1580f4eSBarry Smith   if (share) {
26524f572ea9SToby Isaac     PetscAssertPointer(share, 2);
2653f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetSTShareSubKSP_C", (PC, PetscBool *), (pc, share));
2654f1580f4eSBarry Smith   }
26553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2656f1580f4eSBarry Smith }
2657f1580f4eSBarry Smith 
2658e31fc274SPierre Jolivet static PetscErrorCode PCHPDDMSetSTShareSubKSP_HPDDM(PC pc, PetscBool share)
2659e31fc274SPierre Jolivet {
2660e31fc274SPierre Jolivet   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2661e31fc274SPierre Jolivet 
2662e31fc274SPierre Jolivet   PetscFunctionBegin;
2663e31fc274SPierre Jolivet   data->share = share;
26643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2665e31fc274SPierre Jolivet }
2666e31fc274SPierre Jolivet 
2667d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetSTShareSubKSP_HPDDM(PC pc, PetscBool *share)
2668d71ae5a4SJacob Faibussowitsch {
2669f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2670f1580f4eSBarry Smith 
2671f1580f4eSBarry Smith   PetscFunctionBegin;
2672f1580f4eSBarry Smith   *share = data->share;
26733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2674f1580f4eSBarry Smith }
2675f1580f4eSBarry Smith 
2676f1580f4eSBarry Smith /*@
2677f1580f4eSBarry Smith   PCHPDDMSetDeflationMat - Sets the deflation space used to assemble a coarser operator.
2678f1580f4eSBarry Smith 
2679f1580f4eSBarry Smith   Input Parameters:
2680f1580f4eSBarry Smith + pc - preconditioner context
2681f1580f4eSBarry Smith . is - index set of the local deflation matrix
2682f1580f4eSBarry Smith - U  - deflation sequential matrix stored as a `MATSEQDENSE`
2683f1580f4eSBarry Smith 
2684f1580f4eSBarry Smith   Level: advanced
2685f1580f4eSBarry Smith 
2686562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCDeflationSetSpace()`, `PCMGSetRestriction()`
2687f1580f4eSBarry Smith @*/
2688d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetDeflationMat(PC pc, IS is, Mat U)
2689d71ae5a4SJacob Faibussowitsch {
2690f1580f4eSBarry Smith   PetscFunctionBegin;
2691f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2692f1580f4eSBarry Smith   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
2693f1580f4eSBarry Smith   PetscValidHeaderSpecific(U, MAT_CLASSID, 3);
2694e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetDeflationMat_C", (PC, IS, Mat), (pc, is, U));
26953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2696f1580f4eSBarry Smith }
2697f1580f4eSBarry Smith 
2698d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetDeflationMat_HPDDM(PC pc, IS is, Mat U)
2699d71ae5a4SJacob Faibussowitsch {
2700f1580f4eSBarry Smith   PetscFunctionBegin;
2701f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, U, PETSC_TRUE));
27023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2703f1580f4eSBarry Smith }
2704f1580f4eSBarry Smith 
2705d71ae5a4SJacob Faibussowitsch PetscErrorCode HPDDMLoadDL_Private(PetscBool *found)
2706d71ae5a4SJacob Faibussowitsch {
2707605ad303SPierre Jolivet   PetscBool flg;
2708f1580f4eSBarry Smith   char      lib[PETSC_MAX_PATH_LEN], dlib[PETSC_MAX_PATH_LEN], dir[PETSC_MAX_PATH_LEN];
2709f1580f4eSBarry Smith 
2710f1580f4eSBarry Smith   PetscFunctionBegin;
27114f572ea9SToby Isaac   PetscAssertPointer(found, 1);
2712c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(dir, "${PETSC_LIB_DIR}", sizeof(dir)));
2713db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, nullptr, "-hpddm_dir", dir, sizeof(dir), nullptr));
2714f1580f4eSBarry Smith   PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2715f1580f4eSBarry Smith   PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2716605ad303SPierre Jolivet #if defined(SLEPC_LIB_DIR) /* this variable is passed during SLEPc ./configure when PETSc has not been configured   */
2717605ad303SPierre Jolivet   if (!*found) {           /* with --download-hpddm since slepcconf.h is not yet built (and thus can't be included) */
2718c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(dir, HPDDM_STR(SLEPC_LIB_DIR), sizeof(dir)));
2719f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2720f1580f4eSBarry Smith     PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2721f1580f4eSBarry Smith   }
2722f1580f4eSBarry Smith #endif
2723605ad303SPierre 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 */
2724605ad303SPierre Jolivet     PetscCall(PetscOptionsGetenv(PETSC_COMM_SELF, "SLEPC_DIR", dir, sizeof(dir), &flg));
2725605ad303SPierre 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 */
2726605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libslepc", dir));
2727605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2728605ad303SPierre Jolivet       PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found but SLEPC_DIR=%s", lib, dir);
2729605ad303SPierre Jolivet       PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
2730605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libhpddm_petsc", dir)); /* libhpddm_petsc is always in the same directory as libslepc */
2731605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2732605ad303SPierre Jolivet     }
2733605ad303SPierre Jolivet   }
2734f1580f4eSBarry Smith   PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found", lib);
2735f1580f4eSBarry Smith   PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
27363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2737f1580f4eSBarry Smith }
2738f1580f4eSBarry Smith 
2739f1580f4eSBarry Smith /*MC
2740f1580f4eSBarry Smith    PCHPDDM - Interface with the HPDDM library.
2741f1580f4eSBarry Smith 
2742*1d27aa22SBarry Smith    This `PC` may be used to build multilevel spectral domain decomposition methods based on the GenEO framework {cite}`spillane2011robust` {cite}`al2021multilevel`.
2743*1d27aa22SBarry Smith    It may be viewed as an alternative to spectral
2744*1d27aa22SBarry Smith    AMGe or `PCBDDC` with adaptive selection of constraints. The interface is explained in details in {cite}`jolivetromanzampini2020`
2745f1580f4eSBarry Smith 
27467eb095acSPierre Jolivet    The matrix to be preconditioned (Pmat) may be unassembled (`MATIS`), assembled (`MATAIJ`, `MATBAIJ`, or `MATSBAIJ`), hierarchical (`MATHTOOL`), or `MATNORMAL`.
2747f1580f4eSBarry Smith 
2748f1580f4eSBarry Smith    For multilevel preconditioning, when using an assembled or hierarchical Pmat, one must provide an auxiliary local `Mat` (unassembled local operator for GenEO) using
2749f1580f4eSBarry Smith    `PCHPDDMSetAuxiliaryMat()`. Calling this routine is not needed when using a `MATIS` Pmat, assembly is done internally using `MatConvert()`.
2750f1580f4eSBarry Smith 
2751f1580f4eSBarry Smith    Options Database Keys:
2752f1580f4eSBarry Smith +   -pc_hpddm_define_subdomains <true, default=false>    - on the finest level, calls `PCASMSetLocalSubdomains()` with the `IS` supplied in `PCHPDDMSetAuxiliaryMat()`
2753f1580f4eSBarry Smith                                                          (not relevant with an unassembled Pmat)
2754f1580f4eSBarry Smith .   -pc_hpddm_has_neumann <true, default=false>          - on the finest level, informs the `PC` that the local Neumann matrix is supplied in `PCHPDDMSetAuxiliaryMat()`
2755f1580f4eSBarry Smith -   -pc_hpddm_coarse_correction <type, default=deflated> - determines the `PCHPDDMCoarseCorrectionType` when calling `PCApply()`
2756f1580f4eSBarry Smith 
275738bf2a8cSPierre Jolivet    Options for subdomain solvers, subdomain eigensolvers (for computing deflation vectors), and the coarse solver can be set using the following options database prefixes.
2758f1580f4eSBarry Smith .vb
2759f1580f4eSBarry Smith       -pc_hpddm_levels_%d_pc_
2760f1580f4eSBarry Smith       -pc_hpddm_levels_%d_ksp_
2761f1580f4eSBarry Smith       -pc_hpddm_levels_%d_eps_
2762f1580f4eSBarry Smith       -pc_hpddm_levels_%d_p
27634ec2a359SPierre Jolivet       -pc_hpddm_levels_%d_mat_type
2764f1580f4eSBarry Smith       -pc_hpddm_coarse_
2765f1580f4eSBarry Smith       -pc_hpddm_coarse_p
27664ec2a359SPierre Jolivet       -pc_hpddm_coarse_mat_type
27672ce66baaSPierre Jolivet       -pc_hpddm_coarse_mat_filter
2768f1580f4eSBarry Smith .ve
2769f1580f4eSBarry Smith 
277038bf2a8cSPierre 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
2771f1580f4eSBarry Smith     -pc_hpddm_coarse_p 2 -pc_hpddm_coarse_mat_type baij will use 10 deflation vectors per subdomain on the fine "level 1",
2772f1580f4eSBarry Smith     aggregate the fine subdomains into 4 "level 2" subdomains, then use 10 deflation vectors per subdomain on "level 2",
27737eb095acSPierre Jolivet     and assemble the coarse matrix (of dimension 4 x 10 = 40) on two processes as a `MATBAIJ` (default is `MATSBAIJ`).
2774f1580f4eSBarry Smith 
2775f1580f4eSBarry 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.
2776f1580f4eSBarry Smith 
2777*1d27aa22SBarry Smith    Level: intermediate
2778*1d27aa22SBarry Smith 
2779*1d27aa22SBarry Smith    Notes:
2780*1d27aa22SBarry Smith    This preconditioner requires that PETSc is built with SLEPc (``--download-slepc``).
2781*1d27aa22SBarry Smith 
2782*1d27aa22SBarry Smith    By default, the underlying concurrent eigenproblems
2783*1d27aa22SBarry Smith    are solved using SLEPc shift-and-invert spectral transformation. This is usually what gives the best performance for GenEO, cf.
2784*1d27aa22SBarry Smith    {cite}`spillane2011robust` {cite}`jolivet2013scalabledd`. As
278538bf2a8cSPierre 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
278638bf2a8cSPierre 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
278738bf2a8cSPierre Jolivet    SLEPc documentation since they are specific to `PCHPDDM`.
278838bf2a8cSPierre Jolivet .vb
278938bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_st_share_sub_ksp
279038bf2a8cSPierre Jolivet       -pc_hpddm_levels_%d_eps_threshold
279138bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_eps_use_inertia
279238bf2a8cSPierre Jolivet .ve
279338bf2a8cSPierre Jolivet 
279438bf2a8cSPierre Jolivet    The first option from the list only applies to the fine-level eigensolver, see `PCHPDDMSetSTShareSubKSP()`. The second option from the list is
279538bf2a8cSPierre Jolivet    used to filter eigenmodes retrieved after convergence of `EPSSolve()` at "level N" such that eigenvectors used to define a "level N+1" coarse
279638bf2a8cSPierre 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
279738bf2a8cSPierre 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
279838bf2a8cSPierre 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
279938bf2a8cSPierre Jolivet    to supply -pc_hpddm_levels_1_eps_nev. This last option also only applies to the fine-level (N = 1) eigensolver.
2800f1580f4eSBarry Smith 
2801*1d27aa22SBarry Smith    See also {cite}`dolean2015introduction`, {cite}`al2022robust`, {cite}`al2022robustpd`, and {cite}`nataf2022recent`
2802f1580f4eSBarry Smith 
2803562efe2eSBarry Smith .seealso: [](ch_ksp), `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetAuxiliaryMat()`, `MATIS`, `PCBDDC`, `PCDEFLATION`, `PCTELESCOPE`, `PCASM`,
2804e31fc274SPierre Jolivet           `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDMHasNeumannMat()`, `PCHPDDMSetRHSMat()`, `PCHPDDMSetDeflationMat()`, `PCHPDDMSetSTShareSubKSP()`,
2805e31fc274SPierre Jolivet           `PCHPDDMGetSTShareSubKSP()`, `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDMGetComplexities()`
2806f1580f4eSBarry Smith M*/
2807d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_HPDDM(PC pc)
2808d71ae5a4SJacob Faibussowitsch {
2809f1580f4eSBarry Smith   PC_HPDDM *data;
2810f1580f4eSBarry Smith   PetscBool found;
2811f1580f4eSBarry Smith 
2812f1580f4eSBarry Smith   PetscFunctionBegin;
2813f1580f4eSBarry Smith   if (!loadedSym) {
2814f1580f4eSBarry Smith     PetscCall(HPDDMLoadDL_Private(&found));
2815db4a47b3SPierre Jolivet     if (found) PetscCall(PetscDLLibrarySym(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, nullptr, "PCHPDDM_Internal", (void **)&loadedSym));
2816f1580f4eSBarry Smith   }
2817f1580f4eSBarry Smith   PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCHPDDM_Internal symbol not found in loaded libhpddm_petsc");
28184dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&data));
2819f1580f4eSBarry Smith   pc->data                = data;
2820c8ea6600SPierre Jolivet   data->Neumann           = PETSC_BOOL3_UNKNOWN;
2821f1580f4eSBarry Smith   pc->ops->reset          = PCReset_HPDDM;
2822f1580f4eSBarry Smith   pc->ops->destroy        = PCDestroy_HPDDM;
2823f1580f4eSBarry Smith   pc->ops->setfromoptions = PCSetFromOptions_HPDDM;
2824f1580f4eSBarry Smith   pc->ops->setup          = PCSetUp_HPDDM;
2825f1580f4eSBarry Smith   pc->ops->apply          = PCApply_HPDDM;
2826f1580f4eSBarry Smith   pc->ops->matapply       = PCMatApply_HPDDM;
2827f1580f4eSBarry Smith   pc->ops->view           = PCView_HPDDM;
2828f1580f4eSBarry Smith   pc->ops->presolve       = PCPreSolve_HPDDM;
2829f1580f4eSBarry Smith 
2830f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", PCHPDDMSetAuxiliaryMat_HPDDM));
2831f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", PCHPDDMHasNeumannMat_HPDDM));
2832f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", PCHPDDMSetRHSMat_HPDDM));
2833f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", PCHPDDMSetCoarseCorrectionType_HPDDM));
2834f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", PCHPDDMGetCoarseCorrectionType_HPDDM));
2835e31fc274SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", PCHPDDMSetSTShareSubKSP_HPDDM));
2836f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", PCHPDDMGetSTShareSubKSP_HPDDM));
2837f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", PCHPDDMSetDeflationMat_HPDDM));
28383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2839f1580f4eSBarry Smith }
2840f1580f4eSBarry Smith 
2841f1580f4eSBarry Smith /*@C
2842f1580f4eSBarry Smith   PCHPDDMInitializePackage - This function initializes everything in the `PCHPDDM` package. It is called from `PCInitializePackage()`.
2843f1580f4eSBarry Smith 
2844f1580f4eSBarry Smith   Level: developer
2845f1580f4eSBarry Smith 
2846562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscInitialize()`
2847f1580f4eSBarry Smith @*/
2848d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMInitializePackage(void)
2849d71ae5a4SJacob Faibussowitsch {
2850f1580f4eSBarry Smith   char     ename[32];
2851f1580f4eSBarry Smith   PetscInt i;
2852f1580f4eSBarry Smith 
2853f1580f4eSBarry Smith   PetscFunctionBegin;
28543ba16761SJacob Faibussowitsch   if (PCHPDDMPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
2855f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_TRUE;
2856f1580f4eSBarry Smith   PetscCall(PetscRegisterFinalize(PCHPDDMFinalizePackage));
2857f1580f4eSBarry Smith   /* general events registered once during package initialization */
2858f1580f4eSBarry Smith   /* some of these events are not triggered in libpetsc,          */
2859f1580f4eSBarry Smith   /* but rather directly in libhpddm_petsc,                       */
2860f1580f4eSBarry Smith   /* which is in charge of performing the following operations    */
2861f1580f4eSBarry Smith 
2862f1580f4eSBarry Smith   /* domain decomposition structure from Pmat sparsity pattern    */
2863f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMStrc", PC_CLASSID, &PC_HPDDM_Strc));
2864f1580f4eSBarry Smith   /* Galerkin product, redistribution, and setup (not triggered in libpetsc)                */
2865f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtAP", PC_CLASSID, &PC_HPDDM_PtAP));
2866f1580f4eSBarry Smith   /* Galerkin product with summation, redistribution, and setup (not triggered in libpetsc) */
2867f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtBP", PC_CLASSID, &PC_HPDDM_PtBP));
2868f1580f4eSBarry Smith   /* next level construction using PtAP and PtBP (not triggered in libpetsc)                */
2869f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMNext", PC_CLASSID, &PC_HPDDM_Next));
2870f1580f4eSBarry Smith   static_assert(PETSC_PCHPDDM_MAXLEVELS <= 9, "PETSC_PCHPDDM_MAXLEVELS value is too high");
2871f1580f4eSBarry Smith   for (i = 1; i < PETSC_PCHPDDM_MAXLEVELS; ++i) {
2872f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSetUp L%1" PetscInt_FMT, i));
2873f1580f4eSBarry Smith     /* events during a PCSetUp() at level #i _except_ the assembly */
2874f1580f4eSBarry Smith     /* of the Galerkin operator of the coarser level #(i + 1)      */
2875f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_SetUp[i - 1]));
2876f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSolve L%1" PetscInt_FMT, i));
2877f1580f4eSBarry Smith     /* events during a PCApply() at level #i _except_              */
2878f1580f4eSBarry Smith     /* the KSPSolve() of the coarser level #(i + 1)                */
2879f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_Solve[i - 1]));
2880f1580f4eSBarry Smith   }
28813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2882f1580f4eSBarry Smith }
2883f1580f4eSBarry Smith 
2884f1580f4eSBarry Smith /*@C
2885f1580f4eSBarry Smith   PCHPDDMFinalizePackage - This function frees everything from the `PCHPDDM` package. It is called from `PetscFinalize()`.
2886f1580f4eSBarry Smith 
2887f1580f4eSBarry Smith   Level: developer
2888f1580f4eSBarry Smith 
2889562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscFinalize()`
2890f1580f4eSBarry Smith @*/
2891d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMFinalizePackage(void)
2892d71ae5a4SJacob Faibussowitsch {
2893f1580f4eSBarry Smith   PetscFunctionBegin;
2894f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_FALSE;
28953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2896f1580f4eSBarry Smith }
28979bb5c669SPierre Jolivet 
28989bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat A, Vec x, Vec y)
28999bb5c669SPierre Jolivet {
29009bb5c669SPierre Jolivet   Harmonic h; /* [ A_00  A_01       ], furthermore, A_00 = [ A_loc,loc  A_loc,ovl ], thus, A_01 = [         ] */
29019bb5c669SPierre Jolivet               /* [ A_10  A_11  A_12 ]                      [ A_ovl,loc  A_ovl,ovl ]               [ A_ovl,1 ] */
29029bb5c669SPierre Jolivet   Vec sub;    /*  y = A x = R_loc R_0 [ A_00  A_01 ]^-1                                   R_loc = [  I_loc  ] */
29039bb5c669SPierre Jolivet               /*                      [ A_10  A_11 ]    R_1^T A_12 x                              [         ] */
29049bb5c669SPierre Jolivet   PetscFunctionBegin;
29059bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
29069bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
29079bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
29089bb5c669SPierre Jolivet   PetscCall(MatMult(h->A[0], x, sub));
29099bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
29109bb5c669SPierre Jolivet   PetscCall(KSPSolve(h->ksp, h->v, h->v));
29119bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_REVERSE, y));
29129bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
29139bb5c669SPierre Jolivet }
29149bb5c669SPierre Jolivet 
29159bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat A, Vec y, Vec x)
29169bb5c669SPierre Jolivet {
29179bb5c669SPierre Jolivet   Harmonic h;   /* x = A^T y =            [ A_00  A_01 ]^-T R_0^T R_loc^T y */
29189bb5c669SPierre Jolivet   Vec      sub; /*             A_12^T R_1 [ A_10  A_11 ]                    */
29199bb5c669SPierre Jolivet 
29209bb5c669SPierre Jolivet   PetscFunctionBegin;
29219bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
29229bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
29239bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_FORWARD, y));
29249bb5c669SPierre Jolivet   PetscCall(KSPSolveTranspose(h->ksp, h->v, h->v));
29259bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
29269bb5c669SPierre Jolivet   PetscCall(MatMultTranspose(h->A[0], sub, x));
29279bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
29289bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
29299bb5c669SPierre Jolivet }
29309bb5c669SPierre Jolivet 
29319bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat S, Mat X, Mat Y, void *)
29329bb5c669SPierre Jolivet {
29339bb5c669SPierre Jolivet   Harmonic h;
29349bb5c669SPierre Jolivet   Mat      A, B;
29359bb5c669SPierre Jolivet   Vec      a, b;
29369bb5c669SPierre Jolivet 
29379bb5c669SPierre Jolivet   PetscFunctionBegin;
29389bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
29399bb5c669SPierre Jolivet   PetscCall(MatMatMult(h->A[0], X, MAT_INITIAL_MATRIX, PETSC_DEFAULT, &A));
29409bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
29419bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
29429bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
29439bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B, i, &b));
29449bb5c669SPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_FORWARD, a));
29459bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B, i, &b));
29469bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
29479bb5c669SPierre Jolivet   }
29489bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
29499bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, B->cmap->n, nullptr, &A));
29509bb5c669SPierre Jolivet   PetscCall(KSPMatSolve(h->ksp, B, A));
29519bb5c669SPierre Jolivet   PetscCall(MatDestroy(&B));
29529bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
29539bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
29549bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &b));
29559bb5c669SPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_REVERSE, b));
29569bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &b));
29579bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
29589bb5c669SPierre Jolivet   }
29599bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
29609bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
29619bb5c669SPierre Jolivet }
29629bb5c669SPierre Jolivet 
29639bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat A)
29649bb5c669SPierre Jolivet {
29659bb5c669SPierre Jolivet   Harmonic h;
29669bb5c669SPierre Jolivet 
29679bb5c669SPierre Jolivet   PetscFunctionBegin;
29689bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
29699bb5c669SPierre Jolivet   for (PetscInt i = 0; i < (h->A[1] ? 5 : 3); ++i) PetscCall(ISDestroy(h->is + i));
29709bb5c669SPierre Jolivet   PetscCall(PetscFree(h->is));
29719bb5c669SPierre Jolivet   PetscCall(VecDestroy(&h->v));
29729bb5c669SPierre Jolivet   for (PetscInt i = 0; i < 2; ++i) PetscCall(MatDestroy(h->A + i));
29739bb5c669SPierre Jolivet   PetscCall(PetscFree(h->A));
29749bb5c669SPierre Jolivet   PetscCall(KSPDestroy(&h->ksp));
29759bb5c669SPierre Jolivet   PetscCall(PetscFree(h));
29769bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
29779bb5c669SPierre Jolivet }
2978