xref: /petsc/src/ksp/pc/impls/hpddm/pchpddm.cxx (revision b5a302b32283056a570b9c7766b323c57e4752e5)
101e3c840SPierre Jolivet #include <petscsf.h>
213044ca3SPierre Jolivet #include <petsc/private/vecimpl.h>
3f1580f4eSBarry Smith #include <petsc/private/matimpl.h>
4f1580f4eSBarry Smith #include <petsc/private/petschpddm.h> /*I "petscpc.h" I*/
5e905f78bSJacob Faibussowitsch #include <petsc/private/pcimpl.h>
6e905f78bSJacob Faibussowitsch #include <petsc/private/dmimpl.h> /* this must be included after petschpddm.h so that DM_MAX_WORK_VECTORS is not defined  */
7f1580f4eSBarry Smith                                   /* otherwise, it is assumed that one is compiling libhpddm_petsc => circular dependency */
8f1580f4eSBarry Smith 
9db4a47b3SPierre Jolivet static PetscErrorCode (*loadedSym)(HPDDM::Schwarz<PetscScalar> *const, IS, Mat, Mat, Mat, std::vector<Vec>, PC_HPDDM_Level **const) = nullptr;
10f1580f4eSBarry Smith 
11f1580f4eSBarry Smith static PetscBool PCHPDDMPackageInitialized = PETSC_FALSE;
12f1580f4eSBarry Smith 
13f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_Strc;
14f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_PtAP;
15f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_PtBP;
16f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_Next;
17f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_SetUp[PETSC_PCHPDDM_MAXLEVELS];
18f1580f4eSBarry Smith PetscLogEvent PC_HPDDM_Solve[PETSC_PCHPDDM_MAXLEVELS];
19f1580f4eSBarry Smith 
20aa1539e9SPierre Jolivet const char *const PCHPDDMCoarseCorrectionTypes[] = {"DEFLATED", "ADDITIVE", "BALANCED", "NONE", "PCHPDDMCoarseCorrectionType", "PC_HPDDM_COARSE_CORRECTION_", nullptr};
2113044ca3SPierre Jolivet const char *const PCHPDDMSchurPreTypes[]         = {"LEAST_SQUARES", "GENEO", "PCHPDDMSchurPreType", "PC_HPDDM_SCHUR_PRE", nullptr};
22f1580f4eSBarry Smith 
23d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_HPDDM(PC pc)
24d71ae5a4SJacob Faibussowitsch {
25f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
26f1580f4eSBarry Smith 
27f1580f4eSBarry Smith   PetscFunctionBegin;
28f1580f4eSBarry Smith   if (data->levels) {
29811e8887SPierre Jolivet     for (PetscInt i = 0; i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]; ++i) {
30f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[i]->ksp));
31f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[i]->pc));
32f1580f4eSBarry Smith       PetscCall(PetscFree(data->levels[i]));
33f1580f4eSBarry Smith     }
34f1580f4eSBarry Smith     PetscCall(PetscFree(data->levels));
35f1580f4eSBarry Smith   }
36f1580f4eSBarry Smith   PetscCall(ISDestroy(&data->is));
37f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->aux));
38f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->B));
39f1580f4eSBarry Smith   PetscCall(VecDestroy(&data->normal));
40f1580f4eSBarry Smith   data->correction = PC_HPDDM_COARSE_CORRECTION_DEFLATED;
41c8ea6600SPierre Jolivet   data->Neumann    = PETSC_BOOL3_UNKNOWN;
42f1580f4eSBarry Smith   data->deflation  = PETSC_FALSE;
43db4a47b3SPierre Jolivet   data->setup      = nullptr;
44db4a47b3SPierre Jolivet   data->setup_ctx  = nullptr;
453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
46f1580f4eSBarry Smith }
47f1580f4eSBarry Smith 
48d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDM(PC pc)
49d71ae5a4SJacob Faibussowitsch {
50f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
51f1580f4eSBarry Smith 
52f1580f4eSBarry Smith   PetscFunctionBegin;
53f1580f4eSBarry Smith   PetscCall(PCReset_HPDDM(pc));
54f1580f4eSBarry Smith   PetscCall(PetscFree(data));
55db4a47b3SPierre Jolivet   PetscCall(PetscObjectChangeTypeName((PetscObject)pc, nullptr));
56db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", nullptr));
57db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", nullptr));
58db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", nullptr));
59db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", nullptr));
60db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", nullptr));
61db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", nullptr));
62db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", nullptr));
63db4a47b3SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", nullptr));
6413044ca3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc, "_PCHPDDM_Schur", nullptr));
653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
66f1580f4eSBarry Smith }
67f1580f4eSBarry Smith 
68d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMSetAuxiliaryMat_Private(PC pc, IS is, Mat A, PetscBool deflation)
69d71ae5a4SJacob Faibussowitsch {
70f1580f4eSBarry Smith   PC_HPDDM                   *data = (PC_HPDDM *)pc->data;
71cdbd50ebSPierre Jolivet   PCHPDDMCoarseCorrectionType type = data->correction;
72f1580f4eSBarry Smith 
73f1580f4eSBarry Smith   PetscFunctionBegin;
74c30dab7bSPierre Jolivet   PetscValidLogicalCollectiveBool(pc, deflation, 4);
75c30dab7bSPierre Jolivet   if (is && A) {
76c30dab7bSPierre Jolivet     PetscInt m[2];
77c30dab7bSPierre Jolivet 
78c30dab7bSPierre Jolivet     PetscCall(ISGetLocalSize(is, m));
79c30dab7bSPierre Jolivet     PetscCall(MatGetLocalSize(A, m + 1, nullptr));
80c30dab7bSPierre Jolivet     PetscCheck(m[0] == m[1], PETSC_COMM_SELF, PETSC_ERR_USER_INPUT, "Inconsistent IS and Mat sizes (%" PetscInt_FMT " v. %" PetscInt_FMT ")", m[0], m[1]);
81c30dab7bSPierre Jolivet   }
82f1580f4eSBarry Smith   if (is) {
83f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)is));
84f1580f4eSBarry Smith     if (data->is) { /* new overlap definition resets the PC */
85f1580f4eSBarry Smith       PetscCall(PCReset_HPDDM(pc));
86f1580f4eSBarry Smith       pc->setfromoptionscalled = 0;
87371d2eb7SMartin Diehl       pc->setupcalled          = PETSC_FALSE;
88cdbd50ebSPierre Jolivet       data->correction         = type;
89f1580f4eSBarry Smith     }
90f1580f4eSBarry Smith     PetscCall(ISDestroy(&data->is));
91f1580f4eSBarry Smith     data->is = is;
92f1580f4eSBarry Smith   }
93f1580f4eSBarry Smith   if (A) {
94f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)A));
95f1580f4eSBarry Smith     PetscCall(MatDestroy(&data->aux));
96f1580f4eSBarry Smith     data->aux = A;
97f1580f4eSBarry Smith   }
98f1580f4eSBarry Smith   data->deflation = deflation;
993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
100f1580f4eSBarry Smith }
101f1580f4eSBarry Smith 
102281f8ce6SPierre Jolivet static inline PetscErrorCode PCHPDDMSplittingMatNormal_Private(Mat A, IS *is, Mat *splitting[])
103281f8ce6SPierre Jolivet {
104281f8ce6SPierre Jolivet   Mat *sub;
105281f8ce6SPierre Jolivet   IS   zero;
106281f8ce6SPierre Jolivet 
107281f8ce6SPierre Jolivet   PetscFunctionBegin;
108281f8ce6SPierre Jolivet   PetscCall(MatSetOption(A, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
109281f8ce6SPierre Jolivet   PetscCall(MatCreateSubMatrices(A, 1, is + 2, is, MAT_INITIAL_MATRIX, splitting));
110281f8ce6SPierre Jolivet   PetscCall(MatCreateSubMatrices(**splitting, 1, is + 2, is + 1, MAT_INITIAL_MATRIX, &sub));
111281f8ce6SPierre Jolivet   PetscCall(MatFindZeroRows(*sub, &zero));
112281f8ce6SPierre Jolivet   PetscCall(MatDestroySubMatrices(1, &sub));
113281f8ce6SPierre Jolivet   PetscCall(MatSetOption(**splitting, MAT_KEEP_NONZERO_PATTERN, PETSC_TRUE));
114281f8ce6SPierre Jolivet   PetscCall(MatZeroRowsIS(**splitting, zero, 0.0, nullptr, nullptr));
115281f8ce6SPierre Jolivet   PetscCall(ISDestroy(&zero));
116281f8ce6SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
117281f8ce6SPierre Jolivet }
118281f8ce6SPierre Jolivet 
119281f8ce6SPierre Jolivet static inline PetscErrorCode PCHPDDMSetAuxiliaryMatNormal_Private(PC pc, Mat A, Mat N, Mat *B, const char *pcpre, Vec *diagonal = nullptr, Mat B01 = nullptr)
120d71ae5a4SJacob Faibussowitsch {
121f1580f4eSBarry Smith   PC_HPDDM *data         = (PC_HPDDM *)pc->data;
122281f8ce6SPierre Jolivet   Mat      *splitting[2] = {}, aux;
1233df4cd7bSPierre Jolivet   Vec       d;
124281f8ce6SPierre Jolivet   IS        is[3];
125f1580f4eSBarry Smith   PetscReal norm;
126f1580f4eSBarry Smith   PetscBool flg;
127f1580f4eSBarry Smith   char      type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
128f1580f4eSBarry Smith 
129f1580f4eSBarry Smith   PetscFunctionBegin;
130281f8ce6SPierre Jolivet   if (!B01) PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, B));
131281f8ce6SPierre Jolivet   else PetscCall(MatTransposeMatMult(B01, A, MAT_INITIAL_MATRIX, PETSC_DETERMINE, B));
132feebddf4SPierre Jolivet   PetscCall(MatEliminateZeros(*B, PETSC_TRUE));
133281f8ce6SPierre Jolivet   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, is));
134281f8ce6SPierre Jolivet   PetscCall(MatIncreaseOverlap(*B, 1, is, 1));
135281f8ce6SPierre Jolivet   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, is + 2));
136281f8ce6SPierre Jolivet   PetscCall(ISEmbed(is[0], is[2], PETSC_TRUE, is + 1));
137281f8ce6SPierre Jolivet   PetscCall(ISDestroy(is + 2));
138281f8ce6SPierre Jolivet   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->rmap->N, 0, 1, is + 2));
139281f8ce6SPierre Jolivet   PetscCall(PCHPDDMSplittingMatNormal_Private(A, is, &splitting[0]));
140281f8ce6SPierre Jolivet   if (B01) {
141281f8ce6SPierre Jolivet     PetscCall(PCHPDDMSplittingMatNormal_Private(B01, is, &splitting[1]));
142281f8ce6SPierre Jolivet     PetscCall(MatDestroy(&B01));
143281f8ce6SPierre Jolivet   }
144281f8ce6SPierre Jolivet   PetscCall(ISDestroy(is + 2));
145281f8ce6SPierre Jolivet   PetscCall(ISDestroy(is + 1));
146db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, 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));
180f1580f4eSBarry Smith   } else {
181f1580f4eSBarry Smith     PetscBool flg;
182811e8887SPierre Jolivet 
183281f8ce6SPierre Jolivet     PetscCheck(!splitting[1], PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot use PCQR when A01 != A10^T");
1843df4cd7bSPierre Jolivet     if (diagonal) {
1853df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1863df4cd7bSPierre Jolivet       PetscCheck(norm < PETSC_SMALL, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Nonzero diagonal A11 block");
1873df4cd7bSPierre Jolivet       PetscCall(VecDestroy(diagonal));
1883df4cd7bSPierre Jolivet     }
189f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)N, MATNORMAL, &flg));
190281f8ce6SPierre Jolivet     if (flg) PetscCall(MatCreateNormal(*splitting[0], &aux));
191281f8ce6SPierre Jolivet     else PetscCall(MatCreateNormalHermitian(*splitting[0], &aux));
192f1580f4eSBarry Smith   }
193281f8ce6SPierre Jolivet   PetscCall(MatDestroySubMatrices(1, &splitting[0]));
194281f8ce6SPierre Jolivet   PetscCall(PCHPDDMSetAuxiliaryMat(pc, *is, aux, nullptr, nullptr));
195c8ea6600SPierre Jolivet   data->Neumann = PETSC_BOOL3_TRUE;
196281f8ce6SPierre Jolivet   PetscCall(ISDestroy(is));
197f1580f4eSBarry Smith   PetscCall(MatDestroy(&aux));
1983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
199f1580f4eSBarry Smith }
200f1580f4eSBarry Smith 
201d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetAuxiliaryMat_HPDDM(PC pc, IS is, Mat A, PetscErrorCode (*setup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *setup_ctx)
202d71ae5a4SJacob Faibussowitsch {
203f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
204f1580f4eSBarry Smith 
205f1580f4eSBarry Smith   PetscFunctionBegin;
206f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, A, PETSC_FALSE));
207f1580f4eSBarry Smith   if (setup) {
208f1580f4eSBarry Smith     data->setup     = setup;
209f1580f4eSBarry Smith     data->setup_ctx = setup_ctx;
210f1580f4eSBarry Smith   }
2113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
212f1580f4eSBarry Smith }
213f1580f4eSBarry Smith 
21470009435SPierre Jolivet /*@C
21504c3f3b8SBarry Smith   PCHPDDMSetAuxiliaryMat - Sets the auxiliary matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
216f1580f4eSBarry Smith 
217f1580f4eSBarry Smith   Input Parameters:
218f1580f4eSBarry Smith + pc    - preconditioner context
219f1580f4eSBarry Smith . is    - index set of the local auxiliary, e.g., Neumann, matrix
220f1580f4eSBarry Smith . A     - auxiliary sequential matrix
22104c3f3b8SBarry Smith . setup - function for generating the auxiliary matrix entries, may be `NULL`
22204c3f3b8SBarry Smith - ctx   - context for `setup`, may be `NULL`
22304c3f3b8SBarry Smith 
22404c3f3b8SBarry Smith   Calling sequence of `setup`:
22504c3f3b8SBarry Smith + J   - matrix whose values are to be set
22604c3f3b8SBarry Smith . t   - time
22704c3f3b8SBarry Smith . X   - linearization point
22804c3f3b8SBarry Smith . X_t - time-derivative of the linearization point
22904c3f3b8SBarry Smith . s   - step
23004c3f3b8SBarry Smith . ovl - index set of the local auxiliary, e.g., Neumann, matrix
23104c3f3b8SBarry Smith - ctx - context for `setup`, may be `NULL`
232f1580f4eSBarry Smith 
233f1580f4eSBarry Smith   Level: intermediate
234f1580f4eSBarry Smith 
23504c3f3b8SBarry Smith   Note:
23604c3f3b8SBarry Smith   As an example, in a finite element context with nonoverlapping subdomains plus (overlapping) ghost elements, this could be the unassembled (Neumann)
23704c3f3b8SBarry Smith   local overlapping operator. As opposed to the assembled (Dirichlet) local overlapping operator obtained by summing neighborhood contributions
23804c3f3b8SBarry Smith   at the interface of ghost elements.
23904c3f3b8SBarry Smith 
24070009435SPierre Jolivet   Fortran Notes:
24104c3f3b8SBarry Smith   Only `PETSC_NULL_FUNCTION` is supported for `setup` and `ctx` is never accessed
24270009435SPierre Jolivet 
243562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetRHSMat()`, `MATIS`
244f1580f4eSBarry Smith @*/
24504c3f3b8SBarry Smith PetscErrorCode PCHPDDMSetAuxiliaryMat(PC pc, IS is, Mat A, PetscErrorCode (*setup)(Mat J, PetscReal t, Vec X, Vec X_t, PetscReal s, IS ovl, void *ctx), void *ctx)
246d71ae5a4SJacob Faibussowitsch {
247f1580f4eSBarry Smith   PetscFunctionBegin;
248f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
249f1580f4eSBarry Smith   if (is) PetscValidHeaderSpecific(is, IS_CLASSID, 2);
250f1580f4eSBarry Smith   if (A) PetscValidHeaderSpecific(A, MAT_CLASSID, 3);
25104c3f3b8SBarry Smith   PetscTryMethod(pc, "PCHPDDMSetAuxiliaryMat_C", (PC, IS, Mat, PetscErrorCode (*)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *), (pc, is, A, setup, ctx));
2523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
253f1580f4eSBarry Smith }
254f1580f4eSBarry Smith 
255d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMHasNeumannMat_HPDDM(PC pc, PetscBool has)
256d71ae5a4SJacob Faibussowitsch {
257f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
258f1580f4eSBarry Smith 
259f1580f4eSBarry Smith   PetscFunctionBegin;
260c8ea6600SPierre Jolivet   data->Neumann = PetscBoolToBool3(has);
2613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
262f1580f4eSBarry Smith }
263f1580f4eSBarry Smith 
264f1580f4eSBarry Smith /*@
265f1580f4eSBarry Smith   PCHPDDMHasNeumannMat - Informs `PCHPDDM` that the `Mat` passed to `PCHPDDMSetAuxiliaryMat()` is the local Neumann matrix.
266f1580f4eSBarry Smith 
267f1580f4eSBarry Smith   Input Parameters:
268f1580f4eSBarry Smith + pc  - preconditioner context
269f1580f4eSBarry Smith - has - Boolean value
270f1580f4eSBarry Smith 
271f1580f4eSBarry Smith   Level: intermediate
272f1580f4eSBarry Smith 
273f1580f4eSBarry Smith   Notes:
2747eb095acSPierre Jolivet   This may be used to bypass a call to `MatCreateSubMatrices()` and to `MatConvert()` for `MATSBAIJ` matrices.
275f1580f4eSBarry Smith 
276907a3e9cSStefano 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`.
277f1580f4eSBarry Smith 
278562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetAuxiliaryMat()`
279f1580f4eSBarry Smith @*/
280d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMHasNeumannMat(PC pc, PetscBool has)
281d71ae5a4SJacob Faibussowitsch {
282f1580f4eSBarry Smith   PetscFunctionBegin;
283f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
284f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMHasNeumannMat_C", (PC, PetscBool), (pc, has));
2853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
286f1580f4eSBarry Smith }
287f1580f4eSBarry Smith 
288d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetRHSMat_HPDDM(PC pc, Mat B)
289d71ae5a4SJacob Faibussowitsch {
290f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
291f1580f4eSBarry Smith 
292f1580f4eSBarry Smith   PetscFunctionBegin;
293f1580f4eSBarry Smith   PetscCall(PetscObjectReference((PetscObject)B));
294f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->B));
295f1580f4eSBarry Smith   data->B = B;
2963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
297f1580f4eSBarry Smith }
298f1580f4eSBarry Smith 
299f1580f4eSBarry Smith /*@
30004c3f3b8SBarry Smith   PCHPDDMSetRHSMat - Sets the right-hand side matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
301f1580f4eSBarry Smith 
302f1580f4eSBarry Smith   Input Parameters:
303f1580f4eSBarry Smith + pc - preconditioner context
304f1580f4eSBarry Smith - B  - right-hand side sequential matrix
305f1580f4eSBarry Smith 
306f1580f4eSBarry Smith   Level: advanced
307f1580f4eSBarry Smith 
30804c3f3b8SBarry Smith   Note:
30904c3f3b8SBarry Smith   Must be used in conjunction with `PCHPDDMSetAuxiliaryMat`(N), so that Nv = lambda Bv is solved using `EPSSetOperators`(N, B).
31004c3f3b8SBarry Smith   It is assumed that N and `B` are provided using the same numbering. This provides a means to try more advanced methods such as GenEO-II or H-GenEO.
31104c3f3b8SBarry Smith 
312562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetAuxiliaryMat()`, `PCHPDDM`
313f1580f4eSBarry Smith @*/
314d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetRHSMat(PC pc, Mat B)
315d71ae5a4SJacob Faibussowitsch {
316f1580f4eSBarry Smith   PetscFunctionBegin;
317f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
318f1580f4eSBarry Smith   if (B) {
319f1580f4eSBarry Smith     PetscValidHeaderSpecific(B, MAT_CLASSID, 2);
320f1580f4eSBarry Smith     PetscTryMethod(pc, "PCHPDDMSetRHSMat_C", (PC, Mat), (pc, B));
321f1580f4eSBarry Smith   }
3223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
323f1580f4eSBarry Smith }
324f1580f4eSBarry Smith 
325ce78bad3SBarry Smith static PetscErrorCode PCSetFromOptions_HPDDM(PC pc, PetscOptionItems PetscOptionsObject)
326d71ae5a4SJacob Faibussowitsch {
327f1580f4eSBarry Smith   PC_HPDDM                   *data   = (PC_HPDDM *)pc->data;
328f1580f4eSBarry Smith   PC_HPDDM_Level            **levels = data->levels;
329*b5a302b3SPierre Jolivet   char                        prefix[256], deprecated[256];
330f1580f4eSBarry Smith   int                         i = 1;
331f1580f4eSBarry Smith   PetscMPIInt                 size, previous;
3329bb5c669SPierre Jolivet   PetscInt                    n, overlap = 1;
333f1580f4eSBarry Smith   PCHPDDMCoarseCorrectionType type;
334c8ea6600SPierre Jolivet   PetscBool                   flg = PETSC_TRUE, set;
335f1580f4eSBarry Smith 
336f1580f4eSBarry Smith   PetscFunctionBegin;
337f1580f4eSBarry Smith   if (!data->levels) {
338f1580f4eSBarry Smith     PetscCall(PetscCalloc1(PETSC_PCHPDDM_MAXLEVELS, &levels));
339f1580f4eSBarry Smith     data->levels = levels;
340f1580f4eSBarry Smith   }
341f1580f4eSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "PCHPDDM options");
3429bb5c669SPierre Jolivet   PetscCall(PetscOptionsBoundedInt("-pc_hpddm_harmonic_overlap", "Overlap prior to computing local harmonic extensions", "PCHPDDM", overlap, &overlap, &set, 1));
3439bb5c669SPierre Jolivet   if (!set) overlap = -1;
344f1580f4eSBarry Smith   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
345f1580f4eSBarry Smith   previous = size;
346f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS) {
347f1580f4eSBarry Smith     PetscInt p = 1;
348f1580f4eSBarry Smith 
3494dfa11a4SJacob Faibussowitsch     if (!data->levels[i - 1]) PetscCall(PetscNew(data->levels + i - 1));
350f1580f4eSBarry Smith     data->levels[i - 1]->parent = data;
351f1580f4eSBarry Smith     /* if the previous level has a single process, it is not possible to coarsen further */
352f1580f4eSBarry Smith     if (previous == 1 || !flg) break;
353f1580f4eSBarry Smith     data->levels[i - 1]->nu        = 0;
354f1580f4eSBarry Smith     data->levels[i - 1]->threshold = -1.0;
355f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
356db4a47b3SPierre Jolivet     PetscCall(PetscOptionsBoundedInt(prefix, "Local number of deflation vectors computed by SLEPc", "EPSSetDimensions", data->levels[i - 1]->nu, &data->levels[i - 1]->nu, nullptr, 0));
357*b5a302b3SPierre Jolivet     PetscCall(PetscSNPrintf(deprecated, sizeof(deprecated), "-pc_hpddm_levels_%d_eps_threshold", i));
358*b5a302b3SPierre Jolivet     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold_absolute", i));
359*b5a302b3SPierre Jolivet     PetscCall(PetscOptionsDeprecated(deprecated, prefix, "3.24", NULL));
360*b5a302b3SPierre 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));
361f1580f4eSBarry Smith     if (i == 1) {
362*b5a302b3SPierre 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");
3639bb5c669SPierre Jolivet       if (overlap != -1) {
3649bb5c669SPierre Jolivet         PetscInt  nsv    = 0;
365*b5a302b3SPierre Jolivet         PetscBool set[2] = {PETSC_FALSE, PETSC_FALSE};
366811e8887SPierre Jolivet 
3679bb5c669SPierre Jolivet         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_nsv", i));
3689bb5c669SPierre Jolivet         PetscCall(PetscOptionsBoundedInt(prefix, "Local number of deflation vectors computed by SLEPc", "SVDSetDimensions", nsv, &nsv, nullptr, 0));
369*b5a302b3SPierre 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");
370*b5a302b3SPierre Jolivet         if (data->levels[0]->nu == 0) { /* -eps_nev has not been used, so nu is 0 */
371*b5a302b3SPierre Jolivet           data->levels[0]->nu = nsv;    /* nu may still be 0 if -svd_nsv has not been used */
372*b5a302b3SPierre Jolivet           PetscCall(PetscSNPrintf(deprecated, sizeof(deprecated), "-pc_hpddm_levels_%d_svd_relative_threshold", i));
373*b5a302b3SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_threshold_relative", i));
374*b5a302b3SPierre Jolivet           PetscCall(PetscOptionsDeprecated(deprecated, prefix, "3.24", NULL));
375*b5a302b3SPierre 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 */
376*b5a302b3SPierre Jolivet         }
377*b5a302b3SPierre Jolivet         if (data->levels[0]->nu == 0 || nsv == 0) { /* if neither -eps_nev nor -svd_nsv has been used */
378*b5a302b3SPierre Jolivet           PetscCall(PetscSNPrintf(deprecated, sizeof(deprecated), "-pc_hpddm_levels_%d_eps_relative_threshold", i));
379*b5a302b3SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold_relative", i));
380*b5a302b3SPierre Jolivet           PetscCall(PetscOptionsDeprecated(deprecated, prefix, "3.24", NULL));
381*b5a302b3SPierre 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));
382*b5a302b3SPierre 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");
383*b5a302b3SPierre Jolivet         }
384*b5a302b3SPierre 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)");
3859bb5c669SPierre Jolivet       }
386f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_1_st_share_sub_ksp"));
387db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Shared KSP between SLEPc ST and the fine-level subdomain solver", "PCHPDDMSetSTShareSubKSP", PETSC_FALSE, &data->share, nullptr));
388f1580f4eSBarry Smith     }
389f1580f4eSBarry Smith     /* if there is no prescribed coarsening, just break out of the loop */
3900594bca0SPierre Jolivet     if (data->levels[i - 1]->threshold <= PetscReal() && data->levels[i - 1]->nu <= 0 && !(data->deflation && i == 1)) break;
391f1580f4eSBarry Smith     else {
392f1580f4eSBarry Smith       ++i;
393f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
394f1580f4eSBarry Smith       PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
395f1580f4eSBarry Smith       if (!flg) {
396*b5a302b3SPierre Jolivet         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold_absolute", i));
397f1580f4eSBarry Smith         PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
398f1580f4eSBarry Smith       }
399f1580f4eSBarry Smith       if (flg) {
400f1580f4eSBarry Smith         /* if there are coarsening options for the next level, then register it  */
401f1580f4eSBarry Smith         /* otherwise, don't to avoid having both options levels_N_p and coarse_p */
402f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_p", i));
403f1580f4eSBarry 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)));
404f1580f4eSBarry Smith         previous = p;
405f1580f4eSBarry Smith       }
406f1580f4eSBarry Smith     }
407f1580f4eSBarry Smith   }
408f1580f4eSBarry Smith   data->N = i;
409f1580f4eSBarry Smith   n       = 1;
410f1580f4eSBarry Smith   if (i > 1) {
411f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_coarse_p"));
412db4a47b3SPierre Jolivet     PetscCall(PetscOptionsRangeInt(prefix, "Number of processes used to assemble the coarsest operator", "PCHPDDM", n, &n, nullptr, 1, PetscMax(1, previous / 2)));
41302800ff6SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
414f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "pc_hpddm_coarse_"));
415db4a47b3SPierre Jolivet     PetscCall(PetscOptionsHasName(nullptr, prefix, "-mat_mumps_use_omp_threads", &flg));
416f1580f4eSBarry Smith     if (flg) {
417f1580f4eSBarry Smith       char type[64]; /* same size as in src/ksp/pc/impls/factor/factimpl.c */
418811e8887SPierre Jolivet 
419c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(type, n > 1 && PetscDefined(HAVE_MUMPS) ? MATSOLVERMUMPS : MATSOLVERPETSC, sizeof(type))); /* default solver for a MatMPIAIJ or a MatSeqAIJ */
420db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetString(nullptr, prefix, "-pc_factor_mat_solver_type", type, sizeof(type), nullptr));
4213ce573a3SPierre Jolivet       PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
422f1580f4eSBarry 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);
423f1580f4eSBarry Smith       size = n;
424f1580f4eSBarry Smith       n    = -1;
425db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetInt(nullptr, prefix, "-mat_mumps_use_omp_threads", &n, nullptr));
426f1580f4eSBarry Smith       PetscCheck(n >= 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Need to specify a positive integer for -%smat_mumps_use_omp_threads", prefix);
427f1580f4eSBarry 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" : "");
428f1580f4eSBarry Smith     }
429f1580f4eSBarry Smith #endif
430f1580f4eSBarry Smith     PetscCall(PetscOptionsEnum("-pc_hpddm_coarse_correction", "Type of coarse correction applied each iteration", "PCHPDDMSetCoarseCorrectionType", PCHPDDMCoarseCorrectionTypes, (PetscEnum)data->correction, (PetscEnum *)&type, &flg));
431f1580f4eSBarry Smith     if (flg) PetscCall(PCHPDDMSetCoarseCorrectionType(pc, type));
432f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_has_neumann"));
433c8ea6600SPierre Jolivet     PetscCall(PetscOptionsBool(prefix, "Is the auxiliary Mat the local Neumann matrix?", "PCHPDDMHasNeumannMat", PetscBool3ToBool(data->Neumann), &flg, &set));
434c8ea6600SPierre Jolivet     if (set) data->Neumann = PetscBoolToBool3(flg);
435f1580f4eSBarry Smith     data->log_separate = PETSC_FALSE;
436f1580f4eSBarry Smith     if (PetscDefined(USE_LOG)) {
437f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_log_separate"));
438db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Log events level by level instead of inside PCSetUp()/KSPSolve()", nullptr, data->log_separate, &data->log_separate, nullptr));
439f1580f4eSBarry Smith     }
440f1580f4eSBarry Smith   }
441f1580f4eSBarry Smith   PetscOptionsHeadEnd();
442f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]) PetscCall(PetscFree(data->levels[i++]));
4433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
444f1580f4eSBarry Smith }
445f1580f4eSBarry Smith 
446d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDM(PC pc, Vec x, Vec y)
447d71ae5a4SJacob Faibussowitsch {
448f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
449f1580f4eSBarry Smith 
450f1580f4eSBarry Smith   PetscFunctionBegin;
451f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
452f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
453db4a47b3SPierre 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 */
454f1580f4eSBarry Smith   PetscCall(KSPSolve(data->levels[0]->ksp, x, y));
455db4a47b3SPierre Jolivet   if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
4563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
457f1580f4eSBarry Smith }
458f1580f4eSBarry Smith 
459d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDM(PC pc, Mat X, Mat Y)
460d71ae5a4SJacob Faibussowitsch {
461f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
462f1580f4eSBarry Smith 
463f1580f4eSBarry Smith   PetscFunctionBegin;
464f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
465f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
466f1580f4eSBarry Smith   PetscCall(KSPMatSolve(data->levels[0]->ksp, X, Y));
4673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
468f1580f4eSBarry Smith }
469f1580f4eSBarry Smith 
470cc4c1da9SBarry Smith /*@
471f1580f4eSBarry Smith   PCHPDDMGetComplexities - Computes the grid and operator complexities.
472f1580f4eSBarry Smith 
473c71f06a7SPierre Jolivet   Collective
474c71f06a7SPierre Jolivet 
475f1580f4eSBarry Smith   Input Parameter:
476f1580f4eSBarry Smith . pc - preconditioner context
477f1580f4eSBarry Smith 
478f1580f4eSBarry Smith   Output Parameters:
479cc4c1da9SBarry Smith + gc - grid complexity $ \sum_i m_i / m_1 $
480cc4c1da9SBarry Smith - oc - operator complexity $ \sum_i nnz_i / nnz_1 $
481f1580f4eSBarry Smith 
482f1580f4eSBarry Smith   Level: advanced
483f1580f4eSBarry Smith 
484562efe2eSBarry Smith .seealso: [](ch_ksp), `PCMGGetGridComplexity()`, `PCHPDDM`, `PCHYPRE`, `PCGAMG`
485f1580f4eSBarry Smith @*/
486cc4c1da9SBarry Smith PetscErrorCode PCHPDDMGetComplexities(PC pc, PetscReal *gc, PetscReal *oc)
487d71ae5a4SJacob Faibussowitsch {
488f1580f4eSBarry Smith   PC_HPDDM      *data = (PC_HPDDM *)pc->data;
489f1580f4eSBarry Smith   MatInfo        info;
490f1580f4eSBarry Smith   PetscLogDouble accumulate[2]{}, nnz1 = 1.0, m1 = 1.0;
491f1580f4eSBarry Smith 
492f1580f4eSBarry Smith   PetscFunctionBegin;
493715c1178SPierre Jolivet   if (gc) {
494715c1178SPierre Jolivet     PetscAssertPointer(gc, 2);
495715c1178SPierre Jolivet     *gc = 0;
496715c1178SPierre Jolivet   }
497715c1178SPierre Jolivet   if (oc) {
498715c1178SPierre Jolivet     PetscAssertPointer(oc, 3);
499715c1178SPierre Jolivet     *oc = 0;
500715c1178SPierre Jolivet   }
501715c1178SPierre Jolivet   for (PetscInt n = 0; n < data->N; ++n) {
502f1580f4eSBarry Smith     if (data->levels[n]->ksp) {
50313044ca3SPierre Jolivet       Mat       P, A = nullptr;
504715c1178SPierre Jolivet       PetscInt  m;
50513044ca3SPierre Jolivet       PetscBool flg = PETSC_FALSE;
50613044ca3SPierre Jolivet 
507db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &P));
508db4a47b3SPierre Jolivet       PetscCall(MatGetSize(P, &m, nullptr));
509f1580f4eSBarry Smith       accumulate[0] += m;
510f1580f4eSBarry Smith       if (n == 0) {
511f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
512f1580f4eSBarry Smith         if (flg) {
513f1580f4eSBarry Smith           PetscCall(MatConvert(P, MATAIJ, MAT_INITIAL_MATRIX, &A));
514f1580f4eSBarry Smith           P = A;
51513044ca3SPierre Jolivet         } else {
51613044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
51713044ca3SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)P));
518f1580f4eSBarry Smith         }
51913044ca3SPierre Jolivet       }
52013044ca3SPierre Jolivet       if (!A && flg) accumulate[1] += m * m; /* assumption that a MATSCHURCOMPLEMENT is dense if stored explicitly */
52113044ca3SPierre Jolivet       else if (P->ops->getinfo) {
522f1580f4eSBarry Smith         PetscCall(MatGetInfo(P, MAT_GLOBAL_SUM, &info));
523f1580f4eSBarry Smith         accumulate[1] += info.nz_used;
524f1580f4eSBarry Smith       }
525f1580f4eSBarry Smith       if (n == 0) {
526f1580f4eSBarry Smith         m1 = m;
52713044ca3SPierre Jolivet         if (!A && flg) nnz1 = m * m;
52813044ca3SPierre Jolivet         else if (P->ops->getinfo) nnz1 = info.nz_used;
529f1580f4eSBarry Smith         PetscCall(MatDestroy(&P));
530f1580f4eSBarry Smith       }
531f1580f4eSBarry Smith     }
532f1580f4eSBarry Smith   }
533715c1178SPierre Jolivet   /* only process #0 has access to the full hierarchy by construction, so broadcast to ensure consistent outputs */
534715c1178SPierre Jolivet   PetscCallMPI(MPI_Bcast(accumulate, 2, MPIU_PETSCLOGDOUBLE, 0, PetscObjectComm((PetscObject)pc)));
535715c1178SPierre Jolivet   if (gc) *gc = static_cast<PetscReal>(accumulate[0] / m1);
536715c1178SPierre Jolivet   if (oc) *oc = static_cast<PetscReal>(accumulate[1] / nnz1);
5373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
538f1580f4eSBarry Smith }
539f1580f4eSBarry Smith 
540d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_HPDDM(PC pc, PetscViewer viewer)
541d71ae5a4SJacob Faibussowitsch {
542f1580f4eSBarry Smith   PC_HPDDM         *data = (PC_HPDDM *)pc->data;
543f1580f4eSBarry Smith   PetscViewer       subviewer;
544aa21023fSPierre Jolivet   PetscViewerFormat format;
545f1580f4eSBarry Smith   PetscSubcomm      subcomm;
546f1580f4eSBarry Smith   PetscReal         oc, gc;
547811e8887SPierre Jolivet   PetscInt          tabs;
548f1580f4eSBarry Smith   PetscMPIInt       size, color, rank;
549aa21023fSPierre Jolivet   PetscBool         flg;
550aa21023fSPierre Jolivet   const char       *name;
551f1580f4eSBarry Smith 
552f1580f4eSBarry Smith   PetscFunctionBegin;
553aa21023fSPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &flg));
554aa21023fSPierre Jolivet   if (flg) {
555f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "level%s: %" PetscInt_FMT "\n", data->N > 1 ? "s" : "", data->N));
556f1580f4eSBarry Smith     PetscCall(PCHPDDMGetComplexities(pc, &gc, &oc));
557f1580f4eSBarry Smith     if (data->N > 1) {
558f1580f4eSBarry Smith       if (!data->deflation) {
559c8ea6600SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "Neumann matrix attached? %s\n", PetscBools[PetscBool3ToBool(data->Neumann)]));
560f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, "shared subdomain KSP between SLEPc and PETSc? %s\n", PetscBools[data->share]));
561f1580f4eSBarry Smith       } else PetscCall(PetscViewerASCIIPrintf(viewer, "user-supplied deflation matrix\n"));
562f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "coarse correction: %s\n", PCHPDDMCoarseCorrectionTypes[data->correction]));
563f1580f4eSBarry 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" : ""));
564f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIGetTab(viewer, &tabs));
565f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, 0));
566811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
567f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, data->levels[i - 1]->nu));
5680594bca0SPierre Jolivet         if (data->levels[i - 1]->threshold > static_cast<PetscReal>(-0.1)) PetscCall(PetscViewerASCIIPrintf(viewer, " (%g)", (double)data->levels[i - 1]->threshold));
569f1580f4eSBarry Smith       }
570f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
571f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, tabs));
572f1580f4eSBarry Smith     }
573f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "grid and operator complexities: %g %g\n", (double)gc, (double)oc));
5741fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
575f1580f4eSBarry Smith     if (data->levels[0]->ksp) {
576f1580f4eSBarry Smith       PetscCall(KSPView(data->levels[0]->ksp, viewer));
577f1580f4eSBarry Smith       if (data->levels[0]->pc) PetscCall(PCView(data->levels[0]->pc, viewer));
578eea1a2f1SRaphael Zanella       PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank));
579811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
580f1580f4eSBarry Smith         if (data->levels[i]->ksp) color = 1;
581f1580f4eSBarry Smith         else color = 0;
582f1580f4eSBarry Smith         PetscCall(PetscSubcommCreate(PetscObjectComm((PetscObject)pc), &subcomm));
583f1580f4eSBarry Smith         PetscCall(PetscSubcommSetNumber(subcomm, PetscMin(size, 2)));
584f1580f4eSBarry Smith         PetscCall(PetscSubcommSetTypeGeneral(subcomm, color, rank));
585f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPushTab(viewer));
586f1580f4eSBarry Smith         PetscCall(PetscViewerGetSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
587f1580f4eSBarry Smith         if (color == 1) {
588f1580f4eSBarry Smith           PetscCall(KSPView(data->levels[i]->ksp, subviewer));
589f1580f4eSBarry Smith           if (data->levels[i]->pc) PetscCall(PCView(data->levels[i]->pc, subviewer));
590f1580f4eSBarry Smith           PetscCall(PetscViewerFlush(subviewer));
591f1580f4eSBarry Smith         }
592f1580f4eSBarry Smith         PetscCall(PetscViewerRestoreSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
593f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPopTab(viewer));
594f1580f4eSBarry Smith         PetscCall(PetscSubcommDestroy(&subcomm));
595f1580f4eSBarry Smith       }
596f1580f4eSBarry Smith     }
597aa21023fSPierre Jolivet     PetscCall(PetscViewerGetFormat(viewer, &format));
598aa21023fSPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
599aa21023fSPierre Jolivet       PetscCall(PetscViewerFileGetName(viewer, &name));
600aa21023fSPierre Jolivet       if (name) {
601eea1a2f1SRaphael Zanella         Mat             aux[2];
602aa21023fSPierre Jolivet         IS              is;
603eea1a2f1SRaphael Zanella         const PetscInt *indices;
604eea1a2f1SRaphael Zanella         PetscInt        m, n, sizes[5] = {pc->mat->rmap->n, pc->mat->cmap->n, pc->mat->rmap->N, pc->mat->cmap->N, 0};
605aa21023fSPierre Jolivet         char           *tmp;
606aa21023fSPierre Jolivet         std::string     prefix, suffix;
607aa21023fSPierre Jolivet         size_t          pos;
608aa21023fSPierre Jolivet 
609aa21023fSPierre Jolivet         PetscCall(PetscStrstr(name, ".", &tmp));
610aa21023fSPierre Jolivet         if (tmp) {
611aa21023fSPierre Jolivet           pos    = std::distance(const_cast<char *>(name), tmp);
612aa21023fSPierre Jolivet           prefix = std::string(name, pos);
613aa21023fSPierre Jolivet           suffix = std::string(name + pos + 1);
614aa21023fSPierre Jolivet         } else prefix = name;
615aa21023fSPierre Jolivet         if (data->aux) {
616eea1a2f1SRaphael Zanella           PetscCall(MatGetSize(data->aux, &m, &n));
617eea1a2f1SRaphael Zanella           PetscCall(MatCreate(PetscObjectComm((PetscObject)pc), aux));
618eea1a2f1SRaphael Zanella           PetscCall(MatSetSizes(aux[0], m, n, PETSC_DETERMINE, PETSC_DETERMINE));
619eea1a2f1SRaphael Zanella           PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
620eea1a2f1SRaphael Zanella           if (flg) PetscCall(MatSetType(aux[0], MATMPIAIJ));
621eea1a2f1SRaphael Zanella           else {
622eea1a2f1SRaphael Zanella             PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQBAIJ, &flg));
623eea1a2f1SRaphael Zanella             if (flg) PetscCall(MatSetType(aux[0], MATMPIBAIJ));
624eea1a2f1SRaphael Zanella             else {
625eea1a2f1SRaphael Zanella               PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQSBAIJ, &flg));
626eea1a2f1SRaphael 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);
627eea1a2f1SRaphael Zanella               PetscCall(MatSetType(aux[0], MATMPISBAIJ));
628eea1a2f1SRaphael Zanella             }
629eea1a2f1SRaphael Zanella           }
630eea1a2f1SRaphael Zanella           PetscCall(MatSetBlockSizesFromMats(aux[0], data->aux, data->aux));
631eea1a2f1SRaphael Zanella           PetscCall(MatAssemblyBegin(aux[0], MAT_FINAL_ASSEMBLY));
632eea1a2f1SRaphael Zanella           PetscCall(MatAssemblyEnd(aux[0], MAT_FINAL_ASSEMBLY));
633eea1a2f1SRaphael Zanella           PetscCall(MatGetDiagonalBlock(aux[0], aux + 1));
634eea1a2f1SRaphael Zanella           PetscCall(MatCopy(data->aux, aux[1], DIFFERENT_NONZERO_PATTERN));
635eea1a2f1SRaphael Zanella           PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_aux_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
636eea1a2f1SRaphael Zanella           PetscCall(MatView(aux[0], subviewer));
637aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
638eea1a2f1SRaphael Zanella           PetscCall(MatDestroy(aux));
639aa21023fSPierre Jolivet         }
640aa21023fSPierre Jolivet         if (data->is) {
641eea1a2f1SRaphael Zanella           PetscCall(ISGetIndices(data->is, &indices));
642eea1a2f1SRaphael Zanella           PetscCall(ISGetSize(data->is, sizes + 4));
643eea1a2f1SRaphael Zanella           PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), sizes[4], indices, PETSC_USE_POINTER, &is));
644eea1a2f1SRaphael Zanella           PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_is_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
645eea1a2f1SRaphael Zanella           PetscCall(ISView(is, subviewer));
646aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
647eea1a2f1SRaphael Zanella           PetscCall(ISDestroy(&is));
648eea1a2f1SRaphael Zanella           PetscCall(ISRestoreIndices(data->is, &indices));
649aa21023fSPierre Jolivet         }
650eea1a2f1SRaphael Zanella         PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), PETSC_STATIC_ARRAY_LENGTH(sizes), sizes, PETSC_USE_POINTER, &is));
651eea1a2f1SRaphael Zanella         PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_sizes_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
652aa21023fSPierre Jolivet         PetscCall(ISView(is, subviewer));
653aa21023fSPierre Jolivet         PetscCall(PetscViewerDestroy(&subviewer));
654aa21023fSPierre Jolivet         PetscCall(ISDestroy(&is));
655aa21023fSPierre Jolivet       }
656aa21023fSPierre Jolivet     }
657f1580f4eSBarry Smith   }
6583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
659f1580f4eSBarry Smith }
660f1580f4eSBarry Smith 
661d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCPreSolve_HPDDM(PC pc, KSP ksp, Vec, Vec)
662d71ae5a4SJacob Faibussowitsch {
663f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
664f1580f4eSBarry Smith   Mat       A;
665cdbd50ebSPierre Jolivet   PetscBool flg;
666f1580f4eSBarry Smith 
667f1580f4eSBarry Smith   PetscFunctionBegin;
668f1580f4eSBarry Smith   if (ksp) {
669f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPLSQR, &flg));
670f1580f4eSBarry Smith     if (flg && !data->normal) {
671db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(ksp, &A, nullptr));
672db4a47b3SPierre Jolivet       PetscCall(MatCreateVecs(A, nullptr, &data->normal)); /* temporary Vec used in PCApply_HPDDMShell() for coarse grid corrections */
673cdbd50ebSPierre Jolivet     } else if (!flg) {
674cdbd50ebSPierre Jolivet       PetscCall(PetscObjectTypeCompareAny((PetscObject)ksp, &flg, KSPCG, KSPGROPPCG, KSPPIPECG, KSPPIPECGRR, KSPPIPELCG, KSPPIPEPRCG, KSPPIPECG2, KSPSTCG, KSPFCG, KSPPIPEFCG, KSPMINRES, KSPNASH, KSPSYMMLQ, ""));
675cdbd50ebSPierre Jolivet       if (!flg) {
676cdbd50ebSPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPHPDDM, &flg));
677cdbd50ebSPierre Jolivet         if (flg) {
678cdbd50ebSPierre Jolivet           KSPHPDDMType type;
679811e8887SPierre Jolivet 
680cdbd50ebSPierre Jolivet           PetscCall(KSPHPDDMGetType(ksp, &type));
681cdbd50ebSPierre Jolivet           flg = (type == KSP_HPDDM_TYPE_CG || type == KSP_HPDDM_TYPE_BCG || type == KSP_HPDDM_TYPE_BFBCG ? PETSC_TRUE : PETSC_FALSE);
682cdbd50ebSPierre Jolivet         }
683cdbd50ebSPierre Jolivet       }
684cdbd50ebSPierre Jolivet     }
685cdbd50ebSPierre Jolivet     if (flg) {
686cdbd50ebSPierre Jolivet       if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) {
687cdbd50ebSPierre Jolivet         PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_hpddm_coarse_correction", &flg));
688cdbd50ebSPierre 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",
689cdbd50ebSPierre Jolivet                    PCHPDDMCoarseCorrectionTypes[data->correction], ((PetscObject)ksp)->type_name, ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", PCHPDDMCoarseCorrectionTypes[data->correction], PCHPDDMCoarseCorrectionTypes[PC_HPDDM_COARSE_CORRECTION_BALANCED]);
690cdbd50ebSPierre Jolivet       }
691cdbd50ebSPierre Jolivet       for (PetscInt n = 0; n < data->N; ++n) {
692cdbd50ebSPierre Jolivet         if (data->levels[n]->pc) {
693cdbd50ebSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)data->levels[n]->pc, PCASM, &flg));
694cdbd50ebSPierre Jolivet           if (flg) {
695cdbd50ebSPierre Jolivet             PCASMType type;
696811e8887SPierre Jolivet 
697cdbd50ebSPierre Jolivet             PetscCall(PCASMGetType(data->levels[n]->pc, &type));
698cdbd50ebSPierre Jolivet             if (type == PC_ASM_RESTRICT || type == PC_ASM_INTERPOLATE) {
699cdbd50ebSPierre Jolivet               PetscCall(PetscOptionsHasName(((PetscObject)data->levels[n]->pc)->options, ((PetscObject)data->levels[n]->pc)->prefix, "-pc_asm_type", &flg));
700cdbd50ebSPierre 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],
701cdbd50ebSPierre Jolivet                          ((PetscObject)ksp)->type_name, ((PetscObject)data->levels[n]->pc)->prefix, PCASMTypes[type], PCASMTypes[PC_ASM_BASIC]);
702cdbd50ebSPierre Jolivet             }
703cdbd50ebSPierre Jolivet           }
704cdbd50ebSPierre Jolivet         }
705cdbd50ebSPierre Jolivet       }
706f1580f4eSBarry Smith     }
707f1580f4eSBarry Smith   }
7083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
709f1580f4eSBarry Smith }
710f1580f4eSBarry Smith 
711d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDMShell(PC pc)
712d71ae5a4SJacob Faibussowitsch {
713f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
714f1580f4eSBarry Smith   Mat             A, P;
715f1580f4eSBarry Smith   Vec             x;
716f1580f4eSBarry Smith   const char     *pcpre;
717f1580f4eSBarry Smith 
718f1580f4eSBarry Smith   PetscFunctionBegin;
719f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
720f1580f4eSBarry Smith   PetscCall(KSPGetOptionsPrefix(ctx->ksp, &pcpre));
721f1580f4eSBarry Smith   PetscCall(KSPGetOperators(ctx->ksp, &A, &P));
722f1580f4eSBarry Smith   /* smoother */
723f1580f4eSBarry Smith   PetscCall(PCSetOptionsPrefix(ctx->pc, pcpre));
724f1580f4eSBarry Smith   PetscCall(PCSetOperators(ctx->pc, A, P));
725f1580f4eSBarry Smith   if (!ctx->v[0]) {
726f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(ctx->D, 1, &ctx->v[0]));
727f1580f4eSBarry Smith     if (!std::is_same<PetscScalar, PetscReal>::value) PetscCall(VecDestroy(&ctx->D));
728db4a47b3SPierre Jolivet     PetscCall(MatCreateVecs(A, &x, nullptr));
729f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(x, 2, &ctx->v[1]));
730f1580f4eSBarry Smith     PetscCall(VecDestroy(&x));
731f1580f4eSBarry Smith   }
732f1580f4eSBarry Smith   std::fill_n(ctx->V, 3, nullptr);
7333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
734f1580f4eSBarry Smith }
735f1580f4eSBarry Smith 
736f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
737d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type x, Type y)
738d71ae5a4SJacob Faibussowitsch {
739f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
740f1580f4eSBarry Smith   PetscScalar    *out;
741f1580f4eSBarry Smith 
742f1580f4eSBarry Smith   PetscFunctionBegin;
743f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
744f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
745f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
746f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
747f1580f4eSBarry Smith   PetscCall(VecGetArrayWrite(ctx->v[0][0], &out));
748db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, 1); /* y = Q x */
749f1580f4eSBarry Smith   PetscCall(VecRestoreArrayWrite(ctx->v[0][0], &out));
750f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
751f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
752f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
7533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
754f1580f4eSBarry Smith }
755f1580f4eSBarry Smith 
756f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
757d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type X, Type Y)
758d71ae5a4SJacob Faibussowitsch {
759f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
760f1580f4eSBarry Smith   Vec             vX, vY, vC;
761f1580f4eSBarry Smith   PetscScalar    *out;
762811e8887SPierre Jolivet   PetscInt        N;
763f1580f4eSBarry Smith 
764f1580f4eSBarry Smith   PetscFunctionBegin;
765f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
766db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
767f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
768811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
769f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(X, i, &vX));
770f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(ctx->V[0], i, &vC));
771f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
772f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
773f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(ctx->V[0], i, &vC));
774f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(X, i, &vX));
775f1580f4eSBarry Smith   }
776f1580f4eSBarry Smith   PetscCall(MatDenseGetArrayWrite(ctx->V[0], &out));
777db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, N); /* Y = Q X */
778f1580f4eSBarry Smith   PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &out));
779f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
780811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
781f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(ctx->V[0], i, &vC));
782f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(Y, i, &vY));
783f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
784f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
785f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &vY));
786f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(ctx->V[0], i, &vC));
787f1580f4eSBarry Smith   }
7883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
789f1580f4eSBarry Smith }
790f1580f4eSBarry Smith 
791f1580f4eSBarry Smith /*
792aa1539e9SPierre 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.
793f1580f4eSBarry Smith 
794f1580f4eSBarry Smith .vb
795f1580f4eSBarry Smith    (1) y =                Pmat^-1              x + Q x,
796f1580f4eSBarry Smith    (2) y =                Pmat^-1 (I - Amat Q) x + Q x (default),
797aa1539e9SPierre Jolivet    (3) y = (I - Q Amat^T) Pmat^-1 (I - Amat Q) x + Q x,
798aa1539e9SPierre Jolivet    (4) y =                Pmat^-1              x      .
799f1580f4eSBarry Smith .ve
800f1580f4eSBarry Smith 
801f1580f4eSBarry Smith    Input Parameters:
802f1580f4eSBarry Smith +     pc - preconditioner context
803f1580f4eSBarry Smith -     x - input vector
804f1580f4eSBarry Smith 
805f1580f4eSBarry Smith    Output Parameter:
806f1580f4eSBarry Smith .     y - output vector
807f1580f4eSBarry Smith 
808f1580f4eSBarry Smith    Notes:
809f1580f4eSBarry 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.
810f1580f4eSBarry 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.
811f1580f4eSBarry 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.
812f1580f4eSBarry Smith 
813f1580f4eSBarry Smith    Level: advanced
814f1580f4eSBarry Smith 
815f1580f4eSBarry Smith    Developer Note:
816f1580f4eSBarry 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
817f1580f4eSBarry Smith    to trigger it. Likely the manual page is `PCHPDDM`
818f1580f4eSBarry Smith 
819562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
820f1580f4eSBarry Smith */
821d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDMShell(PC pc, Vec x, Vec y)
822d71ae5a4SJacob Faibussowitsch {
823f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
824f1580f4eSBarry Smith   Mat             A;
825f1580f4eSBarry Smith 
826f1580f4eSBarry Smith   PetscFunctionBegin;
827f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
828f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
829db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
830aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApply(ctx->pc, x, y)); /* y = M^-1 x */
831aa1539e9SPierre Jolivet   else {
832f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, x, y)); /* y = Q x */
833f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
834f1580f4eSBarry Smith       if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMult(A, y, ctx->v[1][0])); /* y = A Q x     */
835f1580f4eSBarry Smith       else { /* KSPLSQR and finest level */ PetscCall(MatMult(A, y, ctx->parent->normal));               /* y = A Q x     */
836f1580f4eSBarry Smith         PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][0]));                      /* y = A^T A Q x */
837f1580f4eSBarry Smith       }
838f1580f4eSBarry Smith       PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x)); /* y = (I - A Q) x                             */
839f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, ctx->v[1][1], ctx->v[1][0]));  /* y = M^-1 (I - A Q) x                        */
840f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
841f1580f4eSBarry 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 */
842f1580f4eSBarry Smith         else {
843f1580f4eSBarry Smith           PetscCall(MatMult(A, ctx->v[1][0], ctx->parent->normal));
844f1580f4eSBarry Smith           PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][1])); /* z = A^T A y           */
845f1580f4eSBarry Smith         }
846f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->v[1][1], ctx->v[1][1]));
847f1580f4eSBarry Smith         PetscCall(VecAXPBYPCZ(y, -1.0, 1.0, 1.0, ctx->v[1][1], ctx->v[1][0])); /* y = (I - Q A^T) y + Q x      */
848f1580f4eSBarry Smith       } else PetscCall(VecAXPY(y, 1.0, ctx->v[1][0]));                         /* y = Q M^-1 (I - A Q) x + Q x */
849f1580f4eSBarry Smith     } else {
850f1580f4eSBarry 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);
851f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, x, ctx->v[1][0]));
852f1580f4eSBarry Smith       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-1 x + Q x */
853f1580f4eSBarry Smith     }
854aa1539e9SPierre Jolivet   }
8553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
856f1580f4eSBarry Smith }
857f1580f4eSBarry Smith 
858f1580f4eSBarry Smith /*
859f1580f4eSBarry Smith      PCMatApply_HPDDMShell - Variant of PCApply_HPDDMShell() for blocks of vectors.
860f1580f4eSBarry Smith 
861f1580f4eSBarry Smith    Input Parameters:
862f1580f4eSBarry Smith +     pc - preconditioner context
863f1580f4eSBarry Smith -     X - block of input vectors
864f1580f4eSBarry Smith 
865f1580f4eSBarry Smith    Output Parameter:
866f1580f4eSBarry Smith .     Y - block of output vectors
867f1580f4eSBarry Smith 
868f1580f4eSBarry Smith    Level: advanced
869f1580f4eSBarry Smith 
870562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
871f1580f4eSBarry Smith */
872d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDMShell(PC pc, Mat X, Mat Y)
873d71ae5a4SJacob Faibussowitsch {
874f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
875f1580f4eSBarry Smith   Mat             A, *ptr;
876db4a47b3SPierre Jolivet   PetscContainer  container = nullptr;
877f1580f4eSBarry Smith   PetscScalar    *array;
878f1580f4eSBarry Smith   PetscInt        m, M, N, prev = 0;
879f1580f4eSBarry Smith   PetscBool       reset = PETSC_FALSE;
880f1580f4eSBarry Smith 
881f1580f4eSBarry Smith   PetscFunctionBegin;
882f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
883f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
884db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
885db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
886aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApply(ctx->pc, X, Y));
887aa1539e9SPierre Jolivet   else {
888f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)A, "_HPDDM_MatProduct", (PetscObject *)&container));
889f1580f4eSBarry Smith     if (container) { /* MatProduct container already attached */
890f1580f4eSBarry Smith       PetscCall(PetscContainerGetPointer(container, (void **)&ptr));
891f1580f4eSBarry Smith       if (ptr[1] != ctx->V[2]) /* Mat has changed or may have been set first in KSPHPDDM */
892f1580f4eSBarry Smith         for (m = 0; m < 2; ++m) {
893f1580f4eSBarry Smith           PetscCall(MatDestroy(ctx->V + m + 1));
894f1580f4eSBarry Smith           ctx->V[m + 1] = ptr[m];
895f1580f4eSBarry Smith           PetscCall(PetscObjectReference((PetscObject)ctx->V[m + 1]));
896f1580f4eSBarry Smith         }
897f1580f4eSBarry Smith     }
898db4a47b3SPierre Jolivet     if (ctx->V[1]) PetscCall(MatGetSize(ctx->V[1], nullptr, &prev));
899f1580f4eSBarry Smith     if (N != prev || !ctx->V[0]) {
900f1580f4eSBarry Smith       PetscCall(MatDestroy(ctx->V));
901f1580f4eSBarry Smith       PetscCall(VecGetLocalSize(ctx->v[0][0], &m));
902db4a47b3SPierre Jolivet       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, PETSC_DECIDE, N, nullptr, ctx->V));
903f1580f4eSBarry Smith       if (N != prev) {
904f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 1));
905f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 2));
906db4a47b3SPierre Jolivet         PetscCall(MatGetLocalSize(X, &m, nullptr));
907db4a47b3SPierre Jolivet         PetscCall(MatGetSize(X, &M, nullptr));
908f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
909db4a47b3SPierre Jolivet         else array = nullptr;
910f1580f4eSBarry Smith         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, array, ctx->V + 1));
911f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
912db4a47b3SPierre Jolivet         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, nullptr, ctx->V + 2));
913db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, Y, nullptr, ctx->V[1]));
914f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[1], MATPRODUCT_AB));
915f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[1]));
916f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[1]));
917715c1178SPierre Jolivet         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() */
918715c1178SPierre Jolivet         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 */
919f1580f4eSBarry Smith       }
920f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
921db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, ctx->V[1], nullptr, ctx->V[2]));
922f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[2], MATPRODUCT_AtB));
923f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[2]));
924f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[2]));
925f1580f4eSBarry Smith       }
926f1580f4eSBarry Smith       ctx->P->start(N);
927f1580f4eSBarry Smith     }
928f1580f4eSBarry Smith     if (N == prev || container) { /* when MatProduct container is attached, always need to MatProductReplaceMats() since KSPHPDDM may have replaced the Mat as well */
929db4a47b3SPierre Jolivet       PetscCall(MatProductReplaceMats(nullptr, Y, nullptr, ctx->V[1]));
930f1580f4eSBarry Smith       if (container && ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) {
931f1580f4eSBarry Smith         PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
932f1580f4eSBarry Smith         PetscCall(MatDensePlaceArray(ctx->V[1], array));
933f1580f4eSBarry Smith         PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
934f1580f4eSBarry Smith         reset = PETSC_TRUE;
935f1580f4eSBarry Smith       }
936f1580f4eSBarry Smith     }
937f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, X, Y));
938f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
939f1580f4eSBarry Smith       PetscCall(MatProductNumeric(ctx->V[1]));
940f1580f4eSBarry Smith       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
941f1580f4eSBarry Smith       PetscCall(MatAXPY(ctx->V[2], -1.0, X, SAME_NONZERO_PATTERN));
942f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, ctx->V[2], ctx->V[1]));
943f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
944f1580f4eSBarry Smith         PetscCall(MatProductNumeric(ctx->V[2]));
945f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->V[2], ctx->V[2]));
946f1580f4eSBarry Smith         PetscCall(MatAXPY(ctx->V[1], -1.0, ctx->V[2], SAME_NONZERO_PATTERN));
947f1580f4eSBarry Smith       }
948f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
949f1580f4eSBarry Smith     } else {
950f1580f4eSBarry 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);
951f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, X, ctx->V[1]));
952f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
953f1580f4eSBarry Smith     }
954f1580f4eSBarry Smith     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
955aa1539e9SPierre Jolivet   }
9563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
957f1580f4eSBarry Smith }
958f1580f4eSBarry Smith 
959d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDMShell(PC pc)
960d71ae5a4SJacob Faibussowitsch {
961f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
962f1580f4eSBarry Smith 
963f1580f4eSBarry Smith   PetscFunctionBegin;
964f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
965f1580f4eSBarry Smith   PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(ctx, PETSC_TRUE));
966f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(1, &ctx->v[0]));
967f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(2, &ctx->v[1]));
968f4f49eeaSPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", nullptr));
969f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V));
970f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 1));
971f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 2));
972f1580f4eSBarry Smith   PetscCall(VecDestroy(&ctx->D));
97301e3c840SPierre Jolivet   PetscCall(PetscSFDestroy(&ctx->scatter));
974f1580f4eSBarry Smith   PetscCall(PCDestroy(&ctx->pc));
9753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
976f1580f4eSBarry Smith }
977f1580f4eSBarry Smith 
9789bb5c669SPierre Jolivet template <class Type, bool T = false, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
9799bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type x, Type y)
9809bb5c669SPierre Jolivet {
9819bb5c669SPierre Jolivet   PetscFunctionBegin;
9829bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[0], std::get<1>(*p), SCATTER_FORWARD, x));
9839bb5c669SPierre Jolivet   if (!T) PetscCall(PCApply(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
9849bb5c669SPierre Jolivet   else PetscCall(PCApplyTranspose(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
9859bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[1], std::get<1>(*p), SCATTER_REVERSE, y));
9869bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9879bb5c669SPierre Jolivet }
9889bb5c669SPierre Jolivet 
9899bb5c669SPierre Jolivet template <class Type, bool = false, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
9909bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type X, Type Y)
9919bb5c669SPierre Jolivet {
9929bb5c669SPierre Jolivet   Mat B[2];
9939bb5c669SPierre Jolivet   Vec x, y;
9949bb5c669SPierre Jolivet 
9959bb5c669SPierre Jolivet   PetscFunctionBegin;
9969bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B));
9979bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B + 1));
9989bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
9999bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(X, i, &x));
10009bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B[0], i, &y));
10019bb5c669SPierre Jolivet     PetscCall(VecISCopy(y, std::get<1>(*p), SCATTER_FORWARD, x));
10029bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B[0], i, &y));
10039bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(X, i, &x));
10049bb5c669SPierre Jolivet   }
10059bb5c669SPierre Jolivet   PetscCall(PCMatApply(factor, B[0], B[1]));
10069bb5c669SPierre Jolivet   PetscCall(MatDestroy(B));
10079bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
10089bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B[1], i, &x));
10099bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &y));
10109bb5c669SPierre Jolivet     PetscCall(VecISCopy(x, std::get<1>(*p), SCATTER_REVERSE, y));
10119bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &y));
10129bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B[1], i, &x));
10139bb5c669SPierre Jolivet   }
10149bb5c669SPierre Jolivet   PetscCall(MatDestroy(B + 1));
10159bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10169bb5c669SPierre Jolivet }
10179bb5c669SPierre Jolivet 
10189bb5c669SPierre Jolivet template <class Type = Vec, bool T = false>
10199bb5c669SPierre Jolivet static PetscErrorCode PCApply_Schur(PC pc, Type x, Type y)
10209bb5c669SPierre Jolivet {
10219bb5c669SPierre Jolivet   PC                           factor;
10229bb5c669SPierre Jolivet   Mat                          A;
10239bb5c669SPierre Jolivet   MatSolverType                type;
10249bb5c669SPierre Jolivet   PetscBool                    flg;
10259bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
10269bb5c669SPierre Jolivet 
10279bb5c669SPierre Jolivet   PetscFunctionBegin;
10289bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
10299bb5c669SPierre Jolivet   PetscCall(KSPGetPC(std::get<0>(*p), &factor));
10309bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(factor, &type));
10319bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatrix(factor, &A));
10329bb5c669SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
10339bb5c669SPierre Jolivet   if (flg) {
10349bb5c669SPierre Jolivet     PetscCheck(PetscDefined(HAVE_MUMPS), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
10359bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 0));
10369bb5c669SPierre Jolivet   } else {
10379bb5c669SPierre Jolivet     PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &flg));
10389bb5c669SPierre Jolivet     PetscCheck(flg && PetscDefined(HAVE_MKL_PARDISO), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
10399bb5c669SPierre Jolivet     flg = PETSC_FALSE;
10409bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
10419bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 1));
10429bb5c669SPierre Jolivet #endif
10439bb5c669SPierre Jolivet   }
10449bb5c669SPierre Jolivet   PetscCall(PCApply_Schur_Private<Type, T>(p, factor, x, y));
10459bb5c669SPierre Jolivet   if (flg) {
10469bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1));
10479bb5c669SPierre Jolivet   } else {
10489bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
10499bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 0));
10509bb5c669SPierre Jolivet #endif
10519bb5c669SPierre Jolivet   }
10529bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10539bb5c669SPierre Jolivet }
10549bb5c669SPierre Jolivet 
10559bb5c669SPierre Jolivet static PetscErrorCode PCDestroy_Schur(PC pc)
10569bb5c669SPierre Jolivet {
10579bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
10589bb5c669SPierre Jolivet 
10599bb5c669SPierre Jolivet   PetscFunctionBegin;
10609bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
10619bb5c669SPierre Jolivet   PetscCall(ISDestroy(&std::get<1>(*p)));
10629bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p)));
10639bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p) + 1));
10649bb5c669SPierre Jolivet   PetscCall(PetscFree(p));
10659bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10669bb5c669SPierre Jolivet }
10679bb5c669SPierre Jolivet 
1068d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSolve_Private(const PC_HPDDM_Level *ctx, PetscScalar *rhs, const unsigned short &mu)
1069d71ae5a4SJacob Faibussowitsch {
1070f1580f4eSBarry Smith   Mat      B, X;
1071f1580f4eSBarry Smith   PetscInt n, N, j = 0;
1072f1580f4eSBarry Smith 
1073f1580f4eSBarry Smith   PetscFunctionBegin;
1074db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &B, nullptr));
1075db4a47b3SPierre Jolivet   PetscCall(MatGetLocalSize(B, &n, nullptr));
1076db4a47b3SPierre Jolivet   PetscCall(MatGetSize(B, &N, nullptr));
1077f1580f4eSBarry Smith   if (ctx->parent->log_separate) {
1078f1580f4eSBarry Smith     j = std::distance(ctx->parent->levels, std::find(ctx->parent->levels, ctx->parent->levels + ctx->parent->N, ctx));
1079db4a47b3SPierre Jolivet     PetscCall(PetscLogEventBegin(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
1080f1580f4eSBarry Smith   }
1081f1580f4eSBarry Smith   if (mu == 1) {
1082f1580f4eSBarry Smith     if (!ctx->ksp->vec_rhs) {
1083db4a47b3SPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ctx->ksp), 1, n, N, nullptr, &ctx->ksp->vec_rhs));
1084f1580f4eSBarry Smith       PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)ctx->ksp), n, N, &ctx->ksp->vec_sol));
1085f1580f4eSBarry Smith     }
1086f1580f4eSBarry Smith     PetscCall(VecPlaceArray(ctx->ksp->vec_rhs, rhs));
1087db4a47b3SPierre Jolivet     PetscCall(KSPSolve(ctx->ksp, nullptr, nullptr));
1088f1580f4eSBarry Smith     PetscCall(VecCopy(ctx->ksp->vec_sol, ctx->ksp->vec_rhs));
1089f1580f4eSBarry Smith     PetscCall(VecResetArray(ctx->ksp->vec_rhs));
1090f1580f4eSBarry Smith   } else {
1091f1580f4eSBarry Smith     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, rhs, &B));
1092db4a47b3SPierre Jolivet     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, nullptr, &X));
1093f1580f4eSBarry Smith     PetscCall(KSPMatSolve(ctx->ksp, B, X));
1094f1580f4eSBarry Smith     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
1095f1580f4eSBarry Smith     PetscCall(MatDestroy(&X));
1096f1580f4eSBarry Smith     PetscCall(MatDestroy(&B));
1097f1580f4eSBarry Smith   }
1098db4a47b3SPierre Jolivet   if (ctx->parent->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
10993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1100f1580f4eSBarry Smith }
1101f1580f4eSBarry Smith 
1102d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetUpNeumannOverlap_Private(PC pc)
1103d71ae5a4SJacob Faibussowitsch {
1104f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
1105f1580f4eSBarry Smith 
1106f1580f4eSBarry Smith   PetscFunctionBegin;
1107f1580f4eSBarry Smith   if (data->setup) {
1108f1580f4eSBarry Smith     Mat       P;
1109db4a47b3SPierre Jolivet     Vec       x, xt = nullptr;
1110f1580f4eSBarry Smith     PetscReal t = 0.0, s = 0.0;
1111f1580f4eSBarry Smith 
1112db4a47b3SPierre Jolivet     PetscCall(PCGetOperators(pc, nullptr, &P));
1113f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)P, "__SNES_latest_X", (PetscObject *)&x));
1114f1580f4eSBarry Smith     PetscCallBack("PCHPDDM Neumann callback", (*data->setup)(data->aux, t, x, xt, s, data->is, data->setup_ctx));
1115f1580f4eSBarry Smith   }
11163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1117f1580f4eSBarry Smith }
1118f1580f4eSBarry Smith 
1119d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCreateSubMatrices_Private(Mat mat, PetscInt n, const IS *, const IS *, MatReuse scall, Mat *submat[])
1120d71ae5a4SJacob Faibussowitsch {
1121f1580f4eSBarry Smith   Mat       A;
112213044ca3SPierre Jolivet   PetscBool flg;
1123f1580f4eSBarry Smith 
1124f1580f4eSBarry Smith   PetscFunctionBegin;
1125f1580f4eSBarry Smith   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatCreateSubMatrices() called to extract %" PetscInt_FMT " submatrices, which is different than 1", n);
1126f1580f4eSBarry Smith   /* previously composed Mat */
1127f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)mat, "_PCHPDDM_SubMatrices", (PetscObject *)&A));
1128f1580f4eSBarry Smith   PetscCheck(A, PETSC_COMM_SELF, PETSC_ERR_PLIB, "SubMatrices not found in Mat");
112913044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSCHURCOMPLEMENT, &flg)); /* MATSCHURCOMPLEMENT has neither a MatDuplicate() nor a MatCopy() implementation */
1130f1580f4eSBarry Smith   if (scall == MAT_INITIAL_MATRIX) {
11316f2c871aSStefano Zampini     PetscCall(PetscCalloc1(2, submat)); /* allocate an extra Mat to avoid errors in MatDestroySubMatrices_Dummy() */
113213044ca3SPierre Jolivet     if (!flg) PetscCall(MatDuplicate(A, MAT_COPY_VALUES, *submat));
113313044ca3SPierre Jolivet   } else if (!flg) PetscCall(MatCopy(A, (*submat)[0], SAME_NONZERO_PATTERN));
113413044ca3SPierre Jolivet   if (flg) {
1135bf583f0cSPierre Jolivet     PetscCall(MatDestroy(*submat)); /* previously created Mat has to be destroyed */
113613044ca3SPierre Jolivet     (*submat)[0] = A;
113713044ca3SPierre Jolivet     PetscCall(PetscObjectReference((PetscObject)A));
113813044ca3SPierre Jolivet   }
11393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1140f1580f4eSBarry Smith }
1141f1580f4eSBarry Smith 
1142d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCommunicationAvoidingPCASM_Private(PC pc, Mat C, PetscBool sorted)
1143d71ae5a4SJacob Faibussowitsch {
1144f1580f4eSBarry Smith   void (*op)(void);
1145f1580f4eSBarry Smith 
1146f1580f4eSBarry Smith   PetscFunctionBegin;
1147f1580f4eSBarry Smith   /* previously-composed Mat */
1148f1580f4eSBarry Smith   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", (PetscObject)C));
1149f1580f4eSBarry Smith   PetscCall(MatGetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, &op));
1150f1580f4eSBarry Smith   /* trick suggested by Barry https://lists.mcs.anl.gov/pipermail/petsc-dev/2020-January/025491.html */
1151f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, (void (*)(void))PCHPDDMCreateSubMatrices_Private));
1152f1580f4eSBarry Smith   if (sorted) PetscCall(PCASMSetSortIndices(pc, PETSC_FALSE)); /* everything is already sorted */
1153f1580f4eSBarry Smith   PetscCall(PCSetFromOptions(pc));                             /* otherwise -pc_hpddm_levels_1_pc_asm_sub_mat_type is not used */
1154f1580f4eSBarry Smith   PetscCall(PCSetUp(pc));
1155f1580f4eSBarry Smith   /* reset MatCreateSubMatrices() */
1156f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, op));
1157db4a47b3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", nullptr));
11583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1159f1580f4eSBarry Smith }
1160f1580f4eSBarry Smith 
1161d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMPermute_Private(IS is, IS in_is, IS *out_is, Mat in_C, Mat *out_C, IS *p)
1162d71ae5a4SJacob Faibussowitsch {
1163f1580f4eSBarry Smith   IS                           perm;
1164f1580f4eSBarry Smith   const PetscInt              *ptr;
1165811e8887SPierre Jolivet   PetscInt                    *concatenate, size, bs;
1166f1580f4eSBarry Smith   std::map<PetscInt, PetscInt> order;
1167f1580f4eSBarry Smith   PetscBool                    sorted;
1168f1580f4eSBarry Smith 
1169f1580f4eSBarry Smith   PetscFunctionBegin;
1170cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(is, IS_CLASSID, 1);
1171cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(in_C, MAT_CLASSID, 4);
1172f1580f4eSBarry Smith   PetscCall(ISSorted(is, &sorted));
1173f1580f4eSBarry Smith   if (!sorted) {
1174f1580f4eSBarry Smith     PetscCall(ISGetLocalSize(is, &size));
1175f1580f4eSBarry Smith     PetscCall(ISGetIndices(is, &ptr));
1176b07dfdedSPierre Jolivet     PetscCall(ISGetBlockSize(is, &bs));
1177f1580f4eSBarry Smith     /* MatCreateSubMatrices(), called by PCASM, follows the global numbering of Pmat */
1178811e8887SPierre Jolivet     for (PetscInt n = 0; n < size; n += bs) order.insert(std::make_pair(ptr[n] / bs, n / bs));
1179f1580f4eSBarry Smith     PetscCall(ISRestoreIndices(is, &ptr));
1180b07dfdedSPierre Jolivet     size /= bs;
1181f1580f4eSBarry Smith     if (out_C) {
1182f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1183f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.second;
1184f1580f4eSBarry Smith       concatenate -= size;
1185b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_C), bs, size, concatenate, PETSC_OWN_POINTER, &perm));
1186f1580f4eSBarry Smith       PetscCall(ISSetPermutation(perm));
1187f1580f4eSBarry Smith       /* permute user-provided Mat so that it matches with MatCreateSubMatrices() numbering */
1188f1580f4eSBarry Smith       PetscCall(MatPermute(in_C, perm, perm, out_C));
1189f1580f4eSBarry Smith       if (p) *p = perm;
1190f1580f4eSBarry Smith       else PetscCall(ISDestroy(&perm)); /* no need to save the permutation */
1191f1580f4eSBarry Smith     }
1192f1580f4eSBarry Smith     if (out_is) {
1193f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1194f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.first;
1195f1580f4eSBarry Smith       concatenate -= size;
1196f1580f4eSBarry Smith       /* permute user-provided IS so that it matches with MatCreateSubMatrices() numbering */
1197b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_is), bs, size, concatenate, PETSC_OWN_POINTER, out_is));
1198f1580f4eSBarry Smith     }
1199f1580f4eSBarry Smith   } else { /* input IS is sorted, nothing to permute, simply duplicate inputs when needed */
1200f1580f4eSBarry Smith     if (out_C) PetscCall(MatDuplicate(in_C, MAT_COPY_VALUES, out_C));
1201f1580f4eSBarry Smith     if (out_is) PetscCall(ISDuplicate(in_is, out_is));
1202f1580f4eSBarry Smith   }
12033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1204f1580f4eSBarry Smith }
1205f1580f4eSBarry Smith 
1206281f8ce6SPierre Jolivet static PetscErrorCode PCHPDDMCheckSymmetry_Private(PC pc, Mat A01, Mat A10, Mat *B01 = nullptr)
120713044ca3SPierre Jolivet {
120813044ca3SPierre Jolivet   Mat       T, U = nullptr, B = nullptr;
120913044ca3SPierre Jolivet   IS        z;
1210281f8ce6SPierre Jolivet   PetscBool flg, conjugate = PETSC_FALSE;
121113044ca3SPierre Jolivet 
121213044ca3SPierre Jolivet   PetscFunctionBegin;
1213281f8ce6SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
1214281f8ce6SPierre Jolivet   if (B01) *B01 = nullptr;
1215281f8ce6SPierre Jolivet   if (flg) {
1216811e8887SPierre 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));
1217811e8887SPierre Jolivet     PetscCall(MatTransposeGetMat(A10, &U));
1218811e8887SPierre Jolivet   } else {
1219281f8ce6SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
1220281f8ce6SPierre Jolivet     if (flg) {
1221811e8887SPierre 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));
1222811e8887SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A10, &U));
1223281f8ce6SPierre Jolivet       conjugate = PETSC_TRUE;
1224811e8887SPierre Jolivet     }
122513044ca3SPierre Jolivet   }
122613044ca3SPierre Jolivet   if (U) PetscCall(MatDuplicate(U, MAT_COPY_VALUES, &T));
122713044ca3SPierre Jolivet   else PetscCall(MatHermitianTranspose(A10, MAT_INITIAL_MATRIX, &T));
1228281f8ce6SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATTRANSPOSEVIRTUAL, &flg));
1229281f8ce6SPierre Jolivet   if (flg) {
1230811e8887SPierre 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));
123113044ca3SPierre Jolivet     PetscCall(MatTransposeGetMat(A01, &A01));
123213044ca3SPierre Jolivet     PetscCall(MatTranspose(A01, MAT_INITIAL_MATRIX, &B));
123313044ca3SPierre Jolivet     A01 = B;
123413044ca3SPierre Jolivet   } else {
1235281f8ce6SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
1236281f8ce6SPierre Jolivet     if (flg) {
1237811e8887SPierre 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));
123813044ca3SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A01, &A01));
123913044ca3SPierre Jolivet       PetscCall(MatHermitianTranspose(A01, MAT_INITIAL_MATRIX, &B));
124013044ca3SPierre Jolivet       A01 = B;
124113044ca3SPierre Jolivet     }
124213044ca3SPierre Jolivet   }
1243281f8ce6SPierre Jolivet   PetscCall(PetscLayoutCompare(T->rmap, A01->rmap, &flg));
1244281f8ce6SPierre Jolivet   if (flg) {
1245281f8ce6SPierre Jolivet     PetscCall(PetscLayoutCompare(T->cmap, A01->cmap, &flg));
1246281f8ce6SPierre Jolivet     if (flg) {
124713044ca3SPierre Jolivet       PetscCall(MatFindZeroRows(A01, &z)); /* for essential boundary conditions, some implementations will */
124813044ca3SPierre Jolivet       if (z) {                             /*  zero rows in [P00 A01] except for the diagonal of P00       */
1249281f8ce6SPierre Jolivet         if (B01) PetscCall(MatDuplicate(T, MAT_COPY_VALUES, B01));
125013044ca3SPierre Jolivet         PetscCall(MatSetOption(T, MAT_NO_OFF_PROC_ZERO_ROWS, PETSC_TRUE));
125113044ca3SPierre Jolivet         PetscCall(MatZeroRowsIS(T, z, 0.0, nullptr, nullptr)); /* corresponding zero rows from A01 */
1252281f8ce6SPierre Jolivet       }
1253281f8ce6SPierre Jolivet       PetscCall(MatMultEqual(A01, T, 20, &flg));
1254281f8ce6SPierre Jolivet       if (!B01) PetscCheck(flg, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "A01 != A10^T");
1255281f8ce6SPierre Jolivet       else {
1256281f8ce6SPierre Jolivet         PetscCall(PetscInfo(pc, "A01 and A10^T are equal? %s\n", PetscBools[flg]));
1257281f8ce6SPierre Jolivet         if (!flg) {
1258281f8ce6SPierre Jolivet           if (z) PetscCall(MatDestroy(&T));
1259281f8ce6SPierre Jolivet           else *B01 = T;
1260281f8ce6SPierre Jolivet           flg = PETSC_TRUE;
1261281f8ce6SPierre Jolivet         } else PetscCall(MatDestroy(B01));
1262281f8ce6SPierre Jolivet       }
126313044ca3SPierre Jolivet       PetscCall(ISDestroy(&z));
126413044ca3SPierre Jolivet     }
126513044ca3SPierre Jolivet   }
1266281f8ce6SPierre Jolivet   if (!flg) PetscCall(PetscInfo(pc, "A01 and A10^T have non-congruent layouts, cannot test for equality\n"));
1267281f8ce6SPierre Jolivet   if (!B01 || !*B01) PetscCall(MatDestroy(&T));
1268281f8ce6SPierre Jolivet   else if (conjugate) PetscCall(MatConjugate(T));
126913044ca3SPierre Jolivet   PetscCall(MatDestroy(&B));
127013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
127113044ca3SPierre Jolivet }
127213044ca3SPierre Jolivet 
1273d16c0b94SPierre Jolivet static PetscErrorCode PCHPDDMCheckInclusion_Private(PC pc, IS is, IS is_local, PetscBool check)
1274d16c0b94SPierre Jolivet {
1275d16c0b94SPierre Jolivet   IS          intersect;
1276d16c0b94SPierre Jolivet   const char *str = "IS of the auxiliary Mat does not include all local rows of A";
1277d16c0b94SPierre Jolivet   PetscBool   equal;
1278d16c0b94SPierre Jolivet 
1279d16c0b94SPierre Jolivet   PetscFunctionBegin;
1280d16c0b94SPierre Jolivet   PetscCall(ISIntersect(is, is_local, &intersect));
1281d16c0b94SPierre Jolivet   PetscCall(ISEqualUnsorted(is_local, intersect, &equal));
1282d16c0b94SPierre Jolivet   PetscCall(ISDestroy(&intersect));
1283d16c0b94SPierre Jolivet   if (check) PetscCheck(equal, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "%s", str);
1284d16c0b94SPierre Jolivet   else if (!equal) PetscCall(PetscInfo(pc, "%s\n", str));
1285d16c0b94SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1286d16c0b94SPierre Jolivet }
1287d16c0b94SPierre Jolivet 
1288d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMDestroySubMatrices_Private(PetscBool flg, PetscBool algebraic, Mat *sub)
1289d71ae5a4SJacob Faibussowitsch {
1290f1580f4eSBarry Smith   IS is;
1291f1580f4eSBarry Smith 
1292f1580f4eSBarry Smith   PetscFunctionBegin;
1293f1580f4eSBarry Smith   if (!flg) {
1294f1580f4eSBarry Smith     if (algebraic) {
1295f1580f4eSBarry Smith       PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Embed", (PetscObject *)&is));
1296f1580f4eSBarry Smith       PetscCall(ISDestroy(&is));
1297db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Embed", nullptr));
1298db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Compact", nullptr));
1299f1580f4eSBarry Smith     }
1300f1580f4eSBarry Smith     PetscCall(MatDestroySubMatrices(algebraic ? 2 : 1, &sub));
1301f1580f4eSBarry Smith   }
13023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1303f1580f4eSBarry Smith }
1304f1580f4eSBarry Smith 
1305d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMAlgebraicAuxiliaryMat_Private(Mat P, IS *is, Mat *sub[], PetscBool block)
1306d71ae5a4SJacob Faibussowitsch {
1307f1580f4eSBarry Smith   IS         icol[3], irow[2];
1308f1580f4eSBarry Smith   Mat       *M, Q;
1309f1580f4eSBarry Smith   PetscReal *ptr;
131058b7e2c1SStefano Zampini   PetscInt  *idx, p = 0, bs = P->cmap->bs;
1311f1580f4eSBarry Smith   PetscBool  flg;
1312f1580f4eSBarry Smith 
1313f1580f4eSBarry Smith   PetscFunctionBegin;
1314f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, P->cmap->N, 0, 1, icol + 2));
1315f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(icol[2], bs));
1316f1580f4eSBarry Smith   PetscCall(ISSetIdentity(icol[2]));
1317f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1318f1580f4eSBarry Smith   if (flg) {
1319f1580f4eSBarry Smith     /* MatCreateSubMatrices() does not handle MATMPISBAIJ properly when iscol != isrow, so convert first to MATMPIBAIJ */
1320f1580f4eSBarry Smith     PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &Q));
1321f1580f4eSBarry Smith     std::swap(P, Q);
1322f1580f4eSBarry Smith   }
1323f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(P, 1, is, icol + 2, MAT_INITIAL_MATRIX, &M));
1324f1580f4eSBarry Smith   if (flg) {
1325f1580f4eSBarry Smith     std::swap(P, Q);
1326f1580f4eSBarry Smith     PetscCall(MatDestroy(&Q));
1327f1580f4eSBarry Smith   }
1328f1580f4eSBarry Smith   PetscCall(ISDestroy(icol + 2));
1329f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, M[0]->rmap->N, 0, 1, irow));
1330f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(irow[0], bs));
1331f1580f4eSBarry Smith   PetscCall(ISSetIdentity(irow[0]));
1332f1580f4eSBarry Smith   if (!block) {
1333b07dfdedSPierre Jolivet     PetscCall(PetscMalloc2(P->cmap->N, &ptr, P->cmap->N / bs, &idx));
1334f1580f4eSBarry Smith     PetscCall(MatGetColumnNorms(M[0], NORM_INFINITY, ptr));
1335f1580f4eSBarry Smith     /* check for nonzero columns so that M[0] may be expressed in compact form */
1336811e8887SPierre Jolivet     for (PetscInt n = 0; n < P->cmap->N; n += bs) {
1337b07dfdedSPierre Jolivet       if (std::find_if(ptr + n, ptr + n + bs, [](PetscReal v) { return v > PETSC_MACHINE_EPSILON; }) != ptr + n + bs) idx[p++] = n / bs;
1338f1580f4eSBarry Smith     }
1339b07dfdedSPierre Jolivet     PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, p, idx, PETSC_USE_POINTER, icol + 1));
1340f1580f4eSBarry Smith     PetscCall(ISSetInfo(icol[1], IS_SORTED, IS_GLOBAL, PETSC_TRUE, PETSC_TRUE));
1341f1580f4eSBarry Smith     PetscCall(ISEmbed(*is, icol[1], PETSC_FALSE, icol + 2));
1342f1580f4eSBarry Smith     irow[1] = irow[0];
1343f1580f4eSBarry 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 */
1344f1580f4eSBarry Smith     icol[0] = is[0];
1345f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 2, irow, icol, MAT_INITIAL_MATRIX, sub));
1346f1580f4eSBarry Smith     PetscCall(ISDestroy(icol + 1));
1347f1580f4eSBarry Smith     PetscCall(PetscFree2(ptr, idx));
1348f1580f4eSBarry Smith     /* IS used to go back and forth between the augmented and the original local linear system, see eq. (3.4) of [2022b] */
1349f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Embed", (PetscObject)icol[2]));
1350f1580f4eSBarry Smith     /* Mat used in eq. (3.1) of [2022b] */
1351f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Compact", (PetscObject)(*sub)[1]));
1352f1580f4eSBarry Smith   } else {
1353f1580f4eSBarry Smith     Mat aux;
1354811e8887SPierre Jolivet 
1355f1580f4eSBarry Smith     PetscCall(MatSetOption(M[0], MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1356f1580f4eSBarry Smith     /* diagonal block of the overlapping rows */
1357f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 1, irow, is, MAT_INITIAL_MATRIX, sub));
1358f1580f4eSBarry Smith     PetscCall(MatDuplicate((*sub)[0], MAT_COPY_VALUES, &aux));
1359f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1360f1580f4eSBarry Smith     if (bs == 1) { /* scalar case */
1361f1580f4eSBarry Smith       Vec sum[2];
1362811e8887SPierre Jolivet 
1363f1580f4eSBarry Smith       PetscCall(MatCreateVecs(aux, sum, sum + 1));
1364f1580f4eSBarry Smith       PetscCall(MatGetRowSum(M[0], sum[0]));
1365f1580f4eSBarry Smith       PetscCall(MatGetRowSum(aux, sum[1]));
1366f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1367f1580f4eSBarry Smith       PetscCall(VecAXPY(sum[0], -1.0, sum[1]));
1368f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1369f1580f4eSBarry Smith       PetscCall(MatDiagonalSet(aux, sum[0], ADD_VALUES));
1370f1580f4eSBarry Smith       PetscCall(VecDestroy(sum));
1371f1580f4eSBarry Smith       PetscCall(VecDestroy(sum + 1));
1372f1580f4eSBarry Smith     } else { /* vectorial case */
1373f1580f4eSBarry Smith       /* TODO: missing MatGetValuesBlocked(), so the code below is     */
1374f1580f4eSBarry Smith       /* an extension of the scalar case for when bs > 1, but it could */
1375f1580f4eSBarry Smith       /* be more efficient by avoiding all these MatMatMult()          */
1376f1580f4eSBarry Smith       Mat          sum[2], ones;
1377f1580f4eSBarry Smith       PetscScalar *ptr;
1378811e8887SPierre Jolivet 
1379f1580f4eSBarry Smith       PetscCall(PetscCalloc1(M[0]->cmap->n * bs, &ptr));
1380f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, M[0]->cmap->n, bs, M[0]->cmap->n, bs, ptr, &ones));
1381811e8887SPierre Jolivet       for (PetscInt n = 0; n < M[0]->cmap->n; n += bs) {
1382f1580f4eSBarry Smith         for (p = 0; p < bs; ++p) ptr[n + p * (M[0]->cmap->n + 1)] = 1.0;
1383f1580f4eSBarry Smith       }
1384fb842aefSJose E. Roman       PetscCall(MatMatMult(M[0], ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum));
1385f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1386f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, aux->cmap->n, bs, aux->cmap->n, bs, ptr, &ones));
1387f1580f4eSBarry Smith       PetscCall(MatDenseSetLDA(ones, M[0]->cmap->n));
1388fb842aefSJose E. Roman       PetscCall(MatMatMult(aux, ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum + 1));
1389f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1390f1580f4eSBarry Smith       PetscCall(PetscFree(ptr));
1391f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1392f1580f4eSBarry Smith       PetscCall(MatAXPY(sum[0], -1.0, sum[1], SAME_NONZERO_PATTERN));
1393f1580f4eSBarry Smith       PetscCall(MatDestroy(sum + 1));
1394f1580f4eSBarry Smith       /* re-order values to be consistent with MatSetValuesBlocked()           */
1395f1580f4eSBarry Smith       /* equivalent to MatTranspose() which does not truly handle              */
1396f1580f4eSBarry Smith       /* MAT_INPLACE_MATRIX in the rectangular case, as it calls PetscMalloc() */
1397f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(sum[0], &ptr));
1398f1580f4eSBarry Smith       HPDDM::Wrapper<PetscScalar>::imatcopy<'T'>(bs, sum[0]->rmap->n, ptr, sum[0]->rmap->n, bs);
1399f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1400811e8887SPierre Jolivet       for (PetscInt n = 0; n < aux->cmap->n / bs; ++n) PetscCall(MatSetValuesBlocked(aux, 1, &n, 1, &n, ptr + n * bs * bs, ADD_VALUES));
1401f1580f4eSBarry Smith       PetscCall(MatAssemblyBegin(aux, MAT_FINAL_ASSEMBLY));
1402f1580f4eSBarry Smith       PetscCall(MatAssemblyEnd(aux, MAT_FINAL_ASSEMBLY));
1403f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(sum[0], &ptr));
1404f1580f4eSBarry Smith       PetscCall(MatDestroy(sum));
1405f1580f4eSBarry Smith     }
1406f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
1407f1580f4eSBarry Smith     /* left-hand side of GenEO, with the same sparsity pattern as PCASM subdomain solvers  */
1408f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Neumann_Mat", (PetscObject)aux));
1409f1580f4eSBarry Smith   }
1410f1580f4eSBarry Smith   PetscCall(ISDestroy(irow));
1411f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &M));
14123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1413f1580f4eSBarry Smith }
1414f1580f4eSBarry Smith 
141513044ca3SPierre Jolivet static PetscErrorCode PCApply_Nest(PC pc, Vec x, Vec y)
141613044ca3SPierre Jolivet {
141713044ca3SPierre Jolivet   Mat                    A;
141813044ca3SPierre Jolivet   MatSolverType          type;
141913044ca3SPierre Jolivet   IS                     is[2];
142013044ca3SPierre Jolivet   PetscBool              flg;
142113044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
142213044ca3SPierre Jolivet 
142313044ca3SPierre Jolivet   PetscFunctionBegin;
142413044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
142551ea4bc8SPierre Jolivet   if (p->second[0]) { /* in case of a centralized Schur complement, some processes may have no local operator */
142613044ca3SPierre Jolivet     PetscCall(PCGetOperators(p->first, &A, nullptr));
142713044ca3SPierre Jolivet     PetscCall(MatNestGetISs(A, is, nullptr));
142851ea4bc8SPierre Jolivet     PetscCall(PetscObjectTypeCompareAny((PetscObject)p->first, &flg, PCLU, PCCHOLESKY, ""));
142951ea4bc8SPierre Jolivet     if (flg) { /* partial solve currently only makes sense with exact factorizations */
143013044ca3SPierre Jolivet       PetscCall(PCFactorGetMatSolverType(p->first, &type));
143113044ca3SPierre Jolivet       PetscCall(PCFactorGetMatrix(p->first, &A));
143251ea4bc8SPierre Jolivet       if (A->schur) {
143313044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
143451ea4bc8SPierre Jolivet         if (flg) PetscCall(MatMumpsSetIcntl(A, 26, 1)); /* reduction/condensation phase followed by Schur complement solve */
143551ea4bc8SPierre Jolivet       } else flg = PETSC_FALSE;
143613044ca3SPierre Jolivet     }
143713044ca3SPierre Jolivet     PetscCall(VecISCopy(p->second[0], is[1], SCATTER_FORWARD, x)); /* assign the RHS associated to the Schur complement */
143813044ca3SPierre Jolivet     PetscCall(PCApply(p->first, p->second[0], p->second[1]));
143913044ca3SPierre Jolivet     PetscCall(VecISCopy(p->second[1], is[1], SCATTER_REVERSE, y)); /* retrieve the partial solution associated to the Schur complement */
144079578405SBarry Smith     if (flg) PetscCall(MatMumpsSetIcntl(A, 26, -1));               /* default ICNTL(26) value in PETSc */
144113044ca3SPierre Jolivet   }
144213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
144313044ca3SPierre Jolivet }
144413044ca3SPierre Jolivet 
144513044ca3SPierre Jolivet static PetscErrorCode PCView_Nest(PC pc, PetscViewer viewer)
144613044ca3SPierre Jolivet {
144713044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
144813044ca3SPierre Jolivet 
144913044ca3SPierre Jolivet   PetscFunctionBegin;
145013044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
145113044ca3SPierre Jolivet   PetscCall(PCView(p->first, viewer));
145213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
145313044ca3SPierre Jolivet }
145413044ca3SPierre Jolivet 
145513044ca3SPierre Jolivet static PetscErrorCode PCDestroy_Nest(PC pc)
145613044ca3SPierre Jolivet {
145713044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
145813044ca3SPierre Jolivet 
145913044ca3SPierre Jolivet   PetscFunctionBegin;
146013044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
146113044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second));
146213044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second + 1));
146313044ca3SPierre Jolivet   PetscCall(PCDestroy(&p->first));
146413044ca3SPierre Jolivet   PetscCall(PetscFree(p));
146513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
146613044ca3SPierre Jolivet }
146713044ca3SPierre Jolivet 
146813044ca3SPierre Jolivet template <bool T = false>
146913044ca3SPierre Jolivet static PetscErrorCode MatMult_Schur(Mat A, Vec x, Vec y)
147013044ca3SPierre Jolivet {
147101e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
147213044ca3SPierre Jolivet 
147313044ca3SPierre Jolivet   PetscFunctionBegin;
147413044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
147513044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD)); /* local Vec with overlap */
147613044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD));
147713044ca3SPierre Jolivet   if (!T) PetscCall(MatMult(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1])); /* local Schur complement */
147813044ca3SPierre Jolivet   else PetscCall(MatMultTranspose(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1]));
147913044ca3SPierre Jolivet   PetscCall(VecSet(y, 0.0));
148013044ca3SPierre 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 */
148113044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE));
148213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
148313044ca3SPierre Jolivet }
148413044ca3SPierre Jolivet 
148513044ca3SPierre Jolivet static PetscErrorCode MatDestroy_Schur(Mat A)
148613044ca3SPierre Jolivet {
148701e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
148813044ca3SPierre Jolivet 
148913044ca3SPierre Jolivet   PetscFunctionBegin;
149013044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
149113044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx)));
149213044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx) + 1));
149313044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
149413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
149513044ca3SPierre Jolivet }
149613044ca3SPierre Jolivet 
149713044ca3SPierre Jolivet static PetscErrorCode MatMult_SchurCorrection(Mat A, Vec x, Vec y)
149813044ca3SPierre Jolivet {
149913044ca3SPierre Jolivet   PC                                         pc;
150013044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
150113044ca3SPierre Jolivet 
150213044ca3SPierre Jolivet   PetscFunctionBegin;
150313044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
150413044ca3SPierre Jolivet   pc = ((PC_HPDDM *)std::get<0>(*ctx)[0]->data)->levels[0]->ksp->pc;
150513044ca3SPierre 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 */
150613044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], x, std::get<3>(*ctx)[1]));                    /*     A_01 x                 */
150713044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 x             */
150813044ca3SPierre 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        */
150913044ca3SPierre 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 */
151013044ca3SPierre Jolivet   } else {
151113044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[0]));                    /*     M_S^-1 x               */
151213044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], std::get<3>(*ctx)[0], std::get<3>(*ctx)[1])); /*     A_01 M_S^-1 x          */
151313044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 M_S^-1 x      */
151413044ca3SPierre 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 */
151513044ca3SPierre Jolivet   }
151613044ca3SPierre Jolivet   PetscCall(VecAXPY(y, -1.0, x)); /* y -= x, preconditioned eq. (24) of https://hal.science/hal-02343808v6/document (with a sign flip) */
151713044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
151813044ca3SPierre Jolivet }
151913044ca3SPierre Jolivet 
152013044ca3SPierre Jolivet static PetscErrorCode MatView_SchurCorrection(Mat A, PetscViewer viewer)
152113044ca3SPierre Jolivet {
152213044ca3SPierre Jolivet   PetscBool                                  ascii;
152313044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
152413044ca3SPierre Jolivet 
152513044ca3SPierre Jolivet   PetscFunctionBegin;
152613044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &ascii));
152713044ca3SPierre Jolivet   if (ascii) {
152813044ca3SPierre Jolivet     PetscCall(MatShellGetContext(A, &ctx));
152913044ca3SPierre 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)"));
153013044ca3SPierre Jolivet     PetscCall(PCView(std::get<0>(*ctx)[1], viewer)); /* no need to PCView(Q_0) since it will be done by PCFIELDSPLIT */
153113044ca3SPierre Jolivet   }
153213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
153313044ca3SPierre Jolivet }
153413044ca3SPierre Jolivet 
153513044ca3SPierre Jolivet static PetscErrorCode MatDestroy_SchurCorrection(Mat A)
153613044ca3SPierre Jolivet {
153713044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
153813044ca3SPierre Jolivet 
153913044ca3SPierre Jolivet   PetscFunctionBegin;
154013044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
154113044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx)));
154213044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 1));
154313044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 2));
154413044ca3SPierre Jolivet   PetscCall(PCDestroy(std::get<0>(*ctx) + 1));
154513044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
154613044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
154713044ca3SPierre Jolivet }
154813044ca3SPierre Jolivet 
1549feebddf4SPierre Jolivet static PetscErrorCode PCPostSolve_SchurPreLeastSquares(PC, KSP, Vec, Vec x)
1550feebddf4SPierre Jolivet {
1551feebddf4SPierre Jolivet   PetscFunctionBegin;
1552feebddf4SPierre Jolivet   PetscCall(VecScale(x, -1.0));
1553feebddf4SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1554feebddf4SPierre Jolivet }
1555feebddf4SPierre Jolivet 
155613044ca3SPierre Jolivet static PetscErrorCode KSPPreSolve_SchurCorrection(KSP, Vec b, Vec, void *context)
155713044ca3SPierre Jolivet {
155813044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
155913044ca3SPierre Jolivet 
1560a6b3e571SPierre Jolivet   PetscFunctionBegin;
156113044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
156213044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], b, std::get<3>(*ctx)[2]));
156313044ca3SPierre 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 */
156413044ca3SPierre Jolivet   }
156513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
156613044ca3SPierre Jolivet }
156713044ca3SPierre Jolivet 
156813044ca3SPierre Jolivet static PetscErrorCode KSPPostSolve_SchurCorrection(KSP, Vec b, Vec x, void *context)
156913044ca3SPierre Jolivet {
157013044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
157113044ca3SPierre Jolivet 
1572a6b3e571SPierre Jolivet   PetscFunctionBegin;
157313044ca3SPierre 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 */
157413044ca3SPierre Jolivet   else {
157513044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[2]));
157613044ca3SPierre Jolivet     PetscCall(VecCopy(std::get<3>(*ctx)[2], x)); /* replace x by M^-1 x */
157713044ca3SPierre Jolivet   }
157813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
157913044ca3SPierre Jolivet }
158013044ca3SPierre Jolivet 
15819bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat, Vec, Vec);
15829bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat, Vec, Vec);
15839bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat, Mat, Mat, void *);
15849bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat);
15859bb5c669SPierre Jolivet 
1586d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDM(PC pc)
1587d71ae5a4SJacob Faibussowitsch {
1588f1580f4eSBarry Smith   PC_HPDDM                                  *data = (PC_HPDDM *)pc->data;
1589f1580f4eSBarry Smith   PC                                         inner;
1590f1580f4eSBarry Smith   KSP                                       *ksp;
159113044ca3SPierre Jolivet   Mat                                       *sub, A, P, N, C = nullptr, uaux = nullptr, weighted, subA[2], S;
1592f1580f4eSBarry Smith   Vec                                        xin, v;
1593f1580f4eSBarry Smith   std::vector<Vec>                           initial;
1594db4a47b3SPierre Jolivet   IS                                         is[1], loc, uis = data->is, unsorted = nullptr;
1595f1580f4eSBarry Smith   ISLocalToGlobalMapping                     l2g;
1596f1580f4eSBarry Smith   char                                       prefix[256];
1597f1580f4eSBarry Smith   const char                                *pcpre;
1598f1580f4eSBarry Smith   const PetscScalar *const                  *ev;
15999bb5c669SPierre Jolivet   PetscInt                                   n, requested = data->N, reused = 0, overlap = -1;
1600f1580f4eSBarry Smith   MatStructure                               structure  = UNKNOWN_NONZERO_PATTERN;
1601f1580f4eSBarry Smith   PetscBool                                  subdomains = PETSC_FALSE, flg = PETSC_FALSE, ismatis, swap = PETSC_FALSE, algebraic = PETSC_FALSE, block = PETSC_FALSE;
1602f1580f4eSBarry Smith   DM                                         dm;
160313044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = nullptr;
1604398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1605db4a47b3SPierre Jolivet   IS  dis  = nullptr;
1606db4a47b3SPierre Jolivet   Mat daux = nullptr;
1607398c7888SPierre Jolivet #endif
1608f1580f4eSBarry Smith 
1609f1580f4eSBarry Smith   PetscFunctionBegin;
1610f1580f4eSBarry Smith   PetscCheck(data->levels && data->levels[0], PETSC_COMM_SELF, PETSC_ERR_PLIB, "Not a single level allocated");
1611f1580f4eSBarry Smith   PetscCall(PCGetOptionsPrefix(pc, &pcpre));
1612f1580f4eSBarry Smith   PetscCall(PCGetOperators(pc, &A, &P));
1613f1580f4eSBarry Smith   if (!data->levels[0]->ksp) {
1614f1580f4eSBarry Smith     PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->ksp));
16153821be0aSBarry Smith     PetscCall(KSPSetNestLevel(data->levels[0]->ksp, pc->kspnestlevel));
1616f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_%s_", pcpre ? pcpre : "", data->N > 1 ? "levels_1" : "coarse"));
1617f1580f4eSBarry Smith     PetscCall(KSPSetOptionsPrefix(data->levels[0]->ksp, prefix));
1618f1580f4eSBarry Smith     PetscCall(KSPSetType(data->levels[0]->ksp, KSPPREONLY));
1619371d2eb7SMartin Diehl   } else if (data->levels[0]->ksp->pc && data->levels[0]->ksp->pc->setupcalled && data->levels[0]->ksp->pc->reusepreconditioner) {
1620f1580f4eSBarry Smith     /* if the fine-level PCSHELL exists, its setup has succeeded, and one wants to reuse it, */
1621f1580f4eSBarry Smith     /* then just propagate the appropriate flag to the coarser levels                        */
1622f1580f4eSBarry Smith     for (n = 0; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1623f1580f4eSBarry Smith       /* the following KSP and PC may be NULL for some processes, hence the check            */
1624f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetReusePreconditioner(data->levels[n]->ksp, PETSC_TRUE));
1625f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
1626f1580f4eSBarry Smith     }
1627f1580f4eSBarry Smith     /* early bail out because there is nothing to do */
16283ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1629f1580f4eSBarry Smith   } else {
1630f1580f4eSBarry Smith     /* reset coarser levels */
1631f1580f4eSBarry Smith     for (n = 1; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1632371d2eb7SMartin 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) {
1633f1580f4eSBarry Smith         reused = data->N - n;
1634f1580f4eSBarry Smith         break;
1635f1580f4eSBarry Smith       }
1636f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[n]->ksp));
1637f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[n]->pc));
1638f1580f4eSBarry Smith     }
1639f1580f4eSBarry Smith     /* check if some coarser levels are being reused */
1640462c564dSBarry Smith     PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &reused, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)pc)));
1641f1580f4eSBarry Smith     const int *addr = data->levels[0]->P ? data->levels[0]->P->getAddrLocal() : &HPDDM::i__0;
1642f1580f4eSBarry Smith 
1643f1580f4eSBarry Smith     if (addr != &HPDDM::i__0 && reused != data->N - 1) {
1644f1580f4eSBarry Smith       /* reuse previously computed eigenvectors */
1645f1580f4eSBarry Smith       ev = data->levels[0]->P->getVectors();
1646f1580f4eSBarry Smith       if (ev) {
1647f1580f4eSBarry Smith         initial.reserve(*addr);
1648f1580f4eSBarry Smith         PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, data->levels[0]->P->getDof(), ev[0], &xin));
1649f1580f4eSBarry Smith         for (n = 0; n < *addr; ++n) {
1650f1580f4eSBarry Smith           PetscCall(VecDuplicate(xin, &v));
1651f1580f4eSBarry Smith           PetscCall(VecPlaceArray(xin, ev[n]));
1652f1580f4eSBarry Smith           PetscCall(VecCopy(xin, v));
1653f1580f4eSBarry Smith           initial.emplace_back(v);
1654f1580f4eSBarry Smith           PetscCall(VecResetArray(xin));
1655f1580f4eSBarry Smith         }
1656f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
1657f1580f4eSBarry Smith       }
1658f1580f4eSBarry Smith     }
1659f1580f4eSBarry Smith   }
1660f1580f4eSBarry Smith   data->N -= reused;
1661f1580f4eSBarry Smith   PetscCall(KSPSetOperators(data->levels[0]->ksp, A, P));
1662f1580f4eSBarry Smith 
1663f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATIS, &ismatis));
1664f1580f4eSBarry Smith   if (!data->is && !ismatis) {
1665db4a47b3SPierre Jolivet     PetscErrorCode (*create)(DM, IS *, Mat *, PetscErrorCode (**)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void **) = nullptr;
1666db4a47b3SPierre Jolivet     PetscErrorCode (*usetup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *)                                                = nullptr;
1667db4a47b3SPierre Jolivet     void *uctx                                                                                                               = nullptr;
1668f1580f4eSBarry Smith 
1669f1580f4eSBarry Smith     /* first see if we can get the data from the DM */
1670f1580f4eSBarry Smith     PetscCall(MatGetDM(P, &dm));
1671f1580f4eSBarry Smith     if (!dm) PetscCall(MatGetDM(A, &dm));
1672f1580f4eSBarry Smith     if (!dm) PetscCall(PCGetDM(pc, &dm));
1673907a3e9cSStefano Zampini     if (dm) { /* this is the hook for DMPLEX for which the auxiliary Mat is the local Neumann matrix */
1674f1580f4eSBarry Smith       PetscCall(PetscObjectQueryFunction((PetscObject)dm, "DMCreateNeumannOverlap_C", &create));
1675f1580f4eSBarry Smith       if (create) {
1676f1580f4eSBarry Smith         PetscCall((*create)(dm, &uis, &uaux, &usetup, &uctx));
1677c8ea6600SPierre 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 */
1678f1580f4eSBarry Smith       }
1679f1580f4eSBarry Smith     }
1680f1580f4eSBarry Smith     if (!create) {
1681f1580f4eSBarry Smith       if (!uis) {
1682f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1683f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1684f1580f4eSBarry Smith       }
1685f1580f4eSBarry Smith       if (!uaux) {
1686f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1687f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1688f1580f4eSBarry Smith       }
1689f1580f4eSBarry Smith       /* look inside the Pmat instead of the PC, needed for MatSchurComplementComputeExplicitOperator() */
1690f1580f4eSBarry Smith       if (!uis) {
1691f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1692f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1693f1580f4eSBarry Smith       }
1694f1580f4eSBarry Smith       if (!uaux) {
1695f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1696f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1697f1580f4eSBarry Smith       }
1698f1580f4eSBarry Smith     }
1699f1580f4eSBarry Smith     PetscCall(PCHPDDMSetAuxiliaryMat(pc, uis, uaux, usetup, uctx));
1700f1580f4eSBarry Smith     PetscCall(MatDestroy(&uaux));
1701f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
1702f1580f4eSBarry Smith   }
1703f1580f4eSBarry Smith 
1704f1580f4eSBarry Smith   if (!ismatis) {
1705f1580f4eSBarry Smith     PetscCall(PCHPDDMSetUpNeumannOverlap_Private(pc));
1706db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_block_splitting", &block, nullptr));
17079bb5c669SPierre Jolivet     PetscCall(PetscOptionsGetInt(nullptr, pcpre, "-pc_hpddm_harmonic_overlap", &overlap, nullptr));
17085e642048SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
170951ea4bc8SPierre Jolivet     if (data->is || flg) {
17109bb5c669SPierre Jolivet       if (block || overlap != -1) {
171102800ff6SPierre Jolivet         PetscCall(ISDestroy(&data->is));
171202800ff6SPierre Jolivet         PetscCall(MatDestroy(&data->aux));
171351ea4bc8SPierre Jolivet       } else if (flg) {
171413044ca3SPierre Jolivet         PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_GENEO;
171513044ca3SPierre Jolivet 
171613044ca3SPierre Jolivet         PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
171713044ca3SPierre Jolivet         if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
171813044ca3SPierre Jolivet           PetscCall(ISDestroy(&data->is)); /* destroy any previously user-set objects since they will be set automatically */
171913044ca3SPierre Jolivet           PetscCall(MatDestroy(&data->aux));
172013044ca3SPierre Jolivet         } else if (type == PC_HPDDM_SCHUR_PRE_GENEO) {
172113044ca3SPierre Jolivet           PetscContainer container = nullptr;
172213044ca3SPierre Jolivet 
172313044ca3SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Schur", (PetscObject *)&container));
172413044ca3SPierre Jolivet           if (!container) { /* first call to PCSetUp() on the PC associated to the Schur complement */
172513044ca3SPierre Jolivet             PC_HPDDM       *data_00;
172613044ca3SPierre Jolivet             KSP             ksp, inner_ksp;
172713044ca3SPierre Jolivet             PC              pc_00;
1728cf67ef9dSPierre Jolivet             Mat             A11 = nullptr;
1729cf67ef9dSPierre Jolivet             Vec             d   = nullptr;
173051ea4bc8SPierre Jolivet             const PetscInt *ranges;
173151ea4bc8SPierre Jolivet             PetscMPIInt     size;
173213044ca3SPierre Jolivet             char           *prefix;
173313044ca3SPierre Jolivet 
173413044ca3SPierre Jolivet             PetscCall(MatSchurComplementGetKSP(P, &ksp));
173513044ca3SPierre Jolivet             PetscCall(KSPGetPC(ksp, &pc_00));
173613044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)pc_00, PCHPDDM, &flg));
1737fd310a01SPierre 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 : "",
173813044ca3SPierre Jolivet                        ((PetscObject)pc_00)->type_name, PCHPDDM);
173913044ca3SPierre Jolivet             data_00 = (PC_HPDDM *)pc_00->data;
1740fd310a01SPierre 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],
1741fd310a01SPierre Jolivet                        data_00->N, data_00->N > 1 ? "s" : "", ((PetscObject)pc_00)->prefix);
174251ea4bc8SPierre 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() : "");
174313044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)data_00->levels[0]->pc, PCASM, &flg));
1744fd310a01SPierre 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,
174513044ca3SPierre Jolivet                        ((PetscObject)data_00->levels[0]->pc)->type_name, PCASM);
174651ea4bc8SPierre 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)  */
1747d16c0b94SPierre Jolivet             PetscCall(MatSchurComplementGetSubMatrices(P, nullptr, nullptr, nullptr, nullptr, &A11));
174851ea4bc8SPierre Jolivet             PetscCall(MatGetOwnershipRanges(A11, &ranges));
174951ea4bc8SPierre Jolivet             PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A11), &size));
175051ea4bc8SPierre 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)? */
175151ea4bc8SPierre Jolivet             if (!flg) {
17525e642048SPierre Jolivet               if (PetscDefined(USE_DEBUG) || !data->is) {
17535e642048SPierre Jolivet                 Mat A01, A10, B = nullptr, C = nullptr, *sub;
175413044ca3SPierre Jolivet 
17555e642048SPierre Jolivet                 PetscCall(MatSchurComplementGetSubMatrices(P, &A, nullptr, &A01, &A10, nullptr));
17565e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
17575e642048SPierre Jolivet                 if (flg) {
17585e642048SPierre Jolivet                   PetscCall(MatTransposeGetMat(A10, &C));
17595e642048SPierre Jolivet                   PetscCall(MatTranspose(C, MAT_INITIAL_MATRIX, &B));
17605e642048SPierre Jolivet                 } else {
17615e642048SPierre Jolivet                   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
17625e642048SPierre Jolivet                   if (flg) {
17635e642048SPierre Jolivet                     PetscCall(MatHermitianTransposeGetMat(A10, &C));
17645e642048SPierre Jolivet                     PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &B));
17655e642048SPierre Jolivet                   }
17665e642048SPierre Jolivet                 }
1767811e8887SPierre Jolivet                 if (flg)
1768811e8887SPierre 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));
17695e642048SPierre Jolivet                 if (!B) {
17705e642048SPierre Jolivet                   B = A10;
17715e642048SPierre Jolivet                   PetscCall(PetscObjectReference((PetscObject)B));
17725e642048SPierre Jolivet                 } else if (!data->is) {
17735e642048SPierre Jolivet                   PetscCall(PetscObjectTypeCompareAny((PetscObject)A01, &flg, MATTRANSPOSEVIRTUAL, MATHERMITIANTRANSPOSEVIRTUAL, ""));
17745e642048SPierre Jolivet                   if (!flg) C = A01;
1775811e8887SPierre Jolivet                   else
1776811e8887SPierre 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));
17775e642048SPierre Jolivet                 }
177813044ca3SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, B->rmap->N, 0, 1, &uis));
17795e642048SPierre Jolivet                 PetscCall(ISSetIdentity(uis));
17805e642048SPierre Jolivet                 if (!data->is) {
17815e642048SPierre Jolivet                   if (C) PetscCall(PetscObjectReference((PetscObject)C));
17825e642048SPierre Jolivet                   else PetscCall(MatTranspose(B, MAT_INITIAL_MATRIX, &C));
17835e642048SPierre Jolivet                   PetscCall(ISDuplicate(data_00->is, is));
17845e642048SPierre Jolivet                   PetscCall(MatIncreaseOverlap(A, 1, is, 1));
17855e642048SPierre Jolivet                   PetscCall(MatSetOption(C, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
17865e642048SPierre Jolivet                   PetscCall(MatCreateSubMatrices(C, 1, is, &uis, MAT_INITIAL_MATRIX, &sub));
17875e642048SPierre Jolivet                   PetscCall(MatDestroy(&C));
17885e642048SPierre Jolivet                   PetscCall(MatTranspose(sub[0], MAT_INITIAL_MATRIX, &C));
17895e642048SPierre Jolivet                   PetscCall(MatDestroySubMatrices(1, &sub));
17905e642048SPierre Jolivet                   PetscCall(MatFindNonzeroRows(C, &data->is));
17915e642048SPierre Jolivet                   PetscCall(MatDestroy(&C));
17925e642048SPierre Jolivet                   PetscCall(ISDestroy(is));
1793d16c0b94SPierre Jolivet                   PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), A11->rmap->n, A11->rmap->rstart, 1, &loc));
1794d16c0b94SPierre Jolivet                   if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_FALSE));
1795d16c0b94SPierre Jolivet                   PetscCall(ISExpand(data->is, loc, is));
1796d16c0b94SPierre Jolivet                   PetscCall(ISDestroy(&loc));
1797d16c0b94SPierre Jolivet                   PetscCall(ISDestroy(&data->is));
1798d16c0b94SPierre Jolivet                   data->is = is[0];
1799d16c0b94SPierre Jolivet                   is[0]    = nullptr;
18005e642048SPierre Jolivet                 }
18015e642048SPierre Jolivet                 if (PetscDefined(USE_DEBUG)) {
18025e642048SPierre Jolivet                   PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
180313044ca3SPierre 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 */
180413044ca3SPierre Jolivet                   PetscCall(ISDestroy(&uis));
180513044ca3SPierre Jolivet                   PetscCall(ISDuplicate(data->is, &uis));
180613044ca3SPierre Jolivet                   PetscCall(ISSort(uis));
18075e642048SPierre Jolivet                   PetscCall(ISComplement(uis, 0, B->rmap->N, is));
180813044ca3SPierre Jolivet                   PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &C));
18095e642048SPierre Jolivet                   PetscCall(MatZeroRowsIS(C, is[0], 0.0, nullptr, nullptr));
18105e642048SPierre Jolivet                   PetscCall(ISDestroy(is));
181113044ca3SPierre Jolivet                   PetscCall(MatMultEqual(sub[0], C, 20, &flg));
181213044ca3SPierre 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 */
181313044ca3SPierre Jolivet                   PetscCall(MatDestroy(&C));
181413044ca3SPierre Jolivet                   PetscCall(MatDestroySubMatrices(1, &sub));
181513044ca3SPierre Jolivet                 }
18165e642048SPierre Jolivet                 PetscCall(ISDestroy(&uis));
18175e642048SPierre Jolivet                 PetscCall(MatDestroy(&B));
18185e642048SPierre Jolivet               }
1819cf67ef9dSPierre Jolivet               flg = PETSC_FALSE;
1820cf67ef9dSPierre Jolivet               if (!data->aux) {
1821cf67ef9dSPierre Jolivet                 Mat D;
1822cf67ef9dSPierre Jolivet 
1823cf67ef9dSPierre Jolivet                 PetscCall(MatCreateVecs(A11, &d, nullptr));
1824cf67ef9dSPierre Jolivet                 PetscCall(MatGetDiagonal(A11, d));
1825cf67ef9dSPierre Jolivet                 PetscCall(PetscObjectTypeCompareAny((PetscObject)A11, &flg, MATDIAGONAL, MATCONSTANTDIAGONAL, ""));
1826cf67ef9dSPierre Jolivet                 if (!flg) {
1827cf67ef9dSPierre Jolivet                   PetscCall(MatCreateDiagonal(d, &D));
1828cf67ef9dSPierre Jolivet                   PetscCall(MatMultEqual(A11, D, 20, &flg));
1829cf67ef9dSPierre Jolivet                   PetscCall(MatDestroy(&D));
1830cf67ef9dSPierre Jolivet                 }
1831cf67ef9dSPierre 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"));
1832cf67ef9dSPierre Jolivet               }
1833cf67ef9dSPierre Jolivet               if (data->Neumann != PETSC_BOOL3_TRUE && !flg && A11) {
1834cf67ef9dSPierre Jolivet                 PetscReal norm;
1835cf67ef9dSPierre Jolivet 
1836cf67ef9dSPierre Jolivet                 PetscCall(MatNorm(A11, NORM_INFINITY, &norm));
1837cf67ef9dSPierre 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 : "");
1838cf67ef9dSPierre 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"));
1839cf67ef9dSPierre Jolivet                 PetscCall(MatDestroy(&data->aux));
1840cf67ef9dSPierre Jolivet                 flg = PETSC_TRUE;
1841cf67ef9dSPierre Jolivet               }
1842cf67ef9dSPierre 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 */
184301e3c840SPierre Jolivet                 PetscSF            scatter;
184413044ca3SPierre Jolivet                 const PetscScalar *read;
1845cf67ef9dSPierre Jolivet                 PetscScalar       *write, *diagonal = nullptr;
184613044ca3SPierre Jolivet 
184713044ca3SPierre Jolivet                 PetscCall(MatDestroy(&data->aux));
184813044ca3SPierre Jolivet                 PetscCall(ISGetLocalSize(data->is, &n));
1849cf67ef9dSPierre Jolivet                 PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &xin));
1850cf67ef9dSPierre Jolivet                 PetscCall(VecDuplicate(xin, &v));
1851cf67ef9dSPierre Jolivet                 PetscCall(VecScatterCreate(xin, data->is, v, nullptr, &scatter));
185213044ca3SPierre Jolivet                 PetscCall(VecSet(v, 1.0));
1853cf67ef9dSPierre Jolivet                 PetscCall(VecSet(xin, 1.0));
1854cf67ef9dSPierre Jolivet                 PetscCall(VecScatterBegin(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE));
1855cf67ef9dSPierre Jolivet                 PetscCall(VecScatterEnd(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE)); /* v has the multiplicity of all unknowns on the overlap */
1856cf67ef9dSPierre Jolivet                 PetscCall(PetscSFDestroy(&scatter));
1857cf67ef9dSPierre Jolivet                 if (d) {
1858cf67ef9dSPierre Jolivet                   PetscCall(VecScatterCreate(d, data->is, v, nullptr, &scatter));
1859cf67ef9dSPierre Jolivet                   PetscCall(VecScatterBegin(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1860cf67ef9dSPierre Jolivet                   PetscCall(VecScatterEnd(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1861cf67ef9dSPierre Jolivet                   PetscCall(PetscSFDestroy(&scatter));
1862cf67ef9dSPierre Jolivet                   PetscCall(VecDestroy(&d));
1863cf67ef9dSPierre Jolivet                   PetscCall(PetscMalloc1(n, &diagonal));
1864cf67ef9dSPierre Jolivet                   PetscCall(VecGetArrayRead(v, &read));
1865cf67ef9dSPierre Jolivet                   PetscCallCXX(std::copy_n(read, n, diagonal));
1866cf67ef9dSPierre Jolivet                   PetscCall(VecRestoreArrayRead(v, &read));
1867cf67ef9dSPierre Jolivet                 }
186813044ca3SPierre Jolivet                 PetscCall(VecDestroy(&v));
186913044ca3SPierre Jolivet                 PetscCall(VecCreateSeq(PETSC_COMM_SELF, n, &v));
1870cf67ef9dSPierre Jolivet                 PetscCall(VecGetArrayRead(xin, &read));
187113044ca3SPierre Jolivet                 PetscCall(VecGetArrayWrite(v, &write));
1872cf67ef9dSPierre 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];
1873cf67ef9dSPierre Jolivet                 PetscCall(PetscFree(diagonal));
1874cf67ef9dSPierre Jolivet                 PetscCall(VecRestoreArrayRead(xin, &read));
187513044ca3SPierre Jolivet                 PetscCall(VecRestoreArrayWrite(v, &write));
1876cf67ef9dSPierre Jolivet                 PetscCall(VecDestroy(&xin));
1877c3e1b152SPierre Jolivet                 PetscCall(MatCreateDiagonal(v, &data->aux));
187813044ca3SPierre Jolivet                 PetscCall(VecDestroy(&v));
187913044ca3SPierre Jolivet               }
188013044ca3SPierre Jolivet               uis  = data->is;
188113044ca3SPierre Jolivet               uaux = data->aux;
188213044ca3SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)uis));
188313044ca3SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)uaux));
188413044ca3SPierre Jolivet               PetscCall(PetscStrallocpy(pcpre, &prefix));
188513044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(pc, nullptr));
188613044ca3SPierre Jolivet               PetscCall(PCSetType(pc, PCKSP));                                    /* replace the PC associated to the Schur complement by PCKSP */
188713044ca3SPierre Jolivet               PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &inner_ksp)); /* new KSP that will be attached to the previously set PC */
188813044ca3SPierre Jolivet               PetscCall(PetscObjectGetTabLevel((PetscObject)pc, &n));
188913044ca3SPierre Jolivet               PetscCall(PetscObjectSetTabLevel((PetscObject)inner_ksp, n + 2));
189013044ca3SPierre Jolivet               PetscCall(KSPSetOperators(inner_ksp, pc->mat, pc->pmat));
189113044ca3SPierre Jolivet               PetscCall(KSPSetOptionsPrefix(inner_ksp, std::string(std::string(prefix) + "pc_hpddm_").c_str()));
189213044ca3SPierre Jolivet               PetscCall(KSPSetSkipPCSetFromOptions(inner_ksp, PETSC_TRUE));
189313044ca3SPierre Jolivet               PetscCall(KSPSetFromOptions(inner_ksp));
189413044ca3SPierre Jolivet               PetscCall(KSPGetPC(inner_ksp, &inner));
189513044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(inner, nullptr));
189613044ca3SPierre Jolivet               PetscCall(PCSetType(inner, PCNONE)); /* no preconditioner since the action of M^-1 A or A M^-1 will be computed by the Amat */
189713044ca3SPierre Jolivet               PetscCall(PCKSPSetKSP(pc, inner_ksp));
189813044ca3SPierre Jolivet               std::get<0>(*ctx)[0] = pc_00; /* for coarse correction on the primal (e.g., velocity) space */
189913044ca3SPierre Jolivet               PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &std::get<0>(*ctx)[1]));
190051ea4bc8SPierre Jolivet               PetscCall(PCSetOptionsPrefix(pc, prefix)); /* both PC share the same prefix so that the outer PC can be reset with PCSetFromOptions() */
190113044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(std::get<0>(*ctx)[1], prefix));
190213044ca3SPierre Jolivet               PetscCall(PetscFree(prefix));
190313044ca3SPierre Jolivet               PetscCall(PCSetOperators(std::get<0>(*ctx)[1], pc->mat, pc->pmat));
190413044ca3SPierre Jolivet               PetscCall(PCSetType(std::get<0>(*ctx)[1], PCHPDDM));
190513044ca3SPierre 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 */
1906cf67ef9dSPierre Jolivet               if (flg) static_cast<PC_HPDDM *>(std::get<0>(*ctx)[1]->data)->Neumann = PETSC_BOOL3_TRUE;
190713044ca3SPierre Jolivet               PetscCall(PCSetFromOptions(std::get<0>(*ctx)[1]));
190813044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)uis));
190913044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)uaux));
191013044ca3SPierre 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 */
191113044ca3SPierre Jolivet               PetscCall(MatShellSetOperation(S, MATOP_MULT, (void (*)(void))MatMult_SchurCorrection));
191213044ca3SPierre Jolivet               PetscCall(MatShellSetOperation(S, MATOP_VIEW, (void (*)(void))MatView_SchurCorrection));
191313044ca3SPierre Jolivet               PetscCall(MatShellSetOperation(S, MATOP_DESTROY, (void (*)(void))MatDestroy_SchurCorrection));
191413044ca3SPierre Jolivet               PetscCall(KSPGetPCSide(inner_ksp, &(std::get<2>(*ctx))));
191513044ca3SPierre Jolivet               if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
191613044ca3SPierre Jolivet                 PetscCall(KSPSetPreSolve(inner_ksp, KSPPreSolve_SchurCorrection, ctx));
191713044ca3SPierre Jolivet               } else { /* no support for PC_SYMMETRIC */
191813044ca3SPierre 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]);
191913044ca3SPierre Jolivet               }
192013044ca3SPierre Jolivet               PetscCall(KSPSetPostSolve(inner_ksp, KSPPostSolve_SchurCorrection, ctx));
1921715c1178SPierre Jolivet               PetscCall(PetscObjectContainerCompose((PetscObject)std::get<0>(*ctx)[1], "_PCHPDDM_Schur", ctx, nullptr));
192213044ca3SPierre Jolivet               PetscCall(PCSetUp(std::get<0>(*ctx)[1]));
192313044ca3SPierre Jolivet               PetscCall(KSPSetOperators(inner_ksp, S, S));
192413044ca3SPierre Jolivet               PetscCall(MatCreateVecs(std::get<1>(*ctx)[0], std::get<3>(*ctx), std::get<3>(*ctx) + 1));
192513044ca3SPierre Jolivet               PetscCall(VecDuplicate(std::get<3>(*ctx)[0], std::get<3>(*ctx) + 2));
192613044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)inner_ksp));
192713044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)S));
192851ea4bc8SPierre Jolivet             } else {
192951ea4bc8SPierre Jolivet               std::get<0>(*ctx)[0] = pc_00;
193051ea4bc8SPierre Jolivet               PetscCall(PetscObjectContainerCompose((PetscObject)pc, "_PCHPDDM_Schur", ctx, nullptr));
193151ea4bc8SPierre 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 */
193251ea4bc8SPierre Jolivet               PetscCall(MatGetDiagonalBlock(A11, &data->aux));
193351ea4bc8SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)data->aux));
193451ea4bc8SPierre Jolivet               PetscCall(PCSetUp(pc));
193551ea4bc8SPierre Jolivet             }
19360307214fSPierre Jolivet             for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
193713044ca3SPierre Jolivet             PetscFunctionReturn(PETSC_SUCCESS);
193813044ca3SPierre Jolivet           } else { /* second call to PCSetUp() on the PC associated to the Schur complement, retrieve previously set context */
193913044ca3SPierre Jolivet             PetscCall(PetscContainerGetPointer(container, (void **)&ctx));
194013044ca3SPierre Jolivet           }
194113044ca3SPierre Jolivet         }
194213044ca3SPierre Jolivet       }
194313044ca3SPierre Jolivet     }
1944f1580f4eSBarry Smith     if (!data->is && data->N > 1) {
1945f1580f4eSBarry Smith       char type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
1946811e8887SPierre Jolivet 
1947f1580f4eSBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
1948f1580f4eSBarry Smith       if (flg || (A->rmap->N != A->cmap->N && P->rmap->N == P->cmap->N && P->rmap->N == A->cmap->N)) {
1949f1580f4eSBarry Smith         Mat B;
1950811e8887SPierre Jolivet 
1951f1580f4eSBarry Smith         PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, A, P, &B, pcpre));
1952f1580f4eSBarry Smith         if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) data->correction = PC_HPDDM_COARSE_CORRECTION_BALANCED;
1953f1580f4eSBarry Smith         PetscCall(MatDestroy(&B));
1954f1580f4eSBarry Smith       } else {
1955f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
1956f1580f4eSBarry Smith         if (flg) {
1957f1580f4eSBarry Smith           Mat                 A00, P00, A01, A10, A11, B, N;
195813044ca3SPierre Jolivet           PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_LEAST_SQUARES;
195913044ca3SPierre Jolivet 
196013044ca3SPierre Jolivet           PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, &A01, &A10, &A11));
196113044ca3SPierre Jolivet           PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
196213044ca3SPierre Jolivet           if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
1963281f8ce6SPierre Jolivet             Mat                        B01;
19643df4cd7bSPierre Jolivet             Vec                        diagonal = nullptr;
1965f1580f4eSBarry Smith             const PetscScalar         *array;
1966f1580f4eSBarry Smith             MatSchurComplementAinvType type;
1967f1580f4eSBarry Smith 
1968281f8ce6SPierre Jolivet             PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10, &B01));
1969f1580f4eSBarry Smith             if (A11) {
19703df4cd7bSPierre Jolivet               PetscCall(MatCreateVecs(A11, &diagonal, nullptr));
19713df4cd7bSPierre Jolivet               PetscCall(MatGetDiagonal(A11, diagonal));
1972f1580f4eSBarry Smith             }
1973db4a47b3SPierre Jolivet             PetscCall(MatCreateVecs(P00, &v, nullptr));
1974f1580f4eSBarry Smith             PetscCall(MatSchurComplementGetAinvType(P, &type));
1975f1580f4eSBarry Smith             PetscCheck(type == MAT_SCHUR_COMPLEMENT_AINV_DIAG || type == MAT_SCHUR_COMPLEMENT_AINV_LUMP, PetscObjectComm((PetscObject)P), PETSC_ERR_SUP, "-%smat_schur_complement_ainv_type %s", ((PetscObject)P)->prefix ? ((PetscObject)P)->prefix : "", MatSchurComplementAinvTypes[type]);
1976f1580f4eSBarry Smith             if (type == MAT_SCHUR_COMPLEMENT_AINV_LUMP) {
1977f1580f4eSBarry Smith               PetscCall(MatGetRowSum(P00, v));
1978f1580f4eSBarry Smith               if (A00 == P00) PetscCall(PetscObjectReference((PetscObject)A00));
1979f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1980f1580f4eSBarry Smith               PetscCall(VecGetArrayRead(v, &array));
1981db4a47b3SPierre Jolivet               PetscCall(MatCreateAIJ(PetscObjectComm((PetscObject)A00), A00->rmap->n, A00->cmap->n, A00->rmap->N, A00->cmap->N, 1, nullptr, 0, nullptr, &P00));
1982f1580f4eSBarry Smith               PetscCall(MatSetOption(P00, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
1983f1580f4eSBarry Smith               for (n = A00->rmap->rstart; n < A00->rmap->rend; ++n) PetscCall(MatSetValue(P00, n, n, array[n - A00->rmap->rstart], INSERT_VALUES));
1984f1580f4eSBarry Smith               PetscCall(MatAssemblyBegin(P00, MAT_FINAL_ASSEMBLY));
1985f1580f4eSBarry Smith               PetscCall(MatAssemblyEnd(P00, MAT_FINAL_ASSEMBLY));
1986f1580f4eSBarry Smith               PetscCall(VecRestoreArrayRead(v, &array));
1987f1580f4eSBarry Smith               PetscCall(MatSchurComplementUpdateSubMatrices(P, A00, P00, A01, A10, A11)); /* replace P00 by diag(sum of each row of P00) */
1988f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1989f1580f4eSBarry Smith             } else PetscCall(MatGetDiagonal(P00, v));
1990f1580f4eSBarry Smith             PetscCall(VecReciprocal(v)); /* inv(diag(P00))       */
1991f1580f4eSBarry Smith             PetscCall(VecSqrtAbs(v));    /* sqrt(inv(diag(P00))) */
1992f1580f4eSBarry Smith             PetscCall(MatDuplicate(A01, MAT_COPY_VALUES, &B));
1993db4a47b3SPierre Jolivet             PetscCall(MatDiagonalScale(B, v, nullptr));
1994281f8ce6SPierre Jolivet             if (B01) PetscCall(MatDiagonalScale(B01, v, nullptr));
1995f1580f4eSBarry Smith             PetscCall(VecDestroy(&v));
1996f1580f4eSBarry Smith             PetscCall(MatCreateNormalHermitian(B, &N));
1997281f8ce6SPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, B, N, &P, pcpre, &diagonal, B01));
1998f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
1999f1580f4eSBarry Smith             if (!flg) {
2000f1580f4eSBarry Smith               PetscCall(MatDestroy(&P));
2001f1580f4eSBarry Smith               P = N;
2002f1580f4eSBarry Smith               PetscCall(PetscObjectReference((PetscObject)P));
2003feebddf4SPierre Jolivet             }
20043df4cd7bSPierre Jolivet             if (diagonal) {
20053df4cd7bSPierre Jolivet               PetscCall(MatDiagonalSet(P, diagonal, ADD_VALUES));
2006feebddf4SPierre Jolivet               PetscCall(PCSetOperators(pc, P, P)); /* replace P by A01^T inv(diag(P00)) A01 - diag(P11) */
20073df4cd7bSPierre Jolivet               PetscCall(VecDestroy(&diagonal));
2008281f8ce6SPierre Jolivet             } else PetscCall(PCSetOperators(pc, B01 ? P : N, P));  /* replace P by A01^T inv(diag(P00)) A01                         */
2009feebddf4SPierre Jolivet             pc->ops->postsolve = PCPostSolve_SchurPreLeastSquares; /*  PCFIELDSPLIT expect a KSP for (P11 - A10 inv(diag(P00)) A01) */
2010feebddf4SPierre Jolivet             PetscCall(MatDestroy(&N));                             /*  but a PC for (A10 inv(diag(P00)) A10 - P11) is setup instead */
2011feebddf4SPierre Jolivet             PetscCall(MatDestroy(&P));                             /*  so the sign of the solution must be flipped                  */
2012f1580f4eSBarry Smith             PetscCall(MatDestroy(&B));
201313044ca3SPierre Jolivet           } else
2014fd310a01SPierre 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 : "");
20150307214fSPierre Jolivet           for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
20163ba16761SJacob Faibussowitsch           PetscFunctionReturn(PETSC_SUCCESS);
2017f1580f4eSBarry Smith         } else {
2018db4a47b3SPierre Jolivet           PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_st_pc_type", type, sizeof(type), nullptr));
2019f1580f4eSBarry Smith           PetscCall(PetscStrcmp(type, PCMAT, &algebraic));
2020b07dfdedSPierre Jolivet           PetscCheck(!algebraic || !block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_block_splitting");
20219bb5c669SPierre Jolivet           if (overlap != -1) {
20229bb5c669SPierre Jolivet             PetscCheck(!block && !algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_%s and -pc_hpddm_harmonic_overlap", block ? "block_splitting" : "levels_1_st_pc_type mat");
20239bb5c669SPierre Jolivet             PetscCheck(overlap >= 1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_WRONG, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " < 1", overlap);
20249bb5c669SPierre Jolivet           }
20259bb5c669SPierre Jolivet           if (block || overlap != -1) algebraic = PETSC_TRUE;
2026f1580f4eSBarry Smith           if (algebraic) {
2027f1580f4eSBarry Smith             PetscCall(ISCreateStride(PETSC_COMM_SELF, P->rmap->n, P->rmap->rstart, 1, &data->is));
2028f1580f4eSBarry Smith             PetscCall(MatIncreaseOverlap(P, 1, &data->is, 1));
2029f1580f4eSBarry Smith             PetscCall(ISSort(data->is));
20309bb5c669SPierre Jolivet           } else
20319bb5c669SPierre 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 : ""));
2032f1580f4eSBarry Smith         }
2033f1580f4eSBarry Smith       }
2034f1580f4eSBarry Smith     }
2035f1580f4eSBarry Smith   }
2036398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2037398c7888SPierre Jolivet   if (data->is) PetscCall(ISDuplicate(data->is, &dis));
2038398c7888SPierre Jolivet   if (data->aux) PetscCall(MatDuplicate(data->aux, MAT_COPY_VALUES, &daux));
2039398c7888SPierre Jolivet #endif
2040f1580f4eSBarry Smith   if (data->is || (ismatis && data->N > 1)) {
2041f1580f4eSBarry Smith     if (ismatis) {
2042f1580f4eSBarry Smith       std::initializer_list<std::string> list = {MATSEQBAIJ, MATSEQSBAIJ};
2043f1580f4eSBarry Smith       PetscCall(MatISGetLocalMat(P, &N));
2044f1580f4eSBarry Smith       std::initializer_list<std::string>::const_iterator it = std::find(list.begin(), list.end(), ((PetscObject)N)->type_name);
2045f1580f4eSBarry Smith       PetscCall(MatISRestoreLocalMat(P, &N));
2046f1580f4eSBarry Smith       switch (std::distance(list.begin(), it)) {
2047d71ae5a4SJacob Faibussowitsch       case 0:
2048d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
2049d71ae5a4SJacob Faibussowitsch         break;
2050f1580f4eSBarry Smith       case 1:
2051f1580f4eSBarry Smith         /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIBAIJ */
2052f1580f4eSBarry Smith         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
2053f1580f4eSBarry Smith         PetscCall(MatSetOption(C, MAT_SYMMETRIC, PETSC_TRUE));
2054f1580f4eSBarry Smith         break;
2055d71ae5a4SJacob Faibussowitsch       default:
2056d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, &C));
2057f1580f4eSBarry Smith       }
2058db4a47b3SPierre Jolivet       PetscCall(MatISGetLocalToGlobalMapping(P, &l2g, nullptr));
2059f1580f4eSBarry Smith       PetscCall(PetscObjectReference((PetscObject)P));
2060f1580f4eSBarry Smith       PetscCall(KSPSetOperators(data->levels[0]->ksp, A, C));
2061f1580f4eSBarry Smith       std::swap(C, P);
2062f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingGetSize(l2g, &n));
2063f1580f4eSBarry Smith       PetscCall(ISCreateStride(PETSC_COMM_SELF, n, 0, 1, &loc));
2064f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingApplyIS(l2g, loc, &is[0]));
2065f1580f4eSBarry Smith       PetscCall(ISDestroy(&loc));
2066f1580f4eSBarry Smith       /* the auxiliary Mat is _not_ the local Neumann matrix                                */
2067f1580f4eSBarry Smith       /* it is the local Neumann matrix augmented (with zeros) through MatIncreaseOverlap() */
2068c8ea6600SPierre Jolivet       data->Neumann = PETSC_BOOL3_FALSE;
2069f1580f4eSBarry Smith       structure     = SAME_NONZERO_PATTERN;
2070f1580f4eSBarry Smith     } else {
2071f1580f4eSBarry Smith       is[0] = data->is;
207213044ca3SPierre Jolivet       if (algebraic || ctx) subdomains = PETSC_TRUE;
2073db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_define_subdomains", &subdomains, nullptr));
207413044ca3SPierre 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);
2075c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann)) {
2076b07dfdedSPierre Jolivet         PetscCheck(!block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_block_splitting and -pc_hpddm_has_neumann");
20779bb5c669SPierre Jolivet         PetscCheck(overlap == -1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " and -pc_hpddm_has_neumann", overlap);
2078b07dfdedSPierre Jolivet         PetscCheck(!algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_has_neumann");
2079f1580f4eSBarry Smith       }
2080c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann) || block) structure = SAME_NONZERO_PATTERN;
2081f1580f4eSBarry Smith       PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), P->rmap->n, P->rmap->rstart, 1, &loc));
2082f1580f4eSBarry Smith     }
2083f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2084db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetEnum(nullptr, prefix, "-st_matstructure", MatStructures, (PetscEnum *)&structure, &flg)); /* if not user-provided, force its value when possible */
2085f1580f4eSBarry Smith     if (!flg && structure == SAME_NONZERO_PATTERN) {                                                                   /* cannot call STSetMatStructure() yet, insert the appropriate option in the database, parsed by STSetFromOptions() */
2086f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-%spc_hpddm_levels_1_st_matstructure", pcpre ? pcpre : ""));
2087db4a47b3SPierre Jolivet       PetscCall(PetscOptionsSetValue(nullptr, prefix, MatStructures[structure]));
2088f1580f4eSBarry Smith     }
2089398c7888SPierre Jolivet     flg = PETSC_FALSE;
2090b07dfdedSPierre Jolivet     if (data->share) {
2091398c7888SPierre Jolivet       data->share = PETSC_FALSE; /* will be reset to PETSC_TRUE if none of the conditions below are true */
2092398c7888SPierre 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 : ""));
2093398c7888SPierre Jolivet       else if (data->deflation) PetscCall(PetscInfo(pc, "Nothing to share since PCHPDDMSetDeflationMat() has been called\n"));
2094398c7888SPierre Jolivet       else if (ismatis) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc with a Pmat of type MATIS\n"));
2095b07dfdedSPierre Jolivet       else if (!algebraic && structure != SAME_NONZERO_PATTERN)
2096398c7888SPierre 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]));
2097398c7888SPierre Jolivet       else data->share = PETSC_TRUE;
2098398c7888SPierre Jolivet     }
2099398c7888SPierre Jolivet     if (!ismatis) {
2100398c7888SPierre Jolivet       if (data->share || (!PetscBool3ToBool(data->Neumann) && subdomains)) PetscCall(ISDuplicate(is[0], &unsorted));
2101398c7888SPierre Jolivet       else unsorted = is[0];
2102398c7888SPierre Jolivet     }
210351ea4bc8SPierre Jolivet     if ((ctx || data->N > 1) && (data->aux || ismatis || algebraic)) {
2104f1580f4eSBarry Smith       PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "HPDDM library not loaded, cannot use more than one level");
2105f1580f4eSBarry Smith       PetscCall(MatSetOption(P, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
2106f1580f4eSBarry Smith       if (ismatis) {
2107f1580f4eSBarry Smith         /* needed by HPDDM (currently) so that the partition of unity is 0 on subdomain interfaces */
2108f1580f4eSBarry Smith         PetscCall(MatIncreaseOverlap(P, 1, is, 1));
2109f1580f4eSBarry Smith         PetscCall(ISDestroy(&data->is));
2110f1580f4eSBarry Smith         data->is = is[0];
2111f1580f4eSBarry Smith       } else {
2112d16c0b94SPierre Jolivet         if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_TRUE));
211351ea4bc8SPierre Jolivet         if (!ctx && overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", PCHPDDMAlgebraicAuxiliaryMat_Private));
21149bb5c669SPierre Jolivet         if (!PetscBool3ToBool(data->Neumann) && (!algebraic || overlap != -1)) {
2115f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
2116f1580f4eSBarry Smith           if (flg) {
2117f1580f4eSBarry Smith             /* maybe better to ISSort(is[0]), MatCreateSubMatrices(), and then MatPermute() */
2118f1580f4eSBarry Smith             /* but there is no MatPermute_SeqSBAIJ(), so as before, just use MATMPIBAIJ     */
2119f1580f4eSBarry Smith             PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &uaux));
2120f1580f4eSBarry Smith             flg = PETSC_FALSE;
2121f1580f4eSBarry Smith           }
2122f1580f4eSBarry Smith         }
2123f1580f4eSBarry Smith       }
21249bb5c669SPierre Jolivet       if (algebraic && overlap == -1) {
2125f1580f4eSBarry Smith         PetscUseMethod(pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", (Mat, IS *, Mat *[], PetscBool), (P, is, &sub, block));
2126f1580f4eSBarry Smith         if (block) {
2127f1580f4eSBarry Smith           PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", (PetscObject *)&data->aux));
2128db4a47b3SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", nullptr));
2129f1580f4eSBarry Smith         }
21309bb5c669SPierre Jolivet       } else if (!uaux || overlap != -1) {
213113044ca3SPierre Jolivet         if (!ctx) {
2132c8ea6600SPierre Jolivet           if (PetscBool3ToBool(data->Neumann)) sub = &data->aux;
21339bb5c669SPierre Jolivet           else {
2134df21ef68SPierre Jolivet             PetscBool flg;
21359bb5c669SPierre Jolivet             if (overlap != -1) {
21369bb5c669SPierre Jolivet               Harmonic              h;
21379bb5c669SPierre Jolivet               Mat                   A0, *a;                    /* with an SVD: [ A_00  A_01       ] */
21389bb5c669SPierre Jolivet               IS                    ov[2], rows, cols, stride; /*              [ A_10  A_11  A_12 ] */
213958b7e2c1SStefano Zampini               const PetscInt       *i[2], bs = P->cmap->bs;    /* with a GEVP: [ A_00  A_01       ] */
21409bb5c669SPierre Jolivet               PetscInt              n[2];                      /*              [ A_10  A_11  A_12 ] */
21419bb5c669SPierre Jolivet               std::vector<PetscInt> v[2];                      /*              [       A_21  A_22 ] */
21429bb5c669SPierre Jolivet 
21439bb5c669SPierre Jolivet               PetscCall(ISDuplicate(data->is, ov));
21449bb5c669SPierre Jolivet               if (overlap > 1) PetscCall(MatIncreaseOverlap(P, 1, ov, overlap - 1));
21459bb5c669SPierre Jolivet               PetscCall(ISDuplicate(ov[0], ov + 1));
21469bb5c669SPierre Jolivet               PetscCall(MatIncreaseOverlap(P, 1, ov + 1, 1));
21479bb5c669SPierre Jolivet               PetscCall(PetscNew(&h));
21489bb5c669SPierre Jolivet               h->ksp = nullptr;
21499bb5c669SPierre Jolivet               PetscCall(PetscCalloc1(2, &h->A));
2150*b5a302b3SPierre Jolivet               PetscCall(PetscOptionsHasName(nullptr, prefix, "-eps_nev", &flg));
2151*b5a302b3SPierre Jolivet               if (!flg) {
21523a60673dSPierre Jolivet                 PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_nsv", &flg));
2153*b5a302b3SPierre Jolivet                 if (!flg) PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_threshold_relative", &flg));
2154*b5a302b3SPierre Jolivet               } else flg = PETSC_FALSE;
21559bb5c669SPierre Jolivet               PetscCall(ISSort(ov[0]));
21569bb5c669SPierre Jolivet               if (!flg) PetscCall(ISSort(ov[1]));
215732603206SJames Wright               PetscCall(PetscCalloc1(5, &h->is));
21589bb5c669SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, ov + !flg, ov + 1, MAT_INITIAL_MATRIX, &a)); /* submatrix from above, either square (!flg) or rectangular (flg) */
21599bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) {
21609bb5c669SPierre Jolivet                 PetscCall(ISGetIndices(ov[j], i + j));
21619bb5c669SPierre Jolivet                 PetscCall(ISGetLocalSize(ov[j], n + j));
21629bb5c669SPierre Jolivet               }
21639bb5c669SPierre Jolivet               v[1].reserve((n[1] - n[0]) / bs);
21649bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[1]; j += bs) { /* indices of the (2,2) block */
21659bb5c669SPierre Jolivet                 PetscInt location;
21669bb5c669SPierre Jolivet                 PetscCall(ISLocate(ov[0], i[1][j], &location));
21679bb5c669SPierre Jolivet                 if (location < 0) v[1].emplace_back(j / bs);
21689bb5c669SPierre Jolivet               }
21699bb5c669SPierre Jolivet               if (!flg) {
21709bb5c669SPierre Jolivet                 h->A[1] = a[0];
21719bb5c669SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)h->A[1]));
21729bb5c669SPierre Jolivet                 v[0].reserve((n[0] - P->rmap->n) / bs);
21739bb5c669SPierre Jolivet                 for (PetscInt j = 0; j < n[1]; j += bs) { /* row indices of the (1,2) block */
21749bb5c669SPierre Jolivet                   PetscInt location;
21759bb5c669SPierre Jolivet                   PetscCall(ISLocate(loc, i[1][j], &location));
21769bb5c669SPierre Jolivet                   if (location < 0) {
21779bb5c669SPierre Jolivet                     PetscCall(ISLocate(ov[0], i[1][j], &location));
21789bb5c669SPierre Jolivet                     if (location >= 0) v[0].emplace_back(j / bs);
21799bb5c669SPierre Jolivet                   }
21809bb5c669SPierre Jolivet                 }
21819bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
21829bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_COPY_VALUES, h->is + 4));
21839bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, h->is[4], MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
21849bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
21859bb5c669SPierre 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 */
21869bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &rows));
21879bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols = rows, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
21889bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
21899bb5c669SPierre Jolivet                 v[0].clear();
21909bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, ov[1], PETSC_TRUE, h->is + 3));
21919bb5c669SPierre Jolivet                 PetscCall(ISEmbed(data->is, ov[1], PETSC_TRUE, h->is + 2));
21929bb5c669SPierre Jolivet               }
21939bb5c669SPierre Jolivet               v[0].reserve((n[0] - P->rmap->n) / bs);
21949bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[0]; j += bs) {
21959bb5c669SPierre Jolivet                 PetscInt location;
21969bb5c669SPierre Jolivet                 PetscCall(ISLocate(loc, i[0][j], &location));
21979bb5c669SPierre Jolivet                 if (location < 0) v[0].emplace_back(j / bs);
21989bb5c669SPierre Jolivet               }
21999bb5c669SPierre Jolivet               PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
22009bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISRestoreIndices(ov[j], i + j));
22019bb5c669SPierre Jolivet               if (flg) {
22029bb5c669SPierre Jolivet                 IS is;
22039bb5c669SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, a[0]->rmap->n, 0, 1, &is));
22049bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &cols));
22059bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], is, cols, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
22069bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
22079bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&is));
22089bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatConvert(A0, MATSEQSBAIJ, MAT_INPLACE_MATRIX, &A0)); /* initial Pmat was MATSBAIJ, convert back to the same format since this submatrix is square */
22099bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, data->is, PETSC_TRUE, h->is + 2));
22109bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_USE_POINTER, &cols));
22119bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols, MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
22129bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
22139bb5c669SPierre Jolivet               }
22149bb5c669SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, A0->rmap->n, 0, 1, &stride));
22159bb5c669SPierre Jolivet               PetscCall(ISEmbed(rows, stride, PETSC_TRUE, h->is));
22169bb5c669SPierre Jolivet               PetscCall(ISDestroy(&stride));
22179bb5c669SPierre Jolivet               PetscCall(ISDestroy(&rows));
22189bb5c669SPierre Jolivet               PetscCall(ISEmbed(loc, ov[0], PETSC_TRUE, h->is + 1));
22199bb5c669SPierre Jolivet               if (subdomains) {
22209bb5c669SPierre Jolivet                 if (!data->levels[0]->pc) {
22219bb5c669SPierre Jolivet                   PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
22229bb5c669SPierre Jolivet                   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
22239bb5c669SPierre Jolivet                   PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
22249bb5c669SPierre Jolivet                   PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
22259bb5c669SPierre Jolivet                 }
22269bb5c669SPierre Jolivet                 PetscCall(PCSetType(data->levels[0]->pc, PCASM));
22279bb5c669SPierre Jolivet                 if (!data->levels[0]->pc->setupcalled) PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, ov + !flg, &loc));
22289bb5c669SPierre Jolivet                 PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, flg ? A0 : a[0], PETSC_TRUE));
22299bb5c669SPierre Jolivet                 if (!flg) ++overlap;
22309bb5c669SPierre Jolivet                 if (data->share) {
22319bb5c669SPierre Jolivet                   PetscInt n = -1;
22329bb5c669SPierre Jolivet                   PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
22339bb5c669SPierre Jolivet                   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
22349bb5c669SPierre Jolivet                   if (flg) {
22359bb5c669SPierre Jolivet                     h->ksp = ksp[0];
22369bb5c669SPierre Jolivet                     PetscCall(PetscObjectReference((PetscObject)h->ksp));
22379bb5c669SPierre Jolivet                   }
22389bb5c669SPierre Jolivet                 }
22399bb5c669SPierre Jolivet               }
22409bb5c669SPierre Jolivet               if (!h->ksp) {
22419bb5c669SPierre Jolivet                 PetscBool share = data->share;
22429bb5c669SPierre Jolivet                 PetscCall(KSPCreate(PETSC_COMM_SELF, &h->ksp));
22439bb5c669SPierre Jolivet                 PetscCall(KSPSetType(h->ksp, KSPPREONLY));
22449bb5c669SPierre Jolivet                 PetscCall(KSPSetOperators(h->ksp, A0, A0));
22459bb5c669SPierre Jolivet                 do {
22469bb5c669SPierre Jolivet                   if (!data->share) {
22479bb5c669SPierre Jolivet                     share = PETSC_FALSE;
22489bb5c669SPierre Jolivet                     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_%s", pcpre ? pcpre : "", flg ? "svd_" : "eps_"));
22499bb5c669SPierre Jolivet                     PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
22509bb5c669SPierre Jolivet                     PetscCall(KSPSetFromOptions(h->ksp));
22519bb5c669SPierre Jolivet                   } else {
22529bb5c669SPierre Jolivet                     MatSolverType type;
22539bb5c669SPierre Jolivet                     PetscCall(KSPGetPC(ksp[0], &pc));
22549bb5c669SPierre Jolivet                     PetscCall(PetscObjectTypeCompareAny((PetscObject)pc, &data->share, PCLU, PCCHOLESKY, ""));
22559bb5c669SPierre Jolivet                     if (data->share) {
22569bb5c669SPierre Jolivet                       PetscCall(PCFactorGetMatSolverType(pc, &type));
22579bb5c669SPierre Jolivet                       if (!type) {
22589bb5c669SPierre Jolivet                         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMUMPS));
22599bb5c669SPierre Jolivet                         else if (PetscDefined(HAVE_MKL_PARDISO)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMKL_PARDISO));
22609bb5c669SPierre Jolivet                         else data->share = PETSC_FALSE;
22619bb5c669SPierre Jolivet                         if (data->share) PetscCall(PCSetFromOptions(pc));
22629bb5c669SPierre Jolivet                       } else {
22639bb5c669SPierre Jolivet                         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &data->share));
22649bb5c669SPierre Jolivet                         if (!data->share) PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &data->share));
22659bb5c669SPierre Jolivet                       }
22669bb5c669SPierre Jolivet                       if (data->share) {
22679bb5c669SPierre Jolivet                         std::tuple<KSP, IS, Vec[2]> *p;
22689bb5c669SPierre Jolivet                         PetscCall(PCFactorGetMatrix(pc, &A));
22699bb5c669SPierre Jolivet                         PetscCall(MatFactorSetSchurIS(A, h->is[4]));
22709bb5c669SPierre Jolivet                         PetscCall(KSPSetUp(ksp[0]));
22719bb5c669SPierre Jolivet                         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_eps_shell_", pcpre ? pcpre : ""));
22729bb5c669SPierre Jolivet                         PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
22739bb5c669SPierre Jolivet                         PetscCall(KSPSetFromOptions(h->ksp));
22749bb5c669SPierre Jolivet                         PetscCall(KSPGetPC(h->ksp, &pc));
22759bb5c669SPierre Jolivet                         PetscCall(PCSetType(pc, PCSHELL));
22769bb5c669SPierre Jolivet                         PetscCall(PetscNew(&p));
22779bb5c669SPierre Jolivet                         std::get<0>(*p) = ksp[0];
22789bb5c669SPierre Jolivet                         PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &std::get<1>(*p)));
22799bb5c669SPierre Jolivet                         PetscCall(MatCreateVecs(A, std::get<2>(*p), std::get<2>(*p) + 1));
22809bb5c669SPierre Jolivet                         PetscCall(PCShellSetContext(pc, p));
22819bb5c669SPierre Jolivet                         PetscCall(PCShellSetApply(pc, PCApply_Schur));
22829bb5c669SPierre Jolivet                         PetscCall(PCShellSetApplyTranspose(pc, PCApply_Schur<Vec, true>));
22839bb5c669SPierre Jolivet                         PetscCall(PCShellSetMatApply(pc, PCApply_Schur<Mat>));
22849bb5c669SPierre Jolivet                         PetscCall(PCShellSetDestroy(pc, PCDestroy_Schur));
22859bb5c669SPierre Jolivet                       }
22869bb5c669SPierre Jolivet                     }
22879bb5c669SPierre Jolivet                     if (!data->share) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since neither MUMPS nor MKL PARDISO is used\n"));
22889bb5c669SPierre Jolivet                   }
22899bb5c669SPierre 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 */
22909bb5c669SPierre Jolivet               }
22919bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov));
22929bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov + 1));
22939bb5c669SPierre Jolivet               if (overlap == 1 && subdomains && flg) {
22949bb5c669SPierre Jolivet                 *subA = A0;
22959bb5c669SPierre Jolivet                 sub   = subA;
22969bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatDestroy(&uaux));
22979bb5c669SPierre Jolivet               } else PetscCall(MatDestroy(&A0));
22989bb5c669SPierre Jolivet               PetscCall(MatCreateShell(PETSC_COMM_SELF, P->rmap->n, n[1] - n[0], P->rmap->n, n[1] - n[0], h, &data->aux));
2299bdcd51b8SPierre Jolivet               PetscCall(KSPSetErrorIfNotConverged(h->ksp, PETSC_TRUE)); /* bail out as early as possible to avoid (apparently) unrelated error messages */
23009bb5c669SPierre Jolivet               PetscCall(MatCreateVecs(h->ksp->pc->pmat, &h->v, nullptr));
23019bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT, (void (*)(void))MatMult_Harmonic));
23029bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMultTranspose_Harmonic));
23039bb5c669SPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AB, nullptr, MatProduct_AB_Harmonic, nullptr, MATDENSE, MATDENSE));
23049bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_DESTROY, (void (*)(void))MatDestroy_Harmonic));
23059bb5c669SPierre Jolivet               PetscCall(MatDestroySubMatrices(1, &a));
23069bb5c669SPierre Jolivet             }
2307df21ef68SPierre Jolivet             if (overlap != 1 || !subdomains) {
2308df21ef68SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2309df21ef68SPierre Jolivet               if (ismatis) {
2310df21ef68SPierre Jolivet                 PetscCall(MatISGetLocalMat(C, &N));
2311df21ef68SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)N, MATSEQSBAIJ, &flg));
2312df21ef68SPierre Jolivet                 if (flg) PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2313df21ef68SPierre Jolivet                 PetscCall(MatISRestoreLocalMat(C, &N));
2314df21ef68SPierre Jolivet               }
2315df21ef68SPierre Jolivet             }
23169bb5c669SPierre Jolivet             if (uaux) {
23179bb5c669SPierre Jolivet               PetscCall(MatDestroy(&uaux));
23189bb5c669SPierre Jolivet               PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
23199bb5c669SPierre Jolivet             }
23209bb5c669SPierre Jolivet           }
232113044ca3SPierre Jolivet         }
232251ea4bc8SPierre Jolivet       } else if (!ctx) {
2323f1580f4eSBarry Smith         PetscCall(MatCreateSubMatrices(uaux, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2324f1580f4eSBarry Smith         PetscCall(MatDestroy(&uaux));
2325f1580f4eSBarry Smith         PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2326f1580f4eSBarry Smith       }
232751ea4bc8SPierre Jolivet       if (data->N > 1) {
2328f1580f4eSBarry Smith         /* Vec holding the partition of unity */
2329f1580f4eSBarry Smith         if (!data->levels[0]->D) {
2330f1580f4eSBarry Smith           PetscCall(ISGetLocalSize(data->is, &n));
2331f1580f4eSBarry Smith           PetscCall(VecCreateMPI(PETSC_COMM_SELF, n, PETSC_DETERMINE, &data->levels[0]->D));
2332f1580f4eSBarry Smith         }
23339bb5c669SPierre Jolivet         if (data->share && overlap == -1) {
2334f1580f4eSBarry Smith           Mat      D;
2335db4a47b3SPierre Jolivet           IS       perm = nullptr;
2336f1580f4eSBarry Smith           PetscInt size = -1;
2337811e8887SPierre Jolivet 
2338398c7888SPierre Jolivet           if (!data->levels[0]->pc) {
2339398c7888SPierre Jolivet             PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2340398c7888SPierre Jolivet             PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
2341398c7888SPierre Jolivet             PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
2342398c7888SPierre Jolivet             PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
2343398c7888SPierre Jolivet           }
2344398c7888SPierre Jolivet           PetscCall(PCSetType(data->levels[0]->pc, PCASM));
234513044ca3SPierre Jolivet           if (!ctx) {
2346398c7888SPierre Jolivet             if (!data->levels[0]->pc->setupcalled) {
2347398c7888SPierre Jolivet               IS sorted; /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2348398c7888SPierre Jolivet               PetscCall(ISDuplicate(is[0], &sorted));
2349398c7888SPierre Jolivet               PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &sorted, &loc));
2350398c7888SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)sorted));
2351398c7888SPierre Jolivet             }
2352398c7888SPierre Jolivet             PetscCall(PCSetFromOptions(data->levels[0]->pc));
2353398c7888SPierre Jolivet             if (block) {
2354398c7888SPierre Jolivet               PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, sub[0], &C, &perm));
2355398c7888SPierre Jolivet               PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, C, algebraic));
2356398c7888SPierre Jolivet             } else PetscCall(PCSetUp(data->levels[0]->pc));
2357db4a47b3SPierre Jolivet             PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &size, nullptr, &ksp));
2358398c7888SPierre Jolivet             if (size != 1) {
2359398c7888SPierre Jolivet               data->share = PETSC_FALSE;
2360398c7888SPierre Jolivet               PetscCheck(size == -1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", size);
2361398c7888SPierre Jolivet               PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since PCASMGetSubKSP() not found in fine-level PC\n"));
2362398c7888SPierre Jolivet               PetscCall(ISDestroy(&unsorted));
2363398c7888SPierre Jolivet               unsorted = is[0];
2364398c7888SPierre Jolivet             } else {
2365811e8887SPierre Jolivet               const char *matpre;
2366811e8887SPierre Jolivet               PetscBool   cmp[4];
2367811e8887SPierre Jolivet 
236813044ca3SPierre Jolivet               if (!block && !ctx) PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, PetscBool3ToBool(data->Neumann) ? sub[0] : data->aux, &C, &perm));
236951ea4bc8SPierre Jolivet               if (perm) { /* unsorted input IS */
2370c8ea6600SPierre Jolivet                 if (!PetscBool3ToBool(data->Neumann) && !block) {
2371f1580f4eSBarry Smith                   PetscCall(MatPermute(sub[0], perm, perm, &D)); /* permute since PCASM will call ISSort() */
2372f1580f4eSBarry Smith                   PetscCall(MatHeaderReplace(sub[0], &D));
2373f1580f4eSBarry Smith                 }
2374f1580f4eSBarry Smith                 if (data->B) { /* see PCHPDDMSetRHSMat() */
2375f1580f4eSBarry Smith                   PetscCall(MatPermute(data->B, perm, perm, &D));
2376f1580f4eSBarry Smith                   PetscCall(MatHeaderReplace(data->B, &D));
2377f1580f4eSBarry Smith                 }
2378f1580f4eSBarry Smith                 PetscCall(ISDestroy(&perm));
237951ea4bc8SPierre Jolivet               }
2380f1580f4eSBarry Smith               PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
23810307214fSPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)subA[0]));
2382f1580f4eSBarry Smith               PetscCall(MatDuplicate(subA[1], MAT_SHARE_NONZERO_PATTERN, &D));
2383f1580f4eSBarry Smith               PetscCall(MatGetOptionsPrefix(subA[1], &matpre));
2384f1580f4eSBarry Smith               PetscCall(MatSetOptionsPrefix(D, matpre));
2385f1580f4eSBarry Smith               PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMAL, cmp));
2386f1580f4eSBarry Smith               PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMAL, cmp + 1));
2387f1580f4eSBarry Smith               if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMALHERMITIAN, cmp + 2));
2388f1580f4eSBarry Smith               else cmp[2] = PETSC_FALSE;
2389f1580f4eSBarry Smith               if (!cmp[1]) PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMALHERMITIAN, cmp + 3));
2390f1580f4eSBarry Smith               else cmp[3] = PETSC_FALSE;
2391f1580f4eSBarry 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);
2392f1580f4eSBarry Smith               if (!cmp[0] && !cmp[2]) {
2393f1580f4eSBarry Smith                 if (!block) PetscCall(MatAXPY(D, 1.0, C, SUBSET_NONZERO_PATTERN));
23945c7345deSPierre Jolivet                 else {
2395db4a47b3SPierre Jolivet                   PetscCall(MatMissingDiagonal(D, cmp, nullptr));
23965c7345deSPierre Jolivet                   if (cmp[0]) structure = DIFFERENT_NONZERO_PATTERN; /* data->aux has no missing diagonal entry */
23975c7345deSPierre Jolivet                   PetscCall(MatAXPY(D, 1.0, data->aux, structure));
23985c7345deSPierre Jolivet                 }
2399f1580f4eSBarry Smith               } else {
2400f1580f4eSBarry Smith                 Mat mat[2];
2401811e8887SPierre Jolivet 
2402f1580f4eSBarry Smith                 if (cmp[0]) {
2403f1580f4eSBarry Smith                   PetscCall(MatNormalGetMat(D, mat));
2404f1580f4eSBarry Smith                   PetscCall(MatNormalGetMat(C, mat + 1));
2405f1580f4eSBarry Smith                 } else {
2406f1580f4eSBarry Smith                   PetscCall(MatNormalHermitianGetMat(D, mat));
2407f1580f4eSBarry Smith                   PetscCall(MatNormalHermitianGetMat(C, mat + 1));
2408f1580f4eSBarry Smith                 }
2409f1580f4eSBarry Smith                 PetscCall(MatAXPY(mat[0], 1.0, mat[1], SUBSET_NONZERO_PATTERN));
2410f1580f4eSBarry Smith               }
2411f1580f4eSBarry Smith               PetscCall(MatPropagateSymmetryOptions(C, D));
2412f1580f4eSBarry Smith               PetscCall(MatDestroy(&C));
2413f1580f4eSBarry Smith               C = D;
2414f1580f4eSBarry Smith               /* swap pointers so that variables stay consistent throughout PCSetUp() */
2415f1580f4eSBarry Smith               std::swap(C, data->aux);
2416f1580f4eSBarry Smith               std::swap(uis, data->is);
2417f1580f4eSBarry Smith               swap = PETSC_TRUE;
2418f1580f4eSBarry Smith             }
2419f1580f4eSBarry Smith           }
242013044ca3SPierre Jolivet         }
242151ea4bc8SPierre Jolivet       }
242213044ca3SPierre Jolivet       if (ctx) {
242313044ca3SPierre Jolivet         PC_HPDDM              *data_00 = (PC_HPDDM *)std::get<0>(*ctx)[0]->data;
242413044ca3SPierre Jolivet         PC                     s;
242500b491fbSPierre Jolivet         Mat                    A00, P00, A01 = nullptr, A10, A11, N, b[4];
242607d8d47fSPierre Jolivet         IS                     sorted, is[2], *is_00;
242713044ca3SPierre Jolivet         MatSolverType          type;
242813044ca3SPierre Jolivet         std::pair<PC, Vec[2]> *p;
242913044ca3SPierre Jolivet 
243007d8d47fSPierre Jolivet         n = -1;
243107d8d47fSPierre Jolivet         PetscTryMethod(data_00->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data_00->levels[0]->pc, &n, nullptr, &ksp));
243207d8d47fSPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
243307d8d47fSPierre Jolivet         PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
243407d8d47fSPierre Jolivet         PetscCall(ISGetLocalSize(data_00->is, &n));
243507d8d47fSPierre Jolivet         if (n != subA[0]->rmap->n || n != subA[0]->cmap->n) {
243607d8d47fSPierre Jolivet           PetscCall(PCASMGetLocalSubdomains(data_00->levels[0]->pc, &n, &is_00, nullptr));
243707d8d47fSPierre Jolivet           PetscCall(ISGetLocalSize(*is_00, &n));
243807d8d47fSPierre 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);
243907d8d47fSPierre Jolivet         } else is_00 = &data_00->is;
244013044ca3SPierre Jolivet         PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, data->aux, &C, nullptr)); /* permute since PCASM works with a sorted IS */
244113044ca3SPierre Jolivet         std::swap(C, data->aux);
244213044ca3SPierre Jolivet         std::swap(uis, data->is);
244313044ca3SPierre Jolivet         swap = PETSC_TRUE;
244413044ca3SPierre Jolivet         PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, std::get<1>(*ctx), &A10, &A11));
244513044ca3SPierre Jolivet         std::get<1>(*ctx)[1] = A10;
244613044ca3SPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
244713044ca3SPierre Jolivet         if (flg) PetscCall(MatTransposeGetMat(A10, &A01));
244813044ca3SPierre Jolivet         else {
244913044ca3SPierre Jolivet           PetscBool flg;
245013044ca3SPierre Jolivet 
245113044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
245213044ca3SPierre Jolivet           if (flg) PetscCall(MatHermitianTransposeGetMat(A10, &A01));
245313044ca3SPierre Jolivet         }
245407d8d47fSPierre 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 */
245513044ca3SPierre Jolivet         PetscCall(ISSort(sorted));               /* this is to avoid changing users inputs, but it requires a new call to ISSort() here                                                                                               */
245600b491fbSPierre Jolivet         if (!A01) {
245700b491fbSPierre Jolivet           PetscCall(MatSetOption(A10, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
245800b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A10, 1, &data->is, &sorted, MAT_INITIAL_MATRIX, &sub));
245900b491fbSPierre Jolivet           b[2] = sub[0];
246000b491fbSPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
246100b491fbSPierre Jolivet           PetscCall(MatDestroySubMatrices(1, &sub));
246200b491fbSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATTRANSPOSEVIRTUAL, &flg));
246300b491fbSPierre Jolivet           A10 = nullptr;
246400b491fbSPierre Jolivet           if (flg) PetscCall(MatTransposeGetMat(std::get<1>(*ctx)[0], &A10));
246513044ca3SPierre Jolivet           else {
246600b491fbSPierre Jolivet             PetscBool flg;
246700b491fbSPierre Jolivet 
2468c71f06a7SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATHERMITIANTRANSPOSEVIRTUAL, &flg));
246900b491fbSPierre Jolivet             if (flg) PetscCall(MatHermitianTransposeGetMat(std::get<1>(*ctx)[0], &A10));
247013044ca3SPierre Jolivet           }
2471811e8887SPierre Jolivet           if (!A10) PetscCall(MatCreateSubMatrices(std::get<1>(*ctx)[0], 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2472811e8887SPierre Jolivet           else {
2473811e8887SPierre Jolivet             if (flg) PetscCall(MatCreateTranspose(b[2], b + 1));
2474811e8887SPierre Jolivet             else PetscCall(MatCreateHermitianTranspose(b[2], b + 1));
247500b491fbSPierre Jolivet           }
247600b491fbSPierre Jolivet         } else {
247700b491fbSPierre Jolivet           PetscCall(MatSetOption(A01, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
247800b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A01, 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2479811e8887SPierre Jolivet           if (flg) PetscCall(MatCreateTranspose(*sub, b + 2));
2480811e8887SPierre Jolivet           else PetscCall(MatCreateHermitianTranspose(*sub, b + 2));
2481811e8887SPierre Jolivet         }
2482811e8887SPierre Jolivet         if (A01 || !A10) {
2483811e8887SPierre Jolivet           b[1] = sub[0];
2484811e8887SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
248500b491fbSPierre Jolivet         }
248600b491fbSPierre Jolivet         PetscCall(MatDestroySubMatrices(1, &sub));
248713044ca3SPierre Jolivet         PetscCall(ISDestroy(&sorted));
248851ea4bc8SPierre Jolivet         b[3] = data->aux;
248951ea4bc8SPierre Jolivet         PetscCall(MatCreateSchurComplement(subA[0], subA[1], b[1], b[2], b[3], &S));
249013044ca3SPierre Jolivet         PetscCall(MatSchurComplementSetKSP(S, ksp[0]));
249151ea4bc8SPierre Jolivet         if (data->N != 1) {
249251ea4bc8SPierre Jolivet           PetscCall(PCASMSetType(data->levels[0]->pc, PC_ASM_NONE)); /* "Neumann--Neumann" preconditioning with overlap and a Boolean partition of unity */
249351ea4bc8SPierre Jolivet           PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &data->is, &loc));
249451ea4bc8SPierre Jolivet           PetscCall(PCSetFromOptions(data->levels[0]->pc)); /* action of eq. (15) of https://hal.science/hal-02343808v6/document (with a sign flip) */
249551ea4bc8SPierre Jolivet           s = data->levels[0]->pc;
249651ea4bc8SPierre Jolivet         } else {
249751ea4bc8SPierre Jolivet           is[0] = data->is;
249851ea4bc8SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)is[0]));
249951ea4bc8SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)b[3]));
250051ea4bc8SPierre Jolivet           PetscCall(PCSetType(pc, PCASM));                          /* change the type of the current PC */
250151ea4bc8SPierre Jolivet           data = nullptr;                                           /* destroyed in the previous PCSetType(), so reset to NULL to avoid any faulty use */
250251ea4bc8SPierre Jolivet           PetscCall(PCAppendOptionsPrefix(pc, "pc_hpddm_coarse_")); /* same prefix as when using PCHPDDM with a single level */
250351ea4bc8SPierre Jolivet           PetscCall(PCASMSetLocalSubdomains(pc, 1, is, &loc));
250451ea4bc8SPierre Jolivet           PetscCall(ISDestroy(is));
250551ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&loc));
250651ea4bc8SPierre Jolivet           s = pc;
250751ea4bc8SPierre Jolivet         }
250851ea4bc8SPierre Jolivet         PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(s, S, PETSC_TRUE)); /* the subdomain Mat is already known and the input IS of PCASMSetLocalSubdomains() is already sorted */
250951ea4bc8SPierre Jolivet         PetscTryMethod(s, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (s, &n, nullptr, &ksp));
251013044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
251113044ca3SPierre Jolivet         PetscCall(KSPGetPC(ksp[0], &inner));
251213044ca3SPierre Jolivet         PetscCall(PCSetType(inner, PCSHELL)); /* compute the action of the inverse of the local Schur complement with a PCSHELL */
251313044ca3SPierre Jolivet         b[0] = subA[0];
251413044ca3SPierre 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 */
251551ea4bc8SPierre Jolivet         if (!data) PetscCall(PetscObjectDereference((PetscObject)b[3]));
251600b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[1]));
251700b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[2]));
251813044ca3SPierre Jolivet         PetscCall(PCCreate(PETSC_COMM_SELF, &s));
251913044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(s, ((PetscObject)inner)->prefix));
252013044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(inner, nullptr));
252113044ca3SPierre Jolivet         PetscCall(KSPSetSkipPCSetFromOptions(ksp[0], PETSC_TRUE));
252213044ca3SPierre Jolivet         PetscCall(PCSetType(s, PCLU));
252351ea4bc8SPierre 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 */
252413044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(s));
252513044ca3SPierre Jolivet         PetscCall(PCFactorGetMatSolverType(s, &type));
252613044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
252751ea4bc8SPierre Jolivet         PetscCall(MatGetLocalSize(A11, &n, nullptr));
252851ea4bc8SPierre Jolivet         if (flg || n == 0) {
252913044ca3SPierre Jolivet           PetscCall(PCSetOperators(s, N, N));
253051ea4bc8SPierre Jolivet           if (n) {
253100b491fbSPierre Jolivet             PetscCall(PCFactorGetMatrix(s, b));
253200b491fbSPierre Jolivet             PetscCall(MatSetOptionsPrefix(*b, ((PetscObject)s)->prefix));
253324ddd604SPierre Jolivet             n = -1;
253424ddd604SPierre Jolivet             PetscCall(PetscOptionsGetInt(nullptr, ((PetscObject)s)->prefix, "-mat_mumps_icntl_26", &n, nullptr));
2535f45b553cSPierre Jolivet             if (n == 1) {                                /* allocates a square MatDense of size is[1]->map->n, so one */
2536f45b553cSPierre Jolivet               PetscCall(MatNestGetISs(N, is, nullptr));  /*  needs to be able to deactivate this path when dealing    */
2537f45b553cSPierre Jolivet               PetscCall(MatFactorSetSchurIS(*b, is[1])); /*  with a large constraint space in order to avoid OOM      */
2538f45b553cSPierre Jolivet             }
253951ea4bc8SPierre Jolivet           } else PetscCall(PCSetType(s, PCNONE)); /* empty local Schur complement (e.g., centralized on another process) */
254013044ca3SPierre Jolivet         } else {
254100b491fbSPierre Jolivet           PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, b));
254200b491fbSPierre Jolivet           PetscCall(PCSetOperators(s, N, *b));
254300b491fbSPierre Jolivet           PetscCall(PetscObjectDereference((PetscObject)*b));
254451ea4bc8SPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)s, &flg, PCLU, PCCHOLESKY, PCILU, PCICC, PCQR, ""));
254551ea4bc8SPierre 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 */
254613044ca3SPierre Jolivet         }
254713044ca3SPierre Jolivet         PetscCall(PetscNew(&p));
254813044ca3SPierre Jolivet         p->first = s;
254951ea4bc8SPierre Jolivet         if (n != 0) PetscCall(MatCreateVecs(*b, p->second, p->second + 1));
255051ea4bc8SPierre Jolivet         else p->second[0] = p->second[1] = nullptr;
255113044ca3SPierre Jolivet         PetscCall(PCShellSetContext(inner, p));
255213044ca3SPierre Jolivet         PetscCall(PCShellSetApply(inner, PCApply_Nest));
255313044ca3SPierre Jolivet         PetscCall(PCShellSetView(inner, PCView_Nest));
255413044ca3SPierre Jolivet         PetscCall(PCShellSetDestroy(inner, PCDestroy_Nest));
255513044ca3SPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)N));
255651ea4bc8SPierre Jolivet         if (!data) {
255751ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&S));
255851ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&unsorted));
255951ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&C));
256051ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&uis));
256151ea4bc8SPierre Jolivet           PetscCall(PetscFree(ctx));
256251ea4bc8SPierre Jolivet #if PetscDefined(USE_DEBUG)
256351ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&dis));
256451ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&daux));
256551ea4bc8SPierre Jolivet #endif
256651ea4bc8SPierre Jolivet           PetscFunctionReturn(PETSC_SUCCESS);
256751ea4bc8SPierre Jolivet         }
256813044ca3SPierre Jolivet       }
2569f1580f4eSBarry Smith       if (!data->levels[0]->scatter) {
2570db4a47b3SPierre Jolivet         PetscCall(MatCreateVecs(P, &xin, nullptr));
2571f1580f4eSBarry Smith         if (ismatis) PetscCall(MatDestroy(&P));
2572db4a47b3SPierre Jolivet         PetscCall(VecScatterCreate(xin, data->is, data->levels[0]->D, nullptr, &data->levels[0]->scatter));
2573f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
2574f1580f4eSBarry Smith       }
2575f1580f4eSBarry Smith       if (data->levels[0]->P) {
2576f1580f4eSBarry Smith         /* if the pattern is the same and PCSetUp() has previously succeeded, reuse HPDDM buffers and connectivity */
2577371d2eb7SMartin Diehl         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[0], !pc->setupcalled || pc->flag == DIFFERENT_NONZERO_PATTERN ? PETSC_TRUE : PETSC_FALSE));
2578f1580f4eSBarry Smith       }
2579f1580f4eSBarry Smith       if (!data->levels[0]->P) data->levels[0]->P = new HPDDM::Schwarz<PetscScalar>();
2580db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2581db4a47b3SPierre Jolivet       else PetscCall(PetscLogEventBegin(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2582f1580f4eSBarry Smith       /* HPDDM internal data structure */
258313044ca3SPierre Jolivet       PetscCall(data->levels[0]->P->structure(loc, data->is, !ctx ? sub[0] : nullptr, ismatis ? C : data->aux, data->levels));
2584db4a47b3SPierre Jolivet       if (!data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2585f1580f4eSBarry Smith       /* matrix pencil of the generalized eigenvalue problem on the overlap (GenEO) */
258613044ca3SPierre Jolivet       if (!ctx) {
25879bb5c669SPierre Jolivet         if (data->deflation || overlap != -1) weighted = data->aux;
2588f1580f4eSBarry Smith         else if (!data->B) {
2589e2b46ddfSPierre Jolivet           PetscBool cmp;
2590811e8887SPierre Jolivet 
2591f1580f4eSBarry Smith           PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &weighted));
2592e2b46ddfSPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)weighted, &cmp, MATNORMAL, MATNORMALHERMITIAN, ""));
2593e2b46ddfSPierre Jolivet           if (cmp) flg = PETSC_FALSE;
2594e2b46ddfSPierre Jolivet           PetscCall(MatDiagonalScale(weighted, data->levels[0]->D, data->levels[0]->D));
25955b0bb9f2SPierre Jolivet           /* neither MatDuplicate() nor MatDiagonalScale() handles the symmetry options, so propagate the options explicitly */
2596f1580f4eSBarry Smith           /* only useful for -mat_type baij -pc_hpddm_levels_1_st_pc_type cholesky (no problem with MATAIJ or MATSBAIJ)      */
2597f1580f4eSBarry Smith           PetscCall(MatPropagateSymmetryOptions(sub[0], weighted));
2598f1580f4eSBarry Smith         } else weighted = data->B;
259913044ca3SPierre Jolivet       } else weighted = nullptr;
2600f1580f4eSBarry Smith       /* SLEPc is used inside the loaded symbol */
26019bb5c669SPierre 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));
26029bb5c669SPierre Jolivet       if (!ctx && data->share && overlap == -1) {
2603f1580f4eSBarry Smith         Mat st[2];
2604f1580f4eSBarry Smith         PetscCall(KSPGetOperators(ksp[0], st, st + 1));
26055c7345deSPierre Jolivet         PetscCall(MatCopy(subA[0], st[0], structure));
2606f1580f4eSBarry Smith         if (subA[1] != subA[0] || st[1] != st[0]) PetscCall(MatCopy(subA[1], st[1], SAME_NONZERO_PATTERN));
26070307214fSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)subA[0]));
2608f1580f4eSBarry Smith       }
2609db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2610f1580f4eSBarry Smith       if (ismatis) PetscCall(MatISGetLocalMat(C, &N));
2611f1580f4eSBarry Smith       else N = data->aux;
261213044ca3SPierre Jolivet       if (!ctx) P = sub[0];
261313044ca3SPierre Jolivet       else P = S;
2614f1580f4eSBarry Smith       /* going through the grid hierarchy */
2615f1580f4eSBarry Smith       for (n = 1; n < data->N; ++n) {
2616db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2617f1580f4eSBarry Smith         /* method composed in the loaded symbol since there, SLEPc is used as well */
2618f1580f4eSBarry 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));
2619db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2620f1580f4eSBarry Smith       }
2621f1580f4eSBarry Smith       /* reset to NULL to avoid any faulty use */
2622db4a47b3SPierre Jolivet       PetscCall(PetscObjectComposeFunction((PetscObject)data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", nullptr));
2623db4a47b3SPierre Jolivet       if (!ismatis) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_C", nullptr));
2624f1580f4eSBarry Smith       else PetscCall(PetscObjectDereference((PetscObject)C)); /* matching PetscObjectReference() above */
2625f1580f4eSBarry Smith       for (n = 0; n < data->N - 1; ++n)
2626f1580f4eSBarry Smith         if (data->levels[n]->P) {
2627f1580f4eSBarry Smith           /* HPDDM internal work buffers */
2628f1580f4eSBarry Smith           data->levels[n]->P->setBuffer();
2629f1580f4eSBarry Smith           data->levels[n]->P->super::start();
2630f1580f4eSBarry Smith         }
26319bb5c669SPierre Jolivet       if (ismatis || !subdomains) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
2632db4a47b3SPierre Jolivet       if (ismatis) data->is = nullptr;
2633f1580f4eSBarry Smith       for (n = 0; n < data->N - 1 + (reused > 0); ++n) {
2634f1580f4eSBarry Smith         if (data->levels[n]->P) {
2635f1580f4eSBarry Smith           PC spc;
2636f1580f4eSBarry Smith 
2637f1580f4eSBarry Smith           /* force the PC to be PCSHELL to do the coarse grid corrections */
2638f1580f4eSBarry Smith           PetscCall(KSPSetSkipPCSetFromOptions(data->levels[n]->ksp, PETSC_TRUE));
2639f1580f4eSBarry Smith           PetscCall(KSPGetPC(data->levels[n]->ksp, &spc));
2640f1580f4eSBarry Smith           PetscCall(PCSetType(spc, PCSHELL));
2641f1580f4eSBarry Smith           PetscCall(PCShellSetContext(spc, data->levels[n]));
2642f1580f4eSBarry Smith           PetscCall(PCShellSetSetUp(spc, PCSetUp_HPDDMShell));
2643f1580f4eSBarry Smith           PetscCall(PCShellSetApply(spc, PCApply_HPDDMShell));
2644f1580f4eSBarry Smith           PetscCall(PCShellSetMatApply(spc, PCMatApply_HPDDMShell));
264513044ca3SPierre Jolivet           if (ctx && n == 0) {
264613044ca3SPierre Jolivet             Mat                               Amat, Pmat;
264713044ca3SPierre Jolivet             PetscInt                          m, M;
264801e3c840SPierre Jolivet             std::tuple<Mat, PetscSF, Vec[2]> *ctx;
264913044ca3SPierre Jolivet 
265013044ca3SPierre Jolivet             PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &Pmat));
265113044ca3SPierre Jolivet             PetscCall(MatGetLocalSize(Pmat, &m, nullptr));
265213044ca3SPierre Jolivet             PetscCall(MatGetSize(Pmat, &M, nullptr));
265313044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));
265413044ca3SPierre Jolivet             std::get<0>(*ctx) = S;
265513044ca3SPierre Jolivet             std::get<1>(*ctx) = data->levels[n]->scatter;
265613044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)data->levels[n]->ksp), m, m, M, M, ctx, &Amat));
265713044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT, (void (*)(void))MatMult_Schur<false>));
265813044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMult_Schur<true>));
265913044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_DESTROY, (void (*)(void))MatDestroy_Schur));
266013044ca3SPierre Jolivet             PetscCall(MatCreateVecs(S, std::get<2>(*ctx), std::get<2>(*ctx) + 1));
266113044ca3SPierre Jolivet             PetscCall(KSPSetOperators(data->levels[n]->ksp, Amat, Pmat));
266213044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)Amat));
266313044ca3SPierre Jolivet           }
2664f1580f4eSBarry Smith           PetscCall(PCShellSetDestroy(spc, PCDestroy_HPDDMShell));
2665f1580f4eSBarry Smith           if (!data->levels[n]->pc) PetscCall(PCCreate(PetscObjectComm((PetscObject)data->levels[n]->ksp), &data->levels[n]->pc));
2666f1580f4eSBarry Smith           if (n < reused) {
2667f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(spc, PETSC_TRUE));
2668f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
2669f1580f4eSBarry Smith           }
2670f1580f4eSBarry Smith           PetscCall(PCSetUp(spc));
2671f1580f4eSBarry Smith         }
2672f1580f4eSBarry Smith       }
267313044ca3SPierre Jolivet       if (ctx) PetscCall(MatDestroy(&S));
26749bb5c669SPierre Jolivet       if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", nullptr));
2675f1580f4eSBarry Smith     } else flg = reused ? PETSC_FALSE : PETSC_TRUE;
2676f1580f4eSBarry Smith     if (!ismatis && subdomains) {
2677f1580f4eSBarry Smith       if (flg) PetscCall(KSPGetPC(data->levels[0]->ksp, &inner));
2678f1580f4eSBarry Smith       else inner = data->levels[0]->pc;
2679f1580f4eSBarry Smith       if (inner) {
2680398c7888SPierre Jolivet         if (!inner->setupcalled) PetscCall(PCSetType(inner, PCASM));
2681398c7888SPierre Jolivet         PetscCall(PCSetFromOptions(inner));
2682398c7888SPierre Jolivet         PetscCall(PetscStrcmp(((PetscObject)inner)->type_name, PCASM, &flg));
2683398c7888SPierre Jolivet         if (flg) {
2684f1580f4eSBarry Smith           if (!inner->setupcalled) { /* evaluates to PETSC_FALSE when -pc_hpddm_block_splitting */
2685398c7888SPierre Jolivet             IS sorted;               /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2686811e8887SPierre Jolivet 
2687398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2688398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(inner, 1, &sorted, &loc));
2689398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2690398c7888SPierre Jolivet           }
2691c8ea6600SPierre Jolivet           if (!PetscBool3ToBool(data->Neumann) && data->N > 1) { /* subdomain matrices are already created for the eigenproblem, reuse them for the fine-level PC */
2692db4a47b3SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(*is, nullptr, nullptr, sub[0], &P, nullptr));
2693398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(inner, P, algebraic));
2694398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)P));
2695f1580f4eSBarry Smith           }
2696f1580f4eSBarry Smith         }
2697f1580f4eSBarry Smith       }
26989bb5c669SPierre Jolivet       if (data->N > 1) {
26999bb5c669SPierre Jolivet         if (overlap != 1) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
27009bb5c669SPierre Jolivet         if (overlap == 1) PetscCall(MatDestroy(subA));
27019bb5c669SPierre Jolivet       }
2702f1580f4eSBarry Smith     }
2703f1580f4eSBarry Smith     PetscCall(ISDestroy(&loc));
2704f1580f4eSBarry Smith   } else data->N = 1 + reused; /* enforce this value to 1 + reused if there is no way to build another level */
2705f1580f4eSBarry Smith   if (requested != data->N + reused) {
2706f1580f4eSBarry 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,
2707f1580f4eSBarry Smith                         data->N, pcpre ? pcpre : ""));
2708*b5a302b3SPierre 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 : "",
2709*b5a302b3SPierre Jolivet                         data->N, pcpre ? pcpre : "", data->N));
2710f1580f4eSBarry Smith     /* cannot use PCDestroy_HPDDMShell() because PCSHELL not set for unassembled levels */
2711f1580f4eSBarry Smith     for (n = data->N - 1; n < requested - 1; ++n) {
2712f1580f4eSBarry Smith       if (data->levels[n]->P) {
2713f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[n], PETSC_TRUE));
2714f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(1, &data->levels[n]->v[0]));
2715f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(2, &data->levels[n]->v[1]));
2716f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V));
2717f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 1));
2718f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 2));
2719f1580f4eSBarry Smith         PetscCall(VecDestroy(&data->levels[n]->D));
272001e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&data->levels[n]->scatter));
2721f1580f4eSBarry Smith       }
2722f1580f4eSBarry Smith     }
2723f1580f4eSBarry Smith     if (reused) {
2724f1580f4eSBarry Smith       for (n = reused; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
2725f1580f4eSBarry Smith         PetscCall(KSPDestroy(&data->levels[n]->ksp));
2726f1580f4eSBarry Smith         PetscCall(PCDestroy(&data->levels[n]->pc));
2727f1580f4eSBarry Smith       }
2728f1580f4eSBarry Smith     }
2729*b5a302b3SPierre 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,
2730*b5a302b3SPierre Jolivet                data->N, reused, data->N, pcpre ? pcpre : "", pcpre ? pcpre : "", data->N, pcpre ? pcpre : "", data->N);
2731f1580f4eSBarry Smith   }
2732f1580f4eSBarry Smith   /* these solvers are created after PCSetFromOptions() is called */
2733f1580f4eSBarry Smith   if (pc->setfromoptionscalled) {
2734f1580f4eSBarry Smith     for (n = 0; n < data->N; ++n) {
2735f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetFromOptions(data->levels[n]->ksp));
2736f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetFromOptions(data->levels[n]->pc));
2737f1580f4eSBarry Smith     }
2738f1580f4eSBarry Smith     pc->setfromoptionscalled = 0;
2739f1580f4eSBarry Smith   }
2740f1580f4eSBarry Smith   data->N += reused;
2741f1580f4eSBarry Smith   if (data->share && swap) {
2742f1580f4eSBarry Smith     /* swap back pointers so that variables follow the user-provided numbering */
2743f1580f4eSBarry Smith     std::swap(C, data->aux);
2744f1580f4eSBarry Smith     std::swap(uis, data->is);
2745f1580f4eSBarry Smith     PetscCall(MatDestroy(&C));
2746f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
2747f1580f4eSBarry Smith   }
2748398c7888SPierre Jolivet   if (algebraic) PetscCall(MatDestroy(&data->aux));
274938fb34a1SPierre Jolivet   if (unsorted && unsorted != is[0]) {
2750398c7888SPierre Jolivet     PetscCall(ISCopy(unsorted, data->is));
2751398c7888SPierre Jolivet     PetscCall(ISDestroy(&unsorted));
2752398c7888SPierre Jolivet   }
2753398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2754398c7888SPierre 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);
2755398c7888SPierre Jolivet   if (data->is) {
2756398c7888SPierre Jolivet     PetscCall(ISEqualUnsorted(data->is, dis, &flg));
2757398c7888SPierre Jolivet     PetscCall(ISDestroy(&dis));
2758398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input IS and output IS are not equal");
2759398c7888SPierre Jolivet   }
2760398c7888SPierre 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);
2761398c7888SPierre Jolivet   if (data->aux) {
2762398c7888SPierre Jolivet     PetscCall(MatMultEqual(data->aux, daux, 20, &flg));
2763398c7888SPierre Jolivet     PetscCall(MatDestroy(&daux));
2764398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input Mat and output Mat are not equal");
2765398c7888SPierre Jolivet   }
2766398c7888SPierre Jolivet #endif
27673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2768f1580f4eSBarry Smith }
2769f1580f4eSBarry Smith 
2770f1580f4eSBarry Smith /*@
2771f1580f4eSBarry Smith   PCHPDDMSetCoarseCorrectionType - Sets the coarse correction type.
2772f1580f4eSBarry Smith 
2773c3339decSBarry Smith   Collective
2774f1580f4eSBarry Smith 
2775f1580f4eSBarry Smith   Input Parameters:
2776f1580f4eSBarry Smith + pc   - preconditioner context
2777aa1539e9SPierre Jolivet - type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2778f1580f4eSBarry Smith 
2779f1580f4eSBarry Smith   Options Database Key:
2780aa1539e9SPierre Jolivet . -pc_hpddm_coarse_correction <deflated, additive, balanced, none> - type of coarse correction to apply
2781f1580f4eSBarry Smith 
2782f1580f4eSBarry Smith   Level: intermediate
2783f1580f4eSBarry Smith 
2784562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2785f1580f4eSBarry Smith @*/
2786d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType type)
2787d71ae5a4SJacob Faibussowitsch {
2788f1580f4eSBarry Smith   PetscFunctionBegin;
2789f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2790f1580f4eSBarry Smith   PetscValidLogicalCollectiveEnum(pc, type, 2);
2791f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMSetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType), (pc, type));
27923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2793f1580f4eSBarry Smith }
2794f1580f4eSBarry Smith 
2795f1580f4eSBarry Smith /*@
2796f1580f4eSBarry Smith   PCHPDDMGetCoarseCorrectionType - Gets the coarse correction type.
2797f1580f4eSBarry Smith 
2798f1580f4eSBarry Smith   Input Parameter:
2799f1580f4eSBarry Smith . pc - preconditioner context
2800f1580f4eSBarry Smith 
2801f1580f4eSBarry Smith   Output Parameter:
2802aa1539e9SPierre Jolivet . type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2803f1580f4eSBarry Smith 
2804f1580f4eSBarry Smith   Level: intermediate
2805f1580f4eSBarry Smith 
2806562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2807f1580f4eSBarry Smith @*/
2808d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType *type)
2809d71ae5a4SJacob Faibussowitsch {
2810f1580f4eSBarry Smith   PetscFunctionBegin;
2811f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2812f1580f4eSBarry Smith   if (type) {
28134f572ea9SToby Isaac     PetscAssertPointer(type, 2);
2814f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType *), (pc, type));
2815f1580f4eSBarry Smith   }
28163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2817f1580f4eSBarry Smith }
2818f1580f4eSBarry Smith 
2819d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType type)
2820d71ae5a4SJacob Faibussowitsch {
2821f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2822f1580f4eSBarry Smith 
2823f1580f4eSBarry Smith   PetscFunctionBegin;
2824f1580f4eSBarry Smith   data->correction = type;
28253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2826f1580f4eSBarry Smith }
2827f1580f4eSBarry Smith 
2828d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType *type)
2829d71ae5a4SJacob Faibussowitsch {
2830f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2831f1580f4eSBarry Smith 
2832f1580f4eSBarry Smith   PetscFunctionBegin;
2833f1580f4eSBarry Smith   *type = data->correction;
28343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2835f1580f4eSBarry Smith }
2836f1580f4eSBarry Smith 
2837f1580f4eSBarry Smith /*@
2838e31fc274SPierre Jolivet   PCHPDDMSetSTShareSubKSP - Sets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver should be shared.
2839e31fc274SPierre Jolivet 
2840e31fc274SPierre Jolivet   Input Parameters:
2841e31fc274SPierre Jolivet + pc    - preconditioner context
2842e31fc274SPierre Jolivet - share - whether the `KSP` should be shared or not
2843e31fc274SPierre Jolivet 
2844e31fc274SPierre Jolivet   Note:
2845e31fc274SPierre Jolivet   This is not the same as `PCSetReusePreconditioner()`. Given certain conditions (visible using -info), a symbolic factorization can be skipped
2846e31fc274SPierre Jolivet   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2847e31fc274SPierre Jolivet 
2848e31fc274SPierre Jolivet   Level: advanced
2849e31fc274SPierre Jolivet 
2850562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMGetSTShareSubKSP()`
2851e31fc274SPierre Jolivet @*/
2852e31fc274SPierre Jolivet PetscErrorCode PCHPDDMSetSTShareSubKSP(PC pc, PetscBool share)
2853e31fc274SPierre Jolivet {
2854e31fc274SPierre Jolivet   PetscFunctionBegin;
2855e31fc274SPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2856e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetSTShareSubKSP_C", (PC, PetscBool), (pc, share));
28573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2858e31fc274SPierre Jolivet }
2859e31fc274SPierre Jolivet 
2860e31fc274SPierre Jolivet /*@
2861f1580f4eSBarry Smith   PCHPDDMGetSTShareSubKSP - Gets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver is shared.
2862f1580f4eSBarry Smith 
2863f1580f4eSBarry Smith   Input Parameter:
2864f1580f4eSBarry Smith . pc - preconditioner context
2865f1580f4eSBarry Smith 
2866f1580f4eSBarry Smith   Output Parameter:
2867f1580f4eSBarry Smith . share - whether the `KSP` is shared or not
2868f1580f4eSBarry Smith 
2869f1580f4eSBarry Smith   Note:
2870f1580f4eSBarry 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
2871f1580f4eSBarry Smith   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2872f1580f4eSBarry Smith 
2873f1580f4eSBarry Smith   Level: advanced
2874f1580f4eSBarry Smith 
2875562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetSTShareSubKSP()`
2876f1580f4eSBarry Smith @*/
2877d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetSTShareSubKSP(PC pc, PetscBool *share)
2878d71ae5a4SJacob Faibussowitsch {
2879f1580f4eSBarry Smith   PetscFunctionBegin;
2880f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2881f1580f4eSBarry Smith   if (share) {
28824f572ea9SToby Isaac     PetscAssertPointer(share, 2);
2883f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetSTShareSubKSP_C", (PC, PetscBool *), (pc, share));
2884f1580f4eSBarry Smith   }
28853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2886f1580f4eSBarry Smith }
2887f1580f4eSBarry Smith 
2888e31fc274SPierre Jolivet static PetscErrorCode PCHPDDMSetSTShareSubKSP_HPDDM(PC pc, PetscBool share)
2889e31fc274SPierre Jolivet {
2890e31fc274SPierre Jolivet   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2891e31fc274SPierre Jolivet 
2892e31fc274SPierre Jolivet   PetscFunctionBegin;
2893e31fc274SPierre Jolivet   data->share = share;
28943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2895e31fc274SPierre Jolivet }
2896e31fc274SPierre Jolivet 
2897d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetSTShareSubKSP_HPDDM(PC pc, PetscBool *share)
2898d71ae5a4SJacob Faibussowitsch {
2899f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2900f1580f4eSBarry Smith 
2901f1580f4eSBarry Smith   PetscFunctionBegin;
2902f1580f4eSBarry Smith   *share = data->share;
29033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2904f1580f4eSBarry Smith }
2905f1580f4eSBarry Smith 
2906f1580f4eSBarry Smith /*@
2907f1580f4eSBarry Smith   PCHPDDMSetDeflationMat - Sets the deflation space used to assemble a coarser operator.
2908f1580f4eSBarry Smith 
2909f1580f4eSBarry Smith   Input Parameters:
2910f1580f4eSBarry Smith + pc - preconditioner context
2911f1580f4eSBarry Smith . is - index set of the local deflation matrix
2912f1580f4eSBarry Smith - U  - deflation sequential matrix stored as a `MATSEQDENSE`
2913f1580f4eSBarry Smith 
2914f1580f4eSBarry Smith   Level: advanced
2915f1580f4eSBarry Smith 
2916562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCDeflationSetSpace()`, `PCMGSetRestriction()`
2917f1580f4eSBarry Smith @*/
2918d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetDeflationMat(PC pc, IS is, Mat U)
2919d71ae5a4SJacob Faibussowitsch {
2920f1580f4eSBarry Smith   PetscFunctionBegin;
2921f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2922f1580f4eSBarry Smith   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
2923f1580f4eSBarry Smith   PetscValidHeaderSpecific(U, MAT_CLASSID, 3);
2924e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetDeflationMat_C", (PC, IS, Mat), (pc, is, U));
29253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2926f1580f4eSBarry Smith }
2927f1580f4eSBarry Smith 
2928d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetDeflationMat_HPDDM(PC pc, IS is, Mat U)
2929d71ae5a4SJacob Faibussowitsch {
2930f1580f4eSBarry Smith   PetscFunctionBegin;
2931f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, U, PETSC_TRUE));
29323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2933f1580f4eSBarry Smith }
2934f1580f4eSBarry Smith 
2935d71ae5a4SJacob Faibussowitsch PetscErrorCode HPDDMLoadDL_Private(PetscBool *found)
2936d71ae5a4SJacob Faibussowitsch {
2937605ad303SPierre Jolivet   PetscBool flg;
2938f1580f4eSBarry Smith   char      lib[PETSC_MAX_PATH_LEN], dlib[PETSC_MAX_PATH_LEN], dir[PETSC_MAX_PATH_LEN];
2939f1580f4eSBarry Smith 
2940f1580f4eSBarry Smith   PetscFunctionBegin;
29414f572ea9SToby Isaac   PetscAssertPointer(found, 1);
2942c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(dir, "${PETSC_LIB_DIR}", sizeof(dir)));
2943db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, nullptr, "-hpddm_dir", dir, sizeof(dir), nullptr));
2944f1580f4eSBarry Smith   PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2945f1580f4eSBarry Smith   PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2946605ad303SPierre Jolivet #if defined(SLEPC_LIB_DIR) /* this variable is passed during SLEPc ./configure when PETSc has not been configured   */
2947605ad303SPierre Jolivet   if (!*found) {           /* with --download-hpddm since slepcconf.h is not yet built (and thus can't be included) */
2948c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(dir, HPDDM_STR(SLEPC_LIB_DIR), sizeof(dir)));
2949f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2950f1580f4eSBarry Smith     PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2951f1580f4eSBarry Smith   }
2952f1580f4eSBarry Smith #endif
2953605ad303SPierre 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 */
2954605ad303SPierre Jolivet     PetscCall(PetscOptionsGetenv(PETSC_COMM_SELF, "SLEPC_DIR", dir, sizeof(dir), &flg));
2955605ad303SPierre 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 */
2956605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libslepc", dir));
2957605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2958605ad303SPierre Jolivet       PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found but SLEPC_DIR=%s", lib, dir);
2959605ad303SPierre Jolivet       PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
2960605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libhpddm_petsc", dir)); /* libhpddm_petsc is always in the same directory as libslepc */
2961605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2962605ad303SPierre Jolivet     }
2963605ad303SPierre Jolivet   }
2964f1580f4eSBarry Smith   PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found", lib);
2965f1580f4eSBarry Smith   PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
29663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2967f1580f4eSBarry Smith }
2968f1580f4eSBarry Smith 
2969f1580f4eSBarry Smith /*MC
2970f1580f4eSBarry Smith    PCHPDDM - Interface with the HPDDM library.
2971f1580f4eSBarry Smith 
29721d27aa22SBarry Smith    This `PC` may be used to build multilevel spectral domain decomposition methods based on the GenEO framework {cite}`spillane2011robust` {cite}`al2021multilevel`.
29731d27aa22SBarry Smith    It may be viewed as an alternative to spectral
29741d27aa22SBarry Smith    AMGe or `PCBDDC` with adaptive selection of constraints. The interface is explained in details in {cite}`jolivetromanzampini2020`
2975f1580f4eSBarry Smith 
2976e7593814SPierre 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`).
2977f1580f4eSBarry Smith 
2978f1580f4eSBarry Smith    For multilevel preconditioning, when using an assembled or hierarchical Pmat, one must provide an auxiliary local `Mat` (unassembled local operator for GenEO) using
2979f1580f4eSBarry Smith    `PCHPDDMSetAuxiliaryMat()`. Calling this routine is not needed when using a `MATIS` Pmat, assembly is done internally using `MatConvert()`.
2980f1580f4eSBarry Smith 
2981f1580f4eSBarry Smith    Options Database Keys:
2982f1580f4eSBarry Smith +   -pc_hpddm_define_subdomains <true, default=false>    - on the finest level, calls `PCASMSetLocalSubdomains()` with the `IS` supplied in `PCHPDDMSetAuxiliaryMat()`
2983f1580f4eSBarry Smith                                                          (not relevant with an unassembled Pmat)
2984f1580f4eSBarry Smith .   -pc_hpddm_has_neumann <true, default=false>          - on the finest level, informs the `PC` that the local Neumann matrix is supplied in `PCHPDDMSetAuxiliaryMat()`
2985f1580f4eSBarry Smith -   -pc_hpddm_coarse_correction <type, default=deflated> - determines the `PCHPDDMCoarseCorrectionType` when calling `PCApply()`
2986f1580f4eSBarry Smith 
298738bf2a8cSPierre Jolivet    Options for subdomain solvers, subdomain eigensolvers (for computing deflation vectors), and the coarse solver can be set using the following options database prefixes.
2988f1580f4eSBarry Smith .vb
2989f1580f4eSBarry Smith       -pc_hpddm_levels_%d_pc_
2990f1580f4eSBarry Smith       -pc_hpddm_levels_%d_ksp_
2991f1580f4eSBarry Smith       -pc_hpddm_levels_%d_eps_
2992f1580f4eSBarry Smith       -pc_hpddm_levels_%d_p
29934ec2a359SPierre Jolivet       -pc_hpddm_levels_%d_mat_type
2994f1580f4eSBarry Smith       -pc_hpddm_coarse_
2995f1580f4eSBarry Smith       -pc_hpddm_coarse_p
29964ec2a359SPierre Jolivet       -pc_hpddm_coarse_mat_type
29972ce66baaSPierre Jolivet       -pc_hpddm_coarse_mat_filter
2998f1580f4eSBarry Smith .ve
2999f1580f4eSBarry Smith 
300038bf2a8cSPierre 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
3001f1580f4eSBarry Smith     -pc_hpddm_coarse_p 2 -pc_hpddm_coarse_mat_type baij will use 10 deflation vectors per subdomain on the fine "level 1",
3002f1580f4eSBarry Smith     aggregate the fine subdomains into 4 "level 2" subdomains, then use 10 deflation vectors per subdomain on "level 2",
30037eb095acSPierre Jolivet     and assemble the coarse matrix (of dimension 4 x 10 = 40) on two processes as a `MATBAIJ` (default is `MATSBAIJ`).
3004f1580f4eSBarry Smith 
3005*b5a302b3SPierre 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.
3006f1580f4eSBarry Smith 
30071d27aa22SBarry Smith    Level: intermediate
30081d27aa22SBarry Smith 
30091d27aa22SBarry Smith    Notes:
30101d27aa22SBarry Smith    This preconditioner requires that PETSc is built with SLEPc (``--download-slepc``).
30111d27aa22SBarry Smith 
30121d27aa22SBarry Smith    By default, the underlying concurrent eigenproblems
30131d27aa22SBarry Smith    are solved using SLEPc shift-and-invert spectral transformation. This is usually what gives the best performance for GenEO, cf.
30141d27aa22SBarry Smith    {cite}`spillane2011robust` {cite}`jolivet2013scalabledd`. As
301538bf2a8cSPierre 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
301638bf2a8cSPierre 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
301738bf2a8cSPierre Jolivet    SLEPc documentation since they are specific to `PCHPDDM`.
301838bf2a8cSPierre Jolivet .vb
301938bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_st_share_sub_ksp
3020*b5a302b3SPierre Jolivet       -pc_hpddm_levels_%d_eps_threshold_absolute
302138bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_eps_use_inertia
302238bf2a8cSPierre Jolivet .ve
302338bf2a8cSPierre Jolivet 
302438bf2a8cSPierre Jolivet    The first option from the list only applies to the fine-level eigensolver, see `PCHPDDMSetSTShareSubKSP()`. The second option from the list is
302538bf2a8cSPierre Jolivet    used to filter eigenmodes retrieved after convergence of `EPSSolve()` at "level N" such that eigenvectors used to define a "level N+1" coarse
3026*b5a302b3SPierre 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
302738bf2a8cSPierre 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
302838bf2a8cSPierre 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
302938bf2a8cSPierre Jolivet    to supply -pc_hpddm_levels_1_eps_nev. This last option also only applies to the fine-level (N = 1) eigensolver.
3030f1580f4eSBarry Smith 
30311d27aa22SBarry Smith    See also {cite}`dolean2015introduction`, {cite}`al2022robust`, {cite}`al2022robustpd`, and {cite}`nataf2022recent`
3032f1580f4eSBarry Smith 
3033562efe2eSBarry Smith .seealso: [](ch_ksp), `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetAuxiliaryMat()`, `MATIS`, `PCBDDC`, `PCDEFLATION`, `PCTELESCOPE`, `PCASM`,
3034e31fc274SPierre Jolivet           `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDMHasNeumannMat()`, `PCHPDDMSetRHSMat()`, `PCHPDDMSetDeflationMat()`, `PCHPDDMSetSTShareSubKSP()`,
3035e31fc274SPierre Jolivet           `PCHPDDMGetSTShareSubKSP()`, `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDMGetComplexities()`
3036f1580f4eSBarry Smith M*/
3037d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_HPDDM(PC pc)
3038d71ae5a4SJacob Faibussowitsch {
3039f1580f4eSBarry Smith   PC_HPDDM *data;
3040f1580f4eSBarry Smith   PetscBool found;
3041f1580f4eSBarry Smith 
3042f1580f4eSBarry Smith   PetscFunctionBegin;
3043f1580f4eSBarry Smith   if (!loadedSym) {
3044f1580f4eSBarry Smith     PetscCall(HPDDMLoadDL_Private(&found));
3045db4a47b3SPierre Jolivet     if (found) PetscCall(PetscDLLibrarySym(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, nullptr, "PCHPDDM_Internal", (void **)&loadedSym));
3046f1580f4eSBarry Smith   }
3047f1580f4eSBarry Smith   PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCHPDDM_Internal symbol not found in loaded libhpddm_petsc");
30484dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&data));
3049f1580f4eSBarry Smith   pc->data                = data;
3050c8ea6600SPierre Jolivet   data->Neumann           = PETSC_BOOL3_UNKNOWN;
3051f1580f4eSBarry Smith   pc->ops->reset          = PCReset_HPDDM;
3052f1580f4eSBarry Smith   pc->ops->destroy        = PCDestroy_HPDDM;
3053f1580f4eSBarry Smith   pc->ops->setfromoptions = PCSetFromOptions_HPDDM;
3054f1580f4eSBarry Smith   pc->ops->setup          = PCSetUp_HPDDM;
3055f1580f4eSBarry Smith   pc->ops->apply          = PCApply_HPDDM;
3056f1580f4eSBarry Smith   pc->ops->matapply       = PCMatApply_HPDDM;
3057f1580f4eSBarry Smith   pc->ops->view           = PCView_HPDDM;
3058f1580f4eSBarry Smith   pc->ops->presolve       = PCPreSolve_HPDDM;
3059f1580f4eSBarry Smith 
3060f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", PCHPDDMSetAuxiliaryMat_HPDDM));
3061f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", PCHPDDMHasNeumannMat_HPDDM));
3062f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", PCHPDDMSetRHSMat_HPDDM));
3063f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", PCHPDDMSetCoarseCorrectionType_HPDDM));
3064f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", PCHPDDMGetCoarseCorrectionType_HPDDM));
3065e31fc274SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", PCHPDDMSetSTShareSubKSP_HPDDM));
3066f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", PCHPDDMGetSTShareSubKSP_HPDDM));
3067f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", PCHPDDMSetDeflationMat_HPDDM));
30683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3069f1580f4eSBarry Smith }
3070f1580f4eSBarry Smith 
3071f1580f4eSBarry Smith /*@C
3072f1580f4eSBarry Smith   PCHPDDMInitializePackage - This function initializes everything in the `PCHPDDM` package. It is called from `PCInitializePackage()`.
3073f1580f4eSBarry Smith 
3074f1580f4eSBarry Smith   Level: developer
3075f1580f4eSBarry Smith 
3076562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscInitialize()`
3077f1580f4eSBarry Smith @*/
3078d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMInitializePackage(void)
3079d71ae5a4SJacob Faibussowitsch {
3080f1580f4eSBarry Smith   char ename[32];
3081f1580f4eSBarry Smith 
3082f1580f4eSBarry Smith   PetscFunctionBegin;
30833ba16761SJacob Faibussowitsch   if (PCHPDDMPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
3084f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_TRUE;
3085f1580f4eSBarry Smith   PetscCall(PetscRegisterFinalize(PCHPDDMFinalizePackage));
3086f1580f4eSBarry Smith   /* general events registered once during package initialization */
3087f1580f4eSBarry Smith   /* some of these events are not triggered in libpetsc,          */
3088f1580f4eSBarry Smith   /* but rather directly in libhpddm_petsc,                       */
3089f1580f4eSBarry Smith   /* which is in charge of performing the following operations    */
3090f1580f4eSBarry Smith 
3091f1580f4eSBarry Smith   /* domain decomposition structure from Pmat sparsity pattern    */
3092f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMStrc", PC_CLASSID, &PC_HPDDM_Strc));
3093f1580f4eSBarry Smith   /* Galerkin product, redistribution, and setup (not triggered in libpetsc)                */
3094f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtAP", PC_CLASSID, &PC_HPDDM_PtAP));
3095f1580f4eSBarry Smith   /* Galerkin product with summation, redistribution, and setup (not triggered in libpetsc) */
3096f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtBP", PC_CLASSID, &PC_HPDDM_PtBP));
3097f1580f4eSBarry Smith   /* next level construction using PtAP and PtBP (not triggered in libpetsc)                */
3098f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMNext", PC_CLASSID, &PC_HPDDM_Next));
3099f1580f4eSBarry Smith   static_assert(PETSC_PCHPDDM_MAXLEVELS <= 9, "PETSC_PCHPDDM_MAXLEVELS value is too high");
3100811e8887SPierre Jolivet   for (PetscInt i = 1; i < PETSC_PCHPDDM_MAXLEVELS; ++i) {
3101f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSetUp L%1" PetscInt_FMT, i));
3102f1580f4eSBarry Smith     /* events during a PCSetUp() at level #i _except_ the assembly */
3103f1580f4eSBarry Smith     /* of the Galerkin operator of the coarser level #(i + 1)      */
3104f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_SetUp[i - 1]));
3105f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSolve L%1" PetscInt_FMT, i));
3106f1580f4eSBarry Smith     /* events during a PCApply() at level #i _except_              */
3107f1580f4eSBarry Smith     /* the KSPSolve() of the coarser level #(i + 1)                */
3108f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_Solve[i - 1]));
3109f1580f4eSBarry Smith   }
31103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3111f1580f4eSBarry Smith }
3112f1580f4eSBarry Smith 
3113f1580f4eSBarry Smith /*@C
3114f1580f4eSBarry Smith   PCHPDDMFinalizePackage - This function frees everything from the `PCHPDDM` package. It is called from `PetscFinalize()`.
3115f1580f4eSBarry Smith 
3116f1580f4eSBarry Smith   Level: developer
3117f1580f4eSBarry Smith 
3118562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscFinalize()`
3119f1580f4eSBarry Smith @*/
3120d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMFinalizePackage(void)
3121d71ae5a4SJacob Faibussowitsch {
3122f1580f4eSBarry Smith   PetscFunctionBegin;
3123f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_FALSE;
31243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3125f1580f4eSBarry Smith }
31269bb5c669SPierre Jolivet 
31279bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat A, Vec x, Vec y)
31289bb5c669SPierre Jolivet {
31299bb5c669SPierre Jolivet   Harmonic h; /* [ A_00  A_01       ], furthermore, A_00 = [ A_loc,loc  A_loc,ovl ], thus, A_01 = [         ] */
31309bb5c669SPierre Jolivet               /* [ A_10  A_11  A_12 ]                      [ A_ovl,loc  A_ovl,ovl ]               [ A_ovl,1 ] */
31319bb5c669SPierre Jolivet   Vec sub;    /*  y = A x = R_loc R_0 [ A_00  A_01 ]^-1                                   R_loc = [  I_loc  ] */
31329bb5c669SPierre Jolivet               /*                      [ A_10  A_11 ]    R_1^T A_12 x                              [         ] */
31339bb5c669SPierre Jolivet   PetscFunctionBegin;
31349bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
31359bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
31369bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
31379bb5c669SPierre Jolivet   PetscCall(MatMult(h->A[0], x, sub));
31389bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
31399bb5c669SPierre Jolivet   PetscCall(KSPSolve(h->ksp, h->v, h->v));
31409bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_REVERSE, y));
31419bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
31429bb5c669SPierre Jolivet }
31439bb5c669SPierre Jolivet 
31449bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat A, Vec y, Vec x)
31459bb5c669SPierre Jolivet {
31469bb5c669SPierre Jolivet   Harmonic h;   /* x = A^T y =            [ A_00  A_01 ]^-T R_0^T R_loc^T y */
31479bb5c669SPierre Jolivet   Vec      sub; /*             A_12^T R_1 [ A_10  A_11 ]                    */
31489bb5c669SPierre Jolivet 
31499bb5c669SPierre Jolivet   PetscFunctionBegin;
31509bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
31519bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
31529bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_FORWARD, y));
31539bb5c669SPierre Jolivet   PetscCall(KSPSolveTranspose(h->ksp, h->v, h->v));
31549bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
31559bb5c669SPierre Jolivet   PetscCall(MatMultTranspose(h->A[0], sub, x));
31569bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
31579bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
31589bb5c669SPierre Jolivet }
31599bb5c669SPierre Jolivet 
31609bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat S, Mat X, Mat Y, void *)
31619bb5c669SPierre Jolivet {
31629bb5c669SPierre Jolivet   Harmonic h;
31639bb5c669SPierre Jolivet   Mat      A, B;
31649bb5c669SPierre Jolivet   Vec      a, b;
31659bb5c669SPierre Jolivet 
31669bb5c669SPierre Jolivet   PetscFunctionBegin;
31679bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
3168fb842aefSJose E. Roman   PetscCall(MatMatMult(h->A[0], X, MAT_INITIAL_MATRIX, PETSC_CURRENT, &A));
31699bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
31709bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
31719bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
31729bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B, i, &b));
31739bb5c669SPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_FORWARD, a));
31749bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B, i, &b));
31759bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
31769bb5c669SPierre Jolivet   }
31779bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
31789bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, B->cmap->n, nullptr, &A));
31799bb5c669SPierre Jolivet   PetscCall(KSPMatSolve(h->ksp, B, A));
31809bb5c669SPierre Jolivet   PetscCall(MatDestroy(&B));
31819bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
31829bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
31839bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &b));
31849bb5c669SPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_REVERSE, b));
31859bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &b));
31869bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
31879bb5c669SPierre Jolivet   }
31889bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
31899bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
31909bb5c669SPierre Jolivet }
31919bb5c669SPierre Jolivet 
31929bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat A)
31939bb5c669SPierre Jolivet {
31949bb5c669SPierre Jolivet   Harmonic h;
31959bb5c669SPierre Jolivet 
31969bb5c669SPierre Jolivet   PetscFunctionBegin;
31979bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
319832603206SJames Wright   for (PetscInt i = 0; i < 5; ++i) PetscCall(ISDestroy(h->is + i));
31999bb5c669SPierre Jolivet   PetscCall(PetscFree(h->is));
32009bb5c669SPierre Jolivet   PetscCall(VecDestroy(&h->v));
32019bb5c669SPierre Jolivet   for (PetscInt i = 0; i < 2; ++i) PetscCall(MatDestroy(h->A + i));
32029bb5c669SPierre Jolivet   PetscCall(PetscFree(h->A));
32039bb5c669SPierre Jolivet   PetscCall(KSPDestroy(&h->ksp));
32049bb5c669SPierre Jolivet   PetscCall(PetscFree(h));
32059bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
32069bb5c669SPierre Jolivet }
3207