xref: /petsc/src/ksp/pc/impls/hpddm/pchpddm.cxx (revision 8dc3fbee5923713866e8a50a6f190ae2fe2caafa)
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) {
29811e8887SPierre 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;
74c30dab7bSPierre Jolivet   PetscValidLogicalCollectiveBool(pc, deflation, 4);
75c30dab7bSPierre Jolivet   if (is && A) {
76c30dab7bSPierre Jolivet     PetscInt m[2];
77c30dab7bSPierre Jolivet 
78c30dab7bSPierre Jolivet     PetscCall(ISGetLocalSize(is, m));
79c30dab7bSPierre Jolivet     PetscCall(MatGetLocalSize(A, m + 1, nullptr));
80c30dab7bSPierre Jolivet     PetscCheck(m[0] == m[1], PETSC_COMM_SELF, PETSC_ERR_USER_INPUT, "Inconsistent IS and Mat sizes (%" PetscInt_FMT " v. %" PetscInt_FMT ")", m[0], m[1]);
81c30dab7bSPierre Jolivet   }
82f1580f4eSBarry Smith   if (is) {
83f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)is));
84f1580f4eSBarry Smith     if (data->is) { /* new overlap definition resets the PC */
85f1580f4eSBarry Smith       PetscCall(PCReset_HPDDM(pc));
86f1580f4eSBarry Smith       pc->setfromoptionscalled = 0;
87371d2eb7SMartin Diehl       pc->setupcalled          = PETSC_FALSE;
88cdbd50ebSPierre Jolivet       data->correction         = type;
89f1580f4eSBarry Smith     }
90f1580f4eSBarry Smith     PetscCall(ISDestroy(&data->is));
91f1580f4eSBarry Smith     data->is = is;
92f1580f4eSBarry Smith   }
93f1580f4eSBarry Smith   if (A) {
94f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)A));
95f1580f4eSBarry Smith     PetscCall(MatDestroy(&data->aux));
96f1580f4eSBarry Smith     data->aux = A;
97f1580f4eSBarry Smith   }
98f1580f4eSBarry Smith   data->deflation = deflation;
993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
100f1580f4eSBarry Smith }
101f1580f4eSBarry Smith 
102281f8ce6SPierre Jolivet static inline PetscErrorCode PCHPDDMSplittingMatNormal_Private(Mat A, IS *is, Mat *splitting[])
103281f8ce6SPierre Jolivet {
104281f8ce6SPierre Jolivet   Mat *sub;
105281f8ce6SPierre Jolivet   IS   zero;
106281f8ce6SPierre Jolivet 
107281f8ce6SPierre Jolivet   PetscFunctionBegin;
108281f8ce6SPierre Jolivet   PetscCall(MatSetOption(A, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
109281f8ce6SPierre Jolivet   PetscCall(MatCreateSubMatrices(A, 1, is + 2, is, MAT_INITIAL_MATRIX, splitting));
110281f8ce6SPierre Jolivet   PetscCall(MatCreateSubMatrices(**splitting, 1, is + 2, is + 1, MAT_INITIAL_MATRIX, &sub));
111281f8ce6SPierre Jolivet   PetscCall(MatFindZeroRows(*sub, &zero));
112281f8ce6SPierre Jolivet   PetscCall(MatDestroySubMatrices(1, &sub));
113281f8ce6SPierre Jolivet   PetscCall(MatSetOption(**splitting, MAT_KEEP_NONZERO_PATTERN, PETSC_TRUE));
114281f8ce6SPierre Jolivet   PetscCall(MatZeroRowsIS(**splitting, zero, 0.0, nullptr, nullptr));
115281f8ce6SPierre Jolivet   PetscCall(ISDestroy(&zero));
116281f8ce6SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
117281f8ce6SPierre Jolivet }
118281f8ce6SPierre Jolivet 
119281f8ce6SPierre Jolivet static inline PetscErrorCode PCHPDDMSetAuxiliaryMatNormal_Private(PC pc, Mat A, Mat N, Mat *B, const char *pcpre, Vec *diagonal = nullptr, Mat B01 = nullptr)
120d71ae5a4SJacob Faibussowitsch {
121f1580f4eSBarry Smith   PC_HPDDM *data         = (PC_HPDDM *)pc->data;
122281f8ce6SPierre Jolivet   Mat      *splitting[2] = {}, aux;
1233df4cd7bSPierre Jolivet   Vec       d;
124281f8ce6SPierre Jolivet   IS        is[3];
125f1580f4eSBarry Smith   PetscReal norm;
126f1580f4eSBarry Smith   PetscBool flg;
127f1580f4eSBarry Smith   char      type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
128f1580f4eSBarry Smith 
129f1580f4eSBarry Smith   PetscFunctionBegin;
130281f8ce6SPierre Jolivet   if (!B01) PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, B));
131281f8ce6SPierre Jolivet   else PetscCall(MatTransposeMatMult(B01, A, MAT_INITIAL_MATRIX, PETSC_DETERMINE, B));
132feebddf4SPierre Jolivet   PetscCall(MatEliminateZeros(*B, PETSC_TRUE));
133281f8ce6SPierre Jolivet   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, is));
134281f8ce6SPierre Jolivet   PetscCall(MatIncreaseOverlap(*B, 1, is, 1));
135281f8ce6SPierre Jolivet   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, is + 2));
136281f8ce6SPierre Jolivet   PetscCall(ISEmbed(is[0], is[2], PETSC_TRUE, is + 1));
137281f8ce6SPierre Jolivet   PetscCall(ISDestroy(is + 2));
138281f8ce6SPierre Jolivet   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->rmap->N, 0, 1, is + 2));
139281f8ce6SPierre Jolivet   PetscCall(PCHPDDMSplittingMatNormal_Private(A, is, &splitting[0]));
140281f8ce6SPierre Jolivet   if (B01) {
141281f8ce6SPierre Jolivet     PetscCall(PCHPDDMSplittingMatNormal_Private(B01, is, &splitting[1]));
142281f8ce6SPierre Jolivet     PetscCall(MatDestroy(&B01));
143281f8ce6SPierre Jolivet   }
144281f8ce6SPierre Jolivet   PetscCall(ISDestroy(is + 2));
145281f8ce6SPierre Jolivet   PetscCall(ISDestroy(is + 1));
146*8dc3fbeeSPierre Jolivet   PetscCall(PetscOptionsGetString(((PetscObject)pc)->options, pcpre, "-pc_hpddm_levels_1_sub_pc_type", type, sizeof(type), nullptr));
147f1580f4eSBarry Smith   PetscCall(PetscStrcmp(type, PCQR, &flg));
148f1580f4eSBarry Smith   if (!flg) {
149281f8ce6SPierre Jolivet     Mat conjugate = *splitting[splitting[1] ? 1 : 0];
150811e8887SPierre Jolivet 
151281f8ce6SPierre Jolivet     if (PetscDefined(USE_COMPLEX) && !splitting[1]) {
152281f8ce6SPierre Jolivet       PetscCall(MatDuplicate(*splitting[0], MAT_COPY_VALUES, &conjugate));
153f1580f4eSBarry Smith       PetscCall(MatConjugate(conjugate));
154f1580f4eSBarry Smith     }
155281f8ce6SPierre Jolivet     PetscCall(MatTransposeMatMult(conjugate, *splitting[0], MAT_INITIAL_MATRIX, PETSC_DETERMINE, &aux));
156281f8ce6SPierre Jolivet     if (PetscDefined(USE_COMPLEX) && !splitting[1]) PetscCall(MatDestroy(&conjugate));
157281f8ce6SPierre Jolivet     else if (splitting[1]) PetscCall(MatDestroySubMatrices(1, &splitting[1]));
158f1580f4eSBarry Smith     PetscCall(MatNorm(aux, NORM_FROBENIUS, &norm));
159f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1603df4cd7bSPierre Jolivet     if (diagonal) {
161811e8887SPierre Jolivet       PetscReal norm;
162811e8887SPierre Jolivet 
163feebddf4SPierre Jolivet       PetscCall(VecScale(*diagonal, -1.0));
1643df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1653df4cd7bSPierre Jolivet       if (norm > PETSC_SMALL) {
16601e3c840SPierre Jolivet         PetscSF  scatter;
1673df4cd7bSPierre Jolivet         PetscInt n;
168811e8887SPierre Jolivet 
169281f8ce6SPierre Jolivet         PetscCall(ISGetLocalSize(*is, &n));
1703df4cd7bSPierre Jolivet         PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)pc), n, PETSC_DECIDE, &d));
171281f8ce6SPierre Jolivet         PetscCall(VecScatterCreate(*diagonal, *is, d, nullptr, &scatter));
1723df4cd7bSPierre Jolivet         PetscCall(VecScatterBegin(scatter, *diagonal, d, INSERT_VALUES, SCATTER_FORWARD));
1733df4cd7bSPierre Jolivet         PetscCall(VecScatterEnd(scatter, *diagonal, d, INSERT_VALUES, SCATTER_FORWARD));
17401e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&scatter));
1753df4cd7bSPierre Jolivet         PetscCall(MatDiagonalSet(aux, d, ADD_VALUES));
1763df4cd7bSPierre Jolivet         PetscCall(VecDestroy(&d));
1773df4cd7bSPierre Jolivet       } else PetscCall(VecDestroy(diagonal));
1783df4cd7bSPierre Jolivet     }
1793df4cd7bSPierre Jolivet     if (!diagonal) PetscCall(MatShift(aux, PETSC_SMALL * norm));
180e5634b20SPierre Jolivet     PetscCall(MatEliminateZeros(aux, PETSC_TRUE));
181f1580f4eSBarry Smith   } else {
182f1580f4eSBarry Smith     PetscBool flg;
183811e8887SPierre Jolivet 
184281f8ce6SPierre Jolivet     PetscCheck(!splitting[1], PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot use PCQR when A01 != A10^T");
1853df4cd7bSPierre Jolivet     if (diagonal) {
1863df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1873df4cd7bSPierre Jolivet       PetscCheck(norm < PETSC_SMALL, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Nonzero diagonal A11 block");
1883df4cd7bSPierre Jolivet       PetscCall(VecDestroy(diagonal));
1893df4cd7bSPierre Jolivet     }
190f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)N, MATNORMAL, &flg));
191281f8ce6SPierre Jolivet     if (flg) PetscCall(MatCreateNormal(*splitting[0], &aux));
192281f8ce6SPierre Jolivet     else PetscCall(MatCreateNormalHermitian(*splitting[0], &aux));
193f1580f4eSBarry Smith   }
194281f8ce6SPierre Jolivet   PetscCall(MatDestroySubMatrices(1, &splitting[0]));
195281f8ce6SPierre Jolivet   PetscCall(PCHPDDMSetAuxiliaryMat(pc, *is, aux, nullptr, nullptr));
196c8ea6600SPierre Jolivet   data->Neumann = PETSC_BOOL3_TRUE;
197281f8ce6SPierre Jolivet   PetscCall(ISDestroy(is));
198f1580f4eSBarry Smith   PetscCall(MatDestroy(&aux));
1993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
200f1580f4eSBarry Smith }
201f1580f4eSBarry Smith 
202d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetAuxiliaryMat_HPDDM(PC pc, IS is, Mat A, PetscErrorCode (*setup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *setup_ctx)
203d71ae5a4SJacob Faibussowitsch {
204f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
205f1580f4eSBarry Smith 
206f1580f4eSBarry Smith   PetscFunctionBegin;
207f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, A, PETSC_FALSE));
208f1580f4eSBarry Smith   if (setup) {
209f1580f4eSBarry Smith     data->setup     = setup;
210f1580f4eSBarry Smith     data->setup_ctx = setup_ctx;
211f1580f4eSBarry Smith   }
2123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
213f1580f4eSBarry Smith }
214f1580f4eSBarry Smith 
21570009435SPierre Jolivet /*@C
21604c3f3b8SBarry Smith   PCHPDDMSetAuxiliaryMat - Sets the auxiliary matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
217f1580f4eSBarry Smith 
218f1580f4eSBarry Smith   Input Parameters:
219f1580f4eSBarry Smith + pc    - preconditioner context
220f1580f4eSBarry Smith . is    - index set of the local auxiliary, e.g., Neumann, matrix
221f1580f4eSBarry Smith . A     - auxiliary sequential matrix
22204c3f3b8SBarry Smith . setup - function for generating the auxiliary matrix entries, may be `NULL`
22304c3f3b8SBarry Smith - ctx   - context for `setup`, may be `NULL`
22404c3f3b8SBarry Smith 
22504c3f3b8SBarry Smith   Calling sequence of `setup`:
22604c3f3b8SBarry Smith + J   - matrix whose values are to be set
22704c3f3b8SBarry Smith . t   - time
22804c3f3b8SBarry Smith . X   - linearization point
22904c3f3b8SBarry Smith . X_t - time-derivative of the linearization point
23004c3f3b8SBarry Smith . s   - step
23104c3f3b8SBarry Smith . ovl - index set of the local auxiliary, e.g., Neumann, matrix
23204c3f3b8SBarry Smith - ctx - context for `setup`, may be `NULL`
233f1580f4eSBarry Smith 
234f1580f4eSBarry Smith   Level: intermediate
235f1580f4eSBarry Smith 
23604c3f3b8SBarry Smith   Note:
23704c3f3b8SBarry Smith   As an example, in a finite element context with nonoverlapping subdomains plus (overlapping) ghost elements, this could be the unassembled (Neumann)
23804c3f3b8SBarry Smith   local overlapping operator. As opposed to the assembled (Dirichlet) local overlapping operator obtained by summing neighborhood contributions
23904c3f3b8SBarry Smith   at the interface of ghost elements.
24004c3f3b8SBarry Smith 
24170009435SPierre Jolivet   Fortran Notes:
24204c3f3b8SBarry Smith   Only `PETSC_NULL_FUNCTION` is supported for `setup` and `ctx` is never accessed
24370009435SPierre Jolivet 
244562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetRHSMat()`, `MATIS`
245f1580f4eSBarry Smith @*/
24604c3f3b8SBarry Smith PetscErrorCode PCHPDDMSetAuxiliaryMat(PC pc, IS is, Mat A, PetscErrorCode (*setup)(Mat J, PetscReal t, Vec X, Vec X_t, PetscReal s, IS ovl, void *ctx), void *ctx)
247d71ae5a4SJacob Faibussowitsch {
248f1580f4eSBarry Smith   PetscFunctionBegin;
249f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
250f1580f4eSBarry Smith   if (is) PetscValidHeaderSpecific(is, IS_CLASSID, 2);
251f1580f4eSBarry Smith   if (A) PetscValidHeaderSpecific(A, MAT_CLASSID, 3);
25204c3f3b8SBarry Smith   PetscTryMethod(pc, "PCHPDDMSetAuxiliaryMat_C", (PC, IS, Mat, PetscErrorCode (*)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *), (pc, is, A, setup, ctx));
2533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
254f1580f4eSBarry Smith }
255f1580f4eSBarry Smith 
256d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMHasNeumannMat_HPDDM(PC pc, PetscBool has)
257d71ae5a4SJacob Faibussowitsch {
258f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
259f1580f4eSBarry Smith 
260f1580f4eSBarry Smith   PetscFunctionBegin;
261c8ea6600SPierre Jolivet   data->Neumann = PetscBoolToBool3(has);
2623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
263f1580f4eSBarry Smith }
264f1580f4eSBarry Smith 
265f1580f4eSBarry Smith /*@
266f1580f4eSBarry Smith   PCHPDDMHasNeumannMat - Informs `PCHPDDM` that the `Mat` passed to `PCHPDDMSetAuxiliaryMat()` is the local Neumann matrix.
267f1580f4eSBarry Smith 
268f1580f4eSBarry Smith   Input Parameters:
269f1580f4eSBarry Smith + pc  - preconditioner context
270f1580f4eSBarry Smith - has - Boolean value
271f1580f4eSBarry Smith 
272f1580f4eSBarry Smith   Level: intermediate
273f1580f4eSBarry Smith 
274f1580f4eSBarry Smith   Notes:
2757eb095acSPierre Jolivet   This may be used to bypass a call to `MatCreateSubMatrices()` and to `MatConvert()` for `MATSBAIJ` matrices.
276f1580f4eSBarry Smith 
277907a3e9cSStefano 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`.
278f1580f4eSBarry Smith 
279562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetAuxiliaryMat()`
280f1580f4eSBarry Smith @*/
281d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMHasNeumannMat(PC pc, PetscBool has)
282d71ae5a4SJacob Faibussowitsch {
283f1580f4eSBarry Smith   PetscFunctionBegin;
284f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
285f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMHasNeumannMat_C", (PC, PetscBool), (pc, has));
2863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
287f1580f4eSBarry Smith }
288f1580f4eSBarry Smith 
289d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetRHSMat_HPDDM(PC pc, Mat B)
290d71ae5a4SJacob Faibussowitsch {
291f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
292f1580f4eSBarry Smith 
293f1580f4eSBarry Smith   PetscFunctionBegin;
294f1580f4eSBarry Smith   PetscCall(PetscObjectReference((PetscObject)B));
295f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->B));
296f1580f4eSBarry Smith   data->B = B;
2973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
298f1580f4eSBarry Smith }
299f1580f4eSBarry Smith 
300f1580f4eSBarry Smith /*@
30104c3f3b8SBarry Smith   PCHPDDMSetRHSMat - Sets the right-hand side matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
302f1580f4eSBarry Smith 
303f1580f4eSBarry Smith   Input Parameters:
304f1580f4eSBarry Smith + pc - preconditioner context
305f1580f4eSBarry Smith - B  - right-hand side sequential matrix
306f1580f4eSBarry Smith 
307f1580f4eSBarry Smith   Level: advanced
308f1580f4eSBarry Smith 
30904c3f3b8SBarry Smith   Note:
31004c3f3b8SBarry Smith   Must be used in conjunction with `PCHPDDMSetAuxiliaryMat`(N), so that Nv = lambda Bv is solved using `EPSSetOperators`(N, B).
31104c3f3b8SBarry 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.
31204c3f3b8SBarry Smith 
313562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetAuxiliaryMat()`, `PCHPDDM`
314f1580f4eSBarry Smith @*/
315d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetRHSMat(PC pc, Mat B)
316d71ae5a4SJacob Faibussowitsch {
317f1580f4eSBarry Smith   PetscFunctionBegin;
318f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
319f1580f4eSBarry Smith   if (B) {
320f1580f4eSBarry Smith     PetscValidHeaderSpecific(B, MAT_CLASSID, 2);
321f1580f4eSBarry Smith     PetscTryMethod(pc, "PCHPDDMSetRHSMat_C", (PC, Mat), (pc, B));
322f1580f4eSBarry Smith   }
3233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
324f1580f4eSBarry Smith }
325f1580f4eSBarry Smith 
326ce78bad3SBarry Smith static PetscErrorCode PCSetFromOptions_HPDDM(PC pc, PetscOptionItems PetscOptionsObject)
327d71ae5a4SJacob Faibussowitsch {
328f1580f4eSBarry Smith   PC_HPDDM                   *data   = (PC_HPDDM *)pc->data;
329f1580f4eSBarry Smith   PC_HPDDM_Level            **levels = data->levels;
330b5a302b3SPierre Jolivet   char                        prefix[256], deprecated[256];
331f1580f4eSBarry Smith   int                         i = 1;
332f1580f4eSBarry Smith   PetscMPIInt                 size, previous;
3339bb5c669SPierre Jolivet   PetscInt                    n, overlap = 1;
334f1580f4eSBarry Smith   PCHPDDMCoarseCorrectionType type;
335c8ea6600SPierre Jolivet   PetscBool                   flg = PETSC_TRUE, set;
336f1580f4eSBarry Smith 
337f1580f4eSBarry Smith   PetscFunctionBegin;
338f1580f4eSBarry Smith   if (!data->levels) {
339f1580f4eSBarry Smith     PetscCall(PetscCalloc1(PETSC_PCHPDDM_MAXLEVELS, &levels));
340f1580f4eSBarry Smith     data->levels = levels;
341f1580f4eSBarry Smith   }
342f1580f4eSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "PCHPDDM options");
3439bb5c669SPierre Jolivet   PetscCall(PetscOptionsBoundedInt("-pc_hpddm_harmonic_overlap", "Overlap prior to computing local harmonic extensions", "PCHPDDM", overlap, &overlap, &set, 1));
3449bb5c669SPierre Jolivet   if (!set) overlap = -1;
345f1580f4eSBarry Smith   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
346f1580f4eSBarry Smith   previous = size;
347f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS) {
348f1580f4eSBarry Smith     PetscInt p = 1;
349f1580f4eSBarry Smith 
3504dfa11a4SJacob Faibussowitsch     if (!data->levels[i - 1]) PetscCall(PetscNew(data->levels + i - 1));
351f1580f4eSBarry Smith     data->levels[i - 1]->parent = data;
352f1580f4eSBarry Smith     /* if the previous level has a single process, it is not possible to coarsen further */
353f1580f4eSBarry Smith     if (previous == 1 || !flg) break;
354f1580f4eSBarry Smith     data->levels[i - 1]->nu        = 0;
355f1580f4eSBarry Smith     data->levels[i - 1]->threshold = -1.0;
356f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
357db4a47b3SPierre 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));
358b5a302b3SPierre Jolivet     PetscCall(PetscSNPrintf(deprecated, sizeof(deprecated), "-pc_hpddm_levels_%d_eps_threshold", i));
359b5a302b3SPierre Jolivet     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold_absolute", i));
3608cb7430dSRaphael Zanella     PetscCall(PetscOptionsDeprecated(deprecated, prefix, "3.24", nullptr));
361b5a302b3SPierre Jolivet     PetscCall(PetscOptionsReal(prefix, "Local absolute 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) {
363b5a302b3SPierre 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_absolute and -pc_hpddm_harmonic_overlap");
3649bb5c669SPierre Jolivet       if (overlap != -1) {
3659bb5c669SPierre Jolivet         PetscInt  nsv    = 0;
366b5a302b3SPierre Jolivet         PetscBool set[2] = {PETSC_FALSE, PETSC_FALSE};
367811e8887SPierre Jolivet 
3689bb5c669SPierre Jolivet         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_nsv", i));
3699bb5c669SPierre Jolivet         PetscCall(PetscOptionsBoundedInt(prefix, "Local number of deflation vectors computed by SLEPc", "SVDSetDimensions", nsv, &nsv, nullptr, 0));
370b5a302b3SPierre Jolivet         PetscCheck(data->levels[0]->nu == 0 || nsv == 0, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot supply both -pc_hpddm_levels_1_eps_nev and -pc_hpddm_levels_1_svd_nsv");
371b5a302b3SPierre Jolivet         if (data->levels[0]->nu == 0) { /* -eps_nev has not been used, so nu is 0 */
372b5a302b3SPierre Jolivet           data->levels[0]->nu = nsv;    /* nu may still be 0 if -svd_nsv has not been used */
373b5a302b3SPierre Jolivet           PetscCall(PetscSNPrintf(deprecated, sizeof(deprecated), "-pc_hpddm_levels_%d_svd_relative_threshold", i));
374b5a302b3SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_threshold_relative", i));
3758cb7430dSRaphael Zanella           PetscCall(PetscOptionsDeprecated(deprecated, prefix, "3.24", nullptr));
376b5a302b3SPierre Jolivet           PetscCall(PetscOptionsReal(prefix, "Local relative threshold for selecting deflation vectors returned by SLEPc", "PCHPDDM", data->levels[0]->threshold, &data->levels[0]->threshold, set)); /* cache whether this option has been used or not to error out in case of exclusive options being used simultaneously later on */
377b5a302b3SPierre Jolivet         }
378b5a302b3SPierre Jolivet         if (data->levels[0]->nu == 0 || nsv == 0) { /* if neither -eps_nev nor -svd_nsv has been used */
379b5a302b3SPierre Jolivet           PetscCall(PetscSNPrintf(deprecated, sizeof(deprecated), "-pc_hpddm_levels_%d_eps_relative_threshold", i));
380b5a302b3SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold_relative", i));
3818cb7430dSRaphael Zanella           PetscCall(PetscOptionsDeprecated(deprecated, prefix, "3.24", nullptr));
382b5a302b3SPierre Jolivet           PetscCall(PetscOptionsReal(prefix, "Local relative threshold for selecting deflation vectors returned by SLEPc", "PCHPDDM", data->levels[0]->threshold, &data->levels[0]->threshold, set + 1));
383b5a302b3SPierre Jolivet           PetscCheck(!set[0] || !set[1], PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot supply both -pc_hpddm_levels_1_eps_threshold_relative and -pc_hpddm_levels_1_svd_threshold_relative");
384b5a302b3SPierre Jolivet         }
385b5a302b3SPierre Jolivet         PetscCheck(data->levels[0]->nu || PetscAbsReal(data->levels[i - 1]->threshold + static_cast<PetscReal>(1.0)) > PETSC_MACHINE_EPSILON, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Need to supply at least one of 1) -pc_hpddm_levels_1_eps_nev, 2) -pc_hpddm_levels_1_svd_nsv, 3) -pc_hpddm_levels_1_eps_threshold_relative, 4) -pc_hpddm_levels_1_svd_threshold_relative (for nonsymmetric matrices, only option 2 and option 4 are appropriate)");
3869bb5c669SPierre Jolivet       }
387f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_1_st_share_sub_ksp"));
388db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Shared KSP between SLEPc ST and the fine-level subdomain solver", "PCHPDDMSetSTShareSubKSP", PETSC_FALSE, &data->share, nullptr));
389f1580f4eSBarry Smith     }
390f1580f4eSBarry Smith     /* if there is no prescribed coarsening, just break out of the loop */
3910594bca0SPierre Jolivet     if (data->levels[i - 1]->threshold <= PetscReal() && data->levels[i - 1]->nu <= 0 && !(data->deflation && i == 1)) break;
392f1580f4eSBarry Smith     else {
393f1580f4eSBarry Smith       ++i;
394f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
395f1580f4eSBarry Smith       PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
396f1580f4eSBarry Smith       if (!flg) {
397b5a302b3SPierre Jolivet         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold_absolute", i));
398f1580f4eSBarry Smith         PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
399f1580f4eSBarry Smith       }
400f1580f4eSBarry Smith       if (flg) {
401f1580f4eSBarry Smith         /* if there are coarsening options for the next level, then register it  */
402f1580f4eSBarry Smith         /* otherwise, don't to avoid having both options levels_N_p and coarse_p */
403f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_p", i));
404f1580f4eSBarry 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)));
405f1580f4eSBarry Smith         previous = p;
406f1580f4eSBarry Smith       }
407f1580f4eSBarry Smith     }
408f1580f4eSBarry Smith   }
409f1580f4eSBarry Smith   data->N = i;
410f1580f4eSBarry Smith   n       = 1;
411f1580f4eSBarry Smith   if (i > 1) {
412f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_coarse_p"));
413db4a47b3SPierre Jolivet     PetscCall(PetscOptionsRangeInt(prefix, "Number of processes used to assemble the coarsest operator", "PCHPDDM", n, &n, nullptr, 1, PetscMax(1, previous / 2)));
41402800ff6SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
415f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "pc_hpddm_coarse_"));
416*8dc3fbeeSPierre Jolivet     PetscCall(PetscOptionsHasName(PetscOptionsObject->options, prefix, "-mat_mumps_use_omp_threads", &flg));
417f1580f4eSBarry Smith     if (flg) {
418f1580f4eSBarry Smith       char type[64]; /* same size as in src/ksp/pc/impls/factor/factimpl.c */
419811e8887SPierre Jolivet 
420c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(type, n > 1 && PetscDefined(HAVE_MUMPS) ? MATSOLVERMUMPS : MATSOLVERPETSC, sizeof(type))); /* default solver for a MatMPIAIJ or a MatSeqAIJ */
421*8dc3fbeeSPierre Jolivet       PetscCall(PetscOptionsGetString(PetscOptionsObject->options, prefix, "-pc_factor_mat_solver_type", type, sizeof(type), nullptr));
4223ce573a3SPierre Jolivet       PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
423f1580f4eSBarry 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);
424f1580f4eSBarry Smith       size = n;
425f1580f4eSBarry Smith       n    = -1;
426*8dc3fbeeSPierre Jolivet       PetscCall(PetscOptionsGetInt(PetscOptionsObject->options, prefix, "-mat_mumps_use_omp_threads", &n, nullptr));
427f1580f4eSBarry Smith       PetscCheck(n >= 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Need to specify a positive integer for -%smat_mumps_use_omp_threads", prefix);
428f1580f4eSBarry 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" : "");
429f1580f4eSBarry Smith     }
430f1580f4eSBarry Smith #endif
431f1580f4eSBarry Smith     PetscCall(PetscOptionsEnum("-pc_hpddm_coarse_correction", "Type of coarse correction applied each iteration", "PCHPDDMSetCoarseCorrectionType", PCHPDDMCoarseCorrectionTypes, (PetscEnum)data->correction, (PetscEnum *)&type, &flg));
432f1580f4eSBarry Smith     if (flg) PetscCall(PCHPDDMSetCoarseCorrectionType(pc, type));
433f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_has_neumann"));
434c8ea6600SPierre Jolivet     PetscCall(PetscOptionsBool(prefix, "Is the auxiliary Mat the local Neumann matrix?", "PCHPDDMHasNeumannMat", PetscBool3ToBool(data->Neumann), &flg, &set));
435c8ea6600SPierre Jolivet     if (set) data->Neumann = PetscBoolToBool3(flg);
436f1580f4eSBarry Smith     data->log_separate = PETSC_FALSE;
437f1580f4eSBarry Smith     if (PetscDefined(USE_LOG)) {
438f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_log_separate"));
439db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Log events level by level instead of inside PCSetUp()/KSPSolve()", nullptr, data->log_separate, &data->log_separate, nullptr));
440f1580f4eSBarry Smith     }
441f1580f4eSBarry Smith   }
442f1580f4eSBarry Smith   PetscOptionsHeadEnd();
443f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]) PetscCall(PetscFree(data->levels[i++]));
4443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
445f1580f4eSBarry Smith }
446f1580f4eSBarry Smith 
447d4f06b61SRaphael Zanella template <bool transpose>
448d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDM(PC pc, Vec x, Vec y)
449d71ae5a4SJacob Faibussowitsch {
450f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
451f1580f4eSBarry Smith 
452f1580f4eSBarry Smith   PetscFunctionBegin;
453f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
454f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
455db4a47b3SPierre 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 */
456d4f06b61SRaphael Zanella   if (!transpose) PetscCall(KSPSolve(data->levels[0]->ksp, x, y));
457d4f06b61SRaphael Zanella   else PetscCall(KSPSolveTranspose(data->levels[0]->ksp, x, y));
458db4a47b3SPierre Jolivet   if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
4593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
460f1580f4eSBarry Smith }
461f1580f4eSBarry Smith 
4628cb7430dSRaphael Zanella template <bool transpose>
463d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDM(PC pc, Mat X, Mat Y)
464d71ae5a4SJacob Faibussowitsch {
465f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
466f1580f4eSBarry Smith 
467f1580f4eSBarry Smith   PetscFunctionBegin;
468f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
469f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
4708cb7430dSRaphael Zanella   if (!transpose) PetscCall(KSPMatSolve(data->levels[0]->ksp, X, Y));
4718cb7430dSRaphael Zanella   else PetscCall(KSPMatSolveTranspose(data->levels[0]->ksp, X, Y));
4723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
473f1580f4eSBarry Smith }
474f1580f4eSBarry Smith 
475cc4c1da9SBarry Smith /*@
476f1580f4eSBarry Smith   PCHPDDMGetComplexities - Computes the grid and operator complexities.
477f1580f4eSBarry Smith 
478c71f06a7SPierre Jolivet   Collective
479c71f06a7SPierre Jolivet 
480f1580f4eSBarry Smith   Input Parameter:
481f1580f4eSBarry Smith . pc - preconditioner context
482f1580f4eSBarry Smith 
483f1580f4eSBarry Smith   Output Parameters:
484cc4c1da9SBarry Smith + gc - grid complexity $ \sum_i m_i / m_1 $
485cc4c1da9SBarry Smith - oc - operator complexity $ \sum_i nnz_i / nnz_1 $
486f1580f4eSBarry Smith 
487f1580f4eSBarry Smith   Level: advanced
488f1580f4eSBarry Smith 
489562efe2eSBarry Smith .seealso: [](ch_ksp), `PCMGGetGridComplexity()`, `PCHPDDM`, `PCHYPRE`, `PCGAMG`
490f1580f4eSBarry Smith @*/
491cc4c1da9SBarry Smith PetscErrorCode PCHPDDMGetComplexities(PC pc, PetscReal *gc, PetscReal *oc)
492d71ae5a4SJacob Faibussowitsch {
493f1580f4eSBarry Smith   PC_HPDDM      *data = (PC_HPDDM *)pc->data;
494f1580f4eSBarry Smith   MatInfo        info;
495f1580f4eSBarry Smith   PetscLogDouble accumulate[2]{}, nnz1 = 1.0, m1 = 1.0;
496f1580f4eSBarry Smith 
497f1580f4eSBarry Smith   PetscFunctionBegin;
498715c1178SPierre Jolivet   if (gc) {
499715c1178SPierre Jolivet     PetscAssertPointer(gc, 2);
500715c1178SPierre Jolivet     *gc = 0;
501715c1178SPierre Jolivet   }
502715c1178SPierre Jolivet   if (oc) {
503715c1178SPierre Jolivet     PetscAssertPointer(oc, 3);
504715c1178SPierre Jolivet     *oc = 0;
505715c1178SPierre Jolivet   }
506715c1178SPierre Jolivet   for (PetscInt n = 0; n < data->N; ++n) {
507f1580f4eSBarry Smith     if (data->levels[n]->ksp) {
50813044ca3SPierre Jolivet       Mat       P, A = nullptr;
509715c1178SPierre Jolivet       PetscInt  m;
51013044ca3SPierre Jolivet       PetscBool flg = PETSC_FALSE;
51113044ca3SPierre Jolivet 
512db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &P));
513db4a47b3SPierre Jolivet       PetscCall(MatGetSize(P, &m, nullptr));
514f1580f4eSBarry Smith       accumulate[0] += m;
515f1580f4eSBarry Smith       if (n == 0) {
516f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
517f1580f4eSBarry Smith         if (flg) {
518f1580f4eSBarry Smith           PetscCall(MatConvert(P, MATAIJ, MAT_INITIAL_MATRIX, &A));
519f1580f4eSBarry Smith           P = A;
52013044ca3SPierre Jolivet         } else {
52113044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
52213044ca3SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)P));
523f1580f4eSBarry Smith         }
52413044ca3SPierre Jolivet       }
52513044ca3SPierre Jolivet       if (!A && flg) accumulate[1] += m * m; /* assumption that a MATSCHURCOMPLEMENT is dense if stored explicitly */
52613044ca3SPierre Jolivet       else if (P->ops->getinfo) {
527f1580f4eSBarry Smith         PetscCall(MatGetInfo(P, MAT_GLOBAL_SUM, &info));
528f1580f4eSBarry Smith         accumulate[1] += info.nz_used;
529f1580f4eSBarry Smith       }
530f1580f4eSBarry Smith       if (n == 0) {
531f1580f4eSBarry Smith         m1 = m;
53213044ca3SPierre Jolivet         if (!A && flg) nnz1 = m * m;
53313044ca3SPierre Jolivet         else if (P->ops->getinfo) nnz1 = info.nz_used;
534f1580f4eSBarry Smith         PetscCall(MatDestroy(&P));
535f1580f4eSBarry Smith       }
536f1580f4eSBarry Smith     }
537f1580f4eSBarry Smith   }
538715c1178SPierre Jolivet   /* only process #0 has access to the full hierarchy by construction, so broadcast to ensure consistent outputs */
539715c1178SPierre Jolivet   PetscCallMPI(MPI_Bcast(accumulate, 2, MPIU_PETSCLOGDOUBLE, 0, PetscObjectComm((PetscObject)pc)));
540715c1178SPierre Jolivet   if (gc) *gc = static_cast<PetscReal>(accumulate[0] / m1);
541715c1178SPierre Jolivet   if (oc) *oc = static_cast<PetscReal>(accumulate[1] / nnz1);
5423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
543f1580f4eSBarry Smith }
544f1580f4eSBarry Smith 
545d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_HPDDM(PC pc, PetscViewer viewer)
546d71ae5a4SJacob Faibussowitsch {
547f1580f4eSBarry Smith   PC_HPDDM         *data = (PC_HPDDM *)pc->data;
548f1580f4eSBarry Smith   PetscViewer       subviewer;
549aa21023fSPierre Jolivet   PetscViewerFormat format;
550f1580f4eSBarry Smith   PetscSubcomm      subcomm;
551f1580f4eSBarry Smith   PetscReal         oc, gc;
552811e8887SPierre Jolivet   PetscInt          tabs;
553f1580f4eSBarry Smith   PetscMPIInt       size, color, rank;
554aa21023fSPierre Jolivet   PetscBool         flg;
555aa21023fSPierre Jolivet   const char       *name;
556f1580f4eSBarry Smith 
557f1580f4eSBarry Smith   PetscFunctionBegin;
558aa21023fSPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &flg));
559aa21023fSPierre Jolivet   if (flg) {
560f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "level%s: %" PetscInt_FMT "\n", data->N > 1 ? "s" : "", data->N));
561f1580f4eSBarry Smith     PetscCall(PCHPDDMGetComplexities(pc, &gc, &oc));
562f1580f4eSBarry Smith     if (data->N > 1) {
563f1580f4eSBarry Smith       if (!data->deflation) {
564c8ea6600SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "Neumann matrix attached? %s\n", PetscBools[PetscBool3ToBool(data->Neumann)]));
565f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, "shared subdomain KSP between SLEPc and PETSc? %s\n", PetscBools[data->share]));
566f1580f4eSBarry Smith       } else PetscCall(PetscViewerASCIIPrintf(viewer, "user-supplied deflation matrix\n"));
567f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "coarse correction: %s\n", PCHPDDMCoarseCorrectionTypes[data->correction]));
568f1580f4eSBarry 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" : ""));
569f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIGetTab(viewer, &tabs));
570f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, 0));
571811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
572f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, data->levels[i - 1]->nu));
5730594bca0SPierre Jolivet         if (data->levels[i - 1]->threshold > static_cast<PetscReal>(-0.1)) PetscCall(PetscViewerASCIIPrintf(viewer, " (%g)", (double)data->levels[i - 1]->threshold));
574f1580f4eSBarry Smith       }
575f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
576f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, tabs));
577f1580f4eSBarry Smith     }
578f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "grid and operator complexities: %g %g\n", (double)gc, (double)oc));
5791fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
580f1580f4eSBarry Smith     if (data->levels[0]->ksp) {
581f1580f4eSBarry Smith       PetscCall(KSPView(data->levels[0]->ksp, viewer));
582f1580f4eSBarry Smith       if (data->levels[0]->pc) PetscCall(PCView(data->levels[0]->pc, viewer));
583eea1a2f1SRaphael Zanella       PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank));
584811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
585f1580f4eSBarry Smith         if (data->levels[i]->ksp) color = 1;
586f1580f4eSBarry Smith         else color = 0;
587f1580f4eSBarry Smith         PetscCall(PetscSubcommCreate(PetscObjectComm((PetscObject)pc), &subcomm));
588f1580f4eSBarry Smith         PetscCall(PetscSubcommSetNumber(subcomm, PetscMin(size, 2)));
589f1580f4eSBarry Smith         PetscCall(PetscSubcommSetTypeGeneral(subcomm, color, rank));
590f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPushTab(viewer));
591f1580f4eSBarry Smith         PetscCall(PetscViewerGetSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
592f1580f4eSBarry Smith         if (color == 1) {
593f1580f4eSBarry Smith           PetscCall(KSPView(data->levels[i]->ksp, subviewer));
594f1580f4eSBarry Smith           if (data->levels[i]->pc) PetscCall(PCView(data->levels[i]->pc, subviewer));
595f1580f4eSBarry Smith           PetscCall(PetscViewerFlush(subviewer));
596f1580f4eSBarry Smith         }
597f1580f4eSBarry Smith         PetscCall(PetscViewerRestoreSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
598f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPopTab(viewer));
599f1580f4eSBarry Smith         PetscCall(PetscSubcommDestroy(&subcomm));
600f1580f4eSBarry Smith       }
601f1580f4eSBarry Smith     }
602aa21023fSPierre Jolivet     PetscCall(PetscViewerGetFormat(viewer, &format));
603aa21023fSPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
604aa21023fSPierre Jolivet       PetscCall(PetscViewerFileGetName(viewer, &name));
605aa21023fSPierre Jolivet       if (name) {
606eea1a2f1SRaphael Zanella         Mat             aux[2];
607aa21023fSPierre Jolivet         IS              is;
608eea1a2f1SRaphael Zanella         const PetscInt *indices;
609eea1a2f1SRaphael Zanella         PetscInt        m, n, sizes[5] = {pc->mat->rmap->n, pc->mat->cmap->n, pc->mat->rmap->N, pc->mat->cmap->N, 0};
610aa21023fSPierre Jolivet         char           *tmp;
611aa21023fSPierre Jolivet         std::string     prefix, suffix;
612aa21023fSPierre Jolivet         size_t          pos;
613aa21023fSPierre Jolivet 
614aa21023fSPierre Jolivet         PetscCall(PetscStrstr(name, ".", &tmp));
615aa21023fSPierre Jolivet         if (tmp) {
616aa21023fSPierre Jolivet           pos    = std::distance(const_cast<char *>(name), tmp);
617aa21023fSPierre Jolivet           prefix = std::string(name, pos);
618aa21023fSPierre Jolivet           suffix = std::string(name + pos + 1);
619aa21023fSPierre Jolivet         } else prefix = name;
620aa21023fSPierre Jolivet         if (data->aux) {
621eea1a2f1SRaphael Zanella           PetscCall(MatGetSize(data->aux, &m, &n));
622eea1a2f1SRaphael Zanella           PetscCall(MatCreate(PetscObjectComm((PetscObject)pc), aux));
623eea1a2f1SRaphael Zanella           PetscCall(MatSetSizes(aux[0], m, n, PETSC_DETERMINE, PETSC_DETERMINE));
624eea1a2f1SRaphael Zanella           PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
625eea1a2f1SRaphael Zanella           if (flg) PetscCall(MatSetType(aux[0], MATMPIAIJ));
626eea1a2f1SRaphael Zanella           else {
627eea1a2f1SRaphael Zanella             PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQBAIJ, &flg));
628eea1a2f1SRaphael Zanella             if (flg) PetscCall(MatSetType(aux[0], MATMPIBAIJ));
629eea1a2f1SRaphael Zanella             else {
630eea1a2f1SRaphael Zanella               PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQSBAIJ, &flg));
631eea1a2f1SRaphael Zanella               PetscCheck(flg, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "MatType of auxiliary Mat (%s) is not any of the following: MATSEQAIJ, MATSEQBAIJ, or MATSEQSBAIJ", ((PetscObject)data->aux)->type_name);
632eea1a2f1SRaphael Zanella               PetscCall(MatSetType(aux[0], MATMPISBAIJ));
633eea1a2f1SRaphael Zanella             }
634eea1a2f1SRaphael Zanella           }
635eea1a2f1SRaphael Zanella           PetscCall(MatSetBlockSizesFromMats(aux[0], data->aux, data->aux));
636eea1a2f1SRaphael Zanella           PetscCall(MatAssemblyBegin(aux[0], MAT_FINAL_ASSEMBLY));
637eea1a2f1SRaphael Zanella           PetscCall(MatAssemblyEnd(aux[0], MAT_FINAL_ASSEMBLY));
638eea1a2f1SRaphael Zanella           PetscCall(MatGetDiagonalBlock(aux[0], aux + 1));
639eea1a2f1SRaphael Zanella           PetscCall(MatCopy(data->aux, aux[1], DIFFERENT_NONZERO_PATTERN));
640eea1a2f1SRaphael Zanella           PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_aux_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
641eea1a2f1SRaphael Zanella           PetscCall(MatView(aux[0], subviewer));
642aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
643eea1a2f1SRaphael Zanella           PetscCall(MatDestroy(aux));
644aa21023fSPierre Jolivet         }
645aa21023fSPierre Jolivet         if (data->is) {
646eea1a2f1SRaphael Zanella           PetscCall(ISGetIndices(data->is, &indices));
647eea1a2f1SRaphael Zanella           PetscCall(ISGetSize(data->is, sizes + 4));
648eea1a2f1SRaphael Zanella           PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), sizes[4], indices, PETSC_USE_POINTER, &is));
649eea1a2f1SRaphael Zanella           PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_is_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
650eea1a2f1SRaphael Zanella           PetscCall(ISView(is, subviewer));
651aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
652eea1a2f1SRaphael Zanella           PetscCall(ISDestroy(&is));
653eea1a2f1SRaphael Zanella           PetscCall(ISRestoreIndices(data->is, &indices));
654aa21023fSPierre Jolivet         }
655eea1a2f1SRaphael Zanella         PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), PETSC_STATIC_ARRAY_LENGTH(sizes), sizes, PETSC_USE_POINTER, &is));
656eea1a2f1SRaphael Zanella         PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_sizes_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
657aa21023fSPierre Jolivet         PetscCall(ISView(is, subviewer));
658aa21023fSPierre Jolivet         PetscCall(PetscViewerDestroy(&subviewer));
659aa21023fSPierre Jolivet         PetscCall(ISDestroy(&is));
660aa21023fSPierre Jolivet       }
661aa21023fSPierre Jolivet     }
662f1580f4eSBarry Smith   }
6633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
664f1580f4eSBarry Smith }
665f1580f4eSBarry Smith 
666d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCPreSolve_HPDDM(PC pc, KSP ksp, Vec, Vec)
667d71ae5a4SJacob Faibussowitsch {
668f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
669f1580f4eSBarry Smith   Mat       A;
670cdbd50ebSPierre Jolivet   PetscBool flg;
671f1580f4eSBarry Smith 
672f1580f4eSBarry Smith   PetscFunctionBegin;
673f1580f4eSBarry Smith   if (ksp) {
674f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPLSQR, &flg));
675f1580f4eSBarry Smith     if (flg && !data->normal) {
676db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(ksp, &A, nullptr));
677db4a47b3SPierre Jolivet       PetscCall(MatCreateVecs(A, nullptr, &data->normal)); /* temporary Vec used in PCApply_HPDDMShell() for coarse grid corrections */
678cdbd50ebSPierre Jolivet     } else if (!flg) {
679cdbd50ebSPierre Jolivet       PetscCall(PetscObjectTypeCompareAny((PetscObject)ksp, &flg, KSPCG, KSPGROPPCG, KSPPIPECG, KSPPIPECGRR, KSPPIPELCG, KSPPIPEPRCG, KSPPIPECG2, KSPSTCG, KSPFCG, KSPPIPEFCG, KSPMINRES, KSPNASH, KSPSYMMLQ, ""));
680cdbd50ebSPierre Jolivet       if (!flg) {
681cdbd50ebSPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPHPDDM, &flg));
682cdbd50ebSPierre Jolivet         if (flg) {
683cdbd50ebSPierre Jolivet           KSPHPDDMType type;
684811e8887SPierre Jolivet 
685cdbd50ebSPierre Jolivet           PetscCall(KSPHPDDMGetType(ksp, &type));
686cdbd50ebSPierre Jolivet           flg = (type == KSP_HPDDM_TYPE_CG || type == KSP_HPDDM_TYPE_BCG || type == KSP_HPDDM_TYPE_BFBCG ? PETSC_TRUE : PETSC_FALSE);
687cdbd50ebSPierre Jolivet         }
688cdbd50ebSPierre Jolivet       }
689cdbd50ebSPierre Jolivet     }
690cdbd50ebSPierre Jolivet     if (flg) {
691cdbd50ebSPierre Jolivet       if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) {
692cdbd50ebSPierre Jolivet         PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_hpddm_coarse_correction", &flg));
693cdbd50ebSPierre 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",
694cdbd50ebSPierre Jolivet                    PCHPDDMCoarseCorrectionTypes[data->correction], ((PetscObject)ksp)->type_name, ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", PCHPDDMCoarseCorrectionTypes[data->correction], PCHPDDMCoarseCorrectionTypes[PC_HPDDM_COARSE_CORRECTION_BALANCED]);
695cdbd50ebSPierre Jolivet       }
696cdbd50ebSPierre Jolivet       for (PetscInt n = 0; n < data->N; ++n) {
697cdbd50ebSPierre Jolivet         if (data->levels[n]->pc) {
698cdbd50ebSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)data->levels[n]->pc, PCASM, &flg));
699cdbd50ebSPierre Jolivet           if (flg) {
700cdbd50ebSPierre Jolivet             PCASMType type;
701811e8887SPierre Jolivet 
702cdbd50ebSPierre Jolivet             PetscCall(PCASMGetType(data->levels[n]->pc, &type));
703cdbd50ebSPierre Jolivet             if (type == PC_ASM_RESTRICT || type == PC_ASM_INTERPOLATE) {
704cdbd50ebSPierre Jolivet               PetscCall(PetscOptionsHasName(((PetscObject)data->levels[n]->pc)->options, ((PetscObject)data->levels[n]->pc)->prefix, "-pc_asm_type", &flg));
705cdbd50ebSPierre 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],
706cdbd50ebSPierre Jolivet                          ((PetscObject)ksp)->type_name, ((PetscObject)data->levels[n]->pc)->prefix, PCASMTypes[type], PCASMTypes[PC_ASM_BASIC]);
707cdbd50ebSPierre Jolivet             }
708cdbd50ebSPierre Jolivet           }
709cdbd50ebSPierre Jolivet         }
710cdbd50ebSPierre Jolivet       }
711f1580f4eSBarry Smith     }
712f1580f4eSBarry Smith   }
7133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
714f1580f4eSBarry Smith }
715f1580f4eSBarry Smith 
716d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDMShell(PC pc)
717d71ae5a4SJacob Faibussowitsch {
718f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
719f1580f4eSBarry Smith   Mat             A, P;
720f1580f4eSBarry Smith   Vec             x;
721f1580f4eSBarry Smith   const char     *pcpre;
722f1580f4eSBarry Smith 
723f1580f4eSBarry Smith   PetscFunctionBegin;
724f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
725f1580f4eSBarry Smith   PetscCall(KSPGetOptionsPrefix(ctx->ksp, &pcpre));
726f1580f4eSBarry Smith   PetscCall(KSPGetOperators(ctx->ksp, &A, &P));
727f1580f4eSBarry Smith   /* smoother */
728f1580f4eSBarry Smith   PetscCall(PCSetOptionsPrefix(ctx->pc, pcpre));
729f1580f4eSBarry Smith   PetscCall(PCSetOperators(ctx->pc, A, P));
730f1580f4eSBarry Smith   if (!ctx->v[0]) {
731f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(ctx->D, 1, &ctx->v[0]));
732f1580f4eSBarry Smith     if (!std::is_same<PetscScalar, PetscReal>::value) PetscCall(VecDestroy(&ctx->D));
733db4a47b3SPierre Jolivet     PetscCall(MatCreateVecs(A, &x, nullptr));
734f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(x, 2, &ctx->v[1]));
735f1580f4eSBarry Smith     PetscCall(VecDestroy(&x));
736f1580f4eSBarry Smith   }
737f1580f4eSBarry Smith   std::fill_n(ctx->V, 3, nullptr);
7383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
739f1580f4eSBarry Smith }
740f1580f4eSBarry Smith 
741d4f06b61SRaphael Zanella template <bool transpose = false, class Type = Vec, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
742d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type x, Type y)
743d71ae5a4SJacob Faibussowitsch {
744f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
745f1580f4eSBarry Smith   PetscScalar    *out;
746f1580f4eSBarry Smith 
747f1580f4eSBarry Smith   PetscFunctionBegin;
748f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
749f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
750f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
751f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
752f1580f4eSBarry Smith   PetscCall(VecGetArrayWrite(ctx->v[0][0], &out));
753d4f06b61SRaphael Zanella   ctx->P->deflation<false, transpose>(nullptr, out, 1); /* y = Q x */
754f1580f4eSBarry Smith   PetscCall(VecRestoreArrayWrite(ctx->v[0][0], &out));
755f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
756f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
757f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
7583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
759f1580f4eSBarry Smith }
760f1580f4eSBarry Smith 
7618cb7430dSRaphael Zanella template <bool transpose = false, class Type = Mat, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
762d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type X, Type Y)
763d71ae5a4SJacob Faibussowitsch {
764f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
765f1580f4eSBarry Smith   Vec             vX, vY, vC;
766f1580f4eSBarry Smith   PetscScalar    *out;
767811e8887SPierre Jolivet   PetscInt        N;
768f1580f4eSBarry Smith 
769f1580f4eSBarry Smith   PetscFunctionBegin;
770f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
771db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
772f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
773811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
774f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(X, i, &vX));
775f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(ctx->V[0], i, &vC));
776f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
777f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
778f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(ctx->V[0], i, &vC));
779f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(X, i, &vX));
780f1580f4eSBarry Smith   }
781f1580f4eSBarry Smith   PetscCall(MatDenseGetArrayWrite(ctx->V[0], &out));
7828cb7430dSRaphael Zanella   ctx->P->deflation<false, transpose>(nullptr, out, N); /* Y = Q X */
783f1580f4eSBarry Smith   PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &out));
784f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
785811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
786f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(ctx->V[0], i, &vC));
787f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(Y, i, &vY));
788f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
789f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
790f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &vY));
791f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(ctx->V[0], i, &vC));
792f1580f4eSBarry Smith   }
7933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
794f1580f4eSBarry Smith }
795f1580f4eSBarry Smith 
796f1580f4eSBarry Smith /*
797aa1539e9SPierre 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.
798f1580f4eSBarry Smith 
799f1580f4eSBarry Smith .vb
800f1580f4eSBarry Smith    (1) y =                Pmat^-1              x + Q x,
801f1580f4eSBarry Smith    (2) y =                Pmat^-1 (I - Amat Q) x + Q x (default),
802aa1539e9SPierre Jolivet    (3) y = (I - Q Amat^T) Pmat^-1 (I - Amat Q) x + Q x,
803aa1539e9SPierre Jolivet    (4) y =                Pmat^-1              x      .
804f1580f4eSBarry Smith .ve
805f1580f4eSBarry Smith 
806f1580f4eSBarry Smith    Input Parameters:
807f1580f4eSBarry Smith +     pc - preconditioner context
808f1580f4eSBarry Smith -     x - input vector
809f1580f4eSBarry Smith 
810f1580f4eSBarry Smith    Output Parameter:
811f1580f4eSBarry Smith .     y - output vector
812f1580f4eSBarry Smith 
813f1580f4eSBarry Smith    Notes:
814f1580f4eSBarry 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.
815f1580f4eSBarry 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.
816f1580f4eSBarry 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.
817f1580f4eSBarry Smith 
818f1580f4eSBarry Smith    Level: advanced
819f1580f4eSBarry Smith 
820f1580f4eSBarry Smith    Developer Note:
821f1580f4eSBarry 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
822f1580f4eSBarry Smith    to trigger it. Likely the manual page is `PCHPDDM`
823f1580f4eSBarry Smith 
824562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
825f1580f4eSBarry Smith */
826d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDMShell(PC pc, Vec x, Vec y)
827d71ae5a4SJacob Faibussowitsch {
828f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
829f1580f4eSBarry Smith   Mat             A;
830f1580f4eSBarry Smith 
831f1580f4eSBarry Smith   PetscFunctionBegin;
832f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
833f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
834db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
835aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApply(ctx->pc, x, y)); /* y = M^-1 x */
836aa1539e9SPierre Jolivet   else {
837f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, x, y)); /* y = Q x */
838f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
839f1580f4eSBarry Smith       if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMult(A, y, ctx->v[1][0])); /* y = A Q x */
8408a8e6071SPierre Jolivet       else {
8418a8e6071SPierre Jolivet         /* KSPLSQR and finest level */
8428a8e6071SPierre Jolivet         PetscCall(MatMult(A, y, ctx->parent->normal));                              /* y = A Q x               */
843f1580f4eSBarry Smith         PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][0])); /* y = A^T A Q x           */
844f1580f4eSBarry Smith       }
845f1580f4eSBarry Smith       PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x)); /* y = (I - A Q) x                             */
846f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, ctx->v[1][1], ctx->v[1][0]));  /* y = M^-1 (I - A Q) x                        */
847f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
848f1580f4eSBarry 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 */
849f1580f4eSBarry Smith         else {
850f1580f4eSBarry Smith           PetscCall(MatMult(A, ctx->v[1][0], ctx->parent->normal));
851f1580f4eSBarry Smith           PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][1])); /* z = A^T A y           */
852f1580f4eSBarry Smith         }
853d4f06b61SRaphael Zanella         PetscCall(PCHPDDMDeflate_Private(pc, ctx->v[1][1], ctx->v[1][1]));     /* z = Q z                      */
854f1580f4eSBarry 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      */
855f1580f4eSBarry Smith       } else PetscCall(VecAXPY(y, 1.0, ctx->v[1][0]));                         /* y = Q M^-1 (I - A Q) x + Q x */
856f1580f4eSBarry Smith     } else {
857f1580f4eSBarry 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);
858f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, x, ctx->v[1][0]));
859f1580f4eSBarry Smith       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-1 x + Q x */
860f1580f4eSBarry Smith     }
861aa1539e9SPierre Jolivet   }
8623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
863f1580f4eSBarry Smith }
864f1580f4eSBarry Smith 
8658cb7430dSRaphael Zanella template <bool transpose>
8668cb7430dSRaphael Zanella static PetscErrorCode PCHPDDMMatApply_Private(PC_HPDDM_Level *ctx, Mat Y, PetscBool *reset)
8678cb7430dSRaphael Zanella {
8688cb7430dSRaphael Zanella   Mat            A, *ptr;
8698cb7430dSRaphael Zanella   PetscScalar   *array;
8708cb7430dSRaphael Zanella   PetscInt       m, M, N, prev = 0;
8718cb7430dSRaphael Zanella   PetscContainer container = nullptr;
8728cb7430dSRaphael Zanella 
8738cb7430dSRaphael Zanella   PetscFunctionBegin;
8748cb7430dSRaphael Zanella   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
8758cb7430dSRaphael Zanella   PetscCall(MatGetSize(Y, nullptr, &N));
8768cb7430dSRaphael Zanella   PetscCall(PetscObjectQuery((PetscObject)A, "_HPDDM_MatProduct", (PetscObject *)&container));
8778cb7430dSRaphael Zanella   if (container) { /* MatProduct container already attached */
8788cb7430dSRaphael Zanella     PetscCall(PetscContainerGetPointer(container, (void **)&ptr));
8798cb7430dSRaphael Zanella     if (ptr[1] != ctx->V[2]) /* Mat has changed or may have been set first in KSPHPDDM */
8808cb7430dSRaphael Zanella       for (m = 0; m < 2; ++m) {
8818cb7430dSRaphael Zanella         PetscCall(MatDestroy(ctx->V + m + 1));
8828cb7430dSRaphael Zanella         ctx->V[m + 1] = ptr[m];
8838cb7430dSRaphael Zanella         PetscCall(PetscObjectReference((PetscObject)ctx->V[m + 1]));
8848cb7430dSRaphael Zanella       }
8858cb7430dSRaphael Zanella   }
8868cb7430dSRaphael Zanella   if (ctx->V[1]) PetscCall(MatGetSize(ctx->V[1], nullptr, &prev));
8878cb7430dSRaphael Zanella   if (N != prev || !ctx->V[0]) {
8888cb7430dSRaphael Zanella     PetscCall(MatDestroy(ctx->V));
8898cb7430dSRaphael Zanella     PetscCall(VecGetLocalSize(ctx->v[0][0], &m));
8908cb7430dSRaphael Zanella     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)Y), m, PETSC_DECIDE, PETSC_DECIDE, N, nullptr, ctx->V));
8918cb7430dSRaphael Zanella     if (N != prev) {
8928cb7430dSRaphael Zanella       PetscCall(MatDestroy(ctx->V + 1));
8938cb7430dSRaphael Zanella       PetscCall(MatDestroy(ctx->V + 2));
8948cb7430dSRaphael Zanella       PetscCall(MatGetLocalSize(Y, &m, nullptr));
8958cb7430dSRaphael Zanella       PetscCall(MatGetSize(Y, &M, nullptr));
8968cb7430dSRaphael Zanella       if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
8978cb7430dSRaphael Zanella       else array = nullptr;
8988cb7430dSRaphael Zanella       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)Y), m, PETSC_DECIDE, M, N, array, ctx->V + 1));
8998cb7430dSRaphael Zanella       if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
9008cb7430dSRaphael Zanella       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)Y), m, PETSC_DECIDE, M, N, nullptr, ctx->V + 2));
9018cb7430dSRaphael Zanella       PetscCall(MatProductCreateWithMat(A, !transpose ? Y : ctx->V[2], nullptr, ctx->V[1]));
9028cb7430dSRaphael Zanella       PetscCall(MatProductSetType(ctx->V[1], !transpose ? MATPRODUCT_AB : MATPRODUCT_AtB));
9038cb7430dSRaphael Zanella       PetscCall(MatProductSetFromOptions(ctx->V[1]));
9048cb7430dSRaphael Zanella       PetscCall(MatProductSymbolic(ctx->V[1]));
9058cb7430dSRaphael Zanella       if (!container) PetscCall(PetscObjectContainerCompose((PetscObject)A, "_HPDDM_MatProduct", ctx->V + 1, nullptr)); /* no MatProduct container attached, create one to be queried in KSPHPDDM or at the next call to PCMatApply() */
9068cb7430dSRaphael Zanella       else 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 */
9078cb7430dSRaphael Zanella     }
9088cb7430dSRaphael Zanella     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
9098cb7430dSRaphael Zanella       PetscCall(MatProductCreateWithMat(A, !transpose ? ctx->V[1] : Y, nullptr, ctx->V[2]));
9108cb7430dSRaphael Zanella       PetscCall(MatProductSetType(ctx->V[2], !transpose ? MATPRODUCT_AtB : MATPRODUCT_AB));
9118cb7430dSRaphael Zanella       PetscCall(MatProductSetFromOptions(ctx->V[2]));
9128cb7430dSRaphael Zanella       PetscCall(MatProductSymbolic(ctx->V[2]));
9138cb7430dSRaphael Zanella     }
9148cb7430dSRaphael Zanella     ctx->P->start(N);
9158cb7430dSRaphael Zanella   }
9168cb7430dSRaphael Zanella   if (N == prev || container) { /* when MatProduct container is attached, always need to MatProductReplaceMats() since KSPHPDDM may have replaced the Mat as well */
9178cb7430dSRaphael Zanella     PetscCall(MatProductReplaceMats(nullptr, !transpose ? Y : ctx->V[2], nullptr, ctx->V[1]));
9188cb7430dSRaphael Zanella     if (container && ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) {
9198cb7430dSRaphael Zanella       PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
9208cb7430dSRaphael Zanella       PetscCall(MatDensePlaceArray(ctx->V[1], array));
9218cb7430dSRaphael Zanella       PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
9228cb7430dSRaphael Zanella       *reset = PETSC_TRUE;
9238cb7430dSRaphael Zanella     }
9248cb7430dSRaphael Zanella   }
9258cb7430dSRaphael Zanella   PetscFunctionReturn(PETSC_SUCCESS);
9268cb7430dSRaphael Zanella }
9278cb7430dSRaphael Zanella 
928f1580f4eSBarry Smith /*
929f1580f4eSBarry Smith      PCMatApply_HPDDMShell - Variant of PCApply_HPDDMShell() for blocks of vectors.
930f1580f4eSBarry Smith 
931f1580f4eSBarry Smith    Input Parameters:
932f1580f4eSBarry Smith +     pc - preconditioner context
933f1580f4eSBarry Smith -     X - block of input vectors
934f1580f4eSBarry Smith 
935f1580f4eSBarry Smith    Output Parameter:
936f1580f4eSBarry Smith .     Y - block of output vectors
937f1580f4eSBarry Smith 
938f1580f4eSBarry Smith    Level: advanced
939f1580f4eSBarry Smith 
940562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
941f1580f4eSBarry Smith */
942d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDMShell(PC pc, Mat X, Mat Y)
943d71ae5a4SJacob Faibussowitsch {
944f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
945f1580f4eSBarry Smith   PetscBool       reset = PETSC_FALSE;
946f1580f4eSBarry Smith 
947f1580f4eSBarry Smith   PetscFunctionBegin;
948f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
949f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
950aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApply(ctx->pc, X, Y));
951aa1539e9SPierre Jolivet   else {
9528cb7430dSRaphael Zanella     PetscCall(PCHPDDMMatApply_Private<false>(ctx, Y, &reset));
953f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, X, Y));
954f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
955f1580f4eSBarry Smith       PetscCall(MatProductNumeric(ctx->V[1]));
956f1580f4eSBarry Smith       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
957f1580f4eSBarry Smith       PetscCall(MatAXPY(ctx->V[2], -1.0, X, SAME_NONZERO_PATTERN));
958f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, ctx->V[2], ctx->V[1]));
959f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
960f1580f4eSBarry Smith         PetscCall(MatProductNumeric(ctx->V[2]));
961f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->V[2], ctx->V[2]));
962f1580f4eSBarry Smith         PetscCall(MatAXPY(ctx->V[1], -1.0, ctx->V[2], SAME_NONZERO_PATTERN));
963f1580f4eSBarry Smith       }
964f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
965f1580f4eSBarry Smith     } else {
966f1580f4eSBarry 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);
967f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, X, ctx->V[1]));
968f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
969f1580f4eSBarry Smith     }
970f1580f4eSBarry Smith     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
971aa1539e9SPierre Jolivet   }
9723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
973f1580f4eSBarry Smith }
974f1580f4eSBarry Smith 
975d4f06b61SRaphael Zanella /*
976d4f06b61SRaphael Zanella      PCApplyTranspose_HPDDMShell - Applies the transpose of 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.
977d4f06b61SRaphael Zanella 
978d4f06b61SRaphael Zanella .vb
979d4f06b61SRaphael Zanella    (1) y =                  Pmat^-T                x + Q^T x,
980d4f06b61SRaphael Zanella    (2) y = (I - Q^T Amat^T) Pmat^-T                x + Q^T x (default),
981d4f06b61SRaphael Zanella    (3) y = (I - Q^T Amat^T) Pmat^-T (I - Amat Q^T) x + Q^T x,
982d4f06b61SRaphael Zanella    (4) y =                  Pmat^-T                x        .
983d4f06b61SRaphael Zanella .ve
984d4f06b61SRaphael Zanella 
985d4f06b61SRaphael Zanella    Input Parameters:
986d4f06b61SRaphael Zanella +     pc - preconditioner context
987d4f06b61SRaphael Zanella -     x - input vector
988d4f06b61SRaphael Zanella 
989d4f06b61SRaphael Zanella    Output Parameter:
990d4f06b61SRaphael Zanella .     y - output vector
991d4f06b61SRaphael Zanella 
992d4f06b61SRaphael Zanella    Level: advanced
993d4f06b61SRaphael Zanella 
994d4f06b61SRaphael Zanella    Developer Note:
995d4f06b61SRaphael Zanella    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
996d4f06b61SRaphael Zanella    to trigger it. Likely the manual page is `PCHPDDM`
997d4f06b61SRaphael Zanella 
998d4f06b61SRaphael Zanella .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
999d4f06b61SRaphael Zanella */
1000d4f06b61SRaphael Zanella static PetscErrorCode PCApplyTranspose_HPDDMShell(PC pc, Vec x, Vec y)
1001d4f06b61SRaphael Zanella {
1002d4f06b61SRaphael Zanella   PC_HPDDM_Level *ctx;
1003d4f06b61SRaphael Zanella   Mat             A;
1004d4f06b61SRaphael Zanella 
1005d4f06b61SRaphael Zanella   PetscFunctionBegin;
1006d4f06b61SRaphael Zanella   PetscCall(PCShellGetContext(pc, &ctx));
1007d4f06b61SRaphael Zanella   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
10088cb7430dSRaphael Zanella   PetscCheck(!ctx->parent->normal, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Not implemented for the normal equations");
1009d4f06b61SRaphael Zanella   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
1010d4f06b61SRaphael Zanella   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApplyTranspose(ctx->pc, x, y)); /* y = M^-T x */
1011d4f06b61SRaphael Zanella   else {
1012d4f06b61SRaphael Zanella     PetscCall(PCHPDDMDeflate_Private<true>(pc, x, y)); /* y = Q^T x */
1013d4f06b61SRaphael Zanella     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
1014d4f06b61SRaphael Zanella       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
10158cb7430dSRaphael Zanella         PetscCall(MatMult(A, y, ctx->v[1][0]));                                /* y = A Q^T x                 */
1016d4f06b61SRaphael Zanella         PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x));              /* y = (I - A Q^T) x           */
1017d4f06b61SRaphael Zanella         PetscCall(PCApplyTranspose(ctx->pc, ctx->v[1][1], ctx->v[1][0]));      /* y = M^-T (I - A Q^T) x      */
1018d4f06b61SRaphael Zanella       } else PetscCall(PCApplyTranspose(ctx->pc, x, ctx->v[1][0]));            /* y = M^-T x                  */
10198cb7430dSRaphael Zanella       PetscCall(MatMultHermitianTranspose(A, ctx->v[1][0], ctx->v[1][1]));     /* z = A^T y                   */
1020d4f06b61SRaphael Zanella       PetscCall(PCHPDDMDeflate_Private<true>(pc, ctx->v[1][1], ctx->v[1][1])); /* z = Q^T z                   */
1021d4f06b61SRaphael Zanella       PetscCall(VecAXPBYPCZ(y, -1.0, 1.0, 1.0, ctx->v[1][1], ctx->v[1][0]));   /* y = (I - Q^T A^T) y + Q^T x */
1022d4f06b61SRaphael Zanella     } else {
1023d4f06b61SRaphael Zanella       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);
1024d4f06b61SRaphael Zanella       PetscCall(PCApplyTranspose(ctx->pc, x, ctx->v[1][0]));
1025d4f06b61SRaphael Zanella       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-T x + Q^T x */
1026d4f06b61SRaphael Zanella     }
1027d4f06b61SRaphael Zanella   }
1028d4f06b61SRaphael Zanella   PetscFunctionReturn(PETSC_SUCCESS);
1029d4f06b61SRaphael Zanella }
1030d4f06b61SRaphael Zanella 
10318cb7430dSRaphael Zanella /*
10328cb7430dSRaphael Zanella      PCMatApplyTranspose_HPDDMShell - Variant of PCApplyTranspose_HPDDMShell() for blocks of vectors.
10338cb7430dSRaphael Zanella 
10348cb7430dSRaphael Zanella    Input Parameters:
10358cb7430dSRaphael Zanella +     pc - preconditioner context
10368cb7430dSRaphael Zanella -     X - block of input vectors
10378cb7430dSRaphael Zanella 
10388cb7430dSRaphael Zanella    Output Parameter:
10398cb7430dSRaphael Zanella .     Y - block of output vectors
10408cb7430dSRaphael Zanella 
10418cb7430dSRaphael Zanella    Level: advanced
10428cb7430dSRaphael Zanella 
10438cb7430dSRaphael Zanella .seealso: [](ch_ksp), `PCHPDDM`, `PCApplyTranspose_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
10448cb7430dSRaphael Zanella */
10458cb7430dSRaphael Zanella static PetscErrorCode PCMatApplyTranspose_HPDDMShell(PC pc, Mat X, Mat Y)
10468cb7430dSRaphael Zanella {
10478cb7430dSRaphael Zanella   PC_HPDDM_Level *ctx;
10488cb7430dSRaphael Zanella   PetscScalar    *array;
10498cb7430dSRaphael Zanella   PetscBool       reset = PETSC_FALSE;
10508cb7430dSRaphael Zanella 
10518cb7430dSRaphael Zanella   PetscFunctionBegin;
10528cb7430dSRaphael Zanella   PetscCall(PCShellGetContext(pc, &ctx));
10538cb7430dSRaphael Zanella   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
10548cb7430dSRaphael Zanella   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApplyTranspose(ctx->pc, X, Y));
10558cb7430dSRaphael Zanella   else {
10568cb7430dSRaphael Zanella     PetscCall(PCHPDDMMatApply_Private<true>(ctx, Y, &reset));
10578cb7430dSRaphael Zanella     PetscCall(PCHPDDMDeflate_Private<true>(pc, X, Y));
10588cb7430dSRaphael Zanella     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
10598cb7430dSRaphael Zanella       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
10608cb7430dSRaphael Zanella         PetscCall(MatProductNumeric(ctx->V[2]));
10618cb7430dSRaphael Zanella         PetscCall(MatCopy(ctx->V[2], ctx->V[1], SAME_NONZERO_PATTERN));
10628cb7430dSRaphael Zanella         PetscCall(MatAYPX(ctx->V[1], -1.0, X, SAME_NONZERO_PATTERN));
10638cb7430dSRaphael Zanella         PetscCall(PCMatApplyTranspose(ctx->pc, ctx->V[1], ctx->V[2]));
10648cb7430dSRaphael Zanella       } else PetscCall(PCMatApplyTranspose(ctx->pc, X, ctx->V[2]));
10658cb7430dSRaphael Zanella       PetscCall(MatAXPY(Y, 1.0, ctx->V[2], SAME_NONZERO_PATTERN));
10668cb7430dSRaphael Zanella       PetscCall(MatProductNumeric(ctx->V[1]));
1067847b6ef2SPierre Jolivet       /* ctx->V[0] and ctx->V[1] memory regions overlap, so need to copy to ctx->V[2] and switch array */
10688cb7430dSRaphael Zanella       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
1069847b6ef2SPierre Jolivet       if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
10708cb7430dSRaphael Zanella       PetscCall(MatDenseGetArrayWrite(ctx->V[2], &array));
10718cb7430dSRaphael Zanella       PetscCall(MatDensePlaceArray(ctx->V[1], array));
10728cb7430dSRaphael Zanella       PetscCall(MatDenseRestoreArrayWrite(ctx->V[2], &array));
1073847b6ef2SPierre Jolivet       reset = PETSC_TRUE;
10748cb7430dSRaphael Zanella       PetscCall(PCHPDDMDeflate_Private<true>(pc, ctx->V[1], ctx->V[1]));
10758cb7430dSRaphael Zanella       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
10768cb7430dSRaphael Zanella     } else {
10778cb7430dSRaphael Zanella       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);
10788cb7430dSRaphael Zanella       PetscCall(PCMatApplyTranspose(ctx->pc, X, ctx->V[1]));
10798cb7430dSRaphael Zanella       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
10808cb7430dSRaphael Zanella     }
10818cb7430dSRaphael Zanella     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
10828cb7430dSRaphael Zanella   }
10838cb7430dSRaphael Zanella   PetscFunctionReturn(PETSC_SUCCESS);
10848cb7430dSRaphael Zanella }
10858cb7430dSRaphael Zanella 
1086d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDMShell(PC pc)
1087d71ae5a4SJacob Faibussowitsch {
1088f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
1089f1580f4eSBarry Smith 
1090f1580f4eSBarry Smith   PetscFunctionBegin;
1091f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
1092f1580f4eSBarry Smith   PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(ctx, PETSC_TRUE));
1093f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(1, &ctx->v[0]));
1094f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(2, &ctx->v[1]));
1095f4f49eeaSPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", nullptr));
1096f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V));
1097f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 1));
1098f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 2));
1099f1580f4eSBarry Smith   PetscCall(VecDestroy(&ctx->D));
110001e3c840SPierre Jolivet   PetscCall(PetscSFDestroy(&ctx->scatter));
1101f1580f4eSBarry Smith   PetscCall(PCDestroy(&ctx->pc));
11023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1103f1580f4eSBarry Smith }
1104f1580f4eSBarry Smith 
11059bb5c669SPierre Jolivet template <class Type, bool T = false, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
11069bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type x, Type y)
11079bb5c669SPierre Jolivet {
11089bb5c669SPierre Jolivet   PetscFunctionBegin;
11099bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[0], std::get<1>(*p), SCATTER_FORWARD, x));
11109bb5c669SPierre Jolivet   if (!T) PetscCall(PCApply(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
11119bb5c669SPierre Jolivet   else PetscCall(PCApplyTranspose(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
11129bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[1], std::get<1>(*p), SCATTER_REVERSE, y));
11139bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
11149bb5c669SPierre Jolivet }
11159bb5c669SPierre Jolivet 
11169bb5c669SPierre Jolivet template <class Type, bool = false, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
11179bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type X, Type Y)
11189bb5c669SPierre Jolivet {
11199bb5c669SPierre Jolivet   Mat B[2];
11209bb5c669SPierre Jolivet   Vec x, y;
11219bb5c669SPierre Jolivet 
11229bb5c669SPierre Jolivet   PetscFunctionBegin;
11239bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B));
11249bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B + 1));
11259bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
11269bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(X, i, &x));
11279bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B[0], i, &y));
11289bb5c669SPierre Jolivet     PetscCall(VecISCopy(y, std::get<1>(*p), SCATTER_FORWARD, x));
11299bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B[0], i, &y));
11309bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(X, i, &x));
11319bb5c669SPierre Jolivet   }
11329bb5c669SPierre Jolivet   PetscCall(PCMatApply(factor, B[0], B[1]));
11339bb5c669SPierre Jolivet   PetscCall(MatDestroy(B));
11349bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
11359bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B[1], i, &x));
11369bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &y));
11379bb5c669SPierre Jolivet     PetscCall(VecISCopy(x, std::get<1>(*p), SCATTER_REVERSE, y));
11389bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &y));
11399bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B[1], i, &x));
11409bb5c669SPierre Jolivet   }
11419bb5c669SPierre Jolivet   PetscCall(MatDestroy(B + 1));
11429bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
11439bb5c669SPierre Jolivet }
11449bb5c669SPierre Jolivet 
11459bb5c669SPierre Jolivet template <class Type = Vec, bool T = false>
11469bb5c669SPierre Jolivet static PetscErrorCode PCApply_Schur(PC pc, Type x, Type y)
11479bb5c669SPierre Jolivet {
11489bb5c669SPierre Jolivet   PC                           factor;
11499bb5c669SPierre Jolivet   Mat                          A;
11509bb5c669SPierre Jolivet   MatSolverType                type;
11519bb5c669SPierre Jolivet   PetscBool                    flg;
11529bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
11539bb5c669SPierre Jolivet 
11549bb5c669SPierre Jolivet   PetscFunctionBegin;
11559bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
11569bb5c669SPierre Jolivet   PetscCall(KSPGetPC(std::get<0>(*p), &factor));
11579bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(factor, &type));
11589bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatrix(factor, &A));
11599bb5c669SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
11609bb5c669SPierre Jolivet   if (flg) {
11619bb5c669SPierre Jolivet     PetscCheck(PetscDefined(HAVE_MUMPS), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
11629bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 0));
11639bb5c669SPierre Jolivet   } else {
11649bb5c669SPierre Jolivet     PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &flg));
11659bb5c669SPierre Jolivet     PetscCheck(flg && PetscDefined(HAVE_MKL_PARDISO), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
11669bb5c669SPierre Jolivet     flg = PETSC_FALSE;
11679bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
11689bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 1));
11699bb5c669SPierre Jolivet #endif
11709bb5c669SPierre Jolivet   }
11719bb5c669SPierre Jolivet   PetscCall(PCApply_Schur_Private<Type, T>(p, factor, x, y));
11729bb5c669SPierre Jolivet   if (flg) {
11739bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1));
11749bb5c669SPierre Jolivet   } else {
11759bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
11769bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 0));
11779bb5c669SPierre Jolivet #endif
11789bb5c669SPierre Jolivet   }
11799bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
11809bb5c669SPierre Jolivet }
11819bb5c669SPierre Jolivet 
11829bb5c669SPierre Jolivet static PetscErrorCode PCDestroy_Schur(PC pc)
11839bb5c669SPierre Jolivet {
11849bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
11859bb5c669SPierre Jolivet 
11869bb5c669SPierre Jolivet   PetscFunctionBegin;
11879bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
11889bb5c669SPierre Jolivet   PetscCall(ISDestroy(&std::get<1>(*p)));
11899bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p)));
11909bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p) + 1));
11919bb5c669SPierre Jolivet   PetscCall(PetscFree(p));
11929bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
11939bb5c669SPierre Jolivet }
11949bb5c669SPierre Jolivet 
1195d4f06b61SRaphael Zanella template <bool transpose>
1196d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSolve_Private(const PC_HPDDM_Level *ctx, PetscScalar *rhs, const unsigned short &mu)
1197d71ae5a4SJacob Faibussowitsch {
1198f1580f4eSBarry Smith   Mat      B, X;
1199f1580f4eSBarry Smith   PetscInt n, N, j = 0;
1200f1580f4eSBarry Smith 
1201f1580f4eSBarry Smith   PetscFunctionBegin;
1202db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &B, nullptr));
1203db4a47b3SPierre Jolivet   PetscCall(MatGetLocalSize(B, &n, nullptr));
1204db4a47b3SPierre Jolivet   PetscCall(MatGetSize(B, &N, nullptr));
1205f1580f4eSBarry Smith   if (ctx->parent->log_separate) {
1206f1580f4eSBarry Smith     j = std::distance(ctx->parent->levels, std::find(ctx->parent->levels, ctx->parent->levels + ctx->parent->N, ctx));
1207db4a47b3SPierre Jolivet     PetscCall(PetscLogEventBegin(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
1208f1580f4eSBarry Smith   }
1209f1580f4eSBarry Smith   if (mu == 1) {
1210f1580f4eSBarry Smith     if (!ctx->ksp->vec_rhs) {
1211db4a47b3SPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ctx->ksp), 1, n, N, nullptr, &ctx->ksp->vec_rhs));
1212f1580f4eSBarry Smith       PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)ctx->ksp), n, N, &ctx->ksp->vec_sol));
1213f1580f4eSBarry Smith     }
1214f1580f4eSBarry Smith     PetscCall(VecPlaceArray(ctx->ksp->vec_rhs, rhs));
1215d4f06b61SRaphael Zanella     if (!transpose) PetscCall(KSPSolve(ctx->ksp, nullptr, nullptr));
1216d4f06b61SRaphael Zanella     else PetscCall(KSPSolveTranspose(ctx->ksp, nullptr, nullptr));
1217f1580f4eSBarry Smith     PetscCall(VecCopy(ctx->ksp->vec_sol, ctx->ksp->vec_rhs));
1218f1580f4eSBarry Smith     PetscCall(VecResetArray(ctx->ksp->vec_rhs));
1219f1580f4eSBarry Smith   } else {
1220f1580f4eSBarry Smith     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, rhs, &B));
1221db4a47b3SPierre Jolivet     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, nullptr, &X));
1222f1580f4eSBarry Smith     PetscCall(KSPMatSolve(ctx->ksp, B, X));
1223f1580f4eSBarry Smith     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
1224f1580f4eSBarry Smith     PetscCall(MatDestroy(&X));
1225f1580f4eSBarry Smith     PetscCall(MatDestroy(&B));
1226f1580f4eSBarry Smith   }
1227db4a47b3SPierre Jolivet   if (ctx->parent->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
12283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1229f1580f4eSBarry Smith }
1230f1580f4eSBarry Smith 
1231d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetUpNeumannOverlap_Private(PC pc)
1232d71ae5a4SJacob Faibussowitsch {
1233f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
1234f1580f4eSBarry Smith 
1235f1580f4eSBarry Smith   PetscFunctionBegin;
1236f1580f4eSBarry Smith   if (data->setup) {
1237f1580f4eSBarry Smith     Mat       P;
1238db4a47b3SPierre Jolivet     Vec       x, xt = nullptr;
1239f1580f4eSBarry Smith     PetscReal t = 0.0, s = 0.0;
1240f1580f4eSBarry Smith 
1241db4a47b3SPierre Jolivet     PetscCall(PCGetOperators(pc, nullptr, &P));
1242f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)P, "__SNES_latest_X", (PetscObject *)&x));
1243f1580f4eSBarry Smith     PetscCallBack("PCHPDDM Neumann callback", (*data->setup)(data->aux, t, x, xt, s, data->is, data->setup_ctx));
1244f1580f4eSBarry Smith   }
12453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1246f1580f4eSBarry Smith }
1247f1580f4eSBarry Smith 
1248d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCreateSubMatrices_Private(Mat mat, PetscInt n, const IS *, const IS *, MatReuse scall, Mat *submat[])
1249d71ae5a4SJacob Faibussowitsch {
1250f1580f4eSBarry Smith   Mat       A;
125113044ca3SPierre Jolivet   PetscBool flg;
1252f1580f4eSBarry Smith 
1253f1580f4eSBarry Smith   PetscFunctionBegin;
1254f1580f4eSBarry Smith   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatCreateSubMatrices() called to extract %" PetscInt_FMT " submatrices, which is different than 1", n);
1255f1580f4eSBarry Smith   /* previously composed Mat */
1256f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)mat, "_PCHPDDM_SubMatrices", (PetscObject *)&A));
1257f1580f4eSBarry Smith   PetscCheck(A, PETSC_COMM_SELF, PETSC_ERR_PLIB, "SubMatrices not found in Mat");
125813044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSCHURCOMPLEMENT, &flg)); /* MATSCHURCOMPLEMENT has neither a MatDuplicate() nor a MatCopy() implementation */
1259f1580f4eSBarry Smith   if (scall == MAT_INITIAL_MATRIX) {
12606f2c871aSStefano Zampini     PetscCall(PetscCalloc1(2, submat)); /* allocate an extra Mat to avoid errors in MatDestroySubMatrices_Dummy() */
126113044ca3SPierre Jolivet     if (!flg) PetscCall(MatDuplicate(A, MAT_COPY_VALUES, *submat));
126213044ca3SPierre Jolivet   } else if (!flg) PetscCall(MatCopy(A, (*submat)[0], SAME_NONZERO_PATTERN));
126313044ca3SPierre Jolivet   if (flg) {
1264bf583f0cSPierre Jolivet     PetscCall(MatDestroy(*submat)); /* previously created Mat has to be destroyed */
126513044ca3SPierre Jolivet     (*submat)[0] = A;
126613044ca3SPierre Jolivet     PetscCall(PetscObjectReference((PetscObject)A));
126713044ca3SPierre Jolivet   }
12683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1269f1580f4eSBarry Smith }
1270f1580f4eSBarry Smith 
1271d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCommunicationAvoidingPCASM_Private(PC pc, Mat C, PetscBool sorted)
1272d71ae5a4SJacob Faibussowitsch {
127357d50842SBarry Smith   PetscErrorCodeFn *op;
1274f1580f4eSBarry Smith 
1275f1580f4eSBarry Smith   PetscFunctionBegin;
1276f1580f4eSBarry Smith   /* previously-composed Mat */
1277f1580f4eSBarry Smith   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", (PetscObject)C));
1278f1580f4eSBarry Smith   PetscCall(MatGetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, &op));
1279f1580f4eSBarry Smith   /* trick suggested by Barry https://lists.mcs.anl.gov/pipermail/petsc-dev/2020-January/025491.html */
128057d50842SBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, (PetscErrorCodeFn *)PCHPDDMCreateSubMatrices_Private));
1281f1580f4eSBarry Smith   if (sorted) PetscCall(PCASMSetSortIndices(pc, PETSC_FALSE)); /* everything is already sorted */
1282f1580f4eSBarry Smith   PetscCall(PCSetFromOptions(pc));                             /* otherwise -pc_hpddm_levels_1_pc_asm_sub_mat_type is not used */
1283f1580f4eSBarry Smith   PetscCall(PCSetUp(pc));
1284f1580f4eSBarry Smith   /* reset MatCreateSubMatrices() */
1285f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, op));
1286db4a47b3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", nullptr));
12873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1288f1580f4eSBarry Smith }
1289f1580f4eSBarry Smith 
1290d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMPermute_Private(IS is, IS in_is, IS *out_is, Mat in_C, Mat *out_C, IS *p)
1291d71ae5a4SJacob Faibussowitsch {
1292f1580f4eSBarry Smith   IS                           perm;
1293f1580f4eSBarry Smith   const PetscInt              *ptr;
1294811e8887SPierre Jolivet   PetscInt                    *concatenate, size, bs;
1295f1580f4eSBarry Smith   std::map<PetscInt, PetscInt> order;
1296f1580f4eSBarry Smith   PetscBool                    sorted;
1297f1580f4eSBarry Smith 
1298f1580f4eSBarry Smith   PetscFunctionBegin;
1299cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(is, IS_CLASSID, 1);
1300cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(in_C, MAT_CLASSID, 4);
1301f1580f4eSBarry Smith   PetscCall(ISSorted(is, &sorted));
1302f1580f4eSBarry Smith   if (!sorted) {
1303f1580f4eSBarry Smith     PetscCall(ISGetLocalSize(is, &size));
1304f1580f4eSBarry Smith     PetscCall(ISGetIndices(is, &ptr));
1305b07dfdedSPierre Jolivet     PetscCall(ISGetBlockSize(is, &bs));
1306f1580f4eSBarry Smith     /* MatCreateSubMatrices(), called by PCASM, follows the global numbering of Pmat */
1307811e8887SPierre Jolivet     for (PetscInt n = 0; n < size; n += bs) order.insert(std::make_pair(ptr[n] / bs, n / bs));
1308f1580f4eSBarry Smith     PetscCall(ISRestoreIndices(is, &ptr));
1309b07dfdedSPierre Jolivet     size /= bs;
1310f1580f4eSBarry Smith     if (out_C) {
1311f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1312f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.second;
1313f1580f4eSBarry Smith       concatenate -= size;
1314b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_C), bs, size, concatenate, PETSC_OWN_POINTER, &perm));
1315f1580f4eSBarry Smith       PetscCall(ISSetPermutation(perm));
1316f1580f4eSBarry Smith       /* permute user-provided Mat so that it matches with MatCreateSubMatrices() numbering */
1317f1580f4eSBarry Smith       PetscCall(MatPermute(in_C, perm, perm, out_C));
1318f1580f4eSBarry Smith       if (p) *p = perm;
1319f1580f4eSBarry Smith       else PetscCall(ISDestroy(&perm)); /* no need to save the permutation */
1320f1580f4eSBarry Smith     }
1321f1580f4eSBarry Smith     if (out_is) {
1322f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1323f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.first;
1324f1580f4eSBarry Smith       concatenate -= size;
1325f1580f4eSBarry Smith       /* permute user-provided IS so that it matches with MatCreateSubMatrices() numbering */
1326b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_is), bs, size, concatenate, PETSC_OWN_POINTER, out_is));
1327f1580f4eSBarry Smith     }
1328f1580f4eSBarry Smith   } else { /* input IS is sorted, nothing to permute, simply duplicate inputs when needed */
1329f1580f4eSBarry Smith     if (out_C) PetscCall(MatDuplicate(in_C, MAT_COPY_VALUES, out_C));
1330f1580f4eSBarry Smith     if (out_is) PetscCall(ISDuplicate(in_is, out_is));
1331f1580f4eSBarry Smith   }
13323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1333f1580f4eSBarry Smith }
1334f1580f4eSBarry Smith 
1335281f8ce6SPierre Jolivet static PetscErrorCode PCHPDDMCheckSymmetry_Private(PC pc, Mat A01, Mat A10, Mat *B01 = nullptr)
133613044ca3SPierre Jolivet {
133713044ca3SPierre Jolivet   Mat       T, U = nullptr, B = nullptr;
133813044ca3SPierre Jolivet   IS        z;
1339281f8ce6SPierre Jolivet   PetscBool flg, conjugate = PETSC_FALSE;
134013044ca3SPierre Jolivet 
134113044ca3SPierre Jolivet   PetscFunctionBegin;
1342281f8ce6SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
1343281f8ce6SPierre Jolivet   if (B01) *B01 = nullptr;
1344281f8ce6SPierre Jolivet   if (flg) {
1345811e8887SPierre 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));
1346811e8887SPierre Jolivet     PetscCall(MatTransposeGetMat(A10, &U));
1347811e8887SPierre Jolivet   } else {
1348281f8ce6SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
1349281f8ce6SPierre Jolivet     if (flg) {
1350811e8887SPierre 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));
1351811e8887SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A10, &U));
1352281f8ce6SPierre Jolivet       conjugate = PETSC_TRUE;
1353811e8887SPierre Jolivet     }
135413044ca3SPierre Jolivet   }
135513044ca3SPierre Jolivet   if (U) PetscCall(MatDuplicate(U, MAT_COPY_VALUES, &T));
135613044ca3SPierre Jolivet   else PetscCall(MatHermitianTranspose(A10, MAT_INITIAL_MATRIX, &T));
1357281f8ce6SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATTRANSPOSEVIRTUAL, &flg));
1358281f8ce6SPierre Jolivet   if (flg) {
1359811e8887SPierre 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));
136013044ca3SPierre Jolivet     PetscCall(MatTransposeGetMat(A01, &A01));
136113044ca3SPierre Jolivet     PetscCall(MatTranspose(A01, MAT_INITIAL_MATRIX, &B));
136213044ca3SPierre Jolivet     A01 = B;
136313044ca3SPierre Jolivet   } else {
1364281f8ce6SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
1365281f8ce6SPierre Jolivet     if (flg) {
1366811e8887SPierre 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));
136713044ca3SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A01, &A01));
136813044ca3SPierre Jolivet       PetscCall(MatHermitianTranspose(A01, MAT_INITIAL_MATRIX, &B));
136913044ca3SPierre Jolivet       A01 = B;
137013044ca3SPierre Jolivet     }
137113044ca3SPierre Jolivet   }
1372281f8ce6SPierre Jolivet   PetscCall(PetscLayoutCompare(T->rmap, A01->rmap, &flg));
1373281f8ce6SPierre Jolivet   if (flg) {
1374281f8ce6SPierre Jolivet     PetscCall(PetscLayoutCompare(T->cmap, A01->cmap, &flg));
1375281f8ce6SPierre Jolivet     if (flg) {
137613044ca3SPierre Jolivet       PetscCall(MatFindZeroRows(A01, &z)); /* for essential boundary conditions, some implementations will */
137713044ca3SPierre Jolivet       if (z) {                             /*  zero rows in [P00 A01] except for the diagonal of P00       */
1378281f8ce6SPierre Jolivet         if (B01) PetscCall(MatDuplicate(T, MAT_COPY_VALUES, B01));
137913044ca3SPierre Jolivet         PetscCall(MatSetOption(T, MAT_NO_OFF_PROC_ZERO_ROWS, PETSC_TRUE));
138013044ca3SPierre Jolivet         PetscCall(MatZeroRowsIS(T, z, 0.0, nullptr, nullptr)); /* corresponding zero rows from A01 */
1381281f8ce6SPierre Jolivet       }
1382281f8ce6SPierre Jolivet       PetscCall(MatMultEqual(A01, T, 20, &flg));
1383281f8ce6SPierre Jolivet       if (!B01) PetscCheck(flg, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "A01 != A10^T");
1384281f8ce6SPierre Jolivet       else {
1385281f8ce6SPierre Jolivet         PetscCall(PetscInfo(pc, "A01 and A10^T are equal? %s\n", PetscBools[flg]));
1386281f8ce6SPierre Jolivet         if (!flg) {
1387281f8ce6SPierre Jolivet           if (z) PetscCall(MatDestroy(&T));
1388281f8ce6SPierre Jolivet           else *B01 = T;
1389281f8ce6SPierre Jolivet           flg = PETSC_TRUE;
1390281f8ce6SPierre Jolivet         } else PetscCall(MatDestroy(B01));
1391281f8ce6SPierre Jolivet       }
139213044ca3SPierre Jolivet       PetscCall(ISDestroy(&z));
139313044ca3SPierre Jolivet     }
139413044ca3SPierre Jolivet   }
1395281f8ce6SPierre Jolivet   if (!flg) PetscCall(PetscInfo(pc, "A01 and A10^T have non-congruent layouts, cannot test for equality\n"));
1396281f8ce6SPierre Jolivet   if (!B01 || !*B01) PetscCall(MatDestroy(&T));
1397281f8ce6SPierre Jolivet   else if (conjugate) PetscCall(MatConjugate(T));
139813044ca3SPierre Jolivet   PetscCall(MatDestroy(&B));
139913044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
140013044ca3SPierre Jolivet }
140113044ca3SPierre Jolivet 
1402d16c0b94SPierre Jolivet static PetscErrorCode PCHPDDMCheckInclusion_Private(PC pc, IS is, IS is_local, PetscBool check)
1403d16c0b94SPierre Jolivet {
1404d16c0b94SPierre Jolivet   IS          intersect;
1405d16c0b94SPierre Jolivet   const char *str = "IS of the auxiliary Mat does not include all local rows of A";
1406d16c0b94SPierre Jolivet   PetscBool   equal;
1407d16c0b94SPierre Jolivet 
1408d16c0b94SPierre Jolivet   PetscFunctionBegin;
1409d16c0b94SPierre Jolivet   PetscCall(ISIntersect(is, is_local, &intersect));
1410d16c0b94SPierre Jolivet   PetscCall(ISEqualUnsorted(is_local, intersect, &equal));
1411d16c0b94SPierre Jolivet   PetscCall(ISDestroy(&intersect));
1412d16c0b94SPierre Jolivet   if (check) PetscCheck(equal, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "%s", str);
1413d16c0b94SPierre Jolivet   else if (!equal) PetscCall(PetscInfo(pc, "%s\n", str));
1414d16c0b94SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1415d16c0b94SPierre Jolivet }
1416d16c0b94SPierre Jolivet 
14178a8e6071SPierre Jolivet static PetscErrorCode PCHPDDMCheckMatStructure_Private(PC pc, Mat A, Mat B)
14188a8e6071SPierre Jolivet {
14198a8e6071SPierre Jolivet   Mat             X, Y;
14208a8e6071SPierre Jolivet   const PetscInt *i[2], *j[2];
14218a8e6071SPierre Jolivet   PetscBool       flg = PETSC_TRUE;
14228a8e6071SPierre Jolivet 
14238a8e6071SPierre Jolivet   PetscFunctionBegin;
14248a8e6071SPierre Jolivet   PetscCall(MatConvert(A, MATAIJ, MAT_INITIAL_MATRIX, &X)); /* no common way to compare sparsity pattern, so just convert to MATSEQAIJ */
14258a8e6071SPierre Jolivet   PetscCall(MatConvert(B, MATAIJ, MAT_INITIAL_MATRIX, &Y)); /* the second Mat (B = Neumann) should have a SUBSET_NONZERO_PATTERN MatStructure of the first one (A = Dirichlet) */
14268a8e6071SPierre Jolivet   PetscCall(MatSeqAIJGetCSRAndMemType(X, &i[0], &j[0], nullptr, nullptr));
14278a8e6071SPierre Jolivet   PetscCall(MatSeqAIJGetCSRAndMemType(Y, &i[1], &j[1], nullptr, nullptr));
14288a8e6071SPierre Jolivet   for (PetscInt row = 0; (row < X->rmap->n) && flg; ++row) {
14298a8e6071SPierre Jolivet     const PetscInt n = i[0][row + 1] - i[0][row];
14308a8e6071SPierre Jolivet 
14318a8e6071SPierre Jolivet     for (PetscInt k = i[1][row]; k < i[1][row + 1]; ++k) {
14328a8e6071SPierre Jolivet       PetscInt loc;
14338a8e6071SPierre Jolivet 
14348a8e6071SPierre Jolivet       PetscCall(PetscFindInt(j[1][k], n, j[0] + i[0][row], &loc));
14358a8e6071SPierre Jolivet       if (loc < 0) {
14368a8e6071SPierre Jolivet         flg = PETSC_FALSE;
14378a8e6071SPierre Jolivet         break;
14388a8e6071SPierre Jolivet       }
14398a8e6071SPierre Jolivet     }
14408a8e6071SPierre Jolivet   }
14418a8e6071SPierre Jolivet   PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &flg, 1, MPI_C_BOOL, MPI_LAND, PetscObjectComm((PetscObject)pc)));
14428a8e6071SPierre Jolivet   PetscCheck(flg, PetscObjectComm((PetscObject)pc), PETSC_ERR_USER_INPUT, "Auxiliary Mat is supposedly the local Neumann matrix but it has a sparsity pattern which is not a subset of the one of the local assembled matrix");
14438a8e6071SPierre Jolivet   PetscCall(MatDestroy(&Y));
14448a8e6071SPierre Jolivet   PetscCall(MatDestroy(&X));
14458a8e6071SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
14468a8e6071SPierre Jolivet }
14478a8e6071SPierre Jolivet 
1448d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMDestroySubMatrices_Private(PetscBool flg, PetscBool algebraic, Mat *sub)
1449d71ae5a4SJacob Faibussowitsch {
1450f1580f4eSBarry Smith   IS is;
1451f1580f4eSBarry Smith 
1452f1580f4eSBarry Smith   PetscFunctionBegin;
1453f1580f4eSBarry Smith   if (!flg) {
1454f1580f4eSBarry Smith     if (algebraic) {
1455f1580f4eSBarry Smith       PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Embed", (PetscObject *)&is));
1456f1580f4eSBarry Smith       PetscCall(ISDestroy(&is));
1457db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Embed", nullptr));
1458db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Compact", nullptr));
1459f1580f4eSBarry Smith     }
1460f1580f4eSBarry Smith     PetscCall(MatDestroySubMatrices(algebraic ? 2 : 1, &sub));
1461f1580f4eSBarry Smith   }
14623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1463f1580f4eSBarry Smith }
1464f1580f4eSBarry Smith 
1465d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMAlgebraicAuxiliaryMat_Private(Mat P, IS *is, Mat *sub[], PetscBool block)
1466d71ae5a4SJacob Faibussowitsch {
1467f1580f4eSBarry Smith   IS         icol[3], irow[2];
1468f1580f4eSBarry Smith   Mat       *M, Q;
1469f1580f4eSBarry Smith   PetscReal *ptr;
147058b7e2c1SStefano Zampini   PetscInt  *idx, p = 0, bs = P->cmap->bs;
1471f1580f4eSBarry Smith   PetscBool  flg;
1472f1580f4eSBarry Smith 
1473f1580f4eSBarry Smith   PetscFunctionBegin;
1474f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, P->cmap->N, 0, 1, icol + 2));
1475f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(icol[2], bs));
1476f1580f4eSBarry Smith   PetscCall(ISSetIdentity(icol[2]));
1477f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1478f1580f4eSBarry Smith   if (flg) {
1479f1580f4eSBarry Smith     /* MatCreateSubMatrices() does not handle MATMPISBAIJ properly when iscol != isrow, so convert first to MATMPIBAIJ */
1480f1580f4eSBarry Smith     PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &Q));
1481f1580f4eSBarry Smith     std::swap(P, Q);
1482f1580f4eSBarry Smith   }
1483f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(P, 1, is, icol + 2, MAT_INITIAL_MATRIX, &M));
1484f1580f4eSBarry Smith   if (flg) {
1485f1580f4eSBarry Smith     std::swap(P, Q);
1486f1580f4eSBarry Smith     PetscCall(MatDestroy(&Q));
1487f1580f4eSBarry Smith   }
1488f1580f4eSBarry Smith   PetscCall(ISDestroy(icol + 2));
1489f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, M[0]->rmap->N, 0, 1, irow));
1490f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(irow[0], bs));
1491f1580f4eSBarry Smith   PetscCall(ISSetIdentity(irow[0]));
1492f1580f4eSBarry Smith   if (!block) {
1493b07dfdedSPierre Jolivet     PetscCall(PetscMalloc2(P->cmap->N, &ptr, P->cmap->N / bs, &idx));
1494f1580f4eSBarry Smith     PetscCall(MatGetColumnNorms(M[0], NORM_INFINITY, ptr));
1495f1580f4eSBarry Smith     /* check for nonzero columns so that M[0] may be expressed in compact form */
1496811e8887SPierre Jolivet     for (PetscInt n = 0; n < P->cmap->N; n += bs) {
1497b07dfdedSPierre Jolivet       if (std::find_if(ptr + n, ptr + n + bs, [](PetscReal v) { return v > PETSC_MACHINE_EPSILON; }) != ptr + n + bs) idx[p++] = n / bs;
1498f1580f4eSBarry Smith     }
1499b07dfdedSPierre Jolivet     PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, p, idx, PETSC_USE_POINTER, icol + 1));
1500f1580f4eSBarry Smith     PetscCall(ISSetInfo(icol[1], IS_SORTED, IS_GLOBAL, PETSC_TRUE, PETSC_TRUE));
1501f1580f4eSBarry Smith     PetscCall(ISEmbed(*is, icol[1], PETSC_FALSE, icol + 2));
1502f1580f4eSBarry Smith     irow[1] = irow[0];
1503f1580f4eSBarry 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 */
1504f1580f4eSBarry Smith     icol[0] = is[0];
1505f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 2, irow, icol, MAT_INITIAL_MATRIX, sub));
1506f1580f4eSBarry Smith     PetscCall(ISDestroy(icol + 1));
1507f1580f4eSBarry Smith     PetscCall(PetscFree2(ptr, idx));
1508f1580f4eSBarry Smith     /* IS used to go back and forth between the augmented and the original local linear system, see eq. (3.4) of [2022b] */
1509f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Embed", (PetscObject)icol[2]));
1510f1580f4eSBarry Smith     /* Mat used in eq. (3.1) of [2022b] */
1511f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Compact", (PetscObject)(*sub)[1]));
1512f1580f4eSBarry Smith   } else {
1513f1580f4eSBarry Smith     Mat aux;
1514811e8887SPierre Jolivet 
1515f1580f4eSBarry Smith     PetscCall(MatSetOption(M[0], MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1516f1580f4eSBarry Smith     /* diagonal block of the overlapping rows */
1517f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 1, irow, is, MAT_INITIAL_MATRIX, sub));
1518f1580f4eSBarry Smith     PetscCall(MatDuplicate((*sub)[0], MAT_COPY_VALUES, &aux));
1519f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1520f1580f4eSBarry Smith     if (bs == 1) { /* scalar case */
1521f1580f4eSBarry Smith       Vec sum[2];
1522811e8887SPierre Jolivet 
1523f1580f4eSBarry Smith       PetscCall(MatCreateVecs(aux, sum, sum + 1));
1524f1580f4eSBarry Smith       PetscCall(MatGetRowSum(M[0], sum[0]));
1525f1580f4eSBarry Smith       PetscCall(MatGetRowSum(aux, sum[1]));
1526f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1527f1580f4eSBarry Smith       PetscCall(VecAXPY(sum[0], -1.0, sum[1]));
1528f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1529f1580f4eSBarry Smith       PetscCall(MatDiagonalSet(aux, sum[0], ADD_VALUES));
1530f1580f4eSBarry Smith       PetscCall(VecDestroy(sum));
1531f1580f4eSBarry Smith       PetscCall(VecDestroy(sum + 1));
1532f1580f4eSBarry Smith     } else { /* vectorial case */
1533f1580f4eSBarry Smith       /* TODO: missing MatGetValuesBlocked(), so the code below is     */
1534f1580f4eSBarry Smith       /* an extension of the scalar case for when bs > 1, but it could */
1535f1580f4eSBarry Smith       /* be more efficient by avoiding all these MatMatMult()          */
1536f1580f4eSBarry Smith       Mat          sum[2], ones;
1537f1580f4eSBarry Smith       PetscScalar *ptr;
1538811e8887SPierre Jolivet 
1539f1580f4eSBarry Smith       PetscCall(PetscCalloc1(M[0]->cmap->n * bs, &ptr));
1540f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, M[0]->cmap->n, bs, M[0]->cmap->n, bs, ptr, &ones));
1541811e8887SPierre Jolivet       for (PetscInt n = 0; n < M[0]->cmap->n; n += bs) {
1542f1580f4eSBarry Smith         for (p = 0; p < bs; ++p) ptr[n + p * (M[0]->cmap->n + 1)] = 1.0;
1543f1580f4eSBarry Smith       }
1544fb842aefSJose E. Roman       PetscCall(MatMatMult(M[0], ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum));
1545f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1546f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, aux->cmap->n, bs, aux->cmap->n, bs, ptr, &ones));
1547f1580f4eSBarry Smith       PetscCall(MatDenseSetLDA(ones, M[0]->cmap->n));
1548fb842aefSJose E. Roman       PetscCall(MatMatMult(aux, ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum + 1));
1549f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1550f1580f4eSBarry Smith       PetscCall(PetscFree(ptr));
1551f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1552f1580f4eSBarry Smith       PetscCall(MatAXPY(sum[0], -1.0, sum[1], SAME_NONZERO_PATTERN));
1553f1580f4eSBarry Smith       PetscCall(MatDestroy(sum + 1));
1554f1580f4eSBarry Smith       /* re-order values to be consistent with MatSetValuesBlocked()           */
1555f1580f4eSBarry Smith       /* equivalent to MatTranspose() which does not truly handle              */
1556f1580f4eSBarry Smith       /* MAT_INPLACE_MATRIX in the rectangular case, as it calls PetscMalloc() */
1557f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(sum[0], &ptr));
1558f1580f4eSBarry Smith       HPDDM::Wrapper<PetscScalar>::imatcopy<'T'>(bs, sum[0]->rmap->n, ptr, sum[0]->rmap->n, bs);
1559f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1560811e8887SPierre Jolivet       for (PetscInt n = 0; n < aux->cmap->n / bs; ++n) PetscCall(MatSetValuesBlocked(aux, 1, &n, 1, &n, ptr + n * bs * bs, ADD_VALUES));
1561f1580f4eSBarry Smith       PetscCall(MatAssemblyBegin(aux, MAT_FINAL_ASSEMBLY));
1562f1580f4eSBarry Smith       PetscCall(MatAssemblyEnd(aux, MAT_FINAL_ASSEMBLY));
1563f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(sum[0], &ptr));
1564f1580f4eSBarry Smith       PetscCall(MatDestroy(sum));
1565f1580f4eSBarry Smith     }
1566f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
1567f1580f4eSBarry Smith     /* left-hand side of GenEO, with the same sparsity pattern as PCASM subdomain solvers  */
1568f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Neumann_Mat", (PetscObject)aux));
1569f1580f4eSBarry Smith   }
1570f1580f4eSBarry Smith   PetscCall(ISDestroy(irow));
1571f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &M));
15723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1573f1580f4eSBarry Smith }
1574f1580f4eSBarry Smith 
157513044ca3SPierre Jolivet static PetscErrorCode PCApply_Nest(PC pc, Vec x, Vec y)
157613044ca3SPierre Jolivet {
157713044ca3SPierre Jolivet   Mat                    A;
157813044ca3SPierre Jolivet   MatSolverType          type;
157913044ca3SPierre Jolivet   IS                     is[2];
158013044ca3SPierre Jolivet   PetscBool              flg;
158113044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
158213044ca3SPierre Jolivet 
158313044ca3SPierre Jolivet   PetscFunctionBegin;
158413044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
158551ea4bc8SPierre Jolivet   if (p->second[0]) { /* in case of a centralized Schur complement, some processes may have no local operator */
158613044ca3SPierre Jolivet     PetscCall(PCGetOperators(p->first, &A, nullptr));
158713044ca3SPierre Jolivet     PetscCall(MatNestGetISs(A, is, nullptr));
158851ea4bc8SPierre Jolivet     PetscCall(PetscObjectTypeCompareAny((PetscObject)p->first, &flg, PCLU, PCCHOLESKY, ""));
158951ea4bc8SPierre Jolivet     if (flg) { /* partial solve currently only makes sense with exact factorizations */
159013044ca3SPierre Jolivet       PetscCall(PCFactorGetMatSolverType(p->first, &type));
159113044ca3SPierre Jolivet       PetscCall(PCFactorGetMatrix(p->first, &A));
159251ea4bc8SPierre Jolivet       if (A->schur) {
159313044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
159451ea4bc8SPierre Jolivet         if (flg) PetscCall(MatMumpsSetIcntl(A, 26, 1)); /* reduction/condensation phase followed by Schur complement solve */
159551ea4bc8SPierre Jolivet       } else flg = PETSC_FALSE;
159613044ca3SPierre Jolivet     }
159713044ca3SPierre Jolivet     PetscCall(VecISCopy(p->second[0], is[1], SCATTER_FORWARD, x)); /* assign the RHS associated to the Schur complement */
159813044ca3SPierre Jolivet     PetscCall(PCApply(p->first, p->second[0], p->second[1]));
159913044ca3SPierre Jolivet     PetscCall(VecISCopy(p->second[1], is[1], SCATTER_REVERSE, y)); /* retrieve the partial solution associated to the Schur complement */
160079578405SBarry Smith     if (flg) PetscCall(MatMumpsSetIcntl(A, 26, -1));               /* default ICNTL(26) value in PETSc */
160113044ca3SPierre Jolivet   }
160213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
160313044ca3SPierre Jolivet }
160413044ca3SPierre Jolivet 
160513044ca3SPierre Jolivet static PetscErrorCode PCView_Nest(PC pc, PetscViewer viewer)
160613044ca3SPierre Jolivet {
160713044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
160813044ca3SPierre Jolivet 
160913044ca3SPierre Jolivet   PetscFunctionBegin;
161013044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
161113044ca3SPierre Jolivet   PetscCall(PCView(p->first, viewer));
161213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
161313044ca3SPierre Jolivet }
161413044ca3SPierre Jolivet 
161513044ca3SPierre Jolivet static PetscErrorCode PCDestroy_Nest(PC pc)
161613044ca3SPierre Jolivet {
161713044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
161813044ca3SPierre Jolivet 
161913044ca3SPierre Jolivet   PetscFunctionBegin;
162013044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
162113044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second));
162213044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second + 1));
162313044ca3SPierre Jolivet   PetscCall(PCDestroy(&p->first));
162413044ca3SPierre Jolivet   PetscCall(PetscFree(p));
162513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
162613044ca3SPierre Jolivet }
162713044ca3SPierre Jolivet 
162813044ca3SPierre Jolivet template <bool T = false>
162913044ca3SPierre Jolivet static PetscErrorCode MatMult_Schur(Mat A, Vec x, Vec y)
163013044ca3SPierre Jolivet {
163101e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
163213044ca3SPierre Jolivet 
163313044ca3SPierre Jolivet   PetscFunctionBegin;
163413044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
163513044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD)); /* local Vec with overlap */
163613044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD));
163713044ca3SPierre Jolivet   if (!T) PetscCall(MatMult(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1])); /* local Schur complement */
163813044ca3SPierre Jolivet   else PetscCall(MatMultTranspose(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1]));
163913044ca3SPierre Jolivet   PetscCall(VecSet(y, 0.0));
164013044ca3SPierre 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 */
164113044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE));
164213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
164313044ca3SPierre Jolivet }
164413044ca3SPierre Jolivet 
164513044ca3SPierre Jolivet static PetscErrorCode MatDestroy_Schur(Mat A)
164613044ca3SPierre Jolivet {
164701e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
164813044ca3SPierre Jolivet 
164913044ca3SPierre Jolivet   PetscFunctionBegin;
165013044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
165113044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx)));
165213044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx) + 1));
165313044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
165413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
165513044ca3SPierre Jolivet }
165613044ca3SPierre Jolivet 
165713044ca3SPierre Jolivet static PetscErrorCode MatMult_SchurCorrection(Mat A, Vec x, Vec y)
165813044ca3SPierre Jolivet {
165913044ca3SPierre Jolivet   PC                                         pc;
166013044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
166113044ca3SPierre Jolivet 
166213044ca3SPierre Jolivet   PetscFunctionBegin;
166313044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
166413044ca3SPierre Jolivet   pc = ((PC_HPDDM *)std::get<0>(*ctx)[0]->data)->levels[0]->ksp->pc;
166513044ca3SPierre 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 */
166613044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], x, std::get<3>(*ctx)[1]));                    /*     A_01 x                 */
166713044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 x             */
166813044ca3SPierre 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        */
166913044ca3SPierre 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 */
167013044ca3SPierre Jolivet   } else {
167113044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[0]));                    /*     M_S^-1 x               */
167213044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], std::get<3>(*ctx)[0], std::get<3>(*ctx)[1])); /*     A_01 M_S^-1 x          */
167313044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 M_S^-1 x      */
167413044ca3SPierre 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 */
167513044ca3SPierre Jolivet   }
167613044ca3SPierre Jolivet   PetscCall(VecAXPY(y, -1.0, x)); /* y -= x, preconditioned eq. (24) of https://hal.science/hal-02343808v6/document (with a sign flip) */
167713044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
167813044ca3SPierre Jolivet }
167913044ca3SPierre Jolivet 
168013044ca3SPierre Jolivet static PetscErrorCode MatView_SchurCorrection(Mat A, PetscViewer viewer)
168113044ca3SPierre Jolivet {
168213044ca3SPierre Jolivet   PetscBool                                  ascii;
168313044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
168413044ca3SPierre Jolivet 
168513044ca3SPierre Jolivet   PetscFunctionBegin;
168613044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &ascii));
168713044ca3SPierre Jolivet   if (ascii) {
168813044ca3SPierre Jolivet     PetscCall(MatShellGetContext(A, &ctx));
168913044ca3SPierre 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)"));
169013044ca3SPierre Jolivet     PetscCall(PCView(std::get<0>(*ctx)[1], viewer)); /* no need to PCView(Q_0) since it will be done by PCFIELDSPLIT */
169113044ca3SPierre Jolivet   }
169213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
169313044ca3SPierre Jolivet }
169413044ca3SPierre Jolivet 
169513044ca3SPierre Jolivet static PetscErrorCode MatDestroy_SchurCorrection(Mat A)
169613044ca3SPierre Jolivet {
169713044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
169813044ca3SPierre Jolivet 
169913044ca3SPierre Jolivet   PetscFunctionBegin;
170013044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
170113044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx)));
170213044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 1));
170313044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 2));
170413044ca3SPierre Jolivet   PetscCall(PCDestroy(std::get<0>(*ctx) + 1));
170513044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
170613044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
170713044ca3SPierre Jolivet }
170813044ca3SPierre Jolivet 
1709feebddf4SPierre Jolivet static PetscErrorCode PCPostSolve_SchurPreLeastSquares(PC, KSP, Vec, Vec x)
1710feebddf4SPierre Jolivet {
1711feebddf4SPierre Jolivet   PetscFunctionBegin;
1712feebddf4SPierre Jolivet   PetscCall(VecScale(x, -1.0));
1713feebddf4SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1714feebddf4SPierre Jolivet }
1715feebddf4SPierre Jolivet 
171613044ca3SPierre Jolivet static PetscErrorCode KSPPreSolve_SchurCorrection(KSP, Vec b, Vec, void *context)
171713044ca3SPierre Jolivet {
171813044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
171913044ca3SPierre Jolivet 
1720a6b3e571SPierre Jolivet   PetscFunctionBegin;
172113044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
172213044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], b, std::get<3>(*ctx)[2]));
172313044ca3SPierre 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 */
172413044ca3SPierre Jolivet   }
172513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
172613044ca3SPierre Jolivet }
172713044ca3SPierre Jolivet 
172813044ca3SPierre Jolivet static PetscErrorCode KSPPostSolve_SchurCorrection(KSP, Vec b, Vec x, void *context)
172913044ca3SPierre Jolivet {
173013044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
173113044ca3SPierre Jolivet 
1732a6b3e571SPierre Jolivet   PetscFunctionBegin;
173313044ca3SPierre 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 */
173413044ca3SPierre Jolivet   else {
173513044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[2]));
173613044ca3SPierre Jolivet     PetscCall(VecCopy(std::get<3>(*ctx)[2], x)); /* replace x by M^-1 x */
173713044ca3SPierre Jolivet   }
173813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
173913044ca3SPierre Jolivet }
174013044ca3SPierre Jolivet 
17419bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat, Vec, Vec);
17429bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat, Vec, Vec);
17439bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat, Mat, Mat, void *);
1744f21e3f8aSPierre Jolivet static PetscErrorCode MatProduct_AtB_Harmonic(Mat, Mat, Mat, void *);
17459bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat);
17469bb5c669SPierre Jolivet 
1747d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDM(PC pc)
1748d71ae5a4SJacob Faibussowitsch {
1749f1580f4eSBarry Smith   PC_HPDDM                                  *data = (PC_HPDDM *)pc->data;
1750f1580f4eSBarry Smith   PC                                         inner;
1751f1580f4eSBarry Smith   KSP                                       *ksp;
175213044ca3SPierre Jolivet   Mat                                       *sub, A, P, N, C = nullptr, uaux = nullptr, weighted, subA[2], S;
1753f1580f4eSBarry Smith   Vec                                        xin, v;
1754f1580f4eSBarry Smith   std::vector<Vec>                           initial;
1755db4a47b3SPierre Jolivet   IS                                         is[1], loc, uis = data->is, unsorted = nullptr;
1756f1580f4eSBarry Smith   ISLocalToGlobalMapping                     l2g;
1757f1580f4eSBarry Smith   char                                       prefix[256];
1758f1580f4eSBarry Smith   const char                                *pcpre;
1759f1580f4eSBarry Smith   const PetscScalar *const                  *ev;
17609bb5c669SPierre Jolivet   PetscInt                                   n, requested = data->N, reused = 0, overlap = -1;
1761f1580f4eSBarry Smith   MatStructure                               structure  = UNKNOWN_NONZERO_PATTERN;
1762f1580f4eSBarry Smith   PetscBool                                  subdomains = PETSC_FALSE, flg = PETSC_FALSE, ismatis, swap = PETSC_FALSE, algebraic = PETSC_FALSE, block = PETSC_FALSE;
1763f1580f4eSBarry Smith   DM                                         dm;
176413044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = nullptr;
1765398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1766db4a47b3SPierre Jolivet   IS  dis  = nullptr;
1767db4a47b3SPierre Jolivet   Mat daux = nullptr;
1768398c7888SPierre Jolivet #endif
1769f1580f4eSBarry Smith 
1770f1580f4eSBarry Smith   PetscFunctionBegin;
1771f1580f4eSBarry Smith   PetscCheck(data->levels && data->levels[0], PETSC_COMM_SELF, PETSC_ERR_PLIB, "Not a single level allocated");
1772f1580f4eSBarry Smith   PetscCall(PCGetOptionsPrefix(pc, &pcpre));
1773f1580f4eSBarry Smith   PetscCall(PCGetOperators(pc, &A, &P));
1774f1580f4eSBarry Smith   if (!data->levels[0]->ksp) {
1775f1580f4eSBarry Smith     PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->ksp));
17763821be0aSBarry Smith     PetscCall(KSPSetNestLevel(data->levels[0]->ksp, pc->kspnestlevel));
1777f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_%s_", pcpre ? pcpre : "", data->N > 1 ? "levels_1" : "coarse"));
1778f1580f4eSBarry Smith     PetscCall(KSPSetOptionsPrefix(data->levels[0]->ksp, prefix));
1779f1580f4eSBarry Smith     PetscCall(KSPSetType(data->levels[0]->ksp, KSPPREONLY));
1780371d2eb7SMartin Diehl   } else if (data->levels[0]->ksp->pc && data->levels[0]->ksp->pc->setupcalled && data->levels[0]->ksp->pc->reusepreconditioner) {
1781f1580f4eSBarry Smith     /* if the fine-level PCSHELL exists, its setup has succeeded, and one wants to reuse it, */
1782f1580f4eSBarry Smith     /* then just propagate the appropriate flag to the coarser levels                        */
1783f1580f4eSBarry Smith     for (n = 0; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1784f1580f4eSBarry Smith       /* the following KSP and PC may be NULL for some processes, hence the check            */
1785f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetReusePreconditioner(data->levels[n]->ksp, PETSC_TRUE));
1786f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
1787f1580f4eSBarry Smith     }
1788f1580f4eSBarry Smith     /* early bail out because there is nothing to do */
17893ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1790f1580f4eSBarry Smith   } else {
1791f1580f4eSBarry Smith     /* reset coarser levels */
1792f1580f4eSBarry Smith     for (n = 1; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1793371d2eb7SMartin Diehl       if (data->levels[n]->ksp && data->levels[n]->ksp->pc && data->levels[n]->ksp->pc->setupcalled && data->levels[n]->ksp->pc->reusepreconditioner && n < data->N) {
1794f1580f4eSBarry Smith         reused = data->N - n;
1795f1580f4eSBarry Smith         break;
1796f1580f4eSBarry Smith       }
1797f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[n]->ksp));
1798f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[n]->pc));
1799f1580f4eSBarry Smith     }
1800f1580f4eSBarry Smith     /* check if some coarser levels are being reused */
1801462c564dSBarry Smith     PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &reused, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)pc)));
1802f1580f4eSBarry Smith     const int *addr = data->levels[0]->P ? data->levels[0]->P->getAddrLocal() : &HPDDM::i__0;
1803f1580f4eSBarry Smith 
1804f1580f4eSBarry Smith     if (addr != &HPDDM::i__0 && reused != data->N - 1) {
1805f1580f4eSBarry Smith       /* reuse previously computed eigenvectors */
1806f1580f4eSBarry Smith       ev = data->levels[0]->P->getVectors();
1807f1580f4eSBarry Smith       if (ev) {
1808f1580f4eSBarry Smith         initial.reserve(*addr);
1809f1580f4eSBarry Smith         PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, data->levels[0]->P->getDof(), ev[0], &xin));
1810f1580f4eSBarry Smith         for (n = 0; n < *addr; ++n) {
1811f1580f4eSBarry Smith           PetscCall(VecDuplicate(xin, &v));
1812f1580f4eSBarry Smith           PetscCall(VecPlaceArray(xin, ev[n]));
1813f1580f4eSBarry Smith           PetscCall(VecCopy(xin, v));
1814f1580f4eSBarry Smith           initial.emplace_back(v);
1815f1580f4eSBarry Smith           PetscCall(VecResetArray(xin));
1816f1580f4eSBarry Smith         }
1817f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
1818f1580f4eSBarry Smith       }
1819f1580f4eSBarry Smith     }
1820f1580f4eSBarry Smith   }
1821f1580f4eSBarry Smith   data->N -= reused;
1822f1580f4eSBarry Smith   PetscCall(KSPSetOperators(data->levels[0]->ksp, A, P));
1823f1580f4eSBarry Smith 
1824f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATIS, &ismatis));
1825f1580f4eSBarry Smith   if (!data->is && !ismatis) {
1826db4a47b3SPierre Jolivet     PetscErrorCode (*create)(DM, IS *, Mat *, PetscErrorCode (**)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void **) = nullptr;
1827db4a47b3SPierre Jolivet     PetscErrorCode (*usetup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *)                                                = nullptr;
1828db4a47b3SPierre Jolivet     void *uctx                                                                                                               = nullptr;
1829f1580f4eSBarry Smith 
1830f1580f4eSBarry Smith     /* first see if we can get the data from the DM */
1831f1580f4eSBarry Smith     PetscCall(MatGetDM(P, &dm));
1832f1580f4eSBarry Smith     if (!dm) PetscCall(MatGetDM(A, &dm));
1833f1580f4eSBarry Smith     if (!dm) PetscCall(PCGetDM(pc, &dm));
1834907a3e9cSStefano Zampini     if (dm) { /* this is the hook for DMPLEX for which the auxiliary Mat is the local Neumann matrix */
1835f1580f4eSBarry Smith       PetscCall(PetscObjectQueryFunction((PetscObject)dm, "DMCreateNeumannOverlap_C", &create));
1836f1580f4eSBarry Smith       if (create) {
1837f1580f4eSBarry Smith         PetscCall((*create)(dm, &uis, &uaux, &usetup, &uctx));
1838c8ea6600SPierre 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 */
1839f1580f4eSBarry Smith       }
1840f1580f4eSBarry Smith     }
1841f1580f4eSBarry Smith     if (!create) {
1842f1580f4eSBarry Smith       if (!uis) {
1843f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1844f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1845f1580f4eSBarry Smith       }
1846f1580f4eSBarry Smith       if (!uaux) {
1847f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1848f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1849f1580f4eSBarry Smith       }
1850f1580f4eSBarry Smith       /* look inside the Pmat instead of the PC, needed for MatSchurComplementComputeExplicitOperator() */
1851f1580f4eSBarry Smith       if (!uis) {
1852f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1853f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1854f1580f4eSBarry Smith       }
1855f1580f4eSBarry Smith       if (!uaux) {
1856f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1857f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1858f1580f4eSBarry Smith       }
1859f1580f4eSBarry Smith     }
1860f1580f4eSBarry Smith     PetscCall(PCHPDDMSetAuxiliaryMat(pc, uis, uaux, usetup, uctx));
1861f1580f4eSBarry Smith     PetscCall(MatDestroy(&uaux));
1862f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
1863f1580f4eSBarry Smith   }
1864f1580f4eSBarry Smith 
1865f1580f4eSBarry Smith   if (!ismatis) {
1866f1580f4eSBarry Smith     PetscCall(PCHPDDMSetUpNeumannOverlap_Private(pc));
1867*8dc3fbeeSPierre Jolivet     PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, pcpre, "-pc_hpddm_block_splitting", &block, nullptr));
1868*8dc3fbeeSPierre Jolivet     PetscCall(PetscOptionsGetInt(((PetscObject)pc)->options, pcpre, "-pc_hpddm_harmonic_overlap", &overlap, nullptr));
18695e642048SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
187051ea4bc8SPierre Jolivet     if (data->is || flg) {
18719bb5c669SPierre Jolivet       if (block || overlap != -1) {
187202800ff6SPierre Jolivet         PetscCall(ISDestroy(&data->is));
187302800ff6SPierre Jolivet         PetscCall(MatDestroy(&data->aux));
187451ea4bc8SPierre Jolivet       } else if (flg) {
187513044ca3SPierre Jolivet         PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_GENEO;
187613044ca3SPierre Jolivet 
1877*8dc3fbeeSPierre Jolivet         PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
187813044ca3SPierre Jolivet         if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
187913044ca3SPierre Jolivet           PetscCall(ISDestroy(&data->is)); /* destroy any previously user-set objects since they will be set automatically */
188013044ca3SPierre Jolivet           PetscCall(MatDestroy(&data->aux));
188113044ca3SPierre Jolivet         } else if (type == PC_HPDDM_SCHUR_PRE_GENEO) {
188213044ca3SPierre Jolivet           PetscContainer container = nullptr;
188313044ca3SPierre Jolivet 
188413044ca3SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Schur", (PetscObject *)&container));
188513044ca3SPierre Jolivet           if (!container) { /* first call to PCSetUp() on the PC associated to the Schur complement */
188613044ca3SPierre Jolivet             PC_HPDDM       *data_00;
188713044ca3SPierre Jolivet             KSP             ksp, inner_ksp;
188813044ca3SPierre Jolivet             PC              pc_00;
1889cf67ef9dSPierre Jolivet             Mat             A11 = nullptr;
1890cf67ef9dSPierre Jolivet             Vec             d   = nullptr;
18918a8e6071SPierre Jolivet             PetscReal       norm;
189251ea4bc8SPierre Jolivet             const PetscInt *ranges;
189351ea4bc8SPierre Jolivet             PetscMPIInt     size;
189413044ca3SPierre Jolivet             char           *prefix;
189513044ca3SPierre Jolivet 
189613044ca3SPierre Jolivet             PetscCall(MatSchurComplementGetKSP(P, &ksp));
189713044ca3SPierre Jolivet             PetscCall(KSPGetPC(ksp, &pc_00));
189813044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)pc_00, PCHPDDM, &flg));
1899fd310a01SPierre 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 : "",
190013044ca3SPierre Jolivet                        ((PetscObject)pc_00)->type_name, PCHPDDM);
190113044ca3SPierre Jolivet             data_00 = (PC_HPDDM *)pc_00->data;
1902fd310a01SPierre 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],
1903fd310a01SPierre Jolivet                        data_00->N, data_00->N > 1 ? "s" : "", ((PetscObject)pc_00)->prefix);
190451ea4bc8SPierre Jolivet             PetscCheck(data_00->levels[0]->pc, PetscObjectComm((PetscObject)P), PETSC_ERR_ORDER, "PC of the first block%s not setup yet", ((PetscObject)pc_00)->prefix ? std::string(std::string(" (") + ((PetscObject)pc_00)->prefix + std::string(")")).c_str() : "");
190513044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)data_00->levels[0]->pc, PCASM, &flg));
1906fd310a01SPierre 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,
190713044ca3SPierre Jolivet                        ((PetscObject)data_00->levels[0]->pc)->type_name, PCASM);
190851ea4bc8SPierre Jolivet             PetscCall(PetscNew(&ctx)); /* context to pass data around for the inner-most PC, which will be a proper PCHPDDM (or a dummy variable if the Schur complement is centralized on a single process)  */
1909d16c0b94SPierre Jolivet             PetscCall(MatSchurComplementGetSubMatrices(P, nullptr, nullptr, nullptr, nullptr, &A11));
191051ea4bc8SPierre Jolivet             PetscCall(MatGetOwnershipRanges(A11, &ranges));
191151ea4bc8SPierre Jolivet             PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A11), &size));
191251ea4bc8SPierre Jolivet             flg = PetscBool(std::find_if(ranges, ranges + size + 1, [&](PetscInt v) { return v != ranges[0] && v != ranges[size]; }) == ranges + size + 1); /* are all local matrices but one of dimension 0 (centralized Schur complement)? */
191351ea4bc8SPierre Jolivet             if (!flg) {
19145e642048SPierre Jolivet               if (PetscDefined(USE_DEBUG) || !data->is) {
19155e642048SPierre Jolivet                 Mat A01, A10, B = nullptr, C = nullptr, *sub;
191613044ca3SPierre Jolivet 
19175e642048SPierre Jolivet                 PetscCall(MatSchurComplementGetSubMatrices(P, &A, nullptr, &A01, &A10, nullptr));
19185e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
19195e642048SPierre Jolivet                 if (flg) {
19205e642048SPierre Jolivet                   PetscCall(MatTransposeGetMat(A10, &C));
19215e642048SPierre Jolivet                   PetscCall(MatTranspose(C, MAT_INITIAL_MATRIX, &B));
19225e642048SPierre Jolivet                 } else {
19235e642048SPierre Jolivet                   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
19245e642048SPierre Jolivet                   if (flg) {
19255e642048SPierre Jolivet                     PetscCall(MatHermitianTransposeGetMat(A10, &C));
19265e642048SPierre Jolivet                     PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &B));
19275e642048SPierre Jolivet                   }
19285e642048SPierre Jolivet                 }
1929811e8887SPierre Jolivet                 if (flg)
1930811e8887SPierre 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));
19315e642048SPierre Jolivet                 if (!B) {
19325e642048SPierre Jolivet                   B = A10;
19335e642048SPierre Jolivet                   PetscCall(PetscObjectReference((PetscObject)B));
19345e642048SPierre Jolivet                 } else if (!data->is) {
19355e642048SPierre Jolivet                   PetscCall(PetscObjectTypeCompareAny((PetscObject)A01, &flg, MATTRANSPOSEVIRTUAL, MATHERMITIANTRANSPOSEVIRTUAL, ""));
19365e642048SPierre Jolivet                   if (!flg) C = A01;
1937811e8887SPierre Jolivet                   else
1938811e8887SPierre 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));
19395e642048SPierre Jolivet                 }
194013044ca3SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, B->rmap->N, 0, 1, &uis));
19415e642048SPierre Jolivet                 PetscCall(ISSetIdentity(uis));
19425e642048SPierre Jolivet                 if (!data->is) {
19435e642048SPierre Jolivet                   if (C) PetscCall(PetscObjectReference((PetscObject)C));
19445e642048SPierre Jolivet                   else PetscCall(MatTranspose(B, MAT_INITIAL_MATRIX, &C));
19455e642048SPierre Jolivet                   PetscCall(ISDuplicate(data_00->is, is));
19465e642048SPierre Jolivet                   PetscCall(MatIncreaseOverlap(A, 1, is, 1));
19475e642048SPierre Jolivet                   PetscCall(MatSetOption(C, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
19485e642048SPierre Jolivet                   PetscCall(MatCreateSubMatrices(C, 1, is, &uis, MAT_INITIAL_MATRIX, &sub));
19495e642048SPierre Jolivet                   PetscCall(MatDestroy(&C));
19505e642048SPierre Jolivet                   PetscCall(MatTranspose(sub[0], MAT_INITIAL_MATRIX, &C));
19515e642048SPierre Jolivet                   PetscCall(MatDestroySubMatrices(1, &sub));
19525e642048SPierre Jolivet                   PetscCall(MatFindNonzeroRows(C, &data->is));
19539640b26aSPierre Jolivet                   PetscCheck(data->is, PetscObjectComm((PetscObject)C), PETSC_ERR_SUP, "No empty row, which likely means that some rows of A_10 are dense");
19545e642048SPierre Jolivet                   PetscCall(MatDestroy(&C));
19555e642048SPierre Jolivet                   PetscCall(ISDestroy(is));
1956d16c0b94SPierre Jolivet                   PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), A11->rmap->n, A11->rmap->rstart, 1, &loc));
1957d16c0b94SPierre Jolivet                   if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_FALSE));
1958d16c0b94SPierre Jolivet                   PetscCall(ISExpand(data->is, loc, is));
1959d16c0b94SPierre Jolivet                   PetscCall(ISDestroy(&loc));
1960d16c0b94SPierre Jolivet                   PetscCall(ISDestroy(&data->is));
1961d16c0b94SPierre Jolivet                   data->is = is[0];
1962d16c0b94SPierre Jolivet                   is[0]    = nullptr;
19635e642048SPierre Jolivet                 }
19645e642048SPierre Jolivet                 if (PetscDefined(USE_DEBUG)) {
19655e642048SPierre Jolivet                   PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
196613044ca3SPierre 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 */
196713044ca3SPierre Jolivet                   PetscCall(ISDestroy(&uis));
196813044ca3SPierre Jolivet                   PetscCall(ISDuplicate(data->is, &uis));
196913044ca3SPierre Jolivet                   PetscCall(ISSort(uis));
19705e642048SPierre Jolivet                   PetscCall(ISComplement(uis, 0, B->rmap->N, is));
197113044ca3SPierre Jolivet                   PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &C));
19725e642048SPierre Jolivet                   PetscCall(MatZeroRowsIS(C, is[0], 0.0, nullptr, nullptr));
19735e642048SPierre Jolivet                   PetscCall(ISDestroy(is));
197413044ca3SPierre Jolivet                   PetscCall(MatMultEqual(sub[0], C, 20, &flg));
197513044ca3SPierre 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 */
197613044ca3SPierre Jolivet                   PetscCall(MatDestroy(&C));
197713044ca3SPierre Jolivet                   PetscCall(MatDestroySubMatrices(1, &sub));
197813044ca3SPierre Jolivet                 }
19795e642048SPierre Jolivet                 PetscCall(ISDestroy(&uis));
19805e642048SPierre Jolivet                 PetscCall(MatDestroy(&B));
19815e642048SPierre Jolivet               }
1982cf67ef9dSPierre Jolivet               flg = PETSC_FALSE;
1983cf67ef9dSPierre Jolivet               if (!data->aux) {
1984cf67ef9dSPierre Jolivet                 Mat D;
1985cf67ef9dSPierre Jolivet 
1986cf67ef9dSPierre Jolivet                 PetscCall(MatCreateVecs(A11, &d, nullptr));
1987cf67ef9dSPierre Jolivet                 PetscCall(MatGetDiagonal(A11, d));
1988cf67ef9dSPierre Jolivet                 PetscCall(PetscObjectTypeCompareAny((PetscObject)A11, &flg, MATDIAGONAL, MATCONSTANTDIAGONAL, ""));
1989cf67ef9dSPierre Jolivet                 if (!flg) {
1990cf67ef9dSPierre Jolivet                   PetscCall(MatCreateDiagonal(d, &D));
1991cf67ef9dSPierre Jolivet                   PetscCall(MatMultEqual(A11, D, 20, &flg));
1992cf67ef9dSPierre Jolivet                   PetscCall(MatDestroy(&D));
1993cf67ef9dSPierre Jolivet                 }
1994cf67ef9dSPierre 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"));
1995cf67ef9dSPierre Jolivet               }
19968a8e6071SPierre Jolivet               if ((PetscDefined(USE_DEBUG) || (data->Neumann != PETSC_BOOL3_TRUE && !flg)) && A11) {
1997cf67ef9dSPierre Jolivet                 PetscCall(MatNorm(A11, NORM_INFINITY, &norm));
19988a8e6071SPierre Jolivet                 if (data->Neumann != PETSC_BOOL3_TRUE && !flg) {
1999cf67ef9dSPierre 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 : "");
2000cf67ef9dSPierre 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"));
2001cf67ef9dSPierre Jolivet                   PetscCall(MatDestroy(&data->aux));
2002cf67ef9dSPierre Jolivet                   flg = PETSC_TRUE;
2003cf67ef9dSPierre Jolivet                 }
20048a8e6071SPierre Jolivet               }
2005cf67ef9dSPierre 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 */
200601e3c840SPierre Jolivet                 PetscSF            scatter;
200713044ca3SPierre Jolivet                 const PetscScalar *read;
2008cf67ef9dSPierre Jolivet                 PetscScalar       *write, *diagonal = nullptr;
200913044ca3SPierre Jolivet 
201013044ca3SPierre Jolivet                 PetscCall(MatDestroy(&data->aux));
201113044ca3SPierre Jolivet                 PetscCall(ISGetLocalSize(data->is, &n));
2012cf67ef9dSPierre Jolivet                 PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &xin));
2013cf67ef9dSPierre Jolivet                 PetscCall(VecDuplicate(xin, &v));
2014cf67ef9dSPierre Jolivet                 PetscCall(VecScatterCreate(xin, data->is, v, nullptr, &scatter));
201513044ca3SPierre Jolivet                 PetscCall(VecSet(v, 1.0));
2016cf67ef9dSPierre Jolivet                 PetscCall(VecSet(xin, 1.0));
2017cf67ef9dSPierre Jolivet                 PetscCall(VecScatterBegin(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE));
2018cf67ef9dSPierre Jolivet                 PetscCall(VecScatterEnd(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE)); /* v has the multiplicity of all unknowns on the overlap */
2019cf67ef9dSPierre Jolivet                 PetscCall(PetscSFDestroy(&scatter));
2020cf67ef9dSPierre Jolivet                 if (d) {
2021cf67ef9dSPierre Jolivet                   PetscCall(VecScatterCreate(d, data->is, v, nullptr, &scatter));
2022cf67ef9dSPierre Jolivet                   PetscCall(VecScatterBegin(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
2023cf67ef9dSPierre Jolivet                   PetscCall(VecScatterEnd(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
2024cf67ef9dSPierre Jolivet                   PetscCall(PetscSFDestroy(&scatter));
2025cf67ef9dSPierre Jolivet                   PetscCall(VecDestroy(&d));
2026cf67ef9dSPierre Jolivet                   PetscCall(PetscMalloc1(n, &diagonal));
2027cf67ef9dSPierre Jolivet                   PetscCall(VecGetArrayRead(v, &read));
2028cf67ef9dSPierre Jolivet                   PetscCallCXX(std::copy_n(read, n, diagonal));
2029cf67ef9dSPierre Jolivet                   PetscCall(VecRestoreArrayRead(v, &read));
2030cf67ef9dSPierre Jolivet                 }
203113044ca3SPierre Jolivet                 PetscCall(VecDestroy(&v));
203213044ca3SPierre Jolivet                 PetscCall(VecCreateSeq(PETSC_COMM_SELF, n, &v));
2033cf67ef9dSPierre Jolivet                 PetscCall(VecGetArrayRead(xin, &read));
203413044ca3SPierre Jolivet                 PetscCall(VecGetArrayWrite(v, &write));
2035cf67ef9dSPierre 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];
2036cf67ef9dSPierre Jolivet                 PetscCall(PetscFree(diagonal));
2037cf67ef9dSPierre Jolivet                 PetscCall(VecRestoreArrayRead(xin, &read));
203813044ca3SPierre Jolivet                 PetscCall(VecRestoreArrayWrite(v, &write));
2039cf67ef9dSPierre Jolivet                 PetscCall(VecDestroy(&xin));
2040c3e1b152SPierre Jolivet                 PetscCall(MatCreateDiagonal(v, &data->aux));
204113044ca3SPierre Jolivet                 PetscCall(VecDestroy(&v));
204213044ca3SPierre Jolivet               }
204313044ca3SPierre Jolivet               uis  = data->is;
204413044ca3SPierre Jolivet               uaux = data->aux;
204513044ca3SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)uis));
204613044ca3SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)uaux));
204713044ca3SPierre Jolivet               PetscCall(PetscStrallocpy(pcpre, &prefix));
204813044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(pc, nullptr));
204913044ca3SPierre Jolivet               PetscCall(PCSetType(pc, PCKSP));                                    /* replace the PC associated to the Schur complement by PCKSP */
205013044ca3SPierre Jolivet               PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &inner_ksp)); /* new KSP that will be attached to the previously set PC */
205113044ca3SPierre Jolivet               PetscCall(PetscObjectGetTabLevel((PetscObject)pc, &n));
205213044ca3SPierre Jolivet               PetscCall(PetscObjectSetTabLevel((PetscObject)inner_ksp, n + 2));
205313044ca3SPierre Jolivet               PetscCall(KSPSetOperators(inner_ksp, pc->mat, pc->pmat));
205413044ca3SPierre Jolivet               PetscCall(KSPSetOptionsPrefix(inner_ksp, std::string(std::string(prefix) + "pc_hpddm_").c_str()));
205513044ca3SPierre Jolivet               PetscCall(KSPSetSkipPCSetFromOptions(inner_ksp, PETSC_TRUE));
205613044ca3SPierre Jolivet               PetscCall(KSPSetFromOptions(inner_ksp));
205713044ca3SPierre Jolivet               PetscCall(KSPGetPC(inner_ksp, &inner));
205813044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(inner, nullptr));
205913044ca3SPierre Jolivet               PetscCall(PCSetType(inner, PCNONE)); /* no preconditioner since the action of M^-1 A or A M^-1 will be computed by the Amat */
206013044ca3SPierre Jolivet               PetscCall(PCKSPSetKSP(pc, inner_ksp));
206113044ca3SPierre Jolivet               std::get<0>(*ctx)[0] = pc_00; /* for coarse correction on the primal (e.g., velocity) space */
206213044ca3SPierre Jolivet               PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &std::get<0>(*ctx)[1]));
206351ea4bc8SPierre Jolivet               PetscCall(PCSetOptionsPrefix(pc, prefix)); /* both PC share the same prefix so that the outer PC can be reset with PCSetFromOptions() */
206413044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(std::get<0>(*ctx)[1], prefix));
206513044ca3SPierre Jolivet               PetscCall(PetscFree(prefix));
206613044ca3SPierre Jolivet               PetscCall(PCSetOperators(std::get<0>(*ctx)[1], pc->mat, pc->pmat));
206713044ca3SPierre Jolivet               PetscCall(PCSetType(std::get<0>(*ctx)[1], PCHPDDM));
206813044ca3SPierre 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 */
2069cf67ef9dSPierre Jolivet               if (flg) static_cast<PC_HPDDM *>(std::get<0>(*ctx)[1]->data)->Neumann = PETSC_BOOL3_TRUE;
20708a8e6071SPierre Jolivet               else if (PetscDefined(USE_DEBUG) && norm > PETSC_MACHINE_EPSILON * static_cast<PetscReal>(10.0)) {
20718a8e6071SPierre Jolivet                 /* no check when A11 is near zero */
20728a8e6071SPierre Jolivet                 PetscCall(MatCreateSubMatrices(A11, 1, &uis, &uis, MAT_INITIAL_MATRIX, &sub));
20738a8e6071SPierre Jolivet                 PetscCall(PCHPDDMCheckMatStructure_Private(pc, sub[0], uaux));
20748a8e6071SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
20758a8e6071SPierre Jolivet               }
207613044ca3SPierre Jolivet               PetscCall(PCSetFromOptions(std::get<0>(*ctx)[1]));
207713044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)uis));
207813044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)uaux));
207913044ca3SPierre 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 */
208057d50842SBarry Smith               PetscCall(MatShellSetOperation(S, MATOP_MULT, (PetscErrorCodeFn *)MatMult_SchurCorrection));
208157d50842SBarry Smith               PetscCall(MatShellSetOperation(S, MATOP_VIEW, (PetscErrorCodeFn *)MatView_SchurCorrection));
208257d50842SBarry Smith               PetscCall(MatShellSetOperation(S, MATOP_DESTROY, (PetscErrorCodeFn *)MatDestroy_SchurCorrection));
208313044ca3SPierre Jolivet               PetscCall(KSPGetPCSide(inner_ksp, &(std::get<2>(*ctx))));
208413044ca3SPierre Jolivet               if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
208513044ca3SPierre Jolivet                 PetscCall(KSPSetPreSolve(inner_ksp, KSPPreSolve_SchurCorrection, ctx));
208613044ca3SPierre Jolivet               } else { /* no support for PC_SYMMETRIC */
208713044ca3SPierre 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]);
208813044ca3SPierre Jolivet               }
208913044ca3SPierre Jolivet               PetscCall(KSPSetPostSolve(inner_ksp, KSPPostSolve_SchurCorrection, ctx));
2090715c1178SPierre Jolivet               PetscCall(PetscObjectContainerCompose((PetscObject)std::get<0>(*ctx)[1], "_PCHPDDM_Schur", ctx, nullptr));
209113044ca3SPierre Jolivet               PetscCall(PCSetUp(std::get<0>(*ctx)[1]));
209213044ca3SPierre Jolivet               PetscCall(KSPSetOperators(inner_ksp, S, S));
209313044ca3SPierre Jolivet               PetscCall(MatCreateVecs(std::get<1>(*ctx)[0], std::get<3>(*ctx), std::get<3>(*ctx) + 1));
209413044ca3SPierre Jolivet               PetscCall(VecDuplicate(std::get<3>(*ctx)[0], std::get<3>(*ctx) + 2));
209513044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)inner_ksp));
209613044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)S));
209751ea4bc8SPierre Jolivet             } else {
209851ea4bc8SPierre Jolivet               std::get<0>(*ctx)[0] = pc_00;
209951ea4bc8SPierre Jolivet               PetscCall(PetscObjectContainerCompose((PetscObject)pc, "_PCHPDDM_Schur", ctx, nullptr));
210051ea4bc8SPierre Jolivet               PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data_00->is), A11->rmap->n, A11->rmap->rstart, 1, &data->is)); /* dummy variables in the case of a centralized Schur complement */
210151ea4bc8SPierre Jolivet               PetscCall(MatGetDiagonalBlock(A11, &data->aux));
210251ea4bc8SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)data->aux));
210351ea4bc8SPierre Jolivet               PetscCall(PCSetUp(pc));
210451ea4bc8SPierre Jolivet             }
21050307214fSPierre Jolivet             for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
210613044ca3SPierre Jolivet             PetscFunctionReturn(PETSC_SUCCESS);
210713044ca3SPierre Jolivet           } else { /* second call to PCSetUp() on the PC associated to the Schur complement, retrieve previously set context */
210813044ca3SPierre Jolivet             PetscCall(PetscContainerGetPointer(container, (void **)&ctx));
210913044ca3SPierre Jolivet           }
211013044ca3SPierre Jolivet         }
211113044ca3SPierre Jolivet       }
211213044ca3SPierre Jolivet     }
2113f1580f4eSBarry Smith     if (!data->is && data->N > 1) {
2114f1580f4eSBarry Smith       char type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
2115811e8887SPierre Jolivet 
2116f1580f4eSBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
2117f1580f4eSBarry Smith       if (flg || (A->rmap->N != A->cmap->N && P->rmap->N == P->cmap->N && P->rmap->N == A->cmap->N)) {
2118f1580f4eSBarry Smith         Mat B;
2119811e8887SPierre Jolivet 
2120f1580f4eSBarry Smith         PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, A, P, &B, pcpre));
2121f1580f4eSBarry Smith         if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) data->correction = PC_HPDDM_COARSE_CORRECTION_BALANCED;
2122f1580f4eSBarry Smith         PetscCall(MatDestroy(&B));
2123f1580f4eSBarry Smith       } else {
2124f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
2125f1580f4eSBarry Smith         if (flg) {
2126f1580f4eSBarry Smith           Mat                 A00, P00, A01, A10, A11, B, N;
212713044ca3SPierre Jolivet           PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_LEAST_SQUARES;
212813044ca3SPierre Jolivet 
212913044ca3SPierre Jolivet           PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, &A01, &A10, &A11));
2130*8dc3fbeeSPierre Jolivet           PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
213113044ca3SPierre Jolivet           if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
2132281f8ce6SPierre Jolivet             Mat                        B01;
21333df4cd7bSPierre Jolivet             Vec                        diagonal = nullptr;
2134f1580f4eSBarry Smith             const PetscScalar         *array;
2135f1580f4eSBarry Smith             MatSchurComplementAinvType type;
2136f1580f4eSBarry Smith 
2137281f8ce6SPierre Jolivet             PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10, &B01));
2138f1580f4eSBarry Smith             if (A11) {
21393df4cd7bSPierre Jolivet               PetscCall(MatCreateVecs(A11, &diagonal, nullptr));
21403df4cd7bSPierre Jolivet               PetscCall(MatGetDiagonal(A11, diagonal));
2141f1580f4eSBarry Smith             }
2142db4a47b3SPierre Jolivet             PetscCall(MatCreateVecs(P00, &v, nullptr));
2143f1580f4eSBarry Smith             PetscCall(MatSchurComplementGetAinvType(P, &type));
2144e5634b20SPierre Jolivet             PetscCheck(type == MAT_SCHUR_COMPLEMENT_AINV_DIAG || type == MAT_SCHUR_COMPLEMENT_AINV_LUMP || type == MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG, PetscObjectComm((PetscObject)P), PETSC_ERR_SUP, "-%smat_schur_complement_ainv_type %s",
2145e5634b20SPierre Jolivet                        ((PetscObject)P)->prefix ? ((PetscObject)P)->prefix : "", MatSchurComplementAinvTypes[type]);
2146e5634b20SPierre Jolivet             if (type != MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG) {
2147f1580f4eSBarry Smith               if (type == MAT_SCHUR_COMPLEMENT_AINV_LUMP) {
2148f1580f4eSBarry Smith                 PetscCall(MatGetRowSum(P00, v));
2149f1580f4eSBarry Smith                 if (A00 == P00) PetscCall(PetscObjectReference((PetscObject)A00));
2150f1580f4eSBarry Smith                 PetscCall(MatDestroy(&P00));
2151f1580f4eSBarry Smith                 PetscCall(VecGetArrayRead(v, &array));
2152db4a47b3SPierre Jolivet                 PetscCall(MatCreateAIJ(PetscObjectComm((PetscObject)A00), A00->rmap->n, A00->cmap->n, A00->rmap->N, A00->cmap->N, 1, nullptr, 0, nullptr, &P00));
2153f1580f4eSBarry Smith                 PetscCall(MatSetOption(P00, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
2154f1580f4eSBarry Smith                 for (n = A00->rmap->rstart; n < A00->rmap->rend; ++n) PetscCall(MatSetValue(P00, n, n, array[n - A00->rmap->rstart], INSERT_VALUES));
2155f1580f4eSBarry Smith                 PetscCall(MatAssemblyBegin(P00, MAT_FINAL_ASSEMBLY));
2156f1580f4eSBarry Smith                 PetscCall(MatAssemblyEnd(P00, MAT_FINAL_ASSEMBLY));
2157f1580f4eSBarry Smith                 PetscCall(VecRestoreArrayRead(v, &array));
2158f1580f4eSBarry Smith                 PetscCall(MatSchurComplementUpdateSubMatrices(P, A00, P00, A01, A10, A11)); /* replace P00 by diag(sum of each row of P00) */
2159f1580f4eSBarry Smith                 PetscCall(MatDestroy(&P00));
2160f1580f4eSBarry Smith               } else PetscCall(MatGetDiagonal(P00, v));
2161f1580f4eSBarry Smith               PetscCall(VecReciprocal(v)); /* inv(diag(P00))       */
2162f1580f4eSBarry Smith               PetscCall(VecSqrtAbs(v));    /* sqrt(inv(diag(P00))) */
2163f1580f4eSBarry Smith               PetscCall(MatDuplicate(A01, MAT_COPY_VALUES, &B));
2164db4a47b3SPierre Jolivet               PetscCall(MatDiagonalScale(B, v, nullptr));
2165281f8ce6SPierre Jolivet               if (B01) PetscCall(MatDiagonalScale(B01, v, nullptr));
2166e5634b20SPierre Jolivet             } else { /* not the same as MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG in MatSchurComplementGetPmat(), which considers process block diagonal, instead of point block diagonal, as done here */
2167e5634b20SPierre Jolivet               Mat     D00;
2168e5634b20SPierre Jolivet               MatType type;
2169e5634b20SPierre Jolivet 
2170e5634b20SPierre Jolivet               PetscCall(MatCreate(PetscObjectComm((PetscObject)A00), &D00));
2171e5634b20SPierre Jolivet               PetscCall(MatSetType(D00, MATAIJ));
2172e5634b20SPierre Jolivet               PetscCall(MatSetOptionsPrefix(D00, ((PetscObject)A00)->prefix));
2173e5634b20SPierre Jolivet               PetscCall(MatAppendOptionsPrefix(D00, "block_diagonal_"));
2174e5634b20SPierre Jolivet               PetscCall(MatSetFromOptions(D00));                          /* for setting -mat_block_size dynamically */
2175e5634b20SPierre Jolivet               PetscCall(MatConvert(A00, MATAIJ, MAT_INITIAL_MATRIX, &B)); /* not all MatTypes have a MatInvertBlockDiagonal() implementation, plus one may want to use a different block size than the one of A00 */
2176e5634b20SPierre Jolivet               PetscCall(MatSetBlockSizesFromMats(B, D00, D00));
2177e5634b20SPierre Jolivet               PetscCall(MatInvertBlockDiagonalMat(B, D00));
2178e5634b20SPierre Jolivet               PetscCall(MatDestroy(&B));
2179e5634b20SPierre Jolivet               PetscCall(MatGetType(A01, &type));                            /* cache MatType */
2180e5634b20SPierre Jolivet               PetscCall(MatConvert(A01, MATAIJ, MAT_INPLACE_MATRIX, &A01)); /* MatProduct is not versatile enough to fallback gracefully if no implementation found, so MatConvert() */
2181e5634b20SPierre Jolivet               PetscCall(MatMatMult(D00, A01, MAT_INITIAL_MATRIX, PETSC_CURRENT, &B));
2182e5634b20SPierre Jolivet               PetscCall(MatDestroy(&D00));
2183e5634b20SPierre Jolivet               PetscCall(MatConvert(A01, type, MAT_INPLACE_MATRIX, &A01)); /* reset to previous MatType */
2184e5634b20SPierre Jolivet               PetscCall(MatConvert(B, type, MAT_INPLACE_MATRIX, &B));
2185e5634b20SPierre Jolivet               if (!B01) { /* symmetric case */
2186e5634b20SPierre Jolivet                 B01 = A01;
2187e5634b20SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)B01));
2188e5634b20SPierre Jolivet               }
2189e5634b20SPierre Jolivet             }
2190e5634b20SPierre Jolivet             if (B01 && B01 != A01) PetscCall(MatSetBlockSizesFromMats(B01, A01, A01)); /* TODO: remove this line once Firedrake is fixed */
2191f1580f4eSBarry Smith             PetscCall(VecDestroy(&v));
2192f1580f4eSBarry Smith             PetscCall(MatCreateNormalHermitian(B, &N));
2193281f8ce6SPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, B, N, &P, pcpre, &diagonal, B01));
2194f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
2195f1580f4eSBarry Smith             if (!flg) {
2196f1580f4eSBarry Smith               PetscCall(MatDestroy(&P));
2197f1580f4eSBarry Smith               P = N;
2198f1580f4eSBarry Smith               PetscCall(PetscObjectReference((PetscObject)P));
2199feebddf4SPierre Jolivet             }
22003df4cd7bSPierre Jolivet             if (diagonal) {
2201e5634b20SPierre Jolivet               PetscCall(MatSetOption(P, MAT_NEW_NONZERO_LOCATION_ERR, PETSC_FALSE)); /* may have missing diagonal entries */
22023df4cd7bSPierre Jolivet               PetscCall(MatDiagonalSet(P, diagonal, ADD_VALUES));
2203feebddf4SPierre Jolivet               PetscCall(PCSetOperators(pc, P, P)); /* replace P by A01^T inv(diag(P00)) A01 - diag(P11) */
22043df4cd7bSPierre Jolivet               PetscCall(VecDestroy(&diagonal));
2205281f8ce6SPierre Jolivet             } else PetscCall(PCSetOperators(pc, B01 ? P : N, P));  /* replace P by A01^T inv(diag(P00)) A01                         */
2206feebddf4SPierre Jolivet             pc->ops->postsolve = PCPostSolve_SchurPreLeastSquares; /*  PCFIELDSPLIT expect a KSP for (P11 - A10 inv(diag(P00)) A01) */
2207feebddf4SPierre Jolivet             PetscCall(MatDestroy(&N));                             /*  but a PC for (A10 inv(diag(P00)) A10 - P11) is setup instead */
2208feebddf4SPierre Jolivet             PetscCall(MatDestroy(&P));                             /*  so the sign of the solution must be flipped                  */
2209f1580f4eSBarry Smith             PetscCall(MatDestroy(&B));
221013044ca3SPierre Jolivet           } else
2211fd310a01SPierre 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 : "");
22120307214fSPierre Jolivet           for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
22133ba16761SJacob Faibussowitsch           PetscFunctionReturn(PETSC_SUCCESS);
2214f1580f4eSBarry Smith         } else {
2215*8dc3fbeeSPierre Jolivet           PetscCall(PetscOptionsGetString(((PetscObject)pc)->options, pcpre, "-pc_hpddm_levels_1_st_pc_type", type, sizeof(type), nullptr));
2216f1580f4eSBarry Smith           PetscCall(PetscStrcmp(type, PCMAT, &algebraic));
2217b07dfdedSPierre Jolivet           PetscCheck(!algebraic || !block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_block_splitting");
22189bb5c669SPierre Jolivet           if (overlap != -1) {
22199bb5c669SPierre 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");
22209bb5c669SPierre Jolivet             PetscCheck(overlap >= 1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_WRONG, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " < 1", overlap);
22219bb5c669SPierre Jolivet           }
22229bb5c669SPierre Jolivet           if (block || overlap != -1) algebraic = PETSC_TRUE;
2223f1580f4eSBarry Smith           if (algebraic) {
2224f1580f4eSBarry Smith             PetscCall(ISCreateStride(PETSC_COMM_SELF, P->rmap->n, P->rmap->rstart, 1, &data->is));
2225f1580f4eSBarry Smith             PetscCall(MatIncreaseOverlap(P, 1, &data->is, 1));
2226f1580f4eSBarry Smith             PetscCall(ISSort(data->is));
22279bb5c669SPierre Jolivet           } else
22289bb5c669SPierre 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 : ""));
2229f1580f4eSBarry Smith         }
2230f1580f4eSBarry Smith       }
2231f1580f4eSBarry Smith     }
2232f1580f4eSBarry Smith   }
2233398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2234398c7888SPierre Jolivet   if (data->is) PetscCall(ISDuplicate(data->is, &dis));
2235398c7888SPierre Jolivet   if (data->aux) PetscCall(MatDuplicate(data->aux, MAT_COPY_VALUES, &daux));
2236398c7888SPierre Jolivet #endif
2237f1580f4eSBarry Smith   if (data->is || (ismatis && data->N > 1)) {
2238f1580f4eSBarry Smith     if (ismatis) {
2239f1580f4eSBarry Smith       std::initializer_list<std::string> list = {MATSEQBAIJ, MATSEQSBAIJ};
2240f1580f4eSBarry Smith       PetscCall(MatISGetLocalMat(P, &N));
2241f1580f4eSBarry Smith       std::initializer_list<std::string>::const_iterator it = std::find(list.begin(), list.end(), ((PetscObject)N)->type_name);
2242f1580f4eSBarry Smith       PetscCall(MatISRestoreLocalMat(P, &N));
2243f1580f4eSBarry Smith       switch (std::distance(list.begin(), it)) {
2244d71ae5a4SJacob Faibussowitsch       case 0:
2245d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
2246d71ae5a4SJacob Faibussowitsch         break;
2247f1580f4eSBarry Smith       case 1:
2248f1580f4eSBarry Smith         /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIBAIJ */
2249f1580f4eSBarry Smith         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
2250f1580f4eSBarry Smith         break;
2251d71ae5a4SJacob Faibussowitsch       default:
2252d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, &C));
2253f1580f4eSBarry Smith       }
2254db4a47b3SPierre Jolivet       PetscCall(MatISGetLocalToGlobalMapping(P, &l2g, nullptr));
2255f1580f4eSBarry Smith       PetscCall(PetscObjectReference((PetscObject)P));
2256f1580f4eSBarry Smith       PetscCall(KSPSetOperators(data->levels[0]->ksp, A, C));
2257f1580f4eSBarry Smith       std::swap(C, P);
2258f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingGetSize(l2g, &n));
2259f1580f4eSBarry Smith       PetscCall(ISCreateStride(PETSC_COMM_SELF, n, 0, 1, &loc));
2260f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingApplyIS(l2g, loc, &is[0]));
2261f1580f4eSBarry Smith       PetscCall(ISDestroy(&loc));
2262f1580f4eSBarry Smith       /* the auxiliary Mat is _not_ the local Neumann matrix                                */
2263f1580f4eSBarry Smith       /* it is the local Neumann matrix augmented (with zeros) through MatIncreaseOverlap() */
2264c8ea6600SPierre Jolivet       data->Neumann = PETSC_BOOL3_FALSE;
2265f1580f4eSBarry Smith       structure     = SAME_NONZERO_PATTERN;
2266f1580f4eSBarry Smith     } else {
2267f1580f4eSBarry Smith       is[0] = data->is;
226813044ca3SPierre Jolivet       if (algebraic || ctx) subdomains = PETSC_TRUE;
2269*8dc3fbeeSPierre Jolivet       PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, pcpre, "-pc_hpddm_define_subdomains", &subdomains, nullptr));
227013044ca3SPierre 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);
2271c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann)) {
2272b07dfdedSPierre Jolivet         PetscCheck(!block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_block_splitting and -pc_hpddm_has_neumann");
22739bb5c669SPierre Jolivet         PetscCheck(overlap == -1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " and -pc_hpddm_has_neumann", overlap);
2274b07dfdedSPierre Jolivet         PetscCheck(!algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_has_neumann");
2275f1580f4eSBarry Smith       }
2276c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann) || block) structure = SAME_NONZERO_PATTERN;
2277f1580f4eSBarry Smith       PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), P->rmap->n, P->rmap->rstart, 1, &loc));
2278f1580f4eSBarry Smith     }
2279f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2280*8dc3fbeeSPierre Jolivet     PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, prefix, "-st_matstructure", MatStructures, (PetscEnum *)&structure, &flg)); /* if not user-provided, force its value when possible */
2281f1580f4eSBarry Smith     if (!flg && structure == SAME_NONZERO_PATTERN) { /* cannot call STSetMatStructure() yet, insert the appropriate option in the database, parsed by STSetFromOptions() */
2282f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-%spc_hpddm_levels_1_st_matstructure", pcpre ? pcpre : ""));
2283*8dc3fbeeSPierre Jolivet       PetscCall(PetscOptionsSetValue(((PetscObject)pc)->options, prefix, MatStructures[structure]));
2284f1580f4eSBarry Smith     }
2285398c7888SPierre Jolivet     flg = PETSC_FALSE;
2286b07dfdedSPierre Jolivet     if (data->share) {
2287398c7888SPierre Jolivet       data->share = PETSC_FALSE; /* will be reset to PETSC_TRUE if none of the conditions below are true */
2288398c7888SPierre 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 : ""));
2289398c7888SPierre Jolivet       else if (data->deflation) PetscCall(PetscInfo(pc, "Nothing to share since PCHPDDMSetDeflationMat() has been called\n"));
2290398c7888SPierre Jolivet       else if (ismatis) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc with a Pmat of type MATIS\n"));
2291b07dfdedSPierre Jolivet       else if (!algebraic && structure != SAME_NONZERO_PATTERN)
2292398c7888SPierre 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]));
2293398c7888SPierre Jolivet       else data->share = PETSC_TRUE;
2294398c7888SPierre Jolivet     }
2295398c7888SPierre Jolivet     if (!ismatis) {
2296398c7888SPierre Jolivet       if (data->share || (!PetscBool3ToBool(data->Neumann) && subdomains)) PetscCall(ISDuplicate(is[0], &unsorted));
2297398c7888SPierre Jolivet       else unsorted = is[0];
2298398c7888SPierre Jolivet     }
229951ea4bc8SPierre Jolivet     if ((ctx || data->N > 1) && (data->aux || ismatis || algebraic)) {
2300f1580f4eSBarry Smith       PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "HPDDM library not loaded, cannot use more than one level");
2301f1580f4eSBarry Smith       PetscCall(MatSetOption(P, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
2302f1580f4eSBarry Smith       if (ismatis) {
2303f1580f4eSBarry Smith         /* needed by HPDDM (currently) so that the partition of unity is 0 on subdomain interfaces */
2304f1580f4eSBarry Smith         PetscCall(MatIncreaseOverlap(P, 1, is, 1));
2305f1580f4eSBarry Smith         PetscCall(ISDestroy(&data->is));
2306f1580f4eSBarry Smith         data->is = is[0];
2307f1580f4eSBarry Smith       } else {
2308d16c0b94SPierre Jolivet         if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_TRUE));
230951ea4bc8SPierre Jolivet         if (!ctx && overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", PCHPDDMAlgebraicAuxiliaryMat_Private));
23109bb5c669SPierre Jolivet         if (!PetscBool3ToBool(data->Neumann) && (!algebraic || overlap != -1)) {
2311f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
2312f1580f4eSBarry Smith           if (flg) {
2313f1580f4eSBarry Smith             /* maybe better to ISSort(is[0]), MatCreateSubMatrices(), and then MatPermute() */
2314f1580f4eSBarry Smith             /* but there is no MatPermute_SeqSBAIJ(), so as before, just use MATMPIBAIJ     */
2315f1580f4eSBarry Smith             PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &uaux));
2316f1580f4eSBarry Smith             flg = PETSC_FALSE;
2317f1580f4eSBarry Smith           }
2318f1580f4eSBarry Smith         }
2319f1580f4eSBarry Smith       }
23209bb5c669SPierre Jolivet       if (algebraic && overlap == -1) {
2321f1580f4eSBarry Smith         PetscUseMethod(pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", (Mat, IS *, Mat *[], PetscBool), (P, is, &sub, block));
2322f1580f4eSBarry Smith         if (block) {
2323f1580f4eSBarry Smith           PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", (PetscObject *)&data->aux));
2324db4a47b3SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", nullptr));
2325f1580f4eSBarry Smith         }
23269bb5c669SPierre Jolivet       } else if (!uaux || overlap != -1) {
232713044ca3SPierre Jolivet         if (!ctx) {
2328c8ea6600SPierre Jolivet           if (PetscBool3ToBool(data->Neumann)) sub = &data->aux;
23299bb5c669SPierre Jolivet           else {
2330df21ef68SPierre Jolivet             PetscBool flg;
23319bb5c669SPierre Jolivet             if (overlap != -1) {
23329bb5c669SPierre Jolivet               Harmonic              h;
23339bb5c669SPierre Jolivet               Mat                   A0, *a;                    /* with an SVD: [ A_00  A_01       ] */
23349bb5c669SPierre Jolivet               IS                    ov[2], rows, cols, stride; /*              [ A_10  A_11  A_12 ] */
233558b7e2c1SStefano Zampini               const PetscInt       *i[2], bs = P->cmap->bs;    /* with a GEVP: [ A_00  A_01       ] */
23369bb5c669SPierre Jolivet               PetscInt              n[2];                      /*              [ A_10  A_11  A_12 ] */
23379bb5c669SPierre Jolivet               std::vector<PetscInt> v[2];                      /*              [       A_21  A_22 ] */
23389bb5c669SPierre Jolivet 
23392589ceddSPierre Jolivet               do {
23409bb5c669SPierre Jolivet                 PetscCall(ISDuplicate(data->is, ov));
23419bb5c669SPierre Jolivet                 if (overlap > 1) PetscCall(MatIncreaseOverlap(P, 1, ov, overlap - 1));
23429bb5c669SPierre Jolivet                 PetscCall(ISDuplicate(ov[0], ov + 1));
23439bb5c669SPierre Jolivet                 PetscCall(MatIncreaseOverlap(P, 1, ov + 1, 1));
23442589ceddSPierre Jolivet                 PetscCall(ISGetLocalSize(ov[0], n));
23452589ceddSPierre Jolivet                 PetscCall(ISGetLocalSize(ov[1], n + 1));
23468fad524dSPierre Jolivet                 flg = PetscBool(n[0] == n[1] && n[0] != P->rmap->n);
23475440e5dcSBarry Smith                 PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &flg, 1, MPI_C_BOOL, MPI_LOR, PetscObjectComm((PetscObject)pc)));
23482589ceddSPierre Jolivet                 if (flg) {
23492589ceddSPierre Jolivet                   PetscCall(ISDestroy(ov));
23502589ceddSPierre Jolivet                   PetscCall(ISDestroy(ov + 1));
23512589ceddSPierre Jolivet                   PetscCheck(--overlap, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "No oversampling possible");
23522589ceddSPierre Jolivet                   PetscCall(PetscInfo(pc, "Supplied -%spc_hpddm_harmonic_overlap parameter is too large, it has been decreased to %" PetscInt_FMT "\n", pcpre ? pcpre : "", overlap));
23532589ceddSPierre Jolivet                 } else break;
23542589ceddSPierre Jolivet               } while (1);
23559bb5c669SPierre Jolivet               PetscCall(PetscNew(&h));
23569bb5c669SPierre Jolivet               h->ksp = nullptr;
23579bb5c669SPierre Jolivet               PetscCall(PetscCalloc1(2, &h->A));
2358*8dc3fbeeSPierre Jolivet               PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, prefix, "-eps_nev", &flg));
2359b5a302b3SPierre Jolivet               if (!flg) {
2360*8dc3fbeeSPierre Jolivet                 PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, prefix, "-svd_nsv", &flg));
2361*8dc3fbeeSPierre Jolivet                 if (!flg) PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, prefix, "-svd_threshold_relative", &flg));
2362b5a302b3SPierre Jolivet               } else flg = PETSC_FALSE;
23639bb5c669SPierre Jolivet               PetscCall(ISSort(ov[0]));
23649bb5c669SPierre Jolivet               if (!flg) PetscCall(ISSort(ov[1]));
236532603206SJames Wright               PetscCall(PetscCalloc1(5, &h->is));
23669bb5c669SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, ov + !flg, ov + 1, MAT_INITIAL_MATRIX, &a)); /* submatrix from above, either square (!flg) or rectangular (flg) */
23672589ceddSPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISGetIndices(ov[j], i + j));
23689bb5c669SPierre Jolivet               v[1].reserve((n[1] - n[0]) / bs);
23699bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[1]; j += bs) { /* indices of the (2,2) block */
23709bb5c669SPierre Jolivet                 PetscInt location;
23719bb5c669SPierre Jolivet                 PetscCall(ISLocate(ov[0], i[1][j], &location));
23729bb5c669SPierre Jolivet                 if (location < 0) v[1].emplace_back(j / bs);
23739bb5c669SPierre Jolivet               }
23749bb5c669SPierre Jolivet               if (!flg) {
23759bb5c669SPierre Jolivet                 h->A[1] = a[0];
23769bb5c669SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)h->A[1]));
23779bb5c669SPierre Jolivet                 v[0].reserve((n[0] - P->rmap->n) / bs);
23789bb5c669SPierre Jolivet                 for (PetscInt j = 0; j < n[1]; j += bs) { /* row indices of the (1,2) block */
23799bb5c669SPierre Jolivet                   PetscInt location;
23809bb5c669SPierre Jolivet                   PetscCall(ISLocate(loc, i[1][j], &location));
23819bb5c669SPierre Jolivet                   if (location < 0) {
23829bb5c669SPierre Jolivet                     PetscCall(ISLocate(ov[0], i[1][j], &location));
23839bb5c669SPierre Jolivet                     if (location >= 0) v[0].emplace_back(j / bs);
23849bb5c669SPierre Jolivet                   }
23859bb5c669SPierre Jolivet                 }
23869bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
23879bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_COPY_VALUES, h->is + 4));
23889bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, h->is[4], MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
23899bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
23909bb5c669SPierre 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 */
23919bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &rows));
23929bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols = rows, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
23939bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
23949bb5c669SPierre Jolivet                 v[0].clear();
23959bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, ov[1], PETSC_TRUE, h->is + 3));
23969bb5c669SPierre Jolivet                 PetscCall(ISEmbed(data->is, ov[1], PETSC_TRUE, h->is + 2));
23979bb5c669SPierre Jolivet               }
23989bb5c669SPierre Jolivet               v[0].reserve((n[0] - P->rmap->n) / bs);
23999bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[0]; j += bs) {
24009bb5c669SPierre Jolivet                 PetscInt location;
24019bb5c669SPierre Jolivet                 PetscCall(ISLocate(loc, i[0][j], &location));
24029bb5c669SPierre Jolivet                 if (location < 0) v[0].emplace_back(j / bs);
24039bb5c669SPierre Jolivet               }
24049bb5c669SPierre Jolivet               PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
24059bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISRestoreIndices(ov[j], i + j));
24069bb5c669SPierre Jolivet               if (flg) {
24079bb5c669SPierre Jolivet                 IS is;
24089bb5c669SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, a[0]->rmap->n, 0, 1, &is));
24099bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &cols));
24109bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], is, cols, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
24119bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
24129bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&is));
2413b0c98d1dSPierre Jolivet                 if (uaux) { /* initial Pmat was MATSBAIJ, convert back to the same format since this submatrix is square */
2414b0c98d1dSPierre Jolivet                   PetscCall(MatSetOption(A0, MAT_SYMMETRIC, PETSC_TRUE));
2415b0c98d1dSPierre Jolivet                   PetscCall(MatConvert(A0, MATSEQSBAIJ, MAT_INPLACE_MATRIX, &A0));
2416b0c98d1dSPierre Jolivet                 }
24179bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, data->is, PETSC_TRUE, h->is + 2));
24189bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_USE_POINTER, &cols));
24199bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols, MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
24209bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
24219bb5c669SPierre Jolivet               }
24229bb5c669SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, A0->rmap->n, 0, 1, &stride));
24239bb5c669SPierre Jolivet               PetscCall(ISEmbed(rows, stride, PETSC_TRUE, h->is));
24249bb5c669SPierre Jolivet               PetscCall(ISDestroy(&stride));
24259bb5c669SPierre Jolivet               PetscCall(ISDestroy(&rows));
24269bb5c669SPierre Jolivet               PetscCall(ISEmbed(loc, ov[0], PETSC_TRUE, h->is + 1));
24279bb5c669SPierre Jolivet               if (subdomains) {
24289bb5c669SPierre Jolivet                 if (!data->levels[0]->pc) {
24299bb5c669SPierre Jolivet                   PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
24309bb5c669SPierre Jolivet                   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
24319bb5c669SPierre Jolivet                   PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
24329bb5c669SPierre Jolivet                   PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
24339bb5c669SPierre Jolivet                 }
24349bb5c669SPierre Jolivet                 PetscCall(PCSetType(data->levels[0]->pc, PCASM));
24359bb5c669SPierre Jolivet                 if (!data->levels[0]->pc->setupcalled) PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, ov + !flg, &loc));
24369bb5c669SPierre Jolivet                 PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, flg ? A0 : a[0], PETSC_TRUE));
24379bb5c669SPierre Jolivet                 if (!flg) ++overlap;
24389bb5c669SPierre Jolivet                 if (data->share) {
24399bb5c669SPierre Jolivet                   PetscInt n = -1;
24409bb5c669SPierre Jolivet                   PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
24419bb5c669SPierre Jolivet                   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
24429bb5c669SPierre Jolivet                   if (flg) {
24439bb5c669SPierre Jolivet                     h->ksp = ksp[0];
24449bb5c669SPierre Jolivet                     PetscCall(PetscObjectReference((PetscObject)h->ksp));
24459bb5c669SPierre Jolivet                   }
24469bb5c669SPierre Jolivet                 }
24479bb5c669SPierre Jolivet               }
24489bb5c669SPierre Jolivet               if (!h->ksp) {
24499bb5c669SPierre Jolivet                 PetscBool share = data->share;
2450*8dc3fbeeSPierre Jolivet 
24519bb5c669SPierre Jolivet                 PetscCall(KSPCreate(PETSC_COMM_SELF, &h->ksp));
24529bb5c669SPierre Jolivet                 PetscCall(KSPSetType(h->ksp, KSPPREONLY));
24539bb5c669SPierre Jolivet                 PetscCall(KSPSetOperators(h->ksp, A0, A0));
24549bb5c669SPierre Jolivet                 do {
24559bb5c669SPierre Jolivet                   if (!data->share) {
24569bb5c669SPierre Jolivet                     share = PETSC_FALSE;
24579bb5c669SPierre Jolivet                     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_%s", pcpre ? pcpre : "", flg ? "svd_" : "eps_"));
24589bb5c669SPierre Jolivet                     PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
24599bb5c669SPierre Jolivet                     PetscCall(KSPSetFromOptions(h->ksp));
24609bb5c669SPierre Jolivet                   } else {
24619bb5c669SPierre Jolivet                     MatSolverType type;
2462*8dc3fbeeSPierre Jolivet 
2463*8dc3fbeeSPierre Jolivet                     PetscCall(PetscObjectTypeCompareAny((PetscObject)ksp[0]->pc, &data->share, PCLU, PCCHOLESKY, ""));
24649bb5c669SPierre Jolivet                     if (data->share) {
2465*8dc3fbeeSPierre Jolivet                       PetscCall(PCFactorGetMatSolverType(ksp[0]->pc, &type));
24669bb5c669SPierre Jolivet                       if (!type) {
2467*8dc3fbeeSPierre Jolivet                         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(ksp[0]->pc, MATSOLVERMUMPS));
2468*8dc3fbeeSPierre Jolivet                         else if (PetscDefined(HAVE_MKL_PARDISO)) PetscCall(PCFactorSetMatSolverType(ksp[0]->pc, MATSOLVERMKL_PARDISO));
24699bb5c669SPierre Jolivet                         else data->share = PETSC_FALSE;
2470*8dc3fbeeSPierre Jolivet                         if (data->share) PetscCall(PCSetFromOptions(ksp[0]->pc));
24719bb5c669SPierre Jolivet                       } else {
24729bb5c669SPierre Jolivet                         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &data->share));
24739bb5c669SPierre Jolivet                         if (!data->share) PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &data->share));
24749bb5c669SPierre Jolivet                       }
24759bb5c669SPierre Jolivet                       if (data->share) {
24769bb5c669SPierre Jolivet                         std::tuple<KSP, IS, Vec[2]> *p;
2477*8dc3fbeeSPierre Jolivet 
2478*8dc3fbeeSPierre Jolivet                         PetscCall(PCFactorGetMatrix(ksp[0]->pc, &A));
24799bb5c669SPierre Jolivet                         PetscCall(MatFactorSetSchurIS(A, h->is[4]));
24809bb5c669SPierre Jolivet                         PetscCall(KSPSetUp(ksp[0]));
24819bb5c669SPierre Jolivet                         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_eps_shell_", pcpre ? pcpre : ""));
24829bb5c669SPierre Jolivet                         PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
24839bb5c669SPierre Jolivet                         PetscCall(KSPSetFromOptions(h->ksp));
2484*8dc3fbeeSPierre Jolivet                         PetscCall(PCSetType(h->ksp->pc, PCSHELL));
24859bb5c669SPierre Jolivet                         PetscCall(PetscNew(&p));
24869bb5c669SPierre Jolivet                         std::get<0>(*p) = ksp[0];
24879bb5c669SPierre Jolivet                         PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &std::get<1>(*p)));
24889bb5c669SPierre Jolivet                         PetscCall(MatCreateVecs(A, std::get<2>(*p), std::get<2>(*p) + 1));
2489*8dc3fbeeSPierre Jolivet                         PetscCall(PCShellSetContext(h->ksp->pc, p));
2490*8dc3fbeeSPierre Jolivet                         PetscCall(PCShellSetApply(h->ksp->pc, PCApply_Schur));
2491*8dc3fbeeSPierre Jolivet                         PetscCall(PCShellSetApplyTranspose(h->ksp->pc, PCApply_Schur<Vec, true>));
2492*8dc3fbeeSPierre Jolivet                         PetscCall(PCShellSetMatApply(h->ksp->pc, PCApply_Schur<Mat>));
2493*8dc3fbeeSPierre Jolivet                         PetscCall(PCShellSetDestroy(h->ksp->pc, PCDestroy_Schur));
24949bb5c669SPierre Jolivet                       }
24959bb5c669SPierre Jolivet                     }
24969bb5c669SPierre Jolivet                     if (!data->share) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since neither MUMPS nor MKL PARDISO is used\n"));
24979bb5c669SPierre Jolivet                   }
24989bb5c669SPierre 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 */
24999bb5c669SPierre Jolivet               }
25009bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov));
25019bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov + 1));
25029bb5c669SPierre Jolivet               if (overlap == 1 && subdomains && flg) {
25039bb5c669SPierre Jolivet                 *subA = A0;
25049bb5c669SPierre Jolivet                 sub   = subA;
25059bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatDestroy(&uaux));
25069bb5c669SPierre Jolivet               } else PetscCall(MatDestroy(&A0));
25079bb5c669SPierre Jolivet               PetscCall(MatCreateShell(PETSC_COMM_SELF, P->rmap->n, n[1] - n[0], P->rmap->n, n[1] - n[0], h, &data->aux));
2508bdcd51b8SPierre Jolivet               PetscCall(KSPSetErrorIfNotConverged(h->ksp, PETSC_TRUE)); /* bail out as early as possible to avoid (apparently) unrelated error messages */
25099bb5c669SPierre Jolivet               PetscCall(MatCreateVecs(h->ksp->pc->pmat, &h->v, nullptr));
251057d50842SBarry Smith               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT, (PetscErrorCodeFn *)MatMult_Harmonic));
251157d50842SBarry Smith               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT_TRANSPOSE, (PetscErrorCodeFn *)MatMultTranspose_Harmonic));
25129bb5c669SPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AB, nullptr, MatProduct_AB_Harmonic, nullptr, MATDENSE, MATDENSE));
2513f21e3f8aSPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AtB, nullptr, MatProduct_AtB_Harmonic, nullptr, MATDENSE, MATDENSE));
251457d50842SBarry Smith               PetscCall(MatShellSetOperation(data->aux, MATOP_DESTROY, (PetscErrorCodeFn *)MatDestroy_Harmonic));
25159bb5c669SPierre Jolivet               PetscCall(MatDestroySubMatrices(1, &a));
25169bb5c669SPierre Jolivet             }
2517df21ef68SPierre Jolivet             if (overlap != 1 || !subdomains) {
2518df21ef68SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2519df21ef68SPierre Jolivet               if (ismatis) {
2520df21ef68SPierre Jolivet                 PetscCall(MatISGetLocalMat(C, &N));
2521df21ef68SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)N, MATSEQSBAIJ, &flg));
2522df21ef68SPierre Jolivet                 if (flg) PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2523df21ef68SPierre Jolivet                 PetscCall(MatISRestoreLocalMat(C, &N));
2524df21ef68SPierre Jolivet               }
2525df21ef68SPierre Jolivet             }
25269bb5c669SPierre Jolivet             if (uaux) {
25279bb5c669SPierre Jolivet               PetscCall(MatDestroy(&uaux));
25289bb5c669SPierre Jolivet               PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
25299bb5c669SPierre Jolivet             }
25309bb5c669SPierre Jolivet           }
253113044ca3SPierre Jolivet         }
253251ea4bc8SPierre Jolivet       } else if (!ctx) {
2533f1580f4eSBarry Smith         PetscCall(MatCreateSubMatrices(uaux, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2534f1580f4eSBarry Smith         PetscCall(MatDestroy(&uaux));
2535f1580f4eSBarry Smith         PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2536f1580f4eSBarry Smith       }
253751ea4bc8SPierre Jolivet       if (data->N > 1) {
2538f1580f4eSBarry Smith         /* Vec holding the partition of unity */
2539f1580f4eSBarry Smith         if (!data->levels[0]->D) {
2540f1580f4eSBarry Smith           PetscCall(ISGetLocalSize(data->is, &n));
2541f1580f4eSBarry Smith           PetscCall(VecCreateMPI(PETSC_COMM_SELF, n, PETSC_DETERMINE, &data->levels[0]->D));
2542f1580f4eSBarry Smith         }
25439bb5c669SPierre Jolivet         if (data->share && overlap == -1) {
2544f1580f4eSBarry Smith           Mat      D;
2545db4a47b3SPierre Jolivet           IS       perm = nullptr;
2546f1580f4eSBarry Smith           PetscInt size = -1;
2547811e8887SPierre Jolivet 
2548398c7888SPierre Jolivet           if (!data->levels[0]->pc) {
2549398c7888SPierre Jolivet             PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2550398c7888SPierre Jolivet             PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
2551398c7888SPierre Jolivet             PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
2552398c7888SPierre Jolivet             PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
2553398c7888SPierre Jolivet           }
2554398c7888SPierre Jolivet           PetscCall(PCSetType(data->levels[0]->pc, PCASM));
255513044ca3SPierre Jolivet           if (!ctx) {
2556398c7888SPierre Jolivet             if (!data->levels[0]->pc->setupcalled) {
2557398c7888SPierre Jolivet               IS sorted; /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2558398c7888SPierre Jolivet               PetscCall(ISDuplicate(is[0], &sorted));
2559398c7888SPierre Jolivet               PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &sorted, &loc));
2560398c7888SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)sorted));
2561398c7888SPierre Jolivet             }
2562398c7888SPierre Jolivet             PetscCall(PCSetFromOptions(data->levels[0]->pc));
2563398c7888SPierre Jolivet             if (block) {
2564398c7888SPierre Jolivet               PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, sub[0], &C, &perm));
2565398c7888SPierre Jolivet               PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, C, algebraic));
2566398c7888SPierre Jolivet             } else PetscCall(PCSetUp(data->levels[0]->pc));
2567db4a47b3SPierre Jolivet             PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &size, nullptr, &ksp));
2568398c7888SPierre Jolivet             if (size != 1) {
2569398c7888SPierre Jolivet               data->share = PETSC_FALSE;
2570398c7888SPierre Jolivet               PetscCheck(size == -1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", size);
2571398c7888SPierre Jolivet               PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since PCASMGetSubKSP() not found in fine-level PC\n"));
2572398c7888SPierre Jolivet               PetscCall(ISDestroy(&unsorted));
2573398c7888SPierre Jolivet               unsorted = is[0];
2574398c7888SPierre Jolivet             } else {
2575811e8887SPierre Jolivet               const char *matpre;
2576811e8887SPierre Jolivet               PetscBool   cmp[4];
2577811e8887SPierre Jolivet 
257813044ca3SPierre Jolivet               if (!block && !ctx) PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, PetscBool3ToBool(data->Neumann) ? sub[0] : data->aux, &C, &perm));
257951ea4bc8SPierre Jolivet               if (perm) { /* unsorted input IS */
2580c8ea6600SPierre Jolivet                 if (!PetscBool3ToBool(data->Neumann) && !block) {
2581f1580f4eSBarry Smith                   PetscCall(MatPermute(sub[0], perm, perm, &D)); /* permute since PCASM will call ISSort() */
2582f1580f4eSBarry Smith                   PetscCall(MatHeaderReplace(sub[0], &D));
2583f1580f4eSBarry Smith                 }
2584f1580f4eSBarry Smith                 if (data->B) { /* see PCHPDDMSetRHSMat() */
2585f1580f4eSBarry Smith                   PetscCall(MatPermute(data->B, perm, perm, &D));
2586f1580f4eSBarry Smith                   PetscCall(MatHeaderReplace(data->B, &D));
2587f1580f4eSBarry Smith                 }
2588f1580f4eSBarry Smith                 PetscCall(ISDestroy(&perm));
258951ea4bc8SPierre Jolivet               }
2590f1580f4eSBarry Smith               PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
25910307214fSPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)subA[0]));
2592f1580f4eSBarry Smith               PetscCall(MatDuplicate(subA[1], MAT_SHARE_NONZERO_PATTERN, &D));
2593f1580f4eSBarry Smith               PetscCall(MatGetOptionsPrefix(subA[1], &matpre));
2594f1580f4eSBarry Smith               PetscCall(MatSetOptionsPrefix(D, matpre));
2595f1580f4eSBarry Smith               PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMAL, cmp));
2596f1580f4eSBarry Smith               PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMAL, cmp + 1));
2597f1580f4eSBarry Smith               if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMALHERMITIAN, cmp + 2));
2598f1580f4eSBarry Smith               else cmp[2] = PETSC_FALSE;
2599f1580f4eSBarry Smith               if (!cmp[1]) PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMALHERMITIAN, cmp + 3));
2600f1580f4eSBarry Smith               else cmp[3] = PETSC_FALSE;
2601f1580f4eSBarry 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);
2602f1580f4eSBarry Smith               if (!cmp[0] && !cmp[2]) {
26038a8e6071SPierre Jolivet                 if (!block) {
26048a8e6071SPierre Jolivet                   if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckMatStructure_Private(pc, D, C));
26058a8e6071SPierre Jolivet                   PetscCall(MatAXPY(D, 1.0, C, SUBSET_NONZERO_PATTERN));
26068a8e6071SPierre Jolivet                 } else {
2607421480d9SBarry Smith                   structure = DIFFERENT_NONZERO_PATTERN;
26085c7345deSPierre Jolivet                   PetscCall(MatAXPY(D, 1.0, data->aux, structure));
26095c7345deSPierre Jolivet                 }
2610f1580f4eSBarry Smith               } else {
2611f1580f4eSBarry Smith                 Mat mat[2];
2612811e8887SPierre Jolivet 
2613f1580f4eSBarry Smith                 if (cmp[0]) {
2614f1580f4eSBarry Smith                   PetscCall(MatNormalGetMat(D, mat));
2615f1580f4eSBarry Smith                   PetscCall(MatNormalGetMat(C, mat + 1));
2616f1580f4eSBarry Smith                 } else {
2617f1580f4eSBarry Smith                   PetscCall(MatNormalHermitianGetMat(D, mat));
2618f1580f4eSBarry Smith                   PetscCall(MatNormalHermitianGetMat(C, mat + 1));
2619f1580f4eSBarry Smith                 }
2620f1580f4eSBarry Smith                 PetscCall(MatAXPY(mat[0], 1.0, mat[1], SUBSET_NONZERO_PATTERN));
2621f1580f4eSBarry Smith               }
2622f1580f4eSBarry Smith               PetscCall(MatPropagateSymmetryOptions(C, D));
2623f1580f4eSBarry Smith               PetscCall(MatDestroy(&C));
2624f1580f4eSBarry Smith               C = D;
2625f1580f4eSBarry Smith               /* swap pointers so that variables stay consistent throughout PCSetUp() */
2626f1580f4eSBarry Smith               std::swap(C, data->aux);
2627f1580f4eSBarry Smith               std::swap(uis, data->is);
2628f1580f4eSBarry Smith               swap = PETSC_TRUE;
2629f1580f4eSBarry Smith             }
2630f1580f4eSBarry Smith           }
263113044ca3SPierre Jolivet         }
263251ea4bc8SPierre Jolivet       }
263313044ca3SPierre Jolivet       if (ctx) {
263413044ca3SPierre Jolivet         PC_HPDDM              *data_00 = (PC_HPDDM *)std::get<0>(*ctx)[0]->data;
263513044ca3SPierre Jolivet         PC                     s;
263600b491fbSPierre Jolivet         Mat                    A00, P00, A01 = nullptr, A10, A11, N, b[4];
263707d8d47fSPierre Jolivet         IS                     sorted, is[2], *is_00;
263813044ca3SPierre Jolivet         MatSolverType          type;
263913044ca3SPierre Jolivet         std::pair<PC, Vec[2]> *p;
264013044ca3SPierre Jolivet 
264107d8d47fSPierre Jolivet         n = -1;
264207d8d47fSPierre Jolivet         PetscTryMethod(data_00->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data_00->levels[0]->pc, &n, nullptr, &ksp));
264307d8d47fSPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
264407d8d47fSPierre Jolivet         PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
264507d8d47fSPierre Jolivet         PetscCall(ISGetLocalSize(data_00->is, &n));
264607d8d47fSPierre Jolivet         if (n != subA[0]->rmap->n || n != subA[0]->cmap->n) {
264707d8d47fSPierre Jolivet           PetscCall(PCASMGetLocalSubdomains(data_00->levels[0]->pc, &n, &is_00, nullptr));
264807d8d47fSPierre Jolivet           PetscCall(ISGetLocalSize(*is_00, &n));
264907d8d47fSPierre 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);
265007d8d47fSPierre Jolivet         } else is_00 = &data_00->is;
265113044ca3SPierre Jolivet         PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, data->aux, &C, nullptr)); /* permute since PCASM works with a sorted IS */
265213044ca3SPierre Jolivet         std::swap(C, data->aux);
265313044ca3SPierre Jolivet         std::swap(uis, data->is);
265413044ca3SPierre Jolivet         swap = PETSC_TRUE;
265513044ca3SPierre Jolivet         PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, std::get<1>(*ctx), &A10, &A11));
265613044ca3SPierre Jolivet         std::get<1>(*ctx)[1] = A10;
265713044ca3SPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
265813044ca3SPierre Jolivet         if (flg) PetscCall(MatTransposeGetMat(A10, &A01));
265913044ca3SPierre Jolivet         else {
266013044ca3SPierre Jolivet           PetscBool flg;
266113044ca3SPierre Jolivet 
266213044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
266313044ca3SPierre Jolivet           if (flg) PetscCall(MatHermitianTransposeGetMat(A10, &A01));
266413044ca3SPierre Jolivet         }
266507d8d47fSPierre 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 */
266613044ca3SPierre Jolivet         PetscCall(ISSort(sorted));               /* this is to avoid changing users inputs, but it requires a new call to ISSort() here                                                                                               */
266700b491fbSPierre Jolivet         if (!A01) {
266800b491fbSPierre Jolivet           PetscCall(MatSetOption(A10, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
266900b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A10, 1, &data->is, &sorted, MAT_INITIAL_MATRIX, &sub));
267000b491fbSPierre Jolivet           b[2] = sub[0];
267100b491fbSPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
267200b491fbSPierre Jolivet           PetscCall(MatDestroySubMatrices(1, &sub));
267300b491fbSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATTRANSPOSEVIRTUAL, &flg));
267400b491fbSPierre Jolivet           A10 = nullptr;
267500b491fbSPierre Jolivet           if (flg) PetscCall(MatTransposeGetMat(std::get<1>(*ctx)[0], &A10));
267613044ca3SPierre Jolivet           else {
267700b491fbSPierre Jolivet             PetscBool flg;
267800b491fbSPierre Jolivet 
2679c71f06a7SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATHERMITIANTRANSPOSEVIRTUAL, &flg));
268000b491fbSPierre Jolivet             if (flg) PetscCall(MatHermitianTransposeGetMat(std::get<1>(*ctx)[0], &A10));
268113044ca3SPierre Jolivet           }
2682811e8887SPierre Jolivet           if (!A10) PetscCall(MatCreateSubMatrices(std::get<1>(*ctx)[0], 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2683811e8887SPierre Jolivet           else {
2684811e8887SPierre Jolivet             if (flg) PetscCall(MatCreateTranspose(b[2], b + 1));
2685811e8887SPierre Jolivet             else PetscCall(MatCreateHermitianTranspose(b[2], b + 1));
268600b491fbSPierre Jolivet           }
268700b491fbSPierre Jolivet         } else {
268800b491fbSPierre Jolivet           PetscCall(MatSetOption(A01, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
268900b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A01, 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2690811e8887SPierre Jolivet           if (flg) PetscCall(MatCreateTranspose(*sub, b + 2));
2691811e8887SPierre Jolivet           else PetscCall(MatCreateHermitianTranspose(*sub, b + 2));
2692811e8887SPierre Jolivet         }
2693811e8887SPierre Jolivet         if (A01 || !A10) {
2694811e8887SPierre Jolivet           b[1] = sub[0];
2695811e8887SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
269600b491fbSPierre Jolivet         }
269700b491fbSPierre Jolivet         PetscCall(MatDestroySubMatrices(1, &sub));
269813044ca3SPierre Jolivet         PetscCall(ISDestroy(&sorted));
269951ea4bc8SPierre Jolivet         b[3] = data->aux;
270051ea4bc8SPierre Jolivet         PetscCall(MatCreateSchurComplement(subA[0], subA[1], b[1], b[2], b[3], &S));
270113044ca3SPierre Jolivet         PetscCall(MatSchurComplementSetKSP(S, ksp[0]));
270251ea4bc8SPierre Jolivet         if (data->N != 1) {
270351ea4bc8SPierre Jolivet           PetscCall(PCASMSetType(data->levels[0]->pc, PC_ASM_NONE)); /* "Neumann--Neumann" preconditioning with overlap and a Boolean partition of unity */
270451ea4bc8SPierre Jolivet           PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &data->is, &loc));
270551ea4bc8SPierre Jolivet           PetscCall(PCSetFromOptions(data->levels[0]->pc)); /* action of eq. (15) of https://hal.science/hal-02343808v6/document (with a sign flip) */
270651ea4bc8SPierre Jolivet           s = data->levels[0]->pc;
270751ea4bc8SPierre Jolivet         } else {
270851ea4bc8SPierre Jolivet           is[0] = data->is;
270951ea4bc8SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)is[0]));
271051ea4bc8SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)b[3]));
271151ea4bc8SPierre Jolivet           PetscCall(PCSetType(pc, PCASM));                          /* change the type of the current PC */
271251ea4bc8SPierre Jolivet           data = nullptr;                                           /* destroyed in the previous PCSetType(), so reset to NULL to avoid any faulty use */
271351ea4bc8SPierre Jolivet           PetscCall(PCAppendOptionsPrefix(pc, "pc_hpddm_coarse_")); /* same prefix as when using PCHPDDM with a single level */
271451ea4bc8SPierre Jolivet           PetscCall(PCASMSetLocalSubdomains(pc, 1, is, &loc));
271551ea4bc8SPierre Jolivet           PetscCall(ISDestroy(is));
271651ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&loc));
271751ea4bc8SPierre Jolivet           s = pc;
271851ea4bc8SPierre Jolivet         }
271951ea4bc8SPierre Jolivet         PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(s, S, PETSC_TRUE)); /* the subdomain Mat is already known and the input IS of PCASMSetLocalSubdomains() is already sorted */
272051ea4bc8SPierre Jolivet         PetscTryMethod(s, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (s, &n, nullptr, &ksp));
272113044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
272213044ca3SPierre Jolivet         PetscCall(KSPGetPC(ksp[0], &inner));
272313044ca3SPierre Jolivet         PetscCall(PCSetType(inner, PCSHELL)); /* compute the action of the inverse of the local Schur complement with a PCSHELL */
272413044ca3SPierre Jolivet         b[0] = subA[0];
272513044ca3SPierre 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 */
272651ea4bc8SPierre Jolivet         if (!data) PetscCall(PetscObjectDereference((PetscObject)b[3]));
272700b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[1]));
272800b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[2]));
272913044ca3SPierre Jolivet         PetscCall(PCCreate(PETSC_COMM_SELF, &s));
273013044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(s, ((PetscObject)inner)->prefix));
273113044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(inner, nullptr));
273213044ca3SPierre Jolivet         PetscCall(KSPSetSkipPCSetFromOptions(ksp[0], PETSC_TRUE));
273313044ca3SPierre Jolivet         PetscCall(PCSetType(s, PCLU));
273451ea4bc8SPierre Jolivet         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(s, MATSOLVERMUMPS)); /* only MATSOLVERMUMPS handles MATNEST, so for the others, e.g., MATSOLVERPETSC or MATSOLVERMKL_PARDISO, convert to plain MATAIJ */
273513044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(s));
273613044ca3SPierre Jolivet         PetscCall(PCFactorGetMatSolverType(s, &type));
273713044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
273851ea4bc8SPierre Jolivet         PetscCall(MatGetLocalSize(A11, &n, nullptr));
273951ea4bc8SPierre Jolivet         if (flg || n == 0) {
274013044ca3SPierre Jolivet           PetscCall(PCSetOperators(s, N, N));
274151ea4bc8SPierre Jolivet           if (n) {
274200b491fbSPierre Jolivet             PetscCall(PCFactorGetMatrix(s, b));
274300b491fbSPierre Jolivet             PetscCall(MatSetOptionsPrefix(*b, ((PetscObject)s)->prefix));
274424ddd604SPierre Jolivet             n = -1;
2745*8dc3fbeeSPierre Jolivet             PetscCall(PetscOptionsGetInt(((PetscObject)pc)->options, ((PetscObject)s)->prefix, "-mat_mumps_icntl_26", &n, nullptr));
2746f45b553cSPierre Jolivet             if (n == 1) {                                /* allocates a square MatDense of size is[1]->map->n, so one */
2747f45b553cSPierre Jolivet               PetscCall(MatNestGetISs(N, is, nullptr));  /*  needs to be able to deactivate this path when dealing    */
2748f45b553cSPierre Jolivet               PetscCall(MatFactorSetSchurIS(*b, is[1])); /*  with a large constraint space in order to avoid OOM      */
2749f45b553cSPierre Jolivet             }
275051ea4bc8SPierre Jolivet           } else PetscCall(PCSetType(s, PCNONE)); /* empty local Schur complement (e.g., centralized on another process) */
275113044ca3SPierre Jolivet         } else {
275200b491fbSPierre Jolivet           PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, b));
275300b491fbSPierre Jolivet           PetscCall(PCSetOperators(s, N, *b));
275400b491fbSPierre Jolivet           PetscCall(PetscObjectDereference((PetscObject)*b));
275551ea4bc8SPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)s, &flg, PCLU, PCCHOLESKY, PCILU, PCICC, PCQR, ""));
275651ea4bc8SPierre Jolivet           if (flg) 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 */
275713044ca3SPierre Jolivet         }
275813044ca3SPierre Jolivet         PetscCall(PetscNew(&p));
275913044ca3SPierre Jolivet         p->first = s;
276051ea4bc8SPierre Jolivet         if (n != 0) PetscCall(MatCreateVecs(*b, p->second, p->second + 1));
276151ea4bc8SPierre Jolivet         else p->second[0] = p->second[1] = nullptr;
276213044ca3SPierre Jolivet         PetscCall(PCShellSetContext(inner, p));
276313044ca3SPierre Jolivet         PetscCall(PCShellSetApply(inner, PCApply_Nest));
276413044ca3SPierre Jolivet         PetscCall(PCShellSetView(inner, PCView_Nest));
276513044ca3SPierre Jolivet         PetscCall(PCShellSetDestroy(inner, PCDestroy_Nest));
276613044ca3SPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)N));
276751ea4bc8SPierre Jolivet         if (!data) {
276851ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&S));
276951ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&unsorted));
277051ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&C));
277151ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&uis));
277251ea4bc8SPierre Jolivet           PetscCall(PetscFree(ctx));
277351ea4bc8SPierre Jolivet #if PetscDefined(USE_DEBUG)
277451ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&dis));
277551ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&daux));
277651ea4bc8SPierre Jolivet #endif
277751ea4bc8SPierre Jolivet           PetscFunctionReturn(PETSC_SUCCESS);
277851ea4bc8SPierre Jolivet         }
277913044ca3SPierre Jolivet       }
2780f1580f4eSBarry Smith       if (!data->levels[0]->scatter) {
2781db4a47b3SPierre Jolivet         PetscCall(MatCreateVecs(P, &xin, nullptr));
2782f1580f4eSBarry Smith         if (ismatis) PetscCall(MatDestroy(&P));
2783db4a47b3SPierre Jolivet         PetscCall(VecScatterCreate(xin, data->is, data->levels[0]->D, nullptr, &data->levels[0]->scatter));
2784f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
2785f1580f4eSBarry Smith       }
2786f1580f4eSBarry Smith       if (data->levels[0]->P) {
2787f1580f4eSBarry Smith         /* if the pattern is the same and PCSetUp() has previously succeeded, reuse HPDDM buffers and connectivity */
2788371d2eb7SMartin Diehl         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[0], !pc->setupcalled || pc->flag == DIFFERENT_NONZERO_PATTERN ? PETSC_TRUE : PETSC_FALSE));
2789f1580f4eSBarry Smith       }
2790f1580f4eSBarry Smith       if (!data->levels[0]->P) data->levels[0]->P = new HPDDM::Schwarz<PetscScalar>();
2791db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2792db4a47b3SPierre Jolivet       else PetscCall(PetscLogEventBegin(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2793f1580f4eSBarry Smith       /* HPDDM internal data structure */
279413044ca3SPierre Jolivet       PetscCall(data->levels[0]->P->structure(loc, data->is, !ctx ? sub[0] : nullptr, ismatis ? C : data->aux, data->levels));
2795db4a47b3SPierre Jolivet       if (!data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2796f1580f4eSBarry Smith       /* matrix pencil of the generalized eigenvalue problem on the overlap (GenEO) */
279713044ca3SPierre Jolivet       if (!ctx) {
27989bb5c669SPierre Jolivet         if (data->deflation || overlap != -1) weighted = data->aux;
2799f1580f4eSBarry Smith         else if (!data->B) {
2800e2b46ddfSPierre Jolivet           PetscBool cmp;
2801811e8887SPierre Jolivet 
2802f1580f4eSBarry Smith           PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &weighted));
2803e2b46ddfSPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)weighted, &cmp, MATNORMAL, MATNORMALHERMITIAN, ""));
2804e2b46ddfSPierre Jolivet           if (cmp) flg = PETSC_FALSE;
2805e2b46ddfSPierre Jolivet           PetscCall(MatDiagonalScale(weighted, data->levels[0]->D, data->levels[0]->D));
28065b0bb9f2SPierre Jolivet           /* neither MatDuplicate() nor MatDiagonalScale() handles the symmetry options, so propagate the options explicitly */
2807f1580f4eSBarry Smith           /* only useful for -mat_type baij -pc_hpddm_levels_1_st_pc_type cholesky (no problem with MATAIJ or MATSBAIJ)      */
2808f1580f4eSBarry Smith           PetscCall(MatPropagateSymmetryOptions(sub[0], weighted));
28096d61d5b2SPierre Jolivet           if (PetscDefined(USE_DEBUG) && PetscBool3ToBool(data->Neumann)) {
28106d61d5b2SPierre Jolivet             Mat      *sub, A[3];
28116d61d5b2SPierre Jolivet             PetscReal norm[2];
28126d61d5b2SPierre Jolivet             PetscBool flg;
28136d61d5b2SPierre Jolivet 
28146d61d5b2SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg)); /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIAIJ */
28156d61d5b2SPierre Jolivet             if (flg) PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, A));
28166d61d5b2SPierre Jolivet             else {
28176d61d5b2SPierre Jolivet               A[0] = P;
28186d61d5b2SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)P));
28196d61d5b2SPierre Jolivet             }
28206d61d5b2SPierre Jolivet             PetscCall(MatCreateSubMatrices(A[0], 1, &data->is, &data->is, MAT_INITIAL_MATRIX, &sub));
28216d61d5b2SPierre Jolivet             PetscCall(MatDiagonalScale(sub[0], data->levels[0]->D, data->levels[0]->D));
28226d61d5b2SPierre Jolivet             PetscCall(MatConvert(sub[0], MATSEQAIJ, MAT_INITIAL_MATRIX, A + 1)); /* too many corner cases to handle (MATNORMAL, MATNORMALHERMITIAN, MATBAIJ with different block sizes...), so just MatConvert() to MATSEQAIJ since this is just for debugging */
28236d61d5b2SPierre Jolivet             PetscCall(MatConvert(weighted, MATSEQAIJ, MAT_INITIAL_MATRIX, A + 2));
28246d61d5b2SPierre Jolivet             PetscCall(MatAXPY(A[1], -1.0, A[2], UNKNOWN_NONZERO_PATTERN));
28256d61d5b2SPierre Jolivet             PetscCall(MatNorm(A[1], NORM_FROBENIUS, norm));
28266d61d5b2SPierre Jolivet             if (norm[0]) {
28276d61d5b2SPierre Jolivet               PetscCall(MatNorm(A[2], NORM_FROBENIUS, norm + 1));
28286d61d5b2SPierre Jolivet               PetscCheck(PetscAbsReal(norm[0] / norm[1]) < PetscSqrtReal(PETSC_SMALL), PETSC_COMM_SELF, PETSC_ERR_USER_INPUT, "Auxiliary Mat is different from the (assembled) subdomain Mat for the interior unknowns, so it cannot be the Neumann matrix, remove -%spc_hpddm_has_neumann", pcpre ? pcpre : "");
28296d61d5b2SPierre Jolivet             }
28306d61d5b2SPierre Jolivet             PetscCall(MatDestroySubMatrices(1, &sub));
28316d61d5b2SPierre Jolivet             for (PetscInt i = 0; i < 3; ++i) PetscCall(MatDestroy(A + i));
28326d61d5b2SPierre Jolivet           }
2833f1580f4eSBarry Smith         } else weighted = data->B;
283413044ca3SPierre Jolivet       } else weighted = nullptr;
2835f1580f4eSBarry Smith       /* SLEPc is used inside the loaded symbol */
28369bb5c669SPierre 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));
28379bb5c669SPierre Jolivet       if (!ctx && data->share && overlap == -1) {
2838f1580f4eSBarry Smith         Mat st[2];
28396d61d5b2SPierre Jolivet 
2840f1580f4eSBarry Smith         PetscCall(KSPGetOperators(ksp[0], st, st + 1));
28415c7345deSPierre Jolivet         PetscCall(MatCopy(subA[0], st[0], structure));
2842f1580f4eSBarry Smith         if (subA[1] != subA[0] || st[1] != st[0]) PetscCall(MatCopy(subA[1], st[1], SAME_NONZERO_PATTERN));
28430307214fSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)subA[0]));
2844f1580f4eSBarry Smith       }
2845db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2846f1580f4eSBarry Smith       if (ismatis) PetscCall(MatISGetLocalMat(C, &N));
2847f1580f4eSBarry Smith       else N = data->aux;
284813044ca3SPierre Jolivet       if (!ctx) P = sub[0];
284913044ca3SPierre Jolivet       else P = S;
2850f1580f4eSBarry Smith       /* going through the grid hierarchy */
2851f1580f4eSBarry Smith       for (n = 1; n < data->N; ++n) {
2852db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2853f1580f4eSBarry Smith         /* method composed in the loaded symbol since there, SLEPc is used as well */
2854f1580f4eSBarry 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));
2855db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2856f1580f4eSBarry Smith       }
2857f1580f4eSBarry Smith       /* reset to NULL to avoid any faulty use */
2858db4a47b3SPierre Jolivet       PetscCall(PetscObjectComposeFunction((PetscObject)data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", nullptr));
2859db4a47b3SPierre Jolivet       if (!ismatis) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_C", nullptr));
2860f1580f4eSBarry Smith       else PetscCall(PetscObjectDereference((PetscObject)C)); /* matching PetscObjectReference() above */
2861f1580f4eSBarry Smith       for (n = 0; n < data->N - 1; ++n)
2862f1580f4eSBarry Smith         if (data->levels[n]->P) {
2863f1580f4eSBarry Smith           /* HPDDM internal work buffers */
2864f1580f4eSBarry Smith           data->levels[n]->P->setBuffer();
2865f1580f4eSBarry Smith           data->levels[n]->P->super::start();
2866f1580f4eSBarry Smith         }
28679bb5c669SPierre Jolivet       if (ismatis || !subdomains) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
2868db4a47b3SPierre Jolivet       if (ismatis) data->is = nullptr;
2869f1580f4eSBarry Smith       for (n = 0; n < data->N - 1 + (reused > 0); ++n) {
2870f1580f4eSBarry Smith         if (data->levels[n]->P) {
2871f1580f4eSBarry Smith           PC spc;
2872f1580f4eSBarry Smith 
2873f1580f4eSBarry Smith           /* force the PC to be PCSHELL to do the coarse grid corrections */
2874f1580f4eSBarry Smith           PetscCall(KSPSetSkipPCSetFromOptions(data->levels[n]->ksp, PETSC_TRUE));
2875f1580f4eSBarry Smith           PetscCall(KSPGetPC(data->levels[n]->ksp, &spc));
2876f1580f4eSBarry Smith           PetscCall(PCSetType(spc, PCSHELL));
2877f1580f4eSBarry Smith           PetscCall(PCShellSetContext(spc, data->levels[n]));
2878f1580f4eSBarry Smith           PetscCall(PCShellSetSetUp(spc, PCSetUp_HPDDMShell));
2879f1580f4eSBarry Smith           PetscCall(PCShellSetApply(spc, PCApply_HPDDMShell));
2880f1580f4eSBarry Smith           PetscCall(PCShellSetMatApply(spc, PCMatApply_HPDDMShell));
2881d4f06b61SRaphael Zanella           PetscCall(PCShellSetApplyTranspose(spc, PCApplyTranspose_HPDDMShell));
28828cb7430dSRaphael Zanella           PetscCall(PCShellSetMatApplyTranspose(spc, PCMatApplyTranspose_HPDDMShell));
288313044ca3SPierre Jolivet           if (ctx && n == 0) {
288413044ca3SPierre Jolivet             Mat                               Amat, Pmat;
288513044ca3SPierre Jolivet             PetscInt                          m, M;
288601e3c840SPierre Jolivet             std::tuple<Mat, PetscSF, Vec[2]> *ctx;
288713044ca3SPierre Jolivet 
288813044ca3SPierre Jolivet             PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &Pmat));
288913044ca3SPierre Jolivet             PetscCall(MatGetLocalSize(Pmat, &m, nullptr));
289013044ca3SPierre Jolivet             PetscCall(MatGetSize(Pmat, &M, nullptr));
289113044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));
289213044ca3SPierre Jolivet             std::get<0>(*ctx) = S;
289313044ca3SPierre Jolivet             std::get<1>(*ctx) = data->levels[n]->scatter;
289413044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)data->levels[n]->ksp), m, m, M, M, ctx, &Amat));
289557d50842SBarry Smith             PetscCall(MatShellSetOperation(Amat, MATOP_MULT, (PetscErrorCodeFn *)MatMult_Schur<false>));
289657d50842SBarry Smith             PetscCall(MatShellSetOperation(Amat, MATOP_MULT_TRANSPOSE, (PetscErrorCodeFn *)MatMult_Schur<true>));
289757d50842SBarry Smith             PetscCall(MatShellSetOperation(Amat, MATOP_DESTROY, (PetscErrorCodeFn *)MatDestroy_Schur));
289813044ca3SPierre Jolivet             PetscCall(MatCreateVecs(S, std::get<2>(*ctx), std::get<2>(*ctx) + 1));
289913044ca3SPierre Jolivet             PetscCall(KSPSetOperators(data->levels[n]->ksp, Amat, Pmat));
290013044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)Amat));
290113044ca3SPierre Jolivet           }
2902f1580f4eSBarry Smith           PetscCall(PCShellSetDestroy(spc, PCDestroy_HPDDMShell));
2903f1580f4eSBarry Smith           if (!data->levels[n]->pc) PetscCall(PCCreate(PetscObjectComm((PetscObject)data->levels[n]->ksp), &data->levels[n]->pc));
2904f1580f4eSBarry Smith           if (n < reused) {
2905f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(spc, PETSC_TRUE));
2906f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
2907f1580f4eSBarry Smith           }
2908f1580f4eSBarry Smith           PetscCall(PCSetUp(spc));
2909f1580f4eSBarry Smith         }
2910f1580f4eSBarry Smith       }
291113044ca3SPierre Jolivet       if (ctx) PetscCall(MatDestroy(&S));
29129bb5c669SPierre Jolivet       if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", nullptr));
2913f1580f4eSBarry Smith     } else flg = reused ? PETSC_FALSE : PETSC_TRUE;
2914f1580f4eSBarry Smith     if (!ismatis && subdomains) {
2915f1580f4eSBarry Smith       if (flg) PetscCall(KSPGetPC(data->levels[0]->ksp, &inner));
2916f1580f4eSBarry Smith       else inner = data->levels[0]->pc;
2917f1580f4eSBarry Smith       if (inner) {
2918398c7888SPierre Jolivet         if (!inner->setupcalled) PetscCall(PCSetType(inner, PCASM));
2919398c7888SPierre Jolivet         PetscCall(PCSetFromOptions(inner));
2920398c7888SPierre Jolivet         PetscCall(PetscStrcmp(((PetscObject)inner)->type_name, PCASM, &flg));
2921398c7888SPierre Jolivet         if (flg) {
2922f1580f4eSBarry Smith           if (!inner->setupcalled) { /* evaluates to PETSC_FALSE when -pc_hpddm_block_splitting */
2923398c7888SPierre Jolivet             IS sorted;               /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2924811e8887SPierre Jolivet 
2925398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2926398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(inner, 1, &sorted, &loc));
2927398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2928398c7888SPierre Jolivet           }
2929c8ea6600SPierre Jolivet           if (!PetscBool3ToBool(data->Neumann) && data->N > 1) { /* subdomain matrices are already created for the eigenproblem, reuse them for the fine-level PC */
2930db4a47b3SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(*is, nullptr, nullptr, sub[0], &P, nullptr));
2931398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(inner, P, algebraic));
2932398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)P));
2933f1580f4eSBarry Smith           }
2934f1580f4eSBarry Smith         }
2935f1580f4eSBarry Smith       }
29369bb5c669SPierre Jolivet       if (data->N > 1) {
29379bb5c669SPierre Jolivet         if (overlap != 1) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
29389bb5c669SPierre Jolivet         if (overlap == 1) PetscCall(MatDestroy(subA));
29399bb5c669SPierre Jolivet       }
2940f1580f4eSBarry Smith     }
2941f1580f4eSBarry Smith     PetscCall(ISDestroy(&loc));
2942f1580f4eSBarry Smith   } else data->N = 1 + reused; /* enforce this value to 1 + reused if there is no way to build another level */
2943f1580f4eSBarry Smith   if (requested != data->N + reused) {
2944f1580f4eSBarry 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,
2945f1580f4eSBarry Smith                         data->N, pcpre ? pcpre : ""));
2946b5a302b3SPierre Jolivet     PetscCall(PetscInfo(pc, "It is best to tune parameters, e.g., a higher value for -%spc_hpddm_levels_%" PetscInt_FMT "_eps_threshold_absolute or a lower value for -%spc_hpddm_levels_%" PetscInt_FMT "_svd_threshold_relative, so that at least one local deflation vector will be selected\n", pcpre ? pcpre : "",
2947b5a302b3SPierre Jolivet                         data->N, pcpre ? pcpre : "", data->N));
2948f1580f4eSBarry Smith     /* cannot use PCDestroy_HPDDMShell() because PCSHELL not set for unassembled levels */
2949f1580f4eSBarry Smith     for (n = data->N - 1; n < requested - 1; ++n) {
2950f1580f4eSBarry Smith       if (data->levels[n]->P) {
2951f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[n], PETSC_TRUE));
2952f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(1, &data->levels[n]->v[0]));
2953f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(2, &data->levels[n]->v[1]));
2954f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V));
2955f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 1));
2956f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 2));
2957f1580f4eSBarry Smith         PetscCall(VecDestroy(&data->levels[n]->D));
295801e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&data->levels[n]->scatter));
2959f1580f4eSBarry Smith       }
2960f1580f4eSBarry Smith     }
2961f1580f4eSBarry Smith     if (reused) {
2962f1580f4eSBarry Smith       for (n = reused; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
2963f1580f4eSBarry Smith         PetscCall(KSPDestroy(&data->levels[n]->ksp));
2964f1580f4eSBarry Smith         PetscCall(PCDestroy(&data->levels[n]->pc));
2965f1580f4eSBarry Smith       }
2966f1580f4eSBarry Smith     }
2967b5a302b3SPierre Jolivet     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 or a lower value for -%spc_hpddm_levels_%" PetscInt_FMT "_svd_threshold_relative, 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,
2968b5a302b3SPierre Jolivet                data->N, reused, data->N, pcpre ? pcpre : "", pcpre ? pcpre : "", data->N, pcpre ? pcpre : "", data->N);
2969f1580f4eSBarry Smith   }
2970f1580f4eSBarry Smith   /* these solvers are created after PCSetFromOptions() is called */
2971f1580f4eSBarry Smith   if (pc->setfromoptionscalled) {
2972f1580f4eSBarry Smith     for (n = 0; n < data->N; ++n) {
2973f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetFromOptions(data->levels[n]->ksp));
2974f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetFromOptions(data->levels[n]->pc));
2975f1580f4eSBarry Smith     }
2976f1580f4eSBarry Smith     pc->setfromoptionscalled = 0;
2977f1580f4eSBarry Smith   }
2978f1580f4eSBarry Smith   data->N += reused;
2979f1580f4eSBarry Smith   if (data->share && swap) {
2980f1580f4eSBarry Smith     /* swap back pointers so that variables follow the user-provided numbering */
2981f1580f4eSBarry Smith     std::swap(C, data->aux);
2982f1580f4eSBarry Smith     std::swap(uis, data->is);
2983f1580f4eSBarry Smith     PetscCall(MatDestroy(&C));
2984f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
2985f1580f4eSBarry Smith   }
2986398c7888SPierre Jolivet   if (algebraic) PetscCall(MatDestroy(&data->aux));
298738fb34a1SPierre Jolivet   if (unsorted && unsorted != is[0]) {
2988398c7888SPierre Jolivet     PetscCall(ISCopy(unsorted, data->is));
2989398c7888SPierre Jolivet     PetscCall(ISDestroy(&unsorted));
2990398c7888SPierre Jolivet   }
2991398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2992398c7888SPierre 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);
2993398c7888SPierre Jolivet   if (data->is) {
2994398c7888SPierre Jolivet     PetscCall(ISEqualUnsorted(data->is, dis, &flg));
2995398c7888SPierre Jolivet     PetscCall(ISDestroy(&dis));
2996398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input IS and output IS are not equal");
2997398c7888SPierre Jolivet   }
2998398c7888SPierre 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);
2999398c7888SPierre Jolivet   if (data->aux) {
3000398c7888SPierre Jolivet     PetscCall(MatMultEqual(data->aux, daux, 20, &flg));
3001398c7888SPierre Jolivet     PetscCall(MatDestroy(&daux));
3002398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input Mat and output Mat are not equal");
3003398c7888SPierre Jolivet   }
3004398c7888SPierre Jolivet #endif
30053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3006f1580f4eSBarry Smith }
3007f1580f4eSBarry Smith 
3008f1580f4eSBarry Smith /*@
3009f1580f4eSBarry Smith   PCHPDDMSetCoarseCorrectionType - Sets the coarse correction type.
3010f1580f4eSBarry Smith 
3011c3339decSBarry Smith   Collective
3012f1580f4eSBarry Smith 
3013f1580f4eSBarry Smith   Input Parameters:
3014f1580f4eSBarry Smith + pc   - preconditioner context
3015aa1539e9SPierre Jolivet - type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
3016f1580f4eSBarry Smith 
3017f1580f4eSBarry Smith   Options Database Key:
3018aa1539e9SPierre Jolivet . -pc_hpddm_coarse_correction <deflated, additive, balanced, none> - type of coarse correction to apply
3019f1580f4eSBarry Smith 
3020f1580f4eSBarry Smith   Level: intermediate
3021f1580f4eSBarry Smith 
3022562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
3023f1580f4eSBarry Smith @*/
3024d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType type)
3025d71ae5a4SJacob Faibussowitsch {
3026f1580f4eSBarry Smith   PetscFunctionBegin;
3027f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3028f1580f4eSBarry Smith   PetscValidLogicalCollectiveEnum(pc, type, 2);
3029f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMSetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType), (pc, type));
30303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3031f1580f4eSBarry Smith }
3032f1580f4eSBarry Smith 
3033f1580f4eSBarry Smith /*@
3034f1580f4eSBarry Smith   PCHPDDMGetCoarseCorrectionType - Gets the coarse correction type.
3035f1580f4eSBarry Smith 
3036f1580f4eSBarry Smith   Input Parameter:
3037f1580f4eSBarry Smith . pc - preconditioner context
3038f1580f4eSBarry Smith 
3039f1580f4eSBarry Smith   Output Parameter:
3040aa1539e9SPierre Jolivet . type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
3041f1580f4eSBarry Smith 
3042f1580f4eSBarry Smith   Level: intermediate
3043f1580f4eSBarry Smith 
3044562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
3045f1580f4eSBarry Smith @*/
3046d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType *type)
3047d71ae5a4SJacob Faibussowitsch {
3048f1580f4eSBarry Smith   PetscFunctionBegin;
3049f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3050f1580f4eSBarry Smith   if (type) {
30514f572ea9SToby Isaac     PetscAssertPointer(type, 2);
3052f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType *), (pc, type));
3053f1580f4eSBarry Smith   }
30543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3055f1580f4eSBarry Smith }
3056f1580f4eSBarry Smith 
3057d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType type)
3058d71ae5a4SJacob Faibussowitsch {
3059f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
3060f1580f4eSBarry Smith 
3061f1580f4eSBarry Smith   PetscFunctionBegin;
3062f1580f4eSBarry Smith   data->correction = type;
30633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3064f1580f4eSBarry Smith }
3065f1580f4eSBarry Smith 
3066d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType *type)
3067d71ae5a4SJacob Faibussowitsch {
3068f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
3069f1580f4eSBarry Smith 
3070f1580f4eSBarry Smith   PetscFunctionBegin;
3071f1580f4eSBarry Smith   *type = data->correction;
30723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3073f1580f4eSBarry Smith }
3074f1580f4eSBarry Smith 
3075f1580f4eSBarry Smith /*@
3076e31fc274SPierre Jolivet   PCHPDDMSetSTShareSubKSP - Sets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver should be shared.
3077e31fc274SPierre Jolivet 
3078e31fc274SPierre Jolivet   Input Parameters:
3079e31fc274SPierre Jolivet + pc    - preconditioner context
3080e31fc274SPierre Jolivet - share - whether the `KSP` should be shared or not
3081e31fc274SPierre Jolivet 
3082e31fc274SPierre Jolivet   Note:
3083e31fc274SPierre Jolivet   This is not the same as `PCSetReusePreconditioner()`. Given certain conditions (visible using -info), a symbolic factorization can be skipped
3084e31fc274SPierre Jolivet   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
3085e31fc274SPierre Jolivet 
3086e31fc274SPierre Jolivet   Level: advanced
3087e31fc274SPierre Jolivet 
3088562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMGetSTShareSubKSP()`
3089e31fc274SPierre Jolivet @*/
3090e31fc274SPierre Jolivet PetscErrorCode PCHPDDMSetSTShareSubKSP(PC pc, PetscBool share)
3091e31fc274SPierre Jolivet {
3092e31fc274SPierre Jolivet   PetscFunctionBegin;
3093e31fc274SPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3094e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetSTShareSubKSP_C", (PC, PetscBool), (pc, share));
30953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3096e31fc274SPierre Jolivet }
3097e31fc274SPierre Jolivet 
3098e31fc274SPierre Jolivet /*@
3099f1580f4eSBarry Smith   PCHPDDMGetSTShareSubKSP - Gets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver is shared.
3100f1580f4eSBarry Smith 
3101f1580f4eSBarry Smith   Input Parameter:
3102f1580f4eSBarry Smith . pc - preconditioner context
3103f1580f4eSBarry Smith 
3104f1580f4eSBarry Smith   Output Parameter:
3105f1580f4eSBarry Smith . share - whether the `KSP` is shared or not
3106f1580f4eSBarry Smith 
3107f1580f4eSBarry Smith   Note:
3108f1580f4eSBarry 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
3109f1580f4eSBarry Smith   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
3110f1580f4eSBarry Smith 
3111f1580f4eSBarry Smith   Level: advanced
3112f1580f4eSBarry Smith 
3113562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetSTShareSubKSP()`
3114f1580f4eSBarry Smith @*/
3115d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetSTShareSubKSP(PC pc, PetscBool *share)
3116d71ae5a4SJacob Faibussowitsch {
3117f1580f4eSBarry Smith   PetscFunctionBegin;
3118f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3119f1580f4eSBarry Smith   if (share) {
31204f572ea9SToby Isaac     PetscAssertPointer(share, 2);
3121f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetSTShareSubKSP_C", (PC, PetscBool *), (pc, share));
3122f1580f4eSBarry Smith   }
31233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3124f1580f4eSBarry Smith }
3125f1580f4eSBarry Smith 
3126e31fc274SPierre Jolivet static PetscErrorCode PCHPDDMSetSTShareSubKSP_HPDDM(PC pc, PetscBool share)
3127e31fc274SPierre Jolivet {
3128e31fc274SPierre Jolivet   PC_HPDDM *data = (PC_HPDDM *)pc->data;
3129e31fc274SPierre Jolivet 
3130e31fc274SPierre Jolivet   PetscFunctionBegin;
3131e31fc274SPierre Jolivet   data->share = share;
31323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3133e31fc274SPierre Jolivet }
3134e31fc274SPierre Jolivet 
3135d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetSTShareSubKSP_HPDDM(PC pc, PetscBool *share)
3136d71ae5a4SJacob Faibussowitsch {
3137f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
3138f1580f4eSBarry Smith 
3139f1580f4eSBarry Smith   PetscFunctionBegin;
3140f1580f4eSBarry Smith   *share = data->share;
31413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3142f1580f4eSBarry Smith }
3143f1580f4eSBarry Smith 
3144f1580f4eSBarry Smith /*@
3145f1580f4eSBarry Smith   PCHPDDMSetDeflationMat - Sets the deflation space used to assemble a coarser operator.
3146f1580f4eSBarry Smith 
3147f1580f4eSBarry Smith   Input Parameters:
3148f1580f4eSBarry Smith + pc - preconditioner context
3149f1580f4eSBarry Smith . is - index set of the local deflation matrix
3150f1580f4eSBarry Smith - U  - deflation sequential matrix stored as a `MATSEQDENSE`
3151f1580f4eSBarry Smith 
3152f1580f4eSBarry Smith   Level: advanced
3153f1580f4eSBarry Smith 
3154562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCDeflationSetSpace()`, `PCMGSetRestriction()`
3155f1580f4eSBarry Smith @*/
3156d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetDeflationMat(PC pc, IS is, Mat U)
3157d71ae5a4SJacob Faibussowitsch {
3158f1580f4eSBarry Smith   PetscFunctionBegin;
3159f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3160f1580f4eSBarry Smith   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
3161f1580f4eSBarry Smith   PetscValidHeaderSpecific(U, MAT_CLASSID, 3);
3162e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetDeflationMat_C", (PC, IS, Mat), (pc, is, U));
31633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3164f1580f4eSBarry Smith }
3165f1580f4eSBarry Smith 
3166d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetDeflationMat_HPDDM(PC pc, IS is, Mat U)
3167d71ae5a4SJacob Faibussowitsch {
3168f1580f4eSBarry Smith   PetscFunctionBegin;
3169f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, U, PETSC_TRUE));
31703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3171f1580f4eSBarry Smith }
3172f1580f4eSBarry Smith 
3173d71ae5a4SJacob Faibussowitsch PetscErrorCode HPDDMLoadDL_Private(PetscBool *found)
3174d71ae5a4SJacob Faibussowitsch {
3175605ad303SPierre Jolivet   PetscBool flg;
3176f1580f4eSBarry Smith   char      lib[PETSC_MAX_PATH_LEN], dlib[PETSC_MAX_PATH_LEN], dir[PETSC_MAX_PATH_LEN];
3177f1580f4eSBarry Smith 
3178f1580f4eSBarry Smith   PetscFunctionBegin;
31794f572ea9SToby Isaac   PetscAssertPointer(found, 1);
3180c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(dir, "${PETSC_LIB_DIR}", sizeof(dir)));
3181db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, nullptr, "-hpddm_dir", dir, sizeof(dir), nullptr));
3182f1580f4eSBarry Smith   PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
3183f1580f4eSBarry Smith   PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3184605ad303SPierre Jolivet #if defined(SLEPC_LIB_DIR) /* this variable is passed during SLEPc ./configure when PETSc has not been configured   */
3185605ad303SPierre Jolivet   if (!*found) {           /* with --download-hpddm since slepcconf.h is not yet built (and thus can't be included) */
3186c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(dir, HPDDM_STR(SLEPC_LIB_DIR), sizeof(dir)));
3187f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
3188f1580f4eSBarry Smith     PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3189f1580f4eSBarry Smith   }
3190f1580f4eSBarry Smith #endif
3191605ad303SPierre 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 */
3192605ad303SPierre Jolivet     PetscCall(PetscOptionsGetenv(PETSC_COMM_SELF, "SLEPC_DIR", dir, sizeof(dir), &flg));
3193605ad303SPierre 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 */
3194605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libslepc", dir));
3195605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3196605ad303SPierre Jolivet       PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found but SLEPC_DIR=%s", lib, dir);
3197605ad303SPierre Jolivet       PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
3198605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libhpddm_petsc", dir)); /* libhpddm_petsc is always in the same directory as libslepc */
3199605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3200605ad303SPierre Jolivet     }
3201605ad303SPierre Jolivet   }
3202f1580f4eSBarry Smith   PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found", lib);
3203f1580f4eSBarry Smith   PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
32043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3205f1580f4eSBarry Smith }
3206f1580f4eSBarry Smith 
3207f1580f4eSBarry Smith /*MC
3208f1580f4eSBarry Smith    PCHPDDM - Interface with the HPDDM library.
3209f1580f4eSBarry Smith 
32101d27aa22SBarry Smith    This `PC` may be used to build multilevel spectral domain decomposition methods based on the GenEO framework {cite}`spillane2011robust` {cite}`al2021multilevel`.
32111d27aa22SBarry Smith    It may be viewed as an alternative to spectral
32121d27aa22SBarry Smith    AMGe or `PCBDDC` with adaptive selection of constraints. The interface is explained in details in {cite}`jolivetromanzampini2020`
3213f1580f4eSBarry Smith 
3214e7593814SPierre 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`).
3215f1580f4eSBarry Smith 
3216f1580f4eSBarry Smith    For multilevel preconditioning, when using an assembled or hierarchical Pmat, one must provide an auxiliary local `Mat` (unassembled local operator for GenEO) using
3217f1580f4eSBarry Smith    `PCHPDDMSetAuxiliaryMat()`. Calling this routine is not needed when using a `MATIS` Pmat, assembly is done internally using `MatConvert()`.
3218f1580f4eSBarry Smith 
3219f1580f4eSBarry Smith    Options Database Keys:
3220f1580f4eSBarry Smith +   -pc_hpddm_define_subdomains <true, default=false>    - on the finest level, calls `PCASMSetLocalSubdomains()` with the `IS` supplied in `PCHPDDMSetAuxiliaryMat()`
3221f1580f4eSBarry Smith                                                          (not relevant with an unassembled Pmat)
3222f1580f4eSBarry Smith .   -pc_hpddm_has_neumann <true, default=false>          - on the finest level, informs the `PC` that the local Neumann matrix is supplied in `PCHPDDMSetAuxiliaryMat()`
3223f1580f4eSBarry Smith -   -pc_hpddm_coarse_correction <type, default=deflated> - determines the `PCHPDDMCoarseCorrectionType` when calling `PCApply()`
3224f1580f4eSBarry Smith 
322538bf2a8cSPierre Jolivet    Options for subdomain solvers, subdomain eigensolvers (for computing deflation vectors), and the coarse solver can be set using the following options database prefixes.
3226f1580f4eSBarry Smith .vb
3227f1580f4eSBarry Smith       -pc_hpddm_levels_%d_pc_
3228f1580f4eSBarry Smith       -pc_hpddm_levels_%d_ksp_
3229f1580f4eSBarry Smith       -pc_hpddm_levels_%d_eps_
3230f1580f4eSBarry Smith       -pc_hpddm_levels_%d_p
32314ec2a359SPierre Jolivet       -pc_hpddm_levels_%d_mat_type
3232f1580f4eSBarry Smith       -pc_hpddm_coarse_
3233f1580f4eSBarry Smith       -pc_hpddm_coarse_p
32344ec2a359SPierre Jolivet       -pc_hpddm_coarse_mat_type
32352ce66baaSPierre Jolivet       -pc_hpddm_coarse_mat_filter
3236f1580f4eSBarry Smith .ve
3237f1580f4eSBarry Smith 
323838bf2a8cSPierre 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
3239f1580f4eSBarry Smith     -pc_hpddm_coarse_p 2 -pc_hpddm_coarse_mat_type baij will use 10 deflation vectors per subdomain on the fine "level 1",
3240f1580f4eSBarry Smith     aggregate the fine subdomains into 4 "level 2" subdomains, then use 10 deflation vectors per subdomain on "level 2",
32417eb095acSPierre Jolivet     and assemble the coarse matrix (of dimension 4 x 10 = 40) on two processes as a `MATBAIJ` (default is `MATSBAIJ`).
3242f1580f4eSBarry Smith 
3243b5a302b3SPierre Jolivet    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_absolute <val>. The default -pc_hpddm_coarse_p value is 1, meaning that the coarse operator is aggregated on a single process.
3244f1580f4eSBarry Smith 
32451d27aa22SBarry Smith    Level: intermediate
32461d27aa22SBarry Smith 
32471d27aa22SBarry Smith    Notes:
32481d27aa22SBarry Smith    This preconditioner requires that PETSc is built with SLEPc (``--download-slepc``).
32491d27aa22SBarry Smith 
32501d27aa22SBarry Smith    By default, the underlying concurrent eigenproblems
32511d27aa22SBarry Smith    are solved using SLEPc shift-and-invert spectral transformation. This is usually what gives the best performance for GenEO, cf.
32521d27aa22SBarry Smith    {cite}`spillane2011robust` {cite}`jolivet2013scalabledd`. As
325338bf2a8cSPierre 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
325438bf2a8cSPierre 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
325538bf2a8cSPierre Jolivet    SLEPc documentation since they are specific to `PCHPDDM`.
325638bf2a8cSPierre Jolivet .vb
325738bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_st_share_sub_ksp
3258b5a302b3SPierre Jolivet       -pc_hpddm_levels_%d_eps_threshold_absolute
325938bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_eps_use_inertia
326038bf2a8cSPierre Jolivet .ve
326138bf2a8cSPierre Jolivet 
326238bf2a8cSPierre Jolivet    The first option from the list only applies to the fine-level eigensolver, see `PCHPDDMSetSTShareSubKSP()`. The second option from the list is
326338bf2a8cSPierre Jolivet    used to filter eigenmodes retrieved after convergence of `EPSSolve()` at "level N" such that eigenvectors used to define a "level N+1" coarse
3264b5a302b3SPierre Jolivet    correction are associated to eigenvalues whose magnitude are lower or equal than -pc_hpddm_levels_N_eps_threshold_absolute. When using an `EPS` which cannot
326538bf2a8cSPierre 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
326638bf2a8cSPierre 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
326738bf2a8cSPierre Jolivet    to supply -pc_hpddm_levels_1_eps_nev. This last option also only applies to the fine-level (N = 1) eigensolver.
3268f1580f4eSBarry Smith 
32691d27aa22SBarry Smith    See also {cite}`dolean2015introduction`, {cite}`al2022robust`, {cite}`al2022robustpd`, and {cite}`nataf2022recent`
3270f1580f4eSBarry Smith 
3271562efe2eSBarry Smith .seealso: [](ch_ksp), `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetAuxiliaryMat()`, `MATIS`, `PCBDDC`, `PCDEFLATION`, `PCTELESCOPE`, `PCASM`,
3272e31fc274SPierre Jolivet           `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDMHasNeumannMat()`, `PCHPDDMSetRHSMat()`, `PCHPDDMSetDeflationMat()`, `PCHPDDMSetSTShareSubKSP()`,
3273e31fc274SPierre Jolivet           `PCHPDDMGetSTShareSubKSP()`, `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDMGetComplexities()`
3274f1580f4eSBarry Smith M*/
3275d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_HPDDM(PC pc)
3276d71ae5a4SJacob Faibussowitsch {
3277f1580f4eSBarry Smith   PC_HPDDM *data;
3278f1580f4eSBarry Smith   PetscBool found;
3279f1580f4eSBarry Smith 
3280f1580f4eSBarry Smith   PetscFunctionBegin;
3281f1580f4eSBarry Smith   if (!loadedSym) {
3282f1580f4eSBarry Smith     PetscCall(HPDDMLoadDL_Private(&found));
3283db4a47b3SPierre Jolivet     if (found) PetscCall(PetscDLLibrarySym(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, nullptr, "PCHPDDM_Internal", (void **)&loadedSym));
3284f1580f4eSBarry Smith   }
3285f1580f4eSBarry Smith   PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCHPDDM_Internal symbol not found in loaded libhpddm_petsc");
32864dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&data));
3287f1580f4eSBarry Smith   pc->data                   = data;
3288c8ea6600SPierre Jolivet   data->Neumann              = PETSC_BOOL3_UNKNOWN;
3289f1580f4eSBarry Smith   pc->ops->reset             = PCReset_HPDDM;
3290f1580f4eSBarry Smith   pc->ops->destroy           = PCDestroy_HPDDM;
3291f1580f4eSBarry Smith   pc->ops->setfromoptions    = PCSetFromOptions_HPDDM;
3292f1580f4eSBarry Smith   pc->ops->setup             = PCSetUp_HPDDM;
3293d4f06b61SRaphael Zanella   pc->ops->apply             = PCApply_HPDDM<false>;
32948cb7430dSRaphael Zanella   pc->ops->matapply          = PCMatApply_HPDDM<false>;
3295d4f06b61SRaphael Zanella   pc->ops->applytranspose    = PCApply_HPDDM<true>;
32968cb7430dSRaphael Zanella   pc->ops->matapplytranspose = PCMatApply_HPDDM<true>;
3297f1580f4eSBarry Smith   pc->ops->view              = PCView_HPDDM;
3298f1580f4eSBarry Smith   pc->ops->presolve          = PCPreSolve_HPDDM;
3299f1580f4eSBarry Smith 
3300f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", PCHPDDMSetAuxiliaryMat_HPDDM));
3301f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", PCHPDDMHasNeumannMat_HPDDM));
3302f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", PCHPDDMSetRHSMat_HPDDM));
3303f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", PCHPDDMSetCoarseCorrectionType_HPDDM));
3304f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", PCHPDDMGetCoarseCorrectionType_HPDDM));
3305e31fc274SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", PCHPDDMSetSTShareSubKSP_HPDDM));
3306f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", PCHPDDMGetSTShareSubKSP_HPDDM));
3307f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", PCHPDDMSetDeflationMat_HPDDM));
33083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3309f1580f4eSBarry Smith }
3310f1580f4eSBarry Smith 
3311f1580f4eSBarry Smith /*@C
3312f1580f4eSBarry Smith   PCHPDDMInitializePackage - This function initializes everything in the `PCHPDDM` package. It is called from `PCInitializePackage()`.
3313f1580f4eSBarry Smith 
3314f1580f4eSBarry Smith   Level: developer
3315f1580f4eSBarry Smith 
3316562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscInitialize()`
3317f1580f4eSBarry Smith @*/
3318d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMInitializePackage(void)
3319d71ae5a4SJacob Faibussowitsch {
3320f1580f4eSBarry Smith   char ename[32];
3321f1580f4eSBarry Smith 
3322f1580f4eSBarry Smith   PetscFunctionBegin;
33233ba16761SJacob Faibussowitsch   if (PCHPDDMPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
3324f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_TRUE;
3325f1580f4eSBarry Smith   PetscCall(PetscRegisterFinalize(PCHPDDMFinalizePackage));
3326f1580f4eSBarry Smith   /* general events registered once during package initialization */
3327f1580f4eSBarry Smith   /* some of these events are not triggered in libpetsc,          */
3328f1580f4eSBarry Smith   /* but rather directly in libhpddm_petsc,                       */
3329f1580f4eSBarry Smith   /* which is in charge of performing the following operations    */
3330f1580f4eSBarry Smith 
3331f1580f4eSBarry Smith   /* domain decomposition structure from Pmat sparsity pattern    */
3332f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMStrc", PC_CLASSID, &PC_HPDDM_Strc));
3333f1580f4eSBarry Smith   /* Galerkin product, redistribution, and setup (not triggered in libpetsc)                */
3334f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtAP", PC_CLASSID, &PC_HPDDM_PtAP));
3335f1580f4eSBarry Smith   /* Galerkin product with summation, redistribution, and setup (not triggered in libpetsc) */
3336f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtBP", PC_CLASSID, &PC_HPDDM_PtBP));
3337f1580f4eSBarry Smith   /* next level construction using PtAP and PtBP (not triggered in libpetsc)                */
3338f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMNext", PC_CLASSID, &PC_HPDDM_Next));
3339f1580f4eSBarry Smith   static_assert(PETSC_PCHPDDM_MAXLEVELS <= 9, "PETSC_PCHPDDM_MAXLEVELS value is too high");
3340811e8887SPierre Jolivet   for (PetscInt i = 1; i < PETSC_PCHPDDM_MAXLEVELS; ++i) {
3341f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSetUp L%1" PetscInt_FMT, i));
3342f1580f4eSBarry Smith     /* events during a PCSetUp() at level #i _except_ the assembly */
3343f1580f4eSBarry Smith     /* of the Galerkin operator of the coarser level #(i + 1)      */
3344f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_SetUp[i - 1]));
3345f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSolve L%1" PetscInt_FMT, i));
3346f1580f4eSBarry Smith     /* events during a PCApply() at level #i _except_              */
3347f1580f4eSBarry Smith     /* the KSPSolve() of the coarser level #(i + 1)                */
3348f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_Solve[i - 1]));
3349f1580f4eSBarry Smith   }
33503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3351f1580f4eSBarry Smith }
3352f1580f4eSBarry Smith 
3353f1580f4eSBarry Smith /*@C
3354f1580f4eSBarry Smith   PCHPDDMFinalizePackage - This function frees everything from the `PCHPDDM` package. It is called from `PetscFinalize()`.
3355f1580f4eSBarry Smith 
3356f1580f4eSBarry Smith   Level: developer
3357f1580f4eSBarry Smith 
3358562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscFinalize()`
3359f1580f4eSBarry Smith @*/
3360d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMFinalizePackage(void)
3361d71ae5a4SJacob Faibussowitsch {
3362f1580f4eSBarry Smith   PetscFunctionBegin;
3363f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_FALSE;
33643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3365f1580f4eSBarry Smith }
33669bb5c669SPierre Jolivet 
33679bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat A, Vec x, Vec y)
33689bb5c669SPierre Jolivet {
33699bb5c669SPierre Jolivet   Harmonic h; /* [ A_00  A_01       ], furthermore, A_00 = [ A_loc,loc  A_loc,ovl ], thus, A_01 = [         ] */
33709bb5c669SPierre Jolivet               /* [ A_10  A_11  A_12 ]                      [ A_ovl,loc  A_ovl,ovl ]               [ A_ovl,1 ] */
33719bb5c669SPierre Jolivet   Vec sub;    /*  y = A x = R_loc R_0 [ A_00  A_01 ]^-1                                   R_loc = [  I_loc  ] */
33729bb5c669SPierre Jolivet               /*                      [ A_10  A_11 ]    R_1^T A_12 x                              [         ] */
33739bb5c669SPierre Jolivet   PetscFunctionBegin;
33749bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
33759bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
33769bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
33779bb5c669SPierre Jolivet   PetscCall(MatMult(h->A[0], x, sub));
33789bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
33799bb5c669SPierre Jolivet   PetscCall(KSPSolve(h->ksp, h->v, h->v));
33809bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_REVERSE, y));
33819bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
33829bb5c669SPierre Jolivet }
33839bb5c669SPierre Jolivet 
33849bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat A, Vec y, Vec x)
33859bb5c669SPierre Jolivet {
33869bb5c669SPierre Jolivet   Harmonic h;   /* x = A^T y =            [ A_00  A_01 ]^-T R_0^T R_loc^T y */
33879bb5c669SPierre Jolivet   Vec      sub; /*             A_12^T R_1 [ A_10  A_11 ]                    */
33889bb5c669SPierre Jolivet 
33899bb5c669SPierre Jolivet   PetscFunctionBegin;
33909bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
33919bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
33929bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_FORWARD, y));
33939bb5c669SPierre Jolivet   PetscCall(KSPSolveTranspose(h->ksp, h->v, h->v));
33949bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
33959bb5c669SPierre Jolivet   PetscCall(MatMultTranspose(h->A[0], sub, x));
33969bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
33979bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
33989bb5c669SPierre Jolivet }
33999bb5c669SPierre Jolivet 
34009bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat S, Mat X, Mat Y, void *)
34019bb5c669SPierre Jolivet {
34029bb5c669SPierre Jolivet   Harmonic h;
34039bb5c669SPierre Jolivet   Mat      A, B;
34049bb5c669SPierre Jolivet   Vec      a, b;
34059bb5c669SPierre Jolivet 
34069bb5c669SPierre Jolivet   PetscFunctionBegin;
34079bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
3408fb842aefSJose E. Roman   PetscCall(MatMatMult(h->A[0], X, MAT_INITIAL_MATRIX, PETSC_CURRENT, &A));
34099bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
34109bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
34119bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
34129bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B, i, &b));
34139bb5c669SPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_FORWARD, a));
34149bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B, i, &b));
34159bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
34169bb5c669SPierre Jolivet   }
34179bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
34189bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, B->cmap->n, nullptr, &A));
34199bb5c669SPierre Jolivet   PetscCall(KSPMatSolve(h->ksp, B, A));
34209bb5c669SPierre Jolivet   PetscCall(MatDestroy(&B));
34219bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
34229bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
34239bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &b));
34249bb5c669SPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_REVERSE, b));
34259bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &b));
34269bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
34279bb5c669SPierre Jolivet   }
34289bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
34299bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
34309bb5c669SPierre Jolivet }
34319bb5c669SPierre Jolivet 
3432f21e3f8aSPierre Jolivet static PetscErrorCode MatProduct_AtB_Harmonic(Mat S, Mat Y, Mat X, void *)
3433f21e3f8aSPierre Jolivet {
3434f21e3f8aSPierre Jolivet   Harmonic h;
3435f21e3f8aSPierre Jolivet   Mat      A, B;
3436f21e3f8aSPierre Jolivet   Vec      a, b;
3437f21e3f8aSPierre Jolivet 
3438f21e3f8aSPierre Jolivet   PetscFunctionBegin;
3439f21e3f8aSPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
3440f21e3f8aSPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, Y->cmap->n, nullptr, &A));
3441f21e3f8aSPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
3442f21e3f8aSPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(Y, i, &b));
3443f21e3f8aSPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(A, i, &a));
3444f21e3f8aSPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_FORWARD, b));
3445f21e3f8aSPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(A, i, &a));
3446f21e3f8aSPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(Y, i, &b));
3447f21e3f8aSPierre Jolivet   }
3448f21e3f8aSPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
3449f21e3f8aSPierre Jolivet   PetscCall(KSPMatSolveTranspose(h->ksp, A, B));
3450f21e3f8aSPierre Jolivet   PetscCall(MatDestroy(&A));
3451f21e3f8aSPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->A[0]->rmap->n, B->cmap->n, nullptr, &A));
3452f21e3f8aSPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
3453f21e3f8aSPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B, i, &b));
3454f21e3f8aSPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(A, i, &a));
3455f21e3f8aSPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_REVERSE, a));
3456f21e3f8aSPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(A, i, &a));
3457f21e3f8aSPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B, i, &b));
3458f21e3f8aSPierre Jolivet   }
3459f21e3f8aSPierre Jolivet   PetscCall(MatDestroy(&B));
3460f21e3f8aSPierre Jolivet   PetscCall(MatTransposeMatMult(h->A[0], A, MAT_REUSE_MATRIX, PETSC_CURRENT, &X));
3461f21e3f8aSPierre Jolivet   PetscCall(MatDestroy(&A));
3462f21e3f8aSPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
3463f21e3f8aSPierre Jolivet }
3464f21e3f8aSPierre Jolivet 
34659bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat A)
34669bb5c669SPierre Jolivet {
34679bb5c669SPierre Jolivet   Harmonic h;
34689bb5c669SPierre Jolivet 
34699bb5c669SPierre Jolivet   PetscFunctionBegin;
34709bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
347132603206SJames Wright   for (PetscInt i = 0; i < 5; ++i) PetscCall(ISDestroy(h->is + i));
34729bb5c669SPierre Jolivet   PetscCall(PetscFree(h->is));
34739bb5c669SPierre Jolivet   PetscCall(VecDestroy(&h->v));
34749bb5c669SPierre Jolivet   for (PetscInt i = 0; i < 2; ++i) PetscCall(MatDestroy(h->A + i));
34759bb5c669SPierre Jolivet   PetscCall(PetscFree(h->A));
34769bb5c669SPierre Jolivet   PetscCall(KSPDestroy(&h->ksp));
34779bb5c669SPierre Jolivet   PetscCall(PetscFree(h));
34789bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
34799bb5c669SPierre Jolivet }
3480