xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 80670ca526307b63e5a1d9a5049dfd9d2168c535)
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 /*
74f1580f4eSBarry Smith     Note:
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. */
82d71ae5a4SJacob Faibussowitsch static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
83d71ae5a4SJacob Faibussowitsch {
84084e4875SJed Brown   switch (jac->schurpre) {
85d71ae5a4SJacob Faibussowitsch   case PC_FIELDSPLIT_SCHUR_PRE_SELF:
86d71ae5a4SJacob Faibussowitsch     return jac->schur;
87d71ae5a4SJacob Faibussowitsch   case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
88d71ae5a4SJacob Faibussowitsch     return jac->schurp;
89d71ae5a4SJacob Faibussowitsch   case PC_FIELDSPLIT_SCHUR_PRE_A11:
90d71ae5a4SJacob Faibussowitsch     return jac->pmat[1];
91e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
92084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
93d71ae5a4SJacob Faibussowitsch   default:
94d71ae5a4SJacob Faibussowitsch     return jac->schur_user ? jac->schur_user : jac->pmat[1];
95084e4875SJed Brown   }
96084e4875SJed Brown }
97084e4875SJed Brown 
989804daf3SBarry Smith #include <petscdraw.h>
99d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit(PC pc, PetscViewer viewer)
100d71ae5a4SJacob Faibussowitsch {
1010971522cSBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
102d9884438SBarry Smith   PetscBool         iascii, isdraw;
1030971522cSBarry Smith   PetscInt          i, j;
1045a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
1050971522cSBarry Smith 
1060971522cSBarry Smith   PetscFunctionBegin;
1079566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
1089566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
1090971522cSBarry Smith   if (iascii) {
1102c9966d7SBarry Smith     if (jac->bs > 0) {
11163a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs));
1122c9966d7SBarry Smith     } else {
11363a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits));
1142c9966d7SBarry Smith     }
11548a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
11648a46eb9SPierre Jolivet     if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for diagonal blocks\n"));
11748a46eb9SPierre Jolivet     if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for off-diagonal blocks\n"));
1189566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Solver info for each split is in the following KSP objects:\n"));
1190971522cSBarry Smith     for (i = 0; i < jac->nsplits; i++) {
1201ab39975SBarry Smith       if (ilink->fields) {
12163a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i));
1229566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
1235a9f2f41SSatish Balay         for (j = 0; j < ilink->nfields; j++) {
12448a46eb9SPierre Jolivet           if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
12563a3b9bcSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
1260971522cSBarry Smith         }
1279566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
1289566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
1291ab39975SBarry Smith       } else {
13063a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i));
1311ab39975SBarry Smith       }
1329566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
1335a9f2f41SSatish Balay       ilink = ilink->next;
1340971522cSBarry Smith     }
1352fa5cd67SKarl Rupp   }
1362fa5cd67SKarl Rupp 
1372fa5cd67SKarl Rupp   if (isdraw) {
138d9884438SBarry Smith     PetscDraw draw;
139d9884438SBarry Smith     PetscReal x, y, w, wd;
140d9884438SBarry Smith 
1419566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
1429566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
143d9884438SBarry Smith     w  = 2 * PetscMin(1.0 - x, x);
144d9884438SBarry Smith     wd = w / (jac->nsplits + 1);
145d9884438SBarry Smith     x  = x - wd * (jac->nsplits - 1) / 2.0;
146d9884438SBarry Smith     for (i = 0; i < jac->nsplits; i++) {
1479566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
1489566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
1499566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
150d9884438SBarry Smith       x += wd;
151d9884438SBarry Smith       ilink = ilink->next;
152d9884438SBarry Smith     }
1530971522cSBarry Smith   }
1543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1550971522cSBarry Smith }
1560971522cSBarry Smith 
157d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_Schur(PC pc, PetscViewer viewer)
158d71ae5a4SJacob Faibussowitsch {
1593b224e63SBarry Smith   PC_FieldSplit             *jac = (PC_FieldSplit *)pc->data;
1604996c5bdSBarry Smith   PetscBool                  iascii, isdraw;
1613b224e63SBarry Smith   PetscInt                   i, j;
1623b224e63SBarry Smith   PC_FieldSplitLink          ilink = jac->head;
163a9908d51SBarry Smith   MatSchurComplementAinvType atype;
1643b224e63SBarry Smith 
1653b224e63SBarry Smith   PetscFunctionBegin;
1669566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
1679566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
1683b224e63SBarry Smith   if (iascii) {
1692c9966d7SBarry Smith     if (jac->bs > 0) {
17063a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with Schur preconditioner, blocksize = %" PetscInt_FMT ", factorization %s\n", jac->bs, PCFieldSplitSchurFactTypes[jac->schurfactorization]));
1712c9966d7SBarry Smith     } else {
1729566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with Schur preconditioner, factorization %s\n", PCFieldSplitSchurFactTypes[jac->schurfactorization]));
1732c9966d7SBarry Smith     }
17448a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
1753e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
176d71ae5a4SJacob Faibussowitsch     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
177d71ae5a4SJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from S itself\n"));
178d71ae5a4SJacob Faibussowitsch       break;
179a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
1807cf5f706SPierre Jolivet       if (jac->schur) {
1819566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetAinvType(jac->schur, &atype));
1829371c9d4SSatish 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 "))));
1837cf5f706SPierre Jolivet       }
184a9908d51SBarry Smith       break;
185d71ae5a4SJacob Faibussowitsch     case PC_FIELDSPLIT_SCHUR_PRE_A11:
186d71ae5a4SJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from A11\n"));
187d71ae5a4SJacob Faibussowitsch       break;
188d71ae5a4SJacob Faibussowitsch     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
189d71ae5a4SJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from the exact Schur complement\n"));
190d71ae5a4SJacob Faibussowitsch       break;
1913e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1923e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1939566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from user provided matrix\n"));
1943e8b8b31SMatthew G Knepley       } else {
1959566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from A11\n"));
1963e8b8b31SMatthew G Knepley       }
1973e8b8b31SMatthew G Knepley       break;
198d71ae5a4SJacob Faibussowitsch     default:
199d71ae5a4SJacob Faibussowitsch       SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
2003e8b8b31SMatthew G Knepley     }
2019566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Split info:\n"));
2029566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
2033b224e63SBarry Smith     for (i = 0; i < jac->nsplits; i++) {
2043b224e63SBarry Smith       if (ilink->fields) {
20563a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i));
2069566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
2073b224e63SBarry Smith         for (j = 0; j < ilink->nfields; j++) {
20848a46eb9SPierre Jolivet           if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
20963a3b9bcSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
2103b224e63SBarry Smith         }
2119566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
2129566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
2133b224e63SBarry Smith       } else {
21463a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i));
2153b224e63SBarry Smith       }
2163b224e63SBarry Smith       ilink = ilink->next;
2173b224e63SBarry Smith     }
2189566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for A00 block\n"));
2199566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
22006de4afeSJed Brown     if (jac->head) {
2219566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->head->ksp, viewer));
2229566063dSJacob Faibussowitsch     } else PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
2239566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
22406de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
2259566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for upper A00 in upper triangular factor\n"));
2269566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPushTab(viewer));
2279566063dSJacob Faibussowitsch       if (jac->kspupper) PetscCall(KSPView(jac->kspupper, viewer));
2289566063dSJacob Faibussowitsch       else PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
2299566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPopTab(viewer));
230443836d0SMatthew G Knepley     }
2319566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for S = A11 - A10 inv(A00) A01\n"));
2329566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
23312cae6f2SJed Brown     if (jac->kspschur) {
2349566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->kspschur, viewer));
23512cae6f2SJed Brown     } else {
2369566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
23712cae6f2SJed Brown     }
2389566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
2399566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
24006de4afeSJed Brown   } else if (isdraw && jac->head) {
2414996c5bdSBarry Smith     PetscDraw draw;
2424996c5bdSBarry Smith     PetscReal x, y, w, wd, h;
2434996c5bdSBarry Smith     PetscInt  cnt = 2;
2444996c5bdSBarry Smith     char      str[32];
2454996c5bdSBarry Smith 
2469566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
2479566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
248c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
249c74581afSBarry Smith     w  = 2 * PetscMin(1.0 - x, x);
250c74581afSBarry Smith     wd = w / (cnt + 1);
251c74581afSBarry Smith 
2529566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(str, 32, "Schur fact. %s", PCFieldSplitSchurFactTypes[jac->schurfactorization]));
2539566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h));
2544996c5bdSBarry Smith     y -= h;
2554996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) {
2569566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]));
2573b224e63SBarry Smith     } else {
2589566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[jac->schurpre]));
2594996c5bdSBarry Smith     }
2609566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x + wd * (cnt - 1) / 2.0, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h));
2614996c5bdSBarry Smith     y -= h;
2624996c5bdSBarry Smith     x = x - wd * (cnt - 1) / 2.0;
2634996c5bdSBarry Smith 
2649566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2659566063dSJacob Faibussowitsch     PetscCall(KSPView(jac->head->ksp, viewer));
2669566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
2674996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2684996c5bdSBarry Smith       x += wd;
2699566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2709566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->kspupper, viewer));
2719566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
2724996c5bdSBarry Smith     }
2734996c5bdSBarry Smith     x += wd;
2749566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2759566063dSJacob Faibussowitsch     PetscCall(KSPView(jac->kspschur, viewer));
2769566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
2773b224e63SBarry Smith   }
2783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2793b224e63SBarry Smith }
2803b224e63SBarry Smith 
281d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_GKB(PC pc, PetscViewer viewer)
282d71ae5a4SJacob Faibussowitsch {
283a51937d4SCarola Kruse   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
284a51937d4SCarola Kruse   PetscBool         iascii, isdraw;
285a51937d4SCarola Kruse   PetscInt          i, j;
286a51937d4SCarola Kruse   PC_FieldSplitLink ilink = jac->head;
287a51937d4SCarola Kruse 
288a51937d4SCarola Kruse   PetscFunctionBegin;
2899566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
2909566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
291a51937d4SCarola Kruse   if (iascii) {
292a51937d4SCarola Kruse     if (jac->bs > 0) {
29363a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs));
294a51937d4SCarola Kruse     } else {
29563a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits));
296a51937d4SCarola Kruse     }
29748a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
29848a46eb9SPierre Jolivet     if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for diagonal blocks\n"));
29948a46eb9SPierre Jolivet     if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for off-diagonal blocks\n"));
300a51937d4SCarola Kruse 
30163a3b9bcSJacob 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));
3029566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Solver info for H = A00 + nu*A01*A01' matrix:\n"));
3039566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
304a51937d4SCarola Kruse 
305a51937d4SCarola Kruse     if (ilink->fields) {
30663a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Fields "));
3079566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
308a51937d4SCarola Kruse       for (j = 0; j < ilink->nfields; j++) {
30948a46eb9SPierre Jolivet         if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
31063a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
311a51937d4SCarola Kruse       }
3129566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
3139566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
314a51937d4SCarola Kruse     } else {
31563a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Defined by IS\n"));
316a51937d4SCarola Kruse     }
3179566063dSJacob Faibussowitsch     PetscCall(KSPView(ilink->ksp, viewer));
318a51937d4SCarola Kruse 
3199566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
320a51937d4SCarola Kruse   }
321a51937d4SCarola Kruse 
322a51937d4SCarola Kruse   if (isdraw) {
323a51937d4SCarola Kruse     PetscDraw draw;
324a51937d4SCarola Kruse     PetscReal x, y, w, wd;
325a51937d4SCarola Kruse 
3269566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
3279566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
328a51937d4SCarola Kruse     w  = 2 * PetscMin(1.0 - x, x);
329a51937d4SCarola Kruse     wd = w / (jac->nsplits + 1);
330a51937d4SCarola Kruse     x  = x - wd * (jac->nsplits - 1) / 2.0;
331a51937d4SCarola Kruse     for (i = 0; i < jac->nsplits; i++) {
3329566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
3339566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
3349566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
335a51937d4SCarola Kruse       x += wd;
336a51937d4SCarola Kruse       ilink = ilink->next;
337a51937d4SCarola Kruse     }
338a51937d4SCarola Kruse   }
3393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
340a51937d4SCarola Kruse }
341a51937d4SCarola Kruse 
342*80670ca5SBarry Smith /* Precondition: jac->bs is set to a meaningful value or MATNEST */
343d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
344d71ae5a4SJacob Faibussowitsch {
3456c924f48SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
346*80670ca5SBarry Smith   PetscInt       bs, i, nfields, *ifields, nfields_col, *ifields_col;
347*80670ca5SBarry Smith   PetscBool      flg, flg_col, mnest;
3485d4c12cdSJungho Lee   char           optionname[128], splitname[8], optionname_col[128];
3496c924f48SJed Brown 
3506c924f48SJed Brown   PetscFunctionBegin;
351*80670ca5SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &mnest));
352*80670ca5SBarry Smith   if (mnest) {
353*80670ca5SBarry Smith     PetscCall(MatNestGetSize(pc->pmat, &bs, NULL));
354*80670ca5SBarry Smith   } else {
355*80670ca5SBarry Smith     bs = jac->bs;
356*80670ca5SBarry Smith   }
357*80670ca5SBarry Smith   PetscCall(PetscMalloc2(bs, &ifields, bs, &ifields_col));
3586c924f48SJed Brown   for (i = 0, flg = PETSC_TRUE;; i++) {
35963a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
36063a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
36163a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname_col, sizeof(optionname_col), "-pc_fieldsplit_%" PetscInt_FMT "_fields_col", i));
362*80670ca5SBarry Smith     nfields     = bs;
363*80670ca5SBarry Smith     nfields_col = bs;
3649566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
3659566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname_col, ifields_col, &nfields_col, &flg_col));
3666c924f48SJed Brown     if (!flg) break;
3675d4c12cdSJungho Lee     else if (flg && !flg_col) {
36828b400f6SJacob Faibussowitsch       PetscCheck(nfields, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
3699566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields));
3702fa5cd67SKarl Rupp     } else {
3717827d75bSBarry Smith       PetscCheck(nfields && nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
37208401ef6SPierre Jolivet       PetscCheck(nfields == nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Number of row and column fields must match");
3739566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields_col));
3745d4c12cdSJungho Lee     }
3756c924f48SJed Brown   }
3766c924f48SJed Brown   if (i > 0) {
3776c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3786c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3796c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3806c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3816c924f48SJed Brown   }
382*80670ca5SBarry Smith   PetscCall(PetscFree2(ifields, ifields_col));
3833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3846c924f48SJed Brown }
3856c924f48SJed Brown 
386d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
387d71ae5a4SJacob Faibussowitsch {
3880971522cSBarry Smith   PC_FieldSplit    *jac                = (PC_FieldSplit *)pc->data;
3895a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3907b752e3dSPatrick Sanan   PetscBool         fieldsplit_default = PETSC_FALSE, coupling = PETSC_FALSE;
3916c924f48SJed Brown   PetscInt          i;
3920971522cSBarry Smith 
3930971522cSBarry Smith   PetscFunctionBegin;
3947287d2a3SDmitry Karpeev   /*
395f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
3967287d2a3SDmitry Karpeev    Should probably be rewritten.
3977287d2a3SDmitry Karpeev    */
398f5f0d762SBarry Smith   if (!ilink) {
3999566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_detect_coupling", &coupling, NULL));
4007b752e3dSPatrick Sanan     if (pc->dm && jac->dm_splits && !jac->detect && !coupling) {
401bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
4020784a22cSJed Brown       char    **fieldNames;
4037b62db95SJungho Lee       IS       *fields;
404e7c4fc90SDmitry Karpeev       DM       *dms;
405bafc1b83SMatthew G Knepley       DM        subdm[128];
406bafc1b83SMatthew G Knepley       PetscBool flg;
407bafc1b83SMatthew G Knepley 
4089566063dSJacob Faibussowitsch       PetscCall(DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms));
409bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
410bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
411bafc1b83SMatthew G Knepley         PetscInt ifields[128];
412bafc1b83SMatthew G Knepley         IS       compField;
413bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
414bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
415bafc1b83SMatthew G Knepley 
41663a3b9bcSJacob Faibussowitsch         PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
4179566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
418bafc1b83SMatthew G Knepley         if (!flg) break;
41963a3b9bcSJacob Faibussowitsch         PetscCheck(numFields <= 128, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot currently support %" PetscInt_FMT " > 128 fields", numFields);
4209566063dSJacob Faibussowitsch         PetscCall(DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]));
421bafc1b83SMatthew G Knepley         if (nfields == 1) {
4229566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField));
423bafc1b83SMatthew G Knepley         } else {
42463a3b9bcSJacob Faibussowitsch           PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
4259566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, splitname, compField));
4267287d2a3SDmitry Karpeev         }
4279566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&compField));
428bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
429bafc1b83SMatthew G Knepley           f = ifields[j];
4309566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4319566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
4327b62db95SJungho Lee         }
433bafc1b83SMatthew G Knepley       }
434bafc1b83SMatthew G Knepley       if (i == 0) {
435bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
4369566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[f], fields[f]));
4379566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4389566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
439bafc1b83SMatthew G Knepley         }
440bafc1b83SMatthew G Knepley       } else {
44148a46eb9SPierre Jolivet         for (j = 0; j < numFields; j++) PetscCall(DMDestroy(dms + j));
4429566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4439566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(i, &dms));
4442fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
445bafc1b83SMatthew G Knepley       }
4469566063dSJacob Faibussowitsch       PetscCall(PetscFree(fieldNames));
4479566063dSJacob Faibussowitsch       PetscCall(PetscFree(fields));
448e7c4fc90SDmitry Karpeev       if (dms) {
4499566063dSJacob Faibussowitsch         PetscCall(PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n"));
450bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
4517287d2a3SDmitry Karpeev           const char *prefix;
452f4f49eeaSPierre Jolivet           PetscCall(PetscObjectGetOptionsPrefix((PetscObject)ilink->ksp, &prefix));
453f4f49eeaSPierre Jolivet           PetscCall(PetscObjectSetOptionsPrefix((PetscObject)dms[i], prefix));
4549566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(ilink->ksp, dms[i]));
4559566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(ilink->ksp, PETSC_FALSE));
45695dbaa6fSMatthew G. Knepley           {
45795dbaa6fSMatthew G. Knepley             PetscErrorCode (*func)(KSP, Mat, Mat, void *);
45895dbaa6fSMatthew G. Knepley             void *ctx;
45995dbaa6fSMatthew G. Knepley 
4609566063dSJacob Faibussowitsch             PetscCall(DMKSPGetComputeOperators(pc->dm, &func, &ctx));
4619566063dSJacob Faibussowitsch             PetscCall(DMKSPSetComputeOperators(dms[i], func, ctx));
46295dbaa6fSMatthew G. Knepley           }
4639566063dSJacob Faibussowitsch           PetscCall(PetscObjectIncrementTabLevel((PetscObject)dms[i], (PetscObject)ilink->ksp, 0));
4649566063dSJacob Faibussowitsch           PetscCall(DMDestroy(&dms[i]));
4652fa5ba8aSJed Brown         }
4669566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4678b8307b2SJed Brown       }
46866ffff09SJed Brown     } else {
469521d7252SBarry Smith       if (jac->bs <= 0) {
470704ba839SBarry Smith         if (pc->pmat) {
4719566063dSJacob Faibussowitsch           PetscCall(MatGetBlockSize(pc->pmat, &jac->bs));
4722fa5cd67SKarl Rupp         } else jac->bs = 1;
473521d7252SBarry Smith       }
474d32f9abdSBarry Smith 
4757b752e3dSPatrick Sanan       if (jac->detect) {
4766ce1633cSBarry Smith         IS       zerodiags, rest;
4776ce1633cSBarry Smith         PetscInt nmin, nmax;
4786ce1633cSBarry Smith 
4799566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4807199da05SBarry Smith         if (jac->diag_use_amat) {
4819566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->mat, &zerodiags));
4827199da05SBarry Smith         } else {
4839566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->pmat, &zerodiags));
4847199da05SBarry Smith         }
4859566063dSJacob Faibussowitsch         PetscCall(ISComplement(zerodiags, nmin, nmax, &rest));
4869566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
4879566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", zerodiags));
4889566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&zerodiags));
4899566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
4903a062f41SBarry Smith       } else if (coupling) {
4913a062f41SBarry Smith         IS       coupling, rest;
4923a062f41SBarry Smith         PetscInt nmin, nmax;
4933a062f41SBarry Smith 
4949566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4957199da05SBarry Smith         if (jac->offdiag_use_amat) {
4969566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->mat, &coupling));
4977199da05SBarry Smith         } else {
4989566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->pmat, &coupling));
4997199da05SBarry Smith         }
5009566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc->mat), nmax - nmin, nmin, 1, &rest));
5019566063dSJacob Faibussowitsch         PetscCall(ISSetIdentity(rest));
5029566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
5039566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", coupling));
5049566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&coupling));
5059566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
5066ce1633cSBarry Smith       } else {
5079566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_default", &fieldsplit_default, NULL));
5087287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
509d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
510d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
5119566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
5129566063dSJacob Faibussowitsch           if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
513d32f9abdSBarry Smith         }
5146dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
5159f001fe8SStefano Zampini           Mat       M = pc->pmat;
516f3b928b9SStefano Zampini           PetscBool isnest;
517*80670ca5SBarry Smith           PetscInt  nf;
518f3b928b9SStefano Zampini 
5199566063dSJacob Faibussowitsch           PetscCall(PetscInfo(pc, "Using default splitting of fields\n"));
5209566063dSJacob Faibussowitsch           PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &isnest));
521f3b928b9SStefano Zampini           if (!isnest) {
5229f001fe8SStefano Zampini             M = pc->mat;
5239566063dSJacob Faibussowitsch             PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &isnest));
524f3b928b9SStefano Zampini           }
525*80670ca5SBarry Smith           if (!isnest) nf = jac->bs;
526*80670ca5SBarry Smith           else PetscCall(MatNestGetSize(M, &nf, NULL));
527*80670ca5SBarry Smith           for (i = 0; i < nf; i++) {
5286c924f48SJed Brown             char splitname[8];
529*80670ca5SBarry Smith 
53063a3b9bcSJacob Faibussowitsch             PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
5319566063dSJacob Faibussowitsch             PetscCall(PCFieldSplitSetFields(pc, splitname, 1, &i, &i));
53279416396SBarry Smith           }
5335d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
534521d7252SBarry Smith         }
53566ffff09SJed Brown       }
5366ce1633cSBarry Smith     }
537edf189efSBarry Smith   } else if (jac->nsplits == 1) {
538edf189efSBarry Smith     IS       is2;
539edf189efSBarry Smith     PetscInt nmin, nmax;
540edf189efSBarry Smith 
5410fdf79fbSJacob Faibussowitsch     PetscCheck(ilink->is, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Must provide at least two sets of fields to PCFieldSplit()");
5429566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
5439566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is, nmin, nmax, &is2));
5449566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetIS(pc, "1", is2));
5459566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is2));
546edf189efSBarry Smith   }
547d0af7cd3SBarry Smith 
54863a3b9bcSJacob Faibussowitsch   PetscCheck(jac->nsplits >= 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unhandled case, must have at least two fields, not %" PetscInt_FMT, jac->nsplits);
5493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
55069a612a9SBarry Smith }
55169a612a9SBarry Smith 
552d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A, Mat B, Mat C, Mat *H, PetscReal gkbnu)
553d71ae5a4SJacob Faibussowitsch {
554a51937d4SCarola Kruse   Mat       BT, T;
555de482cd7SCarola Kruse   PetscReal nrmT, nrmB;
556a51937d4SCarola Kruse 
557a51937d4SCarola Kruse   PetscFunctionBegin;
5589566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &T)); /* Test if augmented matrix is symmetric */
5599566063dSJacob Faibussowitsch   PetscCall(MatAXPY(T, -1.0, B, DIFFERENT_NONZERO_PATTERN));
5609566063dSJacob Faibussowitsch   PetscCall(MatNorm(T, NORM_1, &nrmT));
5619566063dSJacob Faibussowitsch   PetscCall(MatNorm(B, NORM_1, &nrmB));
562049d1499SBarry Smith   PetscCheck(nrmB <= 0 || nrmT / nrmB < PETSC_SMALL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix is not symmetric/hermitian, GKB is not applicable.");
563049d1499SBarry Smith 
564a51937d4SCarola Kruse   /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */
565a51937d4SCarola Kruse   /* setting N := 1/nu*I in [Ar13].                                                 */
5669566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(B, MAT_INITIAL_MATRIX, &BT));
5679566063dSJacob Faibussowitsch   PetscCall(MatMatMult(B, BT, MAT_INITIAL_MATRIX, PETSC_DEFAULT, H)); /* H = A01*A01'          */
5689566063dSJacob Faibussowitsch   PetscCall(MatAYPX(*H, gkbnu, A, DIFFERENT_NONZERO_PATTERN));        /* H = A00 + nu*A01*A01' */
569a51937d4SCarola Kruse 
5709566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&BT));
5719566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&T));
5723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
573a51937d4SCarola Kruse }
574a51937d4SCarola Kruse 
57554a546c1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions, const char pre[], const char name[], const char *option[], const char *value[], PetscBool *flg);
576514bf10dSMatthew G Knepley 
577d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_FieldSplit(PC pc)
578d71ae5a4SJacob Faibussowitsch {
57969a612a9SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
5805a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
5812c9966d7SBarry Smith   PetscInt          i, nsplit;
582*80670ca5SBarry Smith   PetscBool         sorted, sorted_col, matnest = PETSC_FALSE;
58369a612a9SBarry Smith 
58469a612a9SBarry Smith   PetscFunctionBegin;
5855da88fe4STristan Konolige   pc->failedreason = PC_NOERROR;
5869566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDefaults(pc));
58797bbdb24SBarry Smith   nsplit = jac->nsplits;
5885a9f2f41SSatish Balay   ilink  = jac->head;
589*80670ca5SBarry Smith   if (pc->pmat) PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest));
59097bbdb24SBarry Smith 
59197bbdb24SBarry Smith   /* get the matrices for each split */
592704ba839SBarry Smith   if (!jac->issetup) {
5931b9fc7fcSBarry Smith     PetscInt rstart, rend, nslots, bs;
59497bbdb24SBarry Smith 
595704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
596704ba839SBarry Smith 
5975d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
5982c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
5992c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
6002c9966d7SBarry Smith     }
6014db63379SBarry Smith 
6024db63379SBarry Smith     /*  MatCreateSubMatrix() for [S]BAIJ matrices can only work if the indices include entire blocks of the matrix */
6034db63379SBarry Smith     PetscCall(MatGetBlockSize(pc->pmat, &bs));
6044db63379SBarry Smith     if (bs > 1 && (jac->bs <= bs || jac->bs % bs)) {
6054db63379SBarry Smith       PetscBool blk;
6064db63379SBarry Smith 
6074db63379SBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)pc->pmat, &blk, MATBAIJ, MATSBAIJ, MATSEQBAIJ, MATSEQSBAIJ, MATMPIBAIJ, MATMPISBAIJ, NULL));
6084db63379SBarry Smith       PetscCheck(!blk, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Cannot use MATBAIJ with PCFIELDSPLIT and currently set matrix and PC blocksizes");
6094db63379SBarry Smith     }
6104db63379SBarry Smith 
611*80670ca5SBarry Smith     if (!matnest) { /* use the matrix blocksize and stride IS to determine the index sets that define the submatrices */
61251f519a2SBarry Smith       bs = jac->bs;
6139566063dSJacob Faibussowitsch       PetscCall(MatGetOwnershipRange(pc->pmat, &rstart, &rend));
6141b9fc7fcSBarry Smith       nslots = (rend - rstart) / bs;
6151b9fc7fcSBarry Smith       for (i = 0; i < nsplit; i++) {
6161b9fc7fcSBarry Smith         if (jac->defaultsplit) {
6179566063dSJacob Faibussowitsch           PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + i, nsplit, &ilink->is));
6189566063dSJacob Faibussowitsch           PetscCall(ISDuplicate(ilink->is, &ilink->is_col));
619704ba839SBarry Smith         } else if (!ilink->is) {
620ccb205f8SBarry Smith           if (ilink->nfields > 1) {
6215f4ab4e1SJungho Lee             PetscInt *ii, *jj, j, k, nfields = ilink->nfields, *fields = ilink->fields, *fields_col = ilink->fields_col;
622*80670ca5SBarry Smith 
6239566063dSJacob Faibussowitsch             PetscCall(PetscMalloc1(ilink->nfields * nslots, &ii));
6249566063dSJacob Faibussowitsch             PetscCall(PetscMalloc1(ilink->nfields * nslots, &jj));
6251b9fc7fcSBarry Smith             for (j = 0; j < nslots; j++) {
6261b9fc7fcSBarry Smith               for (k = 0; k < nfields; k++) {
6271b9fc7fcSBarry Smith                 ii[nfields * j + k] = rstart + bs * j + fields[k];
6285f4ab4e1SJungho Lee                 jj[nfields * j + k] = rstart + bs * j + fields_col[k];
62997bbdb24SBarry Smith               }
63097bbdb24SBarry Smith             }
6319566063dSJacob Faibussowitsch             PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, ii, PETSC_OWN_POINTER, &ilink->is));
6329566063dSJacob Faibussowitsch             PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, jj, PETSC_OWN_POINTER, &ilink->is_col));
6339566063dSJacob Faibussowitsch             PetscCall(ISSetBlockSize(ilink->is, nfields));
6349566063dSJacob Faibussowitsch             PetscCall(ISSetBlockSize(ilink->is_col, nfields));
635ccb205f8SBarry Smith           } else {
6369566063dSJacob Faibussowitsch             PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields[0], bs, &ilink->is));
6379566063dSJacob Faibussowitsch             PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields_col[0], bs, &ilink->is_col));
638ccb205f8SBarry Smith           }
6393e197d65SBarry Smith         }
6409566063dSJacob Faibussowitsch         PetscCall(ISSorted(ilink->is, &sorted));
6419566063dSJacob Faibussowitsch         if (ilink->is_col) PetscCall(ISSorted(ilink->is_col, &sorted_col));
6427827d75bSBarry Smith         PetscCheck(sorted && sorted_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Fields must be sorted when creating split");
643704ba839SBarry Smith         ilink = ilink->next;
6441b9fc7fcSBarry Smith       }
645*80670ca5SBarry Smith     } else { /* use the IS that define the MATNEST to determine the index sets that define the submatrices */
646*80670ca5SBarry Smith       IS      *rowis, *colis, *ises = NULL;
647*80670ca5SBarry Smith       PetscInt mis, nis;
648*80670ca5SBarry Smith 
649*80670ca5SBarry Smith       PetscCall(MatNestGetSize(pc->pmat, &mis, &nis));
650*80670ca5SBarry Smith       PetscCall(PetscMalloc2(mis, &rowis, nis, &colis));
651*80670ca5SBarry Smith       PetscCall(MatNestGetISs(pc->pmat, rowis, colis));
652*80670ca5SBarry Smith       if (!jac->defaultsplit) PetscCall(PetscMalloc1(mis, &ises));
653*80670ca5SBarry Smith 
654*80670ca5SBarry Smith       for (i = 0; i < nsplit; i++) {
655*80670ca5SBarry Smith         if (jac->defaultsplit) {
656*80670ca5SBarry Smith           PetscCall(ISDuplicate(rowis[i], &ilink->is));
657*80670ca5SBarry Smith           PetscCall(ISDuplicate(ilink->is, &ilink->is_col));
658*80670ca5SBarry Smith         } else if (!ilink->is) {
659*80670ca5SBarry Smith           if (ilink->nfields > 1) {
660*80670ca5SBarry Smith             for (PetscInt j = 0; j < ilink->nfields; j++) ises[j] = rowis[ilink->fields[j]];
661*80670ca5SBarry Smith             PetscCall(ISConcatenate(PetscObjectComm((PetscObject)pc), ilink->nfields, ises, &ilink->is));
662*80670ca5SBarry Smith           } else {
663*80670ca5SBarry Smith             PetscCall(ISDuplicate(rowis[ilink->fields[0]], &ilink->is));
664*80670ca5SBarry Smith           }
665*80670ca5SBarry Smith           PetscCall(ISDuplicate(ilink->is, &ilink->is_col));
666*80670ca5SBarry Smith         }
667*80670ca5SBarry Smith         ilink = ilink->next;
668*80670ca5SBarry Smith       }
669*80670ca5SBarry Smith       PetscCall(PetscFree2(rowis, colis));
670*80670ca5SBarry Smith       PetscCall(PetscFree(ises));
671*80670ca5SBarry Smith     }
6721b9fc7fcSBarry Smith   }
6731b9fc7fcSBarry Smith 
674704ba839SBarry Smith   ilink = jac->head;
67597bbdb24SBarry Smith   if (!jac->pmat) {
676bdddcaaaSMatthew G Knepley     Vec xtmp;
677bdddcaaaSMatthew G Knepley 
6789566063dSJacob Faibussowitsch     PetscCall(MatCreateVecs(pc->pmat, &xtmp, NULL));
6799566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nsplit, &jac->pmat));
6809566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nsplit, &jac->x, nsplit, &jac->y));
681cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
682bdddcaaaSMatthew G Knepley       MatNullSpace sp;
683bdddcaaaSMatthew G Knepley 
684a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
6859566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&jac->pmat[i]));
686a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
6879566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->pmat[i]));
688a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
689a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
6902fa5cd67SKarl Rupp 
6919566063dSJacob Faibussowitsch           PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
692a3df900dSMatthew G Knepley         }
693a3df900dSMatthew G Knepley       } else {
6943a062f41SBarry Smith         const char *prefix;
6959566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->pmat[i]));
6962f427464SPierre Jolivet         PetscCall(MatGetOptionsPrefix(jac->pmat[i], &prefix));
6972f427464SPierre Jolivet         if (!prefix) {
6989566063dSJacob Faibussowitsch           PetscCall(KSPGetOptionsPrefix(ilink->ksp, &prefix));
6999566063dSJacob Faibussowitsch           PetscCall(MatSetOptionsPrefix(jac->pmat[i], prefix));
7002f427464SPierre Jolivet         }
70145881c45SPierre Jolivet         PetscCall(MatSetFromOptions(jac->pmat[i]));
7029566063dSJacob Faibussowitsch         PetscCall(MatViewFromOptions(jac->pmat[i], NULL, "-mat_view"));
703a3df900dSMatthew G Knepley       }
704bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
7059566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(jac->pmat[i], &jac->x[i], &jac->y[i]));
7069371c9d4SSatish Balay       ilink->x = jac->x[i];
7079371c9d4SSatish Balay       ilink->y = jac->y[i];
7089371c9d4SSatish Balay       ilink->z = NULL;
709bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
7109566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(xtmp, ilink->is, jac->x[i], NULL, &ilink->sctx));
7119566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nearnullspace", (PetscObject *)&sp));
71248a46eb9SPierre Jolivet       if (sp) PetscCall(MatSetNearNullSpace(jac->pmat[i], sp));
713704ba839SBarry Smith       ilink = ilink->next;
714cf502942SBarry Smith     }
7159566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&xtmp));
71697bbdb24SBarry Smith   } else {
717ef7efd37SHong Zhang     MatReuse      scall;
7184849c82aSBarry Smith     MatNullSpace *nullsp = NULL;
7194849c82aSBarry Smith 
720ef7efd37SHong Zhang     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7214849c82aSBarry Smith       PetscCall(MatGetNullSpaces(nsplit, jac->pmat, &nullsp));
72248a46eb9SPierre Jolivet       for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->pmat[i]));
723ef7efd37SHong Zhang       scall = MAT_INITIAL_MATRIX;
724ef7efd37SHong Zhang     } else scall = MAT_REUSE_MATRIX;
725ef7efd37SHong Zhang 
726cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
727a3df900dSMatthew G Knepley       Mat pmat;
728a3df900dSMatthew G Knepley 
729a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
7309566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&pmat));
73148a46eb9SPierre Jolivet       if (!pmat) PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, scall, &jac->pmat[i]));
732704ba839SBarry Smith       ilink = ilink->next;
733cf502942SBarry Smith     }
7344849c82aSBarry Smith     if (nullsp) PetscCall(MatRestoreNullSpaces(nsplit, jac->pmat, &nullsp));
73597bbdb24SBarry Smith   }
7364e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
737519d70e2SJed Brown     ilink = jac->head;
738519d70e2SJed Brown     if (!jac->mat) {
7399566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nsplit, &jac->mat));
740519d70e2SJed Brown       for (i = 0; i < nsplit; i++) {
7419566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->mat[i]));
742519d70e2SJed Brown         ilink = ilink->next;
743519d70e2SJed Brown       }
744519d70e2SJed Brown     } else {
745ef7efd37SHong Zhang       MatReuse      scall;
7464849c82aSBarry Smith       MatNullSpace *nullsp = NULL;
7474849c82aSBarry Smith 
748ef7efd37SHong Zhang       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7494849c82aSBarry Smith         PetscCall(MatGetNullSpaces(nsplit, jac->mat, &nullsp));
75048a46eb9SPierre Jolivet         for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->mat[i]));
751ef7efd37SHong Zhang         scall = MAT_INITIAL_MATRIX;
752ef7efd37SHong Zhang       } else scall = MAT_REUSE_MATRIX;
753ef7efd37SHong Zhang 
754ef7efd37SHong Zhang       for (i = 0; i < nsplit; i++) {
7559566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, scall, &jac->mat[i]));
756519d70e2SJed Brown         ilink = ilink->next;
757519d70e2SJed Brown       }
7584849c82aSBarry Smith       if (nullsp) PetscCall(MatRestoreNullSpaces(nsplit, jac->mat, &nullsp));
759519d70e2SJed Brown     }
760519d70e2SJed Brown   } else {
761519d70e2SJed Brown     jac->mat = jac->pmat;
762519d70e2SJed Brown   }
76397bbdb24SBarry Smith 
76453935eafSBarry Smith   /* Check for null space attached to IS */
76553935eafSBarry Smith   ilink = jac->head;
76653935eafSBarry Smith   for (i = 0; i < nsplit; i++) {
76753935eafSBarry Smith     MatNullSpace sp;
76853935eafSBarry Smith 
7699566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nullspace", (PetscObject *)&sp));
77048a46eb9SPierre Jolivet     if (sp) PetscCall(MatSetNullSpace(jac->mat[i], sp));
77153935eafSBarry Smith     ilink = ilink->next;
77253935eafSBarry Smith   }
77353935eafSBarry Smith 
774a51937d4SCarola Kruse   if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) {
77568dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
7764e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
77768dd23aaSBarry Smith     ilink = jac->head;
778e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
779e52d2c62SBarry 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 */
780e52d2c62SBarry Smith       if (!jac->Afield) {
7819566063dSJacob Faibussowitsch         PetscCall(PetscCalloc1(nsplit, &jac->Afield));
78280c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7839566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
784e52d2c62SBarry Smith         } else {
7859566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
78680c96bb1SFande Kong         }
78780c96bb1SFande Kong       } else {
788ef7efd37SHong Zhang         MatReuse scall;
789e9422dd5SStefano Zampini 
790ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7919566063dSJacob Faibussowitsch           PetscCall(MatDestroy(&jac->Afield[1]));
792ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
793ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
794ef7efd37SHong Zhang 
79580c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7969566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
79780c96bb1SFande Kong         } else {
7989566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
79980c96bb1SFande Kong         }
800e52d2c62SBarry Smith       }
801e52d2c62SBarry Smith     } else {
80268dd23aaSBarry Smith       if (!jac->Afield) {
8039566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nsplit, &jac->Afield));
80468dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
80580c96bb1SFande Kong           if (jac->offdiag_use_amat) {
8069566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
80780c96bb1SFande Kong           } else {
8089566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
80980c96bb1SFande Kong           }
81068dd23aaSBarry Smith           ilink = ilink->next;
81168dd23aaSBarry Smith         }
81268dd23aaSBarry Smith       } else {
813ef7efd37SHong Zhang         MatReuse scall;
814ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
81548a46eb9SPierre Jolivet           for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->Afield[i]));
816ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
817ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
818ef7efd37SHong Zhang 
81968dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
82080c96bb1SFande Kong           if (jac->offdiag_use_amat) {
8219566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, scall, &jac->Afield[i]));
82280c96bb1SFande Kong           } else {
8239566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, scall, &jac->Afield[i]));
82480c96bb1SFande Kong           }
82568dd23aaSBarry Smith           ilink = ilink->next;
82668dd23aaSBarry Smith         }
82768dd23aaSBarry Smith       }
82868dd23aaSBarry Smith     }
829e52d2c62SBarry Smith   }
83068dd23aaSBarry Smith 
8313b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
8323b224e63SBarry Smith     IS          ccis;
833b94d7dedSBarry Smith     PetscBool   isset, isspd;
8344aa3045dSJed Brown     PetscInt    rstart, rend;
835093c86ffSJed Brown     char        lscname[256];
836093c86ffSJed Brown     PetscObject LSC_L;
837558f3fe8SPierre Jolivet     PetscBool   set, flg;
838ce94432eSBarry Smith 
83908401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use Schur complement preconditioner you must have exactly 2 fields");
84068dd23aaSBarry Smith 
841c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
842c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
843b94d7dedSBarry Smith       PetscCall(MatIsSPDKnown(pc->pmat, &isset, &isspd));
844b94d7dedSBarry Smith       jac->schurscale = (isset && isspd) ? 1.0 : -1.0;
845c096484dSStefano Zampini     }
846c096484dSStefano Zampini 
847e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
8489566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend));
849558f3fe8SPierre Jolivet     PetscCall(PetscObjectTypeCompareAny(jac->offdiag_use_amat ? (PetscObject)pc->mat : (PetscObject)pc->pmat, &flg, MATSEQSBAIJ, MATMPISBAIJ, ""));
850e6cab6aaSJed Brown 
8513b224e63SBarry Smith     if (jac->schur) {
8520298fd71SBarry Smith       KSP      kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
853e9422dd5SStefano Zampini       MatReuse scall;
854e9422dd5SStefano Zampini 
855e9422dd5SStefano Zampini       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
856e9422dd5SStefano Zampini         scall = MAT_INITIAL_MATRIX;
8579566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->B));
8589566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->C));
859e9422dd5SStefano Zampini       } else scall = MAT_REUSE_MATRIX;
860443836d0SMatthew G Knepley 
8619566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
8623b224e63SBarry Smith       ilink = jac->head;
8639566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8644e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8659566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->B));
866c84da90fSDmitry Karpeev       } else {
8679566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->B));
868c84da90fSDmitry Karpeev       }
8699566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
870558f3fe8SPierre Jolivet       if (!flg) {
8713b224e63SBarry Smith         ilink = ilink->next;
8729566063dSJacob Faibussowitsch         PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8734e39094bSDmitry Karpeev         if (jac->offdiag_use_amat) {
8749566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->C));
875c84da90fSDmitry Karpeev         } else {
8769566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->C));
877c84da90fSDmitry Karpeev         }
8789566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&ccis));
879558f3fe8SPierre Jolivet       } else {
880558f3fe8SPierre Jolivet         PetscCall(MatIsHermitianKnown(jac->offdiag_use_amat ? pc->mat : pc->pmat, &set, &flg));
881558f3fe8SPierre Jolivet         if (set && flg) PetscCall(MatCreateHermitianTranspose(jac->B, &jac->C));
882558f3fe8SPierre Jolivet         else PetscCall(MatCreateTranspose(jac->B, &jac->C));
883558f3fe8SPierre Jolivet       }
8849566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementUpdateSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
885a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
8869566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->schurp));
8879566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
888a7476a74SDmitry Karpeev       }
88948a46eb9SPierre Jolivet       if (kspA != kspInner) PetscCall(KSPSetOperators(kspA, jac->mat[0], jac->pmat[0]));
89048a46eb9SPierre Jolivet       if (kspUpper != kspA) PetscCall(KSPSetOperators(kspUpper, jac->mat[0], jac->pmat[0]));
8919566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
8923b224e63SBarry Smith     } else {
893bafc1b83SMatthew G Knepley       const char  *Dprefix;
894470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
895514bf10dSMatthew G Knepley       char         schurtestoption[256];
896bdddcaaaSMatthew G Knepley       MatNullSpace sp;
897686bed4dSStefano Zampini       KSP          kspt;
8983b224e63SBarry Smith 
899a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
9003b224e63SBarry Smith       ilink = jac->head;
9019566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
9024e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
9039566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
904c84da90fSDmitry Karpeev       } else {
9059566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
906c84da90fSDmitry Karpeev       }
9079566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
9083b224e63SBarry Smith       ilink = ilink->next;
909558f3fe8SPierre Jolivet       if (!flg) {
9109566063dSJacob Faibussowitsch         PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
9114e39094bSDmitry Karpeev         if (jac->offdiag_use_amat) {
9129566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
913c84da90fSDmitry Karpeev         } else {
9149566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
915c84da90fSDmitry Karpeev         }
9169566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&ccis));
917558f3fe8SPierre Jolivet       } else {
918558f3fe8SPierre Jolivet         PetscCall(MatIsHermitianKnown(jac->offdiag_use_amat ? pc->mat : pc->pmat, &set, &flg));
919558f3fe8SPierre Jolivet         if (set && flg) PetscCall(MatCreateHermitianTranspose(jac->B, &jac->C));
920558f3fe8SPierre Jolivet         else PetscCall(MatCreateTranspose(jac->B, &jac->C));
921558f3fe8SPierre Jolivet       }
922f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
9239566063dSJacob Faibussowitsch       PetscCall(MatCreate(((PetscObject)jac->mat[0])->comm, &jac->schur));
9249566063dSJacob Faibussowitsch       PetscCall(MatSetType(jac->schur, MATSCHURCOMPLEMENT));
9259566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementSetSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
9269566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
9279566063dSJacob Faibussowitsch       PetscCall(MatSetOptionsPrefix(jac->schur, schurmatprefix));
9289566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspt));
9299566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(kspt, schurmatprefix));
930686bed4dSStefano Zampini 
931686bed4dSStefano Zampini       /* Note: this is not true in general */
9329566063dSJacob Faibussowitsch       PetscCall(MatGetNullSpace(jac->mat[1], &sp));
9331baa6e33SBarry Smith       if (sp) PetscCall(MatSetNullSpace(jac->schur, sp));
93420252d06SBarry Smith 
9359566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname));
93654a546c1SMatthew G. Knepley       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, NULL, &flg));
937514bf10dSMatthew G Knepley       if (flg) {
938514bf10dSMatthew G Knepley         DM  dmInner;
93921635b76SJed Brown         KSP kspInner;
940686bed4dSStefano Zampini         PC  pcInner;
94121635b76SJed Brown 
9429566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
9439566063dSJacob Faibussowitsch         PetscCall(KSPReset(kspInner));
9449566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(kspInner, jac->mat[0], jac->pmat[0]));
9459566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
94621635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
9479566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject)pc, 2));
9489566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject)pc, 2));
9499566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(kspInner, schurprefix));
950514bf10dSMatthew G Knepley 
951514bf10dSMatthew G Knepley         /* Set DM for new solver */
9529566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
9539566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(kspInner, dmInner));
9549566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(kspInner, PETSC_FALSE));
955686bed4dSStefano Zampini 
956686bed4dSStefano Zampini         /* Defaults to PCKSP as preconditioner */
9579566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9589566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcInner, PCKSP));
9599566063dSJacob Faibussowitsch         PetscCall(PCKSPSetKSP(pcInner, jac->head->ksp));
960514bf10dSMatthew G Knepley       } else {
96121635b76SJed Brown         /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
96221635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
96321635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
96421635b76SJed 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
96521635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
96621635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
9679566063dSJacob Faibussowitsch         PetscCall(KSPSetType(jac->head->ksp, KSPGMRES));
9689566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementSetKSP(jac->schur, jac->head->ksp));
969bafc1b83SMatthew G Knepley       }
9709566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->head->ksp, jac->mat[0], jac->pmat[0]));
9719566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->head->ksp));
9729566063dSJacob Faibussowitsch       PetscCall(MatSetFromOptions(jac->schur));
9733b224e63SBarry Smith 
9749566063dSJacob Faibussowitsch       PetscCall(PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg));
975686bed4dSStefano Zampini       if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */
976686bed4dSStefano Zampini         KSP kspInner;
977686bed4dSStefano Zampini         PC  pcInner;
978686bed4dSStefano Zampini 
9799566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
9809566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9819566063dSJacob Faibussowitsch         PetscCall(PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg));
982686bed4dSStefano Zampini         if (flg) {
983686bed4dSStefano Zampini           KSP ksp;
984686bed4dSStefano Zampini 
9859566063dSJacob Faibussowitsch           PetscCall(PCKSPGetKSP(pcInner, &ksp));
98648a46eb9SPierre Jolivet           if (ksp == jac->head->ksp) PetscCall(PCSetUseAmat(pcInner, PETSC_TRUE));
987686bed4dSStefano Zampini         }
988686bed4dSStefano Zampini       }
9899566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname));
99054a546c1SMatthew G. Knepley       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, NULL, &flg));
991443836d0SMatthew G Knepley       if (flg) {
992443836d0SMatthew G Knepley         DM dmInner;
993443836d0SMatthew G Knepley 
9949566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
9959566063dSJacob Faibussowitsch         PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper));
9963821be0aSBarry Smith         PetscCall(KSPSetNestLevel(jac->kspupper, pc->kspnestlevel));
9979566063dSJacob Faibussowitsch         PetscCall(KSPSetErrorIfNotConverged(jac->kspupper, pc->erroriffailure));
9989566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(jac->kspupper, schurprefix));
9999566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject)pc, 1));
10009566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject)pc, 1));
10019566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
10029566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(jac->kspupper, dmInner));
10039566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(jac->kspupper, PETSC_FALSE));
10049566063dSJacob Faibussowitsch         PetscCall(KSPSetFromOptions(jac->kspupper));
10059566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(jac->kspupper, jac->mat[0], jac->pmat[0]));
10069566063dSJacob Faibussowitsch         PetscCall(VecDuplicate(jac->head->x, &jac->head->z));
1007443836d0SMatthew G Knepley       } else {
1008443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
10099566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->head->ksp));
1010443836d0SMatthew G Knepley       }
1011443836d0SMatthew G Knepley 
101248a46eb9SPierre Jolivet       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
10139566063dSJacob Faibussowitsch       PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspschur));
10143821be0aSBarry Smith       PetscCall(KSPSetNestLevel(jac->kspschur, pc->kspnestlevel));
10159566063dSJacob Faibussowitsch       PetscCall(KSPSetErrorIfNotConverged(jac->kspschur, pc->erroriffailure));
10169566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspschur, (PetscObject)pc, 1));
1017084e4875SJed Brown       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
10187233a360SDmitry Karpeev         PC pcschur;
10199566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(jac->kspschur, &pcschur));
10209566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcschur, PCNONE));
1021084e4875SJed Brown         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
1022e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
10239566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
1024e69d4d44SBarry Smith       }
10259566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
10269566063dSJacob Faibussowitsch       PetscCall(KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix));
10279566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(jac->kspschur, Dprefix));
1028c096484dSStefano Zampini       /* propagate DM */
1029b20b4189SMatthew G. Knepley       {
1030b20b4189SMatthew G. Knepley         DM sdm;
10319566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->next->ksp, &sdm));
1032b20b4189SMatthew G. Knepley         if (sdm) {
10339566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(jac->kspschur, sdm));
10349566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(jac->kspschur, PETSC_FALSE));
1035b20b4189SMatthew G. Knepley         }
1036b20b4189SMatthew G. Knepley       }
10373b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
103820b26d62SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
10399566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->kspschur));
10403b224e63SBarry Smith     }
10419566063dSJacob Faibussowitsch     PetscCall(MatAssemblyBegin(jac->schur, MAT_FINAL_ASSEMBLY));
10429566063dSJacob Faibussowitsch     PetscCall(MatAssemblyEnd(jac->schur, MAT_FINAL_ASSEMBLY));
1043093c86ffSJed Brown 
1044093c86ffSJed Brown     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
10459566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_L", ilink->splitname));
10469566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L));
10479566063dSJacob Faibussowitsch     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L));
10489566063dSJacob Faibussowitsch     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_L", (PetscObject)LSC_L));
10499566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_Lp", ilink->splitname));
10509566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L));
10519566063dSJacob Faibussowitsch     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L));
10529566063dSJacob Faibussowitsch     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_Lp", (PetscObject)LSC_L));
1053a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1054a51937d4SCarola Kruse     IS       ccis;
1055a51937d4SCarola Kruse     PetscInt rstart, rend;
1056a51937d4SCarola Kruse 
105708401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use GKB preconditioner you must have exactly 2 fields");
1058a51937d4SCarola Kruse 
1059a51937d4SCarola Kruse     ilink = jac->head;
1060a51937d4SCarola Kruse 
1061a51937d4SCarola Kruse     /* When extracting off-diagonal submatrices, we take complements from this range */
10629566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend));
1063a51937d4SCarola Kruse 
10649566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
1065a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
10669566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
1067a51937d4SCarola Kruse     } else {
10689566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
1069a51937d4SCarola Kruse     }
10709566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ccis));
1071e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
10729566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->u));
10739566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->Hu));
10749566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w2));
1075a51937d4SCarola Kruse     ilink = ilink->next;
10769566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
1077a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
10789566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
1079a51937d4SCarola Kruse     } else {
10809566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
1081a51937d4SCarola Kruse     }
10829566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ccis));
1083e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
10849566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->v));
10859566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->d));
10869566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w1));
10879566063dSJacob Faibussowitsch     PetscCall(MatGolubKahanComputeExplicitOperator(jac->mat[0], jac->B, jac->C, &jac->H, jac->gkbnu));
10889566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(jac->gkbdelay, &jac->vecz));
1089e071a0a4SCarola Kruse 
1090a51937d4SCarola Kruse     ilink = jac->head;
10919566063dSJacob Faibussowitsch     PetscCall(KSPSetOperators(ilink->ksp, jac->H, jac->H));
10929566063dSJacob Faibussowitsch     if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
1093e071a0a4SCarola Kruse     /* Create gkb_monitor context */
1094de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1095de482cd7SCarola Kruse       PetscInt tablevel;
10969566063dSJacob Faibussowitsch       PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &jac->gkbviewer));
10979566063dSJacob Faibussowitsch       PetscCall(PetscViewerSetType(jac->gkbviewer, PETSCVIEWERASCII));
10989566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetTabLevel((PetscObject)ilink->ksp, &tablevel));
10999566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISetTab(jac->gkbviewer, tablevel));
11009566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)ilink->ksp, 1));
1101de482cd7SCarola Kruse     }
11023b224e63SBarry Smith   } else {
110368bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
110497bbdb24SBarry Smith     i     = 0;
11055a9f2f41SSatish Balay     ilink = jac->head;
11065a9f2f41SSatish Balay     while (ilink) {
11079566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(ilink->ksp, jac->mat[i], jac->pmat[i]));
11083b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
11099566063dSJacob Faibussowitsch       if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
111097bbdb24SBarry Smith       i++;
11115a9f2f41SSatish Balay       ilink = ilink->next;
11120971522cSBarry Smith     }
11133b224e63SBarry Smith   }
11143b224e63SBarry Smith 
11155ddf11f8SNicolas Barnafi   /* Set coordinates to the sub PC objects whenever these are set */
11165ddf11f8SNicolas Barnafi   if (jac->coordinates_set) {
11175ddf11f8SNicolas Barnafi     PC pc_coords;
11185ddf11f8SNicolas Barnafi     if (jac->type == PC_COMPOSITE_SCHUR) {
11195ddf11f8SNicolas Barnafi       // Head is first block.
11209566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->head->ksp, &pc_coords));
11219566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->dim, jac->head->ndofs, jac->head->coords));
11225ddf11f8SNicolas Barnafi       // Second one is Schur block, but its KSP object is in kspschur.
11239566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->kspschur, &pc_coords));
11249566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->next->dim, jac->head->next->ndofs, jac->head->next->coords));
11255ddf11f8SNicolas Barnafi     } else if (jac->type == PC_COMPOSITE_GKB) {
11269d3446b2SPierre Jolivet       PetscCall(PetscInfo(pc, "Warning: Setting coordinates does nothing for the GKB Fieldpslit preconditioner\n"));
11275ddf11f8SNicolas Barnafi     } else {
11285ddf11f8SNicolas Barnafi       ilink = jac->head;
11295ddf11f8SNicolas Barnafi       while (ilink) {
11309566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(ilink->ksp, &pc_coords));
11319566063dSJacob Faibussowitsch         PetscCall(PCSetCoordinates(pc_coords, ilink->dim, ilink->ndofs, ilink->coords));
11325ddf11f8SNicolas Barnafi         ilink = ilink->next;
11335ddf11f8SNicolas Barnafi       }
11345ddf11f8SNicolas Barnafi     }
11355ddf11f8SNicolas Barnafi   }
11365ddf11f8SNicolas Barnafi 
1137c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
11383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11390971522cSBarry Smith }
11400971522cSBarry Smith 
11415a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink, xx, yy) \
11423ba16761SJacob Faibussowitsch   ((PetscErrorCode)(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) || \
11439371c9d4SSatish 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) || \
11443ba16761SJacob Faibussowitsch                     VecScatterEnd(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE)))
114579416396SBarry Smith 
1146d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_Schur(PC pc, Vec x, Vec y)
1147d71ae5a4SJacob Faibussowitsch {
11483b224e63SBarry Smith   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
11493b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1150443836d0SMatthew G Knepley   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
11513b224e63SBarry Smith 
11523b224e63SBarry Smith   PetscFunctionBegin;
1153c5d2311dSJed Brown   switch (jac->schurfactorization) {
1154c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
1155a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
11569566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11579566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11589566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11599566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11609566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11619566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11629566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11639566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11649566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11659566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11669566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11679566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
11689566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11699566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->y, jac->schurscale));
11709566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11719566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11729566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1173c5d2311dSJed Brown     break;
1174c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
1175a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
11769566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11779566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11789566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11799566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11809566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11819566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11829566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
11839566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.));
11849566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11859566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11869566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11879566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11889566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11899566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
11909566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11919566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11929566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11939566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1194c5d2311dSJed Brown     break;
1195c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
1196a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
11979566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11989566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11999566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12009566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
12019566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12029371c9d4SSatish Balay     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12039371c9d4SSatish Balay     PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
12049566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkA->x, -1.));
12059566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
12069566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12079566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
12089566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12099566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
12109566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12119566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12129566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12139566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12149566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1215c5d2311dSJed Brown     break;
1216c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
1217c238f8cdSStefano Zampini     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */
12189566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12199566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12209566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
12219566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspLower, ilinkA->x, ilinkA->y));
12229566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->y));
12239566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
12249566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
12259566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.0));
12269566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12279566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12283b224e63SBarry Smith 
12299566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12309566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
12319566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12329566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12339566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12343b224e63SBarry Smith 
1235443836d0SMatthew G Knepley     if (kspUpper == kspA) {
12369566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->y));
12379566063dSJacob Faibussowitsch       PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y));
12389566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12399566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
12409566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12419566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
1242443836d0SMatthew G Knepley     } else {
12439566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12449566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
12459566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12469566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
12479566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
12489566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspUpper, ilinkA->x, ilinkA->z));
12499566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->z));
12509566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
12519566063dSJacob Faibussowitsch       PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z));
1252443836d0SMatthew G Knepley     }
12539566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12549566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12559566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1256c5d2311dSJed Brown   }
12573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12583b224e63SBarry Smith }
12593b224e63SBarry Smith 
12607b665727SPierre Jolivet static PetscErrorCode PCApplyTranspose_FieldSplit_Schur(PC pc, Vec x, Vec y)
12617b665727SPierre Jolivet {
12627b665727SPierre Jolivet   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
12637b665727SPierre Jolivet   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
12647b665727SPierre Jolivet   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
12657b665727SPierre Jolivet 
12667b665727SPierre Jolivet   PetscFunctionBegin;
12677b665727SPierre Jolivet   switch (jac->schurfactorization) {
12687b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
12697b665727SPierre Jolivet     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
12707b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12717b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12727b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12737b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12747b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
12757b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12767b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12777b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12787b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12797b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12807b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
12817b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12827b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12837b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->y, jac->schurscale));
12847b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12857b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12867b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12877b665727SPierre Jolivet     break;
12887b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
12897b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12907b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12917b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12927b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
12937b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12947b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12957b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x));
12967b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->x, -1.));
12977b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12987b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12997b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13007b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13017b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
13027b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13037b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13047b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13057b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13067b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13077b665727SPierre Jolivet     break;
13087b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
13097b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
13107b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
13117b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13127b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
13137b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13147b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13157b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x));
13167b665727SPierre Jolivet     PetscCall(VecScale(ilinkA->x, -1.));
13177b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
13187b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13197b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
13207b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13217b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
13227b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13237b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13247b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13257b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13267b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13277b665727SPierre Jolivet     break;
13287b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
13297b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13307b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13317b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL));
13327b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspUpper, ilinkA->x, ilinkA->y));
13337b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->y));
13347b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL));
13357b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x));
13367b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->x, -1.0));
13377b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13387b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13397b665727SPierre Jolivet 
13407b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13417b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
13427b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13437b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13447b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13457b665727SPierre Jolivet 
13467b665727SPierre Jolivet     if (kspLower == kspA) {
13477b665727SPierre Jolivet       PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->y));
13487b665727SPierre Jolivet       PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y));
13497b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13507b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
13517b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13527b665727SPierre Jolivet       PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13537b665727SPierre Jolivet     } else {
13547b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13557b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
13567b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13577b665727SPierre Jolivet       PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x));
13587b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL));
13597b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspLower, ilinkA->x, ilinkA->z));
13607b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->z));
13617b665727SPierre Jolivet       PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL));
13627b665727SPierre Jolivet       PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z));
13637b665727SPierre Jolivet     }
13647b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13657b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13667b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13677b665727SPierre Jolivet   }
13687b665727SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
13697b665727SPierre Jolivet }
13707b665727SPierre Jolivet 
1371d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit(PC pc, Vec x, Vec y)
1372d71ae5a4SJacob Faibussowitsch {
13730971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
13745a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
1375939b8a20SBarry Smith   PetscInt          cnt, bs;
13760971522cSBarry Smith 
13770971522cSBarry Smith   PetscFunctionBegin;
137879416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1379*80670ca5SBarry Smith     PetscBool matnest;
1380*80670ca5SBarry Smith 
1381*80670ca5SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest));
1382*80670ca5SBarry Smith     if (jac->defaultsplit && !matnest) {
13839566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
13842472a847SBarry 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);
13859566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
13862472a847SBarry 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);
13879566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
13885a9f2f41SSatish Balay       while (ilink) {
13899566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
13909566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
13919566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
13929566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
13935a9f2f41SSatish Balay         ilink = ilink->next;
13940971522cSBarry Smith       }
13959566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
13961b9fc7fcSBarry Smith     } else {
13979566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
13985a9f2f41SSatish Balay       while (ilink) {
13999566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
14005a9f2f41SSatish Balay         ilink = ilink->next;
14011b9fc7fcSBarry Smith       }
14021b9fc7fcSBarry Smith     }
1403e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
14049566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1405e52d2c62SBarry Smith     /* solve on first block for first block variables */
14069566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
14079566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
14089566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14099566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
14109566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14119566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14129566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
14139566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
1414e52d2c62SBarry Smith 
1415e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
14169566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->Afield[1], ilink->y, ilink->next->x));
1417e52d2c62SBarry Smith     ilink = ilink->next;
14189566063dSJacob Faibussowitsch     PetscCall(VecScale(ilink->x, -1.0));
14199566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
14209566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
1421e52d2c62SBarry Smith 
1422e52d2c62SBarry Smith     /* solve on second block variables */
14239566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14249566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
14259566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14269566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14279566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
14289566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
142916913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
143079416396SBarry Smith     if (!jac->w1) {
14319566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
14329566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
143379416396SBarry Smith     }
14349566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
14359566063dSJacob Faibussowitsch     PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
14363e197d65SBarry Smith     cnt = 1;
14375a9f2f41SSatish Balay     while (ilink->next) {
14385a9f2f41SSatish Balay       ilink = ilink->next;
14393e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
14409566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->Afield[cnt++], y, ilink->x));
14419566063dSJacob Faibussowitsch       PetscCall(VecScale(ilink->x, -1.0));
14429566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
14439566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
14449566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14459566063dSJacob Faibussowitsch       PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
14469566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14479566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14489566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
14499566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
14503e197d65SBarry Smith     }
145151f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
145211755939SBarry Smith       cnt -= 2;
145351f519a2SBarry Smith       while (ilink->previous) {
145451f519a2SBarry Smith         ilink = ilink->previous;
145511755939SBarry Smith         /* compute the residual only over the part of the vector needed */
14569566063dSJacob Faibussowitsch         PetscCall(MatMult(jac->Afield[cnt--], y, ilink->x));
14579566063dSJacob Faibussowitsch         PetscCall(VecScale(ilink->x, -1.0));
14589566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
14599566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
14609566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14619566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
14629566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14639566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14649566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
14659566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
146651f519a2SBarry Smith       }
146711755939SBarry Smith     }
146863a3b9bcSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Unsupported or unknown composition %d", (int)jac->type);
14693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14700971522cSBarry Smith }
14710971522cSBarry Smith 
1472d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_GKB(PC pc, Vec x, Vec y)
1473d71ae5a4SJacob Faibussowitsch {
1474a51937d4SCarola Kruse   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
1475a51937d4SCarola Kruse   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1476a51937d4SCarola Kruse   KSP               ksp = ilinkA->ksp;
1477de482cd7SCarola Kruse   Vec               u, v, Hu, d, work1, work2;
1478e071a0a4SCarola Kruse   PetscScalar       alpha, z, nrmz2, *vecz;
1479e071a0a4SCarola Kruse   PetscReal         lowbnd, nu, beta;
1480a51937d4SCarola Kruse   PetscInt          j, iterGKB;
1481a51937d4SCarola Kruse 
1482a51937d4SCarola Kruse   PetscFunctionBegin;
14839566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
14849566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
14859566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
14869566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
1487e071a0a4SCarola Kruse 
1488e071a0a4SCarola Kruse   u     = jac->u;
1489e071a0a4SCarola Kruse   v     = jac->v;
1490e071a0a4SCarola Kruse   Hu    = jac->Hu;
1491e071a0a4SCarola Kruse   d     = jac->d;
1492e071a0a4SCarola Kruse   work1 = jac->w1;
1493e071a0a4SCarola Kruse   work2 = jac->w2;
1494e071a0a4SCarola Kruse   vecz  = jac->vecz;
1495a51937d4SCarola Kruse 
1496a51937d4SCarola Kruse   /* Change RHS to comply with matrix regularization H = A + nu*B*B' */
1497a51937d4SCarola Kruse   /* Add q = q + nu*B*b */
1498a51937d4SCarola Kruse   if (jac->gkbnu) {
1499a51937d4SCarola Kruse     nu = jac->gkbnu;
15009566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, jac->gkbnu));
15019566063dSJacob Faibussowitsch     PetscCall(MatMultAdd(jac->B, ilinkD->x, ilinkA->x, ilinkA->x)); /* q = q + nu*B*b */
1502a51937d4SCarola Kruse   } else {
1503a51937d4SCarola Kruse     /* Situation when no augmented Lagrangian is used. Then we set inner  */
1504a51937d4SCarola Kruse     /* matrix N = I in [Ar13], and thus nu = 1.                           */
1505a51937d4SCarola Kruse     nu = 1;
1506a51937d4SCarola Kruse   }
1507a51937d4SCarola Kruse 
1508a51937d4SCarola Kruse   /* Transform rhs from [q,tilde{b}] to [0,b] */
15099566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
15109566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, ilinkA->x, ilinkA->y));
15119566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, ilinkA->y));
15129566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
15139566063dSJacob Faibussowitsch   PetscCall(MatMultHermitianTranspose(jac->B, ilinkA->y, work1));
15149566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(work1, 1.0 / nu, -1.0, ilinkD->x)); /* c = b - B'*x        */
1515a51937d4SCarola Kruse 
1516a51937d4SCarola Kruse   /* First step of algorithm */
15179566063dSJacob Faibussowitsch   PetscCall(VecNorm(work1, NORM_2, &beta)); /* beta = sqrt(nu*c'*c)*/
1518e071a0a4SCarola Kruse   KSPCheckDot(ksp, beta);
1519addd1e01SJunchao Zhang   beta = PetscSqrtReal(nu) * beta;
15209566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(v, nu / beta, 0.0, work1)); /* v = nu/beta *c      */
15219566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->B, v, work2));          /* u = H^{-1}*B*v      */
15229566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
15239566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, work2, u));
15249566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, u));
15259566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
15269566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u      */
15279566063dSJacob Faibussowitsch   PetscCall(VecDot(Hu, u, &alpha));
1528e071a0a4SCarola Kruse   KSPCheckDot(ksp, alpha);
152908401ef6SPierre Jolivet   PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1530addd1e01SJunchao Zhang   alpha = PetscSqrtReal(PetscAbsScalar(alpha));
15319566063dSJacob Faibussowitsch   PetscCall(VecScale(u, 1.0 / alpha));
15329566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(d, 1.0 / alpha, 0.0, v)); /* v = nu/beta *c      */
1533de482cd7SCarola Kruse 
1534a51937d4SCarola Kruse   z       = beta / alpha;
1535a51937d4SCarola Kruse   vecz[1] = z;
1536a51937d4SCarola Kruse 
1537de482cd7SCarola Kruse   /* Computation of first iterate x(1) and p(1) */
15389566063dSJacob Faibussowitsch   PetscCall(VecAXPY(ilinkA->y, z, u));
15399566063dSJacob Faibussowitsch   PetscCall(VecCopy(d, ilinkD->y));
15409566063dSJacob Faibussowitsch   PetscCall(VecScale(ilinkD->y, -z));
1541a51937d4SCarola Kruse 
15429371c9d4SSatish Balay   iterGKB = 1;
15439371c9d4SSatish Balay   lowbnd  = 2 * jac->gkbtol;
154448a46eb9SPierre Jolivet   if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1545de482cd7SCarola Kruse 
1546a51937d4SCarola Kruse   while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) {
1547a51937d4SCarola Kruse     iterGKB += 1;
15489566063dSJacob Faibussowitsch     PetscCall(MatMultHermitianTranspose(jac->B, u, work1)); /* v <- nu*(B'*u-alpha/nu*v) */
15499566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(v, nu, -alpha, work1));
15509566063dSJacob Faibussowitsch     PetscCall(VecNorm(v, NORM_2, &beta)); /* beta = sqrt(nu)*v'*v      */
1551addd1e01SJunchao Zhang     beta = beta / PetscSqrtReal(nu);
15529566063dSJacob Faibussowitsch     PetscCall(VecScale(v, 1.0 / beta));
15539566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->B, v, work2)); /* u <- H^{-1}*(B*v-beta*H*u) */
15549566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu));
15559566063dSJacob Faibussowitsch     PetscCall(VecAXPY(work2, -beta, Hu));
15569566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
15579566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ksp, work2, u));
15589566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ksp, pc, u));
15599566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
15609566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u            */
15619566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, u, &alpha));
1562e071a0a4SCarola Kruse     KSPCheckDot(ksp, alpha);
156308401ef6SPierre Jolivet     PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1564addd1e01SJunchao Zhang     alpha = PetscSqrtReal(PetscAbsScalar(alpha));
15659566063dSJacob Faibussowitsch     PetscCall(VecScale(u, 1.0 / alpha));
1566a51937d4SCarola Kruse 
1567e071a0a4SCarola Kruse     z       = -beta / alpha * z; /* z <- beta/alpha*z     */
1568a51937d4SCarola Kruse     vecz[0] = z;
1569a51937d4SCarola Kruse 
1570a51937d4SCarola Kruse     /* Computation of new iterate x(i+1) and p(i+1) */
15719566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(d, 1.0 / alpha, -beta / alpha, v)); /* d = (v-beta*d)/alpha */
15729566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkA->y, z, u));                   /* r = r + z*u          */
15739566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkD->y, -z, d));                  /* p = p - z*d          */
15749566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, ilinkA->y, Hu));             /* ||u||_H = u'*H*u     */
15759566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, ilinkA->y, &nrmz2));
1576a51937d4SCarola Kruse 
1577a51937d4SCarola Kruse     /* Compute Lower Bound estimate */
1578a51937d4SCarola Kruse     if (iterGKB > jac->gkbdelay) {
1579a51937d4SCarola Kruse       lowbnd = 0.0;
1580ad540459SPierre Jolivet       for (j = 0; j < jac->gkbdelay; j++) lowbnd += PetscAbsScalar(vecz[j] * vecz[j]);
1581addd1e01SJunchao Zhang       lowbnd = PetscSqrtReal(lowbnd / PetscAbsScalar(nrmz2));
1582a51937d4SCarola Kruse     }
1583a51937d4SCarola Kruse 
1584ad540459SPierre Jolivet     for (j = 0; j < jac->gkbdelay - 1; j++) vecz[jac->gkbdelay - j - 1] = vecz[jac->gkbdelay - j - 2];
158548a46eb9SPierre Jolivet     if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1586a51937d4SCarola Kruse   }
1587a51937d4SCarola Kruse 
15889566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
15899566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
15909566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
15919566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
15923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1593a51937d4SCarola Kruse }
1594a51937d4SCarola Kruse 
1595421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink, xx, yy) \
15963ba16761SJacob Faibussowitsch   ((PetscErrorCode)(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) || \
15979371c9d4SSatish 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) || \
15983ba16761SJacob Faibussowitsch                     VecScatterEnd(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE)))
1599421e10b8SBarry Smith 
1600d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc, Vec x, Vec y)
1601d71ae5a4SJacob Faibussowitsch {
1602421e10b8SBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
1603421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1604939b8a20SBarry Smith   PetscInt          bs;
1605421e10b8SBarry Smith 
1606421e10b8SBarry Smith   PetscFunctionBegin;
1607421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1608*80670ca5SBarry Smith     PetscBool matnest;
1609*80670ca5SBarry Smith 
1610*80670ca5SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest));
1611*80670ca5SBarry Smith     if (jac->defaultsplit && !matnest) {
16129566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
16132472a847SBarry 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);
16149566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
16152472a847SBarry 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);
16169566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
1617421e10b8SBarry Smith       while (ilink) {
16189566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
16199566063dSJacob Faibussowitsch         PetscCall(KSPSolveTranspose(ilink->ksp, ilink->x, ilink->y));
16209566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
16219566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
1622421e10b8SBarry Smith         ilink = ilink->next;
1623421e10b8SBarry Smith       }
16249566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
1625421e10b8SBarry Smith     } else {
16269566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
1627421e10b8SBarry Smith       while (ilink) {
16289566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1629421e10b8SBarry Smith         ilink = ilink->next;
1630421e10b8SBarry Smith       }
1631421e10b8SBarry Smith     }
1632421e10b8SBarry Smith   } else {
1633421e10b8SBarry Smith     if (!jac->w1) {
16349566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
16359566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
1636421e10b8SBarry Smith     }
16379566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1638421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
16399566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1640421e10b8SBarry Smith       while (ilink->next) {
1641421e10b8SBarry Smith         ilink = ilink->next;
16429566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
16439566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
16449566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1645421e10b8SBarry Smith       }
1646421e10b8SBarry Smith       while (ilink->previous) {
1647421e10b8SBarry Smith         ilink = ilink->previous;
16489566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
16499566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
16509566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1651421e10b8SBarry Smith       }
1652421e10b8SBarry Smith     } else {
1653421e10b8SBarry Smith       while (ilink->next) { /* get to last entry in linked list */
1654421e10b8SBarry Smith         ilink = ilink->next;
1655421e10b8SBarry Smith       }
16569566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1657421e10b8SBarry Smith       while (ilink->previous) {
1658421e10b8SBarry Smith         ilink = ilink->previous;
16599566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
16609566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
16619566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1662421e10b8SBarry Smith       }
1663421e10b8SBarry Smith     }
1664421e10b8SBarry Smith   }
16653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1666421e10b8SBarry Smith }
1667421e10b8SBarry Smith 
1668d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_FieldSplit(PC pc)
1669d71ae5a4SJacob Faibussowitsch {
16700971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
16715a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head, next;
16720971522cSBarry Smith 
16730971522cSBarry Smith   PetscFunctionBegin;
16745a9f2f41SSatish Balay   while (ilink) {
16759566063dSJacob Faibussowitsch     PetscCall(KSPDestroy(&ilink->ksp));
16769566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->x));
16779566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->y));
16789566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->z));
16799566063dSJacob Faibussowitsch     PetscCall(VecScatterDestroy(&ilink->sctx));
16809566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
16819566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
16829566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->splitname));
16839566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields));
16849566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields_col));
16855a9f2f41SSatish Balay     next = ilink->next;
16869566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink));
16875a9f2f41SSatish Balay     ilink = next;
16880971522cSBarry Smith   }
1689f5f0d762SBarry Smith   jac->head = NULL;
16909566063dSJacob Faibussowitsch   PetscCall(PetscFree2(jac->x, jac->y));
1691574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
16929566063dSJacob Faibussowitsch     PetscCall(MatDestroyMatrices(jac->nsplits, &jac->mat));
1693574deadeSBarry Smith   } else if (jac->mat) {
16940298fd71SBarry Smith     jac->mat = NULL;
1695574deadeSBarry Smith   }
16969566063dSJacob Faibussowitsch   if (jac->pmat) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->pmat));
16979566063dSJacob Faibussowitsch   if (jac->Afield) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->Afield));
1698f5f0d762SBarry Smith   jac->nsplits = 0;
16999566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w1));
17009566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w2));
17019566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur));
17029566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schurp));
17039566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur_user));
17049566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspschur));
17059566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspupper));
17069566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->B));
17079566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->C));
17089566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->H));
17099566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->u));
17109566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->v));
17119566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->Hu));
17129566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->d));
17139566063dSJacob Faibussowitsch   PetscCall(PetscFree(jac->vecz));
17149566063dSJacob Faibussowitsch   PetscCall(PetscViewerDestroy(&jac->gkbviewer));
17156dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
17163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1717574deadeSBarry Smith }
1718574deadeSBarry Smith 
1719d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1720d71ae5a4SJacob Faibussowitsch {
1721574deadeSBarry Smith   PetscFunctionBegin;
17229566063dSJacob Faibussowitsch   PetscCall(PCReset_FieldSplit(pc));
17239566063dSJacob Faibussowitsch   PetscCall(PetscFree(pc->data));
17242e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", NULL));
17259566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", NULL));
17269566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", NULL));
17279566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", NULL));
17289566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", NULL));
17292e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", NULL));
17302e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", NULL));
17312e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
17322e956fe4SStefano Zampini 
17332e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
17342e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
17352e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
17362e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
17372e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
17389566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
17399566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
17409566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
17412e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
17423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
17430971522cSBarry Smith }
17440971522cSBarry Smith 
1745d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc, PetscOptionItems *PetscOptionsObject)
1746d71ae5a4SJacob Faibussowitsch {
17476c924f48SJed Brown   PetscInt        bs;
17487b752e3dSPatrick Sanan   PetscBool       flg;
17499dcbbd2bSBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit *)pc->data;
17503b224e63SBarry Smith   PCCompositeType ctype;
17511b9fc7fcSBarry Smith 
17520971522cSBarry Smith   PetscFunctionBegin;
1753d0609cedSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "FieldSplit options");
17549566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_dm_splits", "Whether to use DMCreateFieldDecomposition() for splits", "PCFieldSplitSetDMSplits", jac->dm_splits, &jac->dm_splits, NULL));
17559566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-pc_fieldsplit_block_size", "Blocksize that defines number of fields", "PCFieldSplitSetBlockSize", jac->bs, &bs, &flg));
17561baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetBlockSize(pc, bs));
17572686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
17589566063dSJacob 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));
17592686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
17609566063dSJacob 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));
17619566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_detect_saddle_point", "Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint", jac->detect, &jac->detect, NULL));
17629566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDetectSaddlePoint(pc, jac->detect)); /* Sets split type and Schur PC type */
17639566063dSJacob Faibussowitsch   PetscCall(PetscOptionsEnum("-pc_fieldsplit_type", "Type of composition", "PCFieldSplitSetType", PCCompositeTypes, (PetscEnum)jac->type, (PetscEnum *)&ctype, &flg));
17641baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetType(pc, ctype));
1765c30613efSMatthew Knepley   /* Only setup fields once */
1766c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1767*80670ca5SBarry Smith     /* only allow user to set fields from command line.
1768d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
17699566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
17709566063dSJacob Faibussowitsch     if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
1771d32f9abdSBarry Smith   }
1772c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
17739566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_schur_factorization_type", PCFieldSplitSchurFactTypes, (PetscEnum *)&jac->schurfactorization, &flg));
17749566063dSJacob Faibussowitsch     if (flg) PetscCall(PetscInfo(pc, "Deprecated use of -pc_fieldsplit_schur_factorization_type\n"));
17759566063dSJacob 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));
17769566063dSJacob Faibussowitsch     PetscCall(PetscOptionsEnum("-pc_fieldsplit_schur_precondition", "How to build preconditioner for Schur complement", "PCFieldSplitSetSchurPre", PCFieldSplitSchurPreTypes, (PetscEnum)jac->schurpre, (PetscEnum *)&jac->schurpre, NULL));
17779566063dSJacob Faibussowitsch     PetscCall(PetscOptionsScalar("-pc_fieldsplit_schur_scale", "Scale Schur complement", "PCFieldSplitSetSchurScale", jac->schurscale, &jac->schurscale, NULL));
1778a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
17799566063dSJacob Faibussowitsch     PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_tol", "The tolerance for the lower bound stopping criterion", "PCFieldSplitGKBTol", jac->gkbtol, &jac->gkbtol, NULL));
17809566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_delay", "The delay value for lower bound criterion", "PCFieldSplitGKBDelay", jac->gkbdelay, &jac->gkbdelay, NULL));
178152ce0ab5SPierre Jolivet     PetscCall(PetscOptionsBoundedReal("-pc_fieldsplit_gkb_nu", "Parameter in augmented Lagrangian approach", "PCFieldSplitGKBNu", jac->gkbnu, &jac->gkbnu, NULL, 0.0));
17829566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_maxit", "Maximum allowed number of iterations", "PCFieldSplitGKBMaxit", jac->gkbmaxit, &jac->gkbmaxit, NULL));
17839566063dSJacob Faibussowitsch     PetscCall(PetscOptionsBool("-pc_fieldsplit_gkb_monitor", "Prints number of GKB iterations and error", "PCFieldSplitGKB", jac->gkbmonitor, &jac->gkbmonitor, NULL));
1784c5d2311dSJed Brown   }
178534603f55SBarry Smith   /*
178634603f55SBarry Smith     In the initial call to this routine the sub-solver data structures do not exist so we cannot call KSPSetFromOptions() on them yet.
178734603f55SBarry 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
178834603f55SBarry Smith     is called on the outer solver in case changes were made in the options database
178934603f55SBarry Smith 
179034603f55SBarry 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()
179134603f55SBarry 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.
179234603f55SBarry Smith     Without this extra check test p2p1fetidp_olof_full and others fail with incorrect matrix types.
179334603f55SBarry Smith 
179434603f55SBarry Smith     There could be a negative side effect of calling the KSPSetFromOptions() below.
179534603f55SBarry Smith 
179634603f55SBarry 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
179734603f55SBarry Smith   */
179834603f55SBarry Smith   if (jac->issetup) {
179934603f55SBarry Smith     PC_FieldSplitLink ilink = jac->head;
180034603f55SBarry Smith     if (jac->type == PC_COMPOSITE_SCHUR) {
180134603f55SBarry Smith       if (jac->kspupper && jac->kspupper->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspupper));
180234603f55SBarry Smith       if (jac->kspschur && jac->kspschur->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspschur));
180334603f55SBarry Smith     }
180434603f55SBarry Smith     while (ilink) {
180534603f55SBarry Smith       if (ilink->ksp->totalits > 0) PetscCall(KSPSetFromOptions(ilink->ksp));
180634603f55SBarry Smith       ilink = ilink->next;
180734603f55SBarry Smith     }
180834603f55SBarry Smith   }
1809d0609cedSBarry Smith   PetscOptionsHeadEnd();
18103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
18110971522cSBarry Smith }
18120971522cSBarry Smith 
1813d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col)
1814d71ae5a4SJacob Faibussowitsch {
181597bbdb24SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
18165a9f2f41SSatish Balay   PC_FieldSplitLink ilink, next = jac->head;
181769a612a9SBarry Smith   char              prefix[128];
18185d4c12cdSJungho Lee   PetscInt          i;
18190971522cSBarry Smith 
18200971522cSBarry Smith   PetscFunctionBegin;
18216c924f48SJed Brown   if (jac->splitdefined) {
18229566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
18233ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
18246c924f48SJed Brown   }
1825*80670ca5SBarry Smith   for (i = 0; i < n; i++) { PetscCheck(fields[i] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", fields[i]); }
18269566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
1827a04f6461SBarry Smith   if (splitname) {
18289566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
1829a04f6461SBarry Smith   } else {
18309566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(3, &ilink->splitname));
183163a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 2, "%" PetscInt_FMT, jac->nsplits));
1832a04f6461SBarry Smith   }
18339df09d43SBarry 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 */
18349566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields));
18359566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields, fields, n));
18369566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields_col));
18379566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields_col, fields_col, n));
18382fa5cd67SKarl Rupp 
18395a9f2f41SSatish Balay   ilink->nfields = n;
18400298fd71SBarry Smith   ilink->next    = NULL;
18419566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
18423821be0aSBarry Smith   PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel));
18439566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
18449566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
18459566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
184669a612a9SBarry Smith 
18479566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
18489566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
18490971522cSBarry Smith 
18500971522cSBarry Smith   if (!next) {
18515a9f2f41SSatish Balay     jac->head       = ilink;
18520298fd71SBarry Smith     ilink->previous = NULL;
18530971522cSBarry Smith   } else {
1854ad540459SPierre Jolivet     while (next->next) next = next->next;
18555a9f2f41SSatish Balay     next->next      = ilink;
185651f519a2SBarry Smith     ilink->previous = next;
18570971522cSBarry Smith   }
18580971522cSBarry Smith   jac->nsplits++;
18593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
18600971522cSBarry Smith }
18610971522cSBarry Smith 
1862d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp)
1863d71ae5a4SJacob Faibussowitsch {
1864285fb4e2SStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1865285fb4e2SStefano Zampini 
1866285fb4e2SStefano Zampini   PetscFunctionBegin;
1867285fb4e2SStefano Zampini   *subksp = NULL;
1868285fb4e2SStefano Zampini   if (n) *n = 0;
1869285fb4e2SStefano Zampini   if (jac->type == PC_COMPOSITE_SCHUR) {
1870285fb4e2SStefano Zampini     PetscInt nn;
1871285fb4e2SStefano Zampini 
187228b400f6SJacob Faibussowitsch     PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()");
187363a3b9bcSJacob Faibussowitsch     PetscCheck(jac->nsplits == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unexpected number of splits %" PetscInt_FMT " != 2", jac->nsplits);
1874285fb4e2SStefano Zampini     nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0);
18759566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nn, subksp));
1876285fb4e2SStefano Zampini     (*subksp)[0] = jac->head->ksp;
1877285fb4e2SStefano Zampini     (*subksp)[1] = jac->kspschur;
1878285fb4e2SStefano Zampini     if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper;
1879285fb4e2SStefano Zampini     if (n) *n = nn;
1880285fb4e2SStefano Zampini   }
18813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1882285fb4e2SStefano Zampini }
1883285fb4e2SStefano Zampini 
1884d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc, PetscInt *n, KSP **subksp)
1885d71ae5a4SJacob Faibussowitsch {
1886e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1887e69d4d44SBarry Smith 
1888e69d4d44SBarry Smith   PetscFunctionBegin;
188928b400f6SJacob Faibussowitsch   PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
18909566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
18919566063dSJacob Faibussowitsch   PetscCall(MatSchurComplementGetKSP(jac->schur, *subksp));
18922fa5cd67SKarl Rupp 
1893e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
189413e0d083SBarry Smith   if (n) *n = jac->nsplits;
18953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1896e69d4d44SBarry Smith }
18970971522cSBarry Smith 
1898d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp)
1899d71ae5a4SJacob Faibussowitsch {
19000971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
19010971522cSBarry Smith   PetscInt          cnt   = 0;
19025a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
19030971522cSBarry Smith 
19040971522cSBarry Smith   PetscFunctionBegin;
19059566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
19065a9f2f41SSatish Balay   while (ilink) {
19075a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
19085a9f2f41SSatish Balay     ilink            = ilink->next;
19090971522cSBarry Smith   }
191063a3b9bcSJacob 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);
191113e0d083SBarry Smith   if (n) *n = jac->nsplits;
19123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19130971522cSBarry Smith }
19140971522cSBarry Smith 
19156dbb499eSCian Wilson /*@C
1916f1580f4eSBarry Smith   PCFieldSplitRestrictIS - Restricts the fieldsplit `IS`s to be within a given `IS`.
19176dbb499eSCian Wilson 
19186dbb499eSCian Wilson   Input Parameters:
19196dbb499eSCian Wilson + pc  - the preconditioner context
1920feefa0e1SJacob Faibussowitsch - isy - the index set that defines the indices to which the fieldsplit is to be restricted
19216dbb499eSCian Wilson 
19226dbb499eSCian Wilson   Level: advanced
19236dbb499eSCian Wilson 
1924feefa0e1SJacob Faibussowitsch   Developer Notes:
1925f1580f4eSBarry Smith   It seems the resulting `IS`s will not cover the entire space, so
1926f1580f4eSBarry Smith   how can they define a convergent preconditioner? Needs explaining.
1927f1580f4eSBarry Smith 
192860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
19296dbb499eSCian Wilson @*/
1930d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitRestrictIS(PC pc, IS isy)
1931d71ae5a4SJacob Faibussowitsch {
19326dbb499eSCian Wilson   PetscFunctionBegin;
19336dbb499eSCian Wilson   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
19346dbb499eSCian Wilson   PetscValidHeaderSpecific(isy, IS_CLASSID, 2);
1935cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitRestrictIS_C", (PC, IS), (pc, isy));
19363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19376dbb499eSCian Wilson }
19386dbb499eSCian Wilson 
1939d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
1940d71ae5a4SJacob Faibussowitsch {
19416dbb499eSCian Wilson   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
19426dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
19436dbb499eSCian Wilson   PetscInt          localsize, size, sizez, i;
19446dbb499eSCian Wilson   const PetscInt   *ind, *indz;
19456dbb499eSCian Wilson   PetscInt         *indc, *indcz;
19466dbb499eSCian Wilson   PetscBool         flg;
19476dbb499eSCian Wilson 
19486dbb499eSCian Wilson   PetscFunctionBegin;
19499566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(isy, &localsize));
19509566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&localsize, &size, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)isy)));
19516dbb499eSCian Wilson   size -= localsize;
19526dbb499eSCian Wilson   while (ilink) {
19536dbb499eSCian Wilson     IS isrl, isr;
19541c7cfba8SBarry Smith     PC subpc;
19559566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl));
19569566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(isrl, &localsize));
19579566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(localsize, &indc));
19589566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(isrl, &ind));
19599566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(indc, ind, localsize));
19609566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(isrl, &ind));
19619566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isrl));
19626dbb499eSCian Wilson     for (i = 0; i < localsize; i++) *(indc + i) += size;
19639566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)isy), localsize, indc, PETSC_OWN_POINTER, &isr));
19649566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
19659566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
19666dbb499eSCian Wilson     ilink->is = isr;
19679566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
19689566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
19696dbb499eSCian Wilson     ilink->is_col = isr;
19709566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isr));
19719566063dSJacob Faibussowitsch     PetscCall(KSPGetPC(ilink->ksp, &subpc));
19729566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)subpc, PCFIELDSPLIT, &flg));
19736dbb499eSCian Wilson     if (flg) {
19746dbb499eSCian Wilson       IS       iszl, isz;
19756dbb499eSCian Wilson       MPI_Comm comm;
19769566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(ilink->is, &localsize));
19776dbb499eSCian Wilson       comm = PetscObjectComm((PetscObject)ilink->is);
19789566063dSJacob Faibussowitsch       PetscCall(ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl));
19799566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Scan(&localsize, &sizez, 1, MPIU_INT, MPI_SUM, comm));
19806dbb499eSCian Wilson       sizez -= localsize;
19819566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(iszl, &localsize));
19829566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(localsize, &indcz));
19839566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(iszl, &indz));
19849566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(indcz, indz, localsize));
19859566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(iszl, &indz));
19869566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&iszl));
19876dbb499eSCian Wilson       for (i = 0; i < localsize; i++) *(indcz + i) += sizez;
19889566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(comm, localsize, indcz, PETSC_OWN_POINTER, &isz));
19899566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitRestrictIS(subpc, isz));
19909566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&isz));
19916dbb499eSCian Wilson     }
19926dbb499eSCian Wilson     next  = ilink->next;
19936dbb499eSCian Wilson     ilink = next;
19946dbb499eSCian Wilson   }
19956dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
19963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19976dbb499eSCian Wilson }
19986dbb499eSCian Wilson 
1999d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc, const char splitname[], IS is)
2000d71ae5a4SJacob Faibussowitsch {
2001704ba839SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
2002704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
2003704ba839SBarry Smith   char              prefix[128];
2004704ba839SBarry Smith 
2005704ba839SBarry Smith   PetscFunctionBegin;
20066c924f48SJed Brown   if (jac->splitdefined) {
20079566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
20083ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
20096c924f48SJed Brown   }
20109566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
2011a04f6461SBarry Smith   if (splitname) {
20129566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
2013a04f6461SBarry Smith   } else {
20149566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(8, &ilink->splitname));
201563a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 7, "%" PetscInt_FMT, jac->nsplits));
2016a04f6461SBarry Smith   }
20179df09d43SBarry 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 */
20189566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
20199566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is));
2020b5787286SJed Brown   ilink->is = is;
20219566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
20229566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is_col));
2023b5787286SJed Brown   ilink->is_col = is;
20240298fd71SBarry Smith   ilink->next   = NULL;
20259566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
20263821be0aSBarry Smith   PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel));
20279566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
20289566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
20299566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
2030704ba839SBarry Smith 
20319566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
20329566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
2033704ba839SBarry Smith 
2034704ba839SBarry Smith   if (!next) {
2035704ba839SBarry Smith     jac->head       = ilink;
20360298fd71SBarry Smith     ilink->previous = NULL;
2037704ba839SBarry Smith   } else {
2038ad540459SPierre Jolivet     while (next->next) next = next->next;
2039704ba839SBarry Smith     next->next      = ilink;
2040704ba839SBarry Smith     ilink->previous = next;
2041704ba839SBarry Smith   }
2042704ba839SBarry Smith   jac->nsplits++;
20433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2044704ba839SBarry Smith }
2045704ba839SBarry Smith 
204694ef8ddeSSatish Balay /*@C
204760f59c3bSBarry Smith   PCFieldSplitSetFields - Sets the fields that define one particular split in `PCFIELDSPLIT`
20480971522cSBarry Smith 
2049c3339decSBarry Smith   Logically Collective
20500971522cSBarry Smith 
20510971522cSBarry Smith   Input Parameters:
20520971522cSBarry Smith + pc         - the preconditioner context
205360f59c3bSBarry Smith . splitname  - name of this split, if `NULL` the number of the split is used
20540971522cSBarry Smith . n          - the number of fields in this split
20553b374dbdSBarry Smith . fields     - the fields in this split
2056*80670ca5SBarry Smith - fields_col - generally the same as `fields`, if it does not match `fields` then the submatrix that is solved for this set of fields comes from an off-diagonal block
2057*80670ca5SBarry Smith                of the matrix and `fields_col` provides the column indices for that block
2058*80670ca5SBarry Smith 
2059*80670ca5SBarry Smith   Options Database Key:
2060*80670ca5SBarry Smith . -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the `%d`'th split
20610971522cSBarry Smith 
20620971522cSBarry Smith   Level: intermediate
20630971522cSBarry Smith 
206495452b02SPatrick Sanan   Notes:
2065f1580f4eSBarry Smith   Use `PCFieldSplitSetIS()` to set a  general set of indices as a split.
2066d32f9abdSBarry Smith 
2067*80670ca5SBarry Smith   If the matrix used to construct the preconditioner is `MATNEST` then field i refers to the `is_row[i]` `IS` passed to `MatCreateNest()`.
2068*80670ca5SBarry Smith 
2069*80670ca5SBarry Smith   If the matrix used to construct the preconditioner is not `MATNEST` then
2070*80670ca5SBarry Smith   `PCFieldSplitSetFields()` is for defining fields as strided blocks (based on the block size provided to the matrix with `MatSetBlocksize()` or
2071*80670ca5SBarry Smith   to the `PC` with `PCFieldSplitSetBlockSize()`). For example, if the block
2072f1580f4eSBarry Smith   size is three then one can define a split as 0, or 1 or 2 or 0,1 or 0,2 or 1,2 which mean
2073d32f9abdSBarry Smith   0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
2074f1580f4eSBarry Smith   where the numbered entries indicate what is in the split.
2075d32f9abdSBarry Smith 
2076db4c96c1SJed Brown   This function is called once per split (it creates a new split each time).  Solve options
207760f59c3bSBarry Smith   for this split will be available under the prefix `-fieldsplit_SPLITNAME_`.
2078db4c96c1SJed Brown 
2079*80670ca5SBarry Smith   `PCFieldSplitSetIS()` does not support having a `fields_col` different from `fields`
20803b374dbdSBarry Smith 
2081feefa0e1SJacob Faibussowitsch   Developer Notes:
2082f1580f4eSBarry Smith   This routine does not actually create the `IS` representing the split, that is delayed
2083f1580f4eSBarry Smith   until `PCSetUp_FieldSplit()`, because information about the vector/matrix layouts may not be
20845d4c12cdSJungho Lee   available when this routine is called.
20855d4c12cdSJungho Lee 
2086*80670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetIS()`, `PCFieldSplitRestrictIS()`,
2087*80670ca5SBarry Smith           `MatSetBlocksize()`, `MatCreateNest()`
20880971522cSBarry Smith @*/
2089d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetFields(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col)
2090d71ae5a4SJacob Faibussowitsch {
20910971522cSBarry Smith   PetscFunctionBegin;
20920700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
20934f572ea9SToby Isaac   PetscAssertPointer(splitname, 2);
209463a3b9bcSJacob Faibussowitsch   PetscCheck(n >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Provided number of fields %" PetscInt_FMT " in split \"%s\" not positive", n, splitname);
20954f572ea9SToby Isaac   PetscAssertPointer(fields, 4);
2096cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetFields_C", (PC, const char[], PetscInt, const PetscInt *, const PetscInt *), (pc, splitname, n, fields, fields_col));
20973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20980971522cSBarry Smith }
20990971522cSBarry Smith 
2100c84da90fSDmitry Karpeev /*@
2101f1580f4eSBarry Smith   PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build
2102c14e9f00SDavid Andrs   the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2103c84da90fSDmitry Karpeev 
2104c3339decSBarry Smith   Logically Collective
2105c84da90fSDmitry Karpeev 
2106c84da90fSDmitry Karpeev   Input Parameters:
2107c84da90fSDmitry Karpeev + pc  - the preconditioner object
2108c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
2109c84da90fSDmitry Karpeev 
211020f4b53cSBarry Smith   Options Database Key:
2111147403d9SBarry Smith . -pc_fieldsplit_diag_use_amat - use the Amat to provide the diagonal blocks
2112c84da90fSDmitry Karpeev 
2113c84da90fSDmitry Karpeev   Level: intermediate
2114c84da90fSDmitry Karpeev 
211560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetDiagUseAmat()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFIELDSPLIT`
2116c84da90fSDmitry Karpeev @*/
2117d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc, PetscBool flg)
2118d71ae5a4SJacob Faibussowitsch {
2119c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2120c84da90fSDmitry Karpeev   PetscBool      isfs;
2121c84da90fSDmitry Karpeev 
2122c84da90fSDmitry Karpeev   PetscFunctionBegin;
2123c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
21249566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
212528b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2126c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
21273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2128c84da90fSDmitry Karpeev }
2129c84da90fSDmitry Karpeev 
2130c84da90fSDmitry Karpeev /*@
2131f1580f4eSBarry Smith   PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build
2132c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2133c84da90fSDmitry Karpeev 
2134c3339decSBarry Smith   Logically Collective
2135c84da90fSDmitry Karpeev 
213620f4b53cSBarry Smith   Input Parameter:
2137c84da90fSDmitry Karpeev . pc - the preconditioner object
2138c84da90fSDmitry Karpeev 
213920f4b53cSBarry Smith   Output Parameter:
2140c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
2141c84da90fSDmitry Karpeev 
2142c84da90fSDmitry Karpeev   Level: intermediate
2143c84da90fSDmitry Karpeev 
214460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetDiagUseAmat()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFIELDSPLIT`
2145c84da90fSDmitry Karpeev @*/
2146d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc, PetscBool *flg)
2147d71ae5a4SJacob Faibussowitsch {
2148c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2149c84da90fSDmitry Karpeev   PetscBool      isfs;
2150c84da90fSDmitry Karpeev 
2151c84da90fSDmitry Karpeev   PetscFunctionBegin;
2152c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
21534f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
21549566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
215528b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2156c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
21573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2158c84da90fSDmitry Karpeev }
2159c84da90fSDmitry Karpeev 
2160c84da90fSDmitry Karpeev /*@
2161f1580f4eSBarry Smith   PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build
2162c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2163c84da90fSDmitry Karpeev 
2164c3339decSBarry Smith   Logically Collective
2165c84da90fSDmitry Karpeev 
2166c84da90fSDmitry Karpeev   Input Parameters:
2167c84da90fSDmitry Karpeev + pc  - the preconditioner object
2168c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2169c84da90fSDmitry Karpeev 
217020f4b53cSBarry Smith   Options Database Key:
2171147403d9SBarry Smith . -pc_fieldsplit_off_diag_use_amat <bool> - use the Amat to extract the off-diagonal blocks
2172c84da90fSDmitry Karpeev 
2173c84da90fSDmitry Karpeev   Level: intermediate
2174c84da90fSDmitry Karpeev 
217560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFieldSplitSetDiagUseAmat()`, `PCFIELDSPLIT`
2176c84da90fSDmitry Karpeev @*/
2177d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc, PetscBool flg)
2178d71ae5a4SJacob Faibussowitsch {
2179c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2180c84da90fSDmitry Karpeev   PetscBool      isfs;
2181c84da90fSDmitry Karpeev 
2182c84da90fSDmitry Karpeev   PetscFunctionBegin;
2183c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
21849566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
218528b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2186c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
21873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2188c84da90fSDmitry Karpeev }
2189c84da90fSDmitry Karpeev 
2190c84da90fSDmitry Karpeev /*@
2191f1580f4eSBarry Smith   PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build
2192c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2193c84da90fSDmitry Karpeev 
2194c3339decSBarry Smith   Logically Collective
2195c84da90fSDmitry Karpeev 
219620f4b53cSBarry Smith   Input Parameter:
2197c84da90fSDmitry Karpeev . pc - the preconditioner object
2198c84da90fSDmitry Karpeev 
219920f4b53cSBarry Smith   Output Parameter:
2200c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2201c84da90fSDmitry Karpeev 
2202c84da90fSDmitry Karpeev   Level: intermediate
2203c84da90fSDmitry Karpeev 
220460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFieldSplitGetDiagUseAmat()`, `PCFIELDSPLIT`
2205c84da90fSDmitry Karpeev @*/
2206d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc, PetscBool *flg)
2207d71ae5a4SJacob Faibussowitsch {
2208c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2209c84da90fSDmitry Karpeev   PetscBool      isfs;
2210c84da90fSDmitry Karpeev 
2211c84da90fSDmitry Karpeev   PetscFunctionBegin;
2212c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22134f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
22149566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
221528b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2216c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
22173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2218c84da90fSDmitry Karpeev }
2219c84da90fSDmitry Karpeev 
2220218d4943SBarry Smith /*@C
2221f1580f4eSBarry Smith   PCFieldSplitSetIS - Sets the exact elements for a split in a `PCFIELDSPLIT`
2222704ba839SBarry Smith 
2223c3339decSBarry Smith   Logically Collective
2224704ba839SBarry Smith 
2225704ba839SBarry Smith   Input Parameters:
2226704ba839SBarry Smith + pc        - the preconditioner context
222760f59c3bSBarry Smith . splitname - name of this split, if `NULL` the number of the split is used
2228f1580f4eSBarry Smith - is        - the index set that defines the elements in this split
2229704ba839SBarry Smith 
223060f59c3bSBarry Smith   Level: intermediate
223160f59c3bSBarry Smith 
2232a6ffb8dbSJed Brown   Notes:
2233*80670ca5SBarry Smith   Use `PCFieldSplitSetFields()`, for splits defined by strided `IS` based on the matrix block size or the `is_rows[]` passed into `MATNEST`
2234a6ffb8dbSJed Brown 
2235db4c96c1SJed Brown   This function is called once per split (it creates a new split each time).  Solve options
2236db4c96c1SJed Brown   for this split will be available under the prefix -fieldsplit_SPLITNAME_.
2237d32f9abdSBarry Smith 
2238*80670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetFields()`
2239704ba839SBarry Smith @*/
2240d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetIS(PC pc, const char splitname[], IS is)
2241d71ae5a4SJacob Faibussowitsch {
2242704ba839SBarry Smith   PetscFunctionBegin;
22430700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22444f572ea9SToby Isaac   if (splitname) PetscAssertPointer(splitname, 2);
2245db4c96c1SJed Brown   PetscValidHeaderSpecific(is, IS_CLASSID, 3);
2246cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetIS_C", (PC, const char[], IS), (pc, splitname, is));
22473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2248704ba839SBarry Smith }
2249704ba839SBarry Smith 
225094ef8ddeSSatish Balay /*@C
2251f1580f4eSBarry Smith   PCFieldSplitGetIS - Retrieves the elements for a split as an `IS`
225257a9adfeSMatthew G Knepley 
2253c3339decSBarry Smith   Logically Collective
225457a9adfeSMatthew G Knepley 
225557a9adfeSMatthew G Knepley   Input Parameters:
225657a9adfeSMatthew G Knepley + pc        - the preconditioner context
225757a9adfeSMatthew G Knepley - splitname - name of this split
225857a9adfeSMatthew G Knepley 
225957a9adfeSMatthew G Knepley   Output Parameter:
2260feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split, or `NULL` if the split is not found
226157a9adfeSMatthew G Knepley 
226257a9adfeSMatthew G Knepley   Level: intermediate
226357a9adfeSMatthew G Knepley 
2264*80670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetIS()`, `PCFieldSplitGetISByIndex()`
226557a9adfeSMatthew G Knepley @*/
2266d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetIS(PC pc, const char splitname[], IS *is)
2267d71ae5a4SJacob Faibussowitsch {
226857a9adfeSMatthew G Knepley   PetscFunctionBegin;
226957a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22704f572ea9SToby Isaac   PetscAssertPointer(splitname, 2);
22714f572ea9SToby Isaac   PetscAssertPointer(is, 3);
227257a9adfeSMatthew G Knepley   {
227357a9adfeSMatthew G Knepley     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
227457a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
227557a9adfeSMatthew G Knepley     PetscBool         found;
227657a9adfeSMatthew G Knepley 
22770298fd71SBarry Smith     *is = NULL;
227857a9adfeSMatthew G Knepley     while (ilink) {
22799566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(ilink->splitname, splitname, &found));
228057a9adfeSMatthew G Knepley       if (found) {
228157a9adfeSMatthew G Knepley         *is = ilink->is;
228257a9adfeSMatthew G Knepley         break;
228357a9adfeSMatthew G Knepley       }
228457a9adfeSMatthew G Knepley       ilink = ilink->next;
228557a9adfeSMatthew G Knepley     }
228657a9adfeSMatthew G Knepley   }
22873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
228857a9adfeSMatthew G Knepley }
228957a9adfeSMatthew G Knepley 
2290998f007dSPierre Jolivet /*@C
2291f1580f4eSBarry Smith   PCFieldSplitGetISByIndex - Retrieves the elements for a given split as an `IS`
2292998f007dSPierre Jolivet 
2293c3339decSBarry Smith   Logically Collective
2294998f007dSPierre Jolivet 
2295998f007dSPierre Jolivet   Input Parameters:
2296998f007dSPierre Jolivet + pc    - the preconditioner context
2297998f007dSPierre Jolivet - index - index of this split
2298998f007dSPierre Jolivet 
2299998f007dSPierre Jolivet   Output Parameter:
2300feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split
2301998f007dSPierre Jolivet 
2302998f007dSPierre Jolivet   Level: intermediate
2303998f007dSPierre Jolivet 
2304*80670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitGetIS()`, `PCFieldSplitSetIS()`,
2305*80670ca5SBarry Smith 
2306998f007dSPierre Jolivet @*/
2307d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetISByIndex(PC pc, PetscInt index, IS *is)
2308d71ae5a4SJacob Faibussowitsch {
2309998f007dSPierre Jolivet   PetscFunctionBegin;
231063a3b9bcSJacob Faibussowitsch   PetscCheck(index >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", index);
2311998f007dSPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23124f572ea9SToby Isaac   PetscAssertPointer(is, 3);
2313998f007dSPierre Jolivet   {
2314998f007dSPierre Jolivet     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
2315998f007dSPierre Jolivet     PC_FieldSplitLink ilink = jac->head;
2316998f007dSPierre Jolivet     PetscInt          i     = 0;
231763a3b9bcSJacob Faibussowitsch     PetscCheck(index < jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", index, jac->nsplits);
2318998f007dSPierre Jolivet 
2319998f007dSPierre Jolivet     while (i < index) {
2320998f007dSPierre Jolivet       ilink = ilink->next;
2321998f007dSPierre Jolivet       ++i;
2322998f007dSPierre Jolivet     }
23239566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitGetIS(pc, ilink->splitname, is));
2324998f007dSPierre Jolivet   }
23253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2326998f007dSPierre Jolivet }
2327998f007dSPierre Jolivet 
232851f519a2SBarry Smith /*@
232951f519a2SBarry Smith   PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
2330*80670ca5SBarry Smith   fieldsplit preconditioner when calling `PCFieldSplitSetFields()`. If not set the matrix block size is used.
233151f519a2SBarry Smith 
2332c3339decSBarry Smith   Logically Collective
233351f519a2SBarry Smith 
233451f519a2SBarry Smith   Input Parameters:
233551f519a2SBarry Smith + pc - the preconditioner context
233651f519a2SBarry Smith - bs - the block size
233751f519a2SBarry Smith 
233851f519a2SBarry Smith   Level: intermediate
233951f519a2SBarry Smith 
2340*80670ca5SBarry Smith   Note:
2341*80670ca5SBarry Smith   If the matrix is a `MATNEST` then the `is_rows[]` passed to `MatCreateNest()` determines the fields.
2342*80670ca5SBarry Smith 
234360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
234451f519a2SBarry Smith @*/
2345d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetBlockSize(PC pc, PetscInt bs)
2346d71ae5a4SJacob Faibussowitsch {
234751f519a2SBarry Smith   PetscFunctionBegin;
23480700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2349c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc, bs, 2);
2350cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetBlockSize_C", (PC, PetscInt), (pc, bs));
23513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
235251f519a2SBarry Smith }
235351f519a2SBarry Smith 
23540971522cSBarry Smith /*@C
2355f1580f4eSBarry Smith   PCFieldSplitGetSubKSP - Gets the `KSP` contexts for all splits
23560971522cSBarry Smith 
2357c3339decSBarry Smith   Collective
23580971522cSBarry Smith 
23590971522cSBarry Smith   Input Parameter:
23600971522cSBarry Smith . pc - the preconditioner context
23610971522cSBarry Smith 
23620971522cSBarry Smith   Output Parameters:
236313e0d083SBarry Smith + n      - the number of splits
2364f1580f4eSBarry Smith - subksp - the array of `KSP` contexts
2365196cc216SBarry Smith 
23660971522cSBarry Smith   Level: advanced
23670971522cSBarry Smith 
2368f1580f4eSBarry Smith   Notes:
2369f1580f4eSBarry Smith   After `PCFieldSplitGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()`
2370f1580f4eSBarry Smith   (not the `KSP`, just the array that contains them).
2371f1580f4eSBarry Smith 
2372f1580f4eSBarry Smith   You must call `PCSetUp()` before calling `PCFieldSplitGetSubKSP()`.
2373f1580f4eSBarry Smith 
2374f1580f4eSBarry Smith   If the fieldsplit is of type `PC_COMPOSITE_SCHUR`, it returns the `KSP` object used inside the
2375f1580f4eSBarry Smith   Schur complement and the `KSP` object used to iterate over the Schur complement.
2376f1580f4eSBarry Smith   To access all the `KSP` objects used in `PC_COMPOSITE_SCHUR`, use `PCFieldSplitSchurGetSubKSP()`.
2377f1580f4eSBarry Smith 
2378f1580f4eSBarry Smith   If the fieldsplit is of type `PC_COMPOSITE_GKB`, it returns the `KSP` object used to solve the
2379f1580f4eSBarry Smith   inner linear system defined by the matrix H in each loop.
2380f1580f4eSBarry Smith 
2381feefa0e1SJacob Faibussowitsch   Fortran Notes:
2382f1580f4eSBarry Smith   You must pass in a `KSP` array that is large enough to contain all the `KSP`s.
2383f1580f4eSBarry Smith   You can call `PCFieldSplitGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the
2384f1580f4eSBarry Smith   `KSP` array must be.
2385f1580f4eSBarry Smith 
2386feefa0e1SJacob Faibussowitsch   Developer Notes:
2387f1580f4eSBarry Smith   There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()`
2388f1580f4eSBarry Smith 
2389f1580f4eSBarry Smith   The Fortran interface should be modernized to return directly the array of values.
2390f1580f4eSBarry Smith 
239160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitSchurGetSubKSP()`
23920971522cSBarry Smith @*/
2393d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSubKSP(PC pc, PetscInt *n, KSP *subksp[])
2394d71ae5a4SJacob Faibussowitsch {
23950971522cSBarry Smith   PetscFunctionBegin;
23960700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23974f572ea9SToby Isaac   if (n) PetscAssertPointer(n, 2);
2398cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
23993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24000971522cSBarry Smith }
24010971522cSBarry Smith 
2402285fb4e2SStefano Zampini /*@C
2403f1580f4eSBarry Smith   PCFieldSplitSchurGetSubKSP - Gets the `KSP` contexts used inside the Schur complement based `PCFIELDSPLIT`
2404285fb4e2SStefano Zampini 
240560f59c3bSBarry Smith   Collective
2406285fb4e2SStefano Zampini 
2407285fb4e2SStefano Zampini   Input Parameter:
2408285fb4e2SStefano Zampini . pc - the preconditioner context
2409285fb4e2SStefano Zampini 
2410285fb4e2SStefano Zampini   Output Parameters:
2411285fb4e2SStefano Zampini + n      - the number of splits
2412f1580f4eSBarry Smith - subksp - the array of `KSP` contexts
2413285fb4e2SStefano Zampini 
2414285fb4e2SStefano Zampini   Level: advanced
2415285fb4e2SStefano Zampini 
2416f1580f4eSBarry Smith   Notes:
2417f1580f4eSBarry Smith   After `PCFieldSplitSchurGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()`
2418f1580f4eSBarry Smith   (not the `KSP` just the array that contains them).
2419f1580f4eSBarry Smith 
2420f1580f4eSBarry Smith   You must call `PCSetUp()` before calling `PCFieldSplitSchurGetSubKSP()`.
2421f1580f4eSBarry Smith 
2422f1580f4eSBarry Smith   If the fieldsplit type is of type `PC_COMPOSITE_SCHUR`, it returns (in order)
2423f1580f4eSBarry Smith +  1  - the `KSP` used for the (1,1) block
2424f1580f4eSBarry Smith .  2  - the `KSP` used for the Schur complement (not the one used for the interior Schur solver)
2425f1580f4eSBarry Smith -  3  - the `KSP` used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block).
2426f1580f4eSBarry Smith 
2427f1580f4eSBarry Smith   It returns a null array if the fieldsplit is not of type `PC_COMPOSITE_SCHUR`; in this case, you should use `PCFieldSplitGetSubKSP()`.
2428f1580f4eSBarry Smith 
2429feefa0e1SJacob Faibussowitsch   Fortran Notes:
2430f1580f4eSBarry Smith   You must pass in a `KSP` array that is large enough to contain all the local `KSP`s.
2431f1580f4eSBarry Smith   You can call `PCFieldSplitSchurGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the
2432f1580f4eSBarry Smith   `KSP` array must be.
2433f1580f4eSBarry Smith 
2434f1580f4eSBarry Smith   Developer Notes:
2435f1580f4eSBarry Smith   There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()`
2436f1580f4eSBarry Smith 
2437f1580f4eSBarry Smith   Should the functionality of `PCFieldSplitSchurGetSubKSP()` and `PCFieldSplitGetSubKSP()` be merged?
2438f1580f4eSBarry Smith 
2439f1580f4eSBarry Smith   The Fortran interface should be modernized to return directly the array of values.
2440f1580f4eSBarry Smith 
244160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitGetSubKSP()`
2442285fb4e2SStefano Zampini @*/
2443d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc, PetscInt *n, KSP *subksp[])
2444d71ae5a4SJacob Faibussowitsch {
2445285fb4e2SStefano Zampini   PetscFunctionBegin;
2446285fb4e2SStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
24474f572ea9SToby Isaac   if (n) PetscAssertPointer(n, 2);
2448cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitSchurGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
24493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2450285fb4e2SStefano Zampini }
2451285fb4e2SStefano Zampini 
2452e69d4d44SBarry Smith /*@
2453c14e9f00SDavid Andrs   PCFieldSplitSetSchurPre -  Indicates from what operator the preconditioner is constructed for the Schur complement.
2454a1e3cbf9SBarry Smith   The default is the A11 matrix.
2455e69d4d44SBarry Smith 
2456c3339decSBarry Smith   Collective
2457e69d4d44SBarry Smith 
2458e69d4d44SBarry Smith   Input Parameters:
2459e69d4d44SBarry Smith + pc    - the preconditioner context
2460f1580f4eSBarry Smith . ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11` (default),
2461f1580f4eSBarry Smith               `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER`,
2462f1580f4eSBarry Smith               `PC_FIELDSPLIT_SCHUR_PRE_SELFP`, and `PC_FIELDSPLIT_SCHUR_PRE_FULL`
246360f59c3bSBarry Smith - pre   - matrix to use for preconditioning, or `NULL`
2464084e4875SJed Brown 
2465f1580f4eSBarry Smith   Options Database Keys:
2466d59693daSPierre Jolivet + -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is `a11`. See notes for meaning of various arguments
2467a1e3cbf9SBarry Smith - -fieldsplit_1_pc_type <pctype>                               - the preconditioner algorithm that is used to construct the preconditioner from the operator
2468e69d4d44SBarry Smith 
246960f59c3bSBarry Smith   Level: intermediate
247060f59c3bSBarry Smith 
2471fd1303e9SJungho Lee   Notes:
2472f1580f4eSBarry Smith   If ptype is
2473f1580f4eSBarry Smith +     a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
2474f1580f4eSBarry Smith   matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
2475f1580f4eSBarry Smith .     self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
2476e7593814SPierre Jolivet   The only preconditioners that currently work with this symbolic representation matrix object are `PCLSC` and `PCHPDDM`
2477f1580f4eSBarry Smith .     user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
2478f1580f4eSBarry Smith   to this function).
2479f1580f4eSBarry Smith .     selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
2480f1580f4eSBarry Smith   This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
2481d59693daSPierre Jolivet   lumped before extracting the diagonal using the additional option `-fieldsplit_1_mat_schur_complement_ainv_type lump`
2482f1580f4eSBarry Smith -     full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation
2483f1580f4eSBarry Smith   computed internally by `PCFIELDSPLIT` (this is expensive)
2484f1580f4eSBarry Smith   useful mostly as a test that the Schur complement approach can work for your problem
2485fd1303e9SJungho Lee 
2486d59693daSPierre Jolivet   When solving a saddle point problem, where the A11 block is identically zero, using `a11` as the ptype only makes sense
2487d59693daSPierre Jolivet   with the additional option `-fieldsplit_1_pc_type none`. Usually for saddle point problems one would use a ptype of self and
2488d59693daSPierre Jolivet   `-fieldsplit_1_pc_type lsc` which uses the least squares commutator to compute a preconditioner for the Schur complement.
2489fd1303e9SJungho Lee 
249060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`,
2491e7593814SPierre Jolivet           `MatSchurComplementSetAinvType()`, `PCLSC`
2492feefa0e1SJacob Faibussowitsch 
2493e69d4d44SBarry Smith @*/
2494d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurPre(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2495d71ae5a4SJacob Faibussowitsch {
2496e69d4d44SBarry Smith   PetscFunctionBegin;
24970700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2498cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurPre_C", (PC, PCFieldSplitSchurPreType, Mat), (pc, ptype, pre));
24993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2500e69d4d44SBarry Smith }
2501686bed4dSStefano Zampini 
2502d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurPrecondition(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2503d71ae5a4SJacob Faibussowitsch {
25049371c9d4SSatish Balay   return PCFieldSplitSetSchurPre(pc, ptype, pre);
25059371c9d4SSatish Balay } /* Deprecated name */
2506e69d4d44SBarry Smith 
250737a82bf0SJed Brown /*@
250837a82bf0SJed Brown   PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
2509f1580f4eSBarry Smith   preconditioned.  See `PCFieldSplitSetSchurPre()` for details.
251037a82bf0SJed Brown 
2511c3339decSBarry Smith   Logically Collective
251237a82bf0SJed Brown 
2513f899ff85SJose E. Roman   Input Parameter:
251437a82bf0SJed Brown . pc - the preconditioner context
251537a82bf0SJed Brown 
251637a82bf0SJed Brown   Output Parameters:
2517d59693daSPierre Jolivet + ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11`, `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER`
2518d59693daSPierre Jolivet - pre   - matrix to use for preconditioning (with `PC_FIELDSPLIT_SCHUR_PRE_USER`), or `NULL`
251937a82bf0SJed Brown 
252037a82bf0SJed Brown   Level: intermediate
252137a82bf0SJed Brown 
2522d59693daSPierre Jolivet .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCLSC`
2523feefa0e1SJacob Faibussowitsch 
252437a82bf0SJed Brown @*/
2525d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurPre(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre)
2526d71ae5a4SJacob Faibussowitsch {
252737a82bf0SJed Brown   PetscFunctionBegin;
252837a82bf0SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2529cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSchurPre_C", (PC, PCFieldSplitSchurPreType *, Mat *), (pc, ptype, pre));
25303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2531e69d4d44SBarry Smith }
2532e69d4d44SBarry Smith 
253345e7fc46SDmitry Karpeev /*@
2534f1580f4eSBarry Smith   PCFieldSplitSchurGetS -  extract the `MATSCHURCOMPLEMENT` object used by this `PCFIELDSPLIT` in case it needs to be configured separately
253545e7fc46SDmitry Karpeev 
253620f4b53cSBarry Smith   Not Collective
253745e7fc46SDmitry Karpeev 
253845e7fc46SDmitry Karpeev   Input Parameter:
253945e7fc46SDmitry Karpeev . pc - the preconditioner context
254045e7fc46SDmitry Karpeev 
254145e7fc46SDmitry Karpeev   Output Parameter:
2542470b340bSDmitry Karpeev . S - the Schur complement matrix
254345e7fc46SDmitry Karpeev 
254460f59c3bSBarry Smith   Level: advanced
254560f59c3bSBarry Smith 
2546f1580f4eSBarry Smith   Note:
2547f1580f4eSBarry Smith   This matrix should not be destroyed using `MatDestroy()`; rather, use `PCFieldSplitSchurRestoreS()`.
254845e7fc46SDmitry Karpeev 
254960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MATSCHURCOMPLEMENT`, `PCFieldSplitSchurRestoreS()`,
2550f1580f4eSBarry Smith           `MatCreateSchurComplement()`, `MatSchurComplementGetKSP()`, `MatSchurComplementComputeExplicitOperator()`, `MatGetSchurComplement()`
255145e7fc46SDmitry Karpeev @*/
2552d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetS(PC pc, Mat *S)
2553d71ae5a4SJacob Faibussowitsch {
255445e7fc46SDmitry Karpeev   const char    *t;
255545e7fc46SDmitry Karpeev   PetscBool      isfs;
255645e7fc46SDmitry Karpeev   PC_FieldSplit *jac;
255745e7fc46SDmitry Karpeev 
255845e7fc46SDmitry Karpeev   PetscFunctionBegin;
255945e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
25609566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
25619566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
256228b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
256345e7fc46SDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
256463a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
2565470b340bSDmitry Karpeev   if (S) *S = jac->schur;
25663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
256745e7fc46SDmitry Karpeev }
256845e7fc46SDmitry Karpeev 
2569470b340bSDmitry Karpeev /*@
2570f1580f4eSBarry Smith   PCFieldSplitSchurRestoreS -  returns the `MATSCHURCOMPLEMENT` matrix used by this `PC`
2571470b340bSDmitry Karpeev 
257220f4b53cSBarry Smith   Not Collective
2573470b340bSDmitry Karpeev 
2574470b340bSDmitry Karpeev   Input Parameters:
2575470b340bSDmitry Karpeev + pc - the preconditioner context
2576a2b725a8SWilliam Gropp - S  - the Schur complement matrix
2577470b340bSDmitry Karpeev 
2578470b340bSDmitry Karpeev   Level: advanced
2579470b340bSDmitry Karpeev 
258060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MatSchurComplement`, `PCFieldSplitSchurGetS()`
2581470b340bSDmitry Karpeev @*/
2582d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurRestoreS(PC pc, Mat *S)
2583d71ae5a4SJacob Faibussowitsch {
2584470b340bSDmitry Karpeev   const char    *t;
2585470b340bSDmitry Karpeev   PetscBool      isfs;
2586470b340bSDmitry Karpeev   PC_FieldSplit *jac;
2587470b340bSDmitry Karpeev 
2588470b340bSDmitry Karpeev   PetscFunctionBegin;
2589470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
25909566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
25919566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
259228b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
2593470b340bSDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
259463a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
25957827d75bSBarry Smith   PetscCheck(S && (*S == jac->schur), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatSchurComplement restored is not the same as gotten");
25963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2597470b340bSDmitry Karpeev }
2598470b340bSDmitry Karpeev 
2599d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2600d71ae5a4SJacob Faibussowitsch {
2601e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2602e69d4d44SBarry Smith 
2603e69d4d44SBarry Smith   PetscFunctionBegin;
2604084e4875SJed Brown   jac->schurpre = ptype;
2605a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
26069566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&jac->schur_user));
2607084e4875SJed Brown     jac->schur_user = pre;
26089566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
2609084e4875SJed Brown   }
26103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2611e69d4d44SBarry Smith }
2612e69d4d44SBarry Smith 
2613d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre)
2614d71ae5a4SJacob Faibussowitsch {
261537a82bf0SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
261637a82bf0SJed Brown 
261737a82bf0SJed Brown   PetscFunctionBegin;
26186056e507SPierre Jolivet   if (ptype) *ptype = jac->schurpre;
26196056e507SPierre Jolivet   if (pre) *pre = jac->schur_user;
26203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
262137a82bf0SJed Brown }
262237a82bf0SJed Brown 
2623ab1df9f5SJed Brown /*@
26241d27aa22SBarry Smith   PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner {cite}`murphy2000note` and {cite}`ipsen2001note`
2625ab1df9f5SJed Brown 
2626c3339decSBarry Smith   Collective
2627ab1df9f5SJed Brown 
2628ab1df9f5SJed Brown   Input Parameters:
2629ab1df9f5SJed Brown + pc    - the preconditioner context
2630f1580f4eSBarry Smith - ftype - which blocks of factorization to retain, `PC_FIELDSPLIT_SCHUR_FACT_FULL` is default
2631ab1df9f5SJed Brown 
2632f1580f4eSBarry Smith   Options Database Key:
2633d59693daSPierre Jolivet . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - default is `full`
2634ab1df9f5SJed Brown 
2635ab1df9f5SJed Brown   Level: intermediate
2636ab1df9f5SJed Brown 
2637ab1df9f5SJed Brown   Notes:
2638ab1df9f5SJed Brown   The FULL factorization is
2639147403d9SBarry Smith .vb
2640147403d9SBarry Smith   (A   B)  = (1       0) (A   0) (1  Ainv*B)  = L D U
2641147403d9SBarry Smith   (C   E)    (C*Ainv  1) (0   S) (0       1)
2642147403d9SBarry Smith .vb
26431d27aa22SBarry 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$,
26441d27aa22SBarry Smith   and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations,
26451d27aa22SBarry Smith   thus allowing the use of `KSPMINRES)`. Sign flipping of S can be turned off with `PCFieldSplitSetSchurScale()`.
2646ab1df9f5SJed Brown 
2647147403d9SBarry Smith   If A and S are solved exactly
2648147403d9SBarry Smith .vb
2649147403d9SBarry Smith   *) FULL factorization is a direct solver.
2650f1580f4eSBarry 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.
2651f1580f4eSBarry 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.
2652147403d9SBarry Smith .ve
2653ab1df9f5SJed Brown 
2654f1580f4eSBarry Smith   If the iteration count is very low, consider using `KSPFGMRES` or `KSPGCR` which can use one less preconditioner
26550ffb0e17SBarry 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.
26560ffb0e17SBarry Smith 
2657f1580f4eSBarry Smith   For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with `KSPMINRES`.
26580ffb0e17SBarry Smith 
26591d27aa22SBarry Smith   A flexible method like `KSPFGMRES` or `KSPGCR`, [](sec_flexibleksp), 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).
2660ab1df9f5SJed Brown 
26611d27aa22SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurScale()`,
26621d27aa22SBarry Smith           [](sec_flexibleksp)
2663ab1df9f5SJed Brown @*/
2664d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurFactType(PC pc, PCFieldSplitSchurFactType ftype)
2665d71ae5a4SJacob Faibussowitsch {
2666ab1df9f5SJed Brown   PetscFunctionBegin;
2667ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2668cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurFactType_C", (PC, PCFieldSplitSchurFactType), (pc, ftype));
26693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2670ab1df9f5SJed Brown }
2671ab1df9f5SJed Brown 
2672d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc, PCFieldSplitSchurFactType ftype)
2673d71ae5a4SJacob Faibussowitsch {
2674ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2675ab1df9f5SJed Brown 
2676ab1df9f5SJed Brown   PetscFunctionBegin;
2677ab1df9f5SJed Brown   jac->schurfactorization = ftype;
26783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2679ab1df9f5SJed Brown }
2680ab1df9f5SJed Brown 
2681c096484dSStefano Zampini /*@
2682f1580f4eSBarry Smith   PCFieldSplitSetSchurScale -  Controls the sign flip of S for `PC_FIELDSPLIT_SCHUR_FACT_DIAG`.
2683c096484dSStefano Zampini 
2684c3339decSBarry Smith   Collective
2685c096484dSStefano Zampini 
2686c096484dSStefano Zampini   Input Parameters:
2687c096484dSStefano Zampini + pc    - the preconditioner context
2688c096484dSStefano Zampini - scale - scaling factor for the Schur complement
2689c096484dSStefano Zampini 
2690f1580f4eSBarry Smith   Options Database Key:
26911d27aa22SBarry Smith . -pc_fieldsplit_schur_scale <scale> - default is -1.0
2692c096484dSStefano Zampini 
2693c096484dSStefano Zampini   Level: intermediate
2694c096484dSStefano Zampini 
269542747ad1SJacob Faibussowitsch .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurFactType`, `PCFieldSplitSetSchurFactType()`
2696c096484dSStefano Zampini @*/
2697d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurScale(PC pc, PetscScalar scale)
2698d71ae5a4SJacob Faibussowitsch {
2699c096484dSStefano Zampini   PetscFunctionBegin;
2700c096484dSStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2701c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc, scale, 2);
2702cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurScale_C", (PC, PetscScalar), (pc, scale));
27033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2704c096484dSStefano Zampini }
2705c096484dSStefano Zampini 
2706d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc, PetscScalar scale)
2707d71ae5a4SJacob Faibussowitsch {
2708c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2709c096484dSStefano Zampini 
2710c096484dSStefano Zampini   PetscFunctionBegin;
2711c096484dSStefano Zampini   jac->schurscale = scale;
27123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2713c096484dSStefano Zampini }
2714c096484dSStefano Zampini 
271530ad9308SMatthew Knepley /*@C
27168c03b21aSDmitry Karpeev   PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
271730ad9308SMatthew Knepley 
2718c3339decSBarry Smith   Collective
271930ad9308SMatthew Knepley 
272030ad9308SMatthew Knepley   Input Parameter:
272130ad9308SMatthew Knepley . pc - the preconditioner context
272230ad9308SMatthew Knepley 
272330ad9308SMatthew Knepley   Output Parameters:
2724a04f6461SBarry Smith + A00 - the (0,0) block
2725a04f6461SBarry Smith . A01 - the (0,1) block
2726a04f6461SBarry Smith . A10 - the (1,0) block
2727a04f6461SBarry Smith - A11 - the (1,1) block
272830ad9308SMatthew Knepley 
272930ad9308SMatthew Knepley   Level: advanced
273030ad9308SMatthew Knepley 
273160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `MatSchurComplementGetSubMatrices()`, `MatSchurComplementSetSubMatrices()`
273230ad9308SMatthew Knepley @*/
2733d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc, Mat *A00, Mat *A01, Mat *A10, Mat *A11)
2734d71ae5a4SJacob Faibussowitsch {
273530ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
273630ad9308SMatthew Knepley 
273730ad9308SMatthew Knepley   PetscFunctionBegin;
27380700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
273908401ef6SPierre Jolivet   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2740a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2741a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2742a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2743a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
27443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
274530ad9308SMatthew Knepley }
274630ad9308SMatthew Knepley 
2747b09e027eSCarola Kruse /*@
27481d27aa22SBarry Smith   PCFieldSplitSetGKBTol -  Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2749b09e027eSCarola Kruse 
2750c3339decSBarry Smith   Collective
2751e071a0a4SCarola Kruse 
2752b09e027eSCarola Kruse   Input Parameters:
2753b09e027eSCarola Kruse + pc        - the preconditioner context
2754b09e027eSCarola Kruse - tolerance - the solver tolerance
2755b09e027eSCarola Kruse 
2756f1580f4eSBarry Smith   Options Database Key:
27571d27aa22SBarry Smith . -pc_fieldsplit_gkb_tol <tolerance> - default is 1e-5
2758b09e027eSCarola Kruse 
2759b09e027eSCarola Kruse   Level: intermediate
2760b09e027eSCarola Kruse 
2761f1580f4eSBarry Smith   Note:
27621d27aa22SBarry Smith   The generalized GKB algorithm {cite}`arioli2013` uses a lower bound estimate of the error in energy norm as stopping criterion.
2763f1580f4eSBarry Smith   It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than
27641d27aa22SBarry Smith   this estimate, the stopping criterion is satisfactory in practical cases.
2765f1580f4eSBarry Smith 
276660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBMaxit()`
2767b09e027eSCarola Kruse @*/
2768d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBTol(PC pc, PetscReal tolerance)
2769d71ae5a4SJacob Faibussowitsch {
2770b09e027eSCarola Kruse   PetscFunctionBegin;
2771b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2772de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, tolerance, 2);
2773cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBTol_C", (PC, PetscReal), (pc, tolerance));
27743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2775b09e027eSCarola Kruse }
2776b09e027eSCarola Kruse 
2777d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc, PetscReal tolerance)
2778d71ae5a4SJacob Faibussowitsch {
2779b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2780b09e027eSCarola Kruse 
2781b09e027eSCarola Kruse   PetscFunctionBegin;
2782b09e027eSCarola Kruse   jac->gkbtol = tolerance;
27833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2784b09e027eSCarola Kruse }
2785b09e027eSCarola Kruse 
2786b09e027eSCarola Kruse /*@
2787*80670ca5SBarry Smith   PCFieldSplitSetGKBMaxit -  Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2788b09e027eSCarola Kruse 
2789c3339decSBarry Smith   Collective
2790b09e027eSCarola Kruse 
2791b09e027eSCarola Kruse   Input Parameters:
2792b09e027eSCarola Kruse + pc    - the preconditioner context
2793b09e027eSCarola Kruse - maxit - the maximum number of iterations
2794b09e027eSCarola Kruse 
2795f1580f4eSBarry Smith   Options Database Key:
27961d27aa22SBarry Smith . -pc_fieldsplit_gkb_maxit <maxit> - default is 100
2797b09e027eSCarola Kruse 
2798b09e027eSCarola Kruse   Level: intermediate
2799b09e027eSCarola Kruse 
280060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBNu()`
2801b09e027eSCarola Kruse @*/
2802d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc, PetscInt maxit)
2803d71ae5a4SJacob Faibussowitsch {
2804b09e027eSCarola Kruse   PetscFunctionBegin;
2805b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2806de482cd7SCarola Kruse   PetscValidLogicalCollectiveInt(pc, maxit, 2);
2807cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBMaxit_C", (PC, PetscInt), (pc, maxit));
28083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2809b09e027eSCarola Kruse }
2810b09e027eSCarola Kruse 
2811d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc, PetscInt maxit)
2812d71ae5a4SJacob Faibussowitsch {
2813b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2814b09e027eSCarola Kruse 
2815b09e027eSCarola Kruse   PetscFunctionBegin;
2816b09e027eSCarola Kruse   jac->gkbmaxit = maxit;
28173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2818b09e027eSCarola Kruse }
2819b09e027eSCarola Kruse 
2820b09e027eSCarola Kruse /*@
28211d27aa22SBarry Smith   PCFieldSplitSetGKBDelay -  Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization {cite}`arioli2013` in `PCFIELDSPLIT`
2822e071a0a4SCarola Kruse   preconditioner.
2823b09e027eSCarola Kruse 
2824c3339decSBarry Smith   Collective
2825b09e027eSCarola Kruse 
2826b09e027eSCarola Kruse   Input Parameters:
2827b09e027eSCarola Kruse + pc    - the preconditioner context
2828b09e027eSCarola Kruse - delay - the delay window in the lower bound estimate
2829b09e027eSCarola Kruse 
2830f1580f4eSBarry Smith   Options Database Key:
28311d27aa22SBarry Smith . -pc_fieldsplit_gkb_delay <delay> - default is 5
2832b09e027eSCarola Kruse 
2833b09e027eSCarola Kruse   Level: intermediate
2834b09e027eSCarola Kruse 
28351d27aa22SBarry Smith   Notes:
28361d27aa22SBarry Smith   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 $
28371d27aa22SBarry Smith   is expressed as a truncated sum. The error at iteration k can only be measured at iteration (k + `delay`), and thus the algorithm needs
28381d27aa22SBarry Smith   at least (`delay` + 1) iterations to stop.
2839f1580f4eSBarry Smith 
28401d27aa22SBarry Smith   For more details on the generalized Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to {cite}`arioli2013`
2841f1580f4eSBarry Smith 
284260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
2843b09e027eSCarola Kruse @*/
2844d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBDelay(PC pc, PetscInt delay)
2845d71ae5a4SJacob Faibussowitsch {
2846b09e027eSCarola Kruse   PetscFunctionBegin;
2847b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2848b09e027eSCarola Kruse   PetscValidLogicalCollectiveInt(pc, delay, 2);
2849cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBDelay_C", (PC, PetscInt), (pc, delay));
28503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2851b09e027eSCarola Kruse }
2852b09e027eSCarola Kruse 
2853d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc, PetscInt delay)
2854d71ae5a4SJacob Faibussowitsch {
2855b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2856b09e027eSCarola Kruse 
2857b09e027eSCarola Kruse   PetscFunctionBegin;
2858b09e027eSCarola Kruse   jac->gkbdelay = delay;
28593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2860b09e027eSCarola Kruse }
2861b09e027eSCarola Kruse 
2862b09e027eSCarola Kruse /*@
28631d27aa22SBarry Smith   PCFieldSplitSetGKBNu -  Sets the scalar value nu >= 0 in the transformation H = A00 + nu*A01*A01' of the (1,1) block in the
28641d27aa22SBarry Smith   Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2865b09e027eSCarola Kruse 
2866c3339decSBarry Smith   Collective
2867f1580f4eSBarry Smith 
2868f1580f4eSBarry Smith   Input Parameters:
2869f1580f4eSBarry Smith + pc - the preconditioner context
2870f1580f4eSBarry Smith - nu - the shift parameter
2871f1580f4eSBarry Smith 
287220f4b53cSBarry Smith   Options Database Key:
28731d27aa22SBarry Smith . -pc_fieldsplit_gkb_nu <nu> - default is 1
2874f1580f4eSBarry Smith 
2875f1580f4eSBarry Smith   Level: intermediate
2876b09e027eSCarola Kruse 
2877b09e027eSCarola Kruse   Notes:
28781d27aa22SBarry Smith   This shift is in general done to obtain better convergence properties for the outer loop of the algorithm. This is often achieved by choosing `nu` sufficiently large. However,
28791d27aa22SBarry Smith   if `nu` is chosen too large, the matrix H might be badly conditioned and the solution of the linear system $Hx = b$ in the inner loop becomes difficult. It is therefore
2880b09e027eSCarola Kruse   necessary to find a good balance in between the convergence of the inner and outer loop.
2881b09e027eSCarola Kruse 
28821d27aa22SBarry Smith   For `nu` = 0, no shift is done. In this case A00 has to be positive definite. The matrix N in {cite}`arioli2013` is then chosen as identity.
2883b09e027eSCarola Kruse 
288460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
2885b09e027eSCarola Kruse @*/
2886d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBNu(PC pc, PetscReal nu)
2887d71ae5a4SJacob Faibussowitsch {
2888b09e027eSCarola Kruse   PetscFunctionBegin;
2889b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2890de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, nu, 2);
2891cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBNu_C", (PC, PetscReal), (pc, nu));
28923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2893b09e027eSCarola Kruse }
2894b09e027eSCarola Kruse 
2895d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc, PetscReal nu)
2896d71ae5a4SJacob Faibussowitsch {
2897b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2898b09e027eSCarola Kruse 
2899b09e027eSCarola Kruse   PetscFunctionBegin;
2900b09e027eSCarola Kruse   jac->gkbnu = nu;
29013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2902b09e027eSCarola Kruse }
2903b09e027eSCarola Kruse 
2904d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc, PCCompositeType type)
2905d71ae5a4SJacob Faibussowitsch {
290679416396SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
290779416396SBarry Smith 
290879416396SBarry Smith   PetscFunctionBegin;
290979416396SBarry Smith   jac->type = type;
29102e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
29112e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
29122e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
29132e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
29142e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
29152e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
29162e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
29172e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
29182e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
2919e071a0a4SCarola Kruse 
29203b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
29213b224e63SBarry Smith     pc->ops->apply          = PCApply_FieldSplit_Schur;
29227b665727SPierre Jolivet     pc->ops->applytranspose = PCApplyTranspose_FieldSplit_Schur;
29233b224e63SBarry Smith     pc->ops->view           = PCView_FieldSplit_Schur;
29242fa5cd67SKarl Rupp 
29259566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit_Schur));
29269566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", PCFieldSplitSetSchurPre_FieldSplit));
29279566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", PCFieldSplitGetSchurPre_FieldSplit));
29289566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", PCFieldSplitSetSchurFactType_FieldSplit));
29299566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", PCFieldSplitSetSchurScale_FieldSplit));
2930a51937d4SCarola Kruse   } else if (type == PC_COMPOSITE_GKB) {
2931a51937d4SCarola Kruse     pc->ops->apply = PCApply_FieldSplit_GKB;
2932a51937d4SCarola Kruse     pc->ops->view  = PCView_FieldSplit_GKB;
2933e69d4d44SBarry Smith 
29349566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
29359566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", PCFieldSplitSetGKBTol_FieldSplit));
29369566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", PCFieldSplitSetGKBMaxit_FieldSplit));
29379566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", PCFieldSplitSetGKBNu_FieldSplit));
29389566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", PCFieldSplitSetGKBDelay_FieldSplit));
29393b224e63SBarry Smith   } else {
29403b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
29413b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
29422fa5cd67SKarl Rupp 
29439566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
29443b224e63SBarry Smith   }
29453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
294679416396SBarry Smith }
294779416396SBarry Smith 
2948d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc, PetscInt bs)
2949d71ae5a4SJacob Faibussowitsch {
295051f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
295151f519a2SBarry Smith 
295251f519a2SBarry Smith   PetscFunctionBegin;
295363a3b9bcSJacob Faibussowitsch   PetscCheck(bs >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Blocksize must be positive, you gave %" PetscInt_FMT, bs);
29542472a847SBarry 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);
295551f519a2SBarry Smith   jac->bs = bs;
29563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
295751f519a2SBarry Smith }
295851f519a2SBarry Smith 
2959d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetCoordinates_FieldSplit(PC pc, PetscInt dim, PetscInt nloc, PetscReal coords[])
2960d71ae5a4SJacob Faibussowitsch {
29615ddf11f8SNicolas Barnafi   PC_FieldSplit    *jac           = (PC_FieldSplit *)pc->data;
29625ddf11f8SNicolas Barnafi   PC_FieldSplitLink ilink_current = jac->head;
29635ddf11f8SNicolas Barnafi   IS                is_owned;
29645ddf11f8SNicolas Barnafi 
29655ddf11f8SNicolas Barnafi   PetscFunctionBegin;
29665ddf11f8SNicolas Barnafi   jac->coordinates_set = PETSC_TRUE; // Internal flag
2967f3fa974cSJacob Faibussowitsch   PetscCall(MatGetOwnershipIS(pc->mat, &is_owned, NULL));
29685ddf11f8SNicolas Barnafi 
29695ddf11f8SNicolas Barnafi   while (ilink_current) {
29705ddf11f8SNicolas Barnafi     // For each IS, embed it to get local coords indces
29715ddf11f8SNicolas Barnafi     IS              is_coords;
29725ddf11f8SNicolas Barnafi     PetscInt        ndofs_block;
29735ddf11f8SNicolas Barnafi     const PetscInt *block_dofs_enumeration; // Numbering of the dofs relevant to the current block
29745ddf11f8SNicolas Barnafi 
29755ddf11f8SNicolas Barnafi     // Setting drop to true for safety. It should make no difference.
29769566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink_current->is, is_owned, PETSC_TRUE, &is_coords));
29779566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(is_coords, &ndofs_block));
29789566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(is_coords, &block_dofs_enumeration));
29795ddf11f8SNicolas Barnafi 
29805ddf11f8SNicolas Barnafi     // Allocate coordinates vector and set it directly
2981f4f49eeaSPierre Jolivet     PetscCall(PetscMalloc1(ndofs_block * dim, &ilink_current->coords));
29825ddf11f8SNicolas Barnafi     for (PetscInt dof = 0; dof < ndofs_block; ++dof) {
2983ad540459SPierre Jolivet       for (PetscInt d = 0; d < dim; ++d) (ilink_current->coords)[dim * dof + d] = coords[dim * block_dofs_enumeration[dof] + d];
29845ddf11f8SNicolas Barnafi     }
29855ddf11f8SNicolas Barnafi     ilink_current->dim   = dim;
29865ddf11f8SNicolas Barnafi     ilink_current->ndofs = ndofs_block;
29879566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(is_coords, &block_dofs_enumeration));
29889566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is_coords));
29895ddf11f8SNicolas Barnafi     ilink_current = ilink_current->next;
29905ddf11f8SNicolas Barnafi   }
29919566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_owned));
29923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
29935ddf11f8SNicolas Barnafi }
29945ddf11f8SNicolas Barnafi 
2995bc08b0f1SBarry Smith /*@
2996f1580f4eSBarry Smith   PCFieldSplitSetType - Sets the type, `PCCompositeType`, of a `PCFIELDSPLIT`
299779416396SBarry Smith 
2998c3339decSBarry Smith   Collective
299979416396SBarry Smith 
3000d8d19677SJose E. Roman   Input Parameters:
3001a2b725a8SWilliam Gropp + pc   - the preconditioner context
3002f1580f4eSBarry Smith - type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
300379416396SBarry Smith 
300479416396SBarry Smith   Options Database Key:
30051d27aa22SBarry Smith . -pc_fieldsplit_type <one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
300679416396SBarry Smith 
3007feefa0e1SJacob Faibussowitsch   Level: intermediate
300879416396SBarry Smith 
300960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCCompositeType`, `PCCompositeGetType()`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`,
3010f1580f4eSBarry Smith           `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
301179416396SBarry Smith @*/
3012d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetType(PC pc, PCCompositeType type)
3013d71ae5a4SJacob Faibussowitsch {
301479416396SBarry Smith   PetscFunctionBegin;
30150700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3016cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetType_C", (PC, PCCompositeType), (pc, type));
30173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
301879416396SBarry Smith }
301979416396SBarry Smith 
3020b02e2d75SMatthew G Knepley /*@
3021f1580f4eSBarry Smith   PCFieldSplitGetType - Gets the type, `PCCompositeType`, of a `PCFIELDSPLIT`
3022b02e2d75SMatthew G Knepley 
3023b02e2d75SMatthew G Knepley   Not collective
3024b02e2d75SMatthew G Knepley 
3025b02e2d75SMatthew G Knepley   Input Parameter:
3026b02e2d75SMatthew G Knepley . pc - the preconditioner context
3027b02e2d75SMatthew G Knepley 
3028b02e2d75SMatthew G Knepley   Output Parameter:
3029f1580f4eSBarry Smith . type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
3030b02e2d75SMatthew G Knepley 
3031feefa0e1SJacob Faibussowitsch   Level: intermediate
3032b02e2d75SMatthew G Knepley 
303360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCompositeSetType()`, `PCFIELDSPLIT`, `PCCompositeType`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`,
3034f1580f4eSBarry Smith           `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
3035b02e2d75SMatthew G Knepley @*/
3036d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
3037d71ae5a4SJacob Faibussowitsch {
3038b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
3039b02e2d75SMatthew G Knepley 
3040b02e2d75SMatthew G Knepley   PetscFunctionBegin;
3041b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
30424f572ea9SToby Isaac   PetscAssertPointer(type, 2);
3043b02e2d75SMatthew G Knepley   *type = jac->type;
30443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3045b02e2d75SMatthew G Knepley }
3046b02e2d75SMatthew G Knepley 
30474ab8060aSDmitry Karpeev /*@
3048f1580f4eSBarry Smith   PCFieldSplitSetDMSplits - Flags whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible.
30494ab8060aSDmitry Karpeev 
3050c3339decSBarry Smith   Logically Collective
30514ab8060aSDmitry Karpeev 
30524ab8060aSDmitry Karpeev   Input Parameters:
30534ab8060aSDmitry Karpeev + pc  - the preconditioner context
3054f1580f4eSBarry Smith - flg - boolean indicating whether to use field splits defined by the `DM`
30554ab8060aSDmitry Karpeev 
30564ab8060aSDmitry Karpeev   Options Database Key:
3057f1580f4eSBarry Smith . -pc_fieldsplit_dm_splits <bool> - use the field splits defined by the `DM`
30584ab8060aSDmitry Karpeev 
3059feefa0e1SJacob Faibussowitsch   Level: intermediate
30604ab8060aSDmitry Karpeev 
306173ff1848SBarry Smith   Developer Note:
306273ff1848SBarry Smith   The name should be `PCFieldSplitSetUseDMSplits()`, similar change to options database
306373ff1848SBarry Smith 
306473ff1848SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDMSplits()`, `DMCreateFieldDecomposition()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()`
30654ab8060aSDmitry Karpeev @*/
3066d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDMSplits(PC pc, PetscBool flg)
3067d71ae5a4SJacob Faibussowitsch {
30684ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
30694ab8060aSDmitry Karpeev   PetscBool      isfs;
30704ab8060aSDmitry Karpeev 
30714ab8060aSDmitry Karpeev   PetscFunctionBegin;
30724ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
30734ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc, flg, 2);
30749566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
3075ad540459SPierre Jolivet   if (isfs) jac->dm_splits = flg;
30763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30774ab8060aSDmitry Karpeev }
30784ab8060aSDmitry Karpeev 
30794ab8060aSDmitry Karpeev /*@
3080f1580f4eSBarry Smith   PCFieldSplitGetDMSplits - Returns flag indicating whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible.
30814ab8060aSDmitry Karpeev 
30824ab8060aSDmitry Karpeev   Logically Collective
30834ab8060aSDmitry Karpeev 
30844ab8060aSDmitry Karpeev   Input Parameter:
30854ab8060aSDmitry Karpeev . pc - the preconditioner context
30864ab8060aSDmitry Karpeev 
30874ab8060aSDmitry Karpeev   Output Parameter:
3088f1580f4eSBarry Smith . flg - boolean indicating whether to use field splits defined by the `DM`
30894ab8060aSDmitry Karpeev 
3090feefa0e1SJacob Faibussowitsch   Level: intermediate
30914ab8060aSDmitry Karpeev 
309273ff1848SBarry Smith   Developer Note:
309373ff1848SBarry Smith   The name should be `PCFieldSplitGetUseDMSplits()`
309473ff1848SBarry Smith 
309573ff1848SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDMSplits()`, `DMCreateFieldDecomposition()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()`
30964ab8060aSDmitry Karpeev @*/
3097d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDMSplits(PC pc, PetscBool *flg)
3098d71ae5a4SJacob Faibussowitsch {
30994ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
31004ab8060aSDmitry Karpeev   PetscBool      isfs;
31014ab8060aSDmitry Karpeev 
31024ab8060aSDmitry Karpeev   PetscFunctionBegin;
31034ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
31044f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
31059566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
31064ab8060aSDmitry Karpeev   if (isfs) {
31074ab8060aSDmitry Karpeev     if (flg) *flg = jac->dm_splits;
31084ab8060aSDmitry Karpeev   }
31093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
31104ab8060aSDmitry Karpeev }
31114ab8060aSDmitry Karpeev 
31127b752e3dSPatrick Sanan /*@
3113f1580f4eSBarry Smith   PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries.
31147b752e3dSPatrick Sanan 
31157b752e3dSPatrick Sanan   Logically Collective
31167b752e3dSPatrick Sanan 
31177b752e3dSPatrick Sanan   Input Parameter:
31187b752e3dSPatrick Sanan . pc - the preconditioner context
31197b752e3dSPatrick Sanan 
31207b752e3dSPatrick Sanan   Output Parameter:
31217b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not
31227b752e3dSPatrick Sanan 
3123feefa0e1SJacob Faibussowitsch   Level: intermediate
31247b752e3dSPatrick Sanan 
312560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDetectSaddlePoint()`
31267b752e3dSPatrick Sanan @*/
3127d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc, PetscBool *flg)
3128d71ae5a4SJacob Faibussowitsch {
31297b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
31307b752e3dSPatrick Sanan 
31317b752e3dSPatrick Sanan   PetscFunctionBegin;
31327b752e3dSPatrick Sanan   *flg = jac->detect;
31333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
31347b752e3dSPatrick Sanan }
31357b752e3dSPatrick Sanan 
31367b752e3dSPatrick Sanan /*@
3137f1580f4eSBarry Smith   PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries.
31387b752e3dSPatrick Sanan 
31397b752e3dSPatrick Sanan   Logically Collective
31407b752e3dSPatrick Sanan 
31417b752e3dSPatrick Sanan   Input Parameter:
31427b752e3dSPatrick Sanan . pc - the preconditioner context
31437b752e3dSPatrick Sanan 
31447b752e3dSPatrick Sanan   Output Parameter:
31457b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not
31467b752e3dSPatrick Sanan 
31477b752e3dSPatrick Sanan   Options Database Key:
3148147403d9SBarry Smith . -pc_fieldsplit_detect_saddle_point <bool> - detect and use the saddle point
3149147403d9SBarry Smith 
3150feefa0e1SJacob Faibussowitsch   Level: intermediate
315160f59c3bSBarry Smith 
3152f1580f4eSBarry Smith   Note:
3153f1580f4eSBarry 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()`).
31547b752e3dSPatrick Sanan 
315560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDetectSaddlePoint()`, `PCFieldSplitSetType()`, `PCFieldSplitSetSchurPre()`, `PC_FIELDSPLIT_SCHUR_PRE_SELF`
31567b752e3dSPatrick Sanan @*/
3157d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc, PetscBool flg)
3158d71ae5a4SJacob Faibussowitsch {
31597b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
31607b752e3dSPatrick Sanan 
31617b752e3dSPatrick Sanan   PetscFunctionBegin;
31627b752e3dSPatrick Sanan   jac->detect = flg;
31637b752e3dSPatrick Sanan   if (jac->detect) {
31649566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetType(pc, PC_COMPOSITE_SCHUR));
31659566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetSchurPre(pc, PC_FIELDSPLIT_SCHUR_PRE_SELF, NULL));
31667b752e3dSPatrick Sanan   }
31673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
31687b752e3dSPatrick Sanan }
31697b752e3dSPatrick Sanan 
31700971522cSBarry Smith /*MC
3171a8c7a070SBarry Smith   PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
3172f1580f4eSBarry Smith   collections of variables (that may overlap) called splits. See [the users manual section on "Solving Block Matrices"](sec_block_matrices) for more details.
31730971522cSBarry Smith 
317479416396SBarry Smith   Options Database Keys:
3175de37d9f1SPatrick Sanan +   -pc_fieldsplit_%d_fields <a,b,..>                                                - indicates the fields to be used in the `%d`'th split
317681540f2fSBarry Smith .   -pc_fieldsplit_default                                                           - automatically add any fields to additional splits that have not
3177de37d9f1SPatrick Sanan                                                                                        been supplied explicitly by `-pc_fieldsplit_%d_fields`
317881540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs>                                                   - size of block that defines fields (i.e. there are bs fields)
3179*80670ca5SBarry Smith                                                                                        when the matrix is not of `MatType` `MATNEST`
3180a51937d4SCarola Kruse .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting
3181d59693daSPierre Jolivet .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full>                     - default is `a11`; see `PCFieldSplitSetSchurPre()`
31821d27aa22SBarry Smith .   -pc_fieldsplit_schur_fact_type <diag,lower,upper,full>                           - set factorization type when using `-pc_fieldsplit_type schur`;
31831d27aa22SBarry Smith                                                                                        see `PCFieldSplitSetSchurFactType()`
318473ff1848SBarry Smith .   -pc_fieldsplit_dm_splits <true,false> (default is true)                          - Whether to use `DMCreateFieldDecomposition()` for splits
3185fb6809a2SPatrick Sanan -   -pc_fieldsplit_detect_saddle_point                                               - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
318679416396SBarry Smith 
3187de37d9f1SPatrick Sanan   Options prefixes for inner solvers when using the Schur complement preconditioner are `-fieldsplit_0_` and `-fieldsplit_1_` .
3188de37d9f1SPatrick Sanan   The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is `-fieldsplit_0_`
318960f59c3bSBarry Smith   For all other solvers they are `-fieldsplit_%d_` for the `%d`'th field; use `-fieldsplit_` for all fields.
319060f59c3bSBarry Smith 
319160f59c3bSBarry Smith   To set options on the solvers for each block append `-fieldsplit_` to all the `PC`
319260f59c3bSBarry Smith   options database keys. For example, `-fieldsplit_pc_type ilu` `-fieldsplit_pc_factor_levels 1`
319360f59c3bSBarry Smith 
319460f59c3bSBarry Smith   To set the options on the solvers separate for each block call `PCFieldSplitGetSubKSP()`
319560f59c3bSBarry Smith   and set the options directly on the resulting `KSP` object
319660f59c3bSBarry Smith 
319760f59c3bSBarry Smith   Level: intermediate
31985d4c12cdSJungho Lee 
3199c8a0d604SMatthew G Knepley   Notes:
3200*80670ca5SBarry Smith   Use `PCFieldSplitSetFields()` to set splits defined by "strided" entries or with a `MATNEST` and `PCFieldSplitSetIS()`
3201f1580f4eSBarry Smith   to define a split by an arbitrary collection of entries.
3202d32f9abdSBarry Smith 
320373ff1848SBarry Smith   If no splits are set, the default is used. If a `DM` is associated with the `PC` and it supports
3204*80670ca5SBarry Smith   `DMCreateFieldDecomposition()`, then that is used for the default. Otherwise if the matrix is not `MATNEST`, the splits are defined by entries strided by bs,
3205de37d9f1SPatrick Sanan   beginning at 0 then 1, etc to bs-1. The block size can be set with `PCFieldSplitSetBlockSize()`,
3206d32f9abdSBarry Smith   if this is not called the block size defaults to the blocksize of the second matrix passed
3207de37d9f1SPatrick Sanan   to `KSPSetOperators()`/`PCSetOperators()`.
3208d32f9abdSBarry Smith 
3209de37d9f1SPatrick Sanan   For the Schur complement preconditioner if
3210de37d9f1SPatrick Sanan   ```{math}
3211de37d9f1SPatrick Sanan     J = \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{10} & A_{11} \end{array}\right]
3212de37d9f1SPatrick Sanan   ```
3213e69d4d44SBarry Smith 
3214de37d9f1SPatrick Sanan   the preconditioner using `full` factorization is logically
3215de37d9f1SPatrick Sanan   ```{math}
3216ecaa082aSMatthew Knepley     \left[\begin{array}{cc} I & -\text{ksp}(A_{00}) A_{01} \\ 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]
3217de37d9f1SPatrick Sanan       ```
3218de37d9f1SPatrick Sanan   where the action of $\text{inv}(A_{00})$ is applied using the KSP solver with prefix `-fieldsplit_0_`.  $S$ is the Schur complement
3219de37d9f1SPatrick Sanan   ```{math}
3220223e5b4fSPatrick Sanan      S = A_{11} - A_{10} \text{ksp}(A_{00}) A_{01}
3221de37d9f1SPatrick Sanan   ```
3222de37d9f1SPatrick 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
322360f59c3bSBarry Smith   in providing the SECOND split or 1 if not given). For `PCFieldSplitGetSubKSP()` when field number is 0,
3224*80670ca5SBarry Smith   it returns the `KSP` associated with `-fieldsplit_0_` while field number 1 gives `-fieldsplit_1_` KSP. By default
3225de37d9f1SPatrick Sanan   $A_{11}$ is used to construct a preconditioner for $S$, use `PCFieldSplitSetSchurPre()` for all the possible ways to construct the preconditioner for $S$.
3226de37d9f1SPatrick Sanan 
3227de37d9f1SPatrick Sanan   The factorization type is set using `-pc_fieldsplit_schur_fact_type <diag, lower, upper, full>`. `full` is shown above,
3228de37d9f1SPatrick Sanan   `diag` gives
3229de37d9f1SPatrick Sanan   ```{math}
3230de37d9f1SPatrick Sanan     \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\  0 & -\text{ksp}(S) \end{array}\right]
3231de37d9f1SPatrick Sanan   ```
3232de37d9f1SPatrick 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
3233de37d9f1SPatrick Sanan   can be turned off with `PCFieldSplitSetSchurScale()` or by command line `-pc_fieldsplit_schur_scale 1.0`. The `lower` factorization is the inverse of
3234de37d9f1SPatrick Sanan   ```{math}
3235de37d9f1SPatrick Sanan     \left[\begin{array}{cc} A_{00} & 0 \\  A_{10} & S \end{array}\right]
3236de37d9f1SPatrick Sanan   ```
3237de37d9f1SPatrick Sanan   where the inverses of A_{00} and S are applied using KSPs. The upper factorization is the inverse of
3238de37d9f1SPatrick Sanan   ```{math}
3239de37d9f1SPatrick Sanan     \left[\begin{array}{cc} A_{00} & A_{01} \\  0 & S \end{array}\right]
3240de37d9f1SPatrick Sanan   ```
3241de37d9f1SPatrick Sanan   where again the inverses of $A_{00}$ and $S$ are applied using `KSP`s.
3242de37d9f1SPatrick Sanan 
3243de37d9f1SPatrick Sanan   If only one set of indices (one `IS`) is provided with `PCFieldSplitSetIS()` then the complement of that `IS`
3244*80670ca5SBarry Smith   is used automatically for a second submatrix.
3245edf189efSBarry Smith 
3246f1580f4eSBarry Smith   The fieldsplit preconditioner cannot currently be used with the `MATBAIJ` or `MATSBAIJ` data formats if the blocksize is larger than 1.
3247*80670ca5SBarry Smith   Generally it should be used with the `MATAIJ` or `MATNEST` `MatType`
3248ff218e97SBarry Smith 
3249*80670ca5SBarry Smith   The forms of these preconditioners are closely related, if not identical, to forms derived as "Distributive Iterations", see,
32501d569b8fSBarry Smith   for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling {cite}`wesseling2009`.
3251*80670ca5SBarry Smith   One can also use `PCFIELDSPLIT` inside a smoother resulting in "Distributive Smoothers".
32520716a85fSBarry Smith 
3253de37d9f1SPatrick Sanan   See "A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations" {cite}`elman2008tcp`.
3254a6a584a2SBarry Smith 
3255de37d9f1SPatrick Sanan   The Constrained Pressure Preconditioner (CPR) can be implemented using `PCCOMPOSITE` with `PCGALERKIN`. CPR first solves an $R A P$ subsystem, updates the
3256de37d9f1SPatrick Sanan   residual on all variables (`PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)`), and then applies a simple ILU like preconditioner on all the variables.
3257a51937d4SCarola Kruse 
3258de37d9f1SPatrick Sanan   The generalized Golub-Kahan bidiagonalization preconditioner (GKB) can be applied to symmetric $2 \times 2$ block matrices of the shape
3259de37d9f1SPatrick Sanan   ```{math}
3260de37d9f1SPatrick Sanan     \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{01}' & 0 \end{array}\right]
3261de37d9f1SPatrick Sanan   ```
32621d569b8fSBarry Smith   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}'$.
3263de37d9f1SPatrick 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_`.
3264a51937d4SCarola Kruse 
326560f59c3bSBarry Smith   Developer Note:
326660f59c3bSBarry Smith   The Schur complement functionality of `PCFIELDSPLIT` should likely be factored into its own `PC` thus simplifying the implementation of the preconditioners and their
326760f59c3bSBarry Smith   user API.
3268f1580f4eSBarry Smith 
326960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCLSC`,
3270db781477SPatrick Sanan           `PCFieldSplitGetSubKSP()`, `PCFieldSplitSchurGetSubKSP()`, `PCFieldSplitSetFields()`,
3271db781477SPatrick Sanan           `PCFieldSplitSetType()`, `PCFieldSplitSetIS()`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitSetSchurFactType()`,
3272db781477SPatrick Sanan           `MatSchurComplementSetAinvType()`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetDetectSaddlePoint()`
32730971522cSBarry Smith M*/
32740971522cSBarry Smith 
3275d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
3276d71ae5a4SJacob Faibussowitsch {
32770971522cSBarry Smith   PC_FieldSplit *jac;
32780971522cSBarry Smith 
32790971522cSBarry Smith   PetscFunctionBegin;
32804dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&jac));
32812fa5cd67SKarl Rupp 
32820971522cSBarry Smith   jac->bs                 = -1;
32830971522cSBarry Smith   jac->nsplits            = 0;
32843e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
3285e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
3286c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
3287c096484dSStefano Zampini   jac->schurscale         = -1.0;
3288fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
32897b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
3290a51937d4SCarola Kruse   jac->gkbtol             = 1e-5;
3291a51937d4SCarola Kruse   jac->gkbdelay           = 5;
3292a51937d4SCarola Kruse   jac->gkbnu              = 1;
3293a51937d4SCarola Kruse   jac->gkbmaxit           = 100;
3294de482cd7SCarola Kruse   jac->gkbmonitor         = PETSC_FALSE;
32955ddf11f8SNicolas Barnafi   jac->coordinates_set    = PETSC_FALSE;
329651f519a2SBarry Smith 
32970971522cSBarry Smith   pc->data = (void *)jac;
32980971522cSBarry Smith 
32990971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
3300421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
33010971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
3302574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
33030971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
33040971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
33050971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
33060a545947SLisandro Dalcin   pc->ops->applyrichardson = NULL;
33070971522cSBarry Smith 
33089566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", PCFieldSplitSchurGetSubKSP_FieldSplit));
33099566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
33109566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", PCFieldSplitSetFields_FieldSplit));
33119566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", PCFieldSplitSetIS_FieldSplit));
33129566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", PCFieldSplitSetType_FieldSplit));
33139566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", PCFieldSplitSetBlockSize_FieldSplit));
33149566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", PCFieldSplitRestrictIS_FieldSplit));
33159566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", PCSetCoordinates_FieldSplit));
33163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
33170971522cSBarry Smith }
3318