xref: /petsc/src/ksp/pc/impls/hpddm/pchpddm.cxx (revision d4f06b61b06cc44c3975a1dfe3ec19c3af8ffb47)
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));
359b5a302b3SPierre Jolivet     PetscCall(PetscOptionsDeprecated(deprecated, prefix, "3.24", NULL));
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));
374b5a302b3SPierre Jolivet           PetscCall(PetscOptionsDeprecated(deprecated, prefix, "3.24", NULL));
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));
380b5a302b3SPierre Jolivet           PetscCall(PetscOptionsDeprecated(deprecated, prefix, "3.24", NULL));
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 
446*d4f06b61SRaphael 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 */
455*d4f06b61SRaphael Zanella   if (!transpose) PetscCall(KSPSolve(data->levels[0]->ksp, x, y));
456*d4f06b61SRaphael 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 
461d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDM(PC pc, Mat X, Mat Y)
462d71ae5a4SJacob Faibussowitsch {
463f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
464f1580f4eSBarry Smith 
465f1580f4eSBarry Smith   PetscFunctionBegin;
466f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
467f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
468f1580f4eSBarry Smith   PetscCall(KSPMatSolve(data->levels[0]->ksp, X, Y));
4693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
470f1580f4eSBarry Smith }
471f1580f4eSBarry Smith 
472cc4c1da9SBarry Smith /*@
473f1580f4eSBarry Smith   PCHPDDMGetComplexities - Computes the grid and operator complexities.
474f1580f4eSBarry Smith 
475c71f06a7SPierre Jolivet   Collective
476c71f06a7SPierre Jolivet 
477f1580f4eSBarry Smith   Input Parameter:
478f1580f4eSBarry Smith . pc - preconditioner context
479f1580f4eSBarry Smith 
480f1580f4eSBarry Smith   Output Parameters:
481cc4c1da9SBarry Smith + gc - grid complexity $ \sum_i m_i / m_1 $
482cc4c1da9SBarry Smith - oc - operator complexity $ \sum_i nnz_i / nnz_1 $
483f1580f4eSBarry Smith 
484f1580f4eSBarry Smith   Level: advanced
485f1580f4eSBarry Smith 
486562efe2eSBarry Smith .seealso: [](ch_ksp), `PCMGGetGridComplexity()`, `PCHPDDM`, `PCHYPRE`, `PCGAMG`
487f1580f4eSBarry Smith @*/
488cc4c1da9SBarry Smith PetscErrorCode PCHPDDMGetComplexities(PC pc, PetscReal *gc, PetscReal *oc)
489d71ae5a4SJacob Faibussowitsch {
490f1580f4eSBarry Smith   PC_HPDDM      *data = (PC_HPDDM *)pc->data;
491f1580f4eSBarry Smith   MatInfo        info;
492f1580f4eSBarry Smith   PetscLogDouble accumulate[2]{}, nnz1 = 1.0, m1 = 1.0;
493f1580f4eSBarry Smith 
494f1580f4eSBarry Smith   PetscFunctionBegin;
495715c1178SPierre Jolivet   if (gc) {
496715c1178SPierre Jolivet     PetscAssertPointer(gc, 2);
497715c1178SPierre Jolivet     *gc = 0;
498715c1178SPierre Jolivet   }
499715c1178SPierre Jolivet   if (oc) {
500715c1178SPierre Jolivet     PetscAssertPointer(oc, 3);
501715c1178SPierre Jolivet     *oc = 0;
502715c1178SPierre Jolivet   }
503715c1178SPierre Jolivet   for (PetscInt n = 0; n < data->N; ++n) {
504f1580f4eSBarry Smith     if (data->levels[n]->ksp) {
50513044ca3SPierre Jolivet       Mat       P, A = nullptr;
506715c1178SPierre Jolivet       PetscInt  m;
50713044ca3SPierre Jolivet       PetscBool flg = PETSC_FALSE;
50813044ca3SPierre Jolivet 
509db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &P));
510db4a47b3SPierre Jolivet       PetscCall(MatGetSize(P, &m, nullptr));
511f1580f4eSBarry Smith       accumulate[0] += m;
512f1580f4eSBarry Smith       if (n == 0) {
513f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
514f1580f4eSBarry Smith         if (flg) {
515f1580f4eSBarry Smith           PetscCall(MatConvert(P, MATAIJ, MAT_INITIAL_MATRIX, &A));
516f1580f4eSBarry Smith           P = A;
51713044ca3SPierre Jolivet         } else {
51813044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
51913044ca3SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)P));
520f1580f4eSBarry Smith         }
52113044ca3SPierre Jolivet       }
52213044ca3SPierre Jolivet       if (!A && flg) accumulate[1] += m * m; /* assumption that a MATSCHURCOMPLEMENT is dense if stored explicitly */
52313044ca3SPierre Jolivet       else if (P->ops->getinfo) {
524f1580f4eSBarry Smith         PetscCall(MatGetInfo(P, MAT_GLOBAL_SUM, &info));
525f1580f4eSBarry Smith         accumulate[1] += info.nz_used;
526f1580f4eSBarry Smith       }
527f1580f4eSBarry Smith       if (n == 0) {
528f1580f4eSBarry Smith         m1 = m;
52913044ca3SPierre Jolivet         if (!A && flg) nnz1 = m * m;
53013044ca3SPierre Jolivet         else if (P->ops->getinfo) nnz1 = info.nz_used;
531f1580f4eSBarry Smith         PetscCall(MatDestroy(&P));
532f1580f4eSBarry Smith       }
533f1580f4eSBarry Smith     }
534f1580f4eSBarry Smith   }
535715c1178SPierre Jolivet   /* only process #0 has access to the full hierarchy by construction, so broadcast to ensure consistent outputs */
536715c1178SPierre Jolivet   PetscCallMPI(MPI_Bcast(accumulate, 2, MPIU_PETSCLOGDOUBLE, 0, PetscObjectComm((PetscObject)pc)));
537715c1178SPierre Jolivet   if (gc) *gc = static_cast<PetscReal>(accumulate[0] / m1);
538715c1178SPierre Jolivet   if (oc) *oc = static_cast<PetscReal>(accumulate[1] / nnz1);
5393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
540f1580f4eSBarry Smith }
541f1580f4eSBarry Smith 
542d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_HPDDM(PC pc, PetscViewer viewer)
543d71ae5a4SJacob Faibussowitsch {
544f1580f4eSBarry Smith   PC_HPDDM         *data = (PC_HPDDM *)pc->data;
545f1580f4eSBarry Smith   PetscViewer       subviewer;
546aa21023fSPierre Jolivet   PetscViewerFormat format;
547f1580f4eSBarry Smith   PetscSubcomm      subcomm;
548f1580f4eSBarry Smith   PetscReal         oc, gc;
549811e8887SPierre Jolivet   PetscInt          tabs;
550f1580f4eSBarry Smith   PetscMPIInt       size, color, rank;
551aa21023fSPierre Jolivet   PetscBool         flg;
552aa21023fSPierre Jolivet   const char       *name;
553f1580f4eSBarry Smith 
554f1580f4eSBarry Smith   PetscFunctionBegin;
555aa21023fSPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &flg));
556aa21023fSPierre Jolivet   if (flg) {
557f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "level%s: %" PetscInt_FMT "\n", data->N > 1 ? "s" : "", data->N));
558f1580f4eSBarry Smith     PetscCall(PCHPDDMGetComplexities(pc, &gc, &oc));
559f1580f4eSBarry Smith     if (data->N > 1) {
560f1580f4eSBarry Smith       if (!data->deflation) {
561c8ea6600SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "Neumann matrix attached? %s\n", PetscBools[PetscBool3ToBool(data->Neumann)]));
562f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, "shared subdomain KSP between SLEPc and PETSc? %s\n", PetscBools[data->share]));
563f1580f4eSBarry Smith       } else PetscCall(PetscViewerASCIIPrintf(viewer, "user-supplied deflation matrix\n"));
564f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "coarse correction: %s\n", PCHPDDMCoarseCorrectionTypes[data->correction]));
565f1580f4eSBarry 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" : ""));
566f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIGetTab(viewer, &tabs));
567f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, 0));
568811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
569f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, data->levels[i - 1]->nu));
5700594bca0SPierre Jolivet         if (data->levels[i - 1]->threshold > static_cast<PetscReal>(-0.1)) PetscCall(PetscViewerASCIIPrintf(viewer, " (%g)", (double)data->levels[i - 1]->threshold));
571f1580f4eSBarry Smith       }
572f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
573f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, tabs));
574f1580f4eSBarry Smith     }
575f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "grid and operator complexities: %g %g\n", (double)gc, (double)oc));
5761fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
577f1580f4eSBarry Smith     if (data->levels[0]->ksp) {
578f1580f4eSBarry Smith       PetscCall(KSPView(data->levels[0]->ksp, viewer));
579f1580f4eSBarry Smith       if (data->levels[0]->pc) PetscCall(PCView(data->levels[0]->pc, viewer));
580eea1a2f1SRaphael Zanella       PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank));
581811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
582f1580f4eSBarry Smith         if (data->levels[i]->ksp) color = 1;
583f1580f4eSBarry Smith         else color = 0;
584f1580f4eSBarry Smith         PetscCall(PetscSubcommCreate(PetscObjectComm((PetscObject)pc), &subcomm));
585f1580f4eSBarry Smith         PetscCall(PetscSubcommSetNumber(subcomm, PetscMin(size, 2)));
586f1580f4eSBarry Smith         PetscCall(PetscSubcommSetTypeGeneral(subcomm, color, rank));
587f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPushTab(viewer));
588f1580f4eSBarry Smith         PetscCall(PetscViewerGetSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
589f1580f4eSBarry Smith         if (color == 1) {
590f1580f4eSBarry Smith           PetscCall(KSPView(data->levels[i]->ksp, subviewer));
591f1580f4eSBarry Smith           if (data->levels[i]->pc) PetscCall(PCView(data->levels[i]->pc, subviewer));
592f1580f4eSBarry Smith           PetscCall(PetscViewerFlush(subviewer));
593f1580f4eSBarry Smith         }
594f1580f4eSBarry Smith         PetscCall(PetscViewerRestoreSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
595f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPopTab(viewer));
596f1580f4eSBarry Smith         PetscCall(PetscSubcommDestroy(&subcomm));
597f1580f4eSBarry Smith       }
598f1580f4eSBarry Smith     }
599aa21023fSPierre Jolivet     PetscCall(PetscViewerGetFormat(viewer, &format));
600aa21023fSPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
601aa21023fSPierre Jolivet       PetscCall(PetscViewerFileGetName(viewer, &name));
602aa21023fSPierre Jolivet       if (name) {
603eea1a2f1SRaphael Zanella         Mat             aux[2];
604aa21023fSPierre Jolivet         IS              is;
605eea1a2f1SRaphael Zanella         const PetscInt *indices;
606eea1a2f1SRaphael Zanella         PetscInt        m, n, sizes[5] = {pc->mat->rmap->n, pc->mat->cmap->n, pc->mat->rmap->N, pc->mat->cmap->N, 0};
607aa21023fSPierre Jolivet         char           *tmp;
608aa21023fSPierre Jolivet         std::string     prefix, suffix;
609aa21023fSPierre Jolivet         size_t          pos;
610aa21023fSPierre Jolivet 
611aa21023fSPierre Jolivet         PetscCall(PetscStrstr(name, ".", &tmp));
612aa21023fSPierre Jolivet         if (tmp) {
613aa21023fSPierre Jolivet           pos    = std::distance(const_cast<char *>(name), tmp);
614aa21023fSPierre Jolivet           prefix = std::string(name, pos);
615aa21023fSPierre Jolivet           suffix = std::string(name + pos + 1);
616aa21023fSPierre Jolivet         } else prefix = name;
617aa21023fSPierre Jolivet         if (data->aux) {
618eea1a2f1SRaphael Zanella           PetscCall(MatGetSize(data->aux, &m, &n));
619eea1a2f1SRaphael Zanella           PetscCall(MatCreate(PetscObjectComm((PetscObject)pc), aux));
620eea1a2f1SRaphael Zanella           PetscCall(MatSetSizes(aux[0], m, n, PETSC_DETERMINE, PETSC_DETERMINE));
621eea1a2f1SRaphael Zanella           PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
622eea1a2f1SRaphael Zanella           if (flg) PetscCall(MatSetType(aux[0], MATMPIAIJ));
623eea1a2f1SRaphael Zanella           else {
624eea1a2f1SRaphael Zanella             PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQBAIJ, &flg));
625eea1a2f1SRaphael Zanella             if (flg) PetscCall(MatSetType(aux[0], MATMPIBAIJ));
626eea1a2f1SRaphael Zanella             else {
627eea1a2f1SRaphael Zanella               PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQSBAIJ, &flg));
628eea1a2f1SRaphael 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);
629eea1a2f1SRaphael Zanella               PetscCall(MatSetType(aux[0], MATMPISBAIJ));
630eea1a2f1SRaphael Zanella             }
631eea1a2f1SRaphael Zanella           }
632eea1a2f1SRaphael Zanella           PetscCall(MatSetBlockSizesFromMats(aux[0], data->aux, data->aux));
633eea1a2f1SRaphael Zanella           PetscCall(MatAssemblyBegin(aux[0], MAT_FINAL_ASSEMBLY));
634eea1a2f1SRaphael Zanella           PetscCall(MatAssemblyEnd(aux[0], MAT_FINAL_ASSEMBLY));
635eea1a2f1SRaphael Zanella           PetscCall(MatGetDiagonalBlock(aux[0], aux + 1));
636eea1a2f1SRaphael Zanella           PetscCall(MatCopy(data->aux, aux[1], DIFFERENT_NONZERO_PATTERN));
637eea1a2f1SRaphael Zanella           PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_aux_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
638eea1a2f1SRaphael Zanella           PetscCall(MatView(aux[0], subviewer));
639aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
640eea1a2f1SRaphael Zanella           PetscCall(MatDestroy(aux));
641aa21023fSPierre Jolivet         }
642aa21023fSPierre Jolivet         if (data->is) {
643eea1a2f1SRaphael Zanella           PetscCall(ISGetIndices(data->is, &indices));
644eea1a2f1SRaphael Zanella           PetscCall(ISGetSize(data->is, sizes + 4));
645eea1a2f1SRaphael Zanella           PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), sizes[4], indices, PETSC_USE_POINTER, &is));
646eea1a2f1SRaphael Zanella           PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_is_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
647eea1a2f1SRaphael Zanella           PetscCall(ISView(is, subviewer));
648aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
649eea1a2f1SRaphael Zanella           PetscCall(ISDestroy(&is));
650eea1a2f1SRaphael Zanella           PetscCall(ISRestoreIndices(data->is, &indices));
651aa21023fSPierre Jolivet         }
652eea1a2f1SRaphael Zanella         PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), PETSC_STATIC_ARRAY_LENGTH(sizes), sizes, PETSC_USE_POINTER, &is));
653eea1a2f1SRaphael Zanella         PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_sizes_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
654aa21023fSPierre Jolivet         PetscCall(ISView(is, subviewer));
655aa21023fSPierre Jolivet         PetscCall(PetscViewerDestroy(&subviewer));
656aa21023fSPierre Jolivet         PetscCall(ISDestroy(&is));
657aa21023fSPierre Jolivet       }
658aa21023fSPierre Jolivet     }
659f1580f4eSBarry Smith   }
6603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
661f1580f4eSBarry Smith }
662f1580f4eSBarry Smith 
663d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCPreSolve_HPDDM(PC pc, KSP ksp, Vec, Vec)
664d71ae5a4SJacob Faibussowitsch {
665f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
666f1580f4eSBarry Smith   Mat       A;
667cdbd50ebSPierre Jolivet   PetscBool flg;
668f1580f4eSBarry Smith 
669f1580f4eSBarry Smith   PetscFunctionBegin;
670f1580f4eSBarry Smith   if (ksp) {
671f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPLSQR, &flg));
672f1580f4eSBarry Smith     if (flg && !data->normal) {
673db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(ksp, &A, nullptr));
674db4a47b3SPierre Jolivet       PetscCall(MatCreateVecs(A, nullptr, &data->normal)); /* temporary Vec used in PCApply_HPDDMShell() for coarse grid corrections */
675cdbd50ebSPierre Jolivet     } else if (!flg) {
676cdbd50ebSPierre Jolivet       PetscCall(PetscObjectTypeCompareAny((PetscObject)ksp, &flg, KSPCG, KSPGROPPCG, KSPPIPECG, KSPPIPECGRR, KSPPIPELCG, KSPPIPEPRCG, KSPPIPECG2, KSPSTCG, KSPFCG, KSPPIPEFCG, KSPMINRES, KSPNASH, KSPSYMMLQ, ""));
677cdbd50ebSPierre Jolivet       if (!flg) {
678cdbd50ebSPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPHPDDM, &flg));
679cdbd50ebSPierre Jolivet         if (flg) {
680cdbd50ebSPierre Jolivet           KSPHPDDMType type;
681811e8887SPierre Jolivet 
682cdbd50ebSPierre Jolivet           PetscCall(KSPHPDDMGetType(ksp, &type));
683cdbd50ebSPierre Jolivet           flg = (type == KSP_HPDDM_TYPE_CG || type == KSP_HPDDM_TYPE_BCG || type == KSP_HPDDM_TYPE_BFBCG ? PETSC_TRUE : PETSC_FALSE);
684cdbd50ebSPierre Jolivet         }
685cdbd50ebSPierre Jolivet       }
686cdbd50ebSPierre Jolivet     }
687cdbd50ebSPierre Jolivet     if (flg) {
688cdbd50ebSPierre Jolivet       if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) {
689cdbd50ebSPierre Jolivet         PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_hpddm_coarse_correction", &flg));
690cdbd50ebSPierre 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",
691cdbd50ebSPierre Jolivet                    PCHPDDMCoarseCorrectionTypes[data->correction], ((PetscObject)ksp)->type_name, ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", PCHPDDMCoarseCorrectionTypes[data->correction], PCHPDDMCoarseCorrectionTypes[PC_HPDDM_COARSE_CORRECTION_BALANCED]);
692cdbd50ebSPierre Jolivet       }
693cdbd50ebSPierre Jolivet       for (PetscInt n = 0; n < data->N; ++n) {
694cdbd50ebSPierre Jolivet         if (data->levels[n]->pc) {
695cdbd50ebSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)data->levels[n]->pc, PCASM, &flg));
696cdbd50ebSPierre Jolivet           if (flg) {
697cdbd50ebSPierre Jolivet             PCASMType type;
698811e8887SPierre Jolivet 
699cdbd50ebSPierre Jolivet             PetscCall(PCASMGetType(data->levels[n]->pc, &type));
700cdbd50ebSPierre Jolivet             if (type == PC_ASM_RESTRICT || type == PC_ASM_INTERPOLATE) {
701cdbd50ebSPierre Jolivet               PetscCall(PetscOptionsHasName(((PetscObject)data->levels[n]->pc)->options, ((PetscObject)data->levels[n]->pc)->prefix, "-pc_asm_type", &flg));
702cdbd50ebSPierre 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],
703cdbd50ebSPierre Jolivet                          ((PetscObject)ksp)->type_name, ((PetscObject)data->levels[n]->pc)->prefix, PCASMTypes[type], PCASMTypes[PC_ASM_BASIC]);
704cdbd50ebSPierre Jolivet             }
705cdbd50ebSPierre Jolivet           }
706cdbd50ebSPierre Jolivet         }
707cdbd50ebSPierre Jolivet       }
708f1580f4eSBarry Smith     }
709f1580f4eSBarry Smith   }
7103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
711f1580f4eSBarry Smith }
712f1580f4eSBarry Smith 
713d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDMShell(PC pc)
714d71ae5a4SJacob Faibussowitsch {
715f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
716f1580f4eSBarry Smith   Mat             A, P;
717f1580f4eSBarry Smith   Vec             x;
718f1580f4eSBarry Smith   const char     *pcpre;
719f1580f4eSBarry Smith 
720f1580f4eSBarry Smith   PetscFunctionBegin;
721f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
722f1580f4eSBarry Smith   PetscCall(KSPGetOptionsPrefix(ctx->ksp, &pcpre));
723f1580f4eSBarry Smith   PetscCall(KSPGetOperators(ctx->ksp, &A, &P));
724f1580f4eSBarry Smith   /* smoother */
725f1580f4eSBarry Smith   PetscCall(PCSetOptionsPrefix(ctx->pc, pcpre));
726f1580f4eSBarry Smith   PetscCall(PCSetOperators(ctx->pc, A, P));
727f1580f4eSBarry Smith   if (!ctx->v[0]) {
728f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(ctx->D, 1, &ctx->v[0]));
729f1580f4eSBarry Smith     if (!std::is_same<PetscScalar, PetscReal>::value) PetscCall(VecDestroy(&ctx->D));
730db4a47b3SPierre Jolivet     PetscCall(MatCreateVecs(A, &x, nullptr));
731f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(x, 2, &ctx->v[1]));
732f1580f4eSBarry Smith     PetscCall(VecDestroy(&x));
733f1580f4eSBarry Smith   }
734f1580f4eSBarry Smith   std::fill_n(ctx->V, 3, nullptr);
7353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
736f1580f4eSBarry Smith }
737f1580f4eSBarry Smith 
738*d4f06b61SRaphael Zanella template <bool transpose = false, class Type = Vec, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
739d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type x, Type y)
740d71ae5a4SJacob Faibussowitsch {
741f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
742f1580f4eSBarry Smith   PetscScalar    *out;
743f1580f4eSBarry Smith 
744f1580f4eSBarry Smith   PetscFunctionBegin;
745f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
746f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
747f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
748f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
749f1580f4eSBarry Smith   PetscCall(VecGetArrayWrite(ctx->v[0][0], &out));
750*d4f06b61SRaphael Zanella   ctx->P->deflation<false, transpose>(nullptr, out, 1); /* y = Q x */
751f1580f4eSBarry Smith   PetscCall(VecRestoreArrayWrite(ctx->v[0][0], &out));
752f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
753f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
754f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
7553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
756f1580f4eSBarry Smith }
757f1580f4eSBarry Smith 
758f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
759d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type X, Type Y)
760d71ae5a4SJacob Faibussowitsch {
761f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
762f1580f4eSBarry Smith   Vec             vX, vY, vC;
763f1580f4eSBarry Smith   PetscScalar    *out;
764811e8887SPierre Jolivet   PetscInt        N;
765f1580f4eSBarry Smith 
766f1580f4eSBarry Smith   PetscFunctionBegin;
767f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
768db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
769f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
770811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
771f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(X, i, &vX));
772f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(ctx->V[0], i, &vC));
773f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
774f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
775f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(ctx->V[0], i, &vC));
776f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(X, i, &vX));
777f1580f4eSBarry Smith   }
778f1580f4eSBarry Smith   PetscCall(MatDenseGetArrayWrite(ctx->V[0], &out));
779db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, N); /* Y = Q X */
780f1580f4eSBarry Smith   PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &out));
781f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
782811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
783f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(ctx->V[0], i, &vC));
784f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(Y, i, &vY));
785f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
786f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
787f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &vY));
788f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(ctx->V[0], i, &vC));
789f1580f4eSBarry Smith   }
7903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
791f1580f4eSBarry Smith }
792f1580f4eSBarry Smith 
793f1580f4eSBarry Smith /*
794aa1539e9SPierre 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.
795f1580f4eSBarry Smith 
796f1580f4eSBarry Smith .vb
797f1580f4eSBarry Smith    (1) y =                Pmat^-1              x + Q x,
798f1580f4eSBarry Smith    (2) y =                Pmat^-1 (I - Amat Q) x + Q x (default),
799aa1539e9SPierre Jolivet    (3) y = (I - Q Amat^T) Pmat^-1 (I - Amat Q) x + Q x,
800aa1539e9SPierre Jolivet    (4) y =                Pmat^-1              x      .
801f1580f4eSBarry Smith .ve
802f1580f4eSBarry Smith 
803f1580f4eSBarry Smith    Input Parameters:
804f1580f4eSBarry Smith +     pc - preconditioner context
805f1580f4eSBarry Smith -     x - input vector
806f1580f4eSBarry Smith 
807f1580f4eSBarry Smith    Output Parameter:
808f1580f4eSBarry Smith .     y - output vector
809f1580f4eSBarry Smith 
810f1580f4eSBarry Smith    Notes:
811f1580f4eSBarry 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.
812f1580f4eSBarry 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.
813f1580f4eSBarry 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.
814f1580f4eSBarry Smith 
815f1580f4eSBarry Smith    Level: advanced
816f1580f4eSBarry Smith 
817f1580f4eSBarry Smith    Developer Note:
818f1580f4eSBarry 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
819f1580f4eSBarry Smith    to trigger it. Likely the manual page is `PCHPDDM`
820f1580f4eSBarry Smith 
821562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
822f1580f4eSBarry Smith */
823d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDMShell(PC pc, Vec x, Vec y)
824d71ae5a4SJacob Faibussowitsch {
825f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
826f1580f4eSBarry Smith   Mat             A;
827f1580f4eSBarry Smith 
828f1580f4eSBarry Smith   PetscFunctionBegin;
829f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
830f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
831db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
832aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApply(ctx->pc, x, y)); /* y = M^-1 x */
833aa1539e9SPierre Jolivet   else {
834f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, x, y)); /* y = Q x */
835f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
836f1580f4eSBarry Smith       if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMult(A, y, ctx->v[1][0])); /* y = A Q x     */
837f1580f4eSBarry Smith       else { /* KSPLSQR and finest level */ PetscCall(MatMult(A, y, ctx->parent->normal));               /* y = A Q x     */
838f1580f4eSBarry Smith         PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][0]));                      /* y = A^T A Q x */
839f1580f4eSBarry Smith       }
840f1580f4eSBarry Smith       PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x)); /* y = (I - A Q) x                             */
841f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, ctx->v[1][1], ctx->v[1][0]));  /* y = M^-1 (I - A Q) x                        */
842f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
843f1580f4eSBarry 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 */
844f1580f4eSBarry Smith         else {
845f1580f4eSBarry Smith           PetscCall(MatMult(A, ctx->v[1][0], ctx->parent->normal));
846f1580f4eSBarry Smith           PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][1])); /* z = A^T A y           */
847f1580f4eSBarry Smith         }
848*d4f06b61SRaphael Zanella         PetscCall(PCHPDDMDeflate_Private(pc, ctx->v[1][1], ctx->v[1][1]));     /* z = Q z                      */
849f1580f4eSBarry 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      */
850f1580f4eSBarry Smith       } else PetscCall(VecAXPY(y, 1.0, ctx->v[1][0]));                         /* y = Q M^-1 (I - A Q) x + Q x */
851f1580f4eSBarry Smith     } else {
852f1580f4eSBarry 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);
853f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, x, ctx->v[1][0]));
854f1580f4eSBarry Smith       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-1 x + Q x */
855f1580f4eSBarry Smith     }
856aa1539e9SPierre Jolivet   }
8573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
858f1580f4eSBarry Smith }
859f1580f4eSBarry Smith 
860f1580f4eSBarry Smith /*
861f1580f4eSBarry Smith      PCMatApply_HPDDMShell - Variant of PCApply_HPDDMShell() for blocks of vectors.
862f1580f4eSBarry Smith 
863f1580f4eSBarry Smith    Input Parameters:
864f1580f4eSBarry Smith +     pc - preconditioner context
865f1580f4eSBarry Smith -     X - block of input vectors
866f1580f4eSBarry Smith 
867f1580f4eSBarry Smith    Output Parameter:
868f1580f4eSBarry Smith .     Y - block of output vectors
869f1580f4eSBarry Smith 
870f1580f4eSBarry Smith    Level: advanced
871f1580f4eSBarry Smith 
872562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
873f1580f4eSBarry Smith */
874d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDMShell(PC pc, Mat X, Mat Y)
875d71ae5a4SJacob Faibussowitsch {
876f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
877f1580f4eSBarry Smith   Mat             A, *ptr;
878db4a47b3SPierre Jolivet   PetscContainer  container = nullptr;
879f1580f4eSBarry Smith   PetscScalar    *array;
880f1580f4eSBarry Smith   PetscInt        m, M, N, prev = 0;
881f1580f4eSBarry Smith   PetscBool       reset = PETSC_FALSE;
882f1580f4eSBarry Smith 
883f1580f4eSBarry Smith   PetscFunctionBegin;
884f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
885f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
886db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
887db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
888aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApply(ctx->pc, X, Y));
889aa1539e9SPierre Jolivet   else {
890f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)A, "_HPDDM_MatProduct", (PetscObject *)&container));
891f1580f4eSBarry Smith     if (container) { /* MatProduct container already attached */
892f1580f4eSBarry Smith       PetscCall(PetscContainerGetPointer(container, (void **)&ptr));
893f1580f4eSBarry Smith       if (ptr[1] != ctx->V[2]) /* Mat has changed or may have been set first in KSPHPDDM */
894f1580f4eSBarry Smith         for (m = 0; m < 2; ++m) {
895f1580f4eSBarry Smith           PetscCall(MatDestroy(ctx->V + m + 1));
896f1580f4eSBarry Smith           ctx->V[m + 1] = ptr[m];
897f1580f4eSBarry Smith           PetscCall(PetscObjectReference((PetscObject)ctx->V[m + 1]));
898f1580f4eSBarry Smith         }
899f1580f4eSBarry Smith     }
900db4a47b3SPierre Jolivet     if (ctx->V[1]) PetscCall(MatGetSize(ctx->V[1], nullptr, &prev));
901f1580f4eSBarry Smith     if (N != prev || !ctx->V[0]) {
902f1580f4eSBarry Smith       PetscCall(MatDestroy(ctx->V));
903f1580f4eSBarry Smith       PetscCall(VecGetLocalSize(ctx->v[0][0], &m));
904db4a47b3SPierre Jolivet       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, PETSC_DECIDE, N, nullptr, ctx->V));
905f1580f4eSBarry Smith       if (N != prev) {
906f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 1));
907f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 2));
908db4a47b3SPierre Jolivet         PetscCall(MatGetLocalSize(X, &m, nullptr));
909db4a47b3SPierre Jolivet         PetscCall(MatGetSize(X, &M, nullptr));
910f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
911db4a47b3SPierre Jolivet         else array = nullptr;
912f1580f4eSBarry Smith         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, array, ctx->V + 1));
913f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
914db4a47b3SPierre Jolivet         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, nullptr, ctx->V + 2));
915db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, Y, nullptr, ctx->V[1]));
916f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[1], MATPRODUCT_AB));
917f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[1]));
918f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[1]));
919715c1178SPierre Jolivet         if (!container) PetscCall(PetscObjectContainerCompose((PetscObject)A, "_HPDDM_MatProduct", ctx->V + 1, nullptr)); /* no MatProduct container attached, create one to be queried in KSPHPDDM or at the next call to PCMatApply() */
920715c1178SPierre Jolivet         else PetscCall(PetscContainerSetPointer(container, ctx->V + 1));                                                  /* need to compose B and D from MatProductCreateWithMat(A, B, NULL, D), which are stored in the contiguous array ctx->V */
921f1580f4eSBarry Smith       }
922f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
923db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, ctx->V[1], nullptr, ctx->V[2]));
924f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[2], MATPRODUCT_AtB));
925f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[2]));
926f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[2]));
927f1580f4eSBarry Smith       }
928f1580f4eSBarry Smith       ctx->P->start(N);
929f1580f4eSBarry Smith     }
930f1580f4eSBarry Smith     if (N == prev || container) { /* when MatProduct container is attached, always need to MatProductReplaceMats() since KSPHPDDM may have replaced the Mat as well */
931db4a47b3SPierre Jolivet       PetscCall(MatProductReplaceMats(nullptr, Y, nullptr, ctx->V[1]));
932f1580f4eSBarry Smith       if (container && ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) {
933f1580f4eSBarry Smith         PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
934f1580f4eSBarry Smith         PetscCall(MatDensePlaceArray(ctx->V[1], array));
935f1580f4eSBarry Smith         PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
936f1580f4eSBarry Smith         reset = PETSC_TRUE;
937f1580f4eSBarry Smith       }
938f1580f4eSBarry Smith     }
939f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, X, Y));
940f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
941f1580f4eSBarry Smith       PetscCall(MatProductNumeric(ctx->V[1]));
942f1580f4eSBarry Smith       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
943f1580f4eSBarry Smith       PetscCall(MatAXPY(ctx->V[2], -1.0, X, SAME_NONZERO_PATTERN));
944f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, ctx->V[2], ctx->V[1]));
945f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
946f1580f4eSBarry Smith         PetscCall(MatProductNumeric(ctx->V[2]));
947f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->V[2], ctx->V[2]));
948f1580f4eSBarry Smith         PetscCall(MatAXPY(ctx->V[1], -1.0, ctx->V[2], SAME_NONZERO_PATTERN));
949f1580f4eSBarry Smith       }
950f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
951f1580f4eSBarry Smith     } else {
952f1580f4eSBarry 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);
953f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, X, ctx->V[1]));
954f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
955f1580f4eSBarry Smith     }
956f1580f4eSBarry Smith     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
957aa1539e9SPierre Jolivet   }
9583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
959f1580f4eSBarry Smith }
960f1580f4eSBarry Smith 
961*d4f06b61SRaphael Zanella /*
962*d4f06b61SRaphael 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.
963*d4f06b61SRaphael Zanella 
964*d4f06b61SRaphael Zanella .vb
965*d4f06b61SRaphael Zanella    (1) y =                  Pmat^-T                x + Q^T x,
966*d4f06b61SRaphael Zanella    (2) y = (I - Q^T Amat^T) Pmat^-T                x + Q^T x (default),
967*d4f06b61SRaphael Zanella    (3) y = (I - Q^T Amat^T) Pmat^-T (I - Amat Q^T) x + Q^T x,
968*d4f06b61SRaphael Zanella    (4) y =                  Pmat^-T                x        .
969*d4f06b61SRaphael Zanella .ve
970*d4f06b61SRaphael Zanella 
971*d4f06b61SRaphael Zanella    Input Parameters:
972*d4f06b61SRaphael Zanella +     pc - preconditioner context
973*d4f06b61SRaphael Zanella -     x - input vector
974*d4f06b61SRaphael Zanella 
975*d4f06b61SRaphael Zanella    Output Parameter:
976*d4f06b61SRaphael Zanella .     y - output vector
977*d4f06b61SRaphael Zanella 
978*d4f06b61SRaphael Zanella    Level: advanced
979*d4f06b61SRaphael Zanella 
980*d4f06b61SRaphael Zanella    Developer Note:
981*d4f06b61SRaphael 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
982*d4f06b61SRaphael Zanella    to trigger it. Likely the manual page is `PCHPDDM`
983*d4f06b61SRaphael Zanella 
984*d4f06b61SRaphael Zanella .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
985*d4f06b61SRaphael Zanella */
986*d4f06b61SRaphael Zanella static PetscErrorCode PCApplyTranspose_HPDDMShell(PC pc, Vec x, Vec y)
987*d4f06b61SRaphael Zanella {
988*d4f06b61SRaphael Zanella   PC_HPDDM_Level *ctx;
989*d4f06b61SRaphael Zanella   Mat             A;
990*d4f06b61SRaphael Zanella 
991*d4f06b61SRaphael Zanella   PetscFunctionBegin;
992*d4f06b61SRaphael Zanella   PetscCall(PCShellGetContext(pc, &ctx));
993*d4f06b61SRaphael Zanella   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
994*d4f06b61SRaphael Zanella   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
995*d4f06b61SRaphael Zanella   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApplyTranspose(ctx->pc, x, y)); /* y = M^-T x */
996*d4f06b61SRaphael Zanella   else {
997*d4f06b61SRaphael Zanella     PetscCall(PCHPDDMDeflate_Private<true>(pc, x, y)); /* y = Q^T x */
998*d4f06b61SRaphael Zanella     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
999*d4f06b61SRaphael Zanella       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
1000*d4f06b61SRaphael Zanella         if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMult(A, y, ctx->v[1][0])); /* y = A Q^T x     */
1001*d4f06b61SRaphael Zanella         else { /* KSPLSQR and finest level */ PetscCall(MatMult(A, y, ctx->parent->normal));               /* y = A Q^T x     */
1002*d4f06b61SRaphael Zanella           PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][0]));                      /* y = A^T A Q^T x */
1003*d4f06b61SRaphael Zanella         }
1004*d4f06b61SRaphael Zanella         PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x));                                                                     /* y = (I - A Q^T) x      */
1005*d4f06b61SRaphael Zanella         PetscCall(PCApplyTranspose(ctx->pc, ctx->v[1][1], ctx->v[1][0]));                                                             /* y = M^-T (I - A Q^T) x */
1006*d4f06b61SRaphael Zanella       } else PetscCall(PCApplyTranspose(ctx->pc, x, ctx->v[1][0]));                                                                   /* y = M^-T x             */
1007*d4f06b61SRaphael Zanella       if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMultHermitianTranspose(A, ctx->v[1][0], ctx->v[1][1])); /* z = A^T y              */
1008*d4f06b61SRaphael Zanella       else {
1009*d4f06b61SRaphael Zanella         PetscCall(MatMult(A, ctx->v[1][0], ctx->parent->normal));
1010*d4f06b61SRaphael Zanella         PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][1])); /* z = A^T A y            */
1011*d4f06b61SRaphael Zanella       }
1012*d4f06b61SRaphael Zanella       PetscCall(PCHPDDMDeflate_Private<true>(pc, ctx->v[1][1], ctx->v[1][1])); /* z = Q^T z                   */
1013*d4f06b61SRaphael 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 */
1014*d4f06b61SRaphael Zanella     } else {
1015*d4f06b61SRaphael 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);
1016*d4f06b61SRaphael Zanella       PetscCall(PCApplyTranspose(ctx->pc, x, ctx->v[1][0]));
1017*d4f06b61SRaphael Zanella       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-T x + Q^T x */
1018*d4f06b61SRaphael Zanella     }
1019*d4f06b61SRaphael Zanella   }
1020*d4f06b61SRaphael Zanella   PetscFunctionReturn(PETSC_SUCCESS);
1021*d4f06b61SRaphael Zanella }
1022*d4f06b61SRaphael Zanella 
1023d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDMShell(PC pc)
1024d71ae5a4SJacob Faibussowitsch {
1025f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
1026f1580f4eSBarry Smith 
1027f1580f4eSBarry Smith   PetscFunctionBegin;
1028f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
1029f1580f4eSBarry Smith   PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(ctx, PETSC_TRUE));
1030f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(1, &ctx->v[0]));
1031f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(2, &ctx->v[1]));
1032f4f49eeaSPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", nullptr));
1033f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V));
1034f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 1));
1035f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 2));
1036f1580f4eSBarry Smith   PetscCall(VecDestroy(&ctx->D));
103701e3c840SPierre Jolivet   PetscCall(PetscSFDestroy(&ctx->scatter));
1038f1580f4eSBarry Smith   PetscCall(PCDestroy(&ctx->pc));
10393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1040f1580f4eSBarry Smith }
1041f1580f4eSBarry Smith 
10429bb5c669SPierre Jolivet template <class Type, bool T = false, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
10439bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type x, Type y)
10449bb5c669SPierre Jolivet {
10459bb5c669SPierre Jolivet   PetscFunctionBegin;
10469bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[0], std::get<1>(*p), SCATTER_FORWARD, x));
10479bb5c669SPierre Jolivet   if (!T) PetscCall(PCApply(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
10489bb5c669SPierre Jolivet   else PetscCall(PCApplyTranspose(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
10499bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[1], std::get<1>(*p), SCATTER_REVERSE, y));
10509bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10519bb5c669SPierre Jolivet }
10529bb5c669SPierre Jolivet 
10539bb5c669SPierre Jolivet template <class Type, bool = false, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
10549bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type X, Type Y)
10559bb5c669SPierre Jolivet {
10569bb5c669SPierre Jolivet   Mat B[2];
10579bb5c669SPierre Jolivet   Vec x, y;
10589bb5c669SPierre Jolivet 
10599bb5c669SPierre Jolivet   PetscFunctionBegin;
10609bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B));
10619bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B + 1));
10629bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
10639bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(X, i, &x));
10649bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B[0], i, &y));
10659bb5c669SPierre Jolivet     PetscCall(VecISCopy(y, std::get<1>(*p), SCATTER_FORWARD, x));
10669bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B[0], i, &y));
10679bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(X, i, &x));
10689bb5c669SPierre Jolivet   }
10699bb5c669SPierre Jolivet   PetscCall(PCMatApply(factor, B[0], B[1]));
10709bb5c669SPierre Jolivet   PetscCall(MatDestroy(B));
10719bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
10729bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B[1], i, &x));
10739bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &y));
10749bb5c669SPierre Jolivet     PetscCall(VecISCopy(x, std::get<1>(*p), SCATTER_REVERSE, y));
10759bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &y));
10769bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B[1], i, &x));
10779bb5c669SPierre Jolivet   }
10789bb5c669SPierre Jolivet   PetscCall(MatDestroy(B + 1));
10799bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10809bb5c669SPierre Jolivet }
10819bb5c669SPierre Jolivet 
10829bb5c669SPierre Jolivet template <class Type = Vec, bool T = false>
10839bb5c669SPierre Jolivet static PetscErrorCode PCApply_Schur(PC pc, Type x, Type y)
10849bb5c669SPierre Jolivet {
10859bb5c669SPierre Jolivet   PC                           factor;
10869bb5c669SPierre Jolivet   Mat                          A;
10879bb5c669SPierre Jolivet   MatSolverType                type;
10889bb5c669SPierre Jolivet   PetscBool                    flg;
10899bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
10909bb5c669SPierre Jolivet 
10919bb5c669SPierre Jolivet   PetscFunctionBegin;
10929bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
10939bb5c669SPierre Jolivet   PetscCall(KSPGetPC(std::get<0>(*p), &factor));
10949bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(factor, &type));
10959bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatrix(factor, &A));
10969bb5c669SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
10979bb5c669SPierre Jolivet   if (flg) {
10989bb5c669SPierre Jolivet     PetscCheck(PetscDefined(HAVE_MUMPS), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
10999bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 0));
11009bb5c669SPierre Jolivet   } else {
11019bb5c669SPierre Jolivet     PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &flg));
11029bb5c669SPierre Jolivet     PetscCheck(flg && PetscDefined(HAVE_MKL_PARDISO), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
11039bb5c669SPierre Jolivet     flg = PETSC_FALSE;
11049bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
11059bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 1));
11069bb5c669SPierre Jolivet #endif
11079bb5c669SPierre Jolivet   }
11089bb5c669SPierre Jolivet   PetscCall(PCApply_Schur_Private<Type, T>(p, factor, x, y));
11099bb5c669SPierre Jolivet   if (flg) {
11109bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1));
11119bb5c669SPierre Jolivet   } else {
11129bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
11139bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 0));
11149bb5c669SPierre Jolivet #endif
11159bb5c669SPierre Jolivet   }
11169bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
11179bb5c669SPierre Jolivet }
11189bb5c669SPierre Jolivet 
11199bb5c669SPierre Jolivet static PetscErrorCode PCDestroy_Schur(PC pc)
11209bb5c669SPierre Jolivet {
11219bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
11229bb5c669SPierre Jolivet 
11239bb5c669SPierre Jolivet   PetscFunctionBegin;
11249bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
11259bb5c669SPierre Jolivet   PetscCall(ISDestroy(&std::get<1>(*p)));
11269bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p)));
11279bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p) + 1));
11289bb5c669SPierre Jolivet   PetscCall(PetscFree(p));
11299bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
11309bb5c669SPierre Jolivet }
11319bb5c669SPierre Jolivet 
1132*d4f06b61SRaphael Zanella template <bool transpose>
1133d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSolve_Private(const PC_HPDDM_Level *ctx, PetscScalar *rhs, const unsigned short &mu)
1134d71ae5a4SJacob Faibussowitsch {
1135f1580f4eSBarry Smith   Mat      B, X;
1136f1580f4eSBarry Smith   PetscInt n, N, j = 0;
1137f1580f4eSBarry Smith 
1138f1580f4eSBarry Smith   PetscFunctionBegin;
1139db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &B, nullptr));
1140db4a47b3SPierre Jolivet   PetscCall(MatGetLocalSize(B, &n, nullptr));
1141db4a47b3SPierre Jolivet   PetscCall(MatGetSize(B, &N, nullptr));
1142f1580f4eSBarry Smith   if (ctx->parent->log_separate) {
1143f1580f4eSBarry Smith     j = std::distance(ctx->parent->levels, std::find(ctx->parent->levels, ctx->parent->levels + ctx->parent->N, ctx));
1144db4a47b3SPierre Jolivet     PetscCall(PetscLogEventBegin(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
1145f1580f4eSBarry Smith   }
1146f1580f4eSBarry Smith   if (mu == 1) {
1147f1580f4eSBarry Smith     if (!ctx->ksp->vec_rhs) {
1148db4a47b3SPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ctx->ksp), 1, n, N, nullptr, &ctx->ksp->vec_rhs));
1149f1580f4eSBarry Smith       PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)ctx->ksp), n, N, &ctx->ksp->vec_sol));
1150f1580f4eSBarry Smith     }
1151f1580f4eSBarry Smith     PetscCall(VecPlaceArray(ctx->ksp->vec_rhs, rhs));
1152*d4f06b61SRaphael Zanella     if (!transpose) PetscCall(KSPSolve(ctx->ksp, nullptr, nullptr));
1153*d4f06b61SRaphael Zanella     else PetscCall(KSPSolveTranspose(ctx->ksp, nullptr, nullptr));
1154f1580f4eSBarry Smith     PetscCall(VecCopy(ctx->ksp->vec_sol, ctx->ksp->vec_rhs));
1155f1580f4eSBarry Smith     PetscCall(VecResetArray(ctx->ksp->vec_rhs));
1156f1580f4eSBarry Smith   } else {
1157f1580f4eSBarry Smith     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, rhs, &B));
1158db4a47b3SPierre Jolivet     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, nullptr, &X));
1159f1580f4eSBarry Smith     PetscCall(KSPMatSolve(ctx->ksp, B, X));
1160f1580f4eSBarry Smith     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
1161f1580f4eSBarry Smith     PetscCall(MatDestroy(&X));
1162f1580f4eSBarry Smith     PetscCall(MatDestroy(&B));
1163f1580f4eSBarry Smith   }
1164db4a47b3SPierre Jolivet   if (ctx->parent->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
11653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1166f1580f4eSBarry Smith }
1167f1580f4eSBarry Smith 
1168d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetUpNeumannOverlap_Private(PC pc)
1169d71ae5a4SJacob Faibussowitsch {
1170f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
1171f1580f4eSBarry Smith 
1172f1580f4eSBarry Smith   PetscFunctionBegin;
1173f1580f4eSBarry Smith   if (data->setup) {
1174f1580f4eSBarry Smith     Mat       P;
1175db4a47b3SPierre Jolivet     Vec       x, xt = nullptr;
1176f1580f4eSBarry Smith     PetscReal t = 0.0, s = 0.0;
1177f1580f4eSBarry Smith 
1178db4a47b3SPierre Jolivet     PetscCall(PCGetOperators(pc, nullptr, &P));
1179f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)P, "__SNES_latest_X", (PetscObject *)&x));
1180f1580f4eSBarry Smith     PetscCallBack("PCHPDDM Neumann callback", (*data->setup)(data->aux, t, x, xt, s, data->is, data->setup_ctx));
1181f1580f4eSBarry Smith   }
11823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1183f1580f4eSBarry Smith }
1184f1580f4eSBarry Smith 
1185d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCreateSubMatrices_Private(Mat mat, PetscInt n, const IS *, const IS *, MatReuse scall, Mat *submat[])
1186d71ae5a4SJacob Faibussowitsch {
1187f1580f4eSBarry Smith   Mat       A;
118813044ca3SPierre Jolivet   PetscBool flg;
1189f1580f4eSBarry Smith 
1190f1580f4eSBarry Smith   PetscFunctionBegin;
1191f1580f4eSBarry Smith   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatCreateSubMatrices() called to extract %" PetscInt_FMT " submatrices, which is different than 1", n);
1192f1580f4eSBarry Smith   /* previously composed Mat */
1193f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)mat, "_PCHPDDM_SubMatrices", (PetscObject *)&A));
1194f1580f4eSBarry Smith   PetscCheck(A, PETSC_COMM_SELF, PETSC_ERR_PLIB, "SubMatrices not found in Mat");
119513044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSCHURCOMPLEMENT, &flg)); /* MATSCHURCOMPLEMENT has neither a MatDuplicate() nor a MatCopy() implementation */
1196f1580f4eSBarry Smith   if (scall == MAT_INITIAL_MATRIX) {
11976f2c871aSStefano Zampini     PetscCall(PetscCalloc1(2, submat)); /* allocate an extra Mat to avoid errors in MatDestroySubMatrices_Dummy() */
119813044ca3SPierre Jolivet     if (!flg) PetscCall(MatDuplicate(A, MAT_COPY_VALUES, *submat));
119913044ca3SPierre Jolivet   } else if (!flg) PetscCall(MatCopy(A, (*submat)[0], SAME_NONZERO_PATTERN));
120013044ca3SPierre Jolivet   if (flg) {
1201bf583f0cSPierre Jolivet     PetscCall(MatDestroy(*submat)); /* previously created Mat has to be destroyed */
120213044ca3SPierre Jolivet     (*submat)[0] = A;
120313044ca3SPierre Jolivet     PetscCall(PetscObjectReference((PetscObject)A));
120413044ca3SPierre Jolivet   }
12053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1206f1580f4eSBarry Smith }
1207f1580f4eSBarry Smith 
1208d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCommunicationAvoidingPCASM_Private(PC pc, Mat C, PetscBool sorted)
1209d71ae5a4SJacob Faibussowitsch {
1210f1580f4eSBarry Smith   void (*op)(void);
1211f1580f4eSBarry Smith 
1212f1580f4eSBarry Smith   PetscFunctionBegin;
1213f1580f4eSBarry Smith   /* previously-composed Mat */
1214f1580f4eSBarry Smith   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", (PetscObject)C));
1215f1580f4eSBarry Smith   PetscCall(MatGetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, &op));
1216f1580f4eSBarry Smith   /* trick suggested by Barry https://lists.mcs.anl.gov/pipermail/petsc-dev/2020-January/025491.html */
1217f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, (void (*)(void))PCHPDDMCreateSubMatrices_Private));
1218f1580f4eSBarry Smith   if (sorted) PetscCall(PCASMSetSortIndices(pc, PETSC_FALSE)); /* everything is already sorted */
1219f1580f4eSBarry Smith   PetscCall(PCSetFromOptions(pc));                             /* otherwise -pc_hpddm_levels_1_pc_asm_sub_mat_type is not used */
1220f1580f4eSBarry Smith   PetscCall(PCSetUp(pc));
1221f1580f4eSBarry Smith   /* reset MatCreateSubMatrices() */
1222f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, op));
1223db4a47b3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", nullptr));
12243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1225f1580f4eSBarry Smith }
1226f1580f4eSBarry Smith 
1227d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMPermute_Private(IS is, IS in_is, IS *out_is, Mat in_C, Mat *out_C, IS *p)
1228d71ae5a4SJacob Faibussowitsch {
1229f1580f4eSBarry Smith   IS                           perm;
1230f1580f4eSBarry Smith   const PetscInt              *ptr;
1231811e8887SPierre Jolivet   PetscInt                    *concatenate, size, bs;
1232f1580f4eSBarry Smith   std::map<PetscInt, PetscInt> order;
1233f1580f4eSBarry Smith   PetscBool                    sorted;
1234f1580f4eSBarry Smith 
1235f1580f4eSBarry Smith   PetscFunctionBegin;
1236cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(is, IS_CLASSID, 1);
1237cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(in_C, MAT_CLASSID, 4);
1238f1580f4eSBarry Smith   PetscCall(ISSorted(is, &sorted));
1239f1580f4eSBarry Smith   if (!sorted) {
1240f1580f4eSBarry Smith     PetscCall(ISGetLocalSize(is, &size));
1241f1580f4eSBarry Smith     PetscCall(ISGetIndices(is, &ptr));
1242b07dfdedSPierre Jolivet     PetscCall(ISGetBlockSize(is, &bs));
1243f1580f4eSBarry Smith     /* MatCreateSubMatrices(), called by PCASM, follows the global numbering of Pmat */
1244811e8887SPierre Jolivet     for (PetscInt n = 0; n < size; n += bs) order.insert(std::make_pair(ptr[n] / bs, n / bs));
1245f1580f4eSBarry Smith     PetscCall(ISRestoreIndices(is, &ptr));
1246b07dfdedSPierre Jolivet     size /= bs;
1247f1580f4eSBarry Smith     if (out_C) {
1248f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1249f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.second;
1250f1580f4eSBarry Smith       concatenate -= size;
1251b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_C), bs, size, concatenate, PETSC_OWN_POINTER, &perm));
1252f1580f4eSBarry Smith       PetscCall(ISSetPermutation(perm));
1253f1580f4eSBarry Smith       /* permute user-provided Mat so that it matches with MatCreateSubMatrices() numbering */
1254f1580f4eSBarry Smith       PetscCall(MatPermute(in_C, perm, perm, out_C));
1255f1580f4eSBarry Smith       if (p) *p = perm;
1256f1580f4eSBarry Smith       else PetscCall(ISDestroy(&perm)); /* no need to save the permutation */
1257f1580f4eSBarry Smith     }
1258f1580f4eSBarry Smith     if (out_is) {
1259f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1260f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.first;
1261f1580f4eSBarry Smith       concatenate -= size;
1262f1580f4eSBarry Smith       /* permute user-provided IS so that it matches with MatCreateSubMatrices() numbering */
1263b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_is), bs, size, concatenate, PETSC_OWN_POINTER, out_is));
1264f1580f4eSBarry Smith     }
1265f1580f4eSBarry Smith   } else { /* input IS is sorted, nothing to permute, simply duplicate inputs when needed */
1266f1580f4eSBarry Smith     if (out_C) PetscCall(MatDuplicate(in_C, MAT_COPY_VALUES, out_C));
1267f1580f4eSBarry Smith     if (out_is) PetscCall(ISDuplicate(in_is, out_is));
1268f1580f4eSBarry Smith   }
12693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1270f1580f4eSBarry Smith }
1271f1580f4eSBarry Smith 
1272281f8ce6SPierre Jolivet static PetscErrorCode PCHPDDMCheckSymmetry_Private(PC pc, Mat A01, Mat A10, Mat *B01 = nullptr)
127313044ca3SPierre Jolivet {
127413044ca3SPierre Jolivet   Mat       T, U = nullptr, B = nullptr;
127513044ca3SPierre Jolivet   IS        z;
1276281f8ce6SPierre Jolivet   PetscBool flg, conjugate = PETSC_FALSE;
127713044ca3SPierre Jolivet 
127813044ca3SPierre Jolivet   PetscFunctionBegin;
1279281f8ce6SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
1280281f8ce6SPierre Jolivet   if (B01) *B01 = nullptr;
1281281f8ce6SPierre Jolivet   if (flg) {
1282811e8887SPierre 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));
1283811e8887SPierre Jolivet     PetscCall(MatTransposeGetMat(A10, &U));
1284811e8887SPierre Jolivet   } else {
1285281f8ce6SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
1286281f8ce6SPierre Jolivet     if (flg) {
1287811e8887SPierre 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));
1288811e8887SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A10, &U));
1289281f8ce6SPierre Jolivet       conjugate = PETSC_TRUE;
1290811e8887SPierre Jolivet     }
129113044ca3SPierre Jolivet   }
129213044ca3SPierre Jolivet   if (U) PetscCall(MatDuplicate(U, MAT_COPY_VALUES, &T));
129313044ca3SPierre Jolivet   else PetscCall(MatHermitianTranspose(A10, MAT_INITIAL_MATRIX, &T));
1294281f8ce6SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATTRANSPOSEVIRTUAL, &flg));
1295281f8ce6SPierre Jolivet   if (flg) {
1296811e8887SPierre 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));
129713044ca3SPierre Jolivet     PetscCall(MatTransposeGetMat(A01, &A01));
129813044ca3SPierre Jolivet     PetscCall(MatTranspose(A01, MAT_INITIAL_MATRIX, &B));
129913044ca3SPierre Jolivet     A01 = B;
130013044ca3SPierre Jolivet   } else {
1301281f8ce6SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
1302281f8ce6SPierre Jolivet     if (flg) {
1303811e8887SPierre 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));
130413044ca3SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A01, &A01));
130513044ca3SPierre Jolivet       PetscCall(MatHermitianTranspose(A01, MAT_INITIAL_MATRIX, &B));
130613044ca3SPierre Jolivet       A01 = B;
130713044ca3SPierre Jolivet     }
130813044ca3SPierre Jolivet   }
1309281f8ce6SPierre Jolivet   PetscCall(PetscLayoutCompare(T->rmap, A01->rmap, &flg));
1310281f8ce6SPierre Jolivet   if (flg) {
1311281f8ce6SPierre Jolivet     PetscCall(PetscLayoutCompare(T->cmap, A01->cmap, &flg));
1312281f8ce6SPierre Jolivet     if (flg) {
131313044ca3SPierre Jolivet       PetscCall(MatFindZeroRows(A01, &z)); /* for essential boundary conditions, some implementations will */
131413044ca3SPierre Jolivet       if (z) {                             /*  zero rows in [P00 A01] except for the diagonal of P00       */
1315281f8ce6SPierre Jolivet         if (B01) PetscCall(MatDuplicate(T, MAT_COPY_VALUES, B01));
131613044ca3SPierre Jolivet         PetscCall(MatSetOption(T, MAT_NO_OFF_PROC_ZERO_ROWS, PETSC_TRUE));
131713044ca3SPierre Jolivet         PetscCall(MatZeroRowsIS(T, z, 0.0, nullptr, nullptr)); /* corresponding zero rows from A01 */
1318281f8ce6SPierre Jolivet       }
1319281f8ce6SPierre Jolivet       PetscCall(MatMultEqual(A01, T, 20, &flg));
1320281f8ce6SPierre Jolivet       if (!B01) PetscCheck(flg, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "A01 != A10^T");
1321281f8ce6SPierre Jolivet       else {
1322281f8ce6SPierre Jolivet         PetscCall(PetscInfo(pc, "A01 and A10^T are equal? %s\n", PetscBools[flg]));
1323281f8ce6SPierre Jolivet         if (!flg) {
1324281f8ce6SPierre Jolivet           if (z) PetscCall(MatDestroy(&T));
1325281f8ce6SPierre Jolivet           else *B01 = T;
1326281f8ce6SPierre Jolivet           flg = PETSC_TRUE;
1327281f8ce6SPierre Jolivet         } else PetscCall(MatDestroy(B01));
1328281f8ce6SPierre Jolivet       }
132913044ca3SPierre Jolivet       PetscCall(ISDestroy(&z));
133013044ca3SPierre Jolivet     }
133113044ca3SPierre Jolivet   }
1332281f8ce6SPierre Jolivet   if (!flg) PetscCall(PetscInfo(pc, "A01 and A10^T have non-congruent layouts, cannot test for equality\n"));
1333281f8ce6SPierre Jolivet   if (!B01 || !*B01) PetscCall(MatDestroy(&T));
1334281f8ce6SPierre Jolivet   else if (conjugate) PetscCall(MatConjugate(T));
133513044ca3SPierre Jolivet   PetscCall(MatDestroy(&B));
133613044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
133713044ca3SPierre Jolivet }
133813044ca3SPierre Jolivet 
1339d16c0b94SPierre Jolivet static PetscErrorCode PCHPDDMCheckInclusion_Private(PC pc, IS is, IS is_local, PetscBool check)
1340d16c0b94SPierre Jolivet {
1341d16c0b94SPierre Jolivet   IS          intersect;
1342d16c0b94SPierre Jolivet   const char *str = "IS of the auxiliary Mat does not include all local rows of A";
1343d16c0b94SPierre Jolivet   PetscBool   equal;
1344d16c0b94SPierre Jolivet 
1345d16c0b94SPierre Jolivet   PetscFunctionBegin;
1346d16c0b94SPierre Jolivet   PetscCall(ISIntersect(is, is_local, &intersect));
1347d16c0b94SPierre Jolivet   PetscCall(ISEqualUnsorted(is_local, intersect, &equal));
1348d16c0b94SPierre Jolivet   PetscCall(ISDestroy(&intersect));
1349d16c0b94SPierre Jolivet   if (check) PetscCheck(equal, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "%s", str);
1350d16c0b94SPierre Jolivet   else if (!equal) PetscCall(PetscInfo(pc, "%s\n", str));
1351d16c0b94SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1352d16c0b94SPierre Jolivet }
1353d16c0b94SPierre Jolivet 
1354d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMDestroySubMatrices_Private(PetscBool flg, PetscBool algebraic, Mat *sub)
1355d71ae5a4SJacob Faibussowitsch {
1356f1580f4eSBarry Smith   IS is;
1357f1580f4eSBarry Smith 
1358f1580f4eSBarry Smith   PetscFunctionBegin;
1359f1580f4eSBarry Smith   if (!flg) {
1360f1580f4eSBarry Smith     if (algebraic) {
1361f1580f4eSBarry Smith       PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Embed", (PetscObject *)&is));
1362f1580f4eSBarry Smith       PetscCall(ISDestroy(&is));
1363db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Embed", nullptr));
1364db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Compact", nullptr));
1365f1580f4eSBarry Smith     }
1366f1580f4eSBarry Smith     PetscCall(MatDestroySubMatrices(algebraic ? 2 : 1, &sub));
1367f1580f4eSBarry Smith   }
13683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1369f1580f4eSBarry Smith }
1370f1580f4eSBarry Smith 
1371d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMAlgebraicAuxiliaryMat_Private(Mat P, IS *is, Mat *sub[], PetscBool block)
1372d71ae5a4SJacob Faibussowitsch {
1373f1580f4eSBarry Smith   IS         icol[3], irow[2];
1374f1580f4eSBarry Smith   Mat       *M, Q;
1375f1580f4eSBarry Smith   PetscReal *ptr;
137658b7e2c1SStefano Zampini   PetscInt  *idx, p = 0, bs = P->cmap->bs;
1377f1580f4eSBarry Smith   PetscBool  flg;
1378f1580f4eSBarry Smith 
1379f1580f4eSBarry Smith   PetscFunctionBegin;
1380f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, P->cmap->N, 0, 1, icol + 2));
1381f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(icol[2], bs));
1382f1580f4eSBarry Smith   PetscCall(ISSetIdentity(icol[2]));
1383f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1384f1580f4eSBarry Smith   if (flg) {
1385f1580f4eSBarry Smith     /* MatCreateSubMatrices() does not handle MATMPISBAIJ properly when iscol != isrow, so convert first to MATMPIBAIJ */
1386f1580f4eSBarry Smith     PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &Q));
1387f1580f4eSBarry Smith     std::swap(P, Q);
1388f1580f4eSBarry Smith   }
1389f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(P, 1, is, icol + 2, MAT_INITIAL_MATRIX, &M));
1390f1580f4eSBarry Smith   if (flg) {
1391f1580f4eSBarry Smith     std::swap(P, Q);
1392f1580f4eSBarry Smith     PetscCall(MatDestroy(&Q));
1393f1580f4eSBarry Smith   }
1394f1580f4eSBarry Smith   PetscCall(ISDestroy(icol + 2));
1395f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, M[0]->rmap->N, 0, 1, irow));
1396f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(irow[0], bs));
1397f1580f4eSBarry Smith   PetscCall(ISSetIdentity(irow[0]));
1398f1580f4eSBarry Smith   if (!block) {
1399b07dfdedSPierre Jolivet     PetscCall(PetscMalloc2(P->cmap->N, &ptr, P->cmap->N / bs, &idx));
1400f1580f4eSBarry Smith     PetscCall(MatGetColumnNorms(M[0], NORM_INFINITY, ptr));
1401f1580f4eSBarry Smith     /* check for nonzero columns so that M[0] may be expressed in compact form */
1402811e8887SPierre Jolivet     for (PetscInt n = 0; n < P->cmap->N; n += bs) {
1403b07dfdedSPierre Jolivet       if (std::find_if(ptr + n, ptr + n + bs, [](PetscReal v) { return v > PETSC_MACHINE_EPSILON; }) != ptr + n + bs) idx[p++] = n / bs;
1404f1580f4eSBarry Smith     }
1405b07dfdedSPierre Jolivet     PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, p, idx, PETSC_USE_POINTER, icol + 1));
1406f1580f4eSBarry Smith     PetscCall(ISSetInfo(icol[1], IS_SORTED, IS_GLOBAL, PETSC_TRUE, PETSC_TRUE));
1407f1580f4eSBarry Smith     PetscCall(ISEmbed(*is, icol[1], PETSC_FALSE, icol + 2));
1408f1580f4eSBarry Smith     irow[1] = irow[0];
1409f1580f4eSBarry 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 */
1410f1580f4eSBarry Smith     icol[0] = is[0];
1411f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 2, irow, icol, MAT_INITIAL_MATRIX, sub));
1412f1580f4eSBarry Smith     PetscCall(ISDestroy(icol + 1));
1413f1580f4eSBarry Smith     PetscCall(PetscFree2(ptr, idx));
1414f1580f4eSBarry Smith     /* IS used to go back and forth between the augmented and the original local linear system, see eq. (3.4) of [2022b] */
1415f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Embed", (PetscObject)icol[2]));
1416f1580f4eSBarry Smith     /* Mat used in eq. (3.1) of [2022b] */
1417f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Compact", (PetscObject)(*sub)[1]));
1418f1580f4eSBarry Smith   } else {
1419f1580f4eSBarry Smith     Mat aux;
1420811e8887SPierre Jolivet 
1421f1580f4eSBarry Smith     PetscCall(MatSetOption(M[0], MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1422f1580f4eSBarry Smith     /* diagonal block of the overlapping rows */
1423f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 1, irow, is, MAT_INITIAL_MATRIX, sub));
1424f1580f4eSBarry Smith     PetscCall(MatDuplicate((*sub)[0], MAT_COPY_VALUES, &aux));
1425f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1426f1580f4eSBarry Smith     if (bs == 1) { /* scalar case */
1427f1580f4eSBarry Smith       Vec sum[2];
1428811e8887SPierre Jolivet 
1429f1580f4eSBarry Smith       PetscCall(MatCreateVecs(aux, sum, sum + 1));
1430f1580f4eSBarry Smith       PetscCall(MatGetRowSum(M[0], sum[0]));
1431f1580f4eSBarry Smith       PetscCall(MatGetRowSum(aux, sum[1]));
1432f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1433f1580f4eSBarry Smith       PetscCall(VecAXPY(sum[0], -1.0, sum[1]));
1434f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1435f1580f4eSBarry Smith       PetscCall(MatDiagonalSet(aux, sum[0], ADD_VALUES));
1436f1580f4eSBarry Smith       PetscCall(VecDestroy(sum));
1437f1580f4eSBarry Smith       PetscCall(VecDestroy(sum + 1));
1438f1580f4eSBarry Smith     } else { /* vectorial case */
1439f1580f4eSBarry Smith       /* TODO: missing MatGetValuesBlocked(), so the code below is     */
1440f1580f4eSBarry Smith       /* an extension of the scalar case for when bs > 1, but it could */
1441f1580f4eSBarry Smith       /* be more efficient by avoiding all these MatMatMult()          */
1442f1580f4eSBarry Smith       Mat          sum[2], ones;
1443f1580f4eSBarry Smith       PetscScalar *ptr;
1444811e8887SPierre Jolivet 
1445f1580f4eSBarry Smith       PetscCall(PetscCalloc1(M[0]->cmap->n * bs, &ptr));
1446f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, M[0]->cmap->n, bs, M[0]->cmap->n, bs, ptr, &ones));
1447811e8887SPierre Jolivet       for (PetscInt n = 0; n < M[0]->cmap->n; n += bs) {
1448f1580f4eSBarry Smith         for (p = 0; p < bs; ++p) ptr[n + p * (M[0]->cmap->n + 1)] = 1.0;
1449f1580f4eSBarry Smith       }
1450fb842aefSJose E. Roman       PetscCall(MatMatMult(M[0], ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum));
1451f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1452f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, aux->cmap->n, bs, aux->cmap->n, bs, ptr, &ones));
1453f1580f4eSBarry Smith       PetscCall(MatDenseSetLDA(ones, M[0]->cmap->n));
1454fb842aefSJose E. Roman       PetscCall(MatMatMult(aux, ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum + 1));
1455f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1456f1580f4eSBarry Smith       PetscCall(PetscFree(ptr));
1457f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1458f1580f4eSBarry Smith       PetscCall(MatAXPY(sum[0], -1.0, sum[1], SAME_NONZERO_PATTERN));
1459f1580f4eSBarry Smith       PetscCall(MatDestroy(sum + 1));
1460f1580f4eSBarry Smith       /* re-order values to be consistent with MatSetValuesBlocked()           */
1461f1580f4eSBarry Smith       /* equivalent to MatTranspose() which does not truly handle              */
1462f1580f4eSBarry Smith       /* MAT_INPLACE_MATRIX in the rectangular case, as it calls PetscMalloc() */
1463f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(sum[0], &ptr));
1464f1580f4eSBarry Smith       HPDDM::Wrapper<PetscScalar>::imatcopy<'T'>(bs, sum[0]->rmap->n, ptr, sum[0]->rmap->n, bs);
1465f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1466811e8887SPierre Jolivet       for (PetscInt n = 0; n < aux->cmap->n / bs; ++n) PetscCall(MatSetValuesBlocked(aux, 1, &n, 1, &n, ptr + n * bs * bs, ADD_VALUES));
1467f1580f4eSBarry Smith       PetscCall(MatAssemblyBegin(aux, MAT_FINAL_ASSEMBLY));
1468f1580f4eSBarry Smith       PetscCall(MatAssemblyEnd(aux, MAT_FINAL_ASSEMBLY));
1469f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(sum[0], &ptr));
1470f1580f4eSBarry Smith       PetscCall(MatDestroy(sum));
1471f1580f4eSBarry Smith     }
1472f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
1473f1580f4eSBarry Smith     /* left-hand side of GenEO, with the same sparsity pattern as PCASM subdomain solvers  */
1474f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Neumann_Mat", (PetscObject)aux));
1475f1580f4eSBarry Smith   }
1476f1580f4eSBarry Smith   PetscCall(ISDestroy(irow));
1477f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &M));
14783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1479f1580f4eSBarry Smith }
1480f1580f4eSBarry Smith 
148113044ca3SPierre Jolivet static PetscErrorCode PCApply_Nest(PC pc, Vec x, Vec y)
148213044ca3SPierre Jolivet {
148313044ca3SPierre Jolivet   Mat                    A;
148413044ca3SPierre Jolivet   MatSolverType          type;
148513044ca3SPierre Jolivet   IS                     is[2];
148613044ca3SPierre Jolivet   PetscBool              flg;
148713044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
148813044ca3SPierre Jolivet 
148913044ca3SPierre Jolivet   PetscFunctionBegin;
149013044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
149151ea4bc8SPierre Jolivet   if (p->second[0]) { /* in case of a centralized Schur complement, some processes may have no local operator */
149213044ca3SPierre Jolivet     PetscCall(PCGetOperators(p->first, &A, nullptr));
149313044ca3SPierre Jolivet     PetscCall(MatNestGetISs(A, is, nullptr));
149451ea4bc8SPierre Jolivet     PetscCall(PetscObjectTypeCompareAny((PetscObject)p->first, &flg, PCLU, PCCHOLESKY, ""));
149551ea4bc8SPierre Jolivet     if (flg) { /* partial solve currently only makes sense with exact factorizations */
149613044ca3SPierre Jolivet       PetscCall(PCFactorGetMatSolverType(p->first, &type));
149713044ca3SPierre Jolivet       PetscCall(PCFactorGetMatrix(p->first, &A));
149851ea4bc8SPierre Jolivet       if (A->schur) {
149913044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
150051ea4bc8SPierre Jolivet         if (flg) PetscCall(MatMumpsSetIcntl(A, 26, 1)); /* reduction/condensation phase followed by Schur complement solve */
150151ea4bc8SPierre Jolivet       } else flg = PETSC_FALSE;
150213044ca3SPierre Jolivet     }
150313044ca3SPierre Jolivet     PetscCall(VecISCopy(p->second[0], is[1], SCATTER_FORWARD, x)); /* assign the RHS associated to the Schur complement */
150413044ca3SPierre Jolivet     PetscCall(PCApply(p->first, p->second[0], p->second[1]));
150513044ca3SPierre Jolivet     PetscCall(VecISCopy(p->second[1], is[1], SCATTER_REVERSE, y)); /* retrieve the partial solution associated to the Schur complement */
150679578405SBarry Smith     if (flg) PetscCall(MatMumpsSetIcntl(A, 26, -1));               /* default ICNTL(26) value in PETSc */
150713044ca3SPierre Jolivet   }
150813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
150913044ca3SPierre Jolivet }
151013044ca3SPierre Jolivet 
151113044ca3SPierre Jolivet static PetscErrorCode PCView_Nest(PC pc, PetscViewer viewer)
151213044ca3SPierre Jolivet {
151313044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
151413044ca3SPierre Jolivet 
151513044ca3SPierre Jolivet   PetscFunctionBegin;
151613044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
151713044ca3SPierre Jolivet   PetscCall(PCView(p->first, viewer));
151813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
151913044ca3SPierre Jolivet }
152013044ca3SPierre Jolivet 
152113044ca3SPierre Jolivet static PetscErrorCode PCDestroy_Nest(PC pc)
152213044ca3SPierre Jolivet {
152313044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
152413044ca3SPierre Jolivet 
152513044ca3SPierre Jolivet   PetscFunctionBegin;
152613044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
152713044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second));
152813044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second + 1));
152913044ca3SPierre Jolivet   PetscCall(PCDestroy(&p->first));
153013044ca3SPierre Jolivet   PetscCall(PetscFree(p));
153113044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
153213044ca3SPierre Jolivet }
153313044ca3SPierre Jolivet 
153413044ca3SPierre Jolivet template <bool T = false>
153513044ca3SPierre Jolivet static PetscErrorCode MatMult_Schur(Mat A, Vec x, Vec y)
153613044ca3SPierre Jolivet {
153701e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
153813044ca3SPierre Jolivet 
153913044ca3SPierre Jolivet   PetscFunctionBegin;
154013044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
154113044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD)); /* local Vec with overlap */
154213044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD));
154313044ca3SPierre Jolivet   if (!T) PetscCall(MatMult(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1])); /* local Schur complement */
154413044ca3SPierre Jolivet   else PetscCall(MatMultTranspose(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1]));
154513044ca3SPierre Jolivet   PetscCall(VecSet(y, 0.0));
154613044ca3SPierre 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 */
154713044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE));
154813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
154913044ca3SPierre Jolivet }
155013044ca3SPierre Jolivet 
155113044ca3SPierre Jolivet static PetscErrorCode MatDestroy_Schur(Mat A)
155213044ca3SPierre Jolivet {
155301e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
155413044ca3SPierre Jolivet 
155513044ca3SPierre Jolivet   PetscFunctionBegin;
155613044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
155713044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx)));
155813044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx) + 1));
155913044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
156013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
156113044ca3SPierre Jolivet }
156213044ca3SPierre Jolivet 
156313044ca3SPierre Jolivet static PetscErrorCode MatMult_SchurCorrection(Mat A, Vec x, Vec y)
156413044ca3SPierre Jolivet {
156513044ca3SPierre Jolivet   PC                                         pc;
156613044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
156713044ca3SPierre Jolivet 
156813044ca3SPierre Jolivet   PetscFunctionBegin;
156913044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
157013044ca3SPierre Jolivet   pc = ((PC_HPDDM *)std::get<0>(*ctx)[0]->data)->levels[0]->ksp->pc;
157113044ca3SPierre 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 */
157213044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], x, std::get<3>(*ctx)[1]));                    /*     A_01 x                 */
157313044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 x             */
157413044ca3SPierre 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        */
157513044ca3SPierre 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 */
157613044ca3SPierre Jolivet   } else {
157713044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[0]));                    /*     M_S^-1 x               */
157813044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], std::get<3>(*ctx)[0], std::get<3>(*ctx)[1])); /*     A_01 M_S^-1 x          */
157913044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 M_S^-1 x      */
158013044ca3SPierre 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 */
158113044ca3SPierre Jolivet   }
158213044ca3SPierre Jolivet   PetscCall(VecAXPY(y, -1.0, x)); /* y -= x, preconditioned eq. (24) of https://hal.science/hal-02343808v6/document (with a sign flip) */
158313044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
158413044ca3SPierre Jolivet }
158513044ca3SPierre Jolivet 
158613044ca3SPierre Jolivet static PetscErrorCode MatView_SchurCorrection(Mat A, PetscViewer viewer)
158713044ca3SPierre Jolivet {
158813044ca3SPierre Jolivet   PetscBool                                  ascii;
158913044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
159013044ca3SPierre Jolivet 
159113044ca3SPierre Jolivet   PetscFunctionBegin;
159213044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &ascii));
159313044ca3SPierre Jolivet   if (ascii) {
159413044ca3SPierre Jolivet     PetscCall(MatShellGetContext(A, &ctx));
159513044ca3SPierre 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)"));
159613044ca3SPierre Jolivet     PetscCall(PCView(std::get<0>(*ctx)[1], viewer)); /* no need to PCView(Q_0) since it will be done by PCFIELDSPLIT */
159713044ca3SPierre Jolivet   }
159813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
159913044ca3SPierre Jolivet }
160013044ca3SPierre Jolivet 
160113044ca3SPierre Jolivet static PetscErrorCode MatDestroy_SchurCorrection(Mat A)
160213044ca3SPierre Jolivet {
160313044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
160413044ca3SPierre Jolivet 
160513044ca3SPierre Jolivet   PetscFunctionBegin;
160613044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
160713044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx)));
160813044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 1));
160913044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 2));
161013044ca3SPierre Jolivet   PetscCall(PCDestroy(std::get<0>(*ctx) + 1));
161113044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
161213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
161313044ca3SPierre Jolivet }
161413044ca3SPierre Jolivet 
1615feebddf4SPierre Jolivet static PetscErrorCode PCPostSolve_SchurPreLeastSquares(PC, KSP, Vec, Vec x)
1616feebddf4SPierre Jolivet {
1617feebddf4SPierre Jolivet   PetscFunctionBegin;
1618feebddf4SPierre Jolivet   PetscCall(VecScale(x, -1.0));
1619feebddf4SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1620feebddf4SPierre Jolivet }
1621feebddf4SPierre Jolivet 
162213044ca3SPierre Jolivet static PetscErrorCode KSPPreSolve_SchurCorrection(KSP, Vec b, Vec, void *context)
162313044ca3SPierre Jolivet {
162413044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
162513044ca3SPierre Jolivet 
1626a6b3e571SPierre Jolivet   PetscFunctionBegin;
162713044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
162813044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], b, std::get<3>(*ctx)[2]));
162913044ca3SPierre 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 */
163013044ca3SPierre Jolivet   }
163113044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
163213044ca3SPierre Jolivet }
163313044ca3SPierre Jolivet 
163413044ca3SPierre Jolivet static PetscErrorCode KSPPostSolve_SchurCorrection(KSP, Vec b, Vec x, void *context)
163513044ca3SPierre Jolivet {
163613044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
163713044ca3SPierre Jolivet 
1638a6b3e571SPierre Jolivet   PetscFunctionBegin;
163913044ca3SPierre 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 */
164013044ca3SPierre Jolivet   else {
164113044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[2]));
164213044ca3SPierre Jolivet     PetscCall(VecCopy(std::get<3>(*ctx)[2], x)); /* replace x by M^-1 x */
164313044ca3SPierre Jolivet   }
164413044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
164513044ca3SPierre Jolivet }
164613044ca3SPierre Jolivet 
16479bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat, Vec, Vec);
16489bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat, Vec, Vec);
16499bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat, Mat, Mat, void *);
16509bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat);
16519bb5c669SPierre Jolivet 
1652d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDM(PC pc)
1653d71ae5a4SJacob Faibussowitsch {
1654f1580f4eSBarry Smith   PC_HPDDM                                  *data = (PC_HPDDM *)pc->data;
1655f1580f4eSBarry Smith   PC                                         inner;
1656f1580f4eSBarry Smith   KSP                                       *ksp;
165713044ca3SPierre Jolivet   Mat                                       *sub, A, P, N, C = nullptr, uaux = nullptr, weighted, subA[2], S;
1658f1580f4eSBarry Smith   Vec                                        xin, v;
1659f1580f4eSBarry Smith   std::vector<Vec>                           initial;
1660db4a47b3SPierre Jolivet   IS                                         is[1], loc, uis = data->is, unsorted = nullptr;
1661f1580f4eSBarry Smith   ISLocalToGlobalMapping                     l2g;
1662f1580f4eSBarry Smith   char                                       prefix[256];
1663f1580f4eSBarry Smith   const char                                *pcpre;
1664f1580f4eSBarry Smith   const PetscScalar *const                  *ev;
16659bb5c669SPierre Jolivet   PetscInt                                   n, requested = data->N, reused = 0, overlap = -1;
1666f1580f4eSBarry Smith   MatStructure                               structure  = UNKNOWN_NONZERO_PATTERN;
1667f1580f4eSBarry Smith   PetscBool                                  subdomains = PETSC_FALSE, flg = PETSC_FALSE, ismatis, swap = PETSC_FALSE, algebraic = PETSC_FALSE, block = PETSC_FALSE;
1668f1580f4eSBarry Smith   DM                                         dm;
166913044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = nullptr;
1670398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1671db4a47b3SPierre Jolivet   IS  dis  = nullptr;
1672db4a47b3SPierre Jolivet   Mat daux = nullptr;
1673398c7888SPierre Jolivet #endif
1674f1580f4eSBarry Smith 
1675f1580f4eSBarry Smith   PetscFunctionBegin;
1676f1580f4eSBarry Smith   PetscCheck(data->levels && data->levels[0], PETSC_COMM_SELF, PETSC_ERR_PLIB, "Not a single level allocated");
1677f1580f4eSBarry Smith   PetscCall(PCGetOptionsPrefix(pc, &pcpre));
1678f1580f4eSBarry Smith   PetscCall(PCGetOperators(pc, &A, &P));
1679f1580f4eSBarry Smith   if (!data->levels[0]->ksp) {
1680f1580f4eSBarry Smith     PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->ksp));
16813821be0aSBarry Smith     PetscCall(KSPSetNestLevel(data->levels[0]->ksp, pc->kspnestlevel));
1682f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_%s_", pcpre ? pcpre : "", data->N > 1 ? "levels_1" : "coarse"));
1683f1580f4eSBarry Smith     PetscCall(KSPSetOptionsPrefix(data->levels[0]->ksp, prefix));
1684f1580f4eSBarry Smith     PetscCall(KSPSetType(data->levels[0]->ksp, KSPPREONLY));
1685371d2eb7SMartin Diehl   } else if (data->levels[0]->ksp->pc && data->levels[0]->ksp->pc->setupcalled && data->levels[0]->ksp->pc->reusepreconditioner) {
1686f1580f4eSBarry Smith     /* if the fine-level PCSHELL exists, its setup has succeeded, and one wants to reuse it, */
1687f1580f4eSBarry Smith     /* then just propagate the appropriate flag to the coarser levels                        */
1688f1580f4eSBarry Smith     for (n = 0; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1689f1580f4eSBarry Smith       /* the following KSP and PC may be NULL for some processes, hence the check            */
1690f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetReusePreconditioner(data->levels[n]->ksp, PETSC_TRUE));
1691f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
1692f1580f4eSBarry Smith     }
1693f1580f4eSBarry Smith     /* early bail out because there is nothing to do */
16943ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1695f1580f4eSBarry Smith   } else {
1696f1580f4eSBarry Smith     /* reset coarser levels */
1697f1580f4eSBarry Smith     for (n = 1; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1698371d2eb7SMartin 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) {
1699f1580f4eSBarry Smith         reused = data->N - n;
1700f1580f4eSBarry Smith         break;
1701f1580f4eSBarry Smith       }
1702f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[n]->ksp));
1703f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[n]->pc));
1704f1580f4eSBarry Smith     }
1705f1580f4eSBarry Smith     /* check if some coarser levels are being reused */
1706462c564dSBarry Smith     PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &reused, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)pc)));
1707f1580f4eSBarry Smith     const int *addr = data->levels[0]->P ? data->levels[0]->P->getAddrLocal() : &HPDDM::i__0;
1708f1580f4eSBarry Smith 
1709f1580f4eSBarry Smith     if (addr != &HPDDM::i__0 && reused != data->N - 1) {
1710f1580f4eSBarry Smith       /* reuse previously computed eigenvectors */
1711f1580f4eSBarry Smith       ev = data->levels[0]->P->getVectors();
1712f1580f4eSBarry Smith       if (ev) {
1713f1580f4eSBarry Smith         initial.reserve(*addr);
1714f1580f4eSBarry Smith         PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, data->levels[0]->P->getDof(), ev[0], &xin));
1715f1580f4eSBarry Smith         for (n = 0; n < *addr; ++n) {
1716f1580f4eSBarry Smith           PetscCall(VecDuplicate(xin, &v));
1717f1580f4eSBarry Smith           PetscCall(VecPlaceArray(xin, ev[n]));
1718f1580f4eSBarry Smith           PetscCall(VecCopy(xin, v));
1719f1580f4eSBarry Smith           initial.emplace_back(v);
1720f1580f4eSBarry Smith           PetscCall(VecResetArray(xin));
1721f1580f4eSBarry Smith         }
1722f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
1723f1580f4eSBarry Smith       }
1724f1580f4eSBarry Smith     }
1725f1580f4eSBarry Smith   }
1726f1580f4eSBarry Smith   data->N -= reused;
1727f1580f4eSBarry Smith   PetscCall(KSPSetOperators(data->levels[0]->ksp, A, P));
1728f1580f4eSBarry Smith 
1729f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATIS, &ismatis));
1730f1580f4eSBarry Smith   if (!data->is && !ismatis) {
1731db4a47b3SPierre Jolivet     PetscErrorCode (*create)(DM, IS *, Mat *, PetscErrorCode (**)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void **) = nullptr;
1732db4a47b3SPierre Jolivet     PetscErrorCode (*usetup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *)                                                = nullptr;
1733db4a47b3SPierre Jolivet     void *uctx                                                                                                               = nullptr;
1734f1580f4eSBarry Smith 
1735f1580f4eSBarry Smith     /* first see if we can get the data from the DM */
1736f1580f4eSBarry Smith     PetscCall(MatGetDM(P, &dm));
1737f1580f4eSBarry Smith     if (!dm) PetscCall(MatGetDM(A, &dm));
1738f1580f4eSBarry Smith     if (!dm) PetscCall(PCGetDM(pc, &dm));
1739907a3e9cSStefano Zampini     if (dm) { /* this is the hook for DMPLEX for which the auxiliary Mat is the local Neumann matrix */
1740f1580f4eSBarry Smith       PetscCall(PetscObjectQueryFunction((PetscObject)dm, "DMCreateNeumannOverlap_C", &create));
1741f1580f4eSBarry Smith       if (create) {
1742f1580f4eSBarry Smith         PetscCall((*create)(dm, &uis, &uaux, &usetup, &uctx));
1743c8ea6600SPierre 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 */
1744f1580f4eSBarry Smith       }
1745f1580f4eSBarry Smith     }
1746f1580f4eSBarry Smith     if (!create) {
1747f1580f4eSBarry Smith       if (!uis) {
1748f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1749f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1750f1580f4eSBarry Smith       }
1751f1580f4eSBarry Smith       if (!uaux) {
1752f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1753f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1754f1580f4eSBarry Smith       }
1755f1580f4eSBarry Smith       /* look inside the Pmat instead of the PC, needed for MatSchurComplementComputeExplicitOperator() */
1756f1580f4eSBarry Smith       if (!uis) {
1757f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1758f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1759f1580f4eSBarry Smith       }
1760f1580f4eSBarry Smith       if (!uaux) {
1761f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1762f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1763f1580f4eSBarry Smith       }
1764f1580f4eSBarry Smith     }
1765f1580f4eSBarry Smith     PetscCall(PCHPDDMSetAuxiliaryMat(pc, uis, uaux, usetup, uctx));
1766f1580f4eSBarry Smith     PetscCall(MatDestroy(&uaux));
1767f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
1768f1580f4eSBarry Smith   }
1769f1580f4eSBarry Smith 
1770f1580f4eSBarry Smith   if (!ismatis) {
1771f1580f4eSBarry Smith     PetscCall(PCHPDDMSetUpNeumannOverlap_Private(pc));
1772db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_block_splitting", &block, nullptr));
17739bb5c669SPierre Jolivet     PetscCall(PetscOptionsGetInt(nullptr, pcpre, "-pc_hpddm_harmonic_overlap", &overlap, nullptr));
17745e642048SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
177551ea4bc8SPierre Jolivet     if (data->is || flg) {
17769bb5c669SPierre Jolivet       if (block || overlap != -1) {
177702800ff6SPierre Jolivet         PetscCall(ISDestroy(&data->is));
177802800ff6SPierre Jolivet         PetscCall(MatDestroy(&data->aux));
177951ea4bc8SPierre Jolivet       } else if (flg) {
178013044ca3SPierre Jolivet         PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_GENEO;
178113044ca3SPierre Jolivet 
178213044ca3SPierre Jolivet         PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
178313044ca3SPierre Jolivet         if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
178413044ca3SPierre Jolivet           PetscCall(ISDestroy(&data->is)); /* destroy any previously user-set objects since they will be set automatically */
178513044ca3SPierre Jolivet           PetscCall(MatDestroy(&data->aux));
178613044ca3SPierre Jolivet         } else if (type == PC_HPDDM_SCHUR_PRE_GENEO) {
178713044ca3SPierre Jolivet           PetscContainer container = nullptr;
178813044ca3SPierre Jolivet 
178913044ca3SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Schur", (PetscObject *)&container));
179013044ca3SPierre Jolivet           if (!container) { /* first call to PCSetUp() on the PC associated to the Schur complement */
179113044ca3SPierre Jolivet             PC_HPDDM       *data_00;
179213044ca3SPierre Jolivet             KSP             ksp, inner_ksp;
179313044ca3SPierre Jolivet             PC              pc_00;
1794cf67ef9dSPierre Jolivet             Mat             A11 = nullptr;
1795cf67ef9dSPierre Jolivet             Vec             d   = nullptr;
179651ea4bc8SPierre Jolivet             const PetscInt *ranges;
179751ea4bc8SPierre Jolivet             PetscMPIInt     size;
179813044ca3SPierre Jolivet             char           *prefix;
179913044ca3SPierre Jolivet 
180013044ca3SPierre Jolivet             PetscCall(MatSchurComplementGetKSP(P, &ksp));
180113044ca3SPierre Jolivet             PetscCall(KSPGetPC(ksp, &pc_00));
180213044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)pc_00, PCHPDDM, &flg));
1803fd310a01SPierre 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 : "",
180413044ca3SPierre Jolivet                        ((PetscObject)pc_00)->type_name, PCHPDDM);
180513044ca3SPierre Jolivet             data_00 = (PC_HPDDM *)pc_00->data;
1806fd310a01SPierre 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],
1807fd310a01SPierre Jolivet                        data_00->N, data_00->N > 1 ? "s" : "", ((PetscObject)pc_00)->prefix);
180851ea4bc8SPierre 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() : "");
180913044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)data_00->levels[0]->pc, PCASM, &flg));
1810fd310a01SPierre 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,
181113044ca3SPierre Jolivet                        ((PetscObject)data_00->levels[0]->pc)->type_name, PCASM);
181251ea4bc8SPierre 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)  */
1813d16c0b94SPierre Jolivet             PetscCall(MatSchurComplementGetSubMatrices(P, nullptr, nullptr, nullptr, nullptr, &A11));
181451ea4bc8SPierre Jolivet             PetscCall(MatGetOwnershipRanges(A11, &ranges));
181551ea4bc8SPierre Jolivet             PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A11), &size));
181651ea4bc8SPierre 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)? */
181751ea4bc8SPierre Jolivet             if (!flg) {
18185e642048SPierre Jolivet               if (PetscDefined(USE_DEBUG) || !data->is) {
18195e642048SPierre Jolivet                 Mat A01, A10, B = nullptr, C = nullptr, *sub;
182013044ca3SPierre Jolivet 
18215e642048SPierre Jolivet                 PetscCall(MatSchurComplementGetSubMatrices(P, &A, nullptr, &A01, &A10, nullptr));
18225e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
18235e642048SPierre Jolivet                 if (flg) {
18245e642048SPierre Jolivet                   PetscCall(MatTransposeGetMat(A10, &C));
18255e642048SPierre Jolivet                   PetscCall(MatTranspose(C, MAT_INITIAL_MATRIX, &B));
18265e642048SPierre Jolivet                 } else {
18275e642048SPierre Jolivet                   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
18285e642048SPierre Jolivet                   if (flg) {
18295e642048SPierre Jolivet                     PetscCall(MatHermitianTransposeGetMat(A10, &C));
18305e642048SPierre Jolivet                     PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &B));
18315e642048SPierre Jolivet                   }
18325e642048SPierre Jolivet                 }
1833811e8887SPierre Jolivet                 if (flg)
1834811e8887SPierre 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));
18355e642048SPierre Jolivet                 if (!B) {
18365e642048SPierre Jolivet                   B = A10;
18375e642048SPierre Jolivet                   PetscCall(PetscObjectReference((PetscObject)B));
18385e642048SPierre Jolivet                 } else if (!data->is) {
18395e642048SPierre Jolivet                   PetscCall(PetscObjectTypeCompareAny((PetscObject)A01, &flg, MATTRANSPOSEVIRTUAL, MATHERMITIANTRANSPOSEVIRTUAL, ""));
18405e642048SPierre Jolivet                   if (!flg) C = A01;
1841811e8887SPierre Jolivet                   else
1842811e8887SPierre 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));
18435e642048SPierre Jolivet                 }
184413044ca3SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, B->rmap->N, 0, 1, &uis));
18455e642048SPierre Jolivet                 PetscCall(ISSetIdentity(uis));
18465e642048SPierre Jolivet                 if (!data->is) {
18475e642048SPierre Jolivet                   if (C) PetscCall(PetscObjectReference((PetscObject)C));
18485e642048SPierre Jolivet                   else PetscCall(MatTranspose(B, MAT_INITIAL_MATRIX, &C));
18495e642048SPierre Jolivet                   PetscCall(ISDuplicate(data_00->is, is));
18505e642048SPierre Jolivet                   PetscCall(MatIncreaseOverlap(A, 1, is, 1));
18515e642048SPierre Jolivet                   PetscCall(MatSetOption(C, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
18525e642048SPierre Jolivet                   PetscCall(MatCreateSubMatrices(C, 1, is, &uis, MAT_INITIAL_MATRIX, &sub));
18535e642048SPierre Jolivet                   PetscCall(MatDestroy(&C));
18545e642048SPierre Jolivet                   PetscCall(MatTranspose(sub[0], MAT_INITIAL_MATRIX, &C));
18555e642048SPierre Jolivet                   PetscCall(MatDestroySubMatrices(1, &sub));
18565e642048SPierre Jolivet                   PetscCall(MatFindNonzeroRows(C, &data->is));
18575e642048SPierre Jolivet                   PetscCall(MatDestroy(&C));
18585e642048SPierre Jolivet                   PetscCall(ISDestroy(is));
1859d16c0b94SPierre Jolivet                   PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), A11->rmap->n, A11->rmap->rstart, 1, &loc));
1860d16c0b94SPierre Jolivet                   if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_FALSE));
1861d16c0b94SPierre Jolivet                   PetscCall(ISExpand(data->is, loc, is));
1862d16c0b94SPierre Jolivet                   PetscCall(ISDestroy(&loc));
1863d16c0b94SPierre Jolivet                   PetscCall(ISDestroy(&data->is));
1864d16c0b94SPierre Jolivet                   data->is = is[0];
1865d16c0b94SPierre Jolivet                   is[0]    = nullptr;
18665e642048SPierre Jolivet                 }
18675e642048SPierre Jolivet                 if (PetscDefined(USE_DEBUG)) {
18685e642048SPierre Jolivet                   PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
186913044ca3SPierre 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 */
187013044ca3SPierre Jolivet                   PetscCall(ISDestroy(&uis));
187113044ca3SPierre Jolivet                   PetscCall(ISDuplicate(data->is, &uis));
187213044ca3SPierre Jolivet                   PetscCall(ISSort(uis));
18735e642048SPierre Jolivet                   PetscCall(ISComplement(uis, 0, B->rmap->N, is));
187413044ca3SPierre Jolivet                   PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &C));
18755e642048SPierre Jolivet                   PetscCall(MatZeroRowsIS(C, is[0], 0.0, nullptr, nullptr));
18765e642048SPierre Jolivet                   PetscCall(ISDestroy(is));
187713044ca3SPierre Jolivet                   PetscCall(MatMultEqual(sub[0], C, 20, &flg));
187813044ca3SPierre 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 */
187913044ca3SPierre Jolivet                   PetscCall(MatDestroy(&C));
188013044ca3SPierre Jolivet                   PetscCall(MatDestroySubMatrices(1, &sub));
188113044ca3SPierre Jolivet                 }
18825e642048SPierre Jolivet                 PetscCall(ISDestroy(&uis));
18835e642048SPierre Jolivet                 PetscCall(MatDestroy(&B));
18845e642048SPierre Jolivet               }
1885cf67ef9dSPierre Jolivet               flg = PETSC_FALSE;
1886cf67ef9dSPierre Jolivet               if (!data->aux) {
1887cf67ef9dSPierre Jolivet                 Mat D;
1888cf67ef9dSPierre Jolivet 
1889cf67ef9dSPierre Jolivet                 PetscCall(MatCreateVecs(A11, &d, nullptr));
1890cf67ef9dSPierre Jolivet                 PetscCall(MatGetDiagonal(A11, d));
1891cf67ef9dSPierre Jolivet                 PetscCall(PetscObjectTypeCompareAny((PetscObject)A11, &flg, MATDIAGONAL, MATCONSTANTDIAGONAL, ""));
1892cf67ef9dSPierre Jolivet                 if (!flg) {
1893cf67ef9dSPierre Jolivet                   PetscCall(MatCreateDiagonal(d, &D));
1894cf67ef9dSPierre Jolivet                   PetscCall(MatMultEqual(A11, D, 20, &flg));
1895cf67ef9dSPierre Jolivet                   PetscCall(MatDestroy(&D));
1896cf67ef9dSPierre Jolivet                 }
1897cf67ef9dSPierre 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"));
1898cf67ef9dSPierre Jolivet               }
1899cf67ef9dSPierre Jolivet               if (data->Neumann != PETSC_BOOL3_TRUE && !flg && A11) {
1900cf67ef9dSPierre Jolivet                 PetscReal norm;
1901cf67ef9dSPierre Jolivet 
1902cf67ef9dSPierre Jolivet                 PetscCall(MatNorm(A11, NORM_INFINITY, &norm));
1903cf67ef9dSPierre 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 : "");
1904cf67ef9dSPierre 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"));
1905cf67ef9dSPierre Jolivet                 PetscCall(MatDestroy(&data->aux));
1906cf67ef9dSPierre Jolivet                 flg = PETSC_TRUE;
1907cf67ef9dSPierre Jolivet               }
1908cf67ef9dSPierre 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 */
190901e3c840SPierre Jolivet                 PetscSF            scatter;
191013044ca3SPierre Jolivet                 const PetscScalar *read;
1911cf67ef9dSPierre Jolivet                 PetscScalar       *write, *diagonal = nullptr;
191213044ca3SPierre Jolivet 
191313044ca3SPierre Jolivet                 PetscCall(MatDestroy(&data->aux));
191413044ca3SPierre Jolivet                 PetscCall(ISGetLocalSize(data->is, &n));
1915cf67ef9dSPierre Jolivet                 PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &xin));
1916cf67ef9dSPierre Jolivet                 PetscCall(VecDuplicate(xin, &v));
1917cf67ef9dSPierre Jolivet                 PetscCall(VecScatterCreate(xin, data->is, v, nullptr, &scatter));
191813044ca3SPierre Jolivet                 PetscCall(VecSet(v, 1.0));
1919cf67ef9dSPierre Jolivet                 PetscCall(VecSet(xin, 1.0));
1920cf67ef9dSPierre Jolivet                 PetscCall(VecScatterBegin(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE));
1921cf67ef9dSPierre Jolivet                 PetscCall(VecScatterEnd(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE)); /* v has the multiplicity of all unknowns on the overlap */
1922cf67ef9dSPierre Jolivet                 PetscCall(PetscSFDestroy(&scatter));
1923cf67ef9dSPierre Jolivet                 if (d) {
1924cf67ef9dSPierre Jolivet                   PetscCall(VecScatterCreate(d, data->is, v, nullptr, &scatter));
1925cf67ef9dSPierre Jolivet                   PetscCall(VecScatterBegin(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1926cf67ef9dSPierre Jolivet                   PetscCall(VecScatterEnd(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1927cf67ef9dSPierre Jolivet                   PetscCall(PetscSFDestroy(&scatter));
1928cf67ef9dSPierre Jolivet                   PetscCall(VecDestroy(&d));
1929cf67ef9dSPierre Jolivet                   PetscCall(PetscMalloc1(n, &diagonal));
1930cf67ef9dSPierre Jolivet                   PetscCall(VecGetArrayRead(v, &read));
1931cf67ef9dSPierre Jolivet                   PetscCallCXX(std::copy_n(read, n, diagonal));
1932cf67ef9dSPierre Jolivet                   PetscCall(VecRestoreArrayRead(v, &read));
1933cf67ef9dSPierre Jolivet                 }
193413044ca3SPierre Jolivet                 PetscCall(VecDestroy(&v));
193513044ca3SPierre Jolivet                 PetscCall(VecCreateSeq(PETSC_COMM_SELF, n, &v));
1936cf67ef9dSPierre Jolivet                 PetscCall(VecGetArrayRead(xin, &read));
193713044ca3SPierre Jolivet                 PetscCall(VecGetArrayWrite(v, &write));
1938cf67ef9dSPierre 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];
1939cf67ef9dSPierre Jolivet                 PetscCall(PetscFree(diagonal));
1940cf67ef9dSPierre Jolivet                 PetscCall(VecRestoreArrayRead(xin, &read));
194113044ca3SPierre Jolivet                 PetscCall(VecRestoreArrayWrite(v, &write));
1942cf67ef9dSPierre Jolivet                 PetscCall(VecDestroy(&xin));
1943c3e1b152SPierre Jolivet                 PetscCall(MatCreateDiagonal(v, &data->aux));
194413044ca3SPierre Jolivet                 PetscCall(VecDestroy(&v));
194513044ca3SPierre Jolivet               }
194613044ca3SPierre Jolivet               uis  = data->is;
194713044ca3SPierre Jolivet               uaux = data->aux;
194813044ca3SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)uis));
194913044ca3SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)uaux));
195013044ca3SPierre Jolivet               PetscCall(PetscStrallocpy(pcpre, &prefix));
195113044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(pc, nullptr));
195213044ca3SPierre Jolivet               PetscCall(PCSetType(pc, PCKSP));                                    /* replace the PC associated to the Schur complement by PCKSP */
195313044ca3SPierre Jolivet               PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &inner_ksp)); /* new KSP that will be attached to the previously set PC */
195413044ca3SPierre Jolivet               PetscCall(PetscObjectGetTabLevel((PetscObject)pc, &n));
195513044ca3SPierre Jolivet               PetscCall(PetscObjectSetTabLevel((PetscObject)inner_ksp, n + 2));
195613044ca3SPierre Jolivet               PetscCall(KSPSetOperators(inner_ksp, pc->mat, pc->pmat));
195713044ca3SPierre Jolivet               PetscCall(KSPSetOptionsPrefix(inner_ksp, std::string(std::string(prefix) + "pc_hpddm_").c_str()));
195813044ca3SPierre Jolivet               PetscCall(KSPSetSkipPCSetFromOptions(inner_ksp, PETSC_TRUE));
195913044ca3SPierre Jolivet               PetscCall(KSPSetFromOptions(inner_ksp));
196013044ca3SPierre Jolivet               PetscCall(KSPGetPC(inner_ksp, &inner));
196113044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(inner, nullptr));
196213044ca3SPierre Jolivet               PetscCall(PCSetType(inner, PCNONE)); /* no preconditioner since the action of M^-1 A or A M^-1 will be computed by the Amat */
196313044ca3SPierre Jolivet               PetscCall(PCKSPSetKSP(pc, inner_ksp));
196413044ca3SPierre Jolivet               std::get<0>(*ctx)[0] = pc_00; /* for coarse correction on the primal (e.g., velocity) space */
196513044ca3SPierre Jolivet               PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &std::get<0>(*ctx)[1]));
196651ea4bc8SPierre Jolivet               PetscCall(PCSetOptionsPrefix(pc, prefix)); /* both PC share the same prefix so that the outer PC can be reset with PCSetFromOptions() */
196713044ca3SPierre Jolivet               PetscCall(PCSetOptionsPrefix(std::get<0>(*ctx)[1], prefix));
196813044ca3SPierre Jolivet               PetscCall(PetscFree(prefix));
196913044ca3SPierre Jolivet               PetscCall(PCSetOperators(std::get<0>(*ctx)[1], pc->mat, pc->pmat));
197013044ca3SPierre Jolivet               PetscCall(PCSetType(std::get<0>(*ctx)[1], PCHPDDM));
197113044ca3SPierre 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 */
1972cf67ef9dSPierre Jolivet               if (flg) static_cast<PC_HPDDM *>(std::get<0>(*ctx)[1]->data)->Neumann = PETSC_BOOL3_TRUE;
197313044ca3SPierre Jolivet               PetscCall(PCSetFromOptions(std::get<0>(*ctx)[1]));
197413044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)uis));
197513044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)uaux));
197613044ca3SPierre 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 */
197713044ca3SPierre Jolivet               PetscCall(MatShellSetOperation(S, MATOP_MULT, (void (*)(void))MatMult_SchurCorrection));
197813044ca3SPierre Jolivet               PetscCall(MatShellSetOperation(S, MATOP_VIEW, (void (*)(void))MatView_SchurCorrection));
197913044ca3SPierre Jolivet               PetscCall(MatShellSetOperation(S, MATOP_DESTROY, (void (*)(void))MatDestroy_SchurCorrection));
198013044ca3SPierre Jolivet               PetscCall(KSPGetPCSide(inner_ksp, &(std::get<2>(*ctx))));
198113044ca3SPierre Jolivet               if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
198213044ca3SPierre Jolivet                 PetscCall(KSPSetPreSolve(inner_ksp, KSPPreSolve_SchurCorrection, ctx));
198313044ca3SPierre Jolivet               } else { /* no support for PC_SYMMETRIC */
198413044ca3SPierre 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]);
198513044ca3SPierre Jolivet               }
198613044ca3SPierre Jolivet               PetscCall(KSPSetPostSolve(inner_ksp, KSPPostSolve_SchurCorrection, ctx));
1987715c1178SPierre Jolivet               PetscCall(PetscObjectContainerCompose((PetscObject)std::get<0>(*ctx)[1], "_PCHPDDM_Schur", ctx, nullptr));
198813044ca3SPierre Jolivet               PetscCall(PCSetUp(std::get<0>(*ctx)[1]));
198913044ca3SPierre Jolivet               PetscCall(KSPSetOperators(inner_ksp, S, S));
199013044ca3SPierre Jolivet               PetscCall(MatCreateVecs(std::get<1>(*ctx)[0], std::get<3>(*ctx), std::get<3>(*ctx) + 1));
199113044ca3SPierre Jolivet               PetscCall(VecDuplicate(std::get<3>(*ctx)[0], std::get<3>(*ctx) + 2));
199213044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)inner_ksp));
199313044ca3SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)S));
199451ea4bc8SPierre Jolivet             } else {
199551ea4bc8SPierre Jolivet               std::get<0>(*ctx)[0] = pc_00;
199651ea4bc8SPierre Jolivet               PetscCall(PetscObjectContainerCompose((PetscObject)pc, "_PCHPDDM_Schur", ctx, nullptr));
199751ea4bc8SPierre 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 */
199851ea4bc8SPierre Jolivet               PetscCall(MatGetDiagonalBlock(A11, &data->aux));
199951ea4bc8SPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)data->aux));
200051ea4bc8SPierre Jolivet               PetscCall(PCSetUp(pc));
200151ea4bc8SPierre Jolivet             }
20020307214fSPierre Jolivet             for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
200313044ca3SPierre Jolivet             PetscFunctionReturn(PETSC_SUCCESS);
200413044ca3SPierre Jolivet           } else { /* second call to PCSetUp() on the PC associated to the Schur complement, retrieve previously set context */
200513044ca3SPierre Jolivet             PetscCall(PetscContainerGetPointer(container, (void **)&ctx));
200613044ca3SPierre Jolivet           }
200713044ca3SPierre Jolivet         }
200813044ca3SPierre Jolivet       }
200913044ca3SPierre Jolivet     }
2010f1580f4eSBarry Smith     if (!data->is && data->N > 1) {
2011f1580f4eSBarry Smith       char type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
2012811e8887SPierre Jolivet 
2013f1580f4eSBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
2014f1580f4eSBarry Smith       if (flg || (A->rmap->N != A->cmap->N && P->rmap->N == P->cmap->N && P->rmap->N == A->cmap->N)) {
2015f1580f4eSBarry Smith         Mat B;
2016811e8887SPierre Jolivet 
2017f1580f4eSBarry Smith         PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, A, P, &B, pcpre));
2018f1580f4eSBarry Smith         if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) data->correction = PC_HPDDM_COARSE_CORRECTION_BALANCED;
2019f1580f4eSBarry Smith         PetscCall(MatDestroy(&B));
2020f1580f4eSBarry Smith       } else {
2021f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
2022f1580f4eSBarry Smith         if (flg) {
2023f1580f4eSBarry Smith           Mat                 A00, P00, A01, A10, A11, B, N;
202413044ca3SPierre Jolivet           PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_LEAST_SQUARES;
202513044ca3SPierre Jolivet 
202613044ca3SPierre Jolivet           PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, &A01, &A10, &A11));
202713044ca3SPierre Jolivet           PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
202813044ca3SPierre Jolivet           if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
2029281f8ce6SPierre Jolivet             Mat                        B01;
20303df4cd7bSPierre Jolivet             Vec                        diagonal = nullptr;
2031f1580f4eSBarry Smith             const PetscScalar         *array;
2032f1580f4eSBarry Smith             MatSchurComplementAinvType type;
2033f1580f4eSBarry Smith 
2034281f8ce6SPierre Jolivet             PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10, &B01));
2035f1580f4eSBarry Smith             if (A11) {
20363df4cd7bSPierre Jolivet               PetscCall(MatCreateVecs(A11, &diagonal, nullptr));
20373df4cd7bSPierre Jolivet               PetscCall(MatGetDiagonal(A11, diagonal));
2038f1580f4eSBarry Smith             }
2039db4a47b3SPierre Jolivet             PetscCall(MatCreateVecs(P00, &v, nullptr));
2040f1580f4eSBarry Smith             PetscCall(MatSchurComplementGetAinvType(P, &type));
2041f1580f4eSBarry 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]);
2042f1580f4eSBarry Smith             if (type == MAT_SCHUR_COMPLEMENT_AINV_LUMP) {
2043f1580f4eSBarry Smith               PetscCall(MatGetRowSum(P00, v));
2044f1580f4eSBarry Smith               if (A00 == P00) PetscCall(PetscObjectReference((PetscObject)A00));
2045f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
2046f1580f4eSBarry Smith               PetscCall(VecGetArrayRead(v, &array));
2047db4a47b3SPierre Jolivet               PetscCall(MatCreateAIJ(PetscObjectComm((PetscObject)A00), A00->rmap->n, A00->cmap->n, A00->rmap->N, A00->cmap->N, 1, nullptr, 0, nullptr, &P00));
2048f1580f4eSBarry Smith               PetscCall(MatSetOption(P00, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
2049f1580f4eSBarry Smith               for (n = A00->rmap->rstart; n < A00->rmap->rend; ++n) PetscCall(MatSetValue(P00, n, n, array[n - A00->rmap->rstart], INSERT_VALUES));
2050f1580f4eSBarry Smith               PetscCall(MatAssemblyBegin(P00, MAT_FINAL_ASSEMBLY));
2051f1580f4eSBarry Smith               PetscCall(MatAssemblyEnd(P00, MAT_FINAL_ASSEMBLY));
2052f1580f4eSBarry Smith               PetscCall(VecRestoreArrayRead(v, &array));
2053f1580f4eSBarry Smith               PetscCall(MatSchurComplementUpdateSubMatrices(P, A00, P00, A01, A10, A11)); /* replace P00 by diag(sum of each row of P00) */
2054f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
2055f1580f4eSBarry Smith             } else PetscCall(MatGetDiagonal(P00, v));
2056f1580f4eSBarry Smith             PetscCall(VecReciprocal(v)); /* inv(diag(P00))       */
2057f1580f4eSBarry Smith             PetscCall(VecSqrtAbs(v));    /* sqrt(inv(diag(P00))) */
2058f1580f4eSBarry Smith             PetscCall(MatDuplicate(A01, MAT_COPY_VALUES, &B));
2059db4a47b3SPierre Jolivet             PetscCall(MatDiagonalScale(B, v, nullptr));
2060281f8ce6SPierre Jolivet             if (B01) PetscCall(MatDiagonalScale(B01, v, nullptr));
2061f1580f4eSBarry Smith             PetscCall(VecDestroy(&v));
2062f1580f4eSBarry Smith             PetscCall(MatCreateNormalHermitian(B, &N));
2063281f8ce6SPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, B, N, &P, pcpre, &diagonal, B01));
2064f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
2065f1580f4eSBarry Smith             if (!flg) {
2066f1580f4eSBarry Smith               PetscCall(MatDestroy(&P));
2067f1580f4eSBarry Smith               P = N;
2068f1580f4eSBarry Smith               PetscCall(PetscObjectReference((PetscObject)P));
2069feebddf4SPierre Jolivet             }
20703df4cd7bSPierre Jolivet             if (diagonal) {
20713df4cd7bSPierre Jolivet               PetscCall(MatDiagonalSet(P, diagonal, ADD_VALUES));
2072feebddf4SPierre Jolivet               PetscCall(PCSetOperators(pc, P, P)); /* replace P by A01^T inv(diag(P00)) A01 - diag(P11) */
20733df4cd7bSPierre Jolivet               PetscCall(VecDestroy(&diagonal));
2074281f8ce6SPierre Jolivet             } else PetscCall(PCSetOperators(pc, B01 ? P : N, P));  /* replace P by A01^T inv(diag(P00)) A01                         */
2075feebddf4SPierre Jolivet             pc->ops->postsolve = PCPostSolve_SchurPreLeastSquares; /*  PCFIELDSPLIT expect a KSP for (P11 - A10 inv(diag(P00)) A01) */
2076feebddf4SPierre Jolivet             PetscCall(MatDestroy(&N));                             /*  but a PC for (A10 inv(diag(P00)) A10 - P11) is setup instead */
2077feebddf4SPierre Jolivet             PetscCall(MatDestroy(&P));                             /*  so the sign of the solution must be flipped                  */
2078f1580f4eSBarry Smith             PetscCall(MatDestroy(&B));
207913044ca3SPierre Jolivet           } else
2080fd310a01SPierre 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 : "");
20810307214fSPierre Jolivet           for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
20823ba16761SJacob Faibussowitsch           PetscFunctionReturn(PETSC_SUCCESS);
2083f1580f4eSBarry Smith         } else {
2084db4a47b3SPierre Jolivet           PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_st_pc_type", type, sizeof(type), nullptr));
2085f1580f4eSBarry Smith           PetscCall(PetscStrcmp(type, PCMAT, &algebraic));
2086b07dfdedSPierre Jolivet           PetscCheck(!algebraic || !block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_block_splitting");
20879bb5c669SPierre Jolivet           if (overlap != -1) {
20889bb5c669SPierre 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");
20899bb5c669SPierre Jolivet             PetscCheck(overlap >= 1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_WRONG, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " < 1", overlap);
20909bb5c669SPierre Jolivet           }
20919bb5c669SPierre Jolivet           if (block || overlap != -1) algebraic = PETSC_TRUE;
2092f1580f4eSBarry Smith           if (algebraic) {
2093f1580f4eSBarry Smith             PetscCall(ISCreateStride(PETSC_COMM_SELF, P->rmap->n, P->rmap->rstart, 1, &data->is));
2094f1580f4eSBarry Smith             PetscCall(MatIncreaseOverlap(P, 1, &data->is, 1));
2095f1580f4eSBarry Smith             PetscCall(ISSort(data->is));
20969bb5c669SPierre Jolivet           } else
20979bb5c669SPierre 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 : ""));
2098f1580f4eSBarry Smith         }
2099f1580f4eSBarry Smith       }
2100f1580f4eSBarry Smith     }
2101f1580f4eSBarry Smith   }
2102398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2103398c7888SPierre Jolivet   if (data->is) PetscCall(ISDuplicate(data->is, &dis));
2104398c7888SPierre Jolivet   if (data->aux) PetscCall(MatDuplicate(data->aux, MAT_COPY_VALUES, &daux));
2105398c7888SPierre Jolivet #endif
2106f1580f4eSBarry Smith   if (data->is || (ismatis && data->N > 1)) {
2107f1580f4eSBarry Smith     if (ismatis) {
2108f1580f4eSBarry Smith       std::initializer_list<std::string> list = {MATSEQBAIJ, MATSEQSBAIJ};
2109f1580f4eSBarry Smith       PetscCall(MatISGetLocalMat(P, &N));
2110f1580f4eSBarry Smith       std::initializer_list<std::string>::const_iterator it = std::find(list.begin(), list.end(), ((PetscObject)N)->type_name);
2111f1580f4eSBarry Smith       PetscCall(MatISRestoreLocalMat(P, &N));
2112f1580f4eSBarry Smith       switch (std::distance(list.begin(), it)) {
2113d71ae5a4SJacob Faibussowitsch       case 0:
2114d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
2115d71ae5a4SJacob Faibussowitsch         break;
2116f1580f4eSBarry Smith       case 1:
2117f1580f4eSBarry Smith         /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIBAIJ */
2118f1580f4eSBarry Smith         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
2119f1580f4eSBarry Smith         PetscCall(MatSetOption(C, MAT_SYMMETRIC, PETSC_TRUE));
2120f1580f4eSBarry Smith         break;
2121d71ae5a4SJacob Faibussowitsch       default:
2122d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, &C));
2123f1580f4eSBarry Smith       }
2124db4a47b3SPierre Jolivet       PetscCall(MatISGetLocalToGlobalMapping(P, &l2g, nullptr));
2125f1580f4eSBarry Smith       PetscCall(PetscObjectReference((PetscObject)P));
2126f1580f4eSBarry Smith       PetscCall(KSPSetOperators(data->levels[0]->ksp, A, C));
2127f1580f4eSBarry Smith       std::swap(C, P);
2128f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingGetSize(l2g, &n));
2129f1580f4eSBarry Smith       PetscCall(ISCreateStride(PETSC_COMM_SELF, n, 0, 1, &loc));
2130f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingApplyIS(l2g, loc, &is[0]));
2131f1580f4eSBarry Smith       PetscCall(ISDestroy(&loc));
2132f1580f4eSBarry Smith       /* the auxiliary Mat is _not_ the local Neumann matrix                                */
2133f1580f4eSBarry Smith       /* it is the local Neumann matrix augmented (with zeros) through MatIncreaseOverlap() */
2134c8ea6600SPierre Jolivet       data->Neumann = PETSC_BOOL3_FALSE;
2135f1580f4eSBarry Smith       structure     = SAME_NONZERO_PATTERN;
2136f1580f4eSBarry Smith     } else {
2137f1580f4eSBarry Smith       is[0] = data->is;
213813044ca3SPierre Jolivet       if (algebraic || ctx) subdomains = PETSC_TRUE;
2139db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_define_subdomains", &subdomains, nullptr));
214013044ca3SPierre 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);
2141c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann)) {
2142b07dfdedSPierre Jolivet         PetscCheck(!block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_block_splitting and -pc_hpddm_has_neumann");
21439bb5c669SPierre Jolivet         PetscCheck(overlap == -1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " and -pc_hpddm_has_neumann", overlap);
2144b07dfdedSPierre Jolivet         PetscCheck(!algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_has_neumann");
2145f1580f4eSBarry Smith       }
2146c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann) || block) structure = SAME_NONZERO_PATTERN;
2147f1580f4eSBarry Smith       PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), P->rmap->n, P->rmap->rstart, 1, &loc));
2148f1580f4eSBarry Smith     }
2149f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2150db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetEnum(nullptr, prefix, "-st_matstructure", MatStructures, (PetscEnum *)&structure, &flg)); /* if not user-provided, force its value when possible */
2151f1580f4eSBarry Smith     if (!flg && structure == SAME_NONZERO_PATTERN) {                                                                   /* cannot call STSetMatStructure() yet, insert the appropriate option in the database, parsed by STSetFromOptions() */
2152f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-%spc_hpddm_levels_1_st_matstructure", pcpre ? pcpre : ""));
2153db4a47b3SPierre Jolivet       PetscCall(PetscOptionsSetValue(nullptr, prefix, MatStructures[structure]));
2154f1580f4eSBarry Smith     }
2155398c7888SPierre Jolivet     flg = PETSC_FALSE;
2156b07dfdedSPierre Jolivet     if (data->share) {
2157398c7888SPierre Jolivet       data->share = PETSC_FALSE; /* will be reset to PETSC_TRUE if none of the conditions below are true */
2158398c7888SPierre 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 : ""));
2159398c7888SPierre Jolivet       else if (data->deflation) PetscCall(PetscInfo(pc, "Nothing to share since PCHPDDMSetDeflationMat() has been called\n"));
2160398c7888SPierre Jolivet       else if (ismatis) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc with a Pmat of type MATIS\n"));
2161b07dfdedSPierre Jolivet       else if (!algebraic && structure != SAME_NONZERO_PATTERN)
2162398c7888SPierre 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]));
2163398c7888SPierre Jolivet       else data->share = PETSC_TRUE;
2164398c7888SPierre Jolivet     }
2165398c7888SPierre Jolivet     if (!ismatis) {
2166398c7888SPierre Jolivet       if (data->share || (!PetscBool3ToBool(data->Neumann) && subdomains)) PetscCall(ISDuplicate(is[0], &unsorted));
2167398c7888SPierre Jolivet       else unsorted = is[0];
2168398c7888SPierre Jolivet     }
216951ea4bc8SPierre Jolivet     if ((ctx || data->N > 1) && (data->aux || ismatis || algebraic)) {
2170f1580f4eSBarry Smith       PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "HPDDM library not loaded, cannot use more than one level");
2171f1580f4eSBarry Smith       PetscCall(MatSetOption(P, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
2172f1580f4eSBarry Smith       if (ismatis) {
2173f1580f4eSBarry Smith         /* needed by HPDDM (currently) so that the partition of unity is 0 on subdomain interfaces */
2174f1580f4eSBarry Smith         PetscCall(MatIncreaseOverlap(P, 1, is, 1));
2175f1580f4eSBarry Smith         PetscCall(ISDestroy(&data->is));
2176f1580f4eSBarry Smith         data->is = is[0];
2177f1580f4eSBarry Smith       } else {
2178d16c0b94SPierre Jolivet         if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_TRUE));
217951ea4bc8SPierre Jolivet         if (!ctx && overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", PCHPDDMAlgebraicAuxiliaryMat_Private));
21809bb5c669SPierre Jolivet         if (!PetscBool3ToBool(data->Neumann) && (!algebraic || overlap != -1)) {
2181f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
2182f1580f4eSBarry Smith           if (flg) {
2183f1580f4eSBarry Smith             /* maybe better to ISSort(is[0]), MatCreateSubMatrices(), and then MatPermute() */
2184f1580f4eSBarry Smith             /* but there is no MatPermute_SeqSBAIJ(), so as before, just use MATMPIBAIJ     */
2185f1580f4eSBarry Smith             PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &uaux));
2186f1580f4eSBarry Smith             flg = PETSC_FALSE;
2187f1580f4eSBarry Smith           }
2188f1580f4eSBarry Smith         }
2189f1580f4eSBarry Smith       }
21909bb5c669SPierre Jolivet       if (algebraic && overlap == -1) {
2191f1580f4eSBarry Smith         PetscUseMethod(pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", (Mat, IS *, Mat *[], PetscBool), (P, is, &sub, block));
2192f1580f4eSBarry Smith         if (block) {
2193f1580f4eSBarry Smith           PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", (PetscObject *)&data->aux));
2194db4a47b3SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", nullptr));
2195f1580f4eSBarry Smith         }
21969bb5c669SPierre Jolivet       } else if (!uaux || overlap != -1) {
219713044ca3SPierre Jolivet         if (!ctx) {
2198c8ea6600SPierre Jolivet           if (PetscBool3ToBool(data->Neumann)) sub = &data->aux;
21999bb5c669SPierre Jolivet           else {
2200df21ef68SPierre Jolivet             PetscBool flg;
22019bb5c669SPierre Jolivet             if (overlap != -1) {
22029bb5c669SPierre Jolivet               Harmonic              h;
22039bb5c669SPierre Jolivet               Mat                   A0, *a;                    /* with an SVD: [ A_00  A_01       ] */
22049bb5c669SPierre Jolivet               IS                    ov[2], rows, cols, stride; /*              [ A_10  A_11  A_12 ] */
220558b7e2c1SStefano Zampini               const PetscInt       *i[2], bs = P->cmap->bs;    /* with a GEVP: [ A_00  A_01       ] */
22069bb5c669SPierre Jolivet               PetscInt              n[2];                      /*              [ A_10  A_11  A_12 ] */
22079bb5c669SPierre Jolivet               std::vector<PetscInt> v[2];                      /*              [       A_21  A_22 ] */
22089bb5c669SPierre Jolivet 
22099bb5c669SPierre Jolivet               PetscCall(ISDuplicate(data->is, ov));
22109bb5c669SPierre Jolivet               if (overlap > 1) PetscCall(MatIncreaseOverlap(P, 1, ov, overlap - 1));
22119bb5c669SPierre Jolivet               PetscCall(ISDuplicate(ov[0], ov + 1));
22129bb5c669SPierre Jolivet               PetscCall(MatIncreaseOverlap(P, 1, ov + 1, 1));
22139bb5c669SPierre Jolivet               PetscCall(PetscNew(&h));
22149bb5c669SPierre Jolivet               h->ksp = nullptr;
22159bb5c669SPierre Jolivet               PetscCall(PetscCalloc1(2, &h->A));
2216b5a302b3SPierre Jolivet               PetscCall(PetscOptionsHasName(nullptr, prefix, "-eps_nev", &flg));
2217b5a302b3SPierre Jolivet               if (!flg) {
22183a60673dSPierre Jolivet                 PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_nsv", &flg));
2219b5a302b3SPierre Jolivet                 if (!flg) PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_threshold_relative", &flg));
2220b5a302b3SPierre Jolivet               } else flg = PETSC_FALSE;
22219bb5c669SPierre Jolivet               PetscCall(ISSort(ov[0]));
22229bb5c669SPierre Jolivet               if (!flg) PetscCall(ISSort(ov[1]));
222332603206SJames Wright               PetscCall(PetscCalloc1(5, &h->is));
22249bb5c669SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, ov + !flg, ov + 1, MAT_INITIAL_MATRIX, &a)); /* submatrix from above, either square (!flg) or rectangular (flg) */
22259bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) {
22269bb5c669SPierre Jolivet                 PetscCall(ISGetIndices(ov[j], i + j));
22279bb5c669SPierre Jolivet                 PetscCall(ISGetLocalSize(ov[j], n + j));
22289bb5c669SPierre Jolivet               }
22299bb5c669SPierre Jolivet               v[1].reserve((n[1] - n[0]) / bs);
22309bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[1]; j += bs) { /* indices of the (2,2) block */
22319bb5c669SPierre Jolivet                 PetscInt location;
22329bb5c669SPierre Jolivet                 PetscCall(ISLocate(ov[0], i[1][j], &location));
22339bb5c669SPierre Jolivet                 if (location < 0) v[1].emplace_back(j / bs);
22349bb5c669SPierre Jolivet               }
22359bb5c669SPierre Jolivet               if (!flg) {
22369bb5c669SPierre Jolivet                 h->A[1] = a[0];
22379bb5c669SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)h->A[1]));
22389bb5c669SPierre Jolivet                 v[0].reserve((n[0] - P->rmap->n) / bs);
22399bb5c669SPierre Jolivet                 for (PetscInt j = 0; j < n[1]; j += bs) { /* row indices of the (1,2) block */
22409bb5c669SPierre Jolivet                   PetscInt location;
22419bb5c669SPierre Jolivet                   PetscCall(ISLocate(loc, i[1][j], &location));
22429bb5c669SPierre Jolivet                   if (location < 0) {
22439bb5c669SPierre Jolivet                     PetscCall(ISLocate(ov[0], i[1][j], &location));
22449bb5c669SPierre Jolivet                     if (location >= 0) v[0].emplace_back(j / bs);
22459bb5c669SPierre Jolivet                   }
22469bb5c669SPierre Jolivet                 }
22479bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
22489bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_COPY_VALUES, h->is + 4));
22499bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, h->is[4], MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
22509bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
22519bb5c669SPierre 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 */
22529bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &rows));
22539bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols = rows, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
22549bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
22559bb5c669SPierre Jolivet                 v[0].clear();
22569bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, ov[1], PETSC_TRUE, h->is + 3));
22579bb5c669SPierre Jolivet                 PetscCall(ISEmbed(data->is, ov[1], PETSC_TRUE, h->is + 2));
22589bb5c669SPierre Jolivet               }
22599bb5c669SPierre Jolivet               v[0].reserve((n[0] - P->rmap->n) / bs);
22609bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[0]; j += bs) {
22619bb5c669SPierre Jolivet                 PetscInt location;
22629bb5c669SPierre Jolivet                 PetscCall(ISLocate(loc, i[0][j], &location));
22639bb5c669SPierre Jolivet                 if (location < 0) v[0].emplace_back(j / bs);
22649bb5c669SPierre Jolivet               }
22659bb5c669SPierre Jolivet               PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
22669bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISRestoreIndices(ov[j], i + j));
22679bb5c669SPierre Jolivet               if (flg) {
22689bb5c669SPierre Jolivet                 IS is;
22699bb5c669SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, a[0]->rmap->n, 0, 1, &is));
22709bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &cols));
22719bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], is, cols, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
22729bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
22739bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&is));
22749bb5c669SPierre 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 */
22759bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, data->is, PETSC_TRUE, h->is + 2));
22769bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_USE_POINTER, &cols));
22779bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols, MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
22789bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
22799bb5c669SPierre Jolivet               }
22809bb5c669SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, A0->rmap->n, 0, 1, &stride));
22819bb5c669SPierre Jolivet               PetscCall(ISEmbed(rows, stride, PETSC_TRUE, h->is));
22829bb5c669SPierre Jolivet               PetscCall(ISDestroy(&stride));
22839bb5c669SPierre Jolivet               PetscCall(ISDestroy(&rows));
22849bb5c669SPierre Jolivet               PetscCall(ISEmbed(loc, ov[0], PETSC_TRUE, h->is + 1));
22859bb5c669SPierre Jolivet               if (subdomains) {
22869bb5c669SPierre Jolivet                 if (!data->levels[0]->pc) {
22879bb5c669SPierre Jolivet                   PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
22889bb5c669SPierre Jolivet                   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
22899bb5c669SPierre Jolivet                   PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
22909bb5c669SPierre Jolivet                   PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
22919bb5c669SPierre Jolivet                 }
22929bb5c669SPierre Jolivet                 PetscCall(PCSetType(data->levels[0]->pc, PCASM));
22939bb5c669SPierre Jolivet                 if (!data->levels[0]->pc->setupcalled) PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, ov + !flg, &loc));
22949bb5c669SPierre Jolivet                 PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, flg ? A0 : a[0], PETSC_TRUE));
22959bb5c669SPierre Jolivet                 if (!flg) ++overlap;
22969bb5c669SPierre Jolivet                 if (data->share) {
22979bb5c669SPierre Jolivet                   PetscInt n = -1;
22989bb5c669SPierre Jolivet                   PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
22999bb5c669SPierre Jolivet                   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
23009bb5c669SPierre Jolivet                   if (flg) {
23019bb5c669SPierre Jolivet                     h->ksp = ksp[0];
23029bb5c669SPierre Jolivet                     PetscCall(PetscObjectReference((PetscObject)h->ksp));
23039bb5c669SPierre Jolivet                   }
23049bb5c669SPierre Jolivet                 }
23059bb5c669SPierre Jolivet               }
23069bb5c669SPierre Jolivet               if (!h->ksp) {
23079bb5c669SPierre Jolivet                 PetscBool share = data->share;
23089bb5c669SPierre Jolivet                 PetscCall(KSPCreate(PETSC_COMM_SELF, &h->ksp));
23099bb5c669SPierre Jolivet                 PetscCall(KSPSetType(h->ksp, KSPPREONLY));
23109bb5c669SPierre Jolivet                 PetscCall(KSPSetOperators(h->ksp, A0, A0));
23119bb5c669SPierre Jolivet                 do {
23129bb5c669SPierre Jolivet                   if (!data->share) {
23139bb5c669SPierre Jolivet                     share = PETSC_FALSE;
23149bb5c669SPierre Jolivet                     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_%s", pcpre ? pcpre : "", flg ? "svd_" : "eps_"));
23159bb5c669SPierre Jolivet                     PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
23169bb5c669SPierre Jolivet                     PetscCall(KSPSetFromOptions(h->ksp));
23179bb5c669SPierre Jolivet                   } else {
23189bb5c669SPierre Jolivet                     MatSolverType type;
23199bb5c669SPierre Jolivet                     PetscCall(KSPGetPC(ksp[0], &pc));
23209bb5c669SPierre Jolivet                     PetscCall(PetscObjectTypeCompareAny((PetscObject)pc, &data->share, PCLU, PCCHOLESKY, ""));
23219bb5c669SPierre Jolivet                     if (data->share) {
23229bb5c669SPierre Jolivet                       PetscCall(PCFactorGetMatSolverType(pc, &type));
23239bb5c669SPierre Jolivet                       if (!type) {
23249bb5c669SPierre Jolivet                         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMUMPS));
23259bb5c669SPierre Jolivet                         else if (PetscDefined(HAVE_MKL_PARDISO)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMKL_PARDISO));
23269bb5c669SPierre Jolivet                         else data->share = PETSC_FALSE;
23279bb5c669SPierre Jolivet                         if (data->share) PetscCall(PCSetFromOptions(pc));
23289bb5c669SPierre Jolivet                       } else {
23299bb5c669SPierre Jolivet                         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &data->share));
23309bb5c669SPierre Jolivet                         if (!data->share) PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &data->share));
23319bb5c669SPierre Jolivet                       }
23329bb5c669SPierre Jolivet                       if (data->share) {
23339bb5c669SPierre Jolivet                         std::tuple<KSP, IS, Vec[2]> *p;
23349bb5c669SPierre Jolivet                         PetscCall(PCFactorGetMatrix(pc, &A));
23359bb5c669SPierre Jolivet                         PetscCall(MatFactorSetSchurIS(A, h->is[4]));
23369bb5c669SPierre Jolivet                         PetscCall(KSPSetUp(ksp[0]));
23379bb5c669SPierre Jolivet                         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_eps_shell_", pcpre ? pcpre : ""));
23389bb5c669SPierre Jolivet                         PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
23399bb5c669SPierre Jolivet                         PetscCall(KSPSetFromOptions(h->ksp));
23409bb5c669SPierre Jolivet                         PetscCall(KSPGetPC(h->ksp, &pc));
23419bb5c669SPierre Jolivet                         PetscCall(PCSetType(pc, PCSHELL));
23429bb5c669SPierre Jolivet                         PetscCall(PetscNew(&p));
23439bb5c669SPierre Jolivet                         std::get<0>(*p) = ksp[0];
23449bb5c669SPierre Jolivet                         PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &std::get<1>(*p)));
23459bb5c669SPierre Jolivet                         PetscCall(MatCreateVecs(A, std::get<2>(*p), std::get<2>(*p) + 1));
23469bb5c669SPierre Jolivet                         PetscCall(PCShellSetContext(pc, p));
23479bb5c669SPierre Jolivet                         PetscCall(PCShellSetApply(pc, PCApply_Schur));
23489bb5c669SPierre Jolivet                         PetscCall(PCShellSetApplyTranspose(pc, PCApply_Schur<Vec, true>));
23499bb5c669SPierre Jolivet                         PetscCall(PCShellSetMatApply(pc, PCApply_Schur<Mat>));
23509bb5c669SPierre Jolivet                         PetscCall(PCShellSetDestroy(pc, PCDestroy_Schur));
23519bb5c669SPierre Jolivet                       }
23529bb5c669SPierre Jolivet                     }
23539bb5c669SPierre Jolivet                     if (!data->share) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since neither MUMPS nor MKL PARDISO is used\n"));
23549bb5c669SPierre Jolivet                   }
23559bb5c669SPierre 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 */
23569bb5c669SPierre Jolivet               }
23579bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov));
23589bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov + 1));
23599bb5c669SPierre Jolivet               if (overlap == 1 && subdomains && flg) {
23609bb5c669SPierre Jolivet                 *subA = A0;
23619bb5c669SPierre Jolivet                 sub   = subA;
23629bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatDestroy(&uaux));
23639bb5c669SPierre Jolivet               } else PetscCall(MatDestroy(&A0));
23649bb5c669SPierre Jolivet               PetscCall(MatCreateShell(PETSC_COMM_SELF, P->rmap->n, n[1] - n[0], P->rmap->n, n[1] - n[0], h, &data->aux));
2365bdcd51b8SPierre Jolivet               PetscCall(KSPSetErrorIfNotConverged(h->ksp, PETSC_TRUE)); /* bail out as early as possible to avoid (apparently) unrelated error messages */
23669bb5c669SPierre Jolivet               PetscCall(MatCreateVecs(h->ksp->pc->pmat, &h->v, nullptr));
23679bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT, (void (*)(void))MatMult_Harmonic));
23689bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMultTranspose_Harmonic));
23699bb5c669SPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AB, nullptr, MatProduct_AB_Harmonic, nullptr, MATDENSE, MATDENSE));
23709bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_DESTROY, (void (*)(void))MatDestroy_Harmonic));
23719bb5c669SPierre Jolivet               PetscCall(MatDestroySubMatrices(1, &a));
23729bb5c669SPierre Jolivet             }
2373df21ef68SPierre Jolivet             if (overlap != 1 || !subdomains) {
2374df21ef68SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2375df21ef68SPierre Jolivet               if (ismatis) {
2376df21ef68SPierre Jolivet                 PetscCall(MatISGetLocalMat(C, &N));
2377df21ef68SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)N, MATSEQSBAIJ, &flg));
2378df21ef68SPierre Jolivet                 if (flg) PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2379df21ef68SPierre Jolivet                 PetscCall(MatISRestoreLocalMat(C, &N));
2380df21ef68SPierre Jolivet               }
2381df21ef68SPierre Jolivet             }
23829bb5c669SPierre Jolivet             if (uaux) {
23839bb5c669SPierre Jolivet               PetscCall(MatDestroy(&uaux));
23849bb5c669SPierre Jolivet               PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
23859bb5c669SPierre Jolivet             }
23869bb5c669SPierre Jolivet           }
238713044ca3SPierre Jolivet         }
238851ea4bc8SPierre Jolivet       } else if (!ctx) {
2389f1580f4eSBarry Smith         PetscCall(MatCreateSubMatrices(uaux, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2390f1580f4eSBarry Smith         PetscCall(MatDestroy(&uaux));
2391f1580f4eSBarry Smith         PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2392f1580f4eSBarry Smith       }
239351ea4bc8SPierre Jolivet       if (data->N > 1) {
2394f1580f4eSBarry Smith         /* Vec holding the partition of unity */
2395f1580f4eSBarry Smith         if (!data->levels[0]->D) {
2396f1580f4eSBarry Smith           PetscCall(ISGetLocalSize(data->is, &n));
2397f1580f4eSBarry Smith           PetscCall(VecCreateMPI(PETSC_COMM_SELF, n, PETSC_DETERMINE, &data->levels[0]->D));
2398f1580f4eSBarry Smith         }
23999bb5c669SPierre Jolivet         if (data->share && overlap == -1) {
2400f1580f4eSBarry Smith           Mat      D;
2401db4a47b3SPierre Jolivet           IS       perm = nullptr;
2402f1580f4eSBarry Smith           PetscInt size = -1;
2403811e8887SPierre Jolivet 
2404398c7888SPierre Jolivet           if (!data->levels[0]->pc) {
2405398c7888SPierre Jolivet             PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2406398c7888SPierre Jolivet             PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
2407398c7888SPierre Jolivet             PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
2408398c7888SPierre Jolivet             PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
2409398c7888SPierre Jolivet           }
2410398c7888SPierre Jolivet           PetscCall(PCSetType(data->levels[0]->pc, PCASM));
241113044ca3SPierre Jolivet           if (!ctx) {
2412398c7888SPierre Jolivet             if (!data->levels[0]->pc->setupcalled) {
2413398c7888SPierre Jolivet               IS sorted; /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2414398c7888SPierre Jolivet               PetscCall(ISDuplicate(is[0], &sorted));
2415398c7888SPierre Jolivet               PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &sorted, &loc));
2416398c7888SPierre Jolivet               PetscCall(PetscObjectDereference((PetscObject)sorted));
2417398c7888SPierre Jolivet             }
2418398c7888SPierre Jolivet             PetscCall(PCSetFromOptions(data->levels[0]->pc));
2419398c7888SPierre Jolivet             if (block) {
2420398c7888SPierre Jolivet               PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, sub[0], &C, &perm));
2421398c7888SPierre Jolivet               PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, C, algebraic));
2422398c7888SPierre Jolivet             } else PetscCall(PCSetUp(data->levels[0]->pc));
2423db4a47b3SPierre Jolivet             PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &size, nullptr, &ksp));
2424398c7888SPierre Jolivet             if (size != 1) {
2425398c7888SPierre Jolivet               data->share = PETSC_FALSE;
2426398c7888SPierre Jolivet               PetscCheck(size == -1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", size);
2427398c7888SPierre Jolivet               PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since PCASMGetSubKSP() not found in fine-level PC\n"));
2428398c7888SPierre Jolivet               PetscCall(ISDestroy(&unsorted));
2429398c7888SPierre Jolivet               unsorted = is[0];
2430398c7888SPierre Jolivet             } else {
2431811e8887SPierre Jolivet               const char *matpre;
2432811e8887SPierre Jolivet               PetscBool   cmp[4];
2433811e8887SPierre Jolivet 
243413044ca3SPierre Jolivet               if (!block && !ctx) PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, PetscBool3ToBool(data->Neumann) ? sub[0] : data->aux, &C, &perm));
243551ea4bc8SPierre Jolivet               if (perm) { /* unsorted input IS */
2436c8ea6600SPierre Jolivet                 if (!PetscBool3ToBool(data->Neumann) && !block) {
2437f1580f4eSBarry Smith                   PetscCall(MatPermute(sub[0], perm, perm, &D)); /* permute since PCASM will call ISSort() */
2438f1580f4eSBarry Smith                   PetscCall(MatHeaderReplace(sub[0], &D));
2439f1580f4eSBarry Smith                 }
2440f1580f4eSBarry Smith                 if (data->B) { /* see PCHPDDMSetRHSMat() */
2441f1580f4eSBarry Smith                   PetscCall(MatPermute(data->B, perm, perm, &D));
2442f1580f4eSBarry Smith                   PetscCall(MatHeaderReplace(data->B, &D));
2443f1580f4eSBarry Smith                 }
2444f1580f4eSBarry Smith                 PetscCall(ISDestroy(&perm));
244551ea4bc8SPierre Jolivet               }
2446f1580f4eSBarry Smith               PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
24470307214fSPierre Jolivet               PetscCall(PetscObjectReference((PetscObject)subA[0]));
2448f1580f4eSBarry Smith               PetscCall(MatDuplicate(subA[1], MAT_SHARE_NONZERO_PATTERN, &D));
2449f1580f4eSBarry Smith               PetscCall(MatGetOptionsPrefix(subA[1], &matpre));
2450f1580f4eSBarry Smith               PetscCall(MatSetOptionsPrefix(D, matpre));
2451f1580f4eSBarry Smith               PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMAL, cmp));
2452f1580f4eSBarry Smith               PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMAL, cmp + 1));
2453f1580f4eSBarry Smith               if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMALHERMITIAN, cmp + 2));
2454f1580f4eSBarry Smith               else cmp[2] = PETSC_FALSE;
2455f1580f4eSBarry Smith               if (!cmp[1]) PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMALHERMITIAN, cmp + 3));
2456f1580f4eSBarry Smith               else cmp[3] = PETSC_FALSE;
2457f1580f4eSBarry 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);
2458f1580f4eSBarry Smith               if (!cmp[0] && !cmp[2]) {
2459f1580f4eSBarry Smith                 if (!block) PetscCall(MatAXPY(D, 1.0, C, SUBSET_NONZERO_PATTERN));
24605c7345deSPierre Jolivet                 else {
2461db4a47b3SPierre Jolivet                   PetscCall(MatMissingDiagonal(D, cmp, nullptr));
24625c7345deSPierre Jolivet                   if (cmp[0]) structure = DIFFERENT_NONZERO_PATTERN; /* data->aux has no missing diagonal entry */
24635c7345deSPierre Jolivet                   PetscCall(MatAXPY(D, 1.0, data->aux, structure));
24645c7345deSPierre Jolivet                 }
2465f1580f4eSBarry Smith               } else {
2466f1580f4eSBarry Smith                 Mat mat[2];
2467811e8887SPierre Jolivet 
2468f1580f4eSBarry Smith                 if (cmp[0]) {
2469f1580f4eSBarry Smith                   PetscCall(MatNormalGetMat(D, mat));
2470f1580f4eSBarry Smith                   PetscCall(MatNormalGetMat(C, mat + 1));
2471f1580f4eSBarry Smith                 } else {
2472f1580f4eSBarry Smith                   PetscCall(MatNormalHermitianGetMat(D, mat));
2473f1580f4eSBarry Smith                   PetscCall(MatNormalHermitianGetMat(C, mat + 1));
2474f1580f4eSBarry Smith                 }
2475f1580f4eSBarry Smith                 PetscCall(MatAXPY(mat[0], 1.0, mat[1], SUBSET_NONZERO_PATTERN));
2476f1580f4eSBarry Smith               }
2477f1580f4eSBarry Smith               PetscCall(MatPropagateSymmetryOptions(C, D));
2478f1580f4eSBarry Smith               PetscCall(MatDestroy(&C));
2479f1580f4eSBarry Smith               C = D;
2480f1580f4eSBarry Smith               /* swap pointers so that variables stay consistent throughout PCSetUp() */
2481f1580f4eSBarry Smith               std::swap(C, data->aux);
2482f1580f4eSBarry Smith               std::swap(uis, data->is);
2483f1580f4eSBarry Smith               swap = PETSC_TRUE;
2484f1580f4eSBarry Smith             }
2485f1580f4eSBarry Smith           }
248613044ca3SPierre Jolivet         }
248751ea4bc8SPierre Jolivet       }
248813044ca3SPierre Jolivet       if (ctx) {
248913044ca3SPierre Jolivet         PC_HPDDM              *data_00 = (PC_HPDDM *)std::get<0>(*ctx)[0]->data;
249013044ca3SPierre Jolivet         PC                     s;
249100b491fbSPierre Jolivet         Mat                    A00, P00, A01 = nullptr, A10, A11, N, b[4];
249207d8d47fSPierre Jolivet         IS                     sorted, is[2], *is_00;
249313044ca3SPierre Jolivet         MatSolverType          type;
249413044ca3SPierre Jolivet         std::pair<PC, Vec[2]> *p;
249513044ca3SPierre Jolivet 
249607d8d47fSPierre Jolivet         n = -1;
249707d8d47fSPierre Jolivet         PetscTryMethod(data_00->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data_00->levels[0]->pc, &n, nullptr, &ksp));
249807d8d47fSPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
249907d8d47fSPierre Jolivet         PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
250007d8d47fSPierre Jolivet         PetscCall(ISGetLocalSize(data_00->is, &n));
250107d8d47fSPierre Jolivet         if (n != subA[0]->rmap->n || n != subA[0]->cmap->n) {
250207d8d47fSPierre Jolivet           PetscCall(PCASMGetLocalSubdomains(data_00->levels[0]->pc, &n, &is_00, nullptr));
250307d8d47fSPierre Jolivet           PetscCall(ISGetLocalSize(*is_00, &n));
250407d8d47fSPierre 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);
250507d8d47fSPierre Jolivet         } else is_00 = &data_00->is;
250613044ca3SPierre Jolivet         PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, data->aux, &C, nullptr)); /* permute since PCASM works with a sorted IS */
250713044ca3SPierre Jolivet         std::swap(C, data->aux);
250813044ca3SPierre Jolivet         std::swap(uis, data->is);
250913044ca3SPierre Jolivet         swap = PETSC_TRUE;
251013044ca3SPierre Jolivet         PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, std::get<1>(*ctx), &A10, &A11));
251113044ca3SPierre Jolivet         std::get<1>(*ctx)[1] = A10;
251213044ca3SPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
251313044ca3SPierre Jolivet         if (flg) PetscCall(MatTransposeGetMat(A10, &A01));
251413044ca3SPierre Jolivet         else {
251513044ca3SPierre Jolivet           PetscBool flg;
251613044ca3SPierre Jolivet 
251713044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
251813044ca3SPierre Jolivet           if (flg) PetscCall(MatHermitianTransposeGetMat(A10, &A01));
251913044ca3SPierre Jolivet         }
252007d8d47fSPierre 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 */
252113044ca3SPierre Jolivet         PetscCall(ISSort(sorted));               /* this is to avoid changing users inputs, but it requires a new call to ISSort() here                                                                                               */
252200b491fbSPierre Jolivet         if (!A01) {
252300b491fbSPierre Jolivet           PetscCall(MatSetOption(A10, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
252400b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A10, 1, &data->is, &sorted, MAT_INITIAL_MATRIX, &sub));
252500b491fbSPierre Jolivet           b[2] = sub[0];
252600b491fbSPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
252700b491fbSPierre Jolivet           PetscCall(MatDestroySubMatrices(1, &sub));
252800b491fbSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATTRANSPOSEVIRTUAL, &flg));
252900b491fbSPierre Jolivet           A10 = nullptr;
253000b491fbSPierre Jolivet           if (flg) PetscCall(MatTransposeGetMat(std::get<1>(*ctx)[0], &A10));
253113044ca3SPierre Jolivet           else {
253200b491fbSPierre Jolivet             PetscBool flg;
253300b491fbSPierre Jolivet 
2534c71f06a7SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATHERMITIANTRANSPOSEVIRTUAL, &flg));
253500b491fbSPierre Jolivet             if (flg) PetscCall(MatHermitianTransposeGetMat(std::get<1>(*ctx)[0], &A10));
253613044ca3SPierre Jolivet           }
2537811e8887SPierre Jolivet           if (!A10) PetscCall(MatCreateSubMatrices(std::get<1>(*ctx)[0], 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2538811e8887SPierre Jolivet           else {
2539811e8887SPierre Jolivet             if (flg) PetscCall(MatCreateTranspose(b[2], b + 1));
2540811e8887SPierre Jolivet             else PetscCall(MatCreateHermitianTranspose(b[2], b + 1));
254100b491fbSPierre Jolivet           }
254200b491fbSPierre Jolivet         } else {
254300b491fbSPierre Jolivet           PetscCall(MatSetOption(A01, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
254400b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A01, 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2545811e8887SPierre Jolivet           if (flg) PetscCall(MatCreateTranspose(*sub, b + 2));
2546811e8887SPierre Jolivet           else PetscCall(MatCreateHermitianTranspose(*sub, b + 2));
2547811e8887SPierre Jolivet         }
2548811e8887SPierre Jolivet         if (A01 || !A10) {
2549811e8887SPierre Jolivet           b[1] = sub[0];
2550811e8887SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
255100b491fbSPierre Jolivet         }
255200b491fbSPierre Jolivet         PetscCall(MatDestroySubMatrices(1, &sub));
255313044ca3SPierre Jolivet         PetscCall(ISDestroy(&sorted));
255451ea4bc8SPierre Jolivet         b[3] = data->aux;
255551ea4bc8SPierre Jolivet         PetscCall(MatCreateSchurComplement(subA[0], subA[1], b[1], b[2], b[3], &S));
255613044ca3SPierre Jolivet         PetscCall(MatSchurComplementSetKSP(S, ksp[0]));
255751ea4bc8SPierre Jolivet         if (data->N != 1) {
255851ea4bc8SPierre Jolivet           PetscCall(PCASMSetType(data->levels[0]->pc, PC_ASM_NONE)); /* "Neumann--Neumann" preconditioning with overlap and a Boolean partition of unity */
255951ea4bc8SPierre Jolivet           PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &data->is, &loc));
256051ea4bc8SPierre Jolivet           PetscCall(PCSetFromOptions(data->levels[0]->pc)); /* action of eq. (15) of https://hal.science/hal-02343808v6/document (with a sign flip) */
256151ea4bc8SPierre Jolivet           s = data->levels[0]->pc;
256251ea4bc8SPierre Jolivet         } else {
256351ea4bc8SPierre Jolivet           is[0] = data->is;
256451ea4bc8SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)is[0]));
256551ea4bc8SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)b[3]));
256651ea4bc8SPierre Jolivet           PetscCall(PCSetType(pc, PCASM));                          /* change the type of the current PC */
256751ea4bc8SPierre Jolivet           data = nullptr;                                           /* destroyed in the previous PCSetType(), so reset to NULL to avoid any faulty use */
256851ea4bc8SPierre Jolivet           PetscCall(PCAppendOptionsPrefix(pc, "pc_hpddm_coarse_")); /* same prefix as when using PCHPDDM with a single level */
256951ea4bc8SPierre Jolivet           PetscCall(PCASMSetLocalSubdomains(pc, 1, is, &loc));
257051ea4bc8SPierre Jolivet           PetscCall(ISDestroy(is));
257151ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&loc));
257251ea4bc8SPierre Jolivet           s = pc;
257351ea4bc8SPierre Jolivet         }
257451ea4bc8SPierre Jolivet         PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(s, S, PETSC_TRUE)); /* the subdomain Mat is already known and the input IS of PCASMSetLocalSubdomains() is already sorted */
257551ea4bc8SPierre Jolivet         PetscTryMethod(s, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (s, &n, nullptr, &ksp));
257613044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
257713044ca3SPierre Jolivet         PetscCall(KSPGetPC(ksp[0], &inner));
257813044ca3SPierre Jolivet         PetscCall(PCSetType(inner, PCSHELL)); /* compute the action of the inverse of the local Schur complement with a PCSHELL */
257913044ca3SPierre Jolivet         b[0] = subA[0];
258013044ca3SPierre 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 */
258151ea4bc8SPierre Jolivet         if (!data) PetscCall(PetscObjectDereference((PetscObject)b[3]));
258200b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[1]));
258300b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[2]));
258413044ca3SPierre Jolivet         PetscCall(PCCreate(PETSC_COMM_SELF, &s));
258513044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(s, ((PetscObject)inner)->prefix));
258613044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(inner, nullptr));
258713044ca3SPierre Jolivet         PetscCall(KSPSetSkipPCSetFromOptions(ksp[0], PETSC_TRUE));
258813044ca3SPierre Jolivet         PetscCall(PCSetType(s, PCLU));
258951ea4bc8SPierre 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 */
259013044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(s));
259113044ca3SPierre Jolivet         PetscCall(PCFactorGetMatSolverType(s, &type));
259213044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
259351ea4bc8SPierre Jolivet         PetscCall(MatGetLocalSize(A11, &n, nullptr));
259451ea4bc8SPierre Jolivet         if (flg || n == 0) {
259513044ca3SPierre Jolivet           PetscCall(PCSetOperators(s, N, N));
259651ea4bc8SPierre Jolivet           if (n) {
259700b491fbSPierre Jolivet             PetscCall(PCFactorGetMatrix(s, b));
259800b491fbSPierre Jolivet             PetscCall(MatSetOptionsPrefix(*b, ((PetscObject)s)->prefix));
259924ddd604SPierre Jolivet             n = -1;
260024ddd604SPierre Jolivet             PetscCall(PetscOptionsGetInt(nullptr, ((PetscObject)s)->prefix, "-mat_mumps_icntl_26", &n, nullptr));
2601f45b553cSPierre Jolivet             if (n == 1) {                                /* allocates a square MatDense of size is[1]->map->n, so one */
2602f45b553cSPierre Jolivet               PetscCall(MatNestGetISs(N, is, nullptr));  /*  needs to be able to deactivate this path when dealing    */
2603f45b553cSPierre Jolivet               PetscCall(MatFactorSetSchurIS(*b, is[1])); /*  with a large constraint space in order to avoid OOM      */
2604f45b553cSPierre Jolivet             }
260551ea4bc8SPierre Jolivet           } else PetscCall(PCSetType(s, PCNONE)); /* empty local Schur complement (e.g., centralized on another process) */
260613044ca3SPierre Jolivet         } else {
260700b491fbSPierre Jolivet           PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, b));
260800b491fbSPierre Jolivet           PetscCall(PCSetOperators(s, N, *b));
260900b491fbSPierre Jolivet           PetscCall(PetscObjectDereference((PetscObject)*b));
261051ea4bc8SPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)s, &flg, PCLU, PCCHOLESKY, PCILU, PCICC, PCQR, ""));
261151ea4bc8SPierre 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 */
261213044ca3SPierre Jolivet         }
261313044ca3SPierre Jolivet         PetscCall(PetscNew(&p));
261413044ca3SPierre Jolivet         p->first = s;
261551ea4bc8SPierre Jolivet         if (n != 0) PetscCall(MatCreateVecs(*b, p->second, p->second + 1));
261651ea4bc8SPierre Jolivet         else p->second[0] = p->second[1] = nullptr;
261713044ca3SPierre Jolivet         PetscCall(PCShellSetContext(inner, p));
261813044ca3SPierre Jolivet         PetscCall(PCShellSetApply(inner, PCApply_Nest));
261913044ca3SPierre Jolivet         PetscCall(PCShellSetView(inner, PCView_Nest));
262013044ca3SPierre Jolivet         PetscCall(PCShellSetDestroy(inner, PCDestroy_Nest));
262113044ca3SPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)N));
262251ea4bc8SPierre Jolivet         if (!data) {
262351ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&S));
262451ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&unsorted));
262551ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&C));
262651ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&uis));
262751ea4bc8SPierre Jolivet           PetscCall(PetscFree(ctx));
262851ea4bc8SPierre Jolivet #if PetscDefined(USE_DEBUG)
262951ea4bc8SPierre Jolivet           PetscCall(ISDestroy(&dis));
263051ea4bc8SPierre Jolivet           PetscCall(MatDestroy(&daux));
263151ea4bc8SPierre Jolivet #endif
263251ea4bc8SPierre Jolivet           PetscFunctionReturn(PETSC_SUCCESS);
263351ea4bc8SPierre Jolivet         }
263413044ca3SPierre Jolivet       }
2635f1580f4eSBarry Smith       if (!data->levels[0]->scatter) {
2636db4a47b3SPierre Jolivet         PetscCall(MatCreateVecs(P, &xin, nullptr));
2637f1580f4eSBarry Smith         if (ismatis) PetscCall(MatDestroy(&P));
2638db4a47b3SPierre Jolivet         PetscCall(VecScatterCreate(xin, data->is, data->levels[0]->D, nullptr, &data->levels[0]->scatter));
2639f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
2640f1580f4eSBarry Smith       }
2641f1580f4eSBarry Smith       if (data->levels[0]->P) {
2642f1580f4eSBarry Smith         /* if the pattern is the same and PCSetUp() has previously succeeded, reuse HPDDM buffers and connectivity */
2643371d2eb7SMartin Diehl         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[0], !pc->setupcalled || pc->flag == DIFFERENT_NONZERO_PATTERN ? PETSC_TRUE : PETSC_FALSE));
2644f1580f4eSBarry Smith       }
2645f1580f4eSBarry Smith       if (!data->levels[0]->P) data->levels[0]->P = new HPDDM::Schwarz<PetscScalar>();
2646db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2647db4a47b3SPierre Jolivet       else PetscCall(PetscLogEventBegin(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2648f1580f4eSBarry Smith       /* HPDDM internal data structure */
264913044ca3SPierre Jolivet       PetscCall(data->levels[0]->P->structure(loc, data->is, !ctx ? sub[0] : nullptr, ismatis ? C : data->aux, data->levels));
2650db4a47b3SPierre Jolivet       if (!data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2651f1580f4eSBarry Smith       /* matrix pencil of the generalized eigenvalue problem on the overlap (GenEO) */
265213044ca3SPierre Jolivet       if (!ctx) {
26539bb5c669SPierre Jolivet         if (data->deflation || overlap != -1) weighted = data->aux;
2654f1580f4eSBarry Smith         else if (!data->B) {
2655e2b46ddfSPierre Jolivet           PetscBool cmp;
2656811e8887SPierre Jolivet 
2657f1580f4eSBarry Smith           PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &weighted));
2658e2b46ddfSPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)weighted, &cmp, MATNORMAL, MATNORMALHERMITIAN, ""));
2659e2b46ddfSPierre Jolivet           if (cmp) flg = PETSC_FALSE;
2660e2b46ddfSPierre Jolivet           PetscCall(MatDiagonalScale(weighted, data->levels[0]->D, data->levels[0]->D));
26615b0bb9f2SPierre Jolivet           /* neither MatDuplicate() nor MatDiagonalScale() handles the symmetry options, so propagate the options explicitly */
2662f1580f4eSBarry Smith           /* only useful for -mat_type baij -pc_hpddm_levels_1_st_pc_type cholesky (no problem with MATAIJ or MATSBAIJ)      */
2663f1580f4eSBarry Smith           PetscCall(MatPropagateSymmetryOptions(sub[0], weighted));
2664f1580f4eSBarry Smith         } else weighted = data->B;
266513044ca3SPierre Jolivet       } else weighted = nullptr;
2666f1580f4eSBarry Smith       /* SLEPc is used inside the loaded symbol */
26679bb5c669SPierre 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));
26689bb5c669SPierre Jolivet       if (!ctx && data->share && overlap == -1) {
2669f1580f4eSBarry Smith         Mat st[2];
2670f1580f4eSBarry Smith         PetscCall(KSPGetOperators(ksp[0], st, st + 1));
26715c7345deSPierre Jolivet         PetscCall(MatCopy(subA[0], st[0], structure));
2672f1580f4eSBarry Smith         if (subA[1] != subA[0] || st[1] != st[0]) PetscCall(MatCopy(subA[1], st[1], SAME_NONZERO_PATTERN));
26730307214fSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)subA[0]));
2674f1580f4eSBarry Smith       }
2675db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2676f1580f4eSBarry Smith       if (ismatis) PetscCall(MatISGetLocalMat(C, &N));
2677f1580f4eSBarry Smith       else N = data->aux;
267813044ca3SPierre Jolivet       if (!ctx) P = sub[0];
267913044ca3SPierre Jolivet       else P = S;
2680f1580f4eSBarry Smith       /* going through the grid hierarchy */
2681f1580f4eSBarry Smith       for (n = 1; n < data->N; ++n) {
2682db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2683f1580f4eSBarry Smith         /* method composed in the loaded symbol since there, SLEPc is used as well */
2684f1580f4eSBarry 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));
2685db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2686f1580f4eSBarry Smith       }
2687f1580f4eSBarry Smith       /* reset to NULL to avoid any faulty use */
2688db4a47b3SPierre Jolivet       PetscCall(PetscObjectComposeFunction((PetscObject)data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", nullptr));
2689db4a47b3SPierre Jolivet       if (!ismatis) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_C", nullptr));
2690f1580f4eSBarry Smith       else PetscCall(PetscObjectDereference((PetscObject)C)); /* matching PetscObjectReference() above */
2691f1580f4eSBarry Smith       for (n = 0; n < data->N - 1; ++n)
2692f1580f4eSBarry Smith         if (data->levels[n]->P) {
2693f1580f4eSBarry Smith           /* HPDDM internal work buffers */
2694f1580f4eSBarry Smith           data->levels[n]->P->setBuffer();
2695f1580f4eSBarry Smith           data->levels[n]->P->super::start();
2696f1580f4eSBarry Smith         }
26979bb5c669SPierre Jolivet       if (ismatis || !subdomains) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
2698db4a47b3SPierre Jolivet       if (ismatis) data->is = nullptr;
2699f1580f4eSBarry Smith       for (n = 0; n < data->N - 1 + (reused > 0); ++n) {
2700f1580f4eSBarry Smith         if (data->levels[n]->P) {
2701f1580f4eSBarry Smith           PC spc;
2702f1580f4eSBarry Smith 
2703f1580f4eSBarry Smith           /* force the PC to be PCSHELL to do the coarse grid corrections */
2704f1580f4eSBarry Smith           PetscCall(KSPSetSkipPCSetFromOptions(data->levels[n]->ksp, PETSC_TRUE));
2705f1580f4eSBarry Smith           PetscCall(KSPGetPC(data->levels[n]->ksp, &spc));
2706f1580f4eSBarry Smith           PetscCall(PCSetType(spc, PCSHELL));
2707f1580f4eSBarry Smith           PetscCall(PCShellSetContext(spc, data->levels[n]));
2708f1580f4eSBarry Smith           PetscCall(PCShellSetSetUp(spc, PCSetUp_HPDDMShell));
2709f1580f4eSBarry Smith           PetscCall(PCShellSetApply(spc, PCApply_HPDDMShell));
2710f1580f4eSBarry Smith           PetscCall(PCShellSetMatApply(spc, PCMatApply_HPDDMShell));
2711*d4f06b61SRaphael Zanella           PetscCall(PCShellSetApplyTranspose(spc, PCApplyTranspose_HPDDMShell));
271213044ca3SPierre Jolivet           if (ctx && n == 0) {
271313044ca3SPierre Jolivet             Mat                               Amat, Pmat;
271413044ca3SPierre Jolivet             PetscInt                          m, M;
271501e3c840SPierre Jolivet             std::tuple<Mat, PetscSF, Vec[2]> *ctx;
271613044ca3SPierre Jolivet 
271713044ca3SPierre Jolivet             PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &Pmat));
271813044ca3SPierre Jolivet             PetscCall(MatGetLocalSize(Pmat, &m, nullptr));
271913044ca3SPierre Jolivet             PetscCall(MatGetSize(Pmat, &M, nullptr));
272013044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));
272113044ca3SPierre Jolivet             std::get<0>(*ctx) = S;
272213044ca3SPierre Jolivet             std::get<1>(*ctx) = data->levels[n]->scatter;
272313044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)data->levels[n]->ksp), m, m, M, M, ctx, &Amat));
272413044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT, (void (*)(void))MatMult_Schur<false>));
272513044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMult_Schur<true>));
272613044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_DESTROY, (void (*)(void))MatDestroy_Schur));
272713044ca3SPierre Jolivet             PetscCall(MatCreateVecs(S, std::get<2>(*ctx), std::get<2>(*ctx) + 1));
272813044ca3SPierre Jolivet             PetscCall(KSPSetOperators(data->levels[n]->ksp, Amat, Pmat));
272913044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)Amat));
273013044ca3SPierre Jolivet           }
2731f1580f4eSBarry Smith           PetscCall(PCShellSetDestroy(spc, PCDestroy_HPDDMShell));
2732f1580f4eSBarry Smith           if (!data->levels[n]->pc) PetscCall(PCCreate(PetscObjectComm((PetscObject)data->levels[n]->ksp), &data->levels[n]->pc));
2733f1580f4eSBarry Smith           if (n < reused) {
2734f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(spc, PETSC_TRUE));
2735f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
2736f1580f4eSBarry Smith           }
2737f1580f4eSBarry Smith           PetscCall(PCSetUp(spc));
2738f1580f4eSBarry Smith         }
2739f1580f4eSBarry Smith       }
274013044ca3SPierre Jolivet       if (ctx) PetscCall(MatDestroy(&S));
27419bb5c669SPierre Jolivet       if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", nullptr));
2742f1580f4eSBarry Smith     } else flg = reused ? PETSC_FALSE : PETSC_TRUE;
2743f1580f4eSBarry Smith     if (!ismatis && subdomains) {
2744f1580f4eSBarry Smith       if (flg) PetscCall(KSPGetPC(data->levels[0]->ksp, &inner));
2745f1580f4eSBarry Smith       else inner = data->levels[0]->pc;
2746f1580f4eSBarry Smith       if (inner) {
2747398c7888SPierre Jolivet         if (!inner->setupcalled) PetscCall(PCSetType(inner, PCASM));
2748398c7888SPierre Jolivet         PetscCall(PCSetFromOptions(inner));
2749398c7888SPierre Jolivet         PetscCall(PetscStrcmp(((PetscObject)inner)->type_name, PCASM, &flg));
2750398c7888SPierre Jolivet         if (flg) {
2751f1580f4eSBarry Smith           if (!inner->setupcalled) { /* evaluates to PETSC_FALSE when -pc_hpddm_block_splitting */
2752398c7888SPierre Jolivet             IS sorted;               /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2753811e8887SPierre Jolivet 
2754398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2755398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(inner, 1, &sorted, &loc));
2756398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2757398c7888SPierre Jolivet           }
2758c8ea6600SPierre Jolivet           if (!PetscBool3ToBool(data->Neumann) && data->N > 1) { /* subdomain matrices are already created for the eigenproblem, reuse them for the fine-level PC */
2759db4a47b3SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(*is, nullptr, nullptr, sub[0], &P, nullptr));
2760398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(inner, P, algebraic));
2761398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)P));
2762f1580f4eSBarry Smith           }
2763f1580f4eSBarry Smith         }
2764f1580f4eSBarry Smith       }
27659bb5c669SPierre Jolivet       if (data->N > 1) {
27669bb5c669SPierre Jolivet         if (overlap != 1) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
27679bb5c669SPierre Jolivet         if (overlap == 1) PetscCall(MatDestroy(subA));
27689bb5c669SPierre Jolivet       }
2769f1580f4eSBarry Smith     }
2770f1580f4eSBarry Smith     PetscCall(ISDestroy(&loc));
2771f1580f4eSBarry Smith   } else data->N = 1 + reused; /* enforce this value to 1 + reused if there is no way to build another level */
2772f1580f4eSBarry Smith   if (requested != data->N + reused) {
2773f1580f4eSBarry 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,
2774f1580f4eSBarry Smith                         data->N, pcpre ? pcpre : ""));
2775b5a302b3SPierre 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 : "",
2776b5a302b3SPierre Jolivet                         data->N, pcpre ? pcpre : "", data->N));
2777f1580f4eSBarry Smith     /* cannot use PCDestroy_HPDDMShell() because PCSHELL not set for unassembled levels */
2778f1580f4eSBarry Smith     for (n = data->N - 1; n < requested - 1; ++n) {
2779f1580f4eSBarry Smith       if (data->levels[n]->P) {
2780f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[n], PETSC_TRUE));
2781f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(1, &data->levels[n]->v[0]));
2782f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(2, &data->levels[n]->v[1]));
2783f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V));
2784f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 1));
2785f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 2));
2786f1580f4eSBarry Smith         PetscCall(VecDestroy(&data->levels[n]->D));
278701e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&data->levels[n]->scatter));
2788f1580f4eSBarry Smith       }
2789f1580f4eSBarry Smith     }
2790f1580f4eSBarry Smith     if (reused) {
2791f1580f4eSBarry Smith       for (n = reused; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
2792f1580f4eSBarry Smith         PetscCall(KSPDestroy(&data->levels[n]->ksp));
2793f1580f4eSBarry Smith         PetscCall(PCDestroy(&data->levels[n]->pc));
2794f1580f4eSBarry Smith       }
2795f1580f4eSBarry Smith     }
2796b5a302b3SPierre 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,
2797b5a302b3SPierre Jolivet                data->N, reused, data->N, pcpre ? pcpre : "", pcpre ? pcpre : "", data->N, pcpre ? pcpre : "", data->N);
2798f1580f4eSBarry Smith   }
2799f1580f4eSBarry Smith   /* these solvers are created after PCSetFromOptions() is called */
2800f1580f4eSBarry Smith   if (pc->setfromoptionscalled) {
2801f1580f4eSBarry Smith     for (n = 0; n < data->N; ++n) {
2802f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetFromOptions(data->levels[n]->ksp));
2803f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetFromOptions(data->levels[n]->pc));
2804f1580f4eSBarry Smith     }
2805f1580f4eSBarry Smith     pc->setfromoptionscalled = 0;
2806f1580f4eSBarry Smith   }
2807f1580f4eSBarry Smith   data->N += reused;
2808f1580f4eSBarry Smith   if (data->share && swap) {
2809f1580f4eSBarry Smith     /* swap back pointers so that variables follow the user-provided numbering */
2810f1580f4eSBarry Smith     std::swap(C, data->aux);
2811f1580f4eSBarry Smith     std::swap(uis, data->is);
2812f1580f4eSBarry Smith     PetscCall(MatDestroy(&C));
2813f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
2814f1580f4eSBarry Smith   }
2815398c7888SPierre Jolivet   if (algebraic) PetscCall(MatDestroy(&data->aux));
281638fb34a1SPierre Jolivet   if (unsorted && unsorted != is[0]) {
2817398c7888SPierre Jolivet     PetscCall(ISCopy(unsorted, data->is));
2818398c7888SPierre Jolivet     PetscCall(ISDestroy(&unsorted));
2819398c7888SPierre Jolivet   }
2820398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2821398c7888SPierre 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);
2822398c7888SPierre Jolivet   if (data->is) {
2823398c7888SPierre Jolivet     PetscCall(ISEqualUnsorted(data->is, dis, &flg));
2824398c7888SPierre Jolivet     PetscCall(ISDestroy(&dis));
2825398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input IS and output IS are not equal");
2826398c7888SPierre Jolivet   }
2827398c7888SPierre 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);
2828398c7888SPierre Jolivet   if (data->aux) {
2829398c7888SPierre Jolivet     PetscCall(MatMultEqual(data->aux, daux, 20, &flg));
2830398c7888SPierre Jolivet     PetscCall(MatDestroy(&daux));
2831398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input Mat and output Mat are not equal");
2832398c7888SPierre Jolivet   }
2833398c7888SPierre Jolivet #endif
28343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2835f1580f4eSBarry Smith }
2836f1580f4eSBarry Smith 
2837f1580f4eSBarry Smith /*@
2838f1580f4eSBarry Smith   PCHPDDMSetCoarseCorrectionType - Sets the coarse correction type.
2839f1580f4eSBarry Smith 
2840c3339decSBarry Smith   Collective
2841f1580f4eSBarry Smith 
2842f1580f4eSBarry Smith   Input Parameters:
2843f1580f4eSBarry Smith + pc   - preconditioner context
2844aa1539e9SPierre Jolivet - type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2845f1580f4eSBarry Smith 
2846f1580f4eSBarry Smith   Options Database Key:
2847aa1539e9SPierre Jolivet . -pc_hpddm_coarse_correction <deflated, additive, balanced, none> - type of coarse correction to apply
2848f1580f4eSBarry Smith 
2849f1580f4eSBarry Smith   Level: intermediate
2850f1580f4eSBarry Smith 
2851562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2852f1580f4eSBarry Smith @*/
2853d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType type)
2854d71ae5a4SJacob Faibussowitsch {
2855f1580f4eSBarry Smith   PetscFunctionBegin;
2856f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2857f1580f4eSBarry Smith   PetscValidLogicalCollectiveEnum(pc, type, 2);
2858f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMSetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType), (pc, type));
28593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2860f1580f4eSBarry Smith }
2861f1580f4eSBarry Smith 
2862f1580f4eSBarry Smith /*@
2863f1580f4eSBarry Smith   PCHPDDMGetCoarseCorrectionType - Gets the coarse correction type.
2864f1580f4eSBarry Smith 
2865f1580f4eSBarry Smith   Input Parameter:
2866f1580f4eSBarry Smith . pc - preconditioner context
2867f1580f4eSBarry Smith 
2868f1580f4eSBarry Smith   Output Parameter:
2869aa1539e9SPierre Jolivet . type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2870f1580f4eSBarry Smith 
2871f1580f4eSBarry Smith   Level: intermediate
2872f1580f4eSBarry Smith 
2873562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2874f1580f4eSBarry Smith @*/
2875d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType *type)
2876d71ae5a4SJacob Faibussowitsch {
2877f1580f4eSBarry Smith   PetscFunctionBegin;
2878f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2879f1580f4eSBarry Smith   if (type) {
28804f572ea9SToby Isaac     PetscAssertPointer(type, 2);
2881f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType *), (pc, type));
2882f1580f4eSBarry Smith   }
28833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2884f1580f4eSBarry Smith }
2885f1580f4eSBarry Smith 
2886d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType type)
2887d71ae5a4SJacob Faibussowitsch {
2888f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2889f1580f4eSBarry Smith 
2890f1580f4eSBarry Smith   PetscFunctionBegin;
2891f1580f4eSBarry Smith   data->correction = type;
28923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2893f1580f4eSBarry Smith }
2894f1580f4eSBarry Smith 
2895d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType *type)
2896d71ae5a4SJacob Faibussowitsch {
2897f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2898f1580f4eSBarry Smith 
2899f1580f4eSBarry Smith   PetscFunctionBegin;
2900f1580f4eSBarry Smith   *type = data->correction;
29013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2902f1580f4eSBarry Smith }
2903f1580f4eSBarry Smith 
2904f1580f4eSBarry Smith /*@
2905e31fc274SPierre Jolivet   PCHPDDMSetSTShareSubKSP - Sets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver should be shared.
2906e31fc274SPierre Jolivet 
2907e31fc274SPierre Jolivet   Input Parameters:
2908e31fc274SPierre Jolivet + pc    - preconditioner context
2909e31fc274SPierre Jolivet - share - whether the `KSP` should be shared or not
2910e31fc274SPierre Jolivet 
2911e31fc274SPierre Jolivet   Note:
2912e31fc274SPierre Jolivet   This is not the same as `PCSetReusePreconditioner()`. Given certain conditions (visible using -info), a symbolic factorization can be skipped
2913e31fc274SPierre Jolivet   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2914e31fc274SPierre Jolivet 
2915e31fc274SPierre Jolivet   Level: advanced
2916e31fc274SPierre Jolivet 
2917562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMGetSTShareSubKSP()`
2918e31fc274SPierre Jolivet @*/
2919e31fc274SPierre Jolivet PetscErrorCode PCHPDDMSetSTShareSubKSP(PC pc, PetscBool share)
2920e31fc274SPierre Jolivet {
2921e31fc274SPierre Jolivet   PetscFunctionBegin;
2922e31fc274SPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2923e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetSTShareSubKSP_C", (PC, PetscBool), (pc, share));
29243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2925e31fc274SPierre Jolivet }
2926e31fc274SPierre Jolivet 
2927e31fc274SPierre Jolivet /*@
2928f1580f4eSBarry Smith   PCHPDDMGetSTShareSubKSP - Gets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver is shared.
2929f1580f4eSBarry Smith 
2930f1580f4eSBarry Smith   Input Parameter:
2931f1580f4eSBarry Smith . pc - preconditioner context
2932f1580f4eSBarry Smith 
2933f1580f4eSBarry Smith   Output Parameter:
2934f1580f4eSBarry Smith . share - whether the `KSP` is shared or not
2935f1580f4eSBarry Smith 
2936f1580f4eSBarry Smith   Note:
2937f1580f4eSBarry 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
2938f1580f4eSBarry Smith   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2939f1580f4eSBarry Smith 
2940f1580f4eSBarry Smith   Level: advanced
2941f1580f4eSBarry Smith 
2942562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetSTShareSubKSP()`
2943f1580f4eSBarry Smith @*/
2944d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetSTShareSubKSP(PC pc, PetscBool *share)
2945d71ae5a4SJacob Faibussowitsch {
2946f1580f4eSBarry Smith   PetscFunctionBegin;
2947f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2948f1580f4eSBarry Smith   if (share) {
29494f572ea9SToby Isaac     PetscAssertPointer(share, 2);
2950f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetSTShareSubKSP_C", (PC, PetscBool *), (pc, share));
2951f1580f4eSBarry Smith   }
29523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2953f1580f4eSBarry Smith }
2954f1580f4eSBarry Smith 
2955e31fc274SPierre Jolivet static PetscErrorCode PCHPDDMSetSTShareSubKSP_HPDDM(PC pc, PetscBool share)
2956e31fc274SPierre Jolivet {
2957e31fc274SPierre Jolivet   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2958e31fc274SPierre Jolivet 
2959e31fc274SPierre Jolivet   PetscFunctionBegin;
2960e31fc274SPierre Jolivet   data->share = share;
29613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2962e31fc274SPierre Jolivet }
2963e31fc274SPierre Jolivet 
2964d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetSTShareSubKSP_HPDDM(PC pc, PetscBool *share)
2965d71ae5a4SJacob Faibussowitsch {
2966f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2967f1580f4eSBarry Smith 
2968f1580f4eSBarry Smith   PetscFunctionBegin;
2969f1580f4eSBarry Smith   *share = data->share;
29703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2971f1580f4eSBarry Smith }
2972f1580f4eSBarry Smith 
2973f1580f4eSBarry Smith /*@
2974f1580f4eSBarry Smith   PCHPDDMSetDeflationMat - Sets the deflation space used to assemble a coarser operator.
2975f1580f4eSBarry Smith 
2976f1580f4eSBarry Smith   Input Parameters:
2977f1580f4eSBarry Smith + pc - preconditioner context
2978f1580f4eSBarry Smith . is - index set of the local deflation matrix
2979f1580f4eSBarry Smith - U  - deflation sequential matrix stored as a `MATSEQDENSE`
2980f1580f4eSBarry Smith 
2981f1580f4eSBarry Smith   Level: advanced
2982f1580f4eSBarry Smith 
2983562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCDeflationSetSpace()`, `PCMGSetRestriction()`
2984f1580f4eSBarry Smith @*/
2985d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetDeflationMat(PC pc, IS is, Mat U)
2986d71ae5a4SJacob Faibussowitsch {
2987f1580f4eSBarry Smith   PetscFunctionBegin;
2988f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2989f1580f4eSBarry Smith   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
2990f1580f4eSBarry Smith   PetscValidHeaderSpecific(U, MAT_CLASSID, 3);
2991e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetDeflationMat_C", (PC, IS, Mat), (pc, is, U));
29923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2993f1580f4eSBarry Smith }
2994f1580f4eSBarry Smith 
2995d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetDeflationMat_HPDDM(PC pc, IS is, Mat U)
2996d71ae5a4SJacob Faibussowitsch {
2997f1580f4eSBarry Smith   PetscFunctionBegin;
2998f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, U, PETSC_TRUE));
29993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3000f1580f4eSBarry Smith }
3001f1580f4eSBarry Smith 
3002d71ae5a4SJacob Faibussowitsch PetscErrorCode HPDDMLoadDL_Private(PetscBool *found)
3003d71ae5a4SJacob Faibussowitsch {
3004605ad303SPierre Jolivet   PetscBool flg;
3005f1580f4eSBarry Smith   char      lib[PETSC_MAX_PATH_LEN], dlib[PETSC_MAX_PATH_LEN], dir[PETSC_MAX_PATH_LEN];
3006f1580f4eSBarry Smith 
3007f1580f4eSBarry Smith   PetscFunctionBegin;
30084f572ea9SToby Isaac   PetscAssertPointer(found, 1);
3009c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(dir, "${PETSC_LIB_DIR}", sizeof(dir)));
3010db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, nullptr, "-hpddm_dir", dir, sizeof(dir), nullptr));
3011f1580f4eSBarry Smith   PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
3012f1580f4eSBarry Smith   PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3013605ad303SPierre Jolivet #if defined(SLEPC_LIB_DIR) /* this variable is passed during SLEPc ./configure when PETSc has not been configured   */
3014605ad303SPierre Jolivet   if (!*found) {           /* with --download-hpddm since slepcconf.h is not yet built (and thus can't be included) */
3015c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(dir, HPDDM_STR(SLEPC_LIB_DIR), sizeof(dir)));
3016f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
3017f1580f4eSBarry Smith     PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3018f1580f4eSBarry Smith   }
3019f1580f4eSBarry Smith #endif
3020605ad303SPierre 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 */
3021605ad303SPierre Jolivet     PetscCall(PetscOptionsGetenv(PETSC_COMM_SELF, "SLEPC_DIR", dir, sizeof(dir), &flg));
3022605ad303SPierre 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 */
3023605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libslepc", dir));
3024605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3025605ad303SPierre Jolivet       PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found but SLEPC_DIR=%s", lib, dir);
3026605ad303SPierre Jolivet       PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
3027605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libhpddm_petsc", dir)); /* libhpddm_petsc is always in the same directory as libslepc */
3028605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
3029605ad303SPierre Jolivet     }
3030605ad303SPierre Jolivet   }
3031f1580f4eSBarry Smith   PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found", lib);
3032f1580f4eSBarry Smith   PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
30333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3034f1580f4eSBarry Smith }
3035f1580f4eSBarry Smith 
3036f1580f4eSBarry Smith /*MC
3037f1580f4eSBarry Smith    PCHPDDM - Interface with the HPDDM library.
3038f1580f4eSBarry Smith 
30391d27aa22SBarry Smith    This `PC` may be used to build multilevel spectral domain decomposition methods based on the GenEO framework {cite}`spillane2011robust` {cite}`al2021multilevel`.
30401d27aa22SBarry Smith    It may be viewed as an alternative to spectral
30411d27aa22SBarry Smith    AMGe or `PCBDDC` with adaptive selection of constraints. The interface is explained in details in {cite}`jolivetromanzampini2020`
3042f1580f4eSBarry Smith 
3043e7593814SPierre 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`).
3044f1580f4eSBarry Smith 
3045f1580f4eSBarry Smith    For multilevel preconditioning, when using an assembled or hierarchical Pmat, one must provide an auxiliary local `Mat` (unassembled local operator for GenEO) using
3046f1580f4eSBarry Smith    `PCHPDDMSetAuxiliaryMat()`. Calling this routine is not needed when using a `MATIS` Pmat, assembly is done internally using `MatConvert()`.
3047f1580f4eSBarry Smith 
3048f1580f4eSBarry Smith    Options Database Keys:
3049f1580f4eSBarry Smith +   -pc_hpddm_define_subdomains <true, default=false>    - on the finest level, calls `PCASMSetLocalSubdomains()` with the `IS` supplied in `PCHPDDMSetAuxiliaryMat()`
3050f1580f4eSBarry Smith                                                          (not relevant with an unassembled Pmat)
3051f1580f4eSBarry Smith .   -pc_hpddm_has_neumann <true, default=false>          - on the finest level, informs the `PC` that the local Neumann matrix is supplied in `PCHPDDMSetAuxiliaryMat()`
3052f1580f4eSBarry Smith -   -pc_hpddm_coarse_correction <type, default=deflated> - determines the `PCHPDDMCoarseCorrectionType` when calling `PCApply()`
3053f1580f4eSBarry Smith 
305438bf2a8cSPierre Jolivet    Options for subdomain solvers, subdomain eigensolvers (for computing deflation vectors), and the coarse solver can be set using the following options database prefixes.
3055f1580f4eSBarry Smith .vb
3056f1580f4eSBarry Smith       -pc_hpddm_levels_%d_pc_
3057f1580f4eSBarry Smith       -pc_hpddm_levels_%d_ksp_
3058f1580f4eSBarry Smith       -pc_hpddm_levels_%d_eps_
3059f1580f4eSBarry Smith       -pc_hpddm_levels_%d_p
30604ec2a359SPierre Jolivet       -pc_hpddm_levels_%d_mat_type
3061f1580f4eSBarry Smith       -pc_hpddm_coarse_
3062f1580f4eSBarry Smith       -pc_hpddm_coarse_p
30634ec2a359SPierre Jolivet       -pc_hpddm_coarse_mat_type
30642ce66baaSPierre Jolivet       -pc_hpddm_coarse_mat_filter
3065f1580f4eSBarry Smith .ve
3066f1580f4eSBarry Smith 
306738bf2a8cSPierre 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
3068f1580f4eSBarry Smith     -pc_hpddm_coarse_p 2 -pc_hpddm_coarse_mat_type baij will use 10 deflation vectors per subdomain on the fine "level 1",
3069f1580f4eSBarry Smith     aggregate the fine subdomains into 4 "level 2" subdomains, then use 10 deflation vectors per subdomain on "level 2",
30707eb095acSPierre Jolivet     and assemble the coarse matrix (of dimension 4 x 10 = 40) on two processes as a `MATBAIJ` (default is `MATSBAIJ`).
3071f1580f4eSBarry Smith 
3072b5a302b3SPierre 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.
3073f1580f4eSBarry Smith 
30741d27aa22SBarry Smith    Level: intermediate
30751d27aa22SBarry Smith 
30761d27aa22SBarry Smith    Notes:
30771d27aa22SBarry Smith    This preconditioner requires that PETSc is built with SLEPc (``--download-slepc``).
30781d27aa22SBarry Smith 
30791d27aa22SBarry Smith    By default, the underlying concurrent eigenproblems
30801d27aa22SBarry Smith    are solved using SLEPc shift-and-invert spectral transformation. This is usually what gives the best performance for GenEO, cf.
30811d27aa22SBarry Smith    {cite}`spillane2011robust` {cite}`jolivet2013scalabledd`. As
308238bf2a8cSPierre 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
308338bf2a8cSPierre 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
308438bf2a8cSPierre Jolivet    SLEPc documentation since they are specific to `PCHPDDM`.
308538bf2a8cSPierre Jolivet .vb
308638bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_st_share_sub_ksp
3087b5a302b3SPierre Jolivet       -pc_hpddm_levels_%d_eps_threshold_absolute
308838bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_eps_use_inertia
308938bf2a8cSPierre Jolivet .ve
309038bf2a8cSPierre Jolivet 
309138bf2a8cSPierre Jolivet    The first option from the list only applies to the fine-level eigensolver, see `PCHPDDMSetSTShareSubKSP()`. The second option from the list is
309238bf2a8cSPierre Jolivet    used to filter eigenmodes retrieved after convergence of `EPSSolve()` at "level N" such that eigenvectors used to define a "level N+1" coarse
3093b5a302b3SPierre 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
309438bf2a8cSPierre 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
309538bf2a8cSPierre 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
309638bf2a8cSPierre Jolivet    to supply -pc_hpddm_levels_1_eps_nev. This last option also only applies to the fine-level (N = 1) eigensolver.
3097f1580f4eSBarry Smith 
30981d27aa22SBarry Smith    See also {cite}`dolean2015introduction`, {cite}`al2022robust`, {cite}`al2022robustpd`, and {cite}`nataf2022recent`
3099f1580f4eSBarry Smith 
3100562efe2eSBarry Smith .seealso: [](ch_ksp), `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetAuxiliaryMat()`, `MATIS`, `PCBDDC`, `PCDEFLATION`, `PCTELESCOPE`, `PCASM`,
3101e31fc274SPierre Jolivet           `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDMHasNeumannMat()`, `PCHPDDMSetRHSMat()`, `PCHPDDMSetDeflationMat()`, `PCHPDDMSetSTShareSubKSP()`,
3102e31fc274SPierre Jolivet           `PCHPDDMGetSTShareSubKSP()`, `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDMGetComplexities()`
3103f1580f4eSBarry Smith M*/
3104d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_HPDDM(PC pc)
3105d71ae5a4SJacob Faibussowitsch {
3106f1580f4eSBarry Smith   PC_HPDDM *data;
3107f1580f4eSBarry Smith   PetscBool found;
3108f1580f4eSBarry Smith 
3109f1580f4eSBarry Smith   PetscFunctionBegin;
3110f1580f4eSBarry Smith   if (!loadedSym) {
3111f1580f4eSBarry Smith     PetscCall(HPDDMLoadDL_Private(&found));
3112db4a47b3SPierre Jolivet     if (found) PetscCall(PetscDLLibrarySym(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, nullptr, "PCHPDDM_Internal", (void **)&loadedSym));
3113f1580f4eSBarry Smith   }
3114f1580f4eSBarry Smith   PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCHPDDM_Internal symbol not found in loaded libhpddm_petsc");
31154dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&data));
3116f1580f4eSBarry Smith   pc->data                = data;
3117c8ea6600SPierre Jolivet   data->Neumann           = PETSC_BOOL3_UNKNOWN;
3118f1580f4eSBarry Smith   pc->ops->reset          = PCReset_HPDDM;
3119f1580f4eSBarry Smith   pc->ops->destroy        = PCDestroy_HPDDM;
3120f1580f4eSBarry Smith   pc->ops->setfromoptions = PCSetFromOptions_HPDDM;
3121f1580f4eSBarry Smith   pc->ops->setup          = PCSetUp_HPDDM;
3122*d4f06b61SRaphael Zanella   pc->ops->apply          = PCApply_HPDDM<false>;
3123f1580f4eSBarry Smith   pc->ops->matapply       = PCMatApply_HPDDM;
3124*d4f06b61SRaphael Zanella   pc->ops->applytranspose = PCApply_HPDDM<true>;
3125f1580f4eSBarry Smith   pc->ops->view           = PCView_HPDDM;
3126f1580f4eSBarry Smith   pc->ops->presolve       = PCPreSolve_HPDDM;
3127f1580f4eSBarry Smith 
3128f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", PCHPDDMSetAuxiliaryMat_HPDDM));
3129f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", PCHPDDMHasNeumannMat_HPDDM));
3130f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", PCHPDDMSetRHSMat_HPDDM));
3131f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", PCHPDDMSetCoarseCorrectionType_HPDDM));
3132f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", PCHPDDMGetCoarseCorrectionType_HPDDM));
3133e31fc274SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", PCHPDDMSetSTShareSubKSP_HPDDM));
3134f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", PCHPDDMGetSTShareSubKSP_HPDDM));
3135f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", PCHPDDMSetDeflationMat_HPDDM));
31363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3137f1580f4eSBarry Smith }
3138f1580f4eSBarry Smith 
3139f1580f4eSBarry Smith /*@C
3140f1580f4eSBarry Smith   PCHPDDMInitializePackage - This function initializes everything in the `PCHPDDM` package. It is called from `PCInitializePackage()`.
3141f1580f4eSBarry Smith 
3142f1580f4eSBarry Smith   Level: developer
3143f1580f4eSBarry Smith 
3144562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscInitialize()`
3145f1580f4eSBarry Smith @*/
3146d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMInitializePackage(void)
3147d71ae5a4SJacob Faibussowitsch {
3148f1580f4eSBarry Smith   char ename[32];
3149f1580f4eSBarry Smith 
3150f1580f4eSBarry Smith   PetscFunctionBegin;
31513ba16761SJacob Faibussowitsch   if (PCHPDDMPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
3152f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_TRUE;
3153f1580f4eSBarry Smith   PetscCall(PetscRegisterFinalize(PCHPDDMFinalizePackage));
3154f1580f4eSBarry Smith   /* general events registered once during package initialization */
3155f1580f4eSBarry Smith   /* some of these events are not triggered in libpetsc,          */
3156f1580f4eSBarry Smith   /* but rather directly in libhpddm_petsc,                       */
3157f1580f4eSBarry Smith   /* which is in charge of performing the following operations    */
3158f1580f4eSBarry Smith 
3159f1580f4eSBarry Smith   /* domain decomposition structure from Pmat sparsity pattern    */
3160f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMStrc", PC_CLASSID, &PC_HPDDM_Strc));
3161f1580f4eSBarry Smith   /* Galerkin product, redistribution, and setup (not triggered in libpetsc)                */
3162f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtAP", PC_CLASSID, &PC_HPDDM_PtAP));
3163f1580f4eSBarry Smith   /* Galerkin product with summation, redistribution, and setup (not triggered in libpetsc) */
3164f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtBP", PC_CLASSID, &PC_HPDDM_PtBP));
3165f1580f4eSBarry Smith   /* next level construction using PtAP and PtBP (not triggered in libpetsc)                */
3166f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMNext", PC_CLASSID, &PC_HPDDM_Next));
3167f1580f4eSBarry Smith   static_assert(PETSC_PCHPDDM_MAXLEVELS <= 9, "PETSC_PCHPDDM_MAXLEVELS value is too high");
3168811e8887SPierre Jolivet   for (PetscInt i = 1; i < PETSC_PCHPDDM_MAXLEVELS; ++i) {
3169f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSetUp L%1" PetscInt_FMT, i));
3170f1580f4eSBarry Smith     /* events during a PCSetUp() at level #i _except_ the assembly */
3171f1580f4eSBarry Smith     /* of the Galerkin operator of the coarser level #(i + 1)      */
3172f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_SetUp[i - 1]));
3173f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSolve L%1" PetscInt_FMT, i));
3174f1580f4eSBarry Smith     /* events during a PCApply() at level #i _except_              */
3175f1580f4eSBarry Smith     /* the KSPSolve() of the coarser level #(i + 1)                */
3176f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_Solve[i - 1]));
3177f1580f4eSBarry Smith   }
31783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3179f1580f4eSBarry Smith }
3180f1580f4eSBarry Smith 
3181f1580f4eSBarry Smith /*@C
3182f1580f4eSBarry Smith   PCHPDDMFinalizePackage - This function frees everything from the `PCHPDDM` package. It is called from `PetscFinalize()`.
3183f1580f4eSBarry Smith 
3184f1580f4eSBarry Smith   Level: developer
3185f1580f4eSBarry Smith 
3186562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscFinalize()`
3187f1580f4eSBarry Smith @*/
3188d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMFinalizePackage(void)
3189d71ae5a4SJacob Faibussowitsch {
3190f1580f4eSBarry Smith   PetscFunctionBegin;
3191f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_FALSE;
31923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3193f1580f4eSBarry Smith }
31949bb5c669SPierre Jolivet 
31959bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat A, Vec x, Vec y)
31969bb5c669SPierre Jolivet {
31979bb5c669SPierre Jolivet   Harmonic h; /* [ A_00  A_01       ], furthermore, A_00 = [ A_loc,loc  A_loc,ovl ], thus, A_01 = [         ] */
31989bb5c669SPierre Jolivet               /* [ A_10  A_11  A_12 ]                      [ A_ovl,loc  A_ovl,ovl ]               [ A_ovl,1 ] */
31999bb5c669SPierre Jolivet   Vec sub;    /*  y = A x = R_loc R_0 [ A_00  A_01 ]^-1                                   R_loc = [  I_loc  ] */
32009bb5c669SPierre Jolivet               /*                      [ A_10  A_11 ]    R_1^T A_12 x                              [         ] */
32019bb5c669SPierre Jolivet   PetscFunctionBegin;
32029bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
32039bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
32049bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
32059bb5c669SPierre Jolivet   PetscCall(MatMult(h->A[0], x, sub));
32069bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
32079bb5c669SPierre Jolivet   PetscCall(KSPSolve(h->ksp, h->v, h->v));
32089bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_REVERSE, y));
32099bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
32109bb5c669SPierre Jolivet }
32119bb5c669SPierre Jolivet 
32129bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat A, Vec y, Vec x)
32139bb5c669SPierre Jolivet {
32149bb5c669SPierre Jolivet   Harmonic h;   /* x = A^T y =            [ A_00  A_01 ]^-T R_0^T R_loc^T y */
32159bb5c669SPierre Jolivet   Vec      sub; /*             A_12^T R_1 [ A_10  A_11 ]                    */
32169bb5c669SPierre Jolivet 
32179bb5c669SPierre Jolivet   PetscFunctionBegin;
32189bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
32199bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
32209bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_FORWARD, y));
32219bb5c669SPierre Jolivet   PetscCall(KSPSolveTranspose(h->ksp, h->v, h->v));
32229bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
32239bb5c669SPierre Jolivet   PetscCall(MatMultTranspose(h->A[0], sub, x));
32249bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
32259bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
32269bb5c669SPierre Jolivet }
32279bb5c669SPierre Jolivet 
32289bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat S, Mat X, Mat Y, void *)
32299bb5c669SPierre Jolivet {
32309bb5c669SPierre Jolivet   Harmonic h;
32319bb5c669SPierre Jolivet   Mat      A, B;
32329bb5c669SPierre Jolivet   Vec      a, b;
32339bb5c669SPierre Jolivet 
32349bb5c669SPierre Jolivet   PetscFunctionBegin;
32359bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
3236fb842aefSJose E. Roman   PetscCall(MatMatMult(h->A[0], X, MAT_INITIAL_MATRIX, PETSC_CURRENT, &A));
32379bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
32389bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
32399bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
32409bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B, i, &b));
32419bb5c669SPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_FORWARD, a));
32429bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B, i, &b));
32439bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
32449bb5c669SPierre Jolivet   }
32459bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
32469bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, B->cmap->n, nullptr, &A));
32479bb5c669SPierre Jolivet   PetscCall(KSPMatSolve(h->ksp, B, A));
32489bb5c669SPierre Jolivet   PetscCall(MatDestroy(&B));
32499bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
32509bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
32519bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &b));
32529bb5c669SPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_REVERSE, b));
32539bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &b));
32549bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
32559bb5c669SPierre Jolivet   }
32569bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
32579bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
32589bb5c669SPierre Jolivet }
32599bb5c669SPierre Jolivet 
32609bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat A)
32619bb5c669SPierre Jolivet {
32629bb5c669SPierre Jolivet   Harmonic h;
32639bb5c669SPierre Jolivet 
32649bb5c669SPierre Jolivet   PetscFunctionBegin;
32659bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
326632603206SJames Wright   for (PetscInt i = 0; i < 5; ++i) PetscCall(ISDestroy(h->is + i));
32679bb5c669SPierre Jolivet   PetscCall(PetscFree(h->is));
32689bb5c669SPierre Jolivet   PetscCall(VecDestroy(&h->v));
32699bb5c669SPierre Jolivet   for (PetscInt i = 0; i < 2; ++i) PetscCall(MatDestroy(h->A + i));
32709bb5c669SPierre Jolivet   PetscCall(PetscFree(h->A));
32719bb5c669SPierre Jolivet   PetscCall(KSPDestroy(&h->ksp));
32729bb5c669SPierre Jolivet   PetscCall(PetscFree(h));
32739bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
32749bb5c669SPierre Jolivet }
3275