xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 48a46eb9bd028bec07ec0f396b1a3abb43f14558)
1af0996ceSBarry Smith #include <petsc/private/pcimpl.h>  /*I "petscpc.h" I*/
2a80b646eSBarry Smith #include <petsc/private/kspimpl.h> /*  This is needed to provide the appropriate PETSC_EXTERN for KSP_Solve_FS ....*/
31e25c274SJed Brown #include <petscdm.h>
40971522cSBarry Smith 
50a545947SLisandro Dalcin const char *const PCFieldSplitSchurPreTypes[]  = {"SELF", "SELFP", "A11", "USER", "FULL", "PCFieldSplitSchurPreType", "PC_FIELDSPLIT_SCHUR_PRE_", NULL};
60a545947SLisandro Dalcin const char *const PCFieldSplitSchurFactTypes[] = {"DIAG", "LOWER", "UPPER", "FULL", "PCFieldSplitSchurFactType", "PC_FIELDSPLIT_SCHUR_FACT_", NULL};
7c5d2311dSJed Brown 
89df09d43SBarry Smith PetscLogEvent KSP_Solve_FS_0, KSP_Solve_FS_1, KSP_Solve_FS_S, KSP_Solve_FS_U, KSP_Solve_FS_L, KSP_Solve_FS_2, KSP_Solve_FS_3, KSP_Solve_FS_4;
99df09d43SBarry Smith 
100971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
110971522cSBarry Smith struct _PC_FieldSplitLink {
1269a612a9SBarry Smith   KSP               ksp;
13443836d0SMatthew G Knepley   Vec               x, y, z;
14db4c96c1SJed Brown   char             *splitname;
150971522cSBarry Smith   PetscInt          nfields;
165d4c12cdSJungho Lee   PetscInt         *fields, *fields_col;
171b9fc7fcSBarry Smith   VecScatter        sctx;
18f5f0d762SBarry Smith   IS                is, is_col;
1951f519a2SBarry Smith   PC_FieldSplitLink next, previous;
209df09d43SBarry Smith   PetscLogEvent     event;
215ddf11f8SNicolas Barnafi 
225ddf11f8SNicolas Barnafi   /* Used only when setting coordinates with PCSetCoordinates */
235ddf11f8SNicolas Barnafi   PetscInt   dim;
245ddf11f8SNicolas Barnafi   PetscInt   ndofs;
255ddf11f8SNicolas Barnafi   PetscReal *coords;
260971522cSBarry Smith };
270971522cSBarry Smith 
280971522cSBarry Smith typedef struct {
2968dd23aaSBarry Smith   PCCompositeType type;
30ace3abfcSBarry Smith   PetscBool       defaultsplit; /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
31ace3abfcSBarry Smith   PetscBool       splitdefined; /* Flag is set after the splits have been defined, to prevent more splits from being added */
3230ad9308SMatthew Knepley   PetscInt        bs;           /* Block size for IS and Mat structures */
3330ad9308SMatthew Knepley   PetscInt        nsplits;      /* Number of field divisions defined */
3479416396SBarry Smith   Vec            *x, *y, w1, w2;
35519d70e2SJed Brown   Mat            *mat;    /* The diagonal block for each split */
36519d70e2SJed Brown   Mat            *pmat;   /* The preconditioning diagonal block for each split */
3730ad9308SMatthew Knepley   Mat            *Afield; /* The rows of the matrix associated with each split */
38ace3abfcSBarry Smith   PetscBool       issetup;
392fa5cd67SKarl Rupp 
4030ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
4130ad9308SMatthew Knepley   Mat                       B;          /* The (0,1) block */
4230ad9308SMatthew Knepley   Mat                       C;          /* The (1,0) block */
43443836d0SMatthew G Knepley   Mat                       schur;      /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
44a7476a74SDmitry Karpeev   Mat                       schurp;     /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
45084e4875SJed Brown   Mat                       schur_user; /* User-provided preconditioning matrix for the Schur complement */
46084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;   /* Determines which preconditioning matrix is used for the Schur complement */
47c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4830ad9308SMatthew Knepley   KSP                       kspschur;   /* The solver for S */
49443836d0SMatthew G Knepley   KSP                       kspupper;   /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
50c096484dSStefano Zampini   PetscScalar               schurscale; /* Scaling factor for the Schur complement solution with DIAG factorization */
51c096484dSStefano Zampini 
52a51937d4SCarola Kruse   /* Only used when Golub-Kahan bidiagonalization preconditioning is used */
53a51937d4SCarola Kruse   Mat          H;           /* The modified matrix H = A00 + nu*A01*A01'              */
54a51937d4SCarola Kruse   PetscReal    gkbtol;      /* Stopping tolerance for lower bound estimate            */
55a51937d4SCarola Kruse   PetscInt     gkbdelay;    /* The delay window for the stopping criterion            */
56a51937d4SCarola Kruse   PetscReal    gkbnu;       /* Parameter for augmented Lagrangian H = A + nu*A01*A01' */
57a51937d4SCarola Kruse   PetscInt     gkbmaxit;    /* Maximum number of iterations for outer loop            */
58de482cd7SCarola Kruse   PetscBool    gkbmonitor;  /* Monitor for gkb iterations and the lower bound error   */
59de482cd7SCarola Kruse   PetscViewer  gkbviewer;   /* Viewer context for gkbmonitor                          */
60e071a0a4SCarola Kruse   Vec          u, v, d, Hu; /* Work vectors for the GKB algorithm                     */
61e071a0a4SCarola Kruse   PetscScalar *vecz;        /* Contains intermediate values, eg for lower bound       */
62a51937d4SCarola Kruse 
6397bbdb24SBarry Smith   PC_FieldSplitLink head;
646dbb499eSCian Wilson   PetscBool         isrestrict;       /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */
65c1570756SJed Brown   PetscBool         suboptionsset;    /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
664ab8060aSDmitry Karpeev   PetscBool         dm_splits;        /* Whether to use DMCreateFieldDecomposition() whenever possible */
67c84da90fSDmitry Karpeev   PetscBool         diag_use_amat;    /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
68c84da90fSDmitry Karpeev   PetscBool         offdiag_use_amat; /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
697b752e3dSPatrick Sanan   PetscBool         detect;           /* Whether to form 2-way split by finding zero diagonal entries */
705ddf11f8SNicolas Barnafi   PetscBool         coordinates_set;  /* Whether PCSetCoordinates has been called */
710971522cSBarry Smith } PC_FieldSplit;
720971522cSBarry Smith 
7316913363SBarry Smith /*
7495452b02SPatrick Sanan     Notes:
7595452b02SPatrick Sanan     there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
7616913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
7716913363SBarry Smith    PC you could change this.
7816913363SBarry Smith */
79084e4875SJed Brown 
80e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
81084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
829371c9d4SSatish Balay static Mat FieldSplitSchurPre(PC_FieldSplit *jac) {
83084e4875SJed Brown   switch (jac->schurpre) {
84084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
85a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
86e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
87e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
88084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
899371c9d4SSatish Balay   default: return jac->schur_user ? jac->schur_user : jac->pmat[1];
90084e4875SJed Brown   }
91084e4875SJed Brown }
92084e4875SJed Brown 
939804daf3SBarry Smith #include <petscdraw.h>
949371c9d4SSatish Balay static PetscErrorCode PCView_FieldSplit(PC pc, PetscViewer viewer) {
950971522cSBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
96d9884438SBarry Smith   PetscBool         iascii, isdraw;
970971522cSBarry Smith   PetscInt          i, j;
985a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
990971522cSBarry Smith 
1000971522cSBarry Smith   PetscFunctionBegin;
1019566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
1029566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
1030971522cSBarry Smith   if (iascii) {
1042c9966d7SBarry Smith     if (jac->bs > 0) {
10563a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs));
1062c9966d7SBarry Smith     } else {
10763a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits));
1082c9966d7SBarry Smith     }
109*48a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
110*48a46eb9SPierre Jolivet     if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for diagonal blocks\n"));
111*48a46eb9SPierre Jolivet     if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for off-diagonal blocks\n"));
1129566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Solver info for each split is in the following KSP objects:\n"));
1130971522cSBarry Smith     for (i = 0; i < jac->nsplits; i++) {
1141ab39975SBarry Smith       if (ilink->fields) {
11563a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i));
1169566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
1175a9f2f41SSatish Balay         for (j = 0; j < ilink->nfields; j++) {
118*48a46eb9SPierre Jolivet           if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
11963a3b9bcSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
1200971522cSBarry Smith         }
1219566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
1229566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
1231ab39975SBarry Smith       } else {
12463a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i));
1251ab39975SBarry Smith       }
1269566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
1275a9f2f41SSatish Balay       ilink = ilink->next;
1280971522cSBarry Smith     }
1292fa5cd67SKarl Rupp   }
1302fa5cd67SKarl Rupp 
1312fa5cd67SKarl Rupp   if (isdraw) {
132d9884438SBarry Smith     PetscDraw draw;
133d9884438SBarry Smith     PetscReal x, y, w, wd;
134d9884438SBarry Smith 
1359566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
1369566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
137d9884438SBarry Smith     w  = 2 * PetscMin(1.0 - x, x);
138d9884438SBarry Smith     wd = w / (jac->nsplits + 1);
139d9884438SBarry Smith     x  = x - wd * (jac->nsplits - 1) / 2.0;
140d9884438SBarry Smith     for (i = 0; i < jac->nsplits; i++) {
1419566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
1429566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
1439566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
144d9884438SBarry Smith       x += wd;
145d9884438SBarry Smith       ilink = ilink->next;
146d9884438SBarry Smith     }
1470971522cSBarry Smith   }
1480971522cSBarry Smith   PetscFunctionReturn(0);
1490971522cSBarry Smith }
1500971522cSBarry Smith 
1519371c9d4SSatish Balay static PetscErrorCode PCView_FieldSplit_Schur(PC pc, PetscViewer viewer) {
1523b224e63SBarry Smith   PC_FieldSplit             *jac = (PC_FieldSplit *)pc->data;
1534996c5bdSBarry Smith   PetscBool                  iascii, isdraw;
1543b224e63SBarry Smith   PetscInt                   i, j;
1553b224e63SBarry Smith   PC_FieldSplitLink          ilink = jac->head;
156a9908d51SBarry Smith   MatSchurComplementAinvType atype;
1573b224e63SBarry Smith 
1583b224e63SBarry Smith   PetscFunctionBegin;
1599566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
1609566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
1613b224e63SBarry Smith   if (iascii) {
1622c9966d7SBarry Smith     if (jac->bs > 0) {
16363a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with Schur preconditioner, blocksize = %" PetscInt_FMT ", factorization %s\n", jac->bs, PCFieldSplitSchurFactTypes[jac->schurfactorization]));
1642c9966d7SBarry Smith     } else {
1659566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with Schur preconditioner, factorization %s\n", PCFieldSplitSchurFactTypes[jac->schurfactorization]));
1662c9966d7SBarry Smith     }
167*48a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
1683e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1699371c9d4SSatish Balay     case PC_FIELDSPLIT_SCHUR_PRE_SELF: PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from S itself\n")); break;
170a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
1719566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetAinvType(jac->schur, &atype));
1729371c9d4SSatish Balay       PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses A00's %sinverse\n", atype == MAT_SCHUR_COMPLEMENT_AINV_DIAG ? "diagonal's " : (atype == MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG ? "block diagonal's " : (atype == MAT_SCHUR_COMPLEMENT_AINV_FULL ? "full " : "lumped diagonal's "))));
173a9908d51SBarry Smith       break;
1749371c9d4SSatish Balay     case PC_FIELDSPLIT_SCHUR_PRE_A11: PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from A11\n")); break;
1759371c9d4SSatish Balay     case PC_FIELDSPLIT_SCHUR_PRE_FULL: PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from the exact Schur complement\n")); break;
1763e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1773e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1789566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from user provided matrix\n"));
1793e8b8b31SMatthew G Knepley       } else {
1809566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from A11\n"));
1813e8b8b31SMatthew G Knepley       }
1823e8b8b31SMatthew G Knepley       break;
1839371c9d4SSatish Balay     default: SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1843e8b8b31SMatthew G Knepley     }
1859566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Split info:\n"));
1869566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
1873b224e63SBarry Smith     for (i = 0; i < jac->nsplits; i++) {
1883b224e63SBarry Smith       if (ilink->fields) {
18963a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i));
1909566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
1913b224e63SBarry Smith         for (j = 0; j < ilink->nfields; j++) {
192*48a46eb9SPierre Jolivet           if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
19363a3b9bcSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
1943b224e63SBarry Smith         }
1959566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
1969566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
1973b224e63SBarry Smith       } else {
19863a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i));
1993b224e63SBarry Smith       }
2003b224e63SBarry Smith       ilink = ilink->next;
2013b224e63SBarry Smith     }
2029566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for A00 block\n"));
2039566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
20406de4afeSJed Brown     if (jac->head) {
2059566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->head->ksp, viewer));
2069566063dSJacob Faibussowitsch     } else PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
2079566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
20806de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
2099566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for upper A00 in upper triangular factor \n"));
2109566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPushTab(viewer));
2119566063dSJacob Faibussowitsch       if (jac->kspupper) PetscCall(KSPView(jac->kspupper, viewer));
2129566063dSJacob Faibussowitsch       else PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
2139566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPopTab(viewer));
214443836d0SMatthew G Knepley     }
2159566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for S = A11 - A10 inv(A00) A01 \n"));
2169566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
21712cae6f2SJed Brown     if (jac->kspschur) {
2189566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->kspschur, viewer));
21912cae6f2SJed Brown     } else {
2209566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
22112cae6f2SJed Brown     }
2229566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
2239566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
22406de4afeSJed Brown   } else if (isdraw && jac->head) {
2254996c5bdSBarry Smith     PetscDraw draw;
2264996c5bdSBarry Smith     PetscReal x, y, w, wd, h;
2274996c5bdSBarry Smith     PetscInt  cnt = 2;
2284996c5bdSBarry Smith     char      str[32];
2294996c5bdSBarry Smith 
2309566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
2319566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
232c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
233c74581afSBarry Smith     w  = 2 * PetscMin(1.0 - x, x);
234c74581afSBarry Smith     wd = w / (cnt + 1);
235c74581afSBarry Smith 
2369566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(str, 32, "Schur fact. %s", PCFieldSplitSchurFactTypes[jac->schurfactorization]));
2379566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h));
2384996c5bdSBarry Smith     y -= h;
2394996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) {
2409566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]));
2413b224e63SBarry Smith     } else {
2429566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[jac->schurpre]));
2434996c5bdSBarry Smith     }
2449566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x + wd * (cnt - 1) / 2.0, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h));
2454996c5bdSBarry Smith     y -= h;
2464996c5bdSBarry Smith     x = x - wd * (cnt - 1) / 2.0;
2474996c5bdSBarry Smith 
2489566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2499566063dSJacob Faibussowitsch     PetscCall(KSPView(jac->head->ksp, viewer));
2509566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
2514996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2524996c5bdSBarry Smith       x += wd;
2539566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2549566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->kspupper, viewer));
2559566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
2564996c5bdSBarry Smith     }
2574996c5bdSBarry Smith     x += wd;
2589566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2599566063dSJacob Faibussowitsch     PetscCall(KSPView(jac->kspschur, viewer));
2609566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
2613b224e63SBarry Smith   }
2623b224e63SBarry Smith   PetscFunctionReturn(0);
2633b224e63SBarry Smith }
2643b224e63SBarry Smith 
2659371c9d4SSatish Balay static PetscErrorCode PCView_FieldSplit_GKB(PC pc, PetscViewer viewer) {
266a51937d4SCarola Kruse   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
267a51937d4SCarola Kruse   PetscBool         iascii, isdraw;
268a51937d4SCarola Kruse   PetscInt          i, j;
269a51937d4SCarola Kruse   PC_FieldSplitLink ilink = jac->head;
270a51937d4SCarola Kruse 
271a51937d4SCarola Kruse   PetscFunctionBegin;
2729566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
2739566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
274a51937d4SCarola Kruse   if (iascii) {
275a51937d4SCarola Kruse     if (jac->bs > 0) {
27663a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs));
277a51937d4SCarola Kruse     } else {
27863a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits));
279a51937d4SCarola Kruse     }
280*48a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
281*48a46eb9SPierre Jolivet     if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for diagonal blocks\n"));
282*48a46eb9SPierre Jolivet     if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for off-diagonal blocks\n"));
283a51937d4SCarola Kruse 
28463a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Stopping tolerance=%.1e, delay in error estimate=%" PetscInt_FMT ", maximum iterations=%" PetscInt_FMT "\n", (double)jac->gkbtol, jac->gkbdelay, jac->gkbmaxit));
2859566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Solver info for H = A00 + nu*A01*A01' matrix:\n"));
2869566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
287a51937d4SCarola Kruse 
288a51937d4SCarola Kruse     if (ilink->fields) {
28963a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Fields "));
2909566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
291a51937d4SCarola Kruse       for (j = 0; j < ilink->nfields; j++) {
292*48a46eb9SPierre Jolivet         if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
29363a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
294a51937d4SCarola Kruse       }
2959566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
2969566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
297a51937d4SCarola Kruse     } else {
29863a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Defined by IS\n"));
299a51937d4SCarola Kruse     }
3009566063dSJacob Faibussowitsch     PetscCall(KSPView(ilink->ksp, viewer));
301a51937d4SCarola Kruse 
3029566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
303a51937d4SCarola Kruse   }
304a51937d4SCarola Kruse 
305a51937d4SCarola Kruse   if (isdraw) {
306a51937d4SCarola Kruse     PetscDraw draw;
307a51937d4SCarola Kruse     PetscReal x, y, w, wd;
308a51937d4SCarola Kruse 
3099566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
3109566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
311a51937d4SCarola Kruse     w  = 2 * PetscMin(1.0 - x, x);
312a51937d4SCarola Kruse     wd = w / (jac->nsplits + 1);
313a51937d4SCarola Kruse     x  = x - wd * (jac->nsplits - 1) / 2.0;
314a51937d4SCarola Kruse     for (i = 0; i < jac->nsplits; i++) {
3159566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
3169566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
3179566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
318a51937d4SCarola Kruse       x += wd;
319a51937d4SCarola Kruse       ilink = ilink->next;
320a51937d4SCarola Kruse     }
321a51937d4SCarola Kruse   }
322a51937d4SCarola Kruse   PetscFunctionReturn(0);
323a51937d4SCarola Kruse }
324a51937d4SCarola Kruse 
3256c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
3269371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc) {
3276c924f48SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
3285d4c12cdSJungho Lee   PetscInt       i, nfields, *ifields, nfields_col, *ifields_col;
3295d4c12cdSJungho Lee   PetscBool      flg, flg_col;
3305d4c12cdSJungho Lee   char           optionname[128], splitname[8], optionname_col[128];
3316c924f48SJed Brown 
3326c924f48SJed Brown   PetscFunctionBegin;
3339566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->bs, &ifields));
3349566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->bs, &ifields_col));
3356c924f48SJed Brown   for (i = 0, flg = PETSC_TRUE;; i++) {
33663a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
33763a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
33863a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname_col, sizeof(optionname_col), "-pc_fieldsplit_%" PetscInt_FMT "_fields_col", i));
3396c924f48SJed Brown     nfields     = jac->bs;
34029499fbbSJungho Lee     nfields_col = jac->bs;
3419566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
3429566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname_col, ifields_col, &nfields_col, &flg_col));
3436c924f48SJed Brown     if (!flg) break;
3445d4c12cdSJungho Lee     else if (flg && !flg_col) {
34528b400f6SJacob Faibussowitsch       PetscCheck(nfields, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
3469566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields));
3472fa5cd67SKarl Rupp     } else {
3487827d75bSBarry Smith       PetscCheck(nfields && nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
34908401ef6SPierre Jolivet       PetscCheck(nfields == nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Number of row and column fields must match");
3509566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields_col));
3515d4c12cdSJungho Lee     }
3526c924f48SJed Brown   }
3536c924f48SJed Brown   if (i > 0) {
3546c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3556c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3566c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3576c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3586c924f48SJed Brown   }
3599566063dSJacob Faibussowitsch   PetscCall(PetscFree(ifields));
3609566063dSJacob Faibussowitsch   PetscCall(PetscFree(ifields_col));
3616c924f48SJed Brown   PetscFunctionReturn(0);
3626c924f48SJed Brown }
3636c924f48SJed Brown 
3649371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetDefaults(PC pc) {
3650971522cSBarry Smith   PC_FieldSplit    *jac                = (PC_FieldSplit *)pc->data;
3665a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3677b752e3dSPatrick Sanan   PetscBool         fieldsplit_default = PETSC_FALSE, coupling = PETSC_FALSE;
3686c924f48SJed Brown   PetscInt          i;
3690971522cSBarry Smith 
3700971522cSBarry Smith   PetscFunctionBegin;
3717287d2a3SDmitry Karpeev   /*
372f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
3737287d2a3SDmitry Karpeev    Should probably be rewritten.
3747287d2a3SDmitry Karpeev    */
375f5f0d762SBarry Smith   if (!ilink) {
3769566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_detect_coupling", &coupling, NULL));
3777b752e3dSPatrick Sanan     if (pc->dm && jac->dm_splits && !jac->detect && !coupling) {
378bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3790784a22cSJed Brown       char    **fieldNames;
3807b62db95SJungho Lee       IS       *fields;
381e7c4fc90SDmitry Karpeev       DM       *dms;
382bafc1b83SMatthew G Knepley       DM        subdm[128];
383bafc1b83SMatthew G Knepley       PetscBool flg;
384bafc1b83SMatthew G Knepley 
3859566063dSJacob Faibussowitsch       PetscCall(DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms));
386bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
387bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
388bafc1b83SMatthew G Knepley         PetscInt ifields[128];
389bafc1b83SMatthew G Knepley         IS       compField;
390bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
391bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
392bafc1b83SMatthew G Knepley 
39363a3b9bcSJacob Faibussowitsch         PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
3949566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
395bafc1b83SMatthew G Knepley         if (!flg) break;
39663a3b9bcSJacob Faibussowitsch         PetscCheck(numFields <= 128, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot currently support %" PetscInt_FMT " > 128 fields", numFields);
3979566063dSJacob Faibussowitsch         PetscCall(DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]));
398bafc1b83SMatthew G Knepley         if (nfields == 1) {
3999566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField));
400bafc1b83SMatthew G Knepley         } else {
40163a3b9bcSJacob Faibussowitsch           PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
4029566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, splitname, compField));
4037287d2a3SDmitry Karpeev         }
4049566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&compField));
405bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
406bafc1b83SMatthew G Knepley           f = ifields[j];
4079566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4089566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
4097b62db95SJungho Lee         }
410bafc1b83SMatthew G Knepley       }
411bafc1b83SMatthew G Knepley       if (i == 0) {
412bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
4139566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[f], fields[f]));
4149566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4159566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
416bafc1b83SMatthew G Knepley         }
417bafc1b83SMatthew G Knepley       } else {
418*48a46eb9SPierre Jolivet         for (j = 0; j < numFields; j++) PetscCall(DMDestroy(dms + j));
4199566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4209566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(i, &dms));
4212fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
422bafc1b83SMatthew G Knepley       }
4239566063dSJacob Faibussowitsch       PetscCall(PetscFree(fieldNames));
4249566063dSJacob Faibussowitsch       PetscCall(PetscFree(fields));
425e7c4fc90SDmitry Karpeev       if (dms) {
4269566063dSJacob Faibussowitsch         PetscCall(PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n"));
427bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
4287287d2a3SDmitry Karpeev           const char *prefix;
4299566063dSJacob Faibussowitsch           PetscCall(PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp), &prefix));
4309566063dSJacob Faibussowitsch           PetscCall(PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix));
4319566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(ilink->ksp, dms[i]));
4329566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(ilink->ksp, PETSC_FALSE));
43395dbaa6fSMatthew G. Knepley           {
43495dbaa6fSMatthew G. Knepley             PetscErrorCode (*func)(KSP, Mat, Mat, void *);
43595dbaa6fSMatthew G. Knepley             void *ctx;
43695dbaa6fSMatthew G. Knepley 
4379566063dSJacob Faibussowitsch             PetscCall(DMKSPGetComputeOperators(pc->dm, &func, &ctx));
4389566063dSJacob Faibussowitsch             PetscCall(DMKSPSetComputeOperators(dms[i], func, ctx));
43995dbaa6fSMatthew G. Knepley           }
4409566063dSJacob Faibussowitsch           PetscCall(PetscObjectIncrementTabLevel((PetscObject)dms[i], (PetscObject)ilink->ksp, 0));
4419566063dSJacob Faibussowitsch           PetscCall(DMDestroy(&dms[i]));
4422fa5ba8aSJed Brown         }
4439566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4448b8307b2SJed Brown       }
44566ffff09SJed Brown     } else {
446521d7252SBarry Smith       if (jac->bs <= 0) {
447704ba839SBarry Smith         if (pc->pmat) {
4489566063dSJacob Faibussowitsch           PetscCall(MatGetBlockSize(pc->pmat, &jac->bs));
4492fa5cd67SKarl Rupp         } else jac->bs = 1;
450521d7252SBarry Smith       }
451d32f9abdSBarry Smith 
4527b752e3dSPatrick Sanan       if (jac->detect) {
4536ce1633cSBarry Smith         IS       zerodiags, rest;
4546ce1633cSBarry Smith         PetscInt nmin, nmax;
4556ce1633cSBarry Smith 
4569566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4577199da05SBarry Smith         if (jac->diag_use_amat) {
4589566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->mat, &zerodiags));
4597199da05SBarry Smith         } else {
4609566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->pmat, &zerodiags));
4617199da05SBarry Smith         }
4629566063dSJacob Faibussowitsch         PetscCall(ISComplement(zerodiags, nmin, nmax, &rest));
4639566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
4649566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", zerodiags));
4659566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&zerodiags));
4669566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
4673a062f41SBarry Smith       } else if (coupling) {
4683a062f41SBarry Smith         IS       coupling, rest;
4693a062f41SBarry Smith         PetscInt nmin, nmax;
4703a062f41SBarry Smith 
4719566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4727199da05SBarry Smith         if (jac->offdiag_use_amat) {
4739566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->mat, &coupling));
4747199da05SBarry Smith         } else {
4759566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->pmat, &coupling));
4767199da05SBarry Smith         }
4779566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc->mat), nmax - nmin, nmin, 1, &rest));
4789566063dSJacob Faibussowitsch         PetscCall(ISSetIdentity(rest));
4799566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
4809566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", coupling));
4819566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&coupling));
4829566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
4836ce1633cSBarry Smith       } else {
4849566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_default", &fieldsplit_default, NULL));
4857287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
486d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
487d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4889566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
4899566063dSJacob Faibussowitsch           if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
490d32f9abdSBarry Smith         }
4916dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
4929f001fe8SStefano Zampini           Mat       M = pc->pmat;
493f3b928b9SStefano Zampini           PetscBool isnest;
494f3b928b9SStefano Zampini 
4959566063dSJacob Faibussowitsch           PetscCall(PetscInfo(pc, "Using default splitting of fields\n"));
4969566063dSJacob Faibussowitsch           PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &isnest));
497f3b928b9SStefano Zampini           if (!isnest) {
4989f001fe8SStefano Zampini             M = pc->mat;
4999566063dSJacob Faibussowitsch             PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &isnest));
500f3b928b9SStefano Zampini           }
501f3b928b9SStefano Zampini           if (isnest) {
502f3b928b9SStefano Zampini             IS      *fields;
503f3b928b9SStefano Zampini             PetscInt nf;
504f3b928b9SStefano Zampini 
5059566063dSJacob Faibussowitsch             PetscCall(MatNestGetSize(M, &nf, NULL));
5069566063dSJacob Faibussowitsch             PetscCall(PetscMalloc1(nf, &fields));
5079566063dSJacob Faibussowitsch             PetscCall(MatNestGetISs(M, fields, NULL));
508*48a46eb9SPierre Jolivet             for (i = 0; i < nf; i++) PetscCall(PCFieldSplitSetIS(pc, NULL, fields[i]));
5099566063dSJacob Faibussowitsch             PetscCall(PetscFree(fields));
510f3b928b9SStefano Zampini           } else {
511db4c96c1SJed Brown             for (i = 0; i < jac->bs; i++) {
5126c924f48SJed Brown               char splitname[8];
51363a3b9bcSJacob Faibussowitsch               PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
5149566063dSJacob Faibussowitsch               PetscCall(PCFieldSplitSetFields(pc, splitname, 1, &i, &i));
51579416396SBarry Smith             }
5165d4c12cdSJungho Lee             jac->defaultsplit = PETSC_TRUE;
517521d7252SBarry Smith           }
51866ffff09SJed Brown         }
5196ce1633cSBarry Smith       }
520f3b928b9SStefano Zampini     }
521edf189efSBarry Smith   } else if (jac->nsplits == 1) {
522edf189efSBarry Smith     if (ilink->is) {
523edf189efSBarry Smith       IS       is2;
524edf189efSBarry Smith       PetscInt nmin, nmax;
525edf189efSBarry Smith 
5269566063dSJacob Faibussowitsch       PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
5279566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is, nmin, nmax, &is2));
5289566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetIS(pc, "1", is2));
5299566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is2));
53082f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Must provide at least two sets of fields to PCFieldSplit()");
531edf189efSBarry Smith   }
532d0af7cd3SBarry Smith 
53363a3b9bcSJacob Faibussowitsch   PetscCheck(jac->nsplits >= 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unhandled case, must have at least two fields, not %" PetscInt_FMT, jac->nsplits);
53469a612a9SBarry Smith   PetscFunctionReturn(0);
53569a612a9SBarry Smith }
53669a612a9SBarry Smith 
5379371c9d4SSatish Balay static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A, Mat B, Mat C, Mat *H, PetscReal gkbnu) {
538a51937d4SCarola Kruse   Mat       BT, T;
539de482cd7SCarola Kruse   PetscReal nrmT, nrmB;
540a51937d4SCarola Kruse 
541a51937d4SCarola Kruse   PetscFunctionBegin;
5429566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &T)); /* Test if augmented matrix is symmetric */
5439566063dSJacob Faibussowitsch   PetscCall(MatAXPY(T, -1.0, B, DIFFERENT_NONZERO_PATTERN));
5449566063dSJacob Faibussowitsch   PetscCall(MatNorm(T, NORM_1, &nrmT));
5459566063dSJacob Faibussowitsch   PetscCall(MatNorm(B, NORM_1, &nrmB));
546049d1499SBarry Smith   PetscCheck(nrmB <= 0 || nrmT / nrmB < PETSC_SMALL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix is not symmetric/hermitian, GKB is not applicable.");
547049d1499SBarry Smith 
548a51937d4SCarola Kruse   /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */
549a51937d4SCarola Kruse   /* setting N := 1/nu*I in [Ar13].                                                 */
5509566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(B, MAT_INITIAL_MATRIX, &BT));
5519566063dSJacob Faibussowitsch   PetscCall(MatMatMult(B, BT, MAT_INITIAL_MATRIX, PETSC_DEFAULT, H)); /* H = A01*A01'          */
5529566063dSJacob Faibussowitsch   PetscCall(MatAYPX(*H, gkbnu, A, DIFFERENT_NONZERO_PATTERN));        /* H = A00 + nu*A01*A01' */
553a51937d4SCarola Kruse 
5549566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&BT));
5559566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&T));
556a51937d4SCarola Kruse   PetscFunctionReturn(0);
557a51937d4SCarola Kruse }
558a51937d4SCarola Kruse 
5592d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions, const char pre[], const char name[], const char *value[], PetscBool *flg);
560514bf10dSMatthew G Knepley 
5619371c9d4SSatish Balay static PetscErrorCode PCSetUp_FieldSplit(PC pc) {
56269a612a9SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
5635a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
5642c9966d7SBarry Smith   PetscInt          i, nsplit;
5655f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
56669a612a9SBarry Smith 
56769a612a9SBarry Smith   PetscFunctionBegin;
5685da88fe4STristan Konolige   pc->failedreason = PC_NOERROR;
5699566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDefaults(pc));
57097bbdb24SBarry Smith   nsplit = jac->nsplits;
5715a9f2f41SSatish Balay   ilink  = jac->head;
57297bbdb24SBarry Smith 
57397bbdb24SBarry Smith   /* get the matrices for each split */
574704ba839SBarry Smith   if (!jac->issetup) {
5751b9fc7fcSBarry Smith     PetscInt rstart, rend, nslots, bs;
57697bbdb24SBarry Smith 
577704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
578704ba839SBarry Smith 
5795d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
5802c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
5812c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
5822c9966d7SBarry Smith     }
58351f519a2SBarry Smith     bs = jac->bs;
5849566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRange(pc->pmat, &rstart, &rend));
5851b9fc7fcSBarry Smith     nslots = (rend - rstart) / bs;
5861b9fc7fcSBarry Smith     for (i = 0; i < nsplit; i++) {
5871b9fc7fcSBarry Smith       if (jac->defaultsplit) {
5889566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + i, nsplit, &ilink->is));
5899566063dSJacob Faibussowitsch         PetscCall(ISDuplicate(ilink->is, &ilink->is_col));
590704ba839SBarry Smith       } else if (!ilink->is) {
591ccb205f8SBarry Smith         if (ilink->nfields > 1) {
5925f4ab4e1SJungho Lee           PetscInt *ii, *jj, j, k, nfields = ilink->nfields, *fields = ilink->fields, *fields_col = ilink->fields_col;
5939566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(ilink->nfields * nslots, &ii));
5949566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(ilink->nfields * nslots, &jj));
5951b9fc7fcSBarry Smith           for (j = 0; j < nslots; j++) {
5961b9fc7fcSBarry Smith             for (k = 0; k < nfields; k++) {
5971b9fc7fcSBarry Smith               ii[nfields * j + k] = rstart + bs * j + fields[k];
5985f4ab4e1SJungho Lee               jj[nfields * j + k] = rstart + bs * j + fields_col[k];
59997bbdb24SBarry Smith             }
60097bbdb24SBarry Smith           }
6019566063dSJacob Faibussowitsch           PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, ii, PETSC_OWN_POINTER, &ilink->is));
6029566063dSJacob Faibussowitsch           PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, jj, PETSC_OWN_POINTER, &ilink->is_col));
6039566063dSJacob Faibussowitsch           PetscCall(ISSetBlockSize(ilink->is, nfields));
6049566063dSJacob Faibussowitsch           PetscCall(ISSetBlockSize(ilink->is_col, nfields));
605ccb205f8SBarry Smith         } else {
6069566063dSJacob Faibussowitsch           PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields[0], bs, &ilink->is));
6079566063dSJacob Faibussowitsch           PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields_col[0], bs, &ilink->is_col));
608ccb205f8SBarry Smith         }
6093e197d65SBarry Smith       }
6109566063dSJacob Faibussowitsch       PetscCall(ISSorted(ilink->is, &sorted));
6119566063dSJacob Faibussowitsch       if (ilink->is_col) PetscCall(ISSorted(ilink->is_col, &sorted_col));
6127827d75bSBarry Smith       PetscCheck(sorted && sorted_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Fields must be sorted when creating split");
613704ba839SBarry Smith       ilink = ilink->next;
6141b9fc7fcSBarry Smith     }
6151b9fc7fcSBarry Smith   }
6161b9fc7fcSBarry Smith 
617704ba839SBarry Smith   ilink = jac->head;
61897bbdb24SBarry Smith   if (!jac->pmat) {
619bdddcaaaSMatthew G Knepley     Vec xtmp;
620bdddcaaaSMatthew G Knepley 
6219566063dSJacob Faibussowitsch     PetscCall(MatCreateVecs(pc->pmat, &xtmp, NULL));
6229566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nsplit, &jac->pmat));
6239566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nsplit, &jac->x, nsplit, &jac->y));
624cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
625bdddcaaaSMatthew G Knepley       MatNullSpace sp;
626bdddcaaaSMatthew G Knepley 
627a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
6289566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&jac->pmat[i]));
629a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
6309566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->pmat[i]));
631a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
632a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
6332fa5cd67SKarl Rupp 
6349566063dSJacob Faibussowitsch           PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
635a3df900dSMatthew G Knepley         }
636a3df900dSMatthew G Knepley       } else {
6373a062f41SBarry Smith         const char *prefix;
6389566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->pmat[i]));
6399566063dSJacob Faibussowitsch         PetscCall(KSPGetOptionsPrefix(ilink->ksp, &prefix));
6409566063dSJacob Faibussowitsch         PetscCall(MatSetOptionsPrefix(jac->pmat[i], prefix));
6419566063dSJacob Faibussowitsch         PetscCall(MatViewFromOptions(jac->pmat[i], NULL, "-mat_view"));
642a3df900dSMatthew G Knepley       }
643bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
6449566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(jac->pmat[i], &jac->x[i], &jac->y[i]));
6459371c9d4SSatish Balay       ilink->x = jac->x[i];
6469371c9d4SSatish Balay       ilink->y = jac->y[i];
6479371c9d4SSatish Balay       ilink->z = NULL;
648bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
6499566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(xtmp, ilink->is, jac->x[i], NULL, &ilink->sctx));
6509566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nearnullspace", (PetscObject *)&sp));
651*48a46eb9SPierre Jolivet       if (sp) PetscCall(MatSetNearNullSpace(jac->pmat[i], sp));
652704ba839SBarry Smith       ilink = ilink->next;
653cf502942SBarry Smith     }
6549566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&xtmp));
65597bbdb24SBarry Smith   } else {
656ef7efd37SHong Zhang     MatReuse scall;
657ef7efd37SHong Zhang     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
658*48a46eb9SPierre Jolivet       for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->pmat[i]));
659ef7efd37SHong Zhang       scall = MAT_INITIAL_MATRIX;
660ef7efd37SHong Zhang     } else scall = MAT_REUSE_MATRIX;
661ef7efd37SHong Zhang 
662cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
663a3df900dSMatthew G Knepley       Mat pmat;
664a3df900dSMatthew G Knepley 
665a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
6669566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&pmat));
667*48a46eb9SPierre Jolivet       if (!pmat) PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, scall, &jac->pmat[i]));
668704ba839SBarry Smith       ilink = ilink->next;
669cf502942SBarry Smith     }
67097bbdb24SBarry Smith   }
6714e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
672519d70e2SJed Brown     ilink = jac->head;
673519d70e2SJed Brown     if (!jac->mat) {
6749566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nsplit, &jac->mat));
675519d70e2SJed Brown       for (i = 0; i < nsplit; i++) {
6769566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->mat[i]));
677519d70e2SJed Brown         ilink = ilink->next;
678519d70e2SJed Brown       }
679519d70e2SJed Brown     } else {
680ef7efd37SHong Zhang       MatReuse scall;
681ef7efd37SHong Zhang       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
682*48a46eb9SPierre Jolivet         for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->mat[i]));
683ef7efd37SHong Zhang         scall = MAT_INITIAL_MATRIX;
684ef7efd37SHong Zhang       } else scall = MAT_REUSE_MATRIX;
685ef7efd37SHong Zhang 
686ef7efd37SHong Zhang       for (i = 0; i < nsplit; i++) {
6879566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, scall, &jac->mat[i]));
688519d70e2SJed Brown         ilink = ilink->next;
689519d70e2SJed Brown       }
690519d70e2SJed Brown     }
691519d70e2SJed Brown   } else {
692519d70e2SJed Brown     jac->mat = jac->pmat;
693519d70e2SJed Brown   }
69497bbdb24SBarry Smith 
69553935eafSBarry Smith   /* Check for null space attached to IS */
69653935eafSBarry Smith   ilink = jac->head;
69753935eafSBarry Smith   for (i = 0; i < nsplit; i++) {
69853935eafSBarry Smith     MatNullSpace sp;
69953935eafSBarry Smith 
7009566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nullspace", (PetscObject *)&sp));
701*48a46eb9SPierre Jolivet     if (sp) PetscCall(MatSetNullSpace(jac->mat[i], sp));
70253935eafSBarry Smith     ilink = ilink->next;
70353935eafSBarry Smith   }
70453935eafSBarry Smith 
705a51937d4SCarola Kruse   if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) {
70668dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
7074e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
70868dd23aaSBarry Smith     ilink = jac->head;
709e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
710e52d2c62SBarry Smith       /* special case need where Afield[0] is not needed and only certain columns of Afield[1] are needed since update is only on those rows of the solution */
711e52d2c62SBarry Smith       if (!jac->Afield) {
7129566063dSJacob Faibussowitsch         PetscCall(PetscCalloc1(nsplit, &jac->Afield));
71380c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7149566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
715e52d2c62SBarry Smith         } else {
7169566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
71780c96bb1SFande Kong         }
71880c96bb1SFande Kong       } else {
719ef7efd37SHong Zhang         MatReuse scall;
720e9422dd5SStefano Zampini 
721ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7229566063dSJacob Faibussowitsch           PetscCall(MatDestroy(&jac->Afield[1]));
723ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
724ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
725ef7efd37SHong Zhang 
72680c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7279566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
72880c96bb1SFande Kong         } else {
7299566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
73080c96bb1SFande Kong         }
731e52d2c62SBarry Smith       }
732e52d2c62SBarry Smith     } else {
73368dd23aaSBarry Smith       if (!jac->Afield) {
7349566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nsplit, &jac->Afield));
73568dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
73680c96bb1SFande Kong           if (jac->offdiag_use_amat) {
7379566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
73880c96bb1SFande Kong           } else {
7399566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
74080c96bb1SFande Kong           }
74168dd23aaSBarry Smith           ilink = ilink->next;
74268dd23aaSBarry Smith         }
74368dd23aaSBarry Smith       } else {
744ef7efd37SHong Zhang         MatReuse scall;
745ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
746*48a46eb9SPierre Jolivet           for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->Afield[i]));
747ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
748ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
749ef7efd37SHong Zhang 
75068dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
75180c96bb1SFande Kong           if (jac->offdiag_use_amat) {
7529566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, scall, &jac->Afield[i]));
75380c96bb1SFande Kong           } else {
7549566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, scall, &jac->Afield[i]));
75580c96bb1SFande Kong           }
75668dd23aaSBarry Smith           ilink = ilink->next;
75768dd23aaSBarry Smith         }
75868dd23aaSBarry Smith       }
75968dd23aaSBarry Smith     }
760e52d2c62SBarry Smith   }
76168dd23aaSBarry Smith 
7623b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
7633b224e63SBarry Smith     IS          ccis;
764b94d7dedSBarry Smith     PetscBool   isset, isspd;
7654aa3045dSJed Brown     PetscInt    rstart, rend;
766093c86ffSJed Brown     char        lscname[256];
767093c86ffSJed Brown     PetscObject LSC_L;
768ce94432eSBarry Smith 
76908401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use Schur complement preconditioner you must have exactly 2 fields");
77068dd23aaSBarry Smith 
771c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
772c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
773b94d7dedSBarry Smith       PetscCall(MatIsSPDKnown(pc->pmat, &isset, &isspd));
774b94d7dedSBarry Smith       jac->schurscale = (isset && isspd) ? 1.0 : -1.0;
775c096484dSStefano Zampini     }
776c096484dSStefano Zampini 
777e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
7789566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend));
779e6cab6aaSJed Brown 
7803b224e63SBarry Smith     if (jac->schur) {
7810298fd71SBarry Smith       KSP      kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
782e9422dd5SStefano Zampini       MatReuse scall;
783e9422dd5SStefano Zampini 
784e9422dd5SStefano Zampini       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
785e9422dd5SStefano Zampini         scall = MAT_INITIAL_MATRIX;
7869566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->B));
7879566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->C));
788e9422dd5SStefano Zampini       } else scall = MAT_REUSE_MATRIX;
789443836d0SMatthew G Knepley 
7909566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
7913b224e63SBarry Smith       ilink = jac->head;
7929566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
7934e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7949566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->B));
795c84da90fSDmitry Karpeev       } else {
7969566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->B));
797c84da90fSDmitry Karpeev       }
7989566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
7993b224e63SBarry Smith       ilink = ilink->next;
8009566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8014e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8029566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->C));
803c84da90fSDmitry Karpeev       } else {
8049566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->C));
805c84da90fSDmitry Karpeev       }
8069566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
8079566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementUpdateSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
808a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
8099566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->schurp));
8109566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
811a7476a74SDmitry Karpeev       }
812*48a46eb9SPierre Jolivet       if (kspA != kspInner) PetscCall(KSPSetOperators(kspA, jac->mat[0], jac->pmat[0]));
813*48a46eb9SPierre Jolivet       if (kspUpper != kspA) PetscCall(KSPSetOperators(kspUpper, jac->mat[0], jac->pmat[0]));
8149566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
8153b224e63SBarry Smith     } else {
816bafc1b83SMatthew G Knepley       const char  *Dprefix;
817470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
818514bf10dSMatthew G Knepley       char         schurtestoption[256];
819bdddcaaaSMatthew G Knepley       MatNullSpace sp;
820514bf10dSMatthew G Knepley       PetscBool    flg;
821686bed4dSStefano Zampini       KSP          kspt;
8223b224e63SBarry Smith 
823a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
8243b224e63SBarry Smith       ilink = jac->head;
8259566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8264e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8279566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
828c84da90fSDmitry Karpeev       } else {
8299566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
830c84da90fSDmitry Karpeev       }
8319566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
8323b224e63SBarry Smith       ilink = ilink->next;
8339566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8344e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8359566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
836c84da90fSDmitry Karpeev       } else {
8379566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
838c84da90fSDmitry Karpeev       }
8399566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
84020252d06SBarry Smith 
841f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
8429566063dSJacob Faibussowitsch       PetscCall(MatCreate(((PetscObject)jac->mat[0])->comm, &jac->schur));
8439566063dSJacob Faibussowitsch       PetscCall(MatSetType(jac->schur, MATSCHURCOMPLEMENT));
8449566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementSetSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
8459566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
8469566063dSJacob Faibussowitsch       PetscCall(MatSetOptionsPrefix(jac->schur, schurmatprefix));
8479566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspt));
8489566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(kspt, schurmatprefix));
849686bed4dSStefano Zampini 
850686bed4dSStefano Zampini       /* Note: this is not true in general */
8519566063dSJacob Faibussowitsch       PetscCall(MatGetNullSpace(jac->mat[1], &sp));
8521baa6e33SBarry Smith       if (sp) PetscCall(MatSetNullSpace(jac->schur, sp));
85320252d06SBarry Smith 
8549566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname));
8559566063dSJacob Faibussowitsch       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, &flg));
856514bf10dSMatthew G Knepley       if (flg) {
857514bf10dSMatthew G Knepley         DM  dmInner;
85821635b76SJed Brown         KSP kspInner;
859686bed4dSStefano Zampini         PC  pcInner;
86021635b76SJed Brown 
8619566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
8629566063dSJacob Faibussowitsch         PetscCall(KSPReset(kspInner));
8639566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(kspInner, jac->mat[0], jac->pmat[0]));
8649566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
86521635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
8669566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject)pc, 2));
8679566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject)pc, 2));
8689566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(kspInner, schurprefix));
869514bf10dSMatthew G Knepley 
870514bf10dSMatthew G Knepley         /* Set DM for new solver */
8719566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
8729566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(kspInner, dmInner));
8739566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(kspInner, PETSC_FALSE));
874686bed4dSStefano Zampini 
875686bed4dSStefano Zampini         /* Defaults to PCKSP as preconditioner */
8769566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
8779566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcInner, PCKSP));
8789566063dSJacob Faibussowitsch         PetscCall(PCKSPSetKSP(pcInner, jac->head->ksp));
879514bf10dSMatthew G Knepley       } else {
88021635b76SJed Brown         /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
88121635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
88221635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
88321635b76SJed Brown           * S = D - C A_inner^{-1} B, we expect S to be defined using an accurate definition of A_inner^{-1}, so we make
88421635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
88521635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
8869566063dSJacob Faibussowitsch         PetscCall(KSPSetType(jac->head->ksp, KSPGMRES));
8879566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementSetKSP(jac->schur, jac->head->ksp));
888bafc1b83SMatthew G Knepley       }
8899566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->head->ksp, jac->mat[0], jac->pmat[0]));
8909566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->head->ksp));
8919566063dSJacob Faibussowitsch       PetscCall(MatSetFromOptions(jac->schur));
8923b224e63SBarry Smith 
8939566063dSJacob Faibussowitsch       PetscCall(PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg));
894686bed4dSStefano Zampini       if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */
895686bed4dSStefano Zampini         KSP kspInner;
896686bed4dSStefano Zampini         PC  pcInner;
897686bed4dSStefano Zampini 
8989566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
8999566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9009566063dSJacob Faibussowitsch         PetscCall(PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg));
901686bed4dSStefano Zampini         if (flg) {
902686bed4dSStefano Zampini           KSP ksp;
903686bed4dSStefano Zampini 
9049566063dSJacob Faibussowitsch           PetscCall(PCKSPGetKSP(pcInner, &ksp));
905*48a46eb9SPierre Jolivet           if (ksp == jac->head->ksp) PetscCall(PCSetUseAmat(pcInner, PETSC_TRUE));
906686bed4dSStefano Zampini         }
907686bed4dSStefano Zampini       }
9089566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname));
9099566063dSJacob Faibussowitsch       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, &flg));
910443836d0SMatthew G Knepley       if (flg) {
911443836d0SMatthew G Knepley         DM dmInner;
912443836d0SMatthew G Knepley 
9139566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
9149566063dSJacob Faibussowitsch         PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper));
9159566063dSJacob Faibussowitsch         PetscCall(KSPSetErrorIfNotConverged(jac->kspupper, pc->erroriffailure));
9169566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(jac->kspupper, schurprefix));
9179566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject)pc, 1));
9189566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject)pc, 1));
9199566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
9209566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(jac->kspupper, dmInner));
9219566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(jac->kspupper, PETSC_FALSE));
9229566063dSJacob Faibussowitsch         PetscCall(KSPSetFromOptions(jac->kspupper));
9239566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(jac->kspupper, jac->mat[0], jac->pmat[0]));
9249566063dSJacob Faibussowitsch         PetscCall(VecDuplicate(jac->head->x, &jac->head->z));
925443836d0SMatthew G Knepley       } else {
926443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
9279566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->head->ksp));
928443836d0SMatthew G Knepley       }
929443836d0SMatthew G Knepley 
930*48a46eb9SPierre Jolivet       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
9319566063dSJacob Faibussowitsch       PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspschur));
9329566063dSJacob Faibussowitsch       PetscCall(KSPSetErrorIfNotConverged(jac->kspschur, pc->erroriffailure));
9339566063dSJacob Faibussowitsch       PetscCall(PetscLogObjectParent((PetscObject)pc, (PetscObject)jac->kspschur));
9349566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspschur, (PetscObject)pc, 1));
935084e4875SJed Brown       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
9367233a360SDmitry Karpeev         PC pcschur;
9379566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(jac->kspschur, &pcschur));
9389566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcschur, PCNONE));
939084e4875SJed Brown         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
940e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
9419566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
942e69d4d44SBarry Smith       }
9439566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
9449566063dSJacob Faibussowitsch       PetscCall(KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix));
9459566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(jac->kspschur, Dprefix));
946c096484dSStefano Zampini       /* propagate DM */
947b20b4189SMatthew G. Knepley       {
948b20b4189SMatthew G. Knepley         DM sdm;
9499566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->next->ksp, &sdm));
950b20b4189SMatthew G. Knepley         if (sdm) {
9519566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(jac->kspschur, sdm));
9529566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(jac->kspschur, PETSC_FALSE));
953b20b4189SMatthew G. Knepley         }
954b20b4189SMatthew G. Knepley       }
9553b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
95620b26d62SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
9579566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->kspschur));
9583b224e63SBarry Smith     }
9599566063dSJacob Faibussowitsch     PetscCall(MatAssemblyBegin(jac->schur, MAT_FINAL_ASSEMBLY));
9609566063dSJacob Faibussowitsch     PetscCall(MatAssemblyEnd(jac->schur, MAT_FINAL_ASSEMBLY));
961093c86ffSJed Brown 
962093c86ffSJed Brown     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
9639566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_L", ilink->splitname));
9649566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L));
9659566063dSJacob Faibussowitsch     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L));
9669566063dSJacob Faibussowitsch     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_L", (PetscObject)LSC_L));
9679566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_Lp", ilink->splitname));
9689566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L));
9699566063dSJacob Faibussowitsch     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L));
9709566063dSJacob Faibussowitsch     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_Lp", (PetscObject)LSC_L));
971a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
972a51937d4SCarola Kruse     IS       ccis;
973a51937d4SCarola Kruse     PetscInt rstart, rend;
974a51937d4SCarola Kruse 
97508401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use GKB preconditioner you must have exactly 2 fields");
976a51937d4SCarola Kruse 
977a51937d4SCarola Kruse     ilink = jac->head;
978a51937d4SCarola Kruse 
979a51937d4SCarola Kruse     /* When extracting off-diagonal submatrices, we take complements from this range */
9809566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend));
981a51937d4SCarola Kruse 
9829566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
983a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
9849566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
985a51937d4SCarola Kruse     } else {
9869566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
987a51937d4SCarola Kruse     }
9889566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ccis));
989e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
9909566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->u));
9919566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->Hu));
9929566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w2));
993a51937d4SCarola Kruse     ilink = ilink->next;
9949566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
995a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
9969566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
997a51937d4SCarola Kruse     } else {
9989566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
999a51937d4SCarola Kruse     }
10009566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ccis));
1001e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
10029566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->v));
10039566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->d));
10049566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w1));
10059566063dSJacob Faibussowitsch     PetscCall(MatGolubKahanComputeExplicitOperator(jac->mat[0], jac->B, jac->C, &jac->H, jac->gkbnu));
10069566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(jac->gkbdelay, &jac->vecz));
1007e071a0a4SCarola Kruse 
1008a51937d4SCarola Kruse     ilink = jac->head;
10099566063dSJacob Faibussowitsch     PetscCall(KSPSetOperators(ilink->ksp, jac->H, jac->H));
10109566063dSJacob Faibussowitsch     if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
1011e071a0a4SCarola Kruse     /* Create gkb_monitor context */
1012de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1013de482cd7SCarola Kruse       PetscInt tablevel;
10149566063dSJacob Faibussowitsch       PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &jac->gkbviewer));
10159566063dSJacob Faibussowitsch       PetscCall(PetscViewerSetType(jac->gkbviewer, PETSCVIEWERASCII));
10169566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetTabLevel((PetscObject)ilink->ksp, &tablevel));
10179566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISetTab(jac->gkbviewer, tablevel));
10189566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)ilink->ksp, 1));
1019de482cd7SCarola Kruse     }
10203b224e63SBarry Smith   } else {
102168bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
102297bbdb24SBarry Smith     i     = 0;
10235a9f2f41SSatish Balay     ilink = jac->head;
10245a9f2f41SSatish Balay     while (ilink) {
10259566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(ilink->ksp, jac->mat[i], jac->pmat[i]));
10263b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
10279566063dSJacob Faibussowitsch       if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
102897bbdb24SBarry Smith       i++;
10295a9f2f41SSatish Balay       ilink = ilink->next;
10300971522cSBarry Smith     }
10313b224e63SBarry Smith   }
10323b224e63SBarry Smith 
10335ddf11f8SNicolas Barnafi   /* Set coordinates to the sub PC objects whenever these are set */
10345ddf11f8SNicolas Barnafi   if (jac->coordinates_set) {
10355ddf11f8SNicolas Barnafi     PC pc_coords;
10365ddf11f8SNicolas Barnafi     if (jac->type == PC_COMPOSITE_SCHUR) {
10375ddf11f8SNicolas Barnafi       // Head is first block.
10389566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->head->ksp, &pc_coords));
10399566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->dim, jac->head->ndofs, jac->head->coords));
10405ddf11f8SNicolas Barnafi       // Second one is Schur block, but its KSP object is in kspschur.
10419566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->kspschur, &pc_coords));
10429566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->next->dim, jac->head->next->ndofs, jac->head->next->coords));
10435ddf11f8SNicolas Barnafi     } else if (jac->type == PC_COMPOSITE_GKB) {
10449566063dSJacob Faibussowitsch       PetscCall(PetscInfo(pc, "Warning: Setting coordinates does nothing for the GKB Fieldpslit preconditioner"));
10455ddf11f8SNicolas Barnafi     } else {
10465ddf11f8SNicolas Barnafi       ilink = jac->head;
10475ddf11f8SNicolas Barnafi       while (ilink) {
10489566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(ilink->ksp, &pc_coords));
10499566063dSJacob Faibussowitsch         PetscCall(PCSetCoordinates(pc_coords, ilink->dim, ilink->ndofs, ilink->coords));
10505ddf11f8SNicolas Barnafi         ilink = ilink->next;
10515ddf11f8SNicolas Barnafi       }
10525ddf11f8SNicolas Barnafi     }
10535ddf11f8SNicolas Barnafi   }
10545ddf11f8SNicolas Barnafi 
1055c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
10560971522cSBarry Smith   PetscFunctionReturn(0);
10570971522cSBarry Smith }
10580971522cSBarry Smith 
10595a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink, xx, yy) \
10609371c9d4SSatish Balay   (VecScatterBegin(ilink->sctx, xx, ilink->x, INSERT_VALUES, SCATTER_FORWARD) || VecScatterEnd(ilink->sctx, xx, ilink->x, INSERT_VALUES, SCATTER_FORWARD) || PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL) || \
10619371c9d4SSatish Balay    KSPSolve(ilink->ksp, ilink->x, ilink->y) || KSPCheckSolve(ilink->ksp, pc, ilink->y) || PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL) || VecScatterBegin(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE) || \
1062ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE))
106379416396SBarry Smith 
10649371c9d4SSatish Balay static PetscErrorCode PCApply_FieldSplit_Schur(PC pc, Vec x, Vec y) {
10653b224e63SBarry Smith   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
10663b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1067443836d0SMatthew G Knepley   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
10683b224e63SBarry Smith 
10693b224e63SBarry Smith   PetscFunctionBegin;
1070c5d2311dSJed Brown   switch (jac->schurfactorization) {
1071c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
1072a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
10739566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
10749566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
10759566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
10769566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
10779566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
10789566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
10799566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
10809566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
10819566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
10829566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
10839566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
10849566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
10859566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
10869566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->y, jac->schurscale));
10879566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
10889566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
10899566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1090c5d2311dSJed Brown     break;
1091c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
1092a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
10939566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
10949566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
10959566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
10969566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
10979566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
10989566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
10999566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
11009566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.));
11019566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11029566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11039566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11049566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11059566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11069566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
11079566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11089566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11099566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11109566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1111c5d2311dSJed Brown     break;
1112c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
1113a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
11149566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11159566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11169566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11179566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11189566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
11199371c9d4SSatish Balay     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11209371c9d4SSatish Balay     PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
11219566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkA->x, -1.));
11229566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
11239566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11249566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
11259566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11269566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11279566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11289566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11299566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11309566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11319566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1132c5d2311dSJed Brown     break;
1133c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
1134c238f8cdSStefano Zampini     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */
11359566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11369566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11379566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
11389566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspLower, ilinkA->x, ilinkA->y));
11399566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->y));
11409566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
11419566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
11429566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.0));
11439566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11449566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11453b224e63SBarry Smith 
11469566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11479566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11489566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
11499566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11509566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11513b224e63SBarry Smith 
1152443836d0SMatthew G Knepley     if (kspUpper == kspA) {
11539566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->y));
11549566063dSJacob Faibussowitsch       PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y));
11559566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11569566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11579566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11589566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
1159443836d0SMatthew G Knepley     } else {
11609566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11619566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11629566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11639566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
11649566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
11659566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspUpper, ilinkA->x, ilinkA->z));
11669566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->z));
11679566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
11689566063dSJacob Faibussowitsch       PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z));
1169443836d0SMatthew G Knepley     }
11709566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11719566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11729566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1173c5d2311dSJed Brown   }
11743b224e63SBarry Smith   PetscFunctionReturn(0);
11753b224e63SBarry Smith }
11763b224e63SBarry Smith 
11779371c9d4SSatish Balay static PetscErrorCode PCApply_FieldSplit(PC pc, Vec x, Vec y) {
11780971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
11795a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
1180939b8a20SBarry Smith   PetscInt          cnt, bs;
11810971522cSBarry Smith 
11820971522cSBarry Smith   PetscFunctionBegin;
118379416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
11841b9fc7fcSBarry Smith     if (jac->defaultsplit) {
11859566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
11862472a847SBarry Smith       PetscCheck(jac->bs <= 0 || bs == jac->bs, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Blocksize of x vector %" PetscInt_FMT " does not match fieldsplit blocksize %" PetscInt_FMT, bs, jac->bs);
11879566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
11882472a847SBarry Smith       PetscCheck(jac->bs <= 0 || bs == jac->bs, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Blocksize of y vector %" PetscInt_FMT " does not match fieldsplit blocksize %" PetscInt_FMT, bs, jac->bs);
11899566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
11905a9f2f41SSatish Balay       while (ilink) {
11919566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
11929566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
11939566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
11949566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
11955a9f2f41SSatish Balay         ilink = ilink->next;
11960971522cSBarry Smith       }
11979566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
11981b9fc7fcSBarry Smith     } else {
11999566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
12005a9f2f41SSatish Balay       while (ilink) {
12019566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
12025a9f2f41SSatish Balay         ilink = ilink->next;
12031b9fc7fcSBarry Smith       }
12041b9fc7fcSBarry Smith     }
1205e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
12069566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1207e52d2c62SBarry Smith     /* solve on first block for first block variables */
12089566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
12099566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
12109566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12119566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
12129566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
12139566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12149566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
12159566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
1216e52d2c62SBarry Smith 
1217e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
12189566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->Afield[1], ilink->y, ilink->next->x));
1219e52d2c62SBarry Smith     ilink = ilink->next;
12209566063dSJacob Faibussowitsch     PetscCall(VecScale(ilink->x, -1.0));
12219566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
12229566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
1223e52d2c62SBarry Smith 
1224e52d2c62SBarry Smith     /* solve on second block variables */
12259566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12269566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
12279566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
12289566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12299566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
12309566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
123116913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
123279416396SBarry Smith     if (!jac->w1) {
12339566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
12349566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
123579416396SBarry Smith     }
12369566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
12379566063dSJacob Faibussowitsch     PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
12383e197d65SBarry Smith     cnt = 1;
12395a9f2f41SSatish Balay     while (ilink->next) {
12405a9f2f41SSatish Balay       ilink = ilink->next;
12413e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
12429566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->Afield[cnt++], y, ilink->x));
12439566063dSJacob Faibussowitsch       PetscCall(VecScale(ilink->x, -1.0));
12449566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
12459566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
12469566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12479566063dSJacob Faibussowitsch       PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
12489566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
12499566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12509566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
12519566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
12523e197d65SBarry Smith     }
125351f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
125411755939SBarry Smith       cnt -= 2;
125551f519a2SBarry Smith       while (ilink->previous) {
125651f519a2SBarry Smith         ilink = ilink->previous;
125711755939SBarry Smith         /* compute the residual only over the part of the vector needed */
12589566063dSJacob Faibussowitsch         PetscCall(MatMult(jac->Afield[cnt--], y, ilink->x));
12599566063dSJacob Faibussowitsch         PetscCall(VecScale(ilink->x, -1.0));
12609566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
12619566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
12629566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12639566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
12649566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
12659566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12669566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
12679566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
126851f519a2SBarry Smith       }
126911755939SBarry Smith     }
127063a3b9bcSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Unsupported or unknown composition %d", (int)jac->type);
12710971522cSBarry Smith   PetscFunctionReturn(0);
12720971522cSBarry Smith }
12730971522cSBarry Smith 
12749371c9d4SSatish Balay static PetscErrorCode PCApply_FieldSplit_GKB(PC pc, Vec x, Vec y) {
1275a51937d4SCarola Kruse   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
1276a51937d4SCarola Kruse   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1277a51937d4SCarola Kruse   KSP               ksp = ilinkA->ksp;
1278de482cd7SCarola Kruse   Vec               u, v, Hu, d, work1, work2;
1279e071a0a4SCarola Kruse   PetscScalar       alpha, z, nrmz2, *vecz;
1280e071a0a4SCarola Kruse   PetscReal         lowbnd, nu, beta;
1281a51937d4SCarola Kruse   PetscInt          j, iterGKB;
1282a51937d4SCarola Kruse 
1283a51937d4SCarola Kruse   PetscFunctionBegin;
12849566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12859566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12869566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12879566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
1288e071a0a4SCarola Kruse 
1289e071a0a4SCarola Kruse   u     = jac->u;
1290e071a0a4SCarola Kruse   v     = jac->v;
1291e071a0a4SCarola Kruse   Hu    = jac->Hu;
1292e071a0a4SCarola Kruse   d     = jac->d;
1293e071a0a4SCarola Kruse   work1 = jac->w1;
1294e071a0a4SCarola Kruse   work2 = jac->w2;
1295e071a0a4SCarola Kruse   vecz  = jac->vecz;
1296a51937d4SCarola Kruse 
1297a51937d4SCarola Kruse   /* Change RHS to comply with matrix regularization H = A + nu*B*B' */
1298a51937d4SCarola Kruse   /* Add q = q + nu*B*b */
1299a51937d4SCarola Kruse   if (jac->gkbnu) {
1300a51937d4SCarola Kruse     nu = jac->gkbnu;
13019566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, jac->gkbnu));
13029566063dSJacob Faibussowitsch     PetscCall(MatMultAdd(jac->B, ilinkD->x, ilinkA->x, ilinkA->x)); /* q = q + nu*B*b */
1303a51937d4SCarola Kruse   } else {
1304a51937d4SCarola Kruse     /* Situation when no augmented Lagrangian is used. Then we set inner  */
1305a51937d4SCarola Kruse     /* matrix N = I in [Ar13], and thus nu = 1.                           */
1306a51937d4SCarola Kruse     nu = 1;
1307a51937d4SCarola Kruse   }
1308a51937d4SCarola Kruse 
1309a51937d4SCarola Kruse   /* Transform rhs from [q,tilde{b}] to [0,b] */
13109566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
13119566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, ilinkA->x, ilinkA->y));
13129566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, ilinkA->y));
13139566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
13149566063dSJacob Faibussowitsch   PetscCall(MatMultHermitianTranspose(jac->B, ilinkA->y, work1));
13159566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(work1, 1.0 / nu, -1.0, ilinkD->x)); /* c = b - B'*x        */
1316a51937d4SCarola Kruse 
1317a51937d4SCarola Kruse   /* First step of algorithm */
13189566063dSJacob Faibussowitsch   PetscCall(VecNorm(work1, NORM_2, &beta)); /* beta = sqrt(nu*c'*c)*/
1319e071a0a4SCarola Kruse   KSPCheckDot(ksp, beta);
1320addd1e01SJunchao Zhang   beta = PetscSqrtReal(nu) * beta;
13219566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(v, nu / beta, 0.0, work1)); /* v = nu/beta *c      */
13229566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->B, v, work2));          /* u = H^{-1}*B*v      */
13239566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
13249566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, work2, u));
13259566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, u));
13269566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
13279566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u      */
13289566063dSJacob Faibussowitsch   PetscCall(VecDot(Hu, u, &alpha));
1329e071a0a4SCarola Kruse   KSPCheckDot(ksp, alpha);
133008401ef6SPierre Jolivet   PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1331addd1e01SJunchao Zhang   alpha = PetscSqrtReal(PetscAbsScalar(alpha));
13329566063dSJacob Faibussowitsch   PetscCall(VecScale(u, 1.0 / alpha));
13339566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(d, 1.0 / alpha, 0.0, v)); /* v = nu/beta *c      */
1334de482cd7SCarola Kruse 
1335a51937d4SCarola Kruse   z       = beta / alpha;
1336a51937d4SCarola Kruse   vecz[1] = z;
1337a51937d4SCarola Kruse 
1338de482cd7SCarola Kruse   /* Computation of first iterate x(1) and p(1) */
13399566063dSJacob Faibussowitsch   PetscCall(VecAXPY(ilinkA->y, z, u));
13409566063dSJacob Faibussowitsch   PetscCall(VecCopy(d, ilinkD->y));
13419566063dSJacob Faibussowitsch   PetscCall(VecScale(ilinkD->y, -z));
1342a51937d4SCarola Kruse 
13439371c9d4SSatish Balay   iterGKB = 1;
13449371c9d4SSatish Balay   lowbnd  = 2 * jac->gkbtol;
1345*48a46eb9SPierre Jolivet   if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1346de482cd7SCarola Kruse 
1347a51937d4SCarola Kruse   while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) {
1348a51937d4SCarola Kruse     iterGKB += 1;
13499566063dSJacob Faibussowitsch     PetscCall(MatMultHermitianTranspose(jac->B, u, work1)); /* v <- nu*(B'*u-alpha/nu*v) */
13509566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(v, nu, -alpha, work1));
13519566063dSJacob Faibussowitsch     PetscCall(VecNorm(v, NORM_2, &beta)); /* beta = sqrt(nu)*v'*v      */
1352addd1e01SJunchao Zhang     beta = beta / PetscSqrtReal(nu);
13539566063dSJacob Faibussowitsch     PetscCall(VecScale(v, 1.0 / beta));
13549566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->B, v, work2)); /* u <- H^{-1}*(B*v-beta*H*u) */
13559566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu));
13569566063dSJacob Faibussowitsch     PetscCall(VecAXPY(work2, -beta, Hu));
13579566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
13589566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ksp, work2, u));
13599566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ksp, pc, u));
13609566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
13619566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u            */
13629566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, u, &alpha));
1363e071a0a4SCarola Kruse     KSPCheckDot(ksp, alpha);
136408401ef6SPierre Jolivet     PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1365addd1e01SJunchao Zhang     alpha = PetscSqrtReal(PetscAbsScalar(alpha));
13669566063dSJacob Faibussowitsch     PetscCall(VecScale(u, 1.0 / alpha));
1367a51937d4SCarola Kruse 
1368e071a0a4SCarola Kruse     z       = -beta / alpha * z; /* z <- beta/alpha*z     */
1369a51937d4SCarola Kruse     vecz[0] = z;
1370a51937d4SCarola Kruse 
1371a51937d4SCarola Kruse     /* Computation of new iterate x(i+1) and p(i+1) */
13729566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(d, 1.0 / alpha, -beta / alpha, v)); /* d = (v-beta*d)/alpha */
13739566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkA->y, z, u));                   /* r = r + z*u          */
13749566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkD->y, -z, d));                  /* p = p - z*d          */
13759566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, ilinkA->y, Hu));             /* ||u||_H = u'*H*u     */
13769566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, ilinkA->y, &nrmz2));
1377a51937d4SCarola Kruse 
1378a51937d4SCarola Kruse     /* Compute Lower Bound estimate */
1379a51937d4SCarola Kruse     if (iterGKB > jac->gkbdelay) {
1380a51937d4SCarola Kruse       lowbnd = 0.0;
13819371c9d4SSatish Balay       for (j = 0; j < jac->gkbdelay; j++) { lowbnd += PetscAbsScalar(vecz[j] * vecz[j]); }
1382addd1e01SJunchao Zhang       lowbnd = PetscSqrtReal(lowbnd / PetscAbsScalar(nrmz2));
1383a51937d4SCarola Kruse     }
1384a51937d4SCarola Kruse 
13859371c9d4SSatish Balay     for (j = 0; j < jac->gkbdelay - 1; j++) { vecz[jac->gkbdelay - j - 1] = vecz[jac->gkbdelay - j - 2]; }
1386*48a46eb9SPierre Jolivet     if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1387a51937d4SCarola Kruse   }
1388a51937d4SCarola Kruse 
13899566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13909566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13919566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13929566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1393a51937d4SCarola Kruse 
1394a51937d4SCarola Kruse   PetscFunctionReturn(0);
1395a51937d4SCarola Kruse }
1396a51937d4SCarola Kruse 
1397421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink, xx, yy) \
13989371c9d4SSatish Balay   (VecScatterBegin(ilink->sctx, xx, ilink->y, INSERT_VALUES, SCATTER_FORWARD) || VecScatterEnd(ilink->sctx, xx, ilink->y, INSERT_VALUES, SCATTER_FORWARD) || PetscLogEventBegin(ilink->event, ilink->ksp, ilink->y, ilink->x, NULL) || \
13999371c9d4SSatish Balay    KSPSolveTranspose(ilink->ksp, ilink->y, ilink->x) || KSPCheckSolve(ilink->ksp, pc, ilink->x) || PetscLogEventEnd(ilink->event, ilink->ksp, ilink->y, ilink->x, NULL) || VecScatterBegin(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE) || \
1400ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE))
1401421e10b8SBarry Smith 
14029371c9d4SSatish Balay static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc, Vec x, Vec y) {
1403421e10b8SBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
1404421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1405939b8a20SBarry Smith   PetscInt          bs;
1406421e10b8SBarry Smith 
1407421e10b8SBarry Smith   PetscFunctionBegin;
1408421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1409421e10b8SBarry Smith     if (jac->defaultsplit) {
14109566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
14112472a847SBarry Smith       PetscCheck(jac->bs <= 0 || bs == jac->bs, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Blocksize of x vector %" PetscInt_FMT " does not match fieldsplit blocksize %" PetscInt_FMT, bs, jac->bs);
14129566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
14132472a847SBarry Smith       PetscCheck(jac->bs <= 0 || bs == jac->bs, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Blocksize of y vector %" PetscInt_FMT " does not match fieldsplit blocksize %" PetscInt_FMT, bs, jac->bs);
14149566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
1415421e10b8SBarry Smith       while (ilink) {
14169566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14179566063dSJacob Faibussowitsch         PetscCall(KSPSolveTranspose(ilink->ksp, ilink->x, ilink->y));
14189566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14199566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
1420421e10b8SBarry Smith         ilink = ilink->next;
1421421e10b8SBarry Smith       }
14229566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
1423421e10b8SBarry Smith     } else {
14249566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
1425421e10b8SBarry Smith       while (ilink) {
14269566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1427421e10b8SBarry Smith         ilink = ilink->next;
1428421e10b8SBarry Smith       }
1429421e10b8SBarry Smith     }
1430421e10b8SBarry Smith   } else {
1431421e10b8SBarry Smith     if (!jac->w1) {
14329566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
14339566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
1434421e10b8SBarry Smith     }
14359566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1436421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
14379566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1438421e10b8SBarry Smith       while (ilink->next) {
1439421e10b8SBarry Smith         ilink = ilink->next;
14409566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
14419566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
14429566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1443421e10b8SBarry Smith       }
1444421e10b8SBarry Smith       while (ilink->previous) {
1445421e10b8SBarry Smith         ilink = ilink->previous;
14469566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
14479566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
14489566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1449421e10b8SBarry Smith       }
1450421e10b8SBarry Smith     } else {
1451421e10b8SBarry Smith       while (ilink->next) { /* get to last entry in linked list */
1452421e10b8SBarry Smith         ilink = ilink->next;
1453421e10b8SBarry Smith       }
14549566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1455421e10b8SBarry Smith       while (ilink->previous) {
1456421e10b8SBarry Smith         ilink = ilink->previous;
14579566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
14589566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
14599566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1460421e10b8SBarry Smith       }
1461421e10b8SBarry Smith     }
1462421e10b8SBarry Smith   }
1463421e10b8SBarry Smith   PetscFunctionReturn(0);
1464421e10b8SBarry Smith }
1465421e10b8SBarry Smith 
14669371c9d4SSatish Balay static PetscErrorCode PCReset_FieldSplit(PC pc) {
14670971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
14685a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head, next;
14690971522cSBarry Smith 
14700971522cSBarry Smith   PetscFunctionBegin;
14715a9f2f41SSatish Balay   while (ilink) {
14729566063dSJacob Faibussowitsch     PetscCall(KSPDestroy(&ilink->ksp));
14739566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->x));
14749566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->y));
14759566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->z));
14769566063dSJacob Faibussowitsch     PetscCall(VecScatterDestroy(&ilink->sctx));
14779566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
14789566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
14799566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->splitname));
14809566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields));
14819566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields_col));
14825a9f2f41SSatish Balay     next = ilink->next;
14839566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink));
14845a9f2f41SSatish Balay     ilink = next;
14850971522cSBarry Smith   }
1486f5f0d762SBarry Smith   jac->head = NULL;
14879566063dSJacob Faibussowitsch   PetscCall(PetscFree2(jac->x, jac->y));
1488574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
14899566063dSJacob Faibussowitsch     PetscCall(MatDestroyMatrices(jac->nsplits, &jac->mat));
1490574deadeSBarry Smith   } else if (jac->mat) {
14910298fd71SBarry Smith     jac->mat = NULL;
1492574deadeSBarry Smith   }
14939566063dSJacob Faibussowitsch   if (jac->pmat) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->pmat));
14949566063dSJacob Faibussowitsch   if (jac->Afield) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->Afield));
1495f5f0d762SBarry Smith   jac->nsplits = 0;
14969566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w1));
14979566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w2));
14989566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur));
14999566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schurp));
15009566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur_user));
15019566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspschur));
15029566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspupper));
15039566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->B));
15049566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->C));
15059566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->H));
15069566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->u));
15079566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->v));
15089566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->Hu));
15099566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->d));
15109566063dSJacob Faibussowitsch   PetscCall(PetscFree(jac->vecz));
15119566063dSJacob Faibussowitsch   PetscCall(PetscViewerDestroy(&jac->gkbviewer));
15126dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1513574deadeSBarry Smith   PetscFunctionReturn(0);
1514574deadeSBarry Smith }
1515574deadeSBarry Smith 
15169371c9d4SSatish Balay static PetscErrorCode PCDestroy_FieldSplit(PC pc) {
1517574deadeSBarry Smith   PetscFunctionBegin;
15189566063dSJacob Faibussowitsch   PetscCall(PCReset_FieldSplit(pc));
15199566063dSJacob Faibussowitsch   PetscCall(PetscFree(pc->data));
15202e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", NULL));
15219566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", NULL));
15229566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", NULL));
15239566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", NULL));
15249566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", NULL));
15252e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", NULL));
15262e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", NULL));
15272e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
15282e956fe4SStefano Zampini 
15292e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
15302e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
15312e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
15322e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
15332e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
15349566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
15359566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
15369566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
15372e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
15380971522cSBarry Smith   PetscFunctionReturn(0);
15390971522cSBarry Smith }
15400971522cSBarry Smith 
15419371c9d4SSatish Balay static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc, PetscOptionItems *PetscOptionsObject) {
15426c924f48SJed Brown   PetscInt        bs;
15437b752e3dSPatrick Sanan   PetscBool       flg;
15449dcbbd2bSBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit *)pc->data;
15453b224e63SBarry Smith   PCCompositeType ctype;
15461b9fc7fcSBarry Smith 
15470971522cSBarry Smith   PetscFunctionBegin;
1548d0609cedSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "FieldSplit options");
15499566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_dm_splits", "Whether to use DMCreateFieldDecomposition() for splits", "PCFieldSplitSetDMSplits", jac->dm_splits, &jac->dm_splits, NULL));
15509566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-pc_fieldsplit_block_size", "Blocksize that defines number of fields", "PCFieldSplitSetBlockSize", jac->bs, &bs, &flg));
15511baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetBlockSize(pc, bs));
15522686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
15539566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_diag_use_amat", "Use Amat (not Pmat) to extract diagonal fieldsplit blocks", "PCFieldSplitSetDiagUseAmat", jac->diag_use_amat, &jac->diag_use_amat, NULL));
15542686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
15559566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_off_diag_use_amat", "Use Amat (not Pmat) to extract off-diagonal fieldsplit blocks", "PCFieldSplitSetOffDiagUseAmat", jac->offdiag_use_amat, &jac->offdiag_use_amat, NULL));
15569566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_detect_saddle_point", "Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint", jac->detect, &jac->detect, NULL));
15579566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDetectSaddlePoint(pc, jac->detect)); /* Sets split type and Schur PC type */
15589566063dSJacob Faibussowitsch   PetscCall(PetscOptionsEnum("-pc_fieldsplit_type", "Type of composition", "PCFieldSplitSetType", PCCompositeTypes, (PetscEnum)jac->type, (PetscEnum *)&ctype, &flg));
15591baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetType(pc, ctype));
1560c30613efSMatthew Knepley   /* Only setup fields once */
1561c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1562d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1563d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
15649566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
15659566063dSJacob Faibussowitsch     if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
1566d32f9abdSBarry Smith   }
1567c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
15689566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_schur_factorization_type", PCFieldSplitSchurFactTypes, (PetscEnum *)&jac->schurfactorization, &flg));
15699566063dSJacob Faibussowitsch     if (flg) PetscCall(PetscInfo(pc, "Deprecated use of -pc_fieldsplit_schur_factorization_type\n"));
15709566063dSJacob Faibussowitsch     PetscCall(PetscOptionsEnum("-pc_fieldsplit_schur_fact_type", "Which off-diagonal parts of the block factorization to use", "PCFieldSplitSetSchurFactType", PCFieldSplitSchurFactTypes, (PetscEnum)jac->schurfactorization, (PetscEnum *)&jac->schurfactorization, NULL));
15719566063dSJacob Faibussowitsch     PetscCall(PetscOptionsEnum("-pc_fieldsplit_schur_precondition", "How to build preconditioner for Schur complement", "PCFieldSplitSetSchurPre", PCFieldSplitSchurPreTypes, (PetscEnum)jac->schurpre, (PetscEnum *)&jac->schurpre, NULL));
15729566063dSJacob Faibussowitsch     PetscCall(PetscOptionsScalar("-pc_fieldsplit_schur_scale", "Scale Schur complement", "PCFieldSplitSetSchurScale", jac->schurscale, &jac->schurscale, NULL));
1573a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
15749566063dSJacob Faibussowitsch     PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_tol", "The tolerance for the lower bound stopping criterion", "PCFieldSplitGKBTol", jac->gkbtol, &jac->gkbtol, NULL));
15759566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_delay", "The delay value for lower bound criterion", "PCFieldSplitGKBDelay", jac->gkbdelay, &jac->gkbdelay, NULL));
15769566063dSJacob Faibussowitsch     PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_nu", "Parameter in augmented Lagrangian approach", "PCFieldSplitGKBNu", jac->gkbnu, &jac->gkbnu, NULL));
157763a3b9bcSJacob Faibussowitsch     PetscCheck(jac->gkbnu >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "nu cannot be less than 0: value %g", (double)jac->gkbnu);
15789566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_maxit", "Maximum allowed number of iterations", "PCFieldSplitGKBMaxit", jac->gkbmaxit, &jac->gkbmaxit, NULL));
15799566063dSJacob Faibussowitsch     PetscCall(PetscOptionsBool("-pc_fieldsplit_gkb_monitor", "Prints number of GKB iterations and error", "PCFieldSplitGKB", jac->gkbmonitor, &jac->gkbmonitor, NULL));
1580c5d2311dSJed Brown   }
158134603f55SBarry Smith   /*
158234603f55SBarry Smith     In the initial call to this routine the sub-solver data structures do not exist so we cannot call KSPSetFromOptions() on them yet.
158334603f55SBarry Smith     But after the initial setup of ALL the layers of sub-solvers is completed we do want to call KSPSetFromOptions() on the sub-solvers every time it
158434603f55SBarry Smith     is called on the outer solver in case changes were made in the options database
158534603f55SBarry Smith 
158634603f55SBarry Smith     But even after PCSetUp_FieldSplit() is called all the options inside the inner levels of sub-solvers may still not have been set thus we only call the KSPSetFromOptions()
158734603f55SBarry Smith     if we know that the entire stack of sub-solvers below this have been complete instantiated, we check this by seeing if any solver iterations are complete.
158834603f55SBarry Smith     Without this extra check test p2p1fetidp_olof_full and others fail with incorrect matrix types.
158934603f55SBarry Smith 
159034603f55SBarry Smith     There could be a negative side effect of calling the KSPSetFromOptions() below.
159134603f55SBarry Smith 
159234603f55SBarry Smith     If one captured the PetscObjectState of the options database one could skip these calls if the database has not changed from the previous call
159334603f55SBarry Smith   */
159434603f55SBarry Smith   if (jac->issetup) {
159534603f55SBarry Smith     PC_FieldSplitLink ilink = jac->head;
159634603f55SBarry Smith     if (jac->type == PC_COMPOSITE_SCHUR) {
159734603f55SBarry Smith       if (jac->kspupper && jac->kspupper->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspupper));
159834603f55SBarry Smith       if (jac->kspschur && jac->kspschur->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspschur));
159934603f55SBarry Smith     }
160034603f55SBarry Smith     while (ilink) {
160134603f55SBarry Smith       if (ilink->ksp->totalits > 0) PetscCall(KSPSetFromOptions(ilink->ksp));
160234603f55SBarry Smith       ilink = ilink->next;
160334603f55SBarry Smith     }
160434603f55SBarry Smith   }
1605d0609cedSBarry Smith   PetscOptionsHeadEnd();
16060971522cSBarry Smith   PetscFunctionReturn(0);
16070971522cSBarry Smith }
16080971522cSBarry Smith 
16090971522cSBarry Smith /*------------------------------------------------------------------------------------*/
16100971522cSBarry Smith 
16119371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col) {
161297bbdb24SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
16135a9f2f41SSatish Balay   PC_FieldSplitLink ilink, next = jac->head;
161469a612a9SBarry Smith   char              prefix[128];
16155d4c12cdSJungho Lee   PetscInt          i;
16160971522cSBarry Smith 
16170971522cSBarry Smith   PetscFunctionBegin;
16186c924f48SJed Brown   if (jac->splitdefined) {
16199566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
16206c924f48SJed Brown     PetscFunctionReturn(0);
16216c924f48SJed Brown   }
162251f519a2SBarry Smith   for (i = 0; i < n; i++) {
162363a3b9bcSJacob Faibussowitsch     PetscCheck(fields[i] < jac->bs, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", fields[i], jac->bs);
162463a3b9bcSJacob Faibussowitsch     PetscCheck(fields[i] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", fields[i]);
162551f519a2SBarry Smith   }
16269566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
1627a04f6461SBarry Smith   if (splitname) {
16289566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
1629a04f6461SBarry Smith   } else {
16309566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(3, &ilink->splitname));
163163a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 2, "%" PetscInt_FMT, jac->nsplits));
1632a04f6461SBarry Smith   }
16339df09d43SBarry Smith   ilink->event = jac->nsplits < 5 ? KSP_Solve_FS_0 + jac->nsplits : KSP_Solve_FS_0 + 4; /* Any split great than 4 gets logged in the 4th split */
16349566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields));
16359566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields, fields, n));
16369566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields_col));
16379566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields_col, fields_col, n));
16382fa5cd67SKarl Rupp 
16395a9f2f41SSatish Balay   ilink->nfields = n;
16400298fd71SBarry Smith   ilink->next    = NULL;
16419566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
16429566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
16439566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
16449566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
16459566063dSJacob Faibussowitsch   PetscCall(PetscLogObjectParent((PetscObject)pc, (PetscObject)ilink->ksp));
164669a612a9SBarry Smith 
16479566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
16489566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
16490971522cSBarry Smith 
16500971522cSBarry Smith   if (!next) {
16515a9f2f41SSatish Balay     jac->head       = ilink;
16520298fd71SBarry Smith     ilink->previous = NULL;
16530971522cSBarry Smith   } else {
16549371c9d4SSatish Balay     while (next->next) { next = next->next; }
16555a9f2f41SSatish Balay     next->next      = ilink;
165651f519a2SBarry Smith     ilink->previous = next;
16570971522cSBarry Smith   }
16580971522cSBarry Smith   jac->nsplits++;
16590971522cSBarry Smith   PetscFunctionReturn(0);
16600971522cSBarry Smith }
16610971522cSBarry Smith 
16629371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp) {
1663285fb4e2SStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1664285fb4e2SStefano Zampini 
1665285fb4e2SStefano Zampini   PetscFunctionBegin;
1666285fb4e2SStefano Zampini   *subksp = NULL;
1667285fb4e2SStefano Zampini   if (n) *n = 0;
1668285fb4e2SStefano Zampini   if (jac->type == PC_COMPOSITE_SCHUR) {
1669285fb4e2SStefano Zampini     PetscInt nn;
1670285fb4e2SStefano Zampini 
167128b400f6SJacob Faibussowitsch     PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()");
167263a3b9bcSJacob Faibussowitsch     PetscCheck(jac->nsplits == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unexpected number of splits %" PetscInt_FMT " != 2", jac->nsplits);
1673285fb4e2SStefano Zampini     nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0);
16749566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nn, subksp));
1675285fb4e2SStefano Zampini     (*subksp)[0] = jac->head->ksp;
1676285fb4e2SStefano Zampini     (*subksp)[1] = jac->kspschur;
1677285fb4e2SStefano Zampini     if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper;
1678285fb4e2SStefano Zampini     if (n) *n = nn;
1679285fb4e2SStefano Zampini   }
1680285fb4e2SStefano Zampini   PetscFunctionReturn(0);
1681285fb4e2SStefano Zampini }
1682285fb4e2SStefano Zampini 
16839371c9d4SSatish Balay static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc, PetscInt *n, KSP **subksp) {
1684e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1685e69d4d44SBarry Smith 
1686e69d4d44SBarry Smith   PetscFunctionBegin;
168728b400f6SJacob Faibussowitsch   PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
16889566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
16899566063dSJacob Faibussowitsch   PetscCall(MatSchurComplementGetKSP(jac->schur, *subksp));
16902fa5cd67SKarl Rupp 
1691e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
169213e0d083SBarry Smith   if (n) *n = jac->nsplits;
1693e69d4d44SBarry Smith   PetscFunctionReturn(0);
1694e69d4d44SBarry Smith }
16950971522cSBarry Smith 
16969371c9d4SSatish Balay static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp) {
16970971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
16980971522cSBarry Smith   PetscInt          cnt   = 0;
16995a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
17000971522cSBarry Smith 
17010971522cSBarry Smith   PetscFunctionBegin;
17029566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
17035a9f2f41SSatish Balay   while (ilink) {
17045a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
17055a9f2f41SSatish Balay     ilink            = ilink->next;
17060971522cSBarry Smith   }
170763a3b9bcSJacob Faibussowitsch   PetscCheck(cnt == jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Corrupt PCFIELDSPLIT object: number of splits in linked list %" PetscInt_FMT " does not match number in object %" PetscInt_FMT, cnt, jac->nsplits);
170813e0d083SBarry Smith   if (n) *n = jac->nsplits;
17090971522cSBarry Smith   PetscFunctionReturn(0);
17100971522cSBarry Smith }
17110971522cSBarry Smith 
17126dbb499eSCian Wilson /*@C
17136dbb499eSCian Wilson     PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS.
17146dbb499eSCian Wilson 
17156dbb499eSCian Wilson     Input Parameters:
17166dbb499eSCian Wilson +   pc  - the preconditioner context
1717a2b725a8SWilliam Gropp -   is - the index set that defines the indices to which the fieldsplit is to be restricted
17186dbb499eSCian Wilson 
17196dbb499eSCian Wilson     Level: advanced
17206dbb499eSCian Wilson 
17216dbb499eSCian Wilson @*/
17229371c9d4SSatish Balay PetscErrorCode PCFieldSplitRestrictIS(PC pc, IS isy) {
17236dbb499eSCian Wilson   PetscFunctionBegin;
17246dbb499eSCian Wilson   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
17256dbb499eSCian Wilson   PetscValidHeaderSpecific(isy, IS_CLASSID, 2);
1726cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitRestrictIS_C", (PC, IS), (pc, isy));
17276dbb499eSCian Wilson   PetscFunctionReturn(0);
17286dbb499eSCian Wilson }
17296dbb499eSCian Wilson 
17309371c9d4SSatish Balay static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy) {
17316dbb499eSCian Wilson   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
17326dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
17336dbb499eSCian Wilson   PetscInt          localsize, size, sizez, i;
17346dbb499eSCian Wilson   const PetscInt   *ind, *indz;
17356dbb499eSCian Wilson   PetscInt         *indc, *indcz;
17366dbb499eSCian Wilson   PetscBool         flg;
17376dbb499eSCian Wilson 
17386dbb499eSCian Wilson   PetscFunctionBegin;
17399566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(isy, &localsize));
17409566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&localsize, &size, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)isy)));
17416dbb499eSCian Wilson   size -= localsize;
17426dbb499eSCian Wilson   while (ilink) {
17436dbb499eSCian Wilson     IS isrl, isr;
17441c7cfba8SBarry Smith     PC subpc;
17459566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl));
17469566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(isrl, &localsize));
17479566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(localsize, &indc));
17489566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(isrl, &ind));
17499566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(indc, ind, localsize));
17509566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(isrl, &ind));
17519566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isrl));
17526dbb499eSCian Wilson     for (i = 0; i < localsize; i++) *(indc + i) += size;
17539566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)isy), localsize, indc, PETSC_OWN_POINTER, &isr));
17549566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
17559566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
17566dbb499eSCian Wilson     ilink->is = isr;
17579566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
17589566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
17596dbb499eSCian Wilson     ilink->is_col = isr;
17609566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isr));
17619566063dSJacob Faibussowitsch     PetscCall(KSPGetPC(ilink->ksp, &subpc));
17629566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)subpc, PCFIELDSPLIT, &flg));
17636dbb499eSCian Wilson     if (flg) {
17646dbb499eSCian Wilson       IS       iszl, isz;
17656dbb499eSCian Wilson       MPI_Comm comm;
17669566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(ilink->is, &localsize));
17676dbb499eSCian Wilson       comm = PetscObjectComm((PetscObject)ilink->is);
17689566063dSJacob Faibussowitsch       PetscCall(ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl));
17699566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Scan(&localsize, &sizez, 1, MPIU_INT, MPI_SUM, comm));
17706dbb499eSCian Wilson       sizez -= localsize;
17719566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(iszl, &localsize));
17729566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(localsize, &indcz));
17739566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(iszl, &indz));
17749566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(indcz, indz, localsize));
17759566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(iszl, &indz));
17769566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&iszl));
17776dbb499eSCian Wilson       for (i = 0; i < localsize; i++) *(indcz + i) += sizez;
17789566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(comm, localsize, indcz, PETSC_OWN_POINTER, &isz));
17799566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitRestrictIS(subpc, isz));
17809566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&isz));
17816dbb499eSCian Wilson     }
17826dbb499eSCian Wilson     next  = ilink->next;
17836dbb499eSCian Wilson     ilink = next;
17846dbb499eSCian Wilson   }
17856dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
17866dbb499eSCian Wilson   PetscFunctionReturn(0);
17876dbb499eSCian Wilson }
17886dbb499eSCian Wilson 
17899371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc, const char splitname[], IS is) {
1790704ba839SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
1791704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1792704ba839SBarry Smith   char              prefix[128];
1793704ba839SBarry Smith 
1794704ba839SBarry Smith   PetscFunctionBegin;
17956c924f48SJed Brown   if (jac->splitdefined) {
17969566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
17976c924f48SJed Brown     PetscFunctionReturn(0);
17986c924f48SJed Brown   }
17999566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
1800a04f6461SBarry Smith   if (splitname) {
18019566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
1802a04f6461SBarry Smith   } else {
18039566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(8, &ilink->splitname));
180463a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 7, "%" PetscInt_FMT, jac->nsplits));
1805a04f6461SBarry Smith   }
18069df09d43SBarry Smith   ilink->event = jac->nsplits < 5 ? KSP_Solve_FS_0 + jac->nsplits : KSP_Solve_FS_0 + 4; /* Any split great than 4 gets logged in the 4th split */
18079566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
18089566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is));
1809b5787286SJed Brown   ilink->is = is;
18109566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
18119566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is_col));
1812b5787286SJed Brown   ilink->is_col = is;
18130298fd71SBarry Smith   ilink->next   = NULL;
18149566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
18159566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
18169566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
18179566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
18189566063dSJacob Faibussowitsch   PetscCall(PetscLogObjectParent((PetscObject)pc, (PetscObject)ilink->ksp));
1819704ba839SBarry Smith 
18209566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
18219566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
1822704ba839SBarry Smith 
1823704ba839SBarry Smith   if (!next) {
1824704ba839SBarry Smith     jac->head       = ilink;
18250298fd71SBarry Smith     ilink->previous = NULL;
1826704ba839SBarry Smith   } else {
18279371c9d4SSatish Balay     while (next->next) { next = next->next; }
1828704ba839SBarry Smith     next->next      = ilink;
1829704ba839SBarry Smith     ilink->previous = next;
1830704ba839SBarry Smith   }
1831704ba839SBarry Smith   jac->nsplits++;
1832704ba839SBarry Smith   PetscFunctionReturn(0);
1833704ba839SBarry Smith }
1834704ba839SBarry Smith 
183594ef8ddeSSatish Balay /*@C
18360971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
18370971522cSBarry Smith 
1838ad4df100SBarry Smith     Logically Collective on PC
18390971522cSBarry Smith 
18400971522cSBarry Smith     Input Parameters:
18410971522cSBarry Smith +   pc  - the preconditioner context
18420298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
18430971522cSBarry Smith .   n - the number of fields in this split
1844db4c96c1SJed Brown -   fields - the fields in this split
18450971522cSBarry Smith 
18460971522cSBarry Smith     Level: intermediate
18470971522cSBarry Smith 
184895452b02SPatrick Sanan     Notes:
184995452b02SPatrick Sanan     Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1850d32f9abdSBarry Smith 
18517287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1852d32f9abdSBarry Smith      size is three then one can define a field as 0, or 1 or 2 or 0,1 or 0,2 or 1,2 which mean
1853d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1854d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1855d32f9abdSBarry Smith 
1856db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1857db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1858db4c96c1SJed Brown 
18595d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
18605d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
18615d4c12cdSJungho Lee      available when this routine is called.
18625d4c12cdSJungho Lee 
1863db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetIS()`
18640971522cSBarry Smith 
18650971522cSBarry Smith @*/
18669371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetFields(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col) {
18670971522cSBarry Smith   PetscFunctionBegin;
18680700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
1869db4c96c1SJed Brown   PetscValidCharPointer(splitname, 2);
187063a3b9bcSJacob Faibussowitsch   PetscCheck(n >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Provided number of fields %" PetscInt_FMT " in split \"%s\" not positive", n, splitname);
1871064a246eSJacob Faibussowitsch   PetscValidIntPointer(fields, 4);
1872cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetFields_C", (PC, const char[], PetscInt, const PetscInt *, const PetscInt *), (pc, splitname, n, fields, fields_col));
18730971522cSBarry Smith   PetscFunctionReturn(0);
18740971522cSBarry Smith }
18750971522cSBarry Smith 
1876c84da90fSDmitry Karpeev /*@
1877c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1878c84da90fSDmitry Karpeev 
1879c84da90fSDmitry Karpeev     Logically Collective on PC
1880c84da90fSDmitry Karpeev 
1881c84da90fSDmitry Karpeev     Input Parameters:
1882c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1883c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1884c84da90fSDmitry Karpeev 
18859506b623SDmitry Karpeev     Options Database:
1886147403d9SBarry Smith .   -pc_fieldsplit_diag_use_amat - use the Amat to provide the diagonal blocks
1887c84da90fSDmitry Karpeev 
1888c84da90fSDmitry Karpeev     Level: intermediate
1889c84da90fSDmitry Karpeev 
1890db781477SPatrick Sanan .seealso: `PCFieldSplitGetDiagUseAmat()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFIELDSPLIT`
1891c84da90fSDmitry Karpeev 
1892c84da90fSDmitry Karpeev @*/
18939371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc, PetscBool flg) {
1894c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1895c84da90fSDmitry Karpeev   PetscBool      isfs;
1896c84da90fSDmitry Karpeev 
1897c84da90fSDmitry Karpeev   PetscFunctionBegin;
1898c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
18999566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
190028b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
1901c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1902c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1903c84da90fSDmitry Karpeev }
1904c84da90fSDmitry Karpeev 
1905c84da90fSDmitry Karpeev /*@
1906c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1907c84da90fSDmitry Karpeev 
1908c84da90fSDmitry Karpeev     Logically Collective on PC
1909c84da90fSDmitry Karpeev 
1910c84da90fSDmitry Karpeev     Input Parameters:
1911c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1912c84da90fSDmitry Karpeev 
1913c84da90fSDmitry Karpeev     Output Parameters:
1914c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1915c84da90fSDmitry Karpeev 
1916c84da90fSDmitry Karpeev     Level: intermediate
1917c84da90fSDmitry Karpeev 
1918db781477SPatrick Sanan .seealso: `PCFieldSplitSetDiagUseAmat()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFIELDSPLIT`
1919c84da90fSDmitry Karpeev 
1920c84da90fSDmitry Karpeev @*/
19219371c9d4SSatish Balay PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc, PetscBool *flg) {
1922c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1923c84da90fSDmitry Karpeev   PetscBool      isfs;
1924c84da90fSDmitry Karpeev 
1925c84da90fSDmitry Karpeev   PetscFunctionBegin;
1926c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
1927534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
19289566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
192928b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
1930c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1931c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1932c84da90fSDmitry Karpeev }
1933c84da90fSDmitry Karpeev 
1934c84da90fSDmitry Karpeev /*@
1935c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1936c84da90fSDmitry Karpeev 
1937c84da90fSDmitry Karpeev     Logically Collective on PC
1938c84da90fSDmitry Karpeev 
1939c84da90fSDmitry Karpeev     Input Parameters:
1940c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1941c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1942c84da90fSDmitry Karpeev 
19439506b623SDmitry Karpeev     Options Database:
1944147403d9SBarry Smith .     -pc_fieldsplit_off_diag_use_amat <bool> - use the Amat to extract the off-diagonal blocks
1945c84da90fSDmitry Karpeev 
1946c84da90fSDmitry Karpeev     Level: intermediate
1947c84da90fSDmitry Karpeev 
1948db781477SPatrick Sanan .seealso: `PCFieldSplitGetOffDiagUseAmat()`, `PCFieldSplitSetDiagUseAmat()`, `PCFIELDSPLIT`
1949c84da90fSDmitry Karpeev 
1950c84da90fSDmitry Karpeev @*/
19519371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc, PetscBool flg) {
1952c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1953c84da90fSDmitry Karpeev   PetscBool      isfs;
1954c84da90fSDmitry Karpeev 
1955c84da90fSDmitry Karpeev   PetscFunctionBegin;
1956c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
19579566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
195828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
1959c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
1960c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1961c84da90fSDmitry Karpeev }
1962c84da90fSDmitry Karpeev 
1963c84da90fSDmitry Karpeev /*@
1964c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1965c84da90fSDmitry Karpeev 
1966c84da90fSDmitry Karpeev     Logically Collective on PC
1967c84da90fSDmitry Karpeev 
1968c84da90fSDmitry Karpeev     Input Parameters:
1969c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1970c84da90fSDmitry Karpeev 
1971c84da90fSDmitry Karpeev     Output Parameters:
1972c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1973c84da90fSDmitry Karpeev 
1974c84da90fSDmitry Karpeev     Level: intermediate
1975c84da90fSDmitry Karpeev 
1976db781477SPatrick Sanan .seealso: `PCFieldSplitSetOffDiagUseAmat()`, `PCFieldSplitGetDiagUseAmat()`, `PCFIELDSPLIT`
1977c84da90fSDmitry Karpeev 
1978c84da90fSDmitry Karpeev @*/
19799371c9d4SSatish Balay PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc, PetscBool *flg) {
1980c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1981c84da90fSDmitry Karpeev   PetscBool      isfs;
1982c84da90fSDmitry Karpeev 
1983c84da90fSDmitry Karpeev   PetscFunctionBegin;
1984c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
1985534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
19869566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
198728b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
1988c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
1989c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1990c84da90fSDmitry Karpeev }
1991c84da90fSDmitry Karpeev 
1992218d4943SBarry Smith /*@C
1993704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1994704ba839SBarry Smith 
1995ad4df100SBarry Smith     Logically Collective on PC
1996704ba839SBarry Smith 
1997704ba839SBarry Smith     Input Parameters:
1998704ba839SBarry Smith +   pc  - the preconditioner context
19990298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
2000db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
2001704ba839SBarry Smith 
2002a6ffb8dbSJed Brown     Notes:
2003a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
2004a6ffb8dbSJed Brown 
2005db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
2006db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
2007d32f9abdSBarry Smith 
2008704ba839SBarry Smith     Level: intermediate
2009704ba839SBarry Smith 
2010db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`
2011704ba839SBarry Smith 
2012704ba839SBarry Smith @*/
20139371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetIS(PC pc, const char splitname[], IS is) {
2014704ba839SBarry Smith   PetscFunctionBegin;
20150700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
20167b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname, 2);
2017db4c96c1SJed Brown   PetscValidHeaderSpecific(is, IS_CLASSID, 3);
2018cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetIS_C", (PC, const char[], IS), (pc, splitname, is));
2019704ba839SBarry Smith   PetscFunctionReturn(0);
2020704ba839SBarry Smith }
2021704ba839SBarry Smith 
202294ef8ddeSSatish Balay /*@C
202357a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
202457a9adfeSMatthew G Knepley 
202557a9adfeSMatthew G Knepley     Logically Collective on PC
202657a9adfeSMatthew G Knepley 
202757a9adfeSMatthew G Knepley     Input Parameters:
202857a9adfeSMatthew G Knepley +   pc  - the preconditioner context
202957a9adfeSMatthew G Knepley -   splitname - name of this split
203057a9adfeSMatthew G Knepley 
203157a9adfeSMatthew G Knepley     Output Parameter:
20320298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
203357a9adfeSMatthew G Knepley 
203457a9adfeSMatthew G Knepley     Level: intermediate
203557a9adfeSMatthew G Knepley 
2036db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetIS()`
203757a9adfeSMatthew G Knepley 
203857a9adfeSMatthew G Knepley @*/
20399371c9d4SSatish Balay PetscErrorCode PCFieldSplitGetIS(PC pc, const char splitname[], IS *is) {
204057a9adfeSMatthew G Knepley   PetscFunctionBegin;
204157a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
204257a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname, 2);
204357a9adfeSMatthew G Knepley   PetscValidPointer(is, 3);
204457a9adfeSMatthew G Knepley   {
204557a9adfeSMatthew G Knepley     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
204657a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
204757a9adfeSMatthew G Knepley     PetscBool         found;
204857a9adfeSMatthew G Knepley 
20490298fd71SBarry Smith     *is = NULL;
205057a9adfeSMatthew G Knepley     while (ilink) {
20519566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(ilink->splitname, splitname, &found));
205257a9adfeSMatthew G Knepley       if (found) {
205357a9adfeSMatthew G Knepley         *is = ilink->is;
205457a9adfeSMatthew G Knepley         break;
205557a9adfeSMatthew G Knepley       }
205657a9adfeSMatthew G Knepley       ilink = ilink->next;
205757a9adfeSMatthew G Knepley     }
205857a9adfeSMatthew G Knepley   }
205957a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
206057a9adfeSMatthew G Knepley }
206157a9adfeSMatthew G Knepley 
2062998f007dSPierre Jolivet /*@C
2063998f007dSPierre Jolivet     PCFieldSplitGetISByIndex - Retrieves the elements for a given index field as an IS
2064998f007dSPierre Jolivet 
2065998f007dSPierre Jolivet     Logically Collective on PC
2066998f007dSPierre Jolivet 
2067998f007dSPierre Jolivet     Input Parameters:
2068998f007dSPierre Jolivet +   pc  - the preconditioner context
2069998f007dSPierre Jolivet -   index - index of this split
2070998f007dSPierre Jolivet 
2071998f007dSPierre Jolivet     Output Parameter:
2072998f007dSPierre Jolivet -   is - the index set that defines the vector elements in this field
2073998f007dSPierre Jolivet 
2074998f007dSPierre Jolivet     Level: intermediate
2075998f007dSPierre Jolivet 
2076db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitGetIS()`, `PCFieldSplitSetIS()`
2077998f007dSPierre Jolivet 
2078998f007dSPierre Jolivet @*/
20799371c9d4SSatish Balay PetscErrorCode PCFieldSplitGetISByIndex(PC pc, PetscInt index, IS *is) {
2080998f007dSPierre Jolivet   PetscFunctionBegin;
208163a3b9bcSJacob Faibussowitsch   PetscCheck(index >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", index);
2082998f007dSPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2083998f007dSPierre Jolivet   PetscValidPointer(is, 3);
2084998f007dSPierre Jolivet   {
2085998f007dSPierre Jolivet     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
2086998f007dSPierre Jolivet     PC_FieldSplitLink ilink = jac->head;
2087998f007dSPierre Jolivet     PetscInt          i     = 0;
208863a3b9bcSJacob Faibussowitsch     PetscCheck(index < jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", index, jac->nsplits);
2089998f007dSPierre Jolivet 
2090998f007dSPierre Jolivet     while (i < index) {
2091998f007dSPierre Jolivet       ilink = ilink->next;
2092998f007dSPierre Jolivet       ++i;
2093998f007dSPierre Jolivet     }
20949566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitGetIS(pc, ilink->splitname, is));
2095998f007dSPierre Jolivet   }
2096998f007dSPierre Jolivet   PetscFunctionReturn(0);
2097998f007dSPierre Jolivet }
2098998f007dSPierre Jolivet 
209951f519a2SBarry Smith /*@
210051f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
210151f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
210251f519a2SBarry Smith 
2103ad4df100SBarry Smith     Logically Collective on PC
210451f519a2SBarry Smith 
210551f519a2SBarry Smith     Input Parameters:
210651f519a2SBarry Smith +   pc  - the preconditioner context
210751f519a2SBarry Smith -   bs - the block size
210851f519a2SBarry Smith 
210951f519a2SBarry Smith     Level: intermediate
211051f519a2SBarry Smith 
2111db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`
211251f519a2SBarry Smith 
211351f519a2SBarry Smith @*/
21149371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetBlockSize(PC pc, PetscInt bs) {
211551f519a2SBarry Smith   PetscFunctionBegin;
21160700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2117c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc, bs, 2);
2118cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetBlockSize_C", (PC, PetscInt), (pc, bs));
211951f519a2SBarry Smith   PetscFunctionReturn(0);
212051f519a2SBarry Smith }
212151f519a2SBarry Smith 
21220971522cSBarry Smith /*@C
212369a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
21240971522cSBarry Smith 
212569a612a9SBarry Smith    Collective on KSP
21260971522cSBarry Smith 
21270971522cSBarry Smith    Input Parameter:
21280971522cSBarry Smith .  pc - the preconditioner context
21290971522cSBarry Smith 
21300971522cSBarry Smith    Output Parameters:
213113e0d083SBarry Smith +  n - the number of splits
21323111de3cSBarry Smith -  subksp - the array of KSP contexts
21330971522cSBarry Smith 
21340971522cSBarry Smith    Note:
21359a4f7e47SBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
2136d32f9abdSBarry Smith    (not the KSP just the array that contains them).
21370971522cSBarry Smith 
2138285fb4e2SStefano Zampini    You must call PCSetUp() before calling PCFieldSplitGetSubKSP().
2139285fb4e2SStefano Zampini 
2140285fb4e2SStefano Zampini    If the fieldsplit is of type PC_COMPOSITE_SCHUR, it returns the KSP object used inside the
2141285fb4e2SStefano Zampini    Schur complement and the KSP object used to iterate over the Schur complement.
2142a51937d4SCarola Kruse    To access all the KSP objects used in PC_COMPOSITE_SCHUR, use PCFieldSplitSchurGetSubKSP().
2143a51937d4SCarola Kruse 
2144a51937d4SCarola Kruse    If the fieldsplit is of type PC_COMPOSITE_GKB, it returns the KSP object used to solve the
2145a51937d4SCarola Kruse    inner linear system defined by the matrix H in each loop.
21460971522cSBarry Smith 
2147196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
21482bf68e3eSBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
2149196cc216SBarry Smith       KSP array must be.
2150196cc216SBarry Smith 
21510971522cSBarry Smith    Level: advanced
21520971522cSBarry Smith 
2153db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`
21540971522cSBarry Smith @*/
21559371c9d4SSatish Balay PetscErrorCode PCFieldSplitGetSubKSP(PC pc, PetscInt *n, KSP *subksp[]) {
21560971522cSBarry Smith   PetscFunctionBegin;
21570700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
215813e0d083SBarry Smith   if (n) PetscValidIntPointer(n, 2);
2159cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
21600971522cSBarry Smith   PetscFunctionReturn(0);
21610971522cSBarry Smith }
21620971522cSBarry Smith 
2163285fb4e2SStefano Zampini /*@C
2164285fb4e2SStefano Zampini    PCFieldSplitSchurGetSubKSP - Gets the KSP contexts used inside the Schur complement based PCFIELDSPLIT
2165285fb4e2SStefano Zampini 
2166285fb4e2SStefano Zampini    Collective on KSP
2167285fb4e2SStefano Zampini 
2168285fb4e2SStefano Zampini    Input Parameter:
2169285fb4e2SStefano Zampini .  pc - the preconditioner context
2170285fb4e2SStefano Zampini 
2171285fb4e2SStefano Zampini    Output Parameters:
2172285fb4e2SStefano Zampini +  n - the number of splits
2173285fb4e2SStefano Zampini -  subksp - the array of KSP contexts
2174285fb4e2SStefano Zampini 
2175285fb4e2SStefano Zampini    Note:
2176285fb4e2SStefano Zampini    After PCFieldSplitSchurGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
2177285fb4e2SStefano Zampini    (not the KSP just the array that contains them).
2178285fb4e2SStefano Zampini 
2179285fb4e2SStefano Zampini    You must call PCSetUp() before calling PCFieldSplitSchurGetSubKSP().
2180285fb4e2SStefano Zampini 
2181285fb4e2SStefano Zampini    If the fieldsplit type is of type PC_COMPOSITE_SCHUR, it returns (in order)
2182285fb4e2SStefano Zampini    - the KSP used for the (1,1) block
2183285fb4e2SStefano Zampini    - the KSP used for the Schur complement (not the one used for the interior Schur solver)
2184285fb4e2SStefano Zampini    - the KSP used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block).
2185285fb4e2SStefano Zampini 
2186285fb4e2SStefano Zampini    It returns a null array if the fieldsplit is not of type PC_COMPOSITE_SCHUR; in this case, you should use PCFieldSplitGetSubKSP().
2187285fb4e2SStefano Zampini 
2188285fb4e2SStefano Zampini    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
2189285fb4e2SStefano Zampini       You can call PCFieldSplitSchurGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
2190285fb4e2SStefano Zampini       KSP array must be.
2191285fb4e2SStefano Zampini 
2192285fb4e2SStefano Zampini    Level: advanced
2193285fb4e2SStefano Zampini 
2194db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`
2195285fb4e2SStefano Zampini @*/
21969371c9d4SSatish Balay PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc, PetscInt *n, KSP *subksp[]) {
2197285fb4e2SStefano Zampini   PetscFunctionBegin;
2198285fb4e2SStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2199285fb4e2SStefano Zampini   if (n) PetscValidIntPointer(n, 2);
2200cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitSchurGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
2201285fb4e2SStefano Zampini   PetscFunctionReturn(0);
2202285fb4e2SStefano Zampini }
2203285fb4e2SStefano Zampini 
2204e69d4d44SBarry Smith /*@
2205a1e3cbf9SBarry Smith     PCFieldSplitSetSchurPre -  Indicates from what operator the preconditioner is constructucted for the Schur complement.
2206a1e3cbf9SBarry Smith       The default is the A11 matrix.
2207e69d4d44SBarry Smith 
2208e69d4d44SBarry Smith     Collective on PC
2209e69d4d44SBarry Smith 
2210e69d4d44SBarry Smith     Input Parameters:
2211e69d4d44SBarry Smith +   pc      - the preconditioner context
22126fdd48a9SBarry Smith .   ptype   - which matrix to use for preconditioning the Schur complement: PC_FIELDSPLIT_SCHUR_PRE_A11 (default), PC_FIELDSPLIT_SCHUR_PRE_SELF, PC_FIELDSPLIT_SCHUR_PRE_USER
22136fdd48a9SBarry Smith               PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL
22140298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
2215084e4875SJed Brown 
2216e69d4d44SBarry Smith     Options Database:
2217a1e3cbf9SBarry Smith +    -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments
2218a1e3cbf9SBarry Smith -    -fieldsplit_1_pc_type <pctype> - the preconditioner algorithm that is used to construct the preconditioner from the operator
2219e69d4d44SBarry Smith 
2220fd1303e9SJungho Lee     Notes:
2221fd1303e9SJungho Lee $    If ptype is
2222a1e3cbf9SBarry Smith $        a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
222353f2277eSBarry Smith $        matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
2224a1e3cbf9SBarry Smith $        self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
2225a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
2226fd1303e9SJungho Lee $             preconditioner
2227a1e3cbf9SBarry Smith $        user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
22286fdd48a9SBarry Smith $             to this function).
2229a1e3cbf9SBarry Smith $        selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
22301d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
22316fdd48a9SBarry Smith $             lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump
2232a1e3cbf9SBarry Smith $        full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation computed internally by PCFIELDSPLIT (this is expensive)
22336fdd48a9SBarry Smith $             useful mostly as a test that the Schur complement approach can work for your problem
2234fd1303e9SJungho Lee 
2235e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
2236fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
2237a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
2238fd1303e9SJungho Lee 
2239e69d4d44SBarry Smith     Level: intermediate
2240e69d4d44SBarry Smith 
2241db781477SPatrick Sanan .seealso: `PCFieldSplitGetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`,
2242db781477SPatrick Sanan           `MatSchurComplementSetAinvType()`, `PCLSC`
2243e69d4d44SBarry Smith 
2244e69d4d44SBarry Smith @*/
22459371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetSchurPre(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) {
2246e69d4d44SBarry Smith   PetscFunctionBegin;
22470700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2248cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurPre_C", (PC, PCFieldSplitSchurPreType, Mat), (pc, ptype, pre));
2249e69d4d44SBarry Smith   PetscFunctionReturn(0);
2250e69d4d44SBarry Smith }
2251686bed4dSStefano Zampini 
22529371c9d4SSatish Balay PetscErrorCode PCFieldSplitSchurPrecondition(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) {
22539371c9d4SSatish Balay   return PCFieldSplitSetSchurPre(pc, ptype, pre);
22549371c9d4SSatish Balay } /* Deprecated name */
2255e69d4d44SBarry Smith 
225637a82bf0SJed Brown /*@
225737a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
225829f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
225937a82bf0SJed Brown 
226037a82bf0SJed Brown     Logically Collective on PC
226137a82bf0SJed Brown 
2262f899ff85SJose E. Roman     Input Parameter:
226337a82bf0SJed Brown .   pc      - the preconditioner context
226437a82bf0SJed Brown 
226537a82bf0SJed Brown     Output Parameters:
226637a82bf0SJed Brown +   ptype   - which matrix to use for preconditioning the Schur complement: PC_FIELDSPLIT_SCHUR_PRE_A11, PC_FIELDSPLIT_SCHUR_PRE_SELF, PC_FIELDSPLIT_PRE_USER
226737a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
226837a82bf0SJed Brown 
226937a82bf0SJed Brown     Level: intermediate
227037a82bf0SJed Brown 
2271db781477SPatrick Sanan .seealso: `PCFieldSplitSetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCLSC`
227237a82bf0SJed Brown 
227337a82bf0SJed Brown @*/
22749371c9d4SSatish Balay PetscErrorCode PCFieldSplitGetSchurPre(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre) {
227537a82bf0SJed Brown   PetscFunctionBegin;
227637a82bf0SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2277cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSchurPre_C", (PC, PCFieldSplitSchurPreType *, Mat *), (pc, ptype, pre));
2278e69d4d44SBarry Smith   PetscFunctionReturn(0);
2279e69d4d44SBarry Smith }
2280e69d4d44SBarry Smith 
228145e7fc46SDmitry Karpeev /*@
2282470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
228345e7fc46SDmitry Karpeev 
228445e7fc46SDmitry Karpeev     Not collective
228545e7fc46SDmitry Karpeev 
228645e7fc46SDmitry Karpeev     Input Parameter:
228745e7fc46SDmitry Karpeev .   pc      - the preconditioner context
228845e7fc46SDmitry Karpeev 
228945e7fc46SDmitry Karpeev     Output Parameter:
2290470b340bSDmitry Karpeev .   S       - the Schur complement matrix
229145e7fc46SDmitry Karpeev 
2292470b340bSDmitry Karpeev     Notes:
2293470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
229445e7fc46SDmitry Karpeev 
229545e7fc46SDmitry Karpeev     Level: advanced
229645e7fc46SDmitry Karpeev 
2297db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MatSchurComplement`, `PCFieldSplitSchurRestoreS()`
229845e7fc46SDmitry Karpeev 
229945e7fc46SDmitry Karpeev @*/
23009371c9d4SSatish Balay PetscErrorCode PCFieldSplitSchurGetS(PC pc, Mat *S) {
230145e7fc46SDmitry Karpeev   const char    *t;
230245e7fc46SDmitry Karpeev   PetscBool      isfs;
230345e7fc46SDmitry Karpeev   PC_FieldSplit *jac;
230445e7fc46SDmitry Karpeev 
230545e7fc46SDmitry Karpeev   PetscFunctionBegin;
230645e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23079566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
23089566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
230928b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
231045e7fc46SDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
231163a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
2312470b340bSDmitry Karpeev   if (S) *S = jac->schur;
231345e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
231445e7fc46SDmitry Karpeev }
231545e7fc46SDmitry Karpeev 
2316470b340bSDmitry Karpeev /*@
2317470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
2318470b340bSDmitry Karpeev 
2319470b340bSDmitry Karpeev     Not collective
2320470b340bSDmitry Karpeev 
2321470b340bSDmitry Karpeev     Input Parameters:
2322470b340bSDmitry Karpeev +   pc      - the preconditioner context
2323a2b725a8SWilliam Gropp -   S       - the Schur complement matrix
2324470b340bSDmitry Karpeev 
2325470b340bSDmitry Karpeev     Level: advanced
2326470b340bSDmitry Karpeev 
2327db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MatSchurComplement`, `PCFieldSplitSchurGetS()`
2328470b340bSDmitry Karpeev 
2329470b340bSDmitry Karpeev @*/
23309371c9d4SSatish Balay PetscErrorCode PCFieldSplitSchurRestoreS(PC pc, Mat *S) {
2331470b340bSDmitry Karpeev   const char    *t;
2332470b340bSDmitry Karpeev   PetscBool      isfs;
2333470b340bSDmitry Karpeev   PC_FieldSplit *jac;
2334470b340bSDmitry Karpeev 
2335470b340bSDmitry Karpeev   PetscFunctionBegin;
2336470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23379566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
23389566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
233928b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
2340470b340bSDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
234163a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
23427827d75bSBarry Smith   PetscCheck(S && (*S == jac->schur), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatSchurComplement restored is not the same as gotten");
2343470b340bSDmitry Karpeev   PetscFunctionReturn(0);
2344470b340bSDmitry Karpeev }
2345470b340bSDmitry Karpeev 
23469371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType ptype, Mat pre) {
2347e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2348e69d4d44SBarry Smith 
2349e69d4d44SBarry Smith   PetscFunctionBegin;
2350084e4875SJed Brown   jac->schurpre = ptype;
2351a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
23529566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&jac->schur_user));
2353084e4875SJed Brown     jac->schur_user = pre;
23549566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
2355084e4875SJed Brown   }
2356e69d4d44SBarry Smith   PetscFunctionReturn(0);
2357e69d4d44SBarry Smith }
2358e69d4d44SBarry Smith 
23599371c9d4SSatish Balay static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre) {
236037a82bf0SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
236137a82bf0SJed Brown 
236237a82bf0SJed Brown   PetscFunctionBegin;
236337a82bf0SJed Brown   *ptype = jac->schurpre;
236437a82bf0SJed Brown   *pre   = jac->schur_user;
236537a82bf0SJed Brown   PetscFunctionReturn(0);
236637a82bf0SJed Brown }
236737a82bf0SJed Brown 
2368ab1df9f5SJed Brown /*@
23690ffb0e17SBarry Smith     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner
2370ab1df9f5SJed Brown 
2371ab1df9f5SJed Brown     Collective on PC
2372ab1df9f5SJed Brown 
2373ab1df9f5SJed Brown     Input Parameters:
2374ab1df9f5SJed Brown +   pc  - the preconditioner context
2375c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
2376ab1df9f5SJed Brown 
2377ab1df9f5SJed Brown     Options Database:
2378147403d9SBarry Smith .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - default is full
2379ab1df9f5SJed Brown 
2380ab1df9f5SJed Brown     Level: intermediate
2381ab1df9f5SJed Brown 
2382ab1df9f5SJed Brown     Notes:
2383ab1df9f5SJed Brown     The FULL factorization is
2384ab1df9f5SJed Brown 
2385147403d9SBarry Smith .vb
2386147403d9SBarry Smith    (A   B)  = (1       0) (A   0) (1  Ainv*B)  = L D U
2387147403d9SBarry Smith    (C   E)    (C*Ainv  1) (0   S) (0     1)
2388147403d9SBarry Smith .vb
23890ffb0e17SBarry Smith     where S = E - C*Ainv*B. In practice, the full factorization is applied via block triangular solves with the grouping L*(D*U). UPPER uses D*U, LOWER uses L*D,
2390c096484dSStefano Zampini     and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of KSPMINRES). Sign flipping of S can be turned off with PCFieldSplitSetSchurScale().
2391ab1df9f5SJed Brown 
2392147403d9SBarry Smith     If A and S are solved exactly
2393147403d9SBarry Smith .vb
2394147403d9SBarry Smith       *) FULL factorization is a direct solver.
2395147403d9SBarry Smith       *) The preconditioned operator with LOWER or UPPER has all eigenvalues equal to 1 and minimal polynomial of degree 2, so KSPGMRES converges in 2 iterations.
2396147403d9SBarry Smith       *) With DIAG, the preconditioned operator has three distinct nonzero eigenvalues and minimal polynomial of degree at most 4, so KSPGMRES converges in at most 4 iterations.
2397147403d9SBarry Smith .ve
2398ab1df9f5SJed Brown 
23990ffb0e17SBarry Smith     If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
24000ffb0e17SBarry Smith     application in this case. Note that the preconditioned operator may be highly non-normal, so such fast convergence may not be observed in practice.
24010ffb0e17SBarry Smith 
24020ffb0e17SBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES.
24030ffb0e17SBarry Smith 
24040ffb0e17SBarry Smith     Note that a flexible method like KSPFGMRES or KSPGCR must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used to solve with A or S).
2405ab1df9f5SJed Brown 
2406ab1df9f5SJed Brown     References:
2407606c0280SSatish Balay +   * - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
2408606c0280SSatish Balay -   * - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2409ab1df9f5SJed Brown 
2410db781477SPatrick Sanan .seealso: `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurScale()`
2411ab1df9f5SJed Brown @*/
24129371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetSchurFactType(PC pc, PCFieldSplitSchurFactType ftype) {
2413ab1df9f5SJed Brown   PetscFunctionBegin;
2414ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2415cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurFactType_C", (PC, PCFieldSplitSchurFactType), (pc, ftype));
2416ab1df9f5SJed Brown   PetscFunctionReturn(0);
2417ab1df9f5SJed Brown }
2418ab1df9f5SJed Brown 
24199371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc, PCFieldSplitSchurFactType ftype) {
2420ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2421ab1df9f5SJed Brown 
2422ab1df9f5SJed Brown   PetscFunctionBegin;
2423ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2424ab1df9f5SJed Brown   PetscFunctionReturn(0);
2425ab1df9f5SJed Brown }
2426ab1df9f5SJed Brown 
2427c096484dSStefano Zampini /*@
2428c096484dSStefano Zampini     PCFieldSplitSetSchurScale -  Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG.
2429c096484dSStefano Zampini 
2430c096484dSStefano Zampini     Collective on PC
2431c096484dSStefano Zampini 
2432c096484dSStefano Zampini     Input Parameters:
2433c096484dSStefano Zampini +   pc    - the preconditioner context
2434c096484dSStefano Zampini -   scale - scaling factor for the Schur complement
2435c096484dSStefano Zampini 
2436c096484dSStefano Zampini     Options Database:
2437c096484dSStefano Zampini .     -pc_fieldsplit_schur_scale - default is -1.0
2438c096484dSStefano Zampini 
2439c096484dSStefano Zampini     Level: intermediate
2440c096484dSStefano Zampini 
2441db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurFactType`, `PCFieldSplitSetSchurScale()`
2442c096484dSStefano Zampini @*/
24439371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetSchurScale(PC pc, PetscScalar scale) {
2444c096484dSStefano Zampini   PetscFunctionBegin;
2445c096484dSStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2446c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc, scale, 2);
2447cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurScale_C", (PC, PetscScalar), (pc, scale));
2448c096484dSStefano Zampini   PetscFunctionReturn(0);
2449c096484dSStefano Zampini }
2450c096484dSStefano Zampini 
24519371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc, PetscScalar scale) {
2452c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2453c096484dSStefano Zampini 
2454c096484dSStefano Zampini   PetscFunctionBegin;
2455c096484dSStefano Zampini   jac->schurscale = scale;
2456c096484dSStefano Zampini   PetscFunctionReturn(0);
2457c096484dSStefano Zampini }
2458c096484dSStefano Zampini 
245930ad9308SMatthew Knepley /*@C
24608c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
246130ad9308SMatthew Knepley 
246230ad9308SMatthew Knepley    Collective on KSP
246330ad9308SMatthew Knepley 
246430ad9308SMatthew Knepley    Input Parameter:
246530ad9308SMatthew Knepley .  pc - the preconditioner context
246630ad9308SMatthew Knepley 
246730ad9308SMatthew Knepley    Output Parameters:
2468a04f6461SBarry Smith +  A00 - the (0,0) block
2469a04f6461SBarry Smith .  A01 - the (0,1) block
2470a04f6461SBarry Smith .  A10 - the (1,0) block
2471a04f6461SBarry Smith -  A11 - the (1,1) block
247230ad9308SMatthew Knepley 
247330ad9308SMatthew Knepley    Level: advanced
247430ad9308SMatthew Knepley 
2475db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`
247630ad9308SMatthew Knepley @*/
24779371c9d4SSatish Balay PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc, Mat *A00, Mat *A01, Mat *A10, Mat *A11) {
247830ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
247930ad9308SMatthew Knepley 
248030ad9308SMatthew Knepley   PetscFunctionBegin;
24810700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
248208401ef6SPierre Jolivet   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2483a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2484a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2485a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2486a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
248730ad9308SMatthew Knepley   PetscFunctionReturn(0);
248830ad9308SMatthew Knepley }
248930ad9308SMatthew Knepley 
2490b09e027eSCarola Kruse /*@
2491e071a0a4SCarola Kruse     PCFieldSplitSetGKBTol -  Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner.
2492b09e027eSCarola Kruse 
2493b09e027eSCarola Kruse     Collective on PC
2494b09e027eSCarola Kruse 
2495e071a0a4SCarola Kruse     Notes:
2496e071a0a4SCarola Kruse     The generalized GKB algorithm uses a lower bound estimate of the error in energy norm as stopping criterion.
2497e071a0a4SCarola Kruse     It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than
2498e071a0a4SCarola Kruse     this estimate, the stopping criterion is satisfactory in practical cases [A13].
2499e071a0a4SCarola Kruse 
2500e071a0a4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2501e071a0a4SCarola Kruse 
2502b09e027eSCarola Kruse     Input Parameters:
2503b09e027eSCarola Kruse +   pc        - the preconditioner context
2504b09e027eSCarola Kruse -   tolerance - the solver tolerance
2505b09e027eSCarola Kruse 
2506b09e027eSCarola Kruse     Options Database:
2507b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_tol - default is 1e-5
2508b09e027eSCarola Kruse 
2509b09e027eSCarola Kruse     Level: intermediate
2510b09e027eSCarola Kruse 
2511db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBMaxit()`
2512b09e027eSCarola Kruse @*/
25139371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetGKBTol(PC pc, PetscReal tolerance) {
2514b09e027eSCarola Kruse   PetscFunctionBegin;
2515b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2516de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, tolerance, 2);
2517cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBTol_C", (PC, PetscReal), (pc, tolerance));
2518b09e027eSCarola Kruse   PetscFunctionReturn(0);
2519b09e027eSCarola Kruse }
2520b09e027eSCarola Kruse 
25219371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc, PetscReal tolerance) {
2522b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2523b09e027eSCarola Kruse 
2524b09e027eSCarola Kruse   PetscFunctionBegin;
2525b09e027eSCarola Kruse   jac->gkbtol = tolerance;
2526b09e027eSCarola Kruse   PetscFunctionReturn(0);
2527b09e027eSCarola Kruse }
2528b09e027eSCarola Kruse 
2529b09e027eSCarola Kruse /*@
2530e071a0a4SCarola Kruse     PCFieldSplitSetGKBMaxit -  Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization
2531e071a0a4SCarola Kruse     preconditioner.
2532b09e027eSCarola Kruse 
2533b09e027eSCarola Kruse     Collective on PC
2534b09e027eSCarola Kruse 
2535b09e027eSCarola Kruse     Input Parameters:
2536b09e027eSCarola Kruse +   pc     - the preconditioner context
2537b09e027eSCarola Kruse -   maxit  - the maximum number of iterations
2538b09e027eSCarola Kruse 
2539b09e027eSCarola Kruse     Options Database:
2540b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_maxit - default is 100
2541b09e027eSCarola Kruse 
2542b09e027eSCarola Kruse     Level: intermediate
2543b09e027eSCarola Kruse 
2544db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBNu()`
2545b09e027eSCarola Kruse @*/
25469371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc, PetscInt maxit) {
2547b09e027eSCarola Kruse   PetscFunctionBegin;
2548b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2549de482cd7SCarola Kruse   PetscValidLogicalCollectiveInt(pc, maxit, 2);
2550cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBMaxit_C", (PC, PetscInt), (pc, maxit));
2551b09e027eSCarola Kruse   PetscFunctionReturn(0);
2552b09e027eSCarola Kruse }
2553b09e027eSCarola Kruse 
25549371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc, PetscInt maxit) {
2555b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2556b09e027eSCarola Kruse 
2557b09e027eSCarola Kruse   PetscFunctionBegin;
2558b09e027eSCarola Kruse   jac->gkbmaxit = maxit;
2559b09e027eSCarola Kruse   PetscFunctionReturn(0);
2560b09e027eSCarola Kruse }
2561b09e027eSCarola Kruse 
2562b09e027eSCarola Kruse /*@
2563e071a0a4SCarola Kruse     PCFieldSplitSetGKBDelay -  Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization
2564e071a0a4SCarola Kruse     preconditioner.
2565b09e027eSCarola Kruse 
2566b09e027eSCarola Kruse     Collective on PC
2567b09e027eSCarola Kruse 
2568b09e027eSCarola Kruse     Notes:
2569e071a0a4SCarola Kruse     The algorithm uses a lower bound estimate of the error in energy norm as stopping criterion. The lower bound of the error ||u-u^k||_H
2570e071a0a4SCarola Kruse     is expressed as a truncated sum. The error at iteration k can only be measured at iteration (k + delay), and thus the algorithm needs
2571e071a0a4SCarola Kruse     at least (delay + 1) iterations to stop. For more details on the generalized Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to
2572b09e027eSCarola Kruse 
2573b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2574b09e027eSCarola Kruse 
2575b09e027eSCarola Kruse     Input Parameters:
2576b09e027eSCarola Kruse +   pc     - the preconditioner context
2577b09e027eSCarola Kruse -   delay  - the delay window in the lower bound estimate
2578b09e027eSCarola Kruse 
2579b09e027eSCarola Kruse     Options Database:
2580b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_delay - default is 5
2581b09e027eSCarola Kruse 
2582b09e027eSCarola Kruse     Level: intermediate
2583b09e027eSCarola Kruse 
2584db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
2585b09e027eSCarola Kruse @*/
25869371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetGKBDelay(PC pc, PetscInt delay) {
2587b09e027eSCarola Kruse   PetscFunctionBegin;
2588b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2589b09e027eSCarola Kruse   PetscValidLogicalCollectiveInt(pc, delay, 2);
2590cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBDelay_C", (PC, PetscInt), (pc, delay));
2591b09e027eSCarola Kruse   PetscFunctionReturn(0);
2592b09e027eSCarola Kruse }
2593b09e027eSCarola Kruse 
25949371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc, PetscInt delay) {
2595b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2596b09e027eSCarola Kruse 
2597b09e027eSCarola Kruse   PetscFunctionBegin;
2598b09e027eSCarola Kruse   jac->gkbdelay = delay;
2599b09e027eSCarola Kruse   PetscFunctionReturn(0);
2600b09e027eSCarola Kruse }
2601b09e027eSCarola Kruse 
2602b09e027eSCarola Kruse /*@
2603b09e027eSCarola Kruse     PCFieldSplitSetGKBNu -  Sets the scalar value nu >= 0 in the transformation H = A00 + nu*A01*A01' of the (1,1) block in the Golub-Kahan bidiagonalization preconditioner.
2604b09e027eSCarola Kruse 
2605b09e027eSCarola Kruse     Collective on PC
2606b09e027eSCarola Kruse 
2607b09e027eSCarola Kruse     Notes:
2608e071a0a4SCarola Kruse     This shift is in general done to obtain better convergence properties for the outer loop of the algorithm. This is often achieved by chosing nu sufficiently big. However,
2609b09e027eSCarola Kruse     if nu is chosen too big, the matrix H might be badly conditioned and the solution of the linear system Hx = b in the inner loop gets difficult. It is therefore
2610b09e027eSCarola Kruse     necessary to find a good balance in between the convergence of the inner and outer loop.
2611b09e027eSCarola Kruse 
2612b09e027eSCarola Kruse     For nu = 0, no shift is done. In this case A00 has to be positive definite. The matrix N in [Ar13] is then chosen as identity.
2613b09e027eSCarola Kruse 
2614b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2615b09e027eSCarola Kruse 
2616b09e027eSCarola Kruse     Input Parameters:
2617b09e027eSCarola Kruse +   pc     - the preconditioner context
2618b09e027eSCarola Kruse -   nu     - the shift parameter
2619b09e027eSCarola Kruse 
2620b09e027eSCarola Kruse     Options Database:
2621b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_nu - default is 1
2622b09e027eSCarola Kruse 
2623b09e027eSCarola Kruse     Level: intermediate
2624b09e027eSCarola Kruse 
2625db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
2626b09e027eSCarola Kruse @*/
26279371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetGKBNu(PC pc, PetscReal nu) {
2628b09e027eSCarola Kruse   PetscFunctionBegin;
2629b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2630de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, nu, 2);
2631cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBNu_C", (PC, PetscReal), (pc, nu));
2632b09e027eSCarola Kruse   PetscFunctionReturn(0);
2633b09e027eSCarola Kruse }
2634b09e027eSCarola Kruse 
26359371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc, PetscReal nu) {
2636b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2637b09e027eSCarola Kruse 
2638b09e027eSCarola Kruse   PetscFunctionBegin;
2639b09e027eSCarola Kruse   jac->gkbnu = nu;
2640b09e027eSCarola Kruse   PetscFunctionReturn(0);
2641b09e027eSCarola Kruse }
2642b09e027eSCarola Kruse 
26439371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc, PCCompositeType type) {
264479416396SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
264579416396SBarry Smith 
264679416396SBarry Smith   PetscFunctionBegin;
264779416396SBarry Smith   jac->type = type;
26482e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
26492e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
26502e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
26512e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
26522e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
26532e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
26542e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
26552e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
26562e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
2657e071a0a4SCarola Kruse 
26583b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
26593b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
26603b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
26612fa5cd67SKarl Rupp 
26629566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit_Schur));
26639566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", PCFieldSplitSetSchurPre_FieldSplit));
26649566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", PCFieldSplitGetSchurPre_FieldSplit));
26659566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", PCFieldSplitSetSchurFactType_FieldSplit));
26669566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", PCFieldSplitSetSchurScale_FieldSplit));
2667a51937d4SCarola Kruse   } else if (type == PC_COMPOSITE_GKB) {
2668a51937d4SCarola Kruse     pc->ops->apply = PCApply_FieldSplit_GKB;
2669a51937d4SCarola Kruse     pc->ops->view  = PCView_FieldSplit_GKB;
2670e69d4d44SBarry Smith 
26719566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
26729566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", PCFieldSplitSetGKBTol_FieldSplit));
26739566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", PCFieldSplitSetGKBMaxit_FieldSplit));
26749566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", PCFieldSplitSetGKBNu_FieldSplit));
26759566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", PCFieldSplitSetGKBDelay_FieldSplit));
26763b224e63SBarry Smith   } else {
26773b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
26783b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
26792fa5cd67SKarl Rupp 
26809566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
26813b224e63SBarry Smith   }
268279416396SBarry Smith   PetscFunctionReturn(0);
268379416396SBarry Smith }
268479416396SBarry Smith 
26859371c9d4SSatish Balay static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc, PetscInt bs) {
268651f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
268751f519a2SBarry Smith 
268851f519a2SBarry Smith   PetscFunctionBegin;
268963a3b9bcSJacob Faibussowitsch   PetscCheck(bs >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Blocksize must be positive, you gave %" PetscInt_FMT, bs);
26902472a847SBarry Smith   PetscCheck(jac->bs <= 0 || jac->bs == bs, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Cannot change fieldsplit blocksize from %" PetscInt_FMT " to %" PetscInt_FMT " after it has been set", jac->bs, bs);
269151f519a2SBarry Smith   jac->bs = bs;
269251f519a2SBarry Smith   PetscFunctionReturn(0);
269351f519a2SBarry Smith }
269451f519a2SBarry Smith 
26959371c9d4SSatish Balay static PetscErrorCode PCSetCoordinates_FieldSplit(PC pc, PetscInt dim, PetscInt nloc, PetscReal coords[]) {
26965ddf11f8SNicolas Barnafi   PC_FieldSplit    *jac           = (PC_FieldSplit *)pc->data;
26975ddf11f8SNicolas Barnafi   PC_FieldSplitLink ilink_current = jac->head;
26985ddf11f8SNicolas Barnafi   IS                is_owned;
26995ddf11f8SNicolas Barnafi 
27005ddf11f8SNicolas Barnafi   PetscFunctionBegin;
27015ddf11f8SNicolas Barnafi   jac->coordinates_set = PETSC_TRUE; // Internal flag
27029566063dSJacob Faibussowitsch   PetscCall(MatGetOwnershipIS(pc->mat, &is_owned, PETSC_NULL));
27035ddf11f8SNicolas Barnafi 
27045ddf11f8SNicolas Barnafi   while (ilink_current) {
27055ddf11f8SNicolas Barnafi     // For each IS, embed it to get local coords indces
27065ddf11f8SNicolas Barnafi     IS              is_coords;
27075ddf11f8SNicolas Barnafi     PetscInt        ndofs_block;
27085ddf11f8SNicolas Barnafi     const PetscInt *block_dofs_enumeration; // Numbering of the dofs relevant to the current block
27095ddf11f8SNicolas Barnafi 
27105ddf11f8SNicolas Barnafi     // Setting drop to true for safety. It should make no difference.
27119566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink_current->is, is_owned, PETSC_TRUE, &is_coords));
27129566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(is_coords, &ndofs_block));
27139566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(is_coords, &block_dofs_enumeration));
27145ddf11f8SNicolas Barnafi 
27155ddf11f8SNicolas Barnafi     // Allocate coordinates vector and set it directly
27169566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(ndofs_block * dim, &(ilink_current->coords)));
27175ddf11f8SNicolas Barnafi     for (PetscInt dof = 0; dof < ndofs_block; ++dof) {
27189371c9d4SSatish Balay       for (PetscInt d = 0; d < dim; ++d) { (ilink_current->coords)[dim * dof + d] = coords[dim * block_dofs_enumeration[dof] + d]; }
27195ddf11f8SNicolas Barnafi     }
27205ddf11f8SNicolas Barnafi     ilink_current->dim   = dim;
27215ddf11f8SNicolas Barnafi     ilink_current->ndofs = ndofs_block;
27229566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(is_coords, &block_dofs_enumeration));
27239566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is_coords));
27245ddf11f8SNicolas Barnafi     ilink_current = ilink_current->next;
27255ddf11f8SNicolas Barnafi   }
27269566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_owned));
27275ddf11f8SNicolas Barnafi   PetscFunctionReturn(0);
27285ddf11f8SNicolas Barnafi }
27295ddf11f8SNicolas Barnafi 
2730bc08b0f1SBarry Smith /*@
273179416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
273279416396SBarry Smith 
273379416396SBarry Smith    Collective on PC
273479416396SBarry Smith 
2735d8d19677SJose E. Roman    Input Parameters:
2736a2b725a8SWilliam Gropp +  pc - the preconditioner context
2737a2b725a8SWilliam Gropp -  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
273879416396SBarry Smith 
273979416396SBarry Smith    Options Database Key:
2740a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
274179416396SBarry Smith 
2742b02e2d75SMatthew G Knepley    Level: Intermediate
274379416396SBarry Smith 
2744db781477SPatrick Sanan .seealso: `PCCompositeSetType()`
274579416396SBarry Smith 
274679416396SBarry Smith @*/
27479371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetType(PC pc, PCCompositeType type) {
274879416396SBarry Smith   PetscFunctionBegin;
27490700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2750cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetType_C", (PC, PCCompositeType), (pc, type));
275179416396SBarry Smith   PetscFunctionReturn(0);
275279416396SBarry Smith }
275379416396SBarry Smith 
2754b02e2d75SMatthew G Knepley /*@
2755b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2756b02e2d75SMatthew G Knepley 
2757b02e2d75SMatthew G Knepley   Not collective
2758b02e2d75SMatthew G Knepley 
2759b02e2d75SMatthew G Knepley   Input Parameter:
2760b02e2d75SMatthew G Knepley . pc - the preconditioner context
2761b02e2d75SMatthew G Knepley 
2762b02e2d75SMatthew G Knepley   Output Parameter:
2763b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2764b02e2d75SMatthew G Knepley 
2765b02e2d75SMatthew G Knepley   Level: Intermediate
2766b02e2d75SMatthew G Knepley 
2767db781477SPatrick Sanan .seealso: `PCCompositeSetType()`
2768b02e2d75SMatthew G Knepley @*/
27699371c9d4SSatish Balay PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type) {
2770b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2771b02e2d75SMatthew G Knepley 
2772b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2773b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2774b02e2d75SMatthew G Knepley   PetscValidIntPointer(type, 2);
2775b02e2d75SMatthew G Knepley   *type = jac->type;
2776b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2777b02e2d75SMatthew G Knepley }
2778b02e2d75SMatthew G Knepley 
27794ab8060aSDmitry Karpeev /*@
27804ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
27814ab8060aSDmitry Karpeev 
27824ab8060aSDmitry Karpeev    Logically Collective
27834ab8060aSDmitry Karpeev 
27844ab8060aSDmitry Karpeev    Input Parameters:
27854ab8060aSDmitry Karpeev +  pc   - the preconditioner context
27864ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
27874ab8060aSDmitry Karpeev 
27884ab8060aSDmitry Karpeev    Options Database Key:
278967b8a455SSatish Balay .  -pc_fieldsplit_dm_splits <bool> - use the field splits defined by the DM
27904ab8060aSDmitry Karpeev 
27914ab8060aSDmitry Karpeev    Level: Intermediate
27924ab8060aSDmitry Karpeev 
2793db781477SPatrick Sanan .seealso: `PCFieldSplitGetDMSplits()`
27944ab8060aSDmitry Karpeev 
27954ab8060aSDmitry Karpeev @*/
27969371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetDMSplits(PC pc, PetscBool flg) {
27974ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
27984ab8060aSDmitry Karpeev   PetscBool      isfs;
27994ab8060aSDmitry Karpeev 
28004ab8060aSDmitry Karpeev   PetscFunctionBegin;
28014ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
28024ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc, flg, 2);
28039566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
28049371c9d4SSatish Balay   if (isfs) { jac->dm_splits = flg; }
28054ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
28064ab8060aSDmitry Karpeev }
28074ab8060aSDmitry Karpeev 
28084ab8060aSDmitry Karpeev /*@
28094ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
28104ab8060aSDmitry Karpeev 
28114ab8060aSDmitry Karpeev    Logically Collective
28124ab8060aSDmitry Karpeev 
28134ab8060aSDmitry Karpeev    Input Parameter:
28144ab8060aSDmitry Karpeev .  pc   - the preconditioner context
28154ab8060aSDmitry Karpeev 
28164ab8060aSDmitry Karpeev    Output Parameter:
28174ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
28184ab8060aSDmitry Karpeev 
28194ab8060aSDmitry Karpeev    Level: Intermediate
28204ab8060aSDmitry Karpeev 
2821db781477SPatrick Sanan .seealso: `PCFieldSplitSetDMSplits()`
28224ab8060aSDmitry Karpeev 
28234ab8060aSDmitry Karpeev @*/
28249371c9d4SSatish Balay PetscErrorCode PCFieldSplitGetDMSplits(PC pc, PetscBool *flg) {
28254ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
28264ab8060aSDmitry Karpeev   PetscBool      isfs;
28274ab8060aSDmitry Karpeev 
28284ab8060aSDmitry Karpeev   PetscFunctionBegin;
28294ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2830534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
28319566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
28324ab8060aSDmitry Karpeev   if (isfs) {
28334ab8060aSDmitry Karpeev     if (flg) *flg = jac->dm_splits;
28344ab8060aSDmitry Karpeev   }
28354ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
28364ab8060aSDmitry Karpeev }
28374ab8060aSDmitry Karpeev 
28387b752e3dSPatrick Sanan /*@
28397b752e3dSPatrick Sanan    PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
28407b752e3dSPatrick Sanan 
28417b752e3dSPatrick Sanan    Logically Collective
28427b752e3dSPatrick Sanan 
28437b752e3dSPatrick Sanan    Input Parameter:
28447b752e3dSPatrick Sanan .  pc   - the preconditioner context
28457b752e3dSPatrick Sanan 
28467b752e3dSPatrick Sanan    Output Parameter:
28477b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
28487b752e3dSPatrick Sanan 
28497b752e3dSPatrick Sanan    Level: Intermediate
28507b752e3dSPatrick Sanan 
2851db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetDetectSaddlePoint()`
28527b752e3dSPatrick Sanan 
28537b752e3dSPatrick Sanan @*/
28549371c9d4SSatish Balay PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc, PetscBool *flg) {
28557b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
28567b752e3dSPatrick Sanan 
28577b752e3dSPatrick Sanan   PetscFunctionBegin;
28587b752e3dSPatrick Sanan   *flg = jac->detect;
28597b752e3dSPatrick Sanan   PetscFunctionReturn(0);
28607b752e3dSPatrick Sanan }
28617b752e3dSPatrick Sanan 
28627b752e3dSPatrick Sanan /*@
28637b752e3dSPatrick Sanan    PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
28647b752e3dSPatrick Sanan 
28657b752e3dSPatrick Sanan    Logically Collective
28667b752e3dSPatrick Sanan 
28677b752e3dSPatrick Sanan    Input Parameter:
28687b752e3dSPatrick Sanan .  pc   - the preconditioner context
28697b752e3dSPatrick Sanan 
28707b752e3dSPatrick Sanan    Output Parameter:
28717b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
28727b752e3dSPatrick Sanan 
28737b752e3dSPatrick Sanan    Options Database Key:
2874147403d9SBarry Smith .  -pc_fieldsplit_detect_saddle_point <bool> - detect and use the saddle point
2875147403d9SBarry Smith 
2876147403d9SBarry Smith    Notes:
2877147403d9SBarry Smith    Also sets the split type to PC_COMPOSITE_SCHUR (see PCFieldSplitSetType()) and the Schur preconditioner type to PC_FIELDSPLIT_SCHUR_PRE_SELF (see PCFieldSplitSetSchurPre()).
28787b752e3dSPatrick Sanan 
28797b752e3dSPatrick Sanan    Level: Intermediate
28807b752e3dSPatrick Sanan 
2881db781477SPatrick Sanan .seealso: `PCFIELDSPLIT`, `PCFieldSplitSetDetectSaddlePoint()`, `PCFieldSplitSetType()`, `PCFieldSplitSetSchurPre()`
28827b752e3dSPatrick Sanan 
28837b752e3dSPatrick Sanan @*/
28849371c9d4SSatish Balay PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc, PetscBool flg) {
28857b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
28867b752e3dSPatrick Sanan 
28877b752e3dSPatrick Sanan   PetscFunctionBegin;
28887b752e3dSPatrick Sanan   jac->detect = flg;
28897b752e3dSPatrick Sanan   if (jac->detect) {
28909566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetType(pc, PC_COMPOSITE_SCHUR));
28919566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetSchurPre(pc, PC_FIELDSPLIT_SCHUR_PRE_SELF, NULL));
28927b752e3dSPatrick Sanan   }
28937b752e3dSPatrick Sanan   PetscFunctionReturn(0);
28947b752e3dSPatrick Sanan }
28957b752e3dSPatrick Sanan 
28960971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
28970971522cSBarry Smith /*MC
2898a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2899de37d9f1SPatrick Sanan                   fields or groups of fields. See [the users manual section on "Solving Block Matrices"](sec_block_matrices) for more details.
29000971522cSBarry Smith 
2901de37d9f1SPatrick Sanan      To set options on the solvers for each block append `-fieldsplit_` to all the PC
2902de37d9f1SPatrick Sanan         options database keys. For example, `-fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1`
29030971522cSBarry Smith 
2904de37d9f1SPatrick Sanan      To set the options on the solvers separate for each block call `PCFieldSplitGetSubKSP()`
2905de37d9f1SPatrick Sanan          and set the options directly on the resulting `KSP` object
29060971522cSBarry Smith 
29070971522cSBarry Smith    Level: intermediate
29080971522cSBarry Smith 
290979416396SBarry Smith    Options Database Keys:
2910de37d9f1SPatrick Sanan +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the `%d`'th split
291181540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
2912de37d9f1SPatrick Sanan                               been supplied explicitly by `-pc_fieldsplit_%d_fields`
291381540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
2914a51937d4SCarola Kruse .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting
2915de37d9f1SPatrick Sanan .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see `PCFieldSplitSetSchurPre()`
2916de37d9f1SPatrick Sanan .   -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - set factorization type when using `-pc_fieldsplit_type schur`; see `PCFieldSplitSetSchurFactType()`
2917fb6809a2SPatrick Sanan -   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
291879416396SBarry Smith 
2919de37d9f1SPatrick Sanan      Options prefixes for inner solvers when using the Schur complement preconditioner are `-fieldsplit_0_` and `-fieldsplit_1_` .
2920de37d9f1SPatrick Sanan      For all other solvers they are `-fieldsplit_%d_` for the `d`th field; use `-fieldsplit_` for all fields.
2921de37d9f1SPatrick Sanan      The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is `-fieldsplit_0_`
29225d4c12cdSJungho Lee 
2923c8a0d604SMatthew G Knepley    Notes:
2924de37d9f1SPatrick Sanan     Use `PCFieldSplitSetFields()` to set fields defined by "strided" entries and `PCFieldSplitSetIS()`
2925d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
2926d32f9abdSBarry Smith 
2927d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
2928de37d9f1SPatrick Sanan       beginning at 0 then 1, etc to bs-1. The block size can be set with `PCFieldSplitSetBlockSize()`,
2929d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
2930de37d9f1SPatrick Sanan       to `KSPSetOperators()`/`PCSetOperators()`.
2931d32f9abdSBarry Smith 
2932de37d9f1SPatrick Sanan       For the Schur complement preconditioner if
29331d71051fSDmitry Karpeev 
2934de37d9f1SPatrick Sanan       ```{math}
2935de37d9f1SPatrick Sanan       J = \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{10} & A_{11} \end{array}\right]
2936de37d9f1SPatrick Sanan       ```
2937e69d4d44SBarry Smith 
2938de37d9f1SPatrick Sanan       the preconditioner using `full` factorization is logically
2939de37d9f1SPatrick Sanan       ```{math}
2940de37d9f1SPatrick Sanan       \left[\begin{array}{cc} I & -\text{ksp}(A_{00}) \\ 0 & I \end{array}\right] \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\ 0 & \text{ksp}(S) \end{array}\right] \left[\begin{array}{cc} I & 0 \\ -A_{10} \text{ksp}(A_{00}) & I \end{array}\right]
2941de37d9f1SPatrick Sanan       ```
2942de37d9f1SPatrick Sanan      where the action of $\text{inv}(A_{00})$ is applied using the KSP solver with prefix `-fieldsplit_0_`.  $S$ is the Schur complement
2943de37d9f1SPatrick Sanan      ```{math}
2944223e5b4fSPatrick Sanan      S = A_{11} - A_{10} \text{ksp}(A_{00}) A_{01}
2945de37d9f1SPatrick Sanan      ```
2946de37d9f1SPatrick Sanan      which is usually dense and not stored explicitly.  The action of $\text{ksp}(S)$ is computed using the KSP solver with prefix `-fieldsplit_splitname_` (where `splitname` was given
2947de37d9f1SPatrick Sanan      in providing the SECOND split or 1 if not given). For `PCFieldSplitGetSub\text{ksp}()` when field number is 0,
2948de37d9f1SPatrick Sanan      it returns the KSP associated with `-fieldsplit_0_` while field number 1 gives `-fieldsplit_1_` KSP. By default
2949de37d9f1SPatrick Sanan      $A_{11}$ is used to construct a preconditioner for $S$, use `PCFieldSplitSetSchurPre()` for all the possible ways to construct the preconditioner for $S$.
2950de37d9f1SPatrick Sanan 
2951de37d9f1SPatrick Sanan      The factorization type is set using `-pc_fieldsplit_schur_fact_type <diag, lower, upper, full>`. `full` is shown above,
2952de37d9f1SPatrick Sanan      `diag` gives
2953de37d9f1SPatrick Sanan       ```{math}
2954de37d9f1SPatrick Sanan       \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\  0 & -\text{ksp}(S) \end{array}\right]
2955de37d9f1SPatrick Sanan       ```
2956de37d9f1SPatrick Sanan      Note that, slightly counter intuitively, there is a negative in front of the $\text{ksp}(S)$  so that the preconditioner is positive definite. For SPD matrices $J$, the sign flip
2957de37d9f1SPatrick Sanan      can be turned off with `PCFieldSplitSetSchurScale()` or by command line `-pc_fieldsplit_schur_scale 1.0`. The `lower` factorization is the inverse of
2958de37d9f1SPatrick Sanan       ```{math}
2959de37d9f1SPatrick Sanan       \left[\begin{array}{cc} A_{00} & 0 \\  A_{10} & S \end{array}\right]
2960de37d9f1SPatrick Sanan       ```
2961de37d9f1SPatrick Sanan      where the inverses of A_{00} and S are applied using KSPs. The upper factorization is the inverse of
2962de37d9f1SPatrick Sanan       ```{math}
2963de37d9f1SPatrick Sanan       \left[\begin{array}{cc} A_{00} & A_{01} \\  0 & S \end{array}\right]
2964de37d9f1SPatrick Sanan       ```
2965de37d9f1SPatrick Sanan      where again the inverses of $A_{00}$ and $S$ are applied using `KSP`s.
2966de37d9f1SPatrick Sanan 
2967de37d9f1SPatrick Sanan      If only one set of indices (one `IS`) is provided with `PCFieldSplitSetIS()` then the complement of that `IS`
2968edf189efSBarry Smith      is used automatically for a second block.
2969edf189efSBarry Smith 
2970ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2971ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2972ff218e97SBarry Smith 
2973ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2974de37d9f1SPatrick Sanan      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling {cite}`Wesseling2009`. Note that one can also use `PCFIELDSPLIT`
2975ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
29760716a85fSBarry Smith 
29772da392ccSBarry Smith      References:
29783bc631e0SBarry Smith 
2979de37d9f1SPatrick Sanan      See "A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations" {cite}`elman2008tcp`.
2980a6a584a2SBarry Smith 
2981de37d9f1SPatrick Sanan      The Constrained Pressure Preconditioner (CPR) can be implemented using `PCCOMPOSITE` with `PCGALERKIN`. CPR first solves an $R A P$ subsystem, updates the
2982de37d9f1SPatrick Sanan      residual on all variables (`PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)`), and then applies a simple ILU like preconditioner on all the variables.
2983a51937d4SCarola Kruse 
2984de37d9f1SPatrick Sanan      The generalized Golub-Kahan bidiagonalization preconditioner (GKB) can be applied to symmetric $2 \times 2$ block matrices of the shape
2985de37d9f1SPatrick Sanan      ```{math}
2986de37d9f1SPatrick Sanan      \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{01}' & 0 \end{array}\right]
2987de37d9f1SPatrick Sanan      ```
2988de37d9f1SPatrick Sanan      with $A_{00}$ positive semi-definite. The implementation follows {cite}`Arioli2013`. Therein, we choose $N := 1/\nu * I$ and the $(1,1)$-block of the matrix is modified to $H = _{A00} + \nu*A_{01}*A_{01}'$.
2989de37d9f1SPatrick Sanan      A linear system $Hx = b$ has to be solved in each iteration of the GKB algorithm. This solver is chosen with the option prefix `-fieldsplit_0_`.
2990a51937d4SCarola Kruse 
2991de37d9f1SPatrick Sanan      ```{bibliography}
2992de37d9f1SPatrick Sanan      :filter: docname in docnames
2993de37d9f1SPatrick Sanan      ```
2994de37d9f1SPatrick Sanan 
2995db781477SPatrick Sanan .seealso: `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCLSC`,
2996db781477SPatrick Sanan           `PCFieldSplitGetSubKSP()`, `PCFieldSplitSchurGetSubKSP()`, `PCFieldSplitSetFields()`,
2997db781477SPatrick Sanan           `PCFieldSplitSetType()`, `PCFieldSplitSetIS()`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitSetSchurFactType()`,
2998db781477SPatrick Sanan           `MatSchurComplementSetAinvType()`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetDetectSaddlePoint()`
29990971522cSBarry Smith M*/
30000971522cSBarry Smith 
30019371c9d4SSatish Balay PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc) {
30020971522cSBarry Smith   PC_FieldSplit *jac;
30030971522cSBarry Smith 
30040971522cSBarry Smith   PetscFunctionBegin;
30059566063dSJacob Faibussowitsch   PetscCall(PetscNewLog(pc, &jac));
30062fa5cd67SKarl Rupp 
30070971522cSBarry Smith   jac->bs                 = -1;
30080971522cSBarry Smith   jac->nsplits            = 0;
30093e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
3010e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
3011c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
3012c096484dSStefano Zampini   jac->schurscale         = -1.0;
3013fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
30147b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
3015a51937d4SCarola Kruse   jac->gkbtol             = 1e-5;
3016a51937d4SCarola Kruse   jac->gkbdelay           = 5;
3017a51937d4SCarola Kruse   jac->gkbnu              = 1;
3018a51937d4SCarola Kruse   jac->gkbmaxit           = 100;
3019de482cd7SCarola Kruse   jac->gkbmonitor         = PETSC_FALSE;
30205ddf11f8SNicolas Barnafi   jac->coordinates_set    = PETSC_FALSE;
302151f519a2SBarry Smith 
30220971522cSBarry Smith   pc->data = (void *)jac;
30230971522cSBarry Smith 
30240971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
3025421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
30260971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
3027574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
30280971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
30290971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
30300971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
30310a545947SLisandro Dalcin   pc->ops->applyrichardson = NULL;
30320971522cSBarry Smith 
30339566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", PCFieldSplitSchurGetSubKSP_FieldSplit));
30349566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
30359566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", PCFieldSplitSetFields_FieldSplit));
30369566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", PCFieldSplitSetIS_FieldSplit));
30379566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", PCFieldSplitSetType_FieldSplit));
30389566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", PCFieldSplitSetBlockSize_FieldSplit));
30399566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", PCFieldSplitRestrictIS_FieldSplit));
30409566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", PCSetCoordinates_FieldSplit));
30410971522cSBarry Smith   PetscFunctionReturn(0);
30420971522cSBarry Smith }
3043