xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 4849c82aea8bbb0f1c72cc370030898e85d96b88)
1af0996ceSBarry Smith #include <petsc/private/pcimpl.h>  /*I "petscpc.h" I*/
2a80b646eSBarry Smith #include <petsc/private/kspimpl.h> /*  This is needed to provide the appropriate PETSC_EXTERN for KSP_Solve_FS ....*/
31e25c274SJed Brown #include <petscdm.h>
40971522cSBarry Smith 
50a545947SLisandro Dalcin const char *const PCFieldSplitSchurPreTypes[]  = {"SELF", "SELFP", "A11", "USER", "FULL", "PCFieldSplitSchurPreType", "PC_FIELDSPLIT_SCHUR_PRE_", NULL};
60a545947SLisandro Dalcin const char *const PCFieldSplitSchurFactTypes[] = {"DIAG", "LOWER", "UPPER", "FULL", "PCFieldSplitSchurFactType", "PC_FIELDSPLIT_SCHUR_FACT_", NULL};
7c5d2311dSJed Brown 
89df09d43SBarry Smith PetscLogEvent KSP_Solve_FS_0, KSP_Solve_FS_1, KSP_Solve_FS_S, KSP_Solve_FS_U, KSP_Solve_FS_L, KSP_Solve_FS_2, KSP_Solve_FS_3, KSP_Solve_FS_4;
99df09d43SBarry Smith 
100971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
110971522cSBarry Smith struct _PC_FieldSplitLink {
1269a612a9SBarry Smith   KSP               ksp;
13443836d0SMatthew G Knepley   Vec               x, y, z;
14db4c96c1SJed Brown   char             *splitname;
150971522cSBarry Smith   PetscInt          nfields;
165d4c12cdSJungho Lee   PetscInt         *fields, *fields_col;
171b9fc7fcSBarry Smith   VecScatter        sctx;
18f5f0d762SBarry Smith   IS                is, is_col;
1951f519a2SBarry Smith   PC_FieldSplitLink next, previous;
209df09d43SBarry Smith   PetscLogEvent     event;
215ddf11f8SNicolas Barnafi 
225ddf11f8SNicolas Barnafi   /* Used only when setting coordinates with PCSetCoordinates */
235ddf11f8SNicolas Barnafi   PetscInt   dim;
245ddf11f8SNicolas Barnafi   PetscInt   ndofs;
255ddf11f8SNicolas Barnafi   PetscReal *coords;
260971522cSBarry Smith };
270971522cSBarry Smith 
280971522cSBarry Smith typedef struct {
2968dd23aaSBarry Smith   PCCompositeType type;
30ace3abfcSBarry Smith   PetscBool       defaultsplit; /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
31ace3abfcSBarry Smith   PetscBool       splitdefined; /* Flag is set after the splits have been defined, to prevent more splits from being added */
3230ad9308SMatthew Knepley   PetscInt        bs;           /* Block size for IS and Mat structures */
3330ad9308SMatthew Knepley   PetscInt        nsplits;      /* Number of field divisions defined */
3479416396SBarry Smith   Vec            *x, *y, w1, w2;
35519d70e2SJed Brown   Mat            *mat;    /* The diagonal block for each split */
36519d70e2SJed Brown   Mat            *pmat;   /* The preconditioning diagonal block for each split */
3730ad9308SMatthew Knepley   Mat            *Afield; /* The rows of the matrix associated with each split */
38ace3abfcSBarry Smith   PetscBool       issetup;
392fa5cd67SKarl Rupp 
4030ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
4130ad9308SMatthew Knepley   Mat                       B;          /* The (0,1) block */
4230ad9308SMatthew Knepley   Mat                       C;          /* The (1,0) block */
43443836d0SMatthew G Knepley   Mat                       schur;      /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
44a7476a74SDmitry Karpeev   Mat                       schurp;     /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
45084e4875SJed Brown   Mat                       schur_user; /* User-provided preconditioning matrix for the Schur complement */
46084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;   /* Determines which preconditioning matrix is used for the Schur complement */
47c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4830ad9308SMatthew Knepley   KSP                       kspschur;   /* The solver for S */
49443836d0SMatthew G Knepley   KSP                       kspupper;   /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
50c096484dSStefano Zampini   PetscScalar               schurscale; /* Scaling factor for the Schur complement solution with DIAG factorization */
51c096484dSStefano Zampini 
52a51937d4SCarola Kruse   /* Only used when Golub-Kahan bidiagonalization preconditioning is used */
53a51937d4SCarola Kruse   Mat          H;           /* The modified matrix H = A00 + nu*A01*A01'              */
54a51937d4SCarola Kruse   PetscReal    gkbtol;      /* Stopping tolerance for lower bound estimate            */
55a51937d4SCarola Kruse   PetscInt     gkbdelay;    /* The delay window for the stopping criterion            */
56a51937d4SCarola Kruse   PetscReal    gkbnu;       /* Parameter for augmented Lagrangian H = A + nu*A01*A01' */
57a51937d4SCarola Kruse   PetscInt     gkbmaxit;    /* Maximum number of iterations for outer loop            */
58de482cd7SCarola Kruse   PetscBool    gkbmonitor;  /* Monitor for gkb iterations and the lower bound error   */
59de482cd7SCarola Kruse   PetscViewer  gkbviewer;   /* Viewer context for gkbmonitor                          */
60e071a0a4SCarola Kruse   Vec          u, v, d, Hu; /* Work vectors for the GKB algorithm                     */
61e071a0a4SCarola Kruse   PetscScalar *vecz;        /* Contains intermediate values, eg for lower bound       */
62a51937d4SCarola Kruse 
6397bbdb24SBarry Smith   PC_FieldSplitLink head;
646dbb499eSCian Wilson   PetscBool         isrestrict;       /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */
65c1570756SJed Brown   PetscBool         suboptionsset;    /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
664ab8060aSDmitry Karpeev   PetscBool         dm_splits;        /* Whether to use DMCreateFieldDecomposition() whenever possible */
67c84da90fSDmitry Karpeev   PetscBool         diag_use_amat;    /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
68c84da90fSDmitry Karpeev   PetscBool         offdiag_use_amat; /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
697b752e3dSPatrick Sanan   PetscBool         detect;           /* Whether to form 2-way split by finding zero diagonal entries */
705ddf11f8SNicolas Barnafi   PetscBool         coordinates_set;  /* Whether PCSetCoordinates has been called */
710971522cSBarry Smith } PC_FieldSplit;
720971522cSBarry Smith 
7316913363SBarry Smith /*
74f1580f4eSBarry Smith     Note:
7595452b02SPatrick Sanan     there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
7616913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
7716913363SBarry Smith    PC you could change this.
7816913363SBarry Smith */
79084e4875SJed Brown 
80e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
81084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
82d71ae5a4SJacob Faibussowitsch static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
83d71ae5a4SJacob Faibussowitsch {
84084e4875SJed Brown   switch (jac->schurpre) {
85d71ae5a4SJacob Faibussowitsch   case PC_FIELDSPLIT_SCHUR_PRE_SELF:
86d71ae5a4SJacob Faibussowitsch     return jac->schur;
87d71ae5a4SJacob Faibussowitsch   case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
88d71ae5a4SJacob Faibussowitsch     return jac->schurp;
89d71ae5a4SJacob Faibussowitsch   case PC_FIELDSPLIT_SCHUR_PRE_A11:
90d71ae5a4SJacob Faibussowitsch     return jac->pmat[1];
91e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
92084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
93d71ae5a4SJacob Faibussowitsch   default:
94d71ae5a4SJacob Faibussowitsch     return jac->schur_user ? jac->schur_user : jac->pmat[1];
95084e4875SJed Brown   }
96084e4875SJed Brown }
97084e4875SJed Brown 
989804daf3SBarry Smith #include <petscdraw.h>
99d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit(PC pc, PetscViewer viewer)
100d71ae5a4SJacob Faibussowitsch {
1010971522cSBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
102d9884438SBarry Smith   PetscBool         iascii, isdraw;
1030971522cSBarry Smith   PetscInt          i, j;
1045a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
1050971522cSBarry Smith 
1060971522cSBarry Smith   PetscFunctionBegin;
1079566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
1089566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
1090971522cSBarry Smith   if (iascii) {
1102c9966d7SBarry Smith     if (jac->bs > 0) {
11163a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs));
1122c9966d7SBarry Smith     } else {
11363a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits));
1142c9966d7SBarry Smith     }
11548a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
11648a46eb9SPierre Jolivet     if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for diagonal blocks\n"));
11748a46eb9SPierre Jolivet     if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for off-diagonal blocks\n"));
1189566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Solver info for each split is in the following KSP objects:\n"));
1190971522cSBarry Smith     for (i = 0; i < jac->nsplits; i++) {
1201ab39975SBarry Smith       if (ilink->fields) {
12163a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i));
1229566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
1235a9f2f41SSatish Balay         for (j = 0; j < ilink->nfields; j++) {
12448a46eb9SPierre Jolivet           if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
12563a3b9bcSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
1260971522cSBarry Smith         }
1279566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
1289566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
1291ab39975SBarry Smith       } else {
13063a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i));
1311ab39975SBarry Smith       }
1329566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
1335a9f2f41SSatish Balay       ilink = ilink->next;
1340971522cSBarry Smith     }
1352fa5cd67SKarl Rupp   }
1362fa5cd67SKarl Rupp 
1372fa5cd67SKarl Rupp   if (isdraw) {
138d9884438SBarry Smith     PetscDraw draw;
139d9884438SBarry Smith     PetscReal x, y, w, wd;
140d9884438SBarry Smith 
1419566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
1429566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
143d9884438SBarry Smith     w  = 2 * PetscMin(1.0 - x, x);
144d9884438SBarry Smith     wd = w / (jac->nsplits + 1);
145d9884438SBarry Smith     x  = x - wd * (jac->nsplits - 1) / 2.0;
146d9884438SBarry Smith     for (i = 0; i < jac->nsplits; i++) {
1479566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
1489566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
1499566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
150d9884438SBarry Smith       x += wd;
151d9884438SBarry Smith       ilink = ilink->next;
152d9884438SBarry Smith     }
1530971522cSBarry Smith   }
1543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1550971522cSBarry Smith }
1560971522cSBarry Smith 
157d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_Schur(PC pc, PetscViewer viewer)
158d71ae5a4SJacob Faibussowitsch {
1593b224e63SBarry Smith   PC_FieldSplit             *jac = (PC_FieldSplit *)pc->data;
1604996c5bdSBarry Smith   PetscBool                  iascii, isdraw;
1613b224e63SBarry Smith   PetscInt                   i, j;
1623b224e63SBarry Smith   PC_FieldSplitLink          ilink = jac->head;
163a9908d51SBarry Smith   MatSchurComplementAinvType atype;
1643b224e63SBarry Smith 
1653b224e63SBarry Smith   PetscFunctionBegin;
1669566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
1679566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
1683b224e63SBarry Smith   if (iascii) {
1692c9966d7SBarry Smith     if (jac->bs > 0) {
17063a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with Schur preconditioner, blocksize = %" PetscInt_FMT ", factorization %s\n", jac->bs, PCFieldSplitSchurFactTypes[jac->schurfactorization]));
1712c9966d7SBarry Smith     } else {
1729566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with Schur preconditioner, factorization %s\n", PCFieldSplitSchurFactTypes[jac->schurfactorization]));
1732c9966d7SBarry Smith     }
17448a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
1753e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
176d71ae5a4SJacob Faibussowitsch     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
177d71ae5a4SJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from S itself\n"));
178d71ae5a4SJacob Faibussowitsch       break;
179a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
1807cf5f706SPierre Jolivet       if (jac->schur) {
1819566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetAinvType(jac->schur, &atype));
1829371c9d4SSatish Balay         PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses A00's %sinverse\n", atype == MAT_SCHUR_COMPLEMENT_AINV_DIAG ? "diagonal's " : (atype == MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG ? "block diagonal's " : (atype == MAT_SCHUR_COMPLEMENT_AINV_FULL ? "full " : "lumped diagonal's "))));
1837cf5f706SPierre Jolivet       }
184a9908d51SBarry Smith       break;
185d71ae5a4SJacob Faibussowitsch     case PC_FIELDSPLIT_SCHUR_PRE_A11:
186d71ae5a4SJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from A11\n"));
187d71ae5a4SJacob Faibussowitsch       break;
188d71ae5a4SJacob Faibussowitsch     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
189d71ae5a4SJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from the exact Schur complement\n"));
190d71ae5a4SJacob Faibussowitsch       break;
1913e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1923e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1939566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from user provided matrix\n"));
1943e8b8b31SMatthew G Knepley       } else {
1959566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from A11\n"));
1963e8b8b31SMatthew G Knepley       }
1973e8b8b31SMatthew G Knepley       break;
198d71ae5a4SJacob Faibussowitsch     default:
199d71ae5a4SJacob Faibussowitsch       SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
2003e8b8b31SMatthew G Knepley     }
2019566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Split info:\n"));
2029566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
2033b224e63SBarry Smith     for (i = 0; i < jac->nsplits; i++) {
2043b224e63SBarry Smith       if (ilink->fields) {
20563a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i));
2069566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
2073b224e63SBarry Smith         for (j = 0; j < ilink->nfields; j++) {
20848a46eb9SPierre Jolivet           if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
20963a3b9bcSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
2103b224e63SBarry Smith         }
2119566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
2129566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
2133b224e63SBarry Smith       } else {
21463a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i));
2153b224e63SBarry Smith       }
2163b224e63SBarry Smith       ilink = ilink->next;
2173b224e63SBarry Smith     }
2189566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for A00 block\n"));
2199566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
22006de4afeSJed Brown     if (jac->head) {
2219566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->head->ksp, viewer));
2229566063dSJacob Faibussowitsch     } else PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
2239566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
22406de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
2259566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for upper A00 in upper triangular factor\n"));
2269566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPushTab(viewer));
2279566063dSJacob Faibussowitsch       if (jac->kspupper) PetscCall(KSPView(jac->kspupper, viewer));
2289566063dSJacob Faibussowitsch       else PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
2299566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPopTab(viewer));
230443836d0SMatthew G Knepley     }
2319566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for S = A11 - A10 inv(A00) A01\n"));
2329566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
23312cae6f2SJed Brown     if (jac->kspschur) {
2349566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->kspschur, viewer));
23512cae6f2SJed Brown     } else {
2369566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
23712cae6f2SJed Brown     }
2389566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
2399566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
24006de4afeSJed Brown   } else if (isdraw && jac->head) {
2414996c5bdSBarry Smith     PetscDraw draw;
2424996c5bdSBarry Smith     PetscReal x, y, w, wd, h;
2434996c5bdSBarry Smith     PetscInt  cnt = 2;
2444996c5bdSBarry Smith     char      str[32];
2454996c5bdSBarry Smith 
2469566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
2479566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
248c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
249c74581afSBarry Smith     w  = 2 * PetscMin(1.0 - x, x);
250c74581afSBarry Smith     wd = w / (cnt + 1);
251c74581afSBarry Smith 
2529566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(str, 32, "Schur fact. %s", PCFieldSplitSchurFactTypes[jac->schurfactorization]));
2539566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h));
2544996c5bdSBarry Smith     y -= h;
2554996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) {
2569566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]));
2573b224e63SBarry Smith     } else {
2589566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[jac->schurpre]));
2594996c5bdSBarry Smith     }
2609566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x + wd * (cnt - 1) / 2.0, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h));
2614996c5bdSBarry Smith     y -= h;
2624996c5bdSBarry Smith     x = x - wd * (cnt - 1) / 2.0;
2634996c5bdSBarry Smith 
2649566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2659566063dSJacob Faibussowitsch     PetscCall(KSPView(jac->head->ksp, viewer));
2669566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
2674996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2684996c5bdSBarry Smith       x += wd;
2699566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2709566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->kspupper, viewer));
2719566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
2724996c5bdSBarry Smith     }
2734996c5bdSBarry Smith     x += wd;
2749566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2759566063dSJacob Faibussowitsch     PetscCall(KSPView(jac->kspschur, viewer));
2769566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
2773b224e63SBarry Smith   }
2783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2793b224e63SBarry Smith }
2803b224e63SBarry Smith 
281d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_GKB(PC pc, PetscViewer viewer)
282d71ae5a4SJacob Faibussowitsch {
283a51937d4SCarola Kruse   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
284a51937d4SCarola Kruse   PetscBool         iascii, isdraw;
285a51937d4SCarola Kruse   PetscInt          i, j;
286a51937d4SCarola Kruse   PC_FieldSplitLink ilink = jac->head;
287a51937d4SCarola Kruse 
288a51937d4SCarola Kruse   PetscFunctionBegin;
2899566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
2909566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
291a51937d4SCarola Kruse   if (iascii) {
292a51937d4SCarola Kruse     if (jac->bs > 0) {
29363a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs));
294a51937d4SCarola Kruse     } else {
29563a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits));
296a51937d4SCarola Kruse     }
29748a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
29848a46eb9SPierre Jolivet     if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for diagonal blocks\n"));
29948a46eb9SPierre Jolivet     if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for off-diagonal blocks\n"));
300a51937d4SCarola Kruse 
30163a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Stopping tolerance=%.1e, delay in error estimate=%" PetscInt_FMT ", maximum iterations=%" PetscInt_FMT "\n", (double)jac->gkbtol, jac->gkbdelay, jac->gkbmaxit));
3029566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Solver info for H = A00 + nu*A01*A01' matrix:\n"));
3039566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
304a51937d4SCarola Kruse 
305a51937d4SCarola Kruse     if (ilink->fields) {
30663a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Fields "));
3079566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
308a51937d4SCarola Kruse       for (j = 0; j < ilink->nfields; j++) {
30948a46eb9SPierre Jolivet         if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
31063a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
311a51937d4SCarola Kruse       }
3129566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
3139566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
314a51937d4SCarola Kruse     } else {
31563a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Defined by IS\n"));
316a51937d4SCarola Kruse     }
3179566063dSJacob Faibussowitsch     PetscCall(KSPView(ilink->ksp, viewer));
318a51937d4SCarola Kruse 
3199566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
320a51937d4SCarola Kruse   }
321a51937d4SCarola Kruse 
322a51937d4SCarola Kruse   if (isdraw) {
323a51937d4SCarola Kruse     PetscDraw draw;
324a51937d4SCarola Kruse     PetscReal x, y, w, wd;
325a51937d4SCarola Kruse 
3269566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
3279566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
328a51937d4SCarola Kruse     w  = 2 * PetscMin(1.0 - x, x);
329a51937d4SCarola Kruse     wd = w / (jac->nsplits + 1);
330a51937d4SCarola Kruse     x  = x - wd * (jac->nsplits - 1) / 2.0;
331a51937d4SCarola Kruse     for (i = 0; i < jac->nsplits; i++) {
3329566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
3339566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
3349566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
335a51937d4SCarola Kruse       x += wd;
336a51937d4SCarola Kruse       ilink = ilink->next;
337a51937d4SCarola Kruse     }
338a51937d4SCarola Kruse   }
3393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
340a51937d4SCarola Kruse }
341a51937d4SCarola Kruse 
3426c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
343d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
344d71ae5a4SJacob Faibussowitsch {
3456c924f48SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
3465d4c12cdSJungho Lee   PetscInt       i, nfields, *ifields, nfields_col, *ifields_col;
3475d4c12cdSJungho Lee   PetscBool      flg, flg_col;
3485d4c12cdSJungho Lee   char           optionname[128], splitname[8], optionname_col[128];
3496c924f48SJed Brown 
3506c924f48SJed Brown   PetscFunctionBegin;
3519566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->bs, &ifields));
3529566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->bs, &ifields_col));
3536c924f48SJed Brown   for (i = 0, flg = PETSC_TRUE;; i++) {
35463a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
35563a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
35663a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname_col, sizeof(optionname_col), "-pc_fieldsplit_%" PetscInt_FMT "_fields_col", i));
3576c924f48SJed Brown     nfields     = jac->bs;
35829499fbbSJungho Lee     nfields_col = jac->bs;
3599566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
3609566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname_col, ifields_col, &nfields_col, &flg_col));
3616c924f48SJed Brown     if (!flg) break;
3625d4c12cdSJungho Lee     else if (flg && !flg_col) {
36328b400f6SJacob Faibussowitsch       PetscCheck(nfields, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
3649566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields));
3652fa5cd67SKarl Rupp     } else {
3667827d75bSBarry Smith       PetscCheck(nfields && nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
36708401ef6SPierre Jolivet       PetscCheck(nfields == nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Number of row and column fields must match");
3689566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields_col));
3695d4c12cdSJungho Lee     }
3706c924f48SJed Brown   }
3716c924f48SJed Brown   if (i > 0) {
3726c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3736c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3746c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3756c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3766c924f48SJed Brown   }
3779566063dSJacob Faibussowitsch   PetscCall(PetscFree(ifields));
3789566063dSJacob Faibussowitsch   PetscCall(PetscFree(ifields_col));
3793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3806c924f48SJed Brown }
3816c924f48SJed Brown 
382d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
383d71ae5a4SJacob Faibussowitsch {
3840971522cSBarry Smith   PC_FieldSplit    *jac                = (PC_FieldSplit *)pc->data;
3855a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3867b752e3dSPatrick Sanan   PetscBool         fieldsplit_default = PETSC_FALSE, coupling = PETSC_FALSE;
3876c924f48SJed Brown   PetscInt          i;
3880971522cSBarry Smith 
3890971522cSBarry Smith   PetscFunctionBegin;
3907287d2a3SDmitry Karpeev   /*
391f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
3927287d2a3SDmitry Karpeev    Should probably be rewritten.
3937287d2a3SDmitry Karpeev    */
394f5f0d762SBarry Smith   if (!ilink) {
3959566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_detect_coupling", &coupling, NULL));
3967b752e3dSPatrick Sanan     if (pc->dm && jac->dm_splits && !jac->detect && !coupling) {
397bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3980784a22cSJed Brown       char    **fieldNames;
3997b62db95SJungho Lee       IS       *fields;
400e7c4fc90SDmitry Karpeev       DM       *dms;
401bafc1b83SMatthew G Knepley       DM        subdm[128];
402bafc1b83SMatthew G Knepley       PetscBool flg;
403bafc1b83SMatthew G Knepley 
4049566063dSJacob Faibussowitsch       PetscCall(DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms));
405bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
406bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
407bafc1b83SMatthew G Knepley         PetscInt ifields[128];
408bafc1b83SMatthew G Knepley         IS       compField;
409bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
410bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
411bafc1b83SMatthew G Knepley 
41263a3b9bcSJacob Faibussowitsch         PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
4139566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
414bafc1b83SMatthew G Knepley         if (!flg) break;
41563a3b9bcSJacob Faibussowitsch         PetscCheck(numFields <= 128, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot currently support %" PetscInt_FMT " > 128 fields", numFields);
4169566063dSJacob Faibussowitsch         PetscCall(DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]));
417bafc1b83SMatthew G Knepley         if (nfields == 1) {
4189566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField));
419bafc1b83SMatthew G Knepley         } else {
42063a3b9bcSJacob Faibussowitsch           PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
4219566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, splitname, compField));
4227287d2a3SDmitry Karpeev         }
4239566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&compField));
424bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
425bafc1b83SMatthew G Knepley           f = ifields[j];
4269566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4279566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
4287b62db95SJungho Lee         }
429bafc1b83SMatthew G Knepley       }
430bafc1b83SMatthew G Knepley       if (i == 0) {
431bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
4329566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[f], fields[f]));
4339566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4349566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
435bafc1b83SMatthew G Knepley         }
436bafc1b83SMatthew G Knepley       } else {
43748a46eb9SPierre Jolivet         for (j = 0; j < numFields; j++) PetscCall(DMDestroy(dms + j));
4389566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4399566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(i, &dms));
4402fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
441bafc1b83SMatthew G Knepley       }
4429566063dSJacob Faibussowitsch       PetscCall(PetscFree(fieldNames));
4439566063dSJacob Faibussowitsch       PetscCall(PetscFree(fields));
444e7c4fc90SDmitry Karpeev       if (dms) {
4459566063dSJacob Faibussowitsch         PetscCall(PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n"));
446bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
4477287d2a3SDmitry Karpeev           const char *prefix;
4489566063dSJacob Faibussowitsch           PetscCall(PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp), &prefix));
4499566063dSJacob Faibussowitsch           PetscCall(PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix));
4509566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(ilink->ksp, dms[i]));
4519566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(ilink->ksp, PETSC_FALSE));
45295dbaa6fSMatthew G. Knepley           {
45395dbaa6fSMatthew G. Knepley             PetscErrorCode (*func)(KSP, Mat, Mat, void *);
45495dbaa6fSMatthew G. Knepley             void *ctx;
45595dbaa6fSMatthew G. Knepley 
4569566063dSJacob Faibussowitsch             PetscCall(DMKSPGetComputeOperators(pc->dm, &func, &ctx));
4579566063dSJacob Faibussowitsch             PetscCall(DMKSPSetComputeOperators(dms[i], func, ctx));
45895dbaa6fSMatthew G. Knepley           }
4599566063dSJacob Faibussowitsch           PetscCall(PetscObjectIncrementTabLevel((PetscObject)dms[i], (PetscObject)ilink->ksp, 0));
4609566063dSJacob Faibussowitsch           PetscCall(DMDestroy(&dms[i]));
4612fa5ba8aSJed Brown         }
4629566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4638b8307b2SJed Brown       }
46466ffff09SJed Brown     } else {
465521d7252SBarry Smith       if (jac->bs <= 0) {
466704ba839SBarry Smith         if (pc->pmat) {
4679566063dSJacob Faibussowitsch           PetscCall(MatGetBlockSize(pc->pmat, &jac->bs));
4682fa5cd67SKarl Rupp         } else jac->bs = 1;
469521d7252SBarry Smith       }
470d32f9abdSBarry Smith 
4717b752e3dSPatrick Sanan       if (jac->detect) {
4726ce1633cSBarry Smith         IS       zerodiags, rest;
4736ce1633cSBarry Smith         PetscInt nmin, nmax;
4746ce1633cSBarry Smith 
4759566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4767199da05SBarry Smith         if (jac->diag_use_amat) {
4779566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->mat, &zerodiags));
4787199da05SBarry Smith         } else {
4799566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->pmat, &zerodiags));
4807199da05SBarry Smith         }
4819566063dSJacob Faibussowitsch         PetscCall(ISComplement(zerodiags, nmin, nmax, &rest));
4829566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
4839566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", zerodiags));
4849566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&zerodiags));
4859566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
4863a062f41SBarry Smith       } else if (coupling) {
4873a062f41SBarry Smith         IS       coupling, rest;
4883a062f41SBarry Smith         PetscInt nmin, nmax;
4893a062f41SBarry Smith 
4909566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4917199da05SBarry Smith         if (jac->offdiag_use_amat) {
4929566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->mat, &coupling));
4937199da05SBarry Smith         } else {
4949566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->pmat, &coupling));
4957199da05SBarry Smith         }
4969566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc->mat), nmax - nmin, nmin, 1, &rest));
4979566063dSJacob Faibussowitsch         PetscCall(ISSetIdentity(rest));
4989566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
4999566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", coupling));
5009566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&coupling));
5019566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
5026ce1633cSBarry Smith       } else {
5039566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_default", &fieldsplit_default, NULL));
5047287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
505d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
506d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
5079566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
5089566063dSJacob Faibussowitsch           if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
509d32f9abdSBarry Smith         }
5106dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
5119f001fe8SStefano Zampini           Mat       M = pc->pmat;
512f3b928b9SStefano Zampini           PetscBool isnest;
513f3b928b9SStefano Zampini 
5149566063dSJacob Faibussowitsch           PetscCall(PetscInfo(pc, "Using default splitting of fields\n"));
5159566063dSJacob Faibussowitsch           PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &isnest));
516f3b928b9SStefano Zampini           if (!isnest) {
5179f001fe8SStefano Zampini             M = pc->mat;
5189566063dSJacob Faibussowitsch             PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &isnest));
519f3b928b9SStefano Zampini           }
520f3b928b9SStefano Zampini           if (isnest) {
521f3b928b9SStefano Zampini             IS      *fields;
522f3b928b9SStefano Zampini             PetscInt nf;
523f3b928b9SStefano Zampini 
5249566063dSJacob Faibussowitsch             PetscCall(MatNestGetSize(M, &nf, NULL));
5259566063dSJacob Faibussowitsch             PetscCall(PetscMalloc1(nf, &fields));
5269566063dSJacob Faibussowitsch             PetscCall(MatNestGetISs(M, fields, NULL));
52748a46eb9SPierre Jolivet             for (i = 0; i < nf; i++) PetscCall(PCFieldSplitSetIS(pc, NULL, fields[i]));
5289566063dSJacob Faibussowitsch             PetscCall(PetscFree(fields));
529f3b928b9SStefano Zampini           } else {
530db4c96c1SJed Brown             for (i = 0; i < jac->bs; i++) {
5316c924f48SJed Brown               char splitname[8];
53263a3b9bcSJacob Faibussowitsch               PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
5339566063dSJacob Faibussowitsch               PetscCall(PCFieldSplitSetFields(pc, splitname, 1, &i, &i));
53479416396SBarry Smith             }
5355d4c12cdSJungho Lee             jac->defaultsplit = PETSC_TRUE;
536521d7252SBarry Smith           }
53766ffff09SJed Brown         }
5386ce1633cSBarry Smith       }
539f3b928b9SStefano Zampini     }
540edf189efSBarry Smith   } else if (jac->nsplits == 1) {
541edf189efSBarry Smith     IS       is2;
542edf189efSBarry Smith     PetscInt nmin, nmax;
543edf189efSBarry Smith 
5440fdf79fbSJacob Faibussowitsch     PetscCheck(ilink->is, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Must provide at least two sets of fields to PCFieldSplit()");
5459566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
5469566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is, nmin, nmax, &is2));
5479566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetIS(pc, "1", is2));
5489566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is2));
549edf189efSBarry Smith   }
550d0af7cd3SBarry Smith 
55163a3b9bcSJacob Faibussowitsch   PetscCheck(jac->nsplits >= 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unhandled case, must have at least two fields, not %" PetscInt_FMT, jac->nsplits);
5523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
55369a612a9SBarry Smith }
55469a612a9SBarry Smith 
555d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A, Mat B, Mat C, Mat *H, PetscReal gkbnu)
556d71ae5a4SJacob Faibussowitsch {
557a51937d4SCarola Kruse   Mat       BT, T;
558de482cd7SCarola Kruse   PetscReal nrmT, nrmB;
559a51937d4SCarola Kruse 
560a51937d4SCarola Kruse   PetscFunctionBegin;
5619566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &T)); /* Test if augmented matrix is symmetric */
5629566063dSJacob Faibussowitsch   PetscCall(MatAXPY(T, -1.0, B, DIFFERENT_NONZERO_PATTERN));
5639566063dSJacob Faibussowitsch   PetscCall(MatNorm(T, NORM_1, &nrmT));
5649566063dSJacob Faibussowitsch   PetscCall(MatNorm(B, NORM_1, &nrmB));
565049d1499SBarry Smith   PetscCheck(nrmB <= 0 || nrmT / nrmB < PETSC_SMALL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix is not symmetric/hermitian, GKB is not applicable.");
566049d1499SBarry Smith 
567a51937d4SCarola Kruse   /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */
568a51937d4SCarola Kruse   /* setting N := 1/nu*I in [Ar13].                                                 */
5699566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(B, MAT_INITIAL_MATRIX, &BT));
5709566063dSJacob Faibussowitsch   PetscCall(MatMatMult(B, BT, MAT_INITIAL_MATRIX, PETSC_DEFAULT, H)); /* H = A01*A01'          */
5719566063dSJacob Faibussowitsch   PetscCall(MatAYPX(*H, gkbnu, A, DIFFERENT_NONZERO_PATTERN));        /* H = A00 + nu*A01*A01' */
572a51937d4SCarola Kruse 
5739566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&BT));
5749566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&T));
5753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
576a51937d4SCarola Kruse }
577a51937d4SCarola Kruse 
57854a546c1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions, const char pre[], const char name[], const char *option[], const char *value[], PetscBool *flg);
579514bf10dSMatthew G Knepley 
580d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_FieldSplit(PC pc)
581d71ae5a4SJacob Faibussowitsch {
58269a612a9SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
5835a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
5842c9966d7SBarry Smith   PetscInt          i, nsplit;
5855f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
58669a612a9SBarry Smith 
58769a612a9SBarry Smith   PetscFunctionBegin;
5885da88fe4STristan Konolige   pc->failedreason = PC_NOERROR;
5899566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDefaults(pc));
59097bbdb24SBarry Smith   nsplit = jac->nsplits;
5915a9f2f41SSatish Balay   ilink  = jac->head;
59297bbdb24SBarry Smith 
59397bbdb24SBarry Smith   /* get the matrices for each split */
594704ba839SBarry Smith   if (!jac->issetup) {
5951b9fc7fcSBarry Smith     PetscInt rstart, rend, nslots, bs;
59697bbdb24SBarry Smith 
597704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
598704ba839SBarry Smith 
5995d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
6002c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
6012c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
6022c9966d7SBarry Smith     }
6034db63379SBarry Smith 
6044db63379SBarry Smith     /*  MatCreateSubMatrix() for [S]BAIJ matrices can only work if the indices include entire blocks of the matrix */
6054db63379SBarry Smith     PetscCall(MatGetBlockSize(pc->pmat, &bs));
6064db63379SBarry Smith     if (bs > 1 && (jac->bs <= bs || jac->bs % bs)) {
6074db63379SBarry Smith       PetscBool blk;
6084db63379SBarry Smith 
6094db63379SBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)pc->pmat, &blk, MATBAIJ, MATSBAIJ, MATSEQBAIJ, MATSEQSBAIJ, MATMPIBAIJ, MATMPISBAIJ, NULL));
6104db63379SBarry Smith       PetscCheck(!blk, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Cannot use MATBAIJ with PCFIELDSPLIT and currently set matrix and PC blocksizes");
6114db63379SBarry Smith     }
6124db63379SBarry Smith 
61351f519a2SBarry Smith     bs = jac->bs;
6149566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRange(pc->pmat, &rstart, &rend));
6151b9fc7fcSBarry Smith     nslots = (rend - rstart) / bs;
6161b9fc7fcSBarry Smith     for (i = 0; i < nsplit; i++) {
6171b9fc7fcSBarry Smith       if (jac->defaultsplit) {
6189566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + i, nsplit, &ilink->is));
6199566063dSJacob Faibussowitsch         PetscCall(ISDuplicate(ilink->is, &ilink->is_col));
620704ba839SBarry Smith       } else if (!ilink->is) {
621ccb205f8SBarry Smith         if (ilink->nfields > 1) {
6225f4ab4e1SJungho Lee           PetscInt *ii, *jj, j, k, nfields = ilink->nfields, *fields = ilink->fields, *fields_col = ilink->fields_col;
6239566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(ilink->nfields * nslots, &ii));
6249566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(ilink->nfields * nslots, &jj));
6251b9fc7fcSBarry Smith           for (j = 0; j < nslots; j++) {
6261b9fc7fcSBarry Smith             for (k = 0; k < nfields; k++) {
6271b9fc7fcSBarry Smith               ii[nfields * j + k] = rstart + bs * j + fields[k];
6285f4ab4e1SJungho Lee               jj[nfields * j + k] = rstart + bs * j + fields_col[k];
62997bbdb24SBarry Smith             }
63097bbdb24SBarry Smith           }
6319566063dSJacob Faibussowitsch           PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, ii, PETSC_OWN_POINTER, &ilink->is));
6329566063dSJacob Faibussowitsch           PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, jj, PETSC_OWN_POINTER, &ilink->is_col));
6339566063dSJacob Faibussowitsch           PetscCall(ISSetBlockSize(ilink->is, nfields));
6349566063dSJacob Faibussowitsch           PetscCall(ISSetBlockSize(ilink->is_col, nfields));
635ccb205f8SBarry Smith         } else {
6369566063dSJacob Faibussowitsch           PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields[0], bs, &ilink->is));
6379566063dSJacob Faibussowitsch           PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields_col[0], bs, &ilink->is_col));
638ccb205f8SBarry Smith         }
6393e197d65SBarry Smith       }
6409566063dSJacob Faibussowitsch       PetscCall(ISSorted(ilink->is, &sorted));
6419566063dSJacob Faibussowitsch       if (ilink->is_col) PetscCall(ISSorted(ilink->is_col, &sorted_col));
6427827d75bSBarry Smith       PetscCheck(sorted && sorted_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Fields must be sorted when creating split");
643704ba839SBarry Smith       ilink = ilink->next;
6441b9fc7fcSBarry Smith     }
6451b9fc7fcSBarry Smith   }
6461b9fc7fcSBarry Smith 
647704ba839SBarry Smith   ilink = jac->head;
64897bbdb24SBarry Smith   if (!jac->pmat) {
649bdddcaaaSMatthew G Knepley     Vec xtmp;
650bdddcaaaSMatthew G Knepley 
6519566063dSJacob Faibussowitsch     PetscCall(MatCreateVecs(pc->pmat, &xtmp, NULL));
6529566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nsplit, &jac->pmat));
6539566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nsplit, &jac->x, nsplit, &jac->y));
654cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
655bdddcaaaSMatthew G Knepley       MatNullSpace sp;
656bdddcaaaSMatthew G Knepley 
657a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
6589566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&jac->pmat[i]));
659a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
6609566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->pmat[i]));
661a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
662a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
6632fa5cd67SKarl Rupp 
6649566063dSJacob Faibussowitsch           PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
665a3df900dSMatthew G Knepley         }
666a3df900dSMatthew G Knepley       } else {
6673a062f41SBarry Smith         const char *prefix;
6689566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->pmat[i]));
6692f427464SPierre Jolivet         PetscCall(MatGetOptionsPrefix(jac->pmat[i], &prefix));
6702f427464SPierre Jolivet         if (!prefix) {
6719566063dSJacob Faibussowitsch           PetscCall(KSPGetOptionsPrefix(ilink->ksp, &prefix));
6729566063dSJacob Faibussowitsch           PetscCall(MatSetOptionsPrefix(jac->pmat[i], prefix));
6732f427464SPierre Jolivet         }
67445881c45SPierre Jolivet         PetscCall(MatSetFromOptions(jac->pmat[i]));
6759566063dSJacob Faibussowitsch         PetscCall(MatViewFromOptions(jac->pmat[i], NULL, "-mat_view"));
676a3df900dSMatthew G Knepley       }
677bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
6789566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(jac->pmat[i], &jac->x[i], &jac->y[i]));
6799371c9d4SSatish Balay       ilink->x = jac->x[i];
6809371c9d4SSatish Balay       ilink->y = jac->y[i];
6819371c9d4SSatish Balay       ilink->z = NULL;
682bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
6839566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(xtmp, ilink->is, jac->x[i], NULL, &ilink->sctx));
6849566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nearnullspace", (PetscObject *)&sp));
68548a46eb9SPierre Jolivet       if (sp) PetscCall(MatSetNearNullSpace(jac->pmat[i], sp));
686704ba839SBarry Smith       ilink = ilink->next;
687cf502942SBarry Smith     }
6889566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&xtmp));
68997bbdb24SBarry Smith   } else {
690ef7efd37SHong Zhang     MatReuse      scall;
691*4849c82aSBarry Smith     MatNullSpace *nullsp = NULL;
692*4849c82aSBarry Smith 
693ef7efd37SHong Zhang     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
694*4849c82aSBarry Smith       PetscCall(MatGetNullSpaces(nsplit, jac->pmat, &nullsp));
69548a46eb9SPierre Jolivet       for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->pmat[i]));
696ef7efd37SHong Zhang       scall = MAT_INITIAL_MATRIX;
697ef7efd37SHong Zhang     } else scall = MAT_REUSE_MATRIX;
698ef7efd37SHong Zhang 
699cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
700a3df900dSMatthew G Knepley       Mat pmat;
701a3df900dSMatthew G Knepley 
702a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
7039566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&pmat));
70448a46eb9SPierre Jolivet       if (!pmat) PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, scall, &jac->pmat[i]));
705704ba839SBarry Smith       ilink = ilink->next;
706cf502942SBarry Smith     }
707*4849c82aSBarry Smith     if (nullsp) PetscCall(MatRestoreNullSpaces(nsplit, jac->pmat, &nullsp));
70897bbdb24SBarry Smith   }
7094e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
710519d70e2SJed Brown     ilink = jac->head;
711519d70e2SJed Brown     if (!jac->mat) {
7129566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nsplit, &jac->mat));
713519d70e2SJed Brown       for (i = 0; i < nsplit; i++) {
7149566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->mat[i]));
715519d70e2SJed Brown         ilink = ilink->next;
716519d70e2SJed Brown       }
717519d70e2SJed Brown     } else {
718ef7efd37SHong Zhang       MatReuse      scall;
719*4849c82aSBarry Smith       MatNullSpace *nullsp = NULL;
720*4849c82aSBarry Smith 
721ef7efd37SHong Zhang       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
722*4849c82aSBarry Smith         PetscCall(MatGetNullSpaces(nsplit, jac->mat, &nullsp));
72348a46eb9SPierre Jolivet         for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->mat[i]));
724ef7efd37SHong Zhang         scall = MAT_INITIAL_MATRIX;
725ef7efd37SHong Zhang       } else scall = MAT_REUSE_MATRIX;
726ef7efd37SHong Zhang 
727ef7efd37SHong Zhang       for (i = 0; i < nsplit; i++) {
7289566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, scall, &jac->mat[i]));
729519d70e2SJed Brown         ilink = ilink->next;
730519d70e2SJed Brown       }
731*4849c82aSBarry Smith       if (nullsp) PetscCall(MatRestoreNullSpaces(nsplit, jac->mat, &nullsp));
732519d70e2SJed Brown     }
733519d70e2SJed Brown   } else {
734519d70e2SJed Brown     jac->mat = jac->pmat;
735519d70e2SJed Brown   }
73697bbdb24SBarry Smith 
73753935eafSBarry Smith   /* Check for null space attached to IS */
73853935eafSBarry Smith   ilink = jac->head;
73953935eafSBarry Smith   for (i = 0; i < nsplit; i++) {
74053935eafSBarry Smith     MatNullSpace sp;
74153935eafSBarry Smith 
7429566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nullspace", (PetscObject *)&sp));
74348a46eb9SPierre Jolivet     if (sp) PetscCall(MatSetNullSpace(jac->mat[i], sp));
74453935eafSBarry Smith     ilink = ilink->next;
74553935eafSBarry Smith   }
74653935eafSBarry Smith 
747a51937d4SCarola Kruse   if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) {
74868dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
7494e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
75068dd23aaSBarry Smith     ilink = jac->head;
751e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
752e52d2c62SBarry 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 */
753e52d2c62SBarry Smith       if (!jac->Afield) {
7549566063dSJacob Faibussowitsch         PetscCall(PetscCalloc1(nsplit, &jac->Afield));
75580c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7569566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
757e52d2c62SBarry Smith         } else {
7589566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
75980c96bb1SFande Kong         }
76080c96bb1SFande Kong       } else {
761ef7efd37SHong Zhang         MatReuse scall;
762e9422dd5SStefano Zampini 
763ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7649566063dSJacob Faibussowitsch           PetscCall(MatDestroy(&jac->Afield[1]));
765ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
766ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
767ef7efd37SHong Zhang 
76880c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7699566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
77080c96bb1SFande Kong         } else {
7719566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
77280c96bb1SFande Kong         }
773e52d2c62SBarry Smith       }
774e52d2c62SBarry Smith     } else {
77568dd23aaSBarry Smith       if (!jac->Afield) {
7769566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nsplit, &jac->Afield));
77768dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
77880c96bb1SFande Kong           if (jac->offdiag_use_amat) {
7799566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
78080c96bb1SFande Kong           } else {
7819566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
78280c96bb1SFande Kong           }
78368dd23aaSBarry Smith           ilink = ilink->next;
78468dd23aaSBarry Smith         }
78568dd23aaSBarry Smith       } else {
786ef7efd37SHong Zhang         MatReuse scall;
787ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
78848a46eb9SPierre Jolivet           for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->Afield[i]));
789ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
790ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
791ef7efd37SHong Zhang 
79268dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
79380c96bb1SFande Kong           if (jac->offdiag_use_amat) {
7949566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, scall, &jac->Afield[i]));
79580c96bb1SFande Kong           } else {
7969566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, scall, &jac->Afield[i]));
79780c96bb1SFande Kong           }
79868dd23aaSBarry Smith           ilink = ilink->next;
79968dd23aaSBarry Smith         }
80068dd23aaSBarry Smith       }
80168dd23aaSBarry Smith     }
802e52d2c62SBarry Smith   }
80368dd23aaSBarry Smith 
8043b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
8053b224e63SBarry Smith     IS          ccis;
806b94d7dedSBarry Smith     PetscBool   isset, isspd;
8074aa3045dSJed Brown     PetscInt    rstart, rend;
808093c86ffSJed Brown     char        lscname[256];
809093c86ffSJed Brown     PetscObject LSC_L;
810558f3fe8SPierre Jolivet     PetscBool   set, flg;
811ce94432eSBarry Smith 
81208401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use Schur complement preconditioner you must have exactly 2 fields");
81368dd23aaSBarry Smith 
814c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
815c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
816b94d7dedSBarry Smith       PetscCall(MatIsSPDKnown(pc->pmat, &isset, &isspd));
817b94d7dedSBarry Smith       jac->schurscale = (isset && isspd) ? 1.0 : -1.0;
818c096484dSStefano Zampini     }
819c096484dSStefano Zampini 
820e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
8219566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend));
822558f3fe8SPierre Jolivet     PetscCall(PetscObjectTypeCompareAny(jac->offdiag_use_amat ? (PetscObject)pc->mat : (PetscObject)pc->pmat, &flg, MATSEQSBAIJ, MATMPISBAIJ, ""));
823e6cab6aaSJed Brown 
8243b224e63SBarry Smith     if (jac->schur) {
8250298fd71SBarry Smith       KSP      kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
826e9422dd5SStefano Zampini       MatReuse scall;
827e9422dd5SStefano Zampini 
828e9422dd5SStefano Zampini       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
829e9422dd5SStefano Zampini         scall = MAT_INITIAL_MATRIX;
8309566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->B));
8319566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->C));
832e9422dd5SStefano Zampini       } else scall = MAT_REUSE_MATRIX;
833443836d0SMatthew G Knepley 
8349566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
8353b224e63SBarry Smith       ilink = jac->head;
8369566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8374e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8389566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->B));
839c84da90fSDmitry Karpeev       } else {
8409566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->B));
841c84da90fSDmitry Karpeev       }
8429566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
843558f3fe8SPierre Jolivet       if (!flg) {
8443b224e63SBarry Smith         ilink = ilink->next;
8459566063dSJacob Faibussowitsch         PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8464e39094bSDmitry Karpeev         if (jac->offdiag_use_amat) {
8479566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->C));
848c84da90fSDmitry Karpeev         } else {
8499566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->C));
850c84da90fSDmitry Karpeev         }
8519566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&ccis));
852558f3fe8SPierre Jolivet       } else {
853558f3fe8SPierre Jolivet         PetscCall(MatIsHermitianKnown(jac->offdiag_use_amat ? pc->mat : pc->pmat, &set, &flg));
854558f3fe8SPierre Jolivet         if (set && flg) PetscCall(MatCreateHermitianTranspose(jac->B, &jac->C));
855558f3fe8SPierre Jolivet         else PetscCall(MatCreateTranspose(jac->B, &jac->C));
856558f3fe8SPierre Jolivet       }
8579566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementUpdateSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
858a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
8599566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->schurp));
8609566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
861a7476a74SDmitry Karpeev       }
86248a46eb9SPierre Jolivet       if (kspA != kspInner) PetscCall(KSPSetOperators(kspA, jac->mat[0], jac->pmat[0]));
86348a46eb9SPierre Jolivet       if (kspUpper != kspA) PetscCall(KSPSetOperators(kspUpper, jac->mat[0], jac->pmat[0]));
8649566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
8653b224e63SBarry Smith     } else {
866bafc1b83SMatthew G Knepley       const char  *Dprefix;
867470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
868514bf10dSMatthew G Knepley       char         schurtestoption[256];
869bdddcaaaSMatthew G Knepley       MatNullSpace sp;
870686bed4dSStefano Zampini       KSP          kspt;
8713b224e63SBarry Smith 
872a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
8733b224e63SBarry Smith       ilink = jac->head;
8749566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8754e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8769566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
877c84da90fSDmitry Karpeev       } else {
8789566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
879c84da90fSDmitry Karpeev       }
8809566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
8813b224e63SBarry Smith       ilink = ilink->next;
882558f3fe8SPierre Jolivet       if (!flg) {
8839566063dSJacob Faibussowitsch         PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8844e39094bSDmitry Karpeev         if (jac->offdiag_use_amat) {
8859566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
886c84da90fSDmitry Karpeev         } else {
8879566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
888c84da90fSDmitry Karpeev         }
8899566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&ccis));
890558f3fe8SPierre Jolivet       } else {
891558f3fe8SPierre Jolivet         PetscCall(MatIsHermitianKnown(jac->offdiag_use_amat ? pc->mat : pc->pmat, &set, &flg));
892558f3fe8SPierre Jolivet         if (set && flg) PetscCall(MatCreateHermitianTranspose(jac->B, &jac->C));
893558f3fe8SPierre Jolivet         else PetscCall(MatCreateTranspose(jac->B, &jac->C));
894558f3fe8SPierre Jolivet       }
895f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
8969566063dSJacob Faibussowitsch       PetscCall(MatCreate(((PetscObject)jac->mat[0])->comm, &jac->schur));
8979566063dSJacob Faibussowitsch       PetscCall(MatSetType(jac->schur, MATSCHURCOMPLEMENT));
8989566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementSetSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
8999566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
9009566063dSJacob Faibussowitsch       PetscCall(MatSetOptionsPrefix(jac->schur, schurmatprefix));
9019566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspt));
9029566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(kspt, schurmatprefix));
903686bed4dSStefano Zampini 
904686bed4dSStefano Zampini       /* Note: this is not true in general */
9059566063dSJacob Faibussowitsch       PetscCall(MatGetNullSpace(jac->mat[1], &sp));
9061baa6e33SBarry Smith       if (sp) PetscCall(MatSetNullSpace(jac->schur, sp));
90720252d06SBarry Smith 
9089566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname));
90954a546c1SMatthew G. Knepley       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, NULL, &flg));
910514bf10dSMatthew G Knepley       if (flg) {
911514bf10dSMatthew G Knepley         DM  dmInner;
91221635b76SJed Brown         KSP kspInner;
913686bed4dSStefano Zampini         PC  pcInner;
91421635b76SJed Brown 
9159566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
9169566063dSJacob Faibussowitsch         PetscCall(KSPReset(kspInner));
9179566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(kspInner, jac->mat[0], jac->pmat[0]));
9189566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
91921635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
9209566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject)pc, 2));
9219566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject)pc, 2));
9229566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(kspInner, schurprefix));
923514bf10dSMatthew G Knepley 
924514bf10dSMatthew G Knepley         /* Set DM for new solver */
9259566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
9269566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(kspInner, dmInner));
9279566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(kspInner, PETSC_FALSE));
928686bed4dSStefano Zampini 
929686bed4dSStefano Zampini         /* Defaults to PCKSP as preconditioner */
9309566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9319566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcInner, PCKSP));
9329566063dSJacob Faibussowitsch         PetscCall(PCKSPSetKSP(pcInner, jac->head->ksp));
933514bf10dSMatthew G Knepley       } else {
93421635b76SJed Brown         /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
93521635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
93621635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
93721635b76SJed 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
93821635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
93921635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
9409566063dSJacob Faibussowitsch         PetscCall(KSPSetType(jac->head->ksp, KSPGMRES));
9419566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementSetKSP(jac->schur, jac->head->ksp));
942bafc1b83SMatthew G Knepley       }
9439566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->head->ksp, jac->mat[0], jac->pmat[0]));
9449566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->head->ksp));
9459566063dSJacob Faibussowitsch       PetscCall(MatSetFromOptions(jac->schur));
9463b224e63SBarry Smith 
9479566063dSJacob Faibussowitsch       PetscCall(PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg));
948686bed4dSStefano Zampini       if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */
949686bed4dSStefano Zampini         KSP kspInner;
950686bed4dSStefano Zampini         PC  pcInner;
951686bed4dSStefano Zampini 
9529566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
9539566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9549566063dSJacob Faibussowitsch         PetscCall(PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg));
955686bed4dSStefano Zampini         if (flg) {
956686bed4dSStefano Zampini           KSP ksp;
957686bed4dSStefano Zampini 
9589566063dSJacob Faibussowitsch           PetscCall(PCKSPGetKSP(pcInner, &ksp));
95948a46eb9SPierre Jolivet           if (ksp == jac->head->ksp) PetscCall(PCSetUseAmat(pcInner, PETSC_TRUE));
960686bed4dSStefano Zampini         }
961686bed4dSStefano Zampini       }
9629566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname));
96354a546c1SMatthew G. Knepley       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, NULL, &flg));
964443836d0SMatthew G Knepley       if (flg) {
965443836d0SMatthew G Knepley         DM dmInner;
966443836d0SMatthew G Knepley 
9679566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
9689566063dSJacob Faibussowitsch         PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper));
9693821be0aSBarry Smith         PetscCall(KSPSetNestLevel(jac->kspupper, pc->kspnestlevel));
9709566063dSJacob Faibussowitsch         PetscCall(KSPSetErrorIfNotConverged(jac->kspupper, pc->erroriffailure));
9719566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(jac->kspupper, schurprefix));
9729566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject)pc, 1));
9739566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject)pc, 1));
9749566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
9759566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(jac->kspupper, dmInner));
9769566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(jac->kspupper, PETSC_FALSE));
9779566063dSJacob Faibussowitsch         PetscCall(KSPSetFromOptions(jac->kspupper));
9789566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(jac->kspupper, jac->mat[0], jac->pmat[0]));
9799566063dSJacob Faibussowitsch         PetscCall(VecDuplicate(jac->head->x, &jac->head->z));
980443836d0SMatthew G Knepley       } else {
981443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
9829566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->head->ksp));
983443836d0SMatthew G Knepley       }
984443836d0SMatthew G Knepley 
98548a46eb9SPierre Jolivet       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
9869566063dSJacob Faibussowitsch       PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspschur));
9873821be0aSBarry Smith       PetscCall(KSPSetNestLevel(jac->kspschur, pc->kspnestlevel));
9889566063dSJacob Faibussowitsch       PetscCall(KSPSetErrorIfNotConverged(jac->kspschur, pc->erroriffailure));
9899566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspschur, (PetscObject)pc, 1));
990084e4875SJed Brown       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
9917233a360SDmitry Karpeev         PC pcschur;
9929566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(jac->kspschur, &pcschur));
9939566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcschur, PCNONE));
994084e4875SJed Brown         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
995e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
9969566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
997e69d4d44SBarry Smith       }
9989566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
9999566063dSJacob Faibussowitsch       PetscCall(KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix));
10009566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(jac->kspschur, Dprefix));
1001c096484dSStefano Zampini       /* propagate DM */
1002b20b4189SMatthew G. Knepley       {
1003b20b4189SMatthew G. Knepley         DM sdm;
10049566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->next->ksp, &sdm));
1005b20b4189SMatthew G. Knepley         if (sdm) {
10069566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(jac->kspschur, sdm));
10079566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(jac->kspschur, PETSC_FALSE));
1008b20b4189SMatthew G. Knepley         }
1009b20b4189SMatthew G. Knepley       }
10103b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
101120b26d62SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
10129566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->kspschur));
10133b224e63SBarry Smith     }
10149566063dSJacob Faibussowitsch     PetscCall(MatAssemblyBegin(jac->schur, MAT_FINAL_ASSEMBLY));
10159566063dSJacob Faibussowitsch     PetscCall(MatAssemblyEnd(jac->schur, MAT_FINAL_ASSEMBLY));
1016093c86ffSJed Brown 
1017093c86ffSJed Brown     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
10189566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_L", ilink->splitname));
10199566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L));
10209566063dSJacob Faibussowitsch     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L));
10219566063dSJacob Faibussowitsch     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_L", (PetscObject)LSC_L));
10229566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_Lp", ilink->splitname));
10239566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L));
10249566063dSJacob Faibussowitsch     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L));
10259566063dSJacob Faibussowitsch     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_Lp", (PetscObject)LSC_L));
1026a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1027a51937d4SCarola Kruse     IS       ccis;
1028a51937d4SCarola Kruse     PetscInt rstart, rend;
1029a51937d4SCarola Kruse 
103008401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use GKB preconditioner you must have exactly 2 fields");
1031a51937d4SCarola Kruse 
1032a51937d4SCarola Kruse     ilink = jac->head;
1033a51937d4SCarola Kruse 
1034a51937d4SCarola Kruse     /* When extracting off-diagonal submatrices, we take complements from this range */
10359566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend));
1036a51937d4SCarola Kruse 
10379566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
1038a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
10399566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
1040a51937d4SCarola Kruse     } else {
10419566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
1042a51937d4SCarola Kruse     }
10439566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ccis));
1044e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
10459566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->u));
10469566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->Hu));
10479566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w2));
1048a51937d4SCarola Kruse     ilink = ilink->next;
10499566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
1050a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
10519566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
1052a51937d4SCarola Kruse     } else {
10539566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
1054a51937d4SCarola Kruse     }
10559566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ccis));
1056e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
10579566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->v));
10589566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->d));
10599566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w1));
10609566063dSJacob Faibussowitsch     PetscCall(MatGolubKahanComputeExplicitOperator(jac->mat[0], jac->B, jac->C, &jac->H, jac->gkbnu));
10619566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(jac->gkbdelay, &jac->vecz));
1062e071a0a4SCarola Kruse 
1063a51937d4SCarola Kruse     ilink = jac->head;
10649566063dSJacob Faibussowitsch     PetscCall(KSPSetOperators(ilink->ksp, jac->H, jac->H));
10659566063dSJacob Faibussowitsch     if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
1066e071a0a4SCarola Kruse     /* Create gkb_monitor context */
1067de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1068de482cd7SCarola Kruse       PetscInt tablevel;
10699566063dSJacob Faibussowitsch       PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &jac->gkbviewer));
10709566063dSJacob Faibussowitsch       PetscCall(PetscViewerSetType(jac->gkbviewer, PETSCVIEWERASCII));
10719566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetTabLevel((PetscObject)ilink->ksp, &tablevel));
10729566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISetTab(jac->gkbviewer, tablevel));
10739566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)ilink->ksp, 1));
1074de482cd7SCarola Kruse     }
10753b224e63SBarry Smith   } else {
107668bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
107797bbdb24SBarry Smith     i     = 0;
10785a9f2f41SSatish Balay     ilink = jac->head;
10795a9f2f41SSatish Balay     while (ilink) {
10809566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(ilink->ksp, jac->mat[i], jac->pmat[i]));
10813b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
10829566063dSJacob Faibussowitsch       if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
108397bbdb24SBarry Smith       i++;
10845a9f2f41SSatish Balay       ilink = ilink->next;
10850971522cSBarry Smith     }
10863b224e63SBarry Smith   }
10873b224e63SBarry Smith 
10885ddf11f8SNicolas Barnafi   /* Set coordinates to the sub PC objects whenever these are set */
10895ddf11f8SNicolas Barnafi   if (jac->coordinates_set) {
10905ddf11f8SNicolas Barnafi     PC pc_coords;
10915ddf11f8SNicolas Barnafi     if (jac->type == PC_COMPOSITE_SCHUR) {
10925ddf11f8SNicolas Barnafi       // Head is first block.
10939566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->head->ksp, &pc_coords));
10949566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->dim, jac->head->ndofs, jac->head->coords));
10955ddf11f8SNicolas Barnafi       // Second one is Schur block, but its KSP object is in kspschur.
10969566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->kspschur, &pc_coords));
10979566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->next->dim, jac->head->next->ndofs, jac->head->next->coords));
10985ddf11f8SNicolas Barnafi     } else if (jac->type == PC_COMPOSITE_GKB) {
10999d3446b2SPierre Jolivet       PetscCall(PetscInfo(pc, "Warning: Setting coordinates does nothing for the GKB Fieldpslit preconditioner\n"));
11005ddf11f8SNicolas Barnafi     } else {
11015ddf11f8SNicolas Barnafi       ilink = jac->head;
11025ddf11f8SNicolas Barnafi       while (ilink) {
11039566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(ilink->ksp, &pc_coords));
11049566063dSJacob Faibussowitsch         PetscCall(PCSetCoordinates(pc_coords, ilink->dim, ilink->ndofs, ilink->coords));
11055ddf11f8SNicolas Barnafi         ilink = ilink->next;
11065ddf11f8SNicolas Barnafi       }
11075ddf11f8SNicolas Barnafi     }
11085ddf11f8SNicolas Barnafi   }
11095ddf11f8SNicolas Barnafi 
1110c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
11113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11120971522cSBarry Smith }
11130971522cSBarry Smith 
11145a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink, xx, yy) \
11153ba16761SJacob 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) || \
11169371c9d4SSatish 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) || \
11173ba16761SJacob Faibussowitsch                     VecScatterEnd(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE)))
111879416396SBarry Smith 
1119d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_Schur(PC pc, Vec x, Vec y)
1120d71ae5a4SJacob Faibussowitsch {
11213b224e63SBarry Smith   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
11223b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1123443836d0SMatthew G Knepley   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
11243b224e63SBarry Smith 
11253b224e63SBarry Smith   PetscFunctionBegin;
1126c5d2311dSJed Brown   switch (jac->schurfactorization) {
1127c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
1128a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
11299566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11309566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11319566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11329566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11339566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11349566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11359566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11369566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11379566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11389566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11399566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11409566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
11419566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11429566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->y, jac->schurscale));
11439566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11449566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11459566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1146c5d2311dSJed Brown     break;
1147c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
1148a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
11499566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11509566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11519566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11529566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11539566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11549566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11559566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
11569566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.));
11579566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11589566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11599566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11609566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11619566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11629566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
11639566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11649566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11659566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11669566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1167c5d2311dSJed Brown     break;
1168c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
1169a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
11709566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11719566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11729566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11739566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11749566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
11759371c9d4SSatish Balay     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11769371c9d4SSatish Balay     PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
11779566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkA->x, -1.));
11789566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
11799566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11809566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
11819566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11829566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11839566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11849566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11859566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11869566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11879566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1188c5d2311dSJed Brown     break;
1189c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
1190c238f8cdSStefano Zampini     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */
11919566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11929566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11939566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
11949566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspLower, ilinkA->x, ilinkA->y));
11959566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->y));
11969566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
11979566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
11989566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.0));
11999566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12009566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12013b224e63SBarry Smith 
12029566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12039566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
12049566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12059566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12069566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12073b224e63SBarry Smith 
1208443836d0SMatthew G Knepley     if (kspUpper == kspA) {
12099566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->y));
12109566063dSJacob Faibussowitsch       PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y));
12119566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12129566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
12139566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12149566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
1215443836d0SMatthew G Knepley     } else {
12169566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12179566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
12189566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12199566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
12209566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
12219566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspUpper, ilinkA->x, ilinkA->z));
12229566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->z));
12239566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
12249566063dSJacob Faibussowitsch       PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z));
1225443836d0SMatthew G Knepley     }
12269566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12279566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12289566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1229c5d2311dSJed Brown   }
12303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12313b224e63SBarry Smith }
12323b224e63SBarry Smith 
12337b665727SPierre Jolivet static PetscErrorCode PCApplyTranspose_FieldSplit_Schur(PC pc, Vec x, Vec y)
12347b665727SPierre Jolivet {
12357b665727SPierre Jolivet   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
12367b665727SPierre Jolivet   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
12377b665727SPierre Jolivet   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
12387b665727SPierre Jolivet 
12397b665727SPierre Jolivet   PetscFunctionBegin;
12407b665727SPierre Jolivet   switch (jac->schurfactorization) {
12417b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
12427b665727SPierre Jolivet     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
12437b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12447b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12457b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12467b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12477b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
12487b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12497b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12507b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12517b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12527b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12537b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
12547b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12557b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12567b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->y, jac->schurscale));
12577b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12587b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12597b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12607b665727SPierre Jolivet     break;
12617b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
12627b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12637b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12647b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12657b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
12667b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12677b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12687b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x));
12697b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->x, -1.));
12707b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12717b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12727b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12737b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12747b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
12757b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12767b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12777b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12787b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12797b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12807b665727SPierre Jolivet     break;
12817b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
12827b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12837b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12847b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12857b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
12867b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12877b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12887b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x));
12897b665727SPierre Jolivet     PetscCall(VecScale(ilinkA->x, -1.));
12907b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
12917b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12927b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
12937b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12947b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
12957b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12967b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12977b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12987b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12997b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13007b665727SPierre Jolivet     break;
13017b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
13027b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13037b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13047b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL));
13057b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspUpper, ilinkA->x, ilinkA->y));
13067b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->y));
13077b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL));
13087b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x));
13097b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->x, -1.0));
13107b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13117b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13127b665727SPierre Jolivet 
13137b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13147b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
13157b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13167b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13177b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13187b665727SPierre Jolivet 
13197b665727SPierre Jolivet     if (kspLower == kspA) {
13207b665727SPierre Jolivet       PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->y));
13217b665727SPierre Jolivet       PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y));
13227b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13237b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
13247b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13257b665727SPierre Jolivet       PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13267b665727SPierre Jolivet     } else {
13277b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13287b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
13297b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13307b665727SPierre Jolivet       PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x));
13317b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL));
13327b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspLower, ilinkA->x, ilinkA->z));
13337b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->z));
13347b665727SPierre Jolivet       PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL));
13357b665727SPierre Jolivet       PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z));
13367b665727SPierre Jolivet     }
13377b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13387b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13397b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13407b665727SPierre Jolivet   }
13417b665727SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
13427b665727SPierre Jolivet }
13437b665727SPierre Jolivet 
1344d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit(PC pc, Vec x, Vec y)
1345d71ae5a4SJacob Faibussowitsch {
13460971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
13475a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
1348939b8a20SBarry Smith   PetscInt          cnt, bs;
13490971522cSBarry Smith 
13500971522cSBarry Smith   PetscFunctionBegin;
135179416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
13521b9fc7fcSBarry Smith     if (jac->defaultsplit) {
13539566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
13542472a847SBarry 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);
13559566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
13562472a847SBarry 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);
13579566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
13585a9f2f41SSatish Balay       while (ilink) {
13599566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
13609566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
13619566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
13629566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
13635a9f2f41SSatish Balay         ilink = ilink->next;
13640971522cSBarry Smith       }
13659566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
13661b9fc7fcSBarry Smith     } else {
13679566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
13685a9f2f41SSatish Balay       while (ilink) {
13699566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
13705a9f2f41SSatish Balay         ilink = ilink->next;
13711b9fc7fcSBarry Smith       }
13721b9fc7fcSBarry Smith     }
1373e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
13749566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1375e52d2c62SBarry Smith     /* solve on first block for first block variables */
13769566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
13779566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
13789566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
13799566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
13809566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
13819566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
13829566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
13839566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
1384e52d2c62SBarry Smith 
1385e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
13869566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->Afield[1], ilink->y, ilink->next->x));
1387e52d2c62SBarry Smith     ilink = ilink->next;
13889566063dSJacob Faibussowitsch     PetscCall(VecScale(ilink->x, -1.0));
13899566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
13909566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
1391e52d2c62SBarry Smith 
1392e52d2c62SBarry Smith     /* solve on second block variables */
13939566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
13949566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
13959566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
13969566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
13979566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
13989566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
139916913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
140079416396SBarry Smith     if (!jac->w1) {
14019566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
14029566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
140379416396SBarry Smith     }
14049566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
14059566063dSJacob Faibussowitsch     PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
14063e197d65SBarry Smith     cnt = 1;
14075a9f2f41SSatish Balay     while (ilink->next) {
14085a9f2f41SSatish Balay       ilink = ilink->next;
14093e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
14109566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->Afield[cnt++], y, ilink->x));
14119566063dSJacob Faibussowitsch       PetscCall(VecScale(ilink->x, -1.0));
14129566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
14139566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
14149566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14159566063dSJacob Faibussowitsch       PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
14169566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14179566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14189566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
14199566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
14203e197d65SBarry Smith     }
142151f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
142211755939SBarry Smith       cnt -= 2;
142351f519a2SBarry Smith       while (ilink->previous) {
142451f519a2SBarry Smith         ilink = ilink->previous;
142511755939SBarry Smith         /* compute the residual only over the part of the vector needed */
14269566063dSJacob Faibussowitsch         PetscCall(MatMult(jac->Afield[cnt--], y, ilink->x));
14279566063dSJacob Faibussowitsch         PetscCall(VecScale(ilink->x, -1.0));
14289566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
14299566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
14309566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14319566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
14329566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14339566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14349566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
14359566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
143651f519a2SBarry Smith       }
143711755939SBarry Smith     }
143863a3b9bcSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Unsupported or unknown composition %d", (int)jac->type);
14393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
14400971522cSBarry Smith }
14410971522cSBarry Smith 
1442d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_GKB(PC pc, Vec x, Vec y)
1443d71ae5a4SJacob Faibussowitsch {
1444a51937d4SCarola Kruse   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
1445a51937d4SCarola Kruse   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1446a51937d4SCarola Kruse   KSP               ksp = ilinkA->ksp;
1447de482cd7SCarola Kruse   Vec               u, v, Hu, d, work1, work2;
1448e071a0a4SCarola Kruse   PetscScalar       alpha, z, nrmz2, *vecz;
1449e071a0a4SCarola Kruse   PetscReal         lowbnd, nu, beta;
1450a51937d4SCarola Kruse   PetscInt          j, iterGKB;
1451a51937d4SCarola Kruse 
1452a51937d4SCarola Kruse   PetscFunctionBegin;
14539566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
14549566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
14559566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
14569566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
1457e071a0a4SCarola Kruse 
1458e071a0a4SCarola Kruse   u     = jac->u;
1459e071a0a4SCarola Kruse   v     = jac->v;
1460e071a0a4SCarola Kruse   Hu    = jac->Hu;
1461e071a0a4SCarola Kruse   d     = jac->d;
1462e071a0a4SCarola Kruse   work1 = jac->w1;
1463e071a0a4SCarola Kruse   work2 = jac->w2;
1464e071a0a4SCarola Kruse   vecz  = jac->vecz;
1465a51937d4SCarola Kruse 
1466a51937d4SCarola Kruse   /* Change RHS to comply with matrix regularization H = A + nu*B*B' */
1467a51937d4SCarola Kruse   /* Add q = q + nu*B*b */
1468a51937d4SCarola Kruse   if (jac->gkbnu) {
1469a51937d4SCarola Kruse     nu = jac->gkbnu;
14709566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, jac->gkbnu));
14719566063dSJacob Faibussowitsch     PetscCall(MatMultAdd(jac->B, ilinkD->x, ilinkA->x, ilinkA->x)); /* q = q + nu*B*b */
1472a51937d4SCarola Kruse   } else {
1473a51937d4SCarola Kruse     /* Situation when no augmented Lagrangian is used. Then we set inner  */
1474a51937d4SCarola Kruse     /* matrix N = I in [Ar13], and thus nu = 1.                           */
1475a51937d4SCarola Kruse     nu = 1;
1476a51937d4SCarola Kruse   }
1477a51937d4SCarola Kruse 
1478a51937d4SCarola Kruse   /* Transform rhs from [q,tilde{b}] to [0,b] */
14799566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
14809566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, ilinkA->x, ilinkA->y));
14819566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, ilinkA->y));
14829566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
14839566063dSJacob Faibussowitsch   PetscCall(MatMultHermitianTranspose(jac->B, ilinkA->y, work1));
14849566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(work1, 1.0 / nu, -1.0, ilinkD->x)); /* c = b - B'*x        */
1485a51937d4SCarola Kruse 
1486a51937d4SCarola Kruse   /* First step of algorithm */
14879566063dSJacob Faibussowitsch   PetscCall(VecNorm(work1, NORM_2, &beta)); /* beta = sqrt(nu*c'*c)*/
1488e071a0a4SCarola Kruse   KSPCheckDot(ksp, beta);
1489addd1e01SJunchao Zhang   beta = PetscSqrtReal(nu) * beta;
14909566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(v, nu / beta, 0.0, work1)); /* v = nu/beta *c      */
14919566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->B, v, work2));          /* u = H^{-1}*B*v      */
14929566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
14939566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, work2, u));
14949566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, u));
14959566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
14969566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u      */
14979566063dSJacob Faibussowitsch   PetscCall(VecDot(Hu, u, &alpha));
1498e071a0a4SCarola Kruse   KSPCheckDot(ksp, alpha);
149908401ef6SPierre Jolivet   PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1500addd1e01SJunchao Zhang   alpha = PetscSqrtReal(PetscAbsScalar(alpha));
15019566063dSJacob Faibussowitsch   PetscCall(VecScale(u, 1.0 / alpha));
15029566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(d, 1.0 / alpha, 0.0, v)); /* v = nu/beta *c      */
1503de482cd7SCarola Kruse 
1504a51937d4SCarola Kruse   z       = beta / alpha;
1505a51937d4SCarola Kruse   vecz[1] = z;
1506a51937d4SCarola Kruse 
1507de482cd7SCarola Kruse   /* Computation of first iterate x(1) and p(1) */
15089566063dSJacob Faibussowitsch   PetscCall(VecAXPY(ilinkA->y, z, u));
15099566063dSJacob Faibussowitsch   PetscCall(VecCopy(d, ilinkD->y));
15109566063dSJacob Faibussowitsch   PetscCall(VecScale(ilinkD->y, -z));
1511a51937d4SCarola Kruse 
15129371c9d4SSatish Balay   iterGKB = 1;
15139371c9d4SSatish Balay   lowbnd  = 2 * jac->gkbtol;
151448a46eb9SPierre Jolivet   if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1515de482cd7SCarola Kruse 
1516a51937d4SCarola Kruse   while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) {
1517a51937d4SCarola Kruse     iterGKB += 1;
15189566063dSJacob Faibussowitsch     PetscCall(MatMultHermitianTranspose(jac->B, u, work1)); /* v <- nu*(B'*u-alpha/nu*v) */
15199566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(v, nu, -alpha, work1));
15209566063dSJacob Faibussowitsch     PetscCall(VecNorm(v, NORM_2, &beta)); /* beta = sqrt(nu)*v'*v      */
1521addd1e01SJunchao Zhang     beta = beta / PetscSqrtReal(nu);
15229566063dSJacob Faibussowitsch     PetscCall(VecScale(v, 1.0 / beta));
15239566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->B, v, work2)); /* u <- H^{-1}*(B*v-beta*H*u) */
15249566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu));
15259566063dSJacob Faibussowitsch     PetscCall(VecAXPY(work2, -beta, Hu));
15269566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
15279566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ksp, work2, u));
15289566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ksp, pc, u));
15299566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
15309566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u            */
15319566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, u, &alpha));
1532e071a0a4SCarola Kruse     KSPCheckDot(ksp, alpha);
153308401ef6SPierre Jolivet     PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1534addd1e01SJunchao Zhang     alpha = PetscSqrtReal(PetscAbsScalar(alpha));
15359566063dSJacob Faibussowitsch     PetscCall(VecScale(u, 1.0 / alpha));
1536a51937d4SCarola Kruse 
1537e071a0a4SCarola Kruse     z       = -beta / alpha * z; /* z <- beta/alpha*z     */
1538a51937d4SCarola Kruse     vecz[0] = z;
1539a51937d4SCarola Kruse 
1540a51937d4SCarola Kruse     /* Computation of new iterate x(i+1) and p(i+1) */
15419566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(d, 1.0 / alpha, -beta / alpha, v)); /* d = (v-beta*d)/alpha */
15429566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkA->y, z, u));                   /* r = r + z*u          */
15439566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkD->y, -z, d));                  /* p = p - z*d          */
15449566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, ilinkA->y, Hu));             /* ||u||_H = u'*H*u     */
15459566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, ilinkA->y, &nrmz2));
1546a51937d4SCarola Kruse 
1547a51937d4SCarola Kruse     /* Compute Lower Bound estimate */
1548a51937d4SCarola Kruse     if (iterGKB > jac->gkbdelay) {
1549a51937d4SCarola Kruse       lowbnd = 0.0;
1550ad540459SPierre Jolivet       for (j = 0; j < jac->gkbdelay; j++) lowbnd += PetscAbsScalar(vecz[j] * vecz[j]);
1551addd1e01SJunchao Zhang       lowbnd = PetscSqrtReal(lowbnd / PetscAbsScalar(nrmz2));
1552a51937d4SCarola Kruse     }
1553a51937d4SCarola Kruse 
1554ad540459SPierre Jolivet     for (j = 0; j < jac->gkbdelay - 1; j++) vecz[jac->gkbdelay - j - 1] = vecz[jac->gkbdelay - j - 2];
155548a46eb9SPierre Jolivet     if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1556a51937d4SCarola Kruse   }
1557a51937d4SCarola Kruse 
15589566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
15599566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
15609566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
15619566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1562a51937d4SCarola Kruse 
15633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1564a51937d4SCarola Kruse }
1565a51937d4SCarola Kruse 
1566421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink, xx, yy) \
15673ba16761SJacob 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) || \
15689371c9d4SSatish 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) || \
15693ba16761SJacob Faibussowitsch                     VecScatterEnd(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE)))
1570421e10b8SBarry Smith 
1571d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc, Vec x, Vec y)
1572d71ae5a4SJacob Faibussowitsch {
1573421e10b8SBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
1574421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1575939b8a20SBarry Smith   PetscInt          bs;
1576421e10b8SBarry Smith 
1577421e10b8SBarry Smith   PetscFunctionBegin;
1578421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1579421e10b8SBarry Smith     if (jac->defaultsplit) {
15809566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
15812472a847SBarry 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);
15829566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
15832472a847SBarry 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);
15849566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
1585421e10b8SBarry Smith       while (ilink) {
15869566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15879566063dSJacob Faibussowitsch         PetscCall(KSPSolveTranspose(ilink->ksp, ilink->x, ilink->y));
15889566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
15899566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
1590421e10b8SBarry Smith         ilink = ilink->next;
1591421e10b8SBarry Smith       }
15929566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
1593421e10b8SBarry Smith     } else {
15949566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
1595421e10b8SBarry Smith       while (ilink) {
15969566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1597421e10b8SBarry Smith         ilink = ilink->next;
1598421e10b8SBarry Smith       }
1599421e10b8SBarry Smith     }
1600421e10b8SBarry Smith   } else {
1601421e10b8SBarry Smith     if (!jac->w1) {
16029566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
16039566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
1604421e10b8SBarry Smith     }
16059566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1606421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
16079566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1608421e10b8SBarry Smith       while (ilink->next) {
1609421e10b8SBarry Smith         ilink = ilink->next;
16109566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
16119566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
16129566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1613421e10b8SBarry Smith       }
1614421e10b8SBarry Smith       while (ilink->previous) {
1615421e10b8SBarry Smith         ilink = ilink->previous;
16169566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
16179566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
16189566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1619421e10b8SBarry Smith       }
1620421e10b8SBarry Smith     } else {
1621421e10b8SBarry Smith       while (ilink->next) { /* get to last entry in linked list */
1622421e10b8SBarry Smith         ilink = ilink->next;
1623421e10b8SBarry Smith       }
16249566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1625421e10b8SBarry Smith       while (ilink->previous) {
1626421e10b8SBarry Smith         ilink = ilink->previous;
16279566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
16289566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
16299566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1630421e10b8SBarry Smith       }
1631421e10b8SBarry Smith     }
1632421e10b8SBarry Smith   }
16333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1634421e10b8SBarry Smith }
1635421e10b8SBarry Smith 
1636d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_FieldSplit(PC pc)
1637d71ae5a4SJacob Faibussowitsch {
16380971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
16395a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head, next;
16400971522cSBarry Smith 
16410971522cSBarry Smith   PetscFunctionBegin;
16425a9f2f41SSatish Balay   while (ilink) {
16439566063dSJacob Faibussowitsch     PetscCall(KSPDestroy(&ilink->ksp));
16449566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->x));
16459566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->y));
16469566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->z));
16479566063dSJacob Faibussowitsch     PetscCall(VecScatterDestroy(&ilink->sctx));
16489566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
16499566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
16509566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->splitname));
16519566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields));
16529566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields_col));
16535a9f2f41SSatish Balay     next = ilink->next;
16549566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink));
16555a9f2f41SSatish Balay     ilink = next;
16560971522cSBarry Smith   }
1657f5f0d762SBarry Smith   jac->head = NULL;
16589566063dSJacob Faibussowitsch   PetscCall(PetscFree2(jac->x, jac->y));
1659574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
16609566063dSJacob Faibussowitsch     PetscCall(MatDestroyMatrices(jac->nsplits, &jac->mat));
1661574deadeSBarry Smith   } else if (jac->mat) {
16620298fd71SBarry Smith     jac->mat = NULL;
1663574deadeSBarry Smith   }
16649566063dSJacob Faibussowitsch   if (jac->pmat) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->pmat));
16659566063dSJacob Faibussowitsch   if (jac->Afield) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->Afield));
1666f5f0d762SBarry Smith   jac->nsplits = 0;
16679566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w1));
16689566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w2));
16699566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur));
16709566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schurp));
16719566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur_user));
16729566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspschur));
16739566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspupper));
16749566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->B));
16759566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->C));
16769566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->H));
16779566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->u));
16789566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->v));
16799566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->Hu));
16809566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->d));
16819566063dSJacob Faibussowitsch   PetscCall(PetscFree(jac->vecz));
16829566063dSJacob Faibussowitsch   PetscCall(PetscViewerDestroy(&jac->gkbviewer));
16836dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
16843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1685574deadeSBarry Smith }
1686574deadeSBarry Smith 
1687d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1688d71ae5a4SJacob Faibussowitsch {
1689574deadeSBarry Smith   PetscFunctionBegin;
16909566063dSJacob Faibussowitsch   PetscCall(PCReset_FieldSplit(pc));
16919566063dSJacob Faibussowitsch   PetscCall(PetscFree(pc->data));
16922e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", NULL));
16939566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", NULL));
16949566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", NULL));
16959566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", NULL));
16969566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", NULL));
16972e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", NULL));
16982e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", NULL));
16992e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
17002e956fe4SStefano Zampini 
17012e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
17022e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
17032e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
17042e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
17052e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
17069566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
17079566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
17089566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
17092e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
17103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
17110971522cSBarry Smith }
17120971522cSBarry Smith 
1713d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc, PetscOptionItems *PetscOptionsObject)
1714d71ae5a4SJacob Faibussowitsch {
17156c924f48SJed Brown   PetscInt        bs;
17167b752e3dSPatrick Sanan   PetscBool       flg;
17179dcbbd2bSBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit *)pc->data;
17183b224e63SBarry Smith   PCCompositeType ctype;
17191b9fc7fcSBarry Smith 
17200971522cSBarry Smith   PetscFunctionBegin;
1721d0609cedSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "FieldSplit options");
17229566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_dm_splits", "Whether to use DMCreateFieldDecomposition() for splits", "PCFieldSplitSetDMSplits", jac->dm_splits, &jac->dm_splits, NULL));
17239566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-pc_fieldsplit_block_size", "Blocksize that defines number of fields", "PCFieldSplitSetBlockSize", jac->bs, &bs, &flg));
17241baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetBlockSize(pc, bs));
17252686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
17269566063dSJacob 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));
17272686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
17289566063dSJacob 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));
17299566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_detect_saddle_point", "Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint", jac->detect, &jac->detect, NULL));
17309566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDetectSaddlePoint(pc, jac->detect)); /* Sets split type and Schur PC type */
17319566063dSJacob Faibussowitsch   PetscCall(PetscOptionsEnum("-pc_fieldsplit_type", "Type of composition", "PCFieldSplitSetType", PCCompositeTypes, (PetscEnum)jac->type, (PetscEnum *)&ctype, &flg));
17321baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetType(pc, ctype));
1733c30613efSMatthew Knepley   /* Only setup fields once */
1734c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1735d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1736d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
17379566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
17389566063dSJacob Faibussowitsch     if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
1739d32f9abdSBarry Smith   }
1740c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
17419566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_schur_factorization_type", PCFieldSplitSchurFactTypes, (PetscEnum *)&jac->schurfactorization, &flg));
17429566063dSJacob Faibussowitsch     if (flg) PetscCall(PetscInfo(pc, "Deprecated use of -pc_fieldsplit_schur_factorization_type\n"));
17439566063dSJacob 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));
17449566063dSJacob Faibussowitsch     PetscCall(PetscOptionsEnum("-pc_fieldsplit_schur_precondition", "How to build preconditioner for Schur complement", "PCFieldSplitSetSchurPre", PCFieldSplitSchurPreTypes, (PetscEnum)jac->schurpre, (PetscEnum *)&jac->schurpre, NULL));
17459566063dSJacob Faibussowitsch     PetscCall(PetscOptionsScalar("-pc_fieldsplit_schur_scale", "Scale Schur complement", "PCFieldSplitSetSchurScale", jac->schurscale, &jac->schurscale, NULL));
1746a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
17479566063dSJacob Faibussowitsch     PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_tol", "The tolerance for the lower bound stopping criterion", "PCFieldSplitGKBTol", jac->gkbtol, &jac->gkbtol, NULL));
17489566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_delay", "The delay value for lower bound criterion", "PCFieldSplitGKBDelay", jac->gkbdelay, &jac->gkbdelay, NULL));
174952ce0ab5SPierre Jolivet     PetscCall(PetscOptionsBoundedReal("-pc_fieldsplit_gkb_nu", "Parameter in augmented Lagrangian approach", "PCFieldSplitGKBNu", jac->gkbnu, &jac->gkbnu, NULL, 0.0));
17509566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_maxit", "Maximum allowed number of iterations", "PCFieldSplitGKBMaxit", jac->gkbmaxit, &jac->gkbmaxit, NULL));
17519566063dSJacob Faibussowitsch     PetscCall(PetscOptionsBool("-pc_fieldsplit_gkb_monitor", "Prints number of GKB iterations and error", "PCFieldSplitGKB", jac->gkbmonitor, &jac->gkbmonitor, NULL));
1752c5d2311dSJed Brown   }
175334603f55SBarry Smith   /*
175434603f55SBarry Smith     In the initial call to this routine the sub-solver data structures do not exist so we cannot call KSPSetFromOptions() on them yet.
175534603f55SBarry 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
175634603f55SBarry Smith     is called on the outer solver in case changes were made in the options database
175734603f55SBarry Smith 
175834603f55SBarry 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()
175934603f55SBarry 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.
176034603f55SBarry Smith     Without this extra check test p2p1fetidp_olof_full and others fail with incorrect matrix types.
176134603f55SBarry Smith 
176234603f55SBarry Smith     There could be a negative side effect of calling the KSPSetFromOptions() below.
176334603f55SBarry Smith 
176434603f55SBarry 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
176534603f55SBarry Smith   */
176634603f55SBarry Smith   if (jac->issetup) {
176734603f55SBarry Smith     PC_FieldSplitLink ilink = jac->head;
176834603f55SBarry Smith     if (jac->type == PC_COMPOSITE_SCHUR) {
176934603f55SBarry Smith       if (jac->kspupper && jac->kspupper->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspupper));
177034603f55SBarry Smith       if (jac->kspschur && jac->kspschur->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspschur));
177134603f55SBarry Smith     }
177234603f55SBarry Smith     while (ilink) {
177334603f55SBarry Smith       if (ilink->ksp->totalits > 0) PetscCall(KSPSetFromOptions(ilink->ksp));
177434603f55SBarry Smith       ilink = ilink->next;
177534603f55SBarry Smith     }
177634603f55SBarry Smith   }
1777d0609cedSBarry Smith   PetscOptionsHeadEnd();
17783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
17790971522cSBarry Smith }
17800971522cSBarry Smith 
1781d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col)
1782d71ae5a4SJacob Faibussowitsch {
178397bbdb24SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
17845a9f2f41SSatish Balay   PC_FieldSplitLink ilink, next = jac->head;
178569a612a9SBarry Smith   char              prefix[128];
17865d4c12cdSJungho Lee   PetscInt          i;
17870971522cSBarry Smith 
17880971522cSBarry Smith   PetscFunctionBegin;
17896c924f48SJed Brown   if (jac->splitdefined) {
17909566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
17913ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
17926c924f48SJed Brown   }
179351f519a2SBarry Smith   for (i = 0; i < n; i++) {
179463a3b9bcSJacob 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);
179563a3b9bcSJacob Faibussowitsch     PetscCheck(fields[i] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", fields[i]);
179651f519a2SBarry Smith   }
17979566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
1798a04f6461SBarry Smith   if (splitname) {
17999566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
1800a04f6461SBarry Smith   } else {
18019566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(3, &ilink->splitname));
180263a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 2, "%" PetscInt_FMT, jac->nsplits));
1803a04f6461SBarry Smith   }
18049df09d43SBarry 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 */
18059566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields));
18069566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields, fields, n));
18079566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields_col));
18089566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields_col, fields_col, n));
18092fa5cd67SKarl Rupp 
18105a9f2f41SSatish Balay   ilink->nfields = n;
18110298fd71SBarry Smith   ilink->next    = NULL;
18129566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
18133821be0aSBarry Smith   PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel));
18149566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
18159566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
18169566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
181769a612a9SBarry Smith 
18189566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
18199566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
18200971522cSBarry Smith 
18210971522cSBarry Smith   if (!next) {
18225a9f2f41SSatish Balay     jac->head       = ilink;
18230298fd71SBarry Smith     ilink->previous = NULL;
18240971522cSBarry Smith   } else {
1825ad540459SPierre Jolivet     while (next->next) next = next->next;
18265a9f2f41SSatish Balay     next->next      = ilink;
182751f519a2SBarry Smith     ilink->previous = next;
18280971522cSBarry Smith   }
18290971522cSBarry Smith   jac->nsplits++;
18303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
18310971522cSBarry Smith }
18320971522cSBarry Smith 
1833d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp)
1834d71ae5a4SJacob Faibussowitsch {
1835285fb4e2SStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1836285fb4e2SStefano Zampini 
1837285fb4e2SStefano Zampini   PetscFunctionBegin;
1838285fb4e2SStefano Zampini   *subksp = NULL;
1839285fb4e2SStefano Zampini   if (n) *n = 0;
1840285fb4e2SStefano Zampini   if (jac->type == PC_COMPOSITE_SCHUR) {
1841285fb4e2SStefano Zampini     PetscInt nn;
1842285fb4e2SStefano Zampini 
184328b400f6SJacob Faibussowitsch     PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()");
184463a3b9bcSJacob Faibussowitsch     PetscCheck(jac->nsplits == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unexpected number of splits %" PetscInt_FMT " != 2", jac->nsplits);
1845285fb4e2SStefano Zampini     nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0);
18469566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nn, subksp));
1847285fb4e2SStefano Zampini     (*subksp)[0] = jac->head->ksp;
1848285fb4e2SStefano Zampini     (*subksp)[1] = jac->kspschur;
1849285fb4e2SStefano Zampini     if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper;
1850285fb4e2SStefano Zampini     if (n) *n = nn;
1851285fb4e2SStefano Zampini   }
18523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1853285fb4e2SStefano Zampini }
1854285fb4e2SStefano Zampini 
1855d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc, PetscInt *n, KSP **subksp)
1856d71ae5a4SJacob Faibussowitsch {
1857e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1858e69d4d44SBarry Smith 
1859e69d4d44SBarry Smith   PetscFunctionBegin;
186028b400f6SJacob Faibussowitsch   PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
18619566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
18629566063dSJacob Faibussowitsch   PetscCall(MatSchurComplementGetKSP(jac->schur, *subksp));
18632fa5cd67SKarl Rupp 
1864e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
186513e0d083SBarry Smith   if (n) *n = jac->nsplits;
18663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1867e69d4d44SBarry Smith }
18680971522cSBarry Smith 
1869d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp)
1870d71ae5a4SJacob Faibussowitsch {
18710971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
18720971522cSBarry Smith   PetscInt          cnt   = 0;
18735a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
18740971522cSBarry Smith 
18750971522cSBarry Smith   PetscFunctionBegin;
18769566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
18775a9f2f41SSatish Balay   while (ilink) {
18785a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
18795a9f2f41SSatish Balay     ilink            = ilink->next;
18800971522cSBarry Smith   }
188163a3b9bcSJacob 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);
188213e0d083SBarry Smith   if (n) *n = jac->nsplits;
18833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
18840971522cSBarry Smith }
18850971522cSBarry Smith 
18866dbb499eSCian Wilson /*@C
1887f1580f4eSBarry Smith   PCFieldSplitRestrictIS - Restricts the fieldsplit `IS`s to be within a given `IS`.
18886dbb499eSCian Wilson 
18896dbb499eSCian Wilson   Input Parameters:
18906dbb499eSCian Wilson + pc  - the preconditioner context
1891feefa0e1SJacob Faibussowitsch - isy - the index set that defines the indices to which the fieldsplit is to be restricted
18926dbb499eSCian Wilson 
18936dbb499eSCian Wilson   Level: advanced
18946dbb499eSCian Wilson 
1895feefa0e1SJacob Faibussowitsch   Developer Notes:
1896f1580f4eSBarry Smith   It seems the resulting `IS`s will not cover the entire space, so
1897f1580f4eSBarry Smith   how can they define a convergent preconditioner? Needs explaining.
1898f1580f4eSBarry Smith 
189960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
19006dbb499eSCian Wilson @*/
1901d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitRestrictIS(PC pc, IS isy)
1902d71ae5a4SJacob Faibussowitsch {
19036dbb499eSCian Wilson   PetscFunctionBegin;
19046dbb499eSCian Wilson   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
19056dbb499eSCian Wilson   PetscValidHeaderSpecific(isy, IS_CLASSID, 2);
1906cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitRestrictIS_C", (PC, IS), (pc, isy));
19073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19086dbb499eSCian Wilson }
19096dbb499eSCian Wilson 
1910d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
1911d71ae5a4SJacob Faibussowitsch {
19126dbb499eSCian Wilson   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
19136dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
19146dbb499eSCian Wilson   PetscInt          localsize, size, sizez, i;
19156dbb499eSCian Wilson   const PetscInt   *ind, *indz;
19166dbb499eSCian Wilson   PetscInt         *indc, *indcz;
19176dbb499eSCian Wilson   PetscBool         flg;
19186dbb499eSCian Wilson 
19196dbb499eSCian Wilson   PetscFunctionBegin;
19209566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(isy, &localsize));
19219566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&localsize, &size, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)isy)));
19226dbb499eSCian Wilson   size -= localsize;
19236dbb499eSCian Wilson   while (ilink) {
19246dbb499eSCian Wilson     IS isrl, isr;
19251c7cfba8SBarry Smith     PC subpc;
19269566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl));
19279566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(isrl, &localsize));
19289566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(localsize, &indc));
19299566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(isrl, &ind));
19309566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(indc, ind, localsize));
19319566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(isrl, &ind));
19329566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isrl));
19336dbb499eSCian Wilson     for (i = 0; i < localsize; i++) *(indc + i) += size;
19349566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)isy), localsize, indc, PETSC_OWN_POINTER, &isr));
19359566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
19369566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
19376dbb499eSCian Wilson     ilink->is = isr;
19389566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
19399566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
19406dbb499eSCian Wilson     ilink->is_col = isr;
19419566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isr));
19429566063dSJacob Faibussowitsch     PetscCall(KSPGetPC(ilink->ksp, &subpc));
19439566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)subpc, PCFIELDSPLIT, &flg));
19446dbb499eSCian Wilson     if (flg) {
19456dbb499eSCian Wilson       IS       iszl, isz;
19466dbb499eSCian Wilson       MPI_Comm comm;
19479566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(ilink->is, &localsize));
19486dbb499eSCian Wilson       comm = PetscObjectComm((PetscObject)ilink->is);
19499566063dSJacob Faibussowitsch       PetscCall(ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl));
19509566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Scan(&localsize, &sizez, 1, MPIU_INT, MPI_SUM, comm));
19516dbb499eSCian Wilson       sizez -= localsize;
19529566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(iszl, &localsize));
19539566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(localsize, &indcz));
19549566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(iszl, &indz));
19559566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(indcz, indz, localsize));
19569566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(iszl, &indz));
19579566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&iszl));
19586dbb499eSCian Wilson       for (i = 0; i < localsize; i++) *(indcz + i) += sizez;
19599566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(comm, localsize, indcz, PETSC_OWN_POINTER, &isz));
19609566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitRestrictIS(subpc, isz));
19619566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&isz));
19626dbb499eSCian Wilson     }
19636dbb499eSCian Wilson     next  = ilink->next;
19646dbb499eSCian Wilson     ilink = next;
19656dbb499eSCian Wilson   }
19666dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
19673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19686dbb499eSCian Wilson }
19696dbb499eSCian Wilson 
1970d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc, const char splitname[], IS is)
1971d71ae5a4SJacob Faibussowitsch {
1972704ba839SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
1973704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1974704ba839SBarry Smith   char              prefix[128];
1975704ba839SBarry Smith 
1976704ba839SBarry Smith   PetscFunctionBegin;
19776c924f48SJed Brown   if (jac->splitdefined) {
19789566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
19793ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
19806c924f48SJed Brown   }
19819566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
1982a04f6461SBarry Smith   if (splitname) {
19839566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
1984a04f6461SBarry Smith   } else {
19859566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(8, &ilink->splitname));
198663a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 7, "%" PetscInt_FMT, jac->nsplits));
1987a04f6461SBarry Smith   }
19889df09d43SBarry 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 */
19899566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
19909566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is));
1991b5787286SJed Brown   ilink->is = is;
19929566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
19939566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is_col));
1994b5787286SJed Brown   ilink->is_col = is;
19950298fd71SBarry Smith   ilink->next   = NULL;
19969566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
19973821be0aSBarry Smith   PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel));
19989566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
19999566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
20009566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
2001704ba839SBarry Smith 
20029566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
20039566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
2004704ba839SBarry Smith 
2005704ba839SBarry Smith   if (!next) {
2006704ba839SBarry Smith     jac->head       = ilink;
20070298fd71SBarry Smith     ilink->previous = NULL;
2008704ba839SBarry Smith   } else {
2009ad540459SPierre Jolivet     while (next->next) next = next->next;
2010704ba839SBarry Smith     next->next      = ilink;
2011704ba839SBarry Smith     ilink->previous = next;
2012704ba839SBarry Smith   }
2013704ba839SBarry Smith   jac->nsplits++;
20143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2015704ba839SBarry Smith }
2016704ba839SBarry Smith 
201794ef8ddeSSatish Balay /*@C
201860f59c3bSBarry Smith   PCFieldSplitSetFields - Sets the fields that define one particular split in `PCFIELDSPLIT`
20190971522cSBarry Smith 
2020c3339decSBarry Smith   Logically Collective
20210971522cSBarry Smith 
20220971522cSBarry Smith   Input Parameters:
20230971522cSBarry Smith + pc         - the preconditioner context
202460f59c3bSBarry Smith . splitname  - name of this split, if `NULL` the number of the split is used
20250971522cSBarry Smith . n          - the number of fields in this split
20263b374dbdSBarry Smith . fields     - the fields in this split
20273b374dbdSBarry 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
20283b374dbdSBarry Smith                  of the matrix and fields_col provides the column indices for that block
20290971522cSBarry Smith 
20300971522cSBarry Smith   Level: intermediate
20310971522cSBarry Smith 
203295452b02SPatrick Sanan   Notes:
2033f1580f4eSBarry Smith   Use `PCFieldSplitSetIS()` to set a  general set of indices as a split.
2034d32f9abdSBarry Smith 
2035f1580f4eSBarry Smith   `PCFieldSplitSetFields()` is for defining fields as strided blocks. For example, if the block
2036f1580f4eSBarry 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
2037d32f9abdSBarry Smith   0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
2038f1580f4eSBarry Smith   where the numbered entries indicate what is in the split.
2039d32f9abdSBarry Smith 
2040db4c96c1SJed Brown   This function is called once per split (it creates a new split each time).  Solve options
204160f59c3bSBarry Smith   for this split will be available under the prefix `-fieldsplit_SPLITNAME_`.
2042db4c96c1SJed Brown 
20433b374dbdSBarry Smith   `PCFieldSplitSetIS()` does not support having a fields_col different from fields
20443b374dbdSBarry Smith 
2045feefa0e1SJacob Faibussowitsch   Developer Notes:
2046f1580f4eSBarry Smith   This routine does not actually create the `IS` representing the split, that is delayed
2047f1580f4eSBarry Smith   until `PCSetUp_FieldSplit()`, because information about the vector/matrix layouts may not be
20485d4c12cdSJungho Lee   available when this routine is called.
20495d4c12cdSJungho Lee 
205060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetIS()`, `PCFieldSplitRestrictIS()`
20510971522cSBarry Smith @*/
2052d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetFields(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col)
2053d71ae5a4SJacob Faibussowitsch {
20540971522cSBarry Smith   PetscFunctionBegin;
20550700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
20564f572ea9SToby Isaac   PetscAssertPointer(splitname, 2);
205763a3b9bcSJacob Faibussowitsch   PetscCheck(n >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Provided number of fields %" PetscInt_FMT " in split \"%s\" not positive", n, splitname);
20584f572ea9SToby Isaac   PetscAssertPointer(fields, 4);
2059cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetFields_C", (PC, const char[], PetscInt, const PetscInt *, const PetscInt *), (pc, splitname, n, fields, fields_col));
20603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20610971522cSBarry Smith }
20620971522cSBarry Smith 
2063c84da90fSDmitry Karpeev /*@
2064f1580f4eSBarry Smith   PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build
2065c14e9f00SDavid Andrs   the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2066c84da90fSDmitry Karpeev 
2067c3339decSBarry Smith   Logically Collective
2068c84da90fSDmitry Karpeev 
2069c84da90fSDmitry Karpeev   Input Parameters:
2070c84da90fSDmitry Karpeev + pc  - the preconditioner object
2071c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
2072c84da90fSDmitry Karpeev 
207320f4b53cSBarry Smith   Options Database Key:
2074147403d9SBarry Smith . -pc_fieldsplit_diag_use_amat - use the Amat to provide the diagonal blocks
2075c84da90fSDmitry Karpeev 
2076c84da90fSDmitry Karpeev   Level: intermediate
2077c84da90fSDmitry Karpeev 
207860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetDiagUseAmat()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFIELDSPLIT`
2079c84da90fSDmitry Karpeev @*/
2080d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc, PetscBool flg)
2081d71ae5a4SJacob Faibussowitsch {
2082c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2083c84da90fSDmitry Karpeev   PetscBool      isfs;
2084c84da90fSDmitry Karpeev 
2085c84da90fSDmitry Karpeev   PetscFunctionBegin;
2086c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
20879566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
208828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2089c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
20903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2091c84da90fSDmitry Karpeev }
2092c84da90fSDmitry Karpeev 
2093c84da90fSDmitry Karpeev /*@
2094f1580f4eSBarry Smith   PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build
2095c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2096c84da90fSDmitry Karpeev 
2097c3339decSBarry Smith   Logically Collective
2098c84da90fSDmitry Karpeev 
209920f4b53cSBarry Smith   Input Parameter:
2100c84da90fSDmitry Karpeev . pc - the preconditioner object
2101c84da90fSDmitry Karpeev 
210220f4b53cSBarry Smith   Output Parameter:
2103c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
2104c84da90fSDmitry Karpeev 
2105c84da90fSDmitry Karpeev   Level: intermediate
2106c84da90fSDmitry Karpeev 
210760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetDiagUseAmat()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFIELDSPLIT`
2108c84da90fSDmitry Karpeev @*/
2109d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc, PetscBool *flg)
2110d71ae5a4SJacob Faibussowitsch {
2111c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2112c84da90fSDmitry Karpeev   PetscBool      isfs;
2113c84da90fSDmitry Karpeev 
2114c84da90fSDmitry Karpeev   PetscFunctionBegin;
2115c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
21164f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
21179566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
211828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2119c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
21203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2121c84da90fSDmitry Karpeev }
2122c84da90fSDmitry Karpeev 
2123c84da90fSDmitry Karpeev /*@
2124f1580f4eSBarry Smith   PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build
2125c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2126c84da90fSDmitry Karpeev 
2127c3339decSBarry Smith   Logically Collective
2128c84da90fSDmitry Karpeev 
2129c84da90fSDmitry Karpeev   Input Parameters:
2130c84da90fSDmitry Karpeev + pc  - the preconditioner object
2131c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2132c84da90fSDmitry Karpeev 
213320f4b53cSBarry Smith   Options Database Key:
2134147403d9SBarry Smith . -pc_fieldsplit_off_diag_use_amat <bool> - use the Amat to extract the off-diagonal blocks
2135c84da90fSDmitry Karpeev 
2136c84da90fSDmitry Karpeev   Level: intermediate
2137c84da90fSDmitry Karpeev 
213860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFieldSplitSetDiagUseAmat()`, `PCFIELDSPLIT`
2139c84da90fSDmitry Karpeev @*/
2140d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc, PetscBool flg)
2141d71ae5a4SJacob Faibussowitsch {
2142c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2143c84da90fSDmitry Karpeev   PetscBool      isfs;
2144c84da90fSDmitry Karpeev 
2145c84da90fSDmitry Karpeev   PetscFunctionBegin;
2146c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
21479566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
214828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2149c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
21503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2151c84da90fSDmitry Karpeev }
2152c84da90fSDmitry Karpeev 
2153c84da90fSDmitry Karpeev /*@
2154f1580f4eSBarry Smith   PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build
2155c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2156c84da90fSDmitry Karpeev 
2157c3339decSBarry Smith   Logically Collective
2158c84da90fSDmitry Karpeev 
215920f4b53cSBarry Smith   Input Parameter:
2160c84da90fSDmitry Karpeev . pc - the preconditioner object
2161c84da90fSDmitry Karpeev 
216220f4b53cSBarry Smith   Output Parameter:
2163c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2164c84da90fSDmitry Karpeev 
2165c84da90fSDmitry Karpeev   Level: intermediate
2166c84da90fSDmitry Karpeev 
216760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFieldSplitGetDiagUseAmat()`, `PCFIELDSPLIT`
2168c84da90fSDmitry Karpeev @*/
2169d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc, PetscBool *flg)
2170d71ae5a4SJacob Faibussowitsch {
2171c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2172c84da90fSDmitry Karpeev   PetscBool      isfs;
2173c84da90fSDmitry Karpeev 
2174c84da90fSDmitry Karpeev   PetscFunctionBegin;
2175c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
21764f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
21779566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
217828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2179c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
21803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2181c84da90fSDmitry Karpeev }
2182c84da90fSDmitry Karpeev 
2183218d4943SBarry Smith /*@C
2184f1580f4eSBarry Smith   PCFieldSplitSetIS - Sets the exact elements for a split in a `PCFIELDSPLIT`
2185704ba839SBarry Smith 
2186c3339decSBarry Smith   Logically Collective
2187704ba839SBarry Smith 
2188704ba839SBarry Smith   Input Parameters:
2189704ba839SBarry Smith + pc        - the preconditioner context
219060f59c3bSBarry Smith . splitname - name of this split, if `NULL` the number of the split is used
2191f1580f4eSBarry Smith - is        - the index set that defines the elements in this split
2192704ba839SBarry Smith 
219360f59c3bSBarry Smith   Level: intermediate
219460f59c3bSBarry Smith 
2195a6ffb8dbSJed Brown   Notes:
2196f1580f4eSBarry Smith   Use `PCFieldSplitSetFields()`, for splits defined by strided types.
2197a6ffb8dbSJed Brown 
2198db4c96c1SJed Brown   This function is called once per split (it creates a new split each time).  Solve options
2199db4c96c1SJed Brown   for this split will be available under the prefix -fieldsplit_SPLITNAME_.
2200d32f9abdSBarry Smith 
220160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`
2202704ba839SBarry Smith @*/
2203d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetIS(PC pc, const char splitname[], IS is)
2204d71ae5a4SJacob Faibussowitsch {
2205704ba839SBarry Smith   PetscFunctionBegin;
22060700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22074f572ea9SToby Isaac   if (splitname) PetscAssertPointer(splitname, 2);
2208db4c96c1SJed Brown   PetscValidHeaderSpecific(is, IS_CLASSID, 3);
2209cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetIS_C", (PC, const char[], IS), (pc, splitname, is));
22103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2211704ba839SBarry Smith }
2212704ba839SBarry Smith 
221394ef8ddeSSatish Balay /*@C
2214f1580f4eSBarry Smith   PCFieldSplitGetIS - Retrieves the elements for a split as an `IS`
221557a9adfeSMatthew G Knepley 
2216c3339decSBarry Smith   Logically Collective
221757a9adfeSMatthew G Knepley 
221857a9adfeSMatthew G Knepley   Input Parameters:
221957a9adfeSMatthew G Knepley + pc        - the preconditioner context
222057a9adfeSMatthew G Knepley - splitname - name of this split
222157a9adfeSMatthew G Knepley 
222257a9adfeSMatthew G Knepley   Output Parameter:
2223feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split, or `NULL` if the split is not found
222457a9adfeSMatthew G Knepley 
222557a9adfeSMatthew G Knepley   Level: intermediate
222657a9adfeSMatthew G Knepley 
222760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetIS()`
222857a9adfeSMatthew G Knepley @*/
2229d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetIS(PC pc, const char splitname[], IS *is)
2230d71ae5a4SJacob Faibussowitsch {
223157a9adfeSMatthew G Knepley   PetscFunctionBegin;
223257a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22334f572ea9SToby Isaac   PetscAssertPointer(splitname, 2);
22344f572ea9SToby Isaac   PetscAssertPointer(is, 3);
223557a9adfeSMatthew G Knepley   {
223657a9adfeSMatthew G Knepley     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
223757a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
223857a9adfeSMatthew G Knepley     PetscBool         found;
223957a9adfeSMatthew G Knepley 
22400298fd71SBarry Smith     *is = NULL;
224157a9adfeSMatthew G Knepley     while (ilink) {
22429566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(ilink->splitname, splitname, &found));
224357a9adfeSMatthew G Knepley       if (found) {
224457a9adfeSMatthew G Knepley         *is = ilink->is;
224557a9adfeSMatthew G Knepley         break;
224657a9adfeSMatthew G Knepley       }
224757a9adfeSMatthew G Knepley       ilink = ilink->next;
224857a9adfeSMatthew G Knepley     }
224957a9adfeSMatthew G Knepley   }
22503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
225157a9adfeSMatthew G Knepley }
225257a9adfeSMatthew G Knepley 
2253998f007dSPierre Jolivet /*@C
2254f1580f4eSBarry Smith   PCFieldSplitGetISByIndex - Retrieves the elements for a given split as an `IS`
2255998f007dSPierre Jolivet 
2256c3339decSBarry Smith   Logically Collective
2257998f007dSPierre Jolivet 
2258998f007dSPierre Jolivet   Input Parameters:
2259998f007dSPierre Jolivet + pc    - the preconditioner context
2260998f007dSPierre Jolivet - index - index of this split
2261998f007dSPierre Jolivet 
2262998f007dSPierre Jolivet   Output Parameter:
2263feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split
2264998f007dSPierre Jolivet 
2265998f007dSPierre Jolivet   Level: intermediate
2266998f007dSPierre Jolivet 
226760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitGetIS()`, `PCFieldSplitSetIS()`
2268998f007dSPierre Jolivet @*/
2269d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetISByIndex(PC pc, PetscInt index, IS *is)
2270d71ae5a4SJacob Faibussowitsch {
2271998f007dSPierre Jolivet   PetscFunctionBegin;
227263a3b9bcSJacob Faibussowitsch   PetscCheck(index >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", index);
2273998f007dSPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22744f572ea9SToby Isaac   PetscAssertPointer(is, 3);
2275998f007dSPierre Jolivet   {
2276998f007dSPierre Jolivet     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
2277998f007dSPierre Jolivet     PC_FieldSplitLink ilink = jac->head;
2278998f007dSPierre Jolivet     PetscInt          i     = 0;
227963a3b9bcSJacob Faibussowitsch     PetscCheck(index < jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", index, jac->nsplits);
2280998f007dSPierre Jolivet 
2281998f007dSPierre Jolivet     while (i < index) {
2282998f007dSPierre Jolivet       ilink = ilink->next;
2283998f007dSPierre Jolivet       ++i;
2284998f007dSPierre Jolivet     }
22859566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitGetIS(pc, ilink->splitname, is));
2286998f007dSPierre Jolivet   }
22873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2288998f007dSPierre Jolivet }
2289998f007dSPierre Jolivet 
229051f519a2SBarry Smith /*@
229151f519a2SBarry Smith   PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
2292f1580f4eSBarry Smith   fieldsplit preconditioner when calling `PCFieldSplitSetIS()`. If not set the matrix block size is used.
229351f519a2SBarry Smith 
2294c3339decSBarry Smith   Logically Collective
229551f519a2SBarry Smith 
229651f519a2SBarry Smith   Input Parameters:
229751f519a2SBarry Smith + pc - the preconditioner context
229851f519a2SBarry Smith - bs - the block size
229951f519a2SBarry Smith 
230051f519a2SBarry Smith   Level: intermediate
230151f519a2SBarry Smith 
230260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
230351f519a2SBarry Smith @*/
2304d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetBlockSize(PC pc, PetscInt bs)
2305d71ae5a4SJacob Faibussowitsch {
230651f519a2SBarry Smith   PetscFunctionBegin;
23070700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2308c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc, bs, 2);
2309cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetBlockSize_C", (PC, PetscInt), (pc, bs));
23103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
231151f519a2SBarry Smith }
231251f519a2SBarry Smith 
23130971522cSBarry Smith /*@C
2314f1580f4eSBarry Smith   PCFieldSplitGetSubKSP - Gets the `KSP` contexts for all splits
23150971522cSBarry Smith 
2316c3339decSBarry Smith   Collective
23170971522cSBarry Smith 
23180971522cSBarry Smith   Input Parameter:
23190971522cSBarry Smith . pc - the preconditioner context
23200971522cSBarry Smith 
23210971522cSBarry Smith   Output Parameters:
232213e0d083SBarry Smith + n      - the number of splits
2323f1580f4eSBarry Smith - subksp - the array of `KSP` contexts
2324196cc216SBarry Smith 
23250971522cSBarry Smith   Level: advanced
23260971522cSBarry Smith 
2327f1580f4eSBarry Smith   Notes:
2328f1580f4eSBarry Smith   After `PCFieldSplitGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()`
2329f1580f4eSBarry Smith   (not the `KSP`, just the array that contains them).
2330f1580f4eSBarry Smith 
2331f1580f4eSBarry Smith   You must call `PCSetUp()` before calling `PCFieldSplitGetSubKSP()`.
2332f1580f4eSBarry Smith 
2333f1580f4eSBarry Smith   If the fieldsplit is of type `PC_COMPOSITE_SCHUR`, it returns the `KSP` object used inside the
2334f1580f4eSBarry Smith   Schur complement and the `KSP` object used to iterate over the Schur complement.
2335f1580f4eSBarry Smith   To access all the `KSP` objects used in `PC_COMPOSITE_SCHUR`, use `PCFieldSplitSchurGetSubKSP()`.
2336f1580f4eSBarry Smith 
2337f1580f4eSBarry Smith   If the fieldsplit is of type `PC_COMPOSITE_GKB`, it returns the `KSP` object used to solve the
2338f1580f4eSBarry Smith   inner linear system defined by the matrix H in each loop.
2339f1580f4eSBarry Smith 
2340feefa0e1SJacob Faibussowitsch   Fortran Notes:
2341f1580f4eSBarry Smith   You must pass in a `KSP` array that is large enough to contain all the `KSP`s.
2342f1580f4eSBarry Smith   You can call `PCFieldSplitGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the
2343f1580f4eSBarry Smith   `KSP` array must be.
2344f1580f4eSBarry Smith 
2345feefa0e1SJacob Faibussowitsch   Developer Notes:
2346f1580f4eSBarry Smith   There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()`
2347f1580f4eSBarry Smith 
2348f1580f4eSBarry Smith   The Fortran interface should be modernized to return directly the array of values.
2349f1580f4eSBarry Smith 
235060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitSchurGetSubKSP()`
23510971522cSBarry Smith @*/
2352d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSubKSP(PC pc, PetscInt *n, KSP *subksp[])
2353d71ae5a4SJacob Faibussowitsch {
23540971522cSBarry Smith   PetscFunctionBegin;
23550700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23564f572ea9SToby Isaac   if (n) PetscAssertPointer(n, 2);
2357cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
23583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23590971522cSBarry Smith }
23600971522cSBarry Smith 
2361285fb4e2SStefano Zampini /*@C
2362f1580f4eSBarry Smith   PCFieldSplitSchurGetSubKSP - Gets the `KSP` contexts used inside the Schur complement based `PCFIELDSPLIT`
2363285fb4e2SStefano Zampini 
236460f59c3bSBarry Smith   Collective
2365285fb4e2SStefano Zampini 
2366285fb4e2SStefano Zampini   Input Parameter:
2367285fb4e2SStefano Zampini . pc - the preconditioner context
2368285fb4e2SStefano Zampini 
2369285fb4e2SStefano Zampini   Output Parameters:
2370285fb4e2SStefano Zampini + n      - the number of splits
2371f1580f4eSBarry Smith - subksp - the array of `KSP` contexts
2372285fb4e2SStefano Zampini 
2373285fb4e2SStefano Zampini   Level: advanced
2374285fb4e2SStefano Zampini 
2375f1580f4eSBarry Smith   Notes:
2376f1580f4eSBarry Smith   After `PCFieldSplitSchurGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()`
2377f1580f4eSBarry Smith   (not the `KSP` just the array that contains them).
2378f1580f4eSBarry Smith 
2379f1580f4eSBarry Smith   You must call `PCSetUp()` before calling `PCFieldSplitSchurGetSubKSP()`.
2380f1580f4eSBarry Smith 
2381f1580f4eSBarry Smith   If the fieldsplit type is of type `PC_COMPOSITE_SCHUR`, it returns (in order)
2382f1580f4eSBarry Smith +  1  - the `KSP` used for the (1,1) block
2383f1580f4eSBarry Smith .  2  - the `KSP` used for the Schur complement (not the one used for the interior Schur solver)
2384f1580f4eSBarry Smith -  3  - the `KSP` used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block).
2385f1580f4eSBarry Smith 
2386f1580f4eSBarry Smith   It returns a null array if the fieldsplit is not of type `PC_COMPOSITE_SCHUR`; in this case, you should use `PCFieldSplitGetSubKSP()`.
2387f1580f4eSBarry Smith 
2388feefa0e1SJacob Faibussowitsch   Fortran Notes:
2389f1580f4eSBarry Smith   You must pass in a `KSP` array that is large enough to contain all the local `KSP`s.
2390f1580f4eSBarry Smith   You can call `PCFieldSplitSchurGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the
2391f1580f4eSBarry Smith   `KSP` array must be.
2392f1580f4eSBarry Smith 
2393f1580f4eSBarry Smith   Developer Notes:
2394f1580f4eSBarry Smith   There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()`
2395f1580f4eSBarry Smith 
2396f1580f4eSBarry Smith   Should the functionality of `PCFieldSplitSchurGetSubKSP()` and `PCFieldSplitGetSubKSP()` be merged?
2397f1580f4eSBarry Smith 
2398f1580f4eSBarry Smith   The Fortran interface should be modernized to return directly the array of values.
2399f1580f4eSBarry Smith 
240060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitGetSubKSP()`
2401285fb4e2SStefano Zampini @*/
2402d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc, PetscInt *n, KSP *subksp[])
2403d71ae5a4SJacob Faibussowitsch {
2404285fb4e2SStefano Zampini   PetscFunctionBegin;
2405285fb4e2SStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
24064f572ea9SToby Isaac   if (n) PetscAssertPointer(n, 2);
2407cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitSchurGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
24083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2409285fb4e2SStefano Zampini }
2410285fb4e2SStefano Zampini 
2411e69d4d44SBarry Smith /*@
2412c14e9f00SDavid Andrs   PCFieldSplitSetSchurPre -  Indicates from what operator the preconditioner is constructed for the Schur complement.
2413a1e3cbf9SBarry Smith   The default is the A11 matrix.
2414e69d4d44SBarry Smith 
2415c3339decSBarry Smith   Collective
2416e69d4d44SBarry Smith 
2417e69d4d44SBarry Smith   Input Parameters:
2418e69d4d44SBarry Smith + pc    - the preconditioner context
2419f1580f4eSBarry Smith . ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11` (default),
2420f1580f4eSBarry Smith               `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER`,
2421f1580f4eSBarry Smith               `PC_FIELDSPLIT_SCHUR_PRE_SELFP`, and `PC_FIELDSPLIT_SCHUR_PRE_FULL`
242260f59c3bSBarry Smith - pre   - matrix to use for preconditioning, or `NULL`
2423084e4875SJed Brown 
2424f1580f4eSBarry Smith   Options Database Keys:
2425d59693daSPierre Jolivet + -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is `a11`. See notes for meaning of various arguments
2426a1e3cbf9SBarry Smith - -fieldsplit_1_pc_type <pctype>                               - the preconditioner algorithm that is used to construct the preconditioner from the operator
2427e69d4d44SBarry Smith 
242860f59c3bSBarry Smith   Level: intermediate
242960f59c3bSBarry Smith 
2430fd1303e9SJungho Lee   Notes:
2431f1580f4eSBarry Smith   If ptype is
2432f1580f4eSBarry Smith +     a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
2433f1580f4eSBarry Smith   matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
2434f1580f4eSBarry Smith .     self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
2435da81f932SPierre Jolivet   The only preconditioner that currently works with this symbolic representation matrix object is the `PCLSC`
2436f1580f4eSBarry Smith   preconditioner
2437f1580f4eSBarry Smith .     user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
2438f1580f4eSBarry Smith   to this function).
2439f1580f4eSBarry Smith .     selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
2440f1580f4eSBarry Smith   This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
2441d59693daSPierre Jolivet   lumped before extracting the diagonal using the additional option `-fieldsplit_1_mat_schur_complement_ainv_type lump`
2442f1580f4eSBarry Smith -     full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation
2443f1580f4eSBarry Smith   computed internally by `PCFIELDSPLIT` (this is expensive)
2444f1580f4eSBarry Smith   useful mostly as a test that the Schur complement approach can work for your problem
2445fd1303e9SJungho Lee 
2446d59693daSPierre Jolivet   When solving a saddle point problem, where the A11 block is identically zero, using `a11` as the ptype only makes sense
2447d59693daSPierre Jolivet   with the additional option `-fieldsplit_1_pc_type none`. Usually for saddle point problems one would use a ptype of self and
2448d59693daSPierre Jolivet   `-fieldsplit_1_pc_type lsc` which uses the least squares commutator to compute a preconditioner for the Schur complement.
2449fd1303e9SJungho Lee 
245060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`,
2451f1580f4eSBarry Smith           `MatSchurComplementSetAinvType()`, `PCLSC`,
2452feefa0e1SJacob Faibussowitsch 
2453e69d4d44SBarry Smith @*/
2454d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurPre(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2455d71ae5a4SJacob Faibussowitsch {
2456e69d4d44SBarry Smith   PetscFunctionBegin;
24570700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2458cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurPre_C", (PC, PCFieldSplitSchurPreType, Mat), (pc, ptype, pre));
24593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2460e69d4d44SBarry Smith }
2461686bed4dSStefano Zampini 
2462d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurPrecondition(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2463d71ae5a4SJacob Faibussowitsch {
24649371c9d4SSatish Balay   return PCFieldSplitSetSchurPre(pc, ptype, pre);
24659371c9d4SSatish Balay } /* Deprecated name */
2466e69d4d44SBarry Smith 
246737a82bf0SJed Brown /*@
246837a82bf0SJed Brown   PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
2469f1580f4eSBarry Smith   preconditioned.  See `PCFieldSplitSetSchurPre()` for details.
247037a82bf0SJed Brown 
2471c3339decSBarry Smith   Logically Collective
247237a82bf0SJed Brown 
2473f899ff85SJose E. Roman   Input Parameter:
247437a82bf0SJed Brown . pc - the preconditioner context
247537a82bf0SJed Brown 
247637a82bf0SJed Brown   Output Parameters:
2477d59693daSPierre Jolivet + ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11`, `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER`
2478d59693daSPierre Jolivet - pre   - matrix to use for preconditioning (with `PC_FIELDSPLIT_SCHUR_PRE_USER`), or `NULL`
247937a82bf0SJed Brown 
248037a82bf0SJed Brown   Level: intermediate
248137a82bf0SJed Brown 
2482d59693daSPierre Jolivet .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCLSC`
2483feefa0e1SJacob Faibussowitsch 
248437a82bf0SJed Brown @*/
2485d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurPre(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre)
2486d71ae5a4SJacob Faibussowitsch {
248737a82bf0SJed Brown   PetscFunctionBegin;
248837a82bf0SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2489cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSchurPre_C", (PC, PCFieldSplitSchurPreType *, Mat *), (pc, ptype, pre));
24903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2491e69d4d44SBarry Smith }
2492e69d4d44SBarry Smith 
249345e7fc46SDmitry Karpeev /*@
2494f1580f4eSBarry Smith   PCFieldSplitSchurGetS -  extract the `MATSCHURCOMPLEMENT` object used by this `PCFIELDSPLIT` in case it needs to be configured separately
249545e7fc46SDmitry Karpeev 
249620f4b53cSBarry Smith   Not Collective
249745e7fc46SDmitry Karpeev 
249845e7fc46SDmitry Karpeev   Input Parameter:
249945e7fc46SDmitry Karpeev . pc - the preconditioner context
250045e7fc46SDmitry Karpeev 
250145e7fc46SDmitry Karpeev   Output Parameter:
2502470b340bSDmitry Karpeev . S - the Schur complement matrix
250345e7fc46SDmitry Karpeev 
250460f59c3bSBarry Smith   Level: advanced
250560f59c3bSBarry Smith 
2506f1580f4eSBarry Smith   Note:
2507f1580f4eSBarry Smith   This matrix should not be destroyed using `MatDestroy()`; rather, use `PCFieldSplitSchurRestoreS()`.
250845e7fc46SDmitry Karpeev 
250960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MATSCHURCOMPLEMENT`, `PCFieldSplitSchurRestoreS()`,
2510f1580f4eSBarry Smith           `MatCreateSchurComplement()`, `MatSchurComplementGetKSP()`, `MatSchurComplementComputeExplicitOperator()`, `MatGetSchurComplement()`
251145e7fc46SDmitry Karpeev @*/
2512d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetS(PC pc, Mat *S)
2513d71ae5a4SJacob Faibussowitsch {
251445e7fc46SDmitry Karpeev   const char    *t;
251545e7fc46SDmitry Karpeev   PetscBool      isfs;
251645e7fc46SDmitry Karpeev   PC_FieldSplit *jac;
251745e7fc46SDmitry Karpeev 
251845e7fc46SDmitry Karpeev   PetscFunctionBegin;
251945e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
25209566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
25219566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
252228b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
252345e7fc46SDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
252463a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
2525470b340bSDmitry Karpeev   if (S) *S = jac->schur;
25263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
252745e7fc46SDmitry Karpeev }
252845e7fc46SDmitry Karpeev 
2529470b340bSDmitry Karpeev /*@
2530f1580f4eSBarry Smith   PCFieldSplitSchurRestoreS -  returns the `MATSCHURCOMPLEMENT` matrix used by this `PC`
2531470b340bSDmitry Karpeev 
253220f4b53cSBarry Smith   Not Collective
2533470b340bSDmitry Karpeev 
2534470b340bSDmitry Karpeev   Input Parameters:
2535470b340bSDmitry Karpeev + pc - the preconditioner context
2536a2b725a8SWilliam Gropp - S  - the Schur complement matrix
2537470b340bSDmitry Karpeev 
2538470b340bSDmitry Karpeev   Level: advanced
2539470b340bSDmitry Karpeev 
254060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MatSchurComplement`, `PCFieldSplitSchurGetS()`
2541470b340bSDmitry Karpeev @*/
2542d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurRestoreS(PC pc, Mat *S)
2543d71ae5a4SJacob Faibussowitsch {
2544470b340bSDmitry Karpeev   const char    *t;
2545470b340bSDmitry Karpeev   PetscBool      isfs;
2546470b340bSDmitry Karpeev   PC_FieldSplit *jac;
2547470b340bSDmitry Karpeev 
2548470b340bSDmitry Karpeev   PetscFunctionBegin;
2549470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
25509566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
25519566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
255228b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
2553470b340bSDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
255463a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
25557827d75bSBarry Smith   PetscCheck(S && (*S == jac->schur), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatSchurComplement restored is not the same as gotten");
25563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2557470b340bSDmitry Karpeev }
2558470b340bSDmitry Karpeev 
2559d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2560d71ae5a4SJacob Faibussowitsch {
2561e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2562e69d4d44SBarry Smith 
2563e69d4d44SBarry Smith   PetscFunctionBegin;
2564084e4875SJed Brown   jac->schurpre = ptype;
2565a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
25669566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&jac->schur_user));
2567084e4875SJed Brown     jac->schur_user = pre;
25689566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
2569084e4875SJed Brown   }
25703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2571e69d4d44SBarry Smith }
2572e69d4d44SBarry Smith 
2573d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre)
2574d71ae5a4SJacob Faibussowitsch {
257537a82bf0SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
257637a82bf0SJed Brown 
257737a82bf0SJed Brown   PetscFunctionBegin;
25786056e507SPierre Jolivet   if (ptype) *ptype = jac->schurpre;
25796056e507SPierre Jolivet   if (pre) *pre = jac->schur_user;
25803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
258137a82bf0SJed Brown }
258237a82bf0SJed Brown 
2583ab1df9f5SJed Brown /*@
25841d27aa22SBarry Smith   PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner {cite}`murphy2000note` and {cite}`ipsen2001note`
2585ab1df9f5SJed Brown 
2586c3339decSBarry Smith   Collective
2587ab1df9f5SJed Brown 
2588ab1df9f5SJed Brown   Input Parameters:
2589ab1df9f5SJed Brown + pc    - the preconditioner context
2590f1580f4eSBarry Smith - ftype - which blocks of factorization to retain, `PC_FIELDSPLIT_SCHUR_FACT_FULL` is default
2591ab1df9f5SJed Brown 
2592f1580f4eSBarry Smith   Options Database Key:
2593d59693daSPierre Jolivet . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - default is `full`
2594ab1df9f5SJed Brown 
2595ab1df9f5SJed Brown   Level: intermediate
2596ab1df9f5SJed Brown 
2597ab1df9f5SJed Brown   Notes:
2598ab1df9f5SJed Brown   The FULL factorization is
2599147403d9SBarry Smith .vb
2600147403d9SBarry Smith   (A   B)  = (1       0) (A   0) (1  Ainv*B)  = L D U
2601147403d9SBarry Smith   (C   E)    (C*Ainv  1) (0   S) (0       1)
2602147403d9SBarry Smith .vb
26031d27aa22SBarry 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$,
26041d27aa22SBarry Smith   and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations,
26051d27aa22SBarry Smith   thus allowing the use of `KSPMINRES)`. Sign flipping of S can be turned off with `PCFieldSplitSetSchurScale()`.
2606ab1df9f5SJed Brown 
2607147403d9SBarry Smith   If A and S are solved exactly
2608147403d9SBarry Smith .vb
2609147403d9SBarry Smith   *) FULL factorization is a direct solver.
2610f1580f4eSBarry 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.
2611f1580f4eSBarry 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.
2612147403d9SBarry Smith .ve
2613ab1df9f5SJed Brown 
2614f1580f4eSBarry Smith   If the iteration count is very low, consider using `KSPFGMRES` or `KSPGCR` which can use one less preconditioner
26150ffb0e17SBarry 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.
26160ffb0e17SBarry Smith 
2617f1580f4eSBarry Smith   For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with `KSPMINRES`.
26180ffb0e17SBarry Smith 
26191d27aa22SBarry Smith   A flexible method like `KSPFGMRES` or `KSPGCR`, [](sec_flexibleksp), must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used to solve with A or S).
2620ab1df9f5SJed Brown 
26211d27aa22SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurScale()`,
26221d27aa22SBarry Smith           [](sec_flexibleksp)
2623ab1df9f5SJed Brown @*/
2624d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurFactType(PC pc, PCFieldSplitSchurFactType ftype)
2625d71ae5a4SJacob Faibussowitsch {
2626ab1df9f5SJed Brown   PetscFunctionBegin;
2627ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2628cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurFactType_C", (PC, PCFieldSplitSchurFactType), (pc, ftype));
26293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2630ab1df9f5SJed Brown }
2631ab1df9f5SJed Brown 
2632d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc, PCFieldSplitSchurFactType ftype)
2633d71ae5a4SJacob Faibussowitsch {
2634ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2635ab1df9f5SJed Brown 
2636ab1df9f5SJed Brown   PetscFunctionBegin;
2637ab1df9f5SJed Brown   jac->schurfactorization = ftype;
26383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2639ab1df9f5SJed Brown }
2640ab1df9f5SJed Brown 
2641c096484dSStefano Zampini /*@
2642f1580f4eSBarry Smith   PCFieldSplitSetSchurScale -  Controls the sign flip of S for `PC_FIELDSPLIT_SCHUR_FACT_DIAG`.
2643c096484dSStefano Zampini 
2644c3339decSBarry Smith   Collective
2645c096484dSStefano Zampini 
2646c096484dSStefano Zampini   Input Parameters:
2647c096484dSStefano Zampini + pc    - the preconditioner context
2648c096484dSStefano Zampini - scale - scaling factor for the Schur complement
2649c096484dSStefano Zampini 
2650f1580f4eSBarry Smith   Options Database Key:
26511d27aa22SBarry Smith . -pc_fieldsplit_schur_scale <scale> - default is -1.0
2652c096484dSStefano Zampini 
2653c096484dSStefano Zampini   Level: intermediate
2654c096484dSStefano Zampini 
265542747ad1SJacob Faibussowitsch .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurFactType`, `PCFieldSplitSetSchurFactType()`
2656c096484dSStefano Zampini @*/
2657d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurScale(PC pc, PetscScalar scale)
2658d71ae5a4SJacob Faibussowitsch {
2659c096484dSStefano Zampini   PetscFunctionBegin;
2660c096484dSStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2661c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc, scale, 2);
2662cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurScale_C", (PC, PetscScalar), (pc, scale));
26633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2664c096484dSStefano Zampini }
2665c096484dSStefano Zampini 
2666d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc, PetscScalar scale)
2667d71ae5a4SJacob Faibussowitsch {
2668c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2669c096484dSStefano Zampini 
2670c096484dSStefano Zampini   PetscFunctionBegin;
2671c096484dSStefano Zampini   jac->schurscale = scale;
26723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2673c096484dSStefano Zampini }
2674c096484dSStefano Zampini 
267530ad9308SMatthew Knepley /*@C
26768c03b21aSDmitry Karpeev   PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
267730ad9308SMatthew Knepley 
2678c3339decSBarry Smith   Collective
267930ad9308SMatthew Knepley 
268030ad9308SMatthew Knepley   Input Parameter:
268130ad9308SMatthew Knepley . pc - the preconditioner context
268230ad9308SMatthew Knepley 
268330ad9308SMatthew Knepley   Output Parameters:
2684a04f6461SBarry Smith + A00 - the (0,0) block
2685a04f6461SBarry Smith . A01 - the (0,1) block
2686a04f6461SBarry Smith . A10 - the (1,0) block
2687a04f6461SBarry Smith - A11 - the (1,1) block
268830ad9308SMatthew Knepley 
268930ad9308SMatthew Knepley   Level: advanced
269030ad9308SMatthew Knepley 
269160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `MatSchurComplementGetSubMatrices()`, `MatSchurComplementSetSubMatrices()`
269230ad9308SMatthew Knepley @*/
2693d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc, Mat *A00, Mat *A01, Mat *A10, Mat *A11)
2694d71ae5a4SJacob Faibussowitsch {
269530ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
269630ad9308SMatthew Knepley 
269730ad9308SMatthew Knepley   PetscFunctionBegin;
26980700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
269908401ef6SPierre Jolivet   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2700a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2701a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2702a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2703a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
27043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
270530ad9308SMatthew Knepley }
270630ad9308SMatthew Knepley 
2707b09e027eSCarola Kruse /*@
27081d27aa22SBarry Smith   PCFieldSplitSetGKBTol -  Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2709b09e027eSCarola Kruse 
2710c3339decSBarry Smith   Collective
2711e071a0a4SCarola Kruse 
2712b09e027eSCarola Kruse   Input Parameters:
2713b09e027eSCarola Kruse + pc        - the preconditioner context
2714b09e027eSCarola Kruse - tolerance - the solver tolerance
2715b09e027eSCarola Kruse 
2716f1580f4eSBarry Smith   Options Database Key:
27171d27aa22SBarry Smith . -pc_fieldsplit_gkb_tol <tolerance> - default is 1e-5
2718b09e027eSCarola Kruse 
2719b09e027eSCarola Kruse   Level: intermediate
2720b09e027eSCarola Kruse 
2721f1580f4eSBarry Smith   Note:
27221d27aa22SBarry Smith   The generalized GKB algorithm {cite}`arioli2013` uses a lower bound estimate of the error in energy norm as stopping criterion.
2723f1580f4eSBarry Smith   It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than
27241d27aa22SBarry Smith   this estimate, the stopping criterion is satisfactory in practical cases.
2725f1580f4eSBarry Smith 
272660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBMaxit()`
2727b09e027eSCarola Kruse @*/
2728d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBTol(PC pc, PetscReal tolerance)
2729d71ae5a4SJacob Faibussowitsch {
2730b09e027eSCarola Kruse   PetscFunctionBegin;
2731b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2732de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, tolerance, 2);
2733cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBTol_C", (PC, PetscReal), (pc, tolerance));
27343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2735b09e027eSCarola Kruse }
2736b09e027eSCarola Kruse 
2737d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc, PetscReal tolerance)
2738d71ae5a4SJacob Faibussowitsch {
2739b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2740b09e027eSCarola Kruse 
2741b09e027eSCarola Kruse   PetscFunctionBegin;
2742b09e027eSCarola Kruse   jac->gkbtol = tolerance;
27433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2744b09e027eSCarola Kruse }
2745b09e027eSCarola Kruse 
2746b09e027eSCarola Kruse /*@
2747f1580f4eSBarry Smith   PCFieldSplitSetGKBMaxit -  Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization preconditioner in `PCFIELDSPLIT`
2748b09e027eSCarola Kruse 
2749c3339decSBarry Smith   Collective
2750b09e027eSCarola Kruse 
2751b09e027eSCarola Kruse   Input Parameters:
2752b09e027eSCarola Kruse + pc    - the preconditioner context
2753b09e027eSCarola Kruse - maxit - the maximum number of iterations
2754b09e027eSCarola Kruse 
2755f1580f4eSBarry Smith   Options Database Key:
27561d27aa22SBarry Smith . -pc_fieldsplit_gkb_maxit <maxit> - default is 100
2757b09e027eSCarola Kruse 
2758b09e027eSCarola Kruse   Level: intermediate
2759b09e027eSCarola Kruse 
276060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBNu()`
2761b09e027eSCarola Kruse @*/
2762d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc, PetscInt maxit)
2763d71ae5a4SJacob Faibussowitsch {
2764b09e027eSCarola Kruse   PetscFunctionBegin;
2765b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2766de482cd7SCarola Kruse   PetscValidLogicalCollectiveInt(pc, maxit, 2);
2767cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBMaxit_C", (PC, PetscInt), (pc, maxit));
27683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2769b09e027eSCarola Kruse }
2770b09e027eSCarola Kruse 
2771d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc, PetscInt maxit)
2772d71ae5a4SJacob Faibussowitsch {
2773b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2774b09e027eSCarola Kruse 
2775b09e027eSCarola Kruse   PetscFunctionBegin;
2776b09e027eSCarola Kruse   jac->gkbmaxit = maxit;
27773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2778b09e027eSCarola Kruse }
2779b09e027eSCarola Kruse 
2780b09e027eSCarola Kruse /*@
27811d27aa22SBarry Smith   PCFieldSplitSetGKBDelay -  Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization {cite}`arioli2013` in `PCFIELDSPLIT`
2782e071a0a4SCarola Kruse   preconditioner.
2783b09e027eSCarola Kruse 
2784c3339decSBarry Smith   Collective
2785b09e027eSCarola Kruse 
2786b09e027eSCarola Kruse   Input Parameters:
2787b09e027eSCarola Kruse + pc    - the preconditioner context
2788b09e027eSCarola Kruse - delay - the delay window in the lower bound estimate
2789b09e027eSCarola Kruse 
2790f1580f4eSBarry Smith   Options Database Key:
27911d27aa22SBarry Smith . -pc_fieldsplit_gkb_delay <delay> - default is 5
2792b09e027eSCarola Kruse 
2793b09e027eSCarola Kruse   Level: intermediate
2794b09e027eSCarola Kruse 
27951d27aa22SBarry Smith   Notes:
27961d27aa22SBarry 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 $
27971d27aa22SBarry 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
27981d27aa22SBarry Smith   at least (`delay` + 1) iterations to stop.
2799f1580f4eSBarry Smith 
28001d27aa22SBarry Smith   For more details on the generalized Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to {cite}`arioli2013`
2801f1580f4eSBarry Smith 
280260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
2803b09e027eSCarola Kruse @*/
2804d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBDelay(PC pc, PetscInt delay)
2805d71ae5a4SJacob Faibussowitsch {
2806b09e027eSCarola Kruse   PetscFunctionBegin;
2807b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2808b09e027eSCarola Kruse   PetscValidLogicalCollectiveInt(pc, delay, 2);
2809cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBDelay_C", (PC, PetscInt), (pc, delay));
28103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2811b09e027eSCarola Kruse }
2812b09e027eSCarola Kruse 
2813d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc, PetscInt delay)
2814d71ae5a4SJacob Faibussowitsch {
2815b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2816b09e027eSCarola Kruse 
2817b09e027eSCarola Kruse   PetscFunctionBegin;
2818b09e027eSCarola Kruse   jac->gkbdelay = delay;
28193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2820b09e027eSCarola Kruse }
2821b09e027eSCarola Kruse 
2822b09e027eSCarola Kruse /*@
28231d27aa22SBarry Smith   PCFieldSplitSetGKBNu -  Sets the scalar value nu >= 0 in the transformation H = A00 + nu*A01*A01' of the (1,1) block in the
28241d27aa22SBarry Smith   Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2825b09e027eSCarola Kruse 
2826c3339decSBarry Smith   Collective
2827f1580f4eSBarry Smith 
2828f1580f4eSBarry Smith   Input Parameters:
2829f1580f4eSBarry Smith + pc - the preconditioner context
2830f1580f4eSBarry Smith - nu - the shift parameter
2831f1580f4eSBarry Smith 
283220f4b53cSBarry Smith   Options Database Key:
28331d27aa22SBarry Smith . -pc_fieldsplit_gkb_nu <nu> - default is 1
2834f1580f4eSBarry Smith 
2835f1580f4eSBarry Smith   Level: intermediate
2836b09e027eSCarola Kruse 
2837b09e027eSCarola Kruse   Notes:
28381d27aa22SBarry Smith   This shift is in general done to obtain better convergence properties for the outer loop of the algorithm. This is often achieved by choosing `nu` sufficiently large. However,
28391d27aa22SBarry Smith   if `nu` is chosen too large, the matrix H might be badly conditioned and the solution of the linear system $Hx = b$ in the inner loop becomes difficult. It is therefore
2840b09e027eSCarola Kruse   necessary to find a good balance in between the convergence of the inner and outer loop.
2841b09e027eSCarola Kruse 
28421d27aa22SBarry Smith   For `nu` = 0, no shift is done. In this case A00 has to be positive definite. The matrix N in {cite}`arioli2013` is then chosen as identity.
2843b09e027eSCarola Kruse 
284460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
2845b09e027eSCarola Kruse @*/
2846d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBNu(PC pc, PetscReal nu)
2847d71ae5a4SJacob Faibussowitsch {
2848b09e027eSCarola Kruse   PetscFunctionBegin;
2849b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2850de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, nu, 2);
2851cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBNu_C", (PC, PetscReal), (pc, nu));
28523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2853b09e027eSCarola Kruse }
2854b09e027eSCarola Kruse 
2855d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc, PetscReal nu)
2856d71ae5a4SJacob Faibussowitsch {
2857b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2858b09e027eSCarola Kruse 
2859b09e027eSCarola Kruse   PetscFunctionBegin;
2860b09e027eSCarola Kruse   jac->gkbnu = nu;
28613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2862b09e027eSCarola Kruse }
2863b09e027eSCarola Kruse 
2864d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc, PCCompositeType type)
2865d71ae5a4SJacob Faibussowitsch {
286679416396SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
286779416396SBarry Smith 
286879416396SBarry Smith   PetscFunctionBegin;
286979416396SBarry Smith   jac->type = type;
28702e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
28712e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
28722e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
28732e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
28742e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
28752e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
28762e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
28772e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
28782e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
2879e071a0a4SCarola Kruse 
28803b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
28813b224e63SBarry Smith     pc->ops->apply          = PCApply_FieldSplit_Schur;
28827b665727SPierre Jolivet     pc->ops->applytranspose = PCApplyTranspose_FieldSplit_Schur;
28833b224e63SBarry Smith     pc->ops->view           = PCView_FieldSplit_Schur;
28842fa5cd67SKarl Rupp 
28859566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit_Schur));
28869566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", PCFieldSplitSetSchurPre_FieldSplit));
28879566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", PCFieldSplitGetSchurPre_FieldSplit));
28889566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", PCFieldSplitSetSchurFactType_FieldSplit));
28899566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", PCFieldSplitSetSchurScale_FieldSplit));
2890a51937d4SCarola Kruse   } else if (type == PC_COMPOSITE_GKB) {
2891a51937d4SCarola Kruse     pc->ops->apply = PCApply_FieldSplit_GKB;
2892a51937d4SCarola Kruse     pc->ops->view  = PCView_FieldSplit_GKB;
2893e69d4d44SBarry Smith 
28949566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
28959566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", PCFieldSplitSetGKBTol_FieldSplit));
28969566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", PCFieldSplitSetGKBMaxit_FieldSplit));
28979566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", PCFieldSplitSetGKBNu_FieldSplit));
28989566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", PCFieldSplitSetGKBDelay_FieldSplit));
28993b224e63SBarry Smith   } else {
29003b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
29013b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
29022fa5cd67SKarl Rupp 
29039566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
29043b224e63SBarry Smith   }
29053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
290679416396SBarry Smith }
290779416396SBarry Smith 
2908d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc, PetscInt bs)
2909d71ae5a4SJacob Faibussowitsch {
291051f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
291151f519a2SBarry Smith 
291251f519a2SBarry Smith   PetscFunctionBegin;
291363a3b9bcSJacob Faibussowitsch   PetscCheck(bs >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Blocksize must be positive, you gave %" PetscInt_FMT, bs);
29142472a847SBarry 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);
291551f519a2SBarry Smith   jac->bs = bs;
29163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
291751f519a2SBarry Smith }
291851f519a2SBarry Smith 
2919d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetCoordinates_FieldSplit(PC pc, PetscInt dim, PetscInt nloc, PetscReal coords[])
2920d71ae5a4SJacob Faibussowitsch {
29215ddf11f8SNicolas Barnafi   PC_FieldSplit    *jac           = (PC_FieldSplit *)pc->data;
29225ddf11f8SNicolas Barnafi   PC_FieldSplitLink ilink_current = jac->head;
29235ddf11f8SNicolas Barnafi   IS                is_owned;
29245ddf11f8SNicolas Barnafi 
29255ddf11f8SNicolas Barnafi   PetscFunctionBegin;
29265ddf11f8SNicolas Barnafi   jac->coordinates_set = PETSC_TRUE; // Internal flag
2927f3fa974cSJacob Faibussowitsch   PetscCall(MatGetOwnershipIS(pc->mat, &is_owned, NULL));
29285ddf11f8SNicolas Barnafi 
29295ddf11f8SNicolas Barnafi   while (ilink_current) {
29305ddf11f8SNicolas Barnafi     // For each IS, embed it to get local coords indces
29315ddf11f8SNicolas Barnafi     IS              is_coords;
29325ddf11f8SNicolas Barnafi     PetscInt        ndofs_block;
29335ddf11f8SNicolas Barnafi     const PetscInt *block_dofs_enumeration; // Numbering of the dofs relevant to the current block
29345ddf11f8SNicolas Barnafi 
29355ddf11f8SNicolas Barnafi     // Setting drop to true for safety. It should make no difference.
29369566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink_current->is, is_owned, PETSC_TRUE, &is_coords));
29379566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(is_coords, &ndofs_block));
29389566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(is_coords, &block_dofs_enumeration));
29395ddf11f8SNicolas Barnafi 
29405ddf11f8SNicolas Barnafi     // Allocate coordinates vector and set it directly
29419566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(ndofs_block * dim, &(ilink_current->coords)));
29425ddf11f8SNicolas Barnafi     for (PetscInt dof = 0; dof < ndofs_block; ++dof) {
2943ad540459SPierre Jolivet       for (PetscInt d = 0; d < dim; ++d) (ilink_current->coords)[dim * dof + d] = coords[dim * block_dofs_enumeration[dof] + d];
29445ddf11f8SNicolas Barnafi     }
29455ddf11f8SNicolas Barnafi     ilink_current->dim   = dim;
29465ddf11f8SNicolas Barnafi     ilink_current->ndofs = ndofs_block;
29479566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(is_coords, &block_dofs_enumeration));
29489566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is_coords));
29495ddf11f8SNicolas Barnafi     ilink_current = ilink_current->next;
29505ddf11f8SNicolas Barnafi   }
29519566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_owned));
29523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
29535ddf11f8SNicolas Barnafi }
29545ddf11f8SNicolas Barnafi 
2955bc08b0f1SBarry Smith /*@
2956f1580f4eSBarry Smith   PCFieldSplitSetType - Sets the type, `PCCompositeType`, of a `PCFIELDSPLIT`
295779416396SBarry Smith 
2958c3339decSBarry Smith   Collective
295979416396SBarry Smith 
2960d8d19677SJose E. Roman   Input Parameters:
2961a2b725a8SWilliam Gropp + pc   - the preconditioner context
2962f1580f4eSBarry Smith - type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
296379416396SBarry Smith 
296479416396SBarry Smith   Options Database Key:
29651d27aa22SBarry Smith . -pc_fieldsplit_type <one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
296679416396SBarry Smith 
2967feefa0e1SJacob Faibussowitsch   Level: intermediate
296879416396SBarry Smith 
296960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCCompositeType`, `PCCompositeGetType()`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`,
2970f1580f4eSBarry Smith           `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
297179416396SBarry Smith @*/
2972d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetType(PC pc, PCCompositeType type)
2973d71ae5a4SJacob Faibussowitsch {
297479416396SBarry Smith   PetscFunctionBegin;
29750700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2976cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetType_C", (PC, PCCompositeType), (pc, type));
29773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
297879416396SBarry Smith }
297979416396SBarry Smith 
2980b02e2d75SMatthew G Knepley /*@
2981f1580f4eSBarry Smith   PCFieldSplitGetType - Gets the type, `PCCompositeType`, of a `PCFIELDSPLIT`
2982b02e2d75SMatthew G Knepley 
2983b02e2d75SMatthew G Knepley   Not collective
2984b02e2d75SMatthew G Knepley 
2985b02e2d75SMatthew G Knepley   Input Parameter:
2986b02e2d75SMatthew G Knepley . pc - the preconditioner context
2987b02e2d75SMatthew G Knepley 
2988b02e2d75SMatthew G Knepley   Output Parameter:
2989f1580f4eSBarry Smith . type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
2990b02e2d75SMatthew G Knepley 
2991feefa0e1SJacob Faibussowitsch   Level: intermediate
2992b02e2d75SMatthew G Knepley 
299360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCompositeSetType()`, `PCFIELDSPLIT`, `PCCompositeType`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`,
2994f1580f4eSBarry Smith           `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
2995b02e2d75SMatthew G Knepley @*/
2996d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2997d71ae5a4SJacob Faibussowitsch {
2998b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2999b02e2d75SMatthew G Knepley 
3000b02e2d75SMatthew G Knepley   PetscFunctionBegin;
3001b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
30024f572ea9SToby Isaac   PetscAssertPointer(type, 2);
3003b02e2d75SMatthew G Knepley   *type = jac->type;
30043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3005b02e2d75SMatthew G Knepley }
3006b02e2d75SMatthew G Knepley 
30074ab8060aSDmitry Karpeev /*@
3008f1580f4eSBarry Smith   PCFieldSplitSetDMSplits - Flags whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible.
30094ab8060aSDmitry Karpeev 
3010c3339decSBarry Smith   Logically Collective
30114ab8060aSDmitry Karpeev 
30124ab8060aSDmitry Karpeev   Input Parameters:
30134ab8060aSDmitry Karpeev + pc  - the preconditioner context
3014f1580f4eSBarry Smith - flg - boolean indicating whether to use field splits defined by the `DM`
30154ab8060aSDmitry Karpeev 
30164ab8060aSDmitry Karpeev   Options Database Key:
3017f1580f4eSBarry Smith . -pc_fieldsplit_dm_splits <bool> - use the field splits defined by the `DM`
30184ab8060aSDmitry Karpeev 
3019feefa0e1SJacob Faibussowitsch   Level: intermediate
30204ab8060aSDmitry Karpeev 
302160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDMSplits()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()`
30224ab8060aSDmitry Karpeev @*/
3023d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDMSplits(PC pc, PetscBool flg)
3024d71ae5a4SJacob Faibussowitsch {
30254ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
30264ab8060aSDmitry Karpeev   PetscBool      isfs;
30274ab8060aSDmitry Karpeev 
30284ab8060aSDmitry Karpeev   PetscFunctionBegin;
30294ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
30304ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc, flg, 2);
30319566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
3032ad540459SPierre Jolivet   if (isfs) jac->dm_splits = flg;
30333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30344ab8060aSDmitry Karpeev }
30354ab8060aSDmitry Karpeev 
30364ab8060aSDmitry Karpeev /*@
3037f1580f4eSBarry Smith   PCFieldSplitGetDMSplits - Returns flag indicating whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible.
30384ab8060aSDmitry Karpeev 
30394ab8060aSDmitry Karpeev   Logically Collective
30404ab8060aSDmitry Karpeev 
30414ab8060aSDmitry Karpeev   Input Parameter:
30424ab8060aSDmitry Karpeev . pc - the preconditioner context
30434ab8060aSDmitry Karpeev 
30444ab8060aSDmitry Karpeev   Output Parameter:
3045f1580f4eSBarry Smith . flg - boolean indicating whether to use field splits defined by the `DM`
30464ab8060aSDmitry Karpeev 
3047feefa0e1SJacob Faibussowitsch   Level: intermediate
30484ab8060aSDmitry Karpeev 
304960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDMSplits()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()`
30504ab8060aSDmitry Karpeev @*/
3051d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDMSplits(PC pc, PetscBool *flg)
3052d71ae5a4SJacob Faibussowitsch {
30534ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
30544ab8060aSDmitry Karpeev   PetscBool      isfs;
30554ab8060aSDmitry Karpeev 
30564ab8060aSDmitry Karpeev   PetscFunctionBegin;
30574ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
30584f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
30599566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
30604ab8060aSDmitry Karpeev   if (isfs) {
30614ab8060aSDmitry Karpeev     if (flg) *flg = jac->dm_splits;
30624ab8060aSDmitry Karpeev   }
30633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30644ab8060aSDmitry Karpeev }
30654ab8060aSDmitry Karpeev 
30667b752e3dSPatrick Sanan /*@
3067f1580f4eSBarry Smith   PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries.
30687b752e3dSPatrick Sanan 
30697b752e3dSPatrick Sanan   Logically Collective
30707b752e3dSPatrick Sanan 
30717b752e3dSPatrick Sanan   Input Parameter:
30727b752e3dSPatrick Sanan . pc - the preconditioner context
30737b752e3dSPatrick Sanan 
30747b752e3dSPatrick Sanan   Output Parameter:
30757b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not
30767b752e3dSPatrick Sanan 
3077feefa0e1SJacob Faibussowitsch   Level: intermediate
30787b752e3dSPatrick Sanan 
307960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDetectSaddlePoint()`
30807b752e3dSPatrick Sanan @*/
3081d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc, PetscBool *flg)
3082d71ae5a4SJacob Faibussowitsch {
30837b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
30847b752e3dSPatrick Sanan 
30857b752e3dSPatrick Sanan   PetscFunctionBegin;
30867b752e3dSPatrick Sanan   *flg = jac->detect;
30873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30887b752e3dSPatrick Sanan }
30897b752e3dSPatrick Sanan 
30907b752e3dSPatrick Sanan /*@
3091f1580f4eSBarry Smith   PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries.
30927b752e3dSPatrick Sanan 
30937b752e3dSPatrick Sanan   Logically Collective
30947b752e3dSPatrick Sanan 
30957b752e3dSPatrick Sanan   Input Parameter:
30967b752e3dSPatrick Sanan . pc - the preconditioner context
30977b752e3dSPatrick Sanan 
30987b752e3dSPatrick Sanan   Output Parameter:
30997b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not
31007b752e3dSPatrick Sanan 
31017b752e3dSPatrick Sanan   Options Database Key:
3102147403d9SBarry Smith . -pc_fieldsplit_detect_saddle_point <bool> - detect and use the saddle point
3103147403d9SBarry Smith 
3104feefa0e1SJacob Faibussowitsch   Level: intermediate
310560f59c3bSBarry Smith 
3106f1580f4eSBarry Smith   Note:
3107f1580f4eSBarry 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()`).
31087b752e3dSPatrick Sanan 
310960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDetectSaddlePoint()`, `PCFieldSplitSetType()`, `PCFieldSplitSetSchurPre()`, `PC_FIELDSPLIT_SCHUR_PRE_SELF`
31107b752e3dSPatrick Sanan @*/
3111d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc, PetscBool flg)
3112d71ae5a4SJacob Faibussowitsch {
31137b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
31147b752e3dSPatrick Sanan 
31157b752e3dSPatrick Sanan   PetscFunctionBegin;
31167b752e3dSPatrick Sanan   jac->detect = flg;
31177b752e3dSPatrick Sanan   if (jac->detect) {
31189566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetType(pc, PC_COMPOSITE_SCHUR));
31199566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetSchurPre(pc, PC_FIELDSPLIT_SCHUR_PRE_SELF, NULL));
31207b752e3dSPatrick Sanan   }
31213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
31227b752e3dSPatrick Sanan }
31237b752e3dSPatrick Sanan 
31240971522cSBarry Smith /*MC
3125a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
3126f1580f4eSBarry Smith    collections of variables (that may overlap) called splits. See [the users manual section on "Solving Block Matrices"](sec_block_matrices) for more details.
31270971522cSBarry Smith 
312879416396SBarry Smith    Options Database Keys:
3129de37d9f1SPatrick Sanan +   -pc_fieldsplit_%d_fields <a,b,..>                                                - indicates the fields to be used in the `%d`'th split
313081540f2fSBarry Smith .   -pc_fieldsplit_default                                                           - automatically add any fields to additional splits that have not
3131de37d9f1SPatrick Sanan                                                                                      been supplied explicitly by `-pc_fieldsplit_%d_fields`
313281540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs>                                                   - size of block that defines fields (i.e. there are bs fields)
3133a51937d4SCarola Kruse .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting
3134d59693daSPierre Jolivet .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full>                     - default is `a11`; see `PCFieldSplitSetSchurPre()`
31351d27aa22SBarry Smith .   -pc_fieldsplit_schur_fact_type <diag,lower,upper,full>                           - set factorization type when using `-pc_fieldsplit_type schur`;
31361d27aa22SBarry Smith                                                                                      see `PCFieldSplitSetSchurFactType()`
3137fb6809a2SPatrick Sanan -   -pc_fieldsplit_detect_saddle_point                                               - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
313879416396SBarry Smith 
3139de37d9f1SPatrick Sanan      Options prefixes for inner solvers when using the Schur complement preconditioner are `-fieldsplit_0_` and `-fieldsplit_1_` .
3140de37d9f1SPatrick Sanan      The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is `-fieldsplit_0_`
314160f59c3bSBarry Smith      For all other solvers they are `-fieldsplit_%d_` for the `%d`'th field; use `-fieldsplit_` for all fields.
314260f59c3bSBarry Smith 
314360f59c3bSBarry Smith      To set options on the solvers for each block append `-fieldsplit_` to all the `PC`
314460f59c3bSBarry Smith      options database keys. For example, `-fieldsplit_pc_type ilu` `-fieldsplit_pc_factor_levels 1`
314560f59c3bSBarry Smith 
314660f59c3bSBarry Smith      To set the options on the solvers separate for each block call `PCFieldSplitGetSubKSP()`
314760f59c3bSBarry Smith       and set the options directly on the resulting `KSP` object
314860f59c3bSBarry Smith 
314960f59c3bSBarry Smith     Level: intermediate
31505d4c12cdSJungho Lee 
3151c8a0d604SMatthew G Knepley    Notes:
3152f1580f4eSBarry Smith     Use `PCFieldSplitSetFields()` to set splits defined by "strided" entries and `PCFieldSplitSetIS()`
3153f1580f4eSBarry Smith      to define a split by an arbitrary collection of entries.
3154d32f9abdSBarry Smith 
3155f1580f4eSBarry Smith       If no splits are set the default is used. The splits are defined by entries strided by bs,
3156de37d9f1SPatrick Sanan       beginning at 0 then 1, etc to bs-1. The block size can be set with `PCFieldSplitSetBlockSize()`,
3157d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
3158de37d9f1SPatrick Sanan       to `KSPSetOperators()`/`PCSetOperators()`.
3159d32f9abdSBarry Smith 
3160de37d9f1SPatrick Sanan       For the Schur complement preconditioner if
31611d71051fSDmitry Karpeev 
3162de37d9f1SPatrick Sanan       ```{math}
3163de37d9f1SPatrick Sanan       J = \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{10} & A_{11} \end{array}\right]
3164de37d9f1SPatrick Sanan       ```
3165e69d4d44SBarry Smith 
3166de37d9f1SPatrick Sanan       the preconditioner using `full` factorization is logically
3167de37d9f1SPatrick Sanan       ```{math}
3168ecaa082aSMatthew Knepley       \left[\begin{array}{cc} I & -\text{ksp}(A_{00}) A_{01} \\ 0 & I \end{array}\right] \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\ 0 & \text{ksp}(S) \end{array}\right] \left[\begin{array}{cc} I & 0 \\ -A_{10} \text{ksp}(A_{00}) & I \end{array}\right]
3169de37d9f1SPatrick Sanan       ```
3170de37d9f1SPatrick Sanan      where the action of $\text{inv}(A_{00})$ is applied using the KSP solver with prefix `-fieldsplit_0_`.  $S$ is the Schur complement
3171de37d9f1SPatrick Sanan      ```{math}
3172223e5b4fSPatrick Sanan      S = A_{11} - A_{10} \text{ksp}(A_{00}) A_{01}
3173de37d9f1SPatrick Sanan      ```
3174de37d9f1SPatrick 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
317560f59c3bSBarry Smith      in providing the SECOND split or 1 if not given). For `PCFieldSplitGetSubKSP()` when field number is 0,
3176de37d9f1SPatrick Sanan      it returns the KSP associated with `-fieldsplit_0_` while field number 1 gives `-fieldsplit_1_` KSP. By default
3177de37d9f1SPatrick Sanan      $A_{11}$ is used to construct a preconditioner for $S$, use `PCFieldSplitSetSchurPre()` for all the possible ways to construct the preconditioner for $S$.
3178de37d9f1SPatrick Sanan 
3179de37d9f1SPatrick Sanan      The factorization type is set using `-pc_fieldsplit_schur_fact_type <diag, lower, upper, full>`. `full` is shown above,
3180de37d9f1SPatrick Sanan      `diag` gives
3181de37d9f1SPatrick Sanan       ```{math}
3182de37d9f1SPatrick Sanan       \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\  0 & -\text{ksp}(S) \end{array}\right]
3183de37d9f1SPatrick Sanan       ```
3184de37d9f1SPatrick 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
3185de37d9f1SPatrick Sanan      can be turned off with `PCFieldSplitSetSchurScale()` or by command line `-pc_fieldsplit_schur_scale 1.0`. The `lower` factorization is the inverse of
3186de37d9f1SPatrick Sanan       ```{math}
3187de37d9f1SPatrick Sanan       \left[\begin{array}{cc} A_{00} & 0 \\  A_{10} & S \end{array}\right]
3188de37d9f1SPatrick Sanan       ```
3189de37d9f1SPatrick Sanan      where the inverses of A_{00} and S are applied using KSPs. The upper factorization is the inverse of
3190de37d9f1SPatrick Sanan       ```{math}
3191de37d9f1SPatrick Sanan       \left[\begin{array}{cc} A_{00} & A_{01} \\  0 & S \end{array}\right]
3192de37d9f1SPatrick Sanan       ```
3193de37d9f1SPatrick Sanan      where again the inverses of $A_{00}$ and $S$ are applied using `KSP`s.
3194de37d9f1SPatrick Sanan 
3195de37d9f1SPatrick Sanan      If only one set of indices (one `IS`) is provided with `PCFieldSplitSetIS()` then the complement of that `IS`
3196edf189efSBarry Smith      is used automatically for a second block.
3197edf189efSBarry Smith 
3198f1580f4eSBarry Smith      The fieldsplit preconditioner cannot currently be used with the `MATBAIJ` or `MATSBAIJ` data formats if the blocksize is larger than 1.
3199f1580f4eSBarry Smith      Generally it should be used with the `MATAIJ` format.
3200ff218e97SBarry Smith 
3201ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
32021d569b8fSBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling {cite}`wesseling2009`.
3203f1580f4eSBarry Smith      One can also use `PCFIELDSPLIT`
3204ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
32050716a85fSBarry Smith 
3206de37d9f1SPatrick Sanan      See "A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations" {cite}`elman2008tcp`.
3207a6a584a2SBarry Smith 
3208de37d9f1SPatrick Sanan      The Constrained Pressure Preconditioner (CPR) can be implemented using `PCCOMPOSITE` with `PCGALERKIN`. CPR first solves an $R A P$ subsystem, updates the
3209de37d9f1SPatrick Sanan      residual on all variables (`PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)`), and then applies a simple ILU like preconditioner on all the variables.
3210a51937d4SCarola Kruse 
3211de37d9f1SPatrick Sanan      The generalized Golub-Kahan bidiagonalization preconditioner (GKB) can be applied to symmetric $2 \times 2$ block matrices of the shape
3212de37d9f1SPatrick Sanan      ```{math}
3213de37d9f1SPatrick Sanan      \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{01}' & 0 \end{array}\right]
3214de37d9f1SPatrick Sanan      ```
32151d569b8fSBarry Smith      with $A_{00}$ positive semi-definite. The implementation follows {cite}`arioli2013`. Therein, we choose $N := 1/\nu * I$ and the $(1,1)$-block of the matrix is modified to $H = _{A00} + \nu*A_{01}*A_{01}'$.
3216de37d9f1SPatrick 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_`.
3217a51937d4SCarola Kruse 
321860f59c3bSBarry Smith    Developer Note:
321960f59c3bSBarry Smith    The Schur complement functionality of `PCFIELDSPLIT` should likely be factored into its own `PC` thus simplifying the implementation of the preconditioners and their
322060f59c3bSBarry Smith    user API.
3221f1580f4eSBarry Smith 
322260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCLSC`,
3223db781477SPatrick Sanan           `PCFieldSplitGetSubKSP()`, `PCFieldSplitSchurGetSubKSP()`, `PCFieldSplitSetFields()`,
3224db781477SPatrick Sanan           `PCFieldSplitSetType()`, `PCFieldSplitSetIS()`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitSetSchurFactType()`,
3225db781477SPatrick Sanan           `MatSchurComplementSetAinvType()`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetDetectSaddlePoint()`
32260971522cSBarry Smith M*/
32270971522cSBarry Smith 
3228d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
3229d71ae5a4SJacob Faibussowitsch {
32300971522cSBarry Smith   PC_FieldSplit *jac;
32310971522cSBarry Smith 
32320971522cSBarry Smith   PetscFunctionBegin;
32334dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&jac));
32342fa5cd67SKarl Rupp 
32350971522cSBarry Smith   jac->bs                 = -1;
32360971522cSBarry Smith   jac->nsplits            = 0;
32373e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
3238e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
3239c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
3240c096484dSStefano Zampini   jac->schurscale         = -1.0;
3241fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
32427b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
3243a51937d4SCarola Kruse   jac->gkbtol             = 1e-5;
3244a51937d4SCarola Kruse   jac->gkbdelay           = 5;
3245a51937d4SCarola Kruse   jac->gkbnu              = 1;
3246a51937d4SCarola Kruse   jac->gkbmaxit           = 100;
3247de482cd7SCarola Kruse   jac->gkbmonitor         = PETSC_FALSE;
32485ddf11f8SNicolas Barnafi   jac->coordinates_set    = PETSC_FALSE;
324951f519a2SBarry Smith 
32500971522cSBarry Smith   pc->data = (void *)jac;
32510971522cSBarry Smith 
32520971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
3253421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
32540971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
3255574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
32560971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
32570971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
32580971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
32590a545947SLisandro Dalcin   pc->ops->applyrichardson = NULL;
32600971522cSBarry Smith 
32619566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", PCFieldSplitSchurGetSubKSP_FieldSplit));
32629566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
32639566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", PCFieldSplitSetFields_FieldSplit));
32649566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", PCFieldSplitSetIS_FieldSplit));
32659566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", PCFieldSplitSetType_FieldSplit));
32669566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", PCFieldSplitSetBlockSize_FieldSplit));
32679566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", PCFieldSplitRestrictIS_FieldSplit));
32689566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", PCSetCoordinates_FieldSplit));
32693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32700971522cSBarry Smith }
3271