xref: /petsc/src/ksp/pc/impls/hpddm/pchpddm.cxx (revision 58b7e2c12831107add2e7d2083637d9d213c57af)
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;
74f1580f4eSBarry Smith   if (is) {
75f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)is));
76f1580f4eSBarry Smith     if (data->is) { /* new overlap definition resets the PC */
77f1580f4eSBarry Smith       PetscCall(PCReset_HPDDM(pc));
78f1580f4eSBarry Smith       pc->setfromoptionscalled = 0;
79b853e353SPierre Jolivet       pc->setupcalled          = 0;
80cdbd50ebSPierre Jolivet       data->correction         = type;
81f1580f4eSBarry Smith     }
82f1580f4eSBarry Smith     PetscCall(ISDestroy(&data->is));
83f1580f4eSBarry Smith     data->is = is;
84f1580f4eSBarry Smith   }
85f1580f4eSBarry Smith   if (A) {
86f1580f4eSBarry Smith     PetscCall(PetscObjectReference((PetscObject)A));
87f1580f4eSBarry Smith     PetscCall(MatDestroy(&data->aux));
88f1580f4eSBarry Smith     data->aux = A;
89f1580f4eSBarry Smith   }
90f1580f4eSBarry Smith   data->deflation = deflation;
913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
92f1580f4eSBarry Smith }
93f1580f4eSBarry Smith 
94281f8ce6SPierre Jolivet static inline PetscErrorCode PCHPDDMSplittingMatNormal_Private(Mat A, IS *is, Mat *splitting[])
95281f8ce6SPierre Jolivet {
96281f8ce6SPierre Jolivet   Mat *sub;
97281f8ce6SPierre Jolivet   IS   zero;
98281f8ce6SPierre Jolivet 
99281f8ce6SPierre Jolivet   PetscFunctionBegin;
100281f8ce6SPierre Jolivet   PetscCall(MatSetOption(A, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
101281f8ce6SPierre Jolivet   PetscCall(MatCreateSubMatrices(A, 1, is + 2, is, MAT_INITIAL_MATRIX, splitting));
102281f8ce6SPierre Jolivet   PetscCall(MatCreateSubMatrices(**splitting, 1, is + 2, is + 1, MAT_INITIAL_MATRIX, &sub));
103281f8ce6SPierre Jolivet   PetscCall(MatFindZeroRows(*sub, &zero));
104281f8ce6SPierre Jolivet   PetscCall(MatDestroySubMatrices(1, &sub));
105281f8ce6SPierre Jolivet   PetscCall(MatSetOption(**splitting, MAT_KEEP_NONZERO_PATTERN, PETSC_TRUE));
106281f8ce6SPierre Jolivet   PetscCall(MatZeroRowsIS(**splitting, zero, 0.0, nullptr, nullptr));
107281f8ce6SPierre Jolivet   PetscCall(ISDestroy(&zero));
108281f8ce6SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
109281f8ce6SPierre Jolivet }
110281f8ce6SPierre Jolivet 
111281f8ce6SPierre Jolivet static inline PetscErrorCode PCHPDDMSetAuxiliaryMatNormal_Private(PC pc, Mat A, Mat N, Mat *B, const char *pcpre, Vec *diagonal = nullptr, Mat B01 = nullptr)
112d71ae5a4SJacob Faibussowitsch {
113f1580f4eSBarry Smith   PC_HPDDM *data         = (PC_HPDDM *)pc->data;
114281f8ce6SPierre Jolivet   Mat      *splitting[2] = {}, aux;
1153df4cd7bSPierre Jolivet   Vec       d;
116281f8ce6SPierre Jolivet   IS        is[3];
117f1580f4eSBarry Smith   PetscReal norm;
118f1580f4eSBarry Smith   PetscBool flg;
119f1580f4eSBarry Smith   char      type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
120f1580f4eSBarry Smith 
121f1580f4eSBarry Smith   PetscFunctionBegin;
122281f8ce6SPierre Jolivet   if (!B01) PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, B));
123281f8ce6SPierre Jolivet   else PetscCall(MatTransposeMatMult(B01, A, MAT_INITIAL_MATRIX, PETSC_DETERMINE, B));
124feebddf4SPierre Jolivet   PetscCall(MatEliminateZeros(*B, PETSC_TRUE));
125281f8ce6SPierre Jolivet   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, is));
126281f8ce6SPierre Jolivet   PetscCall(MatIncreaseOverlap(*B, 1, is, 1));
127281f8ce6SPierre Jolivet   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->cmap->n, A->cmap->rstart, 1, is + 2));
128281f8ce6SPierre Jolivet   PetscCall(ISEmbed(is[0], is[2], PETSC_TRUE, is + 1));
129281f8ce6SPierre Jolivet   PetscCall(ISDestroy(is + 2));
130281f8ce6SPierre Jolivet   PetscCall(ISCreateStride(PETSC_COMM_SELF, A->rmap->N, 0, 1, is + 2));
131281f8ce6SPierre Jolivet   PetscCall(PCHPDDMSplittingMatNormal_Private(A, is, &splitting[0]));
132281f8ce6SPierre Jolivet   if (B01) {
133281f8ce6SPierre Jolivet     PetscCall(PCHPDDMSplittingMatNormal_Private(B01, is, &splitting[1]));
134281f8ce6SPierre Jolivet     PetscCall(MatDestroy(&B01));
135281f8ce6SPierre Jolivet   }
136281f8ce6SPierre Jolivet   PetscCall(ISDestroy(is + 2));
137281f8ce6SPierre Jolivet   PetscCall(ISDestroy(is + 1));
138db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_sub_pc_type", type, sizeof(type), nullptr));
139f1580f4eSBarry Smith   PetscCall(PetscStrcmp(type, PCQR, &flg));
140f1580f4eSBarry Smith   if (!flg) {
141281f8ce6SPierre Jolivet     Mat conjugate = *splitting[splitting[1] ? 1 : 0];
142811e8887SPierre Jolivet 
143281f8ce6SPierre Jolivet     if (PetscDefined(USE_COMPLEX) && !splitting[1]) {
144281f8ce6SPierre Jolivet       PetscCall(MatDuplicate(*splitting[0], MAT_COPY_VALUES, &conjugate));
145f1580f4eSBarry Smith       PetscCall(MatConjugate(conjugate));
146f1580f4eSBarry Smith     }
147281f8ce6SPierre Jolivet     PetscCall(MatTransposeMatMult(conjugate, *splitting[0], MAT_INITIAL_MATRIX, PETSC_DETERMINE, &aux));
148281f8ce6SPierre Jolivet     if (PetscDefined(USE_COMPLEX) && !splitting[1]) PetscCall(MatDestroy(&conjugate));
149281f8ce6SPierre Jolivet     else if (splitting[1]) PetscCall(MatDestroySubMatrices(1, &splitting[1]));
150f1580f4eSBarry Smith     PetscCall(MatNorm(aux, NORM_FROBENIUS, &norm));
151f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1523df4cd7bSPierre Jolivet     if (diagonal) {
153811e8887SPierre Jolivet       PetscReal norm;
154811e8887SPierre Jolivet 
155feebddf4SPierre Jolivet       PetscCall(VecScale(*diagonal, -1.0));
1563df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1573df4cd7bSPierre Jolivet       if (norm > PETSC_SMALL) {
15801e3c840SPierre Jolivet         PetscSF  scatter;
1593df4cd7bSPierre Jolivet         PetscInt n;
160811e8887SPierre Jolivet 
161281f8ce6SPierre Jolivet         PetscCall(ISGetLocalSize(*is, &n));
1623df4cd7bSPierre Jolivet         PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)pc), n, PETSC_DECIDE, &d));
163281f8ce6SPierre Jolivet         PetscCall(VecScatterCreate(*diagonal, *is, d, nullptr, &scatter));
1643df4cd7bSPierre Jolivet         PetscCall(VecScatterBegin(scatter, *diagonal, d, INSERT_VALUES, SCATTER_FORWARD));
1653df4cd7bSPierre Jolivet         PetscCall(VecScatterEnd(scatter, *diagonal, d, INSERT_VALUES, SCATTER_FORWARD));
16601e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&scatter));
1673df4cd7bSPierre Jolivet         PetscCall(MatDiagonalSet(aux, d, ADD_VALUES));
1683df4cd7bSPierre Jolivet         PetscCall(VecDestroy(&d));
1693df4cd7bSPierre Jolivet       } else PetscCall(VecDestroy(diagonal));
1703df4cd7bSPierre Jolivet     }
1713df4cd7bSPierre Jolivet     if (!diagonal) PetscCall(MatShift(aux, PETSC_SMALL * norm));
172f1580f4eSBarry Smith   } else {
173f1580f4eSBarry Smith     PetscBool flg;
174811e8887SPierre Jolivet 
175281f8ce6SPierre Jolivet     PetscCheck(!splitting[1], PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot use PCQR when A01 != A10^T");
1763df4cd7bSPierre Jolivet     if (diagonal) {
1773df4cd7bSPierre Jolivet       PetscCall(VecNorm(*diagonal, NORM_INFINITY, &norm));
1783df4cd7bSPierre Jolivet       PetscCheck(norm < PETSC_SMALL, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Nonzero diagonal A11 block");
1793df4cd7bSPierre Jolivet       PetscCall(VecDestroy(diagonal));
1803df4cd7bSPierre Jolivet     }
181f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)N, MATNORMAL, &flg));
182281f8ce6SPierre Jolivet     if (flg) PetscCall(MatCreateNormal(*splitting[0], &aux));
183281f8ce6SPierre Jolivet     else PetscCall(MatCreateNormalHermitian(*splitting[0], &aux));
184f1580f4eSBarry Smith   }
185281f8ce6SPierre Jolivet   PetscCall(MatDestroySubMatrices(1, &splitting[0]));
186281f8ce6SPierre Jolivet   PetscCall(PCHPDDMSetAuxiliaryMat(pc, *is, aux, nullptr, nullptr));
187c8ea6600SPierre Jolivet   data->Neumann = PETSC_BOOL3_TRUE;
188281f8ce6SPierre Jolivet   PetscCall(ISDestroy(is));
189f1580f4eSBarry Smith   PetscCall(MatDestroy(&aux));
1903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
191f1580f4eSBarry Smith }
192f1580f4eSBarry Smith 
193d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetAuxiliaryMat_HPDDM(PC pc, IS is, Mat A, PetscErrorCode (*setup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *setup_ctx)
194d71ae5a4SJacob Faibussowitsch {
195f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
196f1580f4eSBarry Smith 
197f1580f4eSBarry Smith   PetscFunctionBegin;
198f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, A, PETSC_FALSE));
199f1580f4eSBarry Smith   if (setup) {
200f1580f4eSBarry Smith     data->setup     = setup;
201f1580f4eSBarry Smith     data->setup_ctx = setup_ctx;
202f1580f4eSBarry Smith   }
2033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
204f1580f4eSBarry Smith }
205f1580f4eSBarry Smith 
20673329a61SPierre Jolivet typedef struct {
20773329a61SPierre Jolivet   KSP      ksp;
20873329a61SPierre Jolivet   PetscInt its;
20973329a61SPierre Jolivet } PC_KSP;
21073329a61SPierre Jolivet 
21173329a61SPierre Jolivet static inline PetscErrorCode PCSetUp_KSP_Private(PC pc)
21273329a61SPierre Jolivet {
21373329a61SPierre Jolivet   PC_KSP           *data   = (PC_KSP *)pc->data;
21473329a61SPierre Jolivet   const std::string prefix = ((PetscObject)data->ksp)->prefix;
21573329a61SPierre Jolivet   std::string       sub;
21673329a61SPierre Jolivet 
21773329a61SPierre Jolivet   PetscFunctionBegin;
21873329a61SPierre Jolivet   PetscCheck(prefix.size() >= 9, PETSC_COMM_SELF, PETSC_ERR_PLIB, "The prefix of this PCKSP should be of length at least 9 to hold the suffix pc_hpddm_");
21973329a61SPierre Jolivet   sub = prefix.substr(0, prefix.size() - 9);
22073329a61SPierre Jolivet   PetscCall(PCSetType(pc, PCHPDDM));
22173329a61SPierre Jolivet   PetscCall(PCSetOptionsPrefix(pc, sub.c_str()));
22273329a61SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
22373329a61SPierre Jolivet }
22473329a61SPierre Jolivet 
22573329a61SPierre Jolivet static PetscErrorCode PCSetUp_KSP(PC pc)
22673329a61SPierre Jolivet {
22773329a61SPierre Jolivet   PetscFunctionBegin;
22873329a61SPierre Jolivet   PetscCall(PCSetUp_KSP_Private(pc));
22973329a61SPierre Jolivet   PetscCall(PCSetFromOptions(pc));
23073329a61SPierre Jolivet   PetscCall(PCSetUp(pc));
23173329a61SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
23273329a61SPierre Jolivet }
23373329a61SPierre Jolivet 
23470009435SPierre Jolivet /*@C
23504c3f3b8SBarry Smith   PCHPDDMSetAuxiliaryMat - Sets the auxiliary matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
236f1580f4eSBarry Smith 
237f1580f4eSBarry Smith   Input Parameters:
238f1580f4eSBarry Smith + pc    - preconditioner context
239f1580f4eSBarry Smith . is    - index set of the local auxiliary, e.g., Neumann, matrix
240f1580f4eSBarry Smith . A     - auxiliary sequential matrix
24104c3f3b8SBarry Smith . setup - function for generating the auxiliary matrix entries, may be `NULL`
24204c3f3b8SBarry Smith - ctx   - context for `setup`, may be `NULL`
24304c3f3b8SBarry Smith 
24404c3f3b8SBarry Smith   Calling sequence of `setup`:
24504c3f3b8SBarry Smith + J   - matrix whose values are to be set
24604c3f3b8SBarry Smith . t   - time
24704c3f3b8SBarry Smith . X   - linearization point
24804c3f3b8SBarry Smith . X_t - time-derivative of the linearization point
24904c3f3b8SBarry Smith . s   - step
25004c3f3b8SBarry Smith . ovl - index set of the local auxiliary, e.g., Neumann, matrix
25104c3f3b8SBarry Smith - ctx - context for `setup`, may be `NULL`
252f1580f4eSBarry Smith 
253f1580f4eSBarry Smith   Level: intermediate
254f1580f4eSBarry Smith 
25504c3f3b8SBarry Smith   Note:
25604c3f3b8SBarry Smith   As an example, in a finite element context with nonoverlapping subdomains plus (overlapping) ghost elements, this could be the unassembled (Neumann)
25704c3f3b8SBarry Smith   local overlapping operator. As opposed to the assembled (Dirichlet) local overlapping operator obtained by summing neighborhood contributions
25804c3f3b8SBarry Smith   at the interface of ghost elements.
25904c3f3b8SBarry Smith 
26070009435SPierre Jolivet   Fortran Notes:
26104c3f3b8SBarry Smith   Only `PETSC_NULL_FUNCTION` is supported for `setup` and `ctx` is never accessed
26270009435SPierre Jolivet 
263562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetRHSMat()`, `MATIS`
264f1580f4eSBarry Smith @*/
26504c3f3b8SBarry 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)
266d71ae5a4SJacob Faibussowitsch {
267f1580f4eSBarry Smith   PetscFunctionBegin;
268f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
269f1580f4eSBarry Smith   if (is) PetscValidHeaderSpecific(is, IS_CLASSID, 2);
270f1580f4eSBarry Smith   if (A) PetscValidHeaderSpecific(A, MAT_CLASSID, 3);
27173329a61SPierre Jolivet   if (pc->ops->setup == PCSetUp_KSP) PetscCall(PCSetUp_KSP_Private(pc));
27204c3f3b8SBarry Smith   PetscTryMethod(pc, "PCHPDDMSetAuxiliaryMat_C", (PC, IS, Mat, PetscErrorCode (*)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void *), (pc, is, A, setup, ctx));
2733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
274f1580f4eSBarry Smith }
275f1580f4eSBarry Smith 
276d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMHasNeumannMat_HPDDM(PC pc, PetscBool has)
277d71ae5a4SJacob Faibussowitsch {
278f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
279f1580f4eSBarry Smith 
280f1580f4eSBarry Smith   PetscFunctionBegin;
281c8ea6600SPierre Jolivet   data->Neumann = PetscBoolToBool3(has);
2823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
283f1580f4eSBarry Smith }
284f1580f4eSBarry Smith 
285f1580f4eSBarry Smith /*@
286f1580f4eSBarry Smith   PCHPDDMHasNeumannMat - Informs `PCHPDDM` that the `Mat` passed to `PCHPDDMSetAuxiliaryMat()` is the local Neumann matrix.
287f1580f4eSBarry Smith 
288f1580f4eSBarry Smith   Input Parameters:
289f1580f4eSBarry Smith + pc  - preconditioner context
290f1580f4eSBarry Smith - has - Boolean value
291f1580f4eSBarry Smith 
292f1580f4eSBarry Smith   Level: intermediate
293f1580f4eSBarry Smith 
294f1580f4eSBarry Smith   Notes:
2957eb095acSPierre Jolivet   This may be used to bypass a call to `MatCreateSubMatrices()` and to `MatConvert()` for `MATSBAIJ` matrices.
296f1580f4eSBarry Smith 
297907a3e9cSStefano 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`.
298f1580f4eSBarry Smith 
299562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetAuxiliaryMat()`
300f1580f4eSBarry Smith @*/
301d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMHasNeumannMat(PC pc, PetscBool has)
302d71ae5a4SJacob Faibussowitsch {
303f1580f4eSBarry Smith   PetscFunctionBegin;
304f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
305f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMHasNeumannMat_C", (PC, PetscBool), (pc, has));
3063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
307f1580f4eSBarry Smith }
308f1580f4eSBarry Smith 
309d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetRHSMat_HPDDM(PC pc, Mat B)
310d71ae5a4SJacob Faibussowitsch {
311f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
312f1580f4eSBarry Smith 
313f1580f4eSBarry Smith   PetscFunctionBegin;
314f1580f4eSBarry Smith   PetscCall(PetscObjectReference((PetscObject)B));
315f1580f4eSBarry Smith   PetscCall(MatDestroy(&data->B));
316f1580f4eSBarry Smith   data->B = B;
3173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
318f1580f4eSBarry Smith }
319f1580f4eSBarry Smith 
320f1580f4eSBarry Smith /*@
32104c3f3b8SBarry Smith   PCHPDDMSetRHSMat - Sets the right-hand side matrix used by `PCHPDDM` for the concurrent GenEO problems at the finest level.
322f1580f4eSBarry Smith 
323f1580f4eSBarry Smith   Input Parameters:
324f1580f4eSBarry Smith + pc - preconditioner context
325f1580f4eSBarry Smith - B  - right-hand side sequential matrix
326f1580f4eSBarry Smith 
327f1580f4eSBarry Smith   Level: advanced
328f1580f4eSBarry Smith 
32904c3f3b8SBarry Smith   Note:
33004c3f3b8SBarry Smith   Must be used in conjunction with `PCHPDDMSetAuxiliaryMat`(N), so that Nv = lambda Bv is solved using `EPSSetOperators`(N, B).
33104c3f3b8SBarry 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.
33204c3f3b8SBarry Smith 
333562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetAuxiliaryMat()`, `PCHPDDM`
334f1580f4eSBarry Smith @*/
335d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetRHSMat(PC pc, Mat B)
336d71ae5a4SJacob Faibussowitsch {
337f1580f4eSBarry Smith   PetscFunctionBegin;
338f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
339f1580f4eSBarry Smith   if (B) {
340f1580f4eSBarry Smith     PetscValidHeaderSpecific(B, MAT_CLASSID, 2);
341f1580f4eSBarry Smith     PetscTryMethod(pc, "PCHPDDMSetRHSMat_C", (PC, Mat), (pc, B));
342f1580f4eSBarry Smith   }
3433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
344f1580f4eSBarry Smith }
345f1580f4eSBarry Smith 
346ce78bad3SBarry Smith static PetscErrorCode PCSetFromOptions_HPDDM(PC pc, PetscOptionItems PetscOptionsObject)
347d71ae5a4SJacob Faibussowitsch {
348f1580f4eSBarry Smith   PC_HPDDM                   *data   = (PC_HPDDM *)pc->data;
349f1580f4eSBarry Smith   PC_HPDDM_Level            **levels = data->levels;
350f1580f4eSBarry Smith   char                        prefix[256];
351f1580f4eSBarry Smith   int                         i = 1;
352f1580f4eSBarry Smith   PetscMPIInt                 size, previous;
3539bb5c669SPierre Jolivet   PetscInt                    n, overlap = 1;
354f1580f4eSBarry Smith   PCHPDDMCoarseCorrectionType type;
355c8ea6600SPierre Jolivet   PetscBool                   flg = PETSC_TRUE, set;
356f1580f4eSBarry Smith 
357f1580f4eSBarry Smith   PetscFunctionBegin;
358f1580f4eSBarry Smith   if (!data->levels) {
359f1580f4eSBarry Smith     PetscCall(PetscCalloc1(PETSC_PCHPDDM_MAXLEVELS, &levels));
360f1580f4eSBarry Smith     data->levels = levels;
361f1580f4eSBarry Smith   }
362f1580f4eSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "PCHPDDM options");
3639bb5c669SPierre Jolivet   PetscCall(PetscOptionsBoundedInt("-pc_hpddm_harmonic_overlap", "Overlap prior to computing local harmonic extensions", "PCHPDDM", overlap, &overlap, &set, 1));
3649bb5c669SPierre Jolivet   if (!set) overlap = -1;
365f1580f4eSBarry Smith   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
366f1580f4eSBarry Smith   previous = size;
367f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS) {
368f1580f4eSBarry Smith     PetscInt p = 1;
369f1580f4eSBarry Smith 
3704dfa11a4SJacob Faibussowitsch     if (!data->levels[i - 1]) PetscCall(PetscNew(data->levels + i - 1));
371f1580f4eSBarry Smith     data->levels[i - 1]->parent = data;
372f1580f4eSBarry Smith     /* if the previous level has a single process, it is not possible to coarsen further */
373f1580f4eSBarry Smith     if (previous == 1 || !flg) break;
374f1580f4eSBarry Smith     data->levels[i - 1]->nu        = 0;
375f1580f4eSBarry Smith     data->levels[i - 1]->threshold = -1.0;
376f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
377db4a47b3SPierre 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));
378f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold", i));
379db4a47b3SPierre Jolivet     PetscCall(PetscOptionsReal(prefix, "Local threshold for selecting deflation vectors returned by SLEPc", "PCHPDDM", data->levels[i - 1]->threshold, &data->levels[i - 1]->threshold, nullptr));
380f1580f4eSBarry Smith     if (i == 1) {
381aa1539e9SPierre 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 and -pc_hpddm_harmonic_overlap");
3829bb5c669SPierre Jolivet       if (overlap != -1) {
3839bb5c669SPierre Jolivet         PetscInt nsv = 0;
384811e8887SPierre Jolivet 
3859bb5c669SPierre Jolivet         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_nsv", i));
3869bb5c669SPierre Jolivet         PetscCall(PetscOptionsBoundedInt(prefix, "Local number of deflation vectors computed by SLEPc", "SVDSetDimensions", nsv, &nsv, nullptr, 0));
3879bb5c669SPierre Jolivet         PetscCheck(bool(data->levels[0]->nu) != bool(nsv), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot supply %s -pc_hpddm_levels_1_eps_nev %s -pc_hpddm_levels_1_svd_nsv", nsv ? "both" : "neither", nsv ? "and" : "nor");
3889bb5c669SPierre Jolivet         if (nsv) {
3899bb5c669SPierre Jolivet           data->levels[0]->nu = nsv;
3909bb5c669SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_svd_relative_threshold", i));
3919bb5c669SPierre Jolivet         } else PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_relative_threshold", i));
3929bb5c669SPierre Jolivet         PetscCall(PetscOptionsReal(prefix, "Local relative threshold for selecting deflation vectors returned by SLEPc", "PCHPDDM", data->levels[0]->threshold, &data->levels[0]->threshold, nullptr));
3939bb5c669SPierre Jolivet       }
394f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_1_st_share_sub_ksp"));
395db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Shared KSP between SLEPc ST and the fine-level subdomain solver", "PCHPDDMSetSTShareSubKSP", PETSC_FALSE, &data->share, nullptr));
396f1580f4eSBarry Smith     }
397f1580f4eSBarry Smith     /* if there is no prescribed coarsening, just break out of the loop */
3980594bca0SPierre Jolivet     if (data->levels[i - 1]->threshold <= PetscReal() && data->levels[i - 1]->nu <= 0 && !(data->deflation && i == 1)) break;
399f1580f4eSBarry Smith     else {
400f1580f4eSBarry Smith       ++i;
401f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_nev", i));
402f1580f4eSBarry Smith       PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
403f1580f4eSBarry Smith       if (!flg) {
404f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_eps_threshold", i));
405f1580f4eSBarry Smith         PetscCall(PetscOptionsHasName(PetscOptionsObject->options, PetscOptionsObject->prefix, prefix, &flg));
406f1580f4eSBarry Smith       }
407f1580f4eSBarry Smith       if (flg) {
408f1580f4eSBarry Smith         /* if there are coarsening options for the next level, then register it  */
409f1580f4eSBarry Smith         /* otherwise, don't to avoid having both options levels_N_p and coarse_p */
410f1580f4eSBarry Smith         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_levels_%d_p", i));
411f1580f4eSBarry 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)));
412f1580f4eSBarry Smith         previous = p;
413f1580f4eSBarry Smith       }
414f1580f4eSBarry Smith     }
415f1580f4eSBarry Smith   }
416f1580f4eSBarry Smith   data->N = i;
417f1580f4eSBarry Smith   n       = 1;
418f1580f4eSBarry Smith   if (i > 1) {
419f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_coarse_p"));
420db4a47b3SPierre Jolivet     PetscCall(PetscOptionsRangeInt(prefix, "Number of processes used to assemble the coarsest operator", "PCHPDDM", n, &n, nullptr, 1, PetscMax(1, previous / 2)));
42102800ff6SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
422f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "pc_hpddm_coarse_"));
423db4a47b3SPierre Jolivet     PetscCall(PetscOptionsHasName(nullptr, prefix, "-mat_mumps_use_omp_threads", &flg));
424f1580f4eSBarry Smith     if (flg) {
425f1580f4eSBarry Smith       char type[64]; /* same size as in src/ksp/pc/impls/factor/factimpl.c */
426811e8887SPierre Jolivet 
427c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(type, n > 1 && PetscDefined(HAVE_MUMPS) ? MATSOLVERMUMPS : MATSOLVERPETSC, sizeof(type))); /* default solver for a MatMPIAIJ or a MatSeqAIJ */
428db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetString(nullptr, prefix, "-pc_factor_mat_solver_type", type, sizeof(type), nullptr));
4293ce573a3SPierre Jolivet       PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
430f1580f4eSBarry 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);
431f1580f4eSBarry Smith       size = n;
432f1580f4eSBarry Smith       n    = -1;
433db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetInt(nullptr, prefix, "-mat_mumps_use_omp_threads", &n, nullptr));
434f1580f4eSBarry Smith       PetscCheck(n >= 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Need to specify a positive integer for -%smat_mumps_use_omp_threads", prefix);
435f1580f4eSBarry 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" : "");
436f1580f4eSBarry Smith     }
437f1580f4eSBarry Smith #endif
438f1580f4eSBarry Smith     PetscCall(PetscOptionsEnum("-pc_hpddm_coarse_correction", "Type of coarse correction applied each iteration", "PCHPDDMSetCoarseCorrectionType", PCHPDDMCoarseCorrectionTypes, (PetscEnum)data->correction, (PetscEnum *)&type, &flg));
439f1580f4eSBarry Smith     if (flg) PetscCall(PCHPDDMSetCoarseCorrectionType(pc, type));
440f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_has_neumann"));
441c8ea6600SPierre Jolivet     PetscCall(PetscOptionsBool(prefix, "Is the auxiliary Mat the local Neumann matrix?", "PCHPDDMHasNeumannMat", PetscBool3ToBool(data->Neumann), &flg, &set));
442c8ea6600SPierre Jolivet     if (set) data->Neumann = PetscBoolToBool3(flg);
443f1580f4eSBarry Smith     data->log_separate = PETSC_FALSE;
444f1580f4eSBarry Smith     if (PetscDefined(USE_LOG)) {
445f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-pc_hpddm_log_separate"));
446db4a47b3SPierre Jolivet       PetscCall(PetscOptionsBool(prefix, "Log events level by level instead of inside PCSetUp()/KSPSolve()", nullptr, data->log_separate, &data->log_separate, nullptr));
447f1580f4eSBarry Smith     }
448f1580f4eSBarry Smith   }
449f1580f4eSBarry Smith   PetscOptionsHeadEnd();
450f1580f4eSBarry Smith   while (i < PETSC_PCHPDDM_MAXLEVELS && data->levels[i]) PetscCall(PetscFree(data->levels[i++]));
4513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
452f1580f4eSBarry Smith }
453f1580f4eSBarry Smith 
454d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDM(PC pc, Vec x, Vec y)
455d71ae5a4SJacob Faibussowitsch {
456f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
457f1580f4eSBarry Smith 
458f1580f4eSBarry Smith   PetscFunctionBegin;
459f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
460f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
461db4a47b3SPierre 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 */
462f1580f4eSBarry Smith   PetscCall(KSPSolve(data->levels[0]->ksp, x, y));
463db4a47b3SPierre Jolivet   if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
4643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
465f1580f4eSBarry Smith }
466f1580f4eSBarry Smith 
467d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDM(PC pc, Mat X, Mat Y)
468d71ae5a4SJacob Faibussowitsch {
469f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
470f1580f4eSBarry Smith 
471f1580f4eSBarry Smith   PetscFunctionBegin;
472f1580f4eSBarry Smith   PetscCall(PetscCitationsRegister(HPDDMCitation, &HPDDMCite));
473f1580f4eSBarry Smith   PetscCheck(data->levels[0]->ksp, PETSC_COMM_SELF, PETSC_ERR_PLIB, "No KSP attached to PCHPDDM");
474f1580f4eSBarry Smith   PetscCall(KSPMatSolve(data->levels[0]->ksp, X, Y));
4753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
476f1580f4eSBarry Smith }
477f1580f4eSBarry Smith 
478cc4c1da9SBarry Smith /*@
479f1580f4eSBarry Smith   PCHPDDMGetComplexities - Computes the grid and operator complexities.
480f1580f4eSBarry Smith 
481c71f06a7SPierre Jolivet   Collective
482c71f06a7SPierre Jolivet 
483f1580f4eSBarry Smith   Input Parameter:
484f1580f4eSBarry Smith . pc - preconditioner context
485f1580f4eSBarry Smith 
486f1580f4eSBarry Smith   Output Parameters:
487cc4c1da9SBarry Smith + gc - grid complexity $ \sum_i m_i / m_1 $
488cc4c1da9SBarry Smith - oc - operator complexity $ \sum_i nnz_i / nnz_1 $
489f1580f4eSBarry Smith 
490f1580f4eSBarry Smith   Level: advanced
491f1580f4eSBarry Smith 
492562efe2eSBarry Smith .seealso: [](ch_ksp), `PCMGGetGridComplexity()`, `PCHPDDM`, `PCHYPRE`, `PCGAMG`
493f1580f4eSBarry Smith @*/
494cc4c1da9SBarry Smith PetscErrorCode PCHPDDMGetComplexities(PC pc, PetscReal *gc, PetscReal *oc)
495d71ae5a4SJacob Faibussowitsch {
496f1580f4eSBarry Smith   PC_HPDDM      *data = (PC_HPDDM *)pc->data;
497f1580f4eSBarry Smith   MatInfo        info;
498f1580f4eSBarry Smith   PetscLogDouble accumulate[2]{}, nnz1 = 1.0, m1 = 1.0;
499f1580f4eSBarry Smith 
500f1580f4eSBarry Smith   PetscFunctionBegin;
501715c1178SPierre Jolivet   if (gc) {
502715c1178SPierre Jolivet     PetscAssertPointer(gc, 2);
503715c1178SPierre Jolivet     *gc = 0;
504715c1178SPierre Jolivet   }
505715c1178SPierre Jolivet   if (oc) {
506715c1178SPierre Jolivet     PetscAssertPointer(oc, 3);
507715c1178SPierre Jolivet     *oc = 0;
508715c1178SPierre Jolivet   }
509715c1178SPierre Jolivet   for (PetscInt n = 0; n < data->N; ++n) {
510f1580f4eSBarry Smith     if (data->levels[n]->ksp) {
51113044ca3SPierre Jolivet       Mat       P, A = nullptr;
512715c1178SPierre Jolivet       PetscInt  m;
51313044ca3SPierre Jolivet       PetscBool flg = PETSC_FALSE;
51413044ca3SPierre Jolivet 
515db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &P));
516db4a47b3SPierre Jolivet       PetscCall(MatGetSize(P, &m, nullptr));
517f1580f4eSBarry Smith       accumulate[0] += m;
518f1580f4eSBarry Smith       if (n == 0) {
519f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
520f1580f4eSBarry Smith         if (flg) {
521f1580f4eSBarry Smith           PetscCall(MatConvert(P, MATAIJ, MAT_INITIAL_MATRIX, &A));
522f1580f4eSBarry Smith           P = A;
52313044ca3SPierre Jolivet         } else {
52413044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
52513044ca3SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)P));
526f1580f4eSBarry Smith         }
52713044ca3SPierre Jolivet       }
52813044ca3SPierre Jolivet       if (!A && flg) accumulate[1] += m * m; /* assumption that a MATSCHURCOMPLEMENT is dense if stored explicitly */
52913044ca3SPierre Jolivet       else if (P->ops->getinfo) {
530f1580f4eSBarry Smith         PetscCall(MatGetInfo(P, MAT_GLOBAL_SUM, &info));
531f1580f4eSBarry Smith         accumulate[1] += info.nz_used;
532f1580f4eSBarry Smith       }
533f1580f4eSBarry Smith       if (n == 0) {
534f1580f4eSBarry Smith         m1 = m;
53513044ca3SPierre Jolivet         if (!A && flg) nnz1 = m * m;
53613044ca3SPierre Jolivet         else if (P->ops->getinfo) nnz1 = info.nz_used;
537f1580f4eSBarry Smith         PetscCall(MatDestroy(&P));
538f1580f4eSBarry Smith       }
539f1580f4eSBarry Smith     }
540f1580f4eSBarry Smith   }
541715c1178SPierre Jolivet   /* only process #0 has access to the full hierarchy by construction, so broadcast to ensure consistent outputs */
542715c1178SPierre Jolivet   PetscCallMPI(MPI_Bcast(accumulate, 2, MPIU_PETSCLOGDOUBLE, 0, PetscObjectComm((PetscObject)pc)));
543715c1178SPierre Jolivet   if (gc) *gc = static_cast<PetscReal>(accumulate[0] / m1);
544715c1178SPierre Jolivet   if (oc) *oc = static_cast<PetscReal>(accumulate[1] / nnz1);
5453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
546f1580f4eSBarry Smith }
547f1580f4eSBarry Smith 
548d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_HPDDM(PC pc, PetscViewer viewer)
549d71ae5a4SJacob Faibussowitsch {
550f1580f4eSBarry Smith   PC_HPDDM         *data = (PC_HPDDM *)pc->data;
551f1580f4eSBarry Smith   PetscViewer       subviewer;
552aa21023fSPierre Jolivet   PetscViewerFormat format;
553f1580f4eSBarry Smith   PetscSubcomm      subcomm;
554f1580f4eSBarry Smith   PetscReal         oc, gc;
555811e8887SPierre Jolivet   PetscInt          tabs;
556f1580f4eSBarry Smith   PetscMPIInt       size, color, rank;
557aa21023fSPierre Jolivet   PetscBool         flg;
558aa21023fSPierre Jolivet   const char       *name;
559f1580f4eSBarry Smith 
560f1580f4eSBarry Smith   PetscFunctionBegin;
561aa21023fSPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &flg));
562aa21023fSPierre Jolivet   if (flg) {
563f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "level%s: %" PetscInt_FMT "\n", data->N > 1 ? "s" : "", data->N));
564f1580f4eSBarry Smith     PetscCall(PCHPDDMGetComplexities(pc, &gc, &oc));
565f1580f4eSBarry Smith     if (data->N > 1) {
566f1580f4eSBarry Smith       if (!data->deflation) {
567c8ea6600SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "Neumann matrix attached? %s\n", PetscBools[PetscBool3ToBool(data->Neumann)]));
568f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, "shared subdomain KSP between SLEPc and PETSc? %s\n", PetscBools[data->share]));
569f1580f4eSBarry Smith       } else PetscCall(PetscViewerASCIIPrintf(viewer, "user-supplied deflation matrix\n"));
570f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "coarse correction: %s\n", PCHPDDMCoarseCorrectionTypes[data->correction]));
571f1580f4eSBarry 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" : ""));
572f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIGetTab(viewer, &tabs));
573f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, 0));
574811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
575f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, data->levels[i - 1]->nu));
5760594bca0SPierre Jolivet         if (data->levels[i - 1]->threshold > static_cast<PetscReal>(-0.1)) PetscCall(PetscViewerASCIIPrintf(viewer, " (%g)", (double)data->levels[i - 1]->threshold));
577f1580f4eSBarry Smith       }
578f1580f4eSBarry Smith       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
579f1580f4eSBarry Smith       PetscCall(PetscViewerASCIISetTab(viewer, tabs));
580f1580f4eSBarry Smith     }
581f1580f4eSBarry Smith     PetscCall(PetscViewerASCIIPrintf(viewer, "grid and operator complexities: %g %g\n", (double)gc, (double)oc));
5821fe44b27SPierre Jolivet     PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size));
583f1580f4eSBarry Smith     if (data->levels[0]->ksp) {
584f1580f4eSBarry Smith       PetscCall(KSPView(data->levels[0]->ksp, viewer));
585f1580f4eSBarry Smith       if (data->levels[0]->pc) PetscCall(PCView(data->levels[0]->pc, viewer));
586eea1a2f1SRaphael Zanella       PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank));
587811e8887SPierre Jolivet       for (PetscInt i = 1; i < data->N; ++i) {
588f1580f4eSBarry Smith         if (data->levels[i]->ksp) color = 1;
589f1580f4eSBarry Smith         else color = 0;
590f1580f4eSBarry Smith         PetscCall(PetscSubcommCreate(PetscObjectComm((PetscObject)pc), &subcomm));
591f1580f4eSBarry Smith         PetscCall(PetscSubcommSetNumber(subcomm, PetscMin(size, 2)));
592f1580f4eSBarry Smith         PetscCall(PetscSubcommSetTypeGeneral(subcomm, color, rank));
593f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPushTab(viewer));
594f1580f4eSBarry Smith         PetscCall(PetscViewerGetSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
595f1580f4eSBarry Smith         if (color == 1) {
596f1580f4eSBarry Smith           PetscCall(KSPView(data->levels[i]->ksp, subviewer));
597f1580f4eSBarry Smith           if (data->levels[i]->pc) PetscCall(PCView(data->levels[i]->pc, subviewer));
598f1580f4eSBarry Smith           PetscCall(PetscViewerFlush(subviewer));
599f1580f4eSBarry Smith         }
600f1580f4eSBarry Smith         PetscCall(PetscViewerRestoreSubViewer(viewer, PetscSubcommChild(subcomm), &subviewer));
601f1580f4eSBarry Smith         PetscCall(PetscViewerASCIIPopTab(viewer));
602f1580f4eSBarry Smith         PetscCall(PetscSubcommDestroy(&subcomm));
603f1580f4eSBarry Smith       }
604f1580f4eSBarry Smith     }
605aa21023fSPierre Jolivet     PetscCall(PetscViewerGetFormat(viewer, &format));
606aa21023fSPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
607aa21023fSPierre Jolivet       PetscCall(PetscViewerFileGetName(viewer, &name));
608aa21023fSPierre Jolivet       if (name) {
609eea1a2f1SRaphael Zanella         Mat             aux[2];
610aa21023fSPierre Jolivet         IS              is;
611eea1a2f1SRaphael Zanella         const PetscInt *indices;
612eea1a2f1SRaphael Zanella         PetscInt        m, n, sizes[5] = {pc->mat->rmap->n, pc->mat->cmap->n, pc->mat->rmap->N, pc->mat->cmap->N, 0};
613aa21023fSPierre Jolivet         char           *tmp;
614aa21023fSPierre Jolivet         std::string     prefix, suffix;
615aa21023fSPierre Jolivet         size_t          pos;
616aa21023fSPierre Jolivet 
617aa21023fSPierre Jolivet         PetscCall(PetscStrstr(name, ".", &tmp));
618aa21023fSPierre Jolivet         if (tmp) {
619aa21023fSPierre Jolivet           pos    = std::distance(const_cast<char *>(name), tmp);
620aa21023fSPierre Jolivet           prefix = std::string(name, pos);
621aa21023fSPierre Jolivet           suffix = std::string(name + pos + 1);
622aa21023fSPierre Jolivet         } else prefix = name;
623aa21023fSPierre Jolivet         if (data->aux) {
624eea1a2f1SRaphael Zanella           PetscCall(MatGetSize(data->aux, &m, &n));
625eea1a2f1SRaphael Zanella           PetscCall(MatCreate(PetscObjectComm((PetscObject)pc), aux));
626eea1a2f1SRaphael Zanella           PetscCall(MatSetSizes(aux[0], m, n, PETSC_DETERMINE, PETSC_DETERMINE));
627eea1a2f1SRaphael Zanella           PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
628eea1a2f1SRaphael Zanella           if (flg) PetscCall(MatSetType(aux[0], MATMPIAIJ));
629eea1a2f1SRaphael Zanella           else {
630eea1a2f1SRaphael Zanella             PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQBAIJ, &flg));
631eea1a2f1SRaphael Zanella             if (flg) PetscCall(MatSetType(aux[0], MATMPIBAIJ));
632eea1a2f1SRaphael Zanella             else {
633eea1a2f1SRaphael Zanella               PetscCall(PetscObjectBaseTypeCompare((PetscObject)data->aux, MATSEQSBAIJ, &flg));
634eea1a2f1SRaphael 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);
635eea1a2f1SRaphael Zanella               PetscCall(MatSetType(aux[0], MATMPISBAIJ));
636eea1a2f1SRaphael Zanella             }
637eea1a2f1SRaphael Zanella           }
638eea1a2f1SRaphael Zanella           PetscCall(MatSetBlockSizesFromMats(aux[0], data->aux, data->aux));
639eea1a2f1SRaphael Zanella           PetscCall(MatAssemblyBegin(aux[0], MAT_FINAL_ASSEMBLY));
640eea1a2f1SRaphael Zanella           PetscCall(MatAssemblyEnd(aux[0], MAT_FINAL_ASSEMBLY));
641eea1a2f1SRaphael Zanella           PetscCall(MatGetDiagonalBlock(aux[0], aux + 1));
642eea1a2f1SRaphael Zanella           PetscCall(MatCopy(data->aux, aux[1], DIFFERENT_NONZERO_PATTERN));
643eea1a2f1SRaphael Zanella           PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_aux_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
644eea1a2f1SRaphael Zanella           PetscCall(MatView(aux[0], subviewer));
645aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
646eea1a2f1SRaphael Zanella           PetscCall(MatDestroy(aux));
647aa21023fSPierre Jolivet         }
648aa21023fSPierre Jolivet         if (data->is) {
649eea1a2f1SRaphael Zanella           PetscCall(ISGetIndices(data->is, &indices));
650eea1a2f1SRaphael Zanella           PetscCall(ISGetSize(data->is, sizes + 4));
651eea1a2f1SRaphael Zanella           PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), sizes[4], indices, PETSC_USE_POINTER, &is));
652eea1a2f1SRaphael Zanella           PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_is_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
653eea1a2f1SRaphael Zanella           PetscCall(ISView(is, subviewer));
654aa21023fSPierre Jolivet           PetscCall(PetscViewerDestroy(&subviewer));
655eea1a2f1SRaphael Zanella           PetscCall(ISDestroy(&is));
656eea1a2f1SRaphael Zanella           PetscCall(ISRestoreIndices(data->is, &indices));
657aa21023fSPierre Jolivet         }
658eea1a2f1SRaphael Zanella         PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), PETSC_STATIC_ARRAY_LENGTH(sizes), sizes, PETSC_USE_POINTER, &is));
659eea1a2f1SRaphael Zanella         PetscCall(PetscViewerBinaryOpen(PetscObjectComm((PetscObject)pc), std::string(prefix + "_sizes_" + std::to_string(size) + (tmp ? ("." + suffix) : "")).c_str(), FILE_MODE_WRITE, &subviewer));
660aa21023fSPierre Jolivet         PetscCall(ISView(is, subviewer));
661aa21023fSPierre Jolivet         PetscCall(PetscViewerDestroy(&subviewer));
662aa21023fSPierre Jolivet         PetscCall(ISDestroy(&is));
663aa21023fSPierre Jolivet       }
664aa21023fSPierre Jolivet     }
665f1580f4eSBarry Smith   }
6663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
667f1580f4eSBarry Smith }
668f1580f4eSBarry Smith 
669d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCPreSolve_HPDDM(PC pc, KSP ksp, Vec, Vec)
670d71ae5a4SJacob Faibussowitsch {
671f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
672f1580f4eSBarry Smith   Mat       A;
673cdbd50ebSPierre Jolivet   PetscBool flg;
674f1580f4eSBarry Smith 
675f1580f4eSBarry Smith   PetscFunctionBegin;
676f1580f4eSBarry Smith   if (ksp) {
677f1580f4eSBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPLSQR, &flg));
678f1580f4eSBarry Smith     if (flg && !data->normal) {
679db4a47b3SPierre Jolivet       PetscCall(KSPGetOperators(ksp, &A, nullptr));
680db4a47b3SPierre Jolivet       PetscCall(MatCreateVecs(A, nullptr, &data->normal)); /* temporary Vec used in PCApply_HPDDMShell() for coarse grid corrections */
681cdbd50ebSPierre Jolivet     } else if (!flg) {
682cdbd50ebSPierre Jolivet       PetscCall(PetscObjectTypeCompareAny((PetscObject)ksp, &flg, KSPCG, KSPGROPPCG, KSPPIPECG, KSPPIPECGRR, KSPPIPELCG, KSPPIPEPRCG, KSPPIPECG2, KSPSTCG, KSPFCG, KSPPIPEFCG, KSPMINRES, KSPNASH, KSPSYMMLQ, ""));
683cdbd50ebSPierre Jolivet       if (!flg) {
684cdbd50ebSPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)ksp, KSPHPDDM, &flg));
685cdbd50ebSPierre Jolivet         if (flg) {
686cdbd50ebSPierre Jolivet           KSPHPDDMType type;
687811e8887SPierre Jolivet 
688cdbd50ebSPierre Jolivet           PetscCall(KSPHPDDMGetType(ksp, &type));
689cdbd50ebSPierre Jolivet           flg = (type == KSP_HPDDM_TYPE_CG || type == KSP_HPDDM_TYPE_BCG || type == KSP_HPDDM_TYPE_BFBCG ? PETSC_TRUE : PETSC_FALSE);
690cdbd50ebSPierre Jolivet         }
691cdbd50ebSPierre Jolivet       }
692cdbd50ebSPierre Jolivet     }
693cdbd50ebSPierre Jolivet     if (flg) {
694cdbd50ebSPierre Jolivet       if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) {
695cdbd50ebSPierre Jolivet         PetscCall(PetscOptionsHasName(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_hpddm_coarse_correction", &flg));
696cdbd50ebSPierre 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",
697cdbd50ebSPierre Jolivet                    PCHPDDMCoarseCorrectionTypes[data->correction], ((PetscObject)ksp)->type_name, ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", PCHPDDMCoarseCorrectionTypes[data->correction], PCHPDDMCoarseCorrectionTypes[PC_HPDDM_COARSE_CORRECTION_BALANCED]);
698cdbd50ebSPierre Jolivet       }
699cdbd50ebSPierre Jolivet       for (PetscInt n = 0; n < data->N; ++n) {
700cdbd50ebSPierre Jolivet         if (data->levels[n]->pc) {
701cdbd50ebSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)data->levels[n]->pc, PCASM, &flg));
702cdbd50ebSPierre Jolivet           if (flg) {
703cdbd50ebSPierre Jolivet             PCASMType type;
704811e8887SPierre Jolivet 
705cdbd50ebSPierre Jolivet             PetscCall(PCASMGetType(data->levels[n]->pc, &type));
706cdbd50ebSPierre Jolivet             if (type == PC_ASM_RESTRICT || type == PC_ASM_INTERPOLATE) {
707cdbd50ebSPierre Jolivet               PetscCall(PetscOptionsHasName(((PetscObject)data->levels[n]->pc)->options, ((PetscObject)data->levels[n]->pc)->prefix, "-pc_asm_type", &flg));
708cdbd50ebSPierre 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],
709cdbd50ebSPierre Jolivet                          ((PetscObject)ksp)->type_name, ((PetscObject)data->levels[n]->pc)->prefix, PCASMTypes[type], PCASMTypes[PC_ASM_BASIC]);
710cdbd50ebSPierre Jolivet             }
711cdbd50ebSPierre Jolivet           }
712cdbd50ebSPierre Jolivet         }
713cdbd50ebSPierre Jolivet       }
714f1580f4eSBarry Smith     }
715f1580f4eSBarry Smith   }
7163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
717f1580f4eSBarry Smith }
718f1580f4eSBarry Smith 
719d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDMShell(PC pc)
720d71ae5a4SJacob Faibussowitsch {
721f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
722f1580f4eSBarry Smith   Mat             A, P;
723f1580f4eSBarry Smith   Vec             x;
724f1580f4eSBarry Smith   const char     *pcpre;
725f1580f4eSBarry Smith 
726f1580f4eSBarry Smith   PetscFunctionBegin;
727f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
728f1580f4eSBarry Smith   PetscCall(KSPGetOptionsPrefix(ctx->ksp, &pcpre));
729f1580f4eSBarry Smith   PetscCall(KSPGetOperators(ctx->ksp, &A, &P));
730f1580f4eSBarry Smith   /* smoother */
731f1580f4eSBarry Smith   PetscCall(PCSetOptionsPrefix(ctx->pc, pcpre));
732f1580f4eSBarry Smith   PetscCall(PCSetOperators(ctx->pc, A, P));
733f1580f4eSBarry Smith   if (!ctx->v[0]) {
734f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(ctx->D, 1, &ctx->v[0]));
735f1580f4eSBarry Smith     if (!std::is_same<PetscScalar, PetscReal>::value) PetscCall(VecDestroy(&ctx->D));
736db4a47b3SPierre Jolivet     PetscCall(MatCreateVecs(A, &x, nullptr));
737f1580f4eSBarry Smith     PetscCall(VecDuplicateVecs(x, 2, &ctx->v[1]));
738f1580f4eSBarry Smith     PetscCall(VecDestroy(&x));
739f1580f4eSBarry Smith   }
740f1580f4eSBarry Smith   std::fill_n(ctx->V, 3, nullptr);
7413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
742f1580f4eSBarry Smith }
743f1580f4eSBarry Smith 
744f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
745d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type x, Type y)
746d71ae5a4SJacob Faibussowitsch {
747f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
748f1580f4eSBarry Smith   PetscScalar    *out;
749f1580f4eSBarry Smith 
750f1580f4eSBarry Smith   PetscFunctionBegin;
751f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
752f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
753f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
754f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, x, ctx->v[0][0], INSERT_VALUES, SCATTER_FORWARD));
755f1580f4eSBarry Smith   PetscCall(VecGetArrayWrite(ctx->v[0][0], &out));
756db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, 1); /* y = Q x */
757f1580f4eSBarry Smith   PetscCall(VecRestoreArrayWrite(ctx->v[0][0], &out));
758f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
759f1580f4eSBarry Smith   PetscCall(VecScatterBegin(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
760f1580f4eSBarry Smith   PetscCall(VecScatterEnd(ctx->scatter, ctx->v[0][0], y, INSERT_VALUES, SCATTER_REVERSE));
7613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
762f1580f4eSBarry Smith }
763f1580f4eSBarry Smith 
764f1580f4eSBarry Smith template <class Type, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
765d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PCHPDDMDeflate_Private(PC pc, Type X, Type Y)
766d71ae5a4SJacob Faibussowitsch {
767f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
768f1580f4eSBarry Smith   Vec             vX, vY, vC;
769f1580f4eSBarry Smith   PetscScalar    *out;
770811e8887SPierre Jolivet   PetscInt        N;
771f1580f4eSBarry Smith 
772f1580f4eSBarry Smith   PetscFunctionBegin;
773f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
774db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
775f1580f4eSBarry Smith   /* going from PETSc to HPDDM numbering */
776811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
777f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(X, i, &vX));
778f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(ctx->V[0], i, &vC));
779f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
780f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vX, vC, INSERT_VALUES, SCATTER_FORWARD));
781f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(ctx->V[0], i, &vC));
782f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(X, i, &vX));
783f1580f4eSBarry Smith   }
784f1580f4eSBarry Smith   PetscCall(MatDenseGetArrayWrite(ctx->V[0], &out));
785db4a47b3SPierre Jolivet   ctx->P->deflation<false>(nullptr, out, N); /* Y = Q X */
786f1580f4eSBarry Smith   PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &out));
787f1580f4eSBarry Smith   /* going from HPDDM to PETSc numbering */
788811e8887SPierre Jolivet   for (PetscInt i = 0; i < N; ++i) {
789f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecRead(ctx->V[0], i, &vC));
790f1580f4eSBarry Smith     PetscCall(MatDenseGetColumnVecWrite(Y, i, &vY));
791f1580f4eSBarry Smith     PetscCall(VecScatterBegin(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
792f1580f4eSBarry Smith     PetscCall(VecScatterEnd(ctx->scatter, vC, vY, INSERT_VALUES, SCATTER_REVERSE));
793f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &vY));
794f1580f4eSBarry Smith     PetscCall(MatDenseRestoreColumnVecRead(ctx->V[0], i, &vC));
795f1580f4eSBarry Smith   }
7963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
797f1580f4eSBarry Smith }
798f1580f4eSBarry Smith 
799f1580f4eSBarry Smith /*
800aa1539e9SPierre 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.
801f1580f4eSBarry Smith 
802f1580f4eSBarry Smith .vb
803f1580f4eSBarry Smith    (1) y =                Pmat^-1              x + Q x,
804f1580f4eSBarry Smith    (2) y =                Pmat^-1 (I - Amat Q) x + Q x (default),
805aa1539e9SPierre Jolivet    (3) y = (I - Q Amat^T) Pmat^-1 (I - Amat Q) x + Q x,
806aa1539e9SPierre Jolivet    (4) y =                Pmat^-1              x      .
807f1580f4eSBarry Smith .ve
808f1580f4eSBarry Smith 
809f1580f4eSBarry Smith    Input Parameters:
810f1580f4eSBarry Smith +     pc - preconditioner context
811f1580f4eSBarry Smith -     x - input vector
812f1580f4eSBarry Smith 
813f1580f4eSBarry Smith    Output Parameter:
814f1580f4eSBarry Smith .     y - output vector
815f1580f4eSBarry Smith 
816f1580f4eSBarry Smith    Notes:
817f1580f4eSBarry 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.
818f1580f4eSBarry 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.
819f1580f4eSBarry 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.
820f1580f4eSBarry Smith 
821f1580f4eSBarry Smith    Level: advanced
822f1580f4eSBarry Smith 
823f1580f4eSBarry Smith    Developer Note:
824f1580f4eSBarry 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
825f1580f4eSBarry Smith    to trigger it. Likely the manual page is `PCHPDDM`
826f1580f4eSBarry Smith 
827562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
828f1580f4eSBarry Smith */
829d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_HPDDMShell(PC pc, Vec x, Vec y)
830d71ae5a4SJacob Faibussowitsch {
831f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
832f1580f4eSBarry Smith   Mat             A;
833f1580f4eSBarry Smith 
834f1580f4eSBarry Smith   PetscFunctionBegin;
835f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
836f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
837db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
838aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCApply(ctx->pc, x, y)); /* y = M^-1 x */
839aa1539e9SPierre Jolivet   else {
840f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, x, y)); /* y = Q x */
841f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
842f1580f4eSBarry Smith       if (!ctx->parent->normal || ctx != ctx->parent->levels[0]) PetscCall(MatMult(A, y, ctx->v[1][0])); /* y = A Q x     */
843f1580f4eSBarry Smith       else { /* KSPLSQR and finest level */ PetscCall(MatMult(A, y, ctx->parent->normal));               /* y = A Q x     */
844f1580f4eSBarry Smith         PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][0]));                      /* y = A^T A Q x */
845f1580f4eSBarry Smith       }
846f1580f4eSBarry Smith       PetscCall(VecWAXPY(ctx->v[1][1], -1.0, ctx->v[1][0], x)); /* y = (I - A Q) x                             */
847f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, ctx->v[1][1], ctx->v[1][0]));  /* y = M^-1 (I - A Q) x                        */
848f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
849f1580f4eSBarry 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 */
850f1580f4eSBarry Smith         else {
851f1580f4eSBarry Smith           PetscCall(MatMult(A, ctx->v[1][0], ctx->parent->normal));
852f1580f4eSBarry Smith           PetscCall(MatMultHermitianTranspose(A, ctx->parent->normal, ctx->v[1][1])); /* z = A^T A y           */
853f1580f4eSBarry Smith         }
854f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->v[1][1], ctx->v[1][1]));
855f1580f4eSBarry 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      */
856f1580f4eSBarry Smith       } else PetscCall(VecAXPY(y, 1.0, ctx->v[1][0]));                         /* y = Q M^-1 (I - A Q) x + Q x */
857f1580f4eSBarry Smith     } else {
858f1580f4eSBarry 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);
859f1580f4eSBarry Smith       PetscCall(PCApply(ctx->pc, x, ctx->v[1][0]));
860f1580f4eSBarry Smith       PetscCall(VecAXPY(y, 1.0, ctx->v[1][0])); /* y = M^-1 x + Q x */
861f1580f4eSBarry Smith     }
862aa1539e9SPierre Jolivet   }
8633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
864f1580f4eSBarry Smith }
865f1580f4eSBarry Smith 
866f1580f4eSBarry Smith /*
867f1580f4eSBarry Smith      PCMatApply_HPDDMShell - Variant of PCApply_HPDDMShell() for blocks of vectors.
868f1580f4eSBarry Smith 
869f1580f4eSBarry Smith    Input Parameters:
870f1580f4eSBarry Smith +     pc - preconditioner context
871f1580f4eSBarry Smith -     X - block of input vectors
872f1580f4eSBarry Smith 
873f1580f4eSBarry Smith    Output Parameter:
874f1580f4eSBarry Smith .     Y - block of output vectors
875f1580f4eSBarry Smith 
876f1580f4eSBarry Smith    Level: advanced
877f1580f4eSBarry Smith 
878562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCApply_HPDDMShell()`, `PCHPDDMCoarseCorrectionType`
879f1580f4eSBarry Smith */
880d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCMatApply_HPDDMShell(PC pc, Mat X, Mat Y)
881d71ae5a4SJacob Faibussowitsch {
882f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
883f1580f4eSBarry Smith   Mat             A, *ptr;
884db4a47b3SPierre Jolivet   PetscContainer  container = nullptr;
885f1580f4eSBarry Smith   PetscScalar    *array;
886f1580f4eSBarry Smith   PetscInt        m, M, N, prev = 0;
887f1580f4eSBarry Smith   PetscBool       reset = PETSC_FALSE;
888f1580f4eSBarry Smith 
889f1580f4eSBarry Smith   PetscFunctionBegin;
890f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
891f1580f4eSBarry Smith   PetscCheck(ctx->P, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCSHELL from PCHPDDM called with no HPDDM object");
892db4a47b3SPierre Jolivet   PetscCall(MatGetSize(X, nullptr, &N));
893db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &A, nullptr));
894aa1539e9SPierre Jolivet   if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_NONE) PetscCall(PCMatApply(ctx->pc, X, Y));
895aa1539e9SPierre Jolivet   else {
896f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)A, "_HPDDM_MatProduct", (PetscObject *)&container));
897f1580f4eSBarry Smith     if (container) { /* MatProduct container already attached */
898f1580f4eSBarry Smith       PetscCall(PetscContainerGetPointer(container, (void **)&ptr));
899f1580f4eSBarry Smith       if (ptr[1] != ctx->V[2]) /* Mat has changed or may have been set first in KSPHPDDM */
900f1580f4eSBarry Smith         for (m = 0; m < 2; ++m) {
901f1580f4eSBarry Smith           PetscCall(MatDestroy(ctx->V + m + 1));
902f1580f4eSBarry Smith           ctx->V[m + 1] = ptr[m];
903f1580f4eSBarry Smith           PetscCall(PetscObjectReference((PetscObject)ctx->V[m + 1]));
904f1580f4eSBarry Smith         }
905f1580f4eSBarry Smith     }
906db4a47b3SPierre Jolivet     if (ctx->V[1]) PetscCall(MatGetSize(ctx->V[1], nullptr, &prev));
907f1580f4eSBarry Smith     if (N != prev || !ctx->V[0]) {
908f1580f4eSBarry Smith       PetscCall(MatDestroy(ctx->V));
909f1580f4eSBarry Smith       PetscCall(VecGetLocalSize(ctx->v[0][0], &m));
910db4a47b3SPierre Jolivet       PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, PETSC_DECIDE, N, nullptr, ctx->V));
911f1580f4eSBarry Smith       if (N != prev) {
912f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 1));
913f1580f4eSBarry Smith         PetscCall(MatDestroy(ctx->V + 2));
914db4a47b3SPierre Jolivet         PetscCall(MatGetLocalSize(X, &m, nullptr));
915db4a47b3SPierre Jolivet         PetscCall(MatGetSize(X, &M, nullptr));
916f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
917db4a47b3SPierre Jolivet         else array = nullptr;
918f1580f4eSBarry Smith         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, array, ctx->V + 1));
919f1580f4eSBarry Smith         if (ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
920db4a47b3SPierre Jolivet         PetscCall(MatCreateDense(PetscObjectComm((PetscObject)pc), m, PETSC_DECIDE, M, N, nullptr, ctx->V + 2));
921db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, Y, nullptr, ctx->V[1]));
922f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[1], MATPRODUCT_AB));
923f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[1]));
924f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[1]));
925715c1178SPierre 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() */
926715c1178SPierre 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 */
927f1580f4eSBarry Smith       }
928f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
929db4a47b3SPierre Jolivet         PetscCall(MatProductCreateWithMat(A, ctx->V[1], nullptr, ctx->V[2]));
930f1580f4eSBarry Smith         PetscCall(MatProductSetType(ctx->V[2], MATPRODUCT_AtB));
931f1580f4eSBarry Smith         PetscCall(MatProductSetFromOptions(ctx->V[2]));
932f1580f4eSBarry Smith         PetscCall(MatProductSymbolic(ctx->V[2]));
933f1580f4eSBarry Smith       }
934f1580f4eSBarry Smith       ctx->P->start(N);
935f1580f4eSBarry Smith     }
936f1580f4eSBarry Smith     if (N == prev || container) { /* when MatProduct container is attached, always need to MatProductReplaceMats() since KSPHPDDM may have replaced the Mat as well */
937db4a47b3SPierre Jolivet       PetscCall(MatProductReplaceMats(nullptr, Y, nullptr, ctx->V[1]));
938f1580f4eSBarry Smith       if (container && ctx->parent->correction != PC_HPDDM_COARSE_CORRECTION_BALANCED) {
939f1580f4eSBarry Smith         PetscCall(MatDenseGetArrayWrite(ctx->V[0], &array));
940f1580f4eSBarry Smith         PetscCall(MatDensePlaceArray(ctx->V[1], array));
941f1580f4eSBarry Smith         PetscCall(MatDenseRestoreArrayWrite(ctx->V[0], &array));
942f1580f4eSBarry Smith         reset = PETSC_TRUE;
943f1580f4eSBarry Smith       }
944f1580f4eSBarry Smith     }
945f1580f4eSBarry Smith     PetscCall(PCHPDDMDeflate_Private(pc, X, Y));
946f1580f4eSBarry Smith     if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED || ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
947f1580f4eSBarry Smith       PetscCall(MatProductNumeric(ctx->V[1]));
948f1580f4eSBarry Smith       PetscCall(MatCopy(ctx->V[1], ctx->V[2], SAME_NONZERO_PATTERN));
949f1580f4eSBarry Smith       PetscCall(MatAXPY(ctx->V[2], -1.0, X, SAME_NONZERO_PATTERN));
950f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, ctx->V[2], ctx->V[1]));
951f1580f4eSBarry Smith       if (ctx->parent->correction == PC_HPDDM_COARSE_CORRECTION_BALANCED) {
952f1580f4eSBarry Smith         PetscCall(MatProductNumeric(ctx->V[2]));
953f1580f4eSBarry Smith         PetscCall(PCHPDDMDeflate_Private(pc, ctx->V[2], ctx->V[2]));
954f1580f4eSBarry Smith         PetscCall(MatAXPY(ctx->V[1], -1.0, ctx->V[2], SAME_NONZERO_PATTERN));
955f1580f4eSBarry Smith       }
956f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, -1.0, ctx->V[1], SAME_NONZERO_PATTERN));
957f1580f4eSBarry Smith     } else {
958f1580f4eSBarry 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);
959f1580f4eSBarry Smith       PetscCall(PCMatApply(ctx->pc, X, ctx->V[1]));
960f1580f4eSBarry Smith       PetscCall(MatAXPY(Y, 1.0, ctx->V[1], SAME_NONZERO_PATTERN));
961f1580f4eSBarry Smith     }
962f1580f4eSBarry Smith     if (reset) PetscCall(MatDenseResetArray(ctx->V[1]));
963aa1539e9SPierre Jolivet   }
9643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
965f1580f4eSBarry Smith }
966f1580f4eSBarry Smith 
967d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_HPDDMShell(PC pc)
968d71ae5a4SJacob Faibussowitsch {
969f1580f4eSBarry Smith   PC_HPDDM_Level *ctx;
970f1580f4eSBarry Smith 
971f1580f4eSBarry Smith   PetscFunctionBegin;
972f1580f4eSBarry Smith   PetscCall(PCShellGetContext(pc, &ctx));
973f1580f4eSBarry Smith   PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(ctx, PETSC_TRUE));
974f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(1, &ctx->v[0]));
975f1580f4eSBarry Smith   PetscCall(VecDestroyVecs(2, &ctx->v[1]));
976f4f49eeaSPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)ctx->pc->mat, "_HPDDM_MatProduct", nullptr));
977f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V));
978f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 1));
979f1580f4eSBarry Smith   PetscCall(MatDestroy(ctx->V + 2));
980f1580f4eSBarry Smith   PetscCall(VecDestroy(&ctx->D));
98101e3c840SPierre Jolivet   PetscCall(PetscSFDestroy(&ctx->scatter));
982f1580f4eSBarry Smith   PetscCall(PCDestroy(&ctx->pc));
9833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
984f1580f4eSBarry Smith }
985f1580f4eSBarry Smith 
9869bb5c669SPierre Jolivet template <class Type, bool T = false, typename std::enable_if<std::is_same<Type, Vec>::value>::type * = nullptr>
9879bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type x, Type y)
9889bb5c669SPierre Jolivet {
9899bb5c669SPierre Jolivet   PetscFunctionBegin;
9909bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[0], std::get<1>(*p), SCATTER_FORWARD, x));
9919bb5c669SPierre Jolivet   if (!T) PetscCall(PCApply(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
9929bb5c669SPierre Jolivet   else PetscCall(PCApplyTranspose(factor, std::get<2>(*p)[0], std::get<2>(*p)[1]));
9939bb5c669SPierre Jolivet   PetscCall(VecISCopy(std::get<2>(*p)[1], std::get<1>(*p), SCATTER_REVERSE, y));
9949bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
9959bb5c669SPierre Jolivet }
9969bb5c669SPierre Jolivet 
9979bb5c669SPierre Jolivet template <class Type, bool = false, typename std::enable_if<std::is_same<Type, Mat>::value>::type * = nullptr>
9989bb5c669SPierre Jolivet static inline PetscErrorCode PCApply_Schur_Private(std::tuple<KSP, IS, Vec[2]> *p, PC factor, Type X, Type Y)
9999bb5c669SPierre Jolivet {
10009bb5c669SPierre Jolivet   Mat B[2];
10019bb5c669SPierre Jolivet   Vec x, y;
10029bb5c669SPierre Jolivet 
10039bb5c669SPierre Jolivet   PetscFunctionBegin;
10049bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B));
10059bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, factor->mat->rmap->n, X->cmap->n, nullptr, B + 1));
10069bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
10079bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(X, i, &x));
10089bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B[0], i, &y));
10099bb5c669SPierre Jolivet     PetscCall(VecISCopy(y, std::get<1>(*p), SCATTER_FORWARD, x));
10109bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B[0], i, &y));
10119bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(X, i, &x));
10129bb5c669SPierre Jolivet   }
10139bb5c669SPierre Jolivet   PetscCall(PCMatApply(factor, B[0], B[1]));
10149bb5c669SPierre Jolivet   PetscCall(MatDestroy(B));
10159bb5c669SPierre Jolivet   for (PetscInt i = 0; i < X->cmap->n; ++i) {
10169bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(B[1], i, &x));
10179bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &y));
10189bb5c669SPierre Jolivet     PetscCall(VecISCopy(x, std::get<1>(*p), SCATTER_REVERSE, y));
10199bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &y));
10209bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(B[1], i, &x));
10219bb5c669SPierre Jolivet   }
10229bb5c669SPierre Jolivet   PetscCall(MatDestroy(B + 1));
10239bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10249bb5c669SPierre Jolivet }
10259bb5c669SPierre Jolivet 
10269bb5c669SPierre Jolivet template <class Type = Vec, bool T = false>
10279bb5c669SPierre Jolivet static PetscErrorCode PCApply_Schur(PC pc, Type x, Type y)
10289bb5c669SPierre Jolivet {
10299bb5c669SPierre Jolivet   PC                           factor;
10309bb5c669SPierre Jolivet   Mat                          A;
10319bb5c669SPierre Jolivet   MatSolverType                type;
10329bb5c669SPierre Jolivet   PetscBool                    flg;
10339bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
10349bb5c669SPierre Jolivet 
10359bb5c669SPierre Jolivet   PetscFunctionBegin;
10369bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
10379bb5c669SPierre Jolivet   PetscCall(KSPGetPC(std::get<0>(*p), &factor));
10389bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(factor, &type));
10399bb5c669SPierre Jolivet   PetscCall(PCFactorGetMatrix(factor, &A));
10409bb5c669SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
10419bb5c669SPierre Jolivet   if (flg) {
10429bb5c669SPierre Jolivet     PetscCheck(PetscDefined(HAVE_MUMPS), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
10439bb5c669SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
10449bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 0));
10459bb5c669SPierre Jolivet #endif
10469bb5c669SPierre Jolivet   } else {
10479bb5c669SPierre Jolivet     PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &flg));
10489bb5c669SPierre Jolivet     PetscCheck(flg && PetscDefined(HAVE_MKL_PARDISO), PETSC_COMM_SELF, PETSC_ERR_PLIB, "Inconsistent MatSolverType");
10499bb5c669SPierre Jolivet     flg = PETSC_FALSE;
10509bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
10519bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 1));
10529bb5c669SPierre Jolivet #endif
10539bb5c669SPierre Jolivet   }
10549bb5c669SPierre Jolivet   PetscCall(PCApply_Schur_Private<Type, T>(p, factor, x, y));
10559bb5c669SPierre Jolivet   if (flg) {
10569bb5c669SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
10579bb5c669SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1));
10589bb5c669SPierre Jolivet #endif
10599bb5c669SPierre Jolivet   } else {
10609bb5c669SPierre Jolivet #if PetscDefined(HAVE_MKL_PARDISO)
10619bb5c669SPierre Jolivet     PetscCall(MatMkl_PardisoSetCntl(A, 70, 0));
10629bb5c669SPierre Jolivet #endif
10639bb5c669SPierre Jolivet   }
10649bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10659bb5c669SPierre Jolivet }
10669bb5c669SPierre Jolivet 
10679bb5c669SPierre Jolivet static PetscErrorCode PCDestroy_Schur(PC pc)
10689bb5c669SPierre Jolivet {
10699bb5c669SPierre Jolivet   std::tuple<KSP, IS, Vec[2]> *p;
10709bb5c669SPierre Jolivet 
10719bb5c669SPierre Jolivet   PetscFunctionBegin;
10729bb5c669SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
10739bb5c669SPierre Jolivet   PetscCall(ISDestroy(&std::get<1>(*p)));
10749bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p)));
10759bb5c669SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*p) + 1));
10769bb5c669SPierre Jolivet   PetscCall(PetscFree(p));
10779bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10789bb5c669SPierre Jolivet }
10799bb5c669SPierre Jolivet 
1080d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSolve_Private(const PC_HPDDM_Level *ctx, PetscScalar *rhs, const unsigned short &mu)
1081d71ae5a4SJacob Faibussowitsch {
1082f1580f4eSBarry Smith   Mat      B, X;
1083f1580f4eSBarry Smith   PetscInt n, N, j = 0;
1084f1580f4eSBarry Smith 
1085f1580f4eSBarry Smith   PetscFunctionBegin;
1086db4a47b3SPierre Jolivet   PetscCall(KSPGetOperators(ctx->ksp, &B, nullptr));
1087db4a47b3SPierre Jolivet   PetscCall(MatGetLocalSize(B, &n, nullptr));
1088db4a47b3SPierre Jolivet   PetscCall(MatGetSize(B, &N, nullptr));
1089f1580f4eSBarry Smith   if (ctx->parent->log_separate) {
1090f1580f4eSBarry Smith     j = std::distance(ctx->parent->levels, std::find(ctx->parent->levels, ctx->parent->levels + ctx->parent->N, ctx));
1091db4a47b3SPierre Jolivet     PetscCall(PetscLogEventBegin(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
1092f1580f4eSBarry Smith   }
1093f1580f4eSBarry Smith   if (mu == 1) {
1094f1580f4eSBarry Smith     if (!ctx->ksp->vec_rhs) {
1095db4a47b3SPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)ctx->ksp), 1, n, N, nullptr, &ctx->ksp->vec_rhs));
1096f1580f4eSBarry Smith       PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)ctx->ksp), n, N, &ctx->ksp->vec_sol));
1097f1580f4eSBarry Smith     }
1098f1580f4eSBarry Smith     PetscCall(VecPlaceArray(ctx->ksp->vec_rhs, rhs));
1099db4a47b3SPierre Jolivet     PetscCall(KSPSolve(ctx->ksp, nullptr, nullptr));
1100f1580f4eSBarry Smith     PetscCall(VecCopy(ctx->ksp->vec_sol, ctx->ksp->vec_rhs));
1101f1580f4eSBarry Smith     PetscCall(VecResetArray(ctx->ksp->vec_rhs));
1102f1580f4eSBarry Smith   } else {
1103f1580f4eSBarry Smith     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, rhs, &B));
1104db4a47b3SPierre Jolivet     PetscCall(MatCreateDense(PetscObjectComm((PetscObject)ctx->ksp), n, PETSC_DECIDE, N, mu, nullptr, &X));
1105f1580f4eSBarry Smith     PetscCall(KSPMatSolve(ctx->ksp, B, X));
1106f1580f4eSBarry Smith     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
1107f1580f4eSBarry Smith     PetscCall(MatDestroy(&X));
1108f1580f4eSBarry Smith     PetscCall(MatDestroy(&B));
1109f1580f4eSBarry Smith   }
1110db4a47b3SPierre Jolivet   if (ctx->parent->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Solve[j], ctx->ksp, nullptr, nullptr, nullptr));
11113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1112f1580f4eSBarry Smith }
1113f1580f4eSBarry Smith 
1114d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetUpNeumannOverlap_Private(PC pc)
1115d71ae5a4SJacob Faibussowitsch {
1116f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
1117f1580f4eSBarry Smith 
1118f1580f4eSBarry Smith   PetscFunctionBegin;
1119f1580f4eSBarry Smith   if (data->setup) {
1120f1580f4eSBarry Smith     Mat       P;
1121db4a47b3SPierre Jolivet     Vec       x, xt = nullptr;
1122f1580f4eSBarry Smith     PetscReal t = 0.0, s = 0.0;
1123f1580f4eSBarry Smith 
1124db4a47b3SPierre Jolivet     PetscCall(PCGetOperators(pc, nullptr, &P));
1125f1580f4eSBarry Smith     PetscCall(PetscObjectQuery((PetscObject)P, "__SNES_latest_X", (PetscObject *)&x));
1126f1580f4eSBarry Smith     PetscCallBack("PCHPDDM Neumann callback", (*data->setup)(data->aux, t, x, xt, s, data->is, data->setup_ctx));
1127f1580f4eSBarry Smith   }
11283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1129f1580f4eSBarry Smith }
1130f1580f4eSBarry Smith 
1131d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCreateSubMatrices_Private(Mat mat, PetscInt n, const IS *, const IS *, MatReuse scall, Mat *submat[])
1132d71ae5a4SJacob Faibussowitsch {
1133f1580f4eSBarry Smith   Mat       A;
113413044ca3SPierre Jolivet   PetscBool flg;
1135f1580f4eSBarry Smith 
1136f1580f4eSBarry Smith   PetscFunctionBegin;
1137f1580f4eSBarry Smith   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatCreateSubMatrices() called to extract %" PetscInt_FMT " submatrices, which is different than 1", n);
1138f1580f4eSBarry Smith   /* previously composed Mat */
1139f1580f4eSBarry Smith   PetscCall(PetscObjectQuery((PetscObject)mat, "_PCHPDDM_SubMatrices", (PetscObject *)&A));
1140f1580f4eSBarry Smith   PetscCheck(A, PETSC_COMM_SELF, PETSC_ERR_PLIB, "SubMatrices not found in Mat");
114113044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSCHURCOMPLEMENT, &flg)); /* MATSCHURCOMPLEMENT has neither a MatDuplicate() nor a MatCopy() implementation */
1142f1580f4eSBarry Smith   if (scall == MAT_INITIAL_MATRIX) {
11436f2c871aSStefano Zampini     PetscCall(PetscCalloc1(2, submat)); /* allocate an extra Mat to avoid errors in MatDestroySubMatrices_Dummy() */
114413044ca3SPierre Jolivet     if (!flg) PetscCall(MatDuplicate(A, MAT_COPY_VALUES, *submat));
114513044ca3SPierre Jolivet   } else if (!flg) PetscCall(MatCopy(A, (*submat)[0], SAME_NONZERO_PATTERN));
114613044ca3SPierre Jolivet   if (flg) {
1147bf583f0cSPierre Jolivet     PetscCall(MatDestroy(*submat)); /* previously created Mat has to be destroyed */
114813044ca3SPierre Jolivet     (*submat)[0] = A;
114913044ca3SPierre Jolivet     PetscCall(PetscObjectReference((PetscObject)A));
115013044ca3SPierre Jolivet   }
11513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1152f1580f4eSBarry Smith }
1153f1580f4eSBarry Smith 
1154d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMCommunicationAvoidingPCASM_Private(PC pc, Mat C, PetscBool sorted)
1155d71ae5a4SJacob Faibussowitsch {
1156f1580f4eSBarry Smith   void (*op)(void);
1157f1580f4eSBarry Smith 
1158f1580f4eSBarry Smith   PetscFunctionBegin;
1159f1580f4eSBarry Smith   /* previously-composed Mat */
1160f1580f4eSBarry Smith   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", (PetscObject)C));
1161f1580f4eSBarry Smith   PetscCall(MatGetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, &op));
1162f1580f4eSBarry Smith   /* trick suggested by Barry https://lists.mcs.anl.gov/pipermail/petsc-dev/2020-January/025491.html */
1163f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, (void (*)(void))PCHPDDMCreateSubMatrices_Private));
1164f1580f4eSBarry Smith   if (sorted) PetscCall(PCASMSetSortIndices(pc, PETSC_FALSE)); /* everything is already sorted */
1165f1580f4eSBarry Smith   PetscCall(PCSetFromOptions(pc));                             /* otherwise -pc_hpddm_levels_1_pc_asm_sub_mat_type is not used */
1166f1580f4eSBarry Smith   PetscCall(PCSetUp(pc));
1167f1580f4eSBarry Smith   /* reset MatCreateSubMatrices() */
1168f1580f4eSBarry Smith   PetscCall(MatSetOperation(pc->pmat, MATOP_CREATE_SUBMATRICES, op));
1169db4a47b3SPierre Jolivet   PetscCall(PetscObjectCompose((PetscObject)pc->pmat, "_PCHPDDM_SubMatrices", nullptr));
11703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1171f1580f4eSBarry Smith }
1172f1580f4eSBarry Smith 
1173d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMPermute_Private(IS is, IS in_is, IS *out_is, Mat in_C, Mat *out_C, IS *p)
1174d71ae5a4SJacob Faibussowitsch {
1175f1580f4eSBarry Smith   IS                           perm;
1176f1580f4eSBarry Smith   const PetscInt              *ptr;
1177811e8887SPierre Jolivet   PetscInt                    *concatenate, size, bs;
1178f1580f4eSBarry Smith   std::map<PetscInt, PetscInt> order;
1179f1580f4eSBarry Smith   PetscBool                    sorted;
1180f1580f4eSBarry Smith 
1181f1580f4eSBarry Smith   PetscFunctionBegin;
1182cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(is, IS_CLASSID, 1);
1183cf67ef9dSPierre Jolivet   PetscValidHeaderSpecific(in_C, MAT_CLASSID, 4);
1184f1580f4eSBarry Smith   PetscCall(ISSorted(is, &sorted));
1185f1580f4eSBarry Smith   if (!sorted) {
1186f1580f4eSBarry Smith     PetscCall(ISGetLocalSize(is, &size));
1187f1580f4eSBarry Smith     PetscCall(ISGetIndices(is, &ptr));
1188b07dfdedSPierre Jolivet     PetscCall(ISGetBlockSize(is, &bs));
1189f1580f4eSBarry Smith     /* MatCreateSubMatrices(), called by PCASM, follows the global numbering of Pmat */
1190811e8887SPierre Jolivet     for (PetscInt n = 0; n < size; n += bs) order.insert(std::make_pair(ptr[n] / bs, n / bs));
1191f1580f4eSBarry Smith     PetscCall(ISRestoreIndices(is, &ptr));
1192b07dfdedSPierre Jolivet     size /= bs;
1193f1580f4eSBarry Smith     if (out_C) {
1194f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1195f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.second;
1196f1580f4eSBarry Smith       concatenate -= size;
1197b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_C), bs, size, concatenate, PETSC_OWN_POINTER, &perm));
1198f1580f4eSBarry Smith       PetscCall(ISSetPermutation(perm));
1199f1580f4eSBarry Smith       /* permute user-provided Mat so that it matches with MatCreateSubMatrices() numbering */
1200f1580f4eSBarry Smith       PetscCall(MatPermute(in_C, perm, perm, out_C));
1201f1580f4eSBarry Smith       if (p) *p = perm;
1202f1580f4eSBarry Smith       else PetscCall(ISDestroy(&perm)); /* no need to save the permutation */
1203f1580f4eSBarry Smith     }
1204f1580f4eSBarry Smith     if (out_is) {
1205f1580f4eSBarry Smith       PetscCall(PetscMalloc1(size, &concatenate));
1206f1580f4eSBarry Smith       for (const std::pair<const PetscInt, PetscInt> &i : order) *concatenate++ = i.first;
1207f1580f4eSBarry Smith       concatenate -= size;
1208f1580f4eSBarry Smith       /* permute user-provided IS so that it matches with MatCreateSubMatrices() numbering */
1209b07dfdedSPierre Jolivet       PetscCall(ISCreateBlock(PetscObjectComm((PetscObject)in_is), bs, size, concatenate, PETSC_OWN_POINTER, out_is));
1210f1580f4eSBarry Smith     }
1211f1580f4eSBarry Smith   } else { /* input IS is sorted, nothing to permute, simply duplicate inputs when needed */
1212f1580f4eSBarry Smith     if (out_C) PetscCall(MatDuplicate(in_C, MAT_COPY_VALUES, out_C));
1213f1580f4eSBarry Smith     if (out_is) PetscCall(ISDuplicate(in_is, out_is));
1214f1580f4eSBarry Smith   }
12153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1216f1580f4eSBarry Smith }
1217f1580f4eSBarry Smith 
1218281f8ce6SPierre Jolivet static PetscErrorCode PCHPDDMCheckSymmetry_Private(PC pc, Mat A01, Mat A10, Mat *B01 = nullptr)
121913044ca3SPierre Jolivet {
122013044ca3SPierre Jolivet   Mat       T, U = nullptr, B = nullptr;
122113044ca3SPierre Jolivet   IS        z;
1222281f8ce6SPierre Jolivet   PetscBool flg, conjugate = PETSC_FALSE;
122313044ca3SPierre Jolivet 
122413044ca3SPierre Jolivet   PetscFunctionBegin;
1225281f8ce6SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
1226281f8ce6SPierre Jolivet   if (B01) *B01 = nullptr;
1227281f8ce6SPierre Jolivet   if (flg) {
1228811e8887SPierre 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));
1229811e8887SPierre Jolivet     PetscCall(MatTransposeGetMat(A10, &U));
1230811e8887SPierre Jolivet   } else {
1231281f8ce6SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
1232281f8ce6SPierre Jolivet     if (flg) {
1233811e8887SPierre 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));
1234811e8887SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A10, &U));
1235281f8ce6SPierre Jolivet       conjugate = PETSC_TRUE;
1236811e8887SPierre Jolivet     }
123713044ca3SPierre Jolivet   }
123813044ca3SPierre Jolivet   if (U) PetscCall(MatDuplicate(U, MAT_COPY_VALUES, &T));
123913044ca3SPierre Jolivet   else PetscCall(MatHermitianTranspose(A10, MAT_INITIAL_MATRIX, &T));
1240281f8ce6SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATTRANSPOSEVIRTUAL, &flg));
1241281f8ce6SPierre Jolivet   if (flg) {
1242811e8887SPierre 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));
124313044ca3SPierre Jolivet     PetscCall(MatTransposeGetMat(A01, &A01));
124413044ca3SPierre Jolivet     PetscCall(MatTranspose(A01, MAT_INITIAL_MATRIX, &B));
124513044ca3SPierre Jolivet     A01 = B;
124613044ca3SPierre Jolivet   } else {
1247281f8ce6SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)A01, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
1248281f8ce6SPierre Jolivet     if (flg) {
1249811e8887SPierre 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));
125013044ca3SPierre Jolivet       PetscCall(MatHermitianTransposeGetMat(A01, &A01));
125113044ca3SPierre Jolivet       PetscCall(MatHermitianTranspose(A01, MAT_INITIAL_MATRIX, &B));
125213044ca3SPierre Jolivet       A01 = B;
125313044ca3SPierre Jolivet     }
125413044ca3SPierre Jolivet   }
1255281f8ce6SPierre Jolivet   PetscCall(PetscLayoutCompare(T->rmap, A01->rmap, &flg));
1256281f8ce6SPierre Jolivet   if (flg) {
1257281f8ce6SPierre Jolivet     PetscCall(PetscLayoutCompare(T->cmap, A01->cmap, &flg));
1258281f8ce6SPierre Jolivet     if (flg) {
125913044ca3SPierre Jolivet       PetscCall(MatFindZeroRows(A01, &z)); /* for essential boundary conditions, some implementations will */
126013044ca3SPierre Jolivet       if (z) {                             /*  zero rows in [P00 A01] except for the diagonal of P00       */
1261281f8ce6SPierre Jolivet         if (B01) PetscCall(MatDuplicate(T, MAT_COPY_VALUES, B01));
126213044ca3SPierre Jolivet         PetscCall(MatSetOption(T, MAT_NO_OFF_PROC_ZERO_ROWS, PETSC_TRUE));
126313044ca3SPierre Jolivet         PetscCall(MatZeroRowsIS(T, z, 0.0, nullptr, nullptr)); /* corresponding zero rows from A01 */
1264281f8ce6SPierre Jolivet       }
1265281f8ce6SPierre Jolivet       PetscCall(MatMultEqual(A01, T, 20, &flg));
1266281f8ce6SPierre Jolivet       if (!B01) PetscCheck(flg, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "A01 != A10^T");
1267281f8ce6SPierre Jolivet       else {
1268281f8ce6SPierre Jolivet         PetscCall(PetscInfo(pc, "A01 and A10^T are equal? %s\n", PetscBools[flg]));
1269281f8ce6SPierre Jolivet         if (!flg) {
1270281f8ce6SPierre Jolivet           if (z) PetscCall(MatDestroy(&T));
1271281f8ce6SPierre Jolivet           else *B01 = T;
1272281f8ce6SPierre Jolivet           flg = PETSC_TRUE;
1273281f8ce6SPierre Jolivet         } else PetscCall(MatDestroy(B01));
1274281f8ce6SPierre Jolivet       }
127513044ca3SPierre Jolivet       PetscCall(ISDestroy(&z));
127613044ca3SPierre Jolivet     }
127713044ca3SPierre Jolivet   }
1278281f8ce6SPierre Jolivet   if (!flg) PetscCall(PetscInfo(pc, "A01 and A10^T have non-congruent layouts, cannot test for equality\n"));
1279281f8ce6SPierre Jolivet   if (!B01 || !*B01) PetscCall(MatDestroy(&T));
1280281f8ce6SPierre Jolivet   else if (conjugate) PetscCall(MatConjugate(T));
128113044ca3SPierre Jolivet   PetscCall(MatDestroy(&B));
128213044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
128313044ca3SPierre Jolivet }
128413044ca3SPierre Jolivet 
1285d16c0b94SPierre Jolivet static PetscErrorCode PCHPDDMCheckInclusion_Private(PC pc, IS is, IS is_local, PetscBool check)
1286d16c0b94SPierre Jolivet {
1287d16c0b94SPierre Jolivet   IS          intersect;
1288d16c0b94SPierre Jolivet   const char *str = "IS of the auxiliary Mat does not include all local rows of A";
1289d16c0b94SPierre Jolivet   PetscBool   equal;
1290d16c0b94SPierre Jolivet 
1291d16c0b94SPierre Jolivet   PetscFunctionBegin;
1292d16c0b94SPierre Jolivet   PetscCall(ISIntersect(is, is_local, &intersect));
1293d16c0b94SPierre Jolivet   PetscCall(ISEqualUnsorted(is_local, intersect, &equal));
1294d16c0b94SPierre Jolivet   PetscCall(ISDestroy(&intersect));
1295d16c0b94SPierre Jolivet   if (check) PetscCheck(equal, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "%s", str);
1296d16c0b94SPierre Jolivet   else if (!equal) PetscCall(PetscInfo(pc, "%s\n", str));
1297d16c0b94SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1298d16c0b94SPierre Jolivet }
1299d16c0b94SPierre Jolivet 
1300d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMDestroySubMatrices_Private(PetscBool flg, PetscBool algebraic, Mat *sub)
1301d71ae5a4SJacob Faibussowitsch {
1302f1580f4eSBarry Smith   IS is;
1303f1580f4eSBarry Smith 
1304f1580f4eSBarry Smith   PetscFunctionBegin;
1305f1580f4eSBarry Smith   if (!flg) {
1306f1580f4eSBarry Smith     if (algebraic) {
1307f1580f4eSBarry Smith       PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Embed", (PetscObject *)&is));
1308f1580f4eSBarry Smith       PetscCall(ISDestroy(&is));
1309db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Embed", nullptr));
1310db4a47b3SPierre Jolivet       PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Compact", nullptr));
1311f1580f4eSBarry Smith     }
1312f1580f4eSBarry Smith     PetscCall(MatDestroySubMatrices(algebraic ? 2 : 1, &sub));
1313f1580f4eSBarry Smith   }
13143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1315f1580f4eSBarry Smith }
1316f1580f4eSBarry Smith 
1317d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMAlgebraicAuxiliaryMat_Private(Mat P, IS *is, Mat *sub[], PetscBool block)
1318d71ae5a4SJacob Faibussowitsch {
1319f1580f4eSBarry Smith   IS         icol[3], irow[2];
1320f1580f4eSBarry Smith   Mat       *M, Q;
1321f1580f4eSBarry Smith   PetscReal *ptr;
1322*58b7e2c1SStefano Zampini   PetscInt  *idx, p = 0, bs = P->cmap->bs;
1323f1580f4eSBarry Smith   PetscBool  flg;
1324f1580f4eSBarry Smith 
1325f1580f4eSBarry Smith   PetscFunctionBegin;
1326f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, P->cmap->N, 0, 1, icol + 2));
1327f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(icol[2], bs));
1328f1580f4eSBarry Smith   PetscCall(ISSetIdentity(icol[2]));
1329f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
1330f1580f4eSBarry Smith   if (flg) {
1331f1580f4eSBarry Smith     /* MatCreateSubMatrices() does not handle MATMPISBAIJ properly when iscol != isrow, so convert first to MATMPIBAIJ */
1332f1580f4eSBarry Smith     PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &Q));
1333f1580f4eSBarry Smith     std::swap(P, Q);
1334f1580f4eSBarry Smith   }
1335f1580f4eSBarry Smith   PetscCall(MatCreateSubMatrices(P, 1, is, icol + 2, MAT_INITIAL_MATRIX, &M));
1336f1580f4eSBarry Smith   if (flg) {
1337f1580f4eSBarry Smith     std::swap(P, Q);
1338f1580f4eSBarry Smith     PetscCall(MatDestroy(&Q));
1339f1580f4eSBarry Smith   }
1340f1580f4eSBarry Smith   PetscCall(ISDestroy(icol + 2));
1341f1580f4eSBarry Smith   PetscCall(ISCreateStride(PETSC_COMM_SELF, M[0]->rmap->N, 0, 1, irow));
1342f1580f4eSBarry Smith   PetscCall(ISSetBlockSize(irow[0], bs));
1343f1580f4eSBarry Smith   PetscCall(ISSetIdentity(irow[0]));
1344f1580f4eSBarry Smith   if (!block) {
1345b07dfdedSPierre Jolivet     PetscCall(PetscMalloc2(P->cmap->N, &ptr, P->cmap->N / bs, &idx));
1346f1580f4eSBarry Smith     PetscCall(MatGetColumnNorms(M[0], NORM_INFINITY, ptr));
1347f1580f4eSBarry Smith     /* check for nonzero columns so that M[0] may be expressed in compact form */
1348811e8887SPierre Jolivet     for (PetscInt n = 0; n < P->cmap->N; n += bs) {
1349b07dfdedSPierre Jolivet       if (std::find_if(ptr + n, ptr + n + bs, [](PetscReal v) { return v > PETSC_MACHINE_EPSILON; }) != ptr + n + bs) idx[p++] = n / bs;
1350f1580f4eSBarry Smith     }
1351b07dfdedSPierre Jolivet     PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, p, idx, PETSC_USE_POINTER, icol + 1));
1352f1580f4eSBarry Smith     PetscCall(ISSetInfo(icol[1], IS_SORTED, IS_GLOBAL, PETSC_TRUE, PETSC_TRUE));
1353f1580f4eSBarry Smith     PetscCall(ISEmbed(*is, icol[1], PETSC_FALSE, icol + 2));
1354f1580f4eSBarry Smith     irow[1] = irow[0];
1355f1580f4eSBarry 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 */
1356f1580f4eSBarry Smith     icol[0] = is[0];
1357f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 2, irow, icol, MAT_INITIAL_MATRIX, sub));
1358f1580f4eSBarry Smith     PetscCall(ISDestroy(icol + 1));
1359f1580f4eSBarry Smith     PetscCall(PetscFree2(ptr, idx));
1360f1580f4eSBarry Smith     /* IS used to go back and forth between the augmented and the original local linear system, see eq. (3.4) of [2022b] */
1361f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Embed", (PetscObject)icol[2]));
1362f1580f4eSBarry Smith     /* Mat used in eq. (3.1) of [2022b] */
1363f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Compact", (PetscObject)(*sub)[1]));
1364f1580f4eSBarry Smith   } else {
1365f1580f4eSBarry Smith     Mat aux;
1366811e8887SPierre Jolivet 
1367f1580f4eSBarry Smith     PetscCall(MatSetOption(M[0], MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
1368f1580f4eSBarry Smith     /* diagonal block of the overlapping rows */
1369f1580f4eSBarry Smith     PetscCall(MatCreateSubMatrices(M[0], 1, irow, is, MAT_INITIAL_MATRIX, sub));
1370f1580f4eSBarry Smith     PetscCall(MatDuplicate((*sub)[0], MAT_COPY_VALUES, &aux));
1371f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1372f1580f4eSBarry Smith     if (bs == 1) { /* scalar case */
1373f1580f4eSBarry Smith       Vec sum[2];
1374811e8887SPierre Jolivet 
1375f1580f4eSBarry Smith       PetscCall(MatCreateVecs(aux, sum, sum + 1));
1376f1580f4eSBarry Smith       PetscCall(MatGetRowSum(M[0], sum[0]));
1377f1580f4eSBarry Smith       PetscCall(MatGetRowSum(aux, sum[1]));
1378f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1379f1580f4eSBarry Smith       PetscCall(VecAXPY(sum[0], -1.0, sum[1]));
1380f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1381f1580f4eSBarry Smith       PetscCall(MatDiagonalSet(aux, sum[0], ADD_VALUES));
1382f1580f4eSBarry Smith       PetscCall(VecDestroy(sum));
1383f1580f4eSBarry Smith       PetscCall(VecDestroy(sum + 1));
1384f1580f4eSBarry Smith     } else { /* vectorial case */
1385f1580f4eSBarry Smith       /* TODO: missing MatGetValuesBlocked(), so the code below is     */
1386f1580f4eSBarry Smith       /* an extension of the scalar case for when bs > 1, but it could */
1387f1580f4eSBarry Smith       /* be more efficient by avoiding all these MatMatMult()          */
1388f1580f4eSBarry Smith       Mat          sum[2], ones;
1389f1580f4eSBarry Smith       PetscScalar *ptr;
1390811e8887SPierre Jolivet 
1391f1580f4eSBarry Smith       PetscCall(PetscCalloc1(M[0]->cmap->n * bs, &ptr));
1392f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, M[0]->cmap->n, bs, M[0]->cmap->n, bs, ptr, &ones));
1393811e8887SPierre Jolivet       for (PetscInt n = 0; n < M[0]->cmap->n; n += bs) {
1394f1580f4eSBarry Smith         for (p = 0; p < bs; ++p) ptr[n + p * (M[0]->cmap->n + 1)] = 1.0;
1395f1580f4eSBarry Smith       }
1396fb842aefSJose E. Roman       PetscCall(MatMatMult(M[0], ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum));
1397f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1398f1580f4eSBarry Smith       PetscCall(MatCreateDense(PETSC_COMM_SELF, aux->cmap->n, bs, aux->cmap->n, bs, ptr, &ones));
1399f1580f4eSBarry Smith       PetscCall(MatDenseSetLDA(ones, M[0]->cmap->n));
1400fb842aefSJose E. Roman       PetscCall(MatMatMult(aux, ones, MAT_INITIAL_MATRIX, PETSC_CURRENT, sum + 1));
1401f1580f4eSBarry Smith       PetscCall(MatDestroy(&ones));
1402f1580f4eSBarry Smith       PetscCall(PetscFree(ptr));
1403f1580f4eSBarry Smith       /* off-diagonal block row sum (full rows - diagonal block rows) */
1404f1580f4eSBarry Smith       PetscCall(MatAXPY(sum[0], -1.0, sum[1], SAME_NONZERO_PATTERN));
1405f1580f4eSBarry Smith       PetscCall(MatDestroy(sum + 1));
1406f1580f4eSBarry Smith       /* re-order values to be consistent with MatSetValuesBlocked()           */
1407f1580f4eSBarry Smith       /* equivalent to MatTranspose() which does not truly handle              */
1408f1580f4eSBarry Smith       /* MAT_INPLACE_MATRIX in the rectangular case, as it calls PetscMalloc() */
1409f1580f4eSBarry Smith       PetscCall(MatDenseGetArrayWrite(sum[0], &ptr));
1410f1580f4eSBarry Smith       HPDDM::Wrapper<PetscScalar>::imatcopy<'T'>(bs, sum[0]->rmap->n, ptr, sum[0]->rmap->n, bs);
1411f1580f4eSBarry Smith       /* subdomain matrix plus off-diagonal block row sum */
1412811e8887SPierre Jolivet       for (PetscInt n = 0; n < aux->cmap->n / bs; ++n) PetscCall(MatSetValuesBlocked(aux, 1, &n, 1, &n, ptr + n * bs * bs, ADD_VALUES));
1413f1580f4eSBarry Smith       PetscCall(MatAssemblyBegin(aux, MAT_FINAL_ASSEMBLY));
1414f1580f4eSBarry Smith       PetscCall(MatAssemblyEnd(aux, MAT_FINAL_ASSEMBLY));
1415f1580f4eSBarry Smith       PetscCall(MatDenseRestoreArrayWrite(sum[0], &ptr));
1416f1580f4eSBarry Smith       PetscCall(MatDestroy(sum));
1417f1580f4eSBarry Smith     }
1418f1580f4eSBarry Smith     PetscCall(MatSetOption(aux, MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_TRUE));
1419f1580f4eSBarry Smith     /* left-hand side of GenEO, with the same sparsity pattern as PCASM subdomain solvers  */
1420f1580f4eSBarry Smith     PetscCall(PetscObjectCompose((PetscObject)(*sub)[0], "_PCHPDDM_Neumann_Mat", (PetscObject)aux));
1421f1580f4eSBarry Smith   }
1422f1580f4eSBarry Smith   PetscCall(ISDestroy(irow));
1423f1580f4eSBarry Smith   PetscCall(MatDestroySubMatrices(1, &M));
14243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1425f1580f4eSBarry Smith }
1426f1580f4eSBarry Smith 
142713044ca3SPierre Jolivet static PetscErrorCode PCApply_Nest(PC pc, Vec x, Vec y)
142813044ca3SPierre Jolivet {
142913044ca3SPierre Jolivet   Mat                    A;
143013044ca3SPierre Jolivet   MatSolverType          type;
143113044ca3SPierre Jolivet   IS                     is[2];
143213044ca3SPierre Jolivet   PetscBool              flg;
143313044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
143413044ca3SPierre Jolivet 
143513044ca3SPierre Jolivet   PetscFunctionBegin;
143613044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
143713044ca3SPierre Jolivet   PetscCall(PCGetOperators(p->first, &A, nullptr));
143813044ca3SPierre Jolivet   PetscCall(MatNestGetISs(A, is, nullptr));
143913044ca3SPierre Jolivet   PetscCall(PCFactorGetMatSolverType(p->first, &type));
144013044ca3SPierre Jolivet   PetscCall(PCFactorGetMatrix(p->first, &A));
144113044ca3SPierre Jolivet   PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
144224ddd604SPierre Jolivet   if (flg && A->schur) {
144313044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
144413044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, 1)); /* reduction/condensation phase followed by Schur complement solve */
144513044ca3SPierre Jolivet #endif
144613044ca3SPierre Jolivet   }
144713044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[0], is[1], SCATTER_FORWARD, x)); /* assign the RHS associated to the Schur complement */
144813044ca3SPierre Jolivet   PetscCall(PCApply(p->first, p->second[0], p->second[1]));
144913044ca3SPierre Jolivet   PetscCall(VecISCopy(p->second[1], is[1], SCATTER_REVERSE, y)); /* retrieve the partial solution associated to the Schur complement */
145013044ca3SPierre Jolivet   if (flg) {
145113044ca3SPierre Jolivet #if PetscDefined(HAVE_MUMPS)
145213044ca3SPierre Jolivet     PetscCall(MatMumpsSetIcntl(A, 26, -1)); /* default ICNTL(26) value in PETSc */
145313044ca3SPierre Jolivet #endif
145413044ca3SPierre Jolivet   }
145513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
145613044ca3SPierre Jolivet }
145713044ca3SPierre Jolivet 
145813044ca3SPierre Jolivet static PetscErrorCode PCView_Nest(PC pc, PetscViewer viewer)
145913044ca3SPierre Jolivet {
146013044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
146113044ca3SPierre Jolivet 
146213044ca3SPierre Jolivet   PetscFunctionBegin;
146313044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
146413044ca3SPierre Jolivet   PetscCall(PCView(p->first, viewer));
146513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
146613044ca3SPierre Jolivet }
146713044ca3SPierre Jolivet 
146813044ca3SPierre Jolivet static PetscErrorCode PCDestroy_Nest(PC pc)
146913044ca3SPierre Jolivet {
147013044ca3SPierre Jolivet   std::pair<PC, Vec[2]> *p;
147113044ca3SPierre Jolivet 
147213044ca3SPierre Jolivet   PetscFunctionBegin;
147313044ca3SPierre Jolivet   PetscCall(PCShellGetContext(pc, &p));
147413044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second));
147513044ca3SPierre Jolivet   PetscCall(VecDestroy(p->second + 1));
147613044ca3SPierre Jolivet   PetscCall(PCDestroy(&p->first));
147713044ca3SPierre Jolivet   PetscCall(PetscFree(p));
147813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
147913044ca3SPierre Jolivet }
148013044ca3SPierre Jolivet 
148113044ca3SPierre Jolivet template <bool T = false>
148213044ca3SPierre Jolivet static PetscErrorCode MatMult_Schur(Mat A, Vec x, Vec y)
148313044ca3SPierre Jolivet {
148401e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
148513044ca3SPierre Jolivet 
148613044ca3SPierre Jolivet   PetscFunctionBegin;
148713044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
148813044ca3SPierre Jolivet   PetscCall(VecScatterBegin(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD)); /* local Vec with overlap */
148913044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), x, std::get<2>(*ctx)[0], INSERT_VALUES, SCATTER_FORWARD));
149013044ca3SPierre Jolivet   if (!T) PetscCall(MatMult(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1])); /* local Schur complement */
149113044ca3SPierre Jolivet   else PetscCall(MatMultTranspose(std::get<0>(*ctx), std::get<2>(*ctx)[0], std::get<2>(*ctx)[1]));
149213044ca3SPierre Jolivet   PetscCall(VecSet(y, 0.0));
149313044ca3SPierre 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 */
149413044ca3SPierre Jolivet   PetscCall(VecScatterEnd(std::get<1>(*ctx), std::get<2>(*ctx)[1], y, ADD_VALUES, SCATTER_REVERSE));
149513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
149613044ca3SPierre Jolivet }
149713044ca3SPierre Jolivet 
149813044ca3SPierre Jolivet static PetscErrorCode MatDestroy_Schur(Mat A)
149913044ca3SPierre Jolivet {
150001e3c840SPierre Jolivet   std::tuple<Mat, PetscSF, Vec[2]> *ctx;
150113044ca3SPierre Jolivet 
150213044ca3SPierre Jolivet   PetscFunctionBegin;
150313044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
150413044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx)));
150513044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<2>(*ctx) + 1));
150613044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
150713044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
150813044ca3SPierre Jolivet }
150913044ca3SPierre Jolivet 
151013044ca3SPierre Jolivet static PetscErrorCode MatMult_SchurCorrection(Mat A, Vec x, Vec y)
151113044ca3SPierre Jolivet {
151213044ca3SPierre Jolivet   PC                                         pc;
151313044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
151413044ca3SPierre Jolivet 
151513044ca3SPierre Jolivet   PetscFunctionBegin;
151613044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
151713044ca3SPierre Jolivet   pc = ((PC_HPDDM *)std::get<0>(*ctx)[0]->data)->levels[0]->ksp->pc;
151813044ca3SPierre 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 */
151913044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], x, std::get<3>(*ctx)[1]));                    /*     A_01 x                 */
152013044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 x             */
152113044ca3SPierre 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        */
152213044ca3SPierre 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 */
152313044ca3SPierre Jolivet   } else {
152413044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[0]));                    /*     M_S^-1 x               */
152513044ca3SPierre Jolivet     PetscCall(MatMult(std::get<1>(*ctx)[0], std::get<3>(*ctx)[0], std::get<3>(*ctx)[1])); /*     A_01 M_S^-1 x          */
152613044ca3SPierre Jolivet     PetscCall(PCHPDDMDeflate_Private(pc, std::get<3>(*ctx)[1], std::get<3>(*ctx)[1]));    /*     Q_0 A_01 M_S^-1 x      */
152713044ca3SPierre 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 */
152813044ca3SPierre Jolivet   }
152913044ca3SPierre Jolivet   PetscCall(VecAXPY(y, -1.0, x)); /* y -= x, preconditioned eq. (24) of https://hal.science/hal-02343808v6/document (with a sign flip) */
153013044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
153113044ca3SPierre Jolivet }
153213044ca3SPierre Jolivet 
153313044ca3SPierre Jolivet static PetscErrorCode MatView_SchurCorrection(Mat A, PetscViewer viewer)
153413044ca3SPierre Jolivet {
153513044ca3SPierre Jolivet   PetscBool                                  ascii;
153613044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
153713044ca3SPierre Jolivet 
153813044ca3SPierre Jolivet   PetscFunctionBegin;
153913044ca3SPierre Jolivet   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &ascii));
154013044ca3SPierre Jolivet   if (ascii) {
154113044ca3SPierre Jolivet     PetscCall(MatShellGetContext(A, &ctx));
154213044ca3SPierre 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)"));
154313044ca3SPierre Jolivet     PetscCall(PCView(std::get<0>(*ctx)[1], viewer)); /* no need to PCView(Q_0) since it will be done by PCFIELDSPLIT */
154413044ca3SPierre Jolivet   }
154513044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
154613044ca3SPierre Jolivet }
154713044ca3SPierre Jolivet 
154813044ca3SPierre Jolivet static PetscErrorCode MatDestroy_SchurCorrection(Mat A)
154913044ca3SPierre Jolivet {
155013044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx;
155113044ca3SPierre Jolivet 
155213044ca3SPierre Jolivet   PetscFunctionBegin;
155313044ca3SPierre Jolivet   PetscCall(MatShellGetContext(A, &ctx));
155413044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx)));
155513044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 1));
155613044ca3SPierre Jolivet   PetscCall(VecDestroy(std::get<3>(*ctx) + 2));
155713044ca3SPierre Jolivet   PetscCall(PCDestroy(std::get<0>(*ctx) + 1));
155813044ca3SPierre Jolivet   PetscCall(PetscFree(ctx));
155913044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
156013044ca3SPierre Jolivet }
156113044ca3SPierre Jolivet 
1562feebddf4SPierre Jolivet static PetscErrorCode PCPostSolve_SchurPreLeastSquares(PC, KSP, Vec, Vec x)
1563feebddf4SPierre Jolivet {
1564feebddf4SPierre Jolivet   PetscFunctionBegin;
1565feebddf4SPierre Jolivet   PetscCall(VecScale(x, -1.0));
1566feebddf4SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1567feebddf4SPierre Jolivet }
1568feebddf4SPierre Jolivet 
156913044ca3SPierre Jolivet static PetscErrorCode KSPPreSolve_SchurCorrection(KSP, Vec b, Vec, void *context)
157013044ca3SPierre Jolivet {
157113044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
157213044ca3SPierre Jolivet 
1573a6b3e571SPierre Jolivet   PetscFunctionBegin;
157413044ca3SPierre Jolivet   if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
157513044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], b, std::get<3>(*ctx)[2]));
157613044ca3SPierre 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 */
157713044ca3SPierre Jolivet   }
157813044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
157913044ca3SPierre Jolivet }
158013044ca3SPierre Jolivet 
158113044ca3SPierre Jolivet static PetscErrorCode KSPPostSolve_SchurCorrection(KSP, Vec b, Vec x, void *context)
158213044ca3SPierre Jolivet {
158313044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = reinterpret_cast<std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *>(context);
158413044ca3SPierre Jolivet 
1585a6b3e571SPierre Jolivet   PetscFunctionBegin;
158613044ca3SPierre 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 */
158713044ca3SPierre Jolivet   else {
158813044ca3SPierre Jolivet     PetscCall(PCApply(std::get<0>(*ctx)[1], x, std::get<3>(*ctx)[2]));
158913044ca3SPierre Jolivet     PetscCall(VecCopy(std::get<3>(*ctx)[2], x)); /* replace x by M^-1 x */
159013044ca3SPierre Jolivet   }
159113044ca3SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
159213044ca3SPierre Jolivet }
159313044ca3SPierre Jolivet 
15949bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat, Vec, Vec);
15959bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat, Vec, Vec);
15969bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat, Mat, Mat, void *);
15979bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat);
15989bb5c669SPierre Jolivet 
1599d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_HPDDM(PC pc)
1600d71ae5a4SJacob Faibussowitsch {
1601f1580f4eSBarry Smith   PC_HPDDM                                  *data = (PC_HPDDM *)pc->data;
1602f1580f4eSBarry Smith   PC                                         inner;
1603f1580f4eSBarry Smith   KSP                                       *ksp;
160413044ca3SPierre Jolivet   Mat                                       *sub, A, P, N, C = nullptr, uaux = nullptr, weighted, subA[2], S;
1605f1580f4eSBarry Smith   Vec                                        xin, v;
1606f1580f4eSBarry Smith   std::vector<Vec>                           initial;
1607db4a47b3SPierre Jolivet   IS                                         is[1], loc, uis = data->is, unsorted = nullptr;
1608f1580f4eSBarry Smith   ISLocalToGlobalMapping                     l2g;
1609f1580f4eSBarry Smith   char                                       prefix[256];
1610f1580f4eSBarry Smith   const char                                *pcpre;
1611f1580f4eSBarry Smith   const PetscScalar *const                  *ev;
16129bb5c669SPierre Jolivet   PetscInt                                   n, requested = data->N, reused = 0, overlap = -1;
1613f1580f4eSBarry Smith   MatStructure                               structure  = UNKNOWN_NONZERO_PATTERN;
1614f1580f4eSBarry Smith   PetscBool                                  subdomains = PETSC_FALSE, flg = PETSC_FALSE, ismatis, swap = PETSC_FALSE, algebraic = PETSC_FALSE, block = PETSC_FALSE;
1615f1580f4eSBarry Smith   DM                                         dm;
161613044ca3SPierre Jolivet   std::tuple<PC[2], Mat[2], PCSide, Vec[3]> *ctx = nullptr;
1617398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
1618db4a47b3SPierre Jolivet   IS  dis  = nullptr;
1619db4a47b3SPierre Jolivet   Mat daux = nullptr;
1620398c7888SPierre Jolivet #endif
1621f1580f4eSBarry Smith 
1622f1580f4eSBarry Smith   PetscFunctionBegin;
1623f1580f4eSBarry Smith   PetscCheck(data->levels && data->levels[0], PETSC_COMM_SELF, PETSC_ERR_PLIB, "Not a single level allocated");
1624f1580f4eSBarry Smith   PetscCall(PCGetOptionsPrefix(pc, &pcpre));
1625f1580f4eSBarry Smith   PetscCall(PCGetOperators(pc, &A, &P));
1626f1580f4eSBarry Smith   if (!data->levels[0]->ksp) {
1627f1580f4eSBarry Smith     PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->ksp));
16283821be0aSBarry Smith     PetscCall(KSPSetNestLevel(data->levels[0]->ksp, pc->kspnestlevel));
1629f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_%s_", pcpre ? pcpre : "", data->N > 1 ? "levels_1" : "coarse"));
1630f1580f4eSBarry Smith     PetscCall(KSPSetOptionsPrefix(data->levels[0]->ksp, prefix));
1631f1580f4eSBarry Smith     PetscCall(KSPSetType(data->levels[0]->ksp, KSPPREONLY));
1632f1580f4eSBarry Smith   } else if (data->levels[0]->ksp->pc && data->levels[0]->ksp->pc->setupcalled == 1 && data->levels[0]->ksp->pc->reusepreconditioner) {
1633f1580f4eSBarry Smith     /* if the fine-level PCSHELL exists, its setup has succeeded, and one wants to reuse it, */
1634f1580f4eSBarry Smith     /* then just propagate the appropriate flag to the coarser levels                        */
1635f1580f4eSBarry Smith     for (n = 0; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1636f1580f4eSBarry Smith       /* the following KSP and PC may be NULL for some processes, hence the check            */
1637f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetReusePreconditioner(data->levels[n]->ksp, PETSC_TRUE));
1638f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
1639f1580f4eSBarry Smith     }
1640f1580f4eSBarry Smith     /* early bail out because there is nothing to do */
16413ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1642f1580f4eSBarry Smith   } else {
1643f1580f4eSBarry Smith     /* reset coarser levels */
1644f1580f4eSBarry Smith     for (n = 1; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
1645f1580f4eSBarry Smith       if (data->levels[n]->ksp && data->levels[n]->ksp->pc && data->levels[n]->ksp->pc->setupcalled == 1 && data->levels[n]->ksp->pc->reusepreconditioner && n < data->N) {
1646f1580f4eSBarry Smith         reused = data->N - n;
1647f1580f4eSBarry Smith         break;
1648f1580f4eSBarry Smith       }
1649f1580f4eSBarry Smith       PetscCall(KSPDestroy(&data->levels[n]->ksp));
1650f1580f4eSBarry Smith       PetscCall(PCDestroy(&data->levels[n]->pc));
1651f1580f4eSBarry Smith     }
1652f1580f4eSBarry Smith     /* check if some coarser levels are being reused */
1653462c564dSBarry Smith     PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &reused, 1, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)pc)));
1654f1580f4eSBarry Smith     const int *addr = data->levels[0]->P ? data->levels[0]->P->getAddrLocal() : &HPDDM::i__0;
1655f1580f4eSBarry Smith 
1656f1580f4eSBarry Smith     if (addr != &HPDDM::i__0 && reused != data->N - 1) {
1657f1580f4eSBarry Smith       /* reuse previously computed eigenvectors */
1658f1580f4eSBarry Smith       ev = data->levels[0]->P->getVectors();
1659f1580f4eSBarry Smith       if (ev) {
1660f1580f4eSBarry Smith         initial.reserve(*addr);
1661f1580f4eSBarry Smith         PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, data->levels[0]->P->getDof(), ev[0], &xin));
1662f1580f4eSBarry Smith         for (n = 0; n < *addr; ++n) {
1663f1580f4eSBarry Smith           PetscCall(VecDuplicate(xin, &v));
1664f1580f4eSBarry Smith           PetscCall(VecPlaceArray(xin, ev[n]));
1665f1580f4eSBarry Smith           PetscCall(VecCopy(xin, v));
1666f1580f4eSBarry Smith           initial.emplace_back(v);
1667f1580f4eSBarry Smith           PetscCall(VecResetArray(xin));
1668f1580f4eSBarry Smith         }
1669f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
1670f1580f4eSBarry Smith       }
1671f1580f4eSBarry Smith     }
1672f1580f4eSBarry Smith   }
1673f1580f4eSBarry Smith   data->N -= reused;
1674f1580f4eSBarry Smith   PetscCall(KSPSetOperators(data->levels[0]->ksp, A, P));
1675f1580f4eSBarry Smith 
1676f1580f4eSBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)P, MATIS, &ismatis));
1677f1580f4eSBarry Smith   if (!data->is && !ismatis) {
1678db4a47b3SPierre Jolivet     PetscErrorCode (*create)(DM, IS *, Mat *, PetscErrorCode (**)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *), void **) = nullptr;
1679db4a47b3SPierre Jolivet     PetscErrorCode (*usetup)(Mat, PetscReal, Vec, Vec, PetscReal, IS, void *)                                                = nullptr;
1680db4a47b3SPierre Jolivet     void *uctx                                                                                                               = nullptr;
1681f1580f4eSBarry Smith 
1682f1580f4eSBarry Smith     /* first see if we can get the data from the DM */
1683f1580f4eSBarry Smith     PetscCall(MatGetDM(P, &dm));
1684f1580f4eSBarry Smith     if (!dm) PetscCall(MatGetDM(A, &dm));
1685f1580f4eSBarry Smith     if (!dm) PetscCall(PCGetDM(pc, &dm));
1686907a3e9cSStefano Zampini     if (dm) { /* this is the hook for DMPLEX for which the auxiliary Mat is the local Neumann matrix */
1687f1580f4eSBarry Smith       PetscCall(PetscObjectQueryFunction((PetscObject)dm, "DMCreateNeumannOverlap_C", &create));
1688f1580f4eSBarry Smith       if (create) {
1689f1580f4eSBarry Smith         PetscCall((*create)(dm, &uis, &uaux, &usetup, &uctx));
1690c8ea6600SPierre 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 */
1691f1580f4eSBarry Smith       }
1692f1580f4eSBarry Smith     }
1693f1580f4eSBarry Smith     if (!create) {
1694f1580f4eSBarry Smith       if (!uis) {
1695f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1696f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1697f1580f4eSBarry Smith       }
1698f1580f4eSBarry Smith       if (!uaux) {
1699f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1700f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1701f1580f4eSBarry Smith       }
1702f1580f4eSBarry Smith       /* look inside the Pmat instead of the PC, needed for MatSchurComplementComputeExplicitOperator() */
1703f1580f4eSBarry Smith       if (!uis) {
1704f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_IS", (PetscObject *)&uis));
1705f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uis));
1706f1580f4eSBarry Smith       }
1707f1580f4eSBarry Smith       if (!uaux) {
1708f1580f4eSBarry Smith         PetscCall(PetscObjectQuery((PetscObject)P, "_PCHPDDM_Neumann_Mat", (PetscObject *)&uaux));
1709f1580f4eSBarry Smith         PetscCall(PetscObjectReference((PetscObject)uaux));
1710f1580f4eSBarry Smith       }
1711f1580f4eSBarry Smith     }
1712f1580f4eSBarry Smith     PetscCall(PCHPDDMSetAuxiliaryMat(pc, uis, uaux, usetup, uctx));
1713f1580f4eSBarry Smith     PetscCall(MatDestroy(&uaux));
1714f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
1715f1580f4eSBarry Smith   }
1716f1580f4eSBarry Smith 
1717f1580f4eSBarry Smith   if (!ismatis) {
1718f1580f4eSBarry Smith     PetscCall(PCHPDDMSetUpNeumannOverlap_Private(pc));
1719db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_block_splitting", &block, nullptr));
17209bb5c669SPierre Jolivet     PetscCall(PetscOptionsGetInt(nullptr, pcpre, "-pc_hpddm_harmonic_overlap", &overlap, nullptr));
17215e642048SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
17225e642048SPierre Jolivet     if (data->is || (data->N > 1 && flg)) {
17239bb5c669SPierre Jolivet       if (block || overlap != -1) {
172402800ff6SPierre Jolivet         PetscCall(ISDestroy(&data->is));
172502800ff6SPierre Jolivet         PetscCall(MatDestroy(&data->aux));
17265e642048SPierre Jolivet       } else if (data->N > 1 && flg) {
172713044ca3SPierre Jolivet         PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_GENEO;
172813044ca3SPierre Jolivet 
172913044ca3SPierre Jolivet         PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
173013044ca3SPierre Jolivet         if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
173113044ca3SPierre Jolivet           PetscCall(ISDestroy(&data->is)); /* destroy any previously user-set objects since they will be set automatically */
173213044ca3SPierre Jolivet           PetscCall(MatDestroy(&data->aux));
173313044ca3SPierre Jolivet         } else if (type == PC_HPDDM_SCHUR_PRE_GENEO) {
173413044ca3SPierre Jolivet           PetscContainer container = nullptr;
173513044ca3SPierre Jolivet 
173613044ca3SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)pc, "_PCHPDDM_Schur", (PetscObject *)&container));
173713044ca3SPierre Jolivet           if (!container) { /* first call to PCSetUp() on the PC associated to the Schur complement */
173813044ca3SPierre Jolivet             PC_HPDDM *data_00;
173913044ca3SPierre Jolivet             KSP       ksp, inner_ksp;
174013044ca3SPierre Jolivet             PC        pc_00;
1741cf67ef9dSPierre Jolivet             Mat       A11 = nullptr;
1742cf67ef9dSPierre Jolivet             Vec       d   = nullptr;
174313044ca3SPierre Jolivet             char     *prefix;
174413044ca3SPierre Jolivet 
174513044ca3SPierre Jolivet             PetscCall(MatSchurComplementGetKSP(P, &ksp));
174613044ca3SPierre Jolivet             PetscCall(KSPGetPC(ksp, &pc_00));
174713044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)pc_00, PCHPDDM, &flg));
1748fd310a01SPierre 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 : "",
174913044ca3SPierre Jolivet                        ((PetscObject)pc_00)->type_name, PCHPDDM);
175013044ca3SPierre Jolivet             data_00 = (PC_HPDDM *)pc_00->data;
1751fd310a01SPierre 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],
1752fd310a01SPierre Jolivet                        data_00->N, data_00->N > 1 ? "s" : "", ((PetscObject)pc_00)->prefix);
175313044ca3SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)data_00->levels[0]->pc, PCASM, &flg));
1754fd310a01SPierre 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,
175513044ca3SPierre Jolivet                        ((PetscObject)data_00->levels[0]->pc)->type_name, PCASM);
1756d16c0b94SPierre Jolivet             PetscCall(MatSchurComplementGetSubMatrices(P, nullptr, nullptr, nullptr, nullptr, &A11));
17575e642048SPierre Jolivet             if (PetscDefined(USE_DEBUG) || !data->is) {
17585e642048SPierre Jolivet               Mat A01, A10, B = nullptr, C = nullptr, *sub;
175913044ca3SPierre Jolivet 
17605e642048SPierre Jolivet               PetscCall(MatSchurComplementGetSubMatrices(P, &A, nullptr, &A01, &A10, nullptr));
17615e642048SPierre Jolivet               PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
17625e642048SPierre Jolivet               if (flg) {
17635e642048SPierre Jolivet                 PetscCall(MatTransposeGetMat(A10, &C));
17645e642048SPierre Jolivet                 PetscCall(MatTranspose(C, MAT_INITIAL_MATRIX, &B));
17655e642048SPierre Jolivet               } else {
17665e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
17675e642048SPierre Jolivet                 if (flg) {
17685e642048SPierre Jolivet                   PetscCall(MatHermitianTransposeGetMat(A10, &C));
17695e642048SPierre Jolivet                   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &B));
17705e642048SPierre Jolivet                 }
17715e642048SPierre Jolivet               }
1772811e8887SPierre Jolivet               if (flg)
1773811e8887SPierre 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));
17745e642048SPierre Jolivet               if (!B) {
17755e642048SPierre Jolivet                 B = A10;
17765e642048SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)B));
17775e642048SPierre Jolivet               } else if (!data->is) {
17785e642048SPierre Jolivet                 PetscCall(PetscObjectTypeCompareAny((PetscObject)A01, &flg, MATTRANSPOSEVIRTUAL, MATHERMITIANTRANSPOSEVIRTUAL, ""));
17795e642048SPierre Jolivet                 if (!flg) C = A01;
1780811e8887SPierre Jolivet                 else
1781811e8887SPierre 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));
17825e642048SPierre Jolivet               }
178313044ca3SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, B->rmap->N, 0, 1, &uis));
17845e642048SPierre Jolivet               PetscCall(ISSetIdentity(uis));
17855e642048SPierre Jolivet               if (!data->is) {
17865e642048SPierre Jolivet                 if (C) PetscCall(PetscObjectReference((PetscObject)C));
17875e642048SPierre Jolivet                 else PetscCall(MatTranspose(B, MAT_INITIAL_MATRIX, &C));
17885e642048SPierre Jolivet                 PetscCall(ISDuplicate(data_00->is, is));
17895e642048SPierre Jolivet                 PetscCall(MatIncreaseOverlap(A, 1, is, 1));
17905e642048SPierre Jolivet                 PetscCall(MatSetOption(C, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
17915e642048SPierre Jolivet                 PetscCall(MatCreateSubMatrices(C, 1, is, &uis, MAT_INITIAL_MATRIX, &sub));
17925e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
17935e642048SPierre Jolivet                 PetscCall(MatTranspose(sub[0], MAT_INITIAL_MATRIX, &C));
17945e642048SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
17955e642048SPierre Jolivet                 PetscCall(MatFindNonzeroRows(C, &data->is));
17965e642048SPierre Jolivet                 PetscCall(MatDestroy(&C));
17975e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
1798d16c0b94SPierre Jolivet                 PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), A11->rmap->n, A11->rmap->rstart, 1, &loc));
1799d16c0b94SPierre Jolivet                 if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_FALSE));
1800d16c0b94SPierre Jolivet                 PetscCall(ISExpand(data->is, loc, is));
1801d16c0b94SPierre Jolivet                 PetscCall(ISDestroy(&loc));
1802d16c0b94SPierre Jolivet                 PetscCall(ISDestroy(&data->is));
1803d16c0b94SPierre Jolivet                 data->is = is[0];
1804d16c0b94SPierre Jolivet                 is[0]    = nullptr;
18055e642048SPierre Jolivet               }
18065e642048SPierre Jolivet               if (PetscDefined(USE_DEBUG)) {
18075e642048SPierre Jolivet                 PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10));
180813044ca3SPierre 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 */
180913044ca3SPierre Jolivet                 PetscCall(ISDestroy(&uis));
181013044ca3SPierre Jolivet                 PetscCall(ISDuplicate(data->is, &uis));
181113044ca3SPierre Jolivet                 PetscCall(ISSort(uis));
18125e642048SPierre Jolivet                 PetscCall(ISComplement(uis, 0, B->rmap->N, is));
181313044ca3SPierre Jolivet                 PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &C));
18145e642048SPierre Jolivet                 PetscCall(MatZeroRowsIS(C, is[0], 0.0, nullptr, nullptr));
18155e642048SPierre Jolivet                 PetscCall(ISDestroy(is));
181613044ca3SPierre Jolivet                 PetscCall(MatMultEqual(sub[0], C, 20, &flg));
181713044ca3SPierre 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 */
181813044ca3SPierre Jolivet                 PetscCall(MatDestroy(&C));
181913044ca3SPierre Jolivet                 PetscCall(MatDestroySubMatrices(1, &sub));
182013044ca3SPierre Jolivet               }
18215e642048SPierre Jolivet               PetscCall(ISDestroy(&uis));
18225e642048SPierre Jolivet               PetscCall(MatDestroy(&B));
18235e642048SPierre Jolivet             }
1824cf67ef9dSPierre Jolivet             flg = PETSC_FALSE;
1825cf67ef9dSPierre Jolivet             if (!data->aux) {
1826cf67ef9dSPierre Jolivet               Mat D;
1827cf67ef9dSPierre Jolivet 
1828cf67ef9dSPierre Jolivet               PetscCall(MatCreateVecs(A11, &d, nullptr));
1829cf67ef9dSPierre Jolivet               PetscCall(MatGetDiagonal(A11, d));
1830cf67ef9dSPierre Jolivet               PetscCall(PetscObjectTypeCompareAny((PetscObject)A11, &flg, MATDIAGONAL, MATCONSTANTDIAGONAL, ""));
1831cf67ef9dSPierre Jolivet               if (!flg) {
1832cf67ef9dSPierre Jolivet                 PetscCall(MatCreateDiagonal(d, &D));
1833cf67ef9dSPierre Jolivet                 PetscCall(MatMultEqual(A11, D, 20, &flg));
1834cf67ef9dSPierre Jolivet                 PetscCall(MatDestroy(&D));
1835cf67ef9dSPierre Jolivet               }
1836cf67ef9dSPierre 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"));
1837cf67ef9dSPierre Jolivet             }
1838cf67ef9dSPierre Jolivet             if (data->Neumann != PETSC_BOOL3_TRUE && !flg && A11) {
1839cf67ef9dSPierre Jolivet               PetscReal norm;
1840cf67ef9dSPierre Jolivet 
1841cf67ef9dSPierre Jolivet               PetscCall(MatNorm(A11, NORM_INFINITY, &norm));
1842cf67ef9dSPierre 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 : "");
1843cf67ef9dSPierre 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"));
1844cf67ef9dSPierre Jolivet               PetscCall(MatDestroy(&data->aux));
1845cf67ef9dSPierre Jolivet               flg = PETSC_TRUE;
1846cf67ef9dSPierre Jolivet             }
1847cf67ef9dSPierre 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 */
184801e3c840SPierre Jolivet               PetscSF            scatter;
184913044ca3SPierre Jolivet               const PetscScalar *read;
1850cf67ef9dSPierre Jolivet               PetscScalar       *write, *diagonal = nullptr;
185113044ca3SPierre Jolivet 
185213044ca3SPierre Jolivet               PetscCall(MatDestroy(&data->aux));
185313044ca3SPierre Jolivet               PetscCall(ISGetLocalSize(data->is, &n));
1854cf67ef9dSPierre Jolivet               PetscCall(VecCreateMPI(PetscObjectComm((PetscObject)P), n, PETSC_DECIDE, &xin));
1855cf67ef9dSPierre Jolivet               PetscCall(VecDuplicate(xin, &v));
1856cf67ef9dSPierre Jolivet               PetscCall(VecScatterCreate(xin, data->is, v, nullptr, &scatter));
185713044ca3SPierre Jolivet               PetscCall(VecSet(v, 1.0));
1858cf67ef9dSPierre Jolivet               PetscCall(VecSet(xin, 1.0));
1859cf67ef9dSPierre Jolivet               PetscCall(VecScatterBegin(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE));
1860cf67ef9dSPierre Jolivet               PetscCall(VecScatterEnd(scatter, v, xin, ADD_VALUES, SCATTER_REVERSE)); /* v has the multiplicity of all unknowns on the overlap */
1861cf67ef9dSPierre Jolivet               PetscCall(PetscSFDestroy(&scatter));
1862cf67ef9dSPierre Jolivet               if (d) {
1863cf67ef9dSPierre Jolivet                 PetscCall(VecScatterCreate(d, data->is, v, nullptr, &scatter));
1864cf67ef9dSPierre Jolivet                 PetscCall(VecScatterBegin(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1865cf67ef9dSPierre Jolivet                 PetscCall(VecScatterEnd(scatter, d, v, INSERT_VALUES, SCATTER_FORWARD));
1866cf67ef9dSPierre Jolivet                 PetscCall(PetscSFDestroy(&scatter));
1867cf67ef9dSPierre Jolivet                 PetscCall(VecDestroy(&d));
1868cf67ef9dSPierre Jolivet                 PetscCall(PetscMalloc1(n, &diagonal));
1869cf67ef9dSPierre Jolivet                 PetscCall(VecGetArrayRead(v, &read));
1870cf67ef9dSPierre Jolivet                 PetscCallCXX(std::copy_n(read, n, diagonal));
1871cf67ef9dSPierre Jolivet                 PetscCall(VecRestoreArrayRead(v, &read));
1872cf67ef9dSPierre Jolivet               }
187313044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
187413044ca3SPierre Jolivet               PetscCall(VecCreateSeq(PETSC_COMM_SELF, n, &v));
1875cf67ef9dSPierre Jolivet               PetscCall(VecGetArrayRead(xin, &read));
187613044ca3SPierre Jolivet               PetscCall(VecGetArrayWrite(v, &write));
1877cf67ef9dSPierre 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];
1878cf67ef9dSPierre Jolivet               PetscCall(PetscFree(diagonal));
1879cf67ef9dSPierre Jolivet               PetscCall(VecRestoreArrayRead(xin, &read));
188013044ca3SPierre Jolivet               PetscCall(VecRestoreArrayWrite(v, &write));
1881cf67ef9dSPierre Jolivet               PetscCall(VecDestroy(&xin));
1882c3e1b152SPierre Jolivet               PetscCall(MatCreateDiagonal(v, &data->aux));
188313044ca3SPierre Jolivet               PetscCall(VecDestroy(&v));
188413044ca3SPierre Jolivet             }
188513044ca3SPierre Jolivet             uis  = data->is;
188613044ca3SPierre Jolivet             uaux = data->aux;
188713044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uis));
188813044ca3SPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)uaux));
188913044ca3SPierre Jolivet             PetscCall(PetscStrallocpy(pcpre, &prefix));
189013044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(pc, nullptr));
189113044ca3SPierre Jolivet             PetscCall(PCSetType(pc, PCKSP));                                    /* replace the PC associated to the Schur complement by PCKSP */
189213044ca3SPierre Jolivet             PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &inner_ksp)); /* new KSP that will be attached to the previously set PC */
189373329a61SPierre Jolivet             pc->ops->setup = PCSetUp_KSP;
189413044ca3SPierre Jolivet             PetscCall(PetscObjectGetTabLevel((PetscObject)pc, &n));
189513044ca3SPierre Jolivet             PetscCall(PetscObjectSetTabLevel((PetscObject)inner_ksp, n + 2));
189613044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, pc->mat, pc->pmat));
189713044ca3SPierre Jolivet             PetscCall(KSPSetOptionsPrefix(inner_ksp, std::string(std::string(prefix) + "pc_hpddm_").c_str()));
189813044ca3SPierre Jolivet             PetscCall(KSPSetSkipPCSetFromOptions(inner_ksp, PETSC_TRUE));
189913044ca3SPierre Jolivet             PetscCall(KSPSetFromOptions(inner_ksp));
190013044ca3SPierre Jolivet             PetscCall(KSPGetPC(inner_ksp, &inner));
190113044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(inner, nullptr));
190213044ca3SPierre Jolivet             PetscCall(PCSetType(inner, PCNONE)); /* no preconditioner since the action of M^-1 A or A M^-1 will be computed by the Amat */
190313044ca3SPierre Jolivet             PetscCall(PCKSPSetKSP(pc, inner_ksp));
190413044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));    /* context to pass data around for the inner-most PC, which will be a proper PCHPDDM */
190513044ca3SPierre Jolivet             std::get<0>(*ctx)[0] = pc_00; /* for coarse correction on the primal (e.g., velocity) space */
190613044ca3SPierre Jolivet             PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &std::get<0>(*ctx)[1]));
190713044ca3SPierre Jolivet             PetscCall(PCSetOptionsPrefix(std::get<0>(*ctx)[1], prefix));
190813044ca3SPierre Jolivet             PetscCall(PetscFree(prefix));
190913044ca3SPierre Jolivet             PetscCall(PCSetOperators(std::get<0>(*ctx)[1], pc->mat, pc->pmat));
191013044ca3SPierre Jolivet             PetscCall(PCSetType(std::get<0>(*ctx)[1], PCHPDDM));
191113044ca3SPierre 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 */
1912cf67ef9dSPierre Jolivet             if (flg) static_cast<PC_HPDDM *>(std::get<0>(*ctx)[1]->data)->Neumann = PETSC_BOOL3_TRUE;
191313044ca3SPierre Jolivet             PetscCall(PCSetFromOptions(std::get<0>(*ctx)[1]));
191413044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uis));
191513044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)uaux));
191613044ca3SPierre 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 */
191713044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_MULT, (void (*)(void))MatMult_SchurCorrection));
191813044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_VIEW, (void (*)(void))MatView_SchurCorrection));
191913044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(S, MATOP_DESTROY, (void (*)(void))MatDestroy_SchurCorrection));
192013044ca3SPierre Jolivet             PetscCall(KSPGetPCSide(inner_ksp, &(std::get<2>(*ctx))));
192113044ca3SPierre Jolivet             if (std::get<2>(*ctx) == PC_LEFT || std::get<2>(*ctx) == PC_SIDE_DEFAULT) {
192213044ca3SPierre Jolivet               PetscCall(KSPSetPreSolve(inner_ksp, KSPPreSolve_SchurCorrection, ctx));
192313044ca3SPierre Jolivet             } else { /* no support for PC_SYMMETRIC */
192413044ca3SPierre 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]);
192513044ca3SPierre Jolivet             }
192613044ca3SPierre Jolivet             PetscCall(KSPSetPostSolve(inner_ksp, KSPPostSolve_SchurCorrection, ctx));
1927715c1178SPierre Jolivet             PetscCall(PetscObjectContainerCompose((PetscObject)std::get<0>(*ctx)[1], "_PCHPDDM_Schur", ctx, nullptr));
192813044ca3SPierre Jolivet             PetscCall(PCSetUp(std::get<0>(*ctx)[1]));
192913044ca3SPierre Jolivet             PetscCall(KSPSetOperators(inner_ksp, S, S));
193013044ca3SPierre Jolivet             PetscCall(MatCreateVecs(std::get<1>(*ctx)[0], std::get<3>(*ctx), std::get<3>(*ctx) + 1));
193113044ca3SPierre Jolivet             PetscCall(VecDuplicate(std::get<3>(*ctx)[0], std::get<3>(*ctx) + 2));
193213044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)inner_ksp));
193313044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)S));
19340307214fSPierre Jolivet             for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
193513044ca3SPierre Jolivet             PetscFunctionReturn(PETSC_SUCCESS);
193613044ca3SPierre Jolivet           } else { /* second call to PCSetUp() on the PC associated to the Schur complement, retrieve previously set context */
193713044ca3SPierre Jolivet             PetscCall(PetscContainerGetPointer(container, (void **)&ctx));
193813044ca3SPierre Jolivet           }
193913044ca3SPierre Jolivet         }
194013044ca3SPierre Jolivet       }
194113044ca3SPierre Jolivet     }
1942f1580f4eSBarry Smith     if (!data->is && data->N > 1) {
1943f1580f4eSBarry Smith       char type[256] = {}; /* same size as in src/ksp/pc/interface/pcset.c */
1944811e8887SPierre Jolivet 
1945f1580f4eSBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)P, &flg, MATNORMAL, MATNORMALHERMITIAN, ""));
1946f1580f4eSBarry Smith       if (flg || (A->rmap->N != A->cmap->N && P->rmap->N == P->cmap->N && P->rmap->N == A->cmap->N)) {
1947f1580f4eSBarry Smith         Mat B;
1948811e8887SPierre Jolivet 
1949f1580f4eSBarry Smith         PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, A, P, &B, pcpre));
1950f1580f4eSBarry Smith         if (data->correction == PC_HPDDM_COARSE_CORRECTION_DEFLATED) data->correction = PC_HPDDM_COARSE_CORRECTION_BALANCED;
1951f1580f4eSBarry Smith         PetscCall(MatDestroy(&B));
1952f1580f4eSBarry Smith       } else {
1953f1580f4eSBarry Smith         PetscCall(PetscObjectTypeCompare((PetscObject)P, MATSCHURCOMPLEMENT, &flg));
1954f1580f4eSBarry Smith         if (flg) {
1955f1580f4eSBarry Smith           Mat                 A00, P00, A01, A10, A11, B, N;
195613044ca3SPierre Jolivet           PCHPDDMSchurPreType type = PC_HPDDM_SCHUR_PRE_LEAST_SQUARES;
195713044ca3SPierre Jolivet 
195813044ca3SPierre Jolivet           PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, &A01, &A10, &A11));
195913044ca3SPierre Jolivet           PetscCall(PetscOptionsGetEnum(nullptr, pcpre, "-pc_hpddm_schur_precondition", PCHPDDMSchurPreTypes, (PetscEnum *)&type, &flg));
196013044ca3SPierre Jolivet           if (type == PC_HPDDM_SCHUR_PRE_LEAST_SQUARES) {
1961281f8ce6SPierre Jolivet             Mat                        B01;
19623df4cd7bSPierre Jolivet             Vec                        diagonal = nullptr;
1963f1580f4eSBarry Smith             const PetscScalar         *array;
1964f1580f4eSBarry Smith             MatSchurComplementAinvType type;
1965f1580f4eSBarry Smith 
1966281f8ce6SPierre Jolivet             PetscCall(PCHPDDMCheckSymmetry_Private(pc, A01, A10, &B01));
1967f1580f4eSBarry Smith             if (A11) {
19683df4cd7bSPierre Jolivet               PetscCall(MatCreateVecs(A11, &diagonal, nullptr));
19693df4cd7bSPierre Jolivet               PetscCall(MatGetDiagonal(A11, diagonal));
1970f1580f4eSBarry Smith             }
1971db4a47b3SPierre Jolivet             PetscCall(MatCreateVecs(P00, &v, nullptr));
1972f1580f4eSBarry Smith             PetscCall(MatSchurComplementGetAinvType(P, &type));
1973f1580f4eSBarry 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]);
1974f1580f4eSBarry Smith             if (type == MAT_SCHUR_COMPLEMENT_AINV_LUMP) {
1975f1580f4eSBarry Smith               PetscCall(MatGetRowSum(P00, v));
1976f1580f4eSBarry Smith               if (A00 == P00) PetscCall(PetscObjectReference((PetscObject)A00));
1977f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1978f1580f4eSBarry Smith               PetscCall(VecGetArrayRead(v, &array));
1979db4a47b3SPierre Jolivet               PetscCall(MatCreateAIJ(PetscObjectComm((PetscObject)A00), A00->rmap->n, A00->cmap->n, A00->rmap->N, A00->cmap->N, 1, nullptr, 0, nullptr, &P00));
1980f1580f4eSBarry Smith               PetscCall(MatSetOption(P00, MAT_NO_OFF_PROC_ENTRIES, PETSC_TRUE));
1981f1580f4eSBarry Smith               for (n = A00->rmap->rstart; n < A00->rmap->rend; ++n) PetscCall(MatSetValue(P00, n, n, array[n - A00->rmap->rstart], INSERT_VALUES));
1982f1580f4eSBarry Smith               PetscCall(MatAssemblyBegin(P00, MAT_FINAL_ASSEMBLY));
1983f1580f4eSBarry Smith               PetscCall(MatAssemblyEnd(P00, MAT_FINAL_ASSEMBLY));
1984f1580f4eSBarry Smith               PetscCall(VecRestoreArrayRead(v, &array));
1985f1580f4eSBarry Smith               PetscCall(MatSchurComplementUpdateSubMatrices(P, A00, P00, A01, A10, A11)); /* replace P00 by diag(sum of each row of P00) */
1986f1580f4eSBarry Smith               PetscCall(MatDestroy(&P00));
1987f1580f4eSBarry Smith             } else PetscCall(MatGetDiagonal(P00, v));
1988f1580f4eSBarry Smith             PetscCall(VecReciprocal(v)); /* inv(diag(P00))       */
1989f1580f4eSBarry Smith             PetscCall(VecSqrtAbs(v));    /* sqrt(inv(diag(P00))) */
1990f1580f4eSBarry Smith             PetscCall(MatDuplicate(A01, MAT_COPY_VALUES, &B));
1991db4a47b3SPierre Jolivet             PetscCall(MatDiagonalScale(B, v, nullptr));
1992281f8ce6SPierre Jolivet             if (B01) PetscCall(MatDiagonalScale(B01, v, nullptr));
1993f1580f4eSBarry Smith             PetscCall(VecDestroy(&v));
1994f1580f4eSBarry Smith             PetscCall(MatCreateNormalHermitian(B, &N));
1995281f8ce6SPierre Jolivet             PetscCall(PCHPDDMSetAuxiliaryMatNormal_Private(pc, B, N, &P, pcpre, &diagonal, B01));
1996f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)data->aux, MATSEQAIJ, &flg));
1997f1580f4eSBarry Smith             if (!flg) {
1998f1580f4eSBarry Smith               PetscCall(MatDestroy(&P));
1999f1580f4eSBarry Smith               P = N;
2000f1580f4eSBarry Smith               PetscCall(PetscObjectReference((PetscObject)P));
2001feebddf4SPierre Jolivet             }
20023df4cd7bSPierre Jolivet             if (diagonal) {
20033df4cd7bSPierre Jolivet               PetscCall(MatDiagonalSet(P, diagonal, ADD_VALUES));
2004feebddf4SPierre Jolivet               PetscCall(PCSetOperators(pc, P, P)); /* replace P by A01^T inv(diag(P00)) A01 - diag(P11) */
20053df4cd7bSPierre Jolivet               PetscCall(VecDestroy(&diagonal));
2006281f8ce6SPierre Jolivet             } else PetscCall(PCSetOperators(pc, B01 ? P : N, P));  /* replace P by A01^T inv(diag(P00)) A01                         */
2007feebddf4SPierre Jolivet             pc->ops->postsolve = PCPostSolve_SchurPreLeastSquares; /*  PCFIELDSPLIT expect a KSP for (P11 - A10 inv(diag(P00)) A01) */
2008feebddf4SPierre Jolivet             PetscCall(MatDestroy(&N));                             /*  but a PC for (A10 inv(diag(P00)) A10 - P11) is setup instead */
2009feebddf4SPierre Jolivet             PetscCall(MatDestroy(&P));                             /*  so the sign of the solution must be flipped                  */
2010f1580f4eSBarry Smith             PetscCall(MatDestroy(&B));
201113044ca3SPierre Jolivet           } else
2012fd310a01SPierre 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 : "");
20130307214fSPierre Jolivet           for (std::vector<Vec>::iterator it = initial.begin(); it != initial.end(); ++it) PetscCall(VecDestroy(&*it));
20143ba16761SJacob Faibussowitsch           PetscFunctionReturn(PETSC_SUCCESS);
2015f1580f4eSBarry Smith         } else {
2016db4a47b3SPierre Jolivet           PetscCall(PetscOptionsGetString(nullptr, pcpre, "-pc_hpddm_levels_1_st_pc_type", type, sizeof(type), nullptr));
2017f1580f4eSBarry Smith           PetscCall(PetscStrcmp(type, PCMAT, &algebraic));
2018b07dfdedSPierre Jolivet           PetscCheck(!algebraic || !block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_block_splitting");
20199bb5c669SPierre Jolivet           if (overlap != -1) {
20209bb5c669SPierre 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");
20219bb5c669SPierre Jolivet             PetscCheck(overlap >= 1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_WRONG, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " < 1", overlap);
20229bb5c669SPierre Jolivet           }
20239bb5c669SPierre Jolivet           if (block || overlap != -1) algebraic = PETSC_TRUE;
2024f1580f4eSBarry Smith           if (algebraic) {
2025f1580f4eSBarry Smith             PetscCall(ISCreateStride(PETSC_COMM_SELF, P->rmap->n, P->rmap->rstart, 1, &data->is));
2026f1580f4eSBarry Smith             PetscCall(MatIncreaseOverlap(P, 1, &data->is, 1));
2027f1580f4eSBarry Smith             PetscCall(ISSort(data->is));
20289bb5c669SPierre Jolivet           } else
20299bb5c669SPierre 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 : ""));
2030f1580f4eSBarry Smith         }
2031f1580f4eSBarry Smith       }
2032f1580f4eSBarry Smith     }
2033f1580f4eSBarry Smith   }
2034398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2035398c7888SPierre Jolivet   if (data->is) PetscCall(ISDuplicate(data->is, &dis));
2036398c7888SPierre Jolivet   if (data->aux) PetscCall(MatDuplicate(data->aux, MAT_COPY_VALUES, &daux));
2037398c7888SPierre Jolivet #endif
2038f1580f4eSBarry Smith   if (data->is || (ismatis && data->N > 1)) {
2039f1580f4eSBarry Smith     if (ismatis) {
2040f1580f4eSBarry Smith       std::initializer_list<std::string> list = {MATSEQBAIJ, MATSEQSBAIJ};
2041f1580f4eSBarry Smith       PetscCall(MatISGetLocalMat(P, &N));
2042f1580f4eSBarry Smith       std::initializer_list<std::string>::const_iterator it = std::find(list.begin(), list.end(), ((PetscObject)N)->type_name);
2043f1580f4eSBarry Smith       PetscCall(MatISRestoreLocalMat(P, &N));
2044f1580f4eSBarry Smith       switch (std::distance(list.begin(), it)) {
2045d71ae5a4SJacob Faibussowitsch       case 0:
2046d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
2047d71ae5a4SJacob Faibussowitsch         break;
2048f1580f4eSBarry Smith       case 1:
2049f1580f4eSBarry Smith         /* MatCreateSubMatrices() does not work with MATSBAIJ and unsorted ISes, so convert to MPIBAIJ */
2050f1580f4eSBarry Smith         PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &C));
2051f1580f4eSBarry Smith         PetscCall(MatSetOption(C, MAT_SYMMETRIC, PETSC_TRUE));
2052f1580f4eSBarry Smith         break;
2053d71ae5a4SJacob Faibussowitsch       default:
2054d71ae5a4SJacob Faibussowitsch         PetscCall(MatConvert(P, MATMPIAIJ, MAT_INITIAL_MATRIX, &C));
2055f1580f4eSBarry Smith       }
2056db4a47b3SPierre Jolivet       PetscCall(MatISGetLocalToGlobalMapping(P, &l2g, nullptr));
2057f1580f4eSBarry Smith       PetscCall(PetscObjectReference((PetscObject)P));
2058f1580f4eSBarry Smith       PetscCall(KSPSetOperators(data->levels[0]->ksp, A, C));
2059f1580f4eSBarry Smith       std::swap(C, P);
2060f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingGetSize(l2g, &n));
2061f1580f4eSBarry Smith       PetscCall(ISCreateStride(PETSC_COMM_SELF, n, 0, 1, &loc));
2062f1580f4eSBarry Smith       PetscCall(ISLocalToGlobalMappingApplyIS(l2g, loc, &is[0]));
2063f1580f4eSBarry Smith       PetscCall(ISDestroy(&loc));
2064f1580f4eSBarry Smith       /* the auxiliary Mat is _not_ the local Neumann matrix                                */
2065f1580f4eSBarry Smith       /* it is the local Neumann matrix augmented (with zeros) through MatIncreaseOverlap() */
2066c8ea6600SPierre Jolivet       data->Neumann = PETSC_BOOL3_FALSE;
2067f1580f4eSBarry Smith       structure     = SAME_NONZERO_PATTERN;
2068f1580f4eSBarry Smith     } else {
2069f1580f4eSBarry Smith       is[0] = data->is;
207013044ca3SPierre Jolivet       if (algebraic || ctx) subdomains = PETSC_TRUE;
2071db4a47b3SPierre Jolivet       PetscCall(PetscOptionsGetBool(nullptr, pcpre, "-pc_hpddm_define_subdomains", &subdomains, nullptr));
207213044ca3SPierre 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);
2073c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann)) {
2074b07dfdedSPierre Jolivet         PetscCheck(!block, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_block_splitting and -pc_hpddm_has_neumann");
20759bb5c669SPierre Jolivet         PetscCheck(overlap == -1, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_harmonic_overlap %" PetscInt_FMT " and -pc_hpddm_has_neumann", overlap);
2076b07dfdedSPierre Jolivet         PetscCheck(!algebraic, PetscObjectComm((PetscObject)P), PETSC_ERR_ARG_INCOMP, "-pc_hpddm_levels_1_st_pc_type mat and -pc_hpddm_has_neumann");
2077f1580f4eSBarry Smith       }
2078c8ea6600SPierre Jolivet       if (PetscBool3ToBool(data->Neumann) || block) structure = SAME_NONZERO_PATTERN;
2079f1580f4eSBarry Smith       PetscCall(ISCreateStride(PetscObjectComm((PetscObject)data->is), P->rmap->n, P->rmap->rstart, 1, &loc));
2080f1580f4eSBarry Smith     }
2081f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2082db4a47b3SPierre Jolivet     PetscCall(PetscOptionsGetEnum(nullptr, prefix, "-st_matstructure", MatStructures, (PetscEnum *)&structure, &flg)); /* if not user-provided, force its value when possible */
2083f1580f4eSBarry Smith     if (!flg && structure == SAME_NONZERO_PATTERN) {                                                                   /* cannot call STSetMatStructure() yet, insert the appropriate option in the database, parsed by STSetFromOptions() */
2084f1580f4eSBarry Smith       PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "-%spc_hpddm_levels_1_st_matstructure", pcpre ? pcpre : ""));
2085db4a47b3SPierre Jolivet       PetscCall(PetscOptionsSetValue(nullptr, prefix, MatStructures[structure]));
2086f1580f4eSBarry Smith     }
2087398c7888SPierre Jolivet     flg = PETSC_FALSE;
2088b07dfdedSPierre Jolivet     if (data->share) {
2089398c7888SPierre Jolivet       data->share = PETSC_FALSE; /* will be reset to PETSC_TRUE if none of the conditions below are true */
2090398c7888SPierre 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 : ""));
2091398c7888SPierre Jolivet       else if (data->deflation) PetscCall(PetscInfo(pc, "Nothing to share since PCHPDDMSetDeflationMat() has been called\n"));
2092398c7888SPierre Jolivet       else if (ismatis) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc with a Pmat of type MATIS\n"));
2093b07dfdedSPierre Jolivet       else if (!algebraic && structure != SAME_NONZERO_PATTERN)
2094398c7888SPierre 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]));
2095398c7888SPierre Jolivet       else data->share = PETSC_TRUE;
2096398c7888SPierre Jolivet     }
2097398c7888SPierre Jolivet     if (!ismatis) {
2098398c7888SPierre Jolivet       if (data->share || (!PetscBool3ToBool(data->Neumann) && subdomains)) PetscCall(ISDuplicate(is[0], &unsorted));
2099398c7888SPierre Jolivet       else unsorted = is[0];
2100398c7888SPierre Jolivet     }
2101f1580f4eSBarry Smith     if (data->N > 1 && (data->aux || ismatis || algebraic)) {
2102f1580f4eSBarry Smith       PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "HPDDM library not loaded, cannot use more than one level");
2103f1580f4eSBarry Smith       PetscCall(MatSetOption(P, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
2104f1580f4eSBarry Smith       if (ismatis) {
2105f1580f4eSBarry Smith         /* needed by HPDDM (currently) so that the partition of unity is 0 on subdomain interfaces */
2106f1580f4eSBarry Smith         PetscCall(MatIncreaseOverlap(P, 1, is, 1));
2107f1580f4eSBarry Smith         PetscCall(ISDestroy(&data->is));
2108f1580f4eSBarry Smith         data->is = is[0];
2109f1580f4eSBarry Smith       } else {
2110d16c0b94SPierre Jolivet         if (PetscDefined(USE_DEBUG)) PetscCall(PCHPDDMCheckInclusion_Private(pc, data->is, loc, PETSC_TRUE));
21119bb5c669SPierre Jolivet         if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", PCHPDDMAlgebraicAuxiliaryMat_Private));
21129bb5c669SPierre Jolivet         if (!PetscBool3ToBool(data->Neumann) && (!algebraic || overlap != -1)) {
2113f1580f4eSBarry Smith           PetscCall(PetscObjectTypeCompare((PetscObject)P, MATMPISBAIJ, &flg));
2114f1580f4eSBarry Smith           if (flg) {
2115f1580f4eSBarry Smith             /* maybe better to ISSort(is[0]), MatCreateSubMatrices(), and then MatPermute() */
2116f1580f4eSBarry Smith             /* but there is no MatPermute_SeqSBAIJ(), so as before, just use MATMPIBAIJ     */
2117f1580f4eSBarry Smith             PetscCall(MatConvert(P, MATMPIBAIJ, MAT_INITIAL_MATRIX, &uaux));
2118f1580f4eSBarry Smith             flg = PETSC_FALSE;
2119f1580f4eSBarry Smith           }
2120f1580f4eSBarry Smith         }
2121f1580f4eSBarry Smith       }
21229bb5c669SPierre Jolivet       if (algebraic && overlap == -1) {
2123f1580f4eSBarry Smith         PetscUseMethod(pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", (Mat, IS *, Mat *[], PetscBool), (P, is, &sub, block));
2124f1580f4eSBarry Smith         if (block) {
2125f1580f4eSBarry Smith           PetscCall(PetscObjectQuery((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", (PetscObject *)&data->aux));
2126db4a47b3SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)sub[0], "_PCHPDDM_Neumann_Mat", nullptr));
2127f1580f4eSBarry Smith         }
21289bb5c669SPierre Jolivet       } else if (!uaux || overlap != -1) {
212913044ca3SPierre Jolivet         if (!ctx) {
2130c8ea6600SPierre Jolivet           if (PetscBool3ToBool(data->Neumann)) sub = &data->aux;
21319bb5c669SPierre Jolivet           else {
2132df21ef68SPierre Jolivet             PetscBool flg;
21339bb5c669SPierre Jolivet             if (overlap != -1) {
21349bb5c669SPierre Jolivet               Harmonic              h;
21359bb5c669SPierre Jolivet               Mat                   A0, *a;                    /* with an SVD: [ A_00  A_01       ] */
21369bb5c669SPierre Jolivet               IS                    ov[2], rows, cols, stride; /*              [ A_10  A_11  A_12 ] */
2137*58b7e2c1SStefano Zampini               const PetscInt       *i[2], bs = P->cmap->bs;    /* with a GEVP: [ A_00  A_01       ] */
21389bb5c669SPierre Jolivet               PetscInt              n[2];                      /*              [ A_10  A_11  A_12 ] */
21399bb5c669SPierre Jolivet               std::vector<PetscInt> v[2];                      /*              [       A_21  A_22 ] */
21409bb5c669SPierre Jolivet 
21419bb5c669SPierre Jolivet               PetscCall(ISDuplicate(data->is, ov));
21429bb5c669SPierre Jolivet               if (overlap > 1) PetscCall(MatIncreaseOverlap(P, 1, ov, overlap - 1));
21439bb5c669SPierre Jolivet               PetscCall(ISDuplicate(ov[0], ov + 1));
21449bb5c669SPierre Jolivet               PetscCall(MatIncreaseOverlap(P, 1, ov + 1, 1));
21459bb5c669SPierre Jolivet               PetscCall(PetscNew(&h));
21469bb5c669SPierre Jolivet               h->ksp = nullptr;
21479bb5c669SPierre Jolivet               PetscCall(PetscCalloc1(2, &h->A));
21483a60673dSPierre Jolivet               PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_nsv", &flg));
21499bb5c669SPierre Jolivet               if (!flg) PetscCall(PetscOptionsHasName(nullptr, prefix, "-svd_relative_threshold", &flg));
21509bb5c669SPierre Jolivet               PetscCall(ISSort(ov[0]));
21519bb5c669SPierre Jolivet               if (!flg) PetscCall(ISSort(ov[1]));
215232603206SJames Wright               PetscCall(PetscCalloc1(5, &h->is));
21539bb5c669SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, ov + !flg, ov + 1, MAT_INITIAL_MATRIX, &a)); /* submatrix from above, either square (!flg) or rectangular (flg) */
21549bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) {
21559bb5c669SPierre Jolivet                 PetscCall(ISGetIndices(ov[j], i + j));
21569bb5c669SPierre Jolivet                 PetscCall(ISGetLocalSize(ov[j], n + j));
21579bb5c669SPierre Jolivet               }
21589bb5c669SPierre Jolivet               v[1].reserve((n[1] - n[0]) / bs);
21599bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[1]; j += bs) { /* indices of the (2,2) block */
21609bb5c669SPierre Jolivet                 PetscInt location;
21619bb5c669SPierre Jolivet                 PetscCall(ISLocate(ov[0], i[1][j], &location));
21629bb5c669SPierre Jolivet                 if (location < 0) v[1].emplace_back(j / bs);
21639bb5c669SPierre Jolivet               }
21649bb5c669SPierre Jolivet               if (!flg) {
21659bb5c669SPierre Jolivet                 h->A[1] = a[0];
21669bb5c669SPierre Jolivet                 PetscCall(PetscObjectReference((PetscObject)h->A[1]));
21679bb5c669SPierre Jolivet                 v[0].reserve((n[0] - P->rmap->n) / bs);
21689bb5c669SPierre Jolivet                 for (PetscInt j = 0; j < n[1]; j += bs) { /* row indices of the (1,2) block */
21699bb5c669SPierre Jolivet                   PetscInt location;
21709bb5c669SPierre Jolivet                   PetscCall(ISLocate(loc, i[1][j], &location));
21719bb5c669SPierre Jolivet                   if (location < 0) {
21729bb5c669SPierre Jolivet                     PetscCall(ISLocate(ov[0], i[1][j], &location));
21739bb5c669SPierre Jolivet                     if (location >= 0) v[0].emplace_back(j / bs);
21749bb5c669SPierre Jolivet                   }
21759bb5c669SPierre Jolivet                 }
21769bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
21779bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_COPY_VALUES, h->is + 4));
21789bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, h->is[4], MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
21799bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
21809bb5c669SPierre 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 */
21819bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &rows));
21829bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols = rows, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
21839bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&rows));
21849bb5c669SPierre Jolivet                 v[0].clear();
21859bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, ov[1], PETSC_TRUE, h->is + 3));
21869bb5c669SPierre Jolivet                 PetscCall(ISEmbed(data->is, ov[1], PETSC_TRUE, h->is + 2));
21879bb5c669SPierre Jolivet               }
21889bb5c669SPierre Jolivet               v[0].reserve((n[0] - P->rmap->n) / bs);
21899bb5c669SPierre Jolivet               for (PetscInt j = 0; j < n[0]; j += bs) {
21909bb5c669SPierre Jolivet                 PetscInt location;
21919bb5c669SPierre Jolivet                 PetscCall(ISLocate(loc, i[0][j], &location));
21929bb5c669SPierre Jolivet                 if (location < 0) v[0].emplace_back(j / bs);
21939bb5c669SPierre Jolivet               }
21949bb5c669SPierre Jolivet               PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[0].size(), v[0].data(), PETSC_USE_POINTER, &rows));
21959bb5c669SPierre Jolivet               for (PetscInt j = 0; j < 2; ++j) PetscCall(ISRestoreIndices(ov[j], i + j));
21969bb5c669SPierre Jolivet               if (flg) {
21979bb5c669SPierre Jolivet                 IS is;
21989bb5c669SPierre Jolivet                 PetscCall(ISCreateStride(PETSC_COMM_SELF, a[0]->rmap->n, 0, 1, &is));
21999bb5c669SPierre Jolivet                 PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &cols));
22009bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], is, cols, MAT_INITIAL_MATRIX, &A0)); /* [ A_00  A_01 ; A_10  A_11 ] submatrix from above */
22019bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
22029bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&is));
22039bb5c669SPierre 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 */
22049bb5c669SPierre Jolivet                 PetscCall(ISEmbed(loc, data->is, PETSC_TRUE, h->is + 2));
22059bb5c669SPierre Jolivet                 PetscCall(ISCreateBlock(PETSC_COMM_SELF, bs, v[1].size(), v[1].data(), PETSC_USE_POINTER, &cols));
22069bb5c669SPierre Jolivet                 PetscCall(MatCreateSubMatrix(a[0], rows, cols, MAT_INITIAL_MATRIX, h->A)); /* A_12 submatrix from above */
22079bb5c669SPierre Jolivet                 PetscCall(ISDestroy(&cols));
22089bb5c669SPierre Jolivet               }
22099bb5c669SPierre Jolivet               PetscCall(ISCreateStride(PETSC_COMM_SELF, A0->rmap->n, 0, 1, &stride));
22109bb5c669SPierre Jolivet               PetscCall(ISEmbed(rows, stride, PETSC_TRUE, h->is));
22119bb5c669SPierre Jolivet               PetscCall(ISDestroy(&stride));
22129bb5c669SPierre Jolivet               PetscCall(ISDestroy(&rows));
22139bb5c669SPierre Jolivet               PetscCall(ISEmbed(loc, ov[0], PETSC_TRUE, h->is + 1));
22149bb5c669SPierre Jolivet               if (subdomains) {
22159bb5c669SPierre Jolivet                 if (!data->levels[0]->pc) {
22169bb5c669SPierre Jolivet                   PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
22179bb5c669SPierre Jolivet                   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
22189bb5c669SPierre Jolivet                   PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
22199bb5c669SPierre Jolivet                   PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
22209bb5c669SPierre Jolivet                 }
22219bb5c669SPierre Jolivet                 PetscCall(PCSetType(data->levels[0]->pc, PCASM));
22229bb5c669SPierre Jolivet                 if (!data->levels[0]->pc->setupcalled) PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, ov + !flg, &loc));
22239bb5c669SPierre Jolivet                 PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, flg ? A0 : a[0], PETSC_TRUE));
22249bb5c669SPierre Jolivet                 if (!flg) ++overlap;
22259bb5c669SPierre Jolivet                 if (data->share) {
22269bb5c669SPierre Jolivet                   PetscInt n = -1;
22279bb5c669SPierre Jolivet                   PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
22289bb5c669SPierre Jolivet                   PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
22299bb5c669SPierre Jolivet                   if (flg) {
22309bb5c669SPierre Jolivet                     h->ksp = ksp[0];
22319bb5c669SPierre Jolivet                     PetscCall(PetscObjectReference((PetscObject)h->ksp));
22329bb5c669SPierre Jolivet                   }
22339bb5c669SPierre Jolivet                 }
22349bb5c669SPierre Jolivet               }
22359bb5c669SPierre Jolivet               if (!h->ksp) {
22369bb5c669SPierre Jolivet                 PetscBool share = data->share;
22379bb5c669SPierre Jolivet                 PetscCall(KSPCreate(PETSC_COMM_SELF, &h->ksp));
22389bb5c669SPierre Jolivet                 PetscCall(KSPSetType(h->ksp, KSPPREONLY));
22399bb5c669SPierre Jolivet                 PetscCall(KSPSetOperators(h->ksp, A0, A0));
22409bb5c669SPierre Jolivet                 do {
22419bb5c669SPierre Jolivet                   if (!data->share) {
22429bb5c669SPierre Jolivet                     share = PETSC_FALSE;
22439bb5c669SPierre Jolivet                     PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_%s", pcpre ? pcpre : "", flg ? "svd_" : "eps_"));
22449bb5c669SPierre Jolivet                     PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
22459bb5c669SPierre Jolivet                     PetscCall(KSPSetFromOptions(h->ksp));
22469bb5c669SPierre Jolivet                   } else {
22479bb5c669SPierre Jolivet                     MatSolverType type;
22489bb5c669SPierre Jolivet                     PetscCall(KSPGetPC(ksp[0], &pc));
22499bb5c669SPierre Jolivet                     PetscCall(PetscObjectTypeCompareAny((PetscObject)pc, &data->share, PCLU, PCCHOLESKY, ""));
22509bb5c669SPierre Jolivet                     if (data->share) {
22519bb5c669SPierre Jolivet                       PetscCall(PCFactorGetMatSolverType(pc, &type));
22529bb5c669SPierre Jolivet                       if (!type) {
22539bb5c669SPierre Jolivet                         if (PetscDefined(HAVE_MUMPS)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMUMPS));
22549bb5c669SPierre Jolivet                         else if (PetscDefined(HAVE_MKL_PARDISO)) PetscCall(PCFactorSetMatSolverType(pc, MATSOLVERMKL_PARDISO));
22559bb5c669SPierre Jolivet                         else data->share = PETSC_FALSE;
22569bb5c669SPierre Jolivet                         if (data->share) PetscCall(PCSetFromOptions(pc));
22579bb5c669SPierre Jolivet                       } else {
22589bb5c669SPierre Jolivet                         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &data->share));
22599bb5c669SPierre Jolivet                         if (!data->share) PetscCall(PetscStrcmp(type, MATSOLVERMKL_PARDISO, &data->share));
22609bb5c669SPierre Jolivet                       }
22619bb5c669SPierre Jolivet                       if (data->share) {
22629bb5c669SPierre Jolivet                         std::tuple<KSP, IS, Vec[2]> *p;
22639bb5c669SPierre Jolivet                         PetscCall(PCFactorGetMatrix(pc, &A));
22649bb5c669SPierre Jolivet                         PetscCall(MatFactorSetSchurIS(A, h->is[4]));
22659bb5c669SPierre Jolivet                         PetscCall(KSPSetUp(ksp[0]));
22669bb5c669SPierre Jolivet                         PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_eps_shell_", pcpre ? pcpre : ""));
22679bb5c669SPierre Jolivet                         PetscCall(KSPSetOptionsPrefix(h->ksp, prefix));
22689bb5c669SPierre Jolivet                         PetscCall(KSPSetFromOptions(h->ksp));
22699bb5c669SPierre Jolivet                         PetscCall(KSPGetPC(h->ksp, &pc));
22709bb5c669SPierre Jolivet                         PetscCall(PCSetType(pc, PCSHELL));
22719bb5c669SPierre Jolivet                         PetscCall(PetscNew(&p));
22729bb5c669SPierre Jolivet                         std::get<0>(*p) = ksp[0];
22739bb5c669SPierre Jolivet                         PetscCall(ISEmbed(ov[0], ov[1], PETSC_TRUE, &std::get<1>(*p)));
22749bb5c669SPierre Jolivet                         PetscCall(MatCreateVecs(A, std::get<2>(*p), std::get<2>(*p) + 1));
22759bb5c669SPierre Jolivet                         PetscCall(PCShellSetContext(pc, p));
22769bb5c669SPierre Jolivet                         PetscCall(PCShellSetApply(pc, PCApply_Schur));
22779bb5c669SPierre Jolivet                         PetscCall(PCShellSetApplyTranspose(pc, PCApply_Schur<Vec, true>));
22789bb5c669SPierre Jolivet                         PetscCall(PCShellSetMatApply(pc, PCApply_Schur<Mat>));
22799bb5c669SPierre Jolivet                         PetscCall(PCShellSetDestroy(pc, PCDestroy_Schur));
22809bb5c669SPierre Jolivet                       }
22819bb5c669SPierre Jolivet                     }
22829bb5c669SPierre Jolivet                     if (!data->share) PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since neither MUMPS nor MKL PARDISO is used\n"));
22839bb5c669SPierre Jolivet                   }
22849bb5c669SPierre 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 */
22859bb5c669SPierre Jolivet               }
22869bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov));
22879bb5c669SPierre Jolivet               PetscCall(ISDestroy(ov + 1));
22889bb5c669SPierre Jolivet               if (overlap == 1 && subdomains && flg) {
22899bb5c669SPierre Jolivet                 *subA = A0;
22909bb5c669SPierre Jolivet                 sub   = subA;
22919bb5c669SPierre Jolivet                 if (uaux) PetscCall(MatDestroy(&uaux));
22929bb5c669SPierre Jolivet               } else PetscCall(MatDestroy(&A0));
22939bb5c669SPierre Jolivet               PetscCall(MatCreateShell(PETSC_COMM_SELF, P->rmap->n, n[1] - n[0], P->rmap->n, n[1] - n[0], h, &data->aux));
2294bdcd51b8SPierre Jolivet               PetscCall(KSPSetErrorIfNotConverged(h->ksp, PETSC_TRUE)); /* bail out as early as possible to avoid (apparently) unrelated error messages */
22959bb5c669SPierre Jolivet               PetscCall(MatCreateVecs(h->ksp->pc->pmat, &h->v, nullptr));
22969bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT, (void (*)(void))MatMult_Harmonic));
22979bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMultTranspose_Harmonic));
22989bb5c669SPierre Jolivet               PetscCall(MatShellSetMatProductOperation(data->aux, MATPRODUCT_AB, nullptr, MatProduct_AB_Harmonic, nullptr, MATDENSE, MATDENSE));
22999bb5c669SPierre Jolivet               PetscCall(MatShellSetOperation(data->aux, MATOP_DESTROY, (void (*)(void))MatDestroy_Harmonic));
23009bb5c669SPierre Jolivet               PetscCall(MatDestroySubMatrices(1, &a));
23019bb5c669SPierre Jolivet             }
2302df21ef68SPierre Jolivet             if (overlap != 1 || !subdomains) {
2303df21ef68SPierre Jolivet               PetscCall(MatCreateSubMatrices(uaux ? uaux : P, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2304df21ef68SPierre Jolivet               if (ismatis) {
2305df21ef68SPierre Jolivet                 PetscCall(MatISGetLocalMat(C, &N));
2306df21ef68SPierre Jolivet                 PetscCall(PetscObjectTypeCompare((PetscObject)N, MATSEQSBAIJ, &flg));
2307df21ef68SPierre Jolivet                 if (flg) PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2308df21ef68SPierre Jolivet                 PetscCall(MatISRestoreLocalMat(C, &N));
2309df21ef68SPierre Jolivet               }
2310df21ef68SPierre Jolivet             }
23119bb5c669SPierre Jolivet             if (uaux) {
23129bb5c669SPierre Jolivet               PetscCall(MatDestroy(&uaux));
23139bb5c669SPierre Jolivet               PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
23149bb5c669SPierre Jolivet             }
23159bb5c669SPierre Jolivet           }
231613044ca3SPierre Jolivet         }
2317f1580f4eSBarry Smith       } else {
2318f1580f4eSBarry Smith         PetscCall(MatCreateSubMatrices(uaux, 1, is, is, MAT_INITIAL_MATRIX, &sub));
2319f1580f4eSBarry Smith         PetscCall(MatDestroy(&uaux));
2320f1580f4eSBarry Smith         PetscCall(MatConvert(sub[0], MATSEQSBAIJ, MAT_INPLACE_MATRIX, sub));
2321f1580f4eSBarry Smith       }
2322f1580f4eSBarry Smith       /* Vec holding the partition of unity */
2323f1580f4eSBarry Smith       if (!data->levels[0]->D) {
2324f1580f4eSBarry Smith         PetscCall(ISGetLocalSize(data->is, &n));
2325f1580f4eSBarry Smith         PetscCall(VecCreateMPI(PETSC_COMM_SELF, n, PETSC_DETERMINE, &data->levels[0]->D));
2326f1580f4eSBarry Smith       }
23279bb5c669SPierre Jolivet       if (data->share && overlap == -1) {
2328f1580f4eSBarry Smith         Mat      D;
2329db4a47b3SPierre Jolivet         IS       perm = nullptr;
2330f1580f4eSBarry Smith         PetscInt size = -1;
2331811e8887SPierre Jolivet 
2332398c7888SPierre Jolivet         if (!data->levels[0]->pc) {
2333398c7888SPierre Jolivet           PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%spc_hpddm_levels_1_", pcpre ? pcpre : ""));
2334398c7888SPierre Jolivet           PetscCall(PCCreate(PetscObjectComm((PetscObject)pc), &data->levels[0]->pc));
2335398c7888SPierre Jolivet           PetscCall(PCSetOptionsPrefix(data->levels[0]->pc, prefix));
2336398c7888SPierre Jolivet           PetscCall(PCSetOperators(data->levels[0]->pc, A, P));
2337398c7888SPierre Jolivet         }
2338398c7888SPierre Jolivet         PetscCall(PCSetType(data->levels[0]->pc, PCASM));
233913044ca3SPierre Jolivet         if (!ctx) {
2340398c7888SPierre Jolivet           if (!data->levels[0]->pc->setupcalled) {
2341398c7888SPierre Jolivet             IS sorted; /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2342398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2343398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &sorted, &loc));
2344398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2345398c7888SPierre Jolivet           }
2346398c7888SPierre Jolivet           PetscCall(PCSetFromOptions(data->levels[0]->pc));
2347398c7888SPierre Jolivet           if (block) {
2348398c7888SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, sub[0], &C, &perm));
2349398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, C, algebraic));
2350398c7888SPierre Jolivet           } else PetscCall(PCSetUp(data->levels[0]->pc));
2351db4a47b3SPierre Jolivet           PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &size, nullptr, &ksp));
2352398c7888SPierre Jolivet           if (size != 1) {
2353398c7888SPierre Jolivet             data->share = PETSC_FALSE;
2354398c7888SPierre Jolivet             PetscCheck(size == -1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", size);
2355398c7888SPierre Jolivet             PetscCall(PetscInfo(pc, "Cannot share subdomain KSP between SLEPc and PETSc since PCASMGetSubKSP() not found in fine-level PC\n"));
2356398c7888SPierre Jolivet             PetscCall(ISDestroy(&unsorted));
2357398c7888SPierre Jolivet             unsorted = is[0];
2358398c7888SPierre Jolivet           } else {
2359811e8887SPierre Jolivet             const char *matpre;
2360811e8887SPierre Jolivet             PetscBool   cmp[4];
2361811e8887SPierre Jolivet 
236213044ca3SPierre Jolivet             if (!block && !ctx) PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, PetscBool3ToBool(data->Neumann) ? sub[0] : data->aux, &C, &perm));
2363c8ea6600SPierre Jolivet             if (!PetscBool3ToBool(data->Neumann) && !block) {
2364f1580f4eSBarry Smith               PetscCall(MatPermute(sub[0], perm, perm, &D)); /* permute since PCASM will call ISSort() */
2365f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(sub[0], &D));
2366f1580f4eSBarry Smith             }
2367f1580f4eSBarry Smith             if (data->B) { /* see PCHPDDMSetRHSMat() */
2368f1580f4eSBarry Smith               PetscCall(MatPermute(data->B, perm, perm, &D));
2369f1580f4eSBarry Smith               PetscCall(MatHeaderReplace(data->B, &D));
2370f1580f4eSBarry Smith             }
2371f1580f4eSBarry Smith             PetscCall(ISDestroy(&perm));
2372f1580f4eSBarry Smith             PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
23730307214fSPierre Jolivet             PetscCall(PetscObjectReference((PetscObject)subA[0]));
2374f1580f4eSBarry Smith             PetscCall(MatDuplicate(subA[1], MAT_SHARE_NONZERO_PATTERN, &D));
2375f1580f4eSBarry Smith             PetscCall(MatGetOptionsPrefix(subA[1], &matpre));
2376f1580f4eSBarry Smith             PetscCall(MatSetOptionsPrefix(D, matpre));
2377f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMAL, cmp));
2378f1580f4eSBarry Smith             PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMAL, cmp + 1));
2379f1580f4eSBarry Smith             if (!cmp[0]) PetscCall(PetscObjectTypeCompare((PetscObject)D, MATNORMALHERMITIAN, cmp + 2));
2380f1580f4eSBarry Smith             else cmp[2] = PETSC_FALSE;
2381f1580f4eSBarry Smith             if (!cmp[1]) PetscCall(PetscObjectTypeCompare((PetscObject)C, MATNORMALHERMITIAN, cmp + 3));
2382f1580f4eSBarry Smith             else cmp[3] = PETSC_FALSE;
2383f1580f4eSBarry 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);
2384f1580f4eSBarry Smith             if (!cmp[0] && !cmp[2]) {
2385f1580f4eSBarry Smith               if (!block) PetscCall(MatAXPY(D, 1.0, C, SUBSET_NONZERO_PATTERN));
23865c7345deSPierre Jolivet               else {
2387db4a47b3SPierre Jolivet                 PetscCall(MatMissingDiagonal(D, cmp, nullptr));
23885c7345deSPierre Jolivet                 if (cmp[0]) structure = DIFFERENT_NONZERO_PATTERN; /* data->aux has no missing diagonal entry */
23895c7345deSPierre Jolivet                 PetscCall(MatAXPY(D, 1.0, data->aux, structure));
23905c7345deSPierre Jolivet               }
2391f1580f4eSBarry Smith             } else {
2392f1580f4eSBarry Smith               Mat mat[2];
2393811e8887SPierre Jolivet 
2394f1580f4eSBarry Smith               if (cmp[0]) {
2395f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(D, mat));
2396f1580f4eSBarry Smith                 PetscCall(MatNormalGetMat(C, mat + 1));
2397f1580f4eSBarry Smith               } else {
2398f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(D, mat));
2399f1580f4eSBarry Smith                 PetscCall(MatNormalHermitianGetMat(C, mat + 1));
2400f1580f4eSBarry Smith               }
2401f1580f4eSBarry Smith               PetscCall(MatAXPY(mat[0], 1.0, mat[1], SUBSET_NONZERO_PATTERN));
2402f1580f4eSBarry Smith             }
2403f1580f4eSBarry Smith             PetscCall(MatPropagateSymmetryOptions(C, D));
2404f1580f4eSBarry Smith             PetscCall(MatDestroy(&C));
2405f1580f4eSBarry Smith             C = D;
2406f1580f4eSBarry Smith             /* swap pointers so that variables stay consistent throughout PCSetUp() */
2407f1580f4eSBarry Smith             std::swap(C, data->aux);
2408f1580f4eSBarry Smith             std::swap(uis, data->is);
2409f1580f4eSBarry Smith             swap = PETSC_TRUE;
2410f1580f4eSBarry Smith           }
2411f1580f4eSBarry Smith         }
241213044ca3SPierre Jolivet       }
241313044ca3SPierre Jolivet       if (ctx) {
241413044ca3SPierre Jolivet         PC_HPDDM              *data_00 = (PC_HPDDM *)std::get<0>(*ctx)[0]->data;
241513044ca3SPierre Jolivet         PC                     s;
241600b491fbSPierre Jolivet         Mat                    A00, P00, A01 = nullptr, A10, A11, N, b[4];
241707d8d47fSPierre Jolivet         IS                     sorted, is[2], *is_00;
241813044ca3SPierre Jolivet         MatSolverType          type;
241913044ca3SPierre Jolivet         std::pair<PC, Vec[2]> *p;
242013044ca3SPierre Jolivet 
242107d8d47fSPierre Jolivet         n = -1;
242207d8d47fSPierre Jolivet         PetscTryMethod(data_00->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data_00->levels[0]->pc, &n, nullptr, &ksp));
242307d8d47fSPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
242407d8d47fSPierre Jolivet         PetscCall(KSPGetOperators(ksp[0], subA, subA + 1));
242507d8d47fSPierre Jolivet         PetscCall(ISGetLocalSize(data_00->is, &n));
242607d8d47fSPierre Jolivet         if (n != subA[0]->rmap->n || n != subA[0]->cmap->n) {
242707d8d47fSPierre Jolivet           PetscCall(PCASMGetLocalSubdomains(data_00->levels[0]->pc, &n, &is_00, nullptr));
242807d8d47fSPierre Jolivet           PetscCall(ISGetLocalSize(*is_00, &n));
242907d8d47fSPierre 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);
243007d8d47fSPierre Jolivet         } else is_00 = &data_00->is;
243113044ca3SPierre Jolivet         PetscCall(PCHPDDMPermute_Private(unsorted, data->is, &uis, data->aux, &C, nullptr)); /* permute since PCASM works with a sorted IS */
243213044ca3SPierre Jolivet         std::swap(C, data->aux);
243313044ca3SPierre Jolivet         std::swap(uis, data->is);
243413044ca3SPierre Jolivet         swap = PETSC_TRUE;
243513044ca3SPierre Jolivet         PetscCall(PCASMSetType(data->levels[0]->pc, PC_ASM_NONE)); /* "Neumann--Neumann" preconditioning with overlap and a Boolean partition of unity */
243613044ca3SPierre Jolivet         PetscCall(PCASMSetLocalSubdomains(data->levels[0]->pc, 1, &data->is, &loc));
243713044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(data->levels[0]->pc)); /* action of eq. (15) of https://hal.science/hal-02343808v6/document (with a sign flip) */
243813044ca3SPierre Jolivet         PetscCall(MatSchurComplementGetSubMatrices(P, &A00, &P00, std::get<1>(*ctx), &A10, &A11));
243913044ca3SPierre Jolivet         std::get<1>(*ctx)[1] = A10;
244013044ca3SPierre Jolivet         PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATTRANSPOSEVIRTUAL, &flg));
244113044ca3SPierre Jolivet         if (flg) PetscCall(MatTransposeGetMat(A10, &A01));
244213044ca3SPierre Jolivet         else {
244313044ca3SPierre Jolivet           PetscBool flg;
244413044ca3SPierre Jolivet 
244513044ca3SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)A10, MATHERMITIANTRANSPOSEVIRTUAL, &flg));
244613044ca3SPierre Jolivet           if (flg) PetscCall(MatHermitianTransposeGetMat(A10, &A01));
244713044ca3SPierre Jolivet         }
244807d8d47fSPierre 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 */
244913044ca3SPierre Jolivet         PetscCall(ISSort(sorted));               /* this is to avoid changing users inputs, but it requires a new call to ISSort() here                                                                                               */
245000b491fbSPierre Jolivet         if (!A01) {
245100b491fbSPierre Jolivet           PetscCall(MatSetOption(A10, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
245200b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A10, 1, &data->is, &sorted, MAT_INITIAL_MATRIX, &sub));
245300b491fbSPierre Jolivet           b[2] = sub[0];
245400b491fbSPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
245500b491fbSPierre Jolivet           PetscCall(MatDestroySubMatrices(1, &sub));
245600b491fbSPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATTRANSPOSEVIRTUAL, &flg));
245700b491fbSPierre Jolivet           A10 = nullptr;
245800b491fbSPierre Jolivet           if (flg) PetscCall(MatTransposeGetMat(std::get<1>(*ctx)[0], &A10));
245913044ca3SPierre Jolivet           else {
246000b491fbSPierre Jolivet             PetscBool flg;
246100b491fbSPierre Jolivet 
2462c71f06a7SPierre Jolivet             PetscCall(PetscObjectTypeCompare((PetscObject)std::get<1>(*ctx)[0], MATHERMITIANTRANSPOSEVIRTUAL, &flg));
246300b491fbSPierre Jolivet             if (flg) PetscCall(MatHermitianTransposeGetMat(std::get<1>(*ctx)[0], &A10));
246413044ca3SPierre Jolivet           }
2465811e8887SPierre Jolivet           if (!A10) PetscCall(MatCreateSubMatrices(std::get<1>(*ctx)[0], 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2466811e8887SPierre Jolivet           else {
2467811e8887SPierre Jolivet             if (flg) PetscCall(MatCreateTranspose(b[2], b + 1));
2468811e8887SPierre Jolivet             else PetscCall(MatCreateHermitianTranspose(b[2], b + 1));
246900b491fbSPierre Jolivet           }
247000b491fbSPierre Jolivet         } else {
247100b491fbSPierre Jolivet           PetscCall(MatSetOption(A01, MAT_SUBMAT_SINGLEIS, PETSC_TRUE));
247200b491fbSPierre Jolivet           PetscCall(MatCreateSubMatrices(A01, 1, &sorted, &data->is, MAT_INITIAL_MATRIX, &sub));
2473811e8887SPierre Jolivet           if (flg) PetscCall(MatCreateTranspose(*sub, b + 2));
2474811e8887SPierre Jolivet           else PetscCall(MatCreateHermitianTranspose(*sub, b + 2));
2475811e8887SPierre Jolivet         }
2476811e8887SPierre Jolivet         if (A01 || !A10) {
2477811e8887SPierre Jolivet           b[1] = sub[0];
2478811e8887SPierre Jolivet           PetscCall(PetscObjectReference((PetscObject)sub[0]));
247900b491fbSPierre Jolivet         }
248000b491fbSPierre Jolivet         PetscCall(MatDestroySubMatrices(1, &sub));
248113044ca3SPierre Jolivet         PetscCall(ISDestroy(&sorted));
248200b491fbSPierre Jolivet         PetscCall(MatCreateSchurComplement(subA[0], subA[1], b[1], b[2], data->aux, &S));
248313044ca3SPierre Jolivet         PetscCall(MatSchurComplementSetKSP(S, ksp[0]));
248413044ca3SPierre Jolivet         PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(data->levels[0]->pc, S, PETSC_TRUE)); /* the subdomain Mat is already known and the input IS of PCASMSetLocalSubdomains() is already sorted */
248513044ca3SPierre Jolivet         PetscTryMethod(data->levels[0]->pc, "PCASMGetSubKSP_C", (PC, PetscInt *, PetscInt *, KSP **), (data->levels[0]->pc, &n, nullptr, &ksp));
248613044ca3SPierre Jolivet         PetscCheck(n == 1, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Number of subdomain solver %" PetscInt_FMT " != 1", n);
248713044ca3SPierre Jolivet         PetscCall(KSPGetPC(ksp[0], &inner));
248813044ca3SPierre Jolivet         PetscCall(PCSetType(inner, PCSHELL)); /* compute the action of the inverse of the local Schur complement with a PCSHELL */
248913044ca3SPierre Jolivet         b[0] = subA[0];
249013044ca3SPierre Jolivet         b[3] = data->aux;
249113044ca3SPierre 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 */
249200b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[1]));
249300b491fbSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)b[2]));
249413044ca3SPierre Jolivet         PetscCall(PCCreate(PETSC_COMM_SELF, &s));
249513044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(s, ((PetscObject)inner)->prefix));
249613044ca3SPierre Jolivet         PetscCall(PCSetOptionsPrefix(inner, nullptr));
249713044ca3SPierre Jolivet         PetscCall(KSPSetSkipPCSetFromOptions(ksp[0], PETSC_TRUE));
249813044ca3SPierre Jolivet         PetscCall(PCSetType(s, PCLU));
249913044ca3SPierre Jolivet         if (PetscDefined(HAVE_MUMPS)) { /* only MATSOLVERMUMPS handles MATNEST, so for the others, e.g., MATSOLVERPETSC or MATSOLVERMKL_PARDISO, convert to plain MATAIJ */
250013044ca3SPierre Jolivet           PetscCall(PCFactorSetMatSolverType(s, MATSOLVERMUMPS));
250113044ca3SPierre Jolivet         }
250213044ca3SPierre Jolivet         PetscCall(PCSetFromOptions(s));
250313044ca3SPierre Jolivet         PetscCall(PCFactorGetMatSolverType(s, &type));
250413044ca3SPierre Jolivet         PetscCall(PetscStrcmp(type, MATSOLVERMUMPS, &flg));
250513044ca3SPierre Jolivet         if (flg) {
250613044ca3SPierre Jolivet           PetscCall(PCSetOperators(s, N, N));
250700b491fbSPierre Jolivet           PetscCall(PCFactorGetMatrix(s, b));
250800b491fbSPierre Jolivet           PetscCall(MatSetOptionsPrefix(*b, ((PetscObject)s)->prefix));
250924ddd604SPierre Jolivet           n = -1;
251024ddd604SPierre Jolivet           PetscCall(PetscOptionsGetInt(nullptr, ((PetscObject)s)->prefix, "-mat_mumps_icntl_26", &n, nullptr));
2511f45b553cSPierre Jolivet           if (n == 1) {                                /* allocates a square MatDense of size is[1]->map->n, so one */
2512f45b553cSPierre Jolivet             PetscCall(MatNestGetISs(N, is, nullptr));  /*  needs to be able to deactivate this path when dealing    */
2513f45b553cSPierre Jolivet             PetscCall(MatFactorSetSchurIS(*b, is[1])); /*  with a large constraint space in order to avoid OOM      */
2514f45b553cSPierre Jolivet           }
251513044ca3SPierre Jolivet         } else {
251600b491fbSPierre Jolivet           PetscCall(MatConvert(N, MATAIJ, MAT_INITIAL_MATRIX, b));
251700b491fbSPierre Jolivet           PetscCall(PCSetOperators(s, N, *b));
251800b491fbSPierre Jolivet           PetscCall(PetscObjectDereference((PetscObject)*b));
251900b491fbSPierre Jolivet           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 */
252013044ca3SPierre Jolivet         }
252113044ca3SPierre Jolivet         PetscCall(PetscNew(&p));
252213044ca3SPierre Jolivet         p->first = s;
252300b491fbSPierre Jolivet         PetscCall(MatCreateVecs(*b, p->second, p->second + 1));
252413044ca3SPierre Jolivet         PetscCall(PCShellSetContext(inner, p));
252513044ca3SPierre Jolivet         PetscCall(PCShellSetApply(inner, PCApply_Nest));
252613044ca3SPierre Jolivet         PetscCall(PCShellSetView(inner, PCView_Nest));
252713044ca3SPierre Jolivet         PetscCall(PCShellSetDestroy(inner, PCDestroy_Nest));
252813044ca3SPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)N));
252913044ca3SPierre Jolivet       }
2530f1580f4eSBarry Smith       if (!data->levels[0]->scatter) {
2531db4a47b3SPierre Jolivet         PetscCall(MatCreateVecs(P, &xin, nullptr));
2532f1580f4eSBarry Smith         if (ismatis) PetscCall(MatDestroy(&P));
2533db4a47b3SPierre Jolivet         PetscCall(VecScatterCreate(xin, data->is, data->levels[0]->D, nullptr, &data->levels[0]->scatter));
2534f1580f4eSBarry Smith         PetscCall(VecDestroy(&xin));
2535f1580f4eSBarry Smith       }
2536f1580f4eSBarry Smith       if (data->levels[0]->P) {
2537f1580f4eSBarry Smith         /* if the pattern is the same and PCSetUp() has previously succeeded, reuse HPDDM buffers and connectivity */
2538f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[0], pc->setupcalled < 1 || pc->flag == DIFFERENT_NONZERO_PATTERN ? PETSC_TRUE : PETSC_FALSE));
2539f1580f4eSBarry Smith       }
2540f1580f4eSBarry Smith       if (!data->levels[0]->P) data->levels[0]->P = new HPDDM::Schwarz<PetscScalar>();
2541db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2542db4a47b3SPierre Jolivet       else PetscCall(PetscLogEventBegin(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2543f1580f4eSBarry Smith       /* HPDDM internal data structure */
254413044ca3SPierre Jolivet       PetscCall(data->levels[0]->P->structure(loc, data->is, !ctx ? sub[0] : nullptr, ismatis ? C : data->aux, data->levels));
2545db4a47b3SPierre Jolivet       if (!data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_Strc, data->levels[0]->ksp, nullptr, nullptr, nullptr));
2546f1580f4eSBarry Smith       /* matrix pencil of the generalized eigenvalue problem on the overlap (GenEO) */
254713044ca3SPierre Jolivet       if (!ctx) {
25489bb5c669SPierre Jolivet         if (data->deflation || overlap != -1) weighted = data->aux;
2549f1580f4eSBarry Smith         else if (!data->B) {
2550e2b46ddfSPierre Jolivet           PetscBool cmp;
2551811e8887SPierre Jolivet 
2552f1580f4eSBarry Smith           PetscCall(MatDuplicate(sub[0], MAT_COPY_VALUES, &weighted));
2553e2b46ddfSPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)weighted, &cmp, MATNORMAL, MATNORMALHERMITIAN, ""));
2554e2b46ddfSPierre Jolivet           if (cmp) flg = PETSC_FALSE;
2555e2b46ddfSPierre Jolivet           PetscCall(MatDiagonalScale(weighted, data->levels[0]->D, data->levels[0]->D));
25565b0bb9f2SPierre Jolivet           /* neither MatDuplicate() nor MatDiagonalScale() handles the symmetry options, so propagate the options explicitly */
2557f1580f4eSBarry Smith           /* only useful for -mat_type baij -pc_hpddm_levels_1_st_pc_type cholesky (no problem with MATAIJ or MATSBAIJ)      */
2558f1580f4eSBarry Smith           PetscCall(MatPropagateSymmetryOptions(sub[0], weighted));
2559f1580f4eSBarry Smith         } else weighted = data->B;
256013044ca3SPierre Jolivet       } else weighted = nullptr;
2561f1580f4eSBarry Smith       /* SLEPc is used inside the loaded symbol */
25629bb5c669SPierre 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));
25639bb5c669SPierre Jolivet       if (!ctx && data->share && overlap == -1) {
2564f1580f4eSBarry Smith         Mat st[2];
2565f1580f4eSBarry Smith         PetscCall(KSPGetOperators(ksp[0], st, st + 1));
25665c7345deSPierre Jolivet         PetscCall(MatCopy(subA[0], st[0], structure));
2567f1580f4eSBarry Smith         if (subA[1] != subA[0] || st[1] != st[0]) PetscCall(MatCopy(subA[1], st[1], SAME_NONZERO_PATTERN));
25680307214fSPierre Jolivet         PetscCall(PetscObjectDereference((PetscObject)subA[0]));
2569f1580f4eSBarry Smith       }
2570db4a47b3SPierre Jolivet       if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[0], data->levels[0]->ksp, nullptr, nullptr, nullptr));
2571f1580f4eSBarry Smith       if (ismatis) PetscCall(MatISGetLocalMat(C, &N));
2572f1580f4eSBarry Smith       else N = data->aux;
257313044ca3SPierre Jolivet       if (!ctx) P = sub[0];
257413044ca3SPierre Jolivet       else P = S;
2575f1580f4eSBarry Smith       /* going through the grid hierarchy */
2576f1580f4eSBarry Smith       for (n = 1; n < data->N; ++n) {
2577db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventBegin(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2578f1580f4eSBarry Smith         /* method composed in the loaded symbol since there, SLEPc is used as well */
2579f1580f4eSBarry 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));
2580db4a47b3SPierre Jolivet         if (data->log_separate) PetscCall(PetscLogEventEnd(PC_HPDDM_SetUp[n], data->levels[n]->ksp, nullptr, nullptr, nullptr));
2581f1580f4eSBarry Smith       }
2582f1580f4eSBarry Smith       /* reset to NULL to avoid any faulty use */
2583db4a47b3SPierre Jolivet       PetscCall(PetscObjectComposeFunction((PetscObject)data->levels[0]->ksp, "PCHPDDMSetUp_Private_C", nullptr));
2584db4a47b3SPierre Jolivet       if (!ismatis) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_C", nullptr));
2585f1580f4eSBarry Smith       else PetscCall(PetscObjectDereference((PetscObject)C)); /* matching PetscObjectReference() above */
2586f1580f4eSBarry Smith       for (n = 0; n < data->N - 1; ++n)
2587f1580f4eSBarry Smith         if (data->levels[n]->P) {
2588f1580f4eSBarry Smith           /* HPDDM internal work buffers */
2589f1580f4eSBarry Smith           data->levels[n]->P->setBuffer();
2590f1580f4eSBarry Smith           data->levels[n]->P->super::start();
2591f1580f4eSBarry Smith         }
25929bb5c669SPierre Jolivet       if (ismatis || !subdomains) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
2593db4a47b3SPierre Jolivet       if (ismatis) data->is = nullptr;
2594f1580f4eSBarry Smith       for (n = 0; n < data->N - 1 + (reused > 0); ++n) {
2595f1580f4eSBarry Smith         if (data->levels[n]->P) {
2596f1580f4eSBarry Smith           PC spc;
2597f1580f4eSBarry Smith 
2598f1580f4eSBarry Smith           /* force the PC to be PCSHELL to do the coarse grid corrections */
2599f1580f4eSBarry Smith           PetscCall(KSPSetSkipPCSetFromOptions(data->levels[n]->ksp, PETSC_TRUE));
2600f1580f4eSBarry Smith           PetscCall(KSPGetPC(data->levels[n]->ksp, &spc));
2601f1580f4eSBarry Smith           PetscCall(PCSetType(spc, PCSHELL));
2602f1580f4eSBarry Smith           PetscCall(PCShellSetContext(spc, data->levels[n]));
2603f1580f4eSBarry Smith           PetscCall(PCShellSetSetUp(spc, PCSetUp_HPDDMShell));
2604f1580f4eSBarry Smith           PetscCall(PCShellSetApply(spc, PCApply_HPDDMShell));
2605f1580f4eSBarry Smith           PetscCall(PCShellSetMatApply(spc, PCMatApply_HPDDMShell));
260613044ca3SPierre Jolivet           if (ctx && n == 0) {
260713044ca3SPierre Jolivet             Mat                               Amat, Pmat;
260813044ca3SPierre Jolivet             PetscInt                          m, M;
260901e3c840SPierre Jolivet             std::tuple<Mat, PetscSF, Vec[2]> *ctx;
261013044ca3SPierre Jolivet 
261113044ca3SPierre Jolivet             PetscCall(KSPGetOperators(data->levels[n]->ksp, nullptr, &Pmat));
261213044ca3SPierre Jolivet             PetscCall(MatGetLocalSize(Pmat, &m, nullptr));
261313044ca3SPierre Jolivet             PetscCall(MatGetSize(Pmat, &M, nullptr));
261413044ca3SPierre Jolivet             PetscCall(PetscNew(&ctx));
261513044ca3SPierre Jolivet             std::get<0>(*ctx) = S;
261613044ca3SPierre Jolivet             std::get<1>(*ctx) = data->levels[n]->scatter;
261713044ca3SPierre Jolivet             PetscCall(MatCreateShell(PetscObjectComm((PetscObject)data->levels[n]->ksp), m, m, M, M, ctx, &Amat));
261813044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT, (void (*)(void))MatMult_Schur<false>));
261913044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_MULT_TRANSPOSE, (void (*)(void))MatMult_Schur<true>));
262013044ca3SPierre Jolivet             PetscCall(MatShellSetOperation(Amat, MATOP_DESTROY, (void (*)(void))MatDestroy_Schur));
262113044ca3SPierre Jolivet             PetscCall(MatCreateVecs(S, std::get<2>(*ctx), std::get<2>(*ctx) + 1));
262213044ca3SPierre Jolivet             PetscCall(KSPSetOperators(data->levels[n]->ksp, Amat, Pmat));
262313044ca3SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)Amat));
262413044ca3SPierre Jolivet           }
2625f1580f4eSBarry Smith           PetscCall(PCShellSetDestroy(spc, PCDestroy_HPDDMShell));
2626f1580f4eSBarry Smith           if (!data->levels[n]->pc) PetscCall(PCCreate(PetscObjectComm((PetscObject)data->levels[n]->ksp), &data->levels[n]->pc));
2627f1580f4eSBarry Smith           if (n < reused) {
2628f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(spc, PETSC_TRUE));
2629f1580f4eSBarry Smith             PetscCall(PCSetReusePreconditioner(data->levels[n]->pc, PETSC_TRUE));
2630f1580f4eSBarry Smith           }
2631f1580f4eSBarry Smith           PetscCall(PCSetUp(spc));
2632f1580f4eSBarry Smith         }
2633f1580f4eSBarry Smith       }
263413044ca3SPierre Jolivet       if (ctx) PetscCall(MatDestroy(&S));
26359bb5c669SPierre Jolivet       if (overlap == -1) PetscCall(PetscObjectComposeFunction((PetscObject)pc->pmat, "PCHPDDMAlgebraicAuxiliaryMat_Private_C", nullptr));
2636f1580f4eSBarry Smith     } else flg = reused ? PETSC_FALSE : PETSC_TRUE;
2637f1580f4eSBarry Smith     if (!ismatis && subdomains) {
2638f1580f4eSBarry Smith       if (flg) PetscCall(KSPGetPC(data->levels[0]->ksp, &inner));
2639f1580f4eSBarry Smith       else inner = data->levels[0]->pc;
2640f1580f4eSBarry Smith       if (inner) {
2641398c7888SPierre Jolivet         if (!inner->setupcalled) PetscCall(PCSetType(inner, PCASM));
2642398c7888SPierre Jolivet         PetscCall(PCSetFromOptions(inner));
2643398c7888SPierre Jolivet         PetscCall(PetscStrcmp(((PetscObject)inner)->type_name, PCASM, &flg));
2644398c7888SPierre Jolivet         if (flg) {
2645f1580f4eSBarry Smith           if (!inner->setupcalled) { /* evaluates to PETSC_FALSE when -pc_hpddm_block_splitting */
2646398c7888SPierre Jolivet             IS sorted;               /* PCASM will sort the input IS, duplicate it to return an unmodified (PCHPDDM) input IS */
2647811e8887SPierre Jolivet 
2648398c7888SPierre Jolivet             PetscCall(ISDuplicate(is[0], &sorted));
2649398c7888SPierre Jolivet             PetscCall(PCASMSetLocalSubdomains(inner, 1, &sorted, &loc));
2650398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)sorted));
2651398c7888SPierre Jolivet           }
2652c8ea6600SPierre Jolivet           if (!PetscBool3ToBool(data->Neumann) && data->N > 1) { /* subdomain matrices are already created for the eigenproblem, reuse them for the fine-level PC */
2653db4a47b3SPierre Jolivet             PetscCall(PCHPDDMPermute_Private(*is, nullptr, nullptr, sub[0], &P, nullptr));
2654398c7888SPierre Jolivet             PetscCall(PCHPDDMCommunicationAvoidingPCASM_Private(inner, P, algebraic));
2655398c7888SPierre Jolivet             PetscCall(PetscObjectDereference((PetscObject)P));
2656f1580f4eSBarry Smith           }
2657f1580f4eSBarry Smith         }
2658f1580f4eSBarry Smith       }
26599bb5c669SPierre Jolivet       if (data->N > 1) {
26609bb5c669SPierre Jolivet         if (overlap != 1) PetscCall(PCHPDDMDestroySubMatrices_Private(PetscBool3ToBool(data->Neumann), PetscBool(algebraic && !block && overlap == -1), sub));
26619bb5c669SPierre Jolivet         if (overlap == 1) PetscCall(MatDestroy(subA));
26629bb5c669SPierre Jolivet       }
2663f1580f4eSBarry Smith     }
2664f1580f4eSBarry Smith     PetscCall(ISDestroy(&loc));
2665f1580f4eSBarry Smith   } else data->N = 1 + reused; /* enforce this value to 1 + reused if there is no way to build another level */
2666f1580f4eSBarry Smith   if (requested != data->N + reused) {
2667f1580f4eSBarry 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,
2668f1580f4eSBarry Smith                         data->N, pcpre ? pcpre : ""));
2669f1580f4eSBarry Smith     PetscCall(PetscInfo(pc, "It is best to tune parameters, e.g., a higher value for -%spc_hpddm_levels_%" PetscInt_FMT "_eps_threshold so that at least one local deflation vector will be selected\n", pcpre ? pcpre : "", data->N));
2670f1580f4eSBarry Smith     /* cannot use PCDestroy_HPDDMShell() because PCSHELL not set for unassembled levels */
2671f1580f4eSBarry Smith     for (n = data->N - 1; n < requested - 1; ++n) {
2672f1580f4eSBarry Smith       if (data->levels[n]->P) {
2673f1580f4eSBarry Smith         PetscCall(HPDDM::Schwarz<PetscScalar>::destroy(data->levels[n], PETSC_TRUE));
2674f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(1, &data->levels[n]->v[0]));
2675f1580f4eSBarry Smith         PetscCall(VecDestroyVecs(2, &data->levels[n]->v[1]));
2676f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V));
2677f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 1));
2678f1580f4eSBarry Smith         PetscCall(MatDestroy(data->levels[n]->V + 2));
2679f1580f4eSBarry Smith         PetscCall(VecDestroy(&data->levels[n]->D));
268001e3c840SPierre Jolivet         PetscCall(PetscSFDestroy(&data->levels[n]->scatter));
2681f1580f4eSBarry Smith       }
2682f1580f4eSBarry Smith     }
2683f1580f4eSBarry Smith     if (reused) {
2684f1580f4eSBarry Smith       for (n = reused; n < PETSC_PCHPDDM_MAXLEVELS && data->levels[n]; ++n) {
2685f1580f4eSBarry Smith         PetscCall(KSPDestroy(&data->levels[n]->ksp));
2686f1580f4eSBarry Smith         PetscCall(PCDestroy(&data->levels[n]->pc));
2687f1580f4eSBarry Smith       }
2688f1580f4eSBarry Smith     }
2689f1580f4eSBarry Smith     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 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,
2690f1580f4eSBarry Smith                data->N, reused, data->N, pcpre ? pcpre : "", pcpre ? pcpre : "", data->N);
2691f1580f4eSBarry Smith   }
2692f1580f4eSBarry Smith   /* these solvers are created after PCSetFromOptions() is called */
2693f1580f4eSBarry Smith   if (pc->setfromoptionscalled) {
2694f1580f4eSBarry Smith     for (n = 0; n < data->N; ++n) {
2695f1580f4eSBarry Smith       if (data->levels[n]->ksp) PetscCall(KSPSetFromOptions(data->levels[n]->ksp));
2696f1580f4eSBarry Smith       if (data->levels[n]->pc) PetscCall(PCSetFromOptions(data->levels[n]->pc));
2697f1580f4eSBarry Smith     }
2698f1580f4eSBarry Smith     pc->setfromoptionscalled = 0;
2699f1580f4eSBarry Smith   }
2700f1580f4eSBarry Smith   data->N += reused;
2701f1580f4eSBarry Smith   if (data->share && swap) {
2702f1580f4eSBarry Smith     /* swap back pointers so that variables follow the user-provided numbering */
2703f1580f4eSBarry Smith     std::swap(C, data->aux);
2704f1580f4eSBarry Smith     std::swap(uis, data->is);
2705f1580f4eSBarry Smith     PetscCall(MatDestroy(&C));
2706f1580f4eSBarry Smith     PetscCall(ISDestroy(&uis));
2707f1580f4eSBarry Smith   }
2708398c7888SPierre Jolivet   if (algebraic) PetscCall(MatDestroy(&data->aux));
270938fb34a1SPierre Jolivet   if (unsorted && unsorted != is[0]) {
2710398c7888SPierre Jolivet     PetscCall(ISCopy(unsorted, data->is));
2711398c7888SPierre Jolivet     PetscCall(ISDestroy(&unsorted));
2712398c7888SPierre Jolivet   }
2713398c7888SPierre Jolivet #if PetscDefined(USE_DEBUG)
2714398c7888SPierre 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);
2715398c7888SPierre Jolivet   if (data->is) {
2716398c7888SPierre Jolivet     PetscCall(ISEqualUnsorted(data->is, dis, &flg));
2717398c7888SPierre Jolivet     PetscCall(ISDestroy(&dis));
2718398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input IS and output IS are not equal");
2719398c7888SPierre Jolivet   }
2720398c7888SPierre 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);
2721398c7888SPierre Jolivet   if (data->aux) {
2722398c7888SPierre Jolivet     PetscCall(MatMultEqual(data->aux, daux, 20, &flg));
2723398c7888SPierre Jolivet     PetscCall(MatDestroy(&daux));
2724398c7888SPierre Jolivet     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Input Mat and output Mat are not equal");
2725398c7888SPierre Jolivet   }
2726398c7888SPierre Jolivet #endif
27273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2728f1580f4eSBarry Smith }
2729f1580f4eSBarry Smith 
2730f1580f4eSBarry Smith /*@
2731f1580f4eSBarry Smith   PCHPDDMSetCoarseCorrectionType - Sets the coarse correction type.
2732f1580f4eSBarry Smith 
2733c3339decSBarry Smith   Collective
2734f1580f4eSBarry Smith 
2735f1580f4eSBarry Smith   Input Parameters:
2736f1580f4eSBarry Smith + pc   - preconditioner context
2737aa1539e9SPierre Jolivet - type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2738f1580f4eSBarry Smith 
2739f1580f4eSBarry Smith   Options Database Key:
2740aa1539e9SPierre Jolivet . -pc_hpddm_coarse_correction <deflated, additive, balanced, none> - type of coarse correction to apply
2741f1580f4eSBarry Smith 
2742f1580f4eSBarry Smith   Level: intermediate
2743f1580f4eSBarry Smith 
2744562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2745f1580f4eSBarry Smith @*/
2746d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType type)
2747d71ae5a4SJacob Faibussowitsch {
2748f1580f4eSBarry Smith   PetscFunctionBegin;
2749f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2750f1580f4eSBarry Smith   PetscValidLogicalCollectiveEnum(pc, type, 2);
2751f1580f4eSBarry Smith   PetscTryMethod(pc, "PCHPDDMSetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType), (pc, type));
27523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2753f1580f4eSBarry Smith }
2754f1580f4eSBarry Smith 
2755f1580f4eSBarry Smith /*@
2756f1580f4eSBarry Smith   PCHPDDMGetCoarseCorrectionType - Gets the coarse correction type.
2757f1580f4eSBarry Smith 
2758f1580f4eSBarry Smith   Input Parameter:
2759f1580f4eSBarry Smith . pc - preconditioner context
2760f1580f4eSBarry Smith 
2761f1580f4eSBarry Smith   Output Parameter:
2762aa1539e9SPierre Jolivet . type - `PC_HPDDM_COARSE_CORRECTION_DEFLATED`, `PC_HPDDM_COARSE_CORRECTION_ADDITIVE`, `PC_HPDDM_COARSE_CORRECTION_BALANCED`, or `PC_HPDDM_COARSE_CORRECTION_NONE`
2763f1580f4eSBarry Smith 
2764f1580f4eSBarry Smith   Level: intermediate
2765f1580f4eSBarry Smith 
2766562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDM`, `PCHPDDMCoarseCorrectionType`
2767f1580f4eSBarry Smith @*/
2768d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetCoarseCorrectionType(PC pc, PCHPDDMCoarseCorrectionType *type)
2769d71ae5a4SJacob Faibussowitsch {
2770f1580f4eSBarry Smith   PetscFunctionBegin;
2771f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2772f1580f4eSBarry Smith   if (type) {
27734f572ea9SToby Isaac     PetscAssertPointer(type, 2);
2774f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetCoarseCorrectionType_C", (PC, PCHPDDMCoarseCorrectionType *), (pc, type));
2775f1580f4eSBarry Smith   }
27763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2777f1580f4eSBarry Smith }
2778f1580f4eSBarry Smith 
2779d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType type)
2780d71ae5a4SJacob Faibussowitsch {
2781f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2782f1580f4eSBarry Smith 
2783f1580f4eSBarry Smith   PetscFunctionBegin;
2784f1580f4eSBarry Smith   data->correction = type;
27853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2786f1580f4eSBarry Smith }
2787f1580f4eSBarry Smith 
2788d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetCoarseCorrectionType_HPDDM(PC pc, PCHPDDMCoarseCorrectionType *type)
2789d71ae5a4SJacob Faibussowitsch {
2790f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2791f1580f4eSBarry Smith 
2792f1580f4eSBarry Smith   PetscFunctionBegin;
2793f1580f4eSBarry Smith   *type = data->correction;
27943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2795f1580f4eSBarry Smith }
2796f1580f4eSBarry Smith 
2797f1580f4eSBarry Smith /*@
2798e31fc274SPierre Jolivet   PCHPDDMSetSTShareSubKSP - Sets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver should be shared.
2799e31fc274SPierre Jolivet 
2800e31fc274SPierre Jolivet   Input Parameters:
2801e31fc274SPierre Jolivet + pc    - preconditioner context
2802e31fc274SPierre Jolivet - share - whether the `KSP` should be shared or not
2803e31fc274SPierre Jolivet 
2804e31fc274SPierre Jolivet   Note:
2805e31fc274SPierre Jolivet   This is not the same as `PCSetReusePreconditioner()`. Given certain conditions (visible using -info), a symbolic factorization can be skipped
2806e31fc274SPierre Jolivet   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2807e31fc274SPierre Jolivet 
2808e31fc274SPierre Jolivet   Level: advanced
2809e31fc274SPierre Jolivet 
2810562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMGetSTShareSubKSP()`
2811e31fc274SPierre Jolivet @*/
2812e31fc274SPierre Jolivet PetscErrorCode PCHPDDMSetSTShareSubKSP(PC pc, PetscBool share)
2813e31fc274SPierre Jolivet {
2814e31fc274SPierre Jolivet   PetscFunctionBegin;
2815e31fc274SPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2816e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetSTShareSubKSP_C", (PC, PetscBool), (pc, share));
28173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2818e31fc274SPierre Jolivet }
2819e31fc274SPierre Jolivet 
2820e31fc274SPierre Jolivet /*@
2821f1580f4eSBarry Smith   PCHPDDMGetSTShareSubKSP - Gets whether the `KSP` in SLEPc `ST` and the fine-level subdomain solver is shared.
2822f1580f4eSBarry Smith 
2823f1580f4eSBarry Smith   Input Parameter:
2824f1580f4eSBarry Smith . pc - preconditioner context
2825f1580f4eSBarry Smith 
2826f1580f4eSBarry Smith   Output Parameter:
2827f1580f4eSBarry Smith . share - whether the `KSP` is shared or not
2828f1580f4eSBarry Smith 
2829f1580f4eSBarry Smith   Note:
2830f1580f4eSBarry 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
2831f1580f4eSBarry Smith   when using a subdomain `PCType` such as `PCLU` or `PCCHOLESKY`.
2832f1580f4eSBarry Smith 
2833f1580f4eSBarry Smith   Level: advanced
2834f1580f4eSBarry Smith 
2835562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCHPDDMSetSTShareSubKSP()`
2836f1580f4eSBarry Smith @*/
2837d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMGetSTShareSubKSP(PC pc, PetscBool *share)
2838d71ae5a4SJacob Faibussowitsch {
2839f1580f4eSBarry Smith   PetscFunctionBegin;
2840f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2841f1580f4eSBarry Smith   if (share) {
28424f572ea9SToby Isaac     PetscAssertPointer(share, 2);
2843f1580f4eSBarry Smith     PetscUseMethod(pc, "PCHPDDMGetSTShareSubKSP_C", (PC, PetscBool *), (pc, share));
2844f1580f4eSBarry Smith   }
28453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2846f1580f4eSBarry Smith }
2847f1580f4eSBarry Smith 
2848e31fc274SPierre Jolivet static PetscErrorCode PCHPDDMSetSTShareSubKSP_HPDDM(PC pc, PetscBool share)
2849e31fc274SPierre Jolivet {
2850e31fc274SPierre Jolivet   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2851e31fc274SPierre Jolivet 
2852e31fc274SPierre Jolivet   PetscFunctionBegin;
2853e31fc274SPierre Jolivet   data->share = share;
28543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2855e31fc274SPierre Jolivet }
2856e31fc274SPierre Jolivet 
2857d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMGetSTShareSubKSP_HPDDM(PC pc, PetscBool *share)
2858d71ae5a4SJacob Faibussowitsch {
2859f1580f4eSBarry Smith   PC_HPDDM *data = (PC_HPDDM *)pc->data;
2860f1580f4eSBarry Smith 
2861f1580f4eSBarry Smith   PetscFunctionBegin;
2862f1580f4eSBarry Smith   *share = data->share;
28633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2864f1580f4eSBarry Smith }
2865f1580f4eSBarry Smith 
2866f1580f4eSBarry Smith /*@
2867f1580f4eSBarry Smith   PCHPDDMSetDeflationMat - Sets the deflation space used to assemble a coarser operator.
2868f1580f4eSBarry Smith 
2869f1580f4eSBarry Smith   Input Parameters:
2870f1580f4eSBarry Smith + pc - preconditioner context
2871f1580f4eSBarry Smith . is - index set of the local deflation matrix
2872f1580f4eSBarry Smith - U  - deflation sequential matrix stored as a `MATSEQDENSE`
2873f1580f4eSBarry Smith 
2874f1580f4eSBarry Smith   Level: advanced
2875f1580f4eSBarry Smith 
2876562efe2eSBarry Smith .seealso: [](ch_ksp), `PCHPDDM`, `PCDeflationSetSpace()`, `PCMGSetRestriction()`
2877f1580f4eSBarry Smith @*/
2878d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMSetDeflationMat(PC pc, IS is, Mat U)
2879d71ae5a4SJacob Faibussowitsch {
2880f1580f4eSBarry Smith   PetscFunctionBegin;
2881f1580f4eSBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2882f1580f4eSBarry Smith   PetscValidHeaderSpecific(is, IS_CLASSID, 2);
2883f1580f4eSBarry Smith   PetscValidHeaderSpecific(U, MAT_CLASSID, 3);
2884e31fc274SPierre Jolivet   PetscTryMethod(pc, "PCHPDDMSetDeflationMat_C", (PC, IS, Mat), (pc, is, U));
28853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2886f1580f4eSBarry Smith }
2887f1580f4eSBarry Smith 
2888d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCHPDDMSetDeflationMat_HPDDM(PC pc, IS is, Mat U)
2889d71ae5a4SJacob Faibussowitsch {
2890f1580f4eSBarry Smith   PetscFunctionBegin;
2891f1580f4eSBarry Smith   PetscCall(PCHPDDMSetAuxiliaryMat_Private(pc, is, U, PETSC_TRUE));
28923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2893f1580f4eSBarry Smith }
2894f1580f4eSBarry Smith 
2895d71ae5a4SJacob Faibussowitsch PetscErrorCode HPDDMLoadDL_Private(PetscBool *found)
2896d71ae5a4SJacob Faibussowitsch {
2897605ad303SPierre Jolivet   PetscBool flg;
2898f1580f4eSBarry Smith   char      lib[PETSC_MAX_PATH_LEN], dlib[PETSC_MAX_PATH_LEN], dir[PETSC_MAX_PATH_LEN];
2899f1580f4eSBarry Smith 
2900f1580f4eSBarry Smith   PetscFunctionBegin;
29014f572ea9SToby Isaac   PetscAssertPointer(found, 1);
2902c6a7a370SJeremy L Thompson   PetscCall(PetscStrncpy(dir, "${PETSC_LIB_DIR}", sizeof(dir)));
2903db4a47b3SPierre Jolivet   PetscCall(PetscOptionsGetString(nullptr, nullptr, "-hpddm_dir", dir, sizeof(dir), nullptr));
2904f1580f4eSBarry Smith   PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2905f1580f4eSBarry Smith   PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2906605ad303SPierre Jolivet #if defined(SLEPC_LIB_DIR) /* this variable is passed during SLEPc ./configure when PETSc has not been configured   */
2907605ad303SPierre Jolivet   if (!*found) {           /* with --download-hpddm since slepcconf.h is not yet built (and thus can't be included) */
2908c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(dir, HPDDM_STR(SLEPC_LIB_DIR), sizeof(dir)));
2909f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/libhpddm_petsc", dir));
2910f1580f4eSBarry Smith     PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2911f1580f4eSBarry Smith   }
2912f1580f4eSBarry Smith #endif
2913605ad303SPierre 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 */
2914605ad303SPierre Jolivet     PetscCall(PetscOptionsGetenv(PETSC_COMM_SELF, "SLEPC_DIR", dir, sizeof(dir), &flg));
2915605ad303SPierre 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 */
2916605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libslepc", dir));
2917605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2918605ad303SPierre Jolivet       PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found but SLEPC_DIR=%s", lib, dir);
2919605ad303SPierre Jolivet       PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
2920605ad303SPierre Jolivet       PetscCall(PetscSNPrintf(lib, sizeof(lib), "%s/lib/libhpddm_petsc", dir)); /* libhpddm_petsc is always in the same directory as libslepc */
2921605ad303SPierre Jolivet       PetscCall(PetscDLLibraryRetrieve(PETSC_COMM_SELF, lib, dlib, 1024, found));
2922605ad303SPierre Jolivet     }
2923605ad303SPierre Jolivet   }
2924f1580f4eSBarry Smith   PetscCheck(*found, PETSC_COMM_SELF, PETSC_ERR_PLIB, "%s not found", lib);
2925f1580f4eSBarry Smith   PetscCall(PetscDLLibraryAppend(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, dlib));
29263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2927f1580f4eSBarry Smith }
2928f1580f4eSBarry Smith 
2929f1580f4eSBarry Smith /*MC
2930f1580f4eSBarry Smith    PCHPDDM - Interface with the HPDDM library.
2931f1580f4eSBarry Smith 
29321d27aa22SBarry Smith    This `PC` may be used to build multilevel spectral domain decomposition methods based on the GenEO framework {cite}`spillane2011robust` {cite}`al2021multilevel`.
29331d27aa22SBarry Smith    It may be viewed as an alternative to spectral
29341d27aa22SBarry Smith    AMGe or `PCBDDC` with adaptive selection of constraints. The interface is explained in details in {cite}`jolivetromanzampini2020`
2935f1580f4eSBarry Smith 
2936e7593814SPierre 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`).
2937f1580f4eSBarry Smith 
2938f1580f4eSBarry Smith    For multilevel preconditioning, when using an assembled or hierarchical Pmat, one must provide an auxiliary local `Mat` (unassembled local operator for GenEO) using
2939f1580f4eSBarry Smith    `PCHPDDMSetAuxiliaryMat()`. Calling this routine is not needed when using a `MATIS` Pmat, assembly is done internally using `MatConvert()`.
2940f1580f4eSBarry Smith 
2941f1580f4eSBarry Smith    Options Database Keys:
2942f1580f4eSBarry Smith +   -pc_hpddm_define_subdomains <true, default=false>    - on the finest level, calls `PCASMSetLocalSubdomains()` with the `IS` supplied in `PCHPDDMSetAuxiliaryMat()`
2943f1580f4eSBarry Smith                                                          (not relevant with an unassembled Pmat)
2944f1580f4eSBarry Smith .   -pc_hpddm_has_neumann <true, default=false>          - on the finest level, informs the `PC` that the local Neumann matrix is supplied in `PCHPDDMSetAuxiliaryMat()`
2945f1580f4eSBarry Smith -   -pc_hpddm_coarse_correction <type, default=deflated> - determines the `PCHPDDMCoarseCorrectionType` when calling `PCApply()`
2946f1580f4eSBarry Smith 
294738bf2a8cSPierre Jolivet    Options for subdomain solvers, subdomain eigensolvers (for computing deflation vectors), and the coarse solver can be set using the following options database prefixes.
2948f1580f4eSBarry Smith .vb
2949f1580f4eSBarry Smith       -pc_hpddm_levels_%d_pc_
2950f1580f4eSBarry Smith       -pc_hpddm_levels_%d_ksp_
2951f1580f4eSBarry Smith       -pc_hpddm_levels_%d_eps_
2952f1580f4eSBarry Smith       -pc_hpddm_levels_%d_p
29534ec2a359SPierre Jolivet       -pc_hpddm_levels_%d_mat_type
2954f1580f4eSBarry Smith       -pc_hpddm_coarse_
2955f1580f4eSBarry Smith       -pc_hpddm_coarse_p
29564ec2a359SPierre Jolivet       -pc_hpddm_coarse_mat_type
29572ce66baaSPierre Jolivet       -pc_hpddm_coarse_mat_filter
2958f1580f4eSBarry Smith .ve
2959f1580f4eSBarry Smith 
296038bf2a8cSPierre 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
2961f1580f4eSBarry Smith     -pc_hpddm_coarse_p 2 -pc_hpddm_coarse_mat_type baij will use 10 deflation vectors per subdomain on the fine "level 1",
2962f1580f4eSBarry Smith     aggregate the fine subdomains into 4 "level 2" subdomains, then use 10 deflation vectors per subdomain on "level 2",
29637eb095acSPierre Jolivet     and assemble the coarse matrix (of dimension 4 x 10 = 40) on two processes as a `MATBAIJ` (default is `MATSBAIJ`).
2964f1580f4eSBarry Smith 
2965f1580f4eSBarry Smith    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 <val>. The default -pc_hpddm_coarse_p value is 1, meaning that the coarse operator is aggregated on a single process.
2966f1580f4eSBarry Smith 
29671d27aa22SBarry Smith    Level: intermediate
29681d27aa22SBarry Smith 
29691d27aa22SBarry Smith    Notes:
29701d27aa22SBarry Smith    This preconditioner requires that PETSc is built with SLEPc (``--download-slepc``).
29711d27aa22SBarry Smith 
29721d27aa22SBarry Smith    By default, the underlying concurrent eigenproblems
29731d27aa22SBarry Smith    are solved using SLEPc shift-and-invert spectral transformation. This is usually what gives the best performance for GenEO, cf.
29741d27aa22SBarry Smith    {cite}`spillane2011robust` {cite}`jolivet2013scalabledd`. As
297538bf2a8cSPierre 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
297638bf2a8cSPierre 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
297738bf2a8cSPierre Jolivet    SLEPc documentation since they are specific to `PCHPDDM`.
297838bf2a8cSPierre Jolivet .vb
297938bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_st_share_sub_ksp
298038bf2a8cSPierre Jolivet       -pc_hpddm_levels_%d_eps_threshold
298138bf2a8cSPierre Jolivet       -pc_hpddm_levels_1_eps_use_inertia
298238bf2a8cSPierre Jolivet .ve
298338bf2a8cSPierre Jolivet 
298438bf2a8cSPierre Jolivet    The first option from the list only applies to the fine-level eigensolver, see `PCHPDDMSetSTShareSubKSP()`. The second option from the list is
298538bf2a8cSPierre Jolivet    used to filter eigenmodes retrieved after convergence of `EPSSolve()` at "level N" such that eigenvectors used to define a "level N+1" coarse
298638bf2a8cSPierre Jolivet    correction are associated to eigenvalues whose magnitude are lower or equal than -pc_hpddm_levels_N_eps_threshold. When using an `EPS` which cannot
298738bf2a8cSPierre 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
298838bf2a8cSPierre 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
298938bf2a8cSPierre Jolivet    to supply -pc_hpddm_levels_1_eps_nev. This last option also only applies to the fine-level (N = 1) eigensolver.
2990f1580f4eSBarry Smith 
29911d27aa22SBarry Smith    See also {cite}`dolean2015introduction`, {cite}`al2022robust`, {cite}`al2022robustpd`, and {cite}`nataf2022recent`
2992f1580f4eSBarry Smith 
2993562efe2eSBarry Smith .seealso: [](ch_ksp), `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCHPDDMSetAuxiliaryMat()`, `MATIS`, `PCBDDC`, `PCDEFLATION`, `PCTELESCOPE`, `PCASM`,
2994e31fc274SPierre Jolivet           `PCHPDDMSetCoarseCorrectionType()`, `PCHPDDMHasNeumannMat()`, `PCHPDDMSetRHSMat()`, `PCHPDDMSetDeflationMat()`, `PCHPDDMSetSTShareSubKSP()`,
2995e31fc274SPierre Jolivet           `PCHPDDMGetSTShareSubKSP()`, `PCHPDDMGetCoarseCorrectionType()`, `PCHPDDMGetComplexities()`
2996f1580f4eSBarry Smith M*/
2997d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_HPDDM(PC pc)
2998d71ae5a4SJacob Faibussowitsch {
2999f1580f4eSBarry Smith   PC_HPDDM *data;
3000f1580f4eSBarry Smith   PetscBool found;
3001f1580f4eSBarry Smith 
3002f1580f4eSBarry Smith   PetscFunctionBegin;
3003f1580f4eSBarry Smith   if (!loadedSym) {
3004f1580f4eSBarry Smith     PetscCall(HPDDMLoadDL_Private(&found));
3005db4a47b3SPierre Jolivet     if (found) PetscCall(PetscDLLibrarySym(PETSC_COMM_SELF, &PetscDLLibrariesLoaded, nullptr, "PCHPDDM_Internal", (void **)&loadedSym));
3006f1580f4eSBarry Smith   }
3007f1580f4eSBarry Smith   PetscCheck(loadedSym, PETSC_COMM_SELF, PETSC_ERR_PLIB, "PCHPDDM_Internal symbol not found in loaded libhpddm_petsc");
30084dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&data));
3009f1580f4eSBarry Smith   pc->data                = data;
3010c8ea6600SPierre Jolivet   data->Neumann           = PETSC_BOOL3_UNKNOWN;
3011f1580f4eSBarry Smith   pc->ops->reset          = PCReset_HPDDM;
3012f1580f4eSBarry Smith   pc->ops->destroy        = PCDestroy_HPDDM;
3013f1580f4eSBarry Smith   pc->ops->setfromoptions = PCSetFromOptions_HPDDM;
3014f1580f4eSBarry Smith   pc->ops->setup          = PCSetUp_HPDDM;
3015f1580f4eSBarry Smith   pc->ops->apply          = PCApply_HPDDM;
3016f1580f4eSBarry Smith   pc->ops->matapply       = PCMatApply_HPDDM;
3017f1580f4eSBarry Smith   pc->ops->view           = PCView_HPDDM;
3018f1580f4eSBarry Smith   pc->ops->presolve       = PCPreSolve_HPDDM;
3019f1580f4eSBarry Smith 
3020f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetAuxiliaryMat_C", PCHPDDMSetAuxiliaryMat_HPDDM));
3021f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMHasNeumannMat_C", PCHPDDMHasNeumannMat_HPDDM));
3022f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetRHSMat_C", PCHPDDMSetRHSMat_HPDDM));
3023f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetCoarseCorrectionType_C", PCHPDDMSetCoarseCorrectionType_HPDDM));
3024f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetCoarseCorrectionType_C", PCHPDDMGetCoarseCorrectionType_HPDDM));
3025e31fc274SPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetSTShareSubKSP_C", PCHPDDMSetSTShareSubKSP_HPDDM));
3026f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMGetSTShareSubKSP_C", PCHPDDMGetSTShareSubKSP_HPDDM));
3027f1580f4eSBarry Smith   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCHPDDMSetDeflationMat_C", PCHPDDMSetDeflationMat_HPDDM));
30283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3029f1580f4eSBarry Smith }
3030f1580f4eSBarry Smith 
3031f1580f4eSBarry Smith /*@C
3032f1580f4eSBarry Smith   PCHPDDMInitializePackage - This function initializes everything in the `PCHPDDM` package. It is called from `PCInitializePackage()`.
3033f1580f4eSBarry Smith 
3034f1580f4eSBarry Smith   Level: developer
3035f1580f4eSBarry Smith 
3036562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscInitialize()`
3037f1580f4eSBarry Smith @*/
3038d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMInitializePackage(void)
3039d71ae5a4SJacob Faibussowitsch {
3040f1580f4eSBarry Smith   char ename[32];
3041f1580f4eSBarry Smith 
3042f1580f4eSBarry Smith   PetscFunctionBegin;
30433ba16761SJacob Faibussowitsch   if (PCHPDDMPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
3044f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_TRUE;
3045f1580f4eSBarry Smith   PetscCall(PetscRegisterFinalize(PCHPDDMFinalizePackage));
3046f1580f4eSBarry Smith   /* general events registered once during package initialization */
3047f1580f4eSBarry Smith   /* some of these events are not triggered in libpetsc,          */
3048f1580f4eSBarry Smith   /* but rather directly in libhpddm_petsc,                       */
3049f1580f4eSBarry Smith   /* which is in charge of performing the following operations    */
3050f1580f4eSBarry Smith 
3051f1580f4eSBarry Smith   /* domain decomposition structure from Pmat sparsity pattern    */
3052f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMStrc", PC_CLASSID, &PC_HPDDM_Strc));
3053f1580f4eSBarry Smith   /* Galerkin product, redistribution, and setup (not triggered in libpetsc)                */
3054f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtAP", PC_CLASSID, &PC_HPDDM_PtAP));
3055f1580f4eSBarry Smith   /* Galerkin product with summation, redistribution, and setup (not triggered in libpetsc) */
3056f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMPtBP", PC_CLASSID, &PC_HPDDM_PtBP));
3057f1580f4eSBarry Smith   /* next level construction using PtAP and PtBP (not triggered in libpetsc)                */
3058f1580f4eSBarry Smith   PetscCall(PetscLogEventRegister("PCHPDDMNext", PC_CLASSID, &PC_HPDDM_Next));
3059f1580f4eSBarry Smith   static_assert(PETSC_PCHPDDM_MAXLEVELS <= 9, "PETSC_PCHPDDM_MAXLEVELS value is too high");
3060811e8887SPierre Jolivet   for (PetscInt i = 1; i < PETSC_PCHPDDM_MAXLEVELS; ++i) {
3061f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSetUp L%1" PetscInt_FMT, i));
3062f1580f4eSBarry Smith     /* events during a PCSetUp() at level #i _except_ the assembly */
3063f1580f4eSBarry Smith     /* of the Galerkin operator of the coarser level #(i + 1)      */
3064f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_SetUp[i - 1]));
3065f1580f4eSBarry Smith     PetscCall(PetscSNPrintf(ename, sizeof(ename), "PCHPDDMSolve L%1" PetscInt_FMT, i));
3066f1580f4eSBarry Smith     /* events during a PCApply() at level #i _except_              */
3067f1580f4eSBarry Smith     /* the KSPSolve() of the coarser level #(i + 1)                */
3068f1580f4eSBarry Smith     PetscCall(PetscLogEventRegister(ename, PC_CLASSID, &PC_HPDDM_Solve[i - 1]));
3069f1580f4eSBarry Smith   }
30703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3071f1580f4eSBarry Smith }
3072f1580f4eSBarry Smith 
3073f1580f4eSBarry Smith /*@C
3074f1580f4eSBarry Smith   PCHPDDMFinalizePackage - This function frees everything from the `PCHPDDM` package. It is called from `PetscFinalize()`.
3075f1580f4eSBarry Smith 
3076f1580f4eSBarry Smith   Level: developer
3077f1580f4eSBarry Smith 
3078562efe2eSBarry Smith .seealso: [](ch_ksp), `PetscFinalize()`
3079f1580f4eSBarry Smith @*/
3080d71ae5a4SJacob Faibussowitsch PetscErrorCode PCHPDDMFinalizePackage(void)
3081d71ae5a4SJacob Faibussowitsch {
3082f1580f4eSBarry Smith   PetscFunctionBegin;
3083f1580f4eSBarry Smith   PCHPDDMPackageInitialized = PETSC_FALSE;
30843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3085f1580f4eSBarry Smith }
30869bb5c669SPierre Jolivet 
30879bb5c669SPierre Jolivet static PetscErrorCode MatMult_Harmonic(Mat A, Vec x, Vec y)
30889bb5c669SPierre Jolivet {
30899bb5c669SPierre Jolivet   Harmonic h; /* [ A_00  A_01       ], furthermore, A_00 = [ A_loc,loc  A_loc,ovl ], thus, A_01 = [         ] */
30909bb5c669SPierre Jolivet               /* [ A_10  A_11  A_12 ]                      [ A_ovl,loc  A_ovl,ovl ]               [ A_ovl,1 ] */
30919bb5c669SPierre Jolivet   Vec sub;    /*  y = A x = R_loc R_0 [ A_00  A_01 ]^-1                                   R_loc = [  I_loc  ] */
30929bb5c669SPierre Jolivet               /*                      [ A_10  A_11 ]    R_1^T A_12 x                              [         ] */
30939bb5c669SPierre Jolivet   PetscFunctionBegin;
30949bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
30959bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
30969bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
30979bb5c669SPierre Jolivet   PetscCall(MatMult(h->A[0], x, sub));
30989bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
30999bb5c669SPierre Jolivet   PetscCall(KSPSolve(h->ksp, h->v, h->v));
31009bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_REVERSE, y));
31019bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
31029bb5c669SPierre Jolivet }
31039bb5c669SPierre Jolivet 
31049bb5c669SPierre Jolivet static PetscErrorCode MatMultTranspose_Harmonic(Mat A, Vec y, Vec x)
31059bb5c669SPierre Jolivet {
31069bb5c669SPierre Jolivet   Harmonic h;   /* x = A^T y =            [ A_00  A_01 ]^-T R_0^T R_loc^T y */
31079bb5c669SPierre Jolivet   Vec      sub; /*             A_12^T R_1 [ A_10  A_11 ]                    */
31089bb5c669SPierre Jolivet 
31099bb5c669SPierre Jolivet   PetscFunctionBegin;
31109bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
31119bb5c669SPierre Jolivet   PetscCall(VecSet(h->v, 0.0));
31129bb5c669SPierre Jolivet   PetscCall(VecISCopy(h->v, h->is[1], SCATTER_FORWARD, y));
31139bb5c669SPierre Jolivet   PetscCall(KSPSolveTranspose(h->ksp, h->v, h->v));
31149bb5c669SPierre Jolivet   PetscCall(VecGetSubVector(h->v, h->is[0], &sub));
31159bb5c669SPierre Jolivet   PetscCall(MatMultTranspose(h->A[0], sub, x));
31169bb5c669SPierre Jolivet   PetscCall(VecRestoreSubVector(h->v, h->is[0], &sub));
31179bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
31189bb5c669SPierre Jolivet }
31199bb5c669SPierre Jolivet 
31209bb5c669SPierre Jolivet static PetscErrorCode MatProduct_AB_Harmonic(Mat S, Mat X, Mat Y, void *)
31219bb5c669SPierre Jolivet {
31229bb5c669SPierre Jolivet   Harmonic h;
31239bb5c669SPierre Jolivet   Mat      A, B;
31249bb5c669SPierre Jolivet   Vec      a, b;
31259bb5c669SPierre Jolivet 
31269bb5c669SPierre Jolivet   PetscFunctionBegin;
31279bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(S, &h));
3128fb842aefSJose E. Roman   PetscCall(MatMatMult(h->A[0], X, MAT_INITIAL_MATRIX, PETSC_CURRENT, &A));
31299bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, A->cmap->n, nullptr, &B));
31309bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
31319bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
31329bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(B, i, &b));
31339bb5c669SPierre Jolivet     PetscCall(VecISCopy(b, h->is[0], SCATTER_FORWARD, a));
31349bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(B, i, &b));
31359bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
31369bb5c669SPierre Jolivet   }
31379bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
31389bb5c669SPierre Jolivet   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, h->ksp->pc->mat->rmap->n, B->cmap->n, nullptr, &A));
31399bb5c669SPierre Jolivet   PetscCall(KSPMatSolve(h->ksp, B, A));
31409bb5c669SPierre Jolivet   PetscCall(MatDestroy(&B));
31419bb5c669SPierre Jolivet   for (PetscInt i = 0; i < A->cmap->n; ++i) {
31429bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecRead(A, i, &a));
31439bb5c669SPierre Jolivet     PetscCall(MatDenseGetColumnVecWrite(Y, i, &b));
31449bb5c669SPierre Jolivet     PetscCall(VecISCopy(a, h->is[1], SCATTER_REVERSE, b));
31459bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecWrite(Y, i, &b));
31469bb5c669SPierre Jolivet     PetscCall(MatDenseRestoreColumnVecRead(A, i, &a));
31479bb5c669SPierre Jolivet   }
31489bb5c669SPierre Jolivet   PetscCall(MatDestroy(&A));
31499bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
31509bb5c669SPierre Jolivet }
31519bb5c669SPierre Jolivet 
31529bb5c669SPierre Jolivet static PetscErrorCode MatDestroy_Harmonic(Mat A)
31539bb5c669SPierre Jolivet {
31549bb5c669SPierre Jolivet   Harmonic h;
31559bb5c669SPierre Jolivet 
31569bb5c669SPierre Jolivet   PetscFunctionBegin;
31579bb5c669SPierre Jolivet   PetscCall(MatShellGetContext(A, &h));
315832603206SJames Wright   for (PetscInt i = 0; i < 5; ++i) PetscCall(ISDestroy(h->is + i));
31599bb5c669SPierre Jolivet   PetscCall(PetscFree(h->is));
31609bb5c669SPierre Jolivet   PetscCall(VecDestroy(&h->v));
31619bb5c669SPierre Jolivet   for (PetscInt i = 0; i < 2; ++i) PetscCall(MatDestroy(h->A + i));
31629bb5c669SPierre Jolivet   PetscCall(PetscFree(h->A));
31639bb5c669SPierre Jolivet   PetscCall(KSPDestroy(&h->ksp));
31649bb5c669SPierre Jolivet   PetscCall(PetscFree(h));
31659bb5c669SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
31669bb5c669SPierre Jolivet }
3167