xref: /petsc/src/ksp/pc/impls/hpddm/pchpddm.cxx (revision 9640b26a7b197bc83bc18d6c5a4e9a53c0da8fe1)
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;
329b5a302b3SPierre 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));
357b5a302b3SPierre Jolivet     PetscCall(PetscSNPrintf(deprecated, sizeof(deprecated), "-pc_hpddm_levels_%d_eps_threshold", i));
358b5a302b3SPierre Jolivet     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold_absolute", i));
3598cb7430dSRaphael Zanella     PetscCall(PetscOptionsDeprecated(deprecated, prefix, "3.24", nullptr));
360b5a302b3SPierre 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) {
362b5a302b3SPierre 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;
365b5a302b3SPierre 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));
369b5a302b3SPierre 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");
370b5a302b3SPierre Jolivet         if (data->levels[0]->nu == 0) { /* -eps_nev has not been used, so nu is 0 */
371b5a302b3SPierre Jolivet           data->levels[0]->nu = nsv;    /* nu may still be 0 if -svd_nsv has not been used */
372b5a302b3SPierre Jolivet           PetscCall(PetscSNPrintf(deprecated, sizeof(deprecated), "-pc_hpddm_levels_%d_svd_relative_threshold", i));
373b5a302b3SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_threshold_relative", i));
3748cb7430dSRaphael Zanella           PetscCall(PetscOptionsDeprecated(deprecated, prefix, "3.24", nullptr));
375b5a302b3SPierre 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 */
376b5a302b3SPierre Jolivet         }
377b5a302b3SPierre Jolivet         if (data->levels[0]->nu == 0 || nsv == 0) { /* if neither -eps_nev nor -svd_nsv has been used */
378b5a302b3SPierre Jolivet           PetscCall(PetscSNPrintf(deprecated, sizeof(deprecated), "-pc_hpddm_levels_%d_eps_relative_threshold", i));
379b5a302b3SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold_relative", i));
3808cb7430dSRaphael Zanella           PetscCall(PetscOptionsDeprecated(deprecated, prefix, "3.24", nullptr));
381b5a302b3SPierre 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));
382b5a302b3SPierre 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");
383b5a302b3SPierre Jolivet         }
384b5a302b3SPierre 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) {
396b5a302b3SPierre 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 
446d4f06b61SRaphael Zanella template <bool transpose>
447d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDM(PC pc, Vec x, Vec y)
448d71ae5a4SJacob Faibussowitsch {
449f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
450f1580f4eSBarry Smith 
451f1580f4eSBarry Smith   PetscFunctionBegin;
452f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
453f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
454db4a47b3SPierre 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 */
455d4f06b61SRaphael Zanella   if (!transpose) PetscCall(KSPSolve(data->levels[0]->ksp, x, y));
456d4f06b61SRaphael Zanella   else PetscCall(KSPSolveTranspose(data->levels[0]->ksp, x, y));
457db4a47b3SPierre Jolivet   if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
4583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
459f1580f4eSBarry Smith }
460f1580f4eSBarry Smith 
4618cb7430dSRaphael Zanella template <bool transpose>
462d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDM(PC pc, Mat X, Mat Y)
463d71ae5a4SJacob Faibussowitsch {
464f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
465f1580f4eSBarry Smith 
466f1580f4eSBarry Smith   PetscFunctionBegin;
467f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
468f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
4698cb7430dSRaphael Zanella   if (!transpose) PetscCall(KSPMatSolve(data->levels[0]->ksp, X, Y));
4708cb7430dSRaphael Zanella   else PetscCall(KSPMatSolveTranspose(data->levels[0]->ksp, X, Y));
4713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
472f1580f4eSBarry Smith }
473f1580f4eSBarry Smith 
474cc4c1da9SBarry Smith /*@
475f1580f4eSBarry Smith   PCHPDDMGetComplexities - Computes the grid and operator complexities.
476f1580f4eSBarry Smith 
477c71f06a7SPierre Jolivet   Collective
478c71f06a7SPierre Jolivet 
479f1580f4eSBarry Smith   Input Parameter:
480f1580f4eSBarry Smith . pc - preconditioner context
481f1580f4eSBarry Smith 
482f1580f4eSBarry Smith   Output Parameters:
483cc4c1da9SBarry Smith + gc - grid complexity $ \sum_i m_i / m_1 $
484cc4c1da9SBarry Smith - oc - operator complexity $ \sum_i nnz_i / nnz_1 $
485f1580f4eSBarry Smith 
486f1580f4eSBarry Smith   Level: advanced
487f1580f4eSBarry Smith 
488562efe2eSBarry Smith .seealso: [](ch_ksp), `PCMGGetGridComplexity()`, `PCHPDDM`, `PCHYPRE`, `PCGAMG`
489f1580f4eSBarry Smith @*/
490cc4c1da9SBarry Smith PetscErrorCode PCHPDDMGetComplexities(PC pc, PetscReal *gc, PetscReal *oc)
491d71ae5a4SJacob Faibussowitsch {
492f1580f4eSBarry Smith   PC_HPDDM      *data = (PC_HPDDM *)pc->data;
493f1580f4eSBarry Smith   MatInfo        info;
494f1580f4eSBarry Smith   PetscLogDouble accumulate[2]{}, nnz1 = 1.0, m1 = 1.0;
495f1580f4eSBarry Smith 
496f1580f4eSBarry Smith   PetscFunctionBegin;
497715c1178SPierre Jolivet   if (gc) {
498715c1178SPierre Jolivet     PetscAssertPointer(gc, 2);
499715c1178SPierre Jolivet     *gc = 0;
500715c1178SPierre Jolivet   }
501715c1178SPierre Jolivet   if (oc) {
502715c1178SPierre Jolivet     PetscAssertPointer(oc, 3);
503715c1178SPierre Jolivet     *oc = 0;
504715c1178SPierre Jolivet   }
505715c1178SPierre Jolivet   for (PetscInt n = 0; n < data->N; ++n) {
506f1580f4eSBarry Smith     if (data->levels[n]->ksp) {
50713044ca3SPierre Jolivet       Mat       P, A = nullptr;
508715c1178SPierre Jolivet       PetscInt  m;
50913044ca3SPierre Jolivet       PetscBool flg = PETSC_FALSE;
51013044ca3SPierre Jolivet 
511db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &P));
512db4a47b3SPierre Jolivet       PetscCall(MatGetSize(P, &m, nullptr));
513f1580f4eSBarry Smith       accumulate[0] += m;
514f1580f4eSBarry Smith       if (n == 0) {
515f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
516f1580f4eSBarry Smith         if (flg) {
517f1580f4eSBarry Smith           PetscCall(MatConvert(P, MATAIJ, MAT_INITIAL_MATRIX, &A));
518f1580f4eSBarry Smith           P = A;
51913044ca3SPierre Jolivet         } else {
52013044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
52113044ca3SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)P));
522f1580f4eSBarry Smith         }
52313044ca3SPierre Jolivet       }
52413044ca3SPierre Jolivet       if (!A && flg) accumulate[1] += m * m; /* assumption that a MATSCHURCOMPLEMENT is dense if stored explicitly */
52513044ca3SPierre Jolivet       else if (P->ops->getinfo) {
526f1580f4eSBarry Smith         PetscCall(MatGetInfo(P, MAT_GLOBAL_SUM, &info));
527f1580f4eSBarry Smith         accumulate[1] += info.nz_used;
528f1580f4eSBarry Smith       }
529f1580f4eSBarry Smith       if (n == 0) {
530f1580f4eSBarry Smith         m1 = m;
53113044ca3SPierre Jolivet         if (!A && flg) nnz1 = m * m;
53213044ca3SPierre Jolivet         else if (P->ops->getinfo) nnz1 = info.nz_used;
533f1580f4eSBarry Smith         PetscCall(MatDestroy(&P));
534f1580f4eSBarry Smith       }
535f1580f4eSBarry Smith     }
536f1580f4eSBarry Smith   }
537715c1178SPierre Jolivet   /* only process #0 has access to the full hierarchy by construction, so broadcast to ensure consistent outputs */
538715c1178SPierre Jolivet   PetscCallMPI(MPI_Bcast(accumulate, 2, MPIU_PETSCLOGDOUBLE, 0, PetscObjectComm((PetscObject)pc)));
539715c1178SPierre Jolivet   if (gc) *gc = static_cast<PetscReal>(accumulate[0] / m1);
540715c1178SPierre Jolivet   if (oc) *oc = static_cast<PetscReal>(accumulate[1] / nnz1);
5413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
542f1580f4eSBarry Smith }
543f1580f4eSBarry Smith 
544d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_HPDDM(PC pc, PetscViewer viewer)
545d71ae5a4SJacob Faibussowitsch {
546f1580f4eSBarry Smith   PC_HPDDM         *data = (PC_HPDDM *)pc->data;
547f1580f4eSBarry Smith   PetscViewer       subviewer;
548aa21023fSPierre Jolivet   PetscViewerFormat format;
549f1580f4eSBarry Smith   PetscSubcomm      subcomm;
550f1580f4eSBarry Smith   PetscReal         oc, gc;
551811e8887SPierre Jolivet   PetscInt          tabs;
552f1580f4eSBarry Smith   PetscMPIInt       size, color, rank;
553aa21023fSPierre Jolivet   PetscBool         flg;
554aa21023fSPierre Jolivet   const char       *name;
555f1580f4eSBarry Smith 
556f1580f4eSBarry Smith   PetscFunctionBegin;
557aa21023fSPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &flg));
558aa21023fSPierre Jolivet   if (flg) {
559f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "level%s: %" PetscInt_FMT "\n", data->N > 1 ? "s" : "", data->N));
560f1580f4eSBarry Smith     PetscCall(PCHPDDMGetComplexities(pc, &gc, &oc));
561f1580f4eSBarry Smith     if (data->N > 1) {
562f1580f4eSBarry Smith       if (!data->deflation) {
563c8ea6600SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "Neumann matrix attached? %s\n", PetscBools[PetscBool3ToBool(data->Neumann)]));
564f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, "shared subdomain KSP between SLEPc and PETSc? %s\n", PetscBools[data->share]));
565f1580f4eSBarry Smith       } else PetscCall(PetscViewerASCIIPrintf(viewer, "user-supplied deflation matrix\n"));
566f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "coarse correction: %s\n", PCHPDDMCoarseCorrectionTypes[data->correction]));
567f1580f4eSBarry 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" : ""));
568f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIGetTab(viewer, &tabs));
569f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, 0));
570811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
571f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, data->levels[i - 1]->nu));
5720594bca0SPierre Jolivet         if (data->levels[i - 1]->threshold > static_cast<PetscReal>(-0.1)) PetscCall(PetscViewerASCIIPrintf(viewer, " (%g)", (double)data->levels[i - 1]->threshold));
573f1580f4eSBarry Smith       }
574f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
575f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, tabs));
576f1580f4eSBarry Smith     }
577f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "grid and operator complexities: %g %g\n", (double)gc, (double)oc));
5781fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
579f1580f4eSBarry Smith     if (data->levels[0]->ksp) {
580f1580f4eSBarry Smith       PetscCall(KSPView(data->levels[0]->ksp, viewer));
581f1580f4eSBarry Smith       if (data->levels[0]->pc) PetscCall(PCView(data->levels[0]->pc, viewer));
582eea1a2f1SRaphael Zanella       PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank));
583811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
584f1580f4eSBarry Smith         if (data->levels[i]->ksp) color = 1;
585f1580f4eSBarry Smith         else color = 0;
586f1580f4eSBarry Smith         PetscCall(PetscSubcommCreate(PetscObjectComm((PetscObject)pc), &subcomm));
587f1580f4eSBarry Smith         PetscCall(PetscSubcommSetNumber(subcomm, PetscMin(size, 2)));
588f1580f4eSBarry Smith         PetscCall(PetscSubcommSetTypeGeneral(subcomm, color, rank));
589f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPushTab(viewer));
590f1580f4eSBarry Smith         PetscCall(PetscViewerGetSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
591f1580f4eSBarry Smith         if (color == 1) {
592f1580f4eSBarry Smith           PetscCall(KSPView(data->levels[i]->ksp, subviewer));
593f1580f4eSBarry Smith           if (data->levels[i]->pc) PetscCall(PCView(data->levels[i]->pc, subviewer));
594f1580f4eSBarry Smith           PetscCall(PetscViewerFlush(subviewer));
595f1580f4eSBarry Smith         }
596f1580f4eSBarry Smith         PetscCall(PetscViewerRestoreSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
597f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPopTab(viewer));
598f1580f4eSBarry Smith         PetscCall(PetscSubcommDestroy(&subcomm));
599f1580f4eSBarry Smith       }
600f1580f4eSBarry Smith     }
601aa21023fSPierre Jolivet     PetscCall(PetscViewerGetFormat(viewer, &format));
602aa21023fSPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
603aa21023fSPierre Jolivet       PetscCall(PetscViewerFileGetName(viewer, &name));
604aa21023fSPierre Jolivet       if (name) {
605eea1a2f1SRaphael Zanella         Mat             aux[2];
606aa21023fSPierre Jolivet         IS              is;
607eea1a2f1SRaphael Zanella         const PetscInt *indices;
608eea1a2f1SRaphael Zanella         PetscInt        m, n, sizes[5] = {pc->mat->rmap->n, pc->mat->cmap->n, pc->mat->rmap->N, pc->mat->cmap->N, 0};
609aa21023fSPierre Jolivet         char           *tmp;
610aa21023fSPierre Jolivet         std::string     prefix, suffix;
611aa21023fSPierre Jolivet         size_t          pos;
612aa21023fSPierre Jolivet 
613aa21023fSPierre Jolivet         PetscCall(PetscStrstr(name, ".", &tmp));
614aa21023fSPierre Jolivet         if (tmp) {
615aa21023fSPierre Jolivet           pos    = std::distance(const_cast<char *>(name), tmp);
616aa21023fSPierre Jolivet           prefix = std::string(name, pos);
617aa21023fSPierre Jolivet           suffix = std::string(name + pos + 1);
618aa21023fSPierre Jolivet         } else prefix = name;
619aa21023fSPierre Jolivet         if (data->aux) {
620eea1a2f1SRaphael Zanella           PetscCall(MatGetSize(data->aux, &m, &n));
621eea1a2f1SRaphael Zanella           PetscCall(MatCreate(PetscObjectComm((PetscObject)pc), aux));
622eea1a2f1SRaphael Zanella           PetscCall(MatSetSizes(aux[0], m, n, PETSC_DETERMINE, PETSC_DETERMINE));
623eea1a2f1SRaphael Zanella           PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
624eea1a2f1SRaphael Zanella           if (flg) PetscCall(MatSetType(aux[0], MATMPIAIJ));
625eea1a2f1SRaphael Zanella           else {
626eea1a2f1SRaphael Zanella             PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQBAIJ, &flg));
627eea1a2f1SRaphael Zanella             if (flg) PetscCall(MatSetType(aux[0], MATMPIBAIJ));
628eea1a2f1SRaphael Zanella             else {
629eea1a2f1SRaphael Zanella               PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQSBAIJ, &flg));
630eea1a2f1SRaphael 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);
631eea1a2f1SRaphael Zanella               PetscCall(MatSetType(aux[0], MATMPISBAIJ));
632eea1a2f1SRaphael Zanella             }
633eea1a2f1SRaphael Zanella           }
634eea1a2f1SRaphael Zanella           PetscCall(MatSetBlockSizesFromMats(aux[0], data->aux, data->aux));
635eea1a2f1SRaphael Zanella           PetscCall(MatAssemblyBegin(aux[0], MAT_FINAL_ASSEMBLY));
636eea1a2f1SRaphael Zanella           PetscCall(MatAssemblyEnd(aux[0], MAT_FINAL_ASSEMBLY));
637eea1a2f1SRaphael Zanella           PetscCall(MatGetDiagonalBlock(aux[0], aux + 1));
638eea1a2f1SRaphael Zanella           PetscCall(MatCopy(data->aux, aux[1], DIFFERENT_NONZERO_PATTERN));
639eea1a2f1SRaphael Zanella           PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_aux_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
640eea1a2f1SRaphael Zanella           PetscCall(MatView(aux[0], subviewer));
641aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
642eea1a2f1SRaphael Zanella           PetscCall(MatDestroy(aux));
643aa21023fSPierre Jolivet         }
644aa21023fSPierre Jolivet         if (data->is) {
645eea1a2f1SRaphael Zanella           PetscCall(ISGetIndices(data->is, &indices));
646eea1a2f1SRaphael Zanella           PetscCall(ISGetSize(data->is, sizes + 4));
647eea1a2f1SRaphael Zanella           PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), sizes[4], indices, PETSC_USE_POINTER, &is));
648eea1a2f1SRaphael Zanella           PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_is_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
649eea1a2f1SRaphael Zanella           PetscCall(ISView(is, subviewer));
650aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
651eea1a2f1SRaphael Zanella           PetscCall(ISDestroy(&is));
652eea1a2f1SRaphael Zanella           PetscCall(ISRestoreIndices(data->is, &indices));
653aa21023fSPierre Jolivet         }
654eea1a2f1SRaphael Zanella         PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), PETSC_STATIC_ARRAY_LENGTH(sizes), sizes, PETSC_USE_POINTER, &is));
655eea1a2f1SRaphael Zanella         PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_sizes_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
656aa21023fSPierre Jolivet         PetscCall(ISView(is, subviewer));
657aa21023fSPierre Jolivet         PetscCall(PetscViewerDestroy(&subviewer));
658aa21023fSPierre Jolivet         PetscCall(ISDestroy(&is));
659aa21023fSPierre Jolivet       }
660aa21023fSPierre Jolivet     }
661f1580f4eSBarry Smith   }
6623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
663f1580f4eSBarry Smith }
664f1580f4eSBarry Smith 
665d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCPreSolve_HPDDM(PC pc, KSP ksp, Vec, Vec)
666d71ae5a4SJacob Faibussowitsch {
667f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
668f1580f4eSBarry Smith   Mat       A;
669cdbd50ebSPierre Jolivet   PetscBool flg;
670f1580f4eSBarry Smith 
671f1580f4eSBarry Smith   PetscFunctionBegin;
672f1580f4eSBarry Smith   if (ksp) {
673f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPLSQR, &flg));
674f1580f4eSBarry Smith     if (flg && !data->normal) {
675db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(ksp, &A, nullptr));
676db4a47b3SPierre Jolivet       PetscCall(MatCreateVecs(A, nullptr, &data->normal)); /* temporary Vec used in PCApply_HPDDMShell() for coarse grid corrections */
677cdbd50ebSPierre Jolivet     } else if (!flg) {
678cdbd50ebSPierre Jolivet       PetscCall(PetscObjectTypeCompareAny((PetscObject)ksp, &flg, KSPCG, KSPGROPPCG, KSPPIPECG, KSPPIPECGRR, KSPPIPELCG, KSPPIPEPRCG, KSPPIPECG2, KSPSTCG, KSPFCG, KSPPIPEFCG, KSPMINRES, KSPNASH, KSPSYMMLQ, ""));
679cdbd50ebSPierre Jolivet       if (!flg) {
680cdbd50ebSPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPHPDDM, &flg));
681cdbd50ebSPierre Jolivet         if (flg) {
682cdbd50ebSPierre Jolivet           KSPHPDDMType type;
683811e8887SPierre Jolivet 
684cdbd50ebSPierre Jolivet           PetscCall(KSPHPDDMGetType(ksp, &type));
685cdbd50ebSPierre Jolivet           flg = (type == KSP_HPDDM_TYPE_CG || type == KSP_HPDDM_TYPE_BCG || type == KSP_HPDDM_TYPE_BFBCG ? PETSC_TRUE : PETSC_FALSE);
686cdbd50ebSPierre Jolivet         }
687cdbd50ebSPierre Jolivet       }
688cdbd50ebSPierre Jolivet     }
689cdbd50ebSPierre Jolivet     if (flg) {
690cdbd50ebSPierre Jolivet       if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) {
691cdbd50ebSPierre Jolivet         PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_hpddm_coarse_correction", &flg));
692cdbd50ebSPierre 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",
693cdbd50ebSPierre Jolivet                    PCHPDDMCoarseCorrectionTypes[data->correction], ((PetscObject)ksp)->type_name, ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", PCHPDDMCoarseCorrectionTypes[data->correction], PCHPDDMCoarseCorrectionTypes[PC_HPDDM_COARSE_CORRECTION_BALANCED]);
694cdbd50ebSPierre Jolivet       }
695cdbd50ebSPierre Jolivet       for (PetscInt n = 0; n < data->N; ++n) {
696cdbd50ebSPierre Jolivet         if (data->levels[n]->pc) {
697cdbd50ebSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)data->levels[n]->pc, PCASM, &flg));
698cdbd50ebSPierre Jolivet           if (flg) {
699cdbd50ebSPierre Jolivet             PCASMType type;
700811e8887SPierre Jolivet 
701cdbd50ebSPierre Jolivet             PetscCall(PCASMGetType(data->levels[n]->pc, &type));
702cdbd50ebSPierre Jolivet             if (type == PC_ASM_RESTRICT || type == PC_ASM_INTERPOLATE) {
703cdbd50ebSPierre Jolivet               PetscCall(PetscOptionsHasName(((PetscObject)data->levels[n]->pc)->options, ((PetscObject)data->levels[n]->pc)->prefix, "-pc_asm_type", &flg));
704cdbd50ebSPierre 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],
705cdbd50ebSPierre Jolivet                          ((PetscObject)ksp)->type_name, ((PetscObject)data->levels[n]->pc)->prefix, PCASMTypes[type], PCASMTypes[PC_ASM_BASIC]);
706cdbd50ebSPierre Jolivet             }
707cdbd50ebSPierre Jolivet           }
708cdbd50ebSPierre Jolivet         }
709cdbd50ebSPierre Jolivet       }
710f1580f4eSBarry Smith     }
711f1580f4eSBarry Smith   }
7123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
713f1580f4eSBarry Smith }
714f1580f4eSBarry Smith 
715d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDMShell(PC pc)
716d71ae5a4SJacob Faibussowitsch {
717f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
718f1580f4eSBarry Smith   Mat             A, P;
719f1580f4eSBarry Smith   Vec             x;
720f1580f4eSBarry Smith   const char     *pcpre;
721f1580f4eSBarry Smith 
722f1580f4eSBarry Smith   PetscFunctionBegin;
723f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
724f1580f4eSBarry Smith   PetscCall(KSPGetOptionsPrefix(ctx->ksp, &pcpre));
725f1580f4eSBarry Smith   PetscCall(KSPGetOperators(ctx->ksp, &A, &P));
726f1580f4eSBarry Smith   /* smoother */
727f1580f4eSBarry Smith   PetscCall(PCSetOptionsPrefix(ctx->pc, pcpre));
728f1580f4eSBarry Smith   PetscCall(PCSetOperators(ctx->pc, A, P));
729f1580f4eSBarry Smith   if (!ctx->v[0]) {
730f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(ctx->D, 1, &ctx->v[0]));
731f1580f4eSBarry Smith     if (!std::is_same<PetscScalar, PetscReal>::value) PetscCall(VecDestroy(&ctx->D));
732db4a47b3SPierre Jolivet     PetscCall(MatCreateVecs(A, &x, nullptr));
733f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(x, 2, &ctx->v[1]));
734f1580f4eSBarry Smith     PetscCall(VecDestroy(&x));
735f1580f4eSBarry Smith   }
736f1580f4eSBarry Smith   std::fill_n(ctx->V, 3, nullptr);
7373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
738f1580f4eSBarry Smith }
739f1580f4eSBarry Smith 
740d4f06b61SRaphael Zanella template <bool transpose = false, class Type = Vec, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
741d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type x, Type y)
742d71ae5a4SJacob Faibussowitsch {
743f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
744f1580f4eSBarry Smith   PetscScalar    *out;
745f1580f4eSBarry Smith 
746f1580f4eSBarry Smith   PetscFunctionBegin;
747f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
748f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
749f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
750f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
751f1580f4eSBarry Smith   PetscCall(VecGetArrayWrite(ctx->v[0][0], &out));
752d4f06b61SRaphael Zanella   ctx->P->deflation<false, transpose>(nullptr, out, 1); /* y = Q x */
753f1580f4eSBarry Smith   PetscCall(VecRestoreArrayWrite(ctx->v[0][0], &out));
754f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
755f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
756f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
7573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
758f1580f4eSBarry Smith }
759f1580f4eSBarry Smith 
7608cb7430dSRaphael Zanella template <bool transpose = false, class Type = Mat, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
761d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type X, Type Y)
762d71ae5a4SJacob Faibussowitsch {
763f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
764f1580f4eSBarry Smith   Vec             vX, vY, vC;
765f1580f4eSBarry Smith   PetscScalar    *out;
766811e8887SPierre Jolivet   PetscInt        N;
767f1580f4eSBarry Smith 
768f1580f4eSBarry Smith   PetscFunctionBegin;
769f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
770db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
771f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
772811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
773f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(X, i, &vX));
774f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(ctx->V[0], i, &vC));
775f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
776f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
777f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(ctx->V[0], i, &vC));
778f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(X, i, &vX));
779f1580f4eSBarry Smith   }
780f1580f4eSBarry Smith   PetscCall(MatDenseGetArrayWrite(ctx->V[0], &out));
7818cb7430dSRaphael Zanella   ctx->P->deflation<false, transpose>(nullptr, out, N); /* Y = Q X */
782f1580f4eSBarry Smith   PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &out));
783f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
784811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
785f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(ctx->V[0], i, &vC));
786f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(Y, i, &vY));
787f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
788f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
789f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &vY));
790f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(ctx->V[0], i, &vC));
791f1580f4eSBarry Smith   }
7923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
793f1580f4eSBarry Smith }
794f1580f4eSBarry Smith 
795f1580f4eSBarry Smith /*
796aa1539e9SPierre 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.
797f1580f4eSBarry Smith 
798f1580f4eSBarry Smith .vb
799f1580f4eSBarry Smith    (1) y =                Pmat^-1              x + Q x,
800f1580f4eSBarry Smith    (2) y =                Pmat^-1 (I - Amat Q) x + Q x (default),
801aa1539e9SPierre Jolivet    (3) y = (I - Q Amat^T) Pmat^-1 (I - Amat Q) x + Q x,
802aa1539e9SPierre Jolivet    (4) y =                Pmat^-1              x      .
803f1580f4eSBarry Smith .ve
804f1580f4eSBarry Smith 
805f1580f4eSBarry Smith    Input Parameters:
806f1580f4eSBarry Smith +     pc - preconditioner context
807f1580f4eSBarry Smith -     x - input vector
808f1580f4eSBarry Smith 
809f1580f4eSBarry Smith    Output Parameter:
810f1580f4eSBarry Smith .     y - output vector
811f1580f4eSBarry Smith 
812f1580f4eSBarry Smith    Notes:
813f1580f4eSBarry 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.
814f1580f4eSBarry 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.
815f1580f4eSBarry 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.
816f1580f4eSBarry Smith 
817f1580f4eSBarry Smith    Level: advanced
818f1580f4eSBarry Smith 
819f1580f4eSBarry Smith    Developer Note:
820f1580f4eSBarry 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
821f1580f4eSBarry Smith    to trigger it. Likely the manual page is `PCHPDDM`
822f1580f4eSBarry Smith 
823562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
824f1580f4eSBarry Smith */
825d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDMShell(PC pc, Vec x, Vec y)
826d71ae5a4SJacob Faibussowitsch {
827f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
828f1580f4eSBarry Smith   Mat             A;
829f1580f4eSBarry Smith 
830f1580f4eSBarry Smith   PetscFunctionBegin;
831f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
832f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
833db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
834aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApply(ctx->pc, x, y)); /* y = M^-1 x */
835aa1539e9SPierre Jolivet   else {
836f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, x, y)); /* y = Q x */
837f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
838f1580f4eSBarry Smith       if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMult(A, y, ctx->v[1][0])); /* y = A Q x     */
839f1580f4eSBarry Smith       else { /* KSPLSQR and finest level */ PetscCall(MatMult(A, y, ctx->parent->normal));               /* y = A Q x     */
840f1580f4eSBarry Smith         PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][0]));                      /* y = A^T A Q x */
841f1580f4eSBarry Smith       }
842f1580f4eSBarry Smith       PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x)); /* y = (I - A Q) x                             */
843f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, ctx->v[1][1], ctx->v[1][0]));  /* y = M^-1 (I - A Q) x                        */
844f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
845f1580f4eSBarry 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 */
846f1580f4eSBarry Smith         else {
847f1580f4eSBarry Smith           PetscCall(MatMult(A, ctx->v[1][0], ctx->parent->normal));
848f1580f4eSBarry Smith           PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][1])); /* z = A^T A y           */
849f1580f4eSBarry Smith         }
850d4f06b61SRaphael Zanella         PetscCall(PCHPDDMDeflate_Private(pc, ctx->v[1][1], ctx->v[1][1]));     /* z = Q z                      */
851f1580f4eSBarry 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      */
852f1580f4eSBarry Smith       } else PetscCall(VecAXPY(y, 1.0, ctx->v[1][0]));                         /* y = Q M^-1 (I - A Q) x + Q x */
853f1580f4eSBarry Smith     } else {
854f1580f4eSBarry 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);
855f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, x, ctx->v[1][0]));
856f1580f4eSBarry Smith       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-1 x + Q x */
857f1580f4eSBarry Smith     }
858aa1539e9SPierre Jolivet   }
8593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
860f1580f4eSBarry Smith }
861f1580f4eSBarry Smith 
8628cb7430dSRaphael Zanella template <bool transpose>
8638cb7430dSRaphael Zanella static PetscErrorCode PCHPDDMMatApply_Private(PC_HPDDM_Level *ctx, Mat Y, PetscBool *reset)
8648cb7430dSRaphael Zanella {
8658cb7430dSRaphael Zanella   Mat            A, *ptr;
8668cb7430dSRaphael Zanella   PetscScalar   *array;
8678cb7430dSRaphael Zanella   PetscInt       m, M, N, prev = 0;
8688cb7430dSRaphael Zanella   PetscContainer container = nullptr;
8698cb7430dSRaphael Zanella 
8708cb7430dSRaphael Zanella   PetscFunctionBegin;
8718cb7430dSRaphael Zanella   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
8728cb7430dSRaphael Zanella   PetscCall(MatGetSize(Y, nullptr, &N));
8738cb7430dSRaphael Zanella   PetscCall(PetscObjectQuery((PetscObject)A, "_HPDDM_MatProduct", (PetscObject *)&container));
8748cb7430dSRaphael Zanella   if (container) { /* MatProduct container already attached */
8758cb7430dSRaphael Zanella     PetscCall(PetscContainerGetPointer(container, (void **)&ptr));
8768cb7430dSRaphael Zanella     if (ptr[1] != ctx->V[2]) /* Mat has changed or may have been set first in KSPHPDDM */
8778cb7430dSRaphael Zanella       for (m = 0; m < 2; ++m) {
8788cb7430dSRaphael Zanella         PetscCall(MatDestroy(ctx->V + m + 1));
8798cb7430dSRaphael Zanella         ctx->V[m + 1] = ptr[m];
8808cb7430dSRaphael Zanella         PetscCall(PetscObjectReference((PetscObject)ctx->V[m + 1]));
8818cb7430dSRaphael Zanella       }
8828cb7430dSRaphael Zanella   }
8838cb7430dSRaphael Zanella   if (ctx->V[1]) PetscCall(MatGetSize(ctx->V[1], nullptr, &prev));
8848cb7430dSRaphael Zanella   if (N != prev || !ctx->V[0]) {
8858cb7430dSRaphael Zanella     PetscCall(MatDestroy(ctx->V));
8868cb7430dSRaphael Zanella     PetscCall(VecGetLocalSize(ctx->v[0][0], &m));
8878cb7430dSRaphael Zanella     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)Y), m, PETSC_DECIDE, PETSC_DECIDE, N, nullptr, ctx->V));
8888cb7430dSRaphael Zanella     if (N != prev) {
8898cb7430dSRaphael Zanella       PetscCall(MatDestroy(ctx->V + 1));
8908cb7430dSRaphael Zanella       PetscCall(MatDestroy(ctx->V + 2));
8918cb7430dSRaphael Zanella       PetscCall(MatGetLocalSize(Y, &m, nullptr));
8928cb7430dSRaphael Zanella       PetscCall(MatGetSize(Y, &M, nullptr));
8938cb7430dSRaphael Zanella       if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
8948cb7430dSRaphael Zanella       else array = nullptr;
8958cb7430dSRaphael Zanella       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)Y), m, PETSC_DECIDE, M, N, array, ctx->V + 1));
8968cb7430dSRaphael Zanella       if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
8978cb7430dSRaphael Zanella       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)Y), m, PETSC_DECIDE, M, N, nullptr, ctx->V + 2));
8988cb7430dSRaphael Zanella       PetscCall(MatProductCreateWithMat(A, !transpose ? Y : ctx->V[2], nullptr, ctx->V[1]));
8998cb7430dSRaphael Zanella       PetscCall(MatProductSetType(ctx->V[1], !transpose ? MATPRODUCT_AB : MATPRODUCT_AtB));
9008cb7430dSRaphael Zanella       PetscCall(MatProductSetFromOptions(ctx->V[1]));
9018cb7430dSRaphael Zanella       PetscCall(MatProductSymbolic(ctx->V[1]));
9028cb7430dSRaphael Zanella       if (!container) PetscCall(PetscObjectContainerCompose((PetscObject)A, "_HPDDM_MatProduct", ctx->V + 1, nullptr)); /* no MatProduct container attached, create one to be queried in KSPHPDDM or at the next call to PCMatApply() */
9038cb7430dSRaphael Zanella       else PetscCall(PetscContainerSetPointer(container, ctx->V + 1));                                                  /* need to compose B and D from MatProductCreateWithMat(A, B, NULL, D), which are stored in the contiguous array ctx->V */
9048cb7430dSRaphael Zanella     }
9058cb7430dSRaphael Zanella     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
9068cb7430dSRaphael Zanella       PetscCall(MatProductCreateWithMat(A, !transpose ? ctx->V[1] : Y, nullptr, ctx->V[2]));
9078cb7430dSRaphael Zanella       PetscCall(MatProductSetType(ctx->V[2], !transpose ? MATPRODUCT_AtB : MATPRODUCT_AB));
9088cb7430dSRaphael Zanella       PetscCall(MatProductSetFromOptions(ctx->V[2]));
9098cb7430dSRaphael Zanella       PetscCall(MatProductSymbolic(ctx->V[2]));
9108cb7430dSRaphael Zanella     }
9118cb7430dSRaphael Zanella     ctx->P->start(N);
9128cb7430dSRaphael Zanella   }
9138cb7430dSRaphael Zanella   if (N == prev || container) { /* when MatProduct container is attached, always need to MatProductReplaceMats() since KSPHPDDM may have replaced the Mat as well */
9148cb7430dSRaphael Zanella     PetscCall(MatProductReplaceMats(nullptr, !transpose ? Y : ctx->V[2], nullptr, ctx->V[1]));
9158cb7430dSRaphael Zanella     if (container && ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) {
9168cb7430dSRaphael Zanella       PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
9178cb7430dSRaphael Zanella       PetscCall(MatDensePlaceArray(ctx->V[1], array));
9188cb7430dSRaphael Zanella       PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
9198cb7430dSRaphael Zanella       *reset = PETSC_TRUE;
9208cb7430dSRaphael Zanella     }
9218cb7430dSRaphael Zanella   }
9228cb7430dSRaphael Zanella   PetscFunctionReturn(PETSC_SUCCESS);
9238cb7430dSRaphael Zanella }
9248cb7430dSRaphael Zanella 
925f1580f4eSBarry Smith /*
926f1580f4eSBarry Smith      PCMatApply_HPDDMShell - Variant of PCApply_HPDDMShell() for blocks of vectors.
927f1580f4eSBarry Smith 
928f1580f4eSBarry Smith    Input Parameters:
929f1580f4eSBarry Smith +     pc - preconditioner context
930f1580f4eSBarry Smith -     X - block of input vectors
931f1580f4eSBarry Smith 
932f1580f4eSBarry Smith    Output Parameter:
933f1580f4eSBarry Smith .     Y - block of output vectors
934f1580f4eSBarry Smith 
935f1580f4eSBarry Smith    Level: advanced
936f1580f4eSBarry Smith 
937562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
938f1580f4eSBarry Smith */
939d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDMShell(PC pc, Mat X, Mat Y)
940d71ae5a4SJacob Faibussowitsch {
941f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
942f1580f4eSBarry Smith   PetscBool       reset = PETSC_FALSE;
943f1580f4eSBarry Smith 
944f1580f4eSBarry Smith   PetscFunctionBegin;
945f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
946f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
947aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApply(ctx->pc, X, Y));
948aa1539e9SPierre Jolivet   else {
9498cb7430dSRaphael Zanella     PetscCall(PCHPDDMMatApply_Private<false>(ctx, Y, &reset));
950f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, X, Y));
951f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
952f1580f4eSBarry Smith       PetscCall(MatProductNumeric(ctx->V[1]));
953f1580f4eSBarry Smith       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
954f1580f4eSBarry Smith       PetscCall(MatAXPY(ctx->V[2], -1.0, X, SAME_NONZERO_PATTERN));
955f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, ctx->V[2], ctx->V[1]));
956f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
957f1580f4eSBarry Smith         PetscCall(MatProductNumeric(ctx->V[2]));
958f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->V[2], ctx->V[2]));
959f1580f4eSBarry Smith         PetscCall(MatAXPY(ctx->V[1], -1.0, ctx->V[2], SAME_NONZERO_PATTERN));
960f1580f4eSBarry Smith       }
961f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
962f1580f4eSBarry Smith     } else {
963f1580f4eSBarry 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);
964f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, X, ctx->V[1]));
965f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
966f1580f4eSBarry Smith     }
967f1580f4eSBarry Smith     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
968aa1539e9SPierre Jolivet   }
9693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
970f1580f4eSBarry Smith }
971f1580f4eSBarry Smith 
972d4f06b61SRaphael Zanella /*
973d4f06b61SRaphael Zanella      PCApplyTranspose_HPDDMShell - Applies the transpose of a (2) deflated, (1) additive, (3) balanced, or (4) no coarse correction. In what follows, E = Z Pmat Z^T and Q = Z^T E^-1 Z.
974d4f06b61SRaphael Zanella 
975d4f06b61SRaphael Zanella .vb
976d4f06b61SRaphael Zanella    (1) y =                  Pmat^-T                x + Q^T x,
977d4f06b61SRaphael Zanella    (2) y = (I - Q^T Amat^T) Pmat^-T                x + Q^T x (default),
978d4f06b61SRaphael Zanella    (3) y = (I - Q^T Amat^T) Pmat^-T (I - Amat Q^T) x + Q^T x,
979d4f06b61SRaphael Zanella    (4) y =                  Pmat^-T                x        .
980d4f06b61SRaphael Zanella .ve
981d4f06b61SRaphael Zanella 
982d4f06b61SRaphael Zanella    Input Parameters:
983d4f06b61SRaphael Zanella +     pc - preconditioner context
984d4f06b61SRaphael Zanella -     x - input vector
985d4f06b61SRaphael Zanella 
986d4f06b61SRaphael Zanella    Output Parameter:
987d4f06b61SRaphael Zanella .     y - output vector
988d4f06b61SRaphael Zanella 
989d4f06b61SRaphael Zanella    Level: advanced
990d4f06b61SRaphael Zanella 
991d4f06b61SRaphael Zanella    Developer Note:
992d4f06b61SRaphael Zanella    Since this is not an actual manual page the material below should be moved to an appropriate manual page with the appropriate context, i.e. explaining when it is used and how
993d4f06b61SRaphael Zanella    to trigger it. Likely the manual page is `PCHPDDM`
994d4f06b61SRaphael Zanella 
995d4f06b61SRaphael Zanella .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
996d4f06b61SRaphael Zanella */
997d4f06b61SRaphael Zanella static PetscErrorCode PCApplyTranspose_HPDDMShell(PC pc, Vec x, Vec y)
998d4f06b61SRaphael Zanella {
999d4f06b61SRaphael Zanella   PC_HPDDM_Level *ctx;
1000d4f06b61SRaphael Zanella   Mat             A;
1001d4f06b61SRaphael Zanella 
1002d4f06b61SRaphael Zanella   PetscFunctionBegin;
1003d4f06b61SRaphael Zanella   PetscCall(PCShellGetContext(pc, &ctx));
1004d4f06b61SRaphael Zanella   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
10058cb7430dSRaphael Zanella   PetscCheck(!ctx->parent->normal, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Not implemented for the normal equations");
1006d4f06b61SRaphael Zanella   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
1007d4f06b61SRaphael Zanella   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApplyTranspose(ctx->pc, x, y)); /* y = M^-T x */
1008d4f06b61SRaphael Zanella   else {
1009d4f06b61SRaphael Zanella     PetscCall(PCHPDDMDeflate_Private<true>(pc, x, y)); /* y = Q^T x */
1010d4f06b61SRaphael Zanella     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
1011d4f06b61SRaphael Zanella       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
10128cb7430dSRaphael Zanella         PetscCall(MatMult(A, y, ctx->v[1][0]));                                /* y = A Q^T x                 */
1013d4f06b61SRaphael Zanella         PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x));              /* y = (I - A Q^T) x           */
1014d4f06b61SRaphael Zanella         PetscCall(PCApplyTranspose(ctx->pc, ctx->v[1][1], ctx->v[1][0]));      /* y = M^-T (I - A Q^T) x      */
1015d4f06b61SRaphael Zanella       } else PetscCall(PCApplyTranspose(ctx->pc, x, ctx->v[1][0]));            /* y = M^-T x                  */
10168cb7430dSRaphael Zanella       PetscCall(MatMultHermitianTranspose(A, ctx->v[1][0], ctx->v[1][1]));     /* z = A^T y                   */
1017d4f06b61SRaphael Zanella       PetscCall(PCHPDDMDeflate_Private<true>(pc, ctx->v[1][1], ctx->v[1][1])); /* z = Q^T z                   */
1018d4f06b61SRaphael Zanella       PetscCall(VecAXPBYPCZ(y, -1.0, 1.0, 1.0, ctx->v[1][1], ctx->v[1][0]));   /* y = (I - Q^T A^T) y + Q^T x */
1019d4f06b61SRaphael Zanella     } else {
1020d4f06b61SRaphael Zanella       PetscCheck(ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_ADDITIVE, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with an unknown PCHPDDMCoarseCorrectionType %d", ctx->parent->correction);
1021d4f06b61SRaphael Zanella       PetscCall(PCApplyTranspose(ctx->pc, x, ctx->v[1][0]));
1022d4f06b61SRaphael Zanella       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-T x + Q^T x */
1023d4f06b61SRaphael Zanella     }
1024d4f06b61SRaphael Zanella   }
1025d4f06b61SRaphael Zanella   PetscFunctionReturn(PETSC_SUCCESS);
1026d4f06b61SRaphael Zanella }
1027d4f06b61SRaphael Zanella 
10288cb7430dSRaphael Zanella /*
10298cb7430dSRaphael Zanella      PCMatApplyTranspose_HPDDMShell - Variant of PCApplyTranspose_HPDDMShell() for blocks of vectors.
10308cb7430dSRaphael Zanella 
10318cb7430dSRaphael Zanella    Input Parameters:
10328cb7430dSRaphael Zanella +     pc - preconditioner context
10338cb7430dSRaphael Zanella -     X - block of input vectors
10348cb7430dSRaphael Zanella 
10358cb7430dSRaphael Zanella    Output Parameter:
10368cb7430dSRaphael Zanella .     Y - block of output vectors
10378cb7430dSRaphael Zanella 
10388cb7430dSRaphael Zanella    Level: advanced
10398cb7430dSRaphael Zanella 
10408cb7430dSRaphael Zanella .seealso: [](ch_ksp), `PCHPDDM`, `PCApplyTranspose_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
10418cb7430dSRaphael Zanella */
10428cb7430dSRaphael Zanella static PetscErrorCode PCMatApplyTranspose_HPDDMShell(PC pc, Mat X, Mat Y)
10438cb7430dSRaphael Zanella {
10448cb7430dSRaphael Zanella   PC_HPDDM_Level *ctx;
10458cb7430dSRaphael Zanella   PetscScalar    *array;
10468cb7430dSRaphael Zanella   PetscBool       reset = PETSC_FALSE;
10478cb7430dSRaphael Zanella 
10488cb7430dSRaphael Zanella   PetscFunctionBegin;
10498cb7430dSRaphael Zanella   PetscCall(PCShellGetContext(pc, &ctx));
10508cb7430dSRaphael Zanella   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
10518cb7430dSRaphael Zanella   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApplyTranspose(ctx->pc, X, Y));
10528cb7430dSRaphael Zanella   else {
10538cb7430dSRaphael Zanella     PetscCall(PCHPDDMMatApply_Private<true>(ctx, Y, &reset));
10548cb7430dSRaphael Zanella     PetscCall(PCHPDDMDeflate_Private<true>(pc, X, Y));
10558cb7430dSRaphael Zanella     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
10568cb7430dSRaphael Zanella       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
10578cb7430dSRaphael Zanella         PetscCall(MatProductNumeric(ctx->V[2]));
10588cb7430dSRaphael Zanella         PetscCall(MatCopy(ctx->V[2], ctx->V[1], SAME_NONZERO_PATTERN));
10598cb7430dSRaphael Zanella         PetscCall(MatAYPX(ctx->V[1], -1.0, X, SAME_NONZERO_PATTERN));
10608cb7430dSRaphael Zanella         PetscCall(PCMatApplyTranspose(ctx->pc, ctx->V[1], ctx->V[2]));
10618cb7430dSRaphael Zanella       } else PetscCall(PCMatApplyTranspose(ctx->pc, X, ctx->V[2]));
10628cb7430dSRaphael Zanella       PetscCall(MatAXPY(Y, 1.0, ctx->V[2], SAME_NONZERO_PATTERN));
10638cb7430dSRaphael Zanella       PetscCall(MatProductNumeric(ctx->V[1]));
1064847b6ef2SPierre Jolivet       /* ctx->V[0] and ctx->V[1] memory regions overlap, so need to copy to ctx->V[2] and switch array */
10658cb7430dSRaphael Zanella       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
1066847b6ef2SPierre Jolivet       if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
10678cb7430dSRaphael Zanella       PetscCall(MatDenseGetArrayWrite(ctx->V[2], &array));
10688cb7430dSRaphael Zanella       PetscCall(MatDensePlaceArray(ctx->V[1], array));
10698cb7430dSRaphael Zanella       PetscCall(MatDenseRestoreArrayWrite(ctx->V[2], &array));
1070847b6ef2SPierre Jolivet       reset = PETSC_TRUE;
10718cb7430dSRaphael Zanella       PetscCall(PCHPDDMDeflate_Private<true>(pc, ctx->V[1], ctx->V[1]));
10728cb7430dSRaphael Zanella       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
10738cb7430dSRaphael Zanella     } else {
10748cb7430dSRaphael Zanella       PetscCheck(ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_ADDITIVE, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with an unknown PCHPDDMCoarseCorrectionType %d", ctx->parent->correction);
10758cb7430dSRaphael Zanella       PetscCall(PCMatApplyTranspose(ctx->pc, X, ctx->V[1]));
10768cb7430dSRaphael Zanella       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
10778cb7430dSRaphael Zanella     }
10788cb7430dSRaphael Zanella     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
10798cb7430dSRaphael Zanella   }
10808cb7430dSRaphael Zanella   PetscFunctionReturn(PETSC_SUCCESS);
10818cb7430dSRaphael Zanella }
10828cb7430dSRaphael Zanella 
1083d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDMShell(PC pc)
1084d71ae5a4SJacob Faibussowitsch {
1085f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
1086f1580f4eSBarry Smith 
1087f1580f4eSBarry Smith   PetscFunctionBegin;
1088f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
1089f1580f4eSBarry Smith   PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(ctx, PETSC_TRUE));
1090f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(1, &ctx->v[0]));
1091f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(2, &ctx->v[1]));
1092f4f49eeaSPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", nullptr));
1093f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V));
1094f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 1));
1095f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 2));
1096f1580f4eSBarry Smith   PetscCall(VecDestroy(&ctx->D));
109701e3c840SPierre Jolivet   PetscCall(PetscSFDestroy(&ctx->scatter));
1098f1580f4eSBarry Smith   PetscCall(PCDestroy(&ctx->pc));
10993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1100f1580f4eSBarry Smith }
1101f1580f4eSBarry Smith 
11029bb5c669SPierre Jolivet template <class Type, bool T = false, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
11039bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type x, Type y)
11049bb5c669SPierre Jolivet {
11059bb5c669SPierre Jolivet   PetscFunctionBegin;
11069bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[0], std::get<1>(*p), SCATTER_FORWARD, x));
11079bb5c669SPierre Jolivet   if (!T) PetscCall(PCApply(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
11089bb5c669SPierre Jolivet   else PetscCall(PCApplyTranspose(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
11099bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[1], std::get<1>(*p), SCATTER_REVERSE, y));
11109bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
11119bb5c669SPierre Jolivet }
11129bb5c669SPierre Jolivet 
11139bb5c669SPierre Jolivet template <class Type, bool = false, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
11149bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type X, Type Y)
11159bb5c669SPierre Jolivet {
11169bb5c669SPierre Jolivet   Mat B[2];
11179bb5c669SPierre Jolivet   Vec x, y;
11189bb5c669SPierre Jolivet 
11199bb5c669SPierre Jolivet   PetscFunctionBegin;
11209bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B));
11219bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B + 1));
11229bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
11239bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(X, i, &x));
11249bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B[0], i, &y));
11259bb5c669SPierre Jolivet     PetscCall(VecISCopy(y, std::get<1>(*p), SCATTER_FORWARD, x));
11269bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B[0], i, &y));
11279bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(X, i, &x));
11289bb5c669SPierre Jolivet   }
11299bb5c669SPierre Jolivet   PetscCall(PCMatApply(factor, B[0], B[1]));
11309bb5c669SPierre Jolivet   PetscCall(MatDestroy(B));
11319bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
11329bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B[1], i, &x));
11339bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &y));
11349bb5c669SPierre Jolivet     PetscCall(VecISCopy(x, std::get<1>(*p), SCATTER_REVERSE, y));
11359bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &y));
11369bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B[1], i, &x));
11379bb5c669SPierre Jolivet   }
11389bb5c669SPierre Jolivet   PetscCall(MatDestroy(B + 1));
11399bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
11409bb5c669SPierre Jolivet }
11419bb5c669SPierre Jolivet 
11429bb5c669SPierre Jolivet template <class Type = Vec, bool T = false>
11439bb5c669SPierre Jolivet static PetscErrorCode PCApply_Schur(PC pc, Type x, Type y)
11449bb5c669SPierre Jolivet {
11459bb5c669SPierre Jolivet   PC                           factor;
11469bb5c669SPierre Jolivet   Mat                          A;
11479bb5c669SPierre Jolivet   MatSolverType                type;
11489bb5c669SPierre Jolivet   PetscBool                    flg;
11499bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
11509bb5c669SPierre Jolivet 
11519bb5c669SPierre Jolivet   PetscFunctionBegin;
11529bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
11539bb5c669SPierre Jolivet   PetscCall(KSPGetPC(std::get<0>(*p), &factor));
11549bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(factor, &type));
11559bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatrix(factor, &A));
11569bb5c669SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
11579bb5c669SPierre Jolivet   if (flg) {
11589bb5c669SPierre Jolivet     PetscCheck(PetscDefined(HAVE_MUMPS), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
11599bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 0));
11609bb5c669SPierre Jolivet   } else {
11619bb5c669SPierre Jolivet     PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &flg));
11629bb5c669SPierre Jolivet     PetscCheck(flg && PetscDefined(HAVE_MKL_PARDISO), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
11639bb5c669SPierre Jolivet     flg = PETSC_FALSE;
11649bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
11659bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 1));
11669bb5c669SPierre Jolivet #endif
11679bb5c669SPierre Jolivet   }
11689bb5c669SPierre Jolivet   PetscCall(PCApply_Schur_Private<Type, T>(p, factor, x, y));
11699bb5c669SPierre Jolivet   if (flg) {
11709bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1));
11719bb5c669SPierre Jolivet   } else {
11729bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
11739bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 0));
11749bb5c669SPierre Jolivet #endif
11759bb5c669SPierre Jolivet   }
11769bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
11779bb5c669SPierre Jolivet }
11789bb5c669SPierre Jolivet 
11799bb5c669SPierre Jolivet static PetscErrorCode PCDestroy_Schur(PC pc)
11809bb5c669SPierre Jolivet {
11819bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
11829bb5c669SPierre Jolivet 
11839bb5c669SPierre Jolivet   PetscFunctionBegin;
11849bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
11859bb5c669SPierre Jolivet   PetscCall(ISDestroy(&std::get<1>(*p)));
11869bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p)));
11879bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p) + 1));
11889bb5c669SPierre Jolivet   PetscCall(PetscFree(p));
11899bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
11909bb5c669SPierre Jolivet }
11919bb5c669SPierre Jolivet 
1192d4f06b61SRaphael Zanella template <bool transpose>
1193d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSolve_Private(const PC_HPDDM_Level *ctx, PetscScalar *rhs, const unsigned short &mu)
1194d71ae5a4SJacob Faibussowitsch {
1195f1580f4eSBarry Smith   Mat      B, X;
1196f1580f4eSBarry Smith   PetscInt n, N, j = 0;
1197f1580f4eSBarry Smith 
1198f1580f4eSBarry Smith   PetscFunctionBegin;
1199db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &B, nullptr));
1200db4a47b3SPierre Jolivet   PetscCall(MatGetLocalSize(B, &n, nullptr));
1201db4a47b3SPierre Jolivet   PetscCall(MatGetSize(B, &N, nullptr));
1202f1580f4eSBarry Smith   if (ctx->parent->log_separate) {
1203f1580f4eSBarry Smith     j = std::distance(ctx->parent->levels, std::find(ctx->parent->levels, ctx->parent->levels + ctx->parent->N, ctx));
1204db4a47b3SPierre Jolivet     PetscCall(PetscLogEventBegin(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
1205f1580f4eSBarry Smith   }
1206f1580f4eSBarry Smith   if (mu == 1) {
1207f1580f4eSBarry Smith     if (!ctx->ksp->vec_rhs) {
1208db4a47b3SPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ctx->ksp), 1, n, N, nullptr, &ctx->ksp->vec_rhs));
1209f1580f4eSBarry Smith       PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)ctx->ksp), n, N, &ctx->ksp->vec_sol));
1210f1580f4eSBarry Smith     }
1211f1580f4eSBarry Smith     PetscCall(VecPlaceArray(ctx->ksp->vec_rhs, rhs));
1212d4f06b61SRaphael Zanella     if (!transpose) PetscCall(KSPSolve(ctx->ksp, nullptr, nullptr));
1213d4f06b61SRaphael Zanella     else PetscCall(KSPSolveTranspose(ctx->ksp, nullptr, nullptr));
1214f1580f4eSBarry Smith     PetscCall(VecCopy(ctx->ksp->vec_sol, ctx->ksp->vec_rhs));
1215f1580f4eSBarry Smith     PetscCall(VecResetArray(ctx->ksp->vec_rhs));
1216f1580f4eSBarry Smith   } else {
1217f1580f4eSBarry Smith     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, rhs, &B));
1218db4a47b3SPierre Jolivet     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, nullptr, &X));
1219f1580f4eSBarry Smith     PetscCall(KSPMatSolve(ctx->ksp, B, X));
1220f1580f4eSBarry Smith     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
1221f1580f4eSBarry Smith     PetscCall(MatDestroy(&X));
1222f1580f4eSBarry Smith     PetscCall(MatDestroy(&B));
1223f1580f4eSBarry Smith   }
1224db4a47b3SPierre Jolivet   if (ctx->parent->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
12253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1226f1580f4eSBarry Smith }
1227f1580f4eSBarry Smith 
1228d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetUpNeumannOverlap_Private(PC pc)
1229d71ae5a4SJacob Faibussowitsch {
1230f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
1231f1580f4eSBarry Smith 
1232f1580f4eSBarry Smith   PetscFunctionBegin;
1233f1580f4eSBarry Smith   if (data->setup) {
1234f1580f4eSBarry Smith     Mat       P;
1235db4a47b3SPierre Jolivet     Vec       x, xt = nullptr;
1236f1580f4eSBarry Smith     PetscReal t = 0.0, s = 0.0;
1237f1580f4eSBarry Smith 
1238db4a47b3SPierre Jolivet     PetscCall(PCGetOperators(pc, nullptr, &P));
1239f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)P, "__SNES_latest_X", (PetscObject *)&x));
1240f1580f4eSBarry Smith     PetscCallBack("PCHPDDM Neumann callback", (*data->setup)(data->aux, t, x, xt, s, data->is, data->setup_ctx));
1241f1580f4eSBarry Smith   }
12423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1243f1580f4eSBarry Smith }
1244f1580f4eSBarry Smith 
1245d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCreateSubMatrices_Private(Mat mat, PetscInt n, const IS *, const IS *, MatReuse scall, Mat *submat[])
1246d71ae5a4SJacob Faibussowitsch {
1247f1580f4eSBarry Smith   Mat       A;
124813044ca3SPierre Jolivet   PetscBool flg;
1249f1580f4eSBarry Smith 
1250f1580f4eSBarry Smith   PetscFunctionBegin;
1251f1580f4eSBarry Smith   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatCreateSubMatrices() called to extract %" PetscInt_FMT " submatrices, which is different than 1", n);
1252f1580f4eSBarry Smith   /* previously composed Mat */
1253f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)mat, "_PCHPDDM_SubMatrices", (PetscObject *)&A));
1254f1580f4eSBarry Smith   PetscCheck(A, PETSC_COMM_SELF, PETSC_ERR_PLIB, "SubMatrices not found in Mat");
125513044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSCHURCOMPLEMENT, &flg)); /* MATSCHURCOMPLEMENT has neither a MatDuplicate() nor a MatCopy() implementation */
1256f1580f4eSBarry Smith   if (scall == MAT_INITIAL_MATRIX) {
12576f2c871aSStefano Zampini     PetscCall(PetscCalloc1(2, submat)); /* allocate an extra Mat to avoid errors in MatDestroySubMatrices_Dummy() */
125813044ca3SPierre Jolivet     if (!flg) PetscCall(MatDuplicate(A, MAT_COPY_VALUES, *submat));
125913044ca3SPierre Jolivet   } else if (!flg) PetscCall(MatCopy(A, (*submat)[0], SAME_NONZERO_PATTERN));
126013044ca3SPierre Jolivet   if (flg) {
1261bf583f0cSPierre Jolivet     PetscCall(MatDestroy(*submat)); /* previously created Mat has to be destroyed */
126213044ca3SPierre Jolivet     (*submat)[0] = A;
126313044ca3SPierre Jolivet     PetscCall(PetscObjectReference((PetscObject)A));
126413044ca3SPierre Jolivet   }
12653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1266f1580f4eSBarry Smith }
1267f1580f4eSBarry Smith 
1268d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCommunicationAvoidingPCASM_Private(PC pc, Mat C, PetscBool sorted)
1269d71ae5a4SJacob Faibussowitsch {
127057d50842SBarry Smith   PetscErrorCodeFn *op;
1271f1580f4eSBarry Smith 
1272f1580f4eSBarry Smith   PetscFunctionBegin;
1273f1580f4eSBarry Smith   /* previously-composed Mat */
1274f1580f4eSBarry Smith   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", (PetscObject)C));
1275f1580f4eSBarry Smith   PetscCall(MatGetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, &op));
1276f1580f4eSBarry Smith   /* trick suggested by Barry https://lists.mcs.anl.gov/pipermail/petsc-dev/2020-January/025491.html */
127757d50842SBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, (PetscErrorCodeFn *)PCHPDDMCreateSubMatrices_Private));
1278f1580f4eSBarry Smith   if (sorted) PetscCall(PCASMSetSortIndices(pc, PETSC_FALSE)); /* everything is already sorted */
1279f1580f4eSBarry Smith   PetscCall(PCSetFromOptions(pc));                             /* otherwise -pc_hpddm_levels_1_pc_asm_sub_mat_type is not used */
1280f1580f4eSBarry Smith   PetscCall(PCSetUp(pc));
1281f1580f4eSBarry Smith   /* reset MatCreateSubMatrices() */
1282f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, op));
1283db4a47b3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", nullptr));
12843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1285f1580f4eSBarry Smith }
1286f1580f4eSBarry Smith 
1287d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMPermute_Private(IS is, IS in_is, IS *out_is, Mat in_C, Mat *out_C, IS *p)
1288d71ae5a4SJacob Faibussowitsch {
1289f1580f4eSBarry Smith   IS                           perm;
1290f1580f4eSBarry Smith   const PetscInt              *ptr;
1291811e8887SPierre Jolivet   PetscInt                    *concatenate, size, bs;
1292f1580f4eSBarry Smith   std::map<PetscInt, PetscInt> order;
1293f1580f4eSBarry Smith   PetscBool                    sorted;
1294f1580f4eSBarry Smith 
1295f1580f4eSBarry Smith   PetscFunctionBegin;
1296cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(is, IS_CLASSID, 1);
1297cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(in_C, MAT_CLASSID, 4);
1298f1580f4eSBarry Smith   PetscCall(ISSorted(is, &sorted));
1299f1580f4eSBarry Smith   if (!sorted) {
1300f1580f4eSBarry Smith     PetscCall(ISGetLocalSize(is, &size));
1301f1580f4eSBarry Smith     PetscCall(ISGetIndices(is, &ptr));
1302b07dfdedSPierre Jolivet     PetscCall(ISGetBlockSize(is, &bs));
1303f1580f4eSBarry Smith     /* MatCreateSubMatrices(), called by PCASM, follows the global numbering of Pmat */
1304811e8887SPierre Jolivet     for (PetscInt n = 0; n < size; n += bs) order.insert(std::make_pair(ptr[n] / bs, n / bs));
1305f1580f4eSBarry Smith     PetscCall(ISRestoreIndices(is, &ptr));
1306b07dfdedSPierre Jolivet     size /= bs;
1307f1580f4eSBarry Smith     if (out_C) {
1308f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1309f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.second;
1310f1580f4eSBarry Smith       concatenate -= size;
1311b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_C), bs, size, concatenate, PETSC_OWN_POINTER, &perm));
1312f1580f4eSBarry Smith       PetscCall(ISSetPermutation(perm));
1313f1580f4eSBarry Smith       /* permute user-provided Mat so that it matches with MatCreateSubMatrices() numbering */
1314f1580f4eSBarry Smith       PetscCall(MatPermute(in_C, perm, perm, out_C));
1315f1580f4eSBarry Smith       if (p) *p = perm;
1316f1580f4eSBarry Smith       else PetscCall(ISDestroy(&perm)); /* no need to save the permutation */
1317f1580f4eSBarry Smith     }
1318f1580f4eSBarry Smith     if (out_is) {
1319f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1320f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.first;
1321f1580f4eSBarry Smith       concatenate -= size;
1322f1580f4eSBarry Smith       /* permute user-provided IS so that it matches with MatCreateSubMatrices() numbering */
1323b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_is), bs, size, concatenate, PETSC_OWN_POINTER, out_is));
1324f1580f4eSBarry Smith     }
1325f1580f4eSBarry Smith   } else { /* input IS is sorted, nothing to permute, simply duplicate inputs when needed */
1326f1580f4eSBarry Smith     if (out_C) PetscCall(MatDuplicate(in_C, MAT_COPY_VALUES, out_C));
1327f1580f4eSBarry Smith     if (out_is) PetscCall(ISDuplicate(in_is, out_is));
1328f1580f4eSBarry Smith   }
13293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1330f1580f4eSBarry Smith }
1331f1580f4eSBarry Smith 
1332281f8ce6SPierre Jolivet static PetscErrorCode PCHPDDMCheckSymmetry_Private(PC pc, Mat A01, Mat A10, Mat *B01 = nullptr)
133313044ca3SPierre Jolivet {
133413044ca3SPierre Jolivet   Mat       T, U = nullptr, B = nullptr;
133513044ca3SPierre Jolivet   IS        z;
1336281f8ce6SPierre Jolivet   PetscBool flg, conjugate = PETSC_FALSE;
133713044ca3SPierre Jolivet 
133813044ca3SPierre Jolivet   PetscFunctionBegin;
1339281f8ce6SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
1340281f8ce6SPierre Jolivet   if (B01) *B01 = nullptr;
1341281f8ce6SPierre Jolivet   if (flg) {
1342811e8887SPierre 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));
1343811e8887SPierre Jolivet     PetscCall(MatTransposeGetMat(A10, &U));
1344811e8887SPierre Jolivet   } else {
1345281f8ce6SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
1346281f8ce6SPierre Jolivet     if (flg) {
1347811e8887SPierre 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));
1348811e8887SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A10, &U));
1349281f8ce6SPierre Jolivet       conjugate = PETSC_TRUE;
1350811e8887SPierre Jolivet     }
135113044ca3SPierre Jolivet   }
135213044ca3SPierre Jolivet   if (U) PetscCall(MatDuplicate(U, MAT_COPY_VALUES, &T));
135313044ca3SPierre Jolivet   else PetscCall(MatHermitianTranspose(A10, MAT_INITIAL_MATRIX, &T));
1354281f8ce6SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATTRANSPOSEVIRTUAL, &flg));
1355281f8ce6SPierre Jolivet   if (flg) {
1356811e8887SPierre 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));
135713044ca3SPierre Jolivet     PetscCall(MatTransposeGetMat(A01, &A01));
135813044ca3SPierre Jolivet     PetscCall(MatTranspose(A01, MAT_INITIAL_MATRIX, &B));
135913044ca3SPierre Jolivet     A01 = B;
136013044ca3SPierre Jolivet   } else {
1361281f8ce6SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
1362281f8ce6SPierre Jolivet     if (flg) {
1363811e8887SPierre 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));
136413044ca3SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A01, &A01));
136513044ca3SPierre Jolivet       PetscCall(MatHermitianTranspose(A01, MAT_INITIAL_MATRIX, &B));
136613044ca3SPierre Jolivet       A01 = B;
136713044ca3SPierre Jolivet     }
136813044ca3SPierre Jolivet   }
1369281f8ce6SPierre Jolivet   PetscCall(PetscLayoutCompare(T->rmap, A01->rmap, &flg));
1370281f8ce6SPierre Jolivet   if (flg) {
1371281f8ce6SPierre Jolivet     PetscCall(PetscLayoutCompare(T->cmap, A01->cmap, &flg));
1372281f8ce6SPierre Jolivet     if (flg) {
137313044ca3SPierre Jolivet       PetscCall(MatFindZeroRows(A01, &z)); /* for essential boundary conditions, some implementations will */
137413044ca3SPierre Jolivet       if (z) {                             /*  zero rows in [P00 A01] except for the diagonal of P00       */
1375281f8ce6SPierre Jolivet         if (B01) PetscCall(MatDuplicate(T, MAT_COPY_VALUES, B01));
137613044ca3SPierre Jolivet         PetscCall(MatSetOption(T, MAT_NO_OFF_PROC_ZERO_ROWS, PETSC_TRUE));
137713044ca3SPierre Jolivet         PetscCall(MatZeroRowsIS(T, z, 0.0, nullptr, nullptr)); /* corresponding zero rows from A01 */
1378281f8ce6SPierre Jolivet       }
1379281f8ce6SPierre Jolivet       PetscCall(MatMultEqual(A01, T, 20, &flg));
1380281f8ce6SPierre Jolivet       if (!B01) PetscCheck(flg, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "A01 != A10^T");
1381281f8ce6SPierre Jolivet       else {
1382281f8ce6SPierre Jolivet         PetscCall(PetscInfo(pc, "A01 and A10^T are equal? %s\n", PetscBools[flg]));
1383281f8ce6SPierre Jolivet         if (!flg) {
1384281f8ce6SPierre Jolivet           if (z) PetscCall(MatDestroy(&T));
1385281f8ce6SPierre Jolivet           else *B01 = T;
1386281f8ce6SPierre Jolivet           flg = PETSC_TRUE;
1387281f8ce6SPierre Jolivet         } else PetscCall(MatDestroy(B01));
1388281f8ce6SPierre Jolivet       }
138913044ca3SPierre Jolivet       PetscCall(ISDestroy(&z));
139013044ca3SPierre Jolivet     }
139113044ca3SPierre Jolivet   }
1392281f8ce6SPierre Jolivet   if (!flg) PetscCall(PetscInfo(pc, "A01 and A10^T have non-congruent layouts, cannot test for equality\n"));
1393281f8ce6SPierre Jolivet   if (!B01 || !*B01) PetscCall(MatDestroy(&T));
1394281f8ce6SPierre Jolivet   else if (conjugate) PetscCall(MatConjugate(T));
139513044ca3SPierre Jolivet   PetscCall(MatDestroy(&B));
139613044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
139713044ca3SPierre Jolivet }
139813044ca3SPierre Jolivet 
1399d16c0b94SPierre Jolivet static PetscErrorCode PCHPDDMCheckInclusion_Private(PC pc, IS is, IS is_local, PetscBool check)
1400d16c0b94SPierre Jolivet {
1401d16c0b94SPierre Jolivet   IS          intersect;
1402d16c0b94SPierre Jolivet   const char *str = "IS of the auxiliary Mat does not include all local rows of A";
1403d16c0b94SPierre Jolivet   PetscBool   equal;
1404d16c0b94SPierre Jolivet 
1405d16c0b94SPierre Jolivet   PetscFunctionBegin;
1406d16c0b94SPierre Jolivet   PetscCall(ISIntersect(is, is_local, &intersect));
1407d16c0b94SPierre Jolivet   PetscCall(ISEqualUnsorted(is_local, intersect, &equal));
1408d16c0b94SPierre Jolivet   PetscCall(ISDestroy(&intersect));
1409d16c0b94SPierre Jolivet   if (check) PetscCheck(equal, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "%s", str);
1410d16c0b94SPierre Jolivet   else if (!equal) PetscCall(PetscInfo(pc, "%s\n", str));
1411d16c0b94SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1412d16c0b94SPierre Jolivet }
1413d16c0b94SPierre Jolivet 
1414d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMDestroySubMatrices_Private(PetscBool flg, PetscBool algebraic, Mat *sub)
1415d71ae5a4SJacob Faibussowitsch {
1416f1580f4eSBarry Smith   IS is;
1417f1580f4eSBarry Smith 
1418f1580f4eSBarry Smith   PetscFunctionBegin;
1419f1580f4eSBarry Smith   if (!flg) {
1420f1580f4eSBarry Smith     if (algebraic) {
1421f1580f4eSBarry Smith       PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Embed", (PetscObject *)&is));
1422f1580f4eSBarry Smith       PetscCall(ISDestroy(&is));
1423db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Embed", nullptr));
1424db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Compact", nullptr));
1425f1580f4eSBarry Smith     }
1426f1580f4eSBarry Smith     PetscCall(MatDestroySubMatrices(algebraic ? 2 : 1, &sub));
1427f1580f4eSBarry Smith   }
14283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1429f1580f4eSBarry Smith }
1430f1580f4eSBarry Smith 
1431d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMAlgebraicAuxiliaryMat_Private(Mat P, IS *is, Mat *sub[], PetscBool block)
1432d71ae5a4SJacob Faibussowitsch {
1433f1580f4eSBarry Smith   IS         icol[3], irow[2];
1434f1580f4eSBarry Smith   Mat       *M, Q;
1435f1580f4eSBarry Smith   PetscReal *ptr;
143658b7e2c1SStefano Zampini   PetscInt  *idx, p = 0, bs = P->cmap->bs;
1437f1580f4eSBarry Smith   PetscBool  flg;
1438f1580f4eSBarry Smith 
1439f1580f4eSBarry Smith   PetscFunctionBegin;
1440f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, P->cmap->N, 0, 1, icol + 2));
1441f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(icol[2], bs));
1442f1580f4eSBarry Smith   PetscCall(ISSetIdentity(icol[2]));
1443f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1444f1580f4eSBarry Smith   if (flg) {
1445f1580f4eSBarry Smith     /* MatCreateSubMatrices() does not handle MATMPISBAIJ properly when iscol != isrow, so convert first to MATMPIBAIJ */
1446f1580f4eSBarry Smith     PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &Q));
1447f1580f4eSBarry Smith     std::swap(P, Q);
1448f1580f4eSBarry Smith   }
1449f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(P, 1, is, icol + 2, MAT_INITIAL_MATRIX, &M));
1450f1580f4eSBarry Smith   if (flg) {
1451f1580f4eSBarry Smith     std::swap(P, Q);
1452f1580f4eSBarry Smith     PetscCall(MatDestroy(&Q));
1453f1580f4eSBarry Smith   }
1454f1580f4eSBarry Smith   PetscCall(ISDestroy(icol + 2));
1455f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, M[0]->rmap->N, 0, 1, irow));
1456f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(irow[0], bs));
1457f1580f4eSBarry Smith   PetscCall(ISSetIdentity(irow[0]));
1458f1580f4eSBarry Smith   if (!block) {
1459b07dfdedSPierre Jolivet     PetscCall(PetscMalloc2(P->cmap->N, &ptr, P->cmap->N / bs, &idx));
1460f1580f4eSBarry Smith     PetscCall(MatGetColumnNorms(M[0], NORM_INFINITY, ptr));
1461f1580f4eSBarry Smith     /* check for nonzero columns so that M[0] may be expressed in compact form */
1462811e8887SPierre Jolivet     for (PetscInt n = 0; n < P->cmap->N; n += bs) {
1463b07dfdedSPierre Jolivet       if (std::find_if(ptr + n, ptr + n + bs, [](PetscReal v) { return v > PETSC_MACHINE_EPSILON; }) != ptr + n + bs) idx[p++] = n / bs;
1464f1580f4eSBarry Smith     }
1465b07dfdedSPierre Jolivet     PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, p, idx, PETSC_USE_POINTER, icol + 1));
1466f1580f4eSBarry Smith     PetscCall(ISSetInfo(icol[1], IS_SORTED, IS_GLOBAL, PETSC_TRUE, PETSC_TRUE));
1467f1580f4eSBarry Smith     PetscCall(ISEmbed(*is, icol[1], PETSC_FALSE, icol + 2));
1468f1580f4eSBarry Smith     irow[1] = irow[0];
1469f1580f4eSBarry 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 */
1470f1580f4eSBarry Smith     icol[0] = is[0];
1471f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 2, irow, icol, MAT_INITIAL_MATRIX, sub));
1472f1580f4eSBarry Smith     PetscCall(ISDestroy(icol + 1));
1473f1580f4eSBarry Smith     PetscCall(PetscFree2(ptr, idx));
1474f1580f4eSBarry Smith     /* IS used to go back and forth between the augmented and the original local linear system, see eq. (3.4) of [2022b] */
1475f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Embed", (PetscObject)icol[2]));
1476f1580f4eSBarry Smith     /* Mat used in eq. (3.1) of [2022b] */
1477f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Compact", (PetscObject)(*sub)[1]));
1478f1580f4eSBarry Smith   } else {
1479f1580f4eSBarry Smith     Mat aux;
1480811e8887SPierre Jolivet 
1481f1580f4eSBarry Smith     PetscCall(MatSetOption(M[0], MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1482f1580f4eSBarry Smith     /* diagonal block of the overlapping rows */
1483f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 1, irow, is, MAT_INITIAL_MATRIX, sub));
1484f1580f4eSBarry Smith     PetscCall(MatDuplicate((*sub)[0], MAT_COPY_VALUES, &aux));
1485f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1486f1580f4eSBarry Smith     if (bs == 1) { /* scalar case */
1487f1580f4eSBarry Smith       Vec sum[2];
1488811e8887SPierre Jolivet 
1489f1580f4eSBarry Smith       PetscCall(MatCreateVecs(aux, sum, sum + 1));
1490f1580f4eSBarry Smith       PetscCall(MatGetRowSum(M[0], sum[0]));
1491f1580f4eSBarry Smith       PetscCall(MatGetRowSum(aux, sum[1]));
1492f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1493f1580f4eSBarry Smith       PetscCall(VecAXPY(sum[0], -1.0, sum[1]));
1494f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1495f1580f4eSBarry Smith       PetscCall(MatDiagonalSet(aux, sum[0], ADD_VALUES));
1496f1580f4eSBarry Smith       PetscCall(VecDestroy(sum));
1497f1580f4eSBarry Smith       PetscCall(VecDestroy(sum + 1));
1498f1580f4eSBarry Smith     } else { /* vectorial case */
1499f1580f4eSBarry Smith       /* TODO: missing MatGetValuesBlocked(), so the code below is     */
1500f1580f4eSBarry Smith       /* an extension of the scalar case for when bs > 1, but it could */
1501f1580f4eSBarry Smith       /* be more efficient by avoiding all these MatMatMult()          */
1502f1580f4eSBarry Smith       Mat          sum[2], ones;
1503f1580f4eSBarry Smith       PetscScalar *ptr;
1504811e8887SPierre Jolivet 
1505f1580f4eSBarry Smith       PetscCall(PetscCalloc1(M[0]->cmap->n * bs, &ptr));
1506f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, M[0]->cmap->n, bs, M[0]->cmap->n, bs, ptr, &ones));
1507811e8887SPierre Jolivet       for (PetscInt n = 0; n < M[0]->cmap->n; n += bs) {
1508f1580f4eSBarry Smith         for (p = 0; p < bs; ++p) ptr[n + p * (M[0]->cmap->n + 1)] = 1.0;
1509f1580f4eSBarry Smith       }
1510fb842aefSJose E. Roman       PetscCall(MatMatMult(M[0], ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum));
1511f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1512f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, aux->cmap->n, bs, aux->cmap->n, bs, ptr, &ones));
1513f1580f4eSBarry Smith       PetscCall(MatDenseSetLDA(ones, M[0]->cmap->n));
1514fb842aefSJose E. Roman       PetscCall(MatMatMult(aux, ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum + 1));
1515f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1516f1580f4eSBarry Smith       PetscCall(PetscFree(ptr));
1517f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1518f1580f4eSBarry Smith       PetscCall(MatAXPY(sum[0], -1.0, sum[1], SAME_NONZERO_PATTERN));
1519f1580f4eSBarry Smith       PetscCall(MatDestroy(sum + 1));
1520f1580f4eSBarry Smith       /* re-order values to be consistent with MatSetValuesBlocked()           */
1521f1580f4eSBarry Smith       /* equivalent to MatTranspose() which does not truly handle              */
1522f1580f4eSBarry Smith       /* MAT_INPLACE_MATRIX in the rectangular case, as it calls PetscMalloc() */
1523f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(sum[0], &ptr));
1524f1580f4eSBarry Smith       HPDDM::Wrapper<PetscScalar>::imatcopy<'T'>(bs, sum[0]->rmap->n, ptr, sum[0]->rmap->n, bs);
1525f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1526811e8887SPierre Jolivet       for (PetscInt n = 0; n < aux->cmap->n / bs; ++n) PetscCall(MatSetValuesBlocked(aux, 1, &n, 1, &n, ptr + n * bs * bs, ADD_VALUES));
1527f1580f4eSBarry Smith       PetscCall(MatAssemblyBegin(aux, MAT_FINAL_ASSEMBLY));
1528f1580f4eSBarry Smith       PetscCall(MatAssemblyEnd(aux, MAT_FINAL_ASSEMBLY));
1529f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(sum[0], &ptr));
1530f1580f4eSBarry Smith       PetscCall(MatDestroy(sum));
1531f1580f4eSBarry Smith     }
1532f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
1533f1580f4eSBarry Smith     /* left-hand side of GenEO, with the same sparsity pattern as PCASM subdomain solvers  */
1534f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Neumann_Mat", (PetscObject)aux));
1535f1580f4eSBarry Smith   }
1536f1580f4eSBarry Smith   PetscCall(ISDestroy(irow));
1537f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &M));
15383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1539f1580f4eSBarry Smith }
1540f1580f4eSBarry Smith 
154113044ca3SPierre Jolivet static PetscErrorCode PCApply_Nest(PC pc, Vec x, Vec y)
154213044ca3SPierre Jolivet {
154313044ca3SPierre Jolivet   Mat                    A;
154413044ca3SPierre Jolivet   MatSolverType          type;
154513044ca3SPierre Jolivet   IS                     is[2];
154613044ca3SPierre Jolivet   PetscBool              flg;
154713044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
154813044ca3SPierre Jolivet 
154913044ca3SPierre Jolivet   PetscFunctionBegin;
155013044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
155151ea4bc8SPierre Jolivet   if (p->second[0]) { /* in case of a centralized Schur complement, some processes may have no local operator */
155213044ca3SPierre Jolivet     PetscCall(PCGetOperators(p->first, &A, nullptr));
155313044ca3SPierre Jolivet     PetscCall(MatNestGetISs(A, is, nullptr));
155451ea4bc8SPierre Jolivet     PetscCall(PetscObjectTypeCompareAny((PetscObject)p->first, &flg, PCLU, PCCHOLESKY, ""));
155551ea4bc8SPierre Jolivet     if (flg) { /* partial solve currently only makes sense with exact factorizations */
155613044ca3SPierre Jolivet       PetscCall(PCFactorGetMatSolverType(p->first, &type));
155713044ca3SPierre Jolivet       PetscCall(PCFactorGetMatrix(p->first, &A));
155851ea4bc8SPierre Jolivet       if (A->schur) {
155913044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
156051ea4bc8SPierre Jolivet         if (flg) PetscCall(MatMumpsSetIcntl(A, 26, 1)); /* reduction/condensation phase followed by Schur complement solve */
156151ea4bc8SPierre Jolivet       } else flg = PETSC_FALSE;
156213044ca3SPierre Jolivet     }
156313044ca3SPierre Jolivet     PetscCall(VecISCopy(p->second[0], is[1], SCATTER_FORWARD, x)); /* assign the RHS associated to the Schur complement */
156413044ca3SPierre Jolivet     PetscCall(PCApply(p->first, p->second[0], p->second[1]));
156513044ca3SPierre Jolivet     PetscCall(VecISCopy(p->second[1], is[1], SCATTER_REVERSE, y)); /* retrieve the partial solution associated to the Schur complement */
156679578405SBarry Smith     if (flg) PetscCall(MatMumpsSetIcntl(A, 26, -1));               /* default ICNTL(26) value in PETSc */
156713044ca3SPierre Jolivet   }
156813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
156913044ca3SPierre Jolivet }
157013044ca3SPierre Jolivet 
157113044ca3SPierre Jolivet static PetscErrorCode PCView_Nest(PC pc, PetscViewer viewer)
157213044ca3SPierre Jolivet {
157313044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
157413044ca3SPierre Jolivet 
157513044ca3SPierre Jolivet   PetscFunctionBegin;
157613044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
157713044ca3SPierre Jolivet   PetscCall(PCView(p->first, viewer));
157813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
157913044ca3SPierre Jolivet }
158013044ca3SPierre Jolivet 
158113044ca3SPierre Jolivet static PetscErrorCode PCDestroy_Nest(PC pc)
158213044ca3SPierre Jolivet {
158313044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
158413044ca3SPierre Jolivet 
158513044ca3SPierre Jolivet   PetscFunctionBegin;
158613044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
158713044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second));
158813044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second + 1));
158913044ca3SPierre Jolivet   PetscCall(PCDestroy(&p->first));
159013044ca3SPierre Jolivet   PetscCall(PetscFree(p));
159113044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
159213044ca3SPierre Jolivet }
159313044ca3SPierre Jolivet 
159413044ca3SPierre Jolivet template <bool T = false>
159513044ca3SPierre Jolivet static PetscErrorCode MatMult_Schur(Mat A, Vec x, Vec y)
159613044ca3SPierre Jolivet {
159701e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
159813044ca3SPierre Jolivet 
159913044ca3SPierre Jolivet   PetscFunctionBegin;
160013044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
160113044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD)); /* local Vec with overlap */
160213044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD));
160313044ca3SPierre Jolivet   if (!T) PetscCall(MatMult(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1])); /* local Schur complement */
160413044ca3SPierre Jolivet   else PetscCall(MatMultTranspose(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1]));
160513044ca3SPierre Jolivet   PetscCall(VecSet(y, 0.0));
160613044ca3SPierre 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 */
160713044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE));
160813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
160913044ca3SPierre Jolivet }
161013044ca3SPierre Jolivet 
161113044ca3SPierre Jolivet static PetscErrorCode MatDestroy_Schur(Mat A)
161213044ca3SPierre Jolivet {
161301e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
161413044ca3SPierre Jolivet 
161513044ca3SPierre Jolivet   PetscFunctionBegin;
161613044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
161713044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx)));
161813044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx) + 1));
161913044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
162013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
162113044ca3SPierre Jolivet }
162213044ca3SPierre Jolivet 
162313044ca3SPierre Jolivet static PetscErrorCode MatMult_SchurCorrection(Mat A, Vec x, Vec y)
162413044ca3SPierre Jolivet {
162513044ca3SPierre Jolivet   PC                                         pc;
162613044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
162713044ca3SPierre Jolivet 
162813044ca3SPierre Jolivet   PetscFunctionBegin;
162913044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
163013044ca3SPierre Jolivet   pc = ((PC_HPDDM *)std::get<0>(*ctx)[0]->data)->levels[0]->ksp->pc;
163113044ca3SPierre 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 */
163213044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], x, std::get<3>(*ctx)[1]));                    /*     A_01 x                 */
163313044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 x             */
163413044ca3SPierre 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        */
163513044ca3SPierre 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 */
163613044ca3SPierre Jolivet   } else {
163713044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[0]));                    /*     M_S^-1 x               */
163813044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], std::get<3>(*ctx)[0], std::get<3>(*ctx)[1])); /*     A_01 M_S^-1 x          */
163913044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 M_S^-1 x      */
164013044ca3SPierre 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 */
164113044ca3SPierre Jolivet   }
164213044ca3SPierre Jolivet   PetscCall(VecAXPY(y, -1.0, x)); /* y -= x, preconditioned eq. (24) of https://hal.science/hal-02343808v6/document (with a sign flip) */
164313044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
164413044ca3SPierre Jolivet }
164513044ca3SPierre Jolivet 
164613044ca3SPierre Jolivet static PetscErrorCode MatView_SchurCorrection(Mat A, PetscViewer viewer)
164713044ca3SPierre Jolivet {
164813044ca3SPierre Jolivet   PetscBool                                  ascii;
164913044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
165013044ca3SPierre Jolivet 
165113044ca3SPierre Jolivet   PetscFunctionBegin;
165213044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &ascii));
165313044ca3SPierre Jolivet   if (ascii) {
165413044ca3SPierre Jolivet     PetscCall(MatShellGetContext(A, &ctx));
165513044ca3SPierre 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)"));
165613044ca3SPierre Jolivet     PetscCall(PCView(std::get<0>(*ctx)[1], viewer)); /* no need to PCView(Q_0) since it will be done by PCFIELDSPLIT */
165713044ca3SPierre Jolivet   }
165813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
165913044ca3SPierre Jolivet }
166013044ca3SPierre Jolivet 
166113044ca3SPierre Jolivet static PetscErrorCode MatDestroy_SchurCorrection(Mat A)
166213044ca3SPierre Jolivet {
166313044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
166413044ca3SPierre Jolivet 
166513044ca3SPierre Jolivet   PetscFunctionBegin;
166613044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
166713044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx)));
166813044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 1));
166913044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 2));
167013044ca3SPierre Jolivet   PetscCall(PCDestroy(std::get<0>(*ctx) + 1));
167113044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
167213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
167313044ca3SPierre Jolivet }
167413044ca3SPierre Jolivet 
1675feebddf4SPierre Jolivet static PetscErrorCode PCPostSolve_SchurPreLeastSquares(PC, KSP, Vec, Vec x)
1676feebddf4SPierre Jolivet {
1677feebddf4SPierre Jolivet   PetscFunctionBegin;
1678feebddf4SPierre Jolivet   PetscCall(VecScale(x, -1.0));
1679feebddf4SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1680feebddf4SPierre Jolivet }
1681feebddf4SPierre Jolivet 
168213044ca3SPierre Jolivet static PetscErrorCode KSPPreSolve_SchurCorrection(KSP, Vec b, Vec, void *context)
168313044ca3SPierre Jolivet {
168413044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
168513044ca3SPierre Jolivet 
1686a6b3e571SPierre Jolivet   PetscFunctionBegin;
168713044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
168813044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], b, std::get<3>(*ctx)[2]));
168913044ca3SPierre 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 */
169013044ca3SPierre Jolivet   }
169113044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
169213044ca3SPierre Jolivet }
169313044ca3SPierre Jolivet 
169413044ca3SPierre Jolivet static PetscErrorCode KSPPostSolve_SchurCorrection(KSP, Vec b, Vec x, void *context)
169513044ca3SPierre Jolivet {
169613044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
169713044ca3SPierre Jolivet 
1698a6b3e571SPierre Jolivet   PetscFunctionBegin;
169913044ca3SPierre 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 */
170013044ca3SPierre Jolivet   else {
170113044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[2]));
170213044ca3SPierre Jolivet     PetscCall(VecCopy(std::get<3>(*ctx)[2], x)); /* replace x by M^-1 x */
170313044ca3SPierre Jolivet   }
170413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
170513044ca3SPierre Jolivet }
170613044ca3SPierre Jolivet 
17079bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat, Vec, Vec);
17089bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat, Vec, Vec);
17099bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat, Mat, Mat, void *);
17109bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat);
17119bb5c669SPierre Jolivet 
1712d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDM(PC pc)
1713d71ae5a4SJacob Faibussowitsch {
1714f1580f4eSBarry Smith   PC_HPDDM                                  *data = (PC_HPDDM *)pc->data;
1715f1580f4eSBarry Smith   PC                                         inner;
1716f1580f4eSBarry Smith   KSP                                       *ksp;
171713044ca3SPierre Jolivet   Mat                                       *sub, A, P, N, C = nullptr, uaux = nullptr, weighted, subA[2], S;
1718f1580f4eSBarry Smith   Vec                                        xin, v;
1719f1580f4eSBarry Smith   std::vector<Vec>                           initial;
1720db4a47b3SPierre Jolivet   IS                                         is[1], loc, uis = data->is, unsorted = nullptr;
1721f1580f4eSBarry Smith   ISLocalToGlobalMapping                     l2g;
1722f1580f4eSBarry Smith   char                                       prefix[256];
1723f1580f4eSBarry Smith   const char                                *pcpre;
1724f1580f4eSBarry Smith   const PetscScalar *const                  *ev;
17259bb5c669SPierre Jolivet   PetscInt                                   n, requested = data->N, reused = 0, overlap = -1;
1726f1580f4eSBarry Smith   MatStructure                               structure  = UNKNOWN_NONZERO_PATTERN;
1727f1580f4eSBarry Smith   PetscBool                                  subdomains = PETSC_FALSE, flg = PETSC_FALSE, ismatis, swap = PETSC_FALSE, algebraic = PETSC_FALSE, block = PETSC_FALSE;
1728f1580f4eSBarry Smith   DM                                         dm;
172913044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = nullptr;
1730398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1731db4a47b3SPierre Jolivet   IS  dis  = nullptr;
1732db4a47b3SPierre Jolivet   Mat daux = nullptr;
1733398c7888SPierre Jolivet #endif
1734f1580f4eSBarry Smith 
1735f1580f4eSBarry Smith   PetscFunctionBegin;
1736f1580f4eSBarry Smith   PetscCheck(data->levels && data->levels[0], PETSC_COMM_SELF, PETSC_ERR_PLIB, "Not a single level allocated");
1737f1580f4eSBarry Smith   PetscCall(PCGetOptionsPrefix(pc, &pcpre));
1738f1580f4eSBarry Smith   PetscCall(PCGetOperators(pc, &A, &P));
1739f1580f4eSBarry Smith   if (!data->levels[0]->ksp) {
1740f1580f4eSBarry Smith     PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->ksp));
17413821be0aSBarry Smith     PetscCall(KSPSetNestLevel(data->levels[0]->ksp, pc->kspnestlevel));
1742f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_%s_", pcpre ? pcpre : "", data->N > 1 ? "levels_1" : "coarse"));
1743f1580f4eSBarry Smith     PetscCall(KSPSetOptionsPrefix(data->levels[0]->ksp, prefix));
1744f1580f4eSBarry Smith     PetscCall(KSPSetType(data->levels[0]->ksp, KSPPREONLY));
1745371d2eb7SMartin Diehl   } else if (data->levels[0]->ksp->pc && data->levels[0]->ksp->pc->setupcalled && data->levels[0]->ksp->pc->reusepreconditioner) {
1746f1580f4eSBarry Smith     /* if the fine-level PCSHELL exists, its setup has succeeded, and one wants to reuse it, */
1747f1580f4eSBarry Smith     /* then just propagate the appropriate flag to the coarser levels                        */
1748f1580f4eSBarry Smith     for (n = 0; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1749f1580f4eSBarry Smith       /* the following KSP and PC may be NULL for some processes, hence the check            */
1750f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetReusePreconditioner(data->levels[n]->ksp, PETSC_TRUE));
1751f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
1752f1580f4eSBarry Smith     }
1753f1580f4eSBarry Smith     /* early bail out because there is nothing to do */
17543ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1755f1580f4eSBarry Smith   } else {
1756f1580f4eSBarry Smith     /* reset coarser levels */
1757f1580f4eSBarry Smith     for (n = 1; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1758371d2eb7SMartin 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) {
1759f1580f4eSBarry Smith         reused = data->N - n;
1760f1580f4eSBarry Smith         break;
1761f1580f4eSBarry Smith       }
1762f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[n]->ksp));
1763f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[n]->pc));
1764f1580f4eSBarry Smith     }
1765f1580f4eSBarry Smith     /* check if some coarser levels are being reused */
1766462c564dSBarry Smith     PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &reused, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)pc)));
1767f1580f4eSBarry Smith     const int *addr = data->levels[0]->P ? data->levels[0]->P->getAddrLocal() : &HPDDM::i__0;
1768f1580f4eSBarry Smith 
1769f1580f4eSBarry Smith     if (addr != &HPDDM::i__0 && reused != data->N - 1) {
1770f1580f4eSBarry Smith       /* reuse previously computed eigenvectors */
1771f1580f4eSBarry Smith       ev = data->levels[0]->P->getVectors();
1772f1580f4eSBarry Smith       if (ev) {
1773f1580f4eSBarry Smith         initial.reserve(*addr);
1774f1580f4eSBarry Smith         PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, data->levels[0]->P->getDof(), ev[0], &xin));
1775f1580f4eSBarry Smith         for (n = 0; n < *addr; ++n) {
1776f1580f4eSBarry Smith           PetscCall(VecDuplicate(xin, &v));
1777f1580f4eSBarry Smith           PetscCall(VecPlaceArray(xin, ev[n]));
1778f1580f4eSBarry Smith           PetscCall(VecCopy(xin, v));
1779f1580f4eSBarry Smith           initial.emplace_back(v);
1780f1580f4eSBarry Smith           PetscCall(VecResetArray(xin));
1781f1580f4eSBarry Smith         }
1782f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
1783f1580f4eSBarry Smith       }
1784f1580f4eSBarry Smith     }
1785f1580f4eSBarry Smith   }
1786f1580f4eSBarry Smith   data->N -= reused;
1787f1580f4eSBarry Smith   PetscCall(KSPSetOperators(data->levels[0]->ksp, A, P));
1788f1580f4eSBarry Smith 
1789f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATIS, &ismatis));
1790f1580f4eSBarry Smith   if (!data->is && !ismatis) {
1791db4a47b3SPierre Jolivet     PetscErrorCode (*create)(DM, IS *, Mat *, PetscErrorCode (**)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void **) = nullptr;
1792db4a47b3SPierre Jolivet     PetscErrorCode (*usetup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *)                                                = nullptr;
1793db4a47b3SPierre Jolivet     void *uctx                                                                                                               = nullptr;
1794f1580f4eSBarry Smith 
1795f1580f4eSBarry Smith     /* first see if we can get the data from the DM */
1796f1580f4eSBarry Smith     PetscCall(MatGetDM(P, &dm));
1797f1580f4eSBarry Smith     if (!dm) PetscCall(MatGetDM(A, &dm));
1798f1580f4eSBarry Smith     if (!dm) PetscCall(PCGetDM(pc, &dm));
1799907a3e9cSStefano Zampini     if (dm) { /* this is the hook for DMPLEX for which the auxiliary Mat is the local Neumann matrix */
1800f1580f4eSBarry Smith       PetscCall(PetscObjectQueryFunction((PetscObject)dm, "DMCreateNeumannOverlap_C", &create));
1801f1580f4eSBarry Smith       if (create) {
1802f1580f4eSBarry Smith         PetscCall((*create)(dm, &uis, &uaux, &usetup, &uctx));
1803c8ea6600SPierre 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 */
1804f1580f4eSBarry Smith       }
1805f1580f4eSBarry Smith     }
1806f1580f4eSBarry Smith     if (!create) {
1807f1580f4eSBarry Smith       if (!uis) {
1808f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1809f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1810f1580f4eSBarry Smith       }
1811f1580f4eSBarry Smith       if (!uaux) {
1812f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1813f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1814f1580f4eSBarry Smith       }
1815f1580f4eSBarry Smith       /* look inside the Pmat instead of the PC, needed for MatSchurComplementComputeExplicitOperator() */
1816f1580f4eSBarry Smith       if (!uis) {
1817f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1818f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1819f1580f4eSBarry Smith       }
1820f1580f4eSBarry Smith       if (!uaux) {
1821f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1822f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1823f1580f4eSBarry Smith       }
1824f1580f4eSBarry Smith     }
1825f1580f4eSBarry Smith     PetscCall(PCHPDDMSetAuxiliaryMat(pc, uis, uaux, usetup, uctx));
1826f1580f4eSBarry Smith     PetscCall(MatDestroy(&uaux));
1827f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
1828f1580f4eSBarry Smith   }
1829f1580f4eSBarry Smith 
1830f1580f4eSBarry Smith   if (!ismatis) {
1831f1580f4eSBarry Smith     PetscCall(PCHPDDMSetUpNeumannOverlap_Private(pc));
1832db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_block_splitting", &block, nullptr));
18339bb5c669SPierre Jolivet     PetscCall(PetscOptionsGetInt(nullptr, pcpre, "-pc_hpddm_harmonic_overlap", &overlap, nullptr));
18345e642048SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
183551ea4bc8SPierre Jolivet     if (data->is || flg) {
18369bb5c669SPierre Jolivet       if (block || overlap != -1) {
183702800ff6SPierre Jolivet         PetscCall(ISDestroy(&data->is));
183802800ff6SPierre Jolivet         PetscCall(MatDestroy(&data->aux));
183951ea4bc8SPierre Jolivet       } else if (flg) {
184013044ca3SPierre Jolivet         PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_GENEO;
184113044ca3SPierre Jolivet 
184213044ca3SPierre Jolivet         PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
184313044ca3SPierre Jolivet         if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
184413044ca3SPierre Jolivet           PetscCall(ISDestroy(&data->is)); /* destroy any previously user-set objects since they will be set automatically */
184513044ca3SPierre Jolivet           PetscCall(MatDestroy(&data->aux));
184613044ca3SPierre Jolivet         } else if (type == PC_HPDDM_SCHUR_PRE_GENEO) {
184713044ca3SPierre Jolivet           PetscContainer container = nullptr;
184813044ca3SPierre Jolivet 
184913044ca3SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Schur", (PetscObject *)&container));
185013044ca3SPierre Jolivet           if (!container) { /* first call to PCSetUp() on the PC associated to the Schur complement */
185113044ca3SPierre Jolivet             PC_HPDDM       *data_00;
185213044ca3SPierre Jolivet             KSP             ksp, inner_ksp;
185313044ca3SPierre Jolivet             PC              pc_00;
1854cf67ef9dSPierre Jolivet             Mat             A11 = nullptr;
1855cf67ef9dSPierre Jolivet             Vec             d   = nullptr;
185651ea4bc8SPierre Jolivet             const PetscInt *ranges;
185751ea4bc8SPierre Jolivet             PetscMPIInt     size;
185813044ca3SPierre Jolivet             char           *prefix;
185913044ca3SPierre Jolivet 
186013044ca3SPierre Jolivet             PetscCall(MatSchurComplementGetKSP(P, &ksp));
186113044ca3SPierre Jolivet             PetscCall(KSPGetPC(ksp, &pc_00));
186213044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)pc_00, PCHPDDM, &flg));
1863fd310a01SPierre 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 : "",
186413044ca3SPierre Jolivet                        ((PetscObject)pc_00)->type_name, PCHPDDM);
186513044ca3SPierre Jolivet             data_00 = (PC_HPDDM *)pc_00->data;
1866fd310a01SPierre 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],
1867fd310a01SPierre Jolivet                        data_00->N, data_00->N > 1 ? "s" : "", ((PetscObject)pc_00)->prefix);
186851ea4bc8SPierre 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() : "");
186913044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)data_00->levels[0]->pc, PCASM, &flg));
1870fd310a01SPierre 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,
187113044ca3SPierre Jolivet                        ((PetscObject)data_00->levels[0]->pc)->type_name, PCASM);
187251ea4bc8SPierre 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)  */
1873d16c0b94SPierre Jolivet             PetscCall(MatSchurComplementGetSubMatrices(P, nullptr, nullptr, nullptr, nullptr, &A11));
187451ea4bc8SPierre Jolivet             PetscCall(MatGetOwnershipRanges(A11, &ranges));
187551ea4bc8SPierre Jolivet             PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A11), &size));
187651ea4bc8SPierre 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)? */
187751ea4bc8SPierre Jolivet             if (!flg) {
18785e642048SPierre Jolivet               if (PetscDefined(USE_DEBUG) || !data->is) {
18795e642048SPierre Jolivet                 Mat A01, A10, B = nullptr, C = nullptr, *sub;
188013044ca3SPierre Jolivet 
18815e642048SPierre Jolivet                 PetscCall(MatSchurComplementGetSubMatrices(P, &A, nullptr, &A01, &A10, nullptr));
18825e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
18835e642048SPierre Jolivet                 if (flg) {
18845e642048SPierre Jolivet                   PetscCall(MatTransposeGetMat(A10, &C));
18855e642048SPierre Jolivet                   PetscCall(MatTranspose(C, MAT_INITIAL_MATRIX, &B));
18865e642048SPierre Jolivet                 } else {
18875e642048SPierre Jolivet                   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
18885e642048SPierre Jolivet                   if (flg) {
18895e642048SPierre Jolivet                     PetscCall(MatHermitianTransposeGetMat(A10, &C));
18905e642048SPierre Jolivet                     PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &B));
18915e642048SPierre Jolivet                   }
18925e642048SPierre Jolivet                 }
1893811e8887SPierre Jolivet                 if (flg)
1894811e8887SPierre 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));
18955e642048SPierre Jolivet                 if (!B) {
18965e642048SPierre Jolivet                   B = A10;
18975e642048SPierre Jolivet                   PetscCall(PetscObjectReference((PetscObject)B));
18985e642048SPierre Jolivet                 } else if (!data->is) {
18995e642048SPierre Jolivet                   PetscCall(PetscObjectTypeCompareAny((PetscObject)A01, &flg, MATTRANSPOSEVIRTUAL, MATHERMITIANTRANSPOSEVIRTUAL, ""));
19005e642048SPierre Jolivet                   if (!flg) C = A01;
1901811e8887SPierre Jolivet                   else
1902811e8887SPierre 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));
19035e642048SPierre Jolivet                 }
190413044ca3SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, B->rmap->N, 0, 1, &uis));
19055e642048SPierre Jolivet                 PetscCall(ISSetIdentity(uis));
19065e642048SPierre Jolivet                 if (!data->is) {
19075e642048SPierre Jolivet                   if (C) PetscCall(PetscObjectReference((PetscObject)C));
19085e642048SPierre Jolivet                   else PetscCall(MatTranspose(B, MAT_INITIAL_MATRIX, &C));
19095e642048SPierre Jolivet                   PetscCall(ISDuplicate(data_00->is, is));
19105e642048SPierre Jolivet                   PetscCall(MatIncreaseOverlap(A, 1, is, 1));
19115e642048SPierre Jolivet                   PetscCall(MatSetOption(C, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
19125e642048SPierre Jolivet                   PetscCall(MatCreateSubMatrices(C, 1, is, &uis, MAT_INITIAL_MATRIX, &sub));
19135e642048SPierre Jolivet                   PetscCall(MatDestroy(&C));
19145e642048SPierre Jolivet                   PetscCall(MatTranspose(sub[0], MAT_INITIAL_MATRIX, &C));
19155e642048SPierre Jolivet                   PetscCall(MatDestroySubMatrices(1, &sub));
19165e642048SPierre Jolivet                   PetscCall(MatFindNonzeroRows(C, &data->is));
1917*9640b26aSPierre Jolivet                   PetscCheck(data->is, PetscObjectComm((PetscObject)C), PETSC_ERR_SUP, "No empty row, which likely means that some rows of A_10 are dense");
19185e642048SPierre Jolivet                   PetscCall(MatDestroy(&C));
19195e642048SPierre Jolivet                   PetscCall(ISDestroy(is));
1920d16c0b94SPierre Jolivet                   PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), A11->rmap->n, A11->rmap->rstart, 1, &loc));
1921d16c0b94SPierre Jolivet                   if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_FALSE));
1922d16c0b94SPierre Jolivet                   PetscCall(ISExpand(data->is, loc, is));
1923d16c0b94SPierre Jolivet                   PetscCall(ISDestroy(&loc));
1924d16c0b94SPierre Jolivet                   PetscCall(ISDestroy(&data->is));
1925d16c0b94SPierre Jolivet                   data->is = is[0];
1926d16c0b94SPierre Jolivet                   is[0]    = nullptr;
19275e642048SPierre Jolivet                 }
19285e642048SPierre Jolivet                 if (PetscDefined(USE_DEBUG)) {
19295e642048SPierre Jolivet                   PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
193013044ca3SPierre 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 */
193113044ca3SPierre Jolivet                   PetscCall(ISDestroy(&uis));
193213044ca3SPierre Jolivet                   PetscCall(ISDuplicate(data->is, &uis));
193313044ca3SPierre Jolivet                   PetscCall(ISSort(uis));
19345e642048SPierre Jolivet                   PetscCall(ISComplement(uis, 0, B->rmap->N, is));
193513044ca3SPierre Jolivet                   PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &C));
19365e642048SPierre Jolivet                   PetscCall(MatZeroRowsIS(C, is[0], 0.0, nullptr, nullptr));
19375e642048SPierre Jolivet                   PetscCall(ISDestroy(is));
193813044ca3SPierre Jolivet                   PetscCall(MatMultEqual(sub[0], C, 20, &flg));
193913044ca3SPierre 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 */
194013044ca3SPierre Jolivet                   PetscCall(MatDestroy(&C));
194113044ca3SPierre Jolivet                   PetscCall(MatDestroySubMatrices(1, &sub));
194213044ca3SPierre Jolivet                 }
19435e642048SPierre Jolivet                 PetscCall(ISDestroy(&uis));
19445e642048SPierre Jolivet                 PetscCall(MatDestroy(&B));
19455e642048SPierre Jolivet               }
1946cf67ef9dSPierre Jolivet               flg = PETSC_FALSE;
1947cf67ef9dSPierre Jolivet               if (!data->aux) {
1948cf67ef9dSPierre Jolivet                 Mat D;
1949cf67ef9dSPierre Jolivet 
1950cf67ef9dSPierre Jolivet                 PetscCall(MatCreateVecs(A11, &d, nullptr));
1951cf67ef9dSPierre Jolivet                 PetscCall(MatGetDiagonal(A11, d));
1952cf67ef9dSPierre Jolivet                 PetscCall(PetscObjectTypeCompareAny((PetscObject)A11, &flg, MATDIAGONAL, MATCONSTANTDIAGONAL, ""));
1953cf67ef9dSPierre Jolivet                 if (!flg) {
1954cf67ef9dSPierre Jolivet                   PetscCall(MatCreateDiagonal(d, &D));
1955cf67ef9dSPierre Jolivet                   PetscCall(MatMultEqual(A11, D, 20, &flg));
1956cf67ef9dSPierre Jolivet                   PetscCall(MatDestroy(&D));
1957cf67ef9dSPierre Jolivet                 }
1958cf67ef9dSPierre 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"));
1959cf67ef9dSPierre Jolivet               }
1960cf67ef9dSPierre Jolivet               if (data->Neumann != PETSC_BOOL3_TRUE && !flg && A11) {
1961cf67ef9dSPierre Jolivet                 PetscReal norm;
1962cf67ef9dSPierre Jolivet 
1963cf67ef9dSPierre Jolivet                 PetscCall(MatNorm(A11, NORM_INFINITY, &norm));
1964cf67ef9dSPierre 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 : "");
1965cf67ef9dSPierre 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"));
1966cf67ef9dSPierre Jolivet                 PetscCall(MatDestroy(&data->aux));
1967cf67ef9dSPierre Jolivet                 flg = PETSC_TRUE;
1968cf67ef9dSPierre Jolivet               }
1969cf67ef9dSPierre 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 */
197001e3c840SPierre Jolivet                 PetscSF            scatter;
197113044ca3SPierre Jolivet                 const PetscScalar *read;
1972cf67ef9dSPierre Jolivet                 PetscScalar       *write, *diagonal = nullptr;
197313044ca3SPierre Jolivet 
197413044ca3SPierre Jolivet                 PetscCall(MatDestroy(&data->aux));
197513044ca3SPierre Jolivet                 PetscCall(ISGetLocalSize(data->is, &n));
1976cf67ef9dSPierre Jolivet                 PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &xin));
1977cf67ef9dSPierre Jolivet                 PetscCall(VecDuplicate(xin, &v));
1978cf67ef9dSPierre Jolivet                 PetscCall(VecScatterCreate(xin, data->is, v, nullptr, &scatter));
197913044ca3SPierre Jolivet                 PetscCall(VecSet(v, 1.0));
1980cf67ef9dSPierre Jolivet                 PetscCall(VecSet(xin, 1.0));
1981cf67ef9dSPierre Jolivet                 PetscCall(VecScatterBegin(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE));
1982cf67ef9dSPierre Jolivet                 PetscCall(VecScatterEnd(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE)); /* v has the multiplicity of all unknowns on the overlap */
1983cf67ef9dSPierre Jolivet                 PetscCall(PetscSFDestroy(&scatter));
1984cf67ef9dSPierre Jolivet                 if (d) {
1985cf67ef9dSPierre Jolivet                   PetscCall(VecScatterCreate(d, data->is, v, nullptr, &scatter));
1986cf67ef9dSPierre Jolivet                   PetscCall(VecScatterBegin(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1987cf67ef9dSPierre Jolivet                   PetscCall(VecScatterEnd(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1988cf67ef9dSPierre Jolivet                   PetscCall(PetscSFDestroy(&scatter));
1989cf67ef9dSPierre Jolivet                   PetscCall(VecDestroy(&d));
1990cf67ef9dSPierre Jolivet                   PetscCall(PetscMalloc1(n, &diagonal));
1991cf67ef9dSPierre Jolivet                   PetscCall(VecGetArrayRead(v, &read));
1992cf67ef9dSPierre Jolivet                   PetscCallCXX(std::copy_n(read, n, diagonal));
1993cf67ef9dSPierre Jolivet                   PetscCall(VecRestoreArrayRead(v, &read));
1994cf67ef9dSPierre Jolivet                 }
199513044ca3SPierre Jolivet                 PetscCall(VecDestroy(&v));
199613044ca3SPierre Jolivet                 PetscCall(VecCreateSeq(PETSC_COMM_SELF, n, &v));
1997cf67ef9dSPierre Jolivet                 PetscCall(VecGetArrayRead(xin, &read));
199813044ca3SPierre Jolivet                 PetscCall(VecGetArrayWrite(v, &write));
1999cf67ef9dSPierre 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];
2000cf67ef9dSPierre Jolivet                 PetscCall(PetscFree(diagonal));
2001cf67ef9dSPierre Jolivet                 PetscCall(VecRestoreArrayRead(xin, &read));
200213044ca3SPierre Jolivet                 PetscCall(VecRestoreArrayWrite(v, &write));
2003cf67ef9dSPierre Jolivet                 PetscCall(VecDestroy(&xin));
2004c3e1b152SPierre Jolivet                 PetscCall(MatCreateDiagonal(v, &data->aux));
200513044ca3SPierre Jolivet                 PetscCall(VecDestroy(&v));
200613044ca3SPierre Jolivet               }
200713044ca3SPierre Jolivet               uis  = data->is;
200813044ca3SPierre Jolivet               uaux = data->aux;
200913044ca3SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)uis));
201013044ca3SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)uaux));
201113044ca3SPierre Jolivet               PetscCall(PetscStrallocpy(pcpre, &prefix));
201213044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(pc, nullptr));
201313044ca3SPierre Jolivet               PetscCall(PCSetType(pc, PCKSP));                                    /* replace the PC associated to the Schur complement by PCKSP */
201413044ca3SPierre Jolivet               PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &inner_ksp)); /* new KSP that will be attached to the previously set PC */
201513044ca3SPierre Jolivet               PetscCall(PetscObjectGetTabLevel((PetscObject)pc, &n));
201613044ca3SPierre Jolivet               PetscCall(PetscObjectSetTabLevel((PetscObject)inner_ksp, n + 2));
201713044ca3SPierre Jolivet               PetscCall(KSPSetOperators(inner_ksp, pc->mat, pc->pmat));
201813044ca3SPierre Jolivet               PetscCall(KSPSetOptionsPrefix(inner_ksp, std::string(std::string(prefix) + "pc_hpddm_").c_str()));
201913044ca3SPierre Jolivet               PetscCall(KSPSetSkipPCSetFromOptions(inner_ksp, PETSC_TRUE));
202013044ca3SPierre Jolivet               PetscCall(KSPSetFromOptions(inner_ksp));
202113044ca3SPierre Jolivet               PetscCall(KSPGetPC(inner_ksp, &inner));
202213044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(inner, nullptr));
202313044ca3SPierre Jolivet               PetscCall(PCSetType(inner, PCNONE)); /* no preconditioner since the action of M^-1 A or A M^-1 will be computed by the Amat */
202413044ca3SPierre Jolivet               PetscCall(PCKSPSetKSP(pc, inner_ksp));
202513044ca3SPierre Jolivet               std::get<0>(*ctx)[0] = pc_00; /* for coarse correction on the primal (e.g., velocity) space */
202613044ca3SPierre Jolivet               PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &std::get<0>(*ctx)[1]));
202751ea4bc8SPierre Jolivet               PetscCall(PCSetOptionsPrefix(pc, prefix)); /* both PC share the same prefix so that the outer PC can be reset with PCSetFromOptions() */
202813044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(std::get<0>(*ctx)[1], prefix));
202913044ca3SPierre Jolivet               PetscCall(PetscFree(prefix));
203013044ca3SPierre Jolivet               PetscCall(PCSetOperators(std::get<0>(*ctx)[1], pc->mat, pc->pmat));
203113044ca3SPierre Jolivet               PetscCall(PCSetType(std::get<0>(*ctx)[1], PCHPDDM));
203213044ca3SPierre 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 */
2033cf67ef9dSPierre Jolivet               if (flg) static_cast<PC_HPDDM *>(std::get<0>(*ctx)[1]->data)->Neumann = PETSC_BOOL3_TRUE;
203413044ca3SPierre Jolivet               PetscCall(PCSetFromOptions(std::get<0>(*ctx)[1]));
203513044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)uis));
203613044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)uaux));
203713044ca3SPierre 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 */
203857d50842SBarry Smith               PetscCall(MatShellSetOperation(S, MATOP_MULT, (PetscErrorCodeFn *)MatMult_SchurCorrection));
203957d50842SBarry Smith               PetscCall(MatShellSetOperation(S, MATOP_VIEW, (PetscErrorCodeFn *)MatView_SchurCorrection));
204057d50842SBarry Smith               PetscCall(MatShellSetOperation(S, MATOP_DESTROY, (PetscErrorCodeFn *)MatDestroy_SchurCorrection));
204113044ca3SPierre Jolivet               PetscCall(KSPGetPCSide(inner_ksp, &(std::get<2>(*ctx))));
204213044ca3SPierre Jolivet               if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
204313044ca3SPierre Jolivet                 PetscCall(KSPSetPreSolve(inner_ksp, KSPPreSolve_SchurCorrection, ctx));
204413044ca3SPierre Jolivet               } else { /* no support for PC_SYMMETRIC */
204513044ca3SPierre 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]);
204613044ca3SPierre Jolivet               }
204713044ca3SPierre Jolivet               PetscCall(KSPSetPostSolve(inner_ksp, KSPPostSolve_SchurCorrection, ctx));
2048715c1178SPierre Jolivet               PetscCall(PetscObjectContainerCompose((PetscObject)std::get<0>(*ctx)[1], "_PCHPDDM_Schur", ctx, nullptr));
204913044ca3SPierre Jolivet               PetscCall(PCSetUp(std::get<0>(*ctx)[1]));
205013044ca3SPierre Jolivet               PetscCall(KSPSetOperators(inner_ksp, S, S));
205113044ca3SPierre Jolivet               PetscCall(MatCreateVecs(std::get<1>(*ctx)[0], std::get<3>(*ctx), std::get<3>(*ctx) + 1));
205213044ca3SPierre Jolivet               PetscCall(VecDuplicate(std::get<3>(*ctx)[0], std::get<3>(*ctx) + 2));
205313044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)inner_ksp));
205413044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)S));
205551ea4bc8SPierre Jolivet             } else {
205651ea4bc8SPierre Jolivet               std::get<0>(*ctx)[0] = pc_00;
205751ea4bc8SPierre Jolivet               PetscCall(PetscObjectContainerCompose((PetscObject)pc, "_PCHPDDM_Schur", ctx, nullptr));
205851ea4bc8SPierre 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 */
205951ea4bc8SPierre Jolivet               PetscCall(MatGetDiagonalBlock(A11, &data->aux));
206051ea4bc8SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)data->aux));
206151ea4bc8SPierre Jolivet               PetscCall(PCSetUp(pc));
206251ea4bc8SPierre Jolivet             }
20630307214fSPierre Jolivet             for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
206413044ca3SPierre Jolivet             PetscFunctionReturn(PETSC_SUCCESS);
206513044ca3SPierre Jolivet           } else { /* second call to PCSetUp() on the PC associated to the Schur complement, retrieve previously set context */
206613044ca3SPierre Jolivet             PetscCall(PetscContainerGetPointer(container, (void **)&ctx));
206713044ca3SPierre Jolivet           }
206813044ca3SPierre Jolivet         }
206913044ca3SPierre Jolivet       }
207013044ca3SPierre Jolivet     }
2071f1580f4eSBarry Smith     if (!data->is && data->N > 1) {
2072f1580f4eSBarry Smith       char type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
2073811e8887SPierre Jolivet 
2074f1580f4eSBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
2075f1580f4eSBarry Smith       if (flg || (A->rmap->N != A->cmap->N && P->rmap->N == P->cmap->N && P->rmap->N == A->cmap->N)) {
2076f1580f4eSBarry Smith         Mat B;
2077811e8887SPierre Jolivet 
2078f1580f4eSBarry Smith         PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, A, P, &B, pcpre));
2079f1580f4eSBarry Smith         if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) data->correction = PC_HPDDM_COARSE_CORRECTION_BALANCED;
2080f1580f4eSBarry Smith         PetscCall(MatDestroy(&B));
2081f1580f4eSBarry Smith       } else {
2082f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
2083f1580f4eSBarry Smith         if (flg) {
2084f1580f4eSBarry Smith           Mat                 A00, P00, A01, A10, A11, B, N;
208513044ca3SPierre Jolivet           PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_LEAST_SQUARES;
208613044ca3SPierre Jolivet 
208713044ca3SPierre Jolivet           PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, &A01, &A10, &A11));
208813044ca3SPierre Jolivet           PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
208913044ca3SPierre Jolivet           if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
2090281f8ce6SPierre Jolivet             Mat                        B01;
20913df4cd7bSPierre Jolivet             Vec                        diagonal = nullptr;
2092f1580f4eSBarry Smith             const PetscScalar         *array;
2093f1580f4eSBarry Smith             MatSchurComplementAinvType type;
2094f1580f4eSBarry Smith 
2095281f8ce6SPierre Jolivet             PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10, &B01));
2096f1580f4eSBarry Smith             if (A11) {
20973df4cd7bSPierre Jolivet               PetscCall(MatCreateVecs(A11, &diagonal, nullptr));
20983df4cd7bSPierre Jolivet               PetscCall(MatGetDiagonal(A11, diagonal));
2099f1580f4eSBarry Smith             }
2100db4a47b3SPierre Jolivet             PetscCall(MatCreateVecs(P00, &v, nullptr));
2101f1580f4eSBarry Smith             PetscCall(MatSchurComplementGetAinvType(P, &type));
2102f1580f4eSBarry 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]);
2103f1580f4eSBarry Smith             if (type == MAT_SCHUR_COMPLEMENT_AINV_LUMP) {
2104f1580f4eSBarry Smith               PetscCall(MatGetRowSum(P00, v));
2105f1580f4eSBarry Smith               if (A00 == P00) PetscCall(PetscObjectReference((PetscObject)A00));
2106f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
2107f1580f4eSBarry Smith               PetscCall(VecGetArrayRead(v, &array));
2108db4a47b3SPierre Jolivet               PetscCall(MatCreateAIJ(PetscObjectComm((PetscObject)A00), A00->rmap->n, A00->cmap->n, A00->rmap->N, A00->cmap->N, 1, nullptr, 0, nullptr, &P00));
2109f1580f4eSBarry Smith               PetscCall(MatSetOption(P00, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
2110f1580f4eSBarry Smith               for (n = A00->rmap->rstart; n < A00->rmap->rend; ++n) PetscCall(MatSetValue(P00, n, n, array[n - A00->rmap->rstart], INSERT_VALUES));
2111f1580f4eSBarry Smith               PetscCall(MatAssemblyBegin(P00, MAT_FINAL_ASSEMBLY));
2112f1580f4eSBarry Smith               PetscCall(MatAssemblyEnd(P00, MAT_FINAL_ASSEMBLY));
2113f1580f4eSBarry Smith               PetscCall(VecRestoreArrayRead(v, &array));
2114f1580f4eSBarry Smith               PetscCall(MatSchurComplementUpdateSubMatrices(P, A00, P00, A01, A10, A11)); /* replace P00 by diag(sum of each row of P00) */
2115f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
2116f1580f4eSBarry Smith             } else PetscCall(MatGetDiagonal(P00, v));
2117f1580f4eSBarry Smith             PetscCall(VecReciprocal(v)); /* inv(diag(P00))       */
2118f1580f4eSBarry Smith             PetscCall(VecSqrtAbs(v));    /* sqrt(inv(diag(P00))) */
2119f1580f4eSBarry Smith             PetscCall(MatDuplicate(A01, MAT_COPY_VALUES, &B));
2120db4a47b3SPierre Jolivet             PetscCall(MatDiagonalScale(B, v, nullptr));
2121281f8ce6SPierre Jolivet             if (B01) PetscCall(MatDiagonalScale(B01, v, nullptr));
2122f1580f4eSBarry Smith             PetscCall(VecDestroy(&v));
2123f1580f4eSBarry Smith             PetscCall(MatCreateNormalHermitian(B, &N));
2124281f8ce6SPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, B, N, &P, pcpre, &diagonal, B01));
2125f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
2126f1580f4eSBarry Smith             if (!flg) {
2127f1580f4eSBarry Smith               PetscCall(MatDestroy(&P));
2128f1580f4eSBarry Smith               P = N;
2129f1580f4eSBarry Smith               PetscCall(PetscObjectReference((PetscObject)P));
2130feebddf4SPierre Jolivet             }
21313df4cd7bSPierre Jolivet             if (diagonal) {
21323df4cd7bSPierre Jolivet               PetscCall(MatDiagonalSet(P, diagonal, ADD_VALUES));
2133feebddf4SPierre Jolivet               PetscCall(PCSetOperators(pc, P, P)); /* replace P by A01^T inv(diag(P00)) A01 - diag(P11) */
21343df4cd7bSPierre Jolivet               PetscCall(VecDestroy(&diagonal));
2135281f8ce6SPierre Jolivet             } else PetscCall(PCSetOperators(pc, B01 ? P : N, P));  /* replace P by A01^T inv(diag(P00)) A01                         */
2136feebddf4SPierre Jolivet             pc->ops->postsolve = PCPostSolve_SchurPreLeastSquares; /*  PCFIELDSPLIT expect a KSP for (P11 - A10 inv(diag(P00)) A01) */
2137feebddf4SPierre Jolivet             PetscCall(MatDestroy(&N));                             /*  but a PC for (A10 inv(diag(P00)) A10 - P11) is setup instead */
2138feebddf4SPierre Jolivet             PetscCall(MatDestroy(&P));                             /*  so the sign of the solution must be flipped                  */
2139f1580f4eSBarry Smith             PetscCall(MatDestroy(&B));
214013044ca3SPierre Jolivet           } else
2141fd310a01SPierre 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 : "");
21420307214fSPierre Jolivet           for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
21433ba16761SJacob Faibussowitsch           PetscFunctionReturn(PETSC_SUCCESS);
2144f1580f4eSBarry Smith         } else {
2145db4a47b3SPierre Jolivet           PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_st_pc_type", type, sizeof(type), nullptr));
2146f1580f4eSBarry Smith           PetscCall(PetscStrcmp(type, PCMAT, &algebraic));
2147b07dfdedSPierre Jolivet           PetscCheck(!algebraic || !block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_block_splitting");
21489bb5c669SPierre Jolivet           if (overlap != -1) {
21499bb5c669SPierre 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");
21509bb5c669SPierre Jolivet             PetscCheck(overlap >= 1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_WRONG, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " < 1", overlap);
21519bb5c669SPierre Jolivet           }
21529bb5c669SPierre Jolivet           if (block || overlap != -1) algebraic = PETSC_TRUE;
2153f1580f4eSBarry Smith           if (algebraic) {
2154f1580f4eSBarry Smith             PetscCall(ISCreateStride(PETSC_COMM_SELF, P->rmap->n, P->rmap->rstart, 1, &data->is));
2155f1580f4eSBarry Smith             PetscCall(MatIncreaseOverlap(P, 1, &data->is, 1));
2156f1580f4eSBarry Smith             PetscCall(ISSort(data->is));
21579bb5c669SPierre Jolivet           } else
21589bb5c669SPierre 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 : ""));
2159f1580f4eSBarry Smith         }
2160f1580f4eSBarry Smith       }
2161f1580f4eSBarry Smith     }
2162f1580f4eSBarry Smith   }
2163398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2164398c7888SPierre Jolivet   if (data->is) PetscCall(ISDuplicate(data->is, &dis));
2165398c7888SPierre Jolivet   if (data->aux) PetscCall(MatDuplicate(data->aux, MAT_COPY_VALUES, &daux));
2166398c7888SPierre Jolivet #endif
2167f1580f4eSBarry Smith   if (data->is || (ismatis && data->N > 1)) {
2168f1580f4eSBarry Smith     if (ismatis) {
2169f1580f4eSBarry Smith       std::initializer_list<std::string> list = {MATSEQBAIJ, MATSEQSBAIJ};
2170f1580f4eSBarry Smith       PetscCall(MatISGetLocalMat(P, &N));
2171f1580f4eSBarry Smith       std::initializer_list<std::string>::const_iterator it = std::find(list.begin(), list.end(), ((PetscObject)N)->type_name);
2172f1580f4eSBarry Smith       PetscCall(MatISRestoreLocalMat(P, &N));
2173f1580f4eSBarry Smith       switch (std::distance(list.begin(), it)) {
2174d71ae5a4SJacob Faibussowitsch       case 0:
2175d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
2176d71ae5a4SJacob Faibussowitsch         break;
2177f1580f4eSBarry Smith       case 1:
2178f1580f4eSBarry Smith         /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIBAIJ */
2179f1580f4eSBarry Smith         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
2180f1580f4eSBarry Smith         PetscCall(MatSetOption(C, MAT_SYMMETRIC, PETSC_TRUE));
2181f1580f4eSBarry Smith         break;
2182d71ae5a4SJacob Faibussowitsch       default:
2183d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, &C));
2184f1580f4eSBarry Smith       }
2185db4a47b3SPierre Jolivet       PetscCall(MatISGetLocalToGlobalMapping(P, &l2g, nullptr));
2186f1580f4eSBarry Smith       PetscCall(PetscObjectReference((PetscObject)P));
2187f1580f4eSBarry Smith       PetscCall(KSPSetOperators(data->levels[0]->ksp, A, C));
2188f1580f4eSBarry Smith       std::swap(C, P);
2189f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingGetSize(l2g, &n));
2190f1580f4eSBarry Smith       PetscCall(ISCreateStride(PETSC_COMM_SELF, n, 0, 1, &loc));
2191f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingApplyIS(l2g, loc, &is[0]));
2192f1580f4eSBarry Smith       PetscCall(ISDestroy(&loc));
2193f1580f4eSBarry Smith       /* the auxiliary Mat is _not_ the local Neumann matrix                                */
2194f1580f4eSBarry Smith       /* it is the local Neumann matrix augmented (with zeros) through MatIncreaseOverlap() */
2195c8ea6600SPierre Jolivet       data->Neumann = PETSC_BOOL3_FALSE;
2196f1580f4eSBarry Smith       structure     = SAME_NONZERO_PATTERN;
2197f1580f4eSBarry Smith     } else {
2198f1580f4eSBarry Smith       is[0] = data->is;
219913044ca3SPierre Jolivet       if (algebraic || ctx) subdomains = PETSC_TRUE;
2200db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_define_subdomains", &subdomains, nullptr));
220113044ca3SPierre 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);
2202c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann)) {
2203b07dfdedSPierre Jolivet         PetscCheck(!block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_block_splitting and -pc_hpddm_has_neumann");
22049bb5c669SPierre Jolivet         PetscCheck(overlap == -1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " and -pc_hpddm_has_neumann", overlap);
2205b07dfdedSPierre Jolivet         PetscCheck(!algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_has_neumann");
2206f1580f4eSBarry Smith       }
2207c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann) || block) structure = SAME_NONZERO_PATTERN;
2208f1580f4eSBarry Smith       PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), P->rmap->n, P->rmap->rstart, 1, &loc));
2209f1580f4eSBarry Smith     }
2210f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2211db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetEnum(nullptr, prefix, "-st_matstructure", MatStructures, (PetscEnum *)&structure, &flg)); /* if not user-provided, force its value when possible */
2212f1580f4eSBarry Smith     if (!flg && structure == SAME_NONZERO_PATTERN) {                                                                   /* cannot call STSetMatStructure() yet, insert the appropriate option in the database, parsed by STSetFromOptions() */
2213f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-%spc_hpddm_levels_1_st_matstructure", pcpre ? pcpre : ""));
2214db4a47b3SPierre Jolivet       PetscCall(PetscOptionsSetValue(nullptr, prefix, MatStructures[structure]));
2215f1580f4eSBarry Smith     }
2216398c7888SPierre Jolivet     flg = PETSC_FALSE;
2217b07dfdedSPierre Jolivet     if (data->share) {
2218398c7888SPierre Jolivet       data->share = PETSC_FALSE; /* will be reset to PETSC_TRUE if none of the conditions below are true */
2219398c7888SPierre 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 : ""));
2220398c7888SPierre Jolivet       else if (data->deflation) PetscCall(PetscInfo(pc, "Nothing to share since PCHPDDMSetDeflationMat() has been called\n"));
2221398c7888SPierre Jolivet       else if (ismatis) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc with a Pmat of type MATIS\n"));
2222b07dfdedSPierre Jolivet       else if (!algebraic && structure != SAME_NONZERO_PATTERN)
2223398c7888SPierre 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]));
2224398c7888SPierre Jolivet       else data->share = PETSC_TRUE;
2225398c7888SPierre Jolivet     }
2226398c7888SPierre Jolivet     if (!ismatis) {
2227398c7888SPierre Jolivet       if (data->share || (!PetscBool3ToBool(data->Neumann) && subdomains)) PetscCall(ISDuplicate(is[0], &unsorted));
2228398c7888SPierre Jolivet       else unsorted = is[0];
2229398c7888SPierre Jolivet     }
223051ea4bc8SPierre Jolivet     if ((ctx || data->N > 1) && (data->aux || ismatis || algebraic)) {
2231f1580f4eSBarry Smith       PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "HPDDM library not loaded, cannot use more than one level");
2232f1580f4eSBarry Smith       PetscCall(MatSetOption(P, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
2233f1580f4eSBarry Smith       if (ismatis) {
2234f1580f4eSBarry Smith         /* needed by HPDDM (currently) so that the partition of unity is 0 on subdomain interfaces */
2235f1580f4eSBarry Smith         PetscCall(MatIncreaseOverlap(P, 1, is, 1));
2236f1580f4eSBarry Smith         PetscCall(ISDestroy(&data->is));
2237f1580f4eSBarry Smith         data->is = is[0];
2238f1580f4eSBarry Smith       } else {
2239d16c0b94SPierre Jolivet         if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_TRUE));
224051ea4bc8SPierre Jolivet         if (!ctx && overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", PCHPDDMAlgebraicAuxiliaryMat_Private));
22419bb5c669SPierre Jolivet         if (!PetscBool3ToBool(data->Neumann) && (!algebraic || overlap != -1)) {
2242f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
2243f1580f4eSBarry Smith           if (flg) {
2244f1580f4eSBarry Smith             /* maybe better to ISSort(is[0]), MatCreateSubMatrices(), and then MatPermute() */
2245f1580f4eSBarry Smith             /* but there is no MatPermute_SeqSBAIJ(), so as before, just use MATMPIBAIJ     */
2246f1580f4eSBarry Smith             PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &uaux));
2247f1580f4eSBarry Smith             flg = PETSC_FALSE;
2248f1580f4eSBarry Smith           }
2249f1580f4eSBarry Smith         }
2250f1580f4eSBarry Smith       }
22519bb5c669SPierre Jolivet       if (algebraic && overlap == -1) {
2252f1580f4eSBarry Smith         PetscUseMethod(pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", (Mat, IS *, Mat *[], PetscBool), (P, is, &sub, block));
2253f1580f4eSBarry Smith         if (block) {
2254f1580f4eSBarry Smith           PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", (PetscObject *)&data->aux));
2255db4a47b3SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", nullptr));
2256f1580f4eSBarry Smith         }
22579bb5c669SPierre Jolivet       } else if (!uaux || overlap != -1) {
225813044ca3SPierre Jolivet         if (!ctx) {
2259c8ea6600SPierre Jolivet           if (PetscBool3ToBool(data->Neumann)) sub = &data->aux;
22609bb5c669SPierre Jolivet           else {
2261df21ef68SPierre Jolivet             PetscBool flg;
22629bb5c669SPierre Jolivet             if (overlap != -1) {
22639bb5c669SPierre Jolivet               Harmonic              h;
22649bb5c669SPierre Jolivet               Mat                   A0, *a;                    /* with an SVD: [ A_00  A_01       ] */
22659bb5c669SPierre Jolivet               IS                    ov[2], rows, cols, stride; /*              [ A_10  A_11  A_12 ] */
226658b7e2c1SStefano Zampini               const PetscInt       *i[2], bs = P->cmap->bs;    /* with a GEVP: [ A_00  A_01       ] */
22679bb5c669SPierre Jolivet               PetscInt              n[2];                      /*              [ A_10  A_11  A_12 ] */
22689bb5c669SPierre Jolivet               std::vector<PetscInt> v[2];                      /*              [       A_21  A_22 ] */
22699bb5c669SPierre Jolivet 
22702589ceddSPierre Jolivet               do {
22719bb5c669SPierre Jolivet                 PetscCall(ISDuplicate(data->is, ov));
22729bb5c669SPierre Jolivet                 if (overlap > 1) PetscCall(MatIncreaseOverlap(P, 1, ov, overlap - 1));
22739bb5c669SPierre Jolivet                 PetscCall(ISDuplicate(ov[0], ov + 1));
22749bb5c669SPierre Jolivet                 PetscCall(MatIncreaseOverlap(P, 1, ov + 1, 1));
22752589ceddSPierre Jolivet                 PetscCall(ISGetLocalSize(ov[0], n));
22762589ceddSPierre Jolivet                 PetscCall(ISGetLocalSize(ov[1], n + 1));
22778fad524dSPierre Jolivet                 flg = PetscBool(n[0] == n[1] && n[0] != P->rmap->n);
22785440e5dcSBarry Smith                 PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &flg, 1, MPI_C_BOOL, MPI_LOR, PetscObjectComm((PetscObject)pc)));
22792589ceddSPierre Jolivet                 if (flg) {
22802589ceddSPierre Jolivet                   PetscCall(ISDestroy(ov));
22812589ceddSPierre Jolivet                   PetscCall(ISDestroy(ov + 1));
22822589ceddSPierre Jolivet                   PetscCheck(--overlap, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "No oversampling possible");
22832589ceddSPierre Jolivet                   PetscCall(PetscInfo(pc, "Supplied -%spc_hpddm_harmonic_overlap parameter is too large, it has been decreased to %" PetscInt_FMT "\n", pcpre ? pcpre : "", overlap));
22842589ceddSPierre Jolivet                 } else break;
22852589ceddSPierre Jolivet               } while (1);
22869bb5c669SPierre Jolivet               PetscCall(PetscNew(&h));
22879bb5c669SPierre Jolivet               h->ksp = nullptr;
22889bb5c669SPierre Jolivet               PetscCall(PetscCalloc1(2, &h->A));
2289b5a302b3SPierre Jolivet               PetscCall(PetscOptionsHasName(nullptr, prefix, "-eps_nev", &flg));
2290b5a302b3SPierre Jolivet               if (!flg) {
22913a60673dSPierre Jolivet                 PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_nsv", &flg));
2292b5a302b3SPierre Jolivet                 if (!flg) PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_threshold_relative", &flg));
2293b5a302b3SPierre Jolivet               } else flg = PETSC_FALSE;
22949bb5c669SPierre Jolivet               PetscCall(ISSort(ov[0]));
22959bb5c669SPierre Jolivet               if (!flg) PetscCall(ISSort(ov[1]));
229632603206SJames Wright               PetscCall(PetscCalloc1(5, &h->is));
22979bb5c669SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, ov + !flg, ov + 1, MAT_INITIAL_MATRIX, &a)); /* submatrix from above, either square (!flg) or rectangular (flg) */
22982589ceddSPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISGetIndices(ov[j], i + j));
22999bb5c669SPierre Jolivet               v[1].reserve((n[1] - n[0]) / bs);
23009bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[1]; j += bs) { /* indices of the (2,2) block */
23019bb5c669SPierre Jolivet                 PetscInt location;
23029bb5c669SPierre Jolivet                 PetscCall(ISLocate(ov[0], i[1][j], &location));
23039bb5c669SPierre Jolivet                 if (location < 0) v[1].emplace_back(j / bs);
23049bb5c669SPierre Jolivet               }
23059bb5c669SPierre Jolivet               if (!flg) {
23069bb5c669SPierre Jolivet                 h->A[1] = a[0];
23079bb5c669SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)h->A[1]));
23089bb5c669SPierre Jolivet                 v[0].reserve((n[0] - P->rmap->n) / bs);
23099bb5c669SPierre Jolivet                 for (PetscInt j = 0; j < n[1]; j += bs) { /* row indices of the (1,2) block */
23109bb5c669SPierre Jolivet                   PetscInt location;
23119bb5c669SPierre Jolivet                   PetscCall(ISLocate(loc, i[1][j], &location));
23129bb5c669SPierre Jolivet                   if (location < 0) {
23139bb5c669SPierre Jolivet                     PetscCall(ISLocate(ov[0], i[1][j], &location));
23149bb5c669SPierre Jolivet                     if (location >= 0) v[0].emplace_back(j / bs);
23159bb5c669SPierre Jolivet                   }
23169bb5c669SPierre Jolivet                 }
23179bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
23189bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_COPY_VALUES, h->is + 4));
23199bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, h->is[4], MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
23209bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
23219bb5c669SPierre 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 */
23229bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &rows));
23239bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols = rows, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
23249bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
23259bb5c669SPierre Jolivet                 v[0].clear();
23269bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, ov[1], PETSC_TRUE, h->is + 3));
23279bb5c669SPierre Jolivet                 PetscCall(ISEmbed(data->is, ov[1], PETSC_TRUE, h->is + 2));
23289bb5c669SPierre Jolivet               }
23299bb5c669SPierre Jolivet               v[0].reserve((n[0] - P->rmap->n) / bs);
23309bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[0]; j += bs) {
23319bb5c669SPierre Jolivet                 PetscInt location;
23329bb5c669SPierre Jolivet                 PetscCall(ISLocate(loc, i[0][j], &location));
23339bb5c669SPierre Jolivet                 if (location < 0) v[0].emplace_back(j / bs);
23349bb5c669SPierre Jolivet               }
23359bb5c669SPierre Jolivet               PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
23369bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISRestoreIndices(ov[j], i + j));
23379bb5c669SPierre Jolivet               if (flg) {
23389bb5c669SPierre Jolivet                 IS is;
23399bb5c669SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, a[0]->rmap->n, 0, 1, &is));
23409bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &cols));
23419bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], is, cols, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
23429bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
23439bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&is));
23449bb5c669SPierre 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 */
23459bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, data->is, PETSC_TRUE, h->is + 2));
23469bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_USE_POINTER, &cols));
23479bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols, MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
23489bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
23499bb5c669SPierre Jolivet               }
23509bb5c669SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, A0->rmap->n, 0, 1, &stride));
23519bb5c669SPierre Jolivet               PetscCall(ISEmbed(rows, stride, PETSC_TRUE, h->is));
23529bb5c669SPierre Jolivet               PetscCall(ISDestroy(&stride));
23539bb5c669SPierre Jolivet               PetscCall(ISDestroy(&rows));
23549bb5c669SPierre Jolivet               PetscCall(ISEmbed(loc, ov[0], PETSC_TRUE, h->is + 1));
23559bb5c669SPierre Jolivet               if (subdomains) {
23569bb5c669SPierre Jolivet                 if (!data->levels[0]->pc) {
23579bb5c669SPierre Jolivet                   PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
23589bb5c669SPierre Jolivet                   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
23599bb5c669SPierre Jolivet                   PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
23609bb5c669SPierre Jolivet                   PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
23619bb5c669SPierre Jolivet                 }
23629bb5c669SPierre Jolivet                 PetscCall(PCSetType(data->levels[0]->pc, PCASM));
23639bb5c669SPierre Jolivet                 if (!data->levels[0]->pc->setupcalled) PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, ov + !flg, &loc));
23649bb5c669SPierre Jolivet                 PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, flg ? A0 : a[0], PETSC_TRUE));
23659bb5c669SPierre Jolivet                 if (!flg) ++overlap;
23669bb5c669SPierre Jolivet                 if (data->share) {
23679bb5c669SPierre Jolivet                   PetscInt n = -1;
23689bb5c669SPierre Jolivet                   PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
23699bb5c669SPierre Jolivet                   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
23709bb5c669SPierre Jolivet                   if (flg) {
23719bb5c669SPierre Jolivet                     h->ksp = ksp[0];
23729bb5c669SPierre Jolivet                     PetscCall(PetscObjectReference((PetscObject)h->ksp));
23739bb5c669SPierre Jolivet                   }
23749bb5c669SPierre Jolivet                 }
23759bb5c669SPierre Jolivet               }
23769bb5c669SPierre Jolivet               if (!h->ksp) {
23779bb5c669SPierre Jolivet                 PetscBool share = data->share;
23789bb5c669SPierre Jolivet                 PetscCall(KSPCreate(PETSC_COMM_SELF, &h->ksp));
23799bb5c669SPierre Jolivet                 PetscCall(KSPSetType(h->ksp, KSPPREONLY));
23809bb5c669SPierre Jolivet                 PetscCall(KSPSetOperators(h->ksp, A0, A0));
23819bb5c669SPierre Jolivet                 do {
23829bb5c669SPierre Jolivet                   if (!data->share) {
23839bb5c669SPierre Jolivet                     share = PETSC_FALSE;
23849bb5c669SPierre Jolivet                     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_%s", pcpre ? pcpre : "", flg ? "svd_" : "eps_"));
23859bb5c669SPierre Jolivet                     PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
23869bb5c669SPierre Jolivet                     PetscCall(KSPSetFromOptions(h->ksp));
23879bb5c669SPierre Jolivet                   } else {
23889bb5c669SPierre Jolivet                     MatSolverType type;
23899bb5c669SPierre Jolivet                     PetscCall(KSPGetPC(ksp[0], &pc));
23909bb5c669SPierre Jolivet                     PetscCall(PetscObjectTypeCompareAny((PetscObject)pc, &data->share, PCLU, PCCHOLESKY, ""));
23919bb5c669SPierre Jolivet                     if (data->share) {
23929bb5c669SPierre Jolivet                       PetscCall(PCFactorGetMatSolverType(pc, &type));
23939bb5c669SPierre Jolivet                       if (!type) {
23949bb5c669SPierre Jolivet                         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMUMPS));
23959bb5c669SPierre Jolivet                         else if (PetscDefined(HAVE_MKL_PARDISO)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMKL_PARDISO));
23969bb5c669SPierre Jolivet                         else data->share = PETSC_FALSE;
23979bb5c669SPierre Jolivet                         if (data->share) PetscCall(PCSetFromOptions(pc));
23989bb5c669SPierre Jolivet                       } else {
23999bb5c669SPierre Jolivet                         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &data->share));
24009bb5c669SPierre Jolivet                         if (!data->share) PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &data->share));
24019bb5c669SPierre Jolivet                       }
24029bb5c669SPierre Jolivet                       if (data->share) {
24039bb5c669SPierre Jolivet                         std::tuple<KSP, IS, Vec[2]> *p;
24049bb5c669SPierre Jolivet                         PetscCall(PCFactorGetMatrix(pc, &A));
24059bb5c669SPierre Jolivet                         PetscCall(MatFactorSetSchurIS(A, h->is[4]));
24069bb5c669SPierre Jolivet                         PetscCall(KSPSetUp(ksp[0]));
24079bb5c669SPierre Jolivet                         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_eps_shell_", pcpre ? pcpre : ""));
24089bb5c669SPierre Jolivet                         PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
24099bb5c669SPierre Jolivet                         PetscCall(KSPSetFromOptions(h->ksp));
24109bb5c669SPierre Jolivet                         PetscCall(KSPGetPC(h->ksp, &pc));
24119bb5c669SPierre Jolivet                         PetscCall(PCSetType(pc, PCSHELL));
24129bb5c669SPierre Jolivet                         PetscCall(PetscNew(&p));
24139bb5c669SPierre Jolivet                         std::get<0>(*p) = ksp[0];
24149bb5c669SPierre Jolivet                         PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &std::get<1>(*p)));
24159bb5c669SPierre Jolivet                         PetscCall(MatCreateVecs(A, std::get<2>(*p), std::get<2>(*p) + 1));
24169bb5c669SPierre Jolivet                         PetscCall(PCShellSetContext(pc, p));
24179bb5c669SPierre Jolivet                         PetscCall(PCShellSetApply(pc, PCApply_Schur));
24189bb5c669SPierre Jolivet                         PetscCall(PCShellSetApplyTranspose(pc, PCApply_Schur<Vec, true>));
24199bb5c669SPierre Jolivet                         PetscCall(PCShellSetMatApply(pc, PCApply_Schur<Mat>));
24209bb5c669SPierre Jolivet                         PetscCall(PCShellSetDestroy(pc, PCDestroy_Schur));
24219bb5c669SPierre Jolivet                       }
24229bb5c669SPierre Jolivet                     }
24239bb5c669SPierre Jolivet                     if (!data->share) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since neither MUMPS nor MKL PARDISO is used\n"));
24249bb5c669SPierre Jolivet                   }
24259bb5c669SPierre 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 */
24269bb5c669SPierre Jolivet               }
24279bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov));
24289bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov + 1));
24299bb5c669SPierre Jolivet               if (overlap == 1 && subdomains && flg) {
24309bb5c669SPierre Jolivet                 *subA = A0;
24319bb5c669SPierre Jolivet                 sub   = subA;
24329bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatDestroy(&uaux));
24339bb5c669SPierre Jolivet               } else PetscCall(MatDestroy(&A0));
24349bb5c669SPierre Jolivet               PetscCall(MatCreateShell(PETSC_COMM_SELF, P->rmap->n, n[1] - n[0], P->rmap->n, n[1] - n[0], h, &data->aux));
2435bdcd51b8SPierre Jolivet               PetscCall(KSPSetErrorIfNotConverged(h->ksp, PETSC_TRUE)); /* bail out as early as possible to avoid (apparently) unrelated error messages */
24369bb5c669SPierre Jolivet               PetscCall(MatCreateVecs(h->ksp->pc->pmat, &h->v, nullptr));
243757d50842SBarry Smith               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT, (PetscErrorCodeFn *)MatMult_Harmonic));
243857d50842SBarry Smith               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT_TRANSPOSE, (PetscErrorCodeFn *)MatMultTranspose_Harmonic));
24399bb5c669SPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AB, nullptr, MatProduct_AB_Harmonic, nullptr, MATDENSE, MATDENSE));
244057d50842SBarry Smith               PetscCall(MatShellSetOperation(data->aux, MATOP_DESTROY, (PetscErrorCodeFn *)MatDestroy_Harmonic));
24419bb5c669SPierre Jolivet               PetscCall(MatDestroySubMatrices(1, &a));
24429bb5c669SPierre Jolivet             }
2443df21ef68SPierre Jolivet             if (overlap != 1 || !subdomains) {
2444df21ef68SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2445df21ef68SPierre Jolivet               if (ismatis) {
2446df21ef68SPierre Jolivet                 PetscCall(MatISGetLocalMat(C, &N));
2447df21ef68SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)N, MATSEQSBAIJ, &flg));
2448df21ef68SPierre Jolivet                 if (flg) PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2449df21ef68SPierre Jolivet                 PetscCall(MatISRestoreLocalMat(C, &N));
2450df21ef68SPierre Jolivet               }
2451df21ef68SPierre Jolivet             }
24529bb5c669SPierre Jolivet             if (uaux) {
24539bb5c669SPierre Jolivet               PetscCall(MatDestroy(&uaux));
24549bb5c669SPierre Jolivet               PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
24559bb5c669SPierre Jolivet             }
24569bb5c669SPierre Jolivet           }
245713044ca3SPierre Jolivet         }
245851ea4bc8SPierre Jolivet       } else if (!ctx) {
2459f1580f4eSBarry Smith         PetscCall(MatCreateSubMatrices(uaux, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2460f1580f4eSBarry Smith         PetscCall(MatDestroy(&uaux));
2461f1580f4eSBarry Smith         PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2462f1580f4eSBarry Smith       }
246351ea4bc8SPierre Jolivet       if (data->N > 1) {
2464f1580f4eSBarry Smith         /* Vec holding the partition of unity */
2465f1580f4eSBarry Smith         if (!data->levels[0]->D) {
2466f1580f4eSBarry Smith           PetscCall(ISGetLocalSize(data->is, &n));
2467f1580f4eSBarry Smith           PetscCall(VecCreateMPI(PETSC_COMM_SELF, n, PETSC_DETERMINE, &data->levels[0]->D));
2468f1580f4eSBarry Smith         }
24699bb5c669SPierre Jolivet         if (data->share && overlap == -1) {
2470f1580f4eSBarry Smith           Mat      D;
2471db4a47b3SPierre Jolivet           IS       perm = nullptr;
2472f1580f4eSBarry Smith           PetscInt size = -1;
2473811e8887SPierre Jolivet 
2474398c7888SPierre Jolivet           if (!data->levels[0]->pc) {
2475398c7888SPierre Jolivet             PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2476398c7888SPierre Jolivet             PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
2477398c7888SPierre Jolivet             PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
2478398c7888SPierre Jolivet             PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
2479398c7888SPierre Jolivet           }
2480398c7888SPierre Jolivet           PetscCall(PCSetType(data->levels[0]->pc, PCASM));
248113044ca3SPierre Jolivet           if (!ctx) {
2482398c7888SPierre Jolivet             if (!data->levels[0]->pc->setupcalled) {
2483398c7888SPierre Jolivet               IS sorted; /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2484398c7888SPierre Jolivet               PetscCall(ISDuplicate(is[0], &sorted));
2485398c7888SPierre Jolivet               PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &sorted, &loc));
2486398c7888SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)sorted));
2487398c7888SPierre Jolivet             }
2488398c7888SPierre Jolivet             PetscCall(PCSetFromOptions(data->levels[0]->pc));
2489398c7888SPierre Jolivet             if (block) {
2490398c7888SPierre Jolivet               PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, sub[0], &C, &perm));
2491398c7888SPierre Jolivet               PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, C, algebraic));
2492398c7888SPierre Jolivet             } else PetscCall(PCSetUp(data->levels[0]->pc));
2493db4a47b3SPierre Jolivet             PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &size, nullptr, &ksp));
2494398c7888SPierre Jolivet             if (size != 1) {
2495398c7888SPierre Jolivet               data->share = PETSC_FALSE;
2496398c7888SPierre Jolivet               PetscCheck(size == -1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", size);
2497398c7888SPierre Jolivet               PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since PCASMGetSubKSP() not found in fine-level PC\n"));
2498398c7888SPierre Jolivet               PetscCall(ISDestroy(&unsorted));
2499398c7888SPierre Jolivet               unsorted = is[0];
2500398c7888SPierre Jolivet             } else {
2501811e8887SPierre Jolivet               const char *matpre;
2502811e8887SPierre Jolivet               PetscBool   cmp[4];
2503811e8887SPierre Jolivet 
250413044ca3SPierre Jolivet               if (!block && !ctx) PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, PetscBool3ToBool(data->Neumann) ? sub[0] : data->aux, &C, &perm));
250551ea4bc8SPierre Jolivet               if (perm) { /* unsorted input IS */
2506c8ea6600SPierre Jolivet                 if (!PetscBool3ToBool(data->Neumann) && !block) {
2507f1580f4eSBarry Smith                   PetscCall(MatPermute(sub[0], perm, perm, &D)); /* permute since PCASM will call ISSort() */
2508f1580f4eSBarry Smith                   PetscCall(MatHeaderReplace(sub[0], &D));
2509f1580f4eSBarry Smith                 }
2510f1580f4eSBarry Smith                 if (data->B) { /* see PCHPDDMSetRHSMat() */
2511f1580f4eSBarry Smith                   PetscCall(MatPermute(data->B, perm, perm, &D));
2512f1580f4eSBarry Smith                   PetscCall(MatHeaderReplace(data->B, &D));
2513f1580f4eSBarry Smith                 }
2514f1580f4eSBarry Smith                 PetscCall(ISDestroy(&perm));
251551ea4bc8SPierre Jolivet               }
2516f1580f4eSBarry Smith               PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
25170307214fSPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)subA[0]));
2518f1580f4eSBarry Smith               PetscCall(MatDuplicate(subA[1], MAT_SHARE_NONZERO_PATTERN, &D));
2519f1580f4eSBarry Smith               PetscCall(MatGetOptionsPrefix(subA[1], &matpre));
2520f1580f4eSBarry Smith               PetscCall(MatSetOptionsPrefix(D, matpre));
2521f1580f4eSBarry Smith               PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMAL, cmp));
2522f1580f4eSBarry Smith               PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMAL, cmp + 1));
2523f1580f4eSBarry Smith               if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMALHERMITIAN, cmp + 2));
2524f1580f4eSBarry Smith               else cmp[2] = PETSC_FALSE;
2525f1580f4eSBarry Smith               if (!cmp[1]) PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMALHERMITIAN, cmp + 3));
2526f1580f4eSBarry Smith               else cmp[3] = PETSC_FALSE;
2527f1580f4eSBarry 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);
2528f1580f4eSBarry Smith               if (!cmp[0] && !cmp[2]) {
2529f1580f4eSBarry Smith                 if (!block) PetscCall(MatAXPY(D, 1.0, C, SUBSET_NONZERO_PATTERN));
25305c7345deSPierre Jolivet                 else {
2531db4a47b3SPierre Jolivet                   PetscCall(MatMissingDiagonal(D, cmp, nullptr));
25325c7345deSPierre Jolivet                   if (cmp[0]) structure = DIFFERENT_NONZERO_PATTERN; /* data->aux has no missing diagonal entry */
25335c7345deSPierre Jolivet                   PetscCall(MatAXPY(D, 1.0, data->aux, structure));
25345c7345deSPierre Jolivet                 }
2535f1580f4eSBarry Smith               } else {
2536f1580f4eSBarry Smith                 Mat mat[2];
2537811e8887SPierre Jolivet 
2538f1580f4eSBarry Smith                 if (cmp[0]) {
2539f1580f4eSBarry Smith                   PetscCall(MatNormalGetMat(D, mat));
2540f1580f4eSBarry Smith                   PetscCall(MatNormalGetMat(C, mat + 1));
2541f1580f4eSBarry Smith                 } else {
2542f1580f4eSBarry Smith                   PetscCall(MatNormalHermitianGetMat(D, mat));
2543f1580f4eSBarry Smith                   PetscCall(MatNormalHermitianGetMat(C, mat + 1));
2544f1580f4eSBarry Smith                 }
2545f1580f4eSBarry Smith                 PetscCall(MatAXPY(mat[0], 1.0, mat[1], SUBSET_NONZERO_PATTERN));
2546f1580f4eSBarry Smith               }
2547f1580f4eSBarry Smith               PetscCall(MatPropagateSymmetryOptions(C, D));
2548f1580f4eSBarry Smith               PetscCall(MatDestroy(&C));
2549f1580f4eSBarry Smith               C = D;
2550f1580f4eSBarry Smith               /* swap pointers so that variables stay consistent throughout PCSetUp() */
2551f1580f4eSBarry Smith               std::swap(C, data->aux);
2552f1580f4eSBarry Smith               std::swap(uis, data->is);
2553f1580f4eSBarry Smith               swap = PETSC_TRUE;
2554f1580f4eSBarry Smith             }
2555f1580f4eSBarry Smith           }
255613044ca3SPierre Jolivet         }
255751ea4bc8SPierre Jolivet       }
255813044ca3SPierre Jolivet       if (ctx) {
255913044ca3SPierre Jolivet         PC_HPDDM              *data_00 = (PC_HPDDM *)std::get<0>(*ctx)[0]->data;
256013044ca3SPierre Jolivet         PC                     s;
256100b491fbSPierre Jolivet         Mat                    A00, P00, A01 = nullptr, A10, A11, N, b[4];
256207d8d47fSPierre Jolivet         IS                     sorted, is[2], *is_00;
256313044ca3SPierre Jolivet         MatSolverType          type;
256413044ca3SPierre Jolivet         std::pair<PC, Vec[2]> *p;
256513044ca3SPierre Jolivet 
256607d8d47fSPierre Jolivet         n = -1;
256707d8d47fSPierre Jolivet         PetscTryMethod(data_00->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data_00->levels[0]->pc, &n, nullptr, &ksp));
256807d8d47fSPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
256907d8d47fSPierre Jolivet         PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
257007d8d47fSPierre Jolivet         PetscCall(ISGetLocalSize(data_00->is, &n));
257107d8d47fSPierre Jolivet         if (n != subA[0]->rmap->n || n != subA[0]->cmap->n) {
257207d8d47fSPierre Jolivet           PetscCall(PCASMGetLocalSubdomains(data_00->levels[0]->pc, &n, &is_00, nullptr));
257307d8d47fSPierre Jolivet           PetscCall(ISGetLocalSize(*is_00, &n));
257407d8d47fSPierre 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);
257507d8d47fSPierre Jolivet         } else is_00 = &data_00->is;
257613044ca3SPierre Jolivet         PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, data->aux, &C, nullptr)); /* permute since PCASM works with a sorted IS */
257713044ca3SPierre Jolivet         std::swap(C, data->aux);
257813044ca3SPierre Jolivet         std::swap(uis, data->is);
257913044ca3SPierre Jolivet         swap = PETSC_TRUE;
258013044ca3SPierre Jolivet         PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, std::get<1>(*ctx), &A10, &A11));
258113044ca3SPierre Jolivet         std::get<1>(*ctx)[1] = A10;
258213044ca3SPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
258313044ca3SPierre Jolivet         if (flg) PetscCall(MatTransposeGetMat(A10, &A01));
258413044ca3SPierre Jolivet         else {
258513044ca3SPierre Jolivet           PetscBool flg;
258613044ca3SPierre Jolivet 
258713044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
258813044ca3SPierre Jolivet           if (flg) PetscCall(MatHermitianTransposeGetMat(A10, &A01));
258913044ca3SPierre Jolivet         }
259007d8d47fSPierre 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 */
259113044ca3SPierre Jolivet         PetscCall(ISSort(sorted));               /* this is to avoid changing users inputs, but it requires a new call to ISSort() here                                                                                               */
259200b491fbSPierre Jolivet         if (!A01) {
259300b491fbSPierre Jolivet           PetscCall(MatSetOption(A10, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
259400b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A10, 1, &data->is, &sorted, MAT_INITIAL_MATRIX, &sub));
259500b491fbSPierre Jolivet           b[2] = sub[0];
259600b491fbSPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
259700b491fbSPierre Jolivet           PetscCall(MatDestroySubMatrices(1, &sub));
259800b491fbSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATTRANSPOSEVIRTUAL, &flg));
259900b491fbSPierre Jolivet           A10 = nullptr;
260000b491fbSPierre Jolivet           if (flg) PetscCall(MatTransposeGetMat(std::get<1>(*ctx)[0], &A10));
260113044ca3SPierre Jolivet           else {
260200b491fbSPierre Jolivet             PetscBool flg;
260300b491fbSPierre Jolivet 
2604c71f06a7SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATHERMITIANTRANSPOSEVIRTUAL, &flg));
260500b491fbSPierre Jolivet             if (flg) PetscCall(MatHermitianTransposeGetMat(std::get<1>(*ctx)[0], &A10));
260613044ca3SPierre Jolivet           }
2607811e8887SPierre Jolivet           if (!A10) PetscCall(MatCreateSubMatrices(std::get<1>(*ctx)[0], 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2608811e8887SPierre Jolivet           else {
2609811e8887SPierre Jolivet             if (flg) PetscCall(MatCreateTranspose(b[2], b + 1));
2610811e8887SPierre Jolivet             else PetscCall(MatCreateHermitianTranspose(b[2], b + 1));
261100b491fbSPierre Jolivet           }
261200b491fbSPierre Jolivet         } else {
261300b491fbSPierre Jolivet           PetscCall(MatSetOption(A01, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
261400b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A01, 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2615811e8887SPierre Jolivet           if (flg) PetscCall(MatCreateTranspose(*sub, b + 2));
2616811e8887SPierre Jolivet           else PetscCall(MatCreateHermitianTranspose(*sub, b + 2));
2617811e8887SPierre Jolivet         }
2618811e8887SPierre Jolivet         if (A01 || !A10) {
2619811e8887SPierre Jolivet           b[1] = sub[0];
2620811e8887SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
262100b491fbSPierre Jolivet         }
262200b491fbSPierre Jolivet         PetscCall(MatDestroySubMatrices(1, &sub));
262313044ca3SPierre Jolivet         PetscCall(ISDestroy(&sorted));
262451ea4bc8SPierre Jolivet         b[3] = data->aux;
262551ea4bc8SPierre Jolivet         PetscCall(MatCreateSchurComplement(subA[0], subA[1], b[1], b[2], b[3], &S));
262613044ca3SPierre Jolivet         PetscCall(MatSchurComplementSetKSP(S, ksp[0]));
262751ea4bc8SPierre Jolivet         if (data->N != 1) {
262851ea4bc8SPierre Jolivet           PetscCall(PCASMSetType(data->levels[0]->pc, PC_ASM_NONE)); /* "Neumann--Neumann" preconditioning with overlap and a Boolean partition of unity */
262951ea4bc8SPierre Jolivet           PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &data->is, &loc));
263051ea4bc8SPierre Jolivet           PetscCall(PCSetFromOptions(data->levels[0]->pc)); /* action of eq. (15) of https://hal.science/hal-02343808v6/document (with a sign flip) */
263151ea4bc8SPierre Jolivet           s = data->levels[0]->pc;
263251ea4bc8SPierre Jolivet         } else {
263351ea4bc8SPierre Jolivet           is[0] = data->is;
263451ea4bc8SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)is[0]));
263551ea4bc8SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)b[3]));
263651ea4bc8SPierre Jolivet           PetscCall(PCSetType(pc, PCASM));                          /* change the type of the current PC */
263751ea4bc8SPierre Jolivet           data = nullptr;                                           /* destroyed in the previous PCSetType(), so reset to NULL to avoid any faulty use */
263851ea4bc8SPierre Jolivet           PetscCall(PCAppendOptionsPrefix(pc, "pc_hpddm_coarse_")); /* same prefix as when using PCHPDDM with a single level */
263951ea4bc8SPierre Jolivet           PetscCall(PCASMSetLocalSubdomains(pc, 1, is, &loc));
264051ea4bc8SPierre Jolivet           PetscCall(ISDestroy(is));
264151ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&loc));
264251ea4bc8SPierre Jolivet           s = pc;
264351ea4bc8SPierre Jolivet         }
264451ea4bc8SPierre Jolivet         PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(s, S, PETSC_TRUE)); /* the subdomain Mat is already known and the input IS of PCASMSetLocalSubdomains() is already sorted */
264551ea4bc8SPierre Jolivet         PetscTryMethod(s, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (s, &n, nullptr, &ksp));
264613044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
264713044ca3SPierre Jolivet         PetscCall(KSPGetPC(ksp[0], &inner));
264813044ca3SPierre Jolivet         PetscCall(PCSetType(inner, PCSHELL)); /* compute the action of the inverse of the local Schur complement with a PCSHELL */
264913044ca3SPierre Jolivet         b[0] = subA[0];
265013044ca3SPierre 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 */
265151ea4bc8SPierre Jolivet         if (!data) PetscCall(PetscObjectDereference((PetscObject)b[3]));
265200b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[1]));
265300b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[2]));
265413044ca3SPierre Jolivet         PetscCall(PCCreate(PETSC_COMM_SELF, &s));
265513044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(s, ((PetscObject)inner)->prefix));
265613044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(inner, nullptr));
265713044ca3SPierre Jolivet         PetscCall(KSPSetSkipPCSetFromOptions(ksp[0], PETSC_TRUE));
265813044ca3SPierre Jolivet         PetscCall(PCSetType(s, PCLU));
265951ea4bc8SPierre 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 */
266013044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(s));
266113044ca3SPierre Jolivet         PetscCall(PCFactorGetMatSolverType(s, &type));
266213044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
266351ea4bc8SPierre Jolivet         PetscCall(MatGetLocalSize(A11, &n, nullptr));
266451ea4bc8SPierre Jolivet         if (flg || n == 0) {
266513044ca3SPierre Jolivet           PetscCall(PCSetOperators(s, N, N));
266651ea4bc8SPierre Jolivet           if (n) {
266700b491fbSPierre Jolivet             PetscCall(PCFactorGetMatrix(s, b));
266800b491fbSPierre Jolivet             PetscCall(MatSetOptionsPrefix(*b, ((PetscObject)s)->prefix));
266924ddd604SPierre Jolivet             n = -1;
267024ddd604SPierre Jolivet             PetscCall(PetscOptionsGetInt(nullptr, ((PetscObject)s)->prefix, "-mat_mumps_icntl_26", &n, nullptr));
2671f45b553cSPierre Jolivet             if (n == 1) {                                /* allocates a square MatDense of size is[1]->map->n, so one */
2672f45b553cSPierre Jolivet               PetscCall(MatNestGetISs(N, is, nullptr));  /*  needs to be able to deactivate this path when dealing    */
2673f45b553cSPierre Jolivet               PetscCall(MatFactorSetSchurIS(*b, is[1])); /*  with a large constraint space in order to avoid OOM      */
2674f45b553cSPierre Jolivet             }
267551ea4bc8SPierre Jolivet           } else PetscCall(PCSetType(s, PCNONE)); /* empty local Schur complement (e.g., centralized on another process) */
267613044ca3SPierre Jolivet         } else {
267700b491fbSPierre Jolivet           PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, b));
267800b491fbSPierre Jolivet           PetscCall(PCSetOperators(s, N, *b));
267900b491fbSPierre Jolivet           PetscCall(PetscObjectDereference((PetscObject)*b));
268051ea4bc8SPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)s, &flg, PCLU, PCCHOLESKY, PCILU, PCICC, PCQR, ""));
268151ea4bc8SPierre 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 */
268213044ca3SPierre Jolivet         }
268313044ca3SPierre Jolivet         PetscCall(PetscNew(&p));
268413044ca3SPierre Jolivet         p->first = s;
268551ea4bc8SPierre Jolivet         if (n != 0) PetscCall(MatCreateVecs(*b, p->second, p->second + 1));
268651ea4bc8SPierre Jolivet         else p->second[0] = p->second[1] = nullptr;
268713044ca3SPierre Jolivet         PetscCall(PCShellSetContext(inner, p));
268813044ca3SPierre Jolivet         PetscCall(PCShellSetApply(inner, PCApply_Nest));
268913044ca3SPierre Jolivet         PetscCall(PCShellSetView(inner, PCView_Nest));
269013044ca3SPierre Jolivet         PetscCall(PCShellSetDestroy(inner, PCDestroy_Nest));
269113044ca3SPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)N));
269251ea4bc8SPierre Jolivet         if (!data) {
269351ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&S));
269451ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&unsorted));
269551ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&C));
269651ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&uis));
269751ea4bc8SPierre Jolivet           PetscCall(PetscFree(ctx));
269851ea4bc8SPierre Jolivet #if PetscDefined(USE_DEBUG)
269951ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&dis));
270051ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&daux));
270151ea4bc8SPierre Jolivet #endif
270251ea4bc8SPierre Jolivet           PetscFunctionReturn(PETSC_SUCCESS);
270351ea4bc8SPierre Jolivet         }
270413044ca3SPierre Jolivet       }
2705f1580f4eSBarry Smith       if (!data->levels[0]->scatter) {
2706db4a47b3SPierre Jolivet         PetscCall(MatCreateVecs(P, &xin, nullptr));
2707f1580f4eSBarry Smith         if (ismatis) PetscCall(MatDestroy(&P));
2708db4a47b3SPierre Jolivet         PetscCall(VecScatterCreate(xin, data->is, data->levels[0]->D, nullptr, &data->levels[0]->scatter));
2709f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
2710f1580f4eSBarry Smith       }
2711f1580f4eSBarry Smith       if (data->levels[0]->P) {
2712f1580f4eSBarry Smith         /* if the pattern is the same and PCSetUp() has previously succeeded, reuse HPDDM buffers and connectivity */
2713371d2eb7SMartin Diehl         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[0], !pc->setupcalled || pc->flag == DIFFERENT_NONZERO_PATTERN ? PETSC_TRUE : PETSC_FALSE));
2714f1580f4eSBarry Smith       }
2715f1580f4eSBarry Smith       if (!data->levels[0]->P) data->levels[0]->P = new HPDDM::Schwarz<PetscScalar>();
2716db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2717db4a47b3SPierre Jolivet       else PetscCall(PetscLogEventBegin(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2718f1580f4eSBarry Smith       /* HPDDM internal data structure */
271913044ca3SPierre Jolivet       PetscCall(data->levels[0]->P->structure(loc, data->is, !ctx ? sub[0] : nullptr, ismatis ? C : data->aux, data->levels));
2720db4a47b3SPierre Jolivet       if (!data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2721f1580f4eSBarry Smith       /* matrix pencil of the generalized eigenvalue problem on the overlap (GenEO) */
272213044ca3SPierre Jolivet       if (!ctx) {
27239bb5c669SPierre Jolivet         if (data->deflation || overlap != -1) weighted = data->aux;
2724f1580f4eSBarry Smith         else if (!data->B) {
2725e2b46ddfSPierre Jolivet           PetscBool cmp;
2726811e8887SPierre Jolivet 
2727f1580f4eSBarry Smith           PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &weighted));
2728e2b46ddfSPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)weighted, &cmp, MATNORMAL, MATNORMALHERMITIAN, ""));
2729e2b46ddfSPierre Jolivet           if (cmp) flg = PETSC_FALSE;
2730e2b46ddfSPierre Jolivet           PetscCall(MatDiagonalScale(weighted, data->levels[0]->D, data->levels[0]->D));
27315b0bb9f2SPierre Jolivet           /* neither MatDuplicate() nor MatDiagonalScale() handles the symmetry options, so propagate the options explicitly */
2732f1580f4eSBarry Smith           /* only useful for -mat_type baij -pc_hpddm_levels_1_st_pc_type cholesky (no problem with MATAIJ or MATSBAIJ)      */
2733f1580f4eSBarry Smith           PetscCall(MatPropagateSymmetryOptions(sub[0], weighted));
27346d61d5b2SPierre Jolivet           if (PetscDefined(USE_DEBUG) && PetscBool3ToBool(data->Neumann)) {
27356d61d5b2SPierre Jolivet             Mat      *sub, A[3];
27366d61d5b2SPierre Jolivet             PetscReal norm[2];
27376d61d5b2SPierre Jolivet             PetscBool flg;
27386d61d5b2SPierre Jolivet 
27396d61d5b2SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg)); /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIAIJ */
27406d61d5b2SPierre Jolivet             if (flg) PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, A));
27416d61d5b2SPierre Jolivet             else {
27426d61d5b2SPierre Jolivet               A[0] = P;
27436d61d5b2SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)P));
27446d61d5b2SPierre Jolivet             }
27456d61d5b2SPierre Jolivet             PetscCall(MatCreateSubMatrices(A[0], 1, &data->is, &data->is, MAT_INITIAL_MATRIX, &sub));
27466d61d5b2SPierre Jolivet             PetscCall(MatDiagonalScale(sub[0], data->levels[0]->D, data->levels[0]->D));
27476d61d5b2SPierre Jolivet             PetscCall(MatConvert(sub[0], MATSEQAIJ, MAT_INITIAL_MATRIX, A + 1)); /* too many corner cases to handle (MATNORMAL, MATNORMALHERMITIAN, MATBAIJ with different block sizes...), so just MatConvert() to MATSEQAIJ since this is just for debugging */
27486d61d5b2SPierre Jolivet             PetscCall(MatConvert(weighted, MATSEQAIJ, MAT_INITIAL_MATRIX, A + 2));
27496d61d5b2SPierre Jolivet             PetscCall(MatAXPY(A[1], -1.0, A[2], UNKNOWN_NONZERO_PATTERN));
27506d61d5b2SPierre Jolivet             PetscCall(MatNorm(A[1], NORM_FROBENIUS, norm));
27516d61d5b2SPierre Jolivet             if (norm[0]) {
27526d61d5b2SPierre Jolivet               PetscCall(MatNorm(A[2], NORM_FROBENIUS, norm + 1));
27536d61d5b2SPierre Jolivet               PetscCheck(PetscAbsReal(norm[0] / norm[1]) < PetscSqrtReal(PETSC_SMALL), PETSC_COMM_SELF, PETSC_ERR_USER_INPUT, "Auxiliary Mat is different from the (assembled) subdomain Mat for the interior unknowns, so it cannot be the Neumann matrix, remove -%spc_hpddm_has_neumann", pcpre ? pcpre : "");
27546d61d5b2SPierre Jolivet             }
27556d61d5b2SPierre Jolivet             PetscCall(MatDestroySubMatrices(1, &sub));
27566d61d5b2SPierre Jolivet             for (PetscInt i = 0; i < 3; ++i) PetscCall(MatDestroy(A + i));
27576d61d5b2SPierre Jolivet           }
2758f1580f4eSBarry Smith         } else weighted = data->B;
275913044ca3SPierre Jolivet       } else weighted = nullptr;
2760f1580f4eSBarry Smith       /* SLEPc is used inside the loaded symbol */
27619bb5c669SPierre 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));
27629bb5c669SPierre Jolivet       if (!ctx && data->share && overlap == -1) {
2763f1580f4eSBarry Smith         Mat st[2];
27646d61d5b2SPierre Jolivet 
2765f1580f4eSBarry Smith         PetscCall(KSPGetOperators(ksp[0], st, st + 1));
27665c7345deSPierre Jolivet         PetscCall(MatCopy(subA[0], st[0], structure));
2767f1580f4eSBarry Smith         if (subA[1] != subA[0] || st[1] != st[0]) PetscCall(MatCopy(subA[1], st[1], SAME_NONZERO_PATTERN));
27680307214fSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)subA[0]));
2769f1580f4eSBarry Smith       }
2770db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2771f1580f4eSBarry Smith       if (ismatis) PetscCall(MatISGetLocalMat(C, &N));
2772f1580f4eSBarry Smith       else N = data->aux;
277313044ca3SPierre Jolivet       if (!ctx) P = sub[0];
277413044ca3SPierre Jolivet       else P = S;
2775f1580f4eSBarry Smith       /* going through the grid hierarchy */
2776f1580f4eSBarry Smith       for (n = 1; n < data->N; ++n) {
2777db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2778f1580f4eSBarry Smith         /* method composed in the loaded symbol since there, SLEPc is used as well */
2779f1580f4eSBarry 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));
2780db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2781f1580f4eSBarry Smith       }
2782f1580f4eSBarry Smith       /* reset to NULL to avoid any faulty use */
2783db4a47b3SPierre Jolivet       PetscCall(PetscObjectComposeFunction((PetscObject)data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", nullptr));
2784db4a47b3SPierre Jolivet       if (!ismatis) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_C", nullptr));
2785f1580f4eSBarry Smith       else PetscCall(PetscObjectDereference((PetscObject)C)); /* matching PetscObjectReference() above */
2786f1580f4eSBarry Smith       for (n = 0; n < data->N - 1; ++n)
2787f1580f4eSBarry Smith         if (data->levels[n]->P) {
2788f1580f4eSBarry Smith           /* HPDDM internal work buffers */
2789f1580f4eSBarry Smith           data->levels[n]->P->setBuffer();
2790f1580f4eSBarry Smith           data->levels[n]->P->super::start();
2791f1580f4eSBarry Smith         }
27929bb5c669SPierre Jolivet       if (ismatis || !subdomains) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
2793db4a47b3SPierre Jolivet       if (ismatis) data->is = nullptr;
2794f1580f4eSBarry Smith       for (n = 0; n < data->N - 1 + (reused > 0); ++n) {
2795f1580f4eSBarry Smith         if (data->levels[n]->P) {
2796f1580f4eSBarry Smith           PC spc;
2797f1580f4eSBarry Smith 
2798f1580f4eSBarry Smith           /* force the PC to be PCSHELL to do the coarse grid corrections */
2799f1580f4eSBarry Smith           PetscCall(KSPSetSkipPCSetFromOptions(data->levels[n]->ksp, PETSC_TRUE));
2800f1580f4eSBarry Smith           PetscCall(KSPGetPC(data->levels[n]->ksp, &spc));
2801f1580f4eSBarry Smith           PetscCall(PCSetType(spc, PCSHELL));
2802f1580f4eSBarry Smith           PetscCall(PCShellSetContext(spc, data->levels[n]));
2803f1580f4eSBarry Smith           PetscCall(PCShellSetSetUp(spc, PCSetUp_HPDDMShell));
2804f1580f4eSBarry Smith           PetscCall(PCShellSetApply(spc, PCApply_HPDDMShell));
2805f1580f4eSBarry Smith           PetscCall(PCShellSetMatApply(spc, PCMatApply_HPDDMShell));
2806d4f06b61SRaphael Zanella           PetscCall(PCShellSetApplyTranspose(spc, PCApplyTranspose_HPDDMShell));
28078cb7430dSRaphael Zanella           PetscCall(PCShellSetMatApplyTranspose(spc, PCMatApplyTranspose_HPDDMShell));
280813044ca3SPierre Jolivet           if (ctx && n == 0) {
280913044ca3SPierre Jolivet             Mat                               Amat, Pmat;
281013044ca3SPierre Jolivet             PetscInt                          m, M;
281101e3c840SPierre Jolivet             std::tuple<Mat, PetscSF, Vec[2]> *ctx;
281213044ca3SPierre Jolivet 
281313044ca3SPierre Jolivet             PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &Pmat));
281413044ca3SPierre Jolivet             PetscCall(MatGetLocalSize(Pmat, &m, nullptr));
281513044ca3SPierre Jolivet             PetscCall(MatGetSize(Pmat, &M, nullptr));
281613044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));
281713044ca3SPierre Jolivet             std::get<0>(*ctx) = S;
281813044ca3SPierre Jolivet             std::get<1>(*ctx) = data->levels[n]->scatter;
281913044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)data->levels[n]->ksp), m, m, M, M, ctx, &Amat));
282057d50842SBarry Smith             PetscCall(MatShellSetOperation(Amat, MATOP_MULT, (PetscErrorCodeFn *)MatMult_Schur<false>));
282157d50842SBarry Smith             PetscCall(MatShellSetOperation(Amat, MATOP_MULT_TRANSPOSE, (PetscErrorCodeFn *)MatMult_Schur<true>));
282257d50842SBarry Smith             PetscCall(MatShellSetOperation(Amat, MATOP_DESTROY, (PetscErrorCodeFn *)MatDestroy_Schur));
282313044ca3SPierre Jolivet             PetscCall(MatCreateVecs(S, std::get<2>(*ctx), std::get<2>(*ctx) + 1));
282413044ca3SPierre Jolivet             PetscCall(KSPSetOperators(data->levels[n]->ksp, Amat, Pmat));
282513044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)Amat));
282613044ca3SPierre Jolivet           }
2827f1580f4eSBarry Smith           PetscCall(PCShellSetDestroy(spc, PCDestroy_HPDDMShell));
2828f1580f4eSBarry Smith           if (!data->levels[n]->pc) PetscCall(PCCreate(PetscObjectComm((PetscObject)data->levels[n]->ksp), &data->levels[n]->pc));
2829f1580f4eSBarry Smith           if (n < reused) {
2830f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(spc, PETSC_TRUE));
2831f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
2832f1580f4eSBarry Smith           }
2833f1580f4eSBarry Smith           PetscCall(PCSetUp(spc));
2834f1580f4eSBarry Smith         }
2835f1580f4eSBarry Smith       }
283613044ca3SPierre Jolivet       if (ctx) PetscCall(MatDestroy(&S));
28379bb5c669SPierre Jolivet       if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", nullptr));
2838f1580f4eSBarry Smith     } else flg = reused ? PETSC_FALSE : PETSC_TRUE;
2839f1580f4eSBarry Smith     if (!ismatis && subdomains) {
2840f1580f4eSBarry Smith       if (flg) PetscCall(KSPGetPC(data->levels[0]->ksp, &inner));
2841f1580f4eSBarry Smith       else inner = data->levels[0]->pc;
2842f1580f4eSBarry Smith       if (inner) {
2843398c7888SPierre Jolivet         if (!inner->setupcalled) PetscCall(PCSetType(inner, PCASM));
2844398c7888SPierre Jolivet         PetscCall(PCSetFromOptions(inner));
2845398c7888SPierre Jolivet         PetscCall(PetscStrcmp(((PetscObject)inner)->type_name, PCASM, &flg));
2846398c7888SPierre Jolivet         if (flg) {
2847f1580f4eSBarry Smith           if (!inner->setupcalled) { /* evaluates to PETSC_FALSE when -pc_hpddm_block_splitting */
2848398c7888SPierre Jolivet             IS sorted;               /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2849811e8887SPierre Jolivet 
2850398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2851398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(inner, 1, &sorted, &loc));
2852398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2853398c7888SPierre Jolivet           }
2854c8ea6600SPierre Jolivet           if (!PetscBool3ToBool(data->Neumann) && data->N > 1) { /* subdomain matrices are already created for the eigenproblem, reuse them for the fine-level PC */
2855db4a47b3SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(*is, nullptr, nullptr, sub[0], &P, nullptr));
2856398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(inner, P, algebraic));
2857398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)P));
2858f1580f4eSBarry Smith           }
2859f1580f4eSBarry Smith         }
2860f1580f4eSBarry Smith       }
28619bb5c669SPierre Jolivet       if (data->N > 1) {
28629bb5c669SPierre Jolivet         if (overlap != 1) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
28639bb5c669SPierre Jolivet         if (overlap == 1) PetscCall(MatDestroy(subA));
28649bb5c669SPierre Jolivet       }
2865f1580f4eSBarry Smith     }
2866f1580f4eSBarry Smith     PetscCall(ISDestroy(&loc));
2867f1580f4eSBarry Smith   } else data->N = 1 + reused; /* enforce this value to 1 + reused if there is no way to build another level */
2868f1580f4eSBarry Smith   if (requested != data->N + reused) {
2869f1580f4eSBarry 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,
2870f1580f4eSBarry Smith                         data->N, pcpre ? pcpre : ""));
2871b5a302b3SPierre 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 : "",
2872b5a302b3SPierre Jolivet                         data->N, pcpre ? pcpre : "", data->N));
2873f1580f4eSBarry Smith     /* cannot use PCDestroy_HPDDMShell() because PCSHELL not set for unassembled levels */
2874f1580f4eSBarry Smith     for (n = data->N - 1; n < requested - 1; ++n) {
2875f1580f4eSBarry Smith       if (data->levels[n]->P) {
2876f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[n], PETSC_TRUE));
2877f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(1, &data->levels[n]->v[0]));
2878f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(2, &data->levels[n]->v[1]));
2879f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V));
2880f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 1));
2881f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 2));
2882f1580f4eSBarry Smith         PetscCall(VecDestroy(&data->levels[n]->D));
288301e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&data->levels[n]->scatter));
2884f1580f4eSBarry Smith       }
2885f1580f4eSBarry Smith     }
2886f1580f4eSBarry Smith     if (reused) {
2887f1580f4eSBarry Smith       for (n = reused; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
2888f1580f4eSBarry Smith         PetscCall(KSPDestroy(&data->levels[n]->ksp));
2889f1580f4eSBarry Smith         PetscCall(PCDestroy(&data->levels[n]->pc));
2890f1580f4eSBarry Smith       }
2891f1580f4eSBarry Smith     }
2892b5a302b3SPierre 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,
2893b5a302b3SPierre Jolivet                data->N, reused, data->N, pcpre ? pcpre : "", pcpre ? pcpre : "", data->N, pcpre ? pcpre : "", data->N);
2894f1580f4eSBarry Smith   }
2895f1580f4eSBarry Smith   /* these solvers are created after PCSetFromOptions() is called */
2896f1580f4eSBarry Smith   if (pc->setfromoptionscalled) {
2897f1580f4eSBarry Smith     for (n = 0; n < data->N; ++n) {
2898f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetFromOptions(data->levels[n]->ksp));
2899f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetFromOptions(data->levels[n]->pc));
2900f1580f4eSBarry Smith     }
2901f1580f4eSBarry Smith     pc->setfromoptionscalled = 0;
2902f1580f4eSBarry Smith   }
2903f1580f4eSBarry Smith   data->N += reused;
2904f1580f4eSBarry Smith   if (data->share && swap) {
2905f1580f4eSBarry Smith     /* swap back pointers so that variables follow the user-provided numbering */
2906f1580f4eSBarry Smith     std::swap(C, data->aux);
2907f1580f4eSBarry Smith     std::swap(uis, data->is);
2908f1580f4eSBarry Smith     PetscCall(MatDestroy(&C));
2909f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
2910f1580f4eSBarry Smith   }
2911398c7888SPierre Jolivet   if (algebraic) PetscCall(MatDestroy(&data->aux));
291238fb34a1SPierre Jolivet   if (unsorted && unsorted != is[0]) {
2913398c7888SPierre Jolivet     PetscCall(ISCopy(unsorted, data->is));
2914398c7888SPierre Jolivet     PetscCall(ISDestroy(&unsorted));
2915398c7888SPierre Jolivet   }
2916398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2917398c7888SPierre 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);
2918398c7888SPierre Jolivet   if (data->is) {
2919398c7888SPierre Jolivet     PetscCall(ISEqualUnsorted(data->is, dis, &flg));
2920398c7888SPierre Jolivet     PetscCall(ISDestroy(&dis));
2921398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input IS and output IS are not equal");
2922398c7888SPierre Jolivet   }
2923398c7888SPierre 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);
2924398c7888SPierre Jolivet   if (data->aux) {
2925398c7888SPierre Jolivet     PetscCall(MatMultEqual(data->aux, daux, 20, &flg));
2926398c7888SPierre Jolivet     PetscCall(MatDestroy(&daux));
2927398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input Mat and output Mat are not equal");
2928398c7888SPierre Jolivet   }
2929398c7888SPierre Jolivet #endif
29303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2931f1580f4eSBarry Smith }
2932f1580f4eSBarry Smith 
2933f1580f4eSBarry Smith /*@
2934f1580f4eSBarry Smith   PCHPDDMSetCoarseCorrectionType - Sets the coarse correction type.
2935f1580f4eSBarry Smith 
2936c3339decSBarry Smith   Collective
2937f1580f4eSBarry Smith 
2938f1580f4eSBarry Smith   Input Parameters:
2939f1580f4eSBarry Smith + pc   - preconditioner context
2940aa1539e9SPierre Jolivet - type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2941f1580f4eSBarry Smith 
2942f1580f4eSBarry Smith   Options Database Key:
2943aa1539e9SPierre Jolivet . -pc_hpddm_coarse_correction <deflated, additive, balanced, none> - type of coarse correction to apply
2944f1580f4eSBarry Smith 
2945f1580f4eSBarry Smith   Level: intermediate
2946f1580f4eSBarry Smith 
2947562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2948f1580f4eSBarry Smith @*/
2949d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType type)
2950d71ae5a4SJacob Faibussowitsch {
2951f1580f4eSBarry Smith   PetscFunctionBegin;
2952f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2953f1580f4eSBarry Smith   PetscValidLogicalCollectiveEnum(pc, type, 2);
2954f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMSetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType), (pc, type));
29553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2956f1580f4eSBarry Smith }
2957f1580f4eSBarry Smith 
2958f1580f4eSBarry Smith /*@
2959f1580f4eSBarry Smith   PCHPDDMGetCoarseCorrectionType - Gets the coarse correction type.
2960f1580f4eSBarry Smith 
2961f1580f4eSBarry Smith   Input Parameter:
2962f1580f4eSBarry Smith . pc - preconditioner context
2963f1580f4eSBarry Smith 
2964f1580f4eSBarry Smith   Output Parameter:
2965aa1539e9SPierre Jolivet . type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2966f1580f4eSBarry Smith 
2967f1580f4eSBarry Smith   Level: intermediate
2968f1580f4eSBarry Smith 
2969562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2970f1580f4eSBarry Smith @*/
2971d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType *type)
2972d71ae5a4SJacob Faibussowitsch {
2973f1580f4eSBarry Smith   PetscFunctionBegin;
2974f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2975f1580f4eSBarry Smith   if (type) {
29764f572ea9SToby Isaac     PetscAssertPointer(type, 2);
2977f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType *), (pc, type));
2978f1580f4eSBarry Smith   }
29793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2980f1580f4eSBarry Smith }
2981f1580f4eSBarry Smith 
2982d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType type)
2983d71ae5a4SJacob Faibussowitsch {
2984f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2985f1580f4eSBarry Smith 
2986f1580f4eSBarry Smith   PetscFunctionBegin;
2987f1580f4eSBarry Smith   data->correction = type;
29883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2989f1580f4eSBarry Smith }
2990f1580f4eSBarry Smith 
2991d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType *type)
2992d71ae5a4SJacob Faibussowitsch {
2993f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2994f1580f4eSBarry Smith 
2995f1580f4eSBarry Smith   PetscFunctionBegin;
2996f1580f4eSBarry Smith   *type = data->correction;
29973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2998f1580f4eSBarry Smith }
2999f1580f4eSBarry Smith 
3000f1580f4eSBarry Smith /*@
3001e31fc274SPierre Jolivet   PCHPDDMSetSTShareSubKSP - Sets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver should be shared.
3002e31fc274SPierre Jolivet 
3003e31fc274SPierre Jolivet   Input Parameters:
3004e31fc274SPierre Jolivet + pc    - preconditioner context
3005e31fc274SPierre Jolivet - share - whether the `KSP` should be shared or not
3006e31fc274SPierre Jolivet 
3007e31fc274SPierre Jolivet   Note:
3008e31fc274SPierre Jolivet   This is not the same as `PCSetReusePreconditioner()`. Given certain conditions (visible using -info), a symbolic factorization can be skipped
3009e31fc274SPierre Jolivet   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
3010e31fc274SPierre Jolivet 
3011e31fc274SPierre Jolivet   Level: advanced
3012e31fc274SPierre Jolivet 
3013562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMGetSTShareSubKSP()`
3014e31fc274SPierre Jolivet @*/
3015e31fc274SPierre Jolivet PetscErrorCode PCHPDDMSetSTShareSubKSP(PC pc, PetscBool share)
3016e31fc274SPierre Jolivet {
3017e31fc274SPierre Jolivet   PetscFunctionBegin;
3018e31fc274SPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3019e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetSTShareSubKSP_C", (PC, PetscBool), (pc, share));
30203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3021e31fc274SPierre Jolivet }
3022e31fc274SPierre Jolivet 
3023e31fc274SPierre Jolivet /*@
3024f1580f4eSBarry Smith   PCHPDDMGetSTShareSubKSP - Gets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver is shared.
3025f1580f4eSBarry Smith 
3026f1580f4eSBarry Smith   Input Parameter:
3027f1580f4eSBarry Smith . pc - preconditioner context
3028f1580f4eSBarry Smith 
3029f1580f4eSBarry Smith   Output Parameter:
3030f1580f4eSBarry Smith . share - whether the `KSP` is shared or not
3031f1580f4eSBarry Smith 
3032f1580f4eSBarry Smith   Note:
3033f1580f4eSBarry 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
3034f1580f4eSBarry Smith   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
3035f1580f4eSBarry Smith 
3036f1580f4eSBarry Smith   Level: advanced
3037f1580f4eSBarry Smith 
3038562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetSTShareSubKSP()`
3039f1580f4eSBarry Smith @*/
3040d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetSTShareSubKSP(PC pc, PetscBool *share)
3041d71ae5a4SJacob Faibussowitsch {
3042f1580f4eSBarry Smith   PetscFunctionBegin;
3043f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3044f1580f4eSBarry Smith   if (share) {
30454f572ea9SToby Isaac     PetscAssertPointer(share, 2);
3046f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetSTShareSubKSP_C", (PC, PetscBool *), (pc, share));
3047f1580f4eSBarry Smith   }
30483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3049f1580f4eSBarry Smith }
3050f1580f4eSBarry Smith 
3051e31fc274SPierre Jolivet static PetscErrorCode PCHPDDMSetSTShareSubKSP_HPDDM(PC pc, PetscBool share)
3052e31fc274SPierre Jolivet {
3053e31fc274SPierre Jolivet   PC_HPDDM *data = (PC_HPDDM *)pc->data;
3054e31fc274SPierre Jolivet 
3055e31fc274SPierre Jolivet   PetscFunctionBegin;
3056e31fc274SPierre Jolivet   data->share = share;
30573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3058e31fc274SPierre Jolivet }
3059e31fc274SPierre Jolivet 
3060d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetSTShareSubKSP_HPDDM(PC pc, PetscBool *share)
3061d71ae5a4SJacob Faibussowitsch {
3062f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
3063f1580f4eSBarry Smith 
3064f1580f4eSBarry Smith   PetscFunctionBegin;
3065f1580f4eSBarry Smith   *share = data->share;
30663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3067f1580f4eSBarry Smith }
3068f1580f4eSBarry Smith 
3069f1580f4eSBarry Smith /*@
3070f1580f4eSBarry Smith   PCHPDDMSetDeflationMat - Sets the deflation space used to assemble a coarser operator.
3071f1580f4eSBarry Smith 
3072f1580f4eSBarry Smith   Input Parameters:
3073f1580f4eSBarry Smith + pc - preconditioner context
3074f1580f4eSBarry Smith . is - index set of the local deflation matrix
3075f1580f4eSBarry Smith - U  - deflation sequential matrix stored as a `MATSEQDENSE`
3076f1580f4eSBarry Smith 
3077f1580f4eSBarry Smith   Level: advanced
3078f1580f4eSBarry Smith 
3079562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCDeflationSetSpace()`, `PCMGSetRestriction()`
3080f1580f4eSBarry Smith @*/
3081d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetDeflationMat(PC pc, IS is, Mat U)
3082d71ae5a4SJacob Faibussowitsch {
3083f1580f4eSBarry Smith   PetscFunctionBegin;
3084f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3085f1580f4eSBarry Smith   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
3086f1580f4eSBarry Smith   PetscValidHeaderSpecific(U, MAT_CLASSID, 3);
3087e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetDeflationMat_C", (PC, IS, Mat), (pc, is, U));
30883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3089f1580f4eSBarry Smith }
3090f1580f4eSBarry Smith 
3091d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetDeflationMat_HPDDM(PC pc, IS is, Mat U)
3092d71ae5a4SJacob Faibussowitsch {
3093f1580f4eSBarry Smith   PetscFunctionBegin;
3094f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, U, PETSC_TRUE));
30953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3096f1580f4eSBarry Smith }
3097f1580f4eSBarry Smith 
3098d71ae5a4SJacob Faibussowitsch PetscErrorCode HPDDMLoadDL_Private(PetscBool *found)
3099d71ae5a4SJacob Faibussowitsch {
3100605ad303SPierre Jolivet   PetscBool flg;
3101f1580f4eSBarry Smith   char      lib[PETSC_MAX_PATH_LEN], dlib[PETSC_MAX_PATH_LEN], dir[PETSC_MAX_PATH_LEN];
3102f1580f4eSBarry Smith 
3103f1580f4eSBarry Smith   PetscFunctionBegin;
31044f572ea9SToby Isaac   PetscAssertPointer(found, 1);
3105c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(dir, "${PETSC_LIB_DIR}", sizeof(dir)));
3106db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, nullptr, "-hpddm_dir", dir, sizeof(dir), nullptr));
3107f1580f4eSBarry Smith   PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
3108f1580f4eSBarry Smith   PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3109605ad303SPierre Jolivet #if defined(SLEPC_LIB_DIR) /* this variable is passed during SLEPc ./configure when PETSc has not been configured   */
3110605ad303SPierre Jolivet   if (!*found) {           /* with --download-hpddm since slepcconf.h is not yet built (and thus can't be included) */
3111c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(dir, HPDDM_STR(SLEPC_LIB_DIR), sizeof(dir)));
3112f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
3113f1580f4eSBarry Smith     PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3114f1580f4eSBarry Smith   }
3115f1580f4eSBarry Smith #endif
3116605ad303SPierre 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 */
3117605ad303SPierre Jolivet     PetscCall(PetscOptionsGetenv(PETSC_COMM_SELF, "SLEPC_DIR", dir, sizeof(dir), &flg));
3118605ad303SPierre 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 */
3119605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libslepc", dir));
3120605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3121605ad303SPierre Jolivet       PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found but SLEPC_DIR=%s", lib, dir);
3122605ad303SPierre Jolivet       PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
3123605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libhpddm_petsc", dir)); /* libhpddm_petsc is always in the same directory as libslepc */
3124605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3125605ad303SPierre Jolivet     }
3126605ad303SPierre Jolivet   }
3127f1580f4eSBarry Smith   PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found", lib);
3128f1580f4eSBarry Smith   PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
31293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3130f1580f4eSBarry Smith }
3131f1580f4eSBarry Smith 
3132f1580f4eSBarry Smith /*MC
3133f1580f4eSBarry Smith    PCHPDDM - Interface with the HPDDM library.
3134f1580f4eSBarry Smith 
31351d27aa22SBarry Smith    This `PC` may be used to build multilevel spectral domain decomposition methods based on the GenEO framework {cite}`spillane2011robust` {cite}`al2021multilevel`.
31361d27aa22SBarry Smith    It may be viewed as an alternative to spectral
31371d27aa22SBarry Smith    AMGe or `PCBDDC` with adaptive selection of constraints. The interface is explained in details in {cite}`jolivetromanzampini2020`
3138f1580f4eSBarry Smith 
3139e7593814SPierre 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`).
3140f1580f4eSBarry Smith 
3141f1580f4eSBarry Smith    For multilevel preconditioning, when using an assembled or hierarchical Pmat, one must provide an auxiliary local `Mat` (unassembled local operator for GenEO) using
3142f1580f4eSBarry Smith    `PCHPDDMSetAuxiliaryMat()`. Calling this routine is not needed when using a `MATIS` Pmat, assembly is done internally using `MatConvert()`.
3143f1580f4eSBarry Smith 
3144f1580f4eSBarry Smith    Options Database Keys:
3145f1580f4eSBarry Smith +   -pc_hpddm_define_subdomains <true, default=false>    - on the finest level, calls `PCASMSetLocalSubdomains()` with the `IS` supplied in `PCHPDDMSetAuxiliaryMat()`
3146f1580f4eSBarry Smith                                                          (not relevant with an unassembled Pmat)
3147f1580f4eSBarry Smith .   -pc_hpddm_has_neumann <true, default=false>          - on the finest level, informs the `PC` that the local Neumann matrix is supplied in `PCHPDDMSetAuxiliaryMat()`
3148f1580f4eSBarry Smith -   -pc_hpddm_coarse_correction <type, default=deflated> - determines the `PCHPDDMCoarseCorrectionType` when calling `PCApply()`
3149f1580f4eSBarry Smith 
315038bf2a8cSPierre Jolivet    Options for subdomain solvers, subdomain eigensolvers (for computing deflation vectors), and the coarse solver can be set using the following options database prefixes.
3151f1580f4eSBarry Smith .vb
3152f1580f4eSBarry Smith       -pc_hpddm_levels_%d_pc_
3153f1580f4eSBarry Smith       -pc_hpddm_levels_%d_ksp_
3154f1580f4eSBarry Smith       -pc_hpddm_levels_%d_eps_
3155f1580f4eSBarry Smith       -pc_hpddm_levels_%d_p
31564ec2a359SPierre Jolivet       -pc_hpddm_levels_%d_mat_type
3157f1580f4eSBarry Smith       -pc_hpddm_coarse_
3158f1580f4eSBarry Smith       -pc_hpddm_coarse_p
31594ec2a359SPierre Jolivet       -pc_hpddm_coarse_mat_type
31602ce66baaSPierre Jolivet       -pc_hpddm_coarse_mat_filter
3161f1580f4eSBarry Smith .ve
3162f1580f4eSBarry Smith 
316338bf2a8cSPierre 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
3164f1580f4eSBarry Smith     -pc_hpddm_coarse_p 2 -pc_hpddm_coarse_mat_type baij will use 10 deflation vectors per subdomain on the fine "level 1",
3165f1580f4eSBarry Smith     aggregate the fine subdomains into 4 "level 2" subdomains, then use 10 deflation vectors per subdomain on "level 2",
31667eb095acSPierre Jolivet     and assemble the coarse matrix (of dimension 4 x 10 = 40) on two processes as a `MATBAIJ` (default is `MATSBAIJ`).
3167f1580f4eSBarry Smith 
3168b5a302b3SPierre 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.
3169f1580f4eSBarry Smith 
31701d27aa22SBarry Smith    Level: intermediate
31711d27aa22SBarry Smith 
31721d27aa22SBarry Smith    Notes:
31731d27aa22SBarry Smith    This preconditioner requires that PETSc is built with SLEPc (``--download-slepc``).
31741d27aa22SBarry Smith 
31751d27aa22SBarry Smith    By default, the underlying concurrent eigenproblems
31761d27aa22SBarry Smith    are solved using SLEPc shift-and-invert spectral transformation. This is usually what gives the best performance for GenEO, cf.
31771d27aa22SBarry Smith    {cite}`spillane2011robust` {cite}`jolivet2013scalabledd`. As
317838bf2a8cSPierre 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
317938bf2a8cSPierre 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
318038bf2a8cSPierre Jolivet    SLEPc documentation since they are specific to `PCHPDDM`.
318138bf2a8cSPierre Jolivet .vb
318238bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_st_share_sub_ksp
3183b5a302b3SPierre Jolivet       -pc_hpddm_levels_%d_eps_threshold_absolute
318438bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_eps_use_inertia
318538bf2a8cSPierre Jolivet .ve
318638bf2a8cSPierre Jolivet 
318738bf2a8cSPierre Jolivet    The first option from the list only applies to the fine-level eigensolver, see `PCHPDDMSetSTShareSubKSP()`. The second option from the list is
318838bf2a8cSPierre Jolivet    used to filter eigenmodes retrieved after convergence of `EPSSolve()` at "level N" such that eigenvectors used to define a "level N+1" coarse
3189b5a302b3SPierre 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
319038bf2a8cSPierre 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
319138bf2a8cSPierre 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
319238bf2a8cSPierre Jolivet    to supply -pc_hpddm_levels_1_eps_nev. This last option also only applies to the fine-level (N = 1) eigensolver.
3193f1580f4eSBarry Smith 
31941d27aa22SBarry Smith    See also {cite}`dolean2015introduction`, {cite}`al2022robust`, {cite}`al2022robustpd`, and {cite}`nataf2022recent`
3195f1580f4eSBarry Smith 
3196562efe2eSBarry Smith .seealso: [](ch_ksp), `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetAuxiliaryMat()`, `MATIS`, `PCBDDC`, `PCDEFLATION`, `PCTELESCOPE`, `PCASM`,
3197e31fc274SPierre Jolivet           `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDMHasNeumannMat()`, `PCHPDDMSetRHSMat()`, `PCHPDDMSetDeflationMat()`, `PCHPDDMSetSTShareSubKSP()`,
3198e31fc274SPierre Jolivet           `PCHPDDMGetSTShareSubKSP()`, `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDMGetComplexities()`
3199f1580f4eSBarry Smith M*/
3200d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_HPDDM(PC pc)
3201d71ae5a4SJacob Faibussowitsch {
3202f1580f4eSBarry Smith   PC_HPDDM *data;
3203f1580f4eSBarry Smith   PetscBool found;
3204f1580f4eSBarry Smith 
3205f1580f4eSBarry Smith   PetscFunctionBegin;
3206f1580f4eSBarry Smith   if (!loadedSym) {
3207f1580f4eSBarry Smith     PetscCall(HPDDMLoadDL_Private(&found));
3208db4a47b3SPierre Jolivet     if (found) PetscCall(PetscDLLibrarySym(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, nullptr, "PCHPDDM_Internal", (void **)&loadedSym));
3209f1580f4eSBarry Smith   }
3210f1580f4eSBarry Smith   PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCHPDDM_Internal symbol not found in loaded libhpddm_petsc");
32114dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&data));
3212f1580f4eSBarry Smith   pc->data                   = data;
3213c8ea6600SPierre Jolivet   data->Neumann              = PETSC_BOOL3_UNKNOWN;
3214f1580f4eSBarry Smith   pc->ops->reset             = PCReset_HPDDM;
3215f1580f4eSBarry Smith   pc->ops->destroy           = PCDestroy_HPDDM;
3216f1580f4eSBarry Smith   pc->ops->setfromoptions    = PCSetFromOptions_HPDDM;
3217f1580f4eSBarry Smith   pc->ops->setup             = PCSetUp_HPDDM;
3218d4f06b61SRaphael Zanella   pc->ops->apply             = PCApply_HPDDM<false>;
32198cb7430dSRaphael Zanella   pc->ops->matapply          = PCMatApply_HPDDM<false>;
3220d4f06b61SRaphael Zanella   pc->ops->applytranspose    = PCApply_HPDDM<true>;
32218cb7430dSRaphael Zanella   pc->ops->matapplytranspose = PCMatApply_HPDDM<true>;
3222f1580f4eSBarry Smith   pc->ops->view              = PCView_HPDDM;
3223f1580f4eSBarry Smith   pc->ops->presolve          = PCPreSolve_HPDDM;
3224f1580f4eSBarry Smith 
3225f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", PCHPDDMSetAuxiliaryMat_HPDDM));
3226f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", PCHPDDMHasNeumannMat_HPDDM));
3227f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", PCHPDDMSetRHSMat_HPDDM));
3228f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", PCHPDDMSetCoarseCorrectionType_HPDDM));
3229f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", PCHPDDMGetCoarseCorrectionType_HPDDM));
3230e31fc274SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", PCHPDDMSetSTShareSubKSP_HPDDM));
3231f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", PCHPDDMGetSTShareSubKSP_HPDDM));
3232f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", PCHPDDMSetDeflationMat_HPDDM));
32333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3234f1580f4eSBarry Smith }
3235f1580f4eSBarry Smith 
3236f1580f4eSBarry Smith /*@C
3237f1580f4eSBarry Smith   PCHPDDMInitializePackage - This function initializes everything in the `PCHPDDM` package. It is called from `PCInitializePackage()`.
3238f1580f4eSBarry Smith 
3239f1580f4eSBarry Smith   Level: developer
3240f1580f4eSBarry Smith 
3241562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscInitialize()`
3242f1580f4eSBarry Smith @*/
3243d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMInitializePackage(void)
3244d71ae5a4SJacob Faibussowitsch {
3245f1580f4eSBarry Smith   char ename[32];
3246f1580f4eSBarry Smith 
3247f1580f4eSBarry Smith   PetscFunctionBegin;
32483ba16761SJacob Faibussowitsch   if (PCHPDDMPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
3249f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_TRUE;
3250f1580f4eSBarry Smith   PetscCall(PetscRegisterFinalize(PCHPDDMFinalizePackage));
3251f1580f4eSBarry Smith   /* general events registered once during package initialization */
3252f1580f4eSBarry Smith   /* some of these events are not triggered in libpetsc,          */
3253f1580f4eSBarry Smith   /* but rather directly in libhpddm_petsc,                       */
3254f1580f4eSBarry Smith   /* which is in charge of performing the following operations    */
3255f1580f4eSBarry Smith 
3256f1580f4eSBarry Smith   /* domain decomposition structure from Pmat sparsity pattern    */
3257f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMStrc", PC_CLASSID, &PC_HPDDM_Strc));
3258f1580f4eSBarry Smith   /* Galerkin product, redistribution, and setup (not triggered in libpetsc)                */
3259f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtAP", PC_CLASSID, &PC_HPDDM_PtAP));
3260f1580f4eSBarry Smith   /* Galerkin product with summation, redistribution, and setup (not triggered in libpetsc) */
3261f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtBP", PC_CLASSID, &PC_HPDDM_PtBP));
3262f1580f4eSBarry Smith   /* next level construction using PtAP and PtBP (not triggered in libpetsc)                */
3263f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMNext", PC_CLASSID, &PC_HPDDM_Next));
3264f1580f4eSBarry Smith   static_assert(PETSC_PCHPDDM_MAXLEVELS <= 9, "PETSC_PCHPDDM_MAXLEVELS value is too high");
3265811e8887SPierre Jolivet   for (PetscInt i = 1; i < PETSC_PCHPDDM_MAXLEVELS; ++i) {
3266f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSetUp L%1" PetscInt_FMT, i));
3267f1580f4eSBarry Smith     /* events during a PCSetUp() at level #i _except_ the assembly */
3268f1580f4eSBarry Smith     /* of the Galerkin operator of the coarser level #(i + 1)      */
3269f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_SetUp[i - 1]));
3270f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSolve L%1" PetscInt_FMT, i));
3271f1580f4eSBarry Smith     /* events during a PCApply() at level #i _except_              */
3272f1580f4eSBarry Smith     /* the KSPSolve() of the coarser level #(i + 1)                */
3273f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_Solve[i - 1]));
3274f1580f4eSBarry Smith   }
32753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3276f1580f4eSBarry Smith }
3277f1580f4eSBarry Smith 
3278f1580f4eSBarry Smith /*@C
3279f1580f4eSBarry Smith   PCHPDDMFinalizePackage - This function frees everything from the `PCHPDDM` package. It is called from `PetscFinalize()`.
3280f1580f4eSBarry Smith 
3281f1580f4eSBarry Smith   Level: developer
3282f1580f4eSBarry Smith 
3283562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscFinalize()`
3284f1580f4eSBarry Smith @*/
3285d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMFinalizePackage(void)
3286d71ae5a4SJacob Faibussowitsch {
3287f1580f4eSBarry Smith   PetscFunctionBegin;
3288f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_FALSE;
32893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3290f1580f4eSBarry Smith }
32919bb5c669SPierre Jolivet 
32929bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat A, Vec x, Vec y)
32939bb5c669SPierre Jolivet {
32949bb5c669SPierre Jolivet   Harmonic h; /* [ A_00  A_01       ], furthermore, A_00 = [ A_loc,loc  A_loc,ovl ], thus, A_01 = [         ] */
32959bb5c669SPierre Jolivet               /* [ A_10  A_11  A_12 ]                      [ A_ovl,loc  A_ovl,ovl ]               [ A_ovl,1 ] */
32969bb5c669SPierre Jolivet   Vec sub;    /*  y = A x = R_loc R_0 [ A_00  A_01 ]^-1                                   R_loc = [  I_loc  ] */
32979bb5c669SPierre Jolivet               /*                      [ A_10  A_11 ]    R_1^T A_12 x                              [         ] */
32989bb5c669SPierre Jolivet   PetscFunctionBegin;
32999bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
33009bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
33019bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
33029bb5c669SPierre Jolivet   PetscCall(MatMult(h->A[0], x, sub));
33039bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
33049bb5c669SPierre Jolivet   PetscCall(KSPSolve(h->ksp, h->v, h->v));
33059bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_REVERSE, y));
33069bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
33079bb5c669SPierre Jolivet }
33089bb5c669SPierre Jolivet 
33099bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat A, Vec y, Vec x)
33109bb5c669SPierre Jolivet {
33119bb5c669SPierre Jolivet   Harmonic h;   /* x = A^T y =            [ A_00  A_01 ]^-T R_0^T R_loc^T y */
33129bb5c669SPierre Jolivet   Vec      sub; /*             A_12^T R_1 [ A_10  A_11 ]                    */
33139bb5c669SPierre Jolivet 
33149bb5c669SPierre Jolivet   PetscFunctionBegin;
33159bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
33169bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
33179bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_FORWARD, y));
33189bb5c669SPierre Jolivet   PetscCall(KSPSolveTranspose(h->ksp, h->v, h->v));
33199bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
33209bb5c669SPierre Jolivet   PetscCall(MatMultTranspose(h->A[0], sub, x));
33219bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
33229bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
33239bb5c669SPierre Jolivet }
33249bb5c669SPierre Jolivet 
33259bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat S, Mat X, Mat Y, void *)
33269bb5c669SPierre Jolivet {
33279bb5c669SPierre Jolivet   Harmonic h;
33289bb5c669SPierre Jolivet   Mat      A, B;
33299bb5c669SPierre Jolivet   Vec      a, b;
33309bb5c669SPierre Jolivet 
33319bb5c669SPierre Jolivet   PetscFunctionBegin;
33329bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
3333fb842aefSJose E. Roman   PetscCall(MatMatMult(h->A[0], X, MAT_INITIAL_MATRIX, PETSC_CURRENT, &A));
33349bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
33359bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
33369bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
33379bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B, i, &b));
33389bb5c669SPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_FORWARD, a));
33399bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B, i, &b));
33409bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
33419bb5c669SPierre Jolivet   }
33429bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
33439bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, B->cmap->n, nullptr, &A));
33449bb5c669SPierre Jolivet   PetscCall(KSPMatSolve(h->ksp, B, A));
33459bb5c669SPierre Jolivet   PetscCall(MatDestroy(&B));
33469bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
33479bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
33489bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &b));
33499bb5c669SPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_REVERSE, b));
33509bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &b));
33519bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
33529bb5c669SPierre Jolivet   }
33539bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
33549bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
33559bb5c669SPierre Jolivet }
33569bb5c669SPierre Jolivet 
33579bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat A)
33589bb5c669SPierre Jolivet {
33599bb5c669SPierre Jolivet   Harmonic h;
33609bb5c669SPierre Jolivet 
33619bb5c669SPierre Jolivet   PetscFunctionBegin;
33629bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
336332603206SJames Wright   for (PetscInt i = 0; i < 5; ++i) PetscCall(ISDestroy(h->is + i));
33649bb5c669SPierre Jolivet   PetscCall(PetscFree(h->is));
33659bb5c669SPierre Jolivet   PetscCall(VecDestroy(&h->v));
33669bb5c669SPierre Jolivet   for (PetscInt i = 0; i < 2; ++i) PetscCall(MatDestroy(h->A + i));
33679bb5c669SPierre Jolivet   PetscCall(PetscFree(h->A));
33689bb5c669SPierre Jolivet   PetscCall(KSPDestroy(&h->ksp));
33699bb5c669SPierre Jolivet   PetscCall(PetscFree(h));
33709bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
33719bb5c669SPierre Jolivet }
3372