xref: /petsc/src/ksp/pc/impls/hpddm/pchpddm.cxx (revision 811e88878e168ca53963b3b121a7f4657108013d)
101e3c840SPierre Jolivet #include <petscsf.h>
213044ca3SPierre Jolivet #include <petsc/private/vecimpl.h>
3f1580f4eSBarry Smith #include <petsc/private/matimpl.h>
4f1580f4eSBarry Smith #include <petsc/private/petschpddm.h> /*I "petscpc.h" I*/
5e905f78bSJacob Faibussowitsch #include <petsc/private/pcimpl.h>
6e905f78bSJacob Faibussowitsch #include <petsc/private/dmimpl.h> /* this must be included after petschpddm.h so that DM_MAX_WORK_VECTORS is not defined  */
7f1580f4eSBarry Smith                                   /* otherwise, it is assumed that one is compiling libhpddm_petsc => circular dependency */
8f1580f4eSBarry Smith 
9db4a47b3SPierre Jolivet static PetscErrorCode (*loadedSym)(HPDDM::Schwarz<PetscScalar> *const, IS, Mat, Mat, Mat, std::vector<Vec>, PC_HPDDM_Level **const) = nullptr;
10f1580f4eSBarry Smith 
11f1580f4eSBarry Smith static PetscBool PCHPDDMPackageInitialized = PETSC_FALSE;
12f1580f4eSBarry Smith 
13f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_Strc;
14f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_PtAP;
15f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_PtBP;
16f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_Next;
17f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_SetUp[PETSC_PCHPDDM_MAXLEVELS];
18f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_Solve[PETSC_PCHPDDM_MAXLEVELS];
19f1580f4eSBarry Smith 
20aa1539e9SPierre Jolivet const char *const PCHPDDMCoarseCorrectionTypes[] = {"DEFLATED", "ADDITIVE", "BALANCED", "NONE", "PCHPDDMCoarseCorrectionType", "PC_HPDDM_COARSE_CORRECTION_", nullptr};
2113044ca3SPierre Jolivet const char *const PCHPDDMSchurPreTypes[]         = {"LEAST_SQUARES", "GENEO", "PCHPDDMSchurPreType", "PC_HPDDM_SCHUR_PRE", nullptr};
22f1580f4eSBarry Smith 
23d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_HPDDM(PC pc)
24d71ae5a4SJacob Faibussowitsch {
25f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
26f1580f4eSBarry Smith 
27f1580f4eSBarry Smith   PetscFunctionBegin;
28f1580f4eSBarry Smith   if (data->levels) {
29*811e8887SPierre Jolivet     for (PetscInt i = 0; i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]; ++i) {
30f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[i]->ksp));
31f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[i]->pc));
32f1580f4eSBarry Smith       PetscCall(PetscFree(data->levels[i]));
33f1580f4eSBarry Smith     }
34f1580f4eSBarry Smith     PetscCall(PetscFree(data->levels));
35f1580f4eSBarry Smith   }
36f1580f4eSBarry Smith   PetscCall(ISDestroy(&data->is));
37f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->aux));
38f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->B));
39f1580f4eSBarry Smith   PetscCall(VecDestroy(&data->normal));
40f1580f4eSBarry Smith   data->correction = PC_HPDDM_COARSE_CORRECTION_DEFLATED;
41c8ea6600SPierre Jolivet   data->Neumann    = PETSC_BOOL3_UNKNOWN;
42f1580f4eSBarry Smith   data->deflation  = PETSC_FALSE;
43db4a47b3SPierre Jolivet   data->setup      = nullptr;
44db4a47b3SPierre Jolivet   data->setup_ctx  = nullptr;
453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
46f1580f4eSBarry Smith }
47f1580f4eSBarry Smith 
48d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDM(PC pc)
49d71ae5a4SJacob Faibussowitsch {
50f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
51f1580f4eSBarry Smith 
52f1580f4eSBarry Smith   PetscFunctionBegin;
53f1580f4eSBarry Smith   PetscCall(PCReset_HPDDM(pc));
54f1580f4eSBarry Smith   PetscCall(PetscFree(data));
55db4a47b3SPierre Jolivet   PetscCall(PetscObjectChangeTypeName((PetscObject)pc, nullptr));
56db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", nullptr));
57db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", nullptr));
58db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", nullptr));
59db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", nullptr));
60db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", nullptr));
61db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", nullptr));
62db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", nullptr));
63db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", nullptr));
6413044ca3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc, "_PCHPDDM_Schur", nullptr));
653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
66f1580f4eSBarry Smith }
67f1580f4eSBarry Smith 
68d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMSetAuxiliaryMat_Private(PC pc, IS is, Mat A, PetscBool deflation)
69d71ae5a4SJacob Faibussowitsch {
70f1580f4eSBarry Smith   PC_HPDDM                   *data = (PC_HPDDM *)pc->data;
71cdbd50ebSPierre Jolivet   PCHPDDMCoarseCorrectionType type = data->correction;
72f1580f4eSBarry Smith 
73f1580f4eSBarry Smith   PetscFunctionBegin;
74f1580f4eSBarry Smith   if (is) {
75f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)is));
76f1580f4eSBarry Smith     if (data->is) { /* new overlap definition resets the PC */
77f1580f4eSBarry Smith       PetscCall(PCReset_HPDDM(pc));
78f1580f4eSBarry Smith       pc->setfromoptionscalled = 0;
79b853e353SPierre Jolivet       pc->setupcalled          = 0;
80cdbd50ebSPierre Jolivet       data->correction         = type;
81f1580f4eSBarry Smith     }
82f1580f4eSBarry Smith     PetscCall(ISDestroy(&data->is));
83f1580f4eSBarry Smith     data->is = is;
84f1580f4eSBarry Smith   }
85f1580f4eSBarry Smith   if (A) {
86f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)A));
87f1580f4eSBarry Smith     PetscCall(MatDestroy(&data->aux));
88f1580f4eSBarry Smith     data->aux = A;
89f1580f4eSBarry Smith   }
90f1580f4eSBarry Smith   data->deflation = deflation;
913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
92f1580f4eSBarry Smith }
93f1580f4eSBarry Smith 
943df4cd7bSPierre Jolivet static inline PetscErrorCode PCHPDDMSetAuxiliaryMatNormal_Private(PC pc, Mat A, Mat N, Mat *B, const char *pcpre, Vec *diagonal = nullptr)
95d71ae5a4SJacob Faibussowitsch {
96f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
97f1580f4eSBarry Smith   Mat      *splitting, *sub, aux;
983df4cd7bSPierre Jolivet   Vec       d;
99f1580f4eSBarry Smith   IS        is, cols[2], rows;
100f1580f4eSBarry Smith   PetscReal norm;
101f1580f4eSBarry Smith   PetscBool flg;
102f1580f4eSBarry Smith   char      type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
103f1580f4eSBarry Smith 
104f1580f4eSBarry Smith   PetscFunctionBegin;
105f1580f4eSBarry Smith   PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, B));
106f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, cols));
107f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->rmap->N, 0, 1, &rows));
108f1580f4eSBarry Smith   PetscCall(MatSetOption(A, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
109f1580f4eSBarry Smith   PetscCall(MatIncreaseOverlap(*B, 1, cols, 1));
110f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(A, 1, &rows, cols, MAT_INITIAL_MATRIX, &splitting));
111f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, &is));
112f1580f4eSBarry Smith   PetscCall(ISEmbed(*cols, is, PETSC_TRUE, cols + 1));
113f1580f4eSBarry Smith   PetscCall(ISDestroy(&is));
114f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(*splitting, 1, &rows, cols + 1, MAT_INITIAL_MATRIX, &sub));
115f1580f4eSBarry Smith   PetscCall(ISDestroy(cols + 1));
116f1580f4eSBarry Smith   PetscCall(MatFindZeroRows(*sub, &is));
117f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &sub));
118f1580f4eSBarry Smith   PetscCall(ISDestroy(&rows));
119f1580f4eSBarry Smith   PetscCall(MatSetOption(*splitting, MAT_KEEP_NONZERO_PATTERN, PETSC_TRUE));
120db4a47b3SPierre Jolivet   PetscCall(MatZeroRowsIS(*splitting, is, 0.0, nullptr, nullptr));
121f1580f4eSBarry Smith   PetscCall(ISDestroy(&is));
122db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_sub_pc_type", type, sizeof(type), nullptr));
123f1580f4eSBarry Smith   PetscCall(PetscStrcmp(type, PCQR, &flg));
124f1580f4eSBarry Smith   if (!flg) {
125f1580f4eSBarry Smith     Mat conjugate = *splitting;
126*811e8887SPierre Jolivet 
127f1580f4eSBarry Smith     if (PetscDefined(USE_COMPLEX)) {
128f1580f4eSBarry Smith       PetscCall(MatDuplicate(*splitting, MAT_COPY_VALUES, &conjugate));
129f1580f4eSBarry Smith       PetscCall(MatConjugate(conjugate));
130f1580f4eSBarry Smith     }
131fb842aefSJose E. Roman     PetscCall(MatTransposeMatMult(conjugate, *splitting, MAT_INITIAL_MATRIX, PETSC_DETERMINE, &aux));
132f1580f4eSBarry Smith     if (PetscDefined(USE_COMPLEX)) PetscCall(MatDestroy(&conjugate));
133f1580f4eSBarry Smith     PetscCall(MatNorm(aux, NORM_FROBENIUS, &norm));
134f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1353df4cd7bSPierre Jolivet     if (diagonal) {
136*811e8887SPierre Jolivet       PetscReal norm;
137*811e8887SPierre Jolivet 
1383df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1393df4cd7bSPierre Jolivet       if (norm > PETSC_SMALL) {
14001e3c840SPierre Jolivet         PetscSF  scatter;
1413df4cd7bSPierre Jolivet         PetscInt n;
142*811e8887SPierre Jolivet 
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));
14801e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&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;
157*811e8887SPierre Jolivet 
1583df4cd7bSPierre Jolivet     if (diagonal) {
1593df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1603df4cd7bSPierre Jolivet       PetscCheck(norm < PETSC_SMALL, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Nonzero diagonal A11 block");
1613df4cd7bSPierre Jolivet       PetscCall(VecDestroy(diagonal));
1623df4cd7bSPierre Jolivet     }
163f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)N, MATNORMAL, &flg));
164f1580f4eSBarry Smith     if (flg) PetscCall(MatCreateNormal(*splitting, &aux));
165f1580f4eSBarry Smith     else PetscCall(MatCreateNormalHermitian(*splitting, &aux));
166f1580f4eSBarry Smith   }
167f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &splitting));
168db4a47b3SPierre Jolivet   PetscCall(PCHPDDMSetAuxiliaryMat(pc, *cols, aux, nullptr, nullptr));
169c8ea6600SPierre Jolivet   data->Neumann = PETSC_BOOL3_TRUE;
170f1580f4eSBarry Smith   PetscCall(ISDestroy(cols));
171f1580f4eSBarry Smith   PetscCall(MatDestroy(&aux));
1723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
173f1580f4eSBarry Smith }
174f1580f4eSBarry Smith 
175d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetAuxiliaryMat_HPDDM(PC pc, IS is, Mat A, PetscErrorCode (*setup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *setup_ctx)
176d71ae5a4SJacob Faibussowitsch {
177f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
178f1580f4eSBarry Smith 
179f1580f4eSBarry Smith   PetscFunctionBegin;
180f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, A, PETSC_FALSE));
181f1580f4eSBarry Smith   if (setup) {
182f1580f4eSBarry Smith     data->setup     = setup;
183f1580f4eSBarry Smith     data->setup_ctx = setup_ctx;
184f1580f4eSBarry Smith   }
1853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
186f1580f4eSBarry Smith }
187f1580f4eSBarry Smith 
18873329a61SPierre Jolivet typedef struct {
18973329a61SPierre Jolivet   KSP      ksp;
19073329a61SPierre Jolivet   PetscInt its;
19173329a61SPierre Jolivet } PC_KSP;
19273329a61SPierre Jolivet 
19373329a61SPierre Jolivet static inline PetscErrorCode PCSetUp_KSP_Private(PC pc)
19473329a61SPierre Jolivet {
19573329a61SPierre Jolivet   PC_KSP           *data   = (PC_KSP *)pc->data;
19673329a61SPierre Jolivet   const std::string prefix = ((PetscObject)data->ksp)->prefix;
19773329a61SPierre Jolivet   std::string       sub;
19873329a61SPierre Jolivet 
19973329a61SPierre Jolivet   PetscFunctionBegin;
20073329a61SPierre 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_");
20173329a61SPierre Jolivet   sub = prefix.substr(0, prefix.size() - 9);
20273329a61SPierre Jolivet   PetscCall(PCSetType(pc, PCHPDDM));
20373329a61SPierre Jolivet   PetscCall(PCSetOptionsPrefix(pc, sub.c_str()));
20473329a61SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
20573329a61SPierre Jolivet }
20673329a61SPierre Jolivet 
20773329a61SPierre Jolivet static PetscErrorCode PCSetUp_KSP(PC pc)
20873329a61SPierre Jolivet {
20973329a61SPierre Jolivet   PetscFunctionBegin;
21073329a61SPierre Jolivet   PetscCall(PCSetUp_KSP_Private(pc));
21173329a61SPierre Jolivet   PetscCall(PCSetFromOptions(pc));
21273329a61SPierre Jolivet   PetscCall(PCSetUp(pc));
21373329a61SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
21473329a61SPierre Jolivet }
21573329a61SPierre Jolivet 
21670009435SPierre Jolivet /*@C
21704c3f3b8SBarry Smith   PCHPDDMSetAuxiliaryMat - Sets the auxiliary matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
218f1580f4eSBarry Smith 
219f1580f4eSBarry Smith   Input Parameters:
220f1580f4eSBarry Smith + pc    - preconditioner context
221f1580f4eSBarry Smith . is    - index set of the local auxiliary, e.g., Neumann, matrix
222f1580f4eSBarry Smith . A     - auxiliary sequential matrix
22304c3f3b8SBarry Smith . setup - function for generating the auxiliary matrix entries, may be `NULL`
22404c3f3b8SBarry Smith - ctx   - context for `setup`, may be `NULL`
22504c3f3b8SBarry Smith 
22604c3f3b8SBarry Smith   Calling sequence of `setup`:
22704c3f3b8SBarry Smith + J   - matrix whose values are to be set
22804c3f3b8SBarry Smith . t   - time
22904c3f3b8SBarry Smith . X   - linearization point
23004c3f3b8SBarry Smith . X_t - time-derivative of the linearization point
23104c3f3b8SBarry Smith . s   - step
23204c3f3b8SBarry Smith . ovl - index set of the local auxiliary, e.g., Neumann, matrix
23304c3f3b8SBarry Smith - ctx - context for `setup`, may be `NULL`
234f1580f4eSBarry Smith 
235f1580f4eSBarry Smith   Level: intermediate
236f1580f4eSBarry Smith 
23704c3f3b8SBarry Smith   Note:
23804c3f3b8SBarry Smith   As an example, in a finite element context with nonoverlapping subdomains plus (overlapping) ghost elements, this could be the unassembled (Neumann)
23904c3f3b8SBarry Smith   local overlapping operator. As opposed to the assembled (Dirichlet) local overlapping operator obtained by summing neighborhood contributions
24004c3f3b8SBarry Smith   at the interface of ghost elements.
24104c3f3b8SBarry Smith 
24270009435SPierre Jolivet   Fortran Notes:
24304c3f3b8SBarry Smith   Only `PETSC_NULL_FUNCTION` is supported for `setup` and `ctx` is never accessed
24470009435SPierre Jolivet 
245562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetRHSMat()`, `MATIS`
246f1580f4eSBarry Smith @*/
24704c3f3b8SBarry 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)
248d71ae5a4SJacob Faibussowitsch {
249f1580f4eSBarry Smith   PetscFunctionBegin;
250f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
251f1580f4eSBarry Smith   if (is) PetscValidHeaderSpecific(is, IS_CLASSID, 2);
252f1580f4eSBarry Smith   if (A) PetscValidHeaderSpecific(A, MAT_CLASSID, 3);
25373329a61SPierre Jolivet   if (pc->ops->setup == PCSetUp_KSP) PetscCall(PCSetUp_KSP_Private(pc));
25404c3f3b8SBarry Smith   PetscTryMethod(pc, "PCHPDDMSetAuxiliaryMat_C", (PC, IS, Mat, PetscErrorCode(*)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *), (pc, is, A, setup, ctx));
2553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
256f1580f4eSBarry Smith }
257f1580f4eSBarry Smith 
258d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMHasNeumannMat_HPDDM(PC pc, PetscBool has)
259d71ae5a4SJacob Faibussowitsch {
260f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
261f1580f4eSBarry Smith 
262f1580f4eSBarry Smith   PetscFunctionBegin;
263c8ea6600SPierre Jolivet   data->Neumann = PetscBoolToBool3(has);
2643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
265f1580f4eSBarry Smith }
266f1580f4eSBarry Smith 
267f1580f4eSBarry Smith /*@
268f1580f4eSBarry Smith   PCHPDDMHasNeumannMat - Informs `PCHPDDM` that the `Mat` passed to `PCHPDDMSetAuxiliaryMat()` is the local Neumann matrix.
269f1580f4eSBarry Smith 
270f1580f4eSBarry Smith   Input Parameters:
271f1580f4eSBarry Smith + pc  - preconditioner context
272f1580f4eSBarry Smith - has - Boolean value
273f1580f4eSBarry Smith 
274f1580f4eSBarry Smith   Level: intermediate
275f1580f4eSBarry Smith 
276f1580f4eSBarry Smith   Notes:
2777eb095acSPierre Jolivet   This may be used to bypass a call to `MatCreateSubMatrices()` and to `MatConvert()` for `MATSBAIJ` matrices.
278f1580f4eSBarry Smith 
279907a3e9cSStefano 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`.
280f1580f4eSBarry Smith 
281562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetAuxiliaryMat()`
282f1580f4eSBarry Smith @*/
283d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMHasNeumannMat(PC pc, PetscBool has)
284d71ae5a4SJacob Faibussowitsch {
285f1580f4eSBarry Smith   PetscFunctionBegin;
286f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
287f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMHasNeumannMat_C", (PC, PetscBool), (pc, has));
2883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
289f1580f4eSBarry Smith }
290f1580f4eSBarry Smith 
291d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetRHSMat_HPDDM(PC pc, Mat B)
292d71ae5a4SJacob Faibussowitsch {
293f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
294f1580f4eSBarry Smith 
295f1580f4eSBarry Smith   PetscFunctionBegin;
296f1580f4eSBarry Smith   PetscCall(PetscObjectReference((PetscObject)B));
297f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->B));
298f1580f4eSBarry Smith   data->B = B;
2993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
300f1580f4eSBarry Smith }
301f1580f4eSBarry Smith 
302f1580f4eSBarry Smith /*@
30304c3f3b8SBarry Smith   PCHPDDMSetRHSMat - Sets the right-hand side matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
304f1580f4eSBarry Smith 
305f1580f4eSBarry Smith   Input Parameters:
306f1580f4eSBarry Smith + pc - preconditioner context
307f1580f4eSBarry Smith - B  - right-hand side sequential matrix
308f1580f4eSBarry Smith 
309f1580f4eSBarry Smith   Level: advanced
310f1580f4eSBarry Smith 
31104c3f3b8SBarry Smith   Note:
31204c3f3b8SBarry Smith   Must be used in conjunction with `PCHPDDMSetAuxiliaryMat`(N), so that Nv = lambda Bv is solved using `EPSSetOperators`(N, B).
31304c3f3b8SBarry 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.
31404c3f3b8SBarry Smith 
315562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetAuxiliaryMat()`, `PCHPDDM`
316f1580f4eSBarry Smith @*/
317d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetRHSMat(PC pc, Mat B)
318d71ae5a4SJacob Faibussowitsch {
319f1580f4eSBarry Smith   PetscFunctionBegin;
320f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
321f1580f4eSBarry Smith   if (B) {
322f1580f4eSBarry Smith     PetscValidHeaderSpecific(B, MAT_CLASSID, 2);
323f1580f4eSBarry Smith     PetscTryMethod(pc, "PCHPDDMSetRHSMat_C", (PC, Mat), (pc, B));
324f1580f4eSBarry Smith   }
3253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
326f1580f4eSBarry Smith }
327f1580f4eSBarry Smith 
328d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_HPDDM(PC pc, PetscOptionItems *PetscOptionsObject)
329d71ae5a4SJacob Faibussowitsch {
330f1580f4eSBarry Smith   PC_HPDDM                   *data   = (PC_HPDDM *)pc->data;
331f1580f4eSBarry Smith   PC_HPDDM_Level            **levels = data->levels;
332f1580f4eSBarry Smith   char                        prefix[256];
333f1580f4eSBarry Smith   int                         i = 1;
334f1580f4eSBarry Smith   PetscMPIInt                 size, previous;
3359bb5c669SPierre Jolivet   PetscInt                    n, overlap = 1;
336f1580f4eSBarry Smith   PCHPDDMCoarseCorrectionType type;
337c8ea6600SPierre Jolivet   PetscBool                   flg = PETSC_TRUE, set;
338f1580f4eSBarry Smith 
339f1580f4eSBarry Smith   PetscFunctionBegin;
340f1580f4eSBarry Smith   if (!data->levels) {
341f1580f4eSBarry Smith     PetscCall(PetscCalloc1(PETSC_PCHPDDM_MAXLEVELS, &levels));
342f1580f4eSBarry Smith     data->levels = levels;
343f1580f4eSBarry Smith   }
344f1580f4eSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "PCHPDDM options");
3459bb5c669SPierre Jolivet   PetscCall(PetscOptionsBoundedInt("-pc_hpddm_harmonic_overlap", "Overlap prior to computing local harmonic extensions", "PCHPDDM", overlap, &overlap, &set, 1));
3469bb5c669SPierre Jolivet   if (!set) overlap = -1;
347f1580f4eSBarry Smith   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
348f1580f4eSBarry Smith   previous = size;
349f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS) {
350f1580f4eSBarry Smith     PetscInt p = 1;
351f1580f4eSBarry Smith 
3524dfa11a4SJacob Faibussowitsch     if (!data->levels[i - 1]) PetscCall(PetscNew(data->levels + i - 1));
353f1580f4eSBarry Smith     data->levels[i - 1]->parent = data;
354f1580f4eSBarry Smith     /* if the previous level has a single process, it is not possible to coarsen further */
355f1580f4eSBarry Smith     if (previous == 1 || !flg) break;
356f1580f4eSBarry Smith     data->levels[i - 1]->nu        = 0;
357f1580f4eSBarry Smith     data->levels[i - 1]->threshold = -1.0;
358f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
359db4a47b3SPierre 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));
360f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold", i));
361db4a47b3SPierre 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));
362f1580f4eSBarry Smith     if (i == 1) {
363aa1539e9SPierre 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");
3649bb5c669SPierre Jolivet       if (overlap != -1) {
3659bb5c669SPierre Jolivet         PetscInt nsv = 0;
366*811e8887SPierre Jolivet 
3679bb5c669SPierre Jolivet         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_nsv", i));
3689bb5c669SPierre Jolivet         PetscCall(PetscOptionsBoundedInt(prefix, "Local number of deflation vectors computed by SLEPc", "SVDSetDimensions", nsv, &nsv, nullptr, 0));
3699bb5c669SPierre 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");
3709bb5c669SPierre Jolivet         if (nsv) {
3719bb5c669SPierre Jolivet           data->levels[0]->nu = nsv;
3729bb5c669SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_relative_threshold", i));
3739bb5c669SPierre Jolivet         } else PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_relative_threshold", i));
3749bb5c669SPierre Jolivet         PetscCall(PetscOptionsReal(prefix, "Local relative threshold for selecting deflation vectors returned by SLEPc", "PCHPDDM", data->levels[0]->threshold, &data->levels[0]->threshold, nullptr));
3759bb5c669SPierre Jolivet       }
376f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_1_st_share_sub_ksp"));
377db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Shared KSP between SLEPc ST and the fine-level subdomain solver", "PCHPDDMSetSTShareSubKSP", PETSC_FALSE, &data->share, nullptr));
378f1580f4eSBarry Smith     }
379f1580f4eSBarry Smith     /* if there is no prescribed coarsening, just break out of the loop */
3800594bca0SPierre Jolivet     if (data->levels[i - 1]->threshold <= PetscReal() && data->levels[i - 1]->nu <= 0 && !(data->deflation && i == 1)) break;
381f1580f4eSBarry Smith     else {
382f1580f4eSBarry Smith       ++i;
383f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
384f1580f4eSBarry Smith       PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
385f1580f4eSBarry Smith       if (!flg) {
386f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold", i));
387f1580f4eSBarry Smith         PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
388f1580f4eSBarry Smith       }
389f1580f4eSBarry Smith       if (flg) {
390f1580f4eSBarry Smith         /* if there are coarsening options for the next level, then register it  */
391f1580f4eSBarry Smith         /* otherwise, don't to avoid having both options levels_N_p and coarse_p */
392f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_p", i));
393f1580f4eSBarry 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)));
394f1580f4eSBarry Smith         previous = p;
395f1580f4eSBarry Smith       }
396f1580f4eSBarry Smith     }
397f1580f4eSBarry Smith   }
398f1580f4eSBarry Smith   data->N = i;
399f1580f4eSBarry Smith   n       = 1;
400f1580f4eSBarry Smith   if (i > 1) {
401f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_coarse_p"));
402db4a47b3SPierre Jolivet     PetscCall(PetscOptionsRangeInt(prefix, "Number of processes used to assemble the coarsest operator", "PCHPDDM", n, &n, nullptr, 1, PetscMax(1, previous / 2)));
40302800ff6SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
404f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "pc_hpddm_coarse_"));
405db4a47b3SPierre Jolivet     PetscCall(PetscOptionsHasName(nullptr, prefix, "-mat_mumps_use_omp_threads", &flg));
406f1580f4eSBarry Smith     if (flg) {
407f1580f4eSBarry Smith       char type[64]; /* same size as in src/ksp/pc/impls/factor/factimpl.c */
408*811e8887SPierre Jolivet 
409c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(type, n > 1 && PetscDefined(HAVE_MUMPS) ? MATSOLVERMUMPS : MATSOLVERPETSC, sizeof(type))); /* default solver for a MatMPIAIJ or a MatSeqAIJ */
410db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetString(nullptr, prefix, "-pc_factor_mat_solver_type", type, sizeof(type), nullptr));
4113ce573a3SPierre Jolivet       PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
412f1580f4eSBarry 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);
413f1580f4eSBarry Smith       size = n;
414f1580f4eSBarry Smith       n    = -1;
415db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetInt(nullptr, prefix, "-mat_mumps_use_omp_threads", &n, nullptr));
416f1580f4eSBarry Smith       PetscCheck(n >= 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Need to specify a positive integer for -%smat_mumps_use_omp_threads", prefix);
417f1580f4eSBarry 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" : "");
418f1580f4eSBarry Smith     }
419f1580f4eSBarry Smith #endif
420f1580f4eSBarry Smith     PetscCall(PetscOptionsEnum("-pc_hpddm_coarse_correction", "Type of coarse correction applied each iteration", "PCHPDDMSetCoarseCorrectionType", PCHPDDMCoarseCorrectionTypes, (PetscEnum)data->correction, (PetscEnum *)&type, &flg));
421f1580f4eSBarry Smith     if (flg) PetscCall(PCHPDDMSetCoarseCorrectionType(pc, type));
422f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_has_neumann"));
423c8ea6600SPierre Jolivet     PetscCall(PetscOptionsBool(prefix, "Is the auxiliary Mat the local Neumann matrix?", "PCHPDDMHasNeumannMat", PetscBool3ToBool(data->Neumann), &flg, &set));
424c8ea6600SPierre Jolivet     if (set) data->Neumann = PetscBoolToBool3(flg);
425f1580f4eSBarry Smith     data->log_separate = PETSC_FALSE;
426f1580f4eSBarry Smith     if (PetscDefined(USE_LOG)) {
427f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_log_separate"));
428db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Log events level by level instead of inside PCSetUp()/KSPSolve()", nullptr, data->log_separate, &data->log_separate, nullptr));
429f1580f4eSBarry Smith     }
430f1580f4eSBarry Smith   }
431f1580f4eSBarry Smith   PetscOptionsHeadEnd();
432f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]) PetscCall(PetscFree(data->levels[i++]));
4333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
434f1580f4eSBarry Smith }
435f1580f4eSBarry Smith 
436d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDM(PC pc, Vec x, Vec y)
437d71ae5a4SJacob Faibussowitsch {
438f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
439f1580f4eSBarry Smith 
440f1580f4eSBarry Smith   PetscFunctionBegin;
441f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
442f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
443db4a47b3SPierre 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 */
444f1580f4eSBarry Smith   PetscCall(KSPSolve(data->levels[0]->ksp, x, y));
445db4a47b3SPierre Jolivet   if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
4463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
447f1580f4eSBarry Smith }
448f1580f4eSBarry Smith 
449d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDM(PC pc, Mat X, Mat Y)
450d71ae5a4SJacob Faibussowitsch {
451f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
452f1580f4eSBarry Smith 
453f1580f4eSBarry Smith   PetscFunctionBegin;
454f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
455f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
456f1580f4eSBarry Smith   PetscCall(KSPMatSolve(data->levels[0]->ksp, X, Y));
4573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
458f1580f4eSBarry Smith }
459f1580f4eSBarry Smith 
460cc4c1da9SBarry Smith /*@
461f1580f4eSBarry Smith   PCHPDDMGetComplexities - Computes the grid and operator complexities.
462f1580f4eSBarry Smith 
463f1580f4eSBarry Smith   Input Parameter:
464f1580f4eSBarry Smith . pc - preconditioner context
465f1580f4eSBarry Smith 
466f1580f4eSBarry Smith   Output Parameters:
467cc4c1da9SBarry Smith + gc - grid complexity $ \sum_i m_i / m_1 $
468cc4c1da9SBarry Smith - oc - operator complexity $ \sum_i nnz_i / nnz_1 $
469f1580f4eSBarry Smith 
470f1580f4eSBarry Smith   Level: advanced
471f1580f4eSBarry Smith 
472562efe2eSBarry Smith .seealso: [](ch_ksp), `PCMGGetGridComplexity()`, `PCHPDDM`, `PCHYPRE`, `PCGAMG`
473f1580f4eSBarry Smith @*/
474cc4c1da9SBarry Smith PetscErrorCode PCHPDDMGetComplexities(PC pc, PetscReal *gc, PetscReal *oc)
475d71ae5a4SJacob Faibussowitsch {
476f1580f4eSBarry Smith   PC_HPDDM      *data = (PC_HPDDM *)pc->data;
477f1580f4eSBarry Smith   MatInfo        info;
478f1580f4eSBarry Smith   PetscInt       n, m;
479f1580f4eSBarry Smith   PetscLogDouble accumulate[2]{}, nnz1 = 1.0, m1 = 1.0;
480f1580f4eSBarry Smith 
481f1580f4eSBarry Smith   PetscFunctionBegin;
482f1580f4eSBarry Smith   for (n = 0, *gc = 0, *oc = 0; n < data->N; ++n) {
483f1580f4eSBarry Smith     if (data->levels[n]->ksp) {
48413044ca3SPierre Jolivet       Mat       P, A = nullptr;
48513044ca3SPierre Jolivet       PetscBool flg = PETSC_FALSE;
48613044ca3SPierre Jolivet 
487db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &P));
488db4a47b3SPierre Jolivet       PetscCall(MatGetSize(P, &m, nullptr));
489f1580f4eSBarry Smith       accumulate[0] += m;
490f1580f4eSBarry Smith       if (n == 0) {
491f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
492f1580f4eSBarry Smith         if (flg) {
493f1580f4eSBarry Smith           PetscCall(MatConvert(P, MATAIJ, MAT_INITIAL_MATRIX, &A));
494f1580f4eSBarry Smith           P = A;
49513044ca3SPierre Jolivet         } else {
49613044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
49713044ca3SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)P));
498f1580f4eSBarry Smith         }
49913044ca3SPierre Jolivet       }
50013044ca3SPierre Jolivet       if (!A && flg) accumulate[1] += m * m; /* assumption that a MATSCHURCOMPLEMENT is dense if stored explicitly */
50113044ca3SPierre Jolivet       else if (P->ops->getinfo) {
502f1580f4eSBarry Smith         PetscCall(MatGetInfo(P, MAT_GLOBAL_SUM, &info));
503f1580f4eSBarry Smith         accumulate[1] += info.nz_used;
504f1580f4eSBarry Smith       }
505f1580f4eSBarry Smith       if (n == 0) {
506f1580f4eSBarry Smith         m1 = m;
50713044ca3SPierre Jolivet         if (!A && flg) nnz1 = m * m;
50813044ca3SPierre Jolivet         else if (P->ops->getinfo) nnz1 = info.nz_used;
509f1580f4eSBarry Smith         PetscCall(MatDestroy(&P));
510f1580f4eSBarry Smith       }
511f1580f4eSBarry Smith     }
512f1580f4eSBarry Smith   }
513f1580f4eSBarry Smith   *gc = static_cast<PetscReal>(accumulate[0] / m1);
514f1580f4eSBarry Smith   *oc = static_cast<PetscReal>(accumulate[1] / nnz1);
5153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
516f1580f4eSBarry Smith }
517f1580f4eSBarry Smith 
518d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_HPDDM(PC pc, PetscViewer viewer)
519d71ae5a4SJacob Faibussowitsch {
520f1580f4eSBarry Smith   PC_HPDDM         *data = (PC_HPDDM *)pc->data;
521f1580f4eSBarry Smith   PetscViewer       subviewer;
522aa21023fSPierre Jolivet   PetscViewerFormat format;
523f1580f4eSBarry Smith   PetscSubcomm      subcomm;
524f1580f4eSBarry Smith   PetscReal         oc, gc;
525*811e8887SPierre Jolivet   PetscInt          tabs;
526f1580f4eSBarry Smith   PetscMPIInt       size, color, rank;
527aa21023fSPierre Jolivet   PetscBool         flg;
528aa21023fSPierre Jolivet   const char       *name;
529f1580f4eSBarry Smith 
530f1580f4eSBarry Smith   PetscFunctionBegin;
531aa21023fSPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &flg));
532aa21023fSPierre Jolivet   if (flg) {
533f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "level%s: %" PetscInt_FMT "\n", data->N > 1 ? "s" : "", data->N));
534f1580f4eSBarry Smith     PetscCall(PCHPDDMGetComplexities(pc, &gc, &oc));
535f1580f4eSBarry Smith     if (data->N > 1) {
536f1580f4eSBarry Smith       if (!data->deflation) {
537c8ea6600SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "Neumann matrix attached? %s\n", PetscBools[PetscBool3ToBool(data->Neumann)]));
538f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, "shared subdomain KSP between SLEPc and PETSc? %s\n", PetscBools[data->share]));
539f1580f4eSBarry Smith       } else PetscCall(PetscViewerASCIIPrintf(viewer, "user-supplied deflation matrix\n"));
540f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "coarse correction: %s\n", PCHPDDMCoarseCorrectionTypes[data->correction]));
541f1580f4eSBarry 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" : ""));
542f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIGetTab(viewer, &tabs));
543f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, 0));
544*811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
545f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, data->levels[i - 1]->nu));
5460594bca0SPierre Jolivet         if (data->levels[i - 1]->threshold > static_cast<PetscReal>(-0.1)) PetscCall(PetscViewerASCIIPrintf(viewer, " (%g)", (double)data->levels[i - 1]->threshold));
547f1580f4eSBarry Smith       }
548f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
549f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, tabs));
550f1580f4eSBarry Smith     }
551f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "grid and operator complexities: %g %g\n", (double)gc, (double)oc));
5521fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
5531fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank));
554f1580f4eSBarry Smith     if (data->levels[0]->ksp) {
555f1580f4eSBarry Smith       PetscCall(KSPView(data->levels[0]->ksp, viewer));
556f1580f4eSBarry Smith       if (data->levels[0]->pc) PetscCall(PCView(data->levels[0]->pc, viewer));
557*811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
558f1580f4eSBarry Smith         if (data->levels[i]->ksp) color = 1;
559f1580f4eSBarry Smith         else color = 0;
560f1580f4eSBarry Smith         PetscCall(PetscSubcommCreate(PetscObjectComm((PetscObject)pc), &subcomm));
561f1580f4eSBarry Smith         PetscCall(PetscSubcommSetNumber(subcomm, PetscMin(size, 2)));
562f1580f4eSBarry Smith         PetscCall(PetscSubcommSetTypeGeneral(subcomm, color, rank));
563f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPushTab(viewer));
564f1580f4eSBarry Smith         PetscCall(PetscViewerGetSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
565f1580f4eSBarry Smith         if (color == 1) {
566f1580f4eSBarry Smith           PetscCall(KSPView(data->levels[i]->ksp, subviewer));
567f1580f4eSBarry Smith           if (data->levels[i]->pc) PetscCall(PCView(data->levels[i]->pc, subviewer));
568f1580f4eSBarry Smith           PetscCall(PetscViewerFlush(subviewer));
569f1580f4eSBarry Smith         }
570f1580f4eSBarry Smith         PetscCall(PetscViewerRestoreSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
571f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPopTab(viewer));
572f1580f4eSBarry Smith         PetscCall(PetscSubcommDestroy(&subcomm));
573f1580f4eSBarry Smith       }
574f1580f4eSBarry Smith     }
575aa21023fSPierre Jolivet     PetscCall(PetscViewerGetFormat(viewer, &format));
576aa21023fSPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
577aa21023fSPierre Jolivet       PetscCall(PetscViewerFileGetName(viewer, &name));
578aa21023fSPierre Jolivet       if (name) {
579aa21023fSPierre Jolivet         IS          is;
580aa21023fSPierre Jolivet         PetscInt    sizes[4] = {pc->mat->rmap->n, pc->mat->cmap->n, pc->mat->rmap->N, pc->mat->cmap->N};
581aa21023fSPierre Jolivet         char       *tmp;
582aa21023fSPierre Jolivet         std::string prefix, suffix;
583aa21023fSPierre Jolivet         size_t      pos;
584aa21023fSPierre Jolivet 
585aa21023fSPierre Jolivet         PetscCall(PetscStrstr(name, ".", &tmp));
586aa21023fSPierre Jolivet         if (tmp) {
587aa21023fSPierre Jolivet           pos    = std::distance(const_cast<char *>(name), tmp);
588aa21023fSPierre Jolivet           prefix = std::string(name, pos);
589aa21023fSPierre Jolivet           suffix = std::string(name + pos + 1);
590aa21023fSPierre Jolivet         } else prefix = name;
591aa21023fSPierre Jolivet         if (data->aux) {
592aa21023fSPierre 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));
593aa21023fSPierre Jolivet           PetscCall(MatView(data->aux, subviewer));
594aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
595aa21023fSPierre Jolivet         }
596aa21023fSPierre Jolivet         if (data->is) {
597aa21023fSPierre 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));
598aa21023fSPierre Jolivet           PetscCall(ISView(data->is, subviewer));
599aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
600aa21023fSPierre Jolivet         }
601aa21023fSPierre Jolivet         PetscCall(ISCreateGeneral(PETSC_COMM_SELF, PETSC_STATIC_ARRAY_LENGTH(sizes), sizes, PETSC_USE_POINTER, &is));
602aa21023fSPierre 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));
603aa21023fSPierre Jolivet         PetscCall(ISView(is, subviewer));
604aa21023fSPierre Jolivet         PetscCall(PetscViewerDestroy(&subviewer));
605aa21023fSPierre Jolivet         PetscCall(ISDestroy(&is));
606aa21023fSPierre Jolivet       }
607aa21023fSPierre Jolivet     }
608f1580f4eSBarry Smith   }
6093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
610f1580f4eSBarry Smith }
611f1580f4eSBarry Smith 
612d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCPreSolve_HPDDM(PC pc, KSP ksp, Vec, Vec)
613d71ae5a4SJacob Faibussowitsch {
614f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
615f1580f4eSBarry Smith   Mat       A;
616cdbd50ebSPierre Jolivet   PetscBool flg;
617f1580f4eSBarry Smith 
618f1580f4eSBarry Smith   PetscFunctionBegin;
619f1580f4eSBarry Smith   if (ksp) {
620f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPLSQR, &flg));
621f1580f4eSBarry Smith     if (flg && !data->normal) {
622db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(ksp, &A, nullptr));
623db4a47b3SPierre Jolivet       PetscCall(MatCreateVecs(A, nullptr, &data->normal)); /* temporary Vec used in PCApply_HPDDMShell() for coarse grid corrections */
624cdbd50ebSPierre Jolivet     } else if (!flg) {
625cdbd50ebSPierre Jolivet       PetscCall(PetscObjectTypeCompareAny((PetscObject)ksp, &flg, KSPCG, KSPGROPPCG, KSPPIPECG, KSPPIPECGRR, KSPPIPELCG, KSPPIPEPRCG, KSPPIPECG2, KSPSTCG, KSPFCG, KSPPIPEFCG, KSPMINRES, KSPNASH, KSPSYMMLQ, ""));
626cdbd50ebSPierre Jolivet       if (!flg) {
627cdbd50ebSPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPHPDDM, &flg));
628cdbd50ebSPierre Jolivet         if (flg) {
629cdbd50ebSPierre Jolivet           KSPHPDDMType type;
630*811e8887SPierre Jolivet 
631cdbd50ebSPierre Jolivet           PetscCall(KSPHPDDMGetType(ksp, &type));
632cdbd50ebSPierre Jolivet           flg = (type == KSP_HPDDM_TYPE_CG || type == KSP_HPDDM_TYPE_BCG || type == KSP_HPDDM_TYPE_BFBCG ? PETSC_TRUE : PETSC_FALSE);
633cdbd50ebSPierre Jolivet         }
634cdbd50ebSPierre Jolivet       }
635cdbd50ebSPierre Jolivet     }
636cdbd50ebSPierre Jolivet     if (flg) {
637cdbd50ebSPierre Jolivet       if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) {
638cdbd50ebSPierre Jolivet         PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_hpddm_coarse_correction", &flg));
639cdbd50ebSPierre 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",
640cdbd50ebSPierre Jolivet                    PCHPDDMCoarseCorrectionTypes[data->correction], ((PetscObject)ksp)->type_name, ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", PCHPDDMCoarseCorrectionTypes[data->correction], PCHPDDMCoarseCorrectionTypes[PC_HPDDM_COARSE_CORRECTION_BALANCED]);
641cdbd50ebSPierre Jolivet       }
642cdbd50ebSPierre Jolivet       for (PetscInt n = 0; n < data->N; ++n) {
643cdbd50ebSPierre Jolivet         if (data->levels[n]->pc) {
644cdbd50ebSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)data->levels[n]->pc, PCASM, &flg));
645cdbd50ebSPierre Jolivet           if (flg) {
646cdbd50ebSPierre Jolivet             PCASMType type;
647*811e8887SPierre Jolivet 
648cdbd50ebSPierre Jolivet             PetscCall(PCASMGetType(data->levels[n]->pc, &type));
649cdbd50ebSPierre Jolivet             if (type == PC_ASM_RESTRICT || type == PC_ASM_INTERPOLATE) {
650cdbd50ebSPierre Jolivet               PetscCall(PetscOptionsHasName(((PetscObject)data->levels[n]->pc)->options, ((PetscObject)data->levels[n]->pc)->prefix, "-pc_asm_type", &flg));
651cdbd50ebSPierre 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],
652cdbd50ebSPierre Jolivet                          ((PetscObject)ksp)->type_name, ((PetscObject)data->levels[n]->pc)->prefix, PCASMTypes[type], PCASMTypes[PC_ASM_BASIC]);
653cdbd50ebSPierre Jolivet             }
654cdbd50ebSPierre Jolivet           }
655cdbd50ebSPierre Jolivet         }
656cdbd50ebSPierre Jolivet       }
657f1580f4eSBarry Smith     }
658f1580f4eSBarry Smith   }
6593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
660f1580f4eSBarry Smith }
661f1580f4eSBarry Smith 
662d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDMShell(PC pc)
663d71ae5a4SJacob Faibussowitsch {
664f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
665f1580f4eSBarry Smith   Mat             A, P;
666f1580f4eSBarry Smith   Vec             x;
667f1580f4eSBarry Smith   const char     *pcpre;
668f1580f4eSBarry Smith 
669f1580f4eSBarry Smith   PetscFunctionBegin;
670f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
671f1580f4eSBarry Smith   PetscCall(KSPGetOptionsPrefix(ctx->ksp, &pcpre));
672f1580f4eSBarry Smith   PetscCall(KSPGetOperators(ctx->ksp, &A, &P));
673f1580f4eSBarry Smith   /* smoother */
674f1580f4eSBarry Smith   PetscCall(PCSetOptionsPrefix(ctx->pc, pcpre));
675f1580f4eSBarry Smith   PetscCall(PCSetOperators(ctx->pc, A, P));
676f1580f4eSBarry Smith   if (!ctx->v[0]) {
677f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(ctx->D, 1, &ctx->v[0]));
678f1580f4eSBarry Smith     if (!std::is_same<PetscScalar, PetscReal>::value) PetscCall(VecDestroy(&ctx->D));
679db4a47b3SPierre Jolivet     PetscCall(MatCreateVecs(A, &x, nullptr));
680f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(x, 2, &ctx->v[1]));
681f1580f4eSBarry Smith     PetscCall(VecDestroy(&x));
682f1580f4eSBarry Smith   }
683f1580f4eSBarry Smith   std::fill_n(ctx->V, 3, nullptr);
6843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
685f1580f4eSBarry Smith }
686f1580f4eSBarry Smith 
687f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
688d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type x, Type y)
689d71ae5a4SJacob Faibussowitsch {
690f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
691f1580f4eSBarry Smith   PetscScalar    *out;
692f1580f4eSBarry Smith 
693f1580f4eSBarry Smith   PetscFunctionBegin;
694f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
695f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
696f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
697f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
698f1580f4eSBarry Smith   PetscCall(VecGetArrayWrite(ctx->v[0][0], &out));
699db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, 1); /* y = Q x */
700f1580f4eSBarry Smith   PetscCall(VecRestoreArrayWrite(ctx->v[0][0], &out));
701f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
702f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
703f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
7043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
705f1580f4eSBarry Smith }
706f1580f4eSBarry Smith 
707f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
708d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type X, Type Y)
709d71ae5a4SJacob Faibussowitsch {
710f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
711f1580f4eSBarry Smith   Vec             vX, vY, vC;
712f1580f4eSBarry Smith   PetscScalar    *out;
713*811e8887SPierre Jolivet   PetscInt        N;
714f1580f4eSBarry Smith 
715f1580f4eSBarry Smith   PetscFunctionBegin;
716f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
717db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
718f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
719*811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
720f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(X, i, &vX));
721f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(ctx->V[0], i, &vC));
722f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
723f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
724f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(ctx->V[0], i, &vC));
725f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(X, i, &vX));
726f1580f4eSBarry Smith   }
727f1580f4eSBarry Smith   PetscCall(MatDenseGetArrayWrite(ctx->V[0], &out));
728db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, N); /* Y = Q X */
729f1580f4eSBarry Smith   PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &out));
730f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
731*811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
732f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(ctx->V[0], i, &vC));
733f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(Y, i, &vY));
734f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
735f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
736f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &vY));
737f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(ctx->V[0], i, &vC));
738f1580f4eSBarry Smith   }
7393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
740f1580f4eSBarry Smith }
741f1580f4eSBarry Smith 
742f1580f4eSBarry Smith /*
743aa1539e9SPierre 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.
744f1580f4eSBarry Smith 
745f1580f4eSBarry Smith .vb
746f1580f4eSBarry Smith    (1) y =                Pmat^-1              x + Q x,
747f1580f4eSBarry Smith    (2) y =                Pmat^-1 (I - Amat Q) x + Q x (default),
748aa1539e9SPierre Jolivet    (3) y = (I - Q Amat^T) Pmat^-1 (I - Amat Q) x + Q x,
749aa1539e9SPierre Jolivet    (4) y =                Pmat^-1              x      .
750f1580f4eSBarry Smith .ve
751f1580f4eSBarry Smith 
752f1580f4eSBarry Smith    Input Parameters:
753f1580f4eSBarry Smith +     pc - preconditioner context
754f1580f4eSBarry Smith -     x - input vector
755f1580f4eSBarry Smith 
756f1580f4eSBarry Smith    Output Parameter:
757f1580f4eSBarry Smith .     y - output vector
758f1580f4eSBarry Smith 
759f1580f4eSBarry Smith    Notes:
760f1580f4eSBarry 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.
761f1580f4eSBarry 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.
762f1580f4eSBarry 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.
763f1580f4eSBarry Smith 
764f1580f4eSBarry Smith    Level: advanced
765f1580f4eSBarry Smith 
766f1580f4eSBarry Smith    Developer Note:
767f1580f4eSBarry 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
768f1580f4eSBarry Smith    to trigger it. Likely the manual page is `PCHPDDM`
769f1580f4eSBarry Smith 
770562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
771f1580f4eSBarry Smith */
772d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDMShell(PC pc, Vec x, Vec y)
773d71ae5a4SJacob Faibussowitsch {
774f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
775f1580f4eSBarry Smith   Mat             A;
776f1580f4eSBarry Smith 
777f1580f4eSBarry Smith   PetscFunctionBegin;
778f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
779f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
780db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
781aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApply(ctx->pc, x, y)); /* y = M^-1 x */
782aa1539e9SPierre Jolivet   else {
783f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, x, y)); /* y = Q x */
784f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
785f1580f4eSBarry Smith       if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMult(A, y, ctx->v[1][0])); /* y = A Q x     */
786f1580f4eSBarry Smith       else { /* KSPLSQR and finest level */ PetscCall(MatMult(A, y, ctx->parent->normal));               /* y = A Q x     */
787f1580f4eSBarry Smith         PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][0]));                      /* y = A^T A Q x */
788f1580f4eSBarry Smith       }
789f1580f4eSBarry Smith       PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x)); /* y = (I - A Q) x                             */
790f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, ctx->v[1][1], ctx->v[1][0]));  /* y = M^-1 (I - A Q) x                        */
791f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
792f1580f4eSBarry 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 */
793f1580f4eSBarry Smith         else {
794f1580f4eSBarry Smith           PetscCall(MatMult(A, ctx->v[1][0], ctx->parent->normal));
795f1580f4eSBarry Smith           PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][1])); /* z = A^T A y           */
796f1580f4eSBarry Smith         }
797f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->v[1][1], ctx->v[1][1]));
798f1580f4eSBarry 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      */
799f1580f4eSBarry Smith       } else PetscCall(VecAXPY(y, 1.0, ctx->v[1][0]));                         /* y = Q M^-1 (I - A Q) x + Q x */
800f1580f4eSBarry Smith     } else {
801f1580f4eSBarry 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);
802f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, x, ctx->v[1][0]));
803f1580f4eSBarry Smith       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-1 x + Q x */
804f1580f4eSBarry Smith     }
805aa1539e9SPierre Jolivet   }
8063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
807f1580f4eSBarry Smith }
808f1580f4eSBarry Smith 
809f1580f4eSBarry Smith /*
810f1580f4eSBarry Smith      PCMatApply_HPDDMShell - Variant of PCApply_HPDDMShell() for blocks of vectors.
811f1580f4eSBarry Smith 
812f1580f4eSBarry Smith    Input Parameters:
813f1580f4eSBarry Smith +     pc - preconditioner context
814f1580f4eSBarry Smith -     X - block of input vectors
815f1580f4eSBarry Smith 
816f1580f4eSBarry Smith    Output Parameter:
817f1580f4eSBarry Smith .     Y - block of output vectors
818f1580f4eSBarry Smith 
819f1580f4eSBarry Smith    Level: advanced
820f1580f4eSBarry Smith 
821562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
822f1580f4eSBarry Smith */
823d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDMShell(PC pc, Mat X, Mat Y)
824d71ae5a4SJacob Faibussowitsch {
825f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
826f1580f4eSBarry Smith   Mat             A, *ptr;
827db4a47b3SPierre Jolivet   PetscContainer  container = nullptr;
828f1580f4eSBarry Smith   PetscScalar    *array;
829f1580f4eSBarry Smith   PetscInt        m, M, N, prev = 0;
830f1580f4eSBarry Smith   PetscBool       reset = PETSC_FALSE;
831f1580f4eSBarry Smith 
832f1580f4eSBarry Smith   PetscFunctionBegin;
833f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
834f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
835db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
836db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
837aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApply(ctx->pc, X, Y));
838aa1539e9SPierre Jolivet   else {
839f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)A, "_HPDDM_MatProduct", (PetscObject *)&container));
840f1580f4eSBarry Smith     if (container) { /* MatProduct container already attached */
841f1580f4eSBarry Smith       PetscCall(PetscContainerGetPointer(container, (void **)&ptr));
842f1580f4eSBarry Smith       if (ptr[1] != ctx->V[2]) /* Mat has changed or may have been set first in KSPHPDDM */
843f1580f4eSBarry Smith         for (m = 0; m < 2; ++m) {
844f1580f4eSBarry Smith           PetscCall(MatDestroy(ctx->V + m + 1));
845f1580f4eSBarry Smith           ctx->V[m + 1] = ptr[m];
846f1580f4eSBarry Smith           PetscCall(PetscObjectReference((PetscObject)ctx->V[m + 1]));
847f1580f4eSBarry Smith         }
848f1580f4eSBarry Smith     }
849db4a47b3SPierre Jolivet     if (ctx->V[1]) PetscCall(MatGetSize(ctx->V[1], nullptr, &prev));
850f1580f4eSBarry Smith     if (N != prev || !ctx->V[0]) {
851f1580f4eSBarry Smith       PetscCall(MatDestroy(ctx->V));
852f1580f4eSBarry Smith       PetscCall(VecGetLocalSize(ctx->v[0][0], &m));
853db4a47b3SPierre Jolivet       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, PETSC_DECIDE, N, nullptr, ctx->V));
854f1580f4eSBarry Smith       if (N != prev) {
855f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 1));
856f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 2));
857db4a47b3SPierre Jolivet         PetscCall(MatGetLocalSize(X, &m, nullptr));
858db4a47b3SPierre Jolivet         PetscCall(MatGetSize(X, &M, nullptr));
859f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
860db4a47b3SPierre Jolivet         else array = nullptr;
861f1580f4eSBarry Smith         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, array, ctx->V + 1));
862f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
863db4a47b3SPierre Jolivet         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, nullptr, ctx->V + 2));
864db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, Y, nullptr, ctx->V[1]));
865f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[1], MATPRODUCT_AB));
866f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[1]));
867f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[1]));
868f1580f4eSBarry Smith         if (!container) { /* no MatProduct container attached, create one to be queried in KSPHPDDM or at the next call to PCMatApply() */
869f1580f4eSBarry Smith           PetscCall(PetscContainerCreate(PetscObjectComm((PetscObject)A), &container));
870f1580f4eSBarry Smith           PetscCall(PetscObjectCompose((PetscObject)A, "_HPDDM_MatProduct", (PetscObject)container));
871f1580f4eSBarry Smith         }
8723f68fba4SPierre 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 */
873f1580f4eSBarry Smith       }
874f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
875db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, ctx->V[1], nullptr, ctx->V[2]));
876f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[2], MATPRODUCT_AtB));
877f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[2]));
878f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[2]));
879f1580f4eSBarry Smith       }
880f1580f4eSBarry Smith       ctx->P->start(N);
881f1580f4eSBarry Smith     }
882f1580f4eSBarry Smith     if (N == prev || container) { /* when MatProduct container is attached, always need to MatProductReplaceMats() since KSPHPDDM may have replaced the Mat as well */
883db4a47b3SPierre Jolivet       PetscCall(MatProductReplaceMats(nullptr, Y, nullptr, ctx->V[1]));
884f1580f4eSBarry Smith       if (container && ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) {
885f1580f4eSBarry Smith         PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
886f1580f4eSBarry Smith         PetscCall(MatDensePlaceArray(ctx->V[1], array));
887f1580f4eSBarry Smith         PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
888f1580f4eSBarry Smith         reset = PETSC_TRUE;
889f1580f4eSBarry Smith       }
890f1580f4eSBarry Smith     }
891f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, X, Y));
892f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
893f1580f4eSBarry Smith       PetscCall(MatProductNumeric(ctx->V[1]));
894f1580f4eSBarry Smith       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
895f1580f4eSBarry Smith       PetscCall(MatAXPY(ctx->V[2], -1.0, X, SAME_NONZERO_PATTERN));
896f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, ctx->V[2], ctx->V[1]));
897f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
898f1580f4eSBarry Smith         PetscCall(MatProductNumeric(ctx->V[2]));
899f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->V[2], ctx->V[2]));
900f1580f4eSBarry Smith         PetscCall(MatAXPY(ctx->V[1], -1.0, ctx->V[2], SAME_NONZERO_PATTERN));
901f1580f4eSBarry Smith       }
902f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
903f1580f4eSBarry Smith     } else {
904f1580f4eSBarry 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);
905f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, X, ctx->V[1]));
906f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
907f1580f4eSBarry Smith     }
908f1580f4eSBarry Smith     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
909aa1539e9SPierre Jolivet   }
9103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
911f1580f4eSBarry Smith }
912f1580f4eSBarry Smith 
913d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDMShell(PC pc)
914d71ae5a4SJacob Faibussowitsch {
915f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
916f1580f4eSBarry Smith   PetscContainer  container;
917f1580f4eSBarry Smith 
918f1580f4eSBarry Smith   PetscFunctionBegin;
919f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
920f1580f4eSBarry Smith   PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(ctx, PETSC_TRUE));
921f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(1, &ctx->v[0]));
922f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(2, &ctx->v[1]));
923f4f49eeaSPierre Jolivet   PetscCall(PetscObjectQuery((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", (PetscObject *)&container));
924f1580f4eSBarry Smith   PetscCall(PetscContainerDestroy(&container));
925f4f49eeaSPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", nullptr));
926f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V));
927f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 1));
928f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 2));
929f1580f4eSBarry Smith   PetscCall(VecDestroy(&ctx->D));
93001e3c840SPierre Jolivet   PetscCall(PetscSFDestroy(&ctx->scatter));
931f1580f4eSBarry Smith   PetscCall(PCDestroy(&ctx->pc));
9323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
933f1580f4eSBarry Smith }
934f1580f4eSBarry Smith 
9359bb5c669SPierre Jolivet template <class Type, bool T = false, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
9369bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type x, Type y)
9379bb5c669SPierre Jolivet {
9389bb5c669SPierre Jolivet   PetscFunctionBegin;
9399bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[0], std::get<1>(*p), SCATTER_FORWARD, x));
9409bb5c669SPierre Jolivet   if (!T) PetscCall(PCApply(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
9419bb5c669SPierre Jolivet   else PetscCall(PCApplyTranspose(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
9429bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[1], std::get<1>(*p), SCATTER_REVERSE, y));
9439bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9449bb5c669SPierre Jolivet }
9459bb5c669SPierre Jolivet 
9469bb5c669SPierre Jolivet template <class Type, bool = false, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
9479bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type X, Type Y)
9489bb5c669SPierre Jolivet {
9499bb5c669SPierre Jolivet   Mat B[2];
9509bb5c669SPierre Jolivet   Vec x, y;
9519bb5c669SPierre Jolivet 
9529bb5c669SPierre Jolivet   PetscFunctionBegin;
9539bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B));
9549bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B + 1));
9559bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
9569bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(X, i, &x));
9579bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B[0], i, &y));
9589bb5c669SPierre Jolivet     PetscCall(VecISCopy(y, std::get<1>(*p), SCATTER_FORWARD, x));
9599bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B[0], i, &y));
9609bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(X, i, &x));
9619bb5c669SPierre Jolivet   }
9629bb5c669SPierre Jolivet   PetscCall(PCMatApply(factor, B[0], B[1]));
9639bb5c669SPierre Jolivet   PetscCall(MatDestroy(B));
9649bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
9659bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B[1], i, &x));
9669bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &y));
9679bb5c669SPierre Jolivet     PetscCall(VecISCopy(x, std::get<1>(*p), SCATTER_REVERSE, y));
9689bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &y));
9699bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B[1], i, &x));
9709bb5c669SPierre Jolivet   }
9719bb5c669SPierre Jolivet   PetscCall(MatDestroy(B + 1));
9729bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9739bb5c669SPierre Jolivet }
9749bb5c669SPierre Jolivet 
9759bb5c669SPierre Jolivet template <class Type = Vec, bool T = false>
9769bb5c669SPierre Jolivet static PetscErrorCode PCApply_Schur(PC pc, Type x, Type y)
9779bb5c669SPierre Jolivet {
9789bb5c669SPierre Jolivet   PC                           factor;
9799bb5c669SPierre Jolivet   Mat                          A;
9809bb5c669SPierre Jolivet   MatSolverType                type;
9819bb5c669SPierre Jolivet   PetscBool                    flg;
9829bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
9839bb5c669SPierre Jolivet 
9849bb5c669SPierre Jolivet   PetscFunctionBegin;
9859bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
9869bb5c669SPierre Jolivet   PetscCall(KSPGetPC(std::get<0>(*p), &factor));
9879bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(factor, &type));
9889bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatrix(factor, &A));
9899bb5c669SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
9909bb5c669SPierre Jolivet   if (flg) {
9919bb5c669SPierre Jolivet     PetscCheck(PetscDefined(HAVE_MUMPS), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
9929bb5c669SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
9939bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 0));
9949bb5c669SPierre Jolivet #endif
9959bb5c669SPierre Jolivet   } else {
9969bb5c669SPierre Jolivet     PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &flg));
9979bb5c669SPierre Jolivet     PetscCheck(flg && PetscDefined(HAVE_MKL_PARDISO), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
9989bb5c669SPierre Jolivet     flg = PETSC_FALSE;
9999bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
10009bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 1));
10019bb5c669SPierre Jolivet #endif
10029bb5c669SPierre Jolivet   }
10039bb5c669SPierre Jolivet   PetscCall(PCApply_Schur_Private<Type, T>(p, factor, x, y));
10049bb5c669SPierre Jolivet   if (flg) {
10059bb5c669SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
10069bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1));
10079bb5c669SPierre Jolivet #endif
10089bb5c669SPierre Jolivet   } else {
10099bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
10109bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 0));
10119bb5c669SPierre Jolivet #endif
10129bb5c669SPierre Jolivet   }
10139bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10149bb5c669SPierre Jolivet }
10159bb5c669SPierre Jolivet 
10169bb5c669SPierre Jolivet static PetscErrorCode PCDestroy_Schur(PC pc)
10179bb5c669SPierre Jolivet {
10189bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
10199bb5c669SPierre Jolivet 
10209bb5c669SPierre Jolivet   PetscFunctionBegin;
10219bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
10229bb5c669SPierre Jolivet   PetscCall(ISDestroy(&std::get<1>(*p)));
10239bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p)));
10249bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p) + 1));
10259bb5c669SPierre Jolivet   PetscCall(PetscFree(p));
10269bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10279bb5c669SPierre Jolivet }
10289bb5c669SPierre Jolivet 
1029d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSolve_Private(const PC_HPDDM_Level *ctx, PetscScalar *rhs, const unsigned short &mu)
1030d71ae5a4SJacob Faibussowitsch {
1031f1580f4eSBarry Smith   Mat      B, X;
1032f1580f4eSBarry Smith   PetscInt n, N, j = 0;
1033f1580f4eSBarry Smith 
1034f1580f4eSBarry Smith   PetscFunctionBegin;
1035db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &B, nullptr));
1036db4a47b3SPierre Jolivet   PetscCall(MatGetLocalSize(B, &n, nullptr));
1037db4a47b3SPierre Jolivet   PetscCall(MatGetSize(B, &N, nullptr));
1038f1580f4eSBarry Smith   if (ctx->parent->log_separate) {
1039f1580f4eSBarry Smith     j = std::distance(ctx->parent->levels, std::find(ctx->parent->levels, ctx->parent->levels + ctx->parent->N, ctx));
1040db4a47b3SPierre Jolivet     PetscCall(PetscLogEventBegin(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
1041f1580f4eSBarry Smith   }
1042f1580f4eSBarry Smith   if (mu == 1) {
1043f1580f4eSBarry Smith     if (!ctx->ksp->vec_rhs) {
1044db4a47b3SPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ctx->ksp), 1, n, N, nullptr, &ctx->ksp->vec_rhs));
1045f1580f4eSBarry Smith       PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)ctx->ksp), n, N, &ctx->ksp->vec_sol));
1046f1580f4eSBarry Smith     }
1047f1580f4eSBarry Smith     PetscCall(VecPlaceArray(ctx->ksp->vec_rhs, rhs));
1048db4a47b3SPierre Jolivet     PetscCall(KSPSolve(ctx->ksp, nullptr, nullptr));
1049f1580f4eSBarry Smith     PetscCall(VecCopy(ctx->ksp->vec_sol, ctx->ksp->vec_rhs));
1050f1580f4eSBarry Smith     PetscCall(VecResetArray(ctx->ksp->vec_rhs));
1051f1580f4eSBarry Smith   } else {
1052f1580f4eSBarry Smith     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, rhs, &B));
1053db4a47b3SPierre Jolivet     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, nullptr, &X));
1054f1580f4eSBarry Smith     PetscCall(KSPMatSolve(ctx->ksp, B, X));
1055f1580f4eSBarry Smith     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
1056f1580f4eSBarry Smith     PetscCall(MatDestroy(&X));
1057f1580f4eSBarry Smith     PetscCall(MatDestroy(&B));
1058f1580f4eSBarry Smith   }
1059db4a47b3SPierre Jolivet   if (ctx->parent->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
10603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1061f1580f4eSBarry Smith }
1062f1580f4eSBarry Smith 
1063d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetUpNeumannOverlap_Private(PC pc)
1064d71ae5a4SJacob Faibussowitsch {
1065f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
1066f1580f4eSBarry Smith 
1067f1580f4eSBarry Smith   PetscFunctionBegin;
1068f1580f4eSBarry Smith   if (data->setup) {
1069f1580f4eSBarry Smith     Mat       P;
1070db4a47b3SPierre Jolivet     Vec       x, xt = nullptr;
1071f1580f4eSBarry Smith     PetscReal t = 0.0, s = 0.0;
1072f1580f4eSBarry Smith 
1073db4a47b3SPierre Jolivet     PetscCall(PCGetOperators(pc, nullptr, &P));
1074f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)P, "__SNES_latest_X", (PetscObject *)&x));
1075f1580f4eSBarry Smith     PetscCallBack("PCHPDDM Neumann callback", (*data->setup)(data->aux, t, x, xt, s, data->is, data->setup_ctx));
1076f1580f4eSBarry Smith   }
10773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1078f1580f4eSBarry Smith }
1079f1580f4eSBarry Smith 
1080d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCreateSubMatrices_Private(Mat mat, PetscInt n, const IS *, const IS *, MatReuse scall, Mat *submat[])
1081d71ae5a4SJacob Faibussowitsch {
1082f1580f4eSBarry Smith   Mat       A;
108313044ca3SPierre Jolivet   PetscBool flg;
1084f1580f4eSBarry Smith 
1085f1580f4eSBarry Smith   PetscFunctionBegin;
1086f1580f4eSBarry Smith   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatCreateSubMatrices() called to extract %" PetscInt_FMT " submatrices, which is different than 1", n);
1087f1580f4eSBarry Smith   /* previously composed Mat */
1088f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)mat, "_PCHPDDM_SubMatrices", (PetscObject *)&A));
1089f1580f4eSBarry Smith   PetscCheck(A, PETSC_COMM_SELF, PETSC_ERR_PLIB, "SubMatrices not found in Mat");
109013044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSCHURCOMPLEMENT, &flg)); /* MATSCHURCOMPLEMENT has neither a MatDuplicate() nor a MatCopy() implementation */
1091f1580f4eSBarry Smith   if (scall == MAT_INITIAL_MATRIX) {
10926f2c871aSStefano Zampini     PetscCall(PetscCalloc1(2, submat)); /* allocate an extra Mat to avoid errors in MatDestroySubMatrices_Dummy() */
109313044ca3SPierre Jolivet     if (!flg) PetscCall(MatDuplicate(A, MAT_COPY_VALUES, *submat));
109413044ca3SPierre Jolivet   } else if (!flg) PetscCall(MatCopy(A, (*submat)[0], SAME_NONZERO_PATTERN));
109513044ca3SPierre Jolivet   if (flg) {
1096bf583f0cSPierre Jolivet     PetscCall(MatDestroy(*submat)); /* previously created Mat has to be destroyed */
109713044ca3SPierre Jolivet     (*submat)[0] = A;
109813044ca3SPierre Jolivet     PetscCall(PetscObjectReference((PetscObject)A));
109913044ca3SPierre Jolivet   }
11003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1101f1580f4eSBarry Smith }
1102f1580f4eSBarry Smith 
1103d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCommunicationAvoidingPCASM_Private(PC pc, Mat C, PetscBool sorted)
1104d71ae5a4SJacob Faibussowitsch {
1105f1580f4eSBarry Smith   void (*op)(void);
1106f1580f4eSBarry Smith 
1107f1580f4eSBarry Smith   PetscFunctionBegin;
1108f1580f4eSBarry Smith   /* previously-composed Mat */
1109f1580f4eSBarry Smith   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", (PetscObject)C));
1110f1580f4eSBarry Smith   PetscCall(MatGetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, &op));
1111f1580f4eSBarry Smith   /* trick suggested by Barry https://lists.mcs.anl.gov/pipermail/petsc-dev/2020-January/025491.html */
1112f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, (void (*)(void))PCHPDDMCreateSubMatrices_Private));
1113f1580f4eSBarry Smith   if (sorted) PetscCall(PCASMSetSortIndices(pc, PETSC_FALSE)); /* everything is already sorted */
1114f1580f4eSBarry Smith   PetscCall(PCSetFromOptions(pc));                             /* otherwise -pc_hpddm_levels_1_pc_asm_sub_mat_type is not used */
1115f1580f4eSBarry Smith   PetscCall(PCSetUp(pc));
1116f1580f4eSBarry Smith   /* reset MatCreateSubMatrices() */
1117f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, op));
1118db4a47b3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", nullptr));
11193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1120f1580f4eSBarry Smith }
1121f1580f4eSBarry Smith 
1122d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMPermute_Private(IS is, IS in_is, IS *out_is, Mat in_C, Mat *out_C, IS *p)
1123d71ae5a4SJacob Faibussowitsch {
1124f1580f4eSBarry Smith   IS                           perm;
1125f1580f4eSBarry Smith   const PetscInt              *ptr;
1126*811e8887SPierre Jolivet   PetscInt                    *concatenate, size, bs;
1127f1580f4eSBarry Smith   std::map<PetscInt, PetscInt> order;
1128f1580f4eSBarry Smith   PetscBool                    sorted;
1129f1580f4eSBarry Smith 
1130f1580f4eSBarry Smith   PetscFunctionBegin;
1131cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(is, IS_CLASSID, 1);
1132cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(in_C, MAT_CLASSID, 4);
1133f1580f4eSBarry Smith   PetscCall(ISSorted(is, &sorted));
1134f1580f4eSBarry Smith   if (!sorted) {
1135f1580f4eSBarry Smith     PetscCall(ISGetLocalSize(is, &size));
1136f1580f4eSBarry Smith     PetscCall(ISGetIndices(is, &ptr));
1137b07dfdedSPierre Jolivet     PetscCall(ISGetBlockSize(is, &bs));
1138f1580f4eSBarry Smith     /* MatCreateSubMatrices(), called by PCASM, follows the global numbering of Pmat */
1139*811e8887SPierre Jolivet     for (PetscInt n = 0; n < size; n += bs) order.insert(std::make_pair(ptr[n] / bs, n / bs));
1140f1580f4eSBarry Smith     PetscCall(ISRestoreIndices(is, &ptr));
1141b07dfdedSPierre Jolivet     size /= bs;
1142f1580f4eSBarry Smith     if (out_C) {
1143f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1144f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.second;
1145f1580f4eSBarry Smith       concatenate -= size;
1146b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_C), bs, size, concatenate, PETSC_OWN_POINTER, &perm));
1147f1580f4eSBarry Smith       PetscCall(ISSetPermutation(perm));
1148f1580f4eSBarry Smith       /* permute user-provided Mat so that it matches with MatCreateSubMatrices() numbering */
1149f1580f4eSBarry Smith       PetscCall(MatPermute(in_C, perm, perm, out_C));
1150f1580f4eSBarry Smith       if (p) *p = perm;
1151f1580f4eSBarry Smith       else PetscCall(ISDestroy(&perm)); /* no need to save the permutation */
1152f1580f4eSBarry Smith     }
1153f1580f4eSBarry Smith     if (out_is) {
1154f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1155f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.first;
1156f1580f4eSBarry Smith       concatenate -= size;
1157f1580f4eSBarry Smith       /* permute user-provided IS so that it matches with MatCreateSubMatrices() numbering */
1158b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_is), bs, size, concatenate, PETSC_OWN_POINTER, out_is));
1159f1580f4eSBarry Smith     }
1160f1580f4eSBarry Smith   } else { /* input IS is sorted, nothing to permute, simply duplicate inputs when needed */
1161f1580f4eSBarry Smith     if (out_C) PetscCall(MatDuplicate(in_C, MAT_COPY_VALUES, out_C));
1162f1580f4eSBarry Smith     if (out_is) PetscCall(ISDuplicate(in_is, out_is));
1163f1580f4eSBarry Smith   }
11643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1165f1580f4eSBarry Smith }
1166f1580f4eSBarry Smith 
11675e642048SPierre Jolivet static PetscErrorCode PCHPDDMCheckSymmetry_Private(PC pc, Mat A01, Mat A10)
116813044ca3SPierre Jolivet {
116913044ca3SPierre Jolivet   Mat       T, U = nullptr, B = nullptr;
117013044ca3SPierre Jolivet   IS        z;
117113044ca3SPierre Jolivet   PetscBool flg[2];
117213044ca3SPierre Jolivet 
117313044ca3SPierre Jolivet   PetscFunctionBegin;
117413044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, flg));
1175*811e8887SPierre Jolivet   if (flg[0]) {
1176*811e8887SPierre Jolivet     PetscCall(MatShellGetScalingShifts(A10, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
1177*811e8887SPierre Jolivet     PetscCall(MatTransposeGetMat(A10, &U));
1178*811e8887SPierre Jolivet   } else {
117913044ca3SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, flg + 1));
1180*811e8887SPierre Jolivet     if (flg[1]) {
1181*811e8887SPierre Jolivet       PetscCall(MatShellGetScalingShifts(A10, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
1182*811e8887SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A10, &U));
1183*811e8887SPierre Jolivet     }
118413044ca3SPierre Jolivet   }
118513044ca3SPierre Jolivet   if (U) PetscCall(MatDuplicate(U, MAT_COPY_VALUES, &T));
118613044ca3SPierre Jolivet   else PetscCall(MatHermitianTranspose(A10, MAT_INITIAL_MATRIX, &T));
118713044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATTRANSPOSEVIRTUAL, flg));
118813044ca3SPierre Jolivet   if (flg[0]) {
1189*811e8887SPierre Jolivet     PetscCall(MatShellGetScalingShifts(A01, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
119013044ca3SPierre Jolivet     PetscCall(MatTransposeGetMat(A01, &A01));
119113044ca3SPierre Jolivet     PetscCall(MatTranspose(A01, MAT_INITIAL_MATRIX, &B));
119213044ca3SPierre Jolivet     A01 = B;
119313044ca3SPierre Jolivet   } else {
119413044ca3SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATHERMITIANTRANSPOSEVIRTUAL, flg));
119513044ca3SPierre Jolivet     if (flg[0]) {
1196*811e8887SPierre Jolivet       PetscCall(MatShellGetScalingShifts(A01, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
119713044ca3SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A01, &A01));
119813044ca3SPierre Jolivet       PetscCall(MatHermitianTranspose(A01, MAT_INITIAL_MATRIX, &B));
119913044ca3SPierre Jolivet       A01 = B;
120013044ca3SPierre Jolivet     }
120113044ca3SPierre Jolivet   }
120213044ca3SPierre Jolivet   PetscCall(PetscLayoutCompare(T->rmap, A01->rmap, flg));
120313044ca3SPierre Jolivet   if (flg[0]) {
120413044ca3SPierre Jolivet     PetscCall(PetscLayoutCompare(T->cmap, A01->cmap, flg));
120513044ca3SPierre Jolivet     if (flg[0]) {
120613044ca3SPierre Jolivet       PetscCall(MatFindZeroRows(A01, &z)); /* for essential boundary conditions, some implementations will */
120713044ca3SPierre Jolivet       if (z) {                             /*  zero rows in [P00 A01] except for the diagonal of P00       */
120813044ca3SPierre Jolivet         PetscCall(MatSetOption(T, MAT_NO_OFF_PROC_ZERO_ROWS, PETSC_TRUE));
120913044ca3SPierre Jolivet         PetscCall(MatZeroRowsIS(T, z, 0.0, nullptr, nullptr)); /* corresponding zero rows from A01 */
121013044ca3SPierre Jolivet         PetscCall(ISDestroy(&z));
121113044ca3SPierre Jolivet       }
121213044ca3SPierre Jolivet       PetscCall(MatMultEqual(A01, T, 20, flg));
121313044ca3SPierre Jolivet       PetscCheck(flg[0], PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "A01 != A10^T");
121413044ca3SPierre Jolivet     } else PetscCall(PetscInfo(pc, "A01 and A10^T have non-congruent column layouts, cannot test for equality\n"));
121513044ca3SPierre Jolivet   }
121613044ca3SPierre Jolivet   PetscCall(MatDestroy(&B));
121713044ca3SPierre Jolivet   PetscCall(MatDestroy(&T));
121813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
121913044ca3SPierre Jolivet }
122013044ca3SPierre Jolivet 
1221d16c0b94SPierre Jolivet static PetscErrorCode PCHPDDMCheckInclusion_Private(PC pc, IS is, IS is_local, PetscBool check)
1222d16c0b94SPierre Jolivet {
1223d16c0b94SPierre Jolivet   IS          intersect;
1224d16c0b94SPierre Jolivet   const char *str = "IS of the auxiliary Mat does not include all local rows of A";
1225d16c0b94SPierre Jolivet   PetscBool   equal;
1226d16c0b94SPierre Jolivet 
1227d16c0b94SPierre Jolivet   PetscFunctionBegin;
1228d16c0b94SPierre Jolivet   PetscCall(ISIntersect(is, is_local, &intersect));
1229d16c0b94SPierre Jolivet   PetscCall(ISEqualUnsorted(is_local, intersect, &equal));
1230d16c0b94SPierre Jolivet   PetscCall(ISDestroy(&intersect));
1231d16c0b94SPierre Jolivet   if (check) PetscCheck(equal, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "%s", str);
1232d16c0b94SPierre Jolivet   else if (!equal) PetscCall(PetscInfo(pc, "%s\n", str));
1233d16c0b94SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1234d16c0b94SPierre Jolivet }
1235d16c0b94SPierre Jolivet 
1236d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMDestroySubMatrices_Private(PetscBool flg, PetscBool algebraic, Mat *sub)
1237d71ae5a4SJacob Faibussowitsch {
1238f1580f4eSBarry Smith   IS is;
1239f1580f4eSBarry Smith 
1240f1580f4eSBarry Smith   PetscFunctionBegin;
1241f1580f4eSBarry Smith   if (!flg) {
1242f1580f4eSBarry Smith     if (algebraic) {
1243f1580f4eSBarry Smith       PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Embed", (PetscObject *)&is));
1244f1580f4eSBarry Smith       PetscCall(ISDestroy(&is));
1245db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Embed", nullptr));
1246db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Compact", nullptr));
1247f1580f4eSBarry Smith     }
1248f1580f4eSBarry Smith     PetscCall(MatDestroySubMatrices(algebraic ? 2 : 1, &sub));
1249f1580f4eSBarry Smith   }
12503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1251f1580f4eSBarry Smith }
1252f1580f4eSBarry Smith 
1253d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMAlgebraicAuxiliaryMat_Private(Mat P, IS *is, Mat *sub[], PetscBool block)
1254d71ae5a4SJacob Faibussowitsch {
1255f1580f4eSBarry Smith   IS         icol[3], irow[2];
1256f1580f4eSBarry Smith   Mat       *M, Q;
1257f1580f4eSBarry Smith   PetscReal *ptr;
1258*811e8887SPierre Jolivet   PetscInt  *idx, p = 0, bs = PetscAbs(P->cmap->bs);
1259f1580f4eSBarry Smith   PetscBool  flg;
1260f1580f4eSBarry Smith 
1261f1580f4eSBarry Smith   PetscFunctionBegin;
1262f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, P->cmap->N, 0, 1, icol + 2));
1263f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(icol[2], bs));
1264f1580f4eSBarry Smith   PetscCall(ISSetIdentity(icol[2]));
1265f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1266f1580f4eSBarry Smith   if (flg) {
1267f1580f4eSBarry Smith     /* MatCreateSubMatrices() does not handle MATMPISBAIJ properly when iscol != isrow, so convert first to MATMPIBAIJ */
1268f1580f4eSBarry Smith     PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &Q));
1269f1580f4eSBarry Smith     std::swap(P, Q);
1270f1580f4eSBarry Smith   }
1271f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(P, 1, is, icol + 2, MAT_INITIAL_MATRIX, &M));
1272f1580f4eSBarry Smith   if (flg) {
1273f1580f4eSBarry Smith     std::swap(P, Q);
1274f1580f4eSBarry Smith     PetscCall(MatDestroy(&Q));
1275f1580f4eSBarry Smith   }
1276f1580f4eSBarry Smith   PetscCall(ISDestroy(icol + 2));
1277f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, M[0]->rmap->N, 0, 1, irow));
1278f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(irow[0], bs));
1279f1580f4eSBarry Smith   PetscCall(ISSetIdentity(irow[0]));
1280f1580f4eSBarry Smith   if (!block) {
1281b07dfdedSPierre Jolivet     PetscCall(PetscMalloc2(P->cmap->N, &ptr, P->cmap->N / bs, &idx));
1282f1580f4eSBarry Smith     PetscCall(MatGetColumnNorms(M[0], NORM_INFINITY, ptr));
1283f1580f4eSBarry Smith     /* check for nonzero columns so that M[0] may be expressed in compact form */
1284*811e8887SPierre Jolivet     for (PetscInt n = 0; n < P->cmap->N; n += bs) {
1285b07dfdedSPierre Jolivet       if (std::find_if(ptr + n, ptr + n + bs, [](PetscReal v) { return v > PETSC_MACHINE_EPSILON; }) != ptr + n + bs) idx[p++] = n / bs;
1286f1580f4eSBarry Smith     }
1287b07dfdedSPierre Jolivet     PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, p, idx, PETSC_USE_POINTER, icol + 1));
1288f1580f4eSBarry Smith     PetscCall(ISSetInfo(icol[1], IS_SORTED, IS_GLOBAL, PETSC_TRUE, PETSC_TRUE));
1289f1580f4eSBarry Smith     PetscCall(ISEmbed(*is, icol[1], PETSC_FALSE, icol + 2));
1290f1580f4eSBarry Smith     irow[1] = irow[0];
1291f1580f4eSBarry 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 */
1292f1580f4eSBarry Smith     icol[0] = is[0];
1293f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 2, irow, icol, MAT_INITIAL_MATRIX, sub));
1294f1580f4eSBarry Smith     PetscCall(ISDestroy(icol + 1));
1295f1580f4eSBarry Smith     PetscCall(PetscFree2(ptr, idx));
1296f1580f4eSBarry Smith     /* IS used to go back and forth between the augmented and the original local linear system, see eq. (3.4) of [2022b] */
1297f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Embed", (PetscObject)icol[2]));
1298f1580f4eSBarry Smith     /* Mat used in eq. (3.1) of [2022b] */
1299f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Compact", (PetscObject)(*sub)[1]));
1300f1580f4eSBarry Smith   } else {
1301f1580f4eSBarry Smith     Mat aux;
1302*811e8887SPierre Jolivet 
1303f1580f4eSBarry Smith     PetscCall(MatSetOption(M[0], MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1304f1580f4eSBarry Smith     /* diagonal block of the overlapping rows */
1305f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 1, irow, is, MAT_INITIAL_MATRIX, sub));
1306f1580f4eSBarry Smith     PetscCall(MatDuplicate((*sub)[0], MAT_COPY_VALUES, &aux));
1307f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1308f1580f4eSBarry Smith     if (bs == 1) { /* scalar case */
1309f1580f4eSBarry Smith       Vec sum[2];
1310*811e8887SPierre Jolivet 
1311f1580f4eSBarry Smith       PetscCall(MatCreateVecs(aux, sum, sum + 1));
1312f1580f4eSBarry Smith       PetscCall(MatGetRowSum(M[0], sum[0]));
1313f1580f4eSBarry Smith       PetscCall(MatGetRowSum(aux, sum[1]));
1314f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1315f1580f4eSBarry Smith       PetscCall(VecAXPY(sum[0], -1.0, sum[1]));
1316f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1317f1580f4eSBarry Smith       PetscCall(MatDiagonalSet(aux, sum[0], ADD_VALUES));
1318f1580f4eSBarry Smith       PetscCall(VecDestroy(sum));
1319f1580f4eSBarry Smith       PetscCall(VecDestroy(sum + 1));
1320f1580f4eSBarry Smith     } else { /* vectorial case */
1321f1580f4eSBarry Smith       /* TODO: missing MatGetValuesBlocked(), so the code below is     */
1322f1580f4eSBarry Smith       /* an extension of the scalar case for when bs > 1, but it could */
1323f1580f4eSBarry Smith       /* be more efficient by avoiding all these MatMatMult()          */
1324f1580f4eSBarry Smith       Mat          sum[2], ones;
1325f1580f4eSBarry Smith       PetscScalar *ptr;
1326*811e8887SPierre Jolivet 
1327f1580f4eSBarry Smith       PetscCall(PetscCalloc1(M[0]->cmap->n * bs, &ptr));
1328f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, M[0]->cmap->n, bs, M[0]->cmap->n, bs, ptr, &ones));
1329*811e8887SPierre Jolivet       for (PetscInt n = 0; n < M[0]->cmap->n; n += bs) {
1330f1580f4eSBarry Smith         for (p = 0; p < bs; ++p) ptr[n + p * (M[0]->cmap->n + 1)] = 1.0;
1331f1580f4eSBarry Smith       }
1332fb842aefSJose E. Roman       PetscCall(MatMatMult(M[0], ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum));
1333f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1334f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, aux->cmap->n, bs, aux->cmap->n, bs, ptr, &ones));
1335f1580f4eSBarry Smith       PetscCall(MatDenseSetLDA(ones, M[0]->cmap->n));
1336fb842aefSJose E. Roman       PetscCall(MatMatMult(aux, ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum + 1));
1337f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1338f1580f4eSBarry Smith       PetscCall(PetscFree(ptr));
1339f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1340f1580f4eSBarry Smith       PetscCall(MatAXPY(sum[0], -1.0, sum[1], SAME_NONZERO_PATTERN));
1341f1580f4eSBarry Smith       PetscCall(MatDestroy(sum + 1));
1342f1580f4eSBarry Smith       /* re-order values to be consistent with MatSetValuesBlocked()           */
1343f1580f4eSBarry Smith       /* equivalent to MatTranspose() which does not truly handle              */
1344f1580f4eSBarry Smith       /* MAT_INPLACE_MATRIX in the rectangular case, as it calls PetscMalloc() */
1345f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(sum[0], &ptr));
1346f1580f4eSBarry Smith       HPDDM::Wrapper<PetscScalar>::imatcopy<'T'>(bs, sum[0]->rmap->n, ptr, sum[0]->rmap->n, bs);
1347f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1348*811e8887SPierre Jolivet       for (PetscInt n = 0; n < aux->cmap->n / bs; ++n) PetscCall(MatSetValuesBlocked(aux, 1, &n, 1, &n, ptr + n * bs * bs, ADD_VALUES));
1349f1580f4eSBarry Smith       PetscCall(MatAssemblyBegin(aux, MAT_FINAL_ASSEMBLY));
1350f1580f4eSBarry Smith       PetscCall(MatAssemblyEnd(aux, MAT_FINAL_ASSEMBLY));
1351f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(sum[0], &ptr));
1352f1580f4eSBarry Smith       PetscCall(MatDestroy(sum));
1353f1580f4eSBarry Smith     }
1354f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
1355f1580f4eSBarry Smith     /* left-hand side of GenEO, with the same sparsity pattern as PCASM subdomain solvers  */
1356f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Neumann_Mat", (PetscObject)aux));
1357f1580f4eSBarry Smith   }
1358f1580f4eSBarry Smith   PetscCall(ISDestroy(irow));
1359f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &M));
13603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1361f1580f4eSBarry Smith }
1362f1580f4eSBarry Smith 
136313044ca3SPierre Jolivet static PetscErrorCode PCApply_Nest(PC pc, Vec x, Vec y)
136413044ca3SPierre Jolivet {
136513044ca3SPierre Jolivet   Mat                    A;
136613044ca3SPierre Jolivet   MatSolverType          type;
136713044ca3SPierre Jolivet   IS                     is[2];
136813044ca3SPierre Jolivet   PetscBool              flg;
136913044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
137013044ca3SPierre Jolivet 
137113044ca3SPierre Jolivet   PetscFunctionBegin;
137213044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
137313044ca3SPierre Jolivet   PetscCall(PCGetOperators(p->first, &A, nullptr));
137413044ca3SPierre Jolivet   PetscCall(MatNestGetISs(A, is, nullptr));
137513044ca3SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(p->first, &type));
137613044ca3SPierre Jolivet   PetscCall(PCFactorGetMatrix(p->first, &A));
137713044ca3SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
137824ddd604SPierre Jolivet   if (flg && A->schur) {
137913044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
138013044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 1)); /* reduction/condensation phase followed by Schur complement solve */
138113044ca3SPierre Jolivet #endif
138213044ca3SPierre Jolivet   }
138313044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[0], is[1], SCATTER_FORWARD, x)); /* assign the RHS associated to the Schur complement */
138413044ca3SPierre Jolivet   PetscCall(PCApply(p->first, p->second[0], p->second[1]));
138513044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[1], is[1], SCATTER_REVERSE, y)); /* retrieve the partial solution associated to the Schur complement */
138613044ca3SPierre Jolivet   if (flg) {
138713044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
138813044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1)); /* default ICNTL(26) value in PETSc */
138913044ca3SPierre Jolivet #endif
139013044ca3SPierre Jolivet   }
139113044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
139213044ca3SPierre Jolivet }
139313044ca3SPierre Jolivet 
139413044ca3SPierre Jolivet static PetscErrorCode PCView_Nest(PC pc, PetscViewer viewer)
139513044ca3SPierre Jolivet {
139613044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
139713044ca3SPierre Jolivet 
139813044ca3SPierre Jolivet   PetscFunctionBegin;
139913044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
140013044ca3SPierre Jolivet   PetscCall(PCView(p->first, viewer));
140113044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
140213044ca3SPierre Jolivet }
140313044ca3SPierre Jolivet 
140413044ca3SPierre Jolivet static PetscErrorCode PCDestroy_Nest(PC pc)
140513044ca3SPierre Jolivet {
140613044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
140713044ca3SPierre Jolivet 
140813044ca3SPierre Jolivet   PetscFunctionBegin;
140913044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
141013044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second));
141113044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second + 1));
141213044ca3SPierre Jolivet   PetscCall(PCDestroy(&p->first));
141313044ca3SPierre Jolivet   PetscCall(PetscFree(p));
141413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
141513044ca3SPierre Jolivet }
141613044ca3SPierre Jolivet 
141713044ca3SPierre Jolivet template <bool T = false>
141813044ca3SPierre Jolivet static PetscErrorCode MatMult_Schur(Mat A, Vec x, Vec y)
141913044ca3SPierre Jolivet {
142001e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
142113044ca3SPierre Jolivet 
142213044ca3SPierre Jolivet   PetscFunctionBegin;
142313044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
142413044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD)); /* local Vec with overlap */
142513044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD));
142613044ca3SPierre Jolivet   if (!T) PetscCall(MatMult(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1])); /* local Schur complement */
142713044ca3SPierre Jolivet   else PetscCall(MatMultTranspose(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1]));
142813044ca3SPierre Jolivet   PetscCall(VecSet(y, 0.0));
142913044ca3SPierre 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 */
143013044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE));
143113044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
143213044ca3SPierre Jolivet }
143313044ca3SPierre Jolivet 
143413044ca3SPierre Jolivet static PetscErrorCode MatDestroy_Schur(Mat A)
143513044ca3SPierre Jolivet {
143601e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
143713044ca3SPierre Jolivet 
143813044ca3SPierre Jolivet   PetscFunctionBegin;
143913044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
144013044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx)));
144113044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx) + 1));
144213044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
144313044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
144413044ca3SPierre Jolivet }
144513044ca3SPierre Jolivet 
144613044ca3SPierre Jolivet static PetscErrorCode MatMult_SchurCorrection(Mat A, Vec x, Vec y)
144713044ca3SPierre Jolivet {
144813044ca3SPierre Jolivet   PC                                         pc;
144913044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
145013044ca3SPierre Jolivet 
145113044ca3SPierre Jolivet   PetscFunctionBegin;
145213044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
145313044ca3SPierre Jolivet   pc = ((PC_HPDDM *)std::get<0>(*ctx)[0]->data)->levels[0]->ksp->pc;
145413044ca3SPierre 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 */
145513044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], x, std::get<3>(*ctx)[1]));                    /*     A_01 x                 */
145613044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 x             */
145713044ca3SPierre 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        */
145813044ca3SPierre 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 */
145913044ca3SPierre Jolivet   } else {
146013044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[0]));                    /*     M_S^-1 x               */
146113044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], std::get<3>(*ctx)[0], std::get<3>(*ctx)[1])); /*     A_01 M_S^-1 x          */
146213044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 M_S^-1 x      */
146313044ca3SPierre 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 */
146413044ca3SPierre Jolivet   }
146513044ca3SPierre Jolivet   PetscCall(VecAXPY(y, -1.0, x)); /* y -= x, preconditioned eq. (24) of https://hal.science/hal-02343808v6/document (with a sign flip) */
146613044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
146713044ca3SPierre Jolivet }
146813044ca3SPierre Jolivet 
146913044ca3SPierre Jolivet static PetscErrorCode MatView_SchurCorrection(Mat A, PetscViewer viewer)
147013044ca3SPierre Jolivet {
147113044ca3SPierre Jolivet   PetscBool                                  ascii;
147213044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
147313044ca3SPierre Jolivet 
147413044ca3SPierre Jolivet   PetscFunctionBegin;
147513044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &ascii));
147613044ca3SPierre Jolivet   if (ascii) {
147713044ca3SPierre Jolivet     PetscCall(MatShellGetContext(A, &ctx));
147813044ca3SPierre 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)"));
147913044ca3SPierre Jolivet     PetscCall(PCView(std::get<0>(*ctx)[1], viewer)); /* no need to PCView(Q_0) since it will be done by PCFIELDSPLIT */
148013044ca3SPierre Jolivet   }
148113044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
148213044ca3SPierre Jolivet }
148313044ca3SPierre Jolivet 
148413044ca3SPierre Jolivet static PetscErrorCode MatDestroy_SchurCorrection(Mat A)
148513044ca3SPierre Jolivet {
148613044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
148713044ca3SPierre Jolivet 
148813044ca3SPierre Jolivet   PetscFunctionBegin;
148913044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
149013044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx)));
149113044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 1));
149213044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 2));
149313044ca3SPierre Jolivet   PetscCall(PCDestroy(std::get<0>(*ctx) + 1));
149413044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
149513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
149613044ca3SPierre Jolivet }
149713044ca3SPierre Jolivet 
149813044ca3SPierre Jolivet static PetscErrorCode KSPPreSolve_SchurCorrection(KSP, Vec b, Vec, void *context)
149913044ca3SPierre Jolivet {
150013044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
150113044ca3SPierre Jolivet 
1502a6b3e571SPierre Jolivet   PetscFunctionBegin;
150313044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
150413044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], b, std::get<3>(*ctx)[2]));
150513044ca3SPierre 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 */
150613044ca3SPierre Jolivet   }
150713044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
150813044ca3SPierre Jolivet }
150913044ca3SPierre Jolivet 
151013044ca3SPierre Jolivet static PetscErrorCode KSPPostSolve_SchurCorrection(KSP, Vec b, Vec x, void *context)
151113044ca3SPierre Jolivet {
151213044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
151313044ca3SPierre Jolivet 
1514a6b3e571SPierre Jolivet   PetscFunctionBegin;
151513044ca3SPierre 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 */
151613044ca3SPierre Jolivet   else {
151713044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[2]));
151813044ca3SPierre Jolivet     PetscCall(VecCopy(std::get<3>(*ctx)[2], x)); /* replace x by M^-1 x */
151913044ca3SPierre Jolivet   }
152013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
152113044ca3SPierre Jolivet }
152213044ca3SPierre Jolivet 
15239bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat, Vec, Vec);
15249bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat, Vec, Vec);
15259bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat, Mat, Mat, void *);
15269bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat);
15279bb5c669SPierre Jolivet 
1528d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDM(PC pc)
1529d71ae5a4SJacob Faibussowitsch {
1530f1580f4eSBarry Smith   PC_HPDDM                                  *data = (PC_HPDDM *)pc->data;
1531f1580f4eSBarry Smith   PC                                         inner;
1532f1580f4eSBarry Smith   KSP                                       *ksp;
153313044ca3SPierre Jolivet   Mat                                       *sub, A, P, N, C = nullptr, uaux = nullptr, weighted, subA[2], S;
1534f1580f4eSBarry Smith   Vec                                        xin, v;
1535f1580f4eSBarry Smith   std::vector<Vec>                           initial;
1536db4a47b3SPierre Jolivet   IS                                         is[1], loc, uis = data->is, unsorted = nullptr;
1537f1580f4eSBarry Smith   ISLocalToGlobalMapping                     l2g;
1538f1580f4eSBarry Smith   char                                       prefix[256];
1539f1580f4eSBarry Smith   const char                                *pcpre;
1540f1580f4eSBarry Smith   const PetscScalar *const                  *ev;
15419bb5c669SPierre Jolivet   PetscInt                                   n, requested = data->N, reused = 0, overlap = -1;
1542f1580f4eSBarry Smith   MatStructure                               structure  = UNKNOWN_NONZERO_PATTERN;
1543f1580f4eSBarry Smith   PetscBool                                  subdomains = PETSC_FALSE, flg = PETSC_FALSE, ismatis, swap = PETSC_FALSE, algebraic = PETSC_FALSE, block = PETSC_FALSE;
1544f1580f4eSBarry Smith   DM                                         dm;
154513044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = nullptr;
1546398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1547db4a47b3SPierre Jolivet   IS  dis  = nullptr;
1548db4a47b3SPierre Jolivet   Mat daux = nullptr;
1549398c7888SPierre Jolivet #endif
1550f1580f4eSBarry Smith 
1551f1580f4eSBarry Smith   PetscFunctionBegin;
1552f1580f4eSBarry Smith   PetscCheck(data->levels && data->levels[0], PETSC_COMM_SELF, PETSC_ERR_PLIB, "Not a single level allocated");
1553f1580f4eSBarry Smith   PetscCall(PCGetOptionsPrefix(pc, &pcpre));
1554f1580f4eSBarry Smith   PetscCall(PCGetOperators(pc, &A, &P));
1555f1580f4eSBarry Smith   if (!data->levels[0]->ksp) {
1556f1580f4eSBarry Smith     PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->ksp));
15573821be0aSBarry Smith     PetscCall(KSPSetNestLevel(data->levels[0]->ksp, pc->kspnestlevel));
1558f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_%s_", pcpre ? pcpre : "", data->N > 1 ? "levels_1" : "coarse"));
1559f1580f4eSBarry Smith     PetscCall(KSPSetOptionsPrefix(data->levels[0]->ksp, prefix));
1560f1580f4eSBarry Smith     PetscCall(KSPSetType(data->levels[0]->ksp, KSPPREONLY));
1561f1580f4eSBarry Smith   } else if (data->levels[0]->ksp->pc && data->levels[0]->ksp->pc->setupcalled == 1 && data->levels[0]->ksp->pc->reusepreconditioner) {
1562f1580f4eSBarry Smith     /* if the fine-level PCSHELL exists, its setup has succeeded, and one wants to reuse it, */
1563f1580f4eSBarry Smith     /* then just propagate the appropriate flag to the coarser levels                        */
1564f1580f4eSBarry Smith     for (n = 0; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1565f1580f4eSBarry Smith       /* the following KSP and PC may be NULL for some processes, hence the check            */
1566f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetReusePreconditioner(data->levels[n]->ksp, PETSC_TRUE));
1567f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
1568f1580f4eSBarry Smith     }
1569f1580f4eSBarry Smith     /* early bail out because there is nothing to do */
15703ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1571f1580f4eSBarry Smith   } else {
1572f1580f4eSBarry Smith     /* reset coarser levels */
1573f1580f4eSBarry Smith     for (n = 1; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1574f1580f4eSBarry 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) {
1575f1580f4eSBarry Smith         reused = data->N - n;
1576f1580f4eSBarry Smith         break;
1577f1580f4eSBarry Smith       }
1578f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[n]->ksp));
1579f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[n]->pc));
1580f1580f4eSBarry Smith     }
1581f1580f4eSBarry Smith     /* check if some coarser levels are being reused */
1582f1580f4eSBarry Smith     PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &reused, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)pc)));
1583f1580f4eSBarry Smith     const int *addr = data->levels[0]->P ? data->levels[0]->P->getAddrLocal() : &HPDDM::i__0;
1584f1580f4eSBarry Smith 
1585f1580f4eSBarry Smith     if (addr != &HPDDM::i__0 && reused != data->N - 1) {
1586f1580f4eSBarry Smith       /* reuse previously computed eigenvectors */
1587f1580f4eSBarry Smith       ev = data->levels[0]->P->getVectors();
1588f1580f4eSBarry Smith       if (ev) {
1589f1580f4eSBarry Smith         initial.reserve(*addr);
1590f1580f4eSBarry Smith         PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, data->levels[0]->P->getDof(), ev[0], &xin));
1591f1580f4eSBarry Smith         for (n = 0; n < *addr; ++n) {
1592f1580f4eSBarry Smith           PetscCall(VecDuplicate(xin, &v));
1593f1580f4eSBarry Smith           PetscCall(VecPlaceArray(xin, ev[n]));
1594f1580f4eSBarry Smith           PetscCall(VecCopy(xin, v));
1595f1580f4eSBarry Smith           initial.emplace_back(v);
1596f1580f4eSBarry Smith           PetscCall(VecResetArray(xin));
1597f1580f4eSBarry Smith         }
1598f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
1599f1580f4eSBarry Smith       }
1600f1580f4eSBarry Smith     }
1601f1580f4eSBarry Smith   }
1602f1580f4eSBarry Smith   data->N -= reused;
1603f1580f4eSBarry Smith   PetscCall(KSPSetOperators(data->levels[0]->ksp, A, P));
1604f1580f4eSBarry Smith 
1605f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATIS, &ismatis));
1606f1580f4eSBarry Smith   if (!data->is && !ismatis) {
1607db4a47b3SPierre Jolivet     PetscErrorCode (*create)(DM, IS *, Mat *, PetscErrorCode (**)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void **) = nullptr;
1608db4a47b3SPierre Jolivet     PetscErrorCode (*usetup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *)                                                = nullptr;
1609db4a47b3SPierre Jolivet     void *uctx                                                                                                               = nullptr;
1610f1580f4eSBarry Smith 
1611f1580f4eSBarry Smith     /* first see if we can get the data from the DM */
1612f1580f4eSBarry Smith     PetscCall(MatGetDM(P, &dm));
1613f1580f4eSBarry Smith     if (!dm) PetscCall(MatGetDM(A, &dm));
1614f1580f4eSBarry Smith     if (!dm) PetscCall(PCGetDM(pc, &dm));
1615907a3e9cSStefano Zampini     if (dm) { /* this is the hook for DMPLEX for which the auxiliary Mat is the local Neumann matrix */
1616f1580f4eSBarry Smith       PetscCall(PetscObjectQueryFunction((PetscObject)dm, "DMCreateNeumannOverlap_C", &create));
1617f1580f4eSBarry Smith       if (create) {
1618f1580f4eSBarry Smith         PetscCall((*create)(dm, &uis, &uaux, &usetup, &uctx));
1619c8ea6600SPierre 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 */
1620f1580f4eSBarry Smith       }
1621f1580f4eSBarry Smith     }
1622f1580f4eSBarry Smith     if (!create) {
1623f1580f4eSBarry Smith       if (!uis) {
1624f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1625f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1626f1580f4eSBarry Smith       }
1627f1580f4eSBarry Smith       if (!uaux) {
1628f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1629f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1630f1580f4eSBarry Smith       }
1631f1580f4eSBarry Smith       /* look inside the Pmat instead of the PC, needed for MatSchurComplementComputeExplicitOperator() */
1632f1580f4eSBarry Smith       if (!uis) {
1633f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1634f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1635f1580f4eSBarry Smith       }
1636f1580f4eSBarry Smith       if (!uaux) {
1637f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1638f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1639f1580f4eSBarry Smith       }
1640f1580f4eSBarry Smith     }
1641f1580f4eSBarry Smith     PetscCall(PCHPDDMSetAuxiliaryMat(pc, uis, uaux, usetup, uctx));
1642f1580f4eSBarry Smith     PetscCall(MatDestroy(&uaux));
1643f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
1644f1580f4eSBarry Smith   }
1645f1580f4eSBarry Smith 
1646f1580f4eSBarry Smith   if (!ismatis) {
1647f1580f4eSBarry Smith     PetscCall(PCHPDDMSetUpNeumannOverlap_Private(pc));
1648db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_block_splitting", &block, nullptr));
16499bb5c669SPierre Jolivet     PetscCall(PetscOptionsGetInt(nullptr, pcpre, "-pc_hpddm_harmonic_overlap", &overlap, nullptr));
16505e642048SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
16515e642048SPierre Jolivet     if (data->is || (data->N > 1 && flg)) {
16529bb5c669SPierre Jolivet       if (block || overlap != -1) {
165302800ff6SPierre Jolivet         PetscCall(ISDestroy(&data->is));
165402800ff6SPierre Jolivet         PetscCall(MatDestroy(&data->aux));
16555e642048SPierre Jolivet       } else if (data->N > 1 && flg) {
165613044ca3SPierre Jolivet         PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_GENEO;
165713044ca3SPierre Jolivet 
165813044ca3SPierre Jolivet         PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
165913044ca3SPierre Jolivet         if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
166013044ca3SPierre Jolivet           PetscCall(ISDestroy(&data->is)); /* destroy any previously user-set objects since they will be set automatically */
166113044ca3SPierre Jolivet           PetscCall(MatDestroy(&data->aux));
166213044ca3SPierre Jolivet         } else if (type == PC_HPDDM_SCHUR_PRE_GENEO) {
166313044ca3SPierre Jolivet           PetscContainer container = nullptr;
166413044ca3SPierre Jolivet 
166513044ca3SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Schur", (PetscObject *)&container));
166613044ca3SPierre Jolivet           if (!container) { /* first call to PCSetUp() on the PC associated to the Schur complement */
166713044ca3SPierre Jolivet             PC_HPDDM *data_00;
166813044ca3SPierre Jolivet             KSP       ksp, inner_ksp;
166913044ca3SPierre Jolivet             PC        pc_00;
1670cf67ef9dSPierre Jolivet             Mat       A11 = nullptr;
1671cf67ef9dSPierre Jolivet             Vec       d   = nullptr;
167213044ca3SPierre Jolivet             char     *prefix;
167313044ca3SPierre Jolivet 
167413044ca3SPierre Jolivet             PetscCall(MatSchurComplementGetKSP(P, &ksp));
167513044ca3SPierre Jolivet             PetscCall(KSPGetPC(ksp, &pc_00));
167613044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)pc_00, PCHPDDM, &flg));
1677fd310a01SPierre 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 : "",
167813044ca3SPierre Jolivet                        ((PetscObject)pc_00)->type_name, PCHPDDM);
167913044ca3SPierre Jolivet             data_00 = (PC_HPDDM *)pc_00->data;
1680fd310a01SPierre 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],
1681fd310a01SPierre Jolivet                        data_00->N, data_00->N > 1 ? "s" : "", ((PetscObject)pc_00)->prefix);
168213044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)data_00->levels[0]->pc, PCASM, &flg));
1683fd310a01SPierre 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,
168413044ca3SPierre Jolivet                        ((PetscObject)data_00->levels[0]->pc)->type_name, PCASM);
1685d16c0b94SPierre Jolivet             PetscCall(MatSchurComplementGetSubMatrices(P, nullptr, nullptr, nullptr, nullptr, &A11));
16865e642048SPierre Jolivet             if (PetscDefined(USE_DEBUG) || !data->is) {
16875e642048SPierre Jolivet               Mat A01, A10, B = nullptr, C = nullptr, *sub;
168813044ca3SPierre Jolivet 
16895e642048SPierre Jolivet               PetscCall(MatSchurComplementGetSubMatrices(P, &A, nullptr, &A01, &A10, nullptr));
16905e642048SPierre Jolivet               PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
16915e642048SPierre Jolivet               if (flg) {
16925e642048SPierre Jolivet                 PetscCall(MatTransposeGetMat(A10, &C));
16935e642048SPierre Jolivet                 PetscCall(MatTranspose(C, MAT_INITIAL_MATRIX, &B));
16945e642048SPierre Jolivet               } else {
16955e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
16965e642048SPierre Jolivet                 if (flg) {
16975e642048SPierre Jolivet                   PetscCall(MatHermitianTransposeGetMat(A10, &C));
16985e642048SPierre Jolivet                   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &B));
16995e642048SPierre Jolivet                 }
17005e642048SPierre Jolivet               }
1701*811e8887SPierre Jolivet               if (flg)
1702*811e8887SPierre Jolivet                 PetscCall(MatShellGetScalingShifts(A10, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
17035e642048SPierre Jolivet               if (!B) {
17045e642048SPierre Jolivet                 B = A10;
17055e642048SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)B));
17065e642048SPierre Jolivet               } else if (!data->is) {
17075e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompareAny((PetscObject)A01, &flg, MATTRANSPOSEVIRTUAL, MATHERMITIANTRANSPOSEVIRTUAL, ""));
17085e642048SPierre Jolivet                 if (!flg) C = A01;
1709*811e8887SPierre Jolivet                 else
1710*811e8887SPierre Jolivet                   PetscCall(MatShellGetScalingShifts(A01, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
17115e642048SPierre Jolivet               }
171213044ca3SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, B->rmap->N, 0, 1, &uis));
17135e642048SPierre Jolivet               PetscCall(ISSetIdentity(uis));
17145e642048SPierre Jolivet               if (!data->is) {
17155e642048SPierre Jolivet                 if (C) PetscCall(PetscObjectReference((PetscObject)C));
17165e642048SPierre Jolivet                 else PetscCall(MatTranspose(B, MAT_INITIAL_MATRIX, &C));
17175e642048SPierre Jolivet                 PetscCall(ISDuplicate(data_00->is, is));
17185e642048SPierre Jolivet                 PetscCall(MatIncreaseOverlap(A, 1, is, 1));
17195e642048SPierre Jolivet                 PetscCall(MatSetOption(C, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
17205e642048SPierre Jolivet                 PetscCall(MatCreateSubMatrices(C, 1, is, &uis, MAT_INITIAL_MATRIX, &sub));
17215e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
17225e642048SPierre Jolivet                 PetscCall(MatTranspose(sub[0], MAT_INITIAL_MATRIX, &C));
17235e642048SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
17245e642048SPierre Jolivet                 PetscCall(MatFindNonzeroRows(C, &data->is));
17255e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
17265e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
1727d16c0b94SPierre Jolivet                 PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), A11->rmap->n, A11->rmap->rstart, 1, &loc));
1728d16c0b94SPierre Jolivet                 if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_FALSE));
1729d16c0b94SPierre Jolivet                 PetscCall(ISExpand(data->is, loc, is));
1730d16c0b94SPierre Jolivet                 PetscCall(ISDestroy(&loc));
1731d16c0b94SPierre Jolivet                 PetscCall(ISDestroy(&data->is));
1732d16c0b94SPierre Jolivet                 data->is = is[0];
1733d16c0b94SPierre Jolivet                 is[0]    = nullptr;
17345e642048SPierre Jolivet               }
17355e642048SPierre Jolivet               if (PetscDefined(USE_DEBUG)) {
17365e642048SPierre Jolivet                 PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
173713044ca3SPierre 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 */
173813044ca3SPierre Jolivet                 PetscCall(ISDestroy(&uis));
173913044ca3SPierre Jolivet                 PetscCall(ISDuplicate(data->is, &uis));
174013044ca3SPierre Jolivet                 PetscCall(ISSort(uis));
17415e642048SPierre Jolivet                 PetscCall(ISComplement(uis, 0, B->rmap->N, is));
174213044ca3SPierre Jolivet                 PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &C));
17435e642048SPierre Jolivet                 PetscCall(MatZeroRowsIS(C, is[0], 0.0, nullptr, nullptr));
17445e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
174513044ca3SPierre Jolivet                 PetscCall(MatMultEqual(sub[0], C, 20, &flg));
174613044ca3SPierre 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 */
174713044ca3SPierre Jolivet                 PetscCall(MatDestroy(&C));
174813044ca3SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
174913044ca3SPierre Jolivet               }
17505e642048SPierre Jolivet               PetscCall(ISDestroy(&uis));
17515e642048SPierre Jolivet               PetscCall(MatDestroy(&B));
17525e642048SPierre Jolivet             }
1753cf67ef9dSPierre Jolivet             flg = PETSC_FALSE;
1754cf67ef9dSPierre Jolivet             if (!data->aux) {
1755cf67ef9dSPierre Jolivet               Mat D;
1756cf67ef9dSPierre Jolivet 
1757cf67ef9dSPierre Jolivet               PetscCall(MatCreateVecs(A11, &d, nullptr));
1758cf67ef9dSPierre Jolivet               PetscCall(MatGetDiagonal(A11, d));
1759cf67ef9dSPierre Jolivet               PetscCall(PetscObjectTypeCompareAny((PetscObject)A11, &flg, MATDIAGONAL, MATCONSTANTDIAGONAL, ""));
1760cf67ef9dSPierre Jolivet               if (!flg) {
1761cf67ef9dSPierre Jolivet                 PetscCall(MatCreateDiagonal(d, &D));
1762cf67ef9dSPierre Jolivet                 PetscCall(MatMultEqual(A11, D, 20, &flg));
1763cf67ef9dSPierre Jolivet                 PetscCall(MatDestroy(&D));
1764cf67ef9dSPierre Jolivet               }
1765cf67ef9dSPierre Jolivet               if (flg) PetscCall(PetscInfo(pc, "A11 block is likely diagonal so the PC will build an auxiliary Mat (which was not initially provided by the user)\n"));
1766cf67ef9dSPierre Jolivet             }
1767cf67ef9dSPierre Jolivet             if (data->Neumann != PETSC_BOOL3_TRUE && !flg && A11) {
1768cf67ef9dSPierre Jolivet               PetscReal norm;
1769cf67ef9dSPierre Jolivet 
1770cf67ef9dSPierre Jolivet               PetscCall(MatNorm(A11, NORM_INFINITY, &norm));
1771cf67ef9dSPierre Jolivet               PetscCheck(norm < PETSC_MACHINE_EPSILON * static_cast<PetscReal>(10.0), PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_schur_precondition geneo and -%spc_hpddm_has_neumann != true with a nonzero or non-diagonal A11 block", pcpre ? pcpre : "", pcpre ? pcpre : "");
1772cf67ef9dSPierre Jolivet               PetscCall(PetscInfo(pc, "A11 block is likely zero so the PC will build an auxiliary Mat (which was%s initially provided by the user)\n", data->aux ? "" : " not"));
1773cf67ef9dSPierre Jolivet               PetscCall(MatDestroy(&data->aux));
1774cf67ef9dSPierre Jolivet               flg = PETSC_TRUE;
1775cf67ef9dSPierre Jolivet             }
1776cf67ef9dSPierre Jolivet             if (!data->aux) { /* if A11 is near zero, e.g., Stokes equation, or diagonal, build an auxiliary (Neumann) Mat which is a (possibly slightly shifted) diagonal weighted by the inverse of the multiplicity */
177701e3c840SPierre Jolivet               PetscSF            scatter;
177813044ca3SPierre Jolivet               const PetscScalar *read;
1779cf67ef9dSPierre Jolivet               PetscScalar       *write, *diagonal = nullptr;
178013044ca3SPierre Jolivet 
178113044ca3SPierre Jolivet               PetscCall(MatDestroy(&data->aux));
178213044ca3SPierre Jolivet               PetscCall(ISGetLocalSize(data->is, &n));
1783cf67ef9dSPierre Jolivet               PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &xin));
1784cf67ef9dSPierre Jolivet               PetscCall(VecDuplicate(xin, &v));
1785cf67ef9dSPierre Jolivet               PetscCall(VecScatterCreate(xin, data->is, v, nullptr, &scatter));
178613044ca3SPierre Jolivet               PetscCall(VecSet(v, 1.0));
1787cf67ef9dSPierre Jolivet               PetscCall(VecSet(xin, 1.0));
1788cf67ef9dSPierre Jolivet               PetscCall(VecScatterBegin(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE));
1789cf67ef9dSPierre Jolivet               PetscCall(VecScatterEnd(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE)); /* v has the multiplicity of all unknowns on the overlap */
1790cf67ef9dSPierre Jolivet               PetscCall(PetscSFDestroy(&scatter));
1791cf67ef9dSPierre Jolivet               if (d) {
1792cf67ef9dSPierre Jolivet                 PetscCall(VecScatterCreate(d, data->is, v, nullptr, &scatter));
1793cf67ef9dSPierre Jolivet                 PetscCall(VecScatterBegin(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1794cf67ef9dSPierre Jolivet                 PetscCall(VecScatterEnd(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1795cf67ef9dSPierre Jolivet                 PetscCall(PetscSFDestroy(&scatter));
1796cf67ef9dSPierre Jolivet                 PetscCall(VecDestroy(&d));
1797cf67ef9dSPierre Jolivet                 PetscCall(PetscMalloc1(n, &diagonal));
1798cf67ef9dSPierre Jolivet                 PetscCall(VecGetArrayRead(v, &read));
1799cf67ef9dSPierre Jolivet                 PetscCallCXX(std::copy_n(read, n, diagonal));
1800cf67ef9dSPierre Jolivet                 PetscCall(VecRestoreArrayRead(v, &read));
1801cf67ef9dSPierre Jolivet               }
180213044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
180313044ca3SPierre Jolivet               PetscCall(VecCreateSeq(PETSC_COMM_SELF, n, &v));
1804cf67ef9dSPierre Jolivet               PetscCall(VecGetArrayRead(xin, &read));
180513044ca3SPierre Jolivet               PetscCall(VecGetArrayWrite(v, &write));
1806cf67ef9dSPierre Jolivet               for (PetscInt i = 0; i < n; ++i) write[i] = (!diagonal || std::abs(diagonal[i]) < PETSC_MACHINE_EPSILON) ? PETSC_SMALL / (static_cast<PetscReal>(1000.0) * read[i]) : diagonal[i] / read[i];
1807cf67ef9dSPierre Jolivet               PetscCall(PetscFree(diagonal));
1808cf67ef9dSPierre Jolivet               PetscCall(VecRestoreArrayRead(xin, &read));
180913044ca3SPierre Jolivet               PetscCall(VecRestoreArrayWrite(v, &write));
1810cf67ef9dSPierre Jolivet               PetscCall(VecDestroy(&xin));
1811c3e1b152SPierre Jolivet               PetscCall(MatCreateDiagonal(v, &data->aux));
181213044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
181313044ca3SPierre Jolivet             }
181413044ca3SPierre Jolivet             uis  = data->is;
181513044ca3SPierre Jolivet             uaux = data->aux;
181613044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uis));
181713044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uaux));
181813044ca3SPierre Jolivet             PetscCall(PetscStrallocpy(pcpre, &prefix));
181913044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(pc, nullptr));
182013044ca3SPierre Jolivet             PetscCall(PCSetType(pc, PCKSP));                                    /* replace the PC associated to the Schur complement by PCKSP */
182113044ca3SPierre Jolivet             PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &inner_ksp)); /* new KSP that will be attached to the previously set PC */
182273329a61SPierre Jolivet             pc->ops->setup = PCSetUp_KSP;
182313044ca3SPierre Jolivet             PetscCall(PetscObjectGetTabLevel((PetscObject)pc, &n));
182413044ca3SPierre Jolivet             PetscCall(PetscObjectSetTabLevel((PetscObject)inner_ksp, n + 2));
182513044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, pc->mat, pc->pmat));
182613044ca3SPierre Jolivet             PetscCall(KSPSetOptionsPrefix(inner_ksp, std::string(std::string(prefix) + "pc_hpddm_").c_str()));
182713044ca3SPierre Jolivet             PetscCall(KSPSetSkipPCSetFromOptions(inner_ksp, PETSC_TRUE));
182813044ca3SPierre Jolivet             PetscCall(KSPSetFromOptions(inner_ksp));
182913044ca3SPierre Jolivet             PetscCall(KSPGetPC(inner_ksp, &inner));
183013044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(inner, nullptr));
183113044ca3SPierre Jolivet             PetscCall(PCSetType(inner, PCNONE)); /* no preconditioner since the action of M^-1 A or A M^-1 will be computed by the Amat */
183213044ca3SPierre Jolivet             PetscCall(PCKSPSetKSP(pc, inner_ksp));
183313044ca3SPierre Jolivet             PetscCall(PetscContainerCreate(PetscObjectComm((PetscObject)pc), &container));
183413044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx)); /* context to pass data around for the inner-most PC, which will be a proper PCHPDDM */
183513044ca3SPierre Jolivet             PetscCall(PetscContainerSetPointer(container, ctx));
183613044ca3SPierre Jolivet             std::get<0>(*ctx)[0] = pc_00; /* for coarse correction on the primal (e.g., velocity) space */
183713044ca3SPierre Jolivet             PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &std::get<0>(*ctx)[1]));
183813044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(std::get<0>(*ctx)[1], prefix));
183913044ca3SPierre Jolivet             PetscCall(PetscFree(prefix));
184013044ca3SPierre Jolivet             PetscCall(PCSetOperators(std::get<0>(*ctx)[1], pc->mat, pc->pmat));
184113044ca3SPierre Jolivet             PetscCall(PCSetType(std::get<0>(*ctx)[1], PCHPDDM));
184213044ca3SPierre 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 */
1843cf67ef9dSPierre Jolivet             if (flg) static_cast<PC_HPDDM *>(std::get<0>(*ctx)[1]->data)->Neumann = PETSC_BOOL3_TRUE;
184413044ca3SPierre Jolivet             PetscCall(PCSetFromOptions(std::get<0>(*ctx)[1]));
184513044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uis));
184613044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uaux));
184713044ca3SPierre 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 */
184813044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_MULT, (void (*)(void))MatMult_SchurCorrection));
184913044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_VIEW, (void (*)(void))MatView_SchurCorrection));
185013044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_DESTROY, (void (*)(void))MatDestroy_SchurCorrection));
185113044ca3SPierre Jolivet             PetscCall(KSPGetPCSide(inner_ksp, &(std::get<2>(*ctx))));
185213044ca3SPierre Jolivet             if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
185313044ca3SPierre Jolivet               PetscCall(KSPSetPreSolve(inner_ksp, KSPPreSolve_SchurCorrection, ctx));
185413044ca3SPierre Jolivet             } else { /* no support for PC_SYMMETRIC */
185513044ca3SPierre 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]);
185613044ca3SPierre Jolivet             }
185713044ca3SPierre Jolivet             PetscCall(KSPSetPostSolve(inner_ksp, KSPPostSolve_SchurCorrection, ctx));
185813044ca3SPierre Jolivet             PetscCall(PetscObjectCompose((PetscObject)(std::get<0>(*ctx)[1]), "_PCHPDDM_Schur", (PetscObject)container));
185913044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)container));
186013044ca3SPierre Jolivet             PetscCall(PCSetUp(std::get<0>(*ctx)[1]));
186113044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, S, S));
186213044ca3SPierre Jolivet             PetscCall(MatCreateVecs(std::get<1>(*ctx)[0], std::get<3>(*ctx), std::get<3>(*ctx) + 1));
186313044ca3SPierre Jolivet             PetscCall(VecDuplicate(std::get<3>(*ctx)[0], std::get<3>(*ctx) + 2));
186413044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)inner_ksp));
186513044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)S));
18660307214fSPierre Jolivet             for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
186713044ca3SPierre Jolivet             PetscFunctionReturn(PETSC_SUCCESS);
186813044ca3SPierre Jolivet           } else { /* second call to PCSetUp() on the PC associated to the Schur complement, retrieve previously set context */
186913044ca3SPierre Jolivet             PetscCall(PetscContainerGetPointer(container, (void **)&ctx));
187013044ca3SPierre Jolivet           }
187113044ca3SPierre Jolivet         }
187213044ca3SPierre Jolivet       }
187313044ca3SPierre Jolivet     }
1874f1580f4eSBarry Smith     if (!data->is && data->N > 1) {
1875f1580f4eSBarry Smith       char type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
1876*811e8887SPierre Jolivet 
1877f1580f4eSBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
1878f1580f4eSBarry Smith       if (flg || (A->rmap->N != A->cmap->N && P->rmap->N == P->cmap->N && P->rmap->N == A->cmap->N)) {
1879f1580f4eSBarry Smith         Mat B;
1880*811e8887SPierre Jolivet 
1881f1580f4eSBarry Smith         PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, A, P, &B, pcpre));
1882f1580f4eSBarry Smith         if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) data->correction = PC_HPDDM_COARSE_CORRECTION_BALANCED;
1883f1580f4eSBarry Smith         PetscCall(MatDestroy(&B));
1884f1580f4eSBarry Smith       } else {
1885f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
1886f1580f4eSBarry Smith         if (flg) {
1887f1580f4eSBarry Smith           Mat                 A00, P00, A01, A10, A11, B, N;
188813044ca3SPierre Jolivet           PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_LEAST_SQUARES;
188913044ca3SPierre Jolivet 
189013044ca3SPierre Jolivet           PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, &A01, &A10, &A11));
189113044ca3SPierre Jolivet           if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
189213044ca3SPierre Jolivet           PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
189313044ca3SPierre Jolivet           if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
18943df4cd7bSPierre Jolivet             Vec                        diagonal = nullptr;
1895f1580f4eSBarry Smith             const PetscScalar         *array;
1896f1580f4eSBarry Smith             MatSchurComplementAinvType type;
1897f1580f4eSBarry Smith 
1898f1580f4eSBarry Smith             if (A11) {
18993df4cd7bSPierre Jolivet               PetscCall(MatCreateVecs(A11, &diagonal, nullptr));
19003df4cd7bSPierre Jolivet               PetscCall(MatGetDiagonal(A11, diagonal));
1901f1580f4eSBarry Smith             }
1902db4a47b3SPierre Jolivet             PetscCall(MatCreateVecs(P00, &v, nullptr));
1903f1580f4eSBarry Smith             PetscCall(MatSchurComplementGetAinvType(P, &type));
1904f1580f4eSBarry 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]);
1905f1580f4eSBarry Smith             if (type == MAT_SCHUR_COMPLEMENT_AINV_LUMP) {
1906f1580f4eSBarry Smith               PetscCall(MatGetRowSum(P00, v));
1907f1580f4eSBarry Smith               if (A00 == P00) PetscCall(PetscObjectReference((PetscObject)A00));
1908f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1909f1580f4eSBarry Smith               PetscCall(VecGetArrayRead(v, &array));
1910db4a47b3SPierre Jolivet               PetscCall(MatCreateAIJ(PetscObjectComm((PetscObject)A00), A00->rmap->n, A00->cmap->n, A00->rmap->N, A00->cmap->N, 1, nullptr, 0, nullptr, &P00));
1911f1580f4eSBarry Smith               PetscCall(MatSetOption(P00, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
1912f1580f4eSBarry Smith               for (n = A00->rmap->rstart; n < A00->rmap->rend; ++n) PetscCall(MatSetValue(P00, n, n, array[n - A00->rmap->rstart], INSERT_VALUES));
1913f1580f4eSBarry Smith               PetscCall(MatAssemblyBegin(P00, MAT_FINAL_ASSEMBLY));
1914f1580f4eSBarry Smith               PetscCall(MatAssemblyEnd(P00, MAT_FINAL_ASSEMBLY));
1915f1580f4eSBarry Smith               PetscCall(VecRestoreArrayRead(v, &array));
1916f1580f4eSBarry Smith               PetscCall(MatSchurComplementUpdateSubMatrices(P, A00, P00, A01, A10, A11)); /* replace P00 by diag(sum of each row of P00) */
1917f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1918f1580f4eSBarry Smith             } else PetscCall(MatGetDiagonal(P00, v));
1919f1580f4eSBarry Smith             PetscCall(VecReciprocal(v)); /* inv(diag(P00))       */
1920f1580f4eSBarry Smith             PetscCall(VecSqrtAbs(v));    /* sqrt(inv(diag(P00))) */
1921f1580f4eSBarry Smith             PetscCall(MatDuplicate(A01, MAT_COPY_VALUES, &B));
1922db4a47b3SPierre Jolivet             PetscCall(MatDiagonalScale(B, v, nullptr));
1923f1580f4eSBarry Smith             PetscCall(VecDestroy(&v));
1924f1580f4eSBarry Smith             PetscCall(MatCreateNormalHermitian(B, &N));
19253df4cd7bSPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, B, N, &P, pcpre, &diagonal));
1926f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
1927f1580f4eSBarry Smith             if (!flg) {
1928f1580f4eSBarry Smith               PetscCall(MatDestroy(&P));
1929f1580f4eSBarry Smith               P = N;
1930f1580f4eSBarry Smith               PetscCall(PetscObjectReference((PetscObject)P));
1931f1580f4eSBarry Smith             } else PetscCall(MatScale(P, -1.0));
19323df4cd7bSPierre Jolivet             if (diagonal) {
19333df4cd7bSPierre Jolivet               PetscCall(MatDiagonalSet(P, diagonal, ADD_VALUES));
1934aa21023fSPierre Jolivet               PetscCall(PCSetOperators(pc, P, P)); /* replace P by diag(P11) - A01^T inv(diag(P00)) A01 */
19353df4cd7bSPierre Jolivet               PetscCall(VecDestroy(&diagonal));
19363df4cd7bSPierre Jolivet             } else {
1937f1580f4eSBarry Smith               PetscCall(MatScale(N, -1.0));
1938aa21023fSPierre Jolivet               PetscCall(PCSetOperators(pc, N, P)); /* replace P by - A01^T inv(diag(P00)) A01 */
19393df4cd7bSPierre Jolivet             }
1940f1580f4eSBarry Smith             PetscCall(MatDestroy(&N));
1941f1580f4eSBarry Smith             PetscCall(MatDestroy(&P));
1942f1580f4eSBarry Smith             PetscCall(MatDestroy(&B));
194313044ca3SPierre Jolivet           } else
1944fd310a01SPierre 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 : "");
19450307214fSPierre Jolivet           for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
19463ba16761SJacob Faibussowitsch           PetscFunctionReturn(PETSC_SUCCESS);
1947f1580f4eSBarry Smith         } else {
1948db4a47b3SPierre Jolivet           PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_st_pc_type", type, sizeof(type), nullptr));
1949f1580f4eSBarry Smith           PetscCall(PetscStrcmp(type, PCMAT, &algebraic));
1950b07dfdedSPierre Jolivet           PetscCheck(!algebraic || !block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_block_splitting");
19519bb5c669SPierre Jolivet           if (overlap != -1) {
19529bb5c669SPierre 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");
19539bb5c669SPierre Jolivet             PetscCheck(overlap >= 1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_WRONG, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " < 1", overlap);
19549bb5c669SPierre Jolivet           }
19559bb5c669SPierre Jolivet           if (block || overlap != -1) algebraic = PETSC_TRUE;
1956f1580f4eSBarry Smith           if (algebraic) {
1957f1580f4eSBarry Smith             PetscCall(ISCreateStride(PETSC_COMM_SELF, P->rmap->n, P->rmap->rstart, 1, &data->is));
1958f1580f4eSBarry Smith             PetscCall(MatIncreaseOverlap(P, 1, &data->is, 1));
1959f1580f4eSBarry Smith             PetscCall(ISSort(data->is));
19609bb5c669SPierre Jolivet           } else
19619bb5c669SPierre 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 : ""));
1962f1580f4eSBarry Smith         }
1963f1580f4eSBarry Smith       }
1964f1580f4eSBarry Smith     }
1965f1580f4eSBarry Smith   }
1966398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1967398c7888SPierre Jolivet   if (data->is) PetscCall(ISDuplicate(data->is, &dis));
1968398c7888SPierre Jolivet   if (data->aux) PetscCall(MatDuplicate(data->aux, MAT_COPY_VALUES, &daux));
1969398c7888SPierre Jolivet #endif
1970f1580f4eSBarry Smith   if (data->is || (ismatis && data->N > 1)) {
1971f1580f4eSBarry Smith     if (ismatis) {
1972f1580f4eSBarry Smith       std::initializer_list<std::string> list = {MATSEQBAIJ, MATSEQSBAIJ};
1973f1580f4eSBarry Smith       PetscCall(MatISGetLocalMat(P, &N));
1974f1580f4eSBarry Smith       std::initializer_list<std::string>::const_iterator it = std::find(list.begin(), list.end(), ((PetscObject)N)->type_name);
1975f1580f4eSBarry Smith       PetscCall(MatISRestoreLocalMat(P, &N));
1976f1580f4eSBarry Smith       switch (std::distance(list.begin(), it)) {
1977d71ae5a4SJacob Faibussowitsch       case 0:
1978d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
1979d71ae5a4SJacob Faibussowitsch         break;
1980f1580f4eSBarry Smith       case 1:
1981f1580f4eSBarry Smith         /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIBAIJ */
1982f1580f4eSBarry Smith         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
1983f1580f4eSBarry Smith         PetscCall(MatSetOption(C, MAT_SYMMETRIC, PETSC_TRUE));
1984f1580f4eSBarry Smith         break;
1985d71ae5a4SJacob Faibussowitsch       default:
1986d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, &C));
1987f1580f4eSBarry Smith       }
1988db4a47b3SPierre Jolivet       PetscCall(MatISGetLocalToGlobalMapping(P, &l2g, nullptr));
1989f1580f4eSBarry Smith       PetscCall(PetscObjectReference((PetscObject)P));
1990f1580f4eSBarry Smith       PetscCall(KSPSetOperators(data->levels[0]->ksp, A, C));
1991f1580f4eSBarry Smith       std::swap(C, P);
1992f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingGetSize(l2g, &n));
1993f1580f4eSBarry Smith       PetscCall(ISCreateStride(PETSC_COMM_SELF, n, 0, 1, &loc));
1994f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingApplyIS(l2g, loc, &is[0]));
1995f1580f4eSBarry Smith       PetscCall(ISDestroy(&loc));
1996f1580f4eSBarry Smith       /* the auxiliary Mat is _not_ the local Neumann matrix                                */
1997f1580f4eSBarry Smith       /* it is the local Neumann matrix augmented (with zeros) through MatIncreaseOverlap() */
1998c8ea6600SPierre Jolivet       data->Neumann = PETSC_BOOL3_FALSE;
1999f1580f4eSBarry Smith       structure     = SAME_NONZERO_PATTERN;
2000f1580f4eSBarry Smith     } else {
2001f1580f4eSBarry Smith       is[0] = data->is;
200213044ca3SPierre Jolivet       if (algebraic || ctx) subdomains = PETSC_TRUE;
2003db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_define_subdomains", &subdomains, nullptr));
200413044ca3SPierre 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);
2005c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann)) {
2006b07dfdedSPierre Jolivet         PetscCheck(!block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_block_splitting and -pc_hpddm_has_neumann");
20079bb5c669SPierre Jolivet         PetscCheck(overlap == -1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " and -pc_hpddm_has_neumann", overlap);
2008b07dfdedSPierre Jolivet         PetscCheck(!algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_has_neumann");
2009f1580f4eSBarry Smith       }
2010c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann) || block) structure = SAME_NONZERO_PATTERN;
2011f1580f4eSBarry Smith       PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), P->rmap->n, P->rmap->rstart, 1, &loc));
2012f1580f4eSBarry Smith     }
2013f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2014db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetEnum(nullptr, prefix, "-st_matstructure", MatStructures, (PetscEnum *)&structure, &flg)); /* if not user-provided, force its value when possible */
2015f1580f4eSBarry Smith     if (!flg && structure == SAME_NONZERO_PATTERN) {                                                                   /* cannot call STSetMatStructure() yet, insert the appropriate option in the database, parsed by STSetFromOptions() */
2016f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-%spc_hpddm_levels_1_st_matstructure", pcpre ? pcpre : ""));
2017db4a47b3SPierre Jolivet       PetscCall(PetscOptionsSetValue(nullptr, prefix, MatStructures[structure]));
2018f1580f4eSBarry Smith     }
2019398c7888SPierre Jolivet     flg = PETSC_FALSE;
2020b07dfdedSPierre Jolivet     if (data->share) {
2021398c7888SPierre Jolivet       data->share = PETSC_FALSE; /* will be reset to PETSC_TRUE if none of the conditions below are true */
2022398c7888SPierre 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 : ""));
2023398c7888SPierre Jolivet       else if (data->deflation) PetscCall(PetscInfo(pc, "Nothing to share since PCHPDDMSetDeflationMat() has been called\n"));
2024398c7888SPierre Jolivet       else if (ismatis) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc with a Pmat of type MATIS\n"));
2025b07dfdedSPierre Jolivet       else if (!algebraic && structure != SAME_NONZERO_PATTERN)
2026398c7888SPierre 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]));
2027398c7888SPierre Jolivet       else data->share = PETSC_TRUE;
2028398c7888SPierre Jolivet     }
2029398c7888SPierre Jolivet     if (!ismatis) {
2030398c7888SPierre Jolivet       if (data->share || (!PetscBool3ToBool(data->Neumann) && subdomains)) PetscCall(ISDuplicate(is[0], &unsorted));
2031398c7888SPierre Jolivet       else unsorted = is[0];
2032398c7888SPierre Jolivet     }
2033f1580f4eSBarry Smith     if (data->N > 1 && (data->aux || ismatis || algebraic)) {
2034f1580f4eSBarry Smith       PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "HPDDM library not loaded, cannot use more than one level");
2035f1580f4eSBarry Smith       PetscCall(MatSetOption(P, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
2036f1580f4eSBarry Smith       if (ismatis) {
2037f1580f4eSBarry Smith         /* needed by HPDDM (currently) so that the partition of unity is 0 on subdomain interfaces */
2038f1580f4eSBarry Smith         PetscCall(MatIncreaseOverlap(P, 1, is, 1));
2039f1580f4eSBarry Smith         PetscCall(ISDestroy(&data->is));
2040f1580f4eSBarry Smith         data->is = is[0];
2041f1580f4eSBarry Smith       } else {
2042d16c0b94SPierre Jolivet         if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_TRUE));
20439bb5c669SPierre Jolivet         if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", PCHPDDMAlgebraicAuxiliaryMat_Private));
20449bb5c669SPierre Jolivet         if (!PetscBool3ToBool(data->Neumann) && (!algebraic || overlap != -1)) {
2045f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
2046f1580f4eSBarry Smith           if (flg) {
2047f1580f4eSBarry Smith             /* maybe better to ISSort(is[0]), MatCreateSubMatrices(), and then MatPermute() */
2048f1580f4eSBarry Smith             /* but there is no MatPermute_SeqSBAIJ(), so as before, just use MATMPIBAIJ     */
2049f1580f4eSBarry Smith             PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &uaux));
2050f1580f4eSBarry Smith             flg = PETSC_FALSE;
2051f1580f4eSBarry Smith           }
2052f1580f4eSBarry Smith         }
2053f1580f4eSBarry Smith       }
20549bb5c669SPierre Jolivet       if (algebraic && overlap == -1) {
2055f1580f4eSBarry Smith         PetscUseMethod(pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", (Mat, IS *, Mat *[], PetscBool), (P, is, &sub, block));
2056f1580f4eSBarry Smith         if (block) {
2057f1580f4eSBarry Smith           PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", (PetscObject *)&data->aux));
2058db4a47b3SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", nullptr));
2059f1580f4eSBarry Smith         }
20609bb5c669SPierre Jolivet       } else if (!uaux || overlap != -1) {
206113044ca3SPierre Jolivet         if (!ctx) {
2062c8ea6600SPierre Jolivet           if (PetscBool3ToBool(data->Neumann)) sub = &data->aux;
20639bb5c669SPierre Jolivet           else {
2064df21ef68SPierre Jolivet             PetscBool flg;
20659bb5c669SPierre Jolivet             if (overlap != -1) {
20669bb5c669SPierre Jolivet               Harmonic              h;
20679bb5c669SPierre Jolivet               Mat                   A0, *a;                           /* with an SVD: [ A_00  A_01       ] */
20689bb5c669SPierre Jolivet               IS                    ov[2], rows, cols, stride;        /*              [ A_10  A_11  A_12 ] */
20699bb5c669SPierre Jolivet               const PetscInt       *i[2], bs = PetscAbs(P->cmap->bs); /* with a GEVP: [ A_00  A_01       ] */
20709bb5c669SPierre Jolivet               PetscInt              n[2];                             /*              [ A_10  A_11  A_12 ] */
20719bb5c669SPierre Jolivet               std::vector<PetscInt> v[2];                             /*              [       A_21  A_22 ] */
20729bb5c669SPierre Jolivet 
20739bb5c669SPierre Jolivet               PetscCall(ISDuplicate(data->is, ov));
20749bb5c669SPierre Jolivet               if (overlap > 1) PetscCall(MatIncreaseOverlap(P, 1, ov, overlap - 1));
20759bb5c669SPierre Jolivet               PetscCall(ISDuplicate(ov[0], ov + 1));
20769bb5c669SPierre Jolivet               PetscCall(MatIncreaseOverlap(P, 1, ov + 1, 1));
20779bb5c669SPierre Jolivet               PetscCall(PetscNew(&h));
20789bb5c669SPierre Jolivet               h->ksp = nullptr;
20799bb5c669SPierre Jolivet               PetscCall(PetscCalloc1(2, &h->A));
20803a60673dSPierre Jolivet               PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_nsv", &flg));
20819bb5c669SPierre Jolivet               if (!flg) PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_relative_threshold", &flg));
20829bb5c669SPierre Jolivet               PetscCall(ISSort(ov[0]));
20839bb5c669SPierre Jolivet               if (!flg) PetscCall(ISSort(ov[1]));
20849bb5c669SPierre Jolivet               PetscCall(PetscMalloc1(!flg ? 5 : 3, &h->is));
20859bb5c669SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, ov + !flg, ov + 1, MAT_INITIAL_MATRIX, &a)); /* submatrix from above, either square (!flg) or rectangular (flg) */
20869bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) {
20879bb5c669SPierre Jolivet                 PetscCall(ISGetIndices(ov[j], i + j));
20889bb5c669SPierre Jolivet                 PetscCall(ISGetLocalSize(ov[j], n + j));
20899bb5c669SPierre Jolivet               }
20909bb5c669SPierre Jolivet               v[1].reserve((n[1] - n[0]) / bs);
20919bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[1]; j += bs) { /* indices of the (2,2) block */
20929bb5c669SPierre Jolivet                 PetscInt location;
20939bb5c669SPierre Jolivet                 PetscCall(ISLocate(ov[0], i[1][j], &location));
20949bb5c669SPierre Jolivet                 if (location < 0) v[1].emplace_back(j / bs);
20959bb5c669SPierre Jolivet               }
20969bb5c669SPierre Jolivet               if (!flg) {
20979bb5c669SPierre Jolivet                 h->A[1] = a[0];
20989bb5c669SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)h->A[1]));
20999bb5c669SPierre Jolivet                 v[0].reserve((n[0] - P->rmap->n) / bs);
21009bb5c669SPierre Jolivet                 for (PetscInt j = 0; j < n[1]; j += bs) { /* row indices of the (1,2) block */
21019bb5c669SPierre Jolivet                   PetscInt location;
21029bb5c669SPierre Jolivet                   PetscCall(ISLocate(loc, i[1][j], &location));
21039bb5c669SPierre Jolivet                   if (location < 0) {
21049bb5c669SPierre Jolivet                     PetscCall(ISLocate(ov[0], i[1][j], &location));
21059bb5c669SPierre Jolivet                     if (location >= 0) v[0].emplace_back(j / bs);
21069bb5c669SPierre Jolivet                   }
21079bb5c669SPierre Jolivet                 }
21089bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
21099bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_COPY_VALUES, h->is + 4));
21109bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, h->is[4], MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
21119bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
21129bb5c669SPierre 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 */
21139bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &rows));
21149bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols = rows, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
21159bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
21169bb5c669SPierre Jolivet                 v[0].clear();
21179bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, ov[1], PETSC_TRUE, h->is + 3));
21189bb5c669SPierre Jolivet                 PetscCall(ISEmbed(data->is, ov[1], PETSC_TRUE, h->is + 2));
21199bb5c669SPierre Jolivet               }
21209bb5c669SPierre Jolivet               v[0].reserve((n[0] - P->rmap->n) / bs);
21219bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[0]; j += bs) {
21229bb5c669SPierre Jolivet                 PetscInt location;
21239bb5c669SPierre Jolivet                 PetscCall(ISLocate(loc, i[0][j], &location));
21249bb5c669SPierre Jolivet                 if (location < 0) v[0].emplace_back(j / bs);
21259bb5c669SPierre Jolivet               }
21269bb5c669SPierre Jolivet               PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
21279bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISRestoreIndices(ov[j], i + j));
21289bb5c669SPierre Jolivet               if (flg) {
21299bb5c669SPierre Jolivet                 IS is;
21309bb5c669SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, a[0]->rmap->n, 0, 1, &is));
21319bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &cols));
21329bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], is, cols, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
21339bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
21349bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&is));
21359bb5c669SPierre 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 */
21369bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, data->is, PETSC_TRUE, h->is + 2));
21379bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_USE_POINTER, &cols));
21389bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols, MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
21399bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
21409bb5c669SPierre Jolivet               }
21419bb5c669SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, A0->rmap->n, 0, 1, &stride));
21429bb5c669SPierre Jolivet               PetscCall(ISEmbed(rows, stride, PETSC_TRUE, h->is));
21439bb5c669SPierre Jolivet               PetscCall(ISDestroy(&stride));
21449bb5c669SPierre Jolivet               PetscCall(ISDestroy(&rows));
21459bb5c669SPierre Jolivet               PetscCall(ISEmbed(loc, ov[0], PETSC_TRUE, h->is + 1));
21469bb5c669SPierre Jolivet               if (subdomains) {
21479bb5c669SPierre Jolivet                 if (!data->levels[0]->pc) {
21489bb5c669SPierre Jolivet                   PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
21499bb5c669SPierre Jolivet                   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
21509bb5c669SPierre Jolivet                   PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
21519bb5c669SPierre Jolivet                   PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
21529bb5c669SPierre Jolivet                 }
21539bb5c669SPierre Jolivet                 PetscCall(PCSetType(data->levels[0]->pc, PCASM));
21549bb5c669SPierre Jolivet                 if (!data->levels[0]->pc->setupcalled) PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, ov + !flg, &loc));
21559bb5c669SPierre Jolivet                 PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, flg ? A0 : a[0], PETSC_TRUE));
21569bb5c669SPierre Jolivet                 if (!flg) ++overlap;
21579bb5c669SPierre Jolivet                 if (data->share) {
21589bb5c669SPierre Jolivet                   PetscInt n = -1;
21599bb5c669SPierre Jolivet                   PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
21609bb5c669SPierre Jolivet                   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
21619bb5c669SPierre Jolivet                   if (flg) {
21629bb5c669SPierre Jolivet                     h->ksp = ksp[0];
21639bb5c669SPierre Jolivet                     PetscCall(PetscObjectReference((PetscObject)h->ksp));
21649bb5c669SPierre Jolivet                   }
21659bb5c669SPierre Jolivet                 }
21669bb5c669SPierre Jolivet               }
21679bb5c669SPierre Jolivet               if (!h->ksp) {
21689bb5c669SPierre Jolivet                 PetscBool share = data->share;
21699bb5c669SPierre Jolivet                 PetscCall(KSPCreate(PETSC_COMM_SELF, &h->ksp));
21709bb5c669SPierre Jolivet                 PetscCall(KSPSetType(h->ksp, KSPPREONLY));
21719bb5c669SPierre Jolivet                 PetscCall(KSPSetOperators(h->ksp, A0, A0));
21729bb5c669SPierre Jolivet                 do {
21739bb5c669SPierre Jolivet                   if (!data->share) {
21749bb5c669SPierre Jolivet                     share = PETSC_FALSE;
21759bb5c669SPierre Jolivet                     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_%s", pcpre ? pcpre : "", flg ? "svd_" : "eps_"));
21769bb5c669SPierre Jolivet                     PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
21779bb5c669SPierre Jolivet                     PetscCall(KSPSetFromOptions(h->ksp));
21789bb5c669SPierre Jolivet                   } else {
21799bb5c669SPierre Jolivet                     MatSolverType type;
21809bb5c669SPierre Jolivet                     PetscCall(KSPGetPC(ksp[0], &pc));
21819bb5c669SPierre Jolivet                     PetscCall(PetscObjectTypeCompareAny((PetscObject)pc, &data->share, PCLU, PCCHOLESKY, ""));
21829bb5c669SPierre Jolivet                     if (data->share) {
21839bb5c669SPierre Jolivet                       PetscCall(PCFactorGetMatSolverType(pc, &type));
21849bb5c669SPierre Jolivet                       if (!type) {
21859bb5c669SPierre Jolivet                         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMUMPS));
21869bb5c669SPierre Jolivet                         else if (PetscDefined(HAVE_MKL_PARDISO)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMKL_PARDISO));
21879bb5c669SPierre Jolivet                         else data->share = PETSC_FALSE;
21889bb5c669SPierre Jolivet                         if (data->share) PetscCall(PCSetFromOptions(pc));
21899bb5c669SPierre Jolivet                       } else {
21909bb5c669SPierre Jolivet                         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &data->share));
21919bb5c669SPierre Jolivet                         if (!data->share) PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &data->share));
21929bb5c669SPierre Jolivet                       }
21939bb5c669SPierre Jolivet                       if (data->share) {
21949bb5c669SPierre Jolivet                         std::tuple<KSP, IS, Vec[2]> *p;
21959bb5c669SPierre Jolivet                         PetscCall(PCFactorGetMatrix(pc, &A));
21969bb5c669SPierre Jolivet                         PetscCall(MatFactorSetSchurIS(A, h->is[4]));
21979bb5c669SPierre Jolivet                         PetscCall(KSPSetUp(ksp[0]));
21989bb5c669SPierre Jolivet                         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_eps_shell_", pcpre ? pcpre : ""));
21999bb5c669SPierre Jolivet                         PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
22009bb5c669SPierre Jolivet                         PetscCall(KSPSetFromOptions(h->ksp));
22019bb5c669SPierre Jolivet                         PetscCall(KSPGetPC(h->ksp, &pc));
22029bb5c669SPierre Jolivet                         PetscCall(PCSetType(pc, PCSHELL));
22039bb5c669SPierre Jolivet                         PetscCall(PetscNew(&p));
22049bb5c669SPierre Jolivet                         std::get<0>(*p) = ksp[0];
22059bb5c669SPierre Jolivet                         PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &std::get<1>(*p)));
22069bb5c669SPierre Jolivet                         PetscCall(MatCreateVecs(A, std::get<2>(*p), std::get<2>(*p) + 1));
22079bb5c669SPierre Jolivet                         PetscCall(PCShellSetContext(pc, p));
22089bb5c669SPierre Jolivet                         PetscCall(PCShellSetApply(pc, PCApply_Schur));
22099bb5c669SPierre Jolivet                         PetscCall(PCShellSetApplyTranspose(pc, PCApply_Schur<Vec, true>));
22109bb5c669SPierre Jolivet                         PetscCall(PCShellSetMatApply(pc, PCApply_Schur<Mat>));
22119bb5c669SPierre Jolivet                         PetscCall(PCShellSetDestroy(pc, PCDestroy_Schur));
22129bb5c669SPierre Jolivet                       }
22139bb5c669SPierre Jolivet                     }
22149bb5c669SPierre Jolivet                     if (!data->share) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since neither MUMPS nor MKL PARDISO is used\n"));
22159bb5c669SPierre Jolivet                   }
22169bb5c669SPierre 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 */
22179bb5c669SPierre Jolivet               }
22189bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov));
22199bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov + 1));
22209bb5c669SPierre Jolivet               if (overlap == 1 && subdomains && flg) {
22219bb5c669SPierre Jolivet                 *subA = A0;
22229bb5c669SPierre Jolivet                 sub   = subA;
22239bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatDestroy(&uaux));
22249bb5c669SPierre Jolivet               } else PetscCall(MatDestroy(&A0));
22259bb5c669SPierre Jolivet               PetscCall(MatCreateShell(PETSC_COMM_SELF, P->rmap->n, n[1] - n[0], P->rmap->n, n[1] - n[0], h, &data->aux));
22269bb5c669SPierre Jolivet               PetscCall(MatCreateVecs(h->ksp->pc->pmat, &h->v, nullptr));
22279bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT, (void (*)(void))MatMult_Harmonic));
22289bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMultTranspose_Harmonic));
22299bb5c669SPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AB, nullptr, MatProduct_AB_Harmonic, nullptr, MATDENSE, MATDENSE));
22309bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_DESTROY, (void (*)(void))MatDestroy_Harmonic));
22319bb5c669SPierre Jolivet               PetscCall(MatDestroySubMatrices(1, &a));
22329bb5c669SPierre Jolivet             }
2233df21ef68SPierre Jolivet             if (overlap != 1 || !subdomains) {
2234df21ef68SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2235df21ef68SPierre Jolivet               if (ismatis) {
2236df21ef68SPierre Jolivet                 PetscCall(MatISGetLocalMat(C, &N));
2237df21ef68SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)N, MATSEQSBAIJ, &flg));
2238df21ef68SPierre Jolivet                 if (flg) PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2239df21ef68SPierre Jolivet                 PetscCall(MatISRestoreLocalMat(C, &N));
2240df21ef68SPierre Jolivet               }
2241df21ef68SPierre Jolivet             }
22429bb5c669SPierre Jolivet             if (uaux) {
22439bb5c669SPierre Jolivet               PetscCall(MatDestroy(&uaux));
22449bb5c669SPierre Jolivet               PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
22459bb5c669SPierre Jolivet             }
22469bb5c669SPierre Jolivet           }
224713044ca3SPierre Jolivet         }
2248f1580f4eSBarry Smith       } else {
2249f1580f4eSBarry Smith         PetscCall(MatCreateSubMatrices(uaux, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2250f1580f4eSBarry Smith         PetscCall(MatDestroy(&uaux));
2251f1580f4eSBarry Smith         PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2252f1580f4eSBarry Smith       }
2253f1580f4eSBarry Smith       /* Vec holding the partition of unity */
2254f1580f4eSBarry Smith       if (!data->levels[0]->D) {
2255f1580f4eSBarry Smith         PetscCall(ISGetLocalSize(data->is, &n));
2256f1580f4eSBarry Smith         PetscCall(VecCreateMPI(PETSC_COMM_SELF, n, PETSC_DETERMINE, &data->levels[0]->D));
2257f1580f4eSBarry Smith       }
22589bb5c669SPierre Jolivet       if (data->share && overlap == -1) {
2259f1580f4eSBarry Smith         Mat      D;
2260db4a47b3SPierre Jolivet         IS       perm = nullptr;
2261f1580f4eSBarry Smith         PetscInt size = -1;
2262*811e8887SPierre Jolivet 
2263398c7888SPierre Jolivet         if (!data->levels[0]->pc) {
2264398c7888SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2265398c7888SPierre Jolivet           PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
2266398c7888SPierre Jolivet           PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
2267398c7888SPierre Jolivet           PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
2268398c7888SPierre Jolivet         }
2269398c7888SPierre Jolivet         PetscCall(PCSetType(data->levels[0]->pc, PCASM));
227013044ca3SPierre Jolivet         if (!ctx) {
2271398c7888SPierre Jolivet           if (!data->levels[0]->pc->setupcalled) {
2272398c7888SPierre Jolivet             IS sorted; /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2273398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2274398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &sorted, &loc));
2275398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2276398c7888SPierre Jolivet           }
2277398c7888SPierre Jolivet           PetscCall(PCSetFromOptions(data->levels[0]->pc));
2278398c7888SPierre Jolivet           if (block) {
2279398c7888SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, sub[0], &C, &perm));
2280398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, C, algebraic));
2281398c7888SPierre Jolivet           } else PetscCall(PCSetUp(data->levels[0]->pc));
2282db4a47b3SPierre Jolivet           PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &size, nullptr, &ksp));
2283398c7888SPierre Jolivet           if (size != 1) {
2284398c7888SPierre Jolivet             data->share = PETSC_FALSE;
2285398c7888SPierre Jolivet             PetscCheck(size == -1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", size);
2286398c7888SPierre Jolivet             PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since PCASMGetSubKSP() not found in fine-level PC\n"));
2287398c7888SPierre Jolivet             PetscCall(ISDestroy(&unsorted));
2288398c7888SPierre Jolivet             unsorted = is[0];
2289398c7888SPierre Jolivet           } else {
2290*811e8887SPierre Jolivet             const char *matpre;
2291*811e8887SPierre Jolivet             PetscBool   cmp[4];
2292*811e8887SPierre Jolivet 
229313044ca3SPierre Jolivet             if (!block && !ctx) PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, PetscBool3ToBool(data->Neumann) ? sub[0] : data->aux, &C, &perm));
2294c8ea6600SPierre Jolivet             if (!PetscBool3ToBool(data->Neumann) && !block) {
2295f1580f4eSBarry Smith               PetscCall(MatPermute(sub[0], perm, perm, &D)); /* permute since PCASM will call ISSort() */
2296f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(sub[0], &D));
2297f1580f4eSBarry Smith             }
2298f1580f4eSBarry Smith             if (data->B) { /* see PCHPDDMSetRHSMat() */
2299f1580f4eSBarry Smith               PetscCall(MatPermute(data->B, perm, perm, &D));
2300f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(data->B, &D));
2301f1580f4eSBarry Smith             }
2302f1580f4eSBarry Smith             PetscCall(ISDestroy(&perm));
2303f1580f4eSBarry Smith             PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
23040307214fSPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)subA[0]));
2305f1580f4eSBarry Smith             PetscCall(MatDuplicate(subA[1], MAT_SHARE_NONZERO_PATTERN, &D));
2306f1580f4eSBarry Smith             PetscCall(MatGetOptionsPrefix(subA[1], &matpre));
2307f1580f4eSBarry Smith             PetscCall(MatSetOptionsPrefix(D, matpre));
2308f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMAL, cmp));
2309f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMAL, cmp + 1));
2310f1580f4eSBarry Smith             if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMALHERMITIAN, cmp + 2));
2311f1580f4eSBarry Smith             else cmp[2] = PETSC_FALSE;
2312f1580f4eSBarry Smith             if (!cmp[1]) PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMALHERMITIAN, cmp + 3));
2313f1580f4eSBarry Smith             else cmp[3] = PETSC_FALSE;
2314f1580f4eSBarry 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);
2315f1580f4eSBarry Smith             if (!cmp[0] && !cmp[2]) {
2316f1580f4eSBarry Smith               if (!block) PetscCall(MatAXPY(D, 1.0, C, SUBSET_NONZERO_PATTERN));
23175c7345deSPierre Jolivet               else {
2318db4a47b3SPierre Jolivet                 PetscCall(MatMissingDiagonal(D, cmp, nullptr));
23195c7345deSPierre Jolivet                 if (cmp[0]) structure = DIFFERENT_NONZERO_PATTERN; /* data->aux has no missing diagonal entry */
23205c7345deSPierre Jolivet                 PetscCall(MatAXPY(D, 1.0, data->aux, structure));
23215c7345deSPierre Jolivet               }
2322f1580f4eSBarry Smith             } else {
2323f1580f4eSBarry Smith               Mat mat[2];
2324*811e8887SPierre Jolivet 
2325f1580f4eSBarry Smith               if (cmp[0]) {
2326f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(D, mat));
2327f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(C, mat + 1));
2328f1580f4eSBarry Smith               } else {
2329f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(D, mat));
2330f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(C, mat + 1));
2331f1580f4eSBarry Smith               }
2332f1580f4eSBarry Smith               PetscCall(MatAXPY(mat[0], 1.0, mat[1], SUBSET_NONZERO_PATTERN));
2333f1580f4eSBarry Smith             }
2334f1580f4eSBarry Smith             PetscCall(MatPropagateSymmetryOptions(C, D));
2335f1580f4eSBarry Smith             PetscCall(MatDestroy(&C));
2336f1580f4eSBarry Smith             C = D;
2337f1580f4eSBarry Smith             /* swap pointers so that variables stay consistent throughout PCSetUp() */
2338f1580f4eSBarry Smith             std::swap(C, data->aux);
2339f1580f4eSBarry Smith             std::swap(uis, data->is);
2340f1580f4eSBarry Smith             swap = PETSC_TRUE;
2341f1580f4eSBarry Smith           }
2342f1580f4eSBarry Smith         }
234313044ca3SPierre Jolivet       }
234413044ca3SPierre Jolivet       if (ctx) {
234513044ca3SPierre Jolivet         PC_HPDDM              *data_00 = (PC_HPDDM *)std::get<0>(*ctx)[0]->data;
234613044ca3SPierre Jolivet         PC                     s;
234700b491fbSPierre Jolivet         Mat                    A00, P00, A01 = nullptr, A10, A11, N, b[4];
234807d8d47fSPierre Jolivet         IS                     sorted, is[2], *is_00;
234913044ca3SPierre Jolivet         MatSolverType          type;
235013044ca3SPierre Jolivet         std::pair<PC, Vec[2]> *p;
235113044ca3SPierre Jolivet 
235207d8d47fSPierre Jolivet         n = -1;
235307d8d47fSPierre Jolivet         PetscTryMethod(data_00->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data_00->levels[0]->pc, &n, nullptr, &ksp));
235407d8d47fSPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
235507d8d47fSPierre Jolivet         PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
235607d8d47fSPierre Jolivet         PetscCall(ISGetLocalSize(data_00->is, &n));
235707d8d47fSPierre Jolivet         if (n != subA[0]->rmap->n || n != subA[0]->cmap->n) {
235807d8d47fSPierre Jolivet           PetscCall(PCASMGetLocalSubdomains(data_00->levels[0]->pc, &n, &is_00, nullptr));
235907d8d47fSPierre Jolivet           PetscCall(ISGetLocalSize(*is_00, &n));
236007d8d47fSPierre 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);
236107d8d47fSPierre Jolivet         } else is_00 = &data_00->is;
236213044ca3SPierre Jolivet         PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, data->aux, &C, nullptr)); /* permute since PCASM works with a sorted IS */
236313044ca3SPierre Jolivet         std::swap(C, data->aux);
236413044ca3SPierre Jolivet         std::swap(uis, data->is);
236513044ca3SPierre Jolivet         swap = PETSC_TRUE;
236613044ca3SPierre Jolivet         PetscCall(PCASMSetType(data->levels[0]->pc, PC_ASM_NONE)); /* "Neumann--Neumann" preconditioning with overlap and a Boolean partition of unity */
236713044ca3SPierre Jolivet         PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &data->is, &loc));
236813044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(data->levels[0]->pc)); /* action of eq. (15) of https://hal.science/hal-02343808v6/document (with a sign flip) */
236913044ca3SPierre Jolivet         PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, std::get<1>(*ctx), &A10, &A11));
237013044ca3SPierre Jolivet         std::get<1>(*ctx)[1] = A10;
237113044ca3SPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
237213044ca3SPierre Jolivet         if (flg) PetscCall(MatTransposeGetMat(A10, &A01));
237313044ca3SPierre Jolivet         else {
237413044ca3SPierre Jolivet           PetscBool flg;
237513044ca3SPierre Jolivet 
237613044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
237713044ca3SPierre Jolivet           if (flg) PetscCall(MatHermitianTransposeGetMat(A10, &A01));
237813044ca3SPierre Jolivet         }
237907d8d47fSPierre Jolivet         PetscCall(ISDuplicate(*is_00, &sorted)); /* during setup of the PC associated to the A00 block, this IS has already been sorted, but it's put back to its original state at the end of PCSetUp_HPDDM(), which may be unsorted */
238013044ca3SPierre Jolivet         PetscCall(ISSort(sorted));               /* this is to avoid changing users inputs, but it requires a new call to ISSort() here                                                                                               */
238100b491fbSPierre Jolivet         if (!A01) {
238200b491fbSPierre Jolivet           PetscCall(MatSetOption(A10, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
238300b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A10, 1, &data->is, &sorted, MAT_INITIAL_MATRIX, &sub));
238400b491fbSPierre Jolivet           b[2] = sub[0];
238500b491fbSPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
238600b491fbSPierre Jolivet           PetscCall(MatDestroySubMatrices(1, &sub));
238700b491fbSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATTRANSPOSEVIRTUAL, &flg));
238800b491fbSPierre Jolivet           A10 = nullptr;
238900b491fbSPierre Jolivet           if (flg) PetscCall(MatTransposeGetMat(std::get<1>(*ctx)[0], &A10));
239013044ca3SPierre Jolivet           else {
239100b491fbSPierre Jolivet             PetscBool flg;
239200b491fbSPierre Jolivet 
239300b491fbSPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)(PetscObject)std::get<1>(*ctx)[0], MATHERMITIANTRANSPOSEVIRTUAL, &flg));
239400b491fbSPierre Jolivet             if (flg) PetscCall(MatHermitianTransposeGetMat(std::get<1>(*ctx)[0], &A10));
239513044ca3SPierre Jolivet           }
2396*811e8887SPierre Jolivet           if (!A10) PetscCall(MatCreateSubMatrices(std::get<1>(*ctx)[0], 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2397*811e8887SPierre Jolivet           else {
2398*811e8887SPierre Jolivet             if (flg) PetscCall(MatCreateTranspose(b[2], b + 1));
2399*811e8887SPierre Jolivet             else PetscCall(MatCreateHermitianTranspose(b[2], b + 1));
240000b491fbSPierre Jolivet           }
240100b491fbSPierre Jolivet         } else {
240200b491fbSPierre Jolivet           PetscCall(MatSetOption(A01, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
240300b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A01, 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2404*811e8887SPierre Jolivet           if (flg) PetscCall(MatCreateTranspose(*sub, b + 2));
2405*811e8887SPierre Jolivet           else PetscCall(MatCreateHermitianTranspose(*sub, b + 2));
2406*811e8887SPierre Jolivet         }
2407*811e8887SPierre Jolivet         if (A01 || !A10) {
2408*811e8887SPierre Jolivet           b[1] = sub[0];
2409*811e8887SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
241000b491fbSPierre Jolivet         }
241100b491fbSPierre Jolivet         PetscCall(MatDestroySubMatrices(1, &sub));
241213044ca3SPierre Jolivet         PetscCall(ISDestroy(&sorted));
241300b491fbSPierre Jolivet         PetscCall(MatCreateSchurComplement(subA[0], subA[1], b[1], b[2], data->aux, &S));
241413044ca3SPierre Jolivet         PetscCall(MatSchurComplementSetKSP(S, ksp[0]));
241513044ca3SPierre 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 */
241613044ca3SPierre Jolivet         PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
241713044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
241813044ca3SPierre Jolivet         PetscCall(KSPGetPC(ksp[0], &inner));
241913044ca3SPierre Jolivet         PetscCall(PCSetType(inner, PCSHELL)); /* compute the action of the inverse of the local Schur complement with a PCSHELL */
242013044ca3SPierre Jolivet         b[0] = subA[0];
242113044ca3SPierre Jolivet         b[3] = data->aux;
242213044ca3SPierre 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 */
242300b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[1]));
242400b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[2]));
242513044ca3SPierre Jolivet         PetscCall(PCCreate(PETSC_COMM_SELF, &s));
242613044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(s, ((PetscObject)inner)->prefix));
242713044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(inner, nullptr));
242813044ca3SPierre Jolivet         PetscCall(KSPSetSkipPCSetFromOptions(ksp[0], PETSC_TRUE));
242913044ca3SPierre Jolivet         PetscCall(PCSetType(s, PCLU));
243013044ca3SPierre Jolivet         if (PetscDefined(HAVE_MUMPS)) { /* only MATSOLVERMUMPS handles MATNEST, so for the others, e.g., MATSOLVERPETSC or MATSOLVERMKL_PARDISO, convert to plain MATAIJ */
243113044ca3SPierre Jolivet           PetscCall(PCFactorSetMatSolverType(s, MATSOLVERMUMPS));
243213044ca3SPierre Jolivet         }
243313044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(s));
243413044ca3SPierre Jolivet         PetscCall(PCFactorGetMatSolverType(s, &type));
243513044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
243613044ca3SPierre Jolivet         if (flg) {
243713044ca3SPierre Jolivet           PetscCall(PCSetOperators(s, N, N));
243800b491fbSPierre Jolivet           PetscCall(PCFactorGetMatrix(s, b));
243900b491fbSPierre Jolivet           PetscCall(MatSetOptionsPrefix(*b, ((PetscObject)s)->prefix));
244024ddd604SPierre Jolivet           n = -1;
244124ddd604SPierre Jolivet           PetscCall(PetscOptionsGetInt(nullptr, ((PetscObject)s)->prefix, "-mat_mumps_icntl_26", &n, nullptr));
2442f45b553cSPierre Jolivet           if (n == 1) {                                /* allocates a square MatDense of size is[1]->map->n, so one */
2443f45b553cSPierre Jolivet             PetscCall(MatNestGetISs(N, is, nullptr));  /*  needs to be able to deactivate this path when dealing    */
2444f45b553cSPierre Jolivet             PetscCall(MatFactorSetSchurIS(*b, is[1])); /*  with a large constraint space in order to avoid OOM      */
2445f45b553cSPierre Jolivet           }
244613044ca3SPierre Jolivet         } else {
244700b491fbSPierre Jolivet           PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, b));
244800b491fbSPierre Jolivet           PetscCall(PCSetOperators(s, N, *b));
244900b491fbSPierre Jolivet           PetscCall(PetscObjectDereference((PetscObject)*b));
245000b491fbSPierre 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 */
245113044ca3SPierre Jolivet         }
245213044ca3SPierre Jolivet         PetscCall(PetscNew(&p));
245313044ca3SPierre Jolivet         p->first = s;
245400b491fbSPierre Jolivet         PetscCall(MatCreateVecs(*b, p->second, p->second + 1));
245513044ca3SPierre Jolivet         PetscCall(PCShellSetContext(inner, p));
245613044ca3SPierre Jolivet         PetscCall(PCShellSetApply(inner, PCApply_Nest));
245713044ca3SPierre Jolivet         PetscCall(PCShellSetView(inner, PCView_Nest));
245813044ca3SPierre Jolivet         PetscCall(PCShellSetDestroy(inner, PCDestroy_Nest));
245913044ca3SPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)N));
246013044ca3SPierre Jolivet       }
2461f1580f4eSBarry Smith       if (!data->levels[0]->scatter) {
2462db4a47b3SPierre Jolivet         PetscCall(MatCreateVecs(P, &xin, nullptr));
2463f1580f4eSBarry Smith         if (ismatis) PetscCall(MatDestroy(&P));
2464db4a47b3SPierre Jolivet         PetscCall(VecScatterCreate(xin, data->is, data->levels[0]->D, nullptr, &data->levels[0]->scatter));
2465f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
2466f1580f4eSBarry Smith       }
2467f1580f4eSBarry Smith       if (data->levels[0]->P) {
2468f1580f4eSBarry Smith         /* if the pattern is the same and PCSetUp() has previously succeeded, reuse HPDDM buffers and connectivity */
2469f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[0], pc->setupcalled < 1 || pc->flag == DIFFERENT_NONZERO_PATTERN ? PETSC_TRUE : PETSC_FALSE));
2470f1580f4eSBarry Smith       }
2471f1580f4eSBarry Smith       if (!data->levels[0]->P) data->levels[0]->P = new HPDDM::Schwarz<PetscScalar>();
2472db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2473db4a47b3SPierre Jolivet       else PetscCall(PetscLogEventBegin(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2474f1580f4eSBarry Smith       /* HPDDM internal data structure */
247513044ca3SPierre Jolivet       PetscCall(data->levels[0]->P->structure(loc, data->is, !ctx ? sub[0] : nullptr, ismatis ? C : data->aux, data->levels));
2476db4a47b3SPierre Jolivet       if (!data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2477f1580f4eSBarry Smith       /* matrix pencil of the generalized eigenvalue problem on the overlap (GenEO) */
247813044ca3SPierre Jolivet       if (!ctx) {
24799bb5c669SPierre Jolivet         if (data->deflation || overlap != -1) weighted = data->aux;
2480f1580f4eSBarry Smith         else if (!data->B) {
2481e2b46ddfSPierre Jolivet           PetscBool cmp;
2482*811e8887SPierre Jolivet 
2483f1580f4eSBarry Smith           PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &weighted));
2484e2b46ddfSPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)weighted, &cmp, MATNORMAL, MATNORMALHERMITIAN, ""));
2485e2b46ddfSPierre Jolivet           if (cmp) flg = PETSC_FALSE;
2486e2b46ddfSPierre Jolivet           PetscCall(MatDiagonalScale(weighted, data->levels[0]->D, data->levels[0]->D));
24875b0bb9f2SPierre Jolivet           /* neither MatDuplicate() nor MatDiagonalScale() handles the symmetry options, so propagate the options explicitly */
2488f1580f4eSBarry Smith           /* only useful for -mat_type baij -pc_hpddm_levels_1_st_pc_type cholesky (no problem with MATAIJ or MATSBAIJ)      */
2489f1580f4eSBarry Smith           PetscCall(MatPropagateSymmetryOptions(sub[0], weighted));
2490f1580f4eSBarry Smith         } else weighted = data->B;
249113044ca3SPierre Jolivet       } else weighted = nullptr;
2492f1580f4eSBarry Smith       /* SLEPc is used inside the loaded symbol */
24939bb5c669SPierre 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));
24949bb5c669SPierre Jolivet       if (!ctx && data->share && overlap == -1) {
2495f1580f4eSBarry Smith         Mat st[2];
2496f1580f4eSBarry Smith         PetscCall(KSPGetOperators(ksp[0], st, st + 1));
24975c7345deSPierre Jolivet         PetscCall(MatCopy(subA[0], st[0], structure));
2498f1580f4eSBarry Smith         if (subA[1] != subA[0] || st[1] != st[0]) PetscCall(MatCopy(subA[1], st[1], SAME_NONZERO_PATTERN));
24990307214fSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)subA[0]));
2500f1580f4eSBarry Smith       }
2501db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2502f1580f4eSBarry Smith       if (ismatis) PetscCall(MatISGetLocalMat(C, &N));
2503f1580f4eSBarry Smith       else N = data->aux;
250413044ca3SPierre Jolivet       if (!ctx) P = sub[0];
250513044ca3SPierre Jolivet       else P = S;
2506f1580f4eSBarry Smith       /* going through the grid hierarchy */
2507f1580f4eSBarry Smith       for (n = 1; n < data->N; ++n) {
2508db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2509f1580f4eSBarry Smith         /* method composed in the loaded symbol since there, SLEPc is used as well */
2510f1580f4eSBarry 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));
2511db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2512f1580f4eSBarry Smith       }
2513f1580f4eSBarry Smith       /* reset to NULL to avoid any faulty use */
2514db4a47b3SPierre Jolivet       PetscCall(PetscObjectComposeFunction((PetscObject)data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", nullptr));
2515db4a47b3SPierre Jolivet       if (!ismatis) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_C", nullptr));
2516f1580f4eSBarry Smith       else PetscCall(PetscObjectDereference((PetscObject)C)); /* matching PetscObjectReference() above */
2517f1580f4eSBarry Smith       for (n = 0; n < data->N - 1; ++n)
2518f1580f4eSBarry Smith         if (data->levels[n]->P) {
2519f1580f4eSBarry Smith           /* HPDDM internal work buffers */
2520f1580f4eSBarry Smith           data->levels[n]->P->setBuffer();
2521f1580f4eSBarry Smith           data->levels[n]->P->super::start();
2522f1580f4eSBarry Smith         }
25239bb5c669SPierre Jolivet       if (ismatis || !subdomains) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
2524db4a47b3SPierre Jolivet       if (ismatis) data->is = nullptr;
2525f1580f4eSBarry Smith       for (n = 0; n < data->N - 1 + (reused > 0); ++n) {
2526f1580f4eSBarry Smith         if (data->levels[n]->P) {
2527f1580f4eSBarry Smith           PC spc;
2528f1580f4eSBarry Smith 
2529f1580f4eSBarry Smith           /* force the PC to be PCSHELL to do the coarse grid corrections */
2530f1580f4eSBarry Smith           PetscCall(KSPSetSkipPCSetFromOptions(data->levels[n]->ksp, PETSC_TRUE));
2531f1580f4eSBarry Smith           PetscCall(KSPGetPC(data->levels[n]->ksp, &spc));
2532f1580f4eSBarry Smith           PetscCall(PCSetType(spc, PCSHELL));
2533f1580f4eSBarry Smith           PetscCall(PCShellSetContext(spc, data->levels[n]));
2534f1580f4eSBarry Smith           PetscCall(PCShellSetSetUp(spc, PCSetUp_HPDDMShell));
2535f1580f4eSBarry Smith           PetscCall(PCShellSetApply(spc, PCApply_HPDDMShell));
2536f1580f4eSBarry Smith           PetscCall(PCShellSetMatApply(spc, PCMatApply_HPDDMShell));
253713044ca3SPierre Jolivet           if (ctx && n == 0) {
253813044ca3SPierre Jolivet             Mat                               Amat, Pmat;
253913044ca3SPierre Jolivet             PetscInt                          m, M;
254001e3c840SPierre Jolivet             std::tuple<Mat, PetscSF, Vec[2]> *ctx;
254113044ca3SPierre Jolivet 
254213044ca3SPierre Jolivet             PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &Pmat));
254313044ca3SPierre Jolivet             PetscCall(MatGetLocalSize(Pmat, &m, nullptr));
254413044ca3SPierre Jolivet             PetscCall(MatGetSize(Pmat, &M, nullptr));
254513044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));
254613044ca3SPierre Jolivet             std::get<0>(*ctx) = S;
254713044ca3SPierre Jolivet             std::get<1>(*ctx) = data->levels[n]->scatter;
254813044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)data->levels[n]->ksp), m, m, M, M, ctx, &Amat));
254913044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT, (void (*)(void))MatMult_Schur<false>));
255013044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMult_Schur<true>));
255113044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_DESTROY, (void (*)(void))MatDestroy_Schur));
255213044ca3SPierre Jolivet             PetscCall(MatCreateVecs(S, std::get<2>(*ctx), std::get<2>(*ctx) + 1));
255313044ca3SPierre Jolivet             PetscCall(KSPSetOperators(data->levels[n]->ksp, Amat, Pmat));
255413044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)Amat));
255513044ca3SPierre Jolivet           }
2556f1580f4eSBarry Smith           PetscCall(PCShellSetDestroy(spc, PCDestroy_HPDDMShell));
2557f1580f4eSBarry Smith           if (!data->levels[n]->pc) PetscCall(PCCreate(PetscObjectComm((PetscObject)data->levels[n]->ksp), &data->levels[n]->pc));
2558f1580f4eSBarry Smith           if (n < reused) {
2559f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(spc, PETSC_TRUE));
2560f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
2561f1580f4eSBarry Smith           }
2562f1580f4eSBarry Smith           PetscCall(PCSetUp(spc));
2563f1580f4eSBarry Smith         }
2564f1580f4eSBarry Smith       }
256513044ca3SPierre Jolivet       if (ctx) PetscCall(MatDestroy(&S));
25669bb5c669SPierre Jolivet       if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", nullptr));
2567f1580f4eSBarry Smith     } else flg = reused ? PETSC_FALSE : PETSC_TRUE;
2568f1580f4eSBarry Smith     if (!ismatis && subdomains) {
2569f1580f4eSBarry Smith       if (flg) PetscCall(KSPGetPC(data->levels[0]->ksp, &inner));
2570f1580f4eSBarry Smith       else inner = data->levels[0]->pc;
2571f1580f4eSBarry Smith       if (inner) {
2572398c7888SPierre Jolivet         if (!inner->setupcalled) PetscCall(PCSetType(inner, PCASM));
2573398c7888SPierre Jolivet         PetscCall(PCSetFromOptions(inner));
2574398c7888SPierre Jolivet         PetscCall(PetscStrcmp(((PetscObject)inner)->type_name, PCASM, &flg));
2575398c7888SPierre Jolivet         if (flg) {
2576f1580f4eSBarry Smith           if (!inner->setupcalled) { /* evaluates to PETSC_FALSE when -pc_hpddm_block_splitting */
2577398c7888SPierre Jolivet             IS sorted;               /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2578*811e8887SPierre Jolivet 
2579398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2580398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(inner, 1, &sorted, &loc));
2581398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2582398c7888SPierre Jolivet           }
2583c8ea6600SPierre Jolivet           if (!PetscBool3ToBool(data->Neumann) && data->N > 1) { /* subdomain matrices are already created for the eigenproblem, reuse them for the fine-level PC */
2584db4a47b3SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(*is, nullptr, nullptr, sub[0], &P, nullptr));
2585398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(inner, P, algebraic));
2586398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)P));
2587f1580f4eSBarry Smith           }
2588f1580f4eSBarry Smith         }
2589f1580f4eSBarry Smith       }
25909bb5c669SPierre Jolivet       if (data->N > 1) {
25919bb5c669SPierre Jolivet         if (overlap != 1) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
25929bb5c669SPierre Jolivet         if (overlap == 1) PetscCall(MatDestroy(subA));
25939bb5c669SPierre Jolivet       }
2594f1580f4eSBarry Smith     }
2595f1580f4eSBarry Smith     PetscCall(ISDestroy(&loc));
2596f1580f4eSBarry Smith   } else data->N = 1 + reused; /* enforce this value to 1 + reused if there is no way to build another level */
2597f1580f4eSBarry Smith   if (requested != data->N + reused) {
2598f1580f4eSBarry 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,
2599f1580f4eSBarry Smith                         data->N, pcpre ? pcpre : ""));
2600f1580f4eSBarry 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));
2601f1580f4eSBarry Smith     /* cannot use PCDestroy_HPDDMShell() because PCSHELL not set for unassembled levels */
2602f1580f4eSBarry Smith     for (n = data->N - 1; n < requested - 1; ++n) {
2603f1580f4eSBarry Smith       if (data->levels[n]->P) {
2604f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[n], PETSC_TRUE));
2605f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(1, &data->levels[n]->v[0]));
2606f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(2, &data->levels[n]->v[1]));
2607f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V));
2608f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 1));
2609f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 2));
2610f1580f4eSBarry Smith         PetscCall(VecDestroy(&data->levels[n]->D));
261101e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&data->levels[n]->scatter));
2612f1580f4eSBarry Smith       }
2613f1580f4eSBarry Smith     }
2614f1580f4eSBarry Smith     if (reused) {
2615f1580f4eSBarry Smith       for (n = reused; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
2616f1580f4eSBarry Smith         PetscCall(KSPDestroy(&data->levels[n]->ksp));
2617f1580f4eSBarry Smith         PetscCall(PCDestroy(&data->levels[n]->pc));
2618f1580f4eSBarry Smith       }
2619f1580f4eSBarry Smith     }
2620f1580f4eSBarry 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,
2621f1580f4eSBarry Smith                data->N, reused, data->N, pcpre ? pcpre : "", pcpre ? pcpre : "", data->N);
2622f1580f4eSBarry Smith   }
2623f1580f4eSBarry Smith   /* these solvers are created after PCSetFromOptions() is called */
2624f1580f4eSBarry Smith   if (pc->setfromoptionscalled) {
2625f1580f4eSBarry Smith     for (n = 0; n < data->N; ++n) {
2626f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetFromOptions(data->levels[n]->ksp));
2627f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetFromOptions(data->levels[n]->pc));
2628f1580f4eSBarry Smith     }
2629f1580f4eSBarry Smith     pc->setfromoptionscalled = 0;
2630f1580f4eSBarry Smith   }
2631f1580f4eSBarry Smith   data->N += reused;
2632f1580f4eSBarry Smith   if (data->share && swap) {
2633f1580f4eSBarry Smith     /* swap back pointers so that variables follow the user-provided numbering */
2634f1580f4eSBarry Smith     std::swap(C, data->aux);
2635f1580f4eSBarry Smith     std::swap(uis, data->is);
2636f1580f4eSBarry Smith     PetscCall(MatDestroy(&C));
2637f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
2638f1580f4eSBarry Smith   }
2639398c7888SPierre Jolivet   if (algebraic) PetscCall(MatDestroy(&data->aux));
264038fb34a1SPierre Jolivet   if (unsorted && unsorted != is[0]) {
2641398c7888SPierre Jolivet     PetscCall(ISCopy(unsorted, data->is));
2642398c7888SPierre Jolivet     PetscCall(ISDestroy(&unsorted));
2643398c7888SPierre Jolivet   }
2644398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2645398c7888SPierre 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);
2646398c7888SPierre Jolivet   if (data->is) {
2647398c7888SPierre Jolivet     PetscCall(ISEqualUnsorted(data->is, dis, &flg));
2648398c7888SPierre Jolivet     PetscCall(ISDestroy(&dis));
2649398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input IS and output IS are not equal");
2650398c7888SPierre Jolivet   }
2651398c7888SPierre 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);
2652398c7888SPierre Jolivet   if (data->aux) {
2653398c7888SPierre Jolivet     PetscCall(MatMultEqual(data->aux, daux, 20, &flg));
2654398c7888SPierre Jolivet     PetscCall(MatDestroy(&daux));
2655398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input Mat and output Mat are not equal");
2656398c7888SPierre Jolivet   }
2657398c7888SPierre Jolivet #endif
26583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2659f1580f4eSBarry Smith }
2660f1580f4eSBarry Smith 
2661f1580f4eSBarry Smith /*@
2662f1580f4eSBarry Smith   PCHPDDMSetCoarseCorrectionType - Sets the coarse correction type.
2663f1580f4eSBarry Smith 
2664c3339decSBarry Smith   Collective
2665f1580f4eSBarry Smith 
2666f1580f4eSBarry Smith   Input Parameters:
2667f1580f4eSBarry Smith + pc   - preconditioner context
2668aa1539e9SPierre Jolivet - type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2669f1580f4eSBarry Smith 
2670f1580f4eSBarry Smith   Options Database Key:
2671aa1539e9SPierre Jolivet . -pc_hpddm_coarse_correction <deflated, additive, balanced, none> - type of coarse correction to apply
2672f1580f4eSBarry Smith 
2673f1580f4eSBarry Smith   Level: intermediate
2674f1580f4eSBarry Smith 
2675562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2676f1580f4eSBarry Smith @*/
2677d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType type)
2678d71ae5a4SJacob Faibussowitsch {
2679f1580f4eSBarry Smith   PetscFunctionBegin;
2680f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2681f1580f4eSBarry Smith   PetscValidLogicalCollectiveEnum(pc, type, 2);
2682f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMSetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType), (pc, type));
26833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2684f1580f4eSBarry Smith }
2685f1580f4eSBarry Smith 
2686f1580f4eSBarry Smith /*@
2687f1580f4eSBarry Smith   PCHPDDMGetCoarseCorrectionType - Gets the coarse correction type.
2688f1580f4eSBarry Smith 
2689f1580f4eSBarry Smith   Input Parameter:
2690f1580f4eSBarry Smith . pc - preconditioner context
2691f1580f4eSBarry Smith 
2692f1580f4eSBarry Smith   Output Parameter:
2693aa1539e9SPierre Jolivet . type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2694f1580f4eSBarry Smith 
2695f1580f4eSBarry Smith   Level: intermediate
2696f1580f4eSBarry Smith 
2697562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2698f1580f4eSBarry Smith @*/
2699d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType *type)
2700d71ae5a4SJacob Faibussowitsch {
2701f1580f4eSBarry Smith   PetscFunctionBegin;
2702f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2703f1580f4eSBarry Smith   if (type) {
27044f572ea9SToby Isaac     PetscAssertPointer(type, 2);
2705f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType *), (pc, type));
2706f1580f4eSBarry Smith   }
27073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2708f1580f4eSBarry Smith }
2709f1580f4eSBarry Smith 
2710d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType type)
2711d71ae5a4SJacob Faibussowitsch {
2712f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2713f1580f4eSBarry Smith 
2714f1580f4eSBarry Smith   PetscFunctionBegin;
2715f1580f4eSBarry Smith   data->correction = type;
27163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2717f1580f4eSBarry Smith }
2718f1580f4eSBarry Smith 
2719d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType *type)
2720d71ae5a4SJacob Faibussowitsch {
2721f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2722f1580f4eSBarry Smith 
2723f1580f4eSBarry Smith   PetscFunctionBegin;
2724f1580f4eSBarry Smith   *type = data->correction;
27253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2726f1580f4eSBarry Smith }
2727f1580f4eSBarry Smith 
2728f1580f4eSBarry Smith /*@
2729e31fc274SPierre Jolivet   PCHPDDMSetSTShareSubKSP - Sets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver should be shared.
2730e31fc274SPierre Jolivet 
2731e31fc274SPierre Jolivet   Input Parameters:
2732e31fc274SPierre Jolivet + pc    - preconditioner context
2733e31fc274SPierre Jolivet - share - whether the `KSP` should be shared or not
2734e31fc274SPierre Jolivet 
2735e31fc274SPierre Jolivet   Note:
2736e31fc274SPierre Jolivet   This is not the same as `PCSetReusePreconditioner()`. Given certain conditions (visible using -info), a symbolic factorization can be skipped
2737e31fc274SPierre Jolivet   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2738e31fc274SPierre Jolivet 
2739e31fc274SPierre Jolivet   Level: advanced
2740e31fc274SPierre Jolivet 
2741562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMGetSTShareSubKSP()`
2742e31fc274SPierre Jolivet @*/
2743e31fc274SPierre Jolivet PetscErrorCode PCHPDDMSetSTShareSubKSP(PC pc, PetscBool share)
2744e31fc274SPierre Jolivet {
2745e31fc274SPierre Jolivet   PetscFunctionBegin;
2746e31fc274SPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2747e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetSTShareSubKSP_C", (PC, PetscBool), (pc, share));
27483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2749e31fc274SPierre Jolivet }
2750e31fc274SPierre Jolivet 
2751e31fc274SPierre Jolivet /*@
2752f1580f4eSBarry Smith   PCHPDDMGetSTShareSubKSP - Gets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver is shared.
2753f1580f4eSBarry Smith 
2754f1580f4eSBarry Smith   Input Parameter:
2755f1580f4eSBarry Smith . pc - preconditioner context
2756f1580f4eSBarry Smith 
2757f1580f4eSBarry Smith   Output Parameter:
2758f1580f4eSBarry Smith . share - whether the `KSP` is shared or not
2759f1580f4eSBarry Smith 
2760f1580f4eSBarry Smith   Note:
2761f1580f4eSBarry 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
2762f1580f4eSBarry Smith   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2763f1580f4eSBarry Smith 
2764f1580f4eSBarry Smith   Level: advanced
2765f1580f4eSBarry Smith 
2766562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetSTShareSubKSP()`
2767f1580f4eSBarry Smith @*/
2768d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetSTShareSubKSP(PC pc, PetscBool *share)
2769d71ae5a4SJacob Faibussowitsch {
2770f1580f4eSBarry Smith   PetscFunctionBegin;
2771f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2772f1580f4eSBarry Smith   if (share) {
27734f572ea9SToby Isaac     PetscAssertPointer(share, 2);
2774f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetSTShareSubKSP_C", (PC, PetscBool *), (pc, share));
2775f1580f4eSBarry Smith   }
27763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2777f1580f4eSBarry Smith }
2778f1580f4eSBarry Smith 
2779e31fc274SPierre Jolivet static PetscErrorCode PCHPDDMSetSTShareSubKSP_HPDDM(PC pc, PetscBool share)
2780e31fc274SPierre Jolivet {
2781e31fc274SPierre Jolivet   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2782e31fc274SPierre Jolivet 
2783e31fc274SPierre Jolivet   PetscFunctionBegin;
2784e31fc274SPierre Jolivet   data->share = share;
27853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2786e31fc274SPierre Jolivet }
2787e31fc274SPierre Jolivet 
2788d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetSTShareSubKSP_HPDDM(PC pc, PetscBool *share)
2789d71ae5a4SJacob Faibussowitsch {
2790f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2791f1580f4eSBarry Smith 
2792f1580f4eSBarry Smith   PetscFunctionBegin;
2793f1580f4eSBarry Smith   *share = data->share;
27943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2795f1580f4eSBarry Smith }
2796f1580f4eSBarry Smith 
2797f1580f4eSBarry Smith /*@
2798f1580f4eSBarry Smith   PCHPDDMSetDeflationMat - Sets the deflation space used to assemble a coarser operator.
2799f1580f4eSBarry Smith 
2800f1580f4eSBarry Smith   Input Parameters:
2801f1580f4eSBarry Smith + pc - preconditioner context
2802f1580f4eSBarry Smith . is - index set of the local deflation matrix
2803f1580f4eSBarry Smith - U  - deflation sequential matrix stored as a `MATSEQDENSE`
2804f1580f4eSBarry Smith 
2805f1580f4eSBarry Smith   Level: advanced
2806f1580f4eSBarry Smith 
2807562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCDeflationSetSpace()`, `PCMGSetRestriction()`
2808f1580f4eSBarry Smith @*/
2809d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetDeflationMat(PC pc, IS is, Mat U)
2810d71ae5a4SJacob Faibussowitsch {
2811f1580f4eSBarry Smith   PetscFunctionBegin;
2812f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2813f1580f4eSBarry Smith   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
2814f1580f4eSBarry Smith   PetscValidHeaderSpecific(U, MAT_CLASSID, 3);
2815e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetDeflationMat_C", (PC, IS, Mat), (pc, is, U));
28163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2817f1580f4eSBarry Smith }
2818f1580f4eSBarry Smith 
2819d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetDeflationMat_HPDDM(PC pc, IS is, Mat U)
2820d71ae5a4SJacob Faibussowitsch {
2821f1580f4eSBarry Smith   PetscFunctionBegin;
2822f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, U, PETSC_TRUE));
28233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2824f1580f4eSBarry Smith }
2825f1580f4eSBarry Smith 
2826d71ae5a4SJacob Faibussowitsch PetscErrorCode HPDDMLoadDL_Private(PetscBool *found)
2827d71ae5a4SJacob Faibussowitsch {
2828605ad303SPierre Jolivet   PetscBool flg;
2829f1580f4eSBarry Smith   char      lib[PETSC_MAX_PATH_LEN], dlib[PETSC_MAX_PATH_LEN], dir[PETSC_MAX_PATH_LEN];
2830f1580f4eSBarry Smith 
2831f1580f4eSBarry Smith   PetscFunctionBegin;
28324f572ea9SToby Isaac   PetscAssertPointer(found, 1);
2833c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(dir, "${PETSC_LIB_DIR}", sizeof(dir)));
2834db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, nullptr, "-hpddm_dir", dir, sizeof(dir), nullptr));
2835f1580f4eSBarry Smith   PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2836f1580f4eSBarry Smith   PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2837605ad303SPierre Jolivet #if defined(SLEPC_LIB_DIR) /* this variable is passed during SLEPc ./configure when PETSc has not been configured   */
2838605ad303SPierre Jolivet   if (!*found) {           /* with --download-hpddm since slepcconf.h is not yet built (and thus can't be included) */
2839c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(dir, HPDDM_STR(SLEPC_LIB_DIR), sizeof(dir)));
2840f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2841f1580f4eSBarry Smith     PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2842f1580f4eSBarry Smith   }
2843f1580f4eSBarry Smith #endif
2844605ad303SPierre 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 */
2845605ad303SPierre Jolivet     PetscCall(PetscOptionsGetenv(PETSC_COMM_SELF, "SLEPC_DIR", dir, sizeof(dir), &flg));
2846605ad303SPierre 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 */
2847605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libslepc", dir));
2848605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2849605ad303SPierre Jolivet       PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found but SLEPC_DIR=%s", lib, dir);
2850605ad303SPierre Jolivet       PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
2851605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libhpddm_petsc", dir)); /* libhpddm_petsc is always in the same directory as libslepc */
2852605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2853605ad303SPierre Jolivet     }
2854605ad303SPierre Jolivet   }
2855f1580f4eSBarry Smith   PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found", lib);
2856f1580f4eSBarry Smith   PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
28573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2858f1580f4eSBarry Smith }
2859f1580f4eSBarry Smith 
2860f1580f4eSBarry Smith /*MC
2861f1580f4eSBarry Smith    PCHPDDM - Interface with the HPDDM library.
2862f1580f4eSBarry Smith 
28631d27aa22SBarry Smith    This `PC` may be used to build multilevel spectral domain decomposition methods based on the GenEO framework {cite}`spillane2011robust` {cite}`al2021multilevel`.
28641d27aa22SBarry Smith    It may be viewed as an alternative to spectral
28651d27aa22SBarry Smith    AMGe or `PCBDDC` with adaptive selection of constraints. The interface is explained in details in {cite}`jolivetromanzampini2020`
2866f1580f4eSBarry Smith 
2867e7593814SPierre 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`).
2868f1580f4eSBarry Smith 
2869f1580f4eSBarry Smith    For multilevel preconditioning, when using an assembled or hierarchical Pmat, one must provide an auxiliary local `Mat` (unassembled local operator for GenEO) using
2870f1580f4eSBarry Smith    `PCHPDDMSetAuxiliaryMat()`. Calling this routine is not needed when using a `MATIS` Pmat, assembly is done internally using `MatConvert()`.
2871f1580f4eSBarry Smith 
2872f1580f4eSBarry Smith    Options Database Keys:
2873f1580f4eSBarry Smith +   -pc_hpddm_define_subdomains <true, default=false>    - on the finest level, calls `PCASMSetLocalSubdomains()` with the `IS` supplied in `PCHPDDMSetAuxiliaryMat()`
2874f1580f4eSBarry Smith                                                          (not relevant with an unassembled Pmat)
2875f1580f4eSBarry Smith .   -pc_hpddm_has_neumann <true, default=false>          - on the finest level, informs the `PC` that the local Neumann matrix is supplied in `PCHPDDMSetAuxiliaryMat()`
2876f1580f4eSBarry Smith -   -pc_hpddm_coarse_correction <type, default=deflated> - determines the `PCHPDDMCoarseCorrectionType` when calling `PCApply()`
2877f1580f4eSBarry Smith 
287838bf2a8cSPierre Jolivet    Options for subdomain solvers, subdomain eigensolvers (for computing deflation vectors), and the coarse solver can be set using the following options database prefixes.
2879f1580f4eSBarry Smith .vb
2880f1580f4eSBarry Smith       -pc_hpddm_levels_%d_pc_
2881f1580f4eSBarry Smith       -pc_hpddm_levels_%d_ksp_
2882f1580f4eSBarry Smith       -pc_hpddm_levels_%d_eps_
2883f1580f4eSBarry Smith       -pc_hpddm_levels_%d_p
28844ec2a359SPierre Jolivet       -pc_hpddm_levels_%d_mat_type
2885f1580f4eSBarry Smith       -pc_hpddm_coarse_
2886f1580f4eSBarry Smith       -pc_hpddm_coarse_p
28874ec2a359SPierre Jolivet       -pc_hpddm_coarse_mat_type
28882ce66baaSPierre Jolivet       -pc_hpddm_coarse_mat_filter
2889f1580f4eSBarry Smith .ve
2890f1580f4eSBarry Smith 
289138bf2a8cSPierre 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
2892f1580f4eSBarry Smith     -pc_hpddm_coarse_p 2 -pc_hpddm_coarse_mat_type baij will use 10 deflation vectors per subdomain on the fine "level 1",
2893f1580f4eSBarry Smith     aggregate the fine subdomains into 4 "level 2" subdomains, then use 10 deflation vectors per subdomain on "level 2",
28947eb095acSPierre Jolivet     and assemble the coarse matrix (of dimension 4 x 10 = 40) on two processes as a `MATBAIJ` (default is `MATSBAIJ`).
2895f1580f4eSBarry Smith 
2896f1580f4eSBarry 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.
2897f1580f4eSBarry Smith 
28981d27aa22SBarry Smith    Level: intermediate
28991d27aa22SBarry Smith 
29001d27aa22SBarry Smith    Notes:
29011d27aa22SBarry Smith    This preconditioner requires that PETSc is built with SLEPc (``--download-slepc``).
29021d27aa22SBarry Smith 
29031d27aa22SBarry Smith    By default, the underlying concurrent eigenproblems
29041d27aa22SBarry Smith    are solved using SLEPc shift-and-invert spectral transformation. This is usually what gives the best performance for GenEO, cf.
29051d27aa22SBarry Smith    {cite}`spillane2011robust` {cite}`jolivet2013scalabledd`. As
290638bf2a8cSPierre 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
290738bf2a8cSPierre 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
290838bf2a8cSPierre Jolivet    SLEPc documentation since they are specific to `PCHPDDM`.
290938bf2a8cSPierre Jolivet .vb
291038bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_st_share_sub_ksp
291138bf2a8cSPierre Jolivet       -pc_hpddm_levels_%d_eps_threshold
291238bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_eps_use_inertia
291338bf2a8cSPierre Jolivet .ve
291438bf2a8cSPierre Jolivet 
291538bf2a8cSPierre Jolivet    The first option from the list only applies to the fine-level eigensolver, see `PCHPDDMSetSTShareSubKSP()`. The second option from the list is
291638bf2a8cSPierre Jolivet    used to filter eigenmodes retrieved after convergence of `EPSSolve()` at "level N" such that eigenvectors used to define a "level N+1" coarse
291738bf2a8cSPierre 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
291838bf2a8cSPierre 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
291938bf2a8cSPierre 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
292038bf2a8cSPierre Jolivet    to supply -pc_hpddm_levels_1_eps_nev. This last option also only applies to the fine-level (N = 1) eigensolver.
2921f1580f4eSBarry Smith 
29221d27aa22SBarry Smith    See also {cite}`dolean2015introduction`, {cite}`al2022robust`, {cite}`al2022robustpd`, and {cite}`nataf2022recent`
2923f1580f4eSBarry Smith 
2924562efe2eSBarry Smith .seealso: [](ch_ksp), `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetAuxiliaryMat()`, `MATIS`, `PCBDDC`, `PCDEFLATION`, `PCTELESCOPE`, `PCASM`,
2925e31fc274SPierre Jolivet           `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDMHasNeumannMat()`, `PCHPDDMSetRHSMat()`, `PCHPDDMSetDeflationMat()`, `PCHPDDMSetSTShareSubKSP()`,
2926e31fc274SPierre Jolivet           `PCHPDDMGetSTShareSubKSP()`, `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDMGetComplexities()`
2927f1580f4eSBarry Smith M*/
2928d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_HPDDM(PC pc)
2929d71ae5a4SJacob Faibussowitsch {
2930f1580f4eSBarry Smith   PC_HPDDM *data;
2931f1580f4eSBarry Smith   PetscBool found;
2932f1580f4eSBarry Smith 
2933f1580f4eSBarry Smith   PetscFunctionBegin;
2934f1580f4eSBarry Smith   if (!loadedSym) {
2935f1580f4eSBarry Smith     PetscCall(HPDDMLoadDL_Private(&found));
2936db4a47b3SPierre Jolivet     if (found) PetscCall(PetscDLLibrarySym(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, nullptr, "PCHPDDM_Internal", (void **)&loadedSym));
2937f1580f4eSBarry Smith   }
2938f1580f4eSBarry Smith   PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCHPDDM_Internal symbol not found in loaded libhpddm_petsc");
29394dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&data));
2940f1580f4eSBarry Smith   pc->data                = data;
2941c8ea6600SPierre Jolivet   data->Neumann           = PETSC_BOOL3_UNKNOWN;
2942f1580f4eSBarry Smith   pc->ops->reset          = PCReset_HPDDM;
2943f1580f4eSBarry Smith   pc->ops->destroy        = PCDestroy_HPDDM;
2944f1580f4eSBarry Smith   pc->ops->setfromoptions = PCSetFromOptions_HPDDM;
2945f1580f4eSBarry Smith   pc->ops->setup          = PCSetUp_HPDDM;
2946f1580f4eSBarry Smith   pc->ops->apply          = PCApply_HPDDM;
2947f1580f4eSBarry Smith   pc->ops->matapply       = PCMatApply_HPDDM;
2948f1580f4eSBarry Smith   pc->ops->view           = PCView_HPDDM;
2949f1580f4eSBarry Smith   pc->ops->presolve       = PCPreSolve_HPDDM;
2950f1580f4eSBarry Smith 
2951f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", PCHPDDMSetAuxiliaryMat_HPDDM));
2952f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", PCHPDDMHasNeumannMat_HPDDM));
2953f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", PCHPDDMSetRHSMat_HPDDM));
2954f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", PCHPDDMSetCoarseCorrectionType_HPDDM));
2955f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", PCHPDDMGetCoarseCorrectionType_HPDDM));
2956e31fc274SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", PCHPDDMSetSTShareSubKSP_HPDDM));
2957f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", PCHPDDMGetSTShareSubKSP_HPDDM));
2958f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", PCHPDDMSetDeflationMat_HPDDM));
29593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2960f1580f4eSBarry Smith }
2961f1580f4eSBarry Smith 
2962f1580f4eSBarry Smith /*@C
2963f1580f4eSBarry Smith   PCHPDDMInitializePackage - This function initializes everything in the `PCHPDDM` package. It is called from `PCInitializePackage()`.
2964f1580f4eSBarry Smith 
2965f1580f4eSBarry Smith   Level: developer
2966f1580f4eSBarry Smith 
2967562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscInitialize()`
2968f1580f4eSBarry Smith @*/
2969d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMInitializePackage(void)
2970d71ae5a4SJacob Faibussowitsch {
2971f1580f4eSBarry Smith   char ename[32];
2972f1580f4eSBarry Smith 
2973f1580f4eSBarry Smith   PetscFunctionBegin;
29743ba16761SJacob Faibussowitsch   if (PCHPDDMPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
2975f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_TRUE;
2976f1580f4eSBarry Smith   PetscCall(PetscRegisterFinalize(PCHPDDMFinalizePackage));
2977f1580f4eSBarry Smith   /* general events registered once during package initialization */
2978f1580f4eSBarry Smith   /* some of these events are not triggered in libpetsc,          */
2979f1580f4eSBarry Smith   /* but rather directly in libhpddm_petsc,                       */
2980f1580f4eSBarry Smith   /* which is in charge of performing the following operations    */
2981f1580f4eSBarry Smith 
2982f1580f4eSBarry Smith   /* domain decomposition structure from Pmat sparsity pattern    */
2983f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMStrc", PC_CLASSID, &PC_HPDDM_Strc));
2984f1580f4eSBarry Smith   /* Galerkin product, redistribution, and setup (not triggered in libpetsc)                */
2985f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtAP", PC_CLASSID, &PC_HPDDM_PtAP));
2986f1580f4eSBarry Smith   /* Galerkin product with summation, redistribution, and setup (not triggered in libpetsc) */
2987f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtBP", PC_CLASSID, &PC_HPDDM_PtBP));
2988f1580f4eSBarry Smith   /* next level construction using PtAP and PtBP (not triggered in libpetsc)                */
2989f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMNext", PC_CLASSID, &PC_HPDDM_Next));
2990f1580f4eSBarry Smith   static_assert(PETSC_PCHPDDM_MAXLEVELS <= 9, "PETSC_PCHPDDM_MAXLEVELS value is too high");
2991*811e8887SPierre Jolivet   for (PetscInt i = 1; i < PETSC_PCHPDDM_MAXLEVELS; ++i) {
2992f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSetUp L%1" PetscInt_FMT, i));
2993f1580f4eSBarry Smith     /* events during a PCSetUp() at level #i _except_ the assembly */
2994f1580f4eSBarry Smith     /* of the Galerkin operator of the coarser level #(i + 1)      */
2995f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_SetUp[i - 1]));
2996f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSolve L%1" PetscInt_FMT, i));
2997f1580f4eSBarry Smith     /* events during a PCApply() at level #i _except_              */
2998f1580f4eSBarry Smith     /* the KSPSolve() of the coarser level #(i + 1)                */
2999f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_Solve[i - 1]));
3000f1580f4eSBarry Smith   }
30013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3002f1580f4eSBarry Smith }
3003f1580f4eSBarry Smith 
3004f1580f4eSBarry Smith /*@C
3005f1580f4eSBarry Smith   PCHPDDMFinalizePackage - This function frees everything from the `PCHPDDM` package. It is called from `PetscFinalize()`.
3006f1580f4eSBarry Smith 
3007f1580f4eSBarry Smith   Level: developer
3008f1580f4eSBarry Smith 
3009562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscFinalize()`
3010f1580f4eSBarry Smith @*/
3011d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMFinalizePackage(void)
3012d71ae5a4SJacob Faibussowitsch {
3013f1580f4eSBarry Smith   PetscFunctionBegin;
3014f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_FALSE;
30153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3016f1580f4eSBarry Smith }
30179bb5c669SPierre Jolivet 
30189bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat A, Vec x, Vec y)
30199bb5c669SPierre Jolivet {
30209bb5c669SPierre Jolivet   Harmonic h; /* [ A_00  A_01       ], furthermore, A_00 = [ A_loc,loc  A_loc,ovl ], thus, A_01 = [         ] */
30219bb5c669SPierre Jolivet               /* [ A_10  A_11  A_12 ]                      [ A_ovl,loc  A_ovl,ovl ]               [ A_ovl,1 ] */
30229bb5c669SPierre Jolivet   Vec sub;    /*  y = A x = R_loc R_0 [ A_00  A_01 ]^-1                                   R_loc = [  I_loc  ] */
30239bb5c669SPierre Jolivet               /*                      [ A_10  A_11 ]    R_1^T A_12 x                              [         ] */
30249bb5c669SPierre Jolivet   PetscFunctionBegin;
30259bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
30269bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
30279bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
30289bb5c669SPierre Jolivet   PetscCall(MatMult(h->A[0], x, sub));
30299bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
30309bb5c669SPierre Jolivet   PetscCall(KSPSolve(h->ksp, h->v, h->v));
30319bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_REVERSE, y));
30329bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30339bb5c669SPierre Jolivet }
30349bb5c669SPierre Jolivet 
30359bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat A, Vec y, Vec x)
30369bb5c669SPierre Jolivet {
30379bb5c669SPierre Jolivet   Harmonic h;   /* x = A^T y =            [ A_00  A_01 ]^-T R_0^T R_loc^T y */
30389bb5c669SPierre Jolivet   Vec      sub; /*             A_12^T R_1 [ A_10  A_11 ]                    */
30399bb5c669SPierre Jolivet 
30409bb5c669SPierre Jolivet   PetscFunctionBegin;
30419bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
30429bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
30439bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_FORWARD, y));
30449bb5c669SPierre Jolivet   PetscCall(KSPSolveTranspose(h->ksp, h->v, h->v));
30459bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
30469bb5c669SPierre Jolivet   PetscCall(MatMultTranspose(h->A[0], sub, x));
30479bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
30489bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30499bb5c669SPierre Jolivet }
30509bb5c669SPierre Jolivet 
30519bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat S, Mat X, Mat Y, void *)
30529bb5c669SPierre Jolivet {
30539bb5c669SPierre Jolivet   Harmonic h;
30549bb5c669SPierre Jolivet   Mat      A, B;
30559bb5c669SPierre Jolivet   Vec      a, b;
30569bb5c669SPierre Jolivet 
30579bb5c669SPierre Jolivet   PetscFunctionBegin;
30589bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
3059fb842aefSJose E. Roman   PetscCall(MatMatMult(h->A[0], X, MAT_INITIAL_MATRIX, PETSC_CURRENT, &A));
30609bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
30619bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
30629bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
30639bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B, i, &b));
30649bb5c669SPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_FORWARD, a));
30659bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B, i, &b));
30669bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
30679bb5c669SPierre Jolivet   }
30689bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
30699bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, B->cmap->n, nullptr, &A));
30709bb5c669SPierre Jolivet   PetscCall(KSPMatSolve(h->ksp, B, A));
30719bb5c669SPierre Jolivet   PetscCall(MatDestroy(&B));
30729bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
30739bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
30749bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &b));
30759bb5c669SPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_REVERSE, b));
30769bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &b));
30779bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
30789bb5c669SPierre Jolivet   }
30799bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
30809bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30819bb5c669SPierre Jolivet }
30829bb5c669SPierre Jolivet 
30839bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat A)
30849bb5c669SPierre Jolivet {
30859bb5c669SPierre Jolivet   Harmonic h;
30869bb5c669SPierre Jolivet 
30879bb5c669SPierre Jolivet   PetscFunctionBegin;
30889bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
30899bb5c669SPierre Jolivet   for (PetscInt i = 0; i < (h->A[1] ? 5 : 3); ++i) PetscCall(ISDestroy(h->is + i));
30909bb5c669SPierre Jolivet   PetscCall(PetscFree(h->is));
30919bb5c669SPierre Jolivet   PetscCall(VecDestroy(&h->v));
30929bb5c669SPierre Jolivet   for (PetscInt i = 0; i < 2; ++i) PetscCall(MatDestroy(h->A + i));
30939bb5c669SPierre Jolivet   PetscCall(PetscFree(h->A));
30949bb5c669SPierre Jolivet   PetscCall(KSPDestroy(&h->ksp));
30959bb5c669SPierre Jolivet   PetscCall(PetscFree(h));
30969bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
30979bb5c669SPierre Jolivet }
3098