xref: /petsc/src/ksp/pc/impls/hpddm/pchpddm.cxx (revision fc31f8309b15d9e571dbc4ed4e0ad95ca4c2c1f1)
1b04479c2SPierre Jolivet #include <petsc/private/sfimpl.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));
1468dc3fbeeSPierre 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 @*/
2462a8381b2SBarry Smith PetscErrorCode PCHPDDMSetAuxiliaryMat(PC pc, IS is, Mat A, PetscErrorCode (*setup)(Mat J, PetscReal t, Vec X, Vec X_t, PetscReal s, IS ovl, PetscCtx ctx), PetscCtx 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");
364*fc31f830SPierre Jolivet       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_nsv", i));
3659bb5c669SPierre Jolivet       if (overlap != -1) {
3669bb5c669SPierre Jolivet         PetscInt  nsv    = 0;
367b5a302b3SPierre Jolivet         PetscBool set[2] = {PETSC_FALSE, PETSC_FALSE};
368811e8887SPierre Jolivet 
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)");
386*fc31f830SPierre Jolivet       } else if (PetscDefined(USE_DEBUG)) {
387*fc31f830SPierre Jolivet         PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
388*fc31f830SPierre Jolivet         PetscCheck(!flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot supply -%spc_hpddm_levels_%d_svd_nsv without -%spc_hpddm_harmonic_overlap", PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "", i,
389*fc31f830SPierre Jolivet                    PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "");
390*fc31f830SPierre Jolivet         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_threshold_relative", i));
391*fc31f830SPierre Jolivet         PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
392*fc31f830SPierre Jolivet         PetscCheck(!flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot supply -%spc_hpddm_levels_%d_svd_threshold_relative without -%spc_hpddm_harmonic_overlap", PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "", i,
393*fc31f830SPierre Jolivet                    PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "");
394*fc31f830SPierre Jolivet         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold_relative", i));
395*fc31f830SPierre Jolivet         PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
396*fc31f830SPierre Jolivet         PetscCheck(!flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot supply -%spc_hpddm_levels_%d_eps_threshold_relative without -%spc_hpddm_harmonic_overlap, maybe you meant to use -%spc_hpddm_levels_%d_eps_threshold_absolute?",
397*fc31f830SPierre Jolivet                    PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "", i, PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "", PetscOptionsObject->prefix ? PetscOptionsObject->prefix : "", i);
3989bb5c669SPierre Jolivet       }
399f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_1_st_share_sub_ksp"));
400db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Shared KSP between SLEPc ST and the fine-level subdomain solver", "PCHPDDMSetSTShareSubKSP", PETSC_FALSE, &data->share, nullptr));
401f1580f4eSBarry Smith     }
402f1580f4eSBarry Smith     /* if there is no prescribed coarsening, just break out of the loop */
4030594bca0SPierre Jolivet     if (data->levels[i - 1]->threshold <= PetscReal() && data->levels[i - 1]->nu <= 0 && !(data->deflation && i == 1)) break;
404f1580f4eSBarry Smith     else {
405f1580f4eSBarry Smith       ++i;
406f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
407f1580f4eSBarry Smith       PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
408f1580f4eSBarry Smith       if (!flg) {
409b5a302b3SPierre Jolivet         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold_absolute", i));
410f1580f4eSBarry Smith         PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
411f1580f4eSBarry Smith       }
412f1580f4eSBarry Smith       if (flg) {
413f1580f4eSBarry Smith         /* if there are coarsening options for the next level, then register it  */
414f1580f4eSBarry Smith         /* otherwise, don't to avoid having both options levels_N_p and coarse_p */
415f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_p", i));
416f1580f4eSBarry 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)));
417f1580f4eSBarry Smith         previous = p;
418f1580f4eSBarry Smith       }
419f1580f4eSBarry Smith     }
420f1580f4eSBarry Smith   }
421f1580f4eSBarry Smith   data->N = i;
422f1580f4eSBarry Smith   n       = 1;
423f1580f4eSBarry Smith   if (i > 1) {
424f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_coarse_p"));
425db4a47b3SPierre Jolivet     PetscCall(PetscOptionsRangeInt(prefix, "Number of processes used to assemble the coarsest operator", "PCHPDDM", n, &n, nullptr, 1, PetscMax(1, previous / 2)));
42602800ff6SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
427f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "pc_hpddm_coarse_"));
4288dc3fbeeSPierre Jolivet     PetscCall(PetscOptionsHasName(PetscOptionsObject->options, prefix, "-mat_mumps_use_omp_threads", &flg));
429f1580f4eSBarry Smith     if (flg) {
430f1580f4eSBarry Smith       char type[64]; /* same size as in src/ksp/pc/impls/factor/factimpl.c */
431811e8887SPierre Jolivet 
432c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(type, n > 1 && PetscDefined(HAVE_MUMPS) ? MATSOLVERMUMPS : MATSOLVERPETSC, sizeof(type))); /* default solver for a MatMPIAIJ or a MatSeqAIJ */
4338dc3fbeeSPierre Jolivet       PetscCall(PetscOptionsGetString(PetscOptionsObject->options, prefix, "-pc_factor_mat_solver_type", type, sizeof(type), nullptr));
4343ce573a3SPierre Jolivet       PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
435f1580f4eSBarry 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);
436f1580f4eSBarry Smith       size = n;
437f1580f4eSBarry Smith       n    = -1;
4388dc3fbeeSPierre Jolivet       PetscCall(PetscOptionsGetInt(PetscOptionsObject->options, prefix, "-mat_mumps_use_omp_threads", &n, nullptr));
439f1580f4eSBarry Smith       PetscCheck(n >= 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Need to specify a positive integer for -%smat_mumps_use_omp_threads", prefix);
440f1580f4eSBarry 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" : "");
441f1580f4eSBarry Smith     }
442f1580f4eSBarry Smith #endif
443f1580f4eSBarry Smith     PetscCall(PetscOptionsEnum("-pc_hpddm_coarse_correction", "Type of coarse correction applied each iteration", "PCHPDDMSetCoarseCorrectionType", PCHPDDMCoarseCorrectionTypes, (PetscEnum)data->correction, (PetscEnum *)&type, &flg));
444f1580f4eSBarry Smith     if (flg) PetscCall(PCHPDDMSetCoarseCorrectionType(pc, type));
445f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_has_neumann"));
446c8ea6600SPierre Jolivet     PetscCall(PetscOptionsBool(prefix, "Is the auxiliary Mat the local Neumann matrix?", "PCHPDDMHasNeumannMat", PetscBool3ToBool(data->Neumann), &flg, &set));
447c8ea6600SPierre Jolivet     if (set) data->Neumann = PetscBoolToBool3(flg);
448f1580f4eSBarry Smith     data->log_separate = PETSC_FALSE;
449f1580f4eSBarry Smith     if (PetscDefined(USE_LOG)) {
450f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_log_separate"));
451db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Log events level by level instead of inside PCSetUp()/KSPSolve()", nullptr, data->log_separate, &data->log_separate, nullptr));
452f1580f4eSBarry Smith     }
453f1580f4eSBarry Smith   }
454f1580f4eSBarry Smith   PetscOptionsHeadEnd();
455f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]) PetscCall(PetscFree(data->levels[i++]));
4563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
457f1580f4eSBarry Smith }
458f1580f4eSBarry Smith 
459d4f06b61SRaphael Zanella template <bool transpose>
460d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDM(PC pc, Vec x, Vec y)
461d71ae5a4SJacob Faibussowitsch {
462f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
463f1580f4eSBarry Smith 
464f1580f4eSBarry Smith   PetscFunctionBegin;
465f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
466f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
467db4a47b3SPierre 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 */
468d4f06b61SRaphael Zanella   if (!transpose) PetscCall(KSPSolve(data->levels[0]->ksp, x, y));
469d4f06b61SRaphael Zanella   else PetscCall(KSPSolveTranspose(data->levels[0]->ksp, x, y));
470db4a47b3SPierre Jolivet   if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
4713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
472f1580f4eSBarry Smith }
473f1580f4eSBarry Smith 
4748cb7430dSRaphael Zanella template <bool transpose>
475d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDM(PC pc, Mat X, Mat Y)
476d71ae5a4SJacob Faibussowitsch {
477f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
478f1580f4eSBarry Smith 
479f1580f4eSBarry Smith   PetscFunctionBegin;
480f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
481f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
4828cb7430dSRaphael Zanella   if (!transpose) PetscCall(KSPMatSolve(data->levels[0]->ksp, X, Y));
4838cb7430dSRaphael Zanella   else PetscCall(KSPMatSolveTranspose(data->levels[0]->ksp, X, Y));
4843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
485f1580f4eSBarry Smith }
486f1580f4eSBarry Smith 
487cc4c1da9SBarry Smith /*@
488f1580f4eSBarry Smith   PCHPDDMGetComplexities - Computes the grid and operator complexities.
489f1580f4eSBarry Smith 
490c71f06a7SPierre Jolivet   Collective
491c71f06a7SPierre Jolivet 
492f1580f4eSBarry Smith   Input Parameter:
493f1580f4eSBarry Smith . pc - preconditioner context
494f1580f4eSBarry Smith 
495f1580f4eSBarry Smith   Output Parameters:
496cc4c1da9SBarry Smith + gc - grid complexity $ \sum_i m_i / m_1 $
497cc4c1da9SBarry Smith - oc - operator complexity $ \sum_i nnz_i / nnz_1 $
498f1580f4eSBarry Smith 
499f1580f4eSBarry Smith   Level: advanced
500f1580f4eSBarry Smith 
501562efe2eSBarry Smith .seealso: [](ch_ksp), `PCMGGetGridComplexity()`, `PCHPDDM`, `PCHYPRE`, `PCGAMG`
502f1580f4eSBarry Smith @*/
503cc4c1da9SBarry Smith PetscErrorCode PCHPDDMGetComplexities(PC pc, PetscReal *gc, PetscReal *oc)
504d71ae5a4SJacob Faibussowitsch {
505f1580f4eSBarry Smith   PC_HPDDM      *data = (PC_HPDDM *)pc->data;
506f1580f4eSBarry Smith   MatInfo        info;
507f1580f4eSBarry Smith   PetscLogDouble accumulate[2]{}, nnz1 = 1.0, m1 = 1.0;
508f1580f4eSBarry Smith 
509f1580f4eSBarry Smith   PetscFunctionBegin;
510715c1178SPierre Jolivet   if (gc) {
511715c1178SPierre Jolivet     PetscAssertPointer(gc, 2);
512715c1178SPierre Jolivet     *gc = 0;
513715c1178SPierre Jolivet   }
514715c1178SPierre Jolivet   if (oc) {
515715c1178SPierre Jolivet     PetscAssertPointer(oc, 3);
516715c1178SPierre Jolivet     *oc = 0;
517715c1178SPierre Jolivet   }
518715c1178SPierre Jolivet   for (PetscInt n = 0; n < data->N; ++n) {
519f1580f4eSBarry Smith     if (data->levels[n]->ksp) {
52013044ca3SPierre Jolivet       Mat       P, A = nullptr;
521715c1178SPierre Jolivet       PetscInt  m;
52213044ca3SPierre Jolivet       PetscBool flg = PETSC_FALSE;
52313044ca3SPierre Jolivet 
524db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &P));
525db4a47b3SPierre Jolivet       PetscCall(MatGetSize(P, &m, nullptr));
526f1580f4eSBarry Smith       accumulate[0] += m;
527f1580f4eSBarry Smith       if (n == 0) {
528f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
529f1580f4eSBarry Smith         if (flg) {
530f1580f4eSBarry Smith           PetscCall(MatConvert(P, MATAIJ, MAT_INITIAL_MATRIX, &A));
531f1580f4eSBarry Smith           P = A;
53213044ca3SPierre Jolivet         } else {
53313044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
53413044ca3SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)P));
535f1580f4eSBarry Smith         }
53613044ca3SPierre Jolivet       }
53713044ca3SPierre Jolivet       if (!A && flg) accumulate[1] += m * m; /* assumption that a MATSCHURCOMPLEMENT is dense if stored explicitly */
53813044ca3SPierre Jolivet       else if (P->ops->getinfo) {
539f1580f4eSBarry Smith         PetscCall(MatGetInfo(P, MAT_GLOBAL_SUM, &info));
540f1580f4eSBarry Smith         accumulate[1] += info.nz_used;
541f1580f4eSBarry Smith       }
542f1580f4eSBarry Smith       if (n == 0) {
543f1580f4eSBarry Smith         m1 = m;
54413044ca3SPierre Jolivet         if (!A && flg) nnz1 = m * m;
54513044ca3SPierre Jolivet         else if (P->ops->getinfo) nnz1 = info.nz_used;
546f1580f4eSBarry Smith         PetscCall(MatDestroy(&P));
547f1580f4eSBarry Smith       }
548f1580f4eSBarry Smith     }
549f1580f4eSBarry Smith   }
550715c1178SPierre Jolivet   /* only process #0 has access to the full hierarchy by construction, so broadcast to ensure consistent outputs */
551715c1178SPierre Jolivet   PetscCallMPI(MPI_Bcast(accumulate, 2, MPIU_PETSCLOGDOUBLE, 0, PetscObjectComm((PetscObject)pc)));
552715c1178SPierre Jolivet   if (gc) *gc = static_cast<PetscReal>(accumulate[0] / m1);
553715c1178SPierre Jolivet   if (oc) *oc = static_cast<PetscReal>(accumulate[1] / nnz1);
5543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
555f1580f4eSBarry Smith }
556f1580f4eSBarry Smith 
557d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_HPDDM(PC pc, PetscViewer viewer)
558d71ae5a4SJacob Faibussowitsch {
559f1580f4eSBarry Smith   PC_HPDDM         *data = (PC_HPDDM *)pc->data;
560f1580f4eSBarry Smith   PetscViewer       subviewer;
561aa21023fSPierre Jolivet   PetscViewerFormat format;
562f1580f4eSBarry Smith   PetscSubcomm      subcomm;
563f1580f4eSBarry Smith   PetscReal         oc, gc;
564811e8887SPierre Jolivet   PetscInt          tabs;
565f1580f4eSBarry Smith   PetscMPIInt       size, color, rank;
566aa21023fSPierre Jolivet   PetscBool         flg;
567aa21023fSPierre Jolivet   const char       *name;
568f1580f4eSBarry Smith 
569f1580f4eSBarry Smith   PetscFunctionBegin;
570aa21023fSPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &flg));
571aa21023fSPierre Jolivet   if (flg) {
572f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "level%s: %" PetscInt_FMT "\n", data->N > 1 ? "s" : "", data->N));
573f1580f4eSBarry Smith     PetscCall(PCHPDDMGetComplexities(pc, &gc, &oc));
574f1580f4eSBarry Smith     if (data->N > 1) {
575f1580f4eSBarry Smith       if (!data->deflation) {
576c8ea6600SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "Neumann matrix attached? %s\n", PetscBools[PetscBool3ToBool(data->Neumann)]));
577f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, "shared subdomain KSP between SLEPc and PETSc? %s\n", PetscBools[data->share]));
578f1580f4eSBarry Smith       } else PetscCall(PetscViewerASCIIPrintf(viewer, "user-supplied deflation matrix\n"));
579f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "coarse correction: %s\n", PCHPDDMCoarseCorrectionTypes[data->correction]));
580f1580f4eSBarry 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" : ""));
581f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIGetTab(viewer, &tabs));
582f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, 0));
583811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
584f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, data->levels[i - 1]->nu));
5850594bca0SPierre Jolivet         if (data->levels[i - 1]->threshold > static_cast<PetscReal>(-0.1)) PetscCall(PetscViewerASCIIPrintf(viewer, " (%g)", (double)data->levels[i - 1]->threshold));
586f1580f4eSBarry Smith       }
587f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
588f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, tabs));
589f1580f4eSBarry Smith     }
590f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "grid and operator complexities: %g %g\n", (double)gc, (double)oc));
5911fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
592f1580f4eSBarry Smith     if (data->levels[0]->ksp) {
593f1580f4eSBarry Smith       PetscCall(KSPView(data->levels[0]->ksp, viewer));
594f1580f4eSBarry Smith       if (data->levels[0]->pc) PetscCall(PCView(data->levels[0]->pc, viewer));
595eea1a2f1SRaphael Zanella       PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank));
596811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
597f1580f4eSBarry Smith         if (data->levels[i]->ksp) color = 1;
598f1580f4eSBarry Smith         else color = 0;
599f1580f4eSBarry Smith         PetscCall(PetscSubcommCreate(PetscObjectComm((PetscObject)pc), &subcomm));
600f1580f4eSBarry Smith         PetscCall(PetscSubcommSetNumber(subcomm, PetscMin(size, 2)));
601f1580f4eSBarry Smith         PetscCall(PetscSubcommSetTypeGeneral(subcomm, color, rank));
602f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPushTab(viewer));
603f1580f4eSBarry Smith         PetscCall(PetscViewerGetSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
604f1580f4eSBarry Smith         if (color == 1) {
605f1580f4eSBarry Smith           PetscCall(KSPView(data->levels[i]->ksp, subviewer));
606f1580f4eSBarry Smith           if (data->levels[i]->pc) PetscCall(PCView(data->levels[i]->pc, subviewer));
607f1580f4eSBarry Smith           PetscCall(PetscViewerFlush(subviewer));
608f1580f4eSBarry Smith         }
609f1580f4eSBarry Smith         PetscCall(PetscViewerRestoreSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
610f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPopTab(viewer));
611f1580f4eSBarry Smith         PetscCall(PetscSubcommDestroy(&subcomm));
612f1580f4eSBarry Smith       }
613f1580f4eSBarry Smith     }
614aa21023fSPierre Jolivet     PetscCall(PetscViewerGetFormat(viewer, &format));
615aa21023fSPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
616aa21023fSPierre Jolivet       PetscCall(PetscViewerFileGetName(viewer, &name));
617aa21023fSPierre Jolivet       if (name) {
618eea1a2f1SRaphael Zanella         Mat             aux[2];
619aa21023fSPierre Jolivet         IS              is;
620eea1a2f1SRaphael Zanella         const PetscInt *indices;
621eea1a2f1SRaphael Zanella         PetscInt        m, n, sizes[5] = {pc->mat->rmap->n, pc->mat->cmap->n, pc->mat->rmap->N, pc->mat->cmap->N, 0};
622aa21023fSPierre Jolivet         char           *tmp;
623aa21023fSPierre Jolivet         std::string     prefix, suffix;
624aa21023fSPierre Jolivet         size_t          pos;
625aa21023fSPierre Jolivet 
626aa21023fSPierre Jolivet         PetscCall(PetscStrstr(name, ".", &tmp));
627aa21023fSPierre Jolivet         if (tmp) {
628aa21023fSPierre Jolivet           pos    = std::distance(const_cast<char *>(name), tmp);
629aa21023fSPierre Jolivet           prefix = std::string(name, pos);
630aa21023fSPierre Jolivet           suffix = std::string(name + pos + 1);
631aa21023fSPierre Jolivet         } else prefix = name;
632aa21023fSPierre Jolivet         if (data->aux) {
633eea1a2f1SRaphael Zanella           PetscCall(MatGetSize(data->aux, &m, &n));
634eea1a2f1SRaphael Zanella           PetscCall(MatCreate(PetscObjectComm((PetscObject)pc), aux));
635eea1a2f1SRaphael Zanella           PetscCall(MatSetSizes(aux[0], m, n, PETSC_DETERMINE, PETSC_DETERMINE));
636eea1a2f1SRaphael Zanella           PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
637eea1a2f1SRaphael Zanella           if (flg) PetscCall(MatSetType(aux[0], MATMPIAIJ));
638eea1a2f1SRaphael Zanella           else {
639eea1a2f1SRaphael Zanella             PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQBAIJ, &flg));
640eea1a2f1SRaphael Zanella             if (flg) PetscCall(MatSetType(aux[0], MATMPIBAIJ));
641eea1a2f1SRaphael Zanella             else {
642eea1a2f1SRaphael Zanella               PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQSBAIJ, &flg));
643eea1a2f1SRaphael 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);
644eea1a2f1SRaphael Zanella               PetscCall(MatSetType(aux[0], MATMPISBAIJ));
645eea1a2f1SRaphael Zanella             }
646eea1a2f1SRaphael Zanella           }
647eea1a2f1SRaphael Zanella           PetscCall(MatSetBlockSizesFromMats(aux[0], data->aux, data->aux));
648eea1a2f1SRaphael Zanella           PetscCall(MatAssemblyBegin(aux[0], MAT_FINAL_ASSEMBLY));
649eea1a2f1SRaphael Zanella           PetscCall(MatAssemblyEnd(aux[0], MAT_FINAL_ASSEMBLY));
650eea1a2f1SRaphael Zanella           PetscCall(MatGetDiagonalBlock(aux[0], aux + 1));
651eea1a2f1SRaphael Zanella           PetscCall(MatCopy(data->aux, aux[1], DIFFERENT_NONZERO_PATTERN));
652eea1a2f1SRaphael Zanella           PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_aux_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
653eea1a2f1SRaphael Zanella           PetscCall(MatView(aux[0], subviewer));
654aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
655eea1a2f1SRaphael Zanella           PetscCall(MatDestroy(aux));
656aa21023fSPierre Jolivet         }
657aa21023fSPierre Jolivet         if (data->is) {
658eea1a2f1SRaphael Zanella           PetscCall(ISGetIndices(data->is, &indices));
659eea1a2f1SRaphael Zanella           PetscCall(ISGetSize(data->is, sizes + 4));
660eea1a2f1SRaphael Zanella           PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), sizes[4], indices, PETSC_USE_POINTER, &is));
661eea1a2f1SRaphael Zanella           PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_is_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
662eea1a2f1SRaphael Zanella           PetscCall(ISView(is, subviewer));
663aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
664eea1a2f1SRaphael Zanella           PetscCall(ISDestroy(&is));
665eea1a2f1SRaphael Zanella           PetscCall(ISRestoreIndices(data->is, &indices));
666aa21023fSPierre Jolivet         }
667eea1a2f1SRaphael Zanella         PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), PETSC_STATIC_ARRAY_LENGTH(sizes), sizes, PETSC_USE_POINTER, &is));
668eea1a2f1SRaphael Zanella         PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_sizes_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
669aa21023fSPierre Jolivet         PetscCall(ISView(is, subviewer));
670aa21023fSPierre Jolivet         PetscCall(PetscViewerDestroy(&subviewer));
671aa21023fSPierre Jolivet         PetscCall(ISDestroy(&is));
672aa21023fSPierre Jolivet       }
673aa21023fSPierre Jolivet     }
674f1580f4eSBarry Smith   }
6753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
676f1580f4eSBarry Smith }
677f1580f4eSBarry Smith 
678d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCPreSolve_HPDDM(PC pc, KSP ksp, Vec, Vec)
679d71ae5a4SJacob Faibussowitsch {
680f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
681f1580f4eSBarry Smith   Mat       A;
682cdbd50ebSPierre Jolivet   PetscBool flg;
683f1580f4eSBarry Smith 
684f1580f4eSBarry Smith   PetscFunctionBegin;
685f1580f4eSBarry Smith   if (ksp) {
686f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPLSQR, &flg));
687f1580f4eSBarry Smith     if (flg && !data->normal) {
688db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(ksp, &A, nullptr));
689db4a47b3SPierre Jolivet       PetscCall(MatCreateVecs(A, nullptr, &data->normal)); /* temporary Vec used in PCApply_HPDDMShell() for coarse grid corrections */
690cdbd50ebSPierre Jolivet     } else if (!flg) {
691cdbd50ebSPierre Jolivet       PetscCall(PetscObjectTypeCompareAny((PetscObject)ksp, &flg, KSPCG, KSPGROPPCG, KSPPIPECG, KSPPIPECGRR, KSPPIPELCG, KSPPIPEPRCG, KSPPIPECG2, KSPSTCG, KSPFCG, KSPPIPEFCG, KSPMINRES, KSPNASH, KSPSYMMLQ, ""));
692cdbd50ebSPierre Jolivet       if (!flg) {
693cdbd50ebSPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPHPDDM, &flg));
694cdbd50ebSPierre Jolivet         if (flg) {
695cdbd50ebSPierre Jolivet           KSPHPDDMType type;
696811e8887SPierre Jolivet 
697cdbd50ebSPierre Jolivet           PetscCall(KSPHPDDMGetType(ksp, &type));
698cdbd50ebSPierre Jolivet           flg = (type == KSP_HPDDM_TYPE_CG || type == KSP_HPDDM_TYPE_BCG || type == KSP_HPDDM_TYPE_BFBCG ? PETSC_TRUE : PETSC_FALSE);
699cdbd50ebSPierre Jolivet         }
700cdbd50ebSPierre Jolivet       }
701cdbd50ebSPierre Jolivet     }
702cdbd50ebSPierre Jolivet     if (flg) {
703cdbd50ebSPierre Jolivet       if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) {
704cdbd50ebSPierre Jolivet         PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_hpddm_coarse_correction", &flg));
705cdbd50ebSPierre 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",
706cdbd50ebSPierre Jolivet                    PCHPDDMCoarseCorrectionTypes[data->correction], ((PetscObject)ksp)->type_name, ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", PCHPDDMCoarseCorrectionTypes[data->correction], PCHPDDMCoarseCorrectionTypes[PC_HPDDM_COARSE_CORRECTION_BALANCED]);
707cdbd50ebSPierre Jolivet       }
708cdbd50ebSPierre Jolivet       for (PetscInt n = 0; n < data->N; ++n) {
709cdbd50ebSPierre Jolivet         if (data->levels[n]->pc) {
710cdbd50ebSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)data->levels[n]->pc, PCASM, &flg));
711cdbd50ebSPierre Jolivet           if (flg) {
712cdbd50ebSPierre Jolivet             PCASMType type;
713811e8887SPierre Jolivet 
714cdbd50ebSPierre Jolivet             PetscCall(PCASMGetType(data->levels[n]->pc, &type));
715cdbd50ebSPierre Jolivet             if (type == PC_ASM_RESTRICT || type == PC_ASM_INTERPOLATE) {
716cdbd50ebSPierre Jolivet               PetscCall(PetscOptionsHasName(((PetscObject)data->levels[n]->pc)->options, ((PetscObject)data->levels[n]->pc)->prefix, "-pc_asm_type", &flg));
717cdbd50ebSPierre 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],
718cdbd50ebSPierre Jolivet                          ((PetscObject)ksp)->type_name, ((PetscObject)data->levels[n]->pc)->prefix, PCASMTypes[type], PCASMTypes[PC_ASM_BASIC]);
719cdbd50ebSPierre Jolivet             }
720cdbd50ebSPierre Jolivet           }
721cdbd50ebSPierre Jolivet         }
722cdbd50ebSPierre Jolivet       }
723f1580f4eSBarry Smith     }
724f1580f4eSBarry Smith   }
7253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
726f1580f4eSBarry Smith }
727f1580f4eSBarry Smith 
728d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDMShell(PC pc)
729d71ae5a4SJacob Faibussowitsch {
730f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
731f1580f4eSBarry Smith   Mat             A, P;
732f1580f4eSBarry Smith   Vec             x;
733f1580f4eSBarry Smith   const char     *pcpre;
734f1580f4eSBarry Smith 
735f1580f4eSBarry Smith   PetscFunctionBegin;
736f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
737f1580f4eSBarry Smith   PetscCall(KSPGetOptionsPrefix(ctx->ksp, &pcpre));
738f1580f4eSBarry Smith   PetscCall(KSPGetOperators(ctx->ksp, &A, &P));
739f1580f4eSBarry Smith   /* smoother */
740f1580f4eSBarry Smith   PetscCall(PCSetOptionsPrefix(ctx->pc, pcpre));
741f1580f4eSBarry Smith   PetscCall(PCSetOperators(ctx->pc, A, P));
742f1580f4eSBarry Smith   if (!ctx->v[0]) {
743f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(ctx->D, 1, &ctx->v[0]));
744f1580f4eSBarry Smith     if (!std::is_same<PetscScalar, PetscReal>::value) PetscCall(VecDestroy(&ctx->D));
745db4a47b3SPierre Jolivet     PetscCall(MatCreateVecs(A, &x, nullptr));
746f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(x, 2, &ctx->v[1]));
747f1580f4eSBarry Smith     PetscCall(VecDestroy(&x));
748f1580f4eSBarry Smith   }
749f1580f4eSBarry Smith   std::fill_n(ctx->V, 3, nullptr);
7503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
751f1580f4eSBarry Smith }
752f1580f4eSBarry Smith 
753d4f06b61SRaphael Zanella template <bool transpose = false, class Type = Vec, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
754d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type x, Type y)
755d71ae5a4SJacob Faibussowitsch {
756f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
757f1580f4eSBarry Smith   PetscScalar    *out;
758f1580f4eSBarry Smith 
759f1580f4eSBarry Smith   PetscFunctionBegin;
760f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
761f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
762f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
763f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
764f1580f4eSBarry Smith   PetscCall(VecGetArrayWrite(ctx->v[0][0], &out));
76501962aebSPierre Jolivet   PetscCallCXX(ctx->P->deflation<false, transpose>(nullptr, out, 1)); /* y = Q x */
766f1580f4eSBarry Smith   PetscCall(VecRestoreArrayWrite(ctx->v[0][0], &out));
767f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
768f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
769f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
7703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
771f1580f4eSBarry Smith }
772f1580f4eSBarry Smith 
7738cb7430dSRaphael Zanella template <bool transpose = false, class Type = Mat, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
774d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type X, Type Y)
775d71ae5a4SJacob Faibussowitsch {
776f1580f4eSBarry Smith   PC_HPDDM_Level    *ctx;
777b04479c2SPierre Jolivet   PetscSF            strided;
778b04479c2SPierre Jolivet   const PetscScalar *in;
779b04479c2SPierre Jolivet   PetscScalar       *out, *tmp;
780b04479c2SPierre Jolivet   PetscInt           N, ld[2];
781b04479c2SPierre Jolivet   PetscMemType       type[2];
782f1580f4eSBarry Smith 
783f1580f4eSBarry Smith   PetscFunctionBegin;
784f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
785db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
786b04479c2SPierre Jolivet   PetscCall(PetscObjectQuery((PetscObject)ctx->scatter, "_HPDDM_StridedSF", (PetscObject *)&strided));
787b04479c2SPierre Jolivet   PetscCall(MatDenseGetLDA(X, ld));
788b04479c2SPierre Jolivet   PetscCall(MatDenseGetLDA(Y, ld + 1));
789b04479c2SPierre Jolivet   PetscCheck(ld[0] == ld[1], PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Leading dimension of input Mat different than the one of output Mat");
790b04479c2SPierre Jolivet   PetscCall(MatDenseGetLDA(ctx->V[0], ld + 1));
791b04479c2SPierre Jolivet   if (strided) {
792b04479c2SPierre Jolivet     PetscInt nroots[2], nleafs[2];
793b04479c2SPierre Jolivet 
794b04479c2SPierre Jolivet     PetscCall(PetscSFGetGraph(ctx->scatter, nroots, nleafs, nullptr, nullptr));
795b04479c2SPierre Jolivet     PetscCall(PetscSFGetGraph(strided, nroots + 1, nleafs + 1, nullptr, nullptr));
796b04479c2SPierre Jolivet     if (N * nroots[0] != nroots[1] || N * nleafs[0] != nleafs[1]) PetscCall(PetscSFDestroy(&strided));
797b04479c2SPierre Jolivet   }
798b04479c2SPierre Jolivet   if (!strided) {
799b04479c2SPierre Jolivet     PetscCall(PetscSFCreateStridedSF(ctx->scatter, N, ld[0], ld[1], &strided));
800b04479c2SPierre Jolivet     PetscCall(PetscObjectCompose((PetscObject)ctx->scatter, "_HPDDM_StridedSF", (PetscObject)strided));
801b04479c2SPierre Jolivet     PetscCall(PetscObjectDereference((PetscObject)strided));
802b04479c2SPierre Jolivet   }
803b04479c2SPierre Jolivet   PetscCall(MatDenseGetArrayReadAndMemType(X, &in, type));
804b04479c2SPierre Jolivet   PetscCall(MatDenseGetArrayWriteAndMemType(ctx->V[0], &tmp, type + 1));
805f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
806b04479c2SPierre Jolivet   PetscCall(PetscSFBcastWithMemTypeBegin(strided, strided->vscat.unit, type[0], in, type[1], tmp, MPI_REPLACE));
807b04479c2SPierre Jolivet   PetscCall(PetscSFBcastEnd(strided, strided->vscat.unit, in, tmp, MPI_REPLACE));
808b04479c2SPierre Jolivet   PetscCall(MatDenseRestoreArrayReadAndMemType(X, &in));
809b04479c2SPierre Jolivet   PetscCallCXX(ctx->P->deflation<false, transpose>(nullptr, tmp, N)); /* Y = Q X */
810b04479c2SPierre Jolivet   PetscCall(MatDenseGetArrayWriteAndMemType(Y, &out, type + 1));
811f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
812b04479c2SPierre Jolivet   PetscCall(PetscSFReduceWithMemTypeBegin(strided, strided->vscat.unit, type[0], tmp, type[1], out, MPI_REPLACE));
813b04479c2SPierre Jolivet   PetscCall(PetscSFReduceEnd(strided, strided->vscat.unit, tmp, out, MPI_REPLACE));
814b04479c2SPierre Jolivet   PetscCall(MatDenseRestoreArrayWriteAndMemType(Y, &out));
815b04479c2SPierre Jolivet   PetscCall(MatDenseRestoreArrayWriteAndMemType(ctx->V[0], &tmp));
8163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
817f1580f4eSBarry Smith }
818f1580f4eSBarry Smith 
819f1580f4eSBarry Smith /*
820aa1539e9SPierre 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.
821f1580f4eSBarry Smith 
822f1580f4eSBarry Smith .vb
823f1580f4eSBarry Smith    (1) y =                  Pmat^-1              x + Q x,
824f1580f4eSBarry Smith    (2) y =                  Pmat^-1 (I - Amat Q) x + Q x (default),
82501962aebSPierre Jolivet    (3) y = (I - Q^T Amat^T) Pmat^-1 (I - Amat Q) x + Q x,
826aa1539e9SPierre Jolivet    (4) y =                  Pmat^-1              x      .
827f1580f4eSBarry Smith .ve
828f1580f4eSBarry Smith 
829f1580f4eSBarry Smith    Input Parameters:
830f1580f4eSBarry Smith +     pc - preconditioner context
831f1580f4eSBarry Smith -     x - input vector
832f1580f4eSBarry Smith 
833f1580f4eSBarry Smith    Output Parameter:
834f1580f4eSBarry Smith .     y - output vector
835f1580f4eSBarry Smith 
836f1580f4eSBarry Smith    Notes:
837f1580f4eSBarry 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.
838f1580f4eSBarry 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.
839f1580f4eSBarry 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.
840f1580f4eSBarry Smith 
841f1580f4eSBarry Smith    Level: advanced
842f1580f4eSBarry Smith 
843f1580f4eSBarry Smith    Developer Note:
844f1580f4eSBarry 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
845f1580f4eSBarry Smith    to trigger it. Likely the manual page is `PCHPDDM`
846f1580f4eSBarry Smith 
847562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
848f1580f4eSBarry Smith */
849d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDMShell(PC pc, Vec x, Vec y)
850d71ae5a4SJacob Faibussowitsch {
851f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
852f1580f4eSBarry Smith   Mat             A;
853f1580f4eSBarry Smith 
854f1580f4eSBarry Smith   PetscFunctionBegin;
855f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
856f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
857db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
858aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApply(ctx->pc, x, y)); /* y = M^-1 x */
859aa1539e9SPierre Jolivet   else {
860f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, x, y)); /* y = Q x */
861f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
862f1580f4eSBarry Smith       if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMult(A, y, ctx->v[1][0])); /* y = A Q x */
8638a8e6071SPierre Jolivet       else {
8648a8e6071SPierre Jolivet         /* KSPLSQR and finest level */
8658a8e6071SPierre Jolivet         PetscCall(MatMult(A, y, ctx->parent->normal));                              /* y = A Q x                 */
866f1580f4eSBarry Smith         PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][0])); /* y = A^T A Q x             */
867f1580f4eSBarry Smith       }
868f1580f4eSBarry Smith       PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x)); /* y = (I - A Q) x                               */
869f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, ctx->v[1][1], ctx->v[1][0]));  /* y = M^-1 (I - A Q) x                          */
870f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
871f1580f4eSBarry 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 */
872f1580f4eSBarry Smith         else {
873f1580f4eSBarry Smith           PetscCall(MatMult(A, ctx->v[1][0], ctx->parent->normal));
874f1580f4eSBarry Smith           PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][1])); /* z = A^T A y             */
875f1580f4eSBarry Smith         }
87601962aebSPierre Jolivet         PetscCall(PCHPDDMDeflate_Private<true>(pc, ctx->v[1][1], ctx->v[1][1])); /* z = Q^T z                    */
87701962aebSPierre Jolivet         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 x    */
878f1580f4eSBarry Smith       } else PetscCall(VecAXPY(y, 1.0, ctx->v[1][0]));                           /* y = Q M^-1 (I - A Q) x + Q x */
879f1580f4eSBarry Smith     } else {
880f1580f4eSBarry 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);
881f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, x, ctx->v[1][0]));
882f1580f4eSBarry Smith       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-1 x + Q x */
883f1580f4eSBarry Smith     }
884aa1539e9SPierre Jolivet   }
8853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
886f1580f4eSBarry Smith }
887f1580f4eSBarry Smith 
8888cb7430dSRaphael Zanella template <bool transpose>
8898cb7430dSRaphael Zanella static PetscErrorCode PCHPDDMMatApply_Private(PC_HPDDM_Level *ctx, Mat Y, PetscBool *reset)
8908cb7430dSRaphael Zanella {
8918cb7430dSRaphael Zanella   Mat            A, *ptr;
8928cb7430dSRaphael Zanella   PetscScalar   *array;
8938cb7430dSRaphael Zanella   PetscInt       m, M, N, prev = 0;
8948cb7430dSRaphael Zanella   PetscContainer container = nullptr;
8958cb7430dSRaphael Zanella 
8968cb7430dSRaphael Zanella   PetscFunctionBegin;
8978cb7430dSRaphael Zanella   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
8988cb7430dSRaphael Zanella   PetscCall(MatGetSize(Y, nullptr, &N));
8998cb7430dSRaphael Zanella   PetscCall(PetscObjectQuery((PetscObject)A, "_HPDDM_MatProduct", (PetscObject *)&container));
9008cb7430dSRaphael Zanella   if (container) { /* MatProduct container already attached */
9012a8381b2SBarry Smith     PetscCall(PetscContainerGetPointer(container, &ptr));
9028cb7430dSRaphael Zanella     if (ptr[1] != ctx->V[2]) /* Mat has changed or may have been set first in KSPHPDDM */
9038cb7430dSRaphael Zanella       for (m = 0; m < 2; ++m) {
9048cb7430dSRaphael Zanella         PetscCall(MatDestroy(ctx->V + m + 1));
9058cb7430dSRaphael Zanella         ctx->V[m + 1] = ptr[m];
9068cb7430dSRaphael Zanella         PetscCall(PetscObjectReference((PetscObject)ctx->V[m + 1]));
9078cb7430dSRaphael Zanella       }
9088cb7430dSRaphael Zanella   }
9098cb7430dSRaphael Zanella   if (ctx->V[1]) PetscCall(MatGetSize(ctx->V[1], nullptr, &prev));
9108cb7430dSRaphael Zanella   if (N != prev || !ctx->V[0]) {
9118cb7430dSRaphael Zanella     PetscCall(MatDestroy(ctx->V));
9128cb7430dSRaphael Zanella     PetscCall(VecGetLocalSize(ctx->v[0][0], &m));
9138cb7430dSRaphael Zanella     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)Y), m, PETSC_DECIDE, PETSC_DECIDE, N, nullptr, ctx->V));
9148cb7430dSRaphael Zanella     if (N != prev) {
9158cb7430dSRaphael Zanella       PetscCall(MatDestroy(ctx->V + 1));
9168cb7430dSRaphael Zanella       PetscCall(MatDestroy(ctx->V + 2));
9178cb7430dSRaphael Zanella       PetscCall(MatGetLocalSize(Y, &m, nullptr));
9188cb7430dSRaphael Zanella       PetscCall(MatGetSize(Y, &M, nullptr));
9198cb7430dSRaphael Zanella       if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
9208cb7430dSRaphael Zanella       else array = nullptr;
9218cb7430dSRaphael Zanella       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)Y), m, PETSC_DECIDE, M, N, array, ctx->V + 1));
9228cb7430dSRaphael Zanella       if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
9238cb7430dSRaphael Zanella       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)Y), m, PETSC_DECIDE, M, N, nullptr, ctx->V + 2));
9248cb7430dSRaphael Zanella       PetscCall(MatProductCreateWithMat(A, !transpose ? Y : ctx->V[2], nullptr, ctx->V[1]));
9258cb7430dSRaphael Zanella       PetscCall(MatProductSetType(ctx->V[1], !transpose ? MATPRODUCT_AB : MATPRODUCT_AtB));
9268cb7430dSRaphael Zanella       PetscCall(MatProductSetFromOptions(ctx->V[1]));
9278cb7430dSRaphael Zanella       PetscCall(MatProductSymbolic(ctx->V[1]));
9288cb7430dSRaphael 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() */
9298cb7430dSRaphael 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 */
9308cb7430dSRaphael Zanella     }
9318cb7430dSRaphael Zanella     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
9328cb7430dSRaphael Zanella       PetscCall(MatProductCreateWithMat(A, !transpose ? ctx->V[1] : Y, nullptr, ctx->V[2]));
9338cb7430dSRaphael Zanella       PetscCall(MatProductSetType(ctx->V[2], !transpose ? MATPRODUCT_AtB : MATPRODUCT_AB));
9348cb7430dSRaphael Zanella       PetscCall(MatProductSetFromOptions(ctx->V[2]));
9358cb7430dSRaphael Zanella       PetscCall(MatProductSymbolic(ctx->V[2]));
9368cb7430dSRaphael Zanella     }
93701962aebSPierre Jolivet     PetscCallCXX(ctx->P->start(N));
9388cb7430dSRaphael Zanella   }
9398cb7430dSRaphael Zanella   if (N == prev || container) { /* when MatProduct container is attached, always need to MatProductReplaceMats() since KSPHPDDM may have replaced the Mat as well */
9408cb7430dSRaphael Zanella     PetscCall(MatProductReplaceMats(nullptr, !transpose ? Y : ctx->V[2], nullptr, ctx->V[1]));
9418cb7430dSRaphael Zanella     if (container && ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) {
9428cb7430dSRaphael Zanella       PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
9438cb7430dSRaphael Zanella       PetscCall(MatDensePlaceArray(ctx->V[1], array));
9448cb7430dSRaphael Zanella       PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
9458cb7430dSRaphael Zanella       *reset = PETSC_TRUE;
9468cb7430dSRaphael Zanella     }
9478cb7430dSRaphael Zanella   }
9488cb7430dSRaphael Zanella   PetscFunctionReturn(PETSC_SUCCESS);
9498cb7430dSRaphael Zanella }
9508cb7430dSRaphael Zanella 
951f1580f4eSBarry Smith /*
952f1580f4eSBarry Smith      PCMatApply_HPDDMShell - Variant of PCApply_HPDDMShell() for blocks of vectors.
953f1580f4eSBarry Smith 
954f1580f4eSBarry Smith    Input Parameters:
955f1580f4eSBarry Smith +     pc - preconditioner context
956f1580f4eSBarry Smith -     X - block of input vectors
957f1580f4eSBarry Smith 
958f1580f4eSBarry Smith    Output Parameter:
959f1580f4eSBarry Smith .     Y - block of output vectors
960f1580f4eSBarry Smith 
961f1580f4eSBarry Smith    Level: advanced
962f1580f4eSBarry Smith 
963562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
964f1580f4eSBarry Smith */
965d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDMShell(PC pc, Mat X, Mat Y)
966d71ae5a4SJacob Faibussowitsch {
967f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
968f1580f4eSBarry Smith   PetscBool       reset = PETSC_FALSE;
969f1580f4eSBarry Smith 
970f1580f4eSBarry Smith   PetscFunctionBegin;
971f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
972f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
973aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApply(ctx->pc, X, Y));
974aa1539e9SPierre Jolivet   else {
9758cb7430dSRaphael Zanella     PetscCall(PCHPDDMMatApply_Private<false>(ctx, Y, &reset));
976f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, X, Y));
977f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
978f1580f4eSBarry Smith       PetscCall(MatProductNumeric(ctx->V[1]));
979f1580f4eSBarry Smith       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
980f1580f4eSBarry Smith       PetscCall(MatAXPY(ctx->V[2], -1.0, X, SAME_NONZERO_PATTERN));
981f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, ctx->V[2], ctx->V[1]));
982f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
983f1580f4eSBarry Smith         PetscCall(MatProductNumeric(ctx->V[2]));
98401962aebSPierre Jolivet         PetscCall(PCHPDDMDeflate_Private<true>(pc, ctx->V[2], ctx->V[2]));
985f1580f4eSBarry Smith         PetscCall(MatAXPY(ctx->V[1], -1.0, ctx->V[2], SAME_NONZERO_PATTERN));
986f1580f4eSBarry Smith       }
987f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
988f1580f4eSBarry Smith     } else {
989f1580f4eSBarry 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);
990f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, X, ctx->V[1]));
991f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
992f1580f4eSBarry Smith     }
993f1580f4eSBarry Smith     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
994aa1539e9SPierre Jolivet   }
9953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
996f1580f4eSBarry Smith }
997f1580f4eSBarry Smith 
998d4f06b61SRaphael Zanella /*
999d4f06b61SRaphael 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.
1000d4f06b61SRaphael Zanella 
1001d4f06b61SRaphael Zanella .vb
1002d4f06b61SRaphael Zanella    (1) y =                  Pmat^-T              x + Q^T x,
1003d4f06b61SRaphael Zanella    (2) y = (I - Q^T Amat^T) Pmat^-T              x + Q^T x (default),
100401962aebSPierre Jolivet    (3) y = (I - Q^T Amat^T) Pmat^-T (I - Amat Q) x + Q^T x,
1005d4f06b61SRaphael Zanella    (4) y =                  Pmat^-T              x        .
1006d4f06b61SRaphael Zanella .ve
1007d4f06b61SRaphael Zanella 
1008d4f06b61SRaphael Zanella    Input Parameters:
1009d4f06b61SRaphael Zanella +     pc - preconditioner context
1010d4f06b61SRaphael Zanella -     x - input vector
1011d4f06b61SRaphael Zanella 
1012d4f06b61SRaphael Zanella    Output Parameter:
1013d4f06b61SRaphael Zanella .     y - output vector
1014d4f06b61SRaphael Zanella 
1015d4f06b61SRaphael Zanella    Level: advanced
1016d4f06b61SRaphael Zanella 
1017d4f06b61SRaphael Zanella    Developer Note:
1018d4f06b61SRaphael 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
1019d4f06b61SRaphael Zanella    to trigger it. Likely the manual page is `PCHPDDM`
1020d4f06b61SRaphael Zanella 
1021d4f06b61SRaphael Zanella .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
1022d4f06b61SRaphael Zanella */
1023d4f06b61SRaphael Zanella static PetscErrorCode PCApplyTranspose_HPDDMShell(PC pc, Vec x, Vec y)
1024d4f06b61SRaphael Zanella {
1025d4f06b61SRaphael Zanella   PC_HPDDM_Level *ctx;
1026d4f06b61SRaphael Zanella   Mat             A;
1027d4f06b61SRaphael Zanella 
1028d4f06b61SRaphael Zanella   PetscFunctionBegin;
1029d4f06b61SRaphael Zanella   PetscCall(PCShellGetContext(pc, &ctx));
1030d4f06b61SRaphael Zanella   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
10318cb7430dSRaphael Zanella   PetscCheck(!ctx->parent->normal, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Not implemented for the normal equations");
1032d4f06b61SRaphael Zanella   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
1033d4f06b61SRaphael Zanella   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApplyTranspose(ctx->pc, x, y)); /* y = M^-T x */
1034d4f06b61SRaphael Zanella   else {
1035d4f06b61SRaphael Zanella     PetscCall(PCHPDDMDeflate_Private<true>(pc, x, y)); /* y = Q^T x */
1036d4f06b61SRaphael Zanella     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
1037d4f06b61SRaphael Zanella       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
103801962aebSPierre Jolivet         /* TODO: checking whether Q^T = Q would make it possible to skip this coarse correction */
103901962aebSPierre Jolivet         PetscCall(PCHPDDMDeflate_Private(pc, x, ctx->v[1][1]));                /* y = Q x                     */
104001962aebSPierre Jolivet         PetscCall(MatMult(A, ctx->v[1][1], ctx->v[1][0]));                     /* y = A Q x                   */
104101962aebSPierre Jolivet         PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x));              /* y = (I - A Q) x             */
104201962aebSPierre Jolivet         PetscCall(PCApplyTranspose(ctx->pc, ctx->v[1][1], ctx->v[1][0]));      /* y = M^-T (I - A Q) x        */
1043d4f06b61SRaphael Zanella       } else PetscCall(PCApplyTranspose(ctx->pc, x, ctx->v[1][0]));            /* y = M^-T x                  */
10448cb7430dSRaphael Zanella       PetscCall(MatMultHermitianTranspose(A, ctx->v[1][0], ctx->v[1][1]));     /* z = A^T y                   */
1045d4f06b61SRaphael Zanella       PetscCall(PCHPDDMDeflate_Private<true>(pc, ctx->v[1][1], ctx->v[1][1])); /* z = Q^T z                   */
1046d4f06b61SRaphael 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 */
1047d4f06b61SRaphael Zanella     } else {
1048d4f06b61SRaphael 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);
1049d4f06b61SRaphael Zanella       PetscCall(PCApplyTranspose(ctx->pc, x, ctx->v[1][0]));
1050d4f06b61SRaphael Zanella       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-T x + Q^T x */
1051d4f06b61SRaphael Zanella     }
1052d4f06b61SRaphael Zanella   }
1053d4f06b61SRaphael Zanella   PetscFunctionReturn(PETSC_SUCCESS);
1054d4f06b61SRaphael Zanella }
1055d4f06b61SRaphael Zanella 
10568cb7430dSRaphael Zanella /*
10578cb7430dSRaphael Zanella      PCMatApplyTranspose_HPDDMShell - Variant of PCApplyTranspose_HPDDMShell() for blocks of vectors.
10588cb7430dSRaphael Zanella 
10598cb7430dSRaphael Zanella    Input Parameters:
10608cb7430dSRaphael Zanella +     pc - preconditioner context
10618cb7430dSRaphael Zanella -     X - block of input vectors
10628cb7430dSRaphael Zanella 
10638cb7430dSRaphael Zanella    Output Parameter:
10648cb7430dSRaphael Zanella .     Y - block of output vectors
10658cb7430dSRaphael Zanella 
10668cb7430dSRaphael Zanella    Level: advanced
10678cb7430dSRaphael Zanella 
10688cb7430dSRaphael Zanella .seealso: [](ch_ksp), `PCHPDDM`, `PCApplyTranspose_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
10698cb7430dSRaphael Zanella */
10708cb7430dSRaphael Zanella static PetscErrorCode PCMatApplyTranspose_HPDDMShell(PC pc, Mat X, Mat Y)
10718cb7430dSRaphael Zanella {
10728cb7430dSRaphael Zanella   PC_HPDDM_Level *ctx;
10738cb7430dSRaphael Zanella   PetscScalar    *array;
10748cb7430dSRaphael Zanella   PetscBool       reset = PETSC_FALSE;
10758cb7430dSRaphael Zanella 
10768cb7430dSRaphael Zanella   PetscFunctionBegin;
10778cb7430dSRaphael Zanella   PetscCall(PCShellGetContext(pc, &ctx));
10788cb7430dSRaphael Zanella   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
10798cb7430dSRaphael Zanella   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApplyTranspose(ctx->pc, X, Y));
108001962aebSPierre Jolivet   else if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
108101962aebSPierre Jolivet     /* similar code as in PCMatApply_HPDDMShell() with an extra call to PCHPDDMDeflate_Private<true>() */
108201962aebSPierre Jolivet     PetscCall(PCHPDDMMatApply_Private<false>(ctx, Y, &reset));
108301962aebSPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, X, Y));
108401962aebSPierre Jolivet     PetscCall(MatProductNumeric(ctx->V[1]));
108501962aebSPierre Jolivet     PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
108601962aebSPierre Jolivet     PetscCall(MatAXPY(ctx->V[2], -1.0, X, SAME_NONZERO_PATTERN));
108701962aebSPierre Jolivet     PetscCall(PCMatApplyTranspose(ctx->pc, ctx->V[2], ctx->V[1]));
108801962aebSPierre Jolivet     PetscCall(MatProductNumeric(ctx->V[2]));
108901962aebSPierre Jolivet     PetscCall(PCHPDDMDeflate_Private<true>(pc, ctx->V[2], ctx->V[2]));
109001962aebSPierre Jolivet     PetscCall(MatAXPY(ctx->V[1], -1.0, ctx->V[2], SAME_NONZERO_PATTERN));
109101962aebSPierre Jolivet     PetscCall(PCHPDDMDeflate_Private<true>(pc, X, Y)); /* TODO: checking whether Q^T = Q would make it possible to skip this coarse correction */
109201962aebSPierre Jolivet     PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
109301962aebSPierre Jolivet   } else {
10948cb7430dSRaphael Zanella     PetscCall(PCHPDDMMatApply_Private<true>(ctx, Y, &reset));
10958cb7430dSRaphael Zanella     PetscCall(PCHPDDMDeflate_Private<true>(pc, X, Y));
109601962aebSPierre Jolivet     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) {
109701962aebSPierre Jolivet       PetscCall(PCMatApplyTranspose(ctx->pc, X, ctx->V[2]));
10988cb7430dSRaphael Zanella       PetscCall(MatAXPY(Y, 1.0, ctx->V[2], SAME_NONZERO_PATTERN));
10998cb7430dSRaphael Zanella       PetscCall(MatProductNumeric(ctx->V[1]));
1100847b6ef2SPierre Jolivet       /* ctx->V[0] and ctx->V[1] memory regions overlap, so need to copy to ctx->V[2] and switch array */
11018cb7430dSRaphael Zanella       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
1102847b6ef2SPierre Jolivet       if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
11038cb7430dSRaphael Zanella       PetscCall(MatDenseGetArrayWrite(ctx->V[2], &array));
11048cb7430dSRaphael Zanella       PetscCall(MatDensePlaceArray(ctx->V[1], array));
11058cb7430dSRaphael Zanella       PetscCall(MatDenseRestoreArrayWrite(ctx->V[2], &array));
1106847b6ef2SPierre Jolivet       reset = PETSC_TRUE;
11078cb7430dSRaphael Zanella       PetscCall(PCHPDDMDeflate_Private<true>(pc, ctx->V[1], ctx->V[1]));
11088cb7430dSRaphael Zanella       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
11098cb7430dSRaphael Zanella     } else {
11108cb7430dSRaphael 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);
11118cb7430dSRaphael Zanella       PetscCall(PCMatApplyTranspose(ctx->pc, X, ctx->V[1]));
11128cb7430dSRaphael Zanella       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
11138cb7430dSRaphael Zanella     }
11148cb7430dSRaphael Zanella     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
11158cb7430dSRaphael Zanella   }
11168cb7430dSRaphael Zanella   PetscFunctionReturn(PETSC_SUCCESS);
11178cb7430dSRaphael Zanella }
11188cb7430dSRaphael Zanella 
1119d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDMShell(PC pc)
1120d71ae5a4SJacob Faibussowitsch {
1121f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
1122f1580f4eSBarry Smith 
1123f1580f4eSBarry Smith   PetscFunctionBegin;
1124f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
1125f1580f4eSBarry Smith   PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(ctx, PETSC_TRUE));
1126f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(1, &ctx->v[0]));
1127f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(2, &ctx->v[1]));
1128f4f49eeaSPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", nullptr));
1129f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V));
1130f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 1));
1131f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 2));
1132f1580f4eSBarry Smith   PetscCall(VecDestroy(&ctx->D));
1133b04479c2SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)ctx->scatter, "_HPDDM_StridedSF", nullptr));
113401e3c840SPierre Jolivet   PetscCall(PetscSFDestroy(&ctx->scatter));
1135f1580f4eSBarry Smith   PetscCall(PCDestroy(&ctx->pc));
11363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1137f1580f4eSBarry Smith }
1138f1580f4eSBarry Smith 
11399bb5c669SPierre Jolivet template <class Type, bool T = false, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
11409bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type x, Type y)
11419bb5c669SPierre Jolivet {
11429bb5c669SPierre Jolivet   PetscFunctionBegin;
11439bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[0], std::get<1>(*p), SCATTER_FORWARD, x));
11449bb5c669SPierre Jolivet   if (!T) PetscCall(PCApply(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
11459bb5c669SPierre Jolivet   else PetscCall(PCApplyTranspose(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
11469bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[1], std::get<1>(*p), SCATTER_REVERSE, y));
11479bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
11489bb5c669SPierre Jolivet }
11499bb5c669SPierre Jolivet 
11509bb5c669SPierre Jolivet template <class Type, bool = false, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
11519bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type X, Type Y)
11529bb5c669SPierre Jolivet {
11539bb5c669SPierre Jolivet   Mat B[2];
11549bb5c669SPierre Jolivet   Vec x, y;
11559bb5c669SPierre Jolivet 
11569bb5c669SPierre Jolivet   PetscFunctionBegin;
11579bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B));
11589bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B + 1));
11599bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
11609bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(X, i, &x));
11619bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B[0], i, &y));
11629bb5c669SPierre Jolivet     PetscCall(VecISCopy(y, std::get<1>(*p), SCATTER_FORWARD, x));
11639bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B[0], i, &y));
11649bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(X, i, &x));
11659bb5c669SPierre Jolivet   }
11669bb5c669SPierre Jolivet   PetscCall(PCMatApply(factor, B[0], B[1]));
11679bb5c669SPierre Jolivet   PetscCall(MatDestroy(B));
11689bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
11699bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B[1], i, &x));
11709bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &y));
11719bb5c669SPierre Jolivet     PetscCall(VecISCopy(x, std::get<1>(*p), SCATTER_REVERSE, y));
11729bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &y));
11739bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B[1], i, &x));
11749bb5c669SPierre Jolivet   }
11759bb5c669SPierre Jolivet   PetscCall(MatDestroy(B + 1));
11769bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
11779bb5c669SPierre Jolivet }
11789bb5c669SPierre Jolivet 
11799bb5c669SPierre Jolivet template <class Type = Vec, bool T = false>
11809bb5c669SPierre Jolivet static PetscErrorCode PCApply_Schur(PC pc, Type x, Type y)
11819bb5c669SPierre Jolivet {
11829bb5c669SPierre Jolivet   PC                           factor;
11839bb5c669SPierre Jolivet   Mat                          A;
11849bb5c669SPierre Jolivet   MatSolverType                type;
11859bb5c669SPierre Jolivet   PetscBool                    flg;
11869bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
11879bb5c669SPierre Jolivet 
11889bb5c669SPierre Jolivet   PetscFunctionBegin;
11899bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
11909bb5c669SPierre Jolivet   PetscCall(KSPGetPC(std::get<0>(*p), &factor));
11919bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(factor, &type));
11929bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatrix(factor, &A));
11939bb5c669SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
11949bb5c669SPierre Jolivet   if (flg) {
11959bb5c669SPierre Jolivet     PetscCheck(PetscDefined(HAVE_MUMPS), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
11969bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 0));
11979bb5c669SPierre Jolivet   } else {
11989bb5c669SPierre Jolivet     PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &flg));
11999bb5c669SPierre Jolivet     PetscCheck(flg && PetscDefined(HAVE_MKL_PARDISO), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
12009bb5c669SPierre Jolivet     flg = PETSC_FALSE;
12019bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
12029bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 1));
12039bb5c669SPierre Jolivet #endif
12049bb5c669SPierre Jolivet   }
12059bb5c669SPierre Jolivet   PetscCall(PCApply_Schur_Private<Type, T>(p, factor, x, y));
12069bb5c669SPierre Jolivet   if (flg) {
12079bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1));
12089bb5c669SPierre Jolivet   } else {
12099bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
12109bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 0));
12119bb5c669SPierre Jolivet #endif
12129bb5c669SPierre Jolivet   }
12139bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
12149bb5c669SPierre Jolivet }
12159bb5c669SPierre Jolivet 
12169bb5c669SPierre Jolivet static PetscErrorCode PCDestroy_Schur(PC pc)
12179bb5c669SPierre Jolivet {
12189bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
12199bb5c669SPierre Jolivet 
12209bb5c669SPierre Jolivet   PetscFunctionBegin;
12219bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
12229bb5c669SPierre Jolivet   PetscCall(ISDestroy(&std::get<1>(*p)));
12239bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p)));
12249bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p) + 1));
12259bb5c669SPierre Jolivet   PetscCall(PetscFree(p));
12269bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
12279bb5c669SPierre Jolivet }
12289bb5c669SPierre Jolivet 
1229d4f06b61SRaphael Zanella template <bool transpose>
1230d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSolve_Private(const PC_HPDDM_Level *ctx, PetscScalar *rhs, const unsigned short &mu)
1231d71ae5a4SJacob Faibussowitsch {
1232f1580f4eSBarry Smith   Mat      B, X;
1233f1580f4eSBarry Smith   PetscInt n, N, j = 0;
1234f1580f4eSBarry Smith 
1235f1580f4eSBarry Smith   PetscFunctionBegin;
1236db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &B, nullptr));
1237db4a47b3SPierre Jolivet   PetscCall(MatGetLocalSize(B, &n, nullptr));
1238db4a47b3SPierre Jolivet   PetscCall(MatGetSize(B, &N, nullptr));
1239f1580f4eSBarry Smith   if (ctx->parent->log_separate) {
1240f1580f4eSBarry Smith     j = std::distance(ctx->parent->levels, std::find(ctx->parent->levels, ctx->parent->levels + ctx->parent->N, ctx));
1241db4a47b3SPierre Jolivet     PetscCall(PetscLogEventBegin(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
1242f1580f4eSBarry Smith   }
1243f1580f4eSBarry Smith   if (mu == 1) {
1244f1580f4eSBarry Smith     if (!ctx->ksp->vec_rhs) {
1245db4a47b3SPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ctx->ksp), 1, n, N, nullptr, &ctx->ksp->vec_rhs));
1246f1580f4eSBarry Smith       PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)ctx->ksp), n, N, &ctx->ksp->vec_sol));
1247f1580f4eSBarry Smith     }
1248f1580f4eSBarry Smith     PetscCall(VecPlaceArray(ctx->ksp->vec_rhs, rhs));
1249d4f06b61SRaphael Zanella     if (!transpose) PetscCall(KSPSolve(ctx->ksp, nullptr, nullptr));
125001962aebSPierre Jolivet     else {
125101962aebSPierre Jolivet       PetscCall(VecConjugate(ctx->ksp->vec_rhs));
125201962aebSPierre Jolivet       PetscCall(KSPSolveTranspose(ctx->ksp, nullptr, nullptr)); /* TODO: missing KSPSolveHermitianTranspose() */
125301962aebSPierre Jolivet       PetscCall(VecConjugate(ctx->ksp->vec_sol));
125401962aebSPierre Jolivet     }
1255f1580f4eSBarry Smith     PetscCall(VecCopy(ctx->ksp->vec_sol, ctx->ksp->vec_rhs));
1256f1580f4eSBarry Smith     PetscCall(VecResetArray(ctx->ksp->vec_rhs));
1257f1580f4eSBarry Smith   } else {
1258f1580f4eSBarry Smith     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, rhs, &B));
1259db4a47b3SPierre Jolivet     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, nullptr, &X));
126001962aebSPierre Jolivet     if (!transpose) PetscCall(KSPMatSolve(ctx->ksp, B, X));
126101962aebSPierre Jolivet     else {
126201962aebSPierre Jolivet       PetscCall(MatConjugate(B));
126301962aebSPierre Jolivet       PetscCall(KSPMatSolveTranspose(ctx->ksp, B, X)); /* TODO: missing KSPMatSolveHermitianTranspose() */
126401962aebSPierre Jolivet       PetscCall(MatConjugate(X));
126501962aebSPierre Jolivet     }
1266f1580f4eSBarry Smith     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
1267f1580f4eSBarry Smith     PetscCall(MatDestroy(&X));
1268f1580f4eSBarry Smith     PetscCall(MatDestroy(&B));
1269f1580f4eSBarry Smith   }
1270db4a47b3SPierre Jolivet   if (ctx->parent->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
12713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1272f1580f4eSBarry Smith }
1273f1580f4eSBarry Smith 
1274d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetUpNeumannOverlap_Private(PC pc)
1275d71ae5a4SJacob Faibussowitsch {
1276f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
1277f1580f4eSBarry Smith 
1278f1580f4eSBarry Smith   PetscFunctionBegin;
1279f1580f4eSBarry Smith   if (data->setup) {
1280f1580f4eSBarry Smith     Mat       P;
1281db4a47b3SPierre Jolivet     Vec       x, xt = nullptr;
1282f1580f4eSBarry Smith     PetscReal t = 0.0, s = 0.0;
1283f1580f4eSBarry Smith 
1284db4a47b3SPierre Jolivet     PetscCall(PCGetOperators(pc, nullptr, &P));
1285f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)P, "__SNES_latest_X", (PetscObject *)&x));
1286f1580f4eSBarry Smith     PetscCallBack("PCHPDDM Neumann callback", (*data->setup)(data->aux, t, x, xt, s, data->is, data->setup_ctx));
1287f1580f4eSBarry Smith   }
12883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1289f1580f4eSBarry Smith }
1290f1580f4eSBarry Smith 
1291d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCreateSubMatrices_Private(Mat mat, PetscInt n, const IS *, const IS *, MatReuse scall, Mat *submat[])
1292d71ae5a4SJacob Faibussowitsch {
1293f1580f4eSBarry Smith   Mat       A;
129413044ca3SPierre Jolivet   PetscBool flg;
1295f1580f4eSBarry Smith 
1296f1580f4eSBarry Smith   PetscFunctionBegin;
1297f1580f4eSBarry Smith   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatCreateSubMatrices() called to extract %" PetscInt_FMT " submatrices, which is different than 1", n);
1298f1580f4eSBarry Smith   /* previously composed Mat */
1299f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)mat, "_PCHPDDM_SubMatrices", (PetscObject *)&A));
1300f1580f4eSBarry Smith   PetscCheck(A, PETSC_COMM_SELF, PETSC_ERR_PLIB, "SubMatrices not found in Mat");
130113044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSCHURCOMPLEMENT, &flg)); /* MATSCHURCOMPLEMENT has neither a MatDuplicate() nor a MatCopy() implementation */
1302f1580f4eSBarry Smith   if (scall == MAT_INITIAL_MATRIX) {
13036f2c871aSStefano Zampini     PetscCall(PetscCalloc1(2, submat)); /* allocate an extra Mat to avoid errors in MatDestroySubMatrices_Dummy() */
130413044ca3SPierre Jolivet     if (!flg) PetscCall(MatDuplicate(A, MAT_COPY_VALUES, *submat));
130513044ca3SPierre Jolivet   } else if (!flg) PetscCall(MatCopy(A, (*submat)[0], SAME_NONZERO_PATTERN));
130613044ca3SPierre Jolivet   if (flg) {
1307bf583f0cSPierre Jolivet     PetscCall(MatDestroy(*submat)); /* previously created Mat has to be destroyed */
130813044ca3SPierre Jolivet     (*submat)[0] = A;
130913044ca3SPierre Jolivet     PetscCall(PetscObjectReference((PetscObject)A));
131013044ca3SPierre Jolivet   }
13113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1312f1580f4eSBarry Smith }
1313f1580f4eSBarry Smith 
1314d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCommunicationAvoidingPCASM_Private(PC pc, Mat C, PetscBool sorted)
1315d71ae5a4SJacob Faibussowitsch {
131657d50842SBarry Smith   PetscErrorCodeFn *op;
1317f1580f4eSBarry Smith 
1318f1580f4eSBarry Smith   PetscFunctionBegin;
1319f1580f4eSBarry Smith   /* previously-composed Mat */
1320f1580f4eSBarry Smith   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", (PetscObject)C));
1321f1580f4eSBarry Smith   PetscCall(MatGetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, &op));
1322f1580f4eSBarry Smith   /* trick suggested by Barry https://lists.mcs.anl.gov/pipermail/petsc-dev/2020-January/025491.html */
132357d50842SBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, (PetscErrorCodeFn *)PCHPDDMCreateSubMatrices_Private));
1324f1580f4eSBarry Smith   if (sorted) PetscCall(PCASMSetSortIndices(pc, PETSC_FALSE)); /* everything is already sorted */
1325f1580f4eSBarry Smith   PetscCall(PCSetFromOptions(pc));                             /* otherwise -pc_hpddm_levels_1_pc_asm_sub_mat_type is not used */
1326f1580f4eSBarry Smith   PetscCall(PCSetUp(pc));
1327f1580f4eSBarry Smith   /* reset MatCreateSubMatrices() */
1328f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, op));
1329db4a47b3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", nullptr));
13303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1331f1580f4eSBarry Smith }
1332f1580f4eSBarry Smith 
1333d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMPermute_Private(IS is, IS in_is, IS *out_is, Mat in_C, Mat *out_C, IS *p)
1334d71ae5a4SJacob Faibussowitsch {
1335f1580f4eSBarry Smith   IS                           perm;
1336f1580f4eSBarry Smith   const PetscInt              *ptr;
1337811e8887SPierre Jolivet   PetscInt                    *concatenate, size, bs;
1338f1580f4eSBarry Smith   std::map<PetscInt, PetscInt> order;
1339f1580f4eSBarry Smith   PetscBool                    sorted;
1340f1580f4eSBarry Smith 
1341f1580f4eSBarry Smith   PetscFunctionBegin;
1342cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(is, IS_CLASSID, 1);
1343cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(in_C, MAT_CLASSID, 4);
1344f1580f4eSBarry Smith   PetscCall(ISSorted(is, &sorted));
1345f1580f4eSBarry Smith   if (!sorted) {
1346f1580f4eSBarry Smith     PetscCall(ISGetLocalSize(is, &size));
1347f1580f4eSBarry Smith     PetscCall(ISGetIndices(is, &ptr));
1348b07dfdedSPierre Jolivet     PetscCall(ISGetBlockSize(is, &bs));
1349f1580f4eSBarry Smith     /* MatCreateSubMatrices(), called by PCASM, follows the global numbering of Pmat */
1350811e8887SPierre Jolivet     for (PetscInt n = 0; n < size; n += bs) order.insert(std::make_pair(ptr[n] / bs, n / bs));
1351f1580f4eSBarry Smith     PetscCall(ISRestoreIndices(is, &ptr));
1352b07dfdedSPierre Jolivet     size /= bs;
1353f1580f4eSBarry Smith     if (out_C) {
1354f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1355f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.second;
1356f1580f4eSBarry Smith       concatenate -= size;
1357b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_C), bs, size, concatenate, PETSC_OWN_POINTER, &perm));
1358f1580f4eSBarry Smith       PetscCall(ISSetPermutation(perm));
1359f1580f4eSBarry Smith       /* permute user-provided Mat so that it matches with MatCreateSubMatrices() numbering */
1360f1580f4eSBarry Smith       PetscCall(MatPermute(in_C, perm, perm, out_C));
1361f1580f4eSBarry Smith       if (p) *p = perm;
1362f1580f4eSBarry Smith       else PetscCall(ISDestroy(&perm)); /* no need to save the permutation */
1363f1580f4eSBarry Smith     }
1364f1580f4eSBarry Smith     if (out_is) {
1365f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1366f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.first;
1367f1580f4eSBarry Smith       concatenate -= size;
1368f1580f4eSBarry Smith       /* permute user-provided IS so that it matches with MatCreateSubMatrices() numbering */
1369b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_is), bs, size, concatenate, PETSC_OWN_POINTER, out_is));
1370f1580f4eSBarry Smith     }
1371f1580f4eSBarry Smith   } else { /* input IS is sorted, nothing to permute, simply duplicate inputs when needed */
1372f1580f4eSBarry Smith     if (out_C) PetscCall(MatDuplicate(in_C, MAT_COPY_VALUES, out_C));
1373f1580f4eSBarry Smith     if (out_is) PetscCall(ISDuplicate(in_is, out_is));
1374f1580f4eSBarry Smith   }
13753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1376f1580f4eSBarry Smith }
1377f1580f4eSBarry Smith 
1378281f8ce6SPierre Jolivet static PetscErrorCode PCHPDDMCheckSymmetry_Private(PC pc, Mat A01, Mat A10, Mat *B01 = nullptr)
137913044ca3SPierre Jolivet {
138013044ca3SPierre Jolivet   Mat       T, U = nullptr, B = nullptr;
138113044ca3SPierre Jolivet   IS        z;
1382281f8ce6SPierre Jolivet   PetscBool flg, conjugate = PETSC_FALSE;
138313044ca3SPierre Jolivet 
138413044ca3SPierre Jolivet   PetscFunctionBegin;
1385281f8ce6SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
1386281f8ce6SPierre Jolivet   if (B01) *B01 = nullptr;
1387281f8ce6SPierre Jolivet   if (flg) {
1388811e8887SPierre 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));
1389811e8887SPierre Jolivet     PetscCall(MatTransposeGetMat(A10, &U));
1390811e8887SPierre Jolivet   } else {
1391281f8ce6SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
1392281f8ce6SPierre Jolivet     if (flg) {
1393811e8887SPierre 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));
1394811e8887SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A10, &U));
1395281f8ce6SPierre Jolivet       conjugate = PETSC_TRUE;
1396811e8887SPierre Jolivet     }
139713044ca3SPierre Jolivet   }
139813044ca3SPierre Jolivet   if (U) PetscCall(MatDuplicate(U, MAT_COPY_VALUES, &T));
139913044ca3SPierre Jolivet   else PetscCall(MatHermitianTranspose(A10, MAT_INITIAL_MATRIX, &T));
1400281f8ce6SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATTRANSPOSEVIRTUAL, &flg));
1401281f8ce6SPierre Jolivet   if (flg) {
1402811e8887SPierre 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));
140313044ca3SPierre Jolivet     PetscCall(MatTransposeGetMat(A01, &A01));
140413044ca3SPierre Jolivet     PetscCall(MatTranspose(A01, MAT_INITIAL_MATRIX, &B));
140513044ca3SPierre Jolivet     A01 = B;
140613044ca3SPierre Jolivet   } else {
1407281f8ce6SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
1408281f8ce6SPierre Jolivet     if (flg) {
1409811e8887SPierre 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));
141013044ca3SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A01, &A01));
141113044ca3SPierre Jolivet       PetscCall(MatHermitianTranspose(A01, MAT_INITIAL_MATRIX, &B));
141213044ca3SPierre Jolivet       A01 = B;
141313044ca3SPierre Jolivet     }
141413044ca3SPierre Jolivet   }
1415281f8ce6SPierre Jolivet   PetscCall(PetscLayoutCompare(T->rmap, A01->rmap, &flg));
1416281f8ce6SPierre Jolivet   if (flg) {
1417281f8ce6SPierre Jolivet     PetscCall(PetscLayoutCompare(T->cmap, A01->cmap, &flg));
1418281f8ce6SPierre Jolivet     if (flg) {
141913044ca3SPierre Jolivet       PetscCall(MatFindZeroRows(A01, &z)); /* for essential boundary conditions, some implementations will */
142013044ca3SPierre Jolivet       if (z) {                             /*  zero rows in [P00 A01] except for the diagonal of P00       */
1421281f8ce6SPierre Jolivet         if (B01) PetscCall(MatDuplicate(T, MAT_COPY_VALUES, B01));
142213044ca3SPierre Jolivet         PetscCall(MatSetOption(T, MAT_NO_OFF_PROC_ZERO_ROWS, PETSC_TRUE));
142313044ca3SPierre Jolivet         PetscCall(MatZeroRowsIS(T, z, 0.0, nullptr, nullptr)); /* corresponding zero rows from A01 */
1424281f8ce6SPierre Jolivet       }
1425281f8ce6SPierre Jolivet       PetscCall(MatMultEqual(A01, T, 20, &flg));
1426281f8ce6SPierre Jolivet       if (!B01) PetscCheck(flg, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "A01 != A10^T");
1427281f8ce6SPierre Jolivet       else {
1428281f8ce6SPierre Jolivet         PetscCall(PetscInfo(pc, "A01 and A10^T are equal? %s\n", PetscBools[flg]));
1429281f8ce6SPierre Jolivet         if (!flg) {
1430281f8ce6SPierre Jolivet           if (z) PetscCall(MatDestroy(&T));
1431281f8ce6SPierre Jolivet           else *B01 = T;
1432281f8ce6SPierre Jolivet           flg = PETSC_TRUE;
1433281f8ce6SPierre Jolivet         } else PetscCall(MatDestroy(B01));
1434281f8ce6SPierre Jolivet       }
143513044ca3SPierre Jolivet       PetscCall(ISDestroy(&z));
143613044ca3SPierre Jolivet     }
143713044ca3SPierre Jolivet   }
1438281f8ce6SPierre Jolivet   if (!flg) PetscCall(PetscInfo(pc, "A01 and A10^T have non-congruent layouts, cannot test for equality\n"));
1439281f8ce6SPierre Jolivet   if (!B01 || !*B01) PetscCall(MatDestroy(&T));
1440281f8ce6SPierre Jolivet   else if (conjugate) PetscCall(MatConjugate(T));
144113044ca3SPierre Jolivet   PetscCall(MatDestroy(&B));
144213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
144313044ca3SPierre Jolivet }
144413044ca3SPierre Jolivet 
1445d16c0b94SPierre Jolivet static PetscErrorCode PCHPDDMCheckInclusion_Private(PC pc, IS is, IS is_local, PetscBool check)
1446d16c0b94SPierre Jolivet {
1447d16c0b94SPierre Jolivet   IS          intersect;
1448d16c0b94SPierre Jolivet   const char *str = "IS of the auxiliary Mat does not include all local rows of A";
1449d16c0b94SPierre Jolivet   PetscBool   equal;
1450d16c0b94SPierre Jolivet 
1451d16c0b94SPierre Jolivet   PetscFunctionBegin;
1452d16c0b94SPierre Jolivet   PetscCall(ISIntersect(is, is_local, &intersect));
1453d16c0b94SPierre Jolivet   PetscCall(ISEqualUnsorted(is_local, intersect, &equal));
1454d16c0b94SPierre Jolivet   PetscCall(ISDestroy(&intersect));
1455d16c0b94SPierre Jolivet   if (check) PetscCheck(equal, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "%s", str);
1456d16c0b94SPierre Jolivet   else if (!equal) PetscCall(PetscInfo(pc, "%s\n", str));
1457d16c0b94SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1458d16c0b94SPierre Jolivet }
1459d16c0b94SPierre Jolivet 
14608a8e6071SPierre Jolivet static PetscErrorCode PCHPDDMCheckMatStructure_Private(PC pc, Mat A, Mat B)
14618a8e6071SPierre Jolivet {
14628a8e6071SPierre Jolivet   Mat             X, Y;
14638a8e6071SPierre Jolivet   const PetscInt *i[2], *j[2];
14648a8e6071SPierre Jolivet   PetscBool       flg = PETSC_TRUE;
14658a8e6071SPierre Jolivet 
14668a8e6071SPierre Jolivet   PetscFunctionBegin;
14678a8e6071SPierre Jolivet   PetscCall(MatConvert(A, MATAIJ, MAT_INITIAL_MATRIX, &X)); /* no common way to compare sparsity pattern, so just convert to MATSEQAIJ */
14688a8e6071SPierre 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) */
14698a8e6071SPierre Jolivet   PetscCall(MatSeqAIJGetCSRAndMemType(X, &i[0], &j[0], nullptr, nullptr));
14708a8e6071SPierre Jolivet   PetscCall(MatSeqAIJGetCSRAndMemType(Y, &i[1], &j[1], nullptr, nullptr));
14718a8e6071SPierre Jolivet   for (PetscInt row = 0; (row < X->rmap->n) && flg; ++row) {
14728a8e6071SPierre Jolivet     const PetscInt n = i[0][row + 1] - i[0][row];
14738a8e6071SPierre Jolivet 
147401962aebSPierre Jolivet     for (PetscInt k = i[1][row], location; k < i[1][row + 1]; ++k) {
147501962aebSPierre Jolivet       PetscCall(PetscFindInt(j[1][k], n, j[0] + i[0][row], &location));
147601962aebSPierre Jolivet       if (location < 0) {
14778a8e6071SPierre Jolivet         flg = PETSC_FALSE;
14788a8e6071SPierre Jolivet         break;
14798a8e6071SPierre Jolivet       }
14808a8e6071SPierre Jolivet     }
14818a8e6071SPierre Jolivet   }
14828a8e6071SPierre Jolivet   PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &flg, 1, MPI_C_BOOL, MPI_LAND, PetscObjectComm((PetscObject)pc)));
14838a8e6071SPierre 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");
14848a8e6071SPierre Jolivet   PetscCall(MatDestroy(&Y));
14858a8e6071SPierre Jolivet   PetscCall(MatDestroy(&X));
14868a8e6071SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
14878a8e6071SPierre Jolivet }
14888a8e6071SPierre Jolivet 
1489d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMDestroySubMatrices_Private(PetscBool flg, PetscBool algebraic, Mat *sub)
1490d71ae5a4SJacob Faibussowitsch {
1491f1580f4eSBarry Smith   IS is;
1492f1580f4eSBarry Smith 
1493f1580f4eSBarry Smith   PetscFunctionBegin;
1494f1580f4eSBarry Smith   if (!flg) {
1495f1580f4eSBarry Smith     if (algebraic) {
1496f1580f4eSBarry Smith       PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Embed", (PetscObject *)&is));
1497f1580f4eSBarry Smith       PetscCall(ISDestroy(&is));
1498db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Embed", nullptr));
1499db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Compact", nullptr));
1500f1580f4eSBarry Smith     }
1501f1580f4eSBarry Smith     PetscCall(MatDestroySubMatrices(algebraic ? 2 : 1, &sub));
1502f1580f4eSBarry Smith   }
15033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1504f1580f4eSBarry Smith }
1505f1580f4eSBarry Smith 
1506d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMAlgebraicAuxiliaryMat_Private(Mat P, IS *is, Mat *sub[], PetscBool block)
1507d71ae5a4SJacob Faibussowitsch {
1508f1580f4eSBarry Smith   IS         icol[3], irow[2];
1509f1580f4eSBarry Smith   Mat       *M, Q;
1510f1580f4eSBarry Smith   PetscReal *ptr;
151158b7e2c1SStefano Zampini   PetscInt  *idx, p = 0, bs = P->cmap->bs;
1512f1580f4eSBarry Smith   PetscBool  flg;
1513f1580f4eSBarry Smith 
1514f1580f4eSBarry Smith   PetscFunctionBegin;
1515f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, P->cmap->N, 0, 1, icol + 2));
1516f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(icol[2], bs));
1517f1580f4eSBarry Smith   PetscCall(ISSetIdentity(icol[2]));
1518f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1519f1580f4eSBarry Smith   if (flg) {
1520f1580f4eSBarry Smith     /* MatCreateSubMatrices() does not handle MATMPISBAIJ properly when iscol != isrow, so convert first to MATMPIBAIJ */
1521f1580f4eSBarry Smith     PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &Q));
1522f1580f4eSBarry Smith     std::swap(P, Q);
1523f1580f4eSBarry Smith   }
1524f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(P, 1, is, icol + 2, MAT_INITIAL_MATRIX, &M));
1525f1580f4eSBarry Smith   if (flg) {
1526f1580f4eSBarry Smith     std::swap(P, Q);
1527f1580f4eSBarry Smith     PetscCall(MatDestroy(&Q));
1528f1580f4eSBarry Smith   }
1529f1580f4eSBarry Smith   PetscCall(ISDestroy(icol + 2));
1530f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, M[0]->rmap->N, 0, 1, irow));
1531f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(irow[0], bs));
1532f1580f4eSBarry Smith   PetscCall(ISSetIdentity(irow[0]));
1533f1580f4eSBarry Smith   if (!block) {
1534b07dfdedSPierre Jolivet     PetscCall(PetscMalloc2(P->cmap->N, &ptr, P->cmap->N / bs, &idx));
1535f1580f4eSBarry Smith     PetscCall(MatGetColumnNorms(M[0], NORM_INFINITY, ptr));
1536f1580f4eSBarry Smith     /* check for nonzero columns so that M[0] may be expressed in compact form */
1537811e8887SPierre Jolivet     for (PetscInt n = 0; n < P->cmap->N; n += bs) {
1538b07dfdedSPierre Jolivet       if (std::find_if(ptr + n, ptr + n + bs, [](PetscReal v) { return v > PETSC_MACHINE_EPSILON; }) != ptr + n + bs) idx[p++] = n / bs;
1539f1580f4eSBarry Smith     }
1540b07dfdedSPierre Jolivet     PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, p, idx, PETSC_USE_POINTER, icol + 1));
1541f1580f4eSBarry Smith     PetscCall(ISSetInfo(icol[1], IS_SORTED, IS_GLOBAL, PETSC_TRUE, PETSC_TRUE));
1542f1580f4eSBarry Smith     PetscCall(ISEmbed(*is, icol[1], PETSC_FALSE, icol + 2));
1543f1580f4eSBarry Smith     irow[1] = irow[0];
1544f1580f4eSBarry 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 */
1545f1580f4eSBarry Smith     icol[0] = is[0];
1546f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 2, irow, icol, MAT_INITIAL_MATRIX, sub));
1547f1580f4eSBarry Smith     PetscCall(ISDestroy(icol + 1));
1548f1580f4eSBarry Smith     PetscCall(PetscFree2(ptr, idx));
1549f1580f4eSBarry Smith     /* IS used to go back and forth between the augmented and the original local linear system, see eq. (3.4) of [2022b] */
1550f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Embed", (PetscObject)icol[2]));
1551f1580f4eSBarry Smith     /* Mat used in eq. (3.1) of [2022b] */
1552f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Compact", (PetscObject)(*sub)[1]));
1553f1580f4eSBarry Smith   } else {
1554f1580f4eSBarry Smith     Mat aux;
1555811e8887SPierre Jolivet 
1556f1580f4eSBarry Smith     PetscCall(MatSetOption(M[0], MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1557f1580f4eSBarry Smith     /* diagonal block of the overlapping rows */
1558f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 1, irow, is, MAT_INITIAL_MATRIX, sub));
1559f1580f4eSBarry Smith     PetscCall(MatDuplicate((*sub)[0], MAT_COPY_VALUES, &aux));
1560f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1561f1580f4eSBarry Smith     if (bs == 1) { /* scalar case */
1562f1580f4eSBarry Smith       Vec sum[2];
1563811e8887SPierre Jolivet 
1564f1580f4eSBarry Smith       PetscCall(MatCreateVecs(aux, sum, sum + 1));
1565f1580f4eSBarry Smith       PetscCall(MatGetRowSum(M[0], sum[0]));
1566f1580f4eSBarry Smith       PetscCall(MatGetRowSum(aux, sum[1]));
1567f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1568f1580f4eSBarry Smith       PetscCall(VecAXPY(sum[0], -1.0, sum[1]));
1569f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1570f1580f4eSBarry Smith       PetscCall(MatDiagonalSet(aux, sum[0], ADD_VALUES));
1571f1580f4eSBarry Smith       PetscCall(VecDestroy(sum));
1572f1580f4eSBarry Smith       PetscCall(VecDestroy(sum + 1));
1573f1580f4eSBarry Smith     } else { /* vectorial case */
1574f1580f4eSBarry Smith       /* TODO: missing MatGetValuesBlocked(), so the code below is     */
1575f1580f4eSBarry Smith       /* an extension of the scalar case for when bs > 1, but it could */
1576f1580f4eSBarry Smith       /* be more efficient by avoiding all these MatMatMult()          */
1577f1580f4eSBarry Smith       Mat          sum[2], ones;
1578f1580f4eSBarry Smith       PetscScalar *ptr;
1579811e8887SPierre Jolivet 
1580f1580f4eSBarry Smith       PetscCall(PetscCalloc1(M[0]->cmap->n * bs, &ptr));
1581f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, M[0]->cmap->n, bs, M[0]->cmap->n, bs, ptr, &ones));
1582811e8887SPierre Jolivet       for (PetscInt n = 0; n < M[0]->cmap->n; n += bs) {
1583f1580f4eSBarry Smith         for (p = 0; p < bs; ++p) ptr[n + p * (M[0]->cmap->n + 1)] = 1.0;
1584f1580f4eSBarry Smith       }
1585fb842aefSJose E. Roman       PetscCall(MatMatMult(M[0], ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum));
1586f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1587f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, aux->cmap->n, bs, aux->cmap->n, bs, ptr, &ones));
1588f1580f4eSBarry Smith       PetscCall(MatDenseSetLDA(ones, M[0]->cmap->n));
1589fb842aefSJose E. Roman       PetscCall(MatMatMult(aux, ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum + 1));
1590f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1591f1580f4eSBarry Smith       PetscCall(PetscFree(ptr));
1592f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1593f1580f4eSBarry Smith       PetscCall(MatAXPY(sum[0], -1.0, sum[1], SAME_NONZERO_PATTERN));
1594f1580f4eSBarry Smith       PetscCall(MatDestroy(sum + 1));
1595f1580f4eSBarry Smith       /* re-order values to be consistent with MatSetValuesBlocked()           */
1596f1580f4eSBarry Smith       /* equivalent to MatTranspose() which does not truly handle              */
1597f1580f4eSBarry Smith       /* MAT_INPLACE_MATRIX in the rectangular case, as it calls PetscMalloc() */
1598f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(sum[0], &ptr));
1599f1580f4eSBarry Smith       HPDDM::Wrapper<PetscScalar>::imatcopy<'T'>(bs, sum[0]->rmap->n, ptr, sum[0]->rmap->n, bs);
1600f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1601811e8887SPierre Jolivet       for (PetscInt n = 0; n < aux->cmap->n / bs; ++n) PetscCall(MatSetValuesBlocked(aux, 1, &n, 1, &n, ptr + n * bs * bs, ADD_VALUES));
1602f1580f4eSBarry Smith       PetscCall(MatAssemblyBegin(aux, MAT_FINAL_ASSEMBLY));
1603f1580f4eSBarry Smith       PetscCall(MatAssemblyEnd(aux, MAT_FINAL_ASSEMBLY));
1604f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(sum[0], &ptr));
1605f1580f4eSBarry Smith       PetscCall(MatDestroy(sum));
1606f1580f4eSBarry Smith     }
1607f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
1608f1580f4eSBarry Smith     /* left-hand side of GenEO, with the same sparsity pattern as PCASM subdomain solvers  */
1609f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Neumann_Mat", (PetscObject)aux));
1610f1580f4eSBarry Smith   }
1611f1580f4eSBarry Smith   PetscCall(ISDestroy(irow));
1612f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &M));
16133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1614f1580f4eSBarry Smith }
1615f1580f4eSBarry Smith 
161613044ca3SPierre Jolivet static PetscErrorCode PCApply_Nest(PC pc, Vec x, Vec y)
161713044ca3SPierre Jolivet {
161813044ca3SPierre Jolivet   Mat                    A;
161913044ca3SPierre Jolivet   MatSolverType          type;
162013044ca3SPierre Jolivet   IS                     is[2];
162113044ca3SPierre Jolivet   PetscBool              flg;
162213044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
162313044ca3SPierre Jolivet 
162413044ca3SPierre Jolivet   PetscFunctionBegin;
162513044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
162651ea4bc8SPierre Jolivet   if (p->second[0]) { /* in case of a centralized Schur complement, some processes may have no local operator */
162713044ca3SPierre Jolivet     PetscCall(PCGetOperators(p->first, &A, nullptr));
162813044ca3SPierre Jolivet     PetscCall(MatNestGetISs(A, is, nullptr));
162951ea4bc8SPierre Jolivet     PetscCall(PetscObjectTypeCompareAny((PetscObject)p->first, &flg, PCLU, PCCHOLESKY, ""));
163051ea4bc8SPierre Jolivet     if (flg) { /* partial solve currently only makes sense with exact factorizations */
163113044ca3SPierre Jolivet       PetscCall(PCFactorGetMatSolverType(p->first, &type));
163213044ca3SPierre Jolivet       PetscCall(PCFactorGetMatrix(p->first, &A));
163351ea4bc8SPierre Jolivet       if (A->schur) {
163413044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
163551ea4bc8SPierre Jolivet         if (flg) PetscCall(MatMumpsSetIcntl(A, 26, 1)); /* reduction/condensation phase followed by Schur complement solve */
163651ea4bc8SPierre Jolivet       } else flg = PETSC_FALSE;
163713044ca3SPierre Jolivet     }
163813044ca3SPierre Jolivet     PetscCall(VecISCopy(p->second[0], is[1], SCATTER_FORWARD, x)); /* assign the RHS associated to the Schur complement */
163913044ca3SPierre Jolivet     PetscCall(PCApply(p->first, p->second[0], p->second[1]));
164013044ca3SPierre Jolivet     PetscCall(VecISCopy(p->second[1], is[1], SCATTER_REVERSE, y)); /* retrieve the partial solution associated to the Schur complement */
164179578405SBarry Smith     if (flg) PetscCall(MatMumpsSetIcntl(A, 26, -1));               /* default ICNTL(26) value in PETSc */
164213044ca3SPierre Jolivet   }
164313044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
164413044ca3SPierre Jolivet }
164513044ca3SPierre Jolivet 
164613044ca3SPierre Jolivet static PetscErrorCode PCView_Nest(PC pc, PetscViewer viewer)
164713044ca3SPierre Jolivet {
164813044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
164913044ca3SPierre Jolivet 
165013044ca3SPierre Jolivet   PetscFunctionBegin;
165113044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
165213044ca3SPierre Jolivet   PetscCall(PCView(p->first, viewer));
165313044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
165413044ca3SPierre Jolivet }
165513044ca3SPierre Jolivet 
165613044ca3SPierre Jolivet static PetscErrorCode PCDestroy_Nest(PC pc)
165713044ca3SPierre Jolivet {
165813044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
165913044ca3SPierre Jolivet 
166013044ca3SPierre Jolivet   PetscFunctionBegin;
166113044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
166213044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second));
166313044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second + 1));
166413044ca3SPierre Jolivet   PetscCall(PCDestroy(&p->first));
166513044ca3SPierre Jolivet   PetscCall(PetscFree(p));
166613044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
166713044ca3SPierre Jolivet }
166813044ca3SPierre Jolivet 
166913044ca3SPierre Jolivet template <bool T = false>
167013044ca3SPierre Jolivet static PetscErrorCode MatMult_Schur(Mat A, Vec x, Vec y)
167113044ca3SPierre Jolivet {
167201e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
167313044ca3SPierre Jolivet 
167413044ca3SPierre Jolivet   PetscFunctionBegin;
167513044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
167613044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD)); /* local Vec with overlap */
167713044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD));
167813044ca3SPierre Jolivet   if (!T) PetscCall(MatMult(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1])); /* local Schur complement */
167913044ca3SPierre Jolivet   else PetscCall(MatMultTranspose(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1]));
168013044ca3SPierre Jolivet   PetscCall(VecSet(y, 0.0));
168113044ca3SPierre 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 */
168213044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE));
168313044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
168413044ca3SPierre Jolivet }
168513044ca3SPierre Jolivet 
168613044ca3SPierre Jolivet static PetscErrorCode MatDestroy_Schur(Mat A)
168713044ca3SPierre Jolivet {
168801e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
168913044ca3SPierre Jolivet 
169013044ca3SPierre Jolivet   PetscFunctionBegin;
169113044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
169213044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx)));
169313044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx) + 1));
169413044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
169513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
169613044ca3SPierre Jolivet }
169713044ca3SPierre Jolivet 
169813044ca3SPierre Jolivet static PetscErrorCode MatMult_SchurCorrection(Mat A, Vec x, Vec y)
169913044ca3SPierre Jolivet {
170013044ca3SPierre Jolivet   PC                                         pc;
170113044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
170213044ca3SPierre Jolivet 
170313044ca3SPierre Jolivet   PetscFunctionBegin;
170413044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
170513044ca3SPierre Jolivet   pc = ((PC_HPDDM *)std::get<0>(*ctx)[0]->data)->levels[0]->ksp->pc;
170613044ca3SPierre 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 */
170713044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], x, std::get<3>(*ctx)[1]));                    /*     A_01 x                 */
170813044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 x             */
170913044ca3SPierre 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        */
171013044ca3SPierre 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 */
171113044ca3SPierre Jolivet   } else {
171213044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[0]));                    /*     M_S^-1 x               */
171313044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], std::get<3>(*ctx)[0], std::get<3>(*ctx)[1])); /*     A_01 M_S^-1 x          */
171413044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 M_S^-1 x      */
171513044ca3SPierre 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 */
171613044ca3SPierre Jolivet   }
171713044ca3SPierre Jolivet   PetscCall(VecAXPY(y, -1.0, x)); /* y -= x, preconditioned eq. (24) of https://hal.science/hal-02343808v6/document (with a sign flip) */
171813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
171913044ca3SPierre Jolivet }
172013044ca3SPierre Jolivet 
172113044ca3SPierre Jolivet static PetscErrorCode MatView_SchurCorrection(Mat A, PetscViewer viewer)
172213044ca3SPierre Jolivet {
172313044ca3SPierre Jolivet   PetscBool                                  ascii;
172413044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
172513044ca3SPierre Jolivet 
172613044ca3SPierre Jolivet   PetscFunctionBegin;
172713044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &ascii));
172813044ca3SPierre Jolivet   if (ascii) {
172913044ca3SPierre Jolivet     PetscCall(MatShellGetContext(A, &ctx));
173013044ca3SPierre 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)"));
173113044ca3SPierre Jolivet     PetscCall(PCView(std::get<0>(*ctx)[1], viewer)); /* no need to PCView(Q_0) since it will be done by PCFIELDSPLIT */
173213044ca3SPierre Jolivet   }
173313044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
173413044ca3SPierre Jolivet }
173513044ca3SPierre Jolivet 
173613044ca3SPierre Jolivet static PetscErrorCode MatDestroy_SchurCorrection(Mat A)
173713044ca3SPierre Jolivet {
173813044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
173913044ca3SPierre Jolivet 
174013044ca3SPierre Jolivet   PetscFunctionBegin;
174113044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
174213044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx)));
174313044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 1));
174413044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 2));
174513044ca3SPierre Jolivet   PetscCall(PCDestroy(std::get<0>(*ctx) + 1));
174613044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
174713044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
174813044ca3SPierre Jolivet }
174913044ca3SPierre Jolivet 
1750feebddf4SPierre Jolivet static PetscErrorCode PCPostSolve_SchurPreLeastSquares(PC, KSP, Vec, Vec x)
1751feebddf4SPierre Jolivet {
1752feebddf4SPierre Jolivet   PetscFunctionBegin;
1753feebddf4SPierre Jolivet   PetscCall(VecScale(x, -1.0));
1754feebddf4SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1755feebddf4SPierre Jolivet }
1756feebddf4SPierre Jolivet 
175713044ca3SPierre Jolivet static PetscErrorCode KSPPreSolve_SchurCorrection(KSP, Vec b, Vec, void *context)
175813044ca3SPierre Jolivet {
175913044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
176013044ca3SPierre Jolivet 
1761a6b3e571SPierre Jolivet   PetscFunctionBegin;
176213044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
176313044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], b, std::get<3>(*ctx)[2]));
176413044ca3SPierre 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 */
176513044ca3SPierre Jolivet   }
176613044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
176713044ca3SPierre Jolivet }
176813044ca3SPierre Jolivet 
176913044ca3SPierre Jolivet static PetscErrorCode KSPPostSolve_SchurCorrection(KSP, Vec b, Vec x, void *context)
177013044ca3SPierre Jolivet {
177113044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
177213044ca3SPierre Jolivet 
1773a6b3e571SPierre Jolivet   PetscFunctionBegin;
177413044ca3SPierre 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 */
177513044ca3SPierre Jolivet   else {
177613044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[2]));
177713044ca3SPierre Jolivet     PetscCall(VecCopy(std::get<3>(*ctx)[2], x)); /* replace x by M^-1 x */
177813044ca3SPierre Jolivet   }
177913044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
178013044ca3SPierre Jolivet }
178113044ca3SPierre Jolivet 
17829bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat, Vec, Vec);
17839bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat, Vec, Vec);
17849bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat, Mat, Mat, void *);
1785f21e3f8aSPierre Jolivet static PetscErrorCode MatProduct_AtB_Harmonic(Mat, Mat, Mat, void *);
17869bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat);
17879bb5c669SPierre Jolivet 
1788d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDM(PC pc)
1789d71ae5a4SJacob Faibussowitsch {
1790f1580f4eSBarry Smith   PC_HPDDM                                  *data = (PC_HPDDM *)pc->data;
1791f1580f4eSBarry Smith   PC                                         inner;
1792f1580f4eSBarry Smith   KSP                                       *ksp;
179313044ca3SPierre Jolivet   Mat                                       *sub, A, P, N, C = nullptr, uaux = nullptr, weighted, subA[2], S;
1794f1580f4eSBarry Smith   Vec                                        xin, v;
1795f1580f4eSBarry Smith   std::vector<Vec>                           initial;
1796db4a47b3SPierre Jolivet   IS                                         is[1], loc, uis = data->is, unsorted = nullptr;
1797f1580f4eSBarry Smith   ISLocalToGlobalMapping                     l2g;
1798f1580f4eSBarry Smith   char                                       prefix[256];
1799f1580f4eSBarry Smith   const char                                *pcpre;
1800f1580f4eSBarry Smith   const PetscScalar *const                  *ev;
18019bb5c669SPierre Jolivet   PetscInt                                   n, requested = data->N, reused = 0, overlap = -1;
1802f1580f4eSBarry Smith   MatStructure                               structure  = UNKNOWN_NONZERO_PATTERN;
1803f1580f4eSBarry Smith   PetscBool                                  subdomains = PETSC_FALSE, flg = PETSC_FALSE, ismatis, swap = PETSC_FALSE, algebraic = PETSC_FALSE, block = PETSC_FALSE;
1804f1580f4eSBarry Smith   DM                                         dm;
180513044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = nullptr;
1806398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1807db4a47b3SPierre Jolivet   IS  dis  = nullptr;
1808db4a47b3SPierre Jolivet   Mat daux = nullptr;
1809398c7888SPierre Jolivet #endif
1810f1580f4eSBarry Smith 
1811f1580f4eSBarry Smith   PetscFunctionBegin;
1812f1580f4eSBarry Smith   PetscCheck(data->levels && data->levels[0], PETSC_COMM_SELF, PETSC_ERR_PLIB, "Not a single level allocated");
1813f1580f4eSBarry Smith   PetscCall(PCGetOptionsPrefix(pc, &pcpre));
1814f1580f4eSBarry Smith   PetscCall(PCGetOperators(pc, &A, &P));
1815f1580f4eSBarry Smith   if (!data->levels[0]->ksp) {
1816f1580f4eSBarry Smith     PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->ksp));
18173821be0aSBarry Smith     PetscCall(KSPSetNestLevel(data->levels[0]->ksp, pc->kspnestlevel));
1818f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_%s_", pcpre ? pcpre : "", data->N > 1 ? "levels_1" : "coarse"));
1819f1580f4eSBarry Smith     PetscCall(KSPSetOptionsPrefix(data->levels[0]->ksp, prefix));
1820f1580f4eSBarry Smith     PetscCall(KSPSetType(data->levels[0]->ksp, KSPPREONLY));
1821371d2eb7SMartin Diehl   } else if (data->levels[0]->ksp->pc && data->levels[0]->ksp->pc->setupcalled && data->levels[0]->ksp->pc->reusepreconditioner) {
1822f1580f4eSBarry Smith     /* if the fine-level PCSHELL exists, its setup has succeeded, and one wants to reuse it, */
1823f1580f4eSBarry Smith     /* then just propagate the appropriate flag to the coarser levels                        */
1824f1580f4eSBarry Smith     for (n = 0; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1825f1580f4eSBarry Smith       /* the following KSP and PC may be NULL for some processes, hence the check            */
1826f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetReusePreconditioner(data->levels[n]->ksp, PETSC_TRUE));
1827f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
1828f1580f4eSBarry Smith     }
1829f1580f4eSBarry Smith     /* early bail out because there is nothing to do */
18303ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1831f1580f4eSBarry Smith   } else {
1832f1580f4eSBarry Smith     /* reset coarser levels */
1833f1580f4eSBarry Smith     for (n = 1; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1834371d2eb7SMartin 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) {
1835f1580f4eSBarry Smith         reused = data->N - n;
1836f1580f4eSBarry Smith         break;
1837f1580f4eSBarry Smith       }
1838f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[n]->ksp));
1839f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[n]->pc));
1840f1580f4eSBarry Smith     }
1841f1580f4eSBarry Smith     /* check if some coarser levels are being reused */
1842462c564dSBarry Smith     PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &reused, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)pc)));
1843f1580f4eSBarry Smith     const int *addr = data->levels[0]->P ? data->levels[0]->P->getAddrLocal() : &HPDDM::i__0;
1844f1580f4eSBarry Smith 
1845f1580f4eSBarry Smith     if (addr != &HPDDM::i__0 && reused != data->N - 1) {
1846f1580f4eSBarry Smith       /* reuse previously computed eigenvectors */
1847f1580f4eSBarry Smith       ev = data->levels[0]->P->getVectors();
1848f1580f4eSBarry Smith       if (ev) {
1849f1580f4eSBarry Smith         initial.reserve(*addr);
1850f1580f4eSBarry Smith         PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, data->levels[0]->P->getDof(), ev[0], &xin));
1851f1580f4eSBarry Smith         for (n = 0; n < *addr; ++n) {
1852f1580f4eSBarry Smith           PetscCall(VecDuplicate(xin, &v));
1853f1580f4eSBarry Smith           PetscCall(VecPlaceArray(xin, ev[n]));
1854f1580f4eSBarry Smith           PetscCall(VecCopy(xin, v));
1855f1580f4eSBarry Smith           initial.emplace_back(v);
1856f1580f4eSBarry Smith           PetscCall(VecResetArray(xin));
1857f1580f4eSBarry Smith         }
1858f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
1859f1580f4eSBarry Smith       }
1860f1580f4eSBarry Smith     }
1861f1580f4eSBarry Smith   }
1862f1580f4eSBarry Smith   data->N -= reused;
1863f1580f4eSBarry Smith   PetscCall(KSPSetOperators(data->levels[0]->ksp, A, P));
1864f1580f4eSBarry Smith 
1865f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATIS, &ismatis));
1866f1580f4eSBarry Smith   if (!data->is && !ismatis) {
1867db4a47b3SPierre Jolivet     PetscErrorCode (*create)(DM, IS *, Mat *, PetscErrorCode (**)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void **) = nullptr;
1868db4a47b3SPierre Jolivet     PetscErrorCode (*usetup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *)                                                = nullptr;
1869db4a47b3SPierre Jolivet     void *uctx                                                                                                               = nullptr;
1870f1580f4eSBarry Smith 
1871f1580f4eSBarry Smith     /* first see if we can get the data from the DM */
1872f1580f4eSBarry Smith     PetscCall(MatGetDM(P, &dm));
1873f1580f4eSBarry Smith     if (!dm) PetscCall(MatGetDM(A, &dm));
1874f1580f4eSBarry Smith     if (!dm) PetscCall(PCGetDM(pc, &dm));
1875907a3e9cSStefano Zampini     if (dm) { /* this is the hook for DMPLEX for which the auxiliary Mat is the local Neumann matrix */
1876f1580f4eSBarry Smith       PetscCall(PetscObjectQueryFunction((PetscObject)dm, "DMCreateNeumannOverlap_C", &create));
1877f1580f4eSBarry Smith       if (create) {
1878f1580f4eSBarry Smith         PetscCall((*create)(dm, &uis, &uaux, &usetup, &uctx));
1879c8ea6600SPierre 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 */
1880f1580f4eSBarry Smith       }
1881f1580f4eSBarry Smith     }
1882f1580f4eSBarry Smith     if (!create) {
1883f1580f4eSBarry Smith       if (!uis) {
1884f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1885f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1886f1580f4eSBarry Smith       }
1887f1580f4eSBarry Smith       if (!uaux) {
1888f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1889f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1890f1580f4eSBarry Smith       }
1891f1580f4eSBarry Smith       /* look inside the Pmat instead of the PC, needed for MatSchurComplementComputeExplicitOperator() */
1892f1580f4eSBarry Smith       if (!uis) {
1893f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1894f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1895f1580f4eSBarry Smith       }
1896f1580f4eSBarry Smith       if (!uaux) {
1897f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1898f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1899f1580f4eSBarry Smith       }
1900f1580f4eSBarry Smith     }
1901f1580f4eSBarry Smith     PetscCall(PCHPDDMSetAuxiliaryMat(pc, uis, uaux, usetup, uctx));
1902f1580f4eSBarry Smith     PetscCall(MatDestroy(&uaux));
1903f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
1904f1580f4eSBarry Smith   }
1905f1580f4eSBarry Smith 
1906f1580f4eSBarry Smith   if (!ismatis) {
1907f1580f4eSBarry Smith     PetscCall(PCHPDDMSetUpNeumannOverlap_Private(pc));
19088dc3fbeeSPierre Jolivet     PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, pcpre, "-pc_hpddm_block_splitting", &block, nullptr));
19098dc3fbeeSPierre Jolivet     PetscCall(PetscOptionsGetInt(((PetscObject)pc)->options, pcpre, "-pc_hpddm_harmonic_overlap", &overlap, nullptr));
19105e642048SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
191151ea4bc8SPierre Jolivet     if (data->is || flg) {
19129bb5c669SPierre Jolivet       if (block || overlap != -1) {
191302800ff6SPierre Jolivet         PetscCall(ISDestroy(&data->is));
191402800ff6SPierre Jolivet         PetscCall(MatDestroy(&data->aux));
191551ea4bc8SPierre Jolivet       } else if (flg) {
191613044ca3SPierre Jolivet         PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_GENEO;
191713044ca3SPierre Jolivet 
19188dc3fbeeSPierre Jolivet         PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
191913044ca3SPierre Jolivet         if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
192013044ca3SPierre Jolivet           PetscCall(ISDestroy(&data->is)); /* destroy any previously user-set objects since they will be set automatically */
192113044ca3SPierre Jolivet           PetscCall(MatDestroy(&data->aux));
192213044ca3SPierre Jolivet         } else if (type == PC_HPDDM_SCHUR_PRE_GENEO) {
192313044ca3SPierre Jolivet           PetscContainer container = nullptr;
192413044ca3SPierre Jolivet 
192513044ca3SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Schur", (PetscObject *)&container));
192613044ca3SPierre Jolivet           if (!container) { /* first call to PCSetUp() on the PC associated to the Schur complement */
192713044ca3SPierre Jolivet             PC_HPDDM       *data_00;
192813044ca3SPierre Jolivet             KSP             ksp, inner_ksp;
192913044ca3SPierre Jolivet             PC              pc_00;
1930cf67ef9dSPierre Jolivet             Mat             A11 = nullptr;
1931cf67ef9dSPierre Jolivet             Vec             d   = nullptr;
19328a8e6071SPierre Jolivet             PetscReal       norm;
193351ea4bc8SPierre Jolivet             const PetscInt *ranges;
193451ea4bc8SPierre Jolivet             PetscMPIInt     size;
193513044ca3SPierre Jolivet             char           *prefix;
193613044ca3SPierre Jolivet 
193713044ca3SPierre Jolivet             PetscCall(MatSchurComplementGetKSP(P, &ksp));
193813044ca3SPierre Jolivet             PetscCall(KSPGetPC(ksp, &pc_00));
193913044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)pc_00, PCHPDDM, &flg));
1940fd310a01SPierre 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 : "",
194113044ca3SPierre Jolivet                        ((PetscObject)pc_00)->type_name, PCHPDDM);
194213044ca3SPierre Jolivet             data_00 = (PC_HPDDM *)pc_00->data;
1943fd310a01SPierre 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],
1944fd310a01SPierre Jolivet                        data_00->N, data_00->N > 1 ? "s" : "", ((PetscObject)pc_00)->prefix);
194551ea4bc8SPierre 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() : "");
194613044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)data_00->levels[0]->pc, PCASM, &flg));
1947fd310a01SPierre 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,
194813044ca3SPierre Jolivet                        ((PetscObject)data_00->levels[0]->pc)->type_name, PCASM);
194951ea4bc8SPierre 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)  */
1950d16c0b94SPierre Jolivet             PetscCall(MatSchurComplementGetSubMatrices(P, nullptr, nullptr, nullptr, nullptr, &A11));
195151ea4bc8SPierre Jolivet             PetscCall(MatGetOwnershipRanges(A11, &ranges));
195251ea4bc8SPierre Jolivet             PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A11), &size));
195351ea4bc8SPierre 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)? */
195451ea4bc8SPierre Jolivet             if (!flg) {
19555e642048SPierre Jolivet               if (PetscDefined(USE_DEBUG) || !data->is) {
19565e642048SPierre Jolivet                 Mat A01, A10, B = nullptr, C = nullptr, *sub;
195713044ca3SPierre Jolivet 
19585e642048SPierre Jolivet                 PetscCall(MatSchurComplementGetSubMatrices(P, &A, nullptr, &A01, &A10, nullptr));
19595e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
19605e642048SPierre Jolivet                 if (flg) {
19615e642048SPierre Jolivet                   PetscCall(MatTransposeGetMat(A10, &C));
19625e642048SPierre Jolivet                   PetscCall(MatTranspose(C, MAT_INITIAL_MATRIX, &B));
19635e642048SPierre Jolivet                 } else {
19645e642048SPierre Jolivet                   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
19655e642048SPierre Jolivet                   if (flg) {
19665e642048SPierre Jolivet                     PetscCall(MatHermitianTransposeGetMat(A10, &C));
19675e642048SPierre Jolivet                     PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &B));
19685e642048SPierre Jolivet                   }
19695e642048SPierre Jolivet                 }
1970811e8887SPierre Jolivet                 if (flg)
1971811e8887SPierre 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));
19725e642048SPierre Jolivet                 if (!B) {
19735e642048SPierre Jolivet                   B = A10;
19745e642048SPierre Jolivet                   PetscCall(PetscObjectReference((PetscObject)B));
19755e642048SPierre Jolivet                 } else if (!data->is) {
19765e642048SPierre Jolivet                   PetscCall(PetscObjectTypeCompareAny((PetscObject)A01, &flg, MATTRANSPOSEVIRTUAL, MATHERMITIANTRANSPOSEVIRTUAL, ""));
19775e642048SPierre Jolivet                   if (!flg) C = A01;
1978811e8887SPierre Jolivet                   else
1979811e8887SPierre 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));
19805e642048SPierre Jolivet                 }
198113044ca3SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, B->rmap->N, 0, 1, &uis));
19825e642048SPierre Jolivet                 PetscCall(ISSetIdentity(uis));
19835e642048SPierre Jolivet                 if (!data->is) {
19845e642048SPierre Jolivet                   if (C) PetscCall(PetscObjectReference((PetscObject)C));
19855e642048SPierre Jolivet                   else PetscCall(MatTranspose(B, MAT_INITIAL_MATRIX, &C));
19865e642048SPierre Jolivet                   PetscCall(ISDuplicate(data_00->is, is));
19875e642048SPierre Jolivet                   PetscCall(MatIncreaseOverlap(A, 1, is, 1));
19885e642048SPierre Jolivet                   PetscCall(MatSetOption(C, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
19895e642048SPierre Jolivet                   PetscCall(MatCreateSubMatrices(C, 1, is, &uis, MAT_INITIAL_MATRIX, &sub));
19905e642048SPierre Jolivet                   PetscCall(MatDestroy(&C));
19915e642048SPierre Jolivet                   PetscCall(MatTranspose(sub[0], MAT_INITIAL_MATRIX, &C));
19925e642048SPierre Jolivet                   PetscCall(MatDestroySubMatrices(1, &sub));
19935e642048SPierre Jolivet                   PetscCall(MatFindNonzeroRows(C, &data->is));
19949640b26aSPierre Jolivet                   PetscCheck(data->is, PetscObjectComm((PetscObject)C), PETSC_ERR_SUP, "No empty row, which likely means that some rows of A_10 are dense");
19955e642048SPierre Jolivet                   PetscCall(MatDestroy(&C));
19965e642048SPierre Jolivet                   PetscCall(ISDestroy(is));
1997d16c0b94SPierre Jolivet                   PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), A11->rmap->n, A11->rmap->rstart, 1, &loc));
1998d16c0b94SPierre Jolivet                   if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_FALSE));
1999d16c0b94SPierre Jolivet                   PetscCall(ISExpand(data->is, loc, is));
2000d16c0b94SPierre Jolivet                   PetscCall(ISDestroy(&loc));
2001d16c0b94SPierre Jolivet                   PetscCall(ISDestroy(&data->is));
2002d16c0b94SPierre Jolivet                   data->is = is[0];
2003d16c0b94SPierre Jolivet                   is[0]    = nullptr;
20045e642048SPierre Jolivet                 }
20055e642048SPierre Jolivet                 if (PetscDefined(USE_DEBUG)) {
20065e642048SPierre Jolivet                   PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
200713044ca3SPierre 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 */
200813044ca3SPierre Jolivet                   PetscCall(ISDestroy(&uis));
200913044ca3SPierre Jolivet                   PetscCall(ISDuplicate(data->is, &uis));
201013044ca3SPierre Jolivet                   PetscCall(ISSort(uis));
20115e642048SPierre Jolivet                   PetscCall(ISComplement(uis, 0, B->rmap->N, is));
201213044ca3SPierre Jolivet                   PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &C));
20135e642048SPierre Jolivet                   PetscCall(MatZeroRowsIS(C, is[0], 0.0, nullptr, nullptr));
20145e642048SPierre Jolivet                   PetscCall(ISDestroy(is));
201513044ca3SPierre Jolivet                   PetscCall(MatMultEqual(sub[0], C, 20, &flg));
201613044ca3SPierre 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 */
201713044ca3SPierre Jolivet                   PetscCall(MatDestroy(&C));
201813044ca3SPierre Jolivet                   PetscCall(MatDestroySubMatrices(1, &sub));
201913044ca3SPierre Jolivet                 }
20205e642048SPierre Jolivet                 PetscCall(ISDestroy(&uis));
20215e642048SPierre Jolivet                 PetscCall(MatDestroy(&B));
20225e642048SPierre Jolivet               }
2023cf67ef9dSPierre Jolivet               flg = PETSC_FALSE;
2024cf67ef9dSPierre Jolivet               if (!data->aux) {
2025cf67ef9dSPierre Jolivet                 Mat D;
2026cf67ef9dSPierre Jolivet 
2027cf67ef9dSPierre Jolivet                 PetscCall(MatCreateVecs(A11, &d, nullptr));
2028cf67ef9dSPierre Jolivet                 PetscCall(MatGetDiagonal(A11, d));
2029cf67ef9dSPierre Jolivet                 PetscCall(PetscObjectTypeCompareAny((PetscObject)A11, &flg, MATDIAGONAL, MATCONSTANTDIAGONAL, ""));
2030cf67ef9dSPierre Jolivet                 if (!flg) {
2031cf67ef9dSPierre Jolivet                   PetscCall(MatCreateDiagonal(d, &D));
2032cf67ef9dSPierre Jolivet                   PetscCall(MatMultEqual(A11, D, 20, &flg));
2033cf67ef9dSPierre Jolivet                   PetscCall(MatDestroy(&D));
2034cf67ef9dSPierre Jolivet                 }
2035cf67ef9dSPierre 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"));
2036cf67ef9dSPierre Jolivet               }
20378a8e6071SPierre Jolivet               if ((PetscDefined(USE_DEBUG) || (data->Neumann != PETSC_BOOL3_TRUE && !flg)) && A11) {
2038cf67ef9dSPierre Jolivet                 PetscCall(MatNorm(A11, NORM_INFINITY, &norm));
20398a8e6071SPierre Jolivet                 if (data->Neumann != PETSC_BOOL3_TRUE && !flg) {
2040cf67ef9dSPierre 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 : "");
2041cf67ef9dSPierre 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"));
2042cf67ef9dSPierre Jolivet                   PetscCall(MatDestroy(&data->aux));
2043cf67ef9dSPierre Jolivet                   flg = PETSC_TRUE;
2044cf67ef9dSPierre Jolivet                 }
20458a8e6071SPierre Jolivet               }
2046cf67ef9dSPierre 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 */
204701e3c840SPierre Jolivet                 PetscSF            scatter;
204813044ca3SPierre Jolivet                 const PetscScalar *read;
2049cf67ef9dSPierre Jolivet                 PetscScalar       *write, *diagonal = nullptr;
205013044ca3SPierre Jolivet 
205113044ca3SPierre Jolivet                 PetscCall(MatDestroy(&data->aux));
205213044ca3SPierre Jolivet                 PetscCall(ISGetLocalSize(data->is, &n));
2053cf67ef9dSPierre Jolivet                 PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &xin));
2054cf67ef9dSPierre Jolivet                 PetscCall(VecDuplicate(xin, &v));
2055cf67ef9dSPierre Jolivet                 PetscCall(VecScatterCreate(xin, data->is, v, nullptr, &scatter));
205613044ca3SPierre Jolivet                 PetscCall(VecSet(v, 1.0));
2057cf67ef9dSPierre Jolivet                 PetscCall(VecSet(xin, 1.0));
2058cf67ef9dSPierre Jolivet                 PetscCall(VecScatterBegin(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE));
2059cf67ef9dSPierre Jolivet                 PetscCall(VecScatterEnd(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE)); /* v has the multiplicity of all unknowns on the overlap */
2060cf67ef9dSPierre Jolivet                 PetscCall(PetscSFDestroy(&scatter));
2061cf67ef9dSPierre Jolivet                 if (d) {
2062cf67ef9dSPierre Jolivet                   PetscCall(VecScatterCreate(d, data->is, v, nullptr, &scatter));
2063cf67ef9dSPierre Jolivet                   PetscCall(VecScatterBegin(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
2064cf67ef9dSPierre Jolivet                   PetscCall(VecScatterEnd(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
2065cf67ef9dSPierre Jolivet                   PetscCall(PetscSFDestroy(&scatter));
2066cf67ef9dSPierre Jolivet                   PetscCall(VecDestroy(&d));
2067cf67ef9dSPierre Jolivet                   PetscCall(PetscMalloc1(n, &diagonal));
2068cf67ef9dSPierre Jolivet                   PetscCall(VecGetArrayRead(v, &read));
2069cf67ef9dSPierre Jolivet                   PetscCallCXX(std::copy_n(read, n, diagonal));
2070cf67ef9dSPierre Jolivet                   PetscCall(VecRestoreArrayRead(v, &read));
2071cf67ef9dSPierre Jolivet                 }
207213044ca3SPierre Jolivet                 PetscCall(VecDestroy(&v));
207313044ca3SPierre Jolivet                 PetscCall(VecCreateSeq(PETSC_COMM_SELF, n, &v));
2074cf67ef9dSPierre Jolivet                 PetscCall(VecGetArrayRead(xin, &read));
207513044ca3SPierre Jolivet                 PetscCall(VecGetArrayWrite(v, &write));
2076cf67ef9dSPierre 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];
2077cf67ef9dSPierre Jolivet                 PetscCall(PetscFree(diagonal));
2078cf67ef9dSPierre Jolivet                 PetscCall(VecRestoreArrayRead(xin, &read));
207913044ca3SPierre Jolivet                 PetscCall(VecRestoreArrayWrite(v, &write));
2080cf67ef9dSPierre Jolivet                 PetscCall(VecDestroy(&xin));
2081c3e1b152SPierre Jolivet                 PetscCall(MatCreateDiagonal(v, &data->aux));
208213044ca3SPierre Jolivet                 PetscCall(VecDestroy(&v));
208313044ca3SPierre Jolivet               }
208413044ca3SPierre Jolivet               uis  = data->is;
208513044ca3SPierre Jolivet               uaux = data->aux;
208613044ca3SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)uis));
208713044ca3SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)uaux));
208813044ca3SPierre Jolivet               PetscCall(PetscStrallocpy(pcpre, &prefix));
208913044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(pc, nullptr));
209013044ca3SPierre Jolivet               PetscCall(PCSetType(pc, PCKSP));                                    /* replace the PC associated to the Schur complement by PCKSP */
209113044ca3SPierre Jolivet               PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &inner_ksp)); /* new KSP that will be attached to the previously set PC */
209213044ca3SPierre Jolivet               PetscCall(PetscObjectGetTabLevel((PetscObject)pc, &n));
209313044ca3SPierre Jolivet               PetscCall(PetscObjectSetTabLevel((PetscObject)inner_ksp, n + 2));
209413044ca3SPierre Jolivet               PetscCall(KSPSetOperators(inner_ksp, pc->mat, pc->pmat));
209513044ca3SPierre Jolivet               PetscCall(KSPSetOptionsPrefix(inner_ksp, std::string(std::string(prefix) + "pc_hpddm_").c_str()));
209613044ca3SPierre Jolivet               PetscCall(KSPSetSkipPCSetFromOptions(inner_ksp, PETSC_TRUE));
209713044ca3SPierre Jolivet               PetscCall(KSPSetFromOptions(inner_ksp));
209813044ca3SPierre Jolivet               PetscCall(KSPGetPC(inner_ksp, &inner));
209913044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(inner, nullptr));
210013044ca3SPierre Jolivet               PetscCall(PCSetType(inner, PCNONE)); /* no preconditioner since the action of M^-1 A or A M^-1 will be computed by the Amat */
210113044ca3SPierre Jolivet               PetscCall(PCKSPSetKSP(pc, inner_ksp));
210213044ca3SPierre Jolivet               std::get<0>(*ctx)[0] = pc_00; /* for coarse correction on the primal (e.g., velocity) space */
210313044ca3SPierre Jolivet               PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &std::get<0>(*ctx)[1]));
210451ea4bc8SPierre Jolivet               PetscCall(PCSetOptionsPrefix(pc, prefix)); /* both PC share the same prefix so that the outer PC can be reset with PCSetFromOptions() */
210513044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(std::get<0>(*ctx)[1], prefix));
210613044ca3SPierre Jolivet               PetscCall(PetscFree(prefix));
210713044ca3SPierre Jolivet               PetscCall(PCSetOperators(std::get<0>(*ctx)[1], pc->mat, pc->pmat));
210813044ca3SPierre Jolivet               PetscCall(PCSetType(std::get<0>(*ctx)[1], PCHPDDM));
210913044ca3SPierre 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 */
2110cf67ef9dSPierre Jolivet               if (flg) static_cast<PC_HPDDM *>(std::get<0>(*ctx)[1]->data)->Neumann = PETSC_BOOL3_TRUE;
21118a8e6071SPierre Jolivet               else if (PetscDefined(USE_DEBUG) && norm > PETSC_MACHINE_EPSILON * static_cast<PetscReal>(10.0)) {
21128a8e6071SPierre Jolivet                 /* no check when A11 is near zero */
21138a8e6071SPierre Jolivet                 PetscCall(MatCreateSubMatrices(A11, 1, &uis, &uis, MAT_INITIAL_MATRIX, &sub));
21148a8e6071SPierre Jolivet                 PetscCall(PCHPDDMCheckMatStructure_Private(pc, sub[0], uaux));
21158a8e6071SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
21168a8e6071SPierre Jolivet               }
211713044ca3SPierre Jolivet               PetscCall(PCSetFromOptions(std::get<0>(*ctx)[1]));
211813044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)uis));
211913044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)uaux));
212013044ca3SPierre 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 */
212157d50842SBarry Smith               PetscCall(MatShellSetOperation(S, MATOP_MULT, (PetscErrorCodeFn *)MatMult_SchurCorrection));
212257d50842SBarry Smith               PetscCall(MatShellSetOperation(S, MATOP_VIEW, (PetscErrorCodeFn *)MatView_SchurCorrection));
212357d50842SBarry Smith               PetscCall(MatShellSetOperation(S, MATOP_DESTROY, (PetscErrorCodeFn *)MatDestroy_SchurCorrection));
212413044ca3SPierre Jolivet               PetscCall(KSPGetPCSide(inner_ksp, &(std::get<2>(*ctx))));
212513044ca3SPierre Jolivet               if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
212613044ca3SPierre Jolivet                 PetscCall(KSPSetPreSolve(inner_ksp, KSPPreSolve_SchurCorrection, ctx));
212713044ca3SPierre Jolivet               } else { /* no support for PC_SYMMETRIC */
212813044ca3SPierre 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]);
212913044ca3SPierre Jolivet               }
213013044ca3SPierre Jolivet               PetscCall(KSPSetPostSolve(inner_ksp, KSPPostSolve_SchurCorrection, ctx));
2131715c1178SPierre Jolivet               PetscCall(PetscObjectContainerCompose((PetscObject)std::get<0>(*ctx)[1], "_PCHPDDM_Schur", ctx, nullptr));
213213044ca3SPierre Jolivet               PetscCall(PCSetUp(std::get<0>(*ctx)[1]));
213313044ca3SPierre Jolivet               PetscCall(KSPSetOperators(inner_ksp, S, S));
213413044ca3SPierre Jolivet               PetscCall(MatCreateVecs(std::get<1>(*ctx)[0], std::get<3>(*ctx), std::get<3>(*ctx) + 1));
213513044ca3SPierre Jolivet               PetscCall(VecDuplicate(std::get<3>(*ctx)[0], std::get<3>(*ctx) + 2));
213613044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)inner_ksp));
213713044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)S));
213851ea4bc8SPierre Jolivet             } else {
213951ea4bc8SPierre Jolivet               std::get<0>(*ctx)[0] = pc_00;
214051ea4bc8SPierre Jolivet               PetscCall(PetscObjectContainerCompose((PetscObject)pc, "_PCHPDDM_Schur", ctx, nullptr));
214151ea4bc8SPierre 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 */
214251ea4bc8SPierre Jolivet               PetscCall(MatGetDiagonalBlock(A11, &data->aux));
214351ea4bc8SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)data->aux));
214451ea4bc8SPierre Jolivet               PetscCall(PCSetUp(pc));
214551ea4bc8SPierre Jolivet             }
21460307214fSPierre Jolivet             for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
214713044ca3SPierre Jolivet             PetscFunctionReturn(PETSC_SUCCESS);
214813044ca3SPierre Jolivet           } else { /* second call to PCSetUp() on the PC associated to the Schur complement, retrieve previously set context */
21492a8381b2SBarry Smith             PetscCall(PetscContainerGetPointer(container, &ctx));
215013044ca3SPierre Jolivet           }
215113044ca3SPierre Jolivet         }
215213044ca3SPierre Jolivet       }
215313044ca3SPierre Jolivet     }
2154f1580f4eSBarry Smith     if (!data->is && data->N > 1) {
2155f1580f4eSBarry Smith       char type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
2156811e8887SPierre Jolivet 
2157f1580f4eSBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
2158f1580f4eSBarry Smith       if (flg || (A->rmap->N != A->cmap->N && P->rmap->N == P->cmap->N && P->rmap->N == A->cmap->N)) {
2159f1580f4eSBarry Smith         Mat B;
2160811e8887SPierre Jolivet 
2161f1580f4eSBarry Smith         PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, A, P, &B, pcpre));
2162f1580f4eSBarry Smith         if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) data->correction = PC_HPDDM_COARSE_CORRECTION_BALANCED;
2163f1580f4eSBarry Smith         PetscCall(MatDestroy(&B));
2164f1580f4eSBarry Smith       } else {
2165f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
2166f1580f4eSBarry Smith         if (flg) {
2167f1580f4eSBarry Smith           Mat                 A00, P00, A01, A10, A11, B, N;
216813044ca3SPierre Jolivet           PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_LEAST_SQUARES;
216913044ca3SPierre Jolivet 
217013044ca3SPierre Jolivet           PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, &A01, &A10, &A11));
21718dc3fbeeSPierre Jolivet           PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
217213044ca3SPierre Jolivet           if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
2173281f8ce6SPierre Jolivet             Mat                        B01;
21743df4cd7bSPierre Jolivet             Vec                        diagonal = nullptr;
2175f1580f4eSBarry Smith             const PetscScalar         *array;
2176f1580f4eSBarry Smith             MatSchurComplementAinvType type;
2177f1580f4eSBarry Smith 
2178281f8ce6SPierre Jolivet             PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10, &B01));
2179f1580f4eSBarry Smith             if (A11) {
21803df4cd7bSPierre Jolivet               PetscCall(MatCreateVecs(A11, &diagonal, nullptr));
21813df4cd7bSPierre Jolivet               PetscCall(MatGetDiagonal(A11, diagonal));
2182f1580f4eSBarry Smith             }
2183db4a47b3SPierre Jolivet             PetscCall(MatCreateVecs(P00, &v, nullptr));
2184f1580f4eSBarry Smith             PetscCall(MatSchurComplementGetAinvType(P, &type));
2185e5634b20SPierre 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",
2186e5634b20SPierre Jolivet                        ((PetscObject)P)->prefix ? ((PetscObject)P)->prefix : "", MatSchurComplementAinvTypes[type]);
2187e5634b20SPierre Jolivet             if (type != MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG) {
2188f1580f4eSBarry Smith               if (type == MAT_SCHUR_COMPLEMENT_AINV_LUMP) {
2189f1580f4eSBarry Smith                 PetscCall(MatGetRowSum(P00, v));
2190f1580f4eSBarry Smith                 if (A00 == P00) PetscCall(PetscObjectReference((PetscObject)A00));
2191f1580f4eSBarry Smith                 PetscCall(MatDestroy(&P00));
2192f1580f4eSBarry Smith                 PetscCall(VecGetArrayRead(v, &array));
2193db4a47b3SPierre Jolivet                 PetscCall(MatCreateAIJ(PetscObjectComm((PetscObject)A00), A00->rmap->n, A00->cmap->n, A00->rmap->N, A00->cmap->N, 1, nullptr, 0, nullptr, &P00));
2194f1580f4eSBarry Smith                 PetscCall(MatSetOption(P00, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
2195f1580f4eSBarry Smith                 for (n = A00->rmap->rstart; n < A00->rmap->rend; ++n) PetscCall(MatSetValue(P00, n, n, array[n - A00->rmap->rstart], INSERT_VALUES));
2196f1580f4eSBarry Smith                 PetscCall(MatAssemblyBegin(P00, MAT_FINAL_ASSEMBLY));
2197f1580f4eSBarry Smith                 PetscCall(MatAssemblyEnd(P00, MAT_FINAL_ASSEMBLY));
2198f1580f4eSBarry Smith                 PetscCall(VecRestoreArrayRead(v, &array));
2199f1580f4eSBarry Smith                 PetscCall(MatSchurComplementUpdateSubMatrices(P, A00, P00, A01, A10, A11)); /* replace P00 by diag(sum of each row of P00) */
2200f1580f4eSBarry Smith                 PetscCall(MatDestroy(&P00));
2201f1580f4eSBarry Smith               } else PetscCall(MatGetDiagonal(P00, v));
2202f1580f4eSBarry Smith               PetscCall(VecReciprocal(v)); /* inv(diag(P00))       */
2203f1580f4eSBarry Smith               PetscCall(VecSqrtAbs(v));    /* sqrt(inv(diag(P00))) */
2204f1580f4eSBarry Smith               PetscCall(MatDuplicate(A01, MAT_COPY_VALUES, &B));
2205db4a47b3SPierre Jolivet               PetscCall(MatDiagonalScale(B, v, nullptr));
2206281f8ce6SPierre Jolivet               if (B01) PetscCall(MatDiagonalScale(B01, v, nullptr));
220758aab184SPierre Jolivet             } else {
2208e5634b20SPierre Jolivet               Mat     D00;
2209e5634b20SPierre Jolivet               MatType type;
2210e5634b20SPierre Jolivet 
2211e5634b20SPierre Jolivet               PetscCall(MatCreate(PetscObjectComm((PetscObject)A00), &D00));
2212e5634b20SPierre Jolivet               PetscCall(MatSetType(D00, MATAIJ));
2213e5634b20SPierre Jolivet               PetscCall(MatSetOptionsPrefix(D00, ((PetscObject)A00)->prefix));
2214e5634b20SPierre Jolivet               PetscCall(MatAppendOptionsPrefix(D00, "block_diagonal_"));
2215e5634b20SPierre Jolivet               PetscCall(MatSetFromOptions(D00));                          /* for setting -mat_block_size dynamically */
2216e5634b20SPierre 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 */
2217e5634b20SPierre Jolivet               PetscCall(MatSetBlockSizesFromMats(B, D00, D00));
2218e5634b20SPierre Jolivet               PetscCall(MatInvertBlockDiagonalMat(B, D00));
2219e5634b20SPierre Jolivet               PetscCall(MatDestroy(&B));
2220e5634b20SPierre Jolivet               PetscCall(MatGetType(A01, &type));                            /* cache MatType */
2221e5634b20SPierre Jolivet               PetscCall(MatConvert(A01, MATAIJ, MAT_INPLACE_MATRIX, &A01)); /* MatProduct is not versatile enough to fallback gracefully if no implementation found, so MatConvert() */
2222e5634b20SPierre Jolivet               PetscCall(MatMatMult(D00, A01, MAT_INITIAL_MATRIX, PETSC_CURRENT, &B));
2223e5634b20SPierre Jolivet               PetscCall(MatDestroy(&D00));
2224e5634b20SPierre Jolivet               PetscCall(MatConvert(A01, type, MAT_INPLACE_MATRIX, &A01)); /* reset to previous MatType */
2225e5634b20SPierre Jolivet               PetscCall(MatConvert(B, type, MAT_INPLACE_MATRIX, &B));
2226e5634b20SPierre Jolivet               if (!B01) { /* symmetric case */
2227e5634b20SPierre Jolivet                 B01 = A01;
2228e5634b20SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)B01));
2229e5634b20SPierre Jolivet               }
2230e5634b20SPierre Jolivet             }
2231e5634b20SPierre Jolivet             if (B01 && B01 != A01) PetscCall(MatSetBlockSizesFromMats(B01, A01, A01)); /* TODO: remove this line once Firedrake is fixed */
2232f1580f4eSBarry Smith             PetscCall(VecDestroy(&v));
2233f1580f4eSBarry Smith             PetscCall(MatCreateNormalHermitian(B, &N));
2234281f8ce6SPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, B, N, &P, pcpre, &diagonal, B01));
2235f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
2236f1580f4eSBarry Smith             if (!flg) {
2237f1580f4eSBarry Smith               PetscCall(MatDestroy(&P));
2238f1580f4eSBarry Smith               P = N;
2239f1580f4eSBarry Smith               PetscCall(PetscObjectReference((PetscObject)P));
2240feebddf4SPierre Jolivet             }
22413df4cd7bSPierre Jolivet             if (diagonal) {
2242e5634b20SPierre Jolivet               PetscCall(MatSetOption(P, MAT_NEW_NONZERO_LOCATION_ERR, PETSC_FALSE)); /* may have missing diagonal entries */
22433df4cd7bSPierre Jolivet               PetscCall(MatDiagonalSet(P, diagonal, ADD_VALUES));
2244feebddf4SPierre Jolivet               PetscCall(PCSetOperators(pc, P, P)); /* replace P by A01^T inv(diag(P00)) A01 - diag(P11) */
22453df4cd7bSPierre Jolivet               PetscCall(VecDestroy(&diagonal));
2246281f8ce6SPierre Jolivet             } else PetscCall(PCSetOperators(pc, B01 ? P : N, P));  /* replace P by A01^T inv(diag(P00)) A01                         */
2247feebddf4SPierre Jolivet             pc->ops->postsolve = PCPostSolve_SchurPreLeastSquares; /*  PCFIELDSPLIT expect a KSP for (P11 - A10 inv(diag(P00)) A01) */
2248feebddf4SPierre Jolivet             PetscCall(MatDestroy(&N));                             /*  but a PC for (A10 inv(diag(P00)) A10 - P11) is setup instead */
2249feebddf4SPierre Jolivet             PetscCall(MatDestroy(&P));                             /*  so the sign of the solution must be flipped                  */
2250f1580f4eSBarry Smith             PetscCall(MatDestroy(&B));
225113044ca3SPierre Jolivet           } else
2252fd310a01SPierre 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 : "");
22530307214fSPierre Jolivet           for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
22543ba16761SJacob Faibussowitsch           PetscFunctionReturn(PETSC_SUCCESS);
2255f1580f4eSBarry Smith         } else {
22568dc3fbeeSPierre Jolivet           PetscCall(PetscOptionsGetString(((PetscObject)pc)->options, pcpre, "-pc_hpddm_levels_1_st_pc_type", type, sizeof(type), nullptr));
2257f1580f4eSBarry Smith           PetscCall(PetscStrcmp(type, PCMAT, &algebraic));
2258*fc31f830SPierre Jolivet           PetscCheck(!algebraic || !block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_levels_1_st_pc_type mat and -%spc_hpddm_block_splitting", pcpre ? pcpre : "", pcpre ? pcpre : "");
22599bb5c669SPierre Jolivet           if (overlap != -1) {
2260*fc31f830SPierre Jolivet             PetscCheck(!block && !algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_%s and -%spc_hpddm_harmonic_overlap", pcpre ? pcpre : "", block ? "block_splitting" : "levels_1_st_pc_type mat", pcpre ? pcpre : "");
2261*fc31f830SPierre Jolivet             PetscCheck(overlap >= 1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_WRONG, "-%spc_hpddm_harmonic_overlap %" PetscInt_FMT " < 1", pcpre ? pcpre : "", overlap);
22629bb5c669SPierre Jolivet           }
22639bb5c669SPierre Jolivet           if (block || overlap != -1) algebraic = PETSC_TRUE;
2264f1580f4eSBarry Smith           if (algebraic) {
2265f1580f4eSBarry Smith             PetscCall(ISCreateStride(PETSC_COMM_SELF, P->rmap->n, P->rmap->rstart, 1, &data->is));
2266f1580f4eSBarry Smith             PetscCall(MatIncreaseOverlap(P, 1, &data->is, 1));
2267f1580f4eSBarry Smith             PetscCall(ISSort(data->is));
22689bb5c669SPierre Jolivet           } else
22699bb5c669SPierre 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 : ""));
2270f1580f4eSBarry Smith         }
2271f1580f4eSBarry Smith       }
2272f1580f4eSBarry Smith     }
2273f1580f4eSBarry Smith   }
2274398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2275398c7888SPierre Jolivet   if (data->is) PetscCall(ISDuplicate(data->is, &dis));
2276398c7888SPierre Jolivet   if (data->aux) PetscCall(MatDuplicate(data->aux, MAT_COPY_VALUES, &daux));
2277398c7888SPierre Jolivet #endif
2278f1580f4eSBarry Smith   if (data->is || (ismatis && data->N > 1)) {
2279f1580f4eSBarry Smith     if (ismatis) {
2280f1580f4eSBarry Smith       std::initializer_list<std::string> list = {MATSEQBAIJ, MATSEQSBAIJ};
2281f1580f4eSBarry Smith       PetscCall(MatISGetLocalMat(P, &N));
2282f1580f4eSBarry Smith       std::initializer_list<std::string>::const_iterator it = std::find(list.begin(), list.end(), ((PetscObject)N)->type_name);
2283f1580f4eSBarry Smith       PetscCall(MatISRestoreLocalMat(P, &N));
2284f1580f4eSBarry Smith       switch (std::distance(list.begin(), it)) {
2285d71ae5a4SJacob Faibussowitsch       case 0:
2286d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
2287d71ae5a4SJacob Faibussowitsch         break;
2288f1580f4eSBarry Smith       case 1:
2289f1580f4eSBarry Smith         /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIBAIJ */
2290f1580f4eSBarry Smith         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
2291f1580f4eSBarry Smith         break;
2292d71ae5a4SJacob Faibussowitsch       default:
2293d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, &C));
2294f1580f4eSBarry Smith       }
2295db4a47b3SPierre Jolivet       PetscCall(MatISGetLocalToGlobalMapping(P, &l2g, nullptr));
2296f1580f4eSBarry Smith       PetscCall(PetscObjectReference((PetscObject)P));
2297f1580f4eSBarry Smith       PetscCall(KSPSetOperators(data->levels[0]->ksp, A, C));
2298f1580f4eSBarry Smith       std::swap(C, P);
2299f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingGetSize(l2g, &n));
2300f1580f4eSBarry Smith       PetscCall(ISCreateStride(PETSC_COMM_SELF, n, 0, 1, &loc));
2301f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingApplyIS(l2g, loc, &is[0]));
2302f1580f4eSBarry Smith       PetscCall(ISDestroy(&loc));
2303f1580f4eSBarry Smith       /* the auxiliary Mat is _not_ the local Neumann matrix                                */
2304f1580f4eSBarry Smith       /* it is the local Neumann matrix augmented (with zeros) through MatIncreaseOverlap() */
2305c8ea6600SPierre Jolivet       data->Neumann = PETSC_BOOL3_FALSE;
2306f1580f4eSBarry Smith       structure     = SAME_NONZERO_PATTERN;
2307f1580f4eSBarry Smith     } else {
2308f1580f4eSBarry Smith       is[0] = data->is;
230913044ca3SPierre Jolivet       if (algebraic || ctx) subdomains = PETSC_TRUE;
23108dc3fbeeSPierre Jolivet       PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, pcpre, "-pc_hpddm_define_subdomains", &subdomains, nullptr));
231113044ca3SPierre 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);
2312c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann)) {
2313*fc31f830SPierre Jolivet         PetscCheck(!block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_block_splitting and -%spc_hpddm_has_neumann", pcpre ? pcpre : "", pcpre ? pcpre : "");
2314*fc31f830SPierre Jolivet         PetscCheck(overlap == -1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_harmonic_overlap %" PetscInt_FMT " and -%spc_hpddm_has_neumann", pcpre ? pcpre : "", overlap, pcpre ? pcpre : "");
2315*fc31f830SPierre Jolivet         PetscCheck(!algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-%spc_hpddm_levels_1_st_pc_type mat and -%spc_hpddm_has_neumann", pcpre ? pcpre : "", pcpre ? pcpre : "");
2316f1580f4eSBarry Smith       }
2317c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann) || block) structure = SAME_NONZERO_PATTERN;
2318f1580f4eSBarry Smith       PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), P->rmap->n, P->rmap->rstart, 1, &loc));
2319f1580f4eSBarry Smith     }
2320f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
23218dc3fbeeSPierre Jolivet     PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, prefix, "-st_matstructure", MatStructures, (PetscEnum *)&structure, &flg)); /* if not user-provided, force its value when possible */
2322f1580f4eSBarry Smith     if (!flg && structure == SAME_NONZERO_PATTERN) { /* cannot call STSetMatStructure() yet, insert the appropriate option in the database, parsed by STSetFromOptions() */
2323f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-%spc_hpddm_levels_1_st_matstructure", pcpre ? pcpre : ""));
23248dc3fbeeSPierre Jolivet       PetscCall(PetscOptionsSetValue(((PetscObject)pc)->options, prefix, MatStructures[structure]));
2325f1580f4eSBarry Smith     }
2326398c7888SPierre Jolivet     flg = PETSC_FALSE;
2327b07dfdedSPierre Jolivet     if (data->share) {
2328398c7888SPierre Jolivet       data->share = PETSC_FALSE; /* will be reset to PETSC_TRUE if none of the conditions below are true */
2329398c7888SPierre 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 : ""));
2330398c7888SPierre Jolivet       else if (data->deflation) PetscCall(PetscInfo(pc, "Nothing to share since PCHPDDMSetDeflationMat() has been called\n"));
2331398c7888SPierre Jolivet       else if (ismatis) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc with a Pmat of type MATIS\n"));
2332b07dfdedSPierre Jolivet       else if (!algebraic && structure != SAME_NONZERO_PATTERN)
2333398c7888SPierre 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]));
2334398c7888SPierre Jolivet       else data->share = PETSC_TRUE;
2335398c7888SPierre Jolivet     }
2336398c7888SPierre Jolivet     if (!ismatis) {
2337398c7888SPierre Jolivet       if (data->share || (!PetscBool3ToBool(data->Neumann) && subdomains)) PetscCall(ISDuplicate(is[0], &unsorted));
2338398c7888SPierre Jolivet       else unsorted = is[0];
2339398c7888SPierre Jolivet     }
234051ea4bc8SPierre Jolivet     if ((ctx || data->N > 1) && (data->aux || ismatis || algebraic)) {
2341f1580f4eSBarry Smith       PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "HPDDM library not loaded, cannot use more than one level");
2342f1580f4eSBarry Smith       PetscCall(MatSetOption(P, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
2343f1580f4eSBarry Smith       if (ismatis) {
2344f1580f4eSBarry Smith         /* needed by HPDDM (currently) so that the partition of unity is 0 on subdomain interfaces */
2345f1580f4eSBarry Smith         PetscCall(MatIncreaseOverlap(P, 1, is, 1));
2346f1580f4eSBarry Smith         PetscCall(ISDestroy(&data->is));
2347f1580f4eSBarry Smith         data->is = is[0];
2348f1580f4eSBarry Smith       } else {
2349d16c0b94SPierre Jolivet         if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_TRUE));
235051ea4bc8SPierre Jolivet         if (!ctx && overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", PCHPDDMAlgebraicAuxiliaryMat_Private));
23519bb5c669SPierre Jolivet         if (!PetscBool3ToBool(data->Neumann) && (!algebraic || overlap != -1)) {
2352f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
2353f1580f4eSBarry Smith           if (flg) {
2354f1580f4eSBarry Smith             /* maybe better to ISSort(is[0]), MatCreateSubMatrices(), and then MatPermute() */
2355f1580f4eSBarry Smith             /* but there is no MatPermute_SeqSBAIJ(), so as before, just use MATMPIBAIJ     */
2356f1580f4eSBarry Smith             PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &uaux));
2357f1580f4eSBarry Smith             flg = PETSC_FALSE;
2358f1580f4eSBarry Smith           }
2359f1580f4eSBarry Smith         }
2360f1580f4eSBarry Smith       }
23619bb5c669SPierre Jolivet       if (algebraic && overlap == -1) {
2362f1580f4eSBarry Smith         PetscUseMethod(pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", (Mat, IS *, Mat *[], PetscBool), (P, is, &sub, block));
2363f1580f4eSBarry Smith         if (block) {
2364f1580f4eSBarry Smith           PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", (PetscObject *)&data->aux));
2365db4a47b3SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", nullptr));
2366f1580f4eSBarry Smith         }
23679bb5c669SPierre Jolivet       } else if (!uaux || overlap != -1) {
236813044ca3SPierre Jolivet         if (!ctx) {
2369c8ea6600SPierre Jolivet           if (PetscBool3ToBool(data->Neumann)) sub = &data->aux;
23709bb5c669SPierre Jolivet           else {
2371df21ef68SPierre Jolivet             PetscBool flg;
23729bb5c669SPierre Jolivet             if (overlap != -1) {
23739bb5c669SPierre Jolivet               Harmonic              h;
23749bb5c669SPierre Jolivet               Mat                   A0, *a;                    /* with an SVD: [ A_00  A_01       ] */
23759bb5c669SPierre Jolivet               IS                    ov[2], rows, cols, stride; /*              [ A_10  A_11  A_12 ] */
237658b7e2c1SStefano Zampini               const PetscInt       *i[2], bs = P->cmap->bs;    /* with a GEVP: [ A_00  A_01       ] */
237754bee67dSPierre Jolivet               PetscInt              n[2], location;            /*              [ A_10  A_11  A_12 ] */
23789bb5c669SPierre Jolivet               std::vector<PetscInt> v[2];                      /*              [       A_21  A_22 ] */
23799bb5c669SPierre Jolivet 
23802589ceddSPierre Jolivet               do {
23819bb5c669SPierre Jolivet                 PetscCall(ISDuplicate(data->is, ov));
23829bb5c669SPierre Jolivet                 if (overlap > 1) PetscCall(MatIncreaseOverlap(P, 1, ov, overlap - 1));
23839bb5c669SPierre Jolivet                 PetscCall(ISDuplicate(ov[0], ov + 1));
23849bb5c669SPierre Jolivet                 PetscCall(MatIncreaseOverlap(P, 1, ov + 1, 1));
23852589ceddSPierre Jolivet                 PetscCall(ISGetLocalSize(ov[0], n));
23862589ceddSPierre Jolivet                 PetscCall(ISGetLocalSize(ov[1], n + 1));
23878fad524dSPierre Jolivet                 flg = PetscBool(n[0] == n[1] && n[0] != P->rmap->n);
23885440e5dcSBarry Smith                 PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &flg, 1, MPI_C_BOOL, MPI_LOR, PetscObjectComm((PetscObject)pc)));
23892589ceddSPierre Jolivet                 if (flg) {
23902589ceddSPierre Jolivet                   PetscCall(ISDestroy(ov));
23912589ceddSPierre Jolivet                   PetscCall(ISDestroy(ov + 1));
23922589ceddSPierre Jolivet                   PetscCheck(--overlap, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "No oversampling possible");
23932589ceddSPierre Jolivet                   PetscCall(PetscInfo(pc, "Supplied -%spc_hpddm_harmonic_overlap parameter is too large, it has been decreased to %" PetscInt_FMT "\n", pcpre ? pcpre : "", overlap));
23942589ceddSPierre Jolivet                 } else break;
23952589ceddSPierre Jolivet               } while (1);
23969bb5c669SPierre Jolivet               PetscCall(PetscNew(&h));
23979bb5c669SPierre Jolivet               h->ksp = nullptr;
23989bb5c669SPierre Jolivet               PetscCall(PetscCalloc1(2, &h->A));
23998dc3fbeeSPierre Jolivet               PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, prefix, "-eps_nev", &flg));
2400b5a302b3SPierre Jolivet               if (!flg) {
24018dc3fbeeSPierre Jolivet                 PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, prefix, "-svd_nsv", &flg));
24028dc3fbeeSPierre Jolivet                 if (!flg) PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, prefix, "-svd_threshold_relative", &flg));
2403b5a302b3SPierre Jolivet               } else flg = PETSC_FALSE;
24049bb5c669SPierre Jolivet               PetscCall(ISSort(ov[0]));
24059bb5c669SPierre Jolivet               if (!flg) PetscCall(ISSort(ov[1]));
240632603206SJames Wright               PetscCall(PetscCalloc1(5, &h->is));
24079bb5c669SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, ov + !flg, ov + 1, MAT_INITIAL_MATRIX, &a)); /* submatrix from above, either square (!flg) or rectangular (flg) */
24082589ceddSPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISGetIndices(ov[j], i + j));
24099bb5c669SPierre Jolivet               v[1].reserve((n[1] - n[0]) / bs);
24109bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[1]; j += bs) { /* indices of the (2,2) block */
24119bb5c669SPierre Jolivet                 PetscCall(ISLocate(ov[0], i[1][j], &location));
24129bb5c669SPierre Jolivet                 if (location < 0) v[1].emplace_back(j / bs);
24139bb5c669SPierre Jolivet               }
24149bb5c669SPierre Jolivet               if (!flg) {
24159bb5c669SPierre Jolivet                 h->A[1] = a[0];
24169bb5c669SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)h->A[1]));
24179bb5c669SPierre Jolivet                 v[0].reserve((n[0] - P->rmap->n) / bs);
24189bb5c669SPierre Jolivet                 for (PetscInt j = 0; j < n[1]; j += bs) { /* row indices of the (1,2) block */
24199bb5c669SPierre Jolivet                   PetscCall(ISLocate(loc, i[1][j], &location));
24209bb5c669SPierre Jolivet                   if (location < 0) {
24219bb5c669SPierre Jolivet                     PetscCall(ISLocate(ov[0], i[1][j], &location));
24229bb5c669SPierre Jolivet                     if (location >= 0) v[0].emplace_back(j / bs);
24239bb5c669SPierre Jolivet                   }
24249bb5c669SPierre Jolivet                 }
24259bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
24269bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_COPY_VALUES, h->is + 4));
24279bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, h->is[4], MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
24289bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
24299bb5c669SPierre 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 */
24309bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &rows));
24319bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols = rows, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
24329bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
24339bb5c669SPierre Jolivet                 v[0].clear();
24349bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, ov[1], PETSC_TRUE, h->is + 3));
24359bb5c669SPierre Jolivet                 PetscCall(ISEmbed(data->is, ov[1], PETSC_TRUE, h->is + 2));
24369bb5c669SPierre Jolivet               }
24379bb5c669SPierre Jolivet               v[0].reserve((n[0] - P->rmap->n) / bs);
24389bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[0]; j += bs) {
24399bb5c669SPierre Jolivet                 PetscCall(ISLocate(loc, i[0][j], &location));
24409bb5c669SPierre Jolivet                 if (location < 0) v[0].emplace_back(j / bs);
24419bb5c669SPierre Jolivet               }
24429bb5c669SPierre Jolivet               PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
24439bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISRestoreIndices(ov[j], i + j));
24449bb5c669SPierre Jolivet               if (flg) {
244501962aebSPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, a[0]->rmap->n, 0, 1, &stride));
24469bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &cols));
244701962aebSPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], stride, cols, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
24489bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
244901962aebSPierre Jolivet                 PetscCall(ISDestroy(&stride));
2450b0c98d1dSPierre Jolivet                 if (uaux) { /* initial Pmat was MATSBAIJ, convert back to the same format since this submatrix is square */
2451b0c98d1dSPierre Jolivet                   PetscCall(MatSetOption(A0, MAT_SYMMETRIC, PETSC_TRUE));
2452b0c98d1dSPierre Jolivet                   PetscCall(MatConvert(A0, MATSEQSBAIJ, MAT_INPLACE_MATRIX, &A0));
2453b0c98d1dSPierre Jolivet                 }
24549bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, data->is, PETSC_TRUE, h->is + 2));
24559bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_USE_POINTER, &cols));
24569bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols, MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
24579bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
24589bb5c669SPierre Jolivet               }
24599bb5c669SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, A0->rmap->n, 0, 1, &stride));
24609bb5c669SPierre Jolivet               PetscCall(ISEmbed(rows, stride, PETSC_TRUE, h->is));
24619bb5c669SPierre Jolivet               PetscCall(ISDestroy(&stride));
24629bb5c669SPierre Jolivet               PetscCall(ISDestroy(&rows));
24639bb5c669SPierre Jolivet               PetscCall(ISEmbed(loc, ov[0], PETSC_TRUE, h->is + 1));
24649bb5c669SPierre Jolivet               if (subdomains) {
24659bb5c669SPierre Jolivet                 if (!data->levels[0]->pc) {
24669bb5c669SPierre Jolivet                   PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
24679bb5c669SPierre Jolivet                   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
24689bb5c669SPierre Jolivet                   PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
24699bb5c669SPierre Jolivet                   PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
24709bb5c669SPierre Jolivet                 }
24719bb5c669SPierre Jolivet                 PetscCall(PCSetType(data->levels[0]->pc, PCASM));
24729bb5c669SPierre Jolivet                 if (!data->levels[0]->pc->setupcalled) PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, ov + !flg, &loc));
24739bb5c669SPierre Jolivet                 PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, flg ? A0 : a[0], PETSC_TRUE));
24749bb5c669SPierre Jolivet                 if (!flg) ++overlap;
24759bb5c669SPierre Jolivet                 if (data->share) {
24769bb5c669SPierre Jolivet                   PetscInt n = -1;
24779bb5c669SPierre Jolivet                   PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
24789bb5c669SPierre Jolivet                   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
24799bb5c669SPierre Jolivet                   if (flg) {
24809bb5c669SPierre Jolivet                     h->ksp = ksp[0];
24819bb5c669SPierre Jolivet                     PetscCall(PetscObjectReference((PetscObject)h->ksp));
24829bb5c669SPierre Jolivet                   }
24839bb5c669SPierre Jolivet                 }
24849bb5c669SPierre Jolivet               }
24859bb5c669SPierre Jolivet               if (!h->ksp) {
24869bb5c669SPierre Jolivet                 PetscBool share = data->share;
24878dc3fbeeSPierre Jolivet 
24889bb5c669SPierre Jolivet                 PetscCall(KSPCreate(PETSC_COMM_SELF, &h->ksp));
24899bb5c669SPierre Jolivet                 PetscCall(KSPSetType(h->ksp, KSPPREONLY));
24909bb5c669SPierre Jolivet                 PetscCall(KSPSetOperators(h->ksp, A0, A0));
24919bb5c669SPierre Jolivet                 do {
24929bb5c669SPierre Jolivet                   if (!data->share) {
24939bb5c669SPierre Jolivet                     share = PETSC_FALSE;
24949bb5c669SPierre Jolivet                     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_%s", pcpre ? pcpre : "", flg ? "svd_" : "eps_"));
24959bb5c669SPierre Jolivet                     PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
24969bb5c669SPierre Jolivet                     PetscCall(KSPSetFromOptions(h->ksp));
24979bb5c669SPierre Jolivet                   } else {
24989bb5c669SPierre Jolivet                     MatSolverType type;
24998dc3fbeeSPierre Jolivet 
25008dc3fbeeSPierre Jolivet                     PetscCall(PetscObjectTypeCompareAny((PetscObject)ksp[0]->pc, &data->share, PCLU, PCCHOLESKY, ""));
25019bb5c669SPierre Jolivet                     if (data->share) {
25028dc3fbeeSPierre Jolivet                       PetscCall(PCFactorGetMatSolverType(ksp[0]->pc, &type));
25039bb5c669SPierre Jolivet                       if (!type) {
25048dc3fbeeSPierre Jolivet                         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(ksp[0]->pc, MATSOLVERMUMPS));
25058dc3fbeeSPierre Jolivet                         else if (PetscDefined(HAVE_MKL_PARDISO)) PetscCall(PCFactorSetMatSolverType(ksp[0]->pc, MATSOLVERMKL_PARDISO));
25069bb5c669SPierre Jolivet                         else data->share = PETSC_FALSE;
25078dc3fbeeSPierre Jolivet                         if (data->share) PetscCall(PCSetFromOptions(ksp[0]->pc));
25089bb5c669SPierre Jolivet                       } else {
25099bb5c669SPierre Jolivet                         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &data->share));
25109bb5c669SPierre Jolivet                         if (!data->share) PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &data->share));
25119bb5c669SPierre Jolivet                       }
25129bb5c669SPierre Jolivet                       if (data->share) {
25139bb5c669SPierre Jolivet                         std::tuple<KSP, IS, Vec[2]> *p;
25148dc3fbeeSPierre Jolivet 
25158dc3fbeeSPierre Jolivet                         PetscCall(PCFactorGetMatrix(ksp[0]->pc, &A));
25169bb5c669SPierre Jolivet                         PetscCall(MatFactorSetSchurIS(A, h->is[4]));
25179bb5c669SPierre Jolivet                         PetscCall(KSPSetUp(ksp[0]));
25189bb5c669SPierre Jolivet                         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_eps_shell_", pcpre ? pcpre : ""));
25199bb5c669SPierre Jolivet                         PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
25209bb5c669SPierre Jolivet                         PetscCall(KSPSetFromOptions(h->ksp));
25218dc3fbeeSPierre Jolivet                         PetscCall(PCSetType(h->ksp->pc, PCSHELL));
25229bb5c669SPierre Jolivet                         PetscCall(PetscNew(&p));
25239bb5c669SPierre Jolivet                         std::get<0>(*p) = ksp[0];
25249bb5c669SPierre Jolivet                         PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &std::get<1>(*p)));
25259bb5c669SPierre Jolivet                         PetscCall(MatCreateVecs(A, std::get<2>(*p), std::get<2>(*p) + 1));
25268dc3fbeeSPierre Jolivet                         PetscCall(PCShellSetContext(h->ksp->pc, p));
25278dc3fbeeSPierre Jolivet                         PetscCall(PCShellSetApply(h->ksp->pc, PCApply_Schur));
25288dc3fbeeSPierre Jolivet                         PetscCall(PCShellSetApplyTranspose(h->ksp->pc, PCApply_Schur<Vec, true>));
25298dc3fbeeSPierre Jolivet                         PetscCall(PCShellSetMatApply(h->ksp->pc, PCApply_Schur<Mat>));
25308dc3fbeeSPierre Jolivet                         PetscCall(PCShellSetDestroy(h->ksp->pc, PCDestroy_Schur));
25319bb5c669SPierre Jolivet                       }
25329bb5c669SPierre Jolivet                     }
25339bb5c669SPierre Jolivet                     if (!data->share) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since neither MUMPS nor MKL PARDISO is used\n"));
25349bb5c669SPierre Jolivet                   }
25359bb5c669SPierre 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 */
25369bb5c669SPierre Jolivet               }
25379bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov));
25389bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov + 1));
25399bb5c669SPierre Jolivet               if (overlap == 1 && subdomains && flg) {
25409bb5c669SPierre Jolivet                 *subA = A0;
25419bb5c669SPierre Jolivet                 sub   = subA;
25429bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatDestroy(&uaux));
25439bb5c669SPierre Jolivet               } else PetscCall(MatDestroy(&A0));
25449bb5c669SPierre Jolivet               PetscCall(MatCreateShell(PETSC_COMM_SELF, P->rmap->n, n[1] - n[0], P->rmap->n, n[1] - n[0], h, &data->aux));
2545bdcd51b8SPierre Jolivet               PetscCall(KSPSetErrorIfNotConverged(h->ksp, PETSC_TRUE)); /* bail out as early as possible to avoid (apparently) unrelated error messages */
25469bb5c669SPierre Jolivet               PetscCall(MatCreateVecs(h->ksp->pc->pmat, &h->v, nullptr));
254757d50842SBarry Smith               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT, (PetscErrorCodeFn *)MatMult_Harmonic));
254857d50842SBarry Smith               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT_TRANSPOSE, (PetscErrorCodeFn *)MatMultTranspose_Harmonic));
25499bb5c669SPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AB, nullptr, MatProduct_AB_Harmonic, nullptr, MATDENSE, MATDENSE));
2550f21e3f8aSPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AtB, nullptr, MatProduct_AtB_Harmonic, nullptr, MATDENSE, MATDENSE));
255157d50842SBarry Smith               PetscCall(MatShellSetOperation(data->aux, MATOP_DESTROY, (PetscErrorCodeFn *)MatDestroy_Harmonic));
25529bb5c669SPierre Jolivet               PetscCall(MatDestroySubMatrices(1, &a));
25539bb5c669SPierre Jolivet             }
2554df21ef68SPierre Jolivet             if (overlap != 1 || !subdomains) {
2555df21ef68SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2556df21ef68SPierre Jolivet               if (ismatis) {
2557df21ef68SPierre Jolivet                 PetscCall(MatISGetLocalMat(C, &N));
2558df21ef68SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)N, MATSEQSBAIJ, &flg));
2559df21ef68SPierre Jolivet                 if (flg) PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2560df21ef68SPierre Jolivet                 PetscCall(MatISRestoreLocalMat(C, &N));
2561df21ef68SPierre Jolivet               }
2562df21ef68SPierre Jolivet             }
25639bb5c669SPierre Jolivet             if (uaux) {
25649bb5c669SPierre Jolivet               PetscCall(MatDestroy(&uaux));
25659bb5c669SPierre Jolivet               PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
25669bb5c669SPierre Jolivet             }
25679bb5c669SPierre Jolivet           }
256813044ca3SPierre Jolivet         }
256951ea4bc8SPierre Jolivet       } else if (!ctx) {
2570f1580f4eSBarry Smith         PetscCall(MatCreateSubMatrices(uaux, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2571f1580f4eSBarry Smith         PetscCall(MatDestroy(&uaux));
2572f1580f4eSBarry Smith         PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2573f1580f4eSBarry Smith       }
257451ea4bc8SPierre Jolivet       if (data->N > 1) {
2575f1580f4eSBarry Smith         /* Vec holding the partition of unity */
2576f1580f4eSBarry Smith         if (!data->levels[0]->D) {
2577f1580f4eSBarry Smith           PetscCall(ISGetLocalSize(data->is, &n));
2578f1580f4eSBarry Smith           PetscCall(VecCreateMPI(PETSC_COMM_SELF, n, PETSC_DETERMINE, &data->levels[0]->D));
2579f1580f4eSBarry Smith         }
25809bb5c669SPierre Jolivet         if (data->share && overlap == -1) {
2581f1580f4eSBarry Smith           Mat      D;
2582db4a47b3SPierre Jolivet           IS       perm = nullptr;
2583f1580f4eSBarry Smith           PetscInt size = -1;
2584811e8887SPierre Jolivet 
2585398c7888SPierre Jolivet           if (!data->levels[0]->pc) {
2586398c7888SPierre Jolivet             PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2587398c7888SPierre Jolivet             PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
2588398c7888SPierre Jolivet             PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
2589398c7888SPierre Jolivet             PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
2590398c7888SPierre Jolivet           }
2591398c7888SPierre Jolivet           PetscCall(PCSetType(data->levels[0]->pc, PCASM));
259213044ca3SPierre Jolivet           if (!ctx) {
2593398c7888SPierre Jolivet             if (!data->levels[0]->pc->setupcalled) {
2594398c7888SPierre Jolivet               IS sorted; /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2595398c7888SPierre Jolivet               PetscCall(ISDuplicate(is[0], &sorted));
2596398c7888SPierre Jolivet               PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &sorted, &loc));
2597398c7888SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)sorted));
2598398c7888SPierre Jolivet             }
2599398c7888SPierre Jolivet             PetscCall(PCSetFromOptions(data->levels[0]->pc));
2600398c7888SPierre Jolivet             if (block) {
2601398c7888SPierre Jolivet               PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, sub[0], &C, &perm));
2602398c7888SPierre Jolivet               PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, C, algebraic));
2603398c7888SPierre Jolivet             } else PetscCall(PCSetUp(data->levels[0]->pc));
2604db4a47b3SPierre Jolivet             PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &size, nullptr, &ksp));
2605398c7888SPierre Jolivet             if (size != 1) {
2606398c7888SPierre Jolivet               data->share = PETSC_FALSE;
2607398c7888SPierre Jolivet               PetscCheck(size == -1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", size);
2608398c7888SPierre Jolivet               PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since PCASMGetSubKSP() not found in fine-level PC\n"));
2609398c7888SPierre Jolivet               PetscCall(ISDestroy(&unsorted));
2610398c7888SPierre Jolivet               unsorted = is[0];
2611398c7888SPierre Jolivet             } else {
2612811e8887SPierre Jolivet               const char *matpre;
2613811e8887SPierre Jolivet               PetscBool   cmp[4];
2614811e8887SPierre Jolivet 
261513044ca3SPierre Jolivet               if (!block && !ctx) PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, PetscBool3ToBool(data->Neumann) ? sub[0] : data->aux, &C, &perm));
261651ea4bc8SPierre Jolivet               if (perm) { /* unsorted input IS */
2617c8ea6600SPierre Jolivet                 if (!PetscBool3ToBool(data->Neumann) && !block) {
2618f1580f4eSBarry Smith                   PetscCall(MatPermute(sub[0], perm, perm, &D)); /* permute since PCASM will call ISSort() */
2619f1580f4eSBarry Smith                   PetscCall(MatHeaderReplace(sub[0], &D));
2620f1580f4eSBarry Smith                 }
2621f1580f4eSBarry Smith                 if (data->B) { /* see PCHPDDMSetRHSMat() */
2622f1580f4eSBarry Smith                   PetscCall(MatPermute(data->B, perm, perm, &D));
2623f1580f4eSBarry Smith                   PetscCall(MatHeaderReplace(data->B, &D));
2624f1580f4eSBarry Smith                 }
2625f1580f4eSBarry Smith                 PetscCall(ISDestroy(&perm));
262651ea4bc8SPierre Jolivet               }
2627f1580f4eSBarry Smith               PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
26280307214fSPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)subA[0]));
2629f1580f4eSBarry Smith               PetscCall(MatDuplicate(subA[1], MAT_SHARE_NONZERO_PATTERN, &D));
2630f1580f4eSBarry Smith               PetscCall(MatGetOptionsPrefix(subA[1], &matpre));
2631f1580f4eSBarry Smith               PetscCall(MatSetOptionsPrefix(D, matpre));
2632f1580f4eSBarry Smith               PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMAL, cmp));
2633f1580f4eSBarry Smith               PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMAL, cmp + 1));
2634f1580f4eSBarry Smith               if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMALHERMITIAN, cmp + 2));
2635f1580f4eSBarry Smith               else cmp[2] = PETSC_FALSE;
2636f1580f4eSBarry Smith               if (!cmp[1]) PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMALHERMITIAN, cmp + 3));
2637f1580f4eSBarry Smith               else cmp[3] = PETSC_FALSE;
2638f1580f4eSBarry 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);
2639f1580f4eSBarry Smith               if (!cmp[0] && !cmp[2]) {
26408a8e6071SPierre Jolivet                 if (!block) {
26418a8e6071SPierre Jolivet                   if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckMatStructure_Private(pc, D, C));
26428a8e6071SPierre Jolivet                   PetscCall(MatAXPY(D, 1.0, C, SUBSET_NONZERO_PATTERN));
26438a8e6071SPierre Jolivet                 } else {
2644421480d9SBarry Smith                   structure = DIFFERENT_NONZERO_PATTERN;
26455c7345deSPierre Jolivet                   PetscCall(MatAXPY(D, 1.0, data->aux, structure));
26465c7345deSPierre Jolivet                 }
2647f1580f4eSBarry Smith               } else {
2648f1580f4eSBarry Smith                 Mat mat[2];
2649811e8887SPierre Jolivet 
2650f1580f4eSBarry Smith                 if (cmp[0]) {
2651f1580f4eSBarry Smith                   PetscCall(MatNormalGetMat(D, mat));
2652f1580f4eSBarry Smith                   PetscCall(MatNormalGetMat(C, mat + 1));
2653f1580f4eSBarry Smith                 } else {
2654f1580f4eSBarry Smith                   PetscCall(MatNormalHermitianGetMat(D, mat));
2655f1580f4eSBarry Smith                   PetscCall(MatNormalHermitianGetMat(C, mat + 1));
2656f1580f4eSBarry Smith                 }
2657f1580f4eSBarry Smith                 PetscCall(MatAXPY(mat[0], 1.0, mat[1], SUBSET_NONZERO_PATTERN));
2658f1580f4eSBarry Smith               }
2659f1580f4eSBarry Smith               PetscCall(MatPropagateSymmetryOptions(C, D));
2660f1580f4eSBarry Smith               PetscCall(MatDestroy(&C));
2661f1580f4eSBarry Smith               C = D;
2662f1580f4eSBarry Smith               /* swap pointers so that variables stay consistent throughout PCSetUp() */
2663f1580f4eSBarry Smith               std::swap(C, data->aux);
2664f1580f4eSBarry Smith               std::swap(uis, data->is);
2665f1580f4eSBarry Smith               swap = PETSC_TRUE;
2666f1580f4eSBarry Smith             }
2667f1580f4eSBarry Smith           }
266813044ca3SPierre Jolivet         }
266951ea4bc8SPierre Jolivet       }
267013044ca3SPierre Jolivet       if (ctx) {
267113044ca3SPierre Jolivet         PC_HPDDM              *data_00 = (PC_HPDDM *)std::get<0>(*ctx)[0]->data;
267213044ca3SPierre Jolivet         PC                     s;
267300b491fbSPierre Jolivet         Mat                    A00, P00, A01 = nullptr, A10, A11, N, b[4];
267407d8d47fSPierre Jolivet         IS                     sorted, is[2], *is_00;
267513044ca3SPierre Jolivet         MatSolverType          type;
267613044ca3SPierre Jolivet         std::pair<PC, Vec[2]> *p;
267713044ca3SPierre Jolivet 
267807d8d47fSPierre Jolivet         n = -1;
267907d8d47fSPierre Jolivet         PetscTryMethod(data_00->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data_00->levels[0]->pc, &n, nullptr, &ksp));
268007d8d47fSPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
268107d8d47fSPierre Jolivet         PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
268207d8d47fSPierre Jolivet         PetscCall(ISGetLocalSize(data_00->is, &n));
268307d8d47fSPierre Jolivet         if (n != subA[0]->rmap->n || n != subA[0]->cmap->n) {
268407d8d47fSPierre Jolivet           PetscCall(PCASMGetLocalSubdomains(data_00->levels[0]->pc, &n, &is_00, nullptr));
268507d8d47fSPierre Jolivet           PetscCall(ISGetLocalSize(*is_00, &n));
268607d8d47fSPierre 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);
268707d8d47fSPierre Jolivet         } else is_00 = &data_00->is;
268813044ca3SPierre Jolivet         PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, data->aux, &C, nullptr)); /* permute since PCASM works with a sorted IS */
268913044ca3SPierre Jolivet         std::swap(C, data->aux);
269013044ca3SPierre Jolivet         std::swap(uis, data->is);
269113044ca3SPierre Jolivet         swap = PETSC_TRUE;
269213044ca3SPierre Jolivet         PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, std::get<1>(*ctx), &A10, &A11));
269313044ca3SPierre Jolivet         std::get<1>(*ctx)[1] = A10;
269413044ca3SPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
269513044ca3SPierre Jolivet         if (flg) PetscCall(MatTransposeGetMat(A10, &A01));
269613044ca3SPierre Jolivet         else {
269713044ca3SPierre Jolivet           PetscBool flg;
269813044ca3SPierre Jolivet 
269913044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
270013044ca3SPierre Jolivet           if (flg) PetscCall(MatHermitianTransposeGetMat(A10, &A01));
270113044ca3SPierre Jolivet         }
270207d8d47fSPierre 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 */
270313044ca3SPierre Jolivet         PetscCall(ISSort(sorted));               /* this is to avoid changing users inputs, but it requires a new call to ISSort() here                                                                                               */
270400b491fbSPierre Jolivet         if (!A01) {
270500b491fbSPierre Jolivet           PetscCall(MatSetOption(A10, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
270600b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A10, 1, &data->is, &sorted, MAT_INITIAL_MATRIX, &sub));
270700b491fbSPierre Jolivet           b[2] = sub[0];
270800b491fbSPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
270900b491fbSPierre Jolivet           PetscCall(MatDestroySubMatrices(1, &sub));
271000b491fbSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATTRANSPOSEVIRTUAL, &flg));
271100b491fbSPierre Jolivet           A10 = nullptr;
271200b491fbSPierre Jolivet           if (flg) PetscCall(MatTransposeGetMat(std::get<1>(*ctx)[0], &A10));
271313044ca3SPierre Jolivet           else {
271400b491fbSPierre Jolivet             PetscBool flg;
271500b491fbSPierre Jolivet 
2716c71f06a7SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATHERMITIANTRANSPOSEVIRTUAL, &flg));
271700b491fbSPierre Jolivet             if (flg) PetscCall(MatHermitianTransposeGetMat(std::get<1>(*ctx)[0], &A10));
271813044ca3SPierre Jolivet           }
2719811e8887SPierre Jolivet           if (!A10) PetscCall(MatCreateSubMatrices(std::get<1>(*ctx)[0], 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2720811e8887SPierre Jolivet           else {
2721811e8887SPierre Jolivet             if (flg) PetscCall(MatCreateTranspose(b[2], b + 1));
2722811e8887SPierre Jolivet             else PetscCall(MatCreateHermitianTranspose(b[2], b + 1));
272300b491fbSPierre Jolivet           }
272400b491fbSPierre Jolivet         } else {
272500b491fbSPierre Jolivet           PetscCall(MatSetOption(A01, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
272600b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A01, 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2727811e8887SPierre Jolivet           if (flg) PetscCall(MatCreateTranspose(*sub, b + 2));
2728811e8887SPierre Jolivet           else PetscCall(MatCreateHermitianTranspose(*sub, b + 2));
2729811e8887SPierre Jolivet         }
2730811e8887SPierre Jolivet         if (A01 || !A10) {
2731811e8887SPierre Jolivet           b[1] = sub[0];
2732811e8887SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
273300b491fbSPierre Jolivet         }
273400b491fbSPierre Jolivet         PetscCall(MatDestroySubMatrices(1, &sub));
273513044ca3SPierre Jolivet         PetscCall(ISDestroy(&sorted));
273651ea4bc8SPierre Jolivet         b[3] = data->aux;
273751ea4bc8SPierre Jolivet         PetscCall(MatCreateSchurComplement(subA[0], subA[1], b[1], b[2], b[3], &S));
273813044ca3SPierre Jolivet         PetscCall(MatSchurComplementSetKSP(S, ksp[0]));
273951ea4bc8SPierre Jolivet         if (data->N != 1) {
274051ea4bc8SPierre Jolivet           PetscCall(PCASMSetType(data->levels[0]->pc, PC_ASM_NONE)); /* "Neumann--Neumann" preconditioning with overlap and a Boolean partition of unity */
274151ea4bc8SPierre Jolivet           PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &data->is, &loc));
274251ea4bc8SPierre Jolivet           PetscCall(PCSetFromOptions(data->levels[0]->pc)); /* action of eq. (15) of https://hal.science/hal-02343808v6/document (with a sign flip) */
274351ea4bc8SPierre Jolivet           s = data->levels[0]->pc;
274451ea4bc8SPierre Jolivet         } else {
274551ea4bc8SPierre Jolivet           is[0] = data->is;
274651ea4bc8SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)is[0]));
274751ea4bc8SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)b[3]));
274851ea4bc8SPierre Jolivet           PetscCall(PCSetType(pc, PCASM));                          /* change the type of the current PC */
274951ea4bc8SPierre Jolivet           data = nullptr;                                           /* destroyed in the previous PCSetType(), so reset to NULL to avoid any faulty use */
275051ea4bc8SPierre Jolivet           PetscCall(PCAppendOptionsPrefix(pc, "pc_hpddm_coarse_")); /* same prefix as when using PCHPDDM with a single level */
275151ea4bc8SPierre Jolivet           PetscCall(PCASMSetLocalSubdomains(pc, 1, is, &loc));
275251ea4bc8SPierre Jolivet           PetscCall(ISDestroy(is));
275351ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&loc));
275451ea4bc8SPierre Jolivet           s = pc;
275551ea4bc8SPierre Jolivet         }
275651ea4bc8SPierre Jolivet         PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(s, S, PETSC_TRUE)); /* the subdomain Mat is already known and the input IS of PCASMSetLocalSubdomains() is already sorted */
275751ea4bc8SPierre Jolivet         PetscTryMethod(s, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (s, &n, nullptr, &ksp));
275813044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
275913044ca3SPierre Jolivet         PetscCall(KSPGetPC(ksp[0], &inner));
276013044ca3SPierre Jolivet         PetscCall(PCSetType(inner, PCSHELL)); /* compute the action of the inverse of the local Schur complement with a PCSHELL */
276113044ca3SPierre Jolivet         b[0] = subA[0];
276213044ca3SPierre 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 */
276351ea4bc8SPierre Jolivet         if (!data) PetscCall(PetscObjectDereference((PetscObject)b[3]));
276400b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[1]));
276500b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[2]));
276613044ca3SPierre Jolivet         PetscCall(PCCreate(PETSC_COMM_SELF, &s));
276713044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(s, ((PetscObject)inner)->prefix));
276813044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(inner, nullptr));
276913044ca3SPierre Jolivet         PetscCall(KSPSetSkipPCSetFromOptions(ksp[0], PETSC_TRUE));
277013044ca3SPierre Jolivet         PetscCall(PCSetType(s, PCLU));
277151ea4bc8SPierre 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 */
277213044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(s));
277313044ca3SPierre Jolivet         PetscCall(PCFactorGetMatSolverType(s, &type));
277413044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
277551ea4bc8SPierre Jolivet         PetscCall(MatGetLocalSize(A11, &n, nullptr));
277651ea4bc8SPierre Jolivet         if (flg || n == 0) {
277713044ca3SPierre Jolivet           PetscCall(PCSetOperators(s, N, N));
277851ea4bc8SPierre Jolivet           if (n) {
277900b491fbSPierre Jolivet             PetscCall(PCFactorGetMatrix(s, b));
278000b491fbSPierre Jolivet             PetscCall(MatSetOptionsPrefix(*b, ((PetscObject)s)->prefix));
278124ddd604SPierre Jolivet             n = -1;
27828dc3fbeeSPierre Jolivet             PetscCall(PetscOptionsGetInt(((PetscObject)pc)->options, ((PetscObject)s)->prefix, "-mat_mumps_icntl_26", &n, nullptr));
2783f45b553cSPierre Jolivet             if (n == 1) {                                /* allocates a square MatDense of size is[1]->map->n, so one */
2784f45b553cSPierre Jolivet               PetscCall(MatNestGetISs(N, is, nullptr));  /*  needs to be able to deactivate this path when dealing    */
2785f45b553cSPierre Jolivet               PetscCall(MatFactorSetSchurIS(*b, is[1])); /*  with a large constraint space in order to avoid OOM      */
2786f45b553cSPierre Jolivet             }
278751ea4bc8SPierre Jolivet           } else PetscCall(PCSetType(s, PCNONE)); /* empty local Schur complement (e.g., centralized on another process) */
278813044ca3SPierre Jolivet         } else {
278900b491fbSPierre Jolivet           PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, b));
279000b491fbSPierre Jolivet           PetscCall(PCSetOperators(s, N, *b));
279100b491fbSPierre Jolivet           PetscCall(PetscObjectDereference((PetscObject)*b));
279251ea4bc8SPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)s, &flg, PCLU, PCCHOLESKY, PCILU, PCICC, PCQR, ""));
279351ea4bc8SPierre 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 */
279413044ca3SPierre Jolivet         }
279513044ca3SPierre Jolivet         PetscCall(PetscNew(&p));
279613044ca3SPierre Jolivet         p->first = s;
279751ea4bc8SPierre Jolivet         if (n != 0) PetscCall(MatCreateVecs(*b, p->second, p->second + 1));
279851ea4bc8SPierre Jolivet         else p->second[0] = p->second[1] = nullptr;
279913044ca3SPierre Jolivet         PetscCall(PCShellSetContext(inner, p));
280013044ca3SPierre Jolivet         PetscCall(PCShellSetApply(inner, PCApply_Nest));
280113044ca3SPierre Jolivet         PetscCall(PCShellSetView(inner, PCView_Nest));
280213044ca3SPierre Jolivet         PetscCall(PCShellSetDestroy(inner, PCDestroy_Nest));
280313044ca3SPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)N));
280451ea4bc8SPierre Jolivet         if (!data) {
280551ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&S));
280651ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&unsorted));
280751ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&C));
280851ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&uis));
280951ea4bc8SPierre Jolivet           PetscCall(PetscFree(ctx));
281051ea4bc8SPierre Jolivet #if PetscDefined(USE_DEBUG)
281151ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&dis));
281251ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&daux));
281351ea4bc8SPierre Jolivet #endif
281451ea4bc8SPierre Jolivet           PetscFunctionReturn(PETSC_SUCCESS);
281551ea4bc8SPierre Jolivet         }
281613044ca3SPierre Jolivet       }
2817f1580f4eSBarry Smith       if (!data->levels[0]->scatter) {
2818db4a47b3SPierre Jolivet         PetscCall(MatCreateVecs(P, &xin, nullptr));
2819f1580f4eSBarry Smith         if (ismatis) PetscCall(MatDestroy(&P));
2820db4a47b3SPierre Jolivet         PetscCall(VecScatterCreate(xin, data->is, data->levels[0]->D, nullptr, &data->levels[0]->scatter));
2821f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
2822f1580f4eSBarry Smith       }
2823f1580f4eSBarry Smith       if (data->levels[0]->P) {
2824f1580f4eSBarry Smith         /* if the pattern is the same and PCSetUp() has previously succeeded, reuse HPDDM buffers and connectivity */
2825371d2eb7SMartin Diehl         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[0], !pc->setupcalled || pc->flag == DIFFERENT_NONZERO_PATTERN ? PETSC_TRUE : PETSC_FALSE));
2826f1580f4eSBarry Smith       }
2827f1580f4eSBarry Smith       if (!data->levels[0]->P) data->levels[0]->P = new HPDDM::Schwarz<PetscScalar>();
2828db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2829db4a47b3SPierre Jolivet       else PetscCall(PetscLogEventBegin(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2830f1580f4eSBarry Smith       /* HPDDM internal data structure */
283113044ca3SPierre Jolivet       PetscCall(data->levels[0]->P->structure(loc, data->is, !ctx ? sub[0] : nullptr, ismatis ? C : data->aux, data->levels));
2832db4a47b3SPierre Jolivet       if (!data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2833f1580f4eSBarry Smith       /* matrix pencil of the generalized eigenvalue problem on the overlap (GenEO) */
283413044ca3SPierre Jolivet       if (!ctx) {
28359bb5c669SPierre Jolivet         if (data->deflation || overlap != -1) weighted = data->aux;
2836f1580f4eSBarry Smith         else if (!data->B) {
2837e2b46ddfSPierre Jolivet           PetscBool cmp;
2838811e8887SPierre Jolivet 
2839f1580f4eSBarry Smith           PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &weighted));
2840e2b46ddfSPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)weighted, &cmp, MATNORMAL, MATNORMALHERMITIAN, ""));
2841e2b46ddfSPierre Jolivet           if (cmp) flg = PETSC_FALSE;
2842e2b46ddfSPierre Jolivet           PetscCall(MatDiagonalScale(weighted, data->levels[0]->D, data->levels[0]->D));
28435b0bb9f2SPierre Jolivet           /* neither MatDuplicate() nor MatDiagonalScale() handles the symmetry options, so propagate the options explicitly */
2844f1580f4eSBarry Smith           /* only useful for -mat_type baij -pc_hpddm_levels_1_st_pc_type cholesky (no problem with MATAIJ or MATSBAIJ)      */
2845f1580f4eSBarry Smith           PetscCall(MatPropagateSymmetryOptions(sub[0], weighted));
28466d61d5b2SPierre Jolivet           if (PetscDefined(USE_DEBUG) && PetscBool3ToBool(data->Neumann)) {
28476d61d5b2SPierre Jolivet             Mat      *sub, A[3];
28486d61d5b2SPierre Jolivet             PetscReal norm[2];
28496d61d5b2SPierre Jolivet             PetscBool flg;
28506d61d5b2SPierre Jolivet 
28516d61d5b2SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg)); /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIAIJ */
28526d61d5b2SPierre Jolivet             if (flg) PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, A));
28536d61d5b2SPierre Jolivet             else {
28546d61d5b2SPierre Jolivet               A[0] = P;
28556d61d5b2SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)P));
28566d61d5b2SPierre Jolivet             }
28576d61d5b2SPierre Jolivet             PetscCall(MatCreateSubMatrices(A[0], 1, &data->is, &data->is, MAT_INITIAL_MATRIX, &sub));
28586d61d5b2SPierre Jolivet             PetscCall(MatDiagonalScale(sub[0], data->levels[0]->D, data->levels[0]->D));
28596d61d5b2SPierre 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 */
28606d61d5b2SPierre Jolivet             PetscCall(MatConvert(weighted, MATSEQAIJ, MAT_INITIAL_MATRIX, A + 2));
28616d61d5b2SPierre Jolivet             PetscCall(MatAXPY(A[1], -1.0, A[2], UNKNOWN_NONZERO_PATTERN));
28626d61d5b2SPierre Jolivet             PetscCall(MatNorm(A[1], NORM_FROBENIUS, norm));
28636d61d5b2SPierre Jolivet             if (norm[0]) {
28646d61d5b2SPierre Jolivet               PetscCall(MatNorm(A[2], NORM_FROBENIUS, norm + 1));
28656d61d5b2SPierre 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 : "");
28666d61d5b2SPierre Jolivet             }
28676d61d5b2SPierre Jolivet             PetscCall(MatDestroySubMatrices(1, &sub));
28686d61d5b2SPierre Jolivet             for (PetscInt i = 0; i < 3; ++i) PetscCall(MatDestroy(A + i));
28696d61d5b2SPierre Jolivet           }
2870f1580f4eSBarry Smith         } else weighted = data->B;
287113044ca3SPierre Jolivet       } else weighted = nullptr;
2872f1580f4eSBarry Smith       /* SLEPc is used inside the loaded symbol */
28739bb5c669SPierre 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));
28749bb5c669SPierre Jolivet       if (!ctx && data->share && overlap == -1) {
2875f1580f4eSBarry Smith         Mat st[2];
28766d61d5b2SPierre Jolivet 
2877f1580f4eSBarry Smith         PetscCall(KSPGetOperators(ksp[0], st, st + 1));
28785c7345deSPierre Jolivet         PetscCall(MatCopy(subA[0], st[0], structure));
2879f1580f4eSBarry Smith         if (subA[1] != subA[0] || st[1] != st[0]) PetscCall(MatCopy(subA[1], st[1], SAME_NONZERO_PATTERN));
28800307214fSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)subA[0]));
2881f1580f4eSBarry Smith       }
2882db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2883f1580f4eSBarry Smith       if (ismatis) PetscCall(MatISGetLocalMat(C, &N));
2884f1580f4eSBarry Smith       else N = data->aux;
288513044ca3SPierre Jolivet       if (!ctx) P = sub[0];
288613044ca3SPierre Jolivet       else P = S;
2887f1580f4eSBarry Smith       /* going through the grid hierarchy */
2888f1580f4eSBarry Smith       for (n = 1; n < data->N; ++n) {
2889db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2890f1580f4eSBarry Smith         /* method composed in the loaded symbol since there, SLEPc is used as well */
2891f1580f4eSBarry 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));
2892db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2893f1580f4eSBarry Smith       }
2894f1580f4eSBarry Smith       /* reset to NULL to avoid any faulty use */
2895db4a47b3SPierre Jolivet       PetscCall(PetscObjectComposeFunction((PetscObject)data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", nullptr));
2896db4a47b3SPierre Jolivet       if (!ismatis) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_C", nullptr));
2897f1580f4eSBarry Smith       else PetscCall(PetscObjectDereference((PetscObject)C)); /* matching PetscObjectReference() above */
2898f1580f4eSBarry Smith       for (n = 0; n < data->N - 1; ++n)
2899f1580f4eSBarry Smith         if (data->levels[n]->P) {
2900f1580f4eSBarry Smith           /* HPDDM internal work buffers */
2901f1580f4eSBarry Smith           data->levels[n]->P->setBuffer();
2902f1580f4eSBarry Smith           data->levels[n]->P->super::start();
2903f1580f4eSBarry Smith         }
29049bb5c669SPierre Jolivet       if (ismatis || !subdomains) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
2905db4a47b3SPierre Jolivet       if (ismatis) data->is = nullptr;
2906f1580f4eSBarry Smith       for (n = 0; n < data->N - 1 + (reused > 0); ++n) {
2907f1580f4eSBarry Smith         if (data->levels[n]->P) {
2908f1580f4eSBarry Smith           PC spc;
2909f1580f4eSBarry Smith 
2910f1580f4eSBarry Smith           /* force the PC to be PCSHELL to do the coarse grid corrections */
2911f1580f4eSBarry Smith           PetscCall(KSPSetSkipPCSetFromOptions(data->levels[n]->ksp, PETSC_TRUE));
2912f1580f4eSBarry Smith           PetscCall(KSPGetPC(data->levels[n]->ksp, &spc));
2913f1580f4eSBarry Smith           PetscCall(PCSetType(spc, PCSHELL));
2914f1580f4eSBarry Smith           PetscCall(PCShellSetContext(spc, data->levels[n]));
2915f1580f4eSBarry Smith           PetscCall(PCShellSetSetUp(spc, PCSetUp_HPDDMShell));
2916f1580f4eSBarry Smith           PetscCall(PCShellSetApply(spc, PCApply_HPDDMShell));
2917f1580f4eSBarry Smith           PetscCall(PCShellSetMatApply(spc, PCMatApply_HPDDMShell));
2918d4f06b61SRaphael Zanella           PetscCall(PCShellSetApplyTranspose(spc, PCApplyTranspose_HPDDMShell));
29198cb7430dSRaphael Zanella           PetscCall(PCShellSetMatApplyTranspose(spc, PCMatApplyTranspose_HPDDMShell));
292013044ca3SPierre Jolivet           if (ctx && n == 0) {
292113044ca3SPierre Jolivet             Mat                               Amat, Pmat;
292213044ca3SPierre Jolivet             PetscInt                          m, M;
292301e3c840SPierre Jolivet             std::tuple<Mat, PetscSF, Vec[2]> *ctx;
292413044ca3SPierre Jolivet 
292513044ca3SPierre Jolivet             PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &Pmat));
292613044ca3SPierre Jolivet             PetscCall(MatGetLocalSize(Pmat, &m, nullptr));
292713044ca3SPierre Jolivet             PetscCall(MatGetSize(Pmat, &M, nullptr));
292813044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));
292913044ca3SPierre Jolivet             std::get<0>(*ctx) = S;
293013044ca3SPierre Jolivet             std::get<1>(*ctx) = data->levels[n]->scatter;
293113044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)data->levels[n]->ksp), m, m, M, M, ctx, &Amat));
293257d50842SBarry Smith             PetscCall(MatShellSetOperation(Amat, MATOP_MULT, (PetscErrorCodeFn *)MatMult_Schur<false>));
293357d50842SBarry Smith             PetscCall(MatShellSetOperation(Amat, MATOP_MULT_TRANSPOSE, (PetscErrorCodeFn *)MatMult_Schur<true>));
293457d50842SBarry Smith             PetscCall(MatShellSetOperation(Amat, MATOP_DESTROY, (PetscErrorCodeFn *)MatDestroy_Schur));
293513044ca3SPierre Jolivet             PetscCall(MatCreateVecs(S, std::get<2>(*ctx), std::get<2>(*ctx) + 1));
293613044ca3SPierre Jolivet             PetscCall(KSPSetOperators(data->levels[n]->ksp, Amat, Pmat));
293713044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)Amat));
293813044ca3SPierre Jolivet           }
2939f1580f4eSBarry Smith           PetscCall(PCShellSetDestroy(spc, PCDestroy_HPDDMShell));
2940f1580f4eSBarry Smith           if (!data->levels[n]->pc) PetscCall(PCCreate(PetscObjectComm((PetscObject)data->levels[n]->ksp), &data->levels[n]->pc));
2941f1580f4eSBarry Smith           if (n < reused) {
2942f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(spc, PETSC_TRUE));
2943f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
2944f1580f4eSBarry Smith           }
2945f1580f4eSBarry Smith           PetscCall(PCSetUp(spc));
2946f1580f4eSBarry Smith         }
2947f1580f4eSBarry Smith       }
294813044ca3SPierre Jolivet       if (ctx) PetscCall(MatDestroy(&S));
29499bb5c669SPierre Jolivet       if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", nullptr));
2950f1580f4eSBarry Smith     } else flg = reused ? PETSC_FALSE : PETSC_TRUE;
2951f1580f4eSBarry Smith     if (!ismatis && subdomains) {
2952f1580f4eSBarry Smith       if (flg) PetscCall(KSPGetPC(data->levels[0]->ksp, &inner));
2953f1580f4eSBarry Smith       else inner = data->levels[0]->pc;
2954f1580f4eSBarry Smith       if (inner) {
2955398c7888SPierre Jolivet         if (!inner->setupcalled) PetscCall(PCSetType(inner, PCASM));
2956398c7888SPierre Jolivet         PetscCall(PCSetFromOptions(inner));
2957398c7888SPierre Jolivet         PetscCall(PetscStrcmp(((PetscObject)inner)->type_name, PCASM, &flg));
2958398c7888SPierre Jolivet         if (flg) {
2959f1580f4eSBarry Smith           if (!inner->setupcalled) { /* evaluates to PETSC_FALSE when -pc_hpddm_block_splitting */
2960398c7888SPierre Jolivet             IS sorted;               /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2961811e8887SPierre Jolivet 
2962398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2963398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(inner, 1, &sorted, &loc));
2964398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2965398c7888SPierre Jolivet           }
2966c8ea6600SPierre Jolivet           if (!PetscBool3ToBool(data->Neumann) && data->N > 1) { /* subdomain matrices are already created for the eigenproblem, reuse them for the fine-level PC */
2967db4a47b3SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(*is, nullptr, nullptr, sub[0], &P, nullptr));
2968398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(inner, P, algebraic));
2969398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)P));
2970f1580f4eSBarry Smith           }
2971f1580f4eSBarry Smith         }
2972f1580f4eSBarry Smith       }
29739bb5c669SPierre Jolivet       if (data->N > 1) {
29749bb5c669SPierre Jolivet         if (overlap != 1) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
29759bb5c669SPierre Jolivet         if (overlap == 1) PetscCall(MatDestroy(subA));
29769bb5c669SPierre Jolivet       }
2977f1580f4eSBarry Smith     }
2978f1580f4eSBarry Smith     PetscCall(ISDestroy(&loc));
2979f1580f4eSBarry Smith   } else data->N = 1 + reused; /* enforce this value to 1 + reused if there is no way to build another level */
2980f1580f4eSBarry Smith   if (requested != data->N + reused) {
2981f1580f4eSBarry 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,
2982f1580f4eSBarry Smith                         data->N, pcpre ? pcpre : ""));
2983b5a302b3SPierre 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 : "",
2984b5a302b3SPierre Jolivet                         data->N, pcpre ? pcpre : "", data->N));
2985f1580f4eSBarry Smith     /* cannot use PCDestroy_HPDDMShell() because PCSHELL not set for unassembled levels */
2986f1580f4eSBarry Smith     for (n = data->N - 1; n < requested - 1; ++n) {
2987f1580f4eSBarry Smith       if (data->levels[n]->P) {
2988f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[n], PETSC_TRUE));
2989f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(1, &data->levels[n]->v[0]));
2990f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(2, &data->levels[n]->v[1]));
2991f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V));
2992f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 1));
2993f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 2));
2994f1580f4eSBarry Smith         PetscCall(VecDestroy(&data->levels[n]->D));
299501e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&data->levels[n]->scatter));
2996f1580f4eSBarry Smith       }
2997f1580f4eSBarry Smith     }
2998f1580f4eSBarry Smith     if (reused) {
2999f1580f4eSBarry Smith       for (n = reused; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
3000f1580f4eSBarry Smith         PetscCall(KSPDestroy(&data->levels[n]->ksp));
3001f1580f4eSBarry Smith         PetscCall(PCDestroy(&data->levels[n]->pc));
3002f1580f4eSBarry Smith       }
3003f1580f4eSBarry Smith     }
3004b5a302b3SPierre 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,
3005b5a302b3SPierre Jolivet                data->N, reused, data->N, pcpre ? pcpre : "", pcpre ? pcpre : "", data->N, pcpre ? pcpre : "", data->N);
3006f1580f4eSBarry Smith   }
3007f1580f4eSBarry Smith   /* these solvers are created after PCSetFromOptions() is called */
3008f1580f4eSBarry Smith   if (pc->setfromoptionscalled) {
3009f1580f4eSBarry Smith     for (n = 0; n < data->N; ++n) {
3010f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetFromOptions(data->levels[n]->ksp));
3011f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetFromOptions(data->levels[n]->pc));
3012f1580f4eSBarry Smith     }
3013f1580f4eSBarry Smith     pc->setfromoptionscalled = 0;
3014f1580f4eSBarry Smith   }
3015f1580f4eSBarry Smith   data->N += reused;
3016f1580f4eSBarry Smith   if (data->share && swap) {
3017f1580f4eSBarry Smith     /* swap back pointers so that variables follow the user-provided numbering */
3018f1580f4eSBarry Smith     std::swap(C, data->aux);
3019f1580f4eSBarry Smith     std::swap(uis, data->is);
3020f1580f4eSBarry Smith     PetscCall(MatDestroy(&C));
3021f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
3022f1580f4eSBarry Smith   }
3023398c7888SPierre Jolivet   if (algebraic) PetscCall(MatDestroy(&data->aux));
302438fb34a1SPierre Jolivet   if (unsorted && unsorted != is[0]) {
3025398c7888SPierre Jolivet     PetscCall(ISCopy(unsorted, data->is));
3026398c7888SPierre Jolivet     PetscCall(ISDestroy(&unsorted));
3027398c7888SPierre Jolivet   }
3028398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
3029398c7888SPierre 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);
3030398c7888SPierre Jolivet   if (data->is) {
3031398c7888SPierre Jolivet     PetscCall(ISEqualUnsorted(data->is, dis, &flg));
3032398c7888SPierre Jolivet     PetscCall(ISDestroy(&dis));
3033398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input IS and output IS are not equal");
3034398c7888SPierre Jolivet   }
3035398c7888SPierre 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);
3036398c7888SPierre Jolivet   if (data->aux) {
3037398c7888SPierre Jolivet     PetscCall(MatMultEqual(data->aux, daux, 20, &flg));
3038398c7888SPierre Jolivet     PetscCall(MatDestroy(&daux));
3039398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input Mat and output Mat are not equal");
3040398c7888SPierre Jolivet   }
3041398c7888SPierre Jolivet #endif
30423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3043f1580f4eSBarry Smith }
3044f1580f4eSBarry Smith 
3045f1580f4eSBarry Smith /*@
3046f1580f4eSBarry Smith   PCHPDDMSetCoarseCorrectionType - Sets the coarse correction type.
3047f1580f4eSBarry Smith 
3048c3339decSBarry Smith   Collective
3049f1580f4eSBarry Smith 
3050f1580f4eSBarry Smith   Input Parameters:
3051f1580f4eSBarry Smith + pc   - preconditioner context
3052aa1539e9SPierre Jolivet - type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
3053f1580f4eSBarry Smith 
3054f1580f4eSBarry Smith   Options Database Key:
3055aa1539e9SPierre Jolivet . -pc_hpddm_coarse_correction <deflated, additive, balanced, none> - type of coarse correction to apply
3056f1580f4eSBarry Smith 
3057f1580f4eSBarry Smith   Level: intermediate
3058f1580f4eSBarry Smith 
3059562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
3060f1580f4eSBarry Smith @*/
3061d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType type)
3062d71ae5a4SJacob Faibussowitsch {
3063f1580f4eSBarry Smith   PetscFunctionBegin;
3064f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3065f1580f4eSBarry Smith   PetscValidLogicalCollectiveEnum(pc, type, 2);
3066f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMSetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType), (pc, type));
30673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3068f1580f4eSBarry Smith }
3069f1580f4eSBarry Smith 
3070f1580f4eSBarry Smith /*@
3071f1580f4eSBarry Smith   PCHPDDMGetCoarseCorrectionType - Gets the coarse correction type.
3072f1580f4eSBarry Smith 
3073f1580f4eSBarry Smith   Input Parameter:
3074f1580f4eSBarry Smith . pc - preconditioner context
3075f1580f4eSBarry Smith 
3076f1580f4eSBarry Smith   Output Parameter:
3077aa1539e9SPierre Jolivet . type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
3078f1580f4eSBarry Smith 
3079f1580f4eSBarry Smith   Level: intermediate
3080f1580f4eSBarry Smith 
3081562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
3082f1580f4eSBarry Smith @*/
3083d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType *type)
3084d71ae5a4SJacob Faibussowitsch {
3085f1580f4eSBarry Smith   PetscFunctionBegin;
3086f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3087f1580f4eSBarry Smith   if (type) {
30884f572ea9SToby Isaac     PetscAssertPointer(type, 2);
3089f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType *), (pc, type));
3090f1580f4eSBarry Smith   }
30913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3092f1580f4eSBarry Smith }
3093f1580f4eSBarry Smith 
3094d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType type)
3095d71ae5a4SJacob Faibussowitsch {
3096f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
3097f1580f4eSBarry Smith 
3098f1580f4eSBarry Smith   PetscFunctionBegin;
3099f1580f4eSBarry Smith   data->correction = type;
31003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3101f1580f4eSBarry Smith }
3102f1580f4eSBarry Smith 
3103d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType *type)
3104d71ae5a4SJacob Faibussowitsch {
3105f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
3106f1580f4eSBarry Smith 
3107f1580f4eSBarry Smith   PetscFunctionBegin;
3108f1580f4eSBarry Smith   *type = data->correction;
31093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3110f1580f4eSBarry Smith }
3111f1580f4eSBarry Smith 
3112f1580f4eSBarry Smith /*@
3113e31fc274SPierre Jolivet   PCHPDDMSetSTShareSubKSP - Sets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver should be shared.
3114e31fc274SPierre Jolivet 
3115e31fc274SPierre Jolivet   Input Parameters:
3116e31fc274SPierre Jolivet + pc    - preconditioner context
3117e31fc274SPierre Jolivet - share - whether the `KSP` should be shared or not
3118e31fc274SPierre Jolivet 
3119e31fc274SPierre Jolivet   Note:
3120e31fc274SPierre Jolivet   This is not the same as `PCSetReusePreconditioner()`. Given certain conditions (visible using -info), a symbolic factorization can be skipped
3121e31fc274SPierre Jolivet   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
3122e31fc274SPierre Jolivet 
3123e31fc274SPierre Jolivet   Level: advanced
3124e31fc274SPierre Jolivet 
3125562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMGetSTShareSubKSP()`
3126e31fc274SPierre Jolivet @*/
3127e31fc274SPierre Jolivet PetscErrorCode PCHPDDMSetSTShareSubKSP(PC pc, PetscBool share)
3128e31fc274SPierre Jolivet {
3129e31fc274SPierre Jolivet   PetscFunctionBegin;
3130e31fc274SPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3131e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetSTShareSubKSP_C", (PC, PetscBool), (pc, share));
31323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3133e31fc274SPierre Jolivet }
3134e31fc274SPierre Jolivet 
3135e31fc274SPierre Jolivet /*@
3136f1580f4eSBarry Smith   PCHPDDMGetSTShareSubKSP - Gets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver is shared.
3137f1580f4eSBarry Smith 
3138f1580f4eSBarry Smith   Input Parameter:
3139f1580f4eSBarry Smith . pc - preconditioner context
3140f1580f4eSBarry Smith 
3141f1580f4eSBarry Smith   Output Parameter:
3142f1580f4eSBarry Smith . share - whether the `KSP` is shared or not
3143f1580f4eSBarry Smith 
3144f1580f4eSBarry Smith   Note:
3145f1580f4eSBarry 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
3146f1580f4eSBarry Smith   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
3147f1580f4eSBarry Smith 
3148f1580f4eSBarry Smith   Level: advanced
3149f1580f4eSBarry Smith 
3150562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetSTShareSubKSP()`
3151f1580f4eSBarry Smith @*/
3152d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetSTShareSubKSP(PC pc, PetscBool *share)
3153d71ae5a4SJacob Faibussowitsch {
3154f1580f4eSBarry Smith   PetscFunctionBegin;
3155f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3156f1580f4eSBarry Smith   if (share) {
31574f572ea9SToby Isaac     PetscAssertPointer(share, 2);
3158f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetSTShareSubKSP_C", (PC, PetscBool *), (pc, share));
3159f1580f4eSBarry Smith   }
31603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3161f1580f4eSBarry Smith }
3162f1580f4eSBarry Smith 
3163e31fc274SPierre Jolivet static PetscErrorCode PCHPDDMSetSTShareSubKSP_HPDDM(PC pc, PetscBool share)
3164e31fc274SPierre Jolivet {
3165e31fc274SPierre Jolivet   PC_HPDDM *data = (PC_HPDDM *)pc->data;
3166e31fc274SPierre Jolivet 
3167e31fc274SPierre Jolivet   PetscFunctionBegin;
3168e31fc274SPierre Jolivet   data->share = share;
31693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3170e31fc274SPierre Jolivet }
3171e31fc274SPierre Jolivet 
3172d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetSTShareSubKSP_HPDDM(PC pc, PetscBool *share)
3173d71ae5a4SJacob Faibussowitsch {
3174f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
3175f1580f4eSBarry Smith 
3176f1580f4eSBarry Smith   PetscFunctionBegin;
3177f1580f4eSBarry Smith   *share = data->share;
31783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3179f1580f4eSBarry Smith }
3180f1580f4eSBarry Smith 
3181f1580f4eSBarry Smith /*@
3182f1580f4eSBarry Smith   PCHPDDMSetDeflationMat - Sets the deflation space used to assemble a coarser operator.
3183f1580f4eSBarry Smith 
3184f1580f4eSBarry Smith   Input Parameters:
3185f1580f4eSBarry Smith + pc - preconditioner context
3186f1580f4eSBarry Smith . is - index set of the local deflation matrix
3187f1580f4eSBarry Smith - U  - deflation sequential matrix stored as a `MATSEQDENSE`
3188f1580f4eSBarry Smith 
3189f1580f4eSBarry Smith   Level: advanced
3190f1580f4eSBarry Smith 
3191562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCDeflationSetSpace()`, `PCMGSetRestriction()`
3192f1580f4eSBarry Smith @*/
3193d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetDeflationMat(PC pc, IS is, Mat U)
3194d71ae5a4SJacob Faibussowitsch {
3195f1580f4eSBarry Smith   PetscFunctionBegin;
3196f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3197f1580f4eSBarry Smith   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
3198f1580f4eSBarry Smith   PetscValidHeaderSpecific(U, MAT_CLASSID, 3);
3199e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetDeflationMat_C", (PC, IS, Mat), (pc, is, U));
32003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3201f1580f4eSBarry Smith }
3202f1580f4eSBarry Smith 
3203d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetDeflationMat_HPDDM(PC pc, IS is, Mat U)
3204d71ae5a4SJacob Faibussowitsch {
3205f1580f4eSBarry Smith   PetscFunctionBegin;
3206f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, U, PETSC_TRUE));
32073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3208f1580f4eSBarry Smith }
3209f1580f4eSBarry Smith 
3210d71ae5a4SJacob Faibussowitsch PetscErrorCode HPDDMLoadDL_Private(PetscBool *found)
3211d71ae5a4SJacob Faibussowitsch {
3212605ad303SPierre Jolivet   PetscBool flg;
3213f1580f4eSBarry Smith   char      lib[PETSC_MAX_PATH_LEN], dlib[PETSC_MAX_PATH_LEN], dir[PETSC_MAX_PATH_LEN];
3214f1580f4eSBarry Smith 
3215f1580f4eSBarry Smith   PetscFunctionBegin;
32164f572ea9SToby Isaac   PetscAssertPointer(found, 1);
3217c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(dir, "${PETSC_LIB_DIR}", sizeof(dir)));
3218db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, nullptr, "-hpddm_dir", dir, sizeof(dir), nullptr));
3219f1580f4eSBarry Smith   PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
3220f1580f4eSBarry Smith   PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3221605ad303SPierre Jolivet #if defined(SLEPC_LIB_DIR) /* this variable is passed during SLEPc ./configure when PETSc has not been configured   */
3222605ad303SPierre Jolivet   if (!*found) {           /* with --download-hpddm since slepcconf.h is not yet built (and thus can't be included) */
3223c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(dir, HPDDM_STR(SLEPC_LIB_DIR), sizeof(dir)));
3224f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
3225f1580f4eSBarry Smith     PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3226f1580f4eSBarry Smith   }
3227f1580f4eSBarry Smith #endif
3228605ad303SPierre 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 */
3229605ad303SPierre Jolivet     PetscCall(PetscOptionsGetenv(PETSC_COMM_SELF, "SLEPC_DIR", dir, sizeof(dir), &flg));
3230605ad303SPierre 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 */
3231605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libslepc", dir));
3232605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3233605ad303SPierre Jolivet       PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found but SLEPC_DIR=%s", lib, dir);
3234605ad303SPierre Jolivet       PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
3235605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libhpddm_petsc", dir)); /* libhpddm_petsc is always in the same directory as libslepc */
3236605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3237605ad303SPierre Jolivet     }
3238605ad303SPierre Jolivet   }
3239f1580f4eSBarry Smith   PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found", lib);
3240f1580f4eSBarry Smith   PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
32413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3242f1580f4eSBarry Smith }
3243f1580f4eSBarry Smith 
3244f1580f4eSBarry Smith /*MC
3245f1580f4eSBarry Smith    PCHPDDM - Interface with the HPDDM library.
3246f1580f4eSBarry Smith 
32471d27aa22SBarry Smith    This `PC` may be used to build multilevel spectral domain decomposition methods based on the GenEO framework {cite}`spillane2011robust` {cite}`al2021multilevel`.
32481d27aa22SBarry Smith    It may be viewed as an alternative to spectral
32491d27aa22SBarry Smith    AMGe or `PCBDDC` with adaptive selection of constraints. The interface is explained in details in {cite}`jolivetromanzampini2020`
3250f1580f4eSBarry Smith 
3251e7593814SPierre 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`).
3252f1580f4eSBarry Smith 
3253f1580f4eSBarry Smith    For multilevel preconditioning, when using an assembled or hierarchical Pmat, one must provide an auxiliary local `Mat` (unassembled local operator for GenEO) using
3254f1580f4eSBarry Smith    `PCHPDDMSetAuxiliaryMat()`. Calling this routine is not needed when using a `MATIS` Pmat, assembly is done internally using `MatConvert()`.
3255f1580f4eSBarry Smith 
3256f1580f4eSBarry Smith    Options Database Keys:
3257f1580f4eSBarry Smith +   -pc_hpddm_define_subdomains <true, default=false>    - on the finest level, calls `PCASMSetLocalSubdomains()` with the `IS` supplied in `PCHPDDMSetAuxiliaryMat()`
3258f1580f4eSBarry Smith                                                          (not relevant with an unassembled Pmat)
3259f1580f4eSBarry Smith .   -pc_hpddm_has_neumann <true, default=false>          - on the finest level, informs the `PC` that the local Neumann matrix is supplied in `PCHPDDMSetAuxiliaryMat()`
3260f1580f4eSBarry Smith -   -pc_hpddm_coarse_correction <type, default=deflated> - determines the `PCHPDDMCoarseCorrectionType` when calling `PCApply()`
3261f1580f4eSBarry Smith 
326238bf2a8cSPierre Jolivet    Options for subdomain solvers, subdomain eigensolvers (for computing deflation vectors), and the coarse solver can be set using the following options database prefixes.
3263f1580f4eSBarry Smith .vb
3264f1580f4eSBarry Smith       -pc_hpddm_levels_%d_pc_
3265f1580f4eSBarry Smith       -pc_hpddm_levels_%d_ksp_
3266f1580f4eSBarry Smith       -pc_hpddm_levels_%d_eps_
3267f1580f4eSBarry Smith       -pc_hpddm_levels_%d_p
32684ec2a359SPierre Jolivet       -pc_hpddm_levels_%d_mat_type
3269f1580f4eSBarry Smith       -pc_hpddm_coarse_
3270f1580f4eSBarry Smith       -pc_hpddm_coarse_p
32714ec2a359SPierre Jolivet       -pc_hpddm_coarse_mat_type
32722ce66baaSPierre Jolivet       -pc_hpddm_coarse_mat_filter
3273f1580f4eSBarry Smith .ve
3274f1580f4eSBarry Smith 
327538bf2a8cSPierre 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
3276f1580f4eSBarry Smith     -pc_hpddm_coarse_p 2 -pc_hpddm_coarse_mat_type baij will use 10 deflation vectors per subdomain on the fine "level 1",
3277f1580f4eSBarry Smith     aggregate the fine subdomains into 4 "level 2" subdomains, then use 10 deflation vectors per subdomain on "level 2",
32787eb095acSPierre Jolivet     and assemble the coarse matrix (of dimension 4 x 10 = 40) on two processes as a `MATBAIJ` (default is `MATSBAIJ`).
3279f1580f4eSBarry Smith 
3280b5a302b3SPierre 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.
3281f1580f4eSBarry Smith 
32821d27aa22SBarry Smith    Level: intermediate
32831d27aa22SBarry Smith 
32841d27aa22SBarry Smith    Notes:
32851d27aa22SBarry Smith    This preconditioner requires that PETSc is built with SLEPc (``--download-slepc``).
32861d27aa22SBarry Smith 
32871d27aa22SBarry Smith    By default, the underlying concurrent eigenproblems
32881d27aa22SBarry Smith    are solved using SLEPc shift-and-invert spectral transformation. This is usually what gives the best performance for GenEO, cf.
32891d27aa22SBarry Smith    {cite}`spillane2011robust` {cite}`jolivet2013scalabledd`. As
329038bf2a8cSPierre 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
329138bf2a8cSPierre 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
329238bf2a8cSPierre Jolivet    SLEPc documentation since they are specific to `PCHPDDM`.
329338bf2a8cSPierre Jolivet .vb
329438bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_st_share_sub_ksp
3295b5a302b3SPierre Jolivet       -pc_hpddm_levels_%d_eps_threshold_absolute
329638bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_eps_use_inertia
329738bf2a8cSPierre Jolivet .ve
329838bf2a8cSPierre Jolivet 
329938bf2a8cSPierre Jolivet    The first option from the list only applies to the fine-level eigensolver, see `PCHPDDMSetSTShareSubKSP()`. The second option from the list is
330038bf2a8cSPierre Jolivet    used to filter eigenmodes retrieved after convergence of `EPSSolve()` at "level N" such that eigenvectors used to define a "level N+1" coarse
3301b5a302b3SPierre 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
330238bf2a8cSPierre 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
330338bf2a8cSPierre 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
330438bf2a8cSPierre Jolivet    to supply -pc_hpddm_levels_1_eps_nev. This last option also only applies to the fine-level (N = 1) eigensolver.
3305f1580f4eSBarry Smith 
33061d27aa22SBarry Smith    See also {cite}`dolean2015introduction`, {cite}`al2022robust`, {cite}`al2022robustpd`, and {cite}`nataf2022recent`
3307f1580f4eSBarry Smith 
3308562efe2eSBarry Smith .seealso: [](ch_ksp), `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetAuxiliaryMat()`, `MATIS`, `PCBDDC`, `PCDEFLATION`, `PCTELESCOPE`, `PCASM`,
3309e31fc274SPierre Jolivet           `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDMHasNeumannMat()`, `PCHPDDMSetRHSMat()`, `PCHPDDMSetDeflationMat()`, `PCHPDDMSetSTShareSubKSP()`,
3310e31fc274SPierre Jolivet           `PCHPDDMGetSTShareSubKSP()`, `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDMGetComplexities()`
3311f1580f4eSBarry Smith M*/
3312d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_HPDDM(PC pc)
3313d71ae5a4SJacob Faibussowitsch {
3314f1580f4eSBarry Smith   PC_HPDDM *data;
3315f1580f4eSBarry Smith   PetscBool found;
3316f1580f4eSBarry Smith 
3317f1580f4eSBarry Smith   PetscFunctionBegin;
3318f1580f4eSBarry Smith   if (!loadedSym) {
3319f1580f4eSBarry Smith     PetscCall(HPDDMLoadDL_Private(&found));
3320db4a47b3SPierre Jolivet     if (found) PetscCall(PetscDLLibrarySym(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, nullptr, "PCHPDDM_Internal", (void **)&loadedSym));
3321f1580f4eSBarry Smith   }
3322f1580f4eSBarry Smith   PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCHPDDM_Internal symbol not found in loaded libhpddm_petsc");
33234dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&data));
3324f1580f4eSBarry Smith   pc->data                   = data;
3325c8ea6600SPierre Jolivet   data->Neumann              = PETSC_BOOL3_UNKNOWN;
3326f1580f4eSBarry Smith   pc->ops->reset             = PCReset_HPDDM;
3327f1580f4eSBarry Smith   pc->ops->destroy           = PCDestroy_HPDDM;
3328f1580f4eSBarry Smith   pc->ops->setfromoptions    = PCSetFromOptions_HPDDM;
3329f1580f4eSBarry Smith   pc->ops->setup             = PCSetUp_HPDDM;
3330d4f06b61SRaphael Zanella   pc->ops->apply             = PCApply_HPDDM<false>;
33318cb7430dSRaphael Zanella   pc->ops->matapply          = PCMatApply_HPDDM<false>;
3332d4f06b61SRaphael Zanella   pc->ops->applytranspose    = PCApply_HPDDM<true>;
33338cb7430dSRaphael Zanella   pc->ops->matapplytranspose = PCMatApply_HPDDM<true>;
3334f1580f4eSBarry Smith   pc->ops->view              = PCView_HPDDM;
3335f1580f4eSBarry Smith   pc->ops->presolve          = PCPreSolve_HPDDM;
3336f1580f4eSBarry Smith 
3337f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", PCHPDDMSetAuxiliaryMat_HPDDM));
3338f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", PCHPDDMHasNeumannMat_HPDDM));
3339f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", PCHPDDMSetRHSMat_HPDDM));
3340f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", PCHPDDMSetCoarseCorrectionType_HPDDM));
3341f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", PCHPDDMGetCoarseCorrectionType_HPDDM));
3342e31fc274SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", PCHPDDMSetSTShareSubKSP_HPDDM));
3343f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", PCHPDDMGetSTShareSubKSP_HPDDM));
3344f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", PCHPDDMSetDeflationMat_HPDDM));
33453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3346f1580f4eSBarry Smith }
3347f1580f4eSBarry Smith 
3348f1580f4eSBarry Smith /*@C
3349f1580f4eSBarry Smith   PCHPDDMInitializePackage - This function initializes everything in the `PCHPDDM` package. It is called from `PCInitializePackage()`.
3350f1580f4eSBarry Smith 
3351f1580f4eSBarry Smith   Level: developer
3352f1580f4eSBarry Smith 
3353562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscInitialize()`
3354f1580f4eSBarry Smith @*/
3355d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMInitializePackage(void)
3356d71ae5a4SJacob Faibussowitsch {
3357f1580f4eSBarry Smith   char ename[32];
3358f1580f4eSBarry Smith 
3359f1580f4eSBarry Smith   PetscFunctionBegin;
33603ba16761SJacob Faibussowitsch   if (PCHPDDMPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
3361f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_TRUE;
3362f1580f4eSBarry Smith   PetscCall(PetscRegisterFinalize(PCHPDDMFinalizePackage));
3363f1580f4eSBarry Smith   /* general events registered once during package initialization */
3364f1580f4eSBarry Smith   /* some of these events are not triggered in libpetsc,          */
3365f1580f4eSBarry Smith   /* but rather directly in libhpddm_petsc,                       */
3366f1580f4eSBarry Smith   /* which is in charge of performing the following operations    */
3367f1580f4eSBarry Smith 
3368f1580f4eSBarry Smith   /* domain decomposition structure from Pmat sparsity pattern    */
3369f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMStrc", PC_CLASSID, &PC_HPDDM_Strc));
3370f1580f4eSBarry Smith   /* Galerkin product, redistribution, and setup (not triggered in libpetsc)                */
3371f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtAP", PC_CLASSID, &PC_HPDDM_PtAP));
3372f1580f4eSBarry Smith   /* Galerkin product with summation, redistribution, and setup (not triggered in libpetsc) */
3373f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtBP", PC_CLASSID, &PC_HPDDM_PtBP));
3374f1580f4eSBarry Smith   /* next level construction using PtAP and PtBP (not triggered in libpetsc)                */
3375f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMNext", PC_CLASSID, &PC_HPDDM_Next));
3376f1580f4eSBarry Smith   static_assert(PETSC_PCHPDDM_MAXLEVELS <= 9, "PETSC_PCHPDDM_MAXLEVELS value is too high");
3377811e8887SPierre Jolivet   for (PetscInt i = 1; i < PETSC_PCHPDDM_MAXLEVELS; ++i) {
3378f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSetUp L%1" PetscInt_FMT, i));
3379f1580f4eSBarry Smith     /* events during a PCSetUp() at level #i _except_ the assembly */
3380f1580f4eSBarry Smith     /* of the Galerkin operator of the coarser level #(i + 1)      */
3381f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_SetUp[i - 1]));
3382f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSolve L%1" PetscInt_FMT, i));
3383f1580f4eSBarry Smith     /* events during a PCApply() at level #i _except_              */
3384f1580f4eSBarry Smith     /* the KSPSolve() of the coarser level #(i + 1)                */
3385f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_Solve[i - 1]));
3386f1580f4eSBarry Smith   }
33873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3388f1580f4eSBarry Smith }
3389f1580f4eSBarry Smith 
3390f1580f4eSBarry Smith /*@C
3391f1580f4eSBarry Smith   PCHPDDMFinalizePackage - This function frees everything from the `PCHPDDM` package. It is called from `PetscFinalize()`.
3392f1580f4eSBarry Smith 
3393f1580f4eSBarry Smith   Level: developer
3394f1580f4eSBarry Smith 
3395562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscFinalize()`
3396f1580f4eSBarry Smith @*/
3397d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMFinalizePackage(void)
3398d71ae5a4SJacob Faibussowitsch {
3399f1580f4eSBarry Smith   PetscFunctionBegin;
3400f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_FALSE;
34013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3402f1580f4eSBarry Smith }
34039bb5c669SPierre Jolivet 
34049bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat A, Vec x, Vec y)
34059bb5c669SPierre Jolivet {
34069bb5c669SPierre Jolivet   Harmonic h; /* [ A_00  A_01       ], furthermore, A_00 = [ A_loc,loc  A_loc,ovl ], thus, A_01 = [         ] */
34079bb5c669SPierre Jolivet               /* [ A_10  A_11  A_12 ]                      [ A_ovl,loc  A_ovl,ovl ]               [ A_ovl,1 ] */
34089bb5c669SPierre Jolivet   Vec sub;    /*  y = A x = R_loc R_0 [ A_00  A_01 ]^-1                                   R_loc = [  I_loc  ] */
34099bb5c669SPierre Jolivet               /*                      [ A_10  A_11 ]    R_1^T A_12 x                              [         ] */
34109bb5c669SPierre Jolivet   PetscFunctionBegin;
34119bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
34129bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
34139bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
34149bb5c669SPierre Jolivet   PetscCall(MatMult(h->A[0], x, sub));
34159bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
34169bb5c669SPierre Jolivet   PetscCall(KSPSolve(h->ksp, h->v, h->v));
34179bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_REVERSE, y));
34189bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
34199bb5c669SPierre Jolivet }
34209bb5c669SPierre Jolivet 
34219bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat A, Vec y, Vec x)
34229bb5c669SPierre Jolivet {
34239bb5c669SPierre Jolivet   Harmonic h;   /* x = A^T y =            [ A_00  A_01 ]^-T R_0^T R_loc^T y */
34249bb5c669SPierre Jolivet   Vec      sub; /*             A_12^T R_1 [ A_10  A_11 ]                    */
34259bb5c669SPierre Jolivet 
34269bb5c669SPierre Jolivet   PetscFunctionBegin;
34279bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
34289bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
34299bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_FORWARD, y));
34309bb5c669SPierre Jolivet   PetscCall(KSPSolveTranspose(h->ksp, h->v, h->v));
34319bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
34329bb5c669SPierre Jolivet   PetscCall(MatMultTranspose(h->A[0], sub, x));
34339bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
34349bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
34359bb5c669SPierre Jolivet }
34369bb5c669SPierre Jolivet 
34379bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat S, Mat X, Mat Y, void *)
34389bb5c669SPierre Jolivet {
34399bb5c669SPierre Jolivet   Harmonic h;
34409bb5c669SPierre Jolivet   Mat      A, B;
34419bb5c669SPierre Jolivet   Vec      a, b;
34429bb5c669SPierre Jolivet 
34439bb5c669SPierre Jolivet   PetscFunctionBegin;
34449bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
3445fb842aefSJose E. Roman   PetscCall(MatMatMult(h->A[0], X, MAT_INITIAL_MATRIX, PETSC_CURRENT, &A));
34469bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
34479bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
34489bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
34499bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B, i, &b));
34509bb5c669SPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_FORWARD, a));
34519bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B, i, &b));
34529bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
34539bb5c669SPierre Jolivet   }
34549bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
34559bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, B->cmap->n, nullptr, &A));
34569bb5c669SPierre Jolivet   PetscCall(KSPMatSolve(h->ksp, B, A));
34579bb5c669SPierre Jolivet   PetscCall(MatDestroy(&B));
34589bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
34599bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
34609bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &b));
34619bb5c669SPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_REVERSE, b));
34629bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &b));
34639bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
34649bb5c669SPierre Jolivet   }
34659bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
34669bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
34679bb5c669SPierre Jolivet }
34689bb5c669SPierre Jolivet 
3469f21e3f8aSPierre Jolivet static PetscErrorCode MatProduct_AtB_Harmonic(Mat S, Mat Y, Mat X, void *)
3470f21e3f8aSPierre Jolivet {
3471f21e3f8aSPierre Jolivet   Harmonic h;
3472f21e3f8aSPierre Jolivet   Mat      A, B;
3473f21e3f8aSPierre Jolivet   Vec      a, b;
3474f21e3f8aSPierre Jolivet 
3475f21e3f8aSPierre Jolivet   PetscFunctionBegin;
3476f21e3f8aSPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
3477f21e3f8aSPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, Y->cmap->n, nullptr, &A));
3478f21e3f8aSPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
3479f21e3f8aSPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(Y, i, &b));
3480f21e3f8aSPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(A, i, &a));
3481f21e3f8aSPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_FORWARD, b));
3482f21e3f8aSPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(A, i, &a));
3483f21e3f8aSPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(Y, i, &b));
3484f21e3f8aSPierre Jolivet   }
3485f21e3f8aSPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
3486f21e3f8aSPierre Jolivet   PetscCall(KSPMatSolveTranspose(h->ksp, A, B));
3487f21e3f8aSPierre Jolivet   PetscCall(MatDestroy(&A));
3488f21e3f8aSPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->A[0]->rmap->n, B->cmap->n, nullptr, &A));
3489f21e3f8aSPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
3490f21e3f8aSPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B, i, &b));
3491f21e3f8aSPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(A, i, &a));
3492f21e3f8aSPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_REVERSE, a));
3493f21e3f8aSPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(A, i, &a));
3494f21e3f8aSPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B, i, &b));
3495f21e3f8aSPierre Jolivet   }
3496f21e3f8aSPierre Jolivet   PetscCall(MatDestroy(&B));
3497f21e3f8aSPierre Jolivet   PetscCall(MatTransposeMatMult(h->A[0], A, MAT_REUSE_MATRIX, PETSC_CURRENT, &X));
3498f21e3f8aSPierre Jolivet   PetscCall(MatDestroy(&A));
3499f21e3f8aSPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
3500f21e3f8aSPierre Jolivet }
3501f21e3f8aSPierre Jolivet 
35029bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat A)
35039bb5c669SPierre Jolivet {
35049bb5c669SPierre Jolivet   Harmonic h;
35059bb5c669SPierre Jolivet 
35069bb5c669SPierre Jolivet   PetscFunctionBegin;
35079bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
350832603206SJames Wright   for (PetscInt i = 0; i < 5; ++i) PetscCall(ISDestroy(h->is + i));
35099bb5c669SPierre Jolivet   PetscCall(PetscFree(h->is));
35109bb5c669SPierre Jolivet   PetscCall(VecDestroy(&h->v));
35119bb5c669SPierre Jolivet   for (PetscInt i = 0; i < 2; ++i) PetscCall(MatDestroy(h->A + i));
35129bb5c669SPierre Jolivet   PetscCall(PetscFree(h->A));
35139bb5c669SPierre Jolivet   PetscCall(KSPDestroy(&h->ksp));
35149bb5c669SPierre Jolivet   PetscCall(PetscFree(h));
35159bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
35169bb5c669SPierre Jolivet }
3517