xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 20f4b53cbb5e9bd9ef12b76a8697d60d197cda17)
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:
1809566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetAinvType(jac->schur, &atype));
1819371c9d4SSatish 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 "))));
182a9908d51SBarry Smith       break;
183d71ae5a4SJacob Faibussowitsch     case PC_FIELDSPLIT_SCHUR_PRE_A11:
184d71ae5a4SJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from A11\n"));
185d71ae5a4SJacob Faibussowitsch       break;
186d71ae5a4SJacob Faibussowitsch     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
187d71ae5a4SJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from the exact Schur complement\n"));
188d71ae5a4SJacob Faibussowitsch       break;
1893e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1903e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1919566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from user provided matrix\n"));
1923e8b8b31SMatthew G Knepley       } else {
1939566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from A11\n"));
1943e8b8b31SMatthew G Knepley       }
1953e8b8b31SMatthew G Knepley       break;
196d71ae5a4SJacob Faibussowitsch     default:
197d71ae5a4SJacob Faibussowitsch       SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1983e8b8b31SMatthew G Knepley     }
1999566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Split info:\n"));
2009566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
2013b224e63SBarry Smith     for (i = 0; i < jac->nsplits; i++) {
2023b224e63SBarry Smith       if (ilink->fields) {
20363a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i));
2049566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
2053b224e63SBarry Smith         for (j = 0; j < ilink->nfields; j++) {
20648a46eb9SPierre Jolivet           if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
20763a3b9bcSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
2083b224e63SBarry Smith         }
2099566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
2109566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
2113b224e63SBarry Smith       } else {
21263a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i));
2133b224e63SBarry Smith       }
2143b224e63SBarry Smith       ilink = ilink->next;
2153b224e63SBarry Smith     }
2169566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for A00 block\n"));
2179566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
21806de4afeSJed Brown     if (jac->head) {
2199566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->head->ksp, viewer));
2209566063dSJacob Faibussowitsch     } else PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
2219566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
22206de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
2239566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for upper A00 in upper triangular factor \n"));
2249566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPushTab(viewer));
2259566063dSJacob Faibussowitsch       if (jac->kspupper) PetscCall(KSPView(jac->kspupper, viewer));
2269566063dSJacob Faibussowitsch       else PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
2279566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPopTab(viewer));
228443836d0SMatthew G Knepley     }
2299566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for S = A11 - A10 inv(A00) A01 \n"));
2309566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
23112cae6f2SJed Brown     if (jac->kspschur) {
2329566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->kspschur, viewer));
23312cae6f2SJed Brown     } else {
2349566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
23512cae6f2SJed Brown     }
2369566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
2379566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
23806de4afeSJed Brown   } else if (isdraw && jac->head) {
2394996c5bdSBarry Smith     PetscDraw draw;
2404996c5bdSBarry Smith     PetscReal x, y, w, wd, h;
2414996c5bdSBarry Smith     PetscInt  cnt = 2;
2424996c5bdSBarry Smith     char      str[32];
2434996c5bdSBarry Smith 
2449566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
2459566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
246c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
247c74581afSBarry Smith     w  = 2 * PetscMin(1.0 - x, x);
248c74581afSBarry Smith     wd = w / (cnt + 1);
249c74581afSBarry Smith 
2509566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(str, 32, "Schur fact. %s", PCFieldSplitSchurFactTypes[jac->schurfactorization]));
2519566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h));
2524996c5bdSBarry Smith     y -= h;
2534996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) {
2549566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]));
2553b224e63SBarry Smith     } else {
2569566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[jac->schurpre]));
2574996c5bdSBarry Smith     }
2589566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x + wd * (cnt - 1) / 2.0, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h));
2594996c5bdSBarry Smith     y -= h;
2604996c5bdSBarry Smith     x = x - wd * (cnt - 1) / 2.0;
2614996c5bdSBarry Smith 
2629566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2639566063dSJacob Faibussowitsch     PetscCall(KSPView(jac->head->ksp, viewer));
2649566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
2654996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2664996c5bdSBarry Smith       x += wd;
2679566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2689566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->kspupper, viewer));
2699566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
2704996c5bdSBarry Smith     }
2714996c5bdSBarry Smith     x += wd;
2729566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2739566063dSJacob Faibussowitsch     PetscCall(KSPView(jac->kspschur, viewer));
2749566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
2753b224e63SBarry Smith   }
2763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2773b224e63SBarry Smith }
2783b224e63SBarry Smith 
279d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_GKB(PC pc, PetscViewer viewer)
280d71ae5a4SJacob Faibussowitsch {
281a51937d4SCarola Kruse   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
282a51937d4SCarola Kruse   PetscBool         iascii, isdraw;
283a51937d4SCarola Kruse   PetscInt          i, j;
284a51937d4SCarola Kruse   PC_FieldSplitLink ilink = jac->head;
285a51937d4SCarola Kruse 
286a51937d4SCarola Kruse   PetscFunctionBegin;
2879566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
2889566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
289a51937d4SCarola Kruse   if (iascii) {
290a51937d4SCarola Kruse     if (jac->bs > 0) {
29163a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs));
292a51937d4SCarola Kruse     } else {
29363a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits));
294a51937d4SCarola Kruse     }
29548a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
29648a46eb9SPierre Jolivet     if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for diagonal blocks\n"));
29748a46eb9SPierre Jolivet     if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for off-diagonal blocks\n"));
298a51937d4SCarola Kruse 
29963a3b9bcSJacob 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));
3009566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Solver info for H = A00 + nu*A01*A01' matrix:\n"));
3019566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
302a51937d4SCarola Kruse 
303a51937d4SCarola Kruse     if (ilink->fields) {
30463a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Fields "));
3059566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
306a51937d4SCarola Kruse       for (j = 0; j < ilink->nfields; j++) {
30748a46eb9SPierre Jolivet         if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
30863a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
309a51937d4SCarola Kruse       }
3109566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
3119566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
312a51937d4SCarola Kruse     } else {
31363a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Defined by IS\n"));
314a51937d4SCarola Kruse     }
3159566063dSJacob Faibussowitsch     PetscCall(KSPView(ilink->ksp, viewer));
316a51937d4SCarola Kruse 
3179566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
318a51937d4SCarola Kruse   }
319a51937d4SCarola Kruse 
320a51937d4SCarola Kruse   if (isdraw) {
321a51937d4SCarola Kruse     PetscDraw draw;
322a51937d4SCarola Kruse     PetscReal x, y, w, wd;
323a51937d4SCarola Kruse 
3249566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
3259566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
326a51937d4SCarola Kruse     w  = 2 * PetscMin(1.0 - x, x);
327a51937d4SCarola Kruse     wd = w / (jac->nsplits + 1);
328a51937d4SCarola Kruse     x  = x - wd * (jac->nsplits - 1) / 2.0;
329a51937d4SCarola Kruse     for (i = 0; i < jac->nsplits; i++) {
3309566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
3319566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
3329566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
333a51937d4SCarola Kruse       x += wd;
334a51937d4SCarola Kruse       ilink = ilink->next;
335a51937d4SCarola Kruse     }
336a51937d4SCarola Kruse   }
3373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
338a51937d4SCarola Kruse }
339a51937d4SCarola Kruse 
3406c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
341d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
342d71ae5a4SJacob Faibussowitsch {
3436c924f48SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
3445d4c12cdSJungho Lee   PetscInt       i, nfields, *ifields, nfields_col, *ifields_col;
3455d4c12cdSJungho Lee   PetscBool      flg, flg_col;
3465d4c12cdSJungho Lee   char           optionname[128], splitname[8], optionname_col[128];
3476c924f48SJed Brown 
3486c924f48SJed Brown   PetscFunctionBegin;
3499566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->bs, &ifields));
3509566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->bs, &ifields_col));
3516c924f48SJed Brown   for (i = 0, flg = PETSC_TRUE;; i++) {
35263a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
35363a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
35463a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname_col, sizeof(optionname_col), "-pc_fieldsplit_%" PetscInt_FMT "_fields_col", i));
3556c924f48SJed Brown     nfields     = jac->bs;
35629499fbbSJungho Lee     nfields_col = jac->bs;
3579566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
3589566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname_col, ifields_col, &nfields_col, &flg_col));
3596c924f48SJed Brown     if (!flg) break;
3605d4c12cdSJungho Lee     else if (flg && !flg_col) {
36128b400f6SJacob Faibussowitsch       PetscCheck(nfields, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
3629566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields));
3632fa5cd67SKarl Rupp     } else {
3647827d75bSBarry Smith       PetscCheck(nfields && nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
36508401ef6SPierre Jolivet       PetscCheck(nfields == nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Number of row and column fields must match");
3669566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields_col));
3675d4c12cdSJungho Lee     }
3686c924f48SJed Brown   }
3696c924f48SJed Brown   if (i > 0) {
3706c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3716c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3726c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3736c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3746c924f48SJed Brown   }
3759566063dSJacob Faibussowitsch   PetscCall(PetscFree(ifields));
3769566063dSJacob Faibussowitsch   PetscCall(PetscFree(ifields_col));
3773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3786c924f48SJed Brown }
3796c924f48SJed Brown 
380d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
381d71ae5a4SJacob Faibussowitsch {
3820971522cSBarry Smith   PC_FieldSplit    *jac                = (PC_FieldSplit *)pc->data;
3835a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3847b752e3dSPatrick Sanan   PetscBool         fieldsplit_default = PETSC_FALSE, coupling = PETSC_FALSE;
3856c924f48SJed Brown   PetscInt          i;
3860971522cSBarry Smith 
3870971522cSBarry Smith   PetscFunctionBegin;
3887287d2a3SDmitry Karpeev   /*
389f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
3907287d2a3SDmitry Karpeev    Should probably be rewritten.
3917287d2a3SDmitry Karpeev    */
392f5f0d762SBarry Smith   if (!ilink) {
3939566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_detect_coupling", &coupling, NULL));
3947b752e3dSPatrick Sanan     if (pc->dm && jac->dm_splits && !jac->detect && !coupling) {
395bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3960784a22cSJed Brown       char    **fieldNames;
3977b62db95SJungho Lee       IS       *fields;
398e7c4fc90SDmitry Karpeev       DM       *dms;
399bafc1b83SMatthew G Knepley       DM        subdm[128];
400bafc1b83SMatthew G Knepley       PetscBool flg;
401bafc1b83SMatthew G Knepley 
4029566063dSJacob Faibussowitsch       PetscCall(DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms));
403bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
404bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
405bafc1b83SMatthew G Knepley         PetscInt ifields[128];
406bafc1b83SMatthew G Knepley         IS       compField;
407bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
408bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
409bafc1b83SMatthew G Knepley 
41063a3b9bcSJacob Faibussowitsch         PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
4119566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
412bafc1b83SMatthew G Knepley         if (!flg) break;
41363a3b9bcSJacob Faibussowitsch         PetscCheck(numFields <= 128, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot currently support %" PetscInt_FMT " > 128 fields", numFields);
4149566063dSJacob Faibussowitsch         PetscCall(DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]));
415bafc1b83SMatthew G Knepley         if (nfields == 1) {
4169566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField));
417bafc1b83SMatthew G Knepley         } else {
41863a3b9bcSJacob Faibussowitsch           PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
4199566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, splitname, compField));
4207287d2a3SDmitry Karpeev         }
4219566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&compField));
422bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
423bafc1b83SMatthew G Knepley           f = ifields[j];
4249566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4259566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
4267b62db95SJungho Lee         }
427bafc1b83SMatthew G Knepley       }
428bafc1b83SMatthew G Knepley       if (i == 0) {
429bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
4309566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[f], fields[f]));
4319566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4329566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
433bafc1b83SMatthew G Knepley         }
434bafc1b83SMatthew G Knepley       } else {
43548a46eb9SPierre Jolivet         for (j = 0; j < numFields; j++) PetscCall(DMDestroy(dms + j));
4369566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4379566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(i, &dms));
4382fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
439bafc1b83SMatthew G Knepley       }
4409566063dSJacob Faibussowitsch       PetscCall(PetscFree(fieldNames));
4419566063dSJacob Faibussowitsch       PetscCall(PetscFree(fields));
442e7c4fc90SDmitry Karpeev       if (dms) {
4439566063dSJacob Faibussowitsch         PetscCall(PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n"));
444bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
4457287d2a3SDmitry Karpeev           const char *prefix;
4469566063dSJacob Faibussowitsch           PetscCall(PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp), &prefix));
4479566063dSJacob Faibussowitsch           PetscCall(PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix));
4489566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(ilink->ksp, dms[i]));
4499566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(ilink->ksp, PETSC_FALSE));
45095dbaa6fSMatthew G. Knepley           {
45195dbaa6fSMatthew G. Knepley             PetscErrorCode (*func)(KSP, Mat, Mat, void *);
45295dbaa6fSMatthew G. Knepley             void *ctx;
45395dbaa6fSMatthew G. Knepley 
4549566063dSJacob Faibussowitsch             PetscCall(DMKSPGetComputeOperators(pc->dm, &func, &ctx));
4559566063dSJacob Faibussowitsch             PetscCall(DMKSPSetComputeOperators(dms[i], func, ctx));
45695dbaa6fSMatthew G. Knepley           }
4579566063dSJacob Faibussowitsch           PetscCall(PetscObjectIncrementTabLevel((PetscObject)dms[i], (PetscObject)ilink->ksp, 0));
4589566063dSJacob Faibussowitsch           PetscCall(DMDestroy(&dms[i]));
4592fa5ba8aSJed Brown         }
4609566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4618b8307b2SJed Brown       }
46266ffff09SJed Brown     } else {
463521d7252SBarry Smith       if (jac->bs <= 0) {
464704ba839SBarry Smith         if (pc->pmat) {
4659566063dSJacob Faibussowitsch           PetscCall(MatGetBlockSize(pc->pmat, &jac->bs));
4662fa5cd67SKarl Rupp         } else jac->bs = 1;
467521d7252SBarry Smith       }
468d32f9abdSBarry Smith 
4697b752e3dSPatrick Sanan       if (jac->detect) {
4706ce1633cSBarry Smith         IS       zerodiags, rest;
4716ce1633cSBarry Smith         PetscInt nmin, nmax;
4726ce1633cSBarry Smith 
4739566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4747199da05SBarry Smith         if (jac->diag_use_amat) {
4759566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->mat, &zerodiags));
4767199da05SBarry Smith         } else {
4779566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->pmat, &zerodiags));
4787199da05SBarry Smith         }
4799566063dSJacob Faibussowitsch         PetscCall(ISComplement(zerodiags, nmin, nmax, &rest));
4809566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
4819566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", zerodiags));
4829566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&zerodiags));
4839566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
4843a062f41SBarry Smith       } else if (coupling) {
4853a062f41SBarry Smith         IS       coupling, rest;
4863a062f41SBarry Smith         PetscInt nmin, nmax;
4873a062f41SBarry Smith 
4889566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4897199da05SBarry Smith         if (jac->offdiag_use_amat) {
4909566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->mat, &coupling));
4917199da05SBarry Smith         } else {
4929566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->pmat, &coupling));
4937199da05SBarry Smith         }
4949566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc->mat), nmax - nmin, nmin, 1, &rest));
4959566063dSJacob Faibussowitsch         PetscCall(ISSetIdentity(rest));
4969566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
4979566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", coupling));
4989566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&coupling));
4999566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
5006ce1633cSBarry Smith       } else {
5019566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_default", &fieldsplit_default, NULL));
5027287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
503d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
504d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
5059566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
5069566063dSJacob Faibussowitsch           if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
507d32f9abdSBarry Smith         }
5086dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
5099f001fe8SStefano Zampini           Mat       M = pc->pmat;
510f3b928b9SStefano Zampini           PetscBool isnest;
511f3b928b9SStefano Zampini 
5129566063dSJacob Faibussowitsch           PetscCall(PetscInfo(pc, "Using default splitting of fields\n"));
5139566063dSJacob Faibussowitsch           PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &isnest));
514f3b928b9SStefano Zampini           if (!isnest) {
5159f001fe8SStefano Zampini             M = pc->mat;
5169566063dSJacob Faibussowitsch             PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &isnest));
517f3b928b9SStefano Zampini           }
518f3b928b9SStefano Zampini           if (isnest) {
519f3b928b9SStefano Zampini             IS      *fields;
520f3b928b9SStefano Zampini             PetscInt nf;
521f3b928b9SStefano Zampini 
5229566063dSJacob Faibussowitsch             PetscCall(MatNestGetSize(M, &nf, NULL));
5239566063dSJacob Faibussowitsch             PetscCall(PetscMalloc1(nf, &fields));
5249566063dSJacob Faibussowitsch             PetscCall(MatNestGetISs(M, fields, NULL));
52548a46eb9SPierre Jolivet             for (i = 0; i < nf; i++) PetscCall(PCFieldSplitSetIS(pc, NULL, fields[i]));
5269566063dSJacob Faibussowitsch             PetscCall(PetscFree(fields));
527f3b928b9SStefano Zampini           } else {
528db4c96c1SJed Brown             for (i = 0; i < jac->bs; i++) {
5296c924f48SJed Brown               char splitname[8];
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       }
537f3b928b9SStefano Zampini     }
538edf189efSBarry Smith   } else if (jac->nsplits == 1) {
539edf189efSBarry Smith     IS       is2;
540edf189efSBarry Smith     PetscInt nmin, nmax;
541edf189efSBarry Smith 
5420fdf79fbSJacob Faibussowitsch     PetscCheck(ilink->is, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Must provide at least two sets of fields to PCFieldSplit()");
5439566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
5449566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is, nmin, nmax, &is2));
5459566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetIS(pc, "1", is2));
5469566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is2));
547edf189efSBarry Smith   }
548d0af7cd3SBarry Smith 
54963a3b9bcSJacob Faibussowitsch   PetscCheck(jac->nsplits >= 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unhandled case, must have at least two fields, not %" PetscInt_FMT, jac->nsplits);
5503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
55169a612a9SBarry Smith }
55269a612a9SBarry Smith 
553d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A, Mat B, Mat C, Mat *H, PetscReal gkbnu)
554d71ae5a4SJacob Faibussowitsch {
555a51937d4SCarola Kruse   Mat       BT, T;
556de482cd7SCarola Kruse   PetscReal nrmT, nrmB;
557a51937d4SCarola Kruse 
558a51937d4SCarola Kruse   PetscFunctionBegin;
5599566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &T)); /* Test if augmented matrix is symmetric */
5609566063dSJacob Faibussowitsch   PetscCall(MatAXPY(T, -1.0, B, DIFFERENT_NONZERO_PATTERN));
5619566063dSJacob Faibussowitsch   PetscCall(MatNorm(T, NORM_1, &nrmT));
5629566063dSJacob Faibussowitsch   PetscCall(MatNorm(B, NORM_1, &nrmB));
563049d1499SBarry Smith   PetscCheck(nrmB <= 0 || nrmT / nrmB < PETSC_SMALL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix is not symmetric/hermitian, GKB is not applicable.");
564049d1499SBarry Smith 
565a51937d4SCarola Kruse   /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */
566a51937d4SCarola Kruse   /* setting N := 1/nu*I in [Ar13].                                                 */
5679566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(B, MAT_INITIAL_MATRIX, &BT));
5689566063dSJacob Faibussowitsch   PetscCall(MatMatMult(B, BT, MAT_INITIAL_MATRIX, PETSC_DEFAULT, H)); /* H = A01*A01'          */
5699566063dSJacob Faibussowitsch   PetscCall(MatAYPX(*H, gkbnu, A, DIFFERENT_NONZERO_PATTERN));        /* H = A00 + nu*A01*A01' */
570a51937d4SCarola Kruse 
5719566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&BT));
5729566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&T));
5733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
574a51937d4SCarola Kruse }
575a51937d4SCarola Kruse 
5762d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions, const char pre[], const char name[], const char *value[], PetscBool *flg);
577514bf10dSMatthew G Knepley 
578d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_FieldSplit(PC pc)
579d71ae5a4SJacob Faibussowitsch {
58069a612a9SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
5815a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
5822c9966d7SBarry Smith   PetscInt          i, nsplit;
5835f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
58469a612a9SBarry Smith 
58569a612a9SBarry Smith   PetscFunctionBegin;
5865da88fe4STristan Konolige   pc->failedreason = PC_NOERROR;
5879566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDefaults(pc));
58897bbdb24SBarry Smith   nsplit = jac->nsplits;
5895a9f2f41SSatish Balay   ilink  = jac->head;
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 
61151f519a2SBarry Smith     bs = jac->bs;
6129566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRange(pc->pmat, &rstart, &rend));
6131b9fc7fcSBarry Smith     nslots = (rend - rstart) / bs;
6141b9fc7fcSBarry Smith     for (i = 0; i < nsplit; i++) {
6151b9fc7fcSBarry Smith       if (jac->defaultsplit) {
6169566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + i, nsplit, &ilink->is));
6179566063dSJacob Faibussowitsch         PetscCall(ISDuplicate(ilink->is, &ilink->is_col));
618704ba839SBarry Smith       } else if (!ilink->is) {
619ccb205f8SBarry Smith         if (ilink->nfields > 1) {
6205f4ab4e1SJungho Lee           PetscInt *ii, *jj, j, k, nfields = ilink->nfields, *fields = ilink->fields, *fields_col = ilink->fields_col;
6219566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(ilink->nfields * nslots, &ii));
6229566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(ilink->nfields * nslots, &jj));
6231b9fc7fcSBarry Smith           for (j = 0; j < nslots; j++) {
6241b9fc7fcSBarry Smith             for (k = 0; k < nfields; k++) {
6251b9fc7fcSBarry Smith               ii[nfields * j + k] = rstart + bs * j + fields[k];
6265f4ab4e1SJungho Lee               jj[nfields * j + k] = rstart + bs * j + fields_col[k];
62797bbdb24SBarry Smith             }
62897bbdb24SBarry Smith           }
6299566063dSJacob Faibussowitsch           PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, ii, PETSC_OWN_POINTER, &ilink->is));
6309566063dSJacob Faibussowitsch           PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, jj, PETSC_OWN_POINTER, &ilink->is_col));
6319566063dSJacob Faibussowitsch           PetscCall(ISSetBlockSize(ilink->is, nfields));
6329566063dSJacob Faibussowitsch           PetscCall(ISSetBlockSize(ilink->is_col, nfields));
633ccb205f8SBarry Smith         } else {
6349566063dSJacob Faibussowitsch           PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields[0], bs, &ilink->is));
6359566063dSJacob Faibussowitsch           PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields_col[0], bs, &ilink->is_col));
636ccb205f8SBarry Smith         }
6373e197d65SBarry Smith       }
6389566063dSJacob Faibussowitsch       PetscCall(ISSorted(ilink->is, &sorted));
6399566063dSJacob Faibussowitsch       if (ilink->is_col) PetscCall(ISSorted(ilink->is_col, &sorted_col));
6407827d75bSBarry Smith       PetscCheck(sorted && sorted_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Fields must be sorted when creating split");
641704ba839SBarry Smith       ilink = ilink->next;
6421b9fc7fcSBarry Smith     }
6431b9fc7fcSBarry Smith   }
6441b9fc7fcSBarry Smith 
645704ba839SBarry Smith   ilink = jac->head;
64697bbdb24SBarry Smith   if (!jac->pmat) {
647bdddcaaaSMatthew G Knepley     Vec xtmp;
648bdddcaaaSMatthew G Knepley 
6499566063dSJacob Faibussowitsch     PetscCall(MatCreateVecs(pc->pmat, &xtmp, NULL));
6509566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nsplit, &jac->pmat));
6519566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nsplit, &jac->x, nsplit, &jac->y));
652cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
653bdddcaaaSMatthew G Knepley       MatNullSpace sp;
654bdddcaaaSMatthew G Knepley 
655a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
6569566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&jac->pmat[i]));
657a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
6589566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->pmat[i]));
659a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
660a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
6612fa5cd67SKarl Rupp 
6629566063dSJacob Faibussowitsch           PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
663a3df900dSMatthew G Knepley         }
664a3df900dSMatthew G Knepley       } else {
6653a062f41SBarry Smith         const char *prefix;
6669566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->pmat[i]));
6679566063dSJacob Faibussowitsch         PetscCall(KSPGetOptionsPrefix(ilink->ksp, &prefix));
6689566063dSJacob Faibussowitsch         PetscCall(MatSetOptionsPrefix(jac->pmat[i], prefix));
6699566063dSJacob Faibussowitsch         PetscCall(MatViewFromOptions(jac->pmat[i], NULL, "-mat_view"));
670a3df900dSMatthew G Knepley       }
671bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
6729566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(jac->pmat[i], &jac->x[i], &jac->y[i]));
6739371c9d4SSatish Balay       ilink->x = jac->x[i];
6749371c9d4SSatish Balay       ilink->y = jac->y[i];
6759371c9d4SSatish Balay       ilink->z = NULL;
676bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
6779566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(xtmp, ilink->is, jac->x[i], NULL, &ilink->sctx));
6789566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nearnullspace", (PetscObject *)&sp));
67948a46eb9SPierre Jolivet       if (sp) PetscCall(MatSetNearNullSpace(jac->pmat[i], sp));
680704ba839SBarry Smith       ilink = ilink->next;
681cf502942SBarry Smith     }
6829566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&xtmp));
68397bbdb24SBarry Smith   } else {
684ef7efd37SHong Zhang     MatReuse scall;
685ef7efd37SHong Zhang     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
68648a46eb9SPierre Jolivet       for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->pmat[i]));
687ef7efd37SHong Zhang       scall = MAT_INITIAL_MATRIX;
688ef7efd37SHong Zhang     } else scall = MAT_REUSE_MATRIX;
689ef7efd37SHong Zhang 
690cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
691a3df900dSMatthew G Knepley       Mat pmat;
692a3df900dSMatthew G Knepley 
693a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
6949566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&pmat));
69548a46eb9SPierre Jolivet       if (!pmat) PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, scall, &jac->pmat[i]));
696704ba839SBarry Smith       ilink = ilink->next;
697cf502942SBarry Smith     }
69897bbdb24SBarry Smith   }
6994e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
700519d70e2SJed Brown     ilink = jac->head;
701519d70e2SJed Brown     if (!jac->mat) {
7029566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nsplit, &jac->mat));
703519d70e2SJed Brown       for (i = 0; i < nsplit; i++) {
7049566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->mat[i]));
705519d70e2SJed Brown         ilink = ilink->next;
706519d70e2SJed Brown       }
707519d70e2SJed Brown     } else {
708ef7efd37SHong Zhang       MatReuse scall;
709ef7efd37SHong Zhang       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
71048a46eb9SPierre Jolivet         for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->mat[i]));
711ef7efd37SHong Zhang         scall = MAT_INITIAL_MATRIX;
712ef7efd37SHong Zhang       } else scall = MAT_REUSE_MATRIX;
713ef7efd37SHong Zhang 
714ef7efd37SHong Zhang       for (i = 0; i < nsplit; i++) {
7159566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, scall, &jac->mat[i]));
716519d70e2SJed Brown         ilink = ilink->next;
717519d70e2SJed Brown       }
718519d70e2SJed Brown     }
719519d70e2SJed Brown   } else {
720519d70e2SJed Brown     jac->mat = jac->pmat;
721519d70e2SJed Brown   }
72297bbdb24SBarry Smith 
72353935eafSBarry Smith   /* Check for null space attached to IS */
72453935eafSBarry Smith   ilink = jac->head;
72553935eafSBarry Smith   for (i = 0; i < nsplit; i++) {
72653935eafSBarry Smith     MatNullSpace sp;
72753935eafSBarry Smith 
7289566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nullspace", (PetscObject *)&sp));
72948a46eb9SPierre Jolivet     if (sp) PetscCall(MatSetNullSpace(jac->mat[i], sp));
73053935eafSBarry Smith     ilink = ilink->next;
73153935eafSBarry Smith   }
73253935eafSBarry Smith 
733a51937d4SCarola Kruse   if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) {
73468dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
7354e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
73668dd23aaSBarry Smith     ilink = jac->head;
737e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
738e52d2c62SBarry 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 */
739e52d2c62SBarry Smith       if (!jac->Afield) {
7409566063dSJacob Faibussowitsch         PetscCall(PetscCalloc1(nsplit, &jac->Afield));
74180c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7429566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
743e52d2c62SBarry Smith         } else {
7449566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
74580c96bb1SFande Kong         }
74680c96bb1SFande Kong       } else {
747ef7efd37SHong Zhang         MatReuse scall;
748e9422dd5SStefano Zampini 
749ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7509566063dSJacob Faibussowitsch           PetscCall(MatDestroy(&jac->Afield[1]));
751ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
752ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
753ef7efd37SHong Zhang 
75480c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7559566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
75680c96bb1SFande Kong         } else {
7579566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
75880c96bb1SFande Kong         }
759e52d2c62SBarry Smith       }
760e52d2c62SBarry Smith     } else {
76168dd23aaSBarry Smith       if (!jac->Afield) {
7629566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nsplit, &jac->Afield));
76368dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
76480c96bb1SFande Kong           if (jac->offdiag_use_amat) {
7659566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
76680c96bb1SFande Kong           } else {
7679566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
76880c96bb1SFande Kong           }
76968dd23aaSBarry Smith           ilink = ilink->next;
77068dd23aaSBarry Smith         }
77168dd23aaSBarry Smith       } else {
772ef7efd37SHong Zhang         MatReuse scall;
773ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
77448a46eb9SPierre Jolivet           for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->Afield[i]));
775ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
776ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
777ef7efd37SHong Zhang 
77868dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
77980c96bb1SFande Kong           if (jac->offdiag_use_amat) {
7809566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, scall, &jac->Afield[i]));
78180c96bb1SFande Kong           } else {
7829566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, scall, &jac->Afield[i]));
78380c96bb1SFande Kong           }
78468dd23aaSBarry Smith           ilink = ilink->next;
78568dd23aaSBarry Smith         }
78668dd23aaSBarry Smith       }
78768dd23aaSBarry Smith     }
788e52d2c62SBarry Smith   }
78968dd23aaSBarry Smith 
7903b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
7913b224e63SBarry Smith     IS          ccis;
792b94d7dedSBarry Smith     PetscBool   isset, isspd;
7934aa3045dSJed Brown     PetscInt    rstart, rend;
794093c86ffSJed Brown     char        lscname[256];
795093c86ffSJed Brown     PetscObject LSC_L;
796ce94432eSBarry Smith 
79708401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use Schur complement preconditioner you must have exactly 2 fields");
79868dd23aaSBarry Smith 
799c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
800c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
801b94d7dedSBarry Smith       PetscCall(MatIsSPDKnown(pc->pmat, &isset, &isspd));
802b94d7dedSBarry Smith       jac->schurscale = (isset && isspd) ? 1.0 : -1.0;
803c096484dSStefano Zampini     }
804c096484dSStefano Zampini 
805e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
8069566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend));
807e6cab6aaSJed Brown 
8083b224e63SBarry Smith     if (jac->schur) {
8090298fd71SBarry Smith       KSP      kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
810e9422dd5SStefano Zampini       MatReuse scall;
811e9422dd5SStefano Zampini 
812e9422dd5SStefano Zampini       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
813e9422dd5SStefano Zampini         scall = MAT_INITIAL_MATRIX;
8149566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->B));
8159566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->C));
816e9422dd5SStefano Zampini       } else scall = MAT_REUSE_MATRIX;
817443836d0SMatthew G Knepley 
8189566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
8193b224e63SBarry Smith       ilink = jac->head;
8209566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8214e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8229566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->B));
823c84da90fSDmitry Karpeev       } else {
8249566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->B));
825c84da90fSDmitry Karpeev       }
8269566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
8273b224e63SBarry Smith       ilink = ilink->next;
8289566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8294e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8309566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->C));
831c84da90fSDmitry Karpeev       } else {
8329566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->C));
833c84da90fSDmitry Karpeev       }
8349566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
8359566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementUpdateSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
836a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
8379566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->schurp));
8389566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
839a7476a74SDmitry Karpeev       }
84048a46eb9SPierre Jolivet       if (kspA != kspInner) PetscCall(KSPSetOperators(kspA, jac->mat[0], jac->pmat[0]));
84148a46eb9SPierre Jolivet       if (kspUpper != kspA) PetscCall(KSPSetOperators(kspUpper, jac->mat[0], jac->pmat[0]));
8429566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
8433b224e63SBarry Smith     } else {
844bafc1b83SMatthew G Knepley       const char  *Dprefix;
845470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
846514bf10dSMatthew G Knepley       char         schurtestoption[256];
847bdddcaaaSMatthew G Knepley       MatNullSpace sp;
848514bf10dSMatthew G Knepley       PetscBool    flg;
849686bed4dSStefano Zampini       KSP          kspt;
8503b224e63SBarry Smith 
851a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
8523b224e63SBarry Smith       ilink = jac->head;
8539566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8544e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8559566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
856c84da90fSDmitry Karpeev       } else {
8579566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
858c84da90fSDmitry Karpeev       }
8599566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
8603b224e63SBarry Smith       ilink = ilink->next;
8619566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8624e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8639566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
864c84da90fSDmitry Karpeev       } else {
8659566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
866c84da90fSDmitry Karpeev       }
8679566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
86820252d06SBarry Smith 
869f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
8709566063dSJacob Faibussowitsch       PetscCall(MatCreate(((PetscObject)jac->mat[0])->comm, &jac->schur));
8719566063dSJacob Faibussowitsch       PetscCall(MatSetType(jac->schur, MATSCHURCOMPLEMENT));
8729566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementSetSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
8739566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
8749566063dSJacob Faibussowitsch       PetscCall(MatSetOptionsPrefix(jac->schur, schurmatprefix));
8759566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspt));
8769566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(kspt, schurmatprefix));
877686bed4dSStefano Zampini 
878686bed4dSStefano Zampini       /* Note: this is not true in general */
8799566063dSJacob Faibussowitsch       PetscCall(MatGetNullSpace(jac->mat[1], &sp));
8801baa6e33SBarry Smith       if (sp) PetscCall(MatSetNullSpace(jac->schur, sp));
88120252d06SBarry Smith 
8829566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname));
8839566063dSJacob Faibussowitsch       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, &flg));
884514bf10dSMatthew G Knepley       if (flg) {
885514bf10dSMatthew G Knepley         DM  dmInner;
88621635b76SJed Brown         KSP kspInner;
887686bed4dSStefano Zampini         PC  pcInner;
88821635b76SJed Brown 
8899566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
8909566063dSJacob Faibussowitsch         PetscCall(KSPReset(kspInner));
8919566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(kspInner, jac->mat[0], jac->pmat[0]));
8929566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
89321635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
8949566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject)pc, 2));
8959566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject)pc, 2));
8969566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(kspInner, schurprefix));
897514bf10dSMatthew G Knepley 
898514bf10dSMatthew G Knepley         /* Set DM for new solver */
8999566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
9009566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(kspInner, dmInner));
9019566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(kspInner, PETSC_FALSE));
902686bed4dSStefano Zampini 
903686bed4dSStefano Zampini         /* Defaults to PCKSP as preconditioner */
9049566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9059566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcInner, PCKSP));
9069566063dSJacob Faibussowitsch         PetscCall(PCKSPSetKSP(pcInner, jac->head->ksp));
907514bf10dSMatthew G Knepley       } else {
90821635b76SJed Brown         /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
90921635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
91021635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
91121635b76SJed 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
91221635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
91321635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
9149566063dSJacob Faibussowitsch         PetscCall(KSPSetType(jac->head->ksp, KSPGMRES));
9159566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementSetKSP(jac->schur, jac->head->ksp));
916bafc1b83SMatthew G Knepley       }
9179566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->head->ksp, jac->mat[0], jac->pmat[0]));
9189566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->head->ksp));
9199566063dSJacob Faibussowitsch       PetscCall(MatSetFromOptions(jac->schur));
9203b224e63SBarry Smith 
9219566063dSJacob Faibussowitsch       PetscCall(PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg));
922686bed4dSStefano Zampini       if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */
923686bed4dSStefano Zampini         KSP kspInner;
924686bed4dSStefano Zampini         PC  pcInner;
925686bed4dSStefano Zampini 
9269566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
9279566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9289566063dSJacob Faibussowitsch         PetscCall(PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg));
929686bed4dSStefano Zampini         if (flg) {
930686bed4dSStefano Zampini           KSP ksp;
931686bed4dSStefano Zampini 
9329566063dSJacob Faibussowitsch           PetscCall(PCKSPGetKSP(pcInner, &ksp));
93348a46eb9SPierre Jolivet           if (ksp == jac->head->ksp) PetscCall(PCSetUseAmat(pcInner, PETSC_TRUE));
934686bed4dSStefano Zampini         }
935686bed4dSStefano Zampini       }
9369566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname));
9379566063dSJacob Faibussowitsch       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, &flg));
938443836d0SMatthew G Knepley       if (flg) {
939443836d0SMatthew G Knepley         DM dmInner;
940443836d0SMatthew G Knepley 
9419566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
9429566063dSJacob Faibussowitsch         PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper));
9439566063dSJacob Faibussowitsch         PetscCall(KSPSetErrorIfNotConverged(jac->kspupper, pc->erroriffailure));
9449566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(jac->kspupper, schurprefix));
9459566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject)pc, 1));
9469566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject)pc, 1));
9479566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
9489566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(jac->kspupper, dmInner));
9499566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(jac->kspupper, PETSC_FALSE));
9509566063dSJacob Faibussowitsch         PetscCall(KSPSetFromOptions(jac->kspupper));
9519566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(jac->kspupper, jac->mat[0], jac->pmat[0]));
9529566063dSJacob Faibussowitsch         PetscCall(VecDuplicate(jac->head->x, &jac->head->z));
953443836d0SMatthew G Knepley       } else {
954443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
9559566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->head->ksp));
956443836d0SMatthew G Knepley       }
957443836d0SMatthew G Knepley 
95848a46eb9SPierre Jolivet       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
9599566063dSJacob Faibussowitsch       PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspschur));
9609566063dSJacob Faibussowitsch       PetscCall(KSPSetErrorIfNotConverged(jac->kspschur, pc->erroriffailure));
9619566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspschur, (PetscObject)pc, 1));
962084e4875SJed Brown       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
9637233a360SDmitry Karpeev         PC pcschur;
9649566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(jac->kspschur, &pcschur));
9659566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcschur, PCNONE));
966084e4875SJed Brown         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
967e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
9689566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
969e69d4d44SBarry Smith       }
9709566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
9719566063dSJacob Faibussowitsch       PetscCall(KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix));
9729566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(jac->kspschur, Dprefix));
973c096484dSStefano Zampini       /* propagate DM */
974b20b4189SMatthew G. Knepley       {
975b20b4189SMatthew G. Knepley         DM sdm;
9769566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->next->ksp, &sdm));
977b20b4189SMatthew G. Knepley         if (sdm) {
9789566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(jac->kspschur, sdm));
9799566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(jac->kspschur, PETSC_FALSE));
980b20b4189SMatthew G. Knepley         }
981b20b4189SMatthew G. Knepley       }
9823b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
98320b26d62SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
9849566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->kspschur));
9853b224e63SBarry Smith     }
9869566063dSJacob Faibussowitsch     PetscCall(MatAssemblyBegin(jac->schur, MAT_FINAL_ASSEMBLY));
9879566063dSJacob Faibussowitsch     PetscCall(MatAssemblyEnd(jac->schur, MAT_FINAL_ASSEMBLY));
988093c86ffSJed Brown 
989093c86ffSJed Brown     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
9909566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_L", ilink->splitname));
9919566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L));
9929566063dSJacob Faibussowitsch     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L));
9939566063dSJacob Faibussowitsch     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_L", (PetscObject)LSC_L));
9949566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_Lp", ilink->splitname));
9959566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L));
9969566063dSJacob Faibussowitsch     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L));
9979566063dSJacob Faibussowitsch     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_Lp", (PetscObject)LSC_L));
998a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
999a51937d4SCarola Kruse     IS       ccis;
1000a51937d4SCarola Kruse     PetscInt rstart, rend;
1001a51937d4SCarola Kruse 
100208401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use GKB preconditioner you must have exactly 2 fields");
1003a51937d4SCarola Kruse 
1004a51937d4SCarola Kruse     ilink = jac->head;
1005a51937d4SCarola Kruse 
1006a51937d4SCarola Kruse     /* When extracting off-diagonal submatrices, we take complements from this range */
10079566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend));
1008a51937d4SCarola Kruse 
10099566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
1010a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
10119566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
1012a51937d4SCarola Kruse     } else {
10139566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
1014a51937d4SCarola Kruse     }
10159566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ccis));
1016e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
10179566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->u));
10189566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->Hu));
10199566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w2));
1020a51937d4SCarola Kruse     ilink = ilink->next;
10219566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
1022a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
10239566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
1024a51937d4SCarola Kruse     } else {
10259566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
1026a51937d4SCarola Kruse     }
10279566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ccis));
1028e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
10299566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->v));
10309566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->d));
10319566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w1));
10329566063dSJacob Faibussowitsch     PetscCall(MatGolubKahanComputeExplicitOperator(jac->mat[0], jac->B, jac->C, &jac->H, jac->gkbnu));
10339566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(jac->gkbdelay, &jac->vecz));
1034e071a0a4SCarola Kruse 
1035a51937d4SCarola Kruse     ilink = jac->head;
10369566063dSJacob Faibussowitsch     PetscCall(KSPSetOperators(ilink->ksp, jac->H, jac->H));
10379566063dSJacob Faibussowitsch     if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
1038e071a0a4SCarola Kruse     /* Create gkb_monitor context */
1039de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1040de482cd7SCarola Kruse       PetscInt tablevel;
10419566063dSJacob Faibussowitsch       PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &jac->gkbviewer));
10429566063dSJacob Faibussowitsch       PetscCall(PetscViewerSetType(jac->gkbviewer, PETSCVIEWERASCII));
10439566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetTabLevel((PetscObject)ilink->ksp, &tablevel));
10449566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISetTab(jac->gkbviewer, tablevel));
10459566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)ilink->ksp, 1));
1046de482cd7SCarola Kruse     }
10473b224e63SBarry Smith   } else {
104868bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
104997bbdb24SBarry Smith     i     = 0;
10505a9f2f41SSatish Balay     ilink = jac->head;
10515a9f2f41SSatish Balay     while (ilink) {
10529566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(ilink->ksp, jac->mat[i], jac->pmat[i]));
10533b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
10549566063dSJacob Faibussowitsch       if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
105597bbdb24SBarry Smith       i++;
10565a9f2f41SSatish Balay       ilink = ilink->next;
10570971522cSBarry Smith     }
10583b224e63SBarry Smith   }
10593b224e63SBarry Smith 
10605ddf11f8SNicolas Barnafi   /* Set coordinates to the sub PC objects whenever these are set */
10615ddf11f8SNicolas Barnafi   if (jac->coordinates_set) {
10625ddf11f8SNicolas Barnafi     PC pc_coords;
10635ddf11f8SNicolas Barnafi     if (jac->type == PC_COMPOSITE_SCHUR) {
10645ddf11f8SNicolas Barnafi       // Head is first block.
10659566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->head->ksp, &pc_coords));
10669566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->dim, jac->head->ndofs, jac->head->coords));
10675ddf11f8SNicolas Barnafi       // Second one is Schur block, but its KSP object is in kspschur.
10689566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->kspschur, &pc_coords));
10699566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->next->dim, jac->head->next->ndofs, jac->head->next->coords));
10705ddf11f8SNicolas Barnafi     } else if (jac->type == PC_COMPOSITE_GKB) {
10719566063dSJacob Faibussowitsch       PetscCall(PetscInfo(pc, "Warning: Setting coordinates does nothing for the GKB Fieldpslit preconditioner"));
10725ddf11f8SNicolas Barnafi     } else {
10735ddf11f8SNicolas Barnafi       ilink = jac->head;
10745ddf11f8SNicolas Barnafi       while (ilink) {
10759566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(ilink->ksp, &pc_coords));
10769566063dSJacob Faibussowitsch         PetscCall(PCSetCoordinates(pc_coords, ilink->dim, ilink->ndofs, ilink->coords));
10775ddf11f8SNicolas Barnafi         ilink = ilink->next;
10785ddf11f8SNicolas Barnafi       }
10795ddf11f8SNicolas Barnafi     }
10805ddf11f8SNicolas Barnafi   }
10815ddf11f8SNicolas Barnafi 
1082c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
10833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10840971522cSBarry Smith }
10850971522cSBarry Smith 
10865a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink, xx, yy) \
10873ba16761SJacob 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) || \
10889371c9d4SSatish 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) || \
10893ba16761SJacob Faibussowitsch                     VecScatterEnd(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE)))
109079416396SBarry Smith 
1091d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_Schur(PC pc, Vec x, Vec y)
1092d71ae5a4SJacob Faibussowitsch {
10933b224e63SBarry Smith   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
10943b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1095443836d0SMatthew G Knepley   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
10963b224e63SBarry Smith 
10973b224e63SBarry Smith   PetscFunctionBegin;
1098c5d2311dSJed Brown   switch (jac->schurfactorization) {
1099c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
1100a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
11019566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11029566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11039566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11049566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11059566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11069566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11079566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11089566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11099566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11109566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11119566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11129566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
11139566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11149566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->y, jac->schurscale));
11159566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11169566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11179566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1118c5d2311dSJed Brown     break;
1119c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
1120a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
11219566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11229566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11239566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11249566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11259566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11269566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11279566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
11289566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.));
11299566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11309566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11319566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11329566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11339566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11349566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
11359566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11369566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11379566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11389566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1139c5d2311dSJed Brown     break;
1140c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
1141a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
11429566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11439566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11449566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11459566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11469566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
11479371c9d4SSatish Balay     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11489371c9d4SSatish Balay     PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
11499566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkA->x, -1.));
11509566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
11519566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11529566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
11539566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11549566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11559566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11569566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11579566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11589566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11599566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1160c5d2311dSJed Brown     break;
1161c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
1162c238f8cdSStefano Zampini     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */
11639566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11649566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11659566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
11669566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspLower, ilinkA->x, ilinkA->y));
11679566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->y));
11689566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
11699566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
11709566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.0));
11719566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11729566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11733b224e63SBarry Smith 
11749566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11759566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11769566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
11779566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11789566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11793b224e63SBarry Smith 
1180443836d0SMatthew G Knepley     if (kspUpper == kspA) {
11819566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->y));
11829566063dSJacob Faibussowitsch       PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y));
11839566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11849566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11859566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11869566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
1187443836d0SMatthew G Knepley     } else {
11889566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11899566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11909566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11919566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
11929566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
11939566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspUpper, ilinkA->x, ilinkA->z));
11949566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->z));
11959566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
11969566063dSJacob Faibussowitsch       PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z));
1197443836d0SMatthew G Knepley     }
11989566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11999566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12009566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1201c5d2311dSJed Brown   }
12023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12033b224e63SBarry Smith }
12043b224e63SBarry Smith 
1205d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit(PC pc, Vec x, Vec y)
1206d71ae5a4SJacob Faibussowitsch {
12070971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
12085a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
1209939b8a20SBarry Smith   PetscInt          cnt, bs;
12100971522cSBarry Smith 
12110971522cSBarry Smith   PetscFunctionBegin;
121279416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
12131b9fc7fcSBarry Smith     if (jac->defaultsplit) {
12149566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
12152472a847SBarry 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);
12169566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
12172472a847SBarry 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);
12189566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
12195a9f2f41SSatish Balay       while (ilink) {
12209566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12219566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
12229566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
12239566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12245a9f2f41SSatish Balay         ilink = ilink->next;
12250971522cSBarry Smith       }
12269566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
12271b9fc7fcSBarry Smith     } else {
12289566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
12295a9f2f41SSatish Balay       while (ilink) {
12309566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
12315a9f2f41SSatish Balay         ilink = ilink->next;
12321b9fc7fcSBarry Smith       }
12331b9fc7fcSBarry Smith     }
1234e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
12359566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1236e52d2c62SBarry Smith     /* solve on first block for first block variables */
12379566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
12389566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
12399566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12409566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
12419566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
12429566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12439566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
12449566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
1245e52d2c62SBarry Smith 
1246e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
12479566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->Afield[1], ilink->y, ilink->next->x));
1248e52d2c62SBarry Smith     ilink = ilink->next;
12499566063dSJacob Faibussowitsch     PetscCall(VecScale(ilink->x, -1.0));
12509566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
12519566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
1252e52d2c62SBarry Smith 
1253e52d2c62SBarry Smith     /* solve on second block variables */
12549566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12559566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
12569566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
12579566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12589566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
12599566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
126016913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
126179416396SBarry Smith     if (!jac->w1) {
12629566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
12639566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
126479416396SBarry Smith     }
12659566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
12669566063dSJacob Faibussowitsch     PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
12673e197d65SBarry Smith     cnt = 1;
12685a9f2f41SSatish Balay     while (ilink->next) {
12695a9f2f41SSatish Balay       ilink = ilink->next;
12703e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
12719566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->Afield[cnt++], y, ilink->x));
12729566063dSJacob Faibussowitsch       PetscCall(VecScale(ilink->x, -1.0));
12739566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
12749566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
12759566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12769566063dSJacob Faibussowitsch       PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
12779566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
12789566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12799566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
12809566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
12813e197d65SBarry Smith     }
128251f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
128311755939SBarry Smith       cnt -= 2;
128451f519a2SBarry Smith       while (ilink->previous) {
128551f519a2SBarry Smith         ilink = ilink->previous;
128611755939SBarry Smith         /* compute the residual only over the part of the vector needed */
12879566063dSJacob Faibussowitsch         PetscCall(MatMult(jac->Afield[cnt--], y, ilink->x));
12889566063dSJacob Faibussowitsch         PetscCall(VecScale(ilink->x, -1.0));
12899566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
12909566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
12919566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12929566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
12939566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
12949566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
12959566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
12969566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
129751f519a2SBarry Smith       }
129811755939SBarry Smith     }
129963a3b9bcSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Unsupported or unknown composition %d", (int)jac->type);
13003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
13010971522cSBarry Smith }
13020971522cSBarry Smith 
1303d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_GKB(PC pc, Vec x, Vec y)
1304d71ae5a4SJacob Faibussowitsch {
1305a51937d4SCarola Kruse   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
1306a51937d4SCarola Kruse   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1307a51937d4SCarola Kruse   KSP               ksp = ilinkA->ksp;
1308de482cd7SCarola Kruse   Vec               u, v, Hu, d, work1, work2;
1309e071a0a4SCarola Kruse   PetscScalar       alpha, z, nrmz2, *vecz;
1310e071a0a4SCarola Kruse   PetscReal         lowbnd, nu, beta;
1311a51937d4SCarola Kruse   PetscInt          j, iterGKB;
1312a51937d4SCarola Kruse 
1313a51937d4SCarola Kruse   PetscFunctionBegin;
13149566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13159566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
13169566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13179566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
1318e071a0a4SCarola Kruse 
1319e071a0a4SCarola Kruse   u     = jac->u;
1320e071a0a4SCarola Kruse   v     = jac->v;
1321e071a0a4SCarola Kruse   Hu    = jac->Hu;
1322e071a0a4SCarola Kruse   d     = jac->d;
1323e071a0a4SCarola Kruse   work1 = jac->w1;
1324e071a0a4SCarola Kruse   work2 = jac->w2;
1325e071a0a4SCarola Kruse   vecz  = jac->vecz;
1326a51937d4SCarola Kruse 
1327a51937d4SCarola Kruse   /* Change RHS to comply with matrix regularization H = A + nu*B*B' */
1328a51937d4SCarola Kruse   /* Add q = q + nu*B*b */
1329a51937d4SCarola Kruse   if (jac->gkbnu) {
1330a51937d4SCarola Kruse     nu = jac->gkbnu;
13319566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, jac->gkbnu));
13329566063dSJacob Faibussowitsch     PetscCall(MatMultAdd(jac->B, ilinkD->x, ilinkA->x, ilinkA->x)); /* q = q + nu*B*b */
1333a51937d4SCarola Kruse   } else {
1334a51937d4SCarola Kruse     /* Situation when no augmented Lagrangian is used. Then we set inner  */
1335a51937d4SCarola Kruse     /* matrix N = I in [Ar13], and thus nu = 1.                           */
1336a51937d4SCarola Kruse     nu = 1;
1337a51937d4SCarola Kruse   }
1338a51937d4SCarola Kruse 
1339a51937d4SCarola Kruse   /* Transform rhs from [q,tilde{b}] to [0,b] */
13409566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
13419566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, ilinkA->x, ilinkA->y));
13429566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, ilinkA->y));
13439566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
13449566063dSJacob Faibussowitsch   PetscCall(MatMultHermitianTranspose(jac->B, ilinkA->y, work1));
13459566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(work1, 1.0 / nu, -1.0, ilinkD->x)); /* c = b - B'*x        */
1346a51937d4SCarola Kruse 
1347a51937d4SCarola Kruse   /* First step of algorithm */
13489566063dSJacob Faibussowitsch   PetscCall(VecNorm(work1, NORM_2, &beta)); /* beta = sqrt(nu*c'*c)*/
1349e071a0a4SCarola Kruse   KSPCheckDot(ksp, beta);
1350addd1e01SJunchao Zhang   beta = PetscSqrtReal(nu) * beta;
13519566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(v, nu / beta, 0.0, work1)); /* v = nu/beta *c      */
13529566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->B, v, work2));          /* u = H^{-1}*B*v      */
13539566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
13549566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, work2, u));
13559566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, u));
13569566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
13579566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u      */
13589566063dSJacob Faibussowitsch   PetscCall(VecDot(Hu, u, &alpha));
1359e071a0a4SCarola Kruse   KSPCheckDot(ksp, alpha);
136008401ef6SPierre Jolivet   PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1361addd1e01SJunchao Zhang   alpha = PetscSqrtReal(PetscAbsScalar(alpha));
13629566063dSJacob Faibussowitsch   PetscCall(VecScale(u, 1.0 / alpha));
13639566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(d, 1.0 / alpha, 0.0, v)); /* v = nu/beta *c      */
1364de482cd7SCarola Kruse 
1365a51937d4SCarola Kruse   z       = beta / alpha;
1366a51937d4SCarola Kruse   vecz[1] = z;
1367a51937d4SCarola Kruse 
1368de482cd7SCarola Kruse   /* Computation of first iterate x(1) and p(1) */
13699566063dSJacob Faibussowitsch   PetscCall(VecAXPY(ilinkA->y, z, u));
13709566063dSJacob Faibussowitsch   PetscCall(VecCopy(d, ilinkD->y));
13719566063dSJacob Faibussowitsch   PetscCall(VecScale(ilinkD->y, -z));
1372a51937d4SCarola Kruse 
13739371c9d4SSatish Balay   iterGKB = 1;
13749371c9d4SSatish Balay   lowbnd  = 2 * jac->gkbtol;
137548a46eb9SPierre Jolivet   if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1376de482cd7SCarola Kruse 
1377a51937d4SCarola Kruse   while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) {
1378a51937d4SCarola Kruse     iterGKB += 1;
13799566063dSJacob Faibussowitsch     PetscCall(MatMultHermitianTranspose(jac->B, u, work1)); /* v <- nu*(B'*u-alpha/nu*v) */
13809566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(v, nu, -alpha, work1));
13819566063dSJacob Faibussowitsch     PetscCall(VecNorm(v, NORM_2, &beta)); /* beta = sqrt(nu)*v'*v      */
1382addd1e01SJunchao Zhang     beta = beta / PetscSqrtReal(nu);
13839566063dSJacob Faibussowitsch     PetscCall(VecScale(v, 1.0 / beta));
13849566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->B, v, work2)); /* u <- H^{-1}*(B*v-beta*H*u) */
13859566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu));
13869566063dSJacob Faibussowitsch     PetscCall(VecAXPY(work2, -beta, Hu));
13879566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
13889566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ksp, work2, u));
13899566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ksp, pc, u));
13909566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
13919566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u            */
13929566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, u, &alpha));
1393e071a0a4SCarola Kruse     KSPCheckDot(ksp, alpha);
139408401ef6SPierre Jolivet     PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1395addd1e01SJunchao Zhang     alpha = PetscSqrtReal(PetscAbsScalar(alpha));
13969566063dSJacob Faibussowitsch     PetscCall(VecScale(u, 1.0 / alpha));
1397a51937d4SCarola Kruse 
1398e071a0a4SCarola Kruse     z       = -beta / alpha * z; /* z <- beta/alpha*z     */
1399a51937d4SCarola Kruse     vecz[0] = z;
1400a51937d4SCarola Kruse 
1401a51937d4SCarola Kruse     /* Computation of new iterate x(i+1) and p(i+1) */
14029566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(d, 1.0 / alpha, -beta / alpha, v)); /* d = (v-beta*d)/alpha */
14039566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkA->y, z, u));                   /* r = r + z*u          */
14049566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkD->y, -z, d));                  /* p = p - z*d          */
14059566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, ilinkA->y, Hu));             /* ||u||_H = u'*H*u     */
14069566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, ilinkA->y, &nrmz2));
1407a51937d4SCarola Kruse 
1408a51937d4SCarola Kruse     /* Compute Lower Bound estimate */
1409a51937d4SCarola Kruse     if (iterGKB > jac->gkbdelay) {
1410a51937d4SCarola Kruse       lowbnd = 0.0;
1411ad540459SPierre Jolivet       for (j = 0; j < jac->gkbdelay; j++) lowbnd += PetscAbsScalar(vecz[j] * vecz[j]);
1412addd1e01SJunchao Zhang       lowbnd = PetscSqrtReal(lowbnd / PetscAbsScalar(nrmz2));
1413a51937d4SCarola Kruse     }
1414a51937d4SCarola Kruse 
1415ad540459SPierre Jolivet     for (j = 0; j < jac->gkbdelay - 1; j++) vecz[jac->gkbdelay - j - 1] = vecz[jac->gkbdelay - j - 2];
141648a46eb9SPierre Jolivet     if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1417a51937d4SCarola Kruse   }
1418a51937d4SCarola Kruse 
14199566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14209566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14219566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14229566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1423a51937d4SCarola Kruse 
14243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1425a51937d4SCarola Kruse }
1426a51937d4SCarola Kruse 
1427421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink, xx, yy) \
14283ba16761SJacob 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) || \
14299371c9d4SSatish 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) || \
14303ba16761SJacob Faibussowitsch                     VecScatterEnd(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE)))
1431421e10b8SBarry Smith 
1432d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc, Vec x, Vec y)
1433d71ae5a4SJacob Faibussowitsch {
1434421e10b8SBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
1435421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1436939b8a20SBarry Smith   PetscInt          bs;
1437421e10b8SBarry Smith 
1438421e10b8SBarry Smith   PetscFunctionBegin;
1439421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1440421e10b8SBarry Smith     if (jac->defaultsplit) {
14419566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
14422472a847SBarry 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);
14439566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
14442472a847SBarry 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);
14459566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
1446421e10b8SBarry Smith       while (ilink) {
14479566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14489566063dSJacob Faibussowitsch         PetscCall(KSPSolveTranspose(ilink->ksp, ilink->x, ilink->y));
14499566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14509566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
1451421e10b8SBarry Smith         ilink = ilink->next;
1452421e10b8SBarry Smith       }
14539566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
1454421e10b8SBarry Smith     } else {
14559566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
1456421e10b8SBarry Smith       while (ilink) {
14579566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1458421e10b8SBarry Smith         ilink = ilink->next;
1459421e10b8SBarry Smith       }
1460421e10b8SBarry Smith     }
1461421e10b8SBarry Smith   } else {
1462421e10b8SBarry Smith     if (!jac->w1) {
14639566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
14649566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
1465421e10b8SBarry Smith     }
14669566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1467421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
14689566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1469421e10b8SBarry Smith       while (ilink->next) {
1470421e10b8SBarry Smith         ilink = ilink->next;
14719566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
14729566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
14739566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1474421e10b8SBarry Smith       }
1475421e10b8SBarry Smith       while (ilink->previous) {
1476421e10b8SBarry Smith         ilink = ilink->previous;
14779566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
14789566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
14799566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1480421e10b8SBarry Smith       }
1481421e10b8SBarry Smith     } else {
1482421e10b8SBarry Smith       while (ilink->next) { /* get to last entry in linked list */
1483421e10b8SBarry Smith         ilink = ilink->next;
1484421e10b8SBarry Smith       }
14859566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1486421e10b8SBarry Smith       while (ilink->previous) {
1487421e10b8SBarry Smith         ilink = ilink->previous;
14889566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
14899566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
14909566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1491421e10b8SBarry Smith       }
1492421e10b8SBarry Smith     }
1493421e10b8SBarry Smith   }
14943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1495421e10b8SBarry Smith }
1496421e10b8SBarry Smith 
1497d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_FieldSplit(PC pc)
1498d71ae5a4SJacob Faibussowitsch {
14990971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
15005a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head, next;
15010971522cSBarry Smith 
15020971522cSBarry Smith   PetscFunctionBegin;
15035a9f2f41SSatish Balay   while (ilink) {
15049566063dSJacob Faibussowitsch     PetscCall(KSPDestroy(&ilink->ksp));
15059566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->x));
15069566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->y));
15079566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->z));
15089566063dSJacob Faibussowitsch     PetscCall(VecScatterDestroy(&ilink->sctx));
15099566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
15109566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
15119566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->splitname));
15129566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields));
15139566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields_col));
15145a9f2f41SSatish Balay     next = ilink->next;
15159566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink));
15165a9f2f41SSatish Balay     ilink = next;
15170971522cSBarry Smith   }
1518f5f0d762SBarry Smith   jac->head = NULL;
15199566063dSJacob Faibussowitsch   PetscCall(PetscFree2(jac->x, jac->y));
1520574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
15219566063dSJacob Faibussowitsch     PetscCall(MatDestroyMatrices(jac->nsplits, &jac->mat));
1522574deadeSBarry Smith   } else if (jac->mat) {
15230298fd71SBarry Smith     jac->mat = NULL;
1524574deadeSBarry Smith   }
15259566063dSJacob Faibussowitsch   if (jac->pmat) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->pmat));
15269566063dSJacob Faibussowitsch   if (jac->Afield) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->Afield));
1527f5f0d762SBarry Smith   jac->nsplits = 0;
15289566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w1));
15299566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w2));
15309566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur));
15319566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schurp));
15329566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur_user));
15339566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspschur));
15349566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspupper));
15359566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->B));
15369566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->C));
15379566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->H));
15389566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->u));
15399566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->v));
15409566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->Hu));
15419566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->d));
15429566063dSJacob Faibussowitsch   PetscCall(PetscFree(jac->vecz));
15439566063dSJacob Faibussowitsch   PetscCall(PetscViewerDestroy(&jac->gkbviewer));
15446dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
15453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1546574deadeSBarry Smith }
1547574deadeSBarry Smith 
1548d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1549d71ae5a4SJacob Faibussowitsch {
1550574deadeSBarry Smith   PetscFunctionBegin;
15519566063dSJacob Faibussowitsch   PetscCall(PCReset_FieldSplit(pc));
15529566063dSJacob Faibussowitsch   PetscCall(PetscFree(pc->data));
15532e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", NULL));
15549566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", NULL));
15559566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", NULL));
15569566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", NULL));
15579566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", NULL));
15582e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", NULL));
15592e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", NULL));
15602e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
15612e956fe4SStefano Zampini 
15622e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
15632e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
15642e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
15652e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
15662e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
15679566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
15689566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
15699566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
15702e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
15713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15720971522cSBarry Smith }
15730971522cSBarry Smith 
1574d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc, PetscOptionItems *PetscOptionsObject)
1575d71ae5a4SJacob Faibussowitsch {
15766c924f48SJed Brown   PetscInt        bs;
15777b752e3dSPatrick Sanan   PetscBool       flg;
15789dcbbd2bSBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit *)pc->data;
15793b224e63SBarry Smith   PCCompositeType ctype;
15801b9fc7fcSBarry Smith 
15810971522cSBarry Smith   PetscFunctionBegin;
1582d0609cedSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "FieldSplit options");
15839566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_dm_splits", "Whether to use DMCreateFieldDecomposition() for splits", "PCFieldSplitSetDMSplits", jac->dm_splits, &jac->dm_splits, NULL));
15849566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-pc_fieldsplit_block_size", "Blocksize that defines number of fields", "PCFieldSplitSetBlockSize", jac->bs, &bs, &flg));
15851baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetBlockSize(pc, bs));
15862686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
15879566063dSJacob 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));
15882686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
15899566063dSJacob 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));
15909566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_detect_saddle_point", "Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint", jac->detect, &jac->detect, NULL));
15919566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDetectSaddlePoint(pc, jac->detect)); /* Sets split type and Schur PC type */
15929566063dSJacob Faibussowitsch   PetscCall(PetscOptionsEnum("-pc_fieldsplit_type", "Type of composition", "PCFieldSplitSetType", PCCompositeTypes, (PetscEnum)jac->type, (PetscEnum *)&ctype, &flg));
15931baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetType(pc, ctype));
1594c30613efSMatthew Knepley   /* Only setup fields once */
1595c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1596d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1597d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
15989566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
15999566063dSJacob Faibussowitsch     if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
1600d32f9abdSBarry Smith   }
1601c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
16029566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_schur_factorization_type", PCFieldSplitSchurFactTypes, (PetscEnum *)&jac->schurfactorization, &flg));
16039566063dSJacob Faibussowitsch     if (flg) PetscCall(PetscInfo(pc, "Deprecated use of -pc_fieldsplit_schur_factorization_type\n"));
16049566063dSJacob 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));
16059566063dSJacob Faibussowitsch     PetscCall(PetscOptionsEnum("-pc_fieldsplit_schur_precondition", "How to build preconditioner for Schur complement", "PCFieldSplitSetSchurPre", PCFieldSplitSchurPreTypes, (PetscEnum)jac->schurpre, (PetscEnum *)&jac->schurpre, NULL));
16069566063dSJacob Faibussowitsch     PetscCall(PetscOptionsScalar("-pc_fieldsplit_schur_scale", "Scale Schur complement", "PCFieldSplitSetSchurScale", jac->schurscale, &jac->schurscale, NULL));
1607a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
16089566063dSJacob Faibussowitsch     PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_tol", "The tolerance for the lower bound stopping criterion", "PCFieldSplitGKBTol", jac->gkbtol, &jac->gkbtol, NULL));
16099566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_delay", "The delay value for lower bound criterion", "PCFieldSplitGKBDelay", jac->gkbdelay, &jac->gkbdelay, NULL));
16109566063dSJacob Faibussowitsch     PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_nu", "Parameter in augmented Lagrangian approach", "PCFieldSplitGKBNu", jac->gkbnu, &jac->gkbnu, NULL));
161163a3b9bcSJacob Faibussowitsch     PetscCheck(jac->gkbnu >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "nu cannot be less than 0: value %g", (double)jac->gkbnu);
16129566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_maxit", "Maximum allowed number of iterations", "PCFieldSplitGKBMaxit", jac->gkbmaxit, &jac->gkbmaxit, NULL));
16139566063dSJacob Faibussowitsch     PetscCall(PetscOptionsBool("-pc_fieldsplit_gkb_monitor", "Prints number of GKB iterations and error", "PCFieldSplitGKB", jac->gkbmonitor, &jac->gkbmonitor, NULL));
1614c5d2311dSJed Brown   }
161534603f55SBarry Smith   /*
161634603f55SBarry Smith     In the initial call to this routine the sub-solver data structures do not exist so we cannot call KSPSetFromOptions() on them yet.
161734603f55SBarry 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
161834603f55SBarry Smith     is called on the outer solver in case changes were made in the options database
161934603f55SBarry Smith 
162034603f55SBarry 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()
162134603f55SBarry 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.
162234603f55SBarry Smith     Without this extra check test p2p1fetidp_olof_full and others fail with incorrect matrix types.
162334603f55SBarry Smith 
162434603f55SBarry Smith     There could be a negative side effect of calling the KSPSetFromOptions() below.
162534603f55SBarry Smith 
162634603f55SBarry 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
162734603f55SBarry Smith   */
162834603f55SBarry Smith   if (jac->issetup) {
162934603f55SBarry Smith     PC_FieldSplitLink ilink = jac->head;
163034603f55SBarry Smith     if (jac->type == PC_COMPOSITE_SCHUR) {
163134603f55SBarry Smith       if (jac->kspupper && jac->kspupper->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspupper));
163234603f55SBarry Smith       if (jac->kspschur && jac->kspschur->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspschur));
163334603f55SBarry Smith     }
163434603f55SBarry Smith     while (ilink) {
163534603f55SBarry Smith       if (ilink->ksp->totalits > 0) PetscCall(KSPSetFromOptions(ilink->ksp));
163634603f55SBarry Smith       ilink = ilink->next;
163734603f55SBarry Smith     }
163834603f55SBarry Smith   }
1639d0609cedSBarry Smith   PetscOptionsHeadEnd();
16403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
16410971522cSBarry Smith }
16420971522cSBarry Smith 
1643d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col)
1644d71ae5a4SJacob Faibussowitsch {
164597bbdb24SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
16465a9f2f41SSatish Balay   PC_FieldSplitLink ilink, next = jac->head;
164769a612a9SBarry Smith   char              prefix[128];
16485d4c12cdSJungho Lee   PetscInt          i;
16490971522cSBarry Smith 
16500971522cSBarry Smith   PetscFunctionBegin;
16516c924f48SJed Brown   if (jac->splitdefined) {
16529566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
16533ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
16546c924f48SJed Brown   }
165551f519a2SBarry Smith   for (i = 0; i < n; i++) {
165663a3b9bcSJacob Faibussowitsch     PetscCheck(fields[i] < jac->bs, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", fields[i], jac->bs);
165763a3b9bcSJacob Faibussowitsch     PetscCheck(fields[i] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", fields[i]);
165851f519a2SBarry Smith   }
16599566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
1660a04f6461SBarry Smith   if (splitname) {
16619566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
1662a04f6461SBarry Smith   } else {
16639566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(3, &ilink->splitname));
166463a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 2, "%" PetscInt_FMT, jac->nsplits));
1665a04f6461SBarry Smith   }
16669df09d43SBarry 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 */
16679566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields));
16689566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields, fields, n));
16699566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields_col));
16709566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields_col, fields_col, n));
16712fa5cd67SKarl Rupp 
16725a9f2f41SSatish Balay   ilink->nfields = n;
16730298fd71SBarry Smith   ilink->next    = NULL;
16749566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
16759566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
16769566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
16779566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
167869a612a9SBarry Smith 
16799566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
16809566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
16810971522cSBarry Smith 
16820971522cSBarry Smith   if (!next) {
16835a9f2f41SSatish Balay     jac->head       = ilink;
16840298fd71SBarry Smith     ilink->previous = NULL;
16850971522cSBarry Smith   } else {
1686ad540459SPierre Jolivet     while (next->next) next = next->next;
16875a9f2f41SSatish Balay     next->next      = ilink;
168851f519a2SBarry Smith     ilink->previous = next;
16890971522cSBarry Smith   }
16900971522cSBarry Smith   jac->nsplits++;
16913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
16920971522cSBarry Smith }
16930971522cSBarry Smith 
1694d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp)
1695d71ae5a4SJacob Faibussowitsch {
1696285fb4e2SStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1697285fb4e2SStefano Zampini 
1698285fb4e2SStefano Zampini   PetscFunctionBegin;
1699285fb4e2SStefano Zampini   *subksp = NULL;
1700285fb4e2SStefano Zampini   if (n) *n = 0;
1701285fb4e2SStefano Zampini   if (jac->type == PC_COMPOSITE_SCHUR) {
1702285fb4e2SStefano Zampini     PetscInt nn;
1703285fb4e2SStefano Zampini 
170428b400f6SJacob Faibussowitsch     PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()");
170563a3b9bcSJacob Faibussowitsch     PetscCheck(jac->nsplits == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unexpected number of splits %" PetscInt_FMT " != 2", jac->nsplits);
1706285fb4e2SStefano Zampini     nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0);
17079566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nn, subksp));
1708285fb4e2SStefano Zampini     (*subksp)[0] = jac->head->ksp;
1709285fb4e2SStefano Zampini     (*subksp)[1] = jac->kspschur;
1710285fb4e2SStefano Zampini     if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper;
1711285fb4e2SStefano Zampini     if (n) *n = nn;
1712285fb4e2SStefano Zampini   }
17133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1714285fb4e2SStefano Zampini }
1715285fb4e2SStefano Zampini 
1716d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc, PetscInt *n, KSP **subksp)
1717d71ae5a4SJacob Faibussowitsch {
1718e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1719e69d4d44SBarry Smith 
1720e69d4d44SBarry Smith   PetscFunctionBegin;
172128b400f6SJacob Faibussowitsch   PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
17229566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
17239566063dSJacob Faibussowitsch   PetscCall(MatSchurComplementGetKSP(jac->schur, *subksp));
17242fa5cd67SKarl Rupp 
1725e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
172613e0d083SBarry Smith   if (n) *n = jac->nsplits;
17273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1728e69d4d44SBarry Smith }
17290971522cSBarry Smith 
1730d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp)
1731d71ae5a4SJacob Faibussowitsch {
17320971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
17330971522cSBarry Smith   PetscInt          cnt   = 0;
17345a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
17350971522cSBarry Smith 
17360971522cSBarry Smith   PetscFunctionBegin;
17379566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
17385a9f2f41SSatish Balay   while (ilink) {
17395a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
17405a9f2f41SSatish Balay     ilink            = ilink->next;
17410971522cSBarry Smith   }
174263a3b9bcSJacob 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);
174313e0d083SBarry Smith   if (n) *n = jac->nsplits;
17443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
17450971522cSBarry Smith }
17460971522cSBarry Smith 
17476dbb499eSCian Wilson /*@C
1748f1580f4eSBarry Smith     PCFieldSplitRestrictIS - Restricts the fieldsplit `IS`s to be within a given `IS`.
17496dbb499eSCian Wilson 
17506dbb499eSCian Wilson     Input Parameters:
17516dbb499eSCian Wilson +   pc  - the preconditioner context
1752a2b725a8SWilliam Gropp -   is - the index set that defines the indices to which the fieldsplit is to be restricted
17536dbb499eSCian Wilson 
17546dbb499eSCian Wilson     Level: advanced
17556dbb499eSCian Wilson 
1756f1580f4eSBarry Smith     Developer Note:
1757f1580f4eSBarry Smith     It seems the resulting `IS`s will not cover the entire space, so
1758f1580f4eSBarry Smith     how can they define a convergent preconditioner? Needs explaining.
1759f1580f4eSBarry Smith 
176060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
17616dbb499eSCian Wilson @*/
1762d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitRestrictIS(PC pc, IS isy)
1763d71ae5a4SJacob Faibussowitsch {
17646dbb499eSCian Wilson   PetscFunctionBegin;
17656dbb499eSCian Wilson   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
17666dbb499eSCian Wilson   PetscValidHeaderSpecific(isy, IS_CLASSID, 2);
1767cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitRestrictIS_C", (PC, IS), (pc, isy));
17683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
17696dbb499eSCian Wilson }
17706dbb499eSCian Wilson 
1771d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
1772d71ae5a4SJacob Faibussowitsch {
17736dbb499eSCian Wilson   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
17746dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
17756dbb499eSCian Wilson   PetscInt          localsize, size, sizez, i;
17766dbb499eSCian Wilson   const PetscInt   *ind, *indz;
17776dbb499eSCian Wilson   PetscInt         *indc, *indcz;
17786dbb499eSCian Wilson   PetscBool         flg;
17796dbb499eSCian Wilson 
17806dbb499eSCian Wilson   PetscFunctionBegin;
17819566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(isy, &localsize));
17829566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&localsize, &size, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)isy)));
17836dbb499eSCian Wilson   size -= localsize;
17846dbb499eSCian Wilson   while (ilink) {
17856dbb499eSCian Wilson     IS isrl, isr;
17861c7cfba8SBarry Smith     PC subpc;
17879566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl));
17889566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(isrl, &localsize));
17899566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(localsize, &indc));
17909566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(isrl, &ind));
17919566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(indc, ind, localsize));
17929566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(isrl, &ind));
17939566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isrl));
17946dbb499eSCian Wilson     for (i = 0; i < localsize; i++) *(indc + i) += size;
17959566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)isy), localsize, indc, PETSC_OWN_POINTER, &isr));
17969566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
17979566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
17986dbb499eSCian Wilson     ilink->is = isr;
17999566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
18009566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
18016dbb499eSCian Wilson     ilink->is_col = isr;
18029566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isr));
18039566063dSJacob Faibussowitsch     PetscCall(KSPGetPC(ilink->ksp, &subpc));
18049566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)subpc, PCFIELDSPLIT, &flg));
18056dbb499eSCian Wilson     if (flg) {
18066dbb499eSCian Wilson       IS       iszl, isz;
18076dbb499eSCian Wilson       MPI_Comm comm;
18089566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(ilink->is, &localsize));
18096dbb499eSCian Wilson       comm = PetscObjectComm((PetscObject)ilink->is);
18109566063dSJacob Faibussowitsch       PetscCall(ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl));
18119566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Scan(&localsize, &sizez, 1, MPIU_INT, MPI_SUM, comm));
18126dbb499eSCian Wilson       sizez -= localsize;
18139566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(iszl, &localsize));
18149566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(localsize, &indcz));
18159566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(iszl, &indz));
18169566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(indcz, indz, localsize));
18179566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(iszl, &indz));
18189566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&iszl));
18196dbb499eSCian Wilson       for (i = 0; i < localsize; i++) *(indcz + i) += sizez;
18209566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(comm, localsize, indcz, PETSC_OWN_POINTER, &isz));
18219566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitRestrictIS(subpc, isz));
18229566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&isz));
18236dbb499eSCian Wilson     }
18246dbb499eSCian Wilson     next  = ilink->next;
18256dbb499eSCian Wilson     ilink = next;
18266dbb499eSCian Wilson   }
18276dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
18283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
18296dbb499eSCian Wilson }
18306dbb499eSCian Wilson 
1831d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc, const char splitname[], IS is)
1832d71ae5a4SJacob Faibussowitsch {
1833704ba839SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
1834704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1835704ba839SBarry Smith   char              prefix[128];
1836704ba839SBarry Smith 
1837704ba839SBarry Smith   PetscFunctionBegin;
18386c924f48SJed Brown   if (jac->splitdefined) {
18399566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
18403ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
18416c924f48SJed Brown   }
18429566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
1843a04f6461SBarry Smith   if (splitname) {
18449566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
1845a04f6461SBarry Smith   } else {
18469566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(8, &ilink->splitname));
184763a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 7, "%" PetscInt_FMT, jac->nsplits));
1848a04f6461SBarry Smith   }
18499df09d43SBarry 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 */
18509566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
18519566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is));
1852b5787286SJed Brown   ilink->is = is;
18539566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
18549566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is_col));
1855b5787286SJed Brown   ilink->is_col = is;
18560298fd71SBarry Smith   ilink->next   = NULL;
18579566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
18589566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
18599566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
18609566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
1861704ba839SBarry Smith 
18629566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
18639566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
1864704ba839SBarry Smith 
1865704ba839SBarry Smith   if (!next) {
1866704ba839SBarry Smith     jac->head       = ilink;
18670298fd71SBarry Smith     ilink->previous = NULL;
1868704ba839SBarry Smith   } else {
1869ad540459SPierre Jolivet     while (next->next) next = next->next;
1870704ba839SBarry Smith     next->next      = ilink;
1871704ba839SBarry Smith     ilink->previous = next;
1872704ba839SBarry Smith   }
1873704ba839SBarry Smith   jac->nsplits++;
18743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1875704ba839SBarry Smith }
1876704ba839SBarry Smith 
187794ef8ddeSSatish Balay /*@C
187860f59c3bSBarry Smith     PCFieldSplitSetFields - Sets the fields that define one particular split in `PCFIELDSPLIT`
18790971522cSBarry Smith 
1880c3339decSBarry Smith     Logically Collective
18810971522cSBarry Smith 
18820971522cSBarry Smith     Input Parameters:
18830971522cSBarry Smith +   pc  - the preconditioner context
188460f59c3bSBarry Smith .   splitname - name of this split, if `NULL` the number of the split is used
18850971522cSBarry Smith .   n - the number of fields in this split
18863b374dbdSBarry Smith .   fields - the fields in this split
18873b374dbdSBarry Smith -   fields_col - generally the same as fields, if it does not match fields then the matrix block that is solved for this set of fields comes from an off-diagonal block
18883b374dbdSBarry Smith                  of the matrix and fields_col provides the column indices for that block
18890971522cSBarry Smith 
18900971522cSBarry Smith     Level: intermediate
18910971522cSBarry Smith 
189295452b02SPatrick Sanan     Notes:
1893f1580f4eSBarry Smith     Use `PCFieldSplitSetIS()` to set a  general set of indices as a split.
1894d32f9abdSBarry Smith 
1895f1580f4eSBarry Smith      `PCFieldSplitSetFields()` is for defining fields as strided blocks. For example, if the block
1896f1580f4eSBarry 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
1897d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1898f1580f4eSBarry Smith      where the numbered entries indicate what is in the split.
1899d32f9abdSBarry Smith 
1900db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
190160f59c3bSBarry Smith      for this split will be available under the prefix `-fieldsplit_SPLITNAME_`.
1902db4c96c1SJed Brown 
19033b374dbdSBarry Smith    `PCFieldSplitSetIS()` does not support having a fields_col different from fields
19043b374dbdSBarry Smith 
1905f1580f4eSBarry Smith    Developer Note:
1906f1580f4eSBarry Smith    This routine does not actually create the `IS` representing the split, that is delayed
1907f1580f4eSBarry Smith    until `PCSetUp_FieldSplit()`, because information about the vector/matrix layouts may not be
19085d4c12cdSJungho Lee    available when this routine is called.
19095d4c12cdSJungho Lee 
191060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetIS()`, `PCFieldSplitRestrictIS()`
19110971522cSBarry Smith @*/
1912d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetFields(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col)
1913d71ae5a4SJacob Faibussowitsch {
19140971522cSBarry Smith   PetscFunctionBegin;
19150700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
1916db4c96c1SJed Brown   PetscValidCharPointer(splitname, 2);
191763a3b9bcSJacob Faibussowitsch   PetscCheck(n >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Provided number of fields %" PetscInt_FMT " in split \"%s\" not positive", n, splitname);
1918064a246eSJacob Faibussowitsch   PetscValidIntPointer(fields, 4);
1919cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetFields_C", (PC, const char[], PetscInt, const PetscInt *, const PetscInt *), (pc, splitname, n, fields, fields_col));
19203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19210971522cSBarry Smith }
19220971522cSBarry Smith 
1923c84da90fSDmitry Karpeev /*@
1924f1580f4eSBarry Smith     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build
1925f1580f4eSBarry Smith     the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators.
1926c84da90fSDmitry Karpeev 
1927c3339decSBarry Smith     Logically Collective
1928c84da90fSDmitry Karpeev 
1929c84da90fSDmitry Karpeev     Input Parameters:
1930c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1931c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1932c84da90fSDmitry Karpeev 
1933*20f4b53cSBarry Smith     Options Database Key:
1934147403d9SBarry Smith .   -pc_fieldsplit_diag_use_amat - use the Amat to provide the diagonal blocks
1935c84da90fSDmitry Karpeev 
1936c84da90fSDmitry Karpeev     Level: intermediate
1937c84da90fSDmitry Karpeev 
193860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetDiagUseAmat()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFIELDSPLIT`
1939c84da90fSDmitry Karpeev @*/
1940d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc, PetscBool flg)
1941d71ae5a4SJacob Faibussowitsch {
1942c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1943c84da90fSDmitry Karpeev   PetscBool      isfs;
1944c84da90fSDmitry Karpeev 
1945c84da90fSDmitry Karpeev   PetscFunctionBegin;
1946c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
19479566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
194828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
1949c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
19503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1951c84da90fSDmitry Karpeev }
1952c84da90fSDmitry Karpeev 
1953c84da90fSDmitry Karpeev /*@
1954f1580f4eSBarry Smith     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build
1955f1580f4eSBarry Smith     the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators.
1956c84da90fSDmitry Karpeev 
1957c3339decSBarry Smith     Logically Collective
1958c84da90fSDmitry Karpeev 
1959*20f4b53cSBarry Smith     Input Parameter:
1960c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1961c84da90fSDmitry Karpeev 
1962*20f4b53cSBarry Smith     Output Parameter:
1963c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1964c84da90fSDmitry Karpeev 
1965c84da90fSDmitry Karpeev     Level: intermediate
1966c84da90fSDmitry Karpeev 
196760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetDiagUseAmat()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFIELDSPLIT`
1968c84da90fSDmitry Karpeev @*/
1969d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc, PetscBool *flg)
1970d71ae5a4SJacob Faibussowitsch {
1971c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1972c84da90fSDmitry Karpeev   PetscBool      isfs;
1973c84da90fSDmitry Karpeev 
1974c84da90fSDmitry Karpeev   PetscFunctionBegin;
1975c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
1976534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
19779566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
197828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
1979c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
19803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1981c84da90fSDmitry Karpeev }
1982c84da90fSDmitry Karpeev 
1983c84da90fSDmitry Karpeev /*@
1984f1580f4eSBarry Smith     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build
1985f1580f4eSBarry Smith     the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators.
1986c84da90fSDmitry Karpeev 
1987c3339decSBarry Smith     Logically Collective
1988c84da90fSDmitry Karpeev 
1989c84da90fSDmitry Karpeev     Input Parameters:
1990c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1991c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1992c84da90fSDmitry Karpeev 
1993*20f4b53cSBarry Smith     Options Database Key:
1994147403d9SBarry Smith .     -pc_fieldsplit_off_diag_use_amat <bool> - use the Amat to extract the off-diagonal blocks
1995c84da90fSDmitry Karpeev 
1996c84da90fSDmitry Karpeev     Level: intermediate
1997c84da90fSDmitry Karpeev 
199860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFieldSplitSetDiagUseAmat()`, `PCFIELDSPLIT`
1999c84da90fSDmitry Karpeev @*/
2000d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc, PetscBool flg)
2001d71ae5a4SJacob Faibussowitsch {
2002c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2003c84da90fSDmitry Karpeev   PetscBool      isfs;
2004c84da90fSDmitry Karpeev 
2005c84da90fSDmitry Karpeev   PetscFunctionBegin;
2006c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
20079566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
200828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2009c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
20103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2011c84da90fSDmitry Karpeev }
2012c84da90fSDmitry Karpeev 
2013c84da90fSDmitry Karpeev /*@
2014f1580f4eSBarry Smith     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build
2015f1580f4eSBarry Smith     the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat)) was used to supply the operators.
2016c84da90fSDmitry Karpeev 
2017c3339decSBarry Smith     Logically Collective
2018c84da90fSDmitry Karpeev 
2019*20f4b53cSBarry Smith     Input Parameter:
2020c84da90fSDmitry Karpeev .   pc  - the preconditioner object
2021c84da90fSDmitry Karpeev 
2022*20f4b53cSBarry Smith     Output Parameter:
2023c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2024c84da90fSDmitry Karpeev 
2025c84da90fSDmitry Karpeev     Level: intermediate
2026c84da90fSDmitry Karpeev 
202760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFieldSplitGetDiagUseAmat()`, `PCFIELDSPLIT`
2028c84da90fSDmitry Karpeev @*/
2029d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc, PetscBool *flg)
2030d71ae5a4SJacob Faibussowitsch {
2031c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2032c84da90fSDmitry Karpeev   PetscBool      isfs;
2033c84da90fSDmitry Karpeev 
2034c84da90fSDmitry Karpeev   PetscFunctionBegin;
2035c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2036534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
20379566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
203828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2039c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
20403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2041c84da90fSDmitry Karpeev }
2042c84da90fSDmitry Karpeev 
2043218d4943SBarry Smith /*@C
2044f1580f4eSBarry Smith     PCFieldSplitSetIS - Sets the exact elements for a split in a `PCFIELDSPLIT`
2045704ba839SBarry Smith 
2046c3339decSBarry Smith     Logically Collective
2047704ba839SBarry Smith 
2048704ba839SBarry Smith     Input Parameters:
2049704ba839SBarry Smith +   pc  - the preconditioner context
205060f59c3bSBarry Smith .   splitname - name of this split, if `NULL` the number of the split is used
2051f1580f4eSBarry Smith -   is - the index set that defines the elements in this split
2052704ba839SBarry Smith 
205360f59c3bSBarry Smith     Level: intermediate
205460f59c3bSBarry Smith 
2055a6ffb8dbSJed Brown     Notes:
2056f1580f4eSBarry Smith     Use `PCFieldSplitSetFields()`, for splits defined by strided types.
2057a6ffb8dbSJed Brown 
2058db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
2059db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
2060d32f9abdSBarry Smith 
206160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`
2062704ba839SBarry Smith @*/
2063d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetIS(PC pc, const char splitname[], IS is)
2064d71ae5a4SJacob Faibussowitsch {
2065704ba839SBarry Smith   PetscFunctionBegin;
20660700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
20677b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname, 2);
2068db4c96c1SJed Brown   PetscValidHeaderSpecific(is, IS_CLASSID, 3);
2069cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetIS_C", (PC, const char[], IS), (pc, splitname, is));
20703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2071704ba839SBarry Smith }
2072704ba839SBarry Smith 
207394ef8ddeSSatish Balay /*@C
2074f1580f4eSBarry Smith     PCFieldSplitGetIS - Retrieves the elements for a split as an `IS`
207557a9adfeSMatthew G Knepley 
2076c3339decSBarry Smith     Logically Collective
207757a9adfeSMatthew G Knepley 
207857a9adfeSMatthew G Knepley     Input Parameters:
207957a9adfeSMatthew G Knepley +   pc  - the preconditioner context
208057a9adfeSMatthew G Knepley -   splitname - name of this split
208157a9adfeSMatthew G Knepley 
208257a9adfeSMatthew G Knepley     Output Parameter:
208360f59c3bSBarry Smith -   is - the index set that defines the elements in this split, or `NULL` if the split is not found
208457a9adfeSMatthew G Knepley 
208557a9adfeSMatthew G Knepley     Level: intermediate
208657a9adfeSMatthew G Knepley 
208760f59c3bSBarry Smith .seealso:  [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetIS()`
208857a9adfeSMatthew G Knepley @*/
2089d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetIS(PC pc, const char splitname[], IS *is)
2090d71ae5a4SJacob Faibussowitsch {
209157a9adfeSMatthew G Knepley   PetscFunctionBegin;
209257a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
209357a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname, 2);
209457a9adfeSMatthew G Knepley   PetscValidPointer(is, 3);
209557a9adfeSMatthew G Knepley   {
209657a9adfeSMatthew G Knepley     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
209757a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
209857a9adfeSMatthew G Knepley     PetscBool         found;
209957a9adfeSMatthew G Knepley 
21000298fd71SBarry Smith     *is = NULL;
210157a9adfeSMatthew G Knepley     while (ilink) {
21029566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(ilink->splitname, splitname, &found));
210357a9adfeSMatthew G Knepley       if (found) {
210457a9adfeSMatthew G Knepley         *is = ilink->is;
210557a9adfeSMatthew G Knepley         break;
210657a9adfeSMatthew G Knepley       }
210757a9adfeSMatthew G Knepley       ilink = ilink->next;
210857a9adfeSMatthew G Knepley     }
210957a9adfeSMatthew G Knepley   }
21103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
211157a9adfeSMatthew G Knepley }
211257a9adfeSMatthew G Knepley 
2113998f007dSPierre Jolivet /*@C
2114f1580f4eSBarry Smith     PCFieldSplitGetISByIndex - Retrieves the elements for a given split as an `IS`
2115998f007dSPierre Jolivet 
2116c3339decSBarry Smith     Logically Collective
2117998f007dSPierre Jolivet 
2118998f007dSPierre Jolivet     Input Parameters:
2119998f007dSPierre Jolivet +   pc  - the preconditioner context
2120998f007dSPierre Jolivet -   index - index of this split
2121998f007dSPierre Jolivet 
2122998f007dSPierre Jolivet     Output Parameter:
2123f1580f4eSBarry Smith -   is - the index set that defines the elements in this split
2124998f007dSPierre Jolivet 
2125998f007dSPierre Jolivet     Level: intermediate
2126998f007dSPierre Jolivet 
212760f59c3bSBarry Smith .seealso:  [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitGetIS()`, `PCFieldSplitSetIS()`
2128998f007dSPierre Jolivet @*/
2129d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetISByIndex(PC pc, PetscInt index, IS *is)
2130d71ae5a4SJacob Faibussowitsch {
2131998f007dSPierre Jolivet   PetscFunctionBegin;
213263a3b9bcSJacob Faibussowitsch   PetscCheck(index >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", index);
2133998f007dSPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2134998f007dSPierre Jolivet   PetscValidPointer(is, 3);
2135998f007dSPierre Jolivet   {
2136998f007dSPierre Jolivet     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
2137998f007dSPierre Jolivet     PC_FieldSplitLink ilink = jac->head;
2138998f007dSPierre Jolivet     PetscInt          i     = 0;
213963a3b9bcSJacob Faibussowitsch     PetscCheck(index < jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", index, jac->nsplits);
2140998f007dSPierre Jolivet 
2141998f007dSPierre Jolivet     while (i < index) {
2142998f007dSPierre Jolivet       ilink = ilink->next;
2143998f007dSPierre Jolivet       ++i;
2144998f007dSPierre Jolivet     }
21459566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitGetIS(pc, ilink->splitname, is));
2146998f007dSPierre Jolivet   }
21473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2148998f007dSPierre Jolivet }
2149998f007dSPierre Jolivet 
215051f519a2SBarry Smith /*@
215151f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
2152f1580f4eSBarry Smith       fieldsplit preconditioner when calling `PCFieldSplitSetIS()`. If not set the matrix block size is used.
215351f519a2SBarry Smith 
2154c3339decSBarry Smith     Logically Collective
215551f519a2SBarry Smith 
215651f519a2SBarry Smith     Input Parameters:
215751f519a2SBarry Smith +   pc  - the preconditioner context
215851f519a2SBarry Smith -   bs - the block size
215951f519a2SBarry Smith 
216051f519a2SBarry Smith     Level: intermediate
216151f519a2SBarry Smith 
216260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
216351f519a2SBarry Smith @*/
2164d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetBlockSize(PC pc, PetscInt bs)
2165d71ae5a4SJacob Faibussowitsch {
216651f519a2SBarry Smith   PetscFunctionBegin;
21670700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2168c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc, bs, 2);
2169cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetBlockSize_C", (PC, PetscInt), (pc, bs));
21703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
217151f519a2SBarry Smith }
217251f519a2SBarry Smith 
21730971522cSBarry Smith /*@C
2174f1580f4eSBarry Smith    PCFieldSplitGetSubKSP - Gets the `KSP` contexts for all splits
21750971522cSBarry Smith 
2176c3339decSBarry Smith    Collective
21770971522cSBarry Smith 
21780971522cSBarry Smith    Input Parameter:
21790971522cSBarry Smith .  pc - the preconditioner context
21800971522cSBarry Smith 
21810971522cSBarry Smith    Output Parameters:
218213e0d083SBarry Smith +  n - the number of splits
2183f1580f4eSBarry Smith -  subksp - the array of `KSP` contexts
2184196cc216SBarry Smith 
21850971522cSBarry Smith    Level: advanced
21860971522cSBarry Smith 
2187f1580f4eSBarry Smith    Notes:
2188f1580f4eSBarry Smith    After `PCFieldSplitGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()`
2189f1580f4eSBarry Smith    (not the `KSP`, just the array that contains them).
2190f1580f4eSBarry Smith 
2191f1580f4eSBarry Smith    You must call `PCSetUp()` before calling `PCFieldSplitGetSubKSP()`.
2192f1580f4eSBarry Smith 
2193f1580f4eSBarry Smith    If the fieldsplit is of type `PC_COMPOSITE_SCHUR`, it returns the `KSP` object used inside the
2194f1580f4eSBarry Smith    Schur complement and the `KSP` object used to iterate over the Schur complement.
2195f1580f4eSBarry Smith    To access all the `KSP` objects used in `PC_COMPOSITE_SCHUR`, use `PCFieldSplitSchurGetSubKSP()`.
2196f1580f4eSBarry Smith 
2197f1580f4eSBarry Smith    If the fieldsplit is of type `PC_COMPOSITE_GKB`, it returns the `KSP` object used to solve the
2198f1580f4eSBarry Smith    inner linear system defined by the matrix H in each loop.
2199f1580f4eSBarry Smith 
2200f1580f4eSBarry Smith    Fortran Usage:
2201f1580f4eSBarry Smith    You must pass in a `KSP` array that is large enough to contain all the `KSP`s.
2202f1580f4eSBarry Smith    You can call `PCFieldSplitGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the
2203f1580f4eSBarry Smith    `KSP` array must be.
2204f1580f4eSBarry Smith 
2205f1580f4eSBarry Smith    Developer Note:
2206f1580f4eSBarry Smith    There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()`
2207f1580f4eSBarry Smith 
2208f1580f4eSBarry Smith    The Fortran interface should be modernized to return directly the array of values.
2209f1580f4eSBarry Smith 
221060f59c3bSBarry Smith .seealso:  [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitSchurGetSubKSP()`
22110971522cSBarry Smith @*/
2212d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSubKSP(PC pc, PetscInt *n, KSP *subksp[])
2213d71ae5a4SJacob Faibussowitsch {
22140971522cSBarry Smith   PetscFunctionBegin;
22150700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
221613e0d083SBarry Smith   if (n) PetscValidIntPointer(n, 2);
2217cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
22183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22190971522cSBarry Smith }
22200971522cSBarry Smith 
2221285fb4e2SStefano Zampini /*@C
2222f1580f4eSBarry Smith    PCFieldSplitSchurGetSubKSP - Gets the `KSP` contexts used inside the Schur complement based `PCFIELDSPLIT`
2223285fb4e2SStefano Zampini 
222460f59c3bSBarry Smith    Collective
2225285fb4e2SStefano Zampini 
2226285fb4e2SStefano Zampini    Input Parameter:
2227285fb4e2SStefano Zampini .  pc - the preconditioner context
2228285fb4e2SStefano Zampini 
2229285fb4e2SStefano Zampini    Output Parameters:
2230285fb4e2SStefano Zampini +  n - the number of splits
2231f1580f4eSBarry Smith -  subksp - the array of `KSP` contexts
2232285fb4e2SStefano Zampini 
2233285fb4e2SStefano Zampini    Level: advanced
2234285fb4e2SStefano Zampini 
2235f1580f4eSBarry Smith    Notes:
2236f1580f4eSBarry Smith    After `PCFieldSplitSchurGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()`
2237f1580f4eSBarry Smith    (not the `KSP` just the array that contains them).
2238f1580f4eSBarry Smith 
2239f1580f4eSBarry Smith    You must call `PCSetUp()` before calling `PCFieldSplitSchurGetSubKSP()`.
2240f1580f4eSBarry Smith 
2241f1580f4eSBarry Smith    If the fieldsplit type is of type `PC_COMPOSITE_SCHUR`, it returns (in order)
2242f1580f4eSBarry Smith +  1  - the `KSP` used for the (1,1) block
2243f1580f4eSBarry Smith .  2  - the `KSP` used for the Schur complement (not the one used for the interior Schur solver)
2244f1580f4eSBarry Smith -  3  - the `KSP` used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block).
2245f1580f4eSBarry Smith 
2246f1580f4eSBarry Smith    It returns a null array if the fieldsplit is not of type `PC_COMPOSITE_SCHUR`; in this case, you should use `PCFieldSplitGetSubKSP()`.
2247f1580f4eSBarry Smith 
2248f1580f4eSBarry Smith    Fortran Note:
2249f1580f4eSBarry Smith    You must pass in a `KSP` array that is large enough to contain all the local `KSP`s.
2250f1580f4eSBarry Smith    You can call `PCFieldSplitSchurGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the
2251f1580f4eSBarry Smith    `KSP` array must be.
2252f1580f4eSBarry Smith 
2253f1580f4eSBarry Smith    Developer Notes:
2254f1580f4eSBarry Smith    There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()`
2255f1580f4eSBarry Smith 
2256f1580f4eSBarry Smith    Should the functionality of `PCFieldSplitSchurGetSubKSP()` and `PCFieldSplitGetSubKSP()` be merged?
2257f1580f4eSBarry Smith 
2258f1580f4eSBarry Smith    The Fortran interface should be modernized to return directly the array of values.
2259f1580f4eSBarry Smith 
226060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitGetSubKSP()`
2261285fb4e2SStefano Zampini @*/
2262d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc, PetscInt *n, KSP *subksp[])
2263d71ae5a4SJacob Faibussowitsch {
2264285fb4e2SStefano Zampini   PetscFunctionBegin;
2265285fb4e2SStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2266285fb4e2SStefano Zampini   if (n) PetscValidIntPointer(n, 2);
2267cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitSchurGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
22683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2269285fb4e2SStefano Zampini }
2270285fb4e2SStefano Zampini 
2271e69d4d44SBarry Smith /*@
2272a1e3cbf9SBarry Smith     PCFieldSplitSetSchurPre -  Indicates from what operator the preconditioner is constructucted for the Schur complement.
2273a1e3cbf9SBarry Smith       The default is the A11 matrix.
2274e69d4d44SBarry Smith 
2275c3339decSBarry Smith     Collective
2276e69d4d44SBarry Smith 
2277e69d4d44SBarry Smith     Input Parameters:
2278e69d4d44SBarry Smith +   pc      - the preconditioner context
2279f1580f4eSBarry Smith .   ptype   - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11` (default),
2280f1580f4eSBarry Smith               `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER`,
2281f1580f4eSBarry Smith               `PC_FIELDSPLIT_SCHUR_PRE_SELFP`, and `PC_FIELDSPLIT_SCHUR_PRE_FULL`
228260f59c3bSBarry Smith -   pre - matrix to use for preconditioning, or `NULL`
2283084e4875SJed Brown 
2284f1580f4eSBarry Smith     Options Database Keys:
2285a1e3cbf9SBarry Smith +    -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments
2286a1e3cbf9SBarry Smith -    -fieldsplit_1_pc_type <pctype> - the preconditioner algorithm that is used to construct the preconditioner from the operator
2287e69d4d44SBarry Smith 
228860f59c3bSBarry Smith      Level: intermediate
228960f59c3bSBarry Smith 
2290fd1303e9SJungho Lee     Notes:
2291f1580f4eSBarry Smith     If ptype is
2292f1580f4eSBarry Smith +     a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
2293f1580f4eSBarry Smith      matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
2294f1580f4eSBarry Smith .     self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
2295da81f932SPierre Jolivet           The only preconditioner that currently works with this symbolic representation matrix object is the `PCLSC`
2296f1580f4eSBarry Smith           preconditioner
2297f1580f4eSBarry Smith .     user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
2298f1580f4eSBarry Smith           to this function).
2299f1580f4eSBarry Smith .     selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
2300f1580f4eSBarry Smith           This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
2301f1580f4eSBarry Smith           lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump
2302f1580f4eSBarry Smith -     full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation
2303f1580f4eSBarry Smith       computed internally by `PCFIELDSPLIT` (this is expensive)
2304f1580f4eSBarry Smith       useful mostly as a test that the Schur complement approach can work for your problem
2305fd1303e9SJungho Lee 
2306e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
2307fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
2308a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
2309fd1303e9SJungho Lee 
231060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`,
2311f1580f4eSBarry Smith           `MatSchurComplementSetAinvType()`, `PCLSC`,
2312f1580f4eSBarry Smith           `PCFieldSplitSchurPreType`
2313e69d4d44SBarry Smith @*/
2314d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurPre(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2315d71ae5a4SJacob Faibussowitsch {
2316e69d4d44SBarry Smith   PetscFunctionBegin;
23170700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2318cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurPre_C", (PC, PCFieldSplitSchurPreType, Mat), (pc, ptype, pre));
23193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2320e69d4d44SBarry Smith }
2321686bed4dSStefano Zampini 
2322d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurPrecondition(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2323d71ae5a4SJacob Faibussowitsch {
23249371c9d4SSatish Balay   return PCFieldSplitSetSchurPre(pc, ptype, pre);
23259371c9d4SSatish Balay } /* Deprecated name */
2326e69d4d44SBarry Smith 
232737a82bf0SJed Brown /*@
232837a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
2329f1580f4eSBarry Smith     preconditioned.  See `PCFieldSplitSetSchurPre()` for details.
233037a82bf0SJed Brown 
2331c3339decSBarry Smith     Logically Collective
233237a82bf0SJed Brown 
2333f899ff85SJose E. Roman     Input Parameter:
233437a82bf0SJed Brown .   pc      - the preconditioner context
233537a82bf0SJed Brown 
233637a82bf0SJed Brown     Output Parameters:
2337f1580f4eSBarry Smith +   ptype   - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11`, `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_PRE_USER`
2338f408ff4eSRichard Tran Mills -   pre - matrix to use for preconditioning (with `PC_FIELDSPLIT_PRE_USER`), or NULL
233937a82bf0SJed Brown 
234037a82bf0SJed Brown     Level: intermediate
234137a82bf0SJed Brown 
234260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCLSC`,
2343f1580f4eSBarry Smith           `PCFieldSplitSchurPreType`
234437a82bf0SJed Brown @*/
2345d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurPre(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre)
2346d71ae5a4SJacob Faibussowitsch {
234737a82bf0SJed Brown   PetscFunctionBegin;
234837a82bf0SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2349cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSchurPre_C", (PC, PCFieldSplitSchurPreType *, Mat *), (pc, ptype, pre));
23503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2351e69d4d44SBarry Smith }
2352e69d4d44SBarry Smith 
235345e7fc46SDmitry Karpeev /*@
2354f1580f4eSBarry Smith     PCFieldSplitSchurGetS -  extract the `MATSCHURCOMPLEMENT` object used by this `PCFIELDSPLIT` in case it needs to be configured separately
235545e7fc46SDmitry Karpeev 
2356*20f4b53cSBarry Smith     Not Collective
235745e7fc46SDmitry Karpeev 
235845e7fc46SDmitry Karpeev     Input Parameter:
235945e7fc46SDmitry Karpeev .   pc      - the preconditioner context
236045e7fc46SDmitry Karpeev 
236145e7fc46SDmitry Karpeev     Output Parameter:
2362470b340bSDmitry Karpeev .   S       - the Schur complement matrix
236345e7fc46SDmitry Karpeev 
236460f59c3bSBarry Smith     Level: advanced
236560f59c3bSBarry Smith 
2366f1580f4eSBarry Smith     Note:
2367f1580f4eSBarry Smith     This matrix should not be destroyed using `MatDestroy()`; rather, use `PCFieldSplitSchurRestoreS()`.
236845e7fc46SDmitry Karpeev 
236960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MATSCHURCOMPLEMENT`, `PCFieldSplitSchurRestoreS()`,
2370f1580f4eSBarry Smith           `MatCreateSchurComplement()`, `MatSchurComplementGetKSP()`, `MatSchurComplementComputeExplicitOperator()`, `MatGetSchurComplement()`
237145e7fc46SDmitry Karpeev @*/
2372d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetS(PC pc, Mat *S)
2373d71ae5a4SJacob Faibussowitsch {
237445e7fc46SDmitry Karpeev   const char    *t;
237545e7fc46SDmitry Karpeev   PetscBool      isfs;
237645e7fc46SDmitry Karpeev   PC_FieldSplit *jac;
237745e7fc46SDmitry Karpeev 
237845e7fc46SDmitry Karpeev   PetscFunctionBegin;
237945e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23809566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
23819566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
238228b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
238345e7fc46SDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
238463a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
2385470b340bSDmitry Karpeev   if (S) *S = jac->schur;
23863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
238745e7fc46SDmitry Karpeev }
238845e7fc46SDmitry Karpeev 
2389470b340bSDmitry Karpeev /*@
2390f1580f4eSBarry Smith     PCFieldSplitSchurRestoreS -  returns the `MATSCHURCOMPLEMENT` matrix used by this `PC`
2391470b340bSDmitry Karpeev 
2392*20f4b53cSBarry Smith     Not Collective
2393470b340bSDmitry Karpeev 
2394470b340bSDmitry Karpeev     Input Parameters:
2395470b340bSDmitry Karpeev +   pc      - the preconditioner context
2396a2b725a8SWilliam Gropp -   S       - the Schur complement matrix
2397470b340bSDmitry Karpeev 
2398470b340bSDmitry Karpeev     Level: advanced
2399470b340bSDmitry Karpeev 
240060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MatSchurComplement`, `PCFieldSplitSchurGetS()`
2401470b340bSDmitry Karpeev @*/
2402d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurRestoreS(PC pc, Mat *S)
2403d71ae5a4SJacob Faibussowitsch {
2404470b340bSDmitry Karpeev   const char    *t;
2405470b340bSDmitry Karpeev   PetscBool      isfs;
2406470b340bSDmitry Karpeev   PC_FieldSplit *jac;
2407470b340bSDmitry Karpeev 
2408470b340bSDmitry Karpeev   PetscFunctionBegin;
2409470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
24109566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
24119566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
241228b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
2413470b340bSDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
241463a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
24157827d75bSBarry Smith   PetscCheck(S && (*S == jac->schur), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatSchurComplement restored is not the same as gotten");
24163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2417470b340bSDmitry Karpeev }
2418470b340bSDmitry Karpeev 
2419d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2420d71ae5a4SJacob Faibussowitsch {
2421e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2422e69d4d44SBarry Smith 
2423e69d4d44SBarry Smith   PetscFunctionBegin;
2424084e4875SJed Brown   jac->schurpre = ptype;
2425a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
24269566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&jac->schur_user));
2427084e4875SJed Brown     jac->schur_user = pre;
24289566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
2429084e4875SJed Brown   }
24303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2431e69d4d44SBarry Smith }
2432e69d4d44SBarry Smith 
2433d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre)
2434d71ae5a4SJacob Faibussowitsch {
243537a82bf0SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
243637a82bf0SJed Brown 
243737a82bf0SJed Brown   PetscFunctionBegin;
243837a82bf0SJed Brown   *ptype = jac->schurpre;
243937a82bf0SJed Brown   *pre   = jac->schur_user;
24403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
244137a82bf0SJed Brown }
244237a82bf0SJed Brown 
2443ab1df9f5SJed Brown /*@
24440ffb0e17SBarry Smith     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner
2445ab1df9f5SJed Brown 
2446c3339decSBarry Smith     Collective
2447ab1df9f5SJed Brown 
2448ab1df9f5SJed Brown     Input Parameters:
2449ab1df9f5SJed Brown +   pc  - the preconditioner context
2450f1580f4eSBarry Smith -   ftype - which blocks of factorization to retain, `PC_FIELDSPLIT_SCHUR_FACT_FULL` is default
2451ab1df9f5SJed Brown 
2452f1580f4eSBarry Smith     Options Database Key:
2453147403d9SBarry Smith .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - default is full
2454ab1df9f5SJed Brown 
2455ab1df9f5SJed Brown     Level: intermediate
2456ab1df9f5SJed Brown 
2457ab1df9f5SJed Brown     Notes:
2458ab1df9f5SJed Brown     The FULL factorization is
2459ab1df9f5SJed Brown 
2460147403d9SBarry Smith .vb
2461147403d9SBarry Smith    (A   B)  = (1       0) (A   0) (1  Ainv*B)  = L D U
2462147403d9SBarry Smith    (C   E)    (C*Ainv  1) (0   S) (0     1)
2463147403d9SBarry Smith .vb
24640ffb0e17SBarry 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,
2465c096484dSStefano Zampini     and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of KSPMINRES). Sign flipping of S can be turned off with PCFieldSplitSetSchurScale().
2466ab1df9f5SJed Brown 
2467147403d9SBarry Smith     If A and S are solved exactly
2468147403d9SBarry Smith .vb
2469147403d9SBarry Smith       *) FULL factorization is a direct solver.
2470f1580f4eSBarry 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.
2471f1580f4eSBarry 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.
2472147403d9SBarry Smith .ve
2473ab1df9f5SJed Brown 
2474f1580f4eSBarry Smith     If the iteration count is very low, consider using `KSPFGMRES` or `KSPGCR` which can use one less preconditioner
24750ffb0e17SBarry 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.
24760ffb0e17SBarry Smith 
2477f1580f4eSBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with `KSPMINRES`.
24780ffb0e17SBarry Smith 
2479f1580f4eSBarry Smith     A flexible method like `KSPFGMRES` or `KSPGCR` must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used to solve with A or S).
2480ab1df9f5SJed Brown 
2481ab1df9f5SJed Brown     References:
2482606c0280SSatish Balay +   * - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
2483606c0280SSatish Balay -   * - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2484ab1df9f5SJed Brown 
248560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurScale()`
2486ab1df9f5SJed Brown @*/
2487d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurFactType(PC pc, PCFieldSplitSchurFactType ftype)
2488d71ae5a4SJacob Faibussowitsch {
2489ab1df9f5SJed Brown   PetscFunctionBegin;
2490ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2491cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurFactType_C", (PC, PCFieldSplitSchurFactType), (pc, ftype));
24923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2493ab1df9f5SJed Brown }
2494ab1df9f5SJed Brown 
2495d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc, PCFieldSplitSchurFactType ftype)
2496d71ae5a4SJacob Faibussowitsch {
2497ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2498ab1df9f5SJed Brown 
2499ab1df9f5SJed Brown   PetscFunctionBegin;
2500ab1df9f5SJed Brown   jac->schurfactorization = ftype;
25013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2502ab1df9f5SJed Brown }
2503ab1df9f5SJed Brown 
2504c096484dSStefano Zampini /*@
2505f1580f4eSBarry Smith     PCFieldSplitSetSchurScale -  Controls the sign flip of S for `PC_FIELDSPLIT_SCHUR_FACT_DIAG`.
2506c096484dSStefano Zampini 
2507c3339decSBarry Smith     Collective
2508c096484dSStefano Zampini 
2509c096484dSStefano Zampini     Input Parameters:
2510c096484dSStefano Zampini +   pc    - the preconditioner context
2511c096484dSStefano Zampini -   scale - scaling factor for the Schur complement
2512c096484dSStefano Zampini 
2513f1580f4eSBarry Smith     Options Database Key:
2514c096484dSStefano Zampini .   -pc_fieldsplit_schur_scale - default is -1.0
2515c096484dSStefano Zampini 
2516c096484dSStefano Zampini     Level: intermediate
2517c096484dSStefano Zampini 
251860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurFactType`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetSchurFactType()`
2519c096484dSStefano Zampini @*/
2520d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurScale(PC pc, PetscScalar scale)
2521d71ae5a4SJacob Faibussowitsch {
2522c096484dSStefano Zampini   PetscFunctionBegin;
2523c096484dSStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2524c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc, scale, 2);
2525cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurScale_C", (PC, PetscScalar), (pc, scale));
25263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2527c096484dSStefano Zampini }
2528c096484dSStefano Zampini 
2529d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc, PetscScalar scale)
2530d71ae5a4SJacob Faibussowitsch {
2531c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2532c096484dSStefano Zampini 
2533c096484dSStefano Zampini   PetscFunctionBegin;
2534c096484dSStefano Zampini   jac->schurscale = scale;
25353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2536c096484dSStefano Zampini }
2537c096484dSStefano Zampini 
253830ad9308SMatthew Knepley /*@C
25398c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
254030ad9308SMatthew Knepley 
2541c3339decSBarry Smith    Collective
254230ad9308SMatthew Knepley 
254330ad9308SMatthew Knepley    Input Parameter:
254430ad9308SMatthew Knepley .  pc - the preconditioner context
254530ad9308SMatthew Knepley 
254630ad9308SMatthew Knepley    Output Parameters:
2547a04f6461SBarry Smith +  A00 - the (0,0) block
2548a04f6461SBarry Smith .  A01 - the (0,1) block
2549a04f6461SBarry Smith .  A10 - the (1,0) block
2550a04f6461SBarry Smith -  A11 - the (1,1) block
255130ad9308SMatthew Knepley 
255230ad9308SMatthew Knepley    Level: advanced
255330ad9308SMatthew Knepley 
255460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `MatSchurComplementGetSubMatrices()`, `MatSchurComplementSetSubMatrices()`
255530ad9308SMatthew Knepley @*/
2556d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc, Mat *A00, Mat *A01, Mat *A10, Mat *A11)
2557d71ae5a4SJacob Faibussowitsch {
255830ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
255930ad9308SMatthew Knepley 
256030ad9308SMatthew Knepley   PetscFunctionBegin;
25610700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
256208401ef6SPierre Jolivet   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2563a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2564a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2565a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2566a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
25673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
256830ad9308SMatthew Knepley }
256930ad9308SMatthew Knepley 
2570b09e027eSCarola Kruse /*@
2571f1580f4eSBarry Smith     PCFieldSplitSetGKBTol -  Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner in `PCFIELDSPLIT`
2572b09e027eSCarola Kruse 
2573c3339decSBarry Smith     Collective
2574e071a0a4SCarola Kruse 
2575b09e027eSCarola Kruse     Input Parameters:
2576b09e027eSCarola Kruse +   pc        - the preconditioner context
2577b09e027eSCarola Kruse -   tolerance - the solver tolerance
2578b09e027eSCarola Kruse 
2579f1580f4eSBarry Smith     Options Database Key:
2580b09e027eSCarola Kruse .   -pc_fieldsplit_gkb_tol - default is 1e-5
2581b09e027eSCarola Kruse 
2582b09e027eSCarola Kruse     Level: intermediate
2583b09e027eSCarola Kruse 
2584f1580f4eSBarry Smith     Note:
2585f1580f4eSBarry Smith     The generalized GKB algorithm uses a lower bound estimate of the error in energy norm as stopping criterion.
2586f1580f4eSBarry Smith     It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than
2587f1580f4eSBarry Smith     this estimate, the stopping criterion is satisfactory in practical cases [A13].
2588f1580f4eSBarry Smith 
258960f59c3bSBarry Smith     References:
2590f1580f4eSBarry Smith     [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2591f1580f4eSBarry Smith 
259260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBMaxit()`
2593b09e027eSCarola Kruse @*/
2594d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBTol(PC pc, PetscReal tolerance)
2595d71ae5a4SJacob Faibussowitsch {
2596b09e027eSCarola Kruse   PetscFunctionBegin;
2597b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2598de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, tolerance, 2);
2599cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBTol_C", (PC, PetscReal), (pc, tolerance));
26003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2601b09e027eSCarola Kruse }
2602b09e027eSCarola Kruse 
2603d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc, PetscReal tolerance)
2604d71ae5a4SJacob Faibussowitsch {
2605b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2606b09e027eSCarola Kruse 
2607b09e027eSCarola Kruse   PetscFunctionBegin;
2608b09e027eSCarola Kruse   jac->gkbtol = tolerance;
26093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2610b09e027eSCarola Kruse }
2611b09e027eSCarola Kruse 
2612b09e027eSCarola Kruse /*@
2613f1580f4eSBarry Smith     PCFieldSplitSetGKBMaxit -  Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization preconditioner in `PCFIELDSPLIT`
2614b09e027eSCarola Kruse 
2615c3339decSBarry Smith     Collective
2616b09e027eSCarola Kruse 
2617b09e027eSCarola Kruse     Input Parameters:
2618b09e027eSCarola Kruse +   pc     - the preconditioner context
2619b09e027eSCarola Kruse -   maxit  - the maximum number of iterations
2620b09e027eSCarola Kruse 
2621f1580f4eSBarry Smith     Options Database Key:
2622b09e027eSCarola Kruse .   -pc_fieldsplit_gkb_maxit - default is 100
2623b09e027eSCarola Kruse 
2624b09e027eSCarola Kruse     Level: intermediate
2625b09e027eSCarola Kruse 
262660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBNu()`
2627b09e027eSCarola Kruse @*/
2628d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc, PetscInt maxit)
2629d71ae5a4SJacob Faibussowitsch {
2630b09e027eSCarola Kruse   PetscFunctionBegin;
2631b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2632de482cd7SCarola Kruse   PetscValidLogicalCollectiveInt(pc, maxit, 2);
2633cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBMaxit_C", (PC, PetscInt), (pc, maxit));
26343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2635b09e027eSCarola Kruse }
2636b09e027eSCarola Kruse 
2637d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc, PetscInt maxit)
2638d71ae5a4SJacob Faibussowitsch {
2639b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2640b09e027eSCarola Kruse 
2641b09e027eSCarola Kruse   PetscFunctionBegin;
2642b09e027eSCarola Kruse   jac->gkbmaxit = maxit;
26433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2644b09e027eSCarola Kruse }
2645b09e027eSCarola Kruse 
2646b09e027eSCarola Kruse /*@
2647f1580f4eSBarry Smith     PCFieldSplitSetGKBDelay -  Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization in `PCFIELDSPLIT`
2648e071a0a4SCarola Kruse     preconditioner.
2649b09e027eSCarola Kruse 
2650c3339decSBarry Smith     Collective
2651b09e027eSCarola Kruse 
2652b09e027eSCarola Kruse     Input Parameters:
2653b09e027eSCarola Kruse +   pc     - the preconditioner context
2654b09e027eSCarola Kruse -   delay  - the delay window in the lower bound estimate
2655b09e027eSCarola Kruse 
2656f1580f4eSBarry Smith     Options Database Key:
2657b09e027eSCarola Kruse .   -pc_fieldsplit_gkb_delay - default is 5
2658b09e027eSCarola Kruse 
2659b09e027eSCarola Kruse     Level: intermediate
2660b09e027eSCarola Kruse 
2661f1580f4eSBarry Smith     Note:
2662f1580f4eSBarry 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
2663f1580f4eSBarry 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
2664f1580f4eSBarry Smith     at least (delay + 1) iterations to stop. For more details on the generalized Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to
2665f1580f4eSBarry Smith 
266660f59c3bSBarry Smith     References:
2667f1580f4eSBarry Smith     [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2668f1580f4eSBarry Smith 
266960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
2670b09e027eSCarola Kruse @*/
2671d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBDelay(PC pc, PetscInt delay)
2672d71ae5a4SJacob Faibussowitsch {
2673b09e027eSCarola Kruse   PetscFunctionBegin;
2674b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2675b09e027eSCarola Kruse   PetscValidLogicalCollectiveInt(pc, delay, 2);
2676cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBDelay_C", (PC, PetscInt), (pc, delay));
26773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2678b09e027eSCarola Kruse }
2679b09e027eSCarola Kruse 
2680d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc, PetscInt delay)
2681d71ae5a4SJacob Faibussowitsch {
2682b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2683b09e027eSCarola Kruse 
2684b09e027eSCarola Kruse   PetscFunctionBegin;
2685b09e027eSCarola Kruse   jac->gkbdelay = delay;
26863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2687b09e027eSCarola Kruse }
2688b09e027eSCarola Kruse 
2689b09e027eSCarola Kruse /*@
2690f1580f4eSBarry Smith     PCFieldSplitSetGKBNu -  Sets the scalar value nu >= 0 in the transformation H = A00 + nu*A01*A01' of the (1,1) block in the Golub-Kahan bidiagonalization preconditioner
2691f1580f4eSBarry Smith     in `PCFIELDSPLIT`
2692b09e027eSCarola Kruse 
2693c3339decSBarry Smith     Collective
2694f1580f4eSBarry Smith 
2695f1580f4eSBarry Smith     Input Parameters:
2696f1580f4eSBarry Smith +   pc     - the preconditioner context
2697f1580f4eSBarry Smith -   nu     - the shift parameter
2698f1580f4eSBarry Smith 
2699*20f4b53cSBarry Smith     Options Database Key:
2700f1580f4eSBarry Smith .   -pc_fieldsplit_gkb_nu - default is 1
2701f1580f4eSBarry Smith 
2702f1580f4eSBarry Smith     Level: intermediate
2703b09e027eSCarola Kruse 
2704b09e027eSCarola Kruse     Notes:
2705da81f932SPierre Jolivet     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 big. However,
2706da81f932SPierre Jolivet     if nu is chosen too big, the matrix H might be badly conditioned and the solution of the linear system Hx = b in the inner loop becomes difficult. It is therefore
2707b09e027eSCarola Kruse     necessary to find a good balance in between the convergence of the inner and outer loop.
2708b09e027eSCarola Kruse 
2709b09e027eSCarola Kruse     For nu = 0, no shift is done. In this case A00 has to be positive definite. The matrix N in [Ar13] is then chosen as identity.
2710b09e027eSCarola Kruse 
271160f59c3bSBarry Smith     References:
2712b09e027eSCarola Kruse     [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2713b09e027eSCarola Kruse 
271460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
2715b09e027eSCarola Kruse @*/
2716d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBNu(PC pc, PetscReal nu)
2717d71ae5a4SJacob Faibussowitsch {
2718b09e027eSCarola Kruse   PetscFunctionBegin;
2719b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2720de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, nu, 2);
2721cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBNu_C", (PC, PetscReal), (pc, nu));
27223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2723b09e027eSCarola Kruse }
2724b09e027eSCarola Kruse 
2725d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc, PetscReal nu)
2726d71ae5a4SJacob Faibussowitsch {
2727b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2728b09e027eSCarola Kruse 
2729b09e027eSCarola Kruse   PetscFunctionBegin;
2730b09e027eSCarola Kruse   jac->gkbnu = nu;
27313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2732b09e027eSCarola Kruse }
2733b09e027eSCarola Kruse 
2734d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc, PCCompositeType type)
2735d71ae5a4SJacob Faibussowitsch {
273679416396SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
273779416396SBarry Smith 
273879416396SBarry Smith   PetscFunctionBegin;
273979416396SBarry Smith   jac->type = type;
27402e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
27412e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
27422e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
27432e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
27442e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
27452e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
27462e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
27472e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
27482e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
2749e071a0a4SCarola Kruse 
27503b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
27513b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
27523b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
27532fa5cd67SKarl Rupp 
27549566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit_Schur));
27559566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", PCFieldSplitSetSchurPre_FieldSplit));
27569566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", PCFieldSplitGetSchurPre_FieldSplit));
27579566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", PCFieldSplitSetSchurFactType_FieldSplit));
27589566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", PCFieldSplitSetSchurScale_FieldSplit));
2759a51937d4SCarola Kruse   } else if (type == PC_COMPOSITE_GKB) {
2760a51937d4SCarola Kruse     pc->ops->apply = PCApply_FieldSplit_GKB;
2761a51937d4SCarola Kruse     pc->ops->view  = PCView_FieldSplit_GKB;
2762e69d4d44SBarry Smith 
27639566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
27649566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", PCFieldSplitSetGKBTol_FieldSplit));
27659566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", PCFieldSplitSetGKBMaxit_FieldSplit));
27669566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", PCFieldSplitSetGKBNu_FieldSplit));
27679566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", PCFieldSplitSetGKBDelay_FieldSplit));
27683b224e63SBarry Smith   } else {
27693b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
27703b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
27712fa5cd67SKarl Rupp 
27729566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
27733b224e63SBarry Smith   }
27743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
277579416396SBarry Smith }
277679416396SBarry Smith 
2777d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc, PetscInt bs)
2778d71ae5a4SJacob Faibussowitsch {
277951f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
278051f519a2SBarry Smith 
278151f519a2SBarry Smith   PetscFunctionBegin;
278263a3b9bcSJacob Faibussowitsch   PetscCheck(bs >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Blocksize must be positive, you gave %" PetscInt_FMT, bs);
27832472a847SBarry 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);
278451f519a2SBarry Smith   jac->bs = bs;
27853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
278651f519a2SBarry Smith }
278751f519a2SBarry Smith 
2788d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetCoordinates_FieldSplit(PC pc, PetscInt dim, PetscInt nloc, PetscReal coords[])
2789d71ae5a4SJacob Faibussowitsch {
27905ddf11f8SNicolas Barnafi   PC_FieldSplit    *jac           = (PC_FieldSplit *)pc->data;
27915ddf11f8SNicolas Barnafi   PC_FieldSplitLink ilink_current = jac->head;
27925ddf11f8SNicolas Barnafi   IS                is_owned;
27935ddf11f8SNicolas Barnafi 
27945ddf11f8SNicolas Barnafi   PetscFunctionBegin;
27955ddf11f8SNicolas Barnafi   jac->coordinates_set = PETSC_TRUE; // Internal flag
2796f3fa974cSJacob Faibussowitsch   PetscCall(MatGetOwnershipIS(pc->mat, &is_owned, NULL));
27975ddf11f8SNicolas Barnafi 
27985ddf11f8SNicolas Barnafi   while (ilink_current) {
27995ddf11f8SNicolas Barnafi     // For each IS, embed it to get local coords indces
28005ddf11f8SNicolas Barnafi     IS              is_coords;
28015ddf11f8SNicolas Barnafi     PetscInt        ndofs_block;
28025ddf11f8SNicolas Barnafi     const PetscInt *block_dofs_enumeration; // Numbering of the dofs relevant to the current block
28035ddf11f8SNicolas Barnafi 
28045ddf11f8SNicolas Barnafi     // Setting drop to true for safety. It should make no difference.
28059566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink_current->is, is_owned, PETSC_TRUE, &is_coords));
28069566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(is_coords, &ndofs_block));
28079566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(is_coords, &block_dofs_enumeration));
28085ddf11f8SNicolas Barnafi 
28095ddf11f8SNicolas Barnafi     // Allocate coordinates vector and set it directly
28109566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(ndofs_block * dim, &(ilink_current->coords)));
28115ddf11f8SNicolas Barnafi     for (PetscInt dof = 0; dof < ndofs_block; ++dof) {
2812ad540459SPierre Jolivet       for (PetscInt d = 0; d < dim; ++d) (ilink_current->coords)[dim * dof + d] = coords[dim * block_dofs_enumeration[dof] + d];
28135ddf11f8SNicolas Barnafi     }
28145ddf11f8SNicolas Barnafi     ilink_current->dim   = dim;
28155ddf11f8SNicolas Barnafi     ilink_current->ndofs = ndofs_block;
28169566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(is_coords, &block_dofs_enumeration));
28179566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is_coords));
28185ddf11f8SNicolas Barnafi     ilink_current = ilink_current->next;
28195ddf11f8SNicolas Barnafi   }
28209566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_owned));
28213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28225ddf11f8SNicolas Barnafi }
28235ddf11f8SNicolas Barnafi 
2824bc08b0f1SBarry Smith /*@
2825f1580f4eSBarry Smith    PCFieldSplitSetType - Sets the type, `PCCompositeType`, of a `PCFIELDSPLIT`
282679416396SBarry Smith 
2827c3339decSBarry Smith    Collective
282879416396SBarry Smith 
2829d8d19677SJose E. Roman    Input Parameters:
2830a2b725a8SWilliam Gropp +  pc - the preconditioner context
2831f1580f4eSBarry Smith -  type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
283279416396SBarry Smith 
283379416396SBarry Smith    Options Database Key:
2834a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
283579416396SBarry Smith 
2836b02e2d75SMatthew G Knepley    Level: Intermediate
283779416396SBarry Smith 
283860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCCompositeType`, `PCCompositeGetType()`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`,
2839f1580f4eSBarry Smith           `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
284079416396SBarry Smith @*/
2841d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetType(PC pc, PCCompositeType type)
2842d71ae5a4SJacob Faibussowitsch {
284379416396SBarry Smith   PetscFunctionBegin;
28440700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2845cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetType_C", (PC, PCCompositeType), (pc, type));
28463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
284779416396SBarry Smith }
284879416396SBarry Smith 
2849b02e2d75SMatthew G Knepley /*@
2850f1580f4eSBarry Smith   PCFieldSplitGetType - Gets the type, `PCCompositeType`, of a `PCFIELDSPLIT`
2851b02e2d75SMatthew G Knepley 
2852b02e2d75SMatthew G Knepley   Not collective
2853b02e2d75SMatthew G Knepley 
2854b02e2d75SMatthew G Knepley   Input Parameter:
2855b02e2d75SMatthew G Knepley . pc - the preconditioner context
2856b02e2d75SMatthew G Knepley 
2857b02e2d75SMatthew G Knepley   Output Parameter:
2858f1580f4eSBarry Smith . type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
2859b02e2d75SMatthew G Knepley 
2860b02e2d75SMatthew G Knepley   Level: Intermediate
2861b02e2d75SMatthew G Knepley 
286260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCompositeSetType()`, `PCFIELDSPLIT`, `PCCompositeType`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`,
2863f1580f4eSBarry Smith           `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
2864b02e2d75SMatthew G Knepley @*/
2865d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2866d71ae5a4SJacob Faibussowitsch {
2867b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2868b02e2d75SMatthew G Knepley 
2869b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2870b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2871b02e2d75SMatthew G Knepley   PetscValidIntPointer(type, 2);
2872b02e2d75SMatthew G Knepley   *type = jac->type;
28733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2874b02e2d75SMatthew G Knepley }
2875b02e2d75SMatthew G Knepley 
28764ab8060aSDmitry Karpeev /*@
2877f1580f4eSBarry Smith    PCFieldSplitSetDMSplits - Flags whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible.
28784ab8060aSDmitry Karpeev 
2879c3339decSBarry Smith    Logically Collective
28804ab8060aSDmitry Karpeev 
28814ab8060aSDmitry Karpeev    Input Parameters:
28824ab8060aSDmitry Karpeev +  pc   - the preconditioner context
2883f1580f4eSBarry Smith -  flg  - boolean indicating whether to use field splits defined by the `DM`
28844ab8060aSDmitry Karpeev 
28854ab8060aSDmitry Karpeev    Options Database Key:
2886f1580f4eSBarry Smith .  -pc_fieldsplit_dm_splits <bool> - use the field splits defined by the `DM`
28874ab8060aSDmitry Karpeev 
28884ab8060aSDmitry Karpeev    Level: Intermediate
28894ab8060aSDmitry Karpeev 
289060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDMSplits()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()`
28914ab8060aSDmitry Karpeev @*/
2892d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDMSplits(PC pc, PetscBool flg)
2893d71ae5a4SJacob Faibussowitsch {
28944ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
28954ab8060aSDmitry Karpeev   PetscBool      isfs;
28964ab8060aSDmitry Karpeev 
28974ab8060aSDmitry Karpeev   PetscFunctionBegin;
28984ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
28994ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc, flg, 2);
29009566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
2901ad540459SPierre Jolivet   if (isfs) jac->dm_splits = flg;
29023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
29034ab8060aSDmitry Karpeev }
29044ab8060aSDmitry Karpeev 
29054ab8060aSDmitry Karpeev /*@
2906f1580f4eSBarry Smith    PCFieldSplitGetDMSplits - Returns flag indicating whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible.
29074ab8060aSDmitry Karpeev 
29084ab8060aSDmitry Karpeev    Logically Collective
29094ab8060aSDmitry Karpeev 
29104ab8060aSDmitry Karpeev    Input Parameter:
29114ab8060aSDmitry Karpeev .  pc   - the preconditioner context
29124ab8060aSDmitry Karpeev 
29134ab8060aSDmitry Karpeev    Output Parameter:
2914f1580f4eSBarry Smith .  flg  - boolean indicating whether to use field splits defined by the `DM`
29154ab8060aSDmitry Karpeev 
29164ab8060aSDmitry Karpeev    Level: Intermediate
29174ab8060aSDmitry Karpeev 
291860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDMSplits()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()`
29194ab8060aSDmitry Karpeev @*/
2920d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDMSplits(PC pc, PetscBool *flg)
2921d71ae5a4SJacob Faibussowitsch {
29224ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
29234ab8060aSDmitry Karpeev   PetscBool      isfs;
29244ab8060aSDmitry Karpeev 
29254ab8060aSDmitry Karpeev   PetscFunctionBegin;
29264ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2927534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
29289566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
29294ab8060aSDmitry Karpeev   if (isfs) {
29304ab8060aSDmitry Karpeev     if (flg) *flg = jac->dm_splits;
29314ab8060aSDmitry Karpeev   }
29323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
29334ab8060aSDmitry Karpeev }
29344ab8060aSDmitry Karpeev 
29357b752e3dSPatrick Sanan /*@
2936f1580f4eSBarry Smith    PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries.
29377b752e3dSPatrick Sanan 
29387b752e3dSPatrick Sanan    Logically Collective
29397b752e3dSPatrick Sanan 
29407b752e3dSPatrick Sanan    Input Parameter:
29417b752e3dSPatrick Sanan .  pc   - the preconditioner context
29427b752e3dSPatrick Sanan 
29437b752e3dSPatrick Sanan    Output Parameter:
29447b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
29457b752e3dSPatrick Sanan 
29467b752e3dSPatrick Sanan    Level: Intermediate
29477b752e3dSPatrick Sanan 
294860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDetectSaddlePoint()`
29497b752e3dSPatrick Sanan @*/
2950d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc, PetscBool *flg)
2951d71ae5a4SJacob Faibussowitsch {
29527b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
29537b752e3dSPatrick Sanan 
29547b752e3dSPatrick Sanan   PetscFunctionBegin;
29557b752e3dSPatrick Sanan   *flg = jac->detect;
29563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
29577b752e3dSPatrick Sanan }
29587b752e3dSPatrick Sanan 
29597b752e3dSPatrick Sanan /*@
2960f1580f4eSBarry Smith    PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries.
29617b752e3dSPatrick Sanan 
29627b752e3dSPatrick Sanan    Logically Collective
29637b752e3dSPatrick Sanan 
29647b752e3dSPatrick Sanan    Input Parameter:
29657b752e3dSPatrick Sanan .  pc   - the preconditioner context
29667b752e3dSPatrick Sanan 
29677b752e3dSPatrick Sanan    Output Parameter:
29687b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
29697b752e3dSPatrick Sanan 
29707b752e3dSPatrick Sanan    Options Database Key:
2971147403d9SBarry Smith .  -pc_fieldsplit_detect_saddle_point <bool> - detect and use the saddle point
2972147403d9SBarry Smith 
297360f59c3bSBarry Smith    Level: Intermediate
297460f59c3bSBarry Smith 
2975f1580f4eSBarry Smith  Note:
2976f1580f4eSBarry 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()`).
29777b752e3dSPatrick Sanan 
297860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDetectSaddlePoint()`, `PCFieldSplitSetType()`, `PCFieldSplitSetSchurPre()`, `PC_FIELDSPLIT_SCHUR_PRE_SELF`
29797b752e3dSPatrick Sanan @*/
2980d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc, PetscBool flg)
2981d71ae5a4SJacob Faibussowitsch {
29827b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
29837b752e3dSPatrick Sanan 
29847b752e3dSPatrick Sanan   PetscFunctionBegin;
29857b752e3dSPatrick Sanan   jac->detect = flg;
29867b752e3dSPatrick Sanan   if (jac->detect) {
29879566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetType(pc, PC_COMPOSITE_SCHUR));
29889566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetSchurPre(pc, PC_FIELDSPLIT_SCHUR_PRE_SELF, NULL));
29897b752e3dSPatrick Sanan   }
29903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
29917b752e3dSPatrick Sanan }
29927b752e3dSPatrick Sanan 
29930971522cSBarry Smith /*MC
2994a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2995f1580f4eSBarry Smith    collections of variables (that may overlap) called splits. See [the users manual section on "Solving Block Matrices"](sec_block_matrices) for more details.
29960971522cSBarry Smith 
299779416396SBarry Smith    Options Database Keys:
2998de37d9f1SPatrick Sanan +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the `%d`'th split
299981540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
3000de37d9f1SPatrick Sanan                               been supplied explicitly by `-pc_fieldsplit_%d_fields`
300181540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
3002a51937d4SCarola Kruse .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting
3003de37d9f1SPatrick Sanan .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see `PCFieldSplitSetSchurPre()`
3004de37d9f1SPatrick Sanan .   -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - set factorization type when using `-pc_fieldsplit_type schur`; see `PCFieldSplitSetSchurFactType()`
3005fb6809a2SPatrick Sanan -   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
300679416396SBarry Smith 
3007de37d9f1SPatrick Sanan      Options prefixes for inner solvers when using the Schur complement preconditioner are `-fieldsplit_0_` and `-fieldsplit_1_` .
3008de37d9f1SPatrick Sanan      The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is `-fieldsplit_0_`
300960f59c3bSBarry Smith      For all other solvers they are `-fieldsplit_%d_` for the `%d`'th field; use `-fieldsplit_` for all fields.
301060f59c3bSBarry Smith 
301160f59c3bSBarry Smith      To set options on the solvers for each block append `-fieldsplit_` to all the `PC`
301260f59c3bSBarry Smith      options database keys. For example, `-fieldsplit_pc_type ilu` `-fieldsplit_pc_factor_levels 1`
301360f59c3bSBarry Smith 
301460f59c3bSBarry Smith      To set the options on the solvers separate for each block call `PCFieldSplitGetSubKSP()`
301560f59c3bSBarry Smith       and set the options directly on the resulting `KSP` object
301660f59c3bSBarry Smith 
301760f59c3bSBarry Smith     Level: intermediate
30185d4c12cdSJungho Lee 
3019c8a0d604SMatthew G Knepley    Notes:
3020f1580f4eSBarry Smith     Use `PCFieldSplitSetFields()` to set splits defined by "strided" entries and `PCFieldSplitSetIS()`
3021f1580f4eSBarry Smith      to define a split by an arbitrary collection of entries.
3022d32f9abdSBarry Smith 
3023f1580f4eSBarry Smith       If no splits are set the default is used. The splits are defined by entries strided by bs,
3024de37d9f1SPatrick Sanan       beginning at 0 then 1, etc to bs-1. The block size can be set with `PCFieldSplitSetBlockSize()`,
3025d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
3026de37d9f1SPatrick Sanan       to `KSPSetOperators()`/`PCSetOperators()`.
3027d32f9abdSBarry Smith 
3028de37d9f1SPatrick Sanan       For the Schur complement preconditioner if
30291d71051fSDmitry Karpeev 
3030de37d9f1SPatrick Sanan       ```{math}
3031de37d9f1SPatrick Sanan       J = \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{10} & A_{11} \end{array}\right]
3032de37d9f1SPatrick Sanan       ```
3033e69d4d44SBarry Smith 
3034de37d9f1SPatrick Sanan       the preconditioner using `full` factorization is logically
3035de37d9f1SPatrick Sanan       ```{math}
3036de37d9f1SPatrick Sanan       \left[\begin{array}{cc} I & -\text{ksp}(A_{00}) \\ 0 & I \end{array}\right] \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\ 0 & \text{ksp}(S) \end{array}\right] \left[\begin{array}{cc} I & 0 \\ -A_{10} \text{ksp}(A_{00}) & I \end{array}\right]
3037de37d9f1SPatrick Sanan       ```
3038de37d9f1SPatrick Sanan      where the action of $\text{inv}(A_{00})$ is applied using the KSP solver with prefix `-fieldsplit_0_`.  $S$ is the Schur complement
3039de37d9f1SPatrick Sanan      ```{math}
3040223e5b4fSPatrick Sanan      S = A_{11} - A_{10} \text{ksp}(A_{00}) A_{01}
3041de37d9f1SPatrick Sanan      ```
3042de37d9f1SPatrick 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
304360f59c3bSBarry Smith      in providing the SECOND split or 1 if not given). For `PCFieldSplitGetSubKSP()` when field number is 0,
3044de37d9f1SPatrick Sanan      it returns the KSP associated with `-fieldsplit_0_` while field number 1 gives `-fieldsplit_1_` KSP. By default
3045de37d9f1SPatrick Sanan      $A_{11}$ is used to construct a preconditioner for $S$, use `PCFieldSplitSetSchurPre()` for all the possible ways to construct the preconditioner for $S$.
3046de37d9f1SPatrick Sanan 
3047de37d9f1SPatrick Sanan      The factorization type is set using `-pc_fieldsplit_schur_fact_type <diag, lower, upper, full>`. `full` is shown above,
3048de37d9f1SPatrick Sanan      `diag` gives
3049de37d9f1SPatrick Sanan       ```{math}
3050de37d9f1SPatrick Sanan       \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\  0 & -\text{ksp}(S) \end{array}\right]
3051de37d9f1SPatrick Sanan       ```
3052de37d9f1SPatrick 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
3053de37d9f1SPatrick Sanan      can be turned off with `PCFieldSplitSetSchurScale()` or by command line `-pc_fieldsplit_schur_scale 1.0`. The `lower` factorization is the inverse of
3054de37d9f1SPatrick Sanan       ```{math}
3055de37d9f1SPatrick Sanan       \left[\begin{array}{cc} A_{00} & 0 \\  A_{10} & S \end{array}\right]
3056de37d9f1SPatrick Sanan       ```
3057de37d9f1SPatrick Sanan      where the inverses of A_{00} and S are applied using KSPs. The upper factorization is the inverse of
3058de37d9f1SPatrick Sanan       ```{math}
3059de37d9f1SPatrick Sanan       \left[\begin{array}{cc} A_{00} & A_{01} \\  0 & S \end{array}\right]
3060de37d9f1SPatrick Sanan       ```
3061de37d9f1SPatrick Sanan      where again the inverses of $A_{00}$ and $S$ are applied using `KSP`s.
3062de37d9f1SPatrick Sanan 
3063de37d9f1SPatrick Sanan      If only one set of indices (one `IS`) is provided with `PCFieldSplitSetIS()` then the complement of that `IS`
3064edf189efSBarry Smith      is used automatically for a second block.
3065edf189efSBarry Smith 
3066f1580f4eSBarry Smith      The fieldsplit preconditioner cannot currently be used with the `MATBAIJ` or `MATSBAIJ` data formats if the blocksize is larger than 1.
3067f1580f4eSBarry Smith      Generally it should be used with the `MATAIJ` format.
3068ff218e97SBarry Smith 
3069ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
3070f1580f4eSBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling {cite}`Wesseling2009`.
3071f1580f4eSBarry Smith      One can also use `PCFIELDSPLIT`
3072ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
30730716a85fSBarry Smith 
3074de37d9f1SPatrick Sanan      See "A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations" {cite}`elman2008tcp`.
3075a6a584a2SBarry Smith 
3076de37d9f1SPatrick Sanan      The Constrained Pressure Preconditioner (CPR) can be implemented using `PCCOMPOSITE` with `PCGALERKIN`. CPR first solves an $R A P$ subsystem, updates the
3077de37d9f1SPatrick Sanan      residual on all variables (`PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)`), and then applies a simple ILU like preconditioner on all the variables.
3078a51937d4SCarola Kruse 
3079de37d9f1SPatrick Sanan      The generalized Golub-Kahan bidiagonalization preconditioner (GKB) can be applied to symmetric $2 \times 2$ block matrices of the shape
3080de37d9f1SPatrick Sanan      ```{math}
3081de37d9f1SPatrick Sanan      \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{01}' & 0 \end{array}\right]
3082de37d9f1SPatrick Sanan      ```
3083de37d9f1SPatrick Sanan      with $A_{00}$ positive semi-definite. The implementation follows {cite}`Arioli2013`. Therein, we choose $N := 1/\nu * I$ and the $(1,1)$-block of the matrix is modified to $H = _{A00} + \nu*A_{01}*A_{01}'$.
3084de37d9f1SPatrick 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_`.
3085a51937d4SCarola Kruse 
308660f59c3bSBarry Smith    Developer Note:
308760f59c3bSBarry Smith    The Schur complement functionality of `PCFIELDSPLIT` should likely be factored into its own `PC` thus simplifying the implementation of the preconditioners and their
308860f59c3bSBarry Smith    user API.
3089f1580f4eSBarry Smith 
309060f59c3bSBarry Smith      References:
3091de37d9f1SPatrick Sanan      ```{bibliography}
3092de37d9f1SPatrick Sanan      :filter: docname in docnames
3093de37d9f1SPatrick Sanan      ```
3094de37d9f1SPatrick Sanan 
309560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCLSC`,
3096db781477SPatrick Sanan           `PCFieldSplitGetSubKSP()`, `PCFieldSplitSchurGetSubKSP()`, `PCFieldSplitSetFields()`,
3097db781477SPatrick Sanan           `PCFieldSplitSetType()`, `PCFieldSplitSetIS()`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitSetSchurFactType()`,
3098db781477SPatrick Sanan           `MatSchurComplementSetAinvType()`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetDetectSaddlePoint()`
30990971522cSBarry Smith M*/
31000971522cSBarry Smith 
3101d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
3102d71ae5a4SJacob Faibussowitsch {
31030971522cSBarry Smith   PC_FieldSplit *jac;
31040971522cSBarry Smith 
31050971522cSBarry Smith   PetscFunctionBegin;
31064dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&jac));
31072fa5cd67SKarl Rupp 
31080971522cSBarry Smith   jac->bs                 = -1;
31090971522cSBarry Smith   jac->nsplits            = 0;
31103e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
3111e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
3112c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
3113c096484dSStefano Zampini   jac->schurscale         = -1.0;
3114fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
31157b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
3116a51937d4SCarola Kruse   jac->gkbtol             = 1e-5;
3117a51937d4SCarola Kruse   jac->gkbdelay           = 5;
3118a51937d4SCarola Kruse   jac->gkbnu              = 1;
3119a51937d4SCarola Kruse   jac->gkbmaxit           = 100;
3120de482cd7SCarola Kruse   jac->gkbmonitor         = PETSC_FALSE;
31215ddf11f8SNicolas Barnafi   jac->coordinates_set    = PETSC_FALSE;
312251f519a2SBarry Smith 
31230971522cSBarry Smith   pc->data = (void *)jac;
31240971522cSBarry Smith 
31250971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
3126421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
31270971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
3128574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
31290971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
31300971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
31310971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
31320a545947SLisandro Dalcin   pc->ops->applyrichardson = NULL;
31330971522cSBarry Smith 
31349566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", PCFieldSplitSchurGetSubKSP_FieldSplit));
31359566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
31369566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", PCFieldSplitSetFields_FieldSplit));
31379566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", PCFieldSplitSetIS_FieldSplit));
31389566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", PCFieldSplitSetType_FieldSplit));
31399566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", PCFieldSplitSetBlockSize_FieldSplit));
31409566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", PCFieldSplitRestrictIS_FieldSplit));
31419566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", PCSetCoordinates_FieldSplit));
31423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
31430971522cSBarry Smith }
3144