xref: /petsc/src/ksp/pc/impls/hpddm/pchpddm.cxx (revision e7593814f3d18e40d1a3e7e1b30da391cfa0afd7)
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 
22aa1539e9SPierre Jolivet const char *const PCHPDDMCoarseCorrectionTypes[] = {"DEFLATED", "ADDITIVE", "BALANCED", "NONE", "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;
75cdbd50ebSPierre Jolivet   PCHPDDMCoarseCorrectionType type = data->correction;
76f1580f4eSBarry Smith 
77f1580f4eSBarry Smith   PetscFunctionBegin;
78f1580f4eSBarry Smith   if (is) {
79f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)is));
80f1580f4eSBarry Smith     if (data->is) { /* new overlap definition resets the PC */
81f1580f4eSBarry Smith       PetscCall(PCReset_HPDDM(pc));
82f1580f4eSBarry Smith       pc->setfromoptionscalled = 0;
83b853e353SPierre Jolivet       pc->setupcalled          = 0;
84cdbd50ebSPierre Jolivet       data->correction         = type;
85f1580f4eSBarry Smith     }
86f1580f4eSBarry Smith     PetscCall(ISDestroy(&data->is));
87f1580f4eSBarry Smith     data->is = is;
88f1580f4eSBarry Smith   }
89f1580f4eSBarry Smith   if (A) {
90f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)A));
91f1580f4eSBarry Smith     PetscCall(MatDestroy(&data->aux));
92f1580f4eSBarry Smith     data->aux = A;
93f1580f4eSBarry Smith   }
94f1580f4eSBarry Smith   data->deflation = deflation;
953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
96f1580f4eSBarry Smith }
97f1580f4eSBarry Smith 
983df4cd7bSPierre Jolivet static inline PetscErrorCode PCHPDDMSetAuxiliaryMatNormal_Private(PC pc, Mat A, Mat N, Mat *B, const char *pcpre, Vec *diagonal = nullptr)
99d71ae5a4SJacob Faibussowitsch {
100f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
101f1580f4eSBarry Smith   Mat      *splitting, *sub, aux;
1023df4cd7bSPierre Jolivet   Vec       d;
103f1580f4eSBarry Smith   IS        is, cols[2], rows;
104f1580f4eSBarry Smith   PetscReal norm;
105f1580f4eSBarry Smith   PetscBool flg;
106f1580f4eSBarry Smith   char      type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
107f1580f4eSBarry Smith 
108f1580f4eSBarry Smith   PetscFunctionBegin;
109f1580f4eSBarry Smith   PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, B));
110f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, cols));
111f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->rmap->N, 0, 1, &rows));
112f1580f4eSBarry Smith   PetscCall(MatSetOption(A, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
113f1580f4eSBarry Smith   PetscCall(MatIncreaseOverlap(*B, 1, cols, 1));
114f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(A, 1, &rows, cols, MAT_INITIAL_MATRIX, &splitting));
115f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, &is));
116f1580f4eSBarry Smith   PetscCall(ISEmbed(*cols, is, PETSC_TRUE, cols + 1));
117f1580f4eSBarry Smith   PetscCall(ISDestroy(&is));
118f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(*splitting, 1, &rows, cols + 1, MAT_INITIAL_MATRIX, &sub));
119f1580f4eSBarry Smith   PetscCall(ISDestroy(cols + 1));
120f1580f4eSBarry Smith   PetscCall(MatFindZeroRows(*sub, &is));
121f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &sub));
122f1580f4eSBarry Smith   PetscCall(ISDestroy(&rows));
123f1580f4eSBarry Smith   PetscCall(MatSetOption(*splitting, MAT_KEEP_NONZERO_PATTERN, PETSC_TRUE));
124db4a47b3SPierre Jolivet   PetscCall(MatZeroRowsIS(*splitting, is, 0.0, nullptr, nullptr));
125f1580f4eSBarry Smith   PetscCall(ISDestroy(&is));
126db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_sub_pc_type", type, sizeof(type), nullptr));
127f1580f4eSBarry Smith   PetscCall(PetscStrcmp(type, PCQR, &flg));
128f1580f4eSBarry Smith   if (!flg) {
129f1580f4eSBarry Smith     Mat conjugate = *splitting;
130f1580f4eSBarry Smith     if (PetscDefined(USE_COMPLEX)) {
131f1580f4eSBarry Smith       PetscCall(MatDuplicate(*splitting, MAT_COPY_VALUES, &conjugate));
132f1580f4eSBarry Smith       PetscCall(MatConjugate(conjugate));
133f1580f4eSBarry Smith     }
134f1580f4eSBarry Smith     PetscCall(MatTransposeMatMult(conjugate, *splitting, MAT_INITIAL_MATRIX, PETSC_DEFAULT, &aux));
135f1580f4eSBarry Smith     if (PetscDefined(USE_COMPLEX)) PetscCall(MatDestroy(&conjugate));
136f1580f4eSBarry Smith     PetscCall(MatNorm(aux, NORM_FROBENIUS, &norm));
137f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1383df4cd7bSPierre Jolivet     if (diagonal) {
1393df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1403df4cd7bSPierre Jolivet       if (norm > PETSC_SMALL) {
1413df4cd7bSPierre Jolivet         VecScatter scatter;
1423df4cd7bSPierre Jolivet         PetscInt   n;
1433df4cd7bSPierre Jolivet         PetscCall(ISGetLocalSize(*cols, &n));
1443df4cd7bSPierre Jolivet         PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)pc), n, PETSC_DECIDE, &d));
1453df4cd7bSPierre Jolivet         PetscCall(VecScatterCreate(*diagonal, *cols, d, nullptr, &scatter));
1463df4cd7bSPierre Jolivet         PetscCall(VecScatterBegin(scatter, *diagonal, d, INSERT_VALUES, SCATTER_FORWARD));
1473df4cd7bSPierre Jolivet         PetscCall(VecScatterEnd(scatter, *diagonal, d, INSERT_VALUES, SCATTER_FORWARD));
1483df4cd7bSPierre Jolivet         PetscCall(VecScatterDestroy(&scatter));
1493df4cd7bSPierre Jolivet         PetscCall(MatScale(aux, -1.0));
1503df4cd7bSPierre Jolivet         PetscCall(MatDiagonalSet(aux, d, ADD_VALUES));
1513df4cd7bSPierre Jolivet         PetscCall(VecDestroy(&d));
1523df4cd7bSPierre Jolivet       } else PetscCall(VecDestroy(diagonal));
1533df4cd7bSPierre Jolivet     }
1543df4cd7bSPierre Jolivet     if (!diagonal) PetscCall(MatShift(aux, PETSC_SMALL * norm));
155f1580f4eSBarry Smith   } else {
156f1580f4eSBarry Smith     PetscBool flg;
1573df4cd7bSPierre Jolivet     if (diagonal) {
1583df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1593df4cd7bSPierre Jolivet       PetscCheck(norm < PETSC_SMALL, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Nonzero diagonal A11 block");
1603df4cd7bSPierre Jolivet       PetscCall(VecDestroy(diagonal));
1613df4cd7bSPierre Jolivet     }
162f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)N, MATNORMAL, &flg));
163f1580f4eSBarry Smith     if (flg) PetscCall(MatCreateNormal(*splitting, &aux));
164f1580f4eSBarry Smith     else PetscCall(MatCreateNormalHermitian(*splitting, &aux));
165f1580f4eSBarry Smith   }
166f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &splitting));
167db4a47b3SPierre Jolivet   PetscCall(PCHPDDMSetAuxiliaryMat(pc, *cols, aux, nullptr, nullptr));
168c8ea6600SPierre Jolivet   data->Neumann = PETSC_BOOL3_TRUE;
169f1580f4eSBarry Smith   PetscCall(ISDestroy(cols));
170f1580f4eSBarry Smith   PetscCall(MatDestroy(&aux));
1713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
172f1580f4eSBarry Smith }
173f1580f4eSBarry Smith 
174d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetAuxiliaryMat_HPDDM(PC pc, IS is, Mat A, PetscErrorCode (*setup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *setup_ctx)
175d71ae5a4SJacob Faibussowitsch {
176f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
177f1580f4eSBarry Smith 
178f1580f4eSBarry Smith   PetscFunctionBegin;
179f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, A, PETSC_FALSE));
180f1580f4eSBarry Smith   if (setup) {
181f1580f4eSBarry Smith     data->setup     = setup;
182f1580f4eSBarry Smith     data->setup_ctx = setup_ctx;
183f1580f4eSBarry Smith   }
1843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
185f1580f4eSBarry Smith }
186f1580f4eSBarry Smith 
18773329a61SPierre Jolivet typedef struct {
18873329a61SPierre Jolivet   KSP      ksp;
18973329a61SPierre Jolivet   PetscInt its;
19073329a61SPierre Jolivet } PC_KSP;
19173329a61SPierre Jolivet 
19273329a61SPierre Jolivet static inline PetscErrorCode PCSetUp_KSP_Private(PC pc)
19373329a61SPierre Jolivet {
19473329a61SPierre Jolivet   PC_KSP           *data   = (PC_KSP *)pc->data;
19573329a61SPierre Jolivet   const std::string prefix = ((PetscObject)data->ksp)->prefix;
19673329a61SPierre Jolivet   std::string       sub;
19773329a61SPierre Jolivet 
19873329a61SPierre Jolivet   PetscFunctionBegin;
19973329a61SPierre 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_");
20073329a61SPierre Jolivet   sub = prefix.substr(0, prefix.size() - 9);
20173329a61SPierre Jolivet   PetscCall(PCSetType(pc, PCHPDDM));
20273329a61SPierre Jolivet   PetscCall(PCSetOptionsPrefix(pc, sub.c_str()));
20373329a61SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
20473329a61SPierre Jolivet }
20573329a61SPierre Jolivet 
20673329a61SPierre Jolivet static PetscErrorCode PCSetUp_KSP(PC pc)
20773329a61SPierre Jolivet {
20873329a61SPierre Jolivet   PetscFunctionBegin;
20973329a61SPierre Jolivet   PetscCall(PCSetUp_KSP_Private(pc));
21073329a61SPierre Jolivet   PetscCall(PCSetFromOptions(pc));
21173329a61SPierre Jolivet   PetscCall(PCSetUp(pc));
21273329a61SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
21373329a61SPierre Jolivet }
21473329a61SPierre Jolivet 
21570009435SPierre Jolivet /*@C
21604c3f3b8SBarry Smith   PCHPDDMSetAuxiliaryMat - Sets the auxiliary matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
217f1580f4eSBarry Smith 
218f1580f4eSBarry Smith   Input Parameters:
219f1580f4eSBarry Smith + pc    - preconditioner context
220f1580f4eSBarry Smith . is    - index set of the local auxiliary, e.g., Neumann, matrix
221f1580f4eSBarry Smith . A     - auxiliary sequential matrix
22204c3f3b8SBarry Smith . setup - function for generating the auxiliary matrix entries, may be `NULL`
22304c3f3b8SBarry Smith - ctx   - context for `setup`, may be `NULL`
22404c3f3b8SBarry Smith 
22504c3f3b8SBarry Smith   Calling sequence of `setup`:
22604c3f3b8SBarry Smith + J   - matrix whose values are to be set
22704c3f3b8SBarry Smith . t   - time
22804c3f3b8SBarry Smith . X   - linearization point
22904c3f3b8SBarry Smith . X_t - time-derivative of the linearization point
23004c3f3b8SBarry Smith . s   - step
23104c3f3b8SBarry Smith . ovl - index set of the local auxiliary, e.g., Neumann, matrix
23204c3f3b8SBarry Smith - ctx - context for `setup`, may be `NULL`
233f1580f4eSBarry Smith 
234f1580f4eSBarry Smith   Level: intermediate
235f1580f4eSBarry Smith 
23604c3f3b8SBarry Smith   Note:
23704c3f3b8SBarry Smith   As an example, in a finite element context with nonoverlapping subdomains plus (overlapping) ghost elements, this could be the unassembled (Neumann)
23804c3f3b8SBarry Smith   local overlapping operator. As opposed to the assembled (Dirichlet) local overlapping operator obtained by summing neighborhood contributions
23904c3f3b8SBarry Smith   at the interface of ghost elements.
24004c3f3b8SBarry Smith 
24170009435SPierre Jolivet   Fortran Notes:
24204c3f3b8SBarry Smith   Only `PETSC_NULL_FUNCTION` is supported for `setup` and `ctx` is never accessed
24370009435SPierre Jolivet 
244562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetRHSMat()`, `MATIS`
245f1580f4eSBarry Smith @*/
24604c3f3b8SBarry 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)
247d71ae5a4SJacob Faibussowitsch {
248f1580f4eSBarry Smith   PetscFunctionBegin;
249f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
250f1580f4eSBarry Smith   if (is) PetscValidHeaderSpecific(is, IS_CLASSID, 2);
251f1580f4eSBarry Smith   if (A) PetscValidHeaderSpecific(A, MAT_CLASSID, 3);
25273329a61SPierre Jolivet   if (pc->ops->setup == PCSetUp_KSP) PetscCall(PCSetUp_KSP_Private(pc));
25304c3f3b8SBarry Smith   PetscTryMethod(pc, "PCHPDDMSetAuxiliaryMat_C", (PC, IS, Mat, PetscErrorCode(*)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *), (pc, is, A, setup, ctx));
2543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
255f1580f4eSBarry Smith }
256f1580f4eSBarry Smith 
257d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMHasNeumannMat_HPDDM(PC pc, PetscBool has)
258d71ae5a4SJacob Faibussowitsch {
259f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
260f1580f4eSBarry Smith 
261f1580f4eSBarry Smith   PetscFunctionBegin;
262c8ea6600SPierre Jolivet   data->Neumann = PetscBoolToBool3(has);
2633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
264f1580f4eSBarry Smith }
265f1580f4eSBarry Smith 
266f1580f4eSBarry Smith /*@
267f1580f4eSBarry Smith   PCHPDDMHasNeumannMat - Informs `PCHPDDM` that the `Mat` passed to `PCHPDDMSetAuxiliaryMat()` is the local Neumann matrix.
268f1580f4eSBarry Smith 
269f1580f4eSBarry Smith   Input Parameters:
270f1580f4eSBarry Smith + pc  - preconditioner context
271f1580f4eSBarry Smith - has - Boolean value
272f1580f4eSBarry Smith 
273f1580f4eSBarry Smith   Level: intermediate
274f1580f4eSBarry Smith 
275f1580f4eSBarry Smith   Notes:
2767eb095acSPierre Jolivet   This may be used to bypass a call to `MatCreateSubMatrices()` and to `MatConvert()` for `MATSBAIJ` matrices.
277f1580f4eSBarry Smith 
278907a3e9cSStefano Zampini   If a function is composed with DMCreateNeumannOverlap_C implementation is available in the `DM` attached to the Pmat, or the Amat, or the `PC`, the flag is internally set to `PETSC_TRUE`. Its default value is otherwise `PETSC_FALSE`.
279f1580f4eSBarry Smith 
280562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetAuxiliaryMat()`
281f1580f4eSBarry Smith @*/
282d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMHasNeumannMat(PC pc, PetscBool has)
283d71ae5a4SJacob Faibussowitsch {
284f1580f4eSBarry Smith   PetscFunctionBegin;
285f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
286f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMHasNeumannMat_C", (PC, PetscBool), (pc, has));
2873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
288f1580f4eSBarry Smith }
289f1580f4eSBarry Smith 
290d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetRHSMat_HPDDM(PC pc, Mat B)
291d71ae5a4SJacob Faibussowitsch {
292f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
293f1580f4eSBarry Smith 
294f1580f4eSBarry Smith   PetscFunctionBegin;
295f1580f4eSBarry Smith   PetscCall(PetscObjectReference((PetscObject)B));
296f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->B));
297f1580f4eSBarry Smith   data->B = B;
2983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
299f1580f4eSBarry Smith }
300f1580f4eSBarry Smith 
301f1580f4eSBarry Smith /*@
30204c3f3b8SBarry Smith   PCHPDDMSetRHSMat - Sets the right-hand side matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
303f1580f4eSBarry Smith 
304f1580f4eSBarry Smith   Input Parameters:
305f1580f4eSBarry Smith + pc - preconditioner context
306f1580f4eSBarry Smith - B  - right-hand side sequential matrix
307f1580f4eSBarry Smith 
308f1580f4eSBarry Smith   Level: advanced
309f1580f4eSBarry Smith 
31004c3f3b8SBarry Smith   Note:
31104c3f3b8SBarry Smith   Must be used in conjunction with `PCHPDDMSetAuxiliaryMat`(N), so that Nv = lambda Bv is solved using `EPSSetOperators`(N, B).
31204c3f3b8SBarry 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.
31304c3f3b8SBarry Smith 
314562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetAuxiliaryMat()`, `PCHPDDM`
315f1580f4eSBarry Smith @*/
316d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetRHSMat(PC pc, Mat B)
317d71ae5a4SJacob Faibussowitsch {
318f1580f4eSBarry Smith   PetscFunctionBegin;
319f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
320f1580f4eSBarry Smith   if (B) {
321f1580f4eSBarry Smith     PetscValidHeaderSpecific(B, MAT_CLASSID, 2);
322f1580f4eSBarry Smith     PetscTryMethod(pc, "PCHPDDMSetRHSMat_C", (PC, Mat), (pc, B));
323f1580f4eSBarry Smith   }
3243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
325f1580f4eSBarry Smith }
326f1580f4eSBarry Smith 
327d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_HPDDM(PC pc, PetscOptionItems *PetscOptionsObject)
328d71ae5a4SJacob Faibussowitsch {
329f1580f4eSBarry Smith   PC_HPDDM                   *data   = (PC_HPDDM *)pc->data;
330f1580f4eSBarry Smith   PC_HPDDM_Level            **levels = data->levels;
331f1580f4eSBarry Smith   char                        prefix[256];
332f1580f4eSBarry Smith   int                         i = 1;
333f1580f4eSBarry Smith   PetscMPIInt                 size, previous;
3349bb5c669SPierre Jolivet   PetscInt                    n, overlap = 1;
335f1580f4eSBarry Smith   PCHPDDMCoarseCorrectionType type;
336c8ea6600SPierre Jolivet   PetscBool                   flg = PETSC_TRUE, set;
337f1580f4eSBarry Smith 
338f1580f4eSBarry Smith   PetscFunctionBegin;
339f1580f4eSBarry Smith   if (!data->levels) {
340f1580f4eSBarry Smith     PetscCall(PetscCalloc1(PETSC_PCHPDDM_MAXLEVELS, &levels));
341f1580f4eSBarry Smith     data->levels = levels;
342f1580f4eSBarry Smith   }
343f1580f4eSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "PCHPDDM options");
3449bb5c669SPierre Jolivet   PetscCall(PetscOptionsBoundedInt("-pc_hpddm_harmonic_overlap", "Overlap prior to computing local harmonic extensions", "PCHPDDM", overlap, &overlap, &set, 1));
3459bb5c669SPierre Jolivet   if (!set) overlap = -1;
346f1580f4eSBarry Smith   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
347f1580f4eSBarry Smith   previous = size;
348f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS) {
349f1580f4eSBarry Smith     PetscInt p = 1;
350f1580f4eSBarry Smith 
3514dfa11a4SJacob Faibussowitsch     if (!data->levels[i - 1]) PetscCall(PetscNew(data->levels + i - 1));
352f1580f4eSBarry Smith     data->levels[i - 1]->parent = data;
353f1580f4eSBarry Smith     /* if the previous level has a single process, it is not possible to coarsen further */
354f1580f4eSBarry Smith     if (previous == 1 || !flg) break;
355f1580f4eSBarry Smith     data->levels[i - 1]->nu        = 0;
356f1580f4eSBarry Smith     data->levels[i - 1]->threshold = -1.0;
357f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
358db4a47b3SPierre 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));
359f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold", i));
360db4a47b3SPierre 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));
361f1580f4eSBarry Smith     if (i == 1) {
362aa1539e9SPierre Jolivet       PetscCheck(overlap == -1 || PetscAbsReal(data->levels[i - 1]->threshold + static_cast<PetscReal>(1.0)) < PETSC_MACHINE_EPSILON, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot supply both -pc_hpddm_levels_1_eps_threshold and -pc_hpddm_harmonic_overlap");
3639bb5c669SPierre Jolivet       if (overlap != -1) {
3649bb5c669SPierre Jolivet         PetscInt nsv = 0;
3659bb5c669SPierre Jolivet         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_nsv", i));
3669bb5c669SPierre Jolivet         PetscCall(PetscOptionsBoundedInt(prefix, "Local number of deflation vectors computed by SLEPc", "SVDSetDimensions", nsv, &nsv, nullptr, 0));
3679bb5c669SPierre 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");
3689bb5c669SPierre Jolivet         if (nsv) {
3699bb5c669SPierre Jolivet           data->levels[0]->nu = nsv;
3709bb5c669SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_relative_threshold", i));
3719bb5c669SPierre Jolivet         } else PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_relative_threshold", i));
3729bb5c669SPierre Jolivet         PetscCall(PetscOptionsReal(prefix, "Local relative threshold for selecting deflation vectors returned by SLEPc", "PCHPDDM", data->levels[0]->threshold, &data->levels[0]->threshold, nullptr));
3739bb5c669SPierre Jolivet       }
374f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_1_st_share_sub_ksp"));
375db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Shared KSP between SLEPc ST and the fine-level subdomain solver", "PCHPDDMSetSTShareSubKSP", PETSC_FALSE, &data->share, nullptr));
376f1580f4eSBarry Smith     }
377f1580f4eSBarry Smith     /* if there is no prescribed coarsening, just break out of the loop */
3780594bca0SPierre Jolivet     if (data->levels[i - 1]->threshold <= PetscReal() && data->levels[i - 1]->nu <= 0 && !(data->deflation && i == 1)) break;
379f1580f4eSBarry Smith     else {
380f1580f4eSBarry Smith       ++i;
381f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
382f1580f4eSBarry Smith       PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
383f1580f4eSBarry Smith       if (!flg) {
384f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold", i));
385f1580f4eSBarry Smith         PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
386f1580f4eSBarry Smith       }
387f1580f4eSBarry Smith       if (flg) {
388f1580f4eSBarry Smith         /* if there are coarsening options for the next level, then register it  */
389f1580f4eSBarry Smith         /* otherwise, don't to avoid having both options levels_N_p and coarse_p */
390f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_p", i));
391f1580f4eSBarry 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)));
392f1580f4eSBarry Smith         previous = p;
393f1580f4eSBarry Smith       }
394f1580f4eSBarry Smith     }
395f1580f4eSBarry Smith   }
396f1580f4eSBarry Smith   data->N = i;
397f1580f4eSBarry Smith   n       = 1;
398f1580f4eSBarry Smith   if (i > 1) {
399f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_coarse_p"));
400db4a47b3SPierre Jolivet     PetscCall(PetscOptionsRangeInt(prefix, "Number of processes used to assemble the coarsest operator", "PCHPDDM", n, &n, nullptr, 1, PetscMax(1, previous / 2)));
40102800ff6SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
402f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "pc_hpddm_coarse_"));
403db4a47b3SPierre Jolivet     PetscCall(PetscOptionsHasName(nullptr, prefix, "-mat_mumps_use_omp_threads", &flg));
404f1580f4eSBarry Smith     if (flg) {
405f1580f4eSBarry Smith       char type[64];                                                                                                    /* same size as in src/ksp/pc/impls/factor/factimpl.c */
406c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(type, n > 1 && PetscDefined(HAVE_MUMPS) ? MATSOLVERMUMPS : MATSOLVERPETSC, sizeof(type))); /* default solver for a MatMPIAIJ or a MatSeqAIJ */
407db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetString(nullptr, prefix, "-pc_factor_mat_solver_type", type, sizeof(type), nullptr));
4083ce573a3SPierre Jolivet       PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
409f1580f4eSBarry 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);
410f1580f4eSBarry Smith       size = n;
411f1580f4eSBarry Smith       n    = -1;
412db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetInt(nullptr, prefix, "-mat_mumps_use_omp_threads", &n, nullptr));
413f1580f4eSBarry Smith       PetscCheck(n >= 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Need to specify a positive integer for -%smat_mumps_use_omp_threads", prefix);
414f1580f4eSBarry 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" : "");
415f1580f4eSBarry Smith     }
416f1580f4eSBarry Smith #endif
417f1580f4eSBarry Smith     PetscCall(PetscOptionsEnum("-pc_hpddm_coarse_correction", "Type of coarse correction applied each iteration", "PCHPDDMSetCoarseCorrectionType", PCHPDDMCoarseCorrectionTypes, (PetscEnum)data->correction, (PetscEnum *)&type, &flg));
418f1580f4eSBarry Smith     if (flg) PetscCall(PCHPDDMSetCoarseCorrectionType(pc, type));
419f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_has_neumann"));
420c8ea6600SPierre Jolivet     PetscCall(PetscOptionsBool(prefix, "Is the auxiliary Mat the local Neumann matrix?", "PCHPDDMHasNeumannMat", PetscBool3ToBool(data->Neumann), &flg, &set));
421c8ea6600SPierre Jolivet     if (set) data->Neumann = PetscBoolToBool3(flg);
422f1580f4eSBarry Smith     data->log_separate = PETSC_FALSE;
423f1580f4eSBarry Smith     if (PetscDefined(USE_LOG)) {
424f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_log_separate"));
425db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Log events level by level instead of inside PCSetUp()/KSPSolve()", nullptr, data->log_separate, &data->log_separate, nullptr));
426f1580f4eSBarry Smith     }
427f1580f4eSBarry Smith   }
428f1580f4eSBarry Smith   PetscOptionsHeadEnd();
429f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]) PetscCall(PetscFree(data->levels[i++]));
4303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
431f1580f4eSBarry Smith }
432f1580f4eSBarry Smith 
433d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDM(PC pc, Vec x, Vec y)
434d71ae5a4SJacob Faibussowitsch {
435f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
436f1580f4eSBarry Smith 
437f1580f4eSBarry Smith   PetscFunctionBegin;
438f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
439f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
440db4a47b3SPierre 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 */
441f1580f4eSBarry Smith   PetscCall(KSPSolve(data->levels[0]->ksp, x, y));
442db4a47b3SPierre Jolivet   if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
4433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
444f1580f4eSBarry Smith }
445f1580f4eSBarry Smith 
446d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDM(PC pc, Mat X, Mat Y)
447d71ae5a4SJacob Faibussowitsch {
448f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
449f1580f4eSBarry Smith 
450f1580f4eSBarry Smith   PetscFunctionBegin;
451f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
452f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
453f1580f4eSBarry Smith   PetscCall(KSPMatSolve(data->levels[0]->ksp, X, Y));
4543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
455f1580f4eSBarry Smith }
456f1580f4eSBarry Smith 
45704c3f3b8SBarry Smith // PetscClangLinter pragma disable: -fdoc-internal-linkage
458f1580f4eSBarry Smith /*@C
459f1580f4eSBarry Smith      PCHPDDMGetComplexities - Computes the grid and operator complexities.
460f1580f4eSBarry Smith 
461f1580f4eSBarry Smith    Input Parameter:
462f1580f4eSBarry Smith .     pc - preconditioner context
463f1580f4eSBarry Smith 
464f1580f4eSBarry Smith    Output Parameters:
465f1580f4eSBarry Smith +     gc - grid complexity = sum_i(m_i) / m_1
466f1580f4eSBarry Smith -     oc - operator complexity = sum_i(nnz_i) / nnz_1
467f1580f4eSBarry Smith 
468f1580f4eSBarry Smith    Level: advanced
469f1580f4eSBarry Smith 
470562efe2eSBarry Smith .seealso: [](ch_ksp), `PCMGGetGridComplexity()`, `PCHPDDM`, `PCHYPRE`, `PCGAMG`
471f1580f4eSBarry Smith @*/
472d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetComplexities(PC pc, PetscReal *gc, PetscReal *oc)
473d71ae5a4SJacob Faibussowitsch {
474f1580f4eSBarry Smith   PC_HPDDM      *data = (PC_HPDDM *)pc->data;
475f1580f4eSBarry Smith   MatInfo        info;
476f1580f4eSBarry Smith   PetscInt       n, m;
477f1580f4eSBarry Smith   PetscLogDouble accumulate[2]{}, nnz1 = 1.0, m1 = 1.0;
478f1580f4eSBarry Smith 
479f1580f4eSBarry Smith   PetscFunctionBegin;
480f1580f4eSBarry Smith   for (n = 0, *gc = 0, *oc = 0; n < data->N; ++n) {
481f1580f4eSBarry Smith     if (data->levels[n]->ksp) {
48213044ca3SPierre Jolivet       Mat       P, A = nullptr;
48313044ca3SPierre Jolivet       PetscBool flg = PETSC_FALSE;
48413044ca3SPierre Jolivet 
485db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &P));
486db4a47b3SPierre Jolivet       PetscCall(MatGetSize(P, &m, nullptr));
487f1580f4eSBarry Smith       accumulate[0] += m;
488f1580f4eSBarry Smith       if (n == 0) {
489f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
490f1580f4eSBarry Smith         if (flg) {
491f1580f4eSBarry Smith           PetscCall(MatConvert(P, MATAIJ, MAT_INITIAL_MATRIX, &A));
492f1580f4eSBarry Smith           P = A;
49313044ca3SPierre Jolivet         } else {
49413044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
49513044ca3SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)P));
496f1580f4eSBarry Smith         }
49713044ca3SPierre Jolivet       }
49813044ca3SPierre Jolivet       if (!A && flg) accumulate[1] += m * m; /* assumption that a MATSCHURCOMPLEMENT is dense if stored explicitly */
49913044ca3SPierre Jolivet       else if (P->ops->getinfo) {
500f1580f4eSBarry Smith         PetscCall(MatGetInfo(P, MAT_GLOBAL_SUM, &info));
501f1580f4eSBarry Smith         accumulate[1] += info.nz_used;
502f1580f4eSBarry Smith       }
503f1580f4eSBarry Smith       if (n == 0) {
504f1580f4eSBarry Smith         m1 = m;
50513044ca3SPierre Jolivet         if (!A && flg) nnz1 = m * m;
50613044ca3SPierre Jolivet         else if (P->ops->getinfo) nnz1 = info.nz_used;
507f1580f4eSBarry Smith         PetscCall(MatDestroy(&P));
508f1580f4eSBarry Smith       }
509f1580f4eSBarry Smith     }
510f1580f4eSBarry Smith   }
511f1580f4eSBarry Smith   *gc = static_cast<PetscReal>(accumulate[0] / m1);
512f1580f4eSBarry Smith   *oc = static_cast<PetscReal>(accumulate[1] / nnz1);
5133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
514f1580f4eSBarry Smith }
515f1580f4eSBarry Smith 
516d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_HPDDM(PC pc, PetscViewer viewer)
517d71ae5a4SJacob Faibussowitsch {
518f1580f4eSBarry Smith   PC_HPDDM         *data = (PC_HPDDM *)pc->data;
519f1580f4eSBarry Smith   PetscViewer       subviewer;
520aa21023fSPierre Jolivet   PetscViewerFormat format;
521f1580f4eSBarry Smith   PetscSubcomm      subcomm;
522f1580f4eSBarry Smith   PetscReal         oc, gc;
523f1580f4eSBarry Smith   PetscInt          i, tabs;
524f1580f4eSBarry Smith   PetscMPIInt       size, color, rank;
525aa21023fSPierre Jolivet   PetscBool         flg;
526aa21023fSPierre Jolivet   const char       *name;
527f1580f4eSBarry Smith 
528f1580f4eSBarry Smith   PetscFunctionBegin;
529aa21023fSPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &flg));
530aa21023fSPierre Jolivet   if (flg) {
531f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "level%s: %" PetscInt_FMT "\n", data->N > 1 ? "s" : "", data->N));
532f1580f4eSBarry Smith     PetscCall(PCHPDDMGetComplexities(pc, &gc, &oc));
533f1580f4eSBarry Smith     if (data->N > 1) {
534f1580f4eSBarry Smith       if (!data->deflation) {
535c8ea6600SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "Neumann matrix attached? %s\n", PetscBools[PetscBool3ToBool(data->Neumann)]));
536f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, "shared subdomain KSP between SLEPc and PETSc? %s\n", PetscBools[data->share]));
537f1580f4eSBarry Smith       } else PetscCall(PetscViewerASCIIPrintf(viewer, "user-supplied deflation matrix\n"));
538f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "coarse correction: %s\n", PCHPDDMCoarseCorrectionTypes[data->correction]));
539f1580f4eSBarry 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" : ""));
540f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIGetTab(viewer, &tabs));
541f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, 0));
542f1580f4eSBarry Smith       for (i = 1; i < data->N; ++i) {
543f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, data->levels[i - 1]->nu));
5440594bca0SPierre Jolivet         if (data->levels[i - 1]->threshold > static_cast<PetscReal>(-0.1)) PetscCall(PetscViewerASCIIPrintf(viewer, " (%g)", (double)data->levels[i - 1]->threshold));
545f1580f4eSBarry Smith       }
546f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
547f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, tabs));
548f1580f4eSBarry Smith     }
549f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "grid and operator complexities: %g %g\n", (double)gc, (double)oc));
5501fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
5511fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank));
552f1580f4eSBarry Smith     if (data->levels[0]->ksp) {
553f1580f4eSBarry Smith       PetscCall(KSPView(data->levels[0]->ksp, viewer));
554f1580f4eSBarry Smith       if (data->levels[0]->pc) PetscCall(PCView(data->levels[0]->pc, viewer));
555f1580f4eSBarry Smith       for (i = 1; i < data->N; ++i) {
556f1580f4eSBarry Smith         if (data->levels[i]->ksp) color = 1;
557f1580f4eSBarry Smith         else color = 0;
558f1580f4eSBarry Smith         PetscCall(PetscSubcommCreate(PetscObjectComm((PetscObject)pc), &subcomm));
559f1580f4eSBarry Smith         PetscCall(PetscSubcommSetNumber(subcomm, PetscMin(size, 2)));
560f1580f4eSBarry Smith         PetscCall(PetscSubcommSetTypeGeneral(subcomm, color, rank));
561f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPushTab(viewer));
562f1580f4eSBarry Smith         PetscCall(PetscViewerGetSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
563f1580f4eSBarry Smith         if (color == 1) {
564f1580f4eSBarry Smith           PetscCall(KSPView(data->levels[i]->ksp, subviewer));
565f1580f4eSBarry Smith           if (data->levels[i]->pc) PetscCall(PCView(data->levels[i]->pc, subviewer));
566f1580f4eSBarry Smith           PetscCall(PetscViewerFlush(subviewer));
567f1580f4eSBarry Smith         }
568f1580f4eSBarry Smith         PetscCall(PetscViewerRestoreSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
569f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPopTab(viewer));
570f1580f4eSBarry Smith         PetscCall(PetscSubcommDestroy(&subcomm));
571f1580f4eSBarry Smith       }
572f1580f4eSBarry Smith     }
573aa21023fSPierre Jolivet     PetscCall(PetscViewerGetFormat(viewer, &format));
574aa21023fSPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
575aa21023fSPierre Jolivet       PetscCall(PetscViewerFileGetName(viewer, &name));
576aa21023fSPierre Jolivet       if (name) {
577aa21023fSPierre Jolivet         IS          is;
578aa21023fSPierre Jolivet         PetscInt    sizes[4] = {pc->mat->rmap->n, pc->mat->cmap->n, pc->mat->rmap->N, pc->mat->cmap->N};
579aa21023fSPierre Jolivet         char       *tmp;
580aa21023fSPierre Jolivet         std::string prefix, suffix;
581aa21023fSPierre Jolivet         size_t      pos;
582aa21023fSPierre Jolivet 
583aa21023fSPierre Jolivet         PetscCall(PetscStrstr(name, ".", &tmp));
584aa21023fSPierre Jolivet         if (tmp) {
585aa21023fSPierre Jolivet           pos    = std::distance(const_cast<char *>(name), tmp);
586aa21023fSPierre Jolivet           prefix = std::string(name, pos);
587aa21023fSPierre Jolivet           suffix = std::string(name + pos + 1);
588aa21023fSPierre Jolivet         } else prefix = name;
589aa21023fSPierre Jolivet         if (data->aux) {
590aa21023fSPierre 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));
591aa21023fSPierre Jolivet           PetscCall(MatView(data->aux, subviewer));
592aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
593aa21023fSPierre Jolivet         }
594aa21023fSPierre Jolivet         if (data->is) {
595aa21023fSPierre 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));
596aa21023fSPierre Jolivet           PetscCall(ISView(data->is, subviewer));
597aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
598aa21023fSPierre Jolivet         }
599aa21023fSPierre Jolivet         PetscCall(ISCreateGeneral(PETSC_COMM_SELF, PETSC_STATIC_ARRAY_LENGTH(sizes), sizes, PETSC_USE_POINTER, &is));
600aa21023fSPierre 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));
601aa21023fSPierre Jolivet         PetscCall(ISView(is, subviewer));
602aa21023fSPierre Jolivet         PetscCall(PetscViewerDestroy(&subviewer));
603aa21023fSPierre Jolivet         PetscCall(ISDestroy(&is));
604aa21023fSPierre Jolivet       }
605aa21023fSPierre Jolivet     }
606f1580f4eSBarry Smith   }
6073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
608f1580f4eSBarry Smith }
609f1580f4eSBarry Smith 
610d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCPreSolve_HPDDM(PC pc, KSP ksp, Vec, Vec)
611d71ae5a4SJacob Faibussowitsch {
612f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
613f1580f4eSBarry Smith   Mat       A;
614cdbd50ebSPierre Jolivet   PetscBool flg;
615f1580f4eSBarry Smith 
616f1580f4eSBarry Smith   PetscFunctionBegin;
617f1580f4eSBarry Smith   if (ksp) {
618f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPLSQR, &flg));
619f1580f4eSBarry Smith     if (flg && !data->normal) {
620db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(ksp, &A, nullptr));
621db4a47b3SPierre Jolivet       PetscCall(MatCreateVecs(A, nullptr, &data->normal)); /* temporary Vec used in PCApply_HPDDMShell() for coarse grid corrections */
622cdbd50ebSPierre Jolivet     } else if (!flg) {
623cdbd50ebSPierre Jolivet       PetscCall(PetscObjectTypeCompareAny((PetscObject)ksp, &flg, KSPCG, KSPGROPPCG, KSPPIPECG, KSPPIPECGRR, KSPPIPELCG, KSPPIPEPRCG, KSPPIPECG2, KSPSTCG, KSPFCG, KSPPIPEFCG, KSPMINRES, KSPNASH, KSPSYMMLQ, ""));
624cdbd50ebSPierre Jolivet       if (!flg) {
625cdbd50ebSPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPHPDDM, &flg));
626cdbd50ebSPierre Jolivet         if (flg) {
627cdbd50ebSPierre Jolivet           KSPHPDDMType type;
628cdbd50ebSPierre Jolivet           PetscCall(KSPHPDDMGetType(ksp, &type));
629cdbd50ebSPierre Jolivet           flg = (type == KSP_HPDDM_TYPE_CG || type == KSP_HPDDM_TYPE_BCG || type == KSP_HPDDM_TYPE_BFBCG ? PETSC_TRUE : PETSC_FALSE);
630cdbd50ebSPierre Jolivet         }
631cdbd50ebSPierre Jolivet       }
632cdbd50ebSPierre Jolivet     }
633cdbd50ebSPierre Jolivet     if (flg) {
634cdbd50ebSPierre Jolivet       if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) {
635cdbd50ebSPierre Jolivet         PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_hpddm_coarse_correction", &flg));
636cdbd50ebSPierre Jolivet         PetscCheck(flg, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "PCHPDDMCoarseCorrectionType %s is known to be not symmetric, but KSPType %s requires a symmetric PC, if you insist on using this configuration, use the additional option -%spc_hpddm_coarse_correction %s, or alternatively, switch to a symmetric PCHPDDMCoarseCorrectionType such as %s",
637cdbd50ebSPierre Jolivet                    PCHPDDMCoarseCorrectionTypes[data->correction], ((PetscObject)ksp)->type_name, ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", PCHPDDMCoarseCorrectionTypes[data->correction], PCHPDDMCoarseCorrectionTypes[PC_HPDDM_COARSE_CORRECTION_BALANCED]);
638cdbd50ebSPierre Jolivet       }
639cdbd50ebSPierre Jolivet       for (PetscInt n = 0; n < data->N; ++n) {
640cdbd50ebSPierre Jolivet         if (data->levels[n]->pc) {
641cdbd50ebSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)data->levels[n]->pc, PCASM, &flg));
642cdbd50ebSPierre Jolivet           if (flg) {
643cdbd50ebSPierre Jolivet             PCASMType type;
644cdbd50ebSPierre Jolivet             PetscCall(PCASMGetType(data->levels[n]->pc, &type));
645cdbd50ebSPierre Jolivet             if (type == PC_ASM_RESTRICT || type == PC_ASM_INTERPOLATE) {
646cdbd50ebSPierre Jolivet               PetscCall(PetscOptionsHasName(((PetscObject)data->levels[n]->pc)->options, ((PetscObject)data->levels[n]->pc)->prefix, "-pc_asm_type", &flg));
647cdbd50ebSPierre Jolivet               PetscCheck(flg, PetscObjectComm((PetscObject)data->levels[n]->pc), PETSC_ERR_ARG_INCOMP, "PCASMType %s is known to be not symmetric, but KSPType %s requires a symmetric PC, if you insist on using this configuration, use the additional option -%spc_asm_type %s, or alternatively, switch to a symmetric PCASMType such as %s", PCASMTypes[type],
648cdbd50ebSPierre Jolivet                          ((PetscObject)ksp)->type_name, ((PetscObject)data->levels[n]->pc)->prefix, PCASMTypes[type], PCASMTypes[PC_ASM_BASIC]);
649cdbd50ebSPierre Jolivet             }
650cdbd50ebSPierre Jolivet           }
651cdbd50ebSPierre Jolivet         }
652cdbd50ebSPierre Jolivet       }
653f1580f4eSBarry Smith     }
654f1580f4eSBarry Smith   }
6553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
656f1580f4eSBarry Smith }
657f1580f4eSBarry Smith 
658d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDMShell(PC pc)
659d71ae5a4SJacob Faibussowitsch {
660f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
661f1580f4eSBarry Smith   Mat             A, P;
662f1580f4eSBarry Smith   Vec             x;
663f1580f4eSBarry Smith   const char     *pcpre;
664f1580f4eSBarry Smith 
665f1580f4eSBarry Smith   PetscFunctionBegin;
666f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
667f1580f4eSBarry Smith   PetscCall(KSPGetOptionsPrefix(ctx->ksp, &pcpre));
668f1580f4eSBarry Smith   PetscCall(KSPGetOperators(ctx->ksp, &A, &P));
669f1580f4eSBarry Smith   /* smoother */
670f1580f4eSBarry Smith   PetscCall(PCSetOptionsPrefix(ctx->pc, pcpre));
671f1580f4eSBarry Smith   PetscCall(PCSetOperators(ctx->pc, A, P));
672f1580f4eSBarry Smith   if (!ctx->v[0]) {
673f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(ctx->D, 1, &ctx->v[0]));
674f1580f4eSBarry Smith     if (!std::is_same<PetscScalar, PetscReal>::value) PetscCall(VecDestroy(&ctx->D));
675db4a47b3SPierre Jolivet     PetscCall(MatCreateVecs(A, &x, nullptr));
676f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(x, 2, &ctx->v[1]));
677f1580f4eSBarry Smith     PetscCall(VecDestroy(&x));
678f1580f4eSBarry Smith   }
679f1580f4eSBarry Smith   std::fill_n(ctx->V, 3, nullptr);
6803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
681f1580f4eSBarry Smith }
682f1580f4eSBarry Smith 
683f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
684d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type x, Type y)
685d71ae5a4SJacob Faibussowitsch {
686f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
687f1580f4eSBarry Smith   PetscScalar    *out;
688f1580f4eSBarry Smith 
689f1580f4eSBarry Smith   PetscFunctionBegin;
690f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
691f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
692f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
693f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
694f1580f4eSBarry Smith   PetscCall(VecGetArrayWrite(ctx->v[0][0], &out));
695db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, 1); /* y = Q x */
696f1580f4eSBarry Smith   PetscCall(VecRestoreArrayWrite(ctx->v[0][0], &out));
697f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
698f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
699f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
7003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
701f1580f4eSBarry Smith }
702f1580f4eSBarry Smith 
703f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
704d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type X, Type Y)
705d71ae5a4SJacob Faibussowitsch {
706f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
707f1580f4eSBarry Smith   Vec             vX, vY, vC;
708f1580f4eSBarry Smith   PetscScalar    *out;
709f1580f4eSBarry Smith   PetscInt        i, N;
710f1580f4eSBarry Smith 
711f1580f4eSBarry Smith   PetscFunctionBegin;
712f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
713db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
714f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
715f1580f4eSBarry Smith   for (i = 0; i < N; ++i) {
716f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(X, i, &vX));
717f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(ctx->V[0], i, &vC));
718f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
719f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
720f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(ctx->V[0], i, &vC));
721f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(X, i, &vX));
722f1580f4eSBarry Smith   }
723f1580f4eSBarry Smith   PetscCall(MatDenseGetArrayWrite(ctx->V[0], &out));
724db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, N); /* Y = Q X */
725f1580f4eSBarry Smith   PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &out));
726f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
727f1580f4eSBarry Smith   for (i = 0; i < N; ++i) {
728f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(ctx->V[0], i, &vC));
729f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(Y, i, &vY));
730f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
731f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
732f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &vY));
733f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(ctx->V[0], i, &vC));
734f1580f4eSBarry Smith   }
7353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
736f1580f4eSBarry Smith }
737f1580f4eSBarry Smith 
738f1580f4eSBarry Smith /*
739aa1539e9SPierre Jolivet      PCApply_HPDDMShell - Applies a (2) deflated, (1) additive, (3) balanced, or (4) no coarse correction. In what follows, E = Z Pmat Z^T and Q = Z^T E^-1 Z.
740f1580f4eSBarry Smith 
741f1580f4eSBarry Smith .vb
742f1580f4eSBarry Smith    (1) y =                Pmat^-1              x + Q x,
743f1580f4eSBarry Smith    (2) y =                Pmat^-1 (I - Amat Q) x + Q x (default),
744aa1539e9SPierre Jolivet    (3) y = (I - Q Amat^T) Pmat^-1 (I - Amat Q) x + Q x,
745aa1539e9SPierre Jolivet    (4) y =                Pmat^-1              x      .
746f1580f4eSBarry Smith .ve
747f1580f4eSBarry Smith 
748f1580f4eSBarry Smith    Input Parameters:
749f1580f4eSBarry Smith +     pc - preconditioner context
750f1580f4eSBarry Smith -     x - input vector
751f1580f4eSBarry Smith 
752f1580f4eSBarry Smith    Output Parameter:
753f1580f4eSBarry Smith .     y - output vector
754f1580f4eSBarry Smith 
755f1580f4eSBarry Smith    Notes:
756f1580f4eSBarry 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.
757f1580f4eSBarry 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.
758f1580f4eSBarry 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.
759f1580f4eSBarry Smith 
760f1580f4eSBarry Smith    Level: advanced
761f1580f4eSBarry Smith 
762f1580f4eSBarry Smith    Developer Note:
763f1580f4eSBarry 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
764f1580f4eSBarry Smith    to trigger it. Likely the manual page is `PCHPDDM`
765f1580f4eSBarry Smith 
766562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
767f1580f4eSBarry Smith */
768d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDMShell(PC pc, Vec x, Vec y)
769d71ae5a4SJacob Faibussowitsch {
770f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
771f1580f4eSBarry Smith   Mat             A;
772f1580f4eSBarry Smith 
773f1580f4eSBarry Smith   PetscFunctionBegin;
774f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
775f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
776db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
777aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApply(ctx->pc, x, y)); /* y = M^-1 x */
778aa1539e9SPierre Jolivet   else {
779f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, x, y)); /* y = Q x */
780f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
781f1580f4eSBarry Smith       if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMult(A, y, ctx->v[1][0])); /* y = A Q x     */
782f1580f4eSBarry Smith       else { /* KSPLSQR and finest level */ PetscCall(MatMult(A, y, ctx->parent->normal));               /* y = A Q x     */
783f1580f4eSBarry Smith         PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][0]));                      /* y = A^T A Q x */
784f1580f4eSBarry Smith       }
785f1580f4eSBarry Smith       PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x)); /* y = (I - A Q) x                             */
786f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, ctx->v[1][1], ctx->v[1][0]));  /* y = M^-1 (I - A Q) x                        */
787f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
788f1580f4eSBarry 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 */
789f1580f4eSBarry Smith         else {
790f1580f4eSBarry Smith           PetscCall(MatMult(A, ctx->v[1][0], ctx->parent->normal));
791f1580f4eSBarry Smith           PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][1])); /* z = A^T A y           */
792f1580f4eSBarry Smith         }
793f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->v[1][1], ctx->v[1][1]));
794f1580f4eSBarry 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      */
795f1580f4eSBarry Smith       } else PetscCall(VecAXPY(y, 1.0, ctx->v[1][0]));                         /* y = Q M^-1 (I - A Q) x + Q x */
796f1580f4eSBarry Smith     } else {
797f1580f4eSBarry 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);
798f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, x, ctx->v[1][0]));
799f1580f4eSBarry Smith       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-1 x + Q x */
800f1580f4eSBarry Smith     }
801aa1539e9SPierre Jolivet   }
8023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
803f1580f4eSBarry Smith }
804f1580f4eSBarry Smith 
805f1580f4eSBarry Smith /*
806f1580f4eSBarry Smith      PCMatApply_HPDDMShell - Variant of PCApply_HPDDMShell() for blocks of vectors.
807f1580f4eSBarry Smith 
808f1580f4eSBarry Smith    Input Parameters:
809f1580f4eSBarry Smith +     pc - preconditioner context
810f1580f4eSBarry Smith -     X - block of input vectors
811f1580f4eSBarry Smith 
812f1580f4eSBarry Smith    Output Parameter:
813f1580f4eSBarry Smith .     Y - block of output vectors
814f1580f4eSBarry Smith 
815f1580f4eSBarry Smith    Level: advanced
816f1580f4eSBarry Smith 
817562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
818f1580f4eSBarry Smith */
819d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDMShell(PC pc, Mat X, Mat Y)
820d71ae5a4SJacob Faibussowitsch {
821f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
822f1580f4eSBarry Smith   Mat             A, *ptr;
823db4a47b3SPierre Jolivet   PetscContainer  container = nullptr;
824f1580f4eSBarry Smith   PetscScalar    *array;
825f1580f4eSBarry Smith   PetscInt        m, M, N, prev = 0;
826f1580f4eSBarry Smith   PetscBool       reset = PETSC_FALSE;
827f1580f4eSBarry Smith 
828f1580f4eSBarry Smith   PetscFunctionBegin;
829f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
830f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
831db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
832db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
833aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApply(ctx->pc, X, Y));
834aa1539e9SPierre Jolivet   else {
835f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)A, "_HPDDM_MatProduct", (PetscObject *)&container));
836f1580f4eSBarry Smith     if (container) { /* MatProduct container already attached */
837f1580f4eSBarry Smith       PetscCall(PetscContainerGetPointer(container, (void **)&ptr));
838f1580f4eSBarry Smith       if (ptr[1] != ctx->V[2]) /* Mat has changed or may have been set first in KSPHPDDM */
839f1580f4eSBarry Smith         for (m = 0; m < 2; ++m) {
840f1580f4eSBarry Smith           PetscCall(MatDestroy(ctx->V + m + 1));
841f1580f4eSBarry Smith           ctx->V[m + 1] = ptr[m];
842f1580f4eSBarry Smith           PetscCall(PetscObjectReference((PetscObject)ctx->V[m + 1]));
843f1580f4eSBarry Smith         }
844f1580f4eSBarry Smith     }
845db4a47b3SPierre Jolivet     if (ctx->V[1]) PetscCall(MatGetSize(ctx->V[1], nullptr, &prev));
846f1580f4eSBarry Smith     if (N != prev || !ctx->V[0]) {
847f1580f4eSBarry Smith       PetscCall(MatDestroy(ctx->V));
848f1580f4eSBarry Smith       PetscCall(VecGetLocalSize(ctx->v[0][0], &m));
849db4a47b3SPierre Jolivet       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, PETSC_DECIDE, N, nullptr, ctx->V));
850f1580f4eSBarry Smith       if (N != prev) {
851f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 1));
852f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 2));
853db4a47b3SPierre Jolivet         PetscCall(MatGetLocalSize(X, &m, nullptr));
854db4a47b3SPierre Jolivet         PetscCall(MatGetSize(X, &M, nullptr));
855f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
856db4a47b3SPierre Jolivet         else array = nullptr;
857f1580f4eSBarry Smith         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, array, ctx->V + 1));
858f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
859db4a47b3SPierre Jolivet         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, nullptr, ctx->V + 2));
860db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, Y, nullptr, ctx->V[1]));
861f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[1], MATPRODUCT_AB));
862f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[1]));
863f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[1]));
864f1580f4eSBarry Smith         if (!container) { /* no MatProduct container attached, create one to be queried in KSPHPDDM or at the next call to PCMatApply() */
865f1580f4eSBarry Smith           PetscCall(PetscContainerCreate(PetscObjectComm((PetscObject)A), &container));
866f1580f4eSBarry Smith           PetscCall(PetscObjectCompose((PetscObject)A, "_HPDDM_MatProduct", (PetscObject)container));
867f1580f4eSBarry Smith         }
8683f68fba4SPierre Jolivet         PetscCall(PetscContainerSetPointer(container, ctx->V + 1)); /* need to compose B and D from MatProductCreateWithMat(A, B, NULL, D), which are stored in the contiguous array ctx->V */
869f1580f4eSBarry Smith       }
870f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
871db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, ctx->V[1], nullptr, ctx->V[2]));
872f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[2], MATPRODUCT_AtB));
873f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[2]));
874f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[2]));
875f1580f4eSBarry Smith       }
876f1580f4eSBarry Smith       ctx->P->start(N);
877f1580f4eSBarry Smith     }
878f1580f4eSBarry Smith     if (N == prev || container) { /* when MatProduct container is attached, always need to MatProductReplaceMats() since KSPHPDDM may have replaced the Mat as well */
879db4a47b3SPierre Jolivet       PetscCall(MatProductReplaceMats(nullptr, Y, nullptr, ctx->V[1]));
880f1580f4eSBarry Smith       if (container && ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) {
881f1580f4eSBarry Smith         PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
882f1580f4eSBarry Smith         PetscCall(MatDensePlaceArray(ctx->V[1], array));
883f1580f4eSBarry Smith         PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
884f1580f4eSBarry Smith         reset = PETSC_TRUE;
885f1580f4eSBarry Smith       }
886f1580f4eSBarry Smith     }
887f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, X, Y));
888f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
889f1580f4eSBarry Smith       PetscCall(MatProductNumeric(ctx->V[1]));
890f1580f4eSBarry Smith       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
891f1580f4eSBarry Smith       PetscCall(MatAXPY(ctx->V[2], -1.0, X, SAME_NONZERO_PATTERN));
892f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, ctx->V[2], ctx->V[1]));
893f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
894f1580f4eSBarry Smith         PetscCall(MatProductNumeric(ctx->V[2]));
895f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->V[2], ctx->V[2]));
896f1580f4eSBarry Smith         PetscCall(MatAXPY(ctx->V[1], -1.0, ctx->V[2], SAME_NONZERO_PATTERN));
897f1580f4eSBarry Smith       }
898f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
899f1580f4eSBarry Smith     } else {
900f1580f4eSBarry 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);
901f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, X, ctx->V[1]));
902f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
903f1580f4eSBarry Smith     }
904f1580f4eSBarry Smith     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
905aa1539e9SPierre Jolivet   }
9063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
907f1580f4eSBarry Smith }
908f1580f4eSBarry Smith 
909d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDMShell(PC pc)
910d71ae5a4SJacob Faibussowitsch {
911f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
912f1580f4eSBarry Smith   PetscContainer  container;
913f1580f4eSBarry Smith 
914f1580f4eSBarry Smith   PetscFunctionBegin;
915f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
916f1580f4eSBarry Smith   PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(ctx, PETSC_TRUE));
917f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(1, &ctx->v[0]));
918f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(2, &ctx->v[1]));
919f4f49eeaSPierre Jolivet   PetscCall(PetscObjectQuery((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", (PetscObject *)&container));
920f1580f4eSBarry Smith   PetscCall(PetscContainerDestroy(&container));
921f4f49eeaSPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", nullptr));
922f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V));
923f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 1));
924f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 2));
925f1580f4eSBarry Smith   PetscCall(VecDestroy(&ctx->D));
926f1580f4eSBarry Smith   PetscCall(VecScatterDestroy(&ctx->scatter));
927f1580f4eSBarry Smith   PetscCall(PCDestroy(&ctx->pc));
9283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
929f1580f4eSBarry Smith }
930f1580f4eSBarry Smith 
9319bb5c669SPierre Jolivet template <class Type, bool T = false, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
9329bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type x, Type y)
9339bb5c669SPierre Jolivet {
9349bb5c669SPierre Jolivet   PetscFunctionBegin;
9359bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[0], std::get<1>(*p), SCATTER_FORWARD, x));
9369bb5c669SPierre Jolivet   if (!T) PetscCall(PCApply(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
9379bb5c669SPierre Jolivet   else PetscCall(PCApplyTranspose(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
9389bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[1], std::get<1>(*p), SCATTER_REVERSE, y));
9399bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9409bb5c669SPierre Jolivet }
9419bb5c669SPierre Jolivet 
9429bb5c669SPierre Jolivet template <class Type, bool = false, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
9439bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type X, Type Y)
9449bb5c669SPierre Jolivet {
9459bb5c669SPierre Jolivet   Mat B[2];
9469bb5c669SPierre Jolivet   Vec x, y;
9479bb5c669SPierre Jolivet 
9489bb5c669SPierre Jolivet   PetscFunctionBegin;
9499bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B));
9509bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B + 1));
9519bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
9529bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(X, i, &x));
9539bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B[0], i, &y));
9549bb5c669SPierre Jolivet     PetscCall(VecISCopy(y, std::get<1>(*p), SCATTER_FORWARD, x));
9559bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B[0], i, &y));
9569bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(X, i, &x));
9579bb5c669SPierre Jolivet   }
9589bb5c669SPierre Jolivet   PetscCall(PCMatApply(factor, B[0], B[1]));
9599bb5c669SPierre Jolivet   PetscCall(MatDestroy(B));
9609bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
9619bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B[1], i, &x));
9629bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &y));
9639bb5c669SPierre Jolivet     PetscCall(VecISCopy(x, std::get<1>(*p), SCATTER_REVERSE, y));
9649bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &y));
9659bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B[1], i, &x));
9669bb5c669SPierre Jolivet   }
9679bb5c669SPierre Jolivet   PetscCall(MatDestroy(B + 1));
9689bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9699bb5c669SPierre Jolivet }
9709bb5c669SPierre Jolivet 
9719bb5c669SPierre Jolivet template <class Type = Vec, bool T = false>
9729bb5c669SPierre Jolivet static PetscErrorCode PCApply_Schur(PC pc, Type x, Type y)
9739bb5c669SPierre Jolivet {
9749bb5c669SPierre Jolivet   PC                           factor;
9759bb5c669SPierre Jolivet   Mat                          A;
9769bb5c669SPierre Jolivet   MatSolverType                type;
9779bb5c669SPierre Jolivet   PetscBool                    flg;
9789bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
9799bb5c669SPierre Jolivet 
9809bb5c669SPierre Jolivet   PetscFunctionBegin;
9819bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
9829bb5c669SPierre Jolivet   PetscCall(KSPGetPC(std::get<0>(*p), &factor));
9839bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(factor, &type));
9849bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatrix(factor, &A));
9859bb5c669SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
9869bb5c669SPierre Jolivet   if (flg) {
9879bb5c669SPierre Jolivet     PetscCheck(PetscDefined(HAVE_MUMPS), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
9889bb5c669SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
9899bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 0));
9909bb5c669SPierre Jolivet #endif
9919bb5c669SPierre Jolivet   } else {
9929bb5c669SPierre Jolivet     PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &flg));
9939bb5c669SPierre Jolivet     PetscCheck(flg && PetscDefined(HAVE_MKL_PARDISO), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
9949bb5c669SPierre Jolivet     flg = PETSC_FALSE;
9959bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
9969bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 1));
9979bb5c669SPierre Jolivet #endif
9989bb5c669SPierre Jolivet   }
9999bb5c669SPierre Jolivet   PetscCall(PCApply_Schur_Private<Type, T>(p, factor, x, y));
10009bb5c669SPierre Jolivet   if (flg) {
10019bb5c669SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
10029bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1));
10039bb5c669SPierre Jolivet #endif
10049bb5c669SPierre Jolivet   } else {
10059bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
10069bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 0));
10079bb5c669SPierre Jolivet #endif
10089bb5c669SPierre Jolivet   }
10099bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10109bb5c669SPierre Jolivet }
10119bb5c669SPierre Jolivet 
10129bb5c669SPierre Jolivet static PetscErrorCode PCDestroy_Schur(PC pc)
10139bb5c669SPierre Jolivet {
10149bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
10159bb5c669SPierre Jolivet 
10169bb5c669SPierre Jolivet   PetscFunctionBegin;
10179bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
10189bb5c669SPierre Jolivet   PetscCall(ISDestroy(&std::get<1>(*p)));
10199bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p)));
10209bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p) + 1));
10219bb5c669SPierre Jolivet   PetscCall(PetscFree(p));
10229bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10239bb5c669SPierre Jolivet }
10249bb5c669SPierre Jolivet 
1025d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSolve_Private(const PC_HPDDM_Level *ctx, PetscScalar *rhs, const unsigned short &mu)
1026d71ae5a4SJacob Faibussowitsch {
1027f1580f4eSBarry Smith   Mat      B, X;
1028f1580f4eSBarry Smith   PetscInt n, N, j = 0;
1029f1580f4eSBarry Smith 
1030f1580f4eSBarry Smith   PetscFunctionBegin;
1031db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &B, nullptr));
1032db4a47b3SPierre Jolivet   PetscCall(MatGetLocalSize(B, &n, nullptr));
1033db4a47b3SPierre Jolivet   PetscCall(MatGetSize(B, &N, nullptr));
1034f1580f4eSBarry Smith   if (ctx->parent->log_separate) {
1035f1580f4eSBarry Smith     j = std::distance(ctx->parent->levels, std::find(ctx->parent->levels, ctx->parent->levels + ctx->parent->N, ctx));
1036db4a47b3SPierre Jolivet     PetscCall(PetscLogEventBegin(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
1037f1580f4eSBarry Smith   }
1038f1580f4eSBarry Smith   if (mu == 1) {
1039f1580f4eSBarry Smith     if (!ctx->ksp->vec_rhs) {
1040db4a47b3SPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ctx->ksp), 1, n, N, nullptr, &ctx->ksp->vec_rhs));
1041f1580f4eSBarry Smith       PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)ctx->ksp), n, N, &ctx->ksp->vec_sol));
1042f1580f4eSBarry Smith     }
1043f1580f4eSBarry Smith     PetscCall(VecPlaceArray(ctx->ksp->vec_rhs, rhs));
1044db4a47b3SPierre Jolivet     PetscCall(KSPSolve(ctx->ksp, nullptr, nullptr));
1045f1580f4eSBarry Smith     PetscCall(VecCopy(ctx->ksp->vec_sol, ctx->ksp->vec_rhs));
1046f1580f4eSBarry Smith     PetscCall(VecResetArray(ctx->ksp->vec_rhs));
1047f1580f4eSBarry Smith   } else {
1048f1580f4eSBarry Smith     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, rhs, &B));
1049db4a47b3SPierre Jolivet     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, nullptr, &X));
1050f1580f4eSBarry Smith     PetscCall(KSPMatSolve(ctx->ksp, B, X));
1051f1580f4eSBarry Smith     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
1052f1580f4eSBarry Smith     PetscCall(MatDestroy(&X));
1053f1580f4eSBarry Smith     PetscCall(MatDestroy(&B));
1054f1580f4eSBarry Smith   }
1055db4a47b3SPierre Jolivet   if (ctx->parent->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
10563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1057f1580f4eSBarry Smith }
1058f1580f4eSBarry Smith 
1059d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetUpNeumannOverlap_Private(PC pc)
1060d71ae5a4SJacob Faibussowitsch {
1061f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
1062f1580f4eSBarry Smith 
1063f1580f4eSBarry Smith   PetscFunctionBegin;
1064f1580f4eSBarry Smith   if (data->setup) {
1065f1580f4eSBarry Smith     Mat       P;
1066db4a47b3SPierre Jolivet     Vec       x, xt = nullptr;
1067f1580f4eSBarry Smith     PetscReal t = 0.0, s = 0.0;
1068f1580f4eSBarry Smith 
1069db4a47b3SPierre Jolivet     PetscCall(PCGetOperators(pc, nullptr, &P));
1070f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)P, "__SNES_latest_X", (PetscObject *)&x));
1071f1580f4eSBarry Smith     PetscCallBack("PCHPDDM Neumann callback", (*data->setup)(data->aux, t, x, xt, s, data->is, data->setup_ctx));
1072f1580f4eSBarry Smith   }
10733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1074f1580f4eSBarry Smith }
1075f1580f4eSBarry Smith 
1076d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCreateSubMatrices_Private(Mat mat, PetscInt n, const IS *, const IS *, MatReuse scall, Mat *submat[])
1077d71ae5a4SJacob Faibussowitsch {
1078f1580f4eSBarry Smith   Mat       A;
107913044ca3SPierre Jolivet   PetscBool flg;
1080f1580f4eSBarry Smith 
1081f1580f4eSBarry Smith   PetscFunctionBegin;
1082f1580f4eSBarry Smith   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatCreateSubMatrices() called to extract %" PetscInt_FMT " submatrices, which is different than 1", n);
1083f1580f4eSBarry Smith   /* previously composed Mat */
1084f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)mat, "_PCHPDDM_SubMatrices", (PetscObject *)&A));
1085f1580f4eSBarry Smith   PetscCheck(A, PETSC_COMM_SELF, PETSC_ERR_PLIB, "SubMatrices not found in Mat");
108613044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSCHURCOMPLEMENT, &flg)); /* MATSCHURCOMPLEMENT has neither a MatDuplicate() nor a MatCopy() implementation */
1087f1580f4eSBarry Smith   if (scall == MAT_INITIAL_MATRIX) {
10886f2c871aSStefano Zampini     PetscCall(PetscCalloc1(2, submat)); /* allocate an extra Mat to avoid errors in MatDestroySubMatrices_Dummy() */
108913044ca3SPierre Jolivet     if (!flg) PetscCall(MatDuplicate(A, MAT_COPY_VALUES, *submat));
109013044ca3SPierre Jolivet   } else if (!flg) PetscCall(MatCopy(A, (*submat)[0], SAME_NONZERO_PATTERN));
109113044ca3SPierre Jolivet   if (flg) {
1092bf583f0cSPierre Jolivet     PetscCall(MatDestroy(*submat)); /* previously created Mat has to be destroyed */
109313044ca3SPierre Jolivet     (*submat)[0] = A;
109413044ca3SPierre Jolivet     PetscCall(PetscObjectReference((PetscObject)A));
109513044ca3SPierre Jolivet   }
10963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1097f1580f4eSBarry Smith }
1098f1580f4eSBarry Smith 
1099d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCommunicationAvoidingPCASM_Private(PC pc, Mat C, PetscBool sorted)
1100d71ae5a4SJacob Faibussowitsch {
1101f1580f4eSBarry Smith   void (*op)(void);
1102f1580f4eSBarry Smith 
1103f1580f4eSBarry Smith   PetscFunctionBegin;
1104f1580f4eSBarry Smith   /* previously-composed Mat */
1105f1580f4eSBarry Smith   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", (PetscObject)C));
1106f1580f4eSBarry Smith   PetscCall(MatGetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, &op));
1107f1580f4eSBarry Smith   /* trick suggested by Barry https://lists.mcs.anl.gov/pipermail/petsc-dev/2020-January/025491.html */
1108f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, (void (*)(void))PCHPDDMCreateSubMatrices_Private));
1109f1580f4eSBarry Smith   if (sorted) PetscCall(PCASMSetSortIndices(pc, PETSC_FALSE)); /* everything is already sorted */
1110f1580f4eSBarry Smith   PetscCall(PCSetFromOptions(pc));                             /* otherwise -pc_hpddm_levels_1_pc_asm_sub_mat_type is not used */
1111f1580f4eSBarry Smith   PetscCall(PCSetUp(pc));
1112f1580f4eSBarry Smith   /* reset MatCreateSubMatrices() */
1113f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, op));
1114db4a47b3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", nullptr));
11153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1116f1580f4eSBarry Smith }
1117f1580f4eSBarry Smith 
1118d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMPermute_Private(IS is, IS in_is, IS *out_is, Mat in_C, Mat *out_C, IS *p)
1119d71ae5a4SJacob Faibussowitsch {
1120f1580f4eSBarry Smith   IS                           perm;
1121f1580f4eSBarry Smith   const PetscInt              *ptr;
1122b07dfdedSPierre Jolivet   PetscInt                    *concatenate, size, n, bs;
1123f1580f4eSBarry Smith   std::map<PetscInt, PetscInt> order;
1124f1580f4eSBarry Smith   PetscBool                    sorted;
1125f1580f4eSBarry Smith 
1126f1580f4eSBarry Smith   PetscFunctionBegin;
1127f1580f4eSBarry Smith   PetscCall(ISSorted(is, &sorted));
1128f1580f4eSBarry Smith   if (!sorted) {
1129f1580f4eSBarry Smith     PetscCall(ISGetLocalSize(is, &size));
1130f1580f4eSBarry Smith     PetscCall(ISGetIndices(is, &ptr));
1131b07dfdedSPierre Jolivet     PetscCall(ISGetBlockSize(is, &bs));
1132f1580f4eSBarry Smith     /* MatCreateSubMatrices(), called by PCASM, follows the global numbering of Pmat */
1133b07dfdedSPierre Jolivet     for (n = 0; n < size; n += bs) order.insert(std::make_pair(ptr[n] / bs, n / bs));
1134f1580f4eSBarry Smith     PetscCall(ISRestoreIndices(is, &ptr));
1135b07dfdedSPierre Jolivet     size /= bs;
1136f1580f4eSBarry Smith     if (out_C) {
1137f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1138f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.second;
1139f1580f4eSBarry Smith       concatenate -= size;
1140b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_C), bs, size, concatenate, PETSC_OWN_POINTER, &perm));
1141f1580f4eSBarry Smith       PetscCall(ISSetPermutation(perm));
1142f1580f4eSBarry Smith       /* permute user-provided Mat so that it matches with MatCreateSubMatrices() numbering */
1143f1580f4eSBarry Smith       PetscCall(MatPermute(in_C, perm, perm, out_C));
1144f1580f4eSBarry Smith       if (p) *p = perm;
1145f1580f4eSBarry Smith       else PetscCall(ISDestroy(&perm)); /* no need to save the permutation */
1146f1580f4eSBarry Smith     }
1147f1580f4eSBarry Smith     if (out_is) {
1148f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1149f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.first;
1150f1580f4eSBarry Smith       concatenate -= size;
1151f1580f4eSBarry Smith       /* permute user-provided IS so that it matches with MatCreateSubMatrices() numbering */
1152b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_is), bs, size, concatenate, PETSC_OWN_POINTER, out_is));
1153f1580f4eSBarry Smith     }
1154f1580f4eSBarry Smith   } else { /* input IS is sorted, nothing to permute, simply duplicate inputs when needed */
1155f1580f4eSBarry Smith     if (out_C) PetscCall(MatDuplicate(in_C, MAT_COPY_VALUES, out_C));
1156f1580f4eSBarry Smith     if (out_is) PetscCall(ISDuplicate(in_is, out_is));
1157f1580f4eSBarry Smith   }
11583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1159f1580f4eSBarry Smith }
1160f1580f4eSBarry Smith 
11615e642048SPierre Jolivet static PetscErrorCode PCHPDDMCheckSymmetry_Private(PC pc, Mat A01, Mat A10)
116213044ca3SPierre Jolivet {
116313044ca3SPierre Jolivet   Mat       T, U = nullptr, B = nullptr;
116413044ca3SPierre Jolivet   IS        z;
116513044ca3SPierre Jolivet   PetscBool flg[2];
116613044ca3SPierre Jolivet 
116713044ca3SPierre Jolivet   PetscFunctionBegin;
116813044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, flg));
116913044ca3SPierre Jolivet   if (flg[0]) PetscCall(MatTransposeGetMat(A10, &U));
117013044ca3SPierre Jolivet   else {
117113044ca3SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, flg + 1));
117213044ca3SPierre Jolivet     if (flg[1]) PetscCall(MatHermitianTransposeGetMat(A10, &U));
117313044ca3SPierre Jolivet   }
117413044ca3SPierre Jolivet   if (U) PetscCall(MatDuplicate(U, MAT_COPY_VALUES, &T));
117513044ca3SPierre Jolivet   else PetscCall(MatHermitianTranspose(A10, MAT_INITIAL_MATRIX, &T));
117613044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATTRANSPOSEVIRTUAL, flg));
117713044ca3SPierre Jolivet   if (flg[0]) {
117813044ca3SPierre Jolivet     PetscCall(MatTransposeGetMat(A01, &A01));
117913044ca3SPierre Jolivet     PetscCall(MatTranspose(A01, MAT_INITIAL_MATRIX, &B));
118013044ca3SPierre Jolivet     A01 = B;
118113044ca3SPierre Jolivet   } else {
118213044ca3SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATHERMITIANTRANSPOSEVIRTUAL, flg));
118313044ca3SPierre Jolivet     if (flg[0]) {
118413044ca3SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A01, &A01));
118513044ca3SPierre Jolivet       PetscCall(MatHermitianTranspose(A01, MAT_INITIAL_MATRIX, &B));
118613044ca3SPierre Jolivet       A01 = B;
118713044ca3SPierre Jolivet     }
118813044ca3SPierre Jolivet   }
118913044ca3SPierre Jolivet   PetscCall(PetscLayoutCompare(T->rmap, A01->rmap, flg));
119013044ca3SPierre Jolivet   if (flg[0]) {
119113044ca3SPierre Jolivet     PetscCall(PetscLayoutCompare(T->cmap, A01->cmap, flg));
119213044ca3SPierre Jolivet     if (flg[0]) {
119313044ca3SPierre Jolivet       PetscCall(MatFindZeroRows(A01, &z)); /* for essential boundary conditions, some implementations will */
119413044ca3SPierre Jolivet       if (z) {                             /*  zero rows in [P00 A01] except for the diagonal of P00       */
119513044ca3SPierre Jolivet         PetscCall(MatSetOption(T, MAT_NO_OFF_PROC_ZERO_ROWS, PETSC_TRUE));
119613044ca3SPierre Jolivet         PetscCall(MatZeroRowsIS(T, z, 0.0, nullptr, nullptr)); /* corresponding zero rows from A01 */
119713044ca3SPierre Jolivet         PetscCall(ISDestroy(&z));
119813044ca3SPierre Jolivet       }
119913044ca3SPierre Jolivet       PetscCall(MatMultEqual(A01, T, 20, flg));
120013044ca3SPierre Jolivet       PetscCheck(flg[0], PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "A01 != A10^T");
120113044ca3SPierre Jolivet     } else PetscCall(PetscInfo(pc, "A01 and A10^T have non-congruent column layouts, cannot test for equality\n"));
120213044ca3SPierre Jolivet   }
120313044ca3SPierre Jolivet   PetscCall(MatDestroy(&B));
120413044ca3SPierre Jolivet   PetscCall(MatDestroy(&T));
120513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
120613044ca3SPierre Jolivet }
120713044ca3SPierre Jolivet 
1208d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMDestroySubMatrices_Private(PetscBool flg, PetscBool algebraic, Mat *sub)
1209d71ae5a4SJacob Faibussowitsch {
1210f1580f4eSBarry Smith   IS is;
1211f1580f4eSBarry Smith 
1212f1580f4eSBarry Smith   PetscFunctionBegin;
1213f1580f4eSBarry Smith   if (!flg) {
1214f1580f4eSBarry Smith     if (algebraic) {
1215f1580f4eSBarry Smith       PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Embed", (PetscObject *)&is));
1216f1580f4eSBarry Smith       PetscCall(ISDestroy(&is));
1217db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Embed", nullptr));
1218db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Compact", nullptr));
1219f1580f4eSBarry Smith     }
1220f1580f4eSBarry Smith     PetscCall(MatDestroySubMatrices(algebraic ? 2 : 1, &sub));
1221f1580f4eSBarry Smith   }
12223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1223f1580f4eSBarry Smith }
1224f1580f4eSBarry Smith 
1225d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMAlgebraicAuxiliaryMat_Private(Mat P, IS *is, Mat *sub[], PetscBool block)
1226d71ae5a4SJacob Faibussowitsch {
1227f1580f4eSBarry Smith   IS         icol[3], irow[2];
1228f1580f4eSBarry Smith   Mat       *M, Q;
1229f1580f4eSBarry Smith   PetscReal *ptr;
1230f1580f4eSBarry Smith   PetscInt  *idx, p = 0, n, bs = PetscAbs(P->cmap->bs);
1231f1580f4eSBarry Smith   PetscBool  flg;
1232f1580f4eSBarry Smith 
1233f1580f4eSBarry Smith   PetscFunctionBegin;
1234f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, P->cmap->N, 0, 1, icol + 2));
1235f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(icol[2], bs));
1236f1580f4eSBarry Smith   PetscCall(ISSetIdentity(icol[2]));
1237f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1238f1580f4eSBarry Smith   if (flg) {
1239f1580f4eSBarry Smith     /* MatCreateSubMatrices() does not handle MATMPISBAIJ properly when iscol != isrow, so convert first to MATMPIBAIJ */
1240f1580f4eSBarry Smith     PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &Q));
1241f1580f4eSBarry Smith     std::swap(P, Q);
1242f1580f4eSBarry Smith   }
1243f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(P, 1, is, icol + 2, MAT_INITIAL_MATRIX, &M));
1244f1580f4eSBarry Smith   if (flg) {
1245f1580f4eSBarry Smith     std::swap(P, Q);
1246f1580f4eSBarry Smith     PetscCall(MatDestroy(&Q));
1247f1580f4eSBarry Smith   }
1248f1580f4eSBarry Smith   PetscCall(ISDestroy(icol + 2));
1249f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, M[0]->rmap->N, 0, 1, irow));
1250f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(irow[0], bs));
1251f1580f4eSBarry Smith   PetscCall(ISSetIdentity(irow[0]));
1252f1580f4eSBarry Smith   if (!block) {
1253b07dfdedSPierre Jolivet     PetscCall(PetscMalloc2(P->cmap->N, &ptr, P->cmap->N / bs, &idx));
1254f1580f4eSBarry Smith     PetscCall(MatGetColumnNorms(M[0], NORM_INFINITY, ptr));
1255f1580f4eSBarry Smith     /* check for nonzero columns so that M[0] may be expressed in compact form */
1256b07dfdedSPierre Jolivet     for (n = 0; n < P->cmap->N; n += bs) {
1257b07dfdedSPierre Jolivet       if (std::find_if(ptr + n, ptr + n + bs, [](PetscReal v) { return v > PETSC_MACHINE_EPSILON; }) != ptr + n + bs) idx[p++] = n / bs;
1258f1580f4eSBarry Smith     }
1259b07dfdedSPierre Jolivet     PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, p, idx, PETSC_USE_POINTER, icol + 1));
1260f1580f4eSBarry Smith     PetscCall(ISSetInfo(icol[1], IS_SORTED, IS_GLOBAL, PETSC_TRUE, PETSC_TRUE));
1261f1580f4eSBarry Smith     PetscCall(ISEmbed(*is, icol[1], PETSC_FALSE, icol + 2));
1262f1580f4eSBarry Smith     irow[1] = irow[0];
1263f1580f4eSBarry 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 */
1264f1580f4eSBarry Smith     icol[0] = is[0];
1265f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 2, irow, icol, MAT_INITIAL_MATRIX, sub));
1266f1580f4eSBarry Smith     PetscCall(ISDestroy(icol + 1));
1267f1580f4eSBarry Smith     PetscCall(PetscFree2(ptr, idx));
1268f1580f4eSBarry Smith     /* IS used to go back and forth between the augmented and the original local linear system, see eq. (3.4) of [2022b] */
1269f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Embed", (PetscObject)icol[2]));
1270f1580f4eSBarry Smith     /* Mat used in eq. (3.1) of [2022b] */
1271f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Compact", (PetscObject)(*sub)[1]));
1272f1580f4eSBarry Smith   } else {
1273f1580f4eSBarry Smith     Mat aux;
1274f1580f4eSBarry Smith     PetscCall(MatSetOption(M[0], MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1275f1580f4eSBarry Smith     /* diagonal block of the overlapping rows */
1276f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 1, irow, is, MAT_INITIAL_MATRIX, sub));
1277f1580f4eSBarry Smith     PetscCall(MatDuplicate((*sub)[0], MAT_COPY_VALUES, &aux));
1278f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1279f1580f4eSBarry Smith     if (bs == 1) { /* scalar case */
1280f1580f4eSBarry Smith       Vec sum[2];
1281f1580f4eSBarry Smith       PetscCall(MatCreateVecs(aux, sum, sum + 1));
1282f1580f4eSBarry Smith       PetscCall(MatGetRowSum(M[0], sum[0]));
1283f1580f4eSBarry Smith       PetscCall(MatGetRowSum(aux, sum[1]));
1284f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1285f1580f4eSBarry Smith       PetscCall(VecAXPY(sum[0], -1.0, sum[1]));
1286f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1287f1580f4eSBarry Smith       PetscCall(MatDiagonalSet(aux, sum[0], ADD_VALUES));
1288f1580f4eSBarry Smith       PetscCall(VecDestroy(sum));
1289f1580f4eSBarry Smith       PetscCall(VecDestroy(sum + 1));
1290f1580f4eSBarry Smith     } else { /* vectorial case */
1291f1580f4eSBarry Smith       /* TODO: missing MatGetValuesBlocked(), so the code below is     */
1292f1580f4eSBarry Smith       /* an extension of the scalar case for when bs > 1, but it could */
1293f1580f4eSBarry Smith       /* be more efficient by avoiding all these MatMatMult()          */
1294f1580f4eSBarry Smith       Mat          sum[2], ones;
1295f1580f4eSBarry Smith       PetscScalar *ptr;
1296f1580f4eSBarry Smith       PetscCall(PetscCalloc1(M[0]->cmap->n * bs, &ptr));
1297f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, M[0]->cmap->n, bs, M[0]->cmap->n, bs, ptr, &ones));
1298f1580f4eSBarry Smith       for (n = 0; n < M[0]->cmap->n; n += bs) {
1299f1580f4eSBarry Smith         for (p = 0; p < bs; ++p) ptr[n + p * (M[0]->cmap->n + 1)] = 1.0;
1300f1580f4eSBarry Smith       }
1301f1580f4eSBarry Smith       PetscCall(MatMatMult(M[0], ones, MAT_INITIAL_MATRIX, PETSC_DEFAULT, sum));
1302f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1303f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, aux->cmap->n, bs, aux->cmap->n, bs, ptr, &ones));
1304f1580f4eSBarry Smith       PetscCall(MatDenseSetLDA(ones, M[0]->cmap->n));
1305f1580f4eSBarry Smith       PetscCall(MatMatMult(aux, ones, MAT_INITIAL_MATRIX, PETSC_DEFAULT, sum + 1));
1306f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1307f1580f4eSBarry Smith       PetscCall(PetscFree(ptr));
1308f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1309f1580f4eSBarry Smith       PetscCall(MatAXPY(sum[0], -1.0, sum[1], SAME_NONZERO_PATTERN));
1310f1580f4eSBarry Smith       PetscCall(MatDestroy(sum + 1));
1311f1580f4eSBarry Smith       /* re-order values to be consistent with MatSetValuesBlocked()           */
1312f1580f4eSBarry Smith       /* equivalent to MatTranspose() which does not truly handle              */
1313f1580f4eSBarry Smith       /* MAT_INPLACE_MATRIX in the rectangular case, as it calls PetscMalloc() */
1314f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(sum[0], &ptr));
1315f1580f4eSBarry Smith       HPDDM::Wrapper<PetscScalar>::imatcopy<'T'>(bs, sum[0]->rmap->n, ptr, sum[0]->rmap->n, bs);
1316f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1317f1580f4eSBarry Smith       for (n = 0; n < aux->cmap->n / bs; ++n) PetscCall(MatSetValuesBlocked(aux, 1, &n, 1, &n, ptr + n * bs * bs, ADD_VALUES));
1318f1580f4eSBarry Smith       PetscCall(MatAssemblyBegin(aux, MAT_FINAL_ASSEMBLY));
1319f1580f4eSBarry Smith       PetscCall(MatAssemblyEnd(aux, MAT_FINAL_ASSEMBLY));
1320f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(sum[0], &ptr));
1321f1580f4eSBarry Smith       PetscCall(MatDestroy(sum));
1322f1580f4eSBarry Smith     }
1323f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
1324f1580f4eSBarry Smith     /* left-hand side of GenEO, with the same sparsity pattern as PCASM subdomain solvers  */
1325f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Neumann_Mat", (PetscObject)aux));
1326f1580f4eSBarry Smith   }
1327f1580f4eSBarry Smith   PetscCall(ISDestroy(irow));
1328f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &M));
13293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1330f1580f4eSBarry Smith }
1331f1580f4eSBarry Smith 
133213044ca3SPierre Jolivet static PetscErrorCode PCApply_Nest(PC pc, Vec x, Vec y)
133313044ca3SPierre Jolivet {
133413044ca3SPierre Jolivet   Mat                    A;
133513044ca3SPierre Jolivet   MatSolverType          type;
133613044ca3SPierre Jolivet   IS                     is[2];
133713044ca3SPierre Jolivet   PetscBool              flg;
133813044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
133913044ca3SPierre Jolivet 
134013044ca3SPierre Jolivet   PetscFunctionBegin;
134113044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
134213044ca3SPierre Jolivet   PetscCall(PCGetOperators(p->first, &A, nullptr));
134313044ca3SPierre Jolivet   PetscCall(MatNestGetISs(A, is, nullptr));
134413044ca3SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(p->first, &type));
134513044ca3SPierre Jolivet   PetscCall(PCFactorGetMatrix(p->first, &A));
134613044ca3SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
134724ddd604SPierre Jolivet   if (flg && A->schur) {
134813044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
134913044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 1)); /* reduction/condensation phase followed by Schur complement solve */
135013044ca3SPierre Jolivet #endif
135113044ca3SPierre Jolivet   }
135213044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[0], is[1], SCATTER_FORWARD, x)); /* assign the RHS associated to the Schur complement */
135313044ca3SPierre Jolivet   PetscCall(PCApply(p->first, p->second[0], p->second[1]));
135413044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[1], is[1], SCATTER_REVERSE, y)); /* retrieve the partial solution associated to the Schur complement */
135513044ca3SPierre Jolivet   if (flg) {
135613044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
135713044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1)); /* default ICNTL(26) value in PETSc */
135813044ca3SPierre Jolivet #endif
135913044ca3SPierre Jolivet   }
136013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
136113044ca3SPierre Jolivet }
136213044ca3SPierre Jolivet 
136313044ca3SPierre Jolivet static PetscErrorCode PCView_Nest(PC pc, PetscViewer viewer)
136413044ca3SPierre Jolivet {
136513044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
136613044ca3SPierre Jolivet 
136713044ca3SPierre Jolivet   PetscFunctionBegin;
136813044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
136913044ca3SPierre Jolivet   PetscCall(PCView(p->first, viewer));
137013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
137113044ca3SPierre Jolivet }
137213044ca3SPierre Jolivet 
137313044ca3SPierre Jolivet static PetscErrorCode PCDestroy_Nest(PC pc)
137413044ca3SPierre Jolivet {
137513044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
137613044ca3SPierre Jolivet 
137713044ca3SPierre Jolivet   PetscFunctionBegin;
137813044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
137913044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second));
138013044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second + 1));
138113044ca3SPierre Jolivet   PetscCall(PCDestroy(&p->first));
138213044ca3SPierre Jolivet   PetscCall(PetscFree(p));
138313044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
138413044ca3SPierre Jolivet }
138513044ca3SPierre Jolivet 
138613044ca3SPierre Jolivet template <bool T = false>
138713044ca3SPierre Jolivet static PetscErrorCode MatMult_Schur(Mat A, Vec x, Vec y)
138813044ca3SPierre Jolivet {
138913044ca3SPierre Jolivet   std::tuple<Mat, VecScatter, Vec[2]> *ctx;
139013044ca3SPierre Jolivet 
139113044ca3SPierre Jolivet   PetscFunctionBegin;
139213044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
139313044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD)); /* local Vec with overlap */
139413044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD));
139513044ca3SPierre Jolivet   if (!T) PetscCall(MatMult(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1])); /* local Schur complement */
139613044ca3SPierre Jolivet   else PetscCall(MatMultTranspose(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1]));
139713044ca3SPierre Jolivet   PetscCall(VecSet(y, 0.0));
139813044ca3SPierre 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 */
139913044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE));
140013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
140113044ca3SPierre Jolivet }
140213044ca3SPierre Jolivet 
140313044ca3SPierre Jolivet static PetscErrorCode MatDestroy_Schur(Mat A)
140413044ca3SPierre Jolivet {
140513044ca3SPierre Jolivet   std::tuple<Mat, VecScatter, Vec[2]> *ctx;
140613044ca3SPierre Jolivet 
140713044ca3SPierre Jolivet   PetscFunctionBegin;
140813044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
140913044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx)));
141013044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx) + 1));
141113044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
141213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
141313044ca3SPierre Jolivet }
141413044ca3SPierre Jolivet 
141513044ca3SPierre Jolivet static PetscErrorCode MatMult_SchurCorrection(Mat A, Vec x, Vec y)
141613044ca3SPierre Jolivet {
141713044ca3SPierre Jolivet   PC                                         pc;
141813044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
141913044ca3SPierre Jolivet 
142013044ca3SPierre Jolivet   PetscFunctionBegin;
142113044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
142213044ca3SPierre Jolivet   pc = ((PC_HPDDM *)std::get<0>(*ctx)[0]->data)->levels[0]->ksp->pc;
142313044ca3SPierre 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 */
142413044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], x, std::get<3>(*ctx)[1]));                    /*     A_01 x                 */
142513044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 x             */
142613044ca3SPierre 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        */
142713044ca3SPierre 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 */
142813044ca3SPierre Jolivet   } else {
142913044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[0]));                    /*     M_S^-1 x               */
143013044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], std::get<3>(*ctx)[0], std::get<3>(*ctx)[1])); /*     A_01 M_S^-1 x          */
143113044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 M_S^-1 x      */
143213044ca3SPierre 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 */
143313044ca3SPierre Jolivet   }
143413044ca3SPierre Jolivet   PetscCall(VecAXPY(y, -1.0, x)); /* y -= x, preconditioned eq. (24) of https://hal.science/hal-02343808v6/document (with a sign flip) */
143513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
143613044ca3SPierre Jolivet }
143713044ca3SPierre Jolivet 
143813044ca3SPierre Jolivet static PetscErrorCode MatView_SchurCorrection(Mat A, PetscViewer viewer)
143913044ca3SPierre Jolivet {
144013044ca3SPierre Jolivet   PetscBool                                  ascii;
144113044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
144213044ca3SPierre Jolivet 
144313044ca3SPierre Jolivet   PetscFunctionBegin;
144413044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &ascii));
144513044ca3SPierre Jolivet   if (ascii) {
144613044ca3SPierre Jolivet     PetscCall(MatShellGetContext(A, &ctx));
144713044ca3SPierre 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)"));
144813044ca3SPierre Jolivet     PetscCall(PCView(std::get<0>(*ctx)[1], viewer)); /* no need to PCView(Q_0) since it will be done by PCFIELDSPLIT */
144913044ca3SPierre Jolivet   }
145013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
145113044ca3SPierre Jolivet }
145213044ca3SPierre Jolivet 
145313044ca3SPierre Jolivet static PetscErrorCode MatDestroy_SchurCorrection(Mat A)
145413044ca3SPierre Jolivet {
145513044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
145613044ca3SPierre Jolivet 
145713044ca3SPierre Jolivet   PetscFunctionBegin;
145813044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
145913044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx)));
146013044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 1));
146113044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 2));
146213044ca3SPierre Jolivet   PetscCall(PCDestroy(std::get<0>(*ctx) + 1));
146313044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
146413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
146513044ca3SPierre Jolivet }
146613044ca3SPierre Jolivet 
146713044ca3SPierre Jolivet static PetscErrorCode KSPPreSolve_SchurCorrection(KSP, Vec b, Vec, void *context)
146813044ca3SPierre Jolivet {
146913044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
147013044ca3SPierre Jolivet 
1471a6b3e571SPierre Jolivet   PetscFunctionBegin;
147213044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
147313044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], b, std::get<3>(*ctx)[2]));
147413044ca3SPierre 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 */
147513044ca3SPierre Jolivet   }
147613044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
147713044ca3SPierre Jolivet }
147813044ca3SPierre Jolivet 
147913044ca3SPierre Jolivet static PetscErrorCode KSPPostSolve_SchurCorrection(KSP, Vec b, Vec x, void *context)
148013044ca3SPierre Jolivet {
148113044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
148213044ca3SPierre Jolivet 
1483a6b3e571SPierre Jolivet   PetscFunctionBegin;
148413044ca3SPierre 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 */
148513044ca3SPierre Jolivet   else {
148613044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[2]));
148713044ca3SPierre Jolivet     PetscCall(VecCopy(std::get<3>(*ctx)[2], x)); /* replace x by M^-1 x */
148813044ca3SPierre Jolivet   }
148913044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
149013044ca3SPierre Jolivet }
149113044ca3SPierre Jolivet 
14929bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat, Vec, Vec);
14939bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat, Vec, Vec);
14949bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat, Mat, Mat, void *);
14959bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat);
14969bb5c669SPierre Jolivet 
1497d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDM(PC pc)
1498d71ae5a4SJacob Faibussowitsch {
1499f1580f4eSBarry Smith   PC_HPDDM                                  *data = (PC_HPDDM *)pc->data;
1500f1580f4eSBarry Smith   PC                                         inner;
1501f1580f4eSBarry Smith   KSP                                       *ksp;
150213044ca3SPierre Jolivet   Mat                                       *sub, A, P, N, C = nullptr, uaux = nullptr, weighted, subA[2], S;
1503f1580f4eSBarry Smith   Vec                                        xin, v;
1504f1580f4eSBarry Smith   std::vector<Vec>                           initial;
1505db4a47b3SPierre Jolivet   IS                                         is[1], loc, uis = data->is, unsorted = nullptr;
1506f1580f4eSBarry Smith   ISLocalToGlobalMapping                     l2g;
1507f1580f4eSBarry Smith   char                                       prefix[256];
1508f1580f4eSBarry Smith   const char                                *pcpre;
1509f1580f4eSBarry Smith   const PetscScalar *const                  *ev;
15109bb5c669SPierre Jolivet   PetscInt                                   n, requested = data->N, reused = 0, overlap = -1;
1511f1580f4eSBarry Smith   MatStructure                               structure  = UNKNOWN_NONZERO_PATTERN;
1512f1580f4eSBarry Smith   PetscBool                                  subdomains = PETSC_FALSE, flg = PETSC_FALSE, ismatis, swap = PETSC_FALSE, algebraic = PETSC_FALSE, block = PETSC_FALSE;
1513f1580f4eSBarry Smith   DM                                         dm;
151413044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = nullptr;
1515398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1516db4a47b3SPierre Jolivet   IS  dis  = nullptr;
1517db4a47b3SPierre Jolivet   Mat daux = nullptr;
1518398c7888SPierre Jolivet #endif
1519f1580f4eSBarry Smith 
1520f1580f4eSBarry Smith   PetscFunctionBegin;
1521f1580f4eSBarry Smith   PetscCheck(data->levels && data->levels[0], PETSC_COMM_SELF, PETSC_ERR_PLIB, "Not a single level allocated");
1522f1580f4eSBarry Smith   PetscCall(PCGetOptionsPrefix(pc, &pcpre));
1523f1580f4eSBarry Smith   PetscCall(PCGetOperators(pc, &A, &P));
1524f1580f4eSBarry Smith   if (!data->levels[0]->ksp) {
1525f1580f4eSBarry Smith     PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->ksp));
15263821be0aSBarry Smith     PetscCall(KSPSetNestLevel(data->levels[0]->ksp, pc->kspnestlevel));
1527f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_%s_", pcpre ? pcpre : "", data->N > 1 ? "levels_1" : "coarse"));
1528f1580f4eSBarry Smith     PetscCall(KSPSetOptionsPrefix(data->levels[0]->ksp, prefix));
1529f1580f4eSBarry Smith     PetscCall(KSPSetType(data->levels[0]->ksp, KSPPREONLY));
1530f1580f4eSBarry Smith   } else if (data->levels[0]->ksp->pc && data->levels[0]->ksp->pc->setupcalled == 1 && data->levels[0]->ksp->pc->reusepreconditioner) {
1531f1580f4eSBarry Smith     /* if the fine-level PCSHELL exists, its setup has succeeded, and one wants to reuse it, */
1532f1580f4eSBarry Smith     /* then just propagate the appropriate flag to the coarser levels                        */
1533f1580f4eSBarry Smith     for (n = 0; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1534f1580f4eSBarry Smith       /* the following KSP and PC may be NULL for some processes, hence the check            */
1535f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetReusePreconditioner(data->levels[n]->ksp, PETSC_TRUE));
1536f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
1537f1580f4eSBarry Smith     }
1538f1580f4eSBarry Smith     /* early bail out because there is nothing to do */
15393ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1540f1580f4eSBarry Smith   } else {
1541f1580f4eSBarry Smith     /* reset coarser levels */
1542f1580f4eSBarry Smith     for (n = 1; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1543f1580f4eSBarry 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) {
1544f1580f4eSBarry Smith         reused = data->N - n;
1545f1580f4eSBarry Smith         break;
1546f1580f4eSBarry Smith       }
1547f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[n]->ksp));
1548f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[n]->pc));
1549f1580f4eSBarry Smith     }
1550f1580f4eSBarry Smith     /* check if some coarser levels are being reused */
1551f1580f4eSBarry Smith     PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &reused, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)pc)));
1552f1580f4eSBarry Smith     const int *addr = data->levels[0]->P ? data->levels[0]->P->getAddrLocal() : &HPDDM::i__0;
1553f1580f4eSBarry Smith 
1554f1580f4eSBarry Smith     if (addr != &HPDDM::i__0 && reused != data->N - 1) {
1555f1580f4eSBarry Smith       /* reuse previously computed eigenvectors */
1556f1580f4eSBarry Smith       ev = data->levels[0]->P->getVectors();
1557f1580f4eSBarry Smith       if (ev) {
1558f1580f4eSBarry Smith         initial.reserve(*addr);
1559f1580f4eSBarry Smith         PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, data->levels[0]->P->getDof(), ev[0], &xin));
1560f1580f4eSBarry Smith         for (n = 0; n < *addr; ++n) {
1561f1580f4eSBarry Smith           PetscCall(VecDuplicate(xin, &v));
1562f1580f4eSBarry Smith           PetscCall(VecPlaceArray(xin, ev[n]));
1563f1580f4eSBarry Smith           PetscCall(VecCopy(xin, v));
1564f1580f4eSBarry Smith           initial.emplace_back(v);
1565f1580f4eSBarry Smith           PetscCall(VecResetArray(xin));
1566f1580f4eSBarry Smith         }
1567f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
1568f1580f4eSBarry Smith       }
1569f1580f4eSBarry Smith     }
1570f1580f4eSBarry Smith   }
1571f1580f4eSBarry Smith   data->N -= reused;
1572f1580f4eSBarry Smith   PetscCall(KSPSetOperators(data->levels[0]->ksp, A, P));
1573f1580f4eSBarry Smith 
1574f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATIS, &ismatis));
1575f1580f4eSBarry Smith   if (!data->is && !ismatis) {
1576db4a47b3SPierre Jolivet     PetscErrorCode (*create)(DM, IS *, Mat *, PetscErrorCode (**)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void **) = nullptr;
1577db4a47b3SPierre Jolivet     PetscErrorCode (*usetup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *)                                                = nullptr;
1578db4a47b3SPierre Jolivet     void *uctx                                                                                                               = nullptr;
1579f1580f4eSBarry Smith 
1580f1580f4eSBarry Smith     /* first see if we can get the data from the DM */
1581f1580f4eSBarry Smith     PetscCall(MatGetDM(P, &dm));
1582f1580f4eSBarry Smith     if (!dm) PetscCall(MatGetDM(A, &dm));
1583f1580f4eSBarry Smith     if (!dm) PetscCall(PCGetDM(pc, &dm));
1584907a3e9cSStefano Zampini     if (dm) { /* this is the hook for DMPLEX for which the auxiliary Mat is the local Neumann matrix */
1585f1580f4eSBarry Smith       PetscCall(PetscObjectQueryFunction((PetscObject)dm, "DMCreateNeumannOverlap_C", &create));
1586f1580f4eSBarry Smith       if (create) {
1587f1580f4eSBarry Smith         PetscCall((*create)(dm, &uis, &uaux, &usetup, &uctx));
1588c8ea6600SPierre 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 */
1589f1580f4eSBarry Smith       }
1590f1580f4eSBarry Smith     }
1591f1580f4eSBarry Smith     if (!create) {
1592f1580f4eSBarry Smith       if (!uis) {
1593f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1594f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1595f1580f4eSBarry Smith       }
1596f1580f4eSBarry Smith       if (!uaux) {
1597f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1598f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1599f1580f4eSBarry Smith       }
1600f1580f4eSBarry Smith       /* look inside the Pmat instead of the PC, needed for MatSchurComplementComputeExplicitOperator() */
1601f1580f4eSBarry Smith       if (!uis) {
1602f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1603f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1604f1580f4eSBarry Smith       }
1605f1580f4eSBarry Smith       if (!uaux) {
1606f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1607f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1608f1580f4eSBarry Smith       }
1609f1580f4eSBarry Smith     }
1610f1580f4eSBarry Smith     PetscCall(PCHPDDMSetAuxiliaryMat(pc, uis, uaux, usetup, uctx));
1611f1580f4eSBarry Smith     PetscCall(MatDestroy(&uaux));
1612f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
1613f1580f4eSBarry Smith   }
1614f1580f4eSBarry Smith 
1615f1580f4eSBarry Smith   if (!ismatis) {
1616f1580f4eSBarry Smith     PetscCall(PCHPDDMSetUpNeumannOverlap_Private(pc));
1617db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_block_splitting", &block, nullptr));
16189bb5c669SPierre Jolivet     PetscCall(PetscOptionsGetInt(nullptr, pcpre, "-pc_hpddm_harmonic_overlap", &overlap, nullptr));
16195e642048SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
16205e642048SPierre Jolivet     if (data->is || (data->N > 1 && flg)) {
16219bb5c669SPierre Jolivet       if (block || overlap != -1) {
162202800ff6SPierre Jolivet         PetscCall(ISDestroy(&data->is));
162302800ff6SPierre Jolivet         PetscCall(MatDestroy(&data->aux));
16245e642048SPierre Jolivet       } else if (data->N > 1 && flg) {
162513044ca3SPierre Jolivet         PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_GENEO;
162613044ca3SPierre Jolivet 
162713044ca3SPierre Jolivet         PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
162813044ca3SPierre Jolivet         if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
162913044ca3SPierre Jolivet           PetscCall(ISDestroy(&data->is)); /* destroy any previously user-set objects since they will be set automatically */
163013044ca3SPierre Jolivet           PetscCall(MatDestroy(&data->aux));
163113044ca3SPierre Jolivet         } else if (type == PC_HPDDM_SCHUR_PRE_GENEO) {
163213044ca3SPierre Jolivet           PetscContainer container = nullptr;
163313044ca3SPierre Jolivet 
163413044ca3SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Schur", (PetscObject *)&container));
163513044ca3SPierre Jolivet           if (!container) { /* first call to PCSetUp() on the PC associated to the Schur complement */
163613044ca3SPierre Jolivet             PC_HPDDM *data_00;
163713044ca3SPierre Jolivet             KSP       ksp, inner_ksp;
163813044ca3SPierre Jolivet             PC        pc_00;
163913044ca3SPierre Jolivet             char     *prefix;
164013044ca3SPierre Jolivet             PetscReal norm;
164113044ca3SPierre Jolivet 
164213044ca3SPierre Jolivet             PetscCall(MatSchurComplementGetKSP(P, &ksp));
164313044ca3SPierre Jolivet             PetscCall(KSPGetPC(ksp, &pc_00));
164413044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)pc_00, PCHPDDM, &flg));
1645fd310a01SPierre Jolivet             PetscCheck(flg, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition %s and -%spc_type %s (!= %s)", pcpre ? pcpre : "", PCHPDDMSchurPreTypes[type], ((PetscObject)pc_00)->prefix ? ((PetscObject)pc_00)->prefix : "",
164613044ca3SPierre Jolivet                        ((PetscObject)pc_00)->type_name, PCHPDDM);
164713044ca3SPierre Jolivet             data_00 = (PC_HPDDM *)pc_00->data;
1648fd310a01SPierre Jolivet             PetscCheck(data_00->N == 2, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition %s and %" PetscInt_FMT " level%s instead of 2 for the A00 block -%s", pcpre ? pcpre : "", PCHPDDMSchurPreTypes[type],
1649fd310a01SPierre Jolivet                        data_00->N, data_00->N > 1 ? "s" : "", ((PetscObject)pc_00)->prefix);
165013044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)data_00->levels[0]->pc, PCASM, &flg));
1651fd310a01SPierre Jolivet             PetscCheck(flg, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition %s and -%spc_type %s (!= %s)", pcpre ? pcpre : "", PCHPDDMSchurPreTypes[type], ((PetscObject)data_00->levels[0]->pc)->prefix,
165213044ca3SPierre Jolivet                        ((PetscObject)data_00->levels[0]->pc)->type_name, PCASM);
1653fd310a01SPierre Jolivet             PetscCheck(data->Neumann == PETSC_BOOL3_TRUE, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition %s and -%spc_hpddm_has_neumann != true", pcpre ? pcpre : "", PCHPDDMSchurPreTypes[type], pcpre ? pcpre : "");
16545e642048SPierre Jolivet             if (PetscDefined(USE_DEBUG) || !data->is) {
16555e642048SPierre Jolivet               Mat A01, A10, B = nullptr, C = nullptr, *sub;
165613044ca3SPierre Jolivet 
16575e642048SPierre Jolivet               PetscCall(MatSchurComplementGetSubMatrices(P, &A, nullptr, &A01, &A10, nullptr));
16585e642048SPierre Jolivet               PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
16595e642048SPierre Jolivet               if (flg) {
16605e642048SPierre Jolivet                 PetscCall(MatTransposeGetMat(A10, &C));
16615e642048SPierre Jolivet                 PetscCall(MatTranspose(C, MAT_INITIAL_MATRIX, &B));
16625e642048SPierre Jolivet               } else {
16635e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
16645e642048SPierre Jolivet                 if (flg) {
16655e642048SPierre Jolivet                   PetscCall(MatHermitianTransposeGetMat(A10, &C));
16665e642048SPierre Jolivet                   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &B));
16675e642048SPierre Jolivet                 }
16685e642048SPierre Jolivet               }
16695e642048SPierre Jolivet               if (!B) {
16705e642048SPierre Jolivet                 B = A10;
16715e642048SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)B));
16725e642048SPierre Jolivet               } else if (!data->is) {
16735e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompareAny((PetscObject)A01, &flg, MATTRANSPOSEVIRTUAL, MATHERMITIANTRANSPOSEVIRTUAL, ""));
16745e642048SPierre Jolivet                 if (!flg) C = A01;
16755e642048SPierre Jolivet               }
167613044ca3SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, B->rmap->N, 0, 1, &uis));
16775e642048SPierre Jolivet               PetscCall(ISSetIdentity(uis));
16785e642048SPierre Jolivet               if (!data->is) {
16795e642048SPierre Jolivet                 if (C) PetscCall(PetscObjectReference((PetscObject)C));
16805e642048SPierre Jolivet                 else PetscCall(MatTranspose(B, MAT_INITIAL_MATRIX, &C));
16815e642048SPierre Jolivet                 PetscCall(ISDuplicate(data_00->is, is));
16825e642048SPierre Jolivet                 PetscCall(MatIncreaseOverlap(A, 1, is, 1));
16835e642048SPierre Jolivet                 PetscCall(MatSetOption(C, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
16845e642048SPierre Jolivet                 PetscCall(MatCreateSubMatrices(C, 1, is, &uis, MAT_INITIAL_MATRIX, &sub));
16855e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
16865e642048SPierre Jolivet                 PetscCall(MatTranspose(sub[0], MAT_INITIAL_MATRIX, &C));
16875e642048SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
16885e642048SPierre Jolivet                 PetscCall(MatFindNonzeroRows(C, &data->is));
16895e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
16905e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
16915e642048SPierre Jolivet               }
16925e642048SPierre Jolivet               if (PetscDefined(USE_DEBUG)) {
16935e642048SPierre Jolivet                 PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
169413044ca3SPierre 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 */
169513044ca3SPierre Jolivet                 PetscCall(ISDestroy(&uis));
169613044ca3SPierre Jolivet                 PetscCall(ISDuplicate(data->is, &uis));
169713044ca3SPierre Jolivet                 PetscCall(ISSort(uis));
16985e642048SPierre Jolivet                 PetscCall(ISComplement(uis, 0, B->rmap->N, is));
169913044ca3SPierre Jolivet                 PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &C));
17005e642048SPierre Jolivet                 PetscCall(MatZeroRowsIS(C, is[0], 0.0, nullptr, nullptr));
17015e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
170213044ca3SPierre Jolivet                 PetscCall(MatMultEqual(sub[0], C, 20, &flg));
170313044ca3SPierre 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 */
170413044ca3SPierre Jolivet                 PetscCall(MatDestroy(&C));
170513044ca3SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
170613044ca3SPierre Jolivet               }
17075e642048SPierre Jolivet               PetscCall(ISDestroy(&uis));
17085e642048SPierre Jolivet               PetscCall(MatDestroy(&B));
17095e642048SPierre Jolivet             }
171013044ca3SPierre Jolivet             if (data->aux) PetscCall(MatNorm(data->aux, NORM_FROBENIUS, &norm));
171113044ca3SPierre Jolivet             else norm = 0.0;
171213044ca3SPierre Jolivet             PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &norm, 1, MPIU_REAL, MPI_MAX, PetscObjectComm((PetscObject)P)));
17130594bca0SPierre 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 */
171413044ca3SPierre Jolivet               VecScatter         scatter;
171513044ca3SPierre Jolivet               Vec                x;
171613044ca3SPierre Jolivet               const PetscScalar *read;
171713044ca3SPierre Jolivet               PetscScalar       *write;
171813044ca3SPierre Jolivet 
171913044ca3SPierre Jolivet               PetscCall(MatDestroy(&data->aux));
172013044ca3SPierre Jolivet               PetscCall(ISGetLocalSize(data->is, &n));
172113044ca3SPierre Jolivet               PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &x));
172213044ca3SPierre Jolivet               PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &v));
172313044ca3SPierre Jolivet               PetscCall(VecScatterCreate(x, data->is, v, nullptr, &scatter));
172413044ca3SPierre Jolivet               PetscCall(VecSet(v, 1.0));
172513044ca3SPierre Jolivet               PetscCall(VecSet(x, 1.0));
172613044ca3SPierre Jolivet               PetscCall(VecScatterBegin(scatter, v, x, ADD_VALUES, SCATTER_REVERSE));
172713044ca3SPierre Jolivet               PetscCall(VecScatterEnd(scatter, v, x, ADD_VALUES, SCATTER_REVERSE)); /* v has the multiplicity of all unknowns on the overlap */
172813044ca3SPierre Jolivet               PetscCall(VecScatterDestroy(&scatter));
172913044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
173013044ca3SPierre Jolivet               PetscCall(VecCreateSeq(PETSC_COMM_SELF, n, &v));
173113044ca3SPierre Jolivet               PetscCall(VecGetArrayRead(x, &read));
173213044ca3SPierre Jolivet               PetscCall(VecGetArrayWrite(v, &write));
17330594bca0SPierre Jolivet               PetscCallCXX(std::transform(read, read + n, write, [](const PetscScalar &m) { return PETSC_SMALL / (static_cast<PetscReal>(1000.0) * m); }));
173413044ca3SPierre Jolivet               PetscCall(VecRestoreArrayRead(x, &read));
173513044ca3SPierre Jolivet               PetscCall(VecRestoreArrayWrite(v, &write));
173613044ca3SPierre Jolivet               PetscCall(VecDestroy(&x));
1737c3e1b152SPierre Jolivet               PetscCall(MatCreateDiagonal(v, &data->aux));
173813044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
173913044ca3SPierre Jolivet             }
174013044ca3SPierre Jolivet             uis  = data->is;
174113044ca3SPierre Jolivet             uaux = data->aux;
174213044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uis));
174313044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uaux));
174413044ca3SPierre Jolivet             PetscCall(PetscStrallocpy(pcpre, &prefix));
174513044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(pc, nullptr));
174613044ca3SPierre Jolivet             PetscCall(PCSetType(pc, PCKSP));                                    /* replace the PC associated to the Schur complement by PCKSP */
174713044ca3SPierre Jolivet             PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &inner_ksp)); /* new KSP that will be attached to the previously set PC */
174873329a61SPierre Jolivet             pc->ops->setup = PCSetUp_KSP;
174913044ca3SPierre Jolivet             PetscCall(PetscObjectGetTabLevel((PetscObject)pc, &n));
175013044ca3SPierre Jolivet             PetscCall(PetscObjectSetTabLevel((PetscObject)inner_ksp, n + 2));
175113044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, pc->mat, pc->pmat));
175213044ca3SPierre Jolivet             PetscCall(KSPSetOptionsPrefix(inner_ksp, std::string(std::string(prefix) + "pc_hpddm_").c_str()));
175313044ca3SPierre Jolivet             PetscCall(KSPSetSkipPCSetFromOptions(inner_ksp, PETSC_TRUE));
175413044ca3SPierre Jolivet             PetscCall(KSPSetFromOptions(inner_ksp));
175513044ca3SPierre Jolivet             PetscCall(KSPGetPC(inner_ksp, &inner));
175613044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(inner, nullptr));
175713044ca3SPierre Jolivet             PetscCall(PCSetType(inner, PCNONE)); /* no preconditioner since the action of M^-1 A or A M^-1 will be computed by the Amat */
175813044ca3SPierre Jolivet             PetscCall(PCKSPSetKSP(pc, inner_ksp));
175913044ca3SPierre Jolivet             PetscCall(PetscContainerCreate(PetscObjectComm((PetscObject)pc), &container));
176013044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx)); /* context to pass data around for the inner-most PC, which will be a proper PCHPDDM */
176113044ca3SPierre Jolivet             PetscCall(PetscContainerSetPointer(container, ctx));
176213044ca3SPierre Jolivet             std::get<0>(*ctx)[0] = pc_00; /* for coarse correction on the primal (e.g., velocity) space */
176313044ca3SPierre Jolivet             PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &std::get<0>(*ctx)[1]));
176413044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(std::get<0>(*ctx)[1], prefix));
176513044ca3SPierre Jolivet             PetscCall(PetscFree(prefix));
176613044ca3SPierre Jolivet             PetscCall(PCSetOperators(std::get<0>(*ctx)[1], pc->mat, pc->pmat));
176713044ca3SPierre Jolivet             PetscCall(PCSetType(std::get<0>(*ctx)[1], PCHPDDM));
176813044ca3SPierre 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 */
176913044ca3SPierre Jolivet             PetscCall(PCSetFromOptions(std::get<0>(*ctx)[1]));
177013044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uis));
177113044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uaux));
177213044ca3SPierre 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 */
177313044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_MULT, (void (*)(void))MatMult_SchurCorrection));
177413044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_VIEW, (void (*)(void))MatView_SchurCorrection));
177513044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_DESTROY, (void (*)(void))MatDestroy_SchurCorrection));
177613044ca3SPierre Jolivet             PetscCall(KSPGetPCSide(inner_ksp, &(std::get<2>(*ctx))));
177713044ca3SPierre Jolivet             if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
177813044ca3SPierre Jolivet               PetscCall(KSPSetPreSolve(inner_ksp, KSPPreSolve_SchurCorrection, ctx));
177913044ca3SPierre Jolivet             } else { /* no support for PC_SYMMETRIC */
178013044ca3SPierre 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]);
178113044ca3SPierre Jolivet             }
178213044ca3SPierre Jolivet             PetscCall(KSPSetPostSolve(inner_ksp, KSPPostSolve_SchurCorrection, ctx));
178313044ca3SPierre Jolivet             PetscCall(PetscObjectCompose((PetscObject)(std::get<0>(*ctx)[1]), "_PCHPDDM_Schur", (PetscObject)container));
178413044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)container));
178513044ca3SPierre Jolivet             PetscCall(PCSetUp(std::get<0>(*ctx)[1]));
178613044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, S, S));
178713044ca3SPierre Jolivet             PetscCall(MatCreateVecs(std::get<1>(*ctx)[0], std::get<3>(*ctx), std::get<3>(*ctx) + 1));
178813044ca3SPierre Jolivet             PetscCall(VecDuplicate(std::get<3>(*ctx)[0], std::get<3>(*ctx) + 2));
178913044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)inner_ksp));
179013044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)S));
179113044ca3SPierre Jolivet             PetscFunctionReturn(PETSC_SUCCESS);
179213044ca3SPierre Jolivet           } else { /* second call to PCSetUp() on the PC associated to the Schur complement, retrieve previously set context */
179313044ca3SPierre Jolivet             PetscCall(PetscContainerGetPointer(container, (void **)&ctx));
179413044ca3SPierre Jolivet           }
179513044ca3SPierre Jolivet         }
179613044ca3SPierre Jolivet       }
179713044ca3SPierre Jolivet     }
1798f1580f4eSBarry Smith     if (!data->is && data->N > 1) {
1799f1580f4eSBarry Smith       char type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
1800f1580f4eSBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
1801f1580f4eSBarry Smith       if (flg || (A->rmap->N != A->cmap->N && P->rmap->N == P->cmap->N && P->rmap->N == A->cmap->N)) {
1802f1580f4eSBarry Smith         Mat B;
1803f1580f4eSBarry Smith         PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, A, P, &B, pcpre));
1804f1580f4eSBarry Smith         if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) data->correction = PC_HPDDM_COARSE_CORRECTION_BALANCED;
1805f1580f4eSBarry Smith         PetscCall(MatDestroy(&B));
1806f1580f4eSBarry Smith       } else {
1807f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
1808f1580f4eSBarry Smith         if (flg) {
1809f1580f4eSBarry Smith           Mat                 A00, P00, A01, A10, A11, B, N;
181013044ca3SPierre Jolivet           PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_LEAST_SQUARES;
181113044ca3SPierre Jolivet 
181213044ca3SPierre Jolivet           PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, &A01, &A10, &A11));
181313044ca3SPierre Jolivet           if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
181413044ca3SPierre Jolivet           PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
181513044ca3SPierre Jolivet           if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
18163df4cd7bSPierre Jolivet             Vec                        diagonal = nullptr;
1817f1580f4eSBarry Smith             const PetscScalar         *array;
1818f1580f4eSBarry Smith             MatSchurComplementAinvType type;
1819f1580f4eSBarry Smith 
1820f1580f4eSBarry Smith             if (A11) {
18213df4cd7bSPierre Jolivet               PetscCall(MatCreateVecs(A11, &diagonal, nullptr));
18223df4cd7bSPierre Jolivet               PetscCall(MatGetDiagonal(A11, diagonal));
1823f1580f4eSBarry Smith             }
1824db4a47b3SPierre Jolivet             PetscCall(MatCreateVecs(P00, &v, nullptr));
1825f1580f4eSBarry Smith             PetscCall(MatSchurComplementGetAinvType(P, &type));
1826f1580f4eSBarry 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]);
1827f1580f4eSBarry Smith             if (type == MAT_SCHUR_COMPLEMENT_AINV_LUMP) {
1828f1580f4eSBarry Smith               PetscCall(MatGetRowSum(P00, v));
1829f1580f4eSBarry Smith               if (A00 == P00) PetscCall(PetscObjectReference((PetscObject)A00));
1830f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1831f1580f4eSBarry Smith               PetscCall(VecGetArrayRead(v, &array));
1832db4a47b3SPierre Jolivet               PetscCall(MatCreateAIJ(PetscObjectComm((PetscObject)A00), A00->rmap->n, A00->cmap->n, A00->rmap->N, A00->cmap->N, 1, nullptr, 0, nullptr, &P00));
1833f1580f4eSBarry Smith               PetscCall(MatSetOption(P00, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
1834f1580f4eSBarry Smith               for (n = A00->rmap->rstart; n < A00->rmap->rend; ++n) PetscCall(MatSetValue(P00, n, n, array[n - A00->rmap->rstart], INSERT_VALUES));
1835f1580f4eSBarry Smith               PetscCall(MatAssemblyBegin(P00, MAT_FINAL_ASSEMBLY));
1836f1580f4eSBarry Smith               PetscCall(MatAssemblyEnd(P00, MAT_FINAL_ASSEMBLY));
1837f1580f4eSBarry Smith               PetscCall(VecRestoreArrayRead(v, &array));
1838f1580f4eSBarry Smith               PetscCall(MatSchurComplementUpdateSubMatrices(P, A00, P00, A01, A10, A11)); /* replace P00 by diag(sum of each row of P00) */
1839f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1840f1580f4eSBarry Smith             } else PetscCall(MatGetDiagonal(P00, v));
1841f1580f4eSBarry Smith             PetscCall(VecReciprocal(v)); /* inv(diag(P00))       */
1842f1580f4eSBarry Smith             PetscCall(VecSqrtAbs(v));    /* sqrt(inv(diag(P00))) */
1843f1580f4eSBarry Smith             PetscCall(MatDuplicate(A01, MAT_COPY_VALUES, &B));
1844db4a47b3SPierre Jolivet             PetscCall(MatDiagonalScale(B, v, nullptr));
1845f1580f4eSBarry Smith             PetscCall(VecDestroy(&v));
1846f1580f4eSBarry Smith             PetscCall(MatCreateNormalHermitian(B, &N));
18473df4cd7bSPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, B, N, &P, pcpre, &diagonal));
1848f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
1849f1580f4eSBarry Smith             if (!flg) {
1850f1580f4eSBarry Smith               PetscCall(MatDestroy(&P));
1851f1580f4eSBarry Smith               P = N;
1852f1580f4eSBarry Smith               PetscCall(PetscObjectReference((PetscObject)P));
1853f1580f4eSBarry Smith             } else PetscCall(MatScale(P, -1.0));
18543df4cd7bSPierre Jolivet             if (diagonal) {
18553df4cd7bSPierre Jolivet               PetscCall(MatDiagonalSet(P, diagonal, ADD_VALUES));
1856aa21023fSPierre Jolivet               PetscCall(PCSetOperators(pc, P, P)); /* replace P by diag(P11) - A01^T inv(diag(P00)) A01 */
18573df4cd7bSPierre Jolivet               PetscCall(VecDestroy(&diagonal));
18583df4cd7bSPierre Jolivet             } else {
1859f1580f4eSBarry Smith               PetscCall(MatScale(N, -1.0));
1860aa21023fSPierre Jolivet               PetscCall(PCSetOperators(pc, N, P)); /* replace P by - A01^T inv(diag(P00)) A01 */
18613df4cd7bSPierre Jolivet             }
1862f1580f4eSBarry Smith             PetscCall(MatDestroy(&N));
1863f1580f4eSBarry Smith             PetscCall(MatDestroy(&P));
1864f1580f4eSBarry Smith             PetscCall(MatDestroy(&B));
186513044ca3SPierre Jolivet           } else
1866fd310a01SPierre Jolivet             PetscCheck(type != PC_HPDDM_SCHUR_PRE_GENEO, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition %s without a prior call to PCHPDDMSetAuxiliaryMat() on the A11 block%s%s", pcpre ? pcpre : "", PCHPDDMSchurPreTypes[type], pcpre ? " -" : "", pcpre ? pcpre : "");
18673ba16761SJacob Faibussowitsch           PetscFunctionReturn(PETSC_SUCCESS);
1868f1580f4eSBarry Smith         } else {
1869db4a47b3SPierre Jolivet           PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_st_pc_type", type, sizeof(type), nullptr));
1870f1580f4eSBarry Smith           PetscCall(PetscStrcmp(type, PCMAT, &algebraic));
1871b07dfdedSPierre Jolivet           PetscCheck(!algebraic || !block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_block_splitting");
18729bb5c669SPierre Jolivet           if (overlap != -1) {
18739bb5c669SPierre 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");
18749bb5c669SPierre Jolivet             PetscCheck(overlap >= 1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_WRONG, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " < 1", overlap);
18759bb5c669SPierre Jolivet           }
18769bb5c669SPierre Jolivet           if (block || overlap != -1) algebraic = PETSC_TRUE;
1877f1580f4eSBarry Smith           if (algebraic) {
1878f1580f4eSBarry Smith             PetscCall(ISCreateStride(PETSC_COMM_SELF, P->rmap->n, P->rmap->rstart, 1, &data->is));
1879f1580f4eSBarry Smith             PetscCall(MatIncreaseOverlap(P, 1, &data->is, 1));
1880f1580f4eSBarry Smith             PetscCall(ISSort(data->is));
18819bb5c669SPierre Jolivet           } else
18829bb5c669SPierre 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 : ""));
1883f1580f4eSBarry Smith         }
1884f1580f4eSBarry Smith       }
1885f1580f4eSBarry Smith     }
1886f1580f4eSBarry Smith   }
1887398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1888398c7888SPierre Jolivet   if (data->is) PetscCall(ISDuplicate(data->is, &dis));
1889398c7888SPierre Jolivet   if (data->aux) PetscCall(MatDuplicate(data->aux, MAT_COPY_VALUES, &daux));
1890398c7888SPierre Jolivet #endif
1891f1580f4eSBarry Smith   if (data->is || (ismatis && data->N > 1)) {
1892f1580f4eSBarry Smith     if (ismatis) {
1893f1580f4eSBarry Smith       std::initializer_list<std::string> list = {MATSEQBAIJ, MATSEQSBAIJ};
1894f1580f4eSBarry Smith       PetscCall(MatISGetLocalMat(P, &N));
1895f1580f4eSBarry Smith       std::initializer_list<std::string>::const_iterator it = std::find(list.begin(), list.end(), ((PetscObject)N)->type_name);
1896f1580f4eSBarry Smith       PetscCall(MatISRestoreLocalMat(P, &N));
1897f1580f4eSBarry Smith       switch (std::distance(list.begin(), it)) {
1898d71ae5a4SJacob Faibussowitsch       case 0:
1899d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
1900d71ae5a4SJacob Faibussowitsch         break;
1901f1580f4eSBarry Smith       case 1:
1902f1580f4eSBarry Smith         /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIBAIJ */
1903f1580f4eSBarry Smith         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
1904f1580f4eSBarry Smith         PetscCall(MatSetOption(C, MAT_SYMMETRIC, PETSC_TRUE));
1905f1580f4eSBarry Smith         break;
1906d71ae5a4SJacob Faibussowitsch       default:
1907d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, &C));
1908f1580f4eSBarry Smith       }
1909db4a47b3SPierre Jolivet       PetscCall(MatISGetLocalToGlobalMapping(P, &l2g, nullptr));
1910f1580f4eSBarry Smith       PetscCall(PetscObjectReference((PetscObject)P));
1911f1580f4eSBarry Smith       PetscCall(KSPSetOperators(data->levels[0]->ksp, A, C));
1912f1580f4eSBarry Smith       std::swap(C, P);
1913f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingGetSize(l2g, &n));
1914f1580f4eSBarry Smith       PetscCall(ISCreateStride(PETSC_COMM_SELF, n, 0, 1, &loc));
1915f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingApplyIS(l2g, loc, &is[0]));
1916f1580f4eSBarry Smith       PetscCall(ISDestroy(&loc));
1917f1580f4eSBarry Smith       /* the auxiliary Mat is _not_ the local Neumann matrix                                */
1918f1580f4eSBarry Smith       /* it is the local Neumann matrix augmented (with zeros) through MatIncreaseOverlap() */
1919c8ea6600SPierre Jolivet       data->Neumann = PETSC_BOOL3_FALSE;
1920f1580f4eSBarry Smith       structure     = SAME_NONZERO_PATTERN;
1921f1580f4eSBarry Smith     } else {
1922f1580f4eSBarry Smith       is[0] = data->is;
192313044ca3SPierre Jolivet       if (algebraic || ctx) subdomains = PETSC_TRUE;
1924db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_define_subdomains", &subdomains, nullptr));
192513044ca3SPierre 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);
1926c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann)) {
1927b07dfdedSPierre Jolivet         PetscCheck(!block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_block_splitting and -pc_hpddm_has_neumann");
19289bb5c669SPierre Jolivet         PetscCheck(overlap == -1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " and -pc_hpddm_has_neumann", overlap);
1929b07dfdedSPierre Jolivet         PetscCheck(!algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_has_neumann");
1930f1580f4eSBarry Smith       }
1931c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann) || block) structure = SAME_NONZERO_PATTERN;
1932f1580f4eSBarry Smith       PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), P->rmap->n, P->rmap->rstart, 1, &loc));
1933f1580f4eSBarry Smith     }
1934f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
1935db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetEnum(nullptr, prefix, "-st_matstructure", MatStructures, (PetscEnum *)&structure, &flg)); /* if not user-provided, force its value when possible */
1936f1580f4eSBarry Smith     if (!flg && structure == SAME_NONZERO_PATTERN) {                                                                   /* cannot call STSetMatStructure() yet, insert the appropriate option in the database, parsed by STSetFromOptions() */
1937f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-%spc_hpddm_levels_1_st_matstructure", pcpre ? pcpre : ""));
1938db4a47b3SPierre Jolivet       PetscCall(PetscOptionsSetValue(nullptr, prefix, MatStructures[structure]));
1939f1580f4eSBarry Smith     }
1940398c7888SPierre Jolivet     flg = PETSC_FALSE;
1941b07dfdedSPierre Jolivet     if (data->share) {
1942398c7888SPierre Jolivet       data->share = PETSC_FALSE; /* will be reset to PETSC_TRUE if none of the conditions below are true */
1943398c7888SPierre 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 : ""));
1944398c7888SPierre Jolivet       else if (data->deflation) PetscCall(PetscInfo(pc, "Nothing to share since PCHPDDMSetDeflationMat() has been called\n"));
1945398c7888SPierre Jolivet       else if (ismatis) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc with a Pmat of type MATIS\n"));
1946b07dfdedSPierre Jolivet       else if (!algebraic && structure != SAME_NONZERO_PATTERN)
1947398c7888SPierre 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]));
1948398c7888SPierre Jolivet       else data->share = PETSC_TRUE;
1949398c7888SPierre Jolivet     }
1950398c7888SPierre Jolivet     if (!ismatis) {
1951398c7888SPierre Jolivet       if (data->share || (!PetscBool3ToBool(data->Neumann) && subdomains)) PetscCall(ISDuplicate(is[0], &unsorted));
1952398c7888SPierre Jolivet       else unsorted = is[0];
1953398c7888SPierre Jolivet     }
1954f1580f4eSBarry Smith     if (data->N > 1 && (data->aux || ismatis || algebraic)) {
1955f1580f4eSBarry Smith       PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "HPDDM library not loaded, cannot use more than one level");
1956f1580f4eSBarry Smith       PetscCall(MatSetOption(P, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1957f1580f4eSBarry Smith       if (ismatis) {
1958f1580f4eSBarry Smith         /* needed by HPDDM (currently) so that the partition of unity is 0 on subdomain interfaces */
1959f1580f4eSBarry Smith         PetscCall(MatIncreaseOverlap(P, 1, is, 1));
1960f1580f4eSBarry Smith         PetscCall(ISDestroy(&data->is));
1961f1580f4eSBarry Smith         data->is = is[0];
1962f1580f4eSBarry Smith       } else {
1963f1580f4eSBarry Smith         if (PetscDefined(USE_DEBUG)) {
1964f1580f4eSBarry Smith           PetscBool equal;
1965f1580f4eSBarry Smith           IS        intersect;
1966f1580f4eSBarry Smith 
1967f1580f4eSBarry Smith           PetscCall(ISIntersect(data->is, loc, &intersect));
1968f1580f4eSBarry Smith           PetscCall(ISEqualUnsorted(loc, intersect, &equal));
1969f1580f4eSBarry Smith           PetscCall(ISDestroy(&intersect));
1970f1580f4eSBarry Smith           PetscCheck(equal, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "IS of the auxiliary Mat does not include all local rows of A");
1971f1580f4eSBarry Smith         }
19729bb5c669SPierre Jolivet         if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", PCHPDDMAlgebraicAuxiliaryMat_Private));
19739bb5c669SPierre Jolivet         if (!PetscBool3ToBool(data->Neumann) && (!algebraic || overlap != -1)) {
1974f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1975f1580f4eSBarry Smith           if (flg) {
1976f1580f4eSBarry Smith             /* maybe better to ISSort(is[0]), MatCreateSubMatrices(), and then MatPermute() */
1977f1580f4eSBarry Smith             /* but there is no MatPermute_SeqSBAIJ(), so as before, just use MATMPIBAIJ     */
1978f1580f4eSBarry Smith             PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &uaux));
1979f1580f4eSBarry Smith             flg = PETSC_FALSE;
1980f1580f4eSBarry Smith           }
1981f1580f4eSBarry Smith         }
1982f1580f4eSBarry Smith       }
19839bb5c669SPierre Jolivet       if (algebraic && overlap == -1) {
1984f1580f4eSBarry Smith         PetscUseMethod(pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", (Mat, IS *, Mat *[], PetscBool), (P, is, &sub, block));
1985f1580f4eSBarry Smith         if (block) {
1986f1580f4eSBarry Smith           PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", (PetscObject *)&data->aux));
1987db4a47b3SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", nullptr));
1988f1580f4eSBarry Smith         }
19899bb5c669SPierre Jolivet       } else if (!uaux || overlap != -1) {
199013044ca3SPierre Jolivet         if (!ctx) {
1991c8ea6600SPierre Jolivet           if (PetscBool3ToBool(data->Neumann)) sub = &data->aux;
19929bb5c669SPierre Jolivet           else {
1993df21ef68SPierre Jolivet             PetscBool flg;
19949bb5c669SPierre Jolivet             if (overlap != -1) {
19959bb5c669SPierre Jolivet               Harmonic              h;
19969bb5c669SPierre Jolivet               Mat                   A0, *a;                           /* with an SVD: [ A_00  A_01       ] */
19979bb5c669SPierre Jolivet               IS                    ov[2], rows, cols, stride;        /*              [ A_10  A_11  A_12 ] */
19989bb5c669SPierre Jolivet               const PetscInt       *i[2], bs = PetscAbs(P->cmap->bs); /* with a GEVP: [ A_00  A_01       ] */
19999bb5c669SPierre Jolivet               PetscInt              n[2];                             /*              [ A_10  A_11  A_12 ] */
20009bb5c669SPierre Jolivet               std::vector<PetscInt> v[2];                             /*              [       A_21  A_22 ] */
20019bb5c669SPierre Jolivet 
20029bb5c669SPierre Jolivet               PetscCall(ISDuplicate(data->is, ov));
20039bb5c669SPierre Jolivet               if (overlap > 1) PetscCall(MatIncreaseOverlap(P, 1, ov, overlap - 1));
20049bb5c669SPierre Jolivet               PetscCall(ISDuplicate(ov[0], ov + 1));
20059bb5c669SPierre Jolivet               PetscCall(MatIncreaseOverlap(P, 1, ov + 1, 1));
20069bb5c669SPierre Jolivet               PetscCall(PetscNew(&h));
20079bb5c669SPierre Jolivet               h->ksp = nullptr;
20089bb5c669SPierre Jolivet               PetscCall(PetscCalloc1(2, &h->A));
20093a60673dSPierre Jolivet               PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_nsv", &flg));
20109bb5c669SPierre Jolivet               if (!flg) PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_relative_threshold", &flg));
20119bb5c669SPierre Jolivet               PetscCall(ISSort(ov[0]));
20129bb5c669SPierre Jolivet               if (!flg) PetscCall(ISSort(ov[1]));
20139bb5c669SPierre Jolivet               PetscCall(PetscMalloc1(!flg ? 5 : 3, &h->is));
20149bb5c669SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, ov + !flg, ov + 1, MAT_INITIAL_MATRIX, &a)); /* submatrix from above, either square (!flg) or rectangular (flg) */
20159bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) {
20169bb5c669SPierre Jolivet                 PetscCall(ISGetIndices(ov[j], i + j));
20179bb5c669SPierre Jolivet                 PetscCall(ISGetLocalSize(ov[j], n + j));
20189bb5c669SPierre Jolivet               }
20199bb5c669SPierre Jolivet               v[1].reserve((n[1] - n[0]) / bs);
20209bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[1]; j += bs) { /* indices of the (2,2) block */
20219bb5c669SPierre Jolivet                 PetscInt location;
20229bb5c669SPierre Jolivet                 PetscCall(ISLocate(ov[0], i[1][j], &location));
20239bb5c669SPierre Jolivet                 if (location < 0) v[1].emplace_back(j / bs);
20249bb5c669SPierre Jolivet               }
20259bb5c669SPierre Jolivet               if (!flg) {
20269bb5c669SPierre Jolivet                 h->A[1] = a[0];
20279bb5c669SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)h->A[1]));
20289bb5c669SPierre Jolivet                 v[0].reserve((n[0] - P->rmap->n) / bs);
20299bb5c669SPierre Jolivet                 for (PetscInt j = 0; j < n[1]; j += bs) { /* row indices of the (1,2) block */
20309bb5c669SPierre Jolivet                   PetscInt location;
20319bb5c669SPierre Jolivet                   PetscCall(ISLocate(loc, i[1][j], &location));
20329bb5c669SPierre Jolivet                   if (location < 0) {
20339bb5c669SPierre Jolivet                     PetscCall(ISLocate(ov[0], i[1][j], &location));
20349bb5c669SPierre Jolivet                     if (location >= 0) v[0].emplace_back(j / bs);
20359bb5c669SPierre Jolivet                   }
20369bb5c669SPierre Jolivet                 }
20379bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
20389bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_COPY_VALUES, h->is + 4));
20399bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, h->is[4], MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
20409bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
20419bb5c669SPierre 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 */
20429bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &rows));
20439bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols = rows, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
20449bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
20459bb5c669SPierre Jolivet                 v[0].clear();
20469bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, ov[1], PETSC_TRUE, h->is + 3));
20479bb5c669SPierre Jolivet                 PetscCall(ISEmbed(data->is, ov[1], PETSC_TRUE, h->is + 2));
20489bb5c669SPierre Jolivet               }
20499bb5c669SPierre Jolivet               v[0].reserve((n[0] - P->rmap->n) / bs);
20509bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[0]; j += bs) {
20519bb5c669SPierre Jolivet                 PetscInt location;
20529bb5c669SPierre Jolivet                 PetscCall(ISLocate(loc, i[0][j], &location));
20539bb5c669SPierre Jolivet                 if (location < 0) v[0].emplace_back(j / bs);
20549bb5c669SPierre Jolivet               }
20559bb5c669SPierre Jolivet               PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
20569bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISRestoreIndices(ov[j], i + j));
20579bb5c669SPierre Jolivet               if (flg) {
20589bb5c669SPierre Jolivet                 IS is;
20599bb5c669SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, a[0]->rmap->n, 0, 1, &is));
20609bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &cols));
20619bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], is, cols, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
20629bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
20639bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&is));
20649bb5c669SPierre 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 */
20659bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, data->is, PETSC_TRUE, h->is + 2));
20669bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_USE_POINTER, &cols));
20679bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols, MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
20689bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
20699bb5c669SPierre Jolivet               }
20709bb5c669SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, A0->rmap->n, 0, 1, &stride));
20719bb5c669SPierre Jolivet               PetscCall(ISEmbed(rows, stride, PETSC_TRUE, h->is));
20729bb5c669SPierre Jolivet               PetscCall(ISDestroy(&stride));
20739bb5c669SPierre Jolivet               PetscCall(ISDestroy(&rows));
20749bb5c669SPierre Jolivet               PetscCall(ISEmbed(loc, ov[0], PETSC_TRUE, h->is + 1));
20759bb5c669SPierre Jolivet               if (subdomains) {
20769bb5c669SPierre Jolivet                 if (!data->levels[0]->pc) {
20779bb5c669SPierre Jolivet                   PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
20789bb5c669SPierre Jolivet                   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
20799bb5c669SPierre Jolivet                   PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
20809bb5c669SPierre Jolivet                   PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
20819bb5c669SPierre Jolivet                 }
20829bb5c669SPierre Jolivet                 PetscCall(PCSetType(data->levels[0]->pc, PCASM));
20839bb5c669SPierre Jolivet                 if (!data->levels[0]->pc->setupcalled) PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, ov + !flg, &loc));
20849bb5c669SPierre Jolivet                 PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, flg ? A0 : a[0], PETSC_TRUE));
20859bb5c669SPierre Jolivet                 if (!flg) ++overlap;
20869bb5c669SPierre Jolivet                 if (data->share) {
20879bb5c669SPierre Jolivet                   PetscInt n = -1;
20889bb5c669SPierre Jolivet                   PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
20899bb5c669SPierre Jolivet                   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
20909bb5c669SPierre Jolivet                   if (flg) {
20919bb5c669SPierre Jolivet                     h->ksp = ksp[0];
20929bb5c669SPierre Jolivet                     PetscCall(PetscObjectReference((PetscObject)h->ksp));
20939bb5c669SPierre Jolivet                   }
20949bb5c669SPierre Jolivet                 }
20959bb5c669SPierre Jolivet               }
20969bb5c669SPierre Jolivet               if (!h->ksp) {
20979bb5c669SPierre Jolivet                 PetscBool share = data->share;
20989bb5c669SPierre Jolivet                 PetscCall(KSPCreate(PETSC_COMM_SELF, &h->ksp));
20999bb5c669SPierre Jolivet                 PetscCall(KSPSetType(h->ksp, KSPPREONLY));
21009bb5c669SPierre Jolivet                 PetscCall(KSPSetOperators(h->ksp, A0, A0));
21019bb5c669SPierre Jolivet                 do {
21029bb5c669SPierre Jolivet                   if (!data->share) {
21039bb5c669SPierre Jolivet                     share = PETSC_FALSE;
21049bb5c669SPierre Jolivet                     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_%s", pcpre ? pcpre : "", flg ? "svd_" : "eps_"));
21059bb5c669SPierre Jolivet                     PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
21069bb5c669SPierre Jolivet                     PetscCall(KSPSetFromOptions(h->ksp));
21079bb5c669SPierre Jolivet                   } else {
21089bb5c669SPierre Jolivet                     MatSolverType type;
21099bb5c669SPierre Jolivet                     PetscCall(KSPGetPC(ksp[0], &pc));
21109bb5c669SPierre Jolivet                     PetscCall(PetscObjectTypeCompareAny((PetscObject)pc, &data->share, PCLU, PCCHOLESKY, ""));
21119bb5c669SPierre Jolivet                     if (data->share) {
21129bb5c669SPierre Jolivet                       PetscCall(PCFactorGetMatSolverType(pc, &type));
21139bb5c669SPierre Jolivet                       if (!type) {
21149bb5c669SPierre Jolivet                         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMUMPS));
21159bb5c669SPierre Jolivet                         else if (PetscDefined(HAVE_MKL_PARDISO)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMKL_PARDISO));
21169bb5c669SPierre Jolivet                         else data->share = PETSC_FALSE;
21179bb5c669SPierre Jolivet                         if (data->share) PetscCall(PCSetFromOptions(pc));
21189bb5c669SPierre Jolivet                       } else {
21199bb5c669SPierre Jolivet                         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &data->share));
21209bb5c669SPierre Jolivet                         if (!data->share) PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &data->share));
21219bb5c669SPierre Jolivet                       }
21229bb5c669SPierre Jolivet                       if (data->share) {
21239bb5c669SPierre Jolivet                         std::tuple<KSP, IS, Vec[2]> *p;
21249bb5c669SPierre Jolivet                         PetscCall(PCFactorGetMatrix(pc, &A));
21259bb5c669SPierre Jolivet                         PetscCall(MatFactorSetSchurIS(A, h->is[4]));
21269bb5c669SPierre Jolivet                         PetscCall(KSPSetUp(ksp[0]));
21279bb5c669SPierre Jolivet                         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_eps_shell_", pcpre ? pcpre : ""));
21289bb5c669SPierre Jolivet                         PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
21299bb5c669SPierre Jolivet                         PetscCall(KSPSetFromOptions(h->ksp));
21309bb5c669SPierre Jolivet                         PetscCall(KSPGetPC(h->ksp, &pc));
21319bb5c669SPierre Jolivet                         PetscCall(PCSetType(pc, PCSHELL));
21329bb5c669SPierre Jolivet                         PetscCall(PetscNew(&p));
21339bb5c669SPierre Jolivet                         std::get<0>(*p) = ksp[0];
21349bb5c669SPierre Jolivet                         PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &std::get<1>(*p)));
21359bb5c669SPierre Jolivet                         PetscCall(MatCreateVecs(A, std::get<2>(*p), std::get<2>(*p) + 1));
21369bb5c669SPierre Jolivet                         PetscCall(PCShellSetContext(pc, p));
21379bb5c669SPierre Jolivet                         PetscCall(PCShellSetApply(pc, PCApply_Schur));
21389bb5c669SPierre Jolivet                         PetscCall(PCShellSetApplyTranspose(pc, PCApply_Schur<Vec, true>));
21399bb5c669SPierre Jolivet                         PetscCall(PCShellSetMatApply(pc, PCApply_Schur<Mat>));
21409bb5c669SPierre Jolivet                         PetscCall(PCShellSetDestroy(pc, PCDestroy_Schur));
21419bb5c669SPierre Jolivet                       }
21429bb5c669SPierre Jolivet                     }
21439bb5c669SPierre Jolivet                     if (!data->share) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since neither MUMPS nor MKL PARDISO is used\n"));
21449bb5c669SPierre Jolivet                   }
21459bb5c669SPierre 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 */
21469bb5c669SPierre Jolivet               }
21479bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov));
21489bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov + 1));
21499bb5c669SPierre Jolivet               if (overlap == 1 && subdomains && flg) {
21509bb5c669SPierre Jolivet                 *subA = A0;
21519bb5c669SPierre Jolivet                 sub   = subA;
21529bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatDestroy(&uaux));
21539bb5c669SPierre Jolivet               } else PetscCall(MatDestroy(&A0));
21549bb5c669SPierre Jolivet               PetscCall(MatCreateShell(PETSC_COMM_SELF, P->rmap->n, n[1] - n[0], P->rmap->n, n[1] - n[0], h, &data->aux));
21559bb5c669SPierre Jolivet               PetscCall(MatCreateVecs(h->ksp->pc->pmat, &h->v, nullptr));
21569bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT, (void (*)(void))MatMult_Harmonic));
21579bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMultTranspose_Harmonic));
21589bb5c669SPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AB, nullptr, MatProduct_AB_Harmonic, nullptr, MATDENSE, MATDENSE));
21599bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_DESTROY, (void (*)(void))MatDestroy_Harmonic));
21609bb5c669SPierre Jolivet               PetscCall(MatDestroySubMatrices(1, &a));
21619bb5c669SPierre Jolivet             }
2162df21ef68SPierre Jolivet             if (overlap != 1 || !subdomains) {
2163df21ef68SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2164df21ef68SPierre Jolivet               if (ismatis) {
2165df21ef68SPierre Jolivet                 PetscCall(MatISGetLocalMat(C, &N));
2166df21ef68SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)N, MATSEQSBAIJ, &flg));
2167df21ef68SPierre Jolivet                 if (flg) PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2168df21ef68SPierre Jolivet                 PetscCall(MatISRestoreLocalMat(C, &N));
2169df21ef68SPierre Jolivet               }
2170df21ef68SPierre Jolivet             }
21719bb5c669SPierre Jolivet             if (uaux) {
21729bb5c669SPierre Jolivet               PetscCall(MatDestroy(&uaux));
21739bb5c669SPierre Jolivet               PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
21749bb5c669SPierre Jolivet             }
21759bb5c669SPierre Jolivet           }
217613044ca3SPierre Jolivet         }
2177f1580f4eSBarry Smith       } else {
2178f1580f4eSBarry Smith         PetscCall(MatCreateSubMatrices(uaux, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2179f1580f4eSBarry Smith         PetscCall(MatDestroy(&uaux));
2180f1580f4eSBarry Smith         PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2181f1580f4eSBarry Smith       }
2182f1580f4eSBarry Smith       /* Vec holding the partition of unity */
2183f1580f4eSBarry Smith       if (!data->levels[0]->D) {
2184f1580f4eSBarry Smith         PetscCall(ISGetLocalSize(data->is, &n));
2185f1580f4eSBarry Smith         PetscCall(VecCreateMPI(PETSC_COMM_SELF, n, PETSC_DETERMINE, &data->levels[0]->D));
2186f1580f4eSBarry Smith       }
21879bb5c669SPierre Jolivet       if (data->share && overlap == -1) {
2188f1580f4eSBarry Smith         Mat      D;
2189db4a47b3SPierre Jolivet         IS       perm = nullptr;
2190f1580f4eSBarry Smith         PetscInt size = -1;
2191398c7888SPierre Jolivet         if (!data->levels[0]->pc) {
2192398c7888SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2193398c7888SPierre Jolivet           PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
2194398c7888SPierre Jolivet           PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
2195398c7888SPierre Jolivet           PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
2196398c7888SPierre Jolivet         }
2197398c7888SPierre Jolivet         PetscCall(PCSetType(data->levels[0]->pc, PCASM));
219813044ca3SPierre Jolivet         if (!ctx) {
2199398c7888SPierre Jolivet           if (!data->levels[0]->pc->setupcalled) {
2200398c7888SPierre Jolivet             IS sorted; /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2201398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2202398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &sorted, &loc));
2203398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2204398c7888SPierre Jolivet           }
2205398c7888SPierre Jolivet           PetscCall(PCSetFromOptions(data->levels[0]->pc));
2206398c7888SPierre Jolivet           if (block) {
2207398c7888SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, sub[0], &C, &perm));
2208398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, C, algebraic));
2209398c7888SPierre Jolivet           } else PetscCall(PCSetUp(data->levels[0]->pc));
2210db4a47b3SPierre Jolivet           PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &size, nullptr, &ksp));
2211398c7888SPierre Jolivet           if (size != 1) {
2212398c7888SPierre Jolivet             data->share = PETSC_FALSE;
2213398c7888SPierre Jolivet             PetscCheck(size == -1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", size);
2214398c7888SPierre Jolivet             PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since PCASMGetSubKSP() not found in fine-level PC\n"));
2215398c7888SPierre Jolivet             PetscCall(ISDestroy(&unsorted));
2216398c7888SPierre Jolivet             unsorted = is[0];
2217398c7888SPierre Jolivet           } else {
221813044ca3SPierre Jolivet             if (!block && !ctx) PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, PetscBool3ToBool(data->Neumann) ? sub[0] : data->aux, &C, &perm));
2219c8ea6600SPierre Jolivet             if (!PetscBool3ToBool(data->Neumann) && !block) {
2220f1580f4eSBarry Smith               PetscCall(MatPermute(sub[0], perm, perm, &D)); /* permute since PCASM will call ISSort() */
2221f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(sub[0], &D));
2222f1580f4eSBarry Smith             }
2223f1580f4eSBarry Smith             if (data->B) { /* see PCHPDDMSetRHSMat() */
2224f1580f4eSBarry Smith               PetscCall(MatPermute(data->B, perm, perm, &D));
2225f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(data->B, &D));
2226f1580f4eSBarry Smith             }
2227f1580f4eSBarry Smith             PetscCall(ISDestroy(&perm));
2228f1580f4eSBarry Smith             const char *matpre;
2229f1580f4eSBarry Smith             PetscBool   cmp[4];
2230f1580f4eSBarry Smith             PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
2231f1580f4eSBarry Smith             PetscCall(MatDuplicate(subA[1], MAT_SHARE_NONZERO_PATTERN, &D));
2232f1580f4eSBarry Smith             PetscCall(MatGetOptionsPrefix(subA[1], &matpre));
2233f1580f4eSBarry Smith             PetscCall(MatSetOptionsPrefix(D, matpre));
2234f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMAL, cmp));
2235f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMAL, cmp + 1));
2236f1580f4eSBarry Smith             if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMALHERMITIAN, cmp + 2));
2237f1580f4eSBarry Smith             else cmp[2] = PETSC_FALSE;
2238f1580f4eSBarry Smith             if (!cmp[1]) PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMALHERMITIAN, cmp + 3));
2239f1580f4eSBarry Smith             else cmp[3] = PETSC_FALSE;
2240f1580f4eSBarry Smith             PetscCheck(cmp[0] == cmp[1] && cmp[2] == cmp[3], PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_levels_1_pc_asm_sub_mat_type %s and auxiliary Mat of type %s", pcpre ? pcpre : "", ((PetscObject)D)->type_name, ((PetscObject)C)->type_name);
2241f1580f4eSBarry Smith             if (!cmp[0] && !cmp[2]) {
2242f1580f4eSBarry Smith               if (!block) PetscCall(MatAXPY(D, 1.0, C, SUBSET_NONZERO_PATTERN));
22435c7345deSPierre Jolivet               else {
2244db4a47b3SPierre Jolivet                 PetscCall(MatMissingDiagonal(D, cmp, nullptr));
22455c7345deSPierre Jolivet                 if (cmp[0]) structure = DIFFERENT_NONZERO_PATTERN; /* data->aux has no missing diagonal entry */
22465c7345deSPierre Jolivet                 PetscCall(MatAXPY(D, 1.0, data->aux, structure));
22475c7345deSPierre Jolivet               }
2248f1580f4eSBarry Smith             } else {
2249f1580f4eSBarry Smith               Mat mat[2];
2250f1580f4eSBarry Smith               if (cmp[0]) {
2251f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(D, mat));
2252f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(C, mat + 1));
2253f1580f4eSBarry Smith               } else {
2254f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(D, mat));
2255f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(C, mat + 1));
2256f1580f4eSBarry Smith               }
2257f1580f4eSBarry Smith               PetscCall(MatAXPY(mat[0], 1.0, mat[1], SUBSET_NONZERO_PATTERN));
2258f1580f4eSBarry Smith             }
2259f1580f4eSBarry Smith             PetscCall(MatPropagateSymmetryOptions(C, D));
2260f1580f4eSBarry Smith             PetscCall(MatDestroy(&C));
2261f1580f4eSBarry Smith             C = D;
2262f1580f4eSBarry Smith             /* swap pointers so that variables stay consistent throughout PCSetUp() */
2263f1580f4eSBarry Smith             std::swap(C, data->aux);
2264f1580f4eSBarry Smith             std::swap(uis, data->is);
2265f1580f4eSBarry Smith             swap = PETSC_TRUE;
2266f1580f4eSBarry Smith           }
2267f1580f4eSBarry Smith         }
226813044ca3SPierre Jolivet       }
226913044ca3SPierre Jolivet       if (ctx) {
227013044ca3SPierre Jolivet         PC_HPDDM              *data_00 = (PC_HPDDM *)std::get<0>(*ctx)[0]->data;
227113044ca3SPierre Jolivet         PC                     s;
227200b491fbSPierre Jolivet         Mat                    A00, P00, A01 = nullptr, A10, A11, N, b[4];
227313044ca3SPierre Jolivet         IS                     sorted, is[2];
227413044ca3SPierre Jolivet         MatSolverType          type;
227513044ca3SPierre Jolivet         std::pair<PC, Vec[2]> *p;
227613044ca3SPierre Jolivet 
227713044ca3SPierre Jolivet         PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, data->aux, &C, nullptr)); /* permute since PCASM works with a sorted IS */
227813044ca3SPierre Jolivet         std::swap(C, data->aux);
227913044ca3SPierre Jolivet         std::swap(uis, data->is);
228013044ca3SPierre Jolivet         swap = PETSC_TRUE;
228113044ca3SPierre Jolivet         PetscCall(PCASMSetType(data->levels[0]->pc, PC_ASM_NONE)); /* "Neumann--Neumann" preconditioning with overlap and a Boolean partition of unity */
228213044ca3SPierre Jolivet         PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &data->is, &loc));
228313044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(data->levels[0]->pc)); /* action of eq. (15) of https://hal.science/hal-02343808v6/document (with a sign flip) */
228413044ca3SPierre Jolivet         PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, std::get<1>(*ctx), &A10, &A11));
228513044ca3SPierre Jolivet         std::get<1>(*ctx)[1] = A10;
228613044ca3SPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
228713044ca3SPierre Jolivet         if (flg) PetscCall(MatTransposeGetMat(A10, &A01));
228813044ca3SPierre Jolivet         else {
228913044ca3SPierre Jolivet           PetscBool flg;
229013044ca3SPierre Jolivet 
229113044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
229213044ca3SPierre Jolivet           if (flg) PetscCall(MatHermitianTransposeGetMat(A10, &A01));
229313044ca3SPierre Jolivet         }
229413044ca3SPierre Jolivet         PetscCall(ISDuplicate(data_00->is, &sorted)); /* during setup of the PC associated to the A00 block, this IS has already been sorted, but it's put back to its original state at the end of PCSetUp_HPDDM(), which may be unsorted */
229513044ca3SPierre Jolivet         PetscCall(ISSort(sorted));                    /* this is to avoid changing users inputs, but it requires a new call to ISSort() here                                                                                               */
229600b491fbSPierre Jolivet         if (!A01) {
229700b491fbSPierre Jolivet           PetscCall(MatSetOption(A10, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
229800b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A10, 1, &data->is, &sorted, MAT_INITIAL_MATRIX, &sub));
229900b491fbSPierre Jolivet           b[2] = sub[0];
230000b491fbSPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
230100b491fbSPierre Jolivet           PetscCall(MatDestroySubMatrices(1, &sub));
230200b491fbSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATTRANSPOSEVIRTUAL, &flg));
230300b491fbSPierre Jolivet           A10 = nullptr;
230400b491fbSPierre Jolivet           if (flg) PetscCall(MatTransposeGetMat(std::get<1>(*ctx)[0], &A10));
230513044ca3SPierre Jolivet           else {
230600b491fbSPierre Jolivet             PetscBool flg;
230700b491fbSPierre Jolivet 
230800b491fbSPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)(PetscObject)std::get<1>(*ctx)[0], MATHERMITIANTRANSPOSEVIRTUAL, &flg));
230900b491fbSPierre Jolivet             if (flg) PetscCall(MatHermitianTransposeGetMat(std::get<1>(*ctx)[0], &A10));
231013044ca3SPierre Jolivet           }
231100b491fbSPierre Jolivet           if (!A10) {
231200b491fbSPierre Jolivet             PetscCall(MatCreateSubMatrices(std::get<1>(*ctx)[0], 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
231300b491fbSPierre Jolivet             b[1] = sub[0];
231400b491fbSPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)sub[0]));
231500b491fbSPierre Jolivet           }
231600b491fbSPierre Jolivet         } else {
231700b491fbSPierre Jolivet           PetscCall(MatSetOption(A01, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
231800b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A01, 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
231900b491fbSPierre Jolivet           if (flg) PetscCall(MatTranspose(*sub, MAT_INITIAL_MATRIX, b + 2));
232000b491fbSPierre Jolivet           else PetscCall(MatHermitianTranspose(*sub, MAT_INITIAL_MATRIX, b + 2));
232100b491fbSPierre Jolivet         }
232200b491fbSPierre Jolivet         PetscCall(MatDestroySubMatrices(1, &sub));
232313044ca3SPierre Jolivet         PetscCall(ISDestroy(&sorted));
232413044ca3SPierre Jolivet         n = -1;
232513044ca3SPierre Jolivet         PetscTryMethod(data_00->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data_00->levels[0]->pc, &n, nullptr, &ksp));
232613044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
232713044ca3SPierre Jolivet         PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
232813044ca3SPierre Jolivet         PetscCall(ISGetLocalSize(data_00->is, &n));
232913044ca3SPierre Jolivet         PetscCheck(n == subA[0]->rmap->n && n == subA[0]->cmap->n, PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition geneo and -%spc_hpddm_define_subdomains false", pcpre ? pcpre : "", ((PetscObject)pc)->prefix);
233000b491fbSPierre Jolivet         if (A01 || A10) {
233100b491fbSPierre Jolivet           if (flg) PetscCall(MatTranspose(b[2], MAT_INITIAL_MATRIX, b + 1));
233200b491fbSPierre Jolivet           else PetscCall(MatHermitianTranspose(b[2], MAT_INITIAL_MATRIX, b + 1));
233300b491fbSPierre Jolivet         }
233400b491fbSPierre Jolivet         PetscCall(MatCreateSchurComplement(subA[0], subA[1], b[1], b[2], data->aux, &S));
233513044ca3SPierre Jolivet         PetscCall(MatSchurComplementSetKSP(S, ksp[0]));
233613044ca3SPierre Jolivet         PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, S, PETSC_TRUE)); /* the subdomain Mat is already known and the input IS of PCASMSetLocalSubdomains() is already sorted */
233713044ca3SPierre Jolivet         PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
233813044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
233913044ca3SPierre Jolivet         PetscCall(KSPGetPC(ksp[0], &inner));
234013044ca3SPierre Jolivet         PetscCall(PCSetType(inner, PCSHELL)); /* compute the action of the inverse of the local Schur complement with a PCSHELL */
234113044ca3SPierre Jolivet         b[0] = subA[0];
234213044ca3SPierre Jolivet         b[3] = data->aux;
234313044ca3SPierre Jolivet         PetscCall(MatCreateNest(PETSC_COMM_SELF, 2, nullptr, 2, nullptr, b, &N)); /* instead of computing inv(A11 - A10 inv(A00) A01), compute inv([A00, A01; A10, A11]) followed by a partial solution associated to the A11 block */
234400b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[1]));
234500b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[2]));
234613044ca3SPierre Jolivet         PetscCall(PCCreate(PETSC_COMM_SELF, &s));
234713044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(s, ((PetscObject)inner)->prefix));
234813044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(inner, nullptr));
234913044ca3SPierre Jolivet         PetscCall(KSPSetSkipPCSetFromOptions(ksp[0], PETSC_TRUE));
235013044ca3SPierre Jolivet         PetscCall(PCSetType(s, PCLU));
235113044ca3SPierre Jolivet         if (PetscDefined(HAVE_MUMPS)) { /* only MATSOLVERMUMPS handles MATNEST, so for the others, e.g., MATSOLVERPETSC or MATSOLVERMKL_PARDISO, convert to plain MATAIJ */
235213044ca3SPierre Jolivet           PetscCall(PCFactorSetMatSolverType(s, MATSOLVERMUMPS));
235313044ca3SPierre Jolivet         }
235413044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(s));
235513044ca3SPierre Jolivet         PetscCall(PCFactorGetMatSolverType(s, &type));
235613044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
235713044ca3SPierre Jolivet         if (flg) {
235813044ca3SPierre Jolivet           PetscCall(PCSetOperators(s, N, N));
235900b491fbSPierre Jolivet           PetscCall(PCFactorGetMatrix(s, b));
236000b491fbSPierre Jolivet           PetscCall(MatSetOptionsPrefix(*b, ((PetscObject)s)->prefix));
236124ddd604SPierre Jolivet           n = -1;
236224ddd604SPierre Jolivet           PetscCall(PetscOptionsGetInt(nullptr, ((PetscObject)s)->prefix, "-mat_mumps_icntl_26", &n, nullptr));
2363f45b553cSPierre Jolivet           if (n == 1) {                                /* allocates a square MatDense of size is[1]->map->n, so one */
2364f45b553cSPierre Jolivet             PetscCall(MatNestGetISs(N, is, nullptr));  /*  needs to be able to deactivate this path when dealing    */
2365f45b553cSPierre Jolivet             PetscCall(MatFactorSetSchurIS(*b, is[1])); /*  with a large constraint space in order to avoid OOM      */
2366f45b553cSPierre Jolivet           }
236713044ca3SPierre Jolivet         } else {
236800b491fbSPierre Jolivet           PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, b));
236900b491fbSPierre Jolivet           PetscCall(PCSetOperators(s, N, *b));
237000b491fbSPierre Jolivet           PetscCall(PetscObjectDereference((PetscObject)*b));
237100b491fbSPierre Jolivet           PetscCall(PCFactorGetMatrix(s, b)); /* MATSOLVERMKL_PARDISO cannot compute in PETSc (yet) a partial solution associated to the A11 block, only partial solution associated to the A00 block or full solution */
237213044ca3SPierre Jolivet         }
237313044ca3SPierre Jolivet         PetscCall(PetscNew(&p));
237413044ca3SPierre Jolivet         p->first = s;
237500b491fbSPierre Jolivet         PetscCall(MatCreateVecs(*b, p->second, p->second + 1));
237613044ca3SPierre Jolivet         PetscCall(PCShellSetContext(inner, p));
237713044ca3SPierre Jolivet         PetscCall(PCShellSetApply(inner, PCApply_Nest));
237813044ca3SPierre Jolivet         PetscCall(PCShellSetView(inner, PCView_Nest));
237913044ca3SPierre Jolivet         PetscCall(PCShellSetDestroy(inner, PCDestroy_Nest));
238013044ca3SPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)N));
238113044ca3SPierre Jolivet       }
2382f1580f4eSBarry Smith       if (!data->levels[0]->scatter) {
2383db4a47b3SPierre Jolivet         PetscCall(MatCreateVecs(P, &xin, nullptr));
2384f1580f4eSBarry Smith         if (ismatis) PetscCall(MatDestroy(&P));
2385db4a47b3SPierre Jolivet         PetscCall(VecScatterCreate(xin, data->is, data->levels[0]->D, nullptr, &data->levels[0]->scatter));
2386f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
2387f1580f4eSBarry Smith       }
2388f1580f4eSBarry Smith       if (data->levels[0]->P) {
2389f1580f4eSBarry Smith         /* if the pattern is the same and PCSetUp() has previously succeeded, reuse HPDDM buffers and connectivity */
2390f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[0], pc->setupcalled < 1 || pc->flag == DIFFERENT_NONZERO_PATTERN ? PETSC_TRUE : PETSC_FALSE));
2391f1580f4eSBarry Smith       }
2392f1580f4eSBarry Smith       if (!data->levels[0]->P) data->levels[0]->P = new HPDDM::Schwarz<PetscScalar>();
2393db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2394db4a47b3SPierre Jolivet       else PetscCall(PetscLogEventBegin(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2395f1580f4eSBarry Smith       /* HPDDM internal data structure */
239613044ca3SPierre Jolivet       PetscCall(data->levels[0]->P->structure(loc, data->is, !ctx ? sub[0] : nullptr, ismatis ? C : data->aux, data->levels));
2397db4a47b3SPierre Jolivet       if (!data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2398f1580f4eSBarry Smith       /* matrix pencil of the generalized eigenvalue problem on the overlap (GenEO) */
239913044ca3SPierre Jolivet       if (!ctx) {
24009bb5c669SPierre Jolivet         if (data->deflation || overlap != -1) weighted = data->aux;
2401f1580f4eSBarry Smith         else if (!data->B) {
2402e2b46ddfSPierre Jolivet           PetscBool cmp;
2403f1580f4eSBarry Smith           PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &weighted));
2404e2b46ddfSPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)weighted, &cmp, MATNORMAL, MATNORMALHERMITIAN, ""));
2405e2b46ddfSPierre Jolivet           if (cmp) flg = PETSC_FALSE;
2406e2b46ddfSPierre Jolivet           PetscCall(MatDiagonalScale(weighted, data->levels[0]->D, data->levels[0]->D));
24075b0bb9f2SPierre Jolivet           /* neither MatDuplicate() nor MatDiagonalScale() handles the symmetry options, so propagate the options explicitly */
2408f1580f4eSBarry Smith           /* only useful for -mat_type baij -pc_hpddm_levels_1_st_pc_type cholesky (no problem with MATAIJ or MATSBAIJ)      */
2409f1580f4eSBarry Smith           PetscCall(MatPropagateSymmetryOptions(sub[0], weighted));
2410f1580f4eSBarry Smith         } else weighted = data->B;
241113044ca3SPierre Jolivet       } else weighted = nullptr;
2412f1580f4eSBarry Smith       /* SLEPc is used inside the loaded symbol */
24139bb5c669SPierre Jolivet       PetscCall((*loadedSym)(data->levels[0]->P, data->is, ismatis ? C : (algebraic && !block && overlap == -1 ? sub[0] : (!ctx ? data->aux : S)), weighted, data->B, initial, data->levels));
24149bb5c669SPierre Jolivet       if (!ctx && data->share && overlap == -1) {
2415f1580f4eSBarry Smith         Mat st[2];
2416f1580f4eSBarry Smith         PetscCall(KSPGetOperators(ksp[0], st, st + 1));
24175c7345deSPierre Jolivet         PetscCall(MatCopy(subA[0], st[0], structure));
2418f1580f4eSBarry Smith         if (subA[1] != subA[0] || st[1] != st[0]) PetscCall(MatCopy(subA[1], st[1], SAME_NONZERO_PATTERN));
2419f1580f4eSBarry Smith       }
2420db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2421f1580f4eSBarry Smith       if (ismatis) PetscCall(MatISGetLocalMat(C, &N));
2422f1580f4eSBarry Smith       else N = data->aux;
242313044ca3SPierre Jolivet       if (!ctx) P = sub[0];
242413044ca3SPierre Jolivet       else P = S;
2425f1580f4eSBarry Smith       /* going through the grid hierarchy */
2426f1580f4eSBarry Smith       for (n = 1; n < data->N; ++n) {
2427db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2428f1580f4eSBarry Smith         /* method composed in the loaded symbol since there, SLEPc is used as well */
2429f1580f4eSBarry 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));
2430db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2431f1580f4eSBarry Smith       }
2432f1580f4eSBarry Smith       /* reset to NULL to avoid any faulty use */
2433db4a47b3SPierre Jolivet       PetscCall(PetscObjectComposeFunction((PetscObject)data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", nullptr));
2434db4a47b3SPierre Jolivet       if (!ismatis) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_C", nullptr));
2435f1580f4eSBarry Smith       else PetscCall(PetscObjectDereference((PetscObject)C)); /* matching PetscObjectReference() above */
2436f1580f4eSBarry Smith       for (n = 0; n < data->N - 1; ++n)
2437f1580f4eSBarry Smith         if (data->levels[n]->P) {
2438f1580f4eSBarry Smith           /* HPDDM internal work buffers */
2439f1580f4eSBarry Smith           data->levels[n]->P->setBuffer();
2440f1580f4eSBarry Smith           data->levels[n]->P->super::start();
2441f1580f4eSBarry Smith         }
24429bb5c669SPierre Jolivet       if (ismatis || !subdomains) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
2443db4a47b3SPierre Jolivet       if (ismatis) data->is = nullptr;
2444f1580f4eSBarry Smith       for (n = 0; n < data->N - 1 + (reused > 0); ++n) {
2445f1580f4eSBarry Smith         if (data->levels[n]->P) {
2446f1580f4eSBarry Smith           PC spc;
2447f1580f4eSBarry Smith 
2448f1580f4eSBarry Smith           /* force the PC to be PCSHELL to do the coarse grid corrections */
2449f1580f4eSBarry Smith           PetscCall(KSPSetSkipPCSetFromOptions(data->levels[n]->ksp, PETSC_TRUE));
2450f1580f4eSBarry Smith           PetscCall(KSPGetPC(data->levels[n]->ksp, &spc));
2451f1580f4eSBarry Smith           PetscCall(PCSetType(spc, PCSHELL));
2452f1580f4eSBarry Smith           PetscCall(PCShellSetContext(spc, data->levels[n]));
2453f1580f4eSBarry Smith           PetscCall(PCShellSetSetUp(spc, PCSetUp_HPDDMShell));
2454f1580f4eSBarry Smith           PetscCall(PCShellSetApply(spc, PCApply_HPDDMShell));
2455f1580f4eSBarry Smith           PetscCall(PCShellSetMatApply(spc, PCMatApply_HPDDMShell));
245613044ca3SPierre Jolivet           if (ctx && n == 0) {
245713044ca3SPierre Jolivet             Mat                                  Amat, Pmat;
245813044ca3SPierre Jolivet             PetscInt                             m, M;
245913044ca3SPierre Jolivet             std::tuple<Mat, VecScatter, Vec[2]> *ctx;
246013044ca3SPierre Jolivet 
246113044ca3SPierre Jolivet             PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &Pmat));
246213044ca3SPierre Jolivet             PetscCall(MatGetLocalSize(Pmat, &m, nullptr));
246313044ca3SPierre Jolivet             PetscCall(MatGetSize(Pmat, &M, nullptr));
246413044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));
246513044ca3SPierre Jolivet             std::get<0>(*ctx) = S;
246613044ca3SPierre Jolivet             std::get<1>(*ctx) = data->levels[n]->scatter;
246713044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)data->levels[n]->ksp), m, m, M, M, ctx, &Amat));
246813044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT, (void (*)(void))MatMult_Schur<false>));
246913044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMult_Schur<true>));
247013044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_DESTROY, (void (*)(void))MatDestroy_Schur));
247113044ca3SPierre Jolivet             PetscCall(MatCreateVecs(S, std::get<2>(*ctx), std::get<2>(*ctx) + 1));
247213044ca3SPierre Jolivet             PetscCall(KSPSetOperators(data->levels[n]->ksp, Amat, Pmat));
247313044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)Amat));
247413044ca3SPierre Jolivet           }
2475f1580f4eSBarry Smith           PetscCall(PCShellSetDestroy(spc, PCDestroy_HPDDMShell));
2476f1580f4eSBarry Smith           if (!data->levels[n]->pc) PetscCall(PCCreate(PetscObjectComm((PetscObject)data->levels[n]->ksp), &data->levels[n]->pc));
2477f1580f4eSBarry Smith           if (n < reused) {
2478f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(spc, PETSC_TRUE));
2479f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
2480f1580f4eSBarry Smith           }
2481f1580f4eSBarry Smith           PetscCall(PCSetUp(spc));
2482f1580f4eSBarry Smith         }
2483f1580f4eSBarry Smith       }
248413044ca3SPierre Jolivet       if (ctx) PetscCall(MatDestroy(&S));
24859bb5c669SPierre Jolivet       if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", nullptr));
2486f1580f4eSBarry Smith     } else flg = reused ? PETSC_FALSE : PETSC_TRUE;
2487f1580f4eSBarry Smith     if (!ismatis && subdomains) {
2488f1580f4eSBarry Smith       if (flg) PetscCall(KSPGetPC(data->levels[0]->ksp, &inner));
2489f1580f4eSBarry Smith       else inner = data->levels[0]->pc;
2490f1580f4eSBarry Smith       if (inner) {
2491398c7888SPierre Jolivet         if (!inner->setupcalled) PetscCall(PCSetType(inner, PCASM));
2492398c7888SPierre Jolivet         PetscCall(PCSetFromOptions(inner));
2493398c7888SPierre Jolivet         PetscCall(PetscStrcmp(((PetscObject)inner)->type_name, PCASM, &flg));
2494398c7888SPierre Jolivet         if (flg) {
2495f1580f4eSBarry Smith           if (!inner->setupcalled) { /* evaluates to PETSC_FALSE when -pc_hpddm_block_splitting */
2496398c7888SPierre Jolivet             IS sorted;               /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2497398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2498398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(inner, 1, &sorted, &loc));
2499398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2500398c7888SPierre Jolivet           }
2501c8ea6600SPierre Jolivet           if (!PetscBool3ToBool(data->Neumann) && data->N > 1) { /* subdomain matrices are already created for the eigenproblem, reuse them for the fine-level PC */
2502db4a47b3SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(*is, nullptr, nullptr, sub[0], &P, nullptr));
2503398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(inner, P, algebraic));
2504398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)P));
2505f1580f4eSBarry Smith           }
2506f1580f4eSBarry Smith         }
2507f1580f4eSBarry Smith       }
25089bb5c669SPierre Jolivet       if (data->N > 1) {
25099bb5c669SPierre Jolivet         if (overlap != 1) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
25109bb5c669SPierre Jolivet         if (overlap == 1) PetscCall(MatDestroy(subA));
25119bb5c669SPierre Jolivet       }
2512f1580f4eSBarry Smith     }
2513f1580f4eSBarry Smith     PetscCall(ISDestroy(&loc));
2514f1580f4eSBarry Smith   } else data->N = 1 + reused; /* enforce this value to 1 + reused if there is no way to build another level */
2515f1580f4eSBarry Smith   if (requested != data->N + reused) {
2516f1580f4eSBarry 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,
2517f1580f4eSBarry Smith                         data->N, pcpre ? pcpre : ""));
2518f1580f4eSBarry 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));
2519f1580f4eSBarry Smith     /* cannot use PCDestroy_HPDDMShell() because PCSHELL not set for unassembled levels */
2520f1580f4eSBarry Smith     for (n = data->N - 1; n < requested - 1; ++n) {
2521f1580f4eSBarry Smith       if (data->levels[n]->P) {
2522f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[n], PETSC_TRUE));
2523f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(1, &data->levels[n]->v[0]));
2524f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(2, &data->levels[n]->v[1]));
2525f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V));
2526f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 1));
2527f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 2));
2528f1580f4eSBarry Smith         PetscCall(VecDestroy(&data->levels[n]->D));
2529f1580f4eSBarry Smith         PetscCall(VecScatterDestroy(&data->levels[n]->scatter));
2530f1580f4eSBarry Smith       }
2531f1580f4eSBarry Smith     }
2532f1580f4eSBarry Smith     if (reused) {
2533f1580f4eSBarry Smith       for (n = reused; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
2534f1580f4eSBarry Smith         PetscCall(KSPDestroy(&data->levels[n]->ksp));
2535f1580f4eSBarry Smith         PetscCall(PCDestroy(&data->levels[n]->pc));
2536f1580f4eSBarry Smith       }
2537f1580f4eSBarry Smith     }
2538f1580f4eSBarry 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,
2539f1580f4eSBarry Smith                data->N, reused, data->N, pcpre ? pcpre : "", pcpre ? pcpre : "", data->N);
2540f1580f4eSBarry Smith   }
2541f1580f4eSBarry Smith   /* these solvers are created after PCSetFromOptions() is called */
2542f1580f4eSBarry Smith   if (pc->setfromoptionscalled) {
2543f1580f4eSBarry Smith     for (n = 0; n < data->N; ++n) {
2544f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetFromOptions(data->levels[n]->ksp));
2545f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetFromOptions(data->levels[n]->pc));
2546f1580f4eSBarry Smith     }
2547f1580f4eSBarry Smith     pc->setfromoptionscalled = 0;
2548f1580f4eSBarry Smith   }
2549f1580f4eSBarry Smith   data->N += reused;
2550f1580f4eSBarry Smith   if (data->share && swap) {
2551f1580f4eSBarry Smith     /* swap back pointers so that variables follow the user-provided numbering */
2552f1580f4eSBarry Smith     std::swap(C, data->aux);
2553f1580f4eSBarry Smith     std::swap(uis, data->is);
2554f1580f4eSBarry Smith     PetscCall(MatDestroy(&C));
2555f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
2556f1580f4eSBarry Smith   }
2557398c7888SPierre Jolivet   if (algebraic) PetscCall(MatDestroy(&data->aux));
255838fb34a1SPierre Jolivet   if (unsorted && unsorted != is[0]) {
2559398c7888SPierre Jolivet     PetscCall(ISCopy(unsorted, data->is));
2560398c7888SPierre Jolivet     PetscCall(ISDestroy(&unsorted));
2561398c7888SPierre Jolivet   }
2562398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2563398c7888SPierre 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);
2564398c7888SPierre Jolivet   if (data->is) {
2565398c7888SPierre Jolivet     PetscCall(ISEqualUnsorted(data->is, dis, &flg));
2566398c7888SPierre Jolivet     PetscCall(ISDestroy(&dis));
2567398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input IS and output IS are not equal");
2568398c7888SPierre Jolivet   }
2569398c7888SPierre 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);
2570398c7888SPierre Jolivet   if (data->aux) {
2571398c7888SPierre Jolivet     PetscCall(MatMultEqual(data->aux, daux, 20, &flg));
2572398c7888SPierre Jolivet     PetscCall(MatDestroy(&daux));
2573398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input Mat and output Mat are not equal");
2574398c7888SPierre Jolivet   }
2575398c7888SPierre Jolivet #endif
25763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2577f1580f4eSBarry Smith }
2578f1580f4eSBarry Smith 
2579f1580f4eSBarry Smith /*@
2580f1580f4eSBarry Smith   PCHPDDMSetCoarseCorrectionType - Sets the coarse correction type.
2581f1580f4eSBarry Smith 
2582c3339decSBarry Smith   Collective
2583f1580f4eSBarry Smith 
2584f1580f4eSBarry Smith   Input Parameters:
2585f1580f4eSBarry Smith + pc   - preconditioner context
2586aa1539e9SPierre Jolivet - type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2587f1580f4eSBarry Smith 
2588f1580f4eSBarry Smith   Options Database Key:
2589aa1539e9SPierre Jolivet . -pc_hpddm_coarse_correction <deflated, additive, balanced, none> - type of coarse correction to apply
2590f1580f4eSBarry Smith 
2591f1580f4eSBarry Smith   Level: intermediate
2592f1580f4eSBarry Smith 
2593562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2594f1580f4eSBarry Smith @*/
2595d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType type)
2596d71ae5a4SJacob Faibussowitsch {
2597f1580f4eSBarry Smith   PetscFunctionBegin;
2598f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2599f1580f4eSBarry Smith   PetscValidLogicalCollectiveEnum(pc, type, 2);
2600f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMSetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType), (pc, type));
26013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2602f1580f4eSBarry Smith }
2603f1580f4eSBarry Smith 
2604f1580f4eSBarry Smith /*@
2605f1580f4eSBarry Smith   PCHPDDMGetCoarseCorrectionType - Gets the coarse correction type.
2606f1580f4eSBarry Smith 
2607f1580f4eSBarry Smith   Input Parameter:
2608f1580f4eSBarry Smith . pc - preconditioner context
2609f1580f4eSBarry Smith 
2610f1580f4eSBarry Smith   Output Parameter:
2611aa1539e9SPierre Jolivet . type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2612f1580f4eSBarry Smith 
2613f1580f4eSBarry Smith   Level: intermediate
2614f1580f4eSBarry Smith 
2615562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2616f1580f4eSBarry Smith @*/
2617d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType *type)
2618d71ae5a4SJacob Faibussowitsch {
2619f1580f4eSBarry Smith   PetscFunctionBegin;
2620f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2621f1580f4eSBarry Smith   if (type) {
26224f572ea9SToby Isaac     PetscAssertPointer(type, 2);
2623f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType *), (pc, type));
2624f1580f4eSBarry Smith   }
26253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2626f1580f4eSBarry Smith }
2627f1580f4eSBarry Smith 
2628d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType type)
2629d71ae5a4SJacob Faibussowitsch {
2630f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2631f1580f4eSBarry Smith 
2632f1580f4eSBarry Smith   PetscFunctionBegin;
2633f1580f4eSBarry Smith   data->correction = type;
26343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2635f1580f4eSBarry Smith }
2636f1580f4eSBarry Smith 
2637d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType *type)
2638d71ae5a4SJacob Faibussowitsch {
2639f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2640f1580f4eSBarry Smith 
2641f1580f4eSBarry Smith   PetscFunctionBegin;
2642f1580f4eSBarry Smith   *type = data->correction;
26433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2644f1580f4eSBarry Smith }
2645f1580f4eSBarry Smith 
2646f1580f4eSBarry Smith /*@
2647e31fc274SPierre Jolivet   PCHPDDMSetSTShareSubKSP - Sets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver should be shared.
2648e31fc274SPierre Jolivet 
2649e31fc274SPierre Jolivet   Input Parameters:
2650e31fc274SPierre Jolivet + pc    - preconditioner context
2651e31fc274SPierre Jolivet - share - whether the `KSP` should be shared or not
2652e31fc274SPierre Jolivet 
2653e31fc274SPierre Jolivet   Note:
2654e31fc274SPierre Jolivet   This is not the same as `PCSetReusePreconditioner()`. Given certain conditions (visible using -info), a symbolic factorization can be skipped
2655e31fc274SPierre Jolivet   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2656e31fc274SPierre Jolivet 
2657e31fc274SPierre Jolivet   Level: advanced
2658e31fc274SPierre Jolivet 
2659562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMGetSTShareSubKSP()`
2660e31fc274SPierre Jolivet @*/
2661e31fc274SPierre Jolivet PetscErrorCode PCHPDDMSetSTShareSubKSP(PC pc, PetscBool share)
2662e31fc274SPierre Jolivet {
2663e31fc274SPierre Jolivet   PetscFunctionBegin;
2664e31fc274SPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2665e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetSTShareSubKSP_C", (PC, PetscBool), (pc, share));
26663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2667e31fc274SPierre Jolivet }
2668e31fc274SPierre Jolivet 
2669e31fc274SPierre Jolivet /*@
2670f1580f4eSBarry Smith   PCHPDDMGetSTShareSubKSP - Gets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver is shared.
2671f1580f4eSBarry Smith 
2672f1580f4eSBarry Smith   Input Parameter:
2673f1580f4eSBarry Smith . pc - preconditioner context
2674f1580f4eSBarry Smith 
2675f1580f4eSBarry Smith   Output Parameter:
2676f1580f4eSBarry Smith . share - whether the `KSP` is shared or not
2677f1580f4eSBarry Smith 
2678f1580f4eSBarry Smith   Note:
2679f1580f4eSBarry 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
2680f1580f4eSBarry Smith   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2681f1580f4eSBarry Smith 
2682f1580f4eSBarry Smith   Level: advanced
2683f1580f4eSBarry Smith 
2684562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetSTShareSubKSP()`
2685f1580f4eSBarry Smith @*/
2686d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetSTShareSubKSP(PC pc, PetscBool *share)
2687d71ae5a4SJacob Faibussowitsch {
2688f1580f4eSBarry Smith   PetscFunctionBegin;
2689f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2690f1580f4eSBarry Smith   if (share) {
26914f572ea9SToby Isaac     PetscAssertPointer(share, 2);
2692f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetSTShareSubKSP_C", (PC, PetscBool *), (pc, share));
2693f1580f4eSBarry Smith   }
26943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2695f1580f4eSBarry Smith }
2696f1580f4eSBarry Smith 
2697e31fc274SPierre Jolivet static PetscErrorCode PCHPDDMSetSTShareSubKSP_HPDDM(PC pc, PetscBool share)
2698e31fc274SPierre Jolivet {
2699e31fc274SPierre Jolivet   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2700e31fc274SPierre Jolivet 
2701e31fc274SPierre Jolivet   PetscFunctionBegin;
2702e31fc274SPierre Jolivet   data->share = share;
27033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2704e31fc274SPierre Jolivet }
2705e31fc274SPierre Jolivet 
2706d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetSTShareSubKSP_HPDDM(PC pc, PetscBool *share)
2707d71ae5a4SJacob Faibussowitsch {
2708f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2709f1580f4eSBarry Smith 
2710f1580f4eSBarry Smith   PetscFunctionBegin;
2711f1580f4eSBarry Smith   *share = data->share;
27123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2713f1580f4eSBarry Smith }
2714f1580f4eSBarry Smith 
2715f1580f4eSBarry Smith /*@
2716f1580f4eSBarry Smith   PCHPDDMSetDeflationMat - Sets the deflation space used to assemble a coarser operator.
2717f1580f4eSBarry Smith 
2718f1580f4eSBarry Smith   Input Parameters:
2719f1580f4eSBarry Smith + pc - preconditioner context
2720f1580f4eSBarry Smith . is - index set of the local deflation matrix
2721f1580f4eSBarry Smith - U  - deflation sequential matrix stored as a `MATSEQDENSE`
2722f1580f4eSBarry Smith 
2723f1580f4eSBarry Smith   Level: advanced
2724f1580f4eSBarry Smith 
2725562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCDeflationSetSpace()`, `PCMGSetRestriction()`
2726f1580f4eSBarry Smith @*/
2727d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetDeflationMat(PC pc, IS is, Mat U)
2728d71ae5a4SJacob Faibussowitsch {
2729f1580f4eSBarry Smith   PetscFunctionBegin;
2730f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2731f1580f4eSBarry Smith   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
2732f1580f4eSBarry Smith   PetscValidHeaderSpecific(U, MAT_CLASSID, 3);
2733e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetDeflationMat_C", (PC, IS, Mat), (pc, is, U));
27343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2735f1580f4eSBarry Smith }
2736f1580f4eSBarry Smith 
2737d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetDeflationMat_HPDDM(PC pc, IS is, Mat U)
2738d71ae5a4SJacob Faibussowitsch {
2739f1580f4eSBarry Smith   PetscFunctionBegin;
2740f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, U, PETSC_TRUE));
27413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2742f1580f4eSBarry Smith }
2743f1580f4eSBarry Smith 
2744d71ae5a4SJacob Faibussowitsch PetscErrorCode HPDDMLoadDL_Private(PetscBool *found)
2745d71ae5a4SJacob Faibussowitsch {
2746605ad303SPierre Jolivet   PetscBool flg;
2747f1580f4eSBarry Smith   char      lib[PETSC_MAX_PATH_LEN], dlib[PETSC_MAX_PATH_LEN], dir[PETSC_MAX_PATH_LEN];
2748f1580f4eSBarry Smith 
2749f1580f4eSBarry Smith   PetscFunctionBegin;
27504f572ea9SToby Isaac   PetscAssertPointer(found, 1);
2751c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(dir, "${PETSC_LIB_DIR}", sizeof(dir)));
2752db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, nullptr, "-hpddm_dir", dir, sizeof(dir), nullptr));
2753f1580f4eSBarry Smith   PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2754f1580f4eSBarry Smith   PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2755605ad303SPierre Jolivet #if defined(SLEPC_LIB_DIR) /* this variable is passed during SLEPc ./configure when PETSc has not been configured   */
2756605ad303SPierre Jolivet   if (!*found) {           /* with --download-hpddm since slepcconf.h is not yet built (and thus can't be included) */
2757c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(dir, HPDDM_STR(SLEPC_LIB_DIR), sizeof(dir)));
2758f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2759f1580f4eSBarry Smith     PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2760f1580f4eSBarry Smith   }
2761f1580f4eSBarry Smith #endif
2762605ad303SPierre 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 */
2763605ad303SPierre Jolivet     PetscCall(PetscOptionsGetenv(PETSC_COMM_SELF, "SLEPC_DIR", dir, sizeof(dir), &flg));
2764605ad303SPierre 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 */
2765605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libslepc", dir));
2766605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2767605ad303SPierre Jolivet       PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found but SLEPC_DIR=%s", lib, dir);
2768605ad303SPierre Jolivet       PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
2769605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libhpddm_petsc", dir)); /* libhpddm_petsc is always in the same directory as libslepc */
2770605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2771605ad303SPierre Jolivet     }
2772605ad303SPierre Jolivet   }
2773f1580f4eSBarry Smith   PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found", lib);
2774f1580f4eSBarry Smith   PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
27753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2776f1580f4eSBarry Smith }
2777f1580f4eSBarry Smith 
2778f1580f4eSBarry Smith /*MC
2779f1580f4eSBarry Smith    PCHPDDM - Interface with the HPDDM library.
2780f1580f4eSBarry Smith 
27811d27aa22SBarry Smith    This `PC` may be used to build multilevel spectral domain decomposition methods based on the GenEO framework {cite}`spillane2011robust` {cite}`al2021multilevel`.
27821d27aa22SBarry Smith    It may be viewed as an alternative to spectral
27831d27aa22SBarry Smith    AMGe or `PCBDDC` with adaptive selection of constraints. The interface is explained in details in {cite}`jolivetromanzampini2020`
2784f1580f4eSBarry Smith 
2785*e7593814SPierre Jolivet    The matrix used for building the preconditioner (Pmat) may be unassembled (`MATIS`), assembled (`MATAIJ`, `MATBAIJ`, or `MATSBAIJ`), hierarchical (`MATHTOOL`), `MATNORMAL`, `MATNORMALHERMITIAN`, or `MATSCHURCOMPLEMENT` (when `PCHPDDM` is used as part of an outer `PCFIELDSPLIT`).
2786f1580f4eSBarry Smith 
2787f1580f4eSBarry Smith    For multilevel preconditioning, when using an assembled or hierarchical Pmat, one must provide an auxiliary local `Mat` (unassembled local operator for GenEO) using
2788f1580f4eSBarry Smith    `PCHPDDMSetAuxiliaryMat()`. Calling this routine is not needed when using a `MATIS` Pmat, assembly is done internally using `MatConvert()`.
2789f1580f4eSBarry Smith 
2790f1580f4eSBarry Smith    Options Database Keys:
2791f1580f4eSBarry Smith +   -pc_hpddm_define_subdomains <true, default=false>    - on the finest level, calls `PCASMSetLocalSubdomains()` with the `IS` supplied in `PCHPDDMSetAuxiliaryMat()`
2792f1580f4eSBarry Smith                                                          (not relevant with an unassembled Pmat)
2793f1580f4eSBarry Smith .   -pc_hpddm_has_neumann <true, default=false>          - on the finest level, informs the `PC` that the local Neumann matrix is supplied in `PCHPDDMSetAuxiliaryMat()`
2794f1580f4eSBarry Smith -   -pc_hpddm_coarse_correction <type, default=deflated> - determines the `PCHPDDMCoarseCorrectionType` when calling `PCApply()`
2795f1580f4eSBarry Smith 
279638bf2a8cSPierre Jolivet    Options for subdomain solvers, subdomain eigensolvers (for computing deflation vectors), and the coarse solver can be set using the following options database prefixes.
2797f1580f4eSBarry Smith .vb
2798f1580f4eSBarry Smith       -pc_hpddm_levels_%d_pc_
2799f1580f4eSBarry Smith       -pc_hpddm_levels_%d_ksp_
2800f1580f4eSBarry Smith       -pc_hpddm_levels_%d_eps_
2801f1580f4eSBarry Smith       -pc_hpddm_levels_%d_p
28024ec2a359SPierre Jolivet       -pc_hpddm_levels_%d_mat_type
2803f1580f4eSBarry Smith       -pc_hpddm_coarse_
2804f1580f4eSBarry Smith       -pc_hpddm_coarse_p
28054ec2a359SPierre Jolivet       -pc_hpddm_coarse_mat_type
28062ce66baaSPierre Jolivet       -pc_hpddm_coarse_mat_filter
2807f1580f4eSBarry Smith .ve
2808f1580f4eSBarry Smith 
280938bf2a8cSPierre 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
2810f1580f4eSBarry Smith     -pc_hpddm_coarse_p 2 -pc_hpddm_coarse_mat_type baij will use 10 deflation vectors per subdomain on the fine "level 1",
2811f1580f4eSBarry Smith     aggregate the fine subdomains into 4 "level 2" subdomains, then use 10 deflation vectors per subdomain on "level 2",
28127eb095acSPierre Jolivet     and assemble the coarse matrix (of dimension 4 x 10 = 40) on two processes as a `MATBAIJ` (default is `MATSBAIJ`).
2813f1580f4eSBarry Smith 
2814f1580f4eSBarry 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.
2815f1580f4eSBarry Smith 
28161d27aa22SBarry Smith    Level: intermediate
28171d27aa22SBarry Smith 
28181d27aa22SBarry Smith    Notes:
28191d27aa22SBarry Smith    This preconditioner requires that PETSc is built with SLEPc (``--download-slepc``).
28201d27aa22SBarry Smith 
28211d27aa22SBarry Smith    By default, the underlying concurrent eigenproblems
28221d27aa22SBarry Smith    are solved using SLEPc shift-and-invert spectral transformation. This is usually what gives the best performance for GenEO, cf.
28231d27aa22SBarry Smith    {cite}`spillane2011robust` {cite}`jolivet2013scalabledd`. As
282438bf2a8cSPierre 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
282538bf2a8cSPierre 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
282638bf2a8cSPierre Jolivet    SLEPc documentation since they are specific to `PCHPDDM`.
282738bf2a8cSPierre Jolivet .vb
282838bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_st_share_sub_ksp
282938bf2a8cSPierre Jolivet       -pc_hpddm_levels_%d_eps_threshold
283038bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_eps_use_inertia
283138bf2a8cSPierre Jolivet .ve
283238bf2a8cSPierre Jolivet 
283338bf2a8cSPierre Jolivet    The first option from the list only applies to the fine-level eigensolver, see `PCHPDDMSetSTShareSubKSP()`. The second option from the list is
283438bf2a8cSPierre Jolivet    used to filter eigenmodes retrieved after convergence of `EPSSolve()` at "level N" such that eigenvectors used to define a "level N+1" coarse
283538bf2a8cSPierre 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
283638bf2a8cSPierre 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
283738bf2a8cSPierre 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
283838bf2a8cSPierre Jolivet    to supply -pc_hpddm_levels_1_eps_nev. This last option also only applies to the fine-level (N = 1) eigensolver.
2839f1580f4eSBarry Smith 
28401d27aa22SBarry Smith    See also {cite}`dolean2015introduction`, {cite}`al2022robust`, {cite}`al2022robustpd`, and {cite}`nataf2022recent`
2841f1580f4eSBarry Smith 
2842562efe2eSBarry Smith .seealso: [](ch_ksp), `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetAuxiliaryMat()`, `MATIS`, `PCBDDC`, `PCDEFLATION`, `PCTELESCOPE`, `PCASM`,
2843e31fc274SPierre Jolivet           `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDMHasNeumannMat()`, `PCHPDDMSetRHSMat()`, `PCHPDDMSetDeflationMat()`, `PCHPDDMSetSTShareSubKSP()`,
2844e31fc274SPierre Jolivet           `PCHPDDMGetSTShareSubKSP()`, `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDMGetComplexities()`
2845f1580f4eSBarry Smith M*/
2846d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_HPDDM(PC pc)
2847d71ae5a4SJacob Faibussowitsch {
2848f1580f4eSBarry Smith   PC_HPDDM *data;
2849f1580f4eSBarry Smith   PetscBool found;
2850f1580f4eSBarry Smith 
2851f1580f4eSBarry Smith   PetscFunctionBegin;
2852f1580f4eSBarry Smith   if (!loadedSym) {
2853f1580f4eSBarry Smith     PetscCall(HPDDMLoadDL_Private(&found));
2854db4a47b3SPierre Jolivet     if (found) PetscCall(PetscDLLibrarySym(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, nullptr, "PCHPDDM_Internal", (void **)&loadedSym));
2855f1580f4eSBarry Smith   }
2856f1580f4eSBarry Smith   PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCHPDDM_Internal symbol not found in loaded libhpddm_petsc");
28574dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&data));
2858f1580f4eSBarry Smith   pc->data                = data;
2859c8ea6600SPierre Jolivet   data->Neumann           = PETSC_BOOL3_UNKNOWN;
2860f1580f4eSBarry Smith   pc->ops->reset          = PCReset_HPDDM;
2861f1580f4eSBarry Smith   pc->ops->destroy        = PCDestroy_HPDDM;
2862f1580f4eSBarry Smith   pc->ops->setfromoptions = PCSetFromOptions_HPDDM;
2863f1580f4eSBarry Smith   pc->ops->setup          = PCSetUp_HPDDM;
2864f1580f4eSBarry Smith   pc->ops->apply          = PCApply_HPDDM;
2865f1580f4eSBarry Smith   pc->ops->matapply       = PCMatApply_HPDDM;
2866f1580f4eSBarry Smith   pc->ops->view           = PCView_HPDDM;
2867f1580f4eSBarry Smith   pc->ops->presolve       = PCPreSolve_HPDDM;
2868f1580f4eSBarry Smith 
2869f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", PCHPDDMSetAuxiliaryMat_HPDDM));
2870f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", PCHPDDMHasNeumannMat_HPDDM));
2871f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", PCHPDDMSetRHSMat_HPDDM));
2872f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", PCHPDDMSetCoarseCorrectionType_HPDDM));
2873f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", PCHPDDMGetCoarseCorrectionType_HPDDM));
2874e31fc274SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", PCHPDDMSetSTShareSubKSP_HPDDM));
2875f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", PCHPDDMGetSTShareSubKSP_HPDDM));
2876f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", PCHPDDMSetDeflationMat_HPDDM));
28773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2878f1580f4eSBarry Smith }
2879f1580f4eSBarry Smith 
2880f1580f4eSBarry Smith /*@C
2881f1580f4eSBarry Smith   PCHPDDMInitializePackage - This function initializes everything in the `PCHPDDM` package. It is called from `PCInitializePackage()`.
2882f1580f4eSBarry Smith 
2883f1580f4eSBarry Smith   Level: developer
2884f1580f4eSBarry Smith 
2885562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscInitialize()`
2886f1580f4eSBarry Smith @*/
2887d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMInitializePackage(void)
2888d71ae5a4SJacob Faibussowitsch {
2889f1580f4eSBarry Smith   char     ename[32];
2890f1580f4eSBarry Smith   PetscInt i;
2891f1580f4eSBarry Smith 
2892f1580f4eSBarry Smith   PetscFunctionBegin;
28933ba16761SJacob Faibussowitsch   if (PCHPDDMPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
2894f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_TRUE;
2895f1580f4eSBarry Smith   PetscCall(PetscRegisterFinalize(PCHPDDMFinalizePackage));
2896f1580f4eSBarry Smith   /* general events registered once during package initialization */
2897f1580f4eSBarry Smith   /* some of these events are not triggered in libpetsc,          */
2898f1580f4eSBarry Smith   /* but rather directly in libhpddm_petsc,                       */
2899f1580f4eSBarry Smith   /* which is in charge of performing the following operations    */
2900f1580f4eSBarry Smith 
2901f1580f4eSBarry Smith   /* domain decomposition structure from Pmat sparsity pattern    */
2902f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMStrc", PC_CLASSID, &PC_HPDDM_Strc));
2903f1580f4eSBarry Smith   /* Galerkin product, redistribution, and setup (not triggered in libpetsc)                */
2904f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtAP", PC_CLASSID, &PC_HPDDM_PtAP));
2905f1580f4eSBarry Smith   /* Galerkin product with summation, redistribution, and setup (not triggered in libpetsc) */
2906f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtBP", PC_CLASSID, &PC_HPDDM_PtBP));
2907f1580f4eSBarry Smith   /* next level construction using PtAP and PtBP (not triggered in libpetsc)                */
2908f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMNext", PC_CLASSID, &PC_HPDDM_Next));
2909f1580f4eSBarry Smith   static_assert(PETSC_PCHPDDM_MAXLEVELS <= 9, "PETSC_PCHPDDM_MAXLEVELS value is too high");
2910f1580f4eSBarry Smith   for (i = 1; i < PETSC_PCHPDDM_MAXLEVELS; ++i) {
2911f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSetUp L%1" PetscInt_FMT, i));
2912f1580f4eSBarry Smith     /* events during a PCSetUp() at level #i _except_ the assembly */
2913f1580f4eSBarry Smith     /* of the Galerkin operator of the coarser level #(i + 1)      */
2914f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_SetUp[i - 1]));
2915f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSolve L%1" PetscInt_FMT, i));
2916f1580f4eSBarry Smith     /* events during a PCApply() at level #i _except_              */
2917f1580f4eSBarry Smith     /* the KSPSolve() of the coarser level #(i + 1)                */
2918f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_Solve[i - 1]));
2919f1580f4eSBarry Smith   }
29203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2921f1580f4eSBarry Smith }
2922f1580f4eSBarry Smith 
2923f1580f4eSBarry Smith /*@C
2924f1580f4eSBarry Smith   PCHPDDMFinalizePackage - This function frees everything from the `PCHPDDM` package. It is called from `PetscFinalize()`.
2925f1580f4eSBarry Smith 
2926f1580f4eSBarry Smith   Level: developer
2927f1580f4eSBarry Smith 
2928562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscFinalize()`
2929f1580f4eSBarry Smith @*/
2930d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMFinalizePackage(void)
2931d71ae5a4SJacob Faibussowitsch {
2932f1580f4eSBarry Smith   PetscFunctionBegin;
2933f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_FALSE;
29343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2935f1580f4eSBarry Smith }
29369bb5c669SPierre Jolivet 
29379bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat A, Vec x, Vec y)
29389bb5c669SPierre Jolivet {
29399bb5c669SPierre Jolivet   Harmonic h; /* [ A_00  A_01       ], furthermore, A_00 = [ A_loc,loc  A_loc,ovl ], thus, A_01 = [         ] */
29409bb5c669SPierre Jolivet               /* [ A_10  A_11  A_12 ]                      [ A_ovl,loc  A_ovl,ovl ]               [ A_ovl,1 ] */
29419bb5c669SPierre Jolivet   Vec sub;    /*  y = A x = R_loc R_0 [ A_00  A_01 ]^-1                                   R_loc = [  I_loc  ] */
29429bb5c669SPierre Jolivet               /*                      [ A_10  A_11 ]    R_1^T A_12 x                              [         ] */
29439bb5c669SPierre Jolivet   PetscFunctionBegin;
29449bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
29459bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
29469bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
29479bb5c669SPierre Jolivet   PetscCall(MatMult(h->A[0], x, sub));
29489bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
29499bb5c669SPierre Jolivet   PetscCall(KSPSolve(h->ksp, h->v, h->v));
29509bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_REVERSE, y));
29519bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
29529bb5c669SPierre Jolivet }
29539bb5c669SPierre Jolivet 
29549bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat A, Vec y, Vec x)
29559bb5c669SPierre Jolivet {
29569bb5c669SPierre Jolivet   Harmonic h;   /* x = A^T y =            [ A_00  A_01 ]^-T R_0^T R_loc^T y */
29579bb5c669SPierre Jolivet   Vec      sub; /*             A_12^T R_1 [ A_10  A_11 ]                    */
29589bb5c669SPierre Jolivet 
29599bb5c669SPierre Jolivet   PetscFunctionBegin;
29609bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
29619bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
29629bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_FORWARD, y));
29639bb5c669SPierre Jolivet   PetscCall(KSPSolveTranspose(h->ksp, h->v, h->v));
29649bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
29659bb5c669SPierre Jolivet   PetscCall(MatMultTranspose(h->A[0], sub, x));
29669bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
29679bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
29689bb5c669SPierre Jolivet }
29699bb5c669SPierre Jolivet 
29709bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat S, Mat X, Mat Y, void *)
29719bb5c669SPierre Jolivet {
29729bb5c669SPierre Jolivet   Harmonic h;
29739bb5c669SPierre Jolivet   Mat      A, B;
29749bb5c669SPierre Jolivet   Vec      a, b;
29759bb5c669SPierre Jolivet 
29769bb5c669SPierre Jolivet   PetscFunctionBegin;
29779bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
29789bb5c669SPierre Jolivet   PetscCall(MatMatMult(h->A[0], X, MAT_INITIAL_MATRIX, PETSC_DEFAULT, &A));
29799bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
29809bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
29819bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
29829bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B, i, &b));
29839bb5c669SPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_FORWARD, a));
29849bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B, i, &b));
29859bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
29869bb5c669SPierre Jolivet   }
29879bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
29889bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, B->cmap->n, nullptr, &A));
29899bb5c669SPierre Jolivet   PetscCall(KSPMatSolve(h->ksp, B, A));
29909bb5c669SPierre Jolivet   PetscCall(MatDestroy(&B));
29919bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
29929bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
29939bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &b));
29949bb5c669SPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_REVERSE, b));
29959bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &b));
29969bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
29979bb5c669SPierre Jolivet   }
29989bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
29999bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30009bb5c669SPierre Jolivet }
30019bb5c669SPierre Jolivet 
30029bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat A)
30039bb5c669SPierre Jolivet {
30049bb5c669SPierre Jolivet   Harmonic h;
30059bb5c669SPierre Jolivet 
30069bb5c669SPierre Jolivet   PetscFunctionBegin;
30079bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
30089bb5c669SPierre Jolivet   for (PetscInt i = 0; i < (h->A[1] ? 5 : 3); ++i) PetscCall(ISDestroy(h->is + i));
30099bb5c669SPierre Jolivet   PetscCall(PetscFree(h->is));
30109bb5c669SPierre Jolivet   PetscCall(VecDestroy(&h->v));
30119bb5c669SPierre Jolivet   for (PetscInt i = 0; i < 2; ++i) PetscCall(MatDestroy(h->A + i));
30129bb5c669SPierre Jolivet   PetscCall(PetscFree(h->A));
30139bb5c669SPierre Jolivet   PetscCall(KSPDestroy(&h->ksp));
30149bb5c669SPierre Jolivet   PetscCall(PetscFree(h));
30159bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30169bb5c669SPierre Jolivet }
3017