xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision d9eadc85669fa749c7ed1d8708e7e534720294b4)
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 
34280670ca5SBarry Smith /* Precondition: jac->bs is set to a meaningful value or MATNEST */
343d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
344d71ae5a4SJacob Faibussowitsch {
3456c924f48SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
34680670ca5SBarry Smith   PetscInt       bs, i, nfields, *ifields, nfields_col, *ifields_col;
34780670ca5SBarry Smith   PetscBool      flg, flg_col, mnest;
3485d4c12cdSJungho Lee   char           optionname[128], splitname[8], optionname_col[128];
3496c924f48SJed Brown 
3506c924f48SJed Brown   PetscFunctionBegin;
35180670ca5SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &mnest));
35280670ca5SBarry Smith   if (mnest) {
35380670ca5SBarry Smith     PetscCall(MatNestGetSize(pc->pmat, &bs, NULL));
35480670ca5SBarry Smith   } else {
35580670ca5SBarry Smith     bs = jac->bs;
35680670ca5SBarry Smith   }
35780670ca5SBarry Smith   PetscCall(PetscMalloc2(bs, &ifields, bs, &ifields_col));
3586c924f48SJed Brown   for (i = 0, flg = PETSC_TRUE;; i++) {
35963a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
36063a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
36163a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname_col, sizeof(optionname_col), "-pc_fieldsplit_%" PetscInt_FMT "_fields_col", i));
36280670ca5SBarry Smith     nfields     = bs;
36380670ca5SBarry Smith     nfields_col = bs;
3649566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
3659566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname_col, ifields_col, &nfields_col, &flg_col));
3666c924f48SJed Brown     if (!flg) break;
3675d4c12cdSJungho Lee     else if (flg && !flg_col) {
36828b400f6SJacob Faibussowitsch       PetscCheck(nfields, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
3699566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields));
3702fa5cd67SKarl Rupp     } else {
3717827d75bSBarry Smith       PetscCheck(nfields && nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
37208401ef6SPierre Jolivet       PetscCheck(nfields == nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Number of row and column fields must match");
3739566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields_col));
3745d4c12cdSJungho Lee     }
3756c924f48SJed Brown   }
3766c924f48SJed Brown   if (i > 0) {
3776c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3786c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3796c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3806c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3816c924f48SJed Brown   }
38280670ca5SBarry Smith   PetscCall(PetscFree2(ifields, ifields_col));
3833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3846c924f48SJed Brown }
3856c924f48SJed Brown 
386d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
387d71ae5a4SJacob Faibussowitsch {
3880971522cSBarry Smith   PC_FieldSplit    *jac                = (PC_FieldSplit *)pc->data;
3895a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3907b752e3dSPatrick Sanan   PetscBool         fieldsplit_default = PETSC_FALSE, coupling = PETSC_FALSE;
3916c924f48SJed Brown   PetscInt          i;
3920971522cSBarry Smith 
3930971522cSBarry Smith   PetscFunctionBegin;
3947287d2a3SDmitry Karpeev   /*
395f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
3967287d2a3SDmitry Karpeev    Should probably be rewritten.
3977287d2a3SDmitry Karpeev    */
398f5f0d762SBarry Smith   if (!ilink) {
3999566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_detect_coupling", &coupling, NULL));
4007b752e3dSPatrick Sanan     if (pc->dm && jac->dm_splits && !jac->detect && !coupling) {
401bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
4020784a22cSJed Brown       char    **fieldNames;
4037b62db95SJungho Lee       IS       *fields;
404e7c4fc90SDmitry Karpeev       DM       *dms;
405bafc1b83SMatthew G Knepley       DM        subdm[128];
406bafc1b83SMatthew G Knepley       PetscBool flg;
407bafc1b83SMatthew G Knepley 
4089566063dSJacob Faibussowitsch       PetscCall(DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms));
409bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
410bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
411bafc1b83SMatthew G Knepley         PetscInt ifields[128];
412bafc1b83SMatthew G Knepley         IS       compField;
413bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
414bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
415bafc1b83SMatthew G Knepley 
41663a3b9bcSJacob Faibussowitsch         PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
4179566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
418bafc1b83SMatthew G Knepley         if (!flg) break;
41963a3b9bcSJacob Faibussowitsch         PetscCheck(numFields <= 128, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot currently support %" PetscInt_FMT " > 128 fields", numFields);
4209566063dSJacob Faibussowitsch         PetscCall(DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]));
421bafc1b83SMatthew G Knepley         if (nfields == 1) {
4229566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField));
423bafc1b83SMatthew G Knepley         } else {
42463a3b9bcSJacob Faibussowitsch           PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
4259566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, splitname, compField));
4267287d2a3SDmitry Karpeev         }
4279566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&compField));
428bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
429bafc1b83SMatthew G Knepley           f = ifields[j];
4309566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4319566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
4327b62db95SJungho Lee         }
433bafc1b83SMatthew G Knepley       }
434bafc1b83SMatthew G Knepley       if (i == 0) {
435bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
4369566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[f], fields[f]));
4379566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4389566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
439bafc1b83SMatthew G Knepley         }
440bafc1b83SMatthew G Knepley       } else {
44148a46eb9SPierre Jolivet         for (j = 0; j < numFields; j++) PetscCall(DMDestroy(dms + j));
4429566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4439566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(i, &dms));
4442fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
445bafc1b83SMatthew G Knepley       }
4469566063dSJacob Faibussowitsch       PetscCall(PetscFree(fieldNames));
4479566063dSJacob Faibussowitsch       PetscCall(PetscFree(fields));
448e7c4fc90SDmitry Karpeev       if (dms) {
4499566063dSJacob Faibussowitsch         PetscCall(PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n"));
450bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
4517287d2a3SDmitry Karpeev           const char *prefix;
452f4f49eeaSPierre Jolivet           PetscCall(PetscObjectGetOptionsPrefix((PetscObject)ilink->ksp, &prefix));
453f4f49eeaSPierre Jolivet           PetscCall(PetscObjectSetOptionsPrefix((PetscObject)dms[i], prefix));
4549566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(ilink->ksp, dms[i]));
4559566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(ilink->ksp, PETSC_FALSE));
4569566063dSJacob Faibussowitsch           PetscCall(PetscObjectIncrementTabLevel((PetscObject)dms[i], (PetscObject)ilink->ksp, 0));
4579566063dSJacob Faibussowitsch           PetscCall(DMDestroy(&dms[i]));
4582fa5ba8aSJed Brown         }
4599566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4608b8307b2SJed Brown       }
46166ffff09SJed Brown     } else {
462521d7252SBarry Smith       if (jac->bs <= 0) {
463704ba839SBarry Smith         if (pc->pmat) {
4649566063dSJacob Faibussowitsch           PetscCall(MatGetBlockSize(pc->pmat, &jac->bs));
4652fa5cd67SKarl Rupp         } else jac->bs = 1;
466521d7252SBarry Smith       }
467d32f9abdSBarry Smith 
4687b752e3dSPatrick Sanan       if (jac->detect) {
4696ce1633cSBarry Smith         IS       zerodiags, rest;
4706ce1633cSBarry Smith         PetscInt nmin, nmax;
4716ce1633cSBarry Smith 
4729566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4737199da05SBarry Smith         if (jac->diag_use_amat) {
4749566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->mat, &zerodiags));
4757199da05SBarry Smith         } else {
4769566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->pmat, &zerodiags));
4777199da05SBarry Smith         }
4789566063dSJacob Faibussowitsch         PetscCall(ISComplement(zerodiags, nmin, nmax, &rest));
4799566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
4809566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", zerodiags));
4819566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&zerodiags));
4829566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
4833a062f41SBarry Smith       } else if (coupling) {
4843a062f41SBarry Smith         IS       coupling, rest;
4853a062f41SBarry Smith         PetscInt nmin, nmax;
4863a062f41SBarry Smith 
4879566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4887199da05SBarry Smith         if (jac->offdiag_use_amat) {
4899566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->mat, &coupling));
4907199da05SBarry Smith         } else {
4919566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->pmat, &coupling));
4927199da05SBarry Smith         }
4939566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc->mat), nmax - nmin, nmin, 1, &rest));
4949566063dSJacob Faibussowitsch         PetscCall(ISSetIdentity(rest));
4959566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
4969566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", coupling));
4979566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&coupling));
4989566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
4996ce1633cSBarry Smith       } else {
5009566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_default", &fieldsplit_default, NULL));
5017287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
502d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
503d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
5049566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
5059566063dSJacob Faibussowitsch           if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
506d32f9abdSBarry Smith         }
5076dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
5089f001fe8SStefano Zampini           Mat       M = pc->pmat;
509f3b928b9SStefano Zampini           PetscBool isnest;
51080670ca5SBarry Smith           PetscInt  nf;
511f3b928b9SStefano Zampini 
5129566063dSJacob Faibussowitsch           PetscCall(PetscInfo(pc, "Using default splitting of fields\n"));
5139566063dSJacob Faibussowitsch           PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &isnest));
514f3b928b9SStefano Zampini           if (!isnest) {
5159f001fe8SStefano Zampini             M = pc->mat;
5169566063dSJacob Faibussowitsch             PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &isnest));
517f3b928b9SStefano Zampini           }
51880670ca5SBarry Smith           if (!isnest) nf = jac->bs;
51980670ca5SBarry Smith           else PetscCall(MatNestGetSize(M, &nf, NULL));
52080670ca5SBarry Smith           for (i = 0; i < nf; i++) {
5216c924f48SJed Brown             char splitname[8];
52280670ca5SBarry Smith 
52363a3b9bcSJacob Faibussowitsch             PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
5249566063dSJacob Faibussowitsch             PetscCall(PCFieldSplitSetFields(pc, splitname, 1, &i, &i));
52579416396SBarry Smith           }
5265d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
527521d7252SBarry Smith         }
52866ffff09SJed Brown       }
5296ce1633cSBarry Smith     }
530edf189efSBarry Smith   } else if (jac->nsplits == 1) {
531edf189efSBarry Smith     IS       is2;
532edf189efSBarry Smith     PetscInt nmin, nmax;
533edf189efSBarry Smith 
5340fdf79fbSJacob Faibussowitsch     PetscCheck(ilink->is, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Must provide at least two sets of fields to PCFieldSplit()");
5359566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
5369566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is, nmin, nmax, &is2));
5379566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetIS(pc, "1", is2));
5389566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is2));
539edf189efSBarry Smith   }
540d0af7cd3SBarry Smith 
54163a3b9bcSJacob Faibussowitsch   PetscCheck(jac->nsplits >= 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unhandled case, must have at least two fields, not %" PetscInt_FMT, jac->nsplits);
5423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
54369a612a9SBarry Smith }
54469a612a9SBarry Smith 
545d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A, Mat B, Mat C, Mat *H, PetscReal gkbnu)
546d71ae5a4SJacob Faibussowitsch {
547a51937d4SCarola Kruse   Mat       BT, T;
548de482cd7SCarola Kruse   PetscReal nrmT, nrmB;
549a51937d4SCarola Kruse 
550a51937d4SCarola Kruse   PetscFunctionBegin;
5519566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &T)); /* Test if augmented matrix is symmetric */
5529566063dSJacob Faibussowitsch   PetscCall(MatAXPY(T, -1.0, B, DIFFERENT_NONZERO_PATTERN));
5539566063dSJacob Faibussowitsch   PetscCall(MatNorm(T, NORM_1, &nrmT));
5549566063dSJacob Faibussowitsch   PetscCall(MatNorm(B, NORM_1, &nrmB));
555049d1499SBarry Smith   PetscCheck(nrmB <= 0 || nrmT / nrmB < PETSC_SMALL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix is not symmetric/hermitian, GKB is not applicable.");
556049d1499SBarry Smith 
557a51937d4SCarola Kruse   /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */
558a51937d4SCarola Kruse   /* setting N := 1/nu*I in [Ar13].                                                 */
5599566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(B, MAT_INITIAL_MATRIX, &BT));
5609566063dSJacob Faibussowitsch   PetscCall(MatMatMult(B, BT, MAT_INITIAL_MATRIX, PETSC_DEFAULT, H)); /* H = A01*A01'          */
5619566063dSJacob Faibussowitsch   PetscCall(MatAYPX(*H, gkbnu, A, DIFFERENT_NONZERO_PATTERN));        /* H = A00 + nu*A01*A01' */
562a51937d4SCarola Kruse 
5639566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&BT));
5649566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&T));
5653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
566a51937d4SCarola Kruse }
567a51937d4SCarola Kruse 
56854a546c1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions, const char pre[], const char name[], const char *option[], const char *value[], PetscBool *flg);
569514bf10dSMatthew G Knepley 
570d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_FieldSplit(PC pc)
571d71ae5a4SJacob Faibussowitsch {
57269a612a9SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
5735a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
5742c9966d7SBarry Smith   PetscInt          i, nsplit;
57580670ca5SBarry Smith   PetscBool         sorted, sorted_col, matnest = PETSC_FALSE;
57669a612a9SBarry Smith 
57769a612a9SBarry Smith   PetscFunctionBegin;
5785da88fe4STristan Konolige   pc->failedreason = PC_NOERROR;
5799566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDefaults(pc));
58097bbdb24SBarry Smith   nsplit = jac->nsplits;
5815a9f2f41SSatish Balay   ilink  = jac->head;
58280670ca5SBarry Smith   if (pc->pmat) PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest));
58397bbdb24SBarry Smith 
58497bbdb24SBarry Smith   /* get the matrices for each split */
585704ba839SBarry Smith   if (!jac->issetup) {
5861b9fc7fcSBarry Smith     PetscInt rstart, rend, nslots, bs;
58797bbdb24SBarry Smith 
588704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
589704ba839SBarry Smith 
5905d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
5912c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
5922c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
5932c9966d7SBarry Smith     }
5944db63379SBarry Smith 
5954db63379SBarry Smith     /*  MatCreateSubMatrix() for [S]BAIJ matrices can only work if the indices include entire blocks of the matrix */
5964db63379SBarry Smith     PetscCall(MatGetBlockSize(pc->pmat, &bs));
5974db63379SBarry Smith     if (bs > 1 && (jac->bs <= bs || jac->bs % bs)) {
5984db63379SBarry Smith       PetscBool blk;
5994db63379SBarry Smith 
6004db63379SBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)pc->pmat, &blk, MATBAIJ, MATSBAIJ, MATSEQBAIJ, MATSEQSBAIJ, MATMPIBAIJ, MATMPISBAIJ, NULL));
6014db63379SBarry Smith       PetscCheck(!blk, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Cannot use MATBAIJ with PCFIELDSPLIT and currently set matrix and PC blocksizes");
6024db63379SBarry Smith     }
6034db63379SBarry Smith 
60480670ca5SBarry Smith     if (!matnest) { /* use the matrix blocksize and stride IS to determine the index sets that define the submatrices */
60551f519a2SBarry Smith       bs = jac->bs;
6069566063dSJacob Faibussowitsch       PetscCall(MatGetOwnershipRange(pc->pmat, &rstart, &rend));
6071b9fc7fcSBarry Smith       nslots = (rend - rstart) / bs;
6081b9fc7fcSBarry Smith       for (i = 0; i < nsplit; i++) {
6091b9fc7fcSBarry Smith         if (jac->defaultsplit) {
6109566063dSJacob Faibussowitsch           PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + i, nsplit, &ilink->is));
6119566063dSJacob Faibussowitsch           PetscCall(ISDuplicate(ilink->is, &ilink->is_col));
612704ba839SBarry Smith         } else if (!ilink->is) {
613ccb205f8SBarry Smith           if (ilink->nfields > 1) {
6145f4ab4e1SJungho Lee             PetscInt *ii, *jj, j, k, nfields = ilink->nfields, *fields = ilink->fields, *fields_col = ilink->fields_col;
61580670ca5SBarry Smith 
6169566063dSJacob Faibussowitsch             PetscCall(PetscMalloc1(ilink->nfields * nslots, &ii));
6179566063dSJacob Faibussowitsch             PetscCall(PetscMalloc1(ilink->nfields * nslots, &jj));
6181b9fc7fcSBarry Smith             for (j = 0; j < nslots; j++) {
6191b9fc7fcSBarry Smith               for (k = 0; k < nfields; k++) {
6201b9fc7fcSBarry Smith                 ii[nfields * j + k] = rstart + bs * j + fields[k];
6215f4ab4e1SJungho Lee                 jj[nfields * j + k] = rstart + bs * j + fields_col[k];
62297bbdb24SBarry Smith               }
62397bbdb24SBarry Smith             }
6249566063dSJacob Faibussowitsch             PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, ii, PETSC_OWN_POINTER, &ilink->is));
6259566063dSJacob Faibussowitsch             PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, jj, PETSC_OWN_POINTER, &ilink->is_col));
6269566063dSJacob Faibussowitsch             PetscCall(ISSetBlockSize(ilink->is, nfields));
6279566063dSJacob Faibussowitsch             PetscCall(ISSetBlockSize(ilink->is_col, nfields));
628ccb205f8SBarry Smith           } else {
6299566063dSJacob Faibussowitsch             PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields[0], bs, &ilink->is));
6309566063dSJacob Faibussowitsch             PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields_col[0], bs, &ilink->is_col));
631ccb205f8SBarry Smith           }
6323e197d65SBarry Smith         }
6339566063dSJacob Faibussowitsch         PetscCall(ISSorted(ilink->is, &sorted));
6349566063dSJacob Faibussowitsch         if (ilink->is_col) PetscCall(ISSorted(ilink->is_col, &sorted_col));
6357827d75bSBarry Smith         PetscCheck(sorted && sorted_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Fields must be sorted when creating split");
636704ba839SBarry Smith         ilink = ilink->next;
6371b9fc7fcSBarry Smith       }
63880670ca5SBarry Smith     } else { /* use the IS that define the MATNEST to determine the index sets that define the submatrices */
63980670ca5SBarry Smith       IS      *rowis, *colis, *ises = NULL;
64080670ca5SBarry Smith       PetscInt mis, nis;
64180670ca5SBarry Smith 
64280670ca5SBarry Smith       PetscCall(MatNestGetSize(pc->pmat, &mis, &nis));
64380670ca5SBarry Smith       PetscCall(PetscMalloc2(mis, &rowis, nis, &colis));
64480670ca5SBarry Smith       PetscCall(MatNestGetISs(pc->pmat, rowis, colis));
64580670ca5SBarry Smith       if (!jac->defaultsplit) PetscCall(PetscMalloc1(mis, &ises));
64680670ca5SBarry Smith 
64780670ca5SBarry Smith       for (i = 0; i < nsplit; i++) {
64880670ca5SBarry Smith         if (jac->defaultsplit) {
64980670ca5SBarry Smith           PetscCall(ISDuplicate(rowis[i], &ilink->is));
65080670ca5SBarry Smith           PetscCall(ISDuplicate(ilink->is, &ilink->is_col));
65180670ca5SBarry Smith         } else if (!ilink->is) {
65280670ca5SBarry Smith           if (ilink->nfields > 1) {
65380670ca5SBarry Smith             for (PetscInt j = 0; j < ilink->nfields; j++) ises[j] = rowis[ilink->fields[j]];
65480670ca5SBarry Smith             PetscCall(ISConcatenate(PetscObjectComm((PetscObject)pc), ilink->nfields, ises, &ilink->is));
65580670ca5SBarry Smith           } else {
65680670ca5SBarry Smith             PetscCall(ISDuplicate(rowis[ilink->fields[0]], &ilink->is));
65780670ca5SBarry Smith           }
65880670ca5SBarry Smith           PetscCall(ISDuplicate(ilink->is, &ilink->is_col));
65980670ca5SBarry Smith         }
66080670ca5SBarry Smith         ilink = ilink->next;
66180670ca5SBarry Smith       }
66280670ca5SBarry Smith       PetscCall(PetscFree2(rowis, colis));
66380670ca5SBarry Smith       PetscCall(PetscFree(ises));
66480670ca5SBarry Smith     }
6651b9fc7fcSBarry Smith   }
6661b9fc7fcSBarry Smith 
667704ba839SBarry Smith   ilink = jac->head;
66897bbdb24SBarry Smith   if (!jac->pmat) {
669bdddcaaaSMatthew G Knepley     Vec xtmp;
670bdddcaaaSMatthew G Knepley 
6719566063dSJacob Faibussowitsch     PetscCall(MatCreateVecs(pc->pmat, &xtmp, NULL));
6729566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nsplit, &jac->pmat));
6739566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nsplit, &jac->x, nsplit, &jac->y));
674cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
675bdddcaaaSMatthew G Knepley       MatNullSpace sp;
676bdddcaaaSMatthew G Knepley 
677a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
6789566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&jac->pmat[i]));
679a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
6809566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->pmat[i]));
681a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
682a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
6832fa5cd67SKarl Rupp 
6849566063dSJacob Faibussowitsch           PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
685a3df900dSMatthew G Knepley         }
686a3df900dSMatthew G Knepley       } else {
6873a062f41SBarry Smith         const char *prefix;
6889566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->pmat[i]));
6892f427464SPierre Jolivet         PetscCall(MatGetOptionsPrefix(jac->pmat[i], &prefix));
6902f427464SPierre Jolivet         if (!prefix) {
6919566063dSJacob Faibussowitsch           PetscCall(KSPGetOptionsPrefix(ilink->ksp, &prefix));
6929566063dSJacob Faibussowitsch           PetscCall(MatSetOptionsPrefix(jac->pmat[i], prefix));
6932f427464SPierre Jolivet         }
69445881c45SPierre Jolivet         PetscCall(MatSetFromOptions(jac->pmat[i]));
6959566063dSJacob Faibussowitsch         PetscCall(MatViewFromOptions(jac->pmat[i], NULL, "-mat_view"));
696a3df900dSMatthew G Knepley       }
697bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
6989566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(jac->pmat[i], &jac->x[i], &jac->y[i]));
6999371c9d4SSatish Balay       ilink->x = jac->x[i];
7009371c9d4SSatish Balay       ilink->y = jac->y[i];
7019371c9d4SSatish Balay       ilink->z = NULL;
702bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
7039566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(xtmp, ilink->is, jac->x[i], NULL, &ilink->sctx));
7049566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nearnullspace", (PetscObject *)&sp));
70548a46eb9SPierre Jolivet       if (sp) PetscCall(MatSetNearNullSpace(jac->pmat[i], sp));
706704ba839SBarry Smith       ilink = ilink->next;
707cf502942SBarry Smith     }
7089566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&xtmp));
70997bbdb24SBarry Smith   } else {
710ef7efd37SHong Zhang     MatReuse      scall;
7114849c82aSBarry Smith     MatNullSpace *nullsp = NULL;
7124849c82aSBarry Smith 
713ef7efd37SHong Zhang     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7144849c82aSBarry Smith       PetscCall(MatGetNullSpaces(nsplit, jac->pmat, &nullsp));
71548a46eb9SPierre Jolivet       for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->pmat[i]));
716ef7efd37SHong Zhang       scall = MAT_INITIAL_MATRIX;
717ef7efd37SHong Zhang     } else scall = MAT_REUSE_MATRIX;
718ef7efd37SHong Zhang 
719cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
720a3df900dSMatthew G Knepley       Mat pmat;
721a3df900dSMatthew G Knepley 
722a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
7239566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&pmat));
72448a46eb9SPierre Jolivet       if (!pmat) PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, scall, &jac->pmat[i]));
725704ba839SBarry Smith       ilink = ilink->next;
726cf502942SBarry Smith     }
7274849c82aSBarry Smith     if (nullsp) PetscCall(MatRestoreNullSpaces(nsplit, jac->pmat, &nullsp));
72897bbdb24SBarry Smith   }
7294e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
730519d70e2SJed Brown     ilink = jac->head;
731519d70e2SJed Brown     if (!jac->mat) {
7329566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nsplit, &jac->mat));
733519d70e2SJed Brown       for (i = 0; i < nsplit; i++) {
7349566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->mat[i]));
735519d70e2SJed Brown         ilink = ilink->next;
736519d70e2SJed Brown       }
737519d70e2SJed Brown     } else {
738ef7efd37SHong Zhang       MatReuse      scall;
7394849c82aSBarry Smith       MatNullSpace *nullsp = NULL;
7404849c82aSBarry Smith 
741ef7efd37SHong Zhang       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7424849c82aSBarry Smith         PetscCall(MatGetNullSpaces(nsplit, jac->mat, &nullsp));
74348a46eb9SPierre Jolivet         for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->mat[i]));
744ef7efd37SHong Zhang         scall = MAT_INITIAL_MATRIX;
745ef7efd37SHong Zhang       } else scall = MAT_REUSE_MATRIX;
746ef7efd37SHong Zhang 
747ef7efd37SHong Zhang       for (i = 0; i < nsplit; i++) {
7489566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, scall, &jac->mat[i]));
749519d70e2SJed Brown         ilink = ilink->next;
750519d70e2SJed Brown       }
7514849c82aSBarry Smith       if (nullsp) PetscCall(MatRestoreNullSpaces(nsplit, jac->mat, &nullsp));
752519d70e2SJed Brown     }
753519d70e2SJed Brown   } else {
754519d70e2SJed Brown     jac->mat = jac->pmat;
755519d70e2SJed Brown   }
75697bbdb24SBarry Smith 
75753935eafSBarry Smith   /* Check for null space attached to IS */
75853935eafSBarry Smith   ilink = jac->head;
75953935eafSBarry Smith   for (i = 0; i < nsplit; i++) {
76053935eafSBarry Smith     MatNullSpace sp;
76153935eafSBarry Smith 
7629566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nullspace", (PetscObject *)&sp));
76348a46eb9SPierre Jolivet     if (sp) PetscCall(MatSetNullSpace(jac->mat[i], sp));
76453935eafSBarry Smith     ilink = ilink->next;
76553935eafSBarry Smith   }
76653935eafSBarry Smith 
767a51937d4SCarola Kruse   if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) {
76868dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
7694e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
77068dd23aaSBarry Smith     ilink = jac->head;
771e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
772e52d2c62SBarry 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 */
773e52d2c62SBarry Smith       if (!jac->Afield) {
7749566063dSJacob Faibussowitsch         PetscCall(PetscCalloc1(nsplit, &jac->Afield));
77580c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7769566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
777e52d2c62SBarry Smith         } else {
7789566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
77980c96bb1SFande Kong         }
78080c96bb1SFande Kong       } else {
781ef7efd37SHong Zhang         MatReuse scall;
782e9422dd5SStefano Zampini 
783ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7849566063dSJacob Faibussowitsch           PetscCall(MatDestroy(&jac->Afield[1]));
785ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
786ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
787ef7efd37SHong Zhang 
78880c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7899566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
79080c96bb1SFande Kong         } else {
7919566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
79280c96bb1SFande Kong         }
793e52d2c62SBarry Smith       }
794e52d2c62SBarry Smith     } else {
79568dd23aaSBarry Smith       if (!jac->Afield) {
7969566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nsplit, &jac->Afield));
79768dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
79880c96bb1SFande Kong           if (jac->offdiag_use_amat) {
7999566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
80080c96bb1SFande Kong           } else {
8019566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
80280c96bb1SFande Kong           }
80368dd23aaSBarry Smith           ilink = ilink->next;
80468dd23aaSBarry Smith         }
80568dd23aaSBarry Smith       } else {
806ef7efd37SHong Zhang         MatReuse scall;
807ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
80848a46eb9SPierre Jolivet           for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->Afield[i]));
809ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
810ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
811ef7efd37SHong Zhang 
81268dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
81380c96bb1SFande Kong           if (jac->offdiag_use_amat) {
8149566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, scall, &jac->Afield[i]));
81580c96bb1SFande Kong           } else {
8169566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, scall, &jac->Afield[i]));
81780c96bb1SFande Kong           }
81868dd23aaSBarry Smith           ilink = ilink->next;
81968dd23aaSBarry Smith         }
82068dd23aaSBarry Smith       }
82168dd23aaSBarry Smith     }
822e52d2c62SBarry Smith   }
82368dd23aaSBarry Smith 
8243b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
8253b224e63SBarry Smith     IS          ccis;
826b94d7dedSBarry Smith     PetscBool   isset, isspd;
8274aa3045dSJed Brown     PetscInt    rstart, rend;
828093c86ffSJed Brown     char        lscname[256];
829093c86ffSJed Brown     PetscObject LSC_L;
830558f3fe8SPierre Jolivet     PetscBool   set, flg;
831ce94432eSBarry Smith 
83208401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use Schur complement preconditioner you must have exactly 2 fields");
83368dd23aaSBarry Smith 
834c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
835c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
836b94d7dedSBarry Smith       PetscCall(MatIsSPDKnown(pc->pmat, &isset, &isspd));
837b94d7dedSBarry Smith       jac->schurscale = (isset && isspd) ? 1.0 : -1.0;
838c096484dSStefano Zampini     }
839c096484dSStefano Zampini 
840e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
8419566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend));
842558f3fe8SPierre Jolivet     PetscCall(PetscObjectTypeCompareAny(jac->offdiag_use_amat ? (PetscObject)pc->mat : (PetscObject)pc->pmat, &flg, MATSEQSBAIJ, MATMPISBAIJ, ""));
843e6cab6aaSJed Brown 
8443b224e63SBarry Smith     if (jac->schur) {
8450298fd71SBarry Smith       KSP      kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
846e9422dd5SStefano Zampini       MatReuse scall;
847e9422dd5SStefano Zampini 
848e9422dd5SStefano Zampini       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
849e9422dd5SStefano Zampini         scall = MAT_INITIAL_MATRIX;
8509566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->B));
8519566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->C));
852e9422dd5SStefano Zampini       } else scall = MAT_REUSE_MATRIX;
853443836d0SMatthew G Knepley 
8549566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
8553b224e63SBarry Smith       ilink = jac->head;
8569566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8574e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8589566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->B));
859c84da90fSDmitry Karpeev       } else {
8609566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->B));
861c84da90fSDmitry Karpeev       }
8629566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
863558f3fe8SPierre Jolivet       if (!flg) {
8643b224e63SBarry Smith         ilink = ilink->next;
8659566063dSJacob Faibussowitsch         PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8664e39094bSDmitry Karpeev         if (jac->offdiag_use_amat) {
8679566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->C));
868c84da90fSDmitry Karpeev         } else {
8699566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->C));
870c84da90fSDmitry Karpeev         }
8719566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&ccis));
872558f3fe8SPierre Jolivet       } else {
873558f3fe8SPierre Jolivet         PetscCall(MatIsHermitianKnown(jac->offdiag_use_amat ? pc->mat : pc->pmat, &set, &flg));
874558f3fe8SPierre Jolivet         if (set && flg) PetscCall(MatCreateHermitianTranspose(jac->B, &jac->C));
875558f3fe8SPierre Jolivet         else PetscCall(MatCreateTranspose(jac->B, &jac->C));
876558f3fe8SPierre Jolivet       }
8779566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementUpdateSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
878a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
8799566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->schurp));
8809566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
881*d9eadc85SPierre Jolivet       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
882*d9eadc85SPierre Jolivet         PetscCall(MatDestroy(&jac->schur_user));
883*d9eadc85SPierre Jolivet         if (jac->kspupper == jac->head->ksp) {
884*d9eadc85SPierre Jolivet           Mat AinvB;
885*d9eadc85SPierre Jolivet 
886*d9eadc85SPierre Jolivet           PetscCall(PetscObjectQuery((PetscObject)jac->schur, "AinvB", (PetscObject *)&AinvB));
887*d9eadc85SPierre Jolivet           PetscCall(MatDestroy(&AinvB));
888*d9eadc85SPierre Jolivet           PetscCall(MatCreate(PetscObjectComm((PetscObject)jac->schur), &AinvB));
889*d9eadc85SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)jac->schur, "AinvB", (PetscObject)AinvB));
890*d9eadc85SPierre Jolivet         }
891*d9eadc85SPierre Jolivet         PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
892a7476a74SDmitry Karpeev       }
89348a46eb9SPierre Jolivet       if (kspA != kspInner) PetscCall(KSPSetOperators(kspA, jac->mat[0], jac->pmat[0]));
89448a46eb9SPierre Jolivet       if (kspUpper != kspA) PetscCall(KSPSetOperators(kspUpper, jac->mat[0], jac->pmat[0]));
8959566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
8963b224e63SBarry Smith     } else {
897bafc1b83SMatthew G Knepley       const char  *Dprefix;
898470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
899514bf10dSMatthew G Knepley       char         schurtestoption[256];
900bdddcaaaSMatthew G Knepley       MatNullSpace sp;
901686bed4dSStefano Zampini       KSP          kspt;
9023b224e63SBarry Smith 
903a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
9043b224e63SBarry Smith       ilink = jac->head;
9059566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
9064e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
9079566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
908c84da90fSDmitry Karpeev       } else {
9099566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
910c84da90fSDmitry Karpeev       }
9119566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
9123b224e63SBarry Smith       ilink = ilink->next;
913558f3fe8SPierre Jolivet       if (!flg) {
9149566063dSJacob Faibussowitsch         PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
9154e39094bSDmitry Karpeev         if (jac->offdiag_use_amat) {
9169566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
917c84da90fSDmitry Karpeev         } else {
9189566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
919c84da90fSDmitry Karpeev         }
9209566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&ccis));
921558f3fe8SPierre Jolivet       } else {
922558f3fe8SPierre Jolivet         PetscCall(MatIsHermitianKnown(jac->offdiag_use_amat ? pc->mat : pc->pmat, &set, &flg));
923558f3fe8SPierre Jolivet         if (set && flg) PetscCall(MatCreateHermitianTranspose(jac->B, &jac->C));
924558f3fe8SPierre Jolivet         else PetscCall(MatCreateTranspose(jac->B, &jac->C));
925558f3fe8SPierre Jolivet       }
926f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
9279566063dSJacob Faibussowitsch       PetscCall(MatCreate(((PetscObject)jac->mat[0])->comm, &jac->schur));
9289566063dSJacob Faibussowitsch       PetscCall(MatSetType(jac->schur, MATSCHURCOMPLEMENT));
9299566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementSetSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
9309566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
9319566063dSJacob Faibussowitsch       PetscCall(MatSetOptionsPrefix(jac->schur, schurmatprefix));
9329566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspt));
9339566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(kspt, schurmatprefix));
934686bed4dSStefano Zampini 
935686bed4dSStefano Zampini       /* Note: this is not true in general */
9369566063dSJacob Faibussowitsch       PetscCall(MatGetNullSpace(jac->mat[1], &sp));
9371baa6e33SBarry Smith       if (sp) PetscCall(MatSetNullSpace(jac->schur, sp));
93820252d06SBarry Smith 
9399566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname));
94054a546c1SMatthew G. Knepley       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, NULL, &flg));
941514bf10dSMatthew G Knepley       if (flg) {
942514bf10dSMatthew G Knepley         DM  dmInner;
94321635b76SJed Brown         KSP kspInner;
944686bed4dSStefano Zampini         PC  pcInner;
94521635b76SJed Brown 
9469566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
9479566063dSJacob Faibussowitsch         PetscCall(KSPReset(kspInner));
9489566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(kspInner, jac->mat[0], jac->pmat[0]));
9499566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
95021635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
9519566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject)pc, 2));
9529566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject)pc, 2));
9539566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(kspInner, schurprefix));
954514bf10dSMatthew G Knepley 
955514bf10dSMatthew G Knepley         /* Set DM for new solver */
9569566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
9579566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(kspInner, dmInner));
9589566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(kspInner, PETSC_FALSE));
959686bed4dSStefano Zampini 
960686bed4dSStefano Zampini         /* Defaults to PCKSP as preconditioner */
9619566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9629566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcInner, PCKSP));
9639566063dSJacob Faibussowitsch         PetscCall(PCKSPSetKSP(pcInner, jac->head->ksp));
964514bf10dSMatthew G Knepley       } else {
96521635b76SJed Brown         /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
96621635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
96721635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
96821635b76SJed 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
96921635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
97021635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
9719566063dSJacob Faibussowitsch         PetscCall(KSPSetType(jac->head->ksp, KSPGMRES));
9729566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementSetKSP(jac->schur, jac->head->ksp));
973bafc1b83SMatthew G Knepley       }
9749566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->head->ksp, jac->mat[0], jac->pmat[0]));
9759566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->head->ksp));
9769566063dSJacob Faibussowitsch       PetscCall(MatSetFromOptions(jac->schur));
9773b224e63SBarry Smith 
9789566063dSJacob Faibussowitsch       PetscCall(PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg));
979686bed4dSStefano Zampini       if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */
980686bed4dSStefano Zampini         KSP kspInner;
981686bed4dSStefano Zampini         PC  pcInner;
982686bed4dSStefano Zampini 
9839566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
9849566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9859566063dSJacob Faibussowitsch         PetscCall(PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg));
986686bed4dSStefano Zampini         if (flg) {
987686bed4dSStefano Zampini           KSP ksp;
988686bed4dSStefano Zampini 
9899566063dSJacob Faibussowitsch           PetscCall(PCKSPGetKSP(pcInner, &ksp));
99048a46eb9SPierre Jolivet           if (ksp == jac->head->ksp) PetscCall(PCSetUseAmat(pcInner, PETSC_TRUE));
991686bed4dSStefano Zampini         }
992686bed4dSStefano Zampini       }
9939566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname));
99454a546c1SMatthew G. Knepley       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, NULL, &flg));
995443836d0SMatthew G Knepley       if (flg) {
996443836d0SMatthew G Knepley         DM dmInner;
997443836d0SMatthew G Knepley 
9989566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
9999566063dSJacob Faibussowitsch         PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper));
10003821be0aSBarry Smith         PetscCall(KSPSetNestLevel(jac->kspupper, pc->kspnestlevel));
10019566063dSJacob Faibussowitsch         PetscCall(KSPSetErrorIfNotConverged(jac->kspupper, pc->erroriffailure));
10029566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(jac->kspupper, schurprefix));
10039566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject)pc, 1));
10049566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject)pc, 1));
10059566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
10069566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(jac->kspupper, dmInner));
10079566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(jac->kspupper, PETSC_FALSE));
10089566063dSJacob Faibussowitsch         PetscCall(KSPSetFromOptions(jac->kspupper));
10099566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(jac->kspupper, jac->mat[0], jac->pmat[0]));
10109566063dSJacob Faibussowitsch         PetscCall(VecDuplicate(jac->head->x, &jac->head->z));
1011443836d0SMatthew G Knepley       } else {
1012443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
10139566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->head->ksp));
1014443836d0SMatthew G Knepley       }
1015443836d0SMatthew G Knepley 
101648a46eb9SPierre Jolivet       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
10179566063dSJacob Faibussowitsch       PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspschur));
10183821be0aSBarry Smith       PetscCall(KSPSetNestLevel(jac->kspschur, pc->kspnestlevel));
10199566063dSJacob Faibussowitsch       PetscCall(KSPSetErrorIfNotConverged(jac->kspschur, pc->erroriffailure));
10209566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspschur, (PetscObject)pc, 1));
1021084e4875SJed Brown       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
10227233a360SDmitry Karpeev         PC pcschur;
10239566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(jac->kspschur, &pcschur));
10249566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcschur, PCNONE));
1025084e4875SJed Brown         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
1026e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
1027*d9eadc85SPierre Jolivet         if (jac->schurfactorization == PC_FIELDSPLIT_SCHUR_FACT_FULL && jac->kspupper == jac->head->ksp) {
1028*d9eadc85SPierre Jolivet           Mat AinvB;
1029*d9eadc85SPierre Jolivet 
1030*d9eadc85SPierre Jolivet           PetscCall(MatCreate(PetscObjectComm((PetscObject)jac->schur), &AinvB));
1031*d9eadc85SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)jac->schur, "AinvB", (PetscObject)AinvB));
1032*d9eadc85SPierre Jolivet         }
10339566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
1034e69d4d44SBarry Smith       }
10359566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
10369566063dSJacob Faibussowitsch       PetscCall(KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix));
10379566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(jac->kspschur, Dprefix));
1038c096484dSStefano Zampini       /* propagate DM */
1039b20b4189SMatthew G. Knepley       {
1040b20b4189SMatthew G. Knepley         DM sdm;
10419566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->next->ksp, &sdm));
1042b20b4189SMatthew G. Knepley         if (sdm) {
10439566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(jac->kspschur, sdm));
10449566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(jac->kspschur, PETSC_FALSE));
1045b20b4189SMatthew G. Knepley         }
1046b20b4189SMatthew G. Knepley       }
10473b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
104820b26d62SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
10499566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->kspschur));
10503b224e63SBarry Smith     }
10519566063dSJacob Faibussowitsch     PetscCall(MatAssemblyBegin(jac->schur, MAT_FINAL_ASSEMBLY));
10529566063dSJacob Faibussowitsch     PetscCall(MatAssemblyEnd(jac->schur, MAT_FINAL_ASSEMBLY));
1053093c86ffSJed Brown 
1054093c86ffSJed Brown     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
10559566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_L", ilink->splitname));
10569566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L));
10579566063dSJacob Faibussowitsch     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L));
10589566063dSJacob Faibussowitsch     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_L", (PetscObject)LSC_L));
10599566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_Lp", ilink->splitname));
10609566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L));
10619566063dSJacob Faibussowitsch     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L));
10629566063dSJacob Faibussowitsch     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_Lp", (PetscObject)LSC_L));
1063a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1064a51937d4SCarola Kruse     IS       ccis;
1065a51937d4SCarola Kruse     PetscInt rstart, rend;
1066a51937d4SCarola Kruse 
106708401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use GKB preconditioner you must have exactly 2 fields");
1068a51937d4SCarola Kruse 
1069a51937d4SCarola Kruse     ilink = jac->head;
1070a51937d4SCarola Kruse 
1071a51937d4SCarola Kruse     /* When extracting off-diagonal submatrices, we take complements from this range */
10729566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend));
1073a51937d4SCarola Kruse 
10749566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
1075a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
10769566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
1077a51937d4SCarola Kruse     } else {
10789566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
1079a51937d4SCarola Kruse     }
10809566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ccis));
1081e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
10829566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->u));
10839566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->Hu));
10849566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w2));
1085a51937d4SCarola Kruse     ilink = ilink->next;
10869566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
1087a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
10889566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
1089a51937d4SCarola Kruse     } else {
10909566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
1091a51937d4SCarola Kruse     }
10929566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ccis));
1093e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
10949566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->v));
10959566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->d));
10969566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w1));
10979566063dSJacob Faibussowitsch     PetscCall(MatGolubKahanComputeExplicitOperator(jac->mat[0], jac->B, jac->C, &jac->H, jac->gkbnu));
10989566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(jac->gkbdelay, &jac->vecz));
1099e071a0a4SCarola Kruse 
1100a51937d4SCarola Kruse     ilink = jac->head;
11019566063dSJacob Faibussowitsch     PetscCall(KSPSetOperators(ilink->ksp, jac->H, jac->H));
11029566063dSJacob Faibussowitsch     if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
1103e071a0a4SCarola Kruse     /* Create gkb_monitor context */
1104de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1105de482cd7SCarola Kruse       PetscInt tablevel;
11069566063dSJacob Faibussowitsch       PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &jac->gkbviewer));
11079566063dSJacob Faibussowitsch       PetscCall(PetscViewerSetType(jac->gkbviewer, PETSCVIEWERASCII));
11089566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetTabLevel((PetscObject)ilink->ksp, &tablevel));
11099566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISetTab(jac->gkbviewer, tablevel));
11109566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)ilink->ksp, 1));
1111de482cd7SCarola Kruse     }
11123b224e63SBarry Smith   } else {
111368bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
111497bbdb24SBarry Smith     i     = 0;
11155a9f2f41SSatish Balay     ilink = jac->head;
11165a9f2f41SSatish Balay     while (ilink) {
11179566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(ilink->ksp, jac->mat[i], jac->pmat[i]));
11183b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
11199566063dSJacob Faibussowitsch       if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
112097bbdb24SBarry Smith       i++;
11215a9f2f41SSatish Balay       ilink = ilink->next;
11220971522cSBarry Smith     }
11233b224e63SBarry Smith   }
11243b224e63SBarry Smith 
11255ddf11f8SNicolas Barnafi   /* Set coordinates to the sub PC objects whenever these are set */
11265ddf11f8SNicolas Barnafi   if (jac->coordinates_set) {
11275ddf11f8SNicolas Barnafi     PC pc_coords;
11285ddf11f8SNicolas Barnafi     if (jac->type == PC_COMPOSITE_SCHUR) {
11295ddf11f8SNicolas Barnafi       // Head is first block.
11309566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->head->ksp, &pc_coords));
11319566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->dim, jac->head->ndofs, jac->head->coords));
11325ddf11f8SNicolas Barnafi       // Second one is Schur block, but its KSP object is in kspschur.
11339566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->kspschur, &pc_coords));
11349566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->next->dim, jac->head->next->ndofs, jac->head->next->coords));
11355ddf11f8SNicolas Barnafi     } else if (jac->type == PC_COMPOSITE_GKB) {
11369d3446b2SPierre Jolivet       PetscCall(PetscInfo(pc, "Warning: Setting coordinates does nothing for the GKB Fieldpslit preconditioner\n"));
11375ddf11f8SNicolas Barnafi     } else {
11385ddf11f8SNicolas Barnafi       ilink = jac->head;
11395ddf11f8SNicolas Barnafi       while (ilink) {
11409566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(ilink->ksp, &pc_coords));
11419566063dSJacob Faibussowitsch         PetscCall(PCSetCoordinates(pc_coords, ilink->dim, ilink->ndofs, ilink->coords));
11425ddf11f8SNicolas Barnafi         ilink = ilink->next;
11435ddf11f8SNicolas Barnafi       }
11445ddf11f8SNicolas Barnafi     }
11455ddf11f8SNicolas Barnafi   }
11465ddf11f8SNicolas Barnafi 
1147c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
11483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11490971522cSBarry Smith }
11500971522cSBarry Smith 
11515a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink, xx, yy) \
11523ba16761SJacob 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) || \
11539371c9d4SSatish 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) || \
11543ba16761SJacob Faibussowitsch                     VecScatterEnd(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE)))
115579416396SBarry Smith 
1156d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_Schur(PC pc, Vec x, Vec y)
1157d71ae5a4SJacob Faibussowitsch {
11583b224e63SBarry Smith   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
11593b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1160443836d0SMatthew G Knepley   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
1161*d9eadc85SPierre Jolivet   Mat               AinvB = NULL;
1162*d9eadc85SPierre Jolivet   PetscInt          N     = -1;
11633b224e63SBarry Smith 
11643b224e63SBarry Smith   PetscFunctionBegin;
1165c5d2311dSJed Brown   switch (jac->schurfactorization) {
1166c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
1167a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
11689566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11699566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11709566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11719566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11729566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11739566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11749566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11759566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11769566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11779566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1178e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
11799566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11809566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
1181e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
11829566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
11839566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->y, jac->schurscale));
11849566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11859566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
11869566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1187c5d2311dSJed Brown     break;
1188c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
1189a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
11909566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11919566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11929566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11939566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11949566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11959566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11969566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
11979566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.));
11989566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
11999566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12009566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12019566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1202e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
12039566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
1204e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
12059566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12069566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12079566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12089566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12099566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1210c5d2311dSJed Brown     break;
1211c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
1212a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
12139566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12149566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12159566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1216e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
12179566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
1218e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
12199566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12209371c9d4SSatish Balay     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12219371c9d4SSatish Balay     PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
12229566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkA->x, -1.));
12239566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
12249566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12259566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
12269566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12279566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
12289566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12299566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12309566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12319566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12329566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1233c5d2311dSJed Brown     break;
1234c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
1235c238f8cdSStefano Zampini     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */
12369566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12379566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12389566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
1239*d9eadc85SPierre Jolivet     if (kspUpper == kspA) {
1240*d9eadc85SPierre Jolivet       PetscCall(PetscObjectQuery((PetscObject)jac->schur, "AinvB", (PetscObject *)&AinvB));
1241*d9eadc85SPierre Jolivet       if (AinvB) {
1242*d9eadc85SPierre Jolivet         PetscCall(MatGetSize(AinvB, NULL, &N));
1243*d9eadc85SPierre Jolivet         if (N == -1) { // first time PCApply_FieldSplit_Schur() is called
1244*d9eadc85SPierre Jolivet           Mat                A;
1245*d9eadc85SPierre Jolivet           PetscInt           m, M, N;
1246*d9eadc85SPierre Jolivet           PetscScalar       *v, *write;
1247*d9eadc85SPierre Jolivet           const PetscScalar *read;
1248*d9eadc85SPierre Jolivet 
1249*d9eadc85SPierre Jolivet           PetscCall(MatGetSize(jac->B, &M, &N));
1250*d9eadc85SPierre Jolivet           PetscCall(MatGetLocalSize(jac->B, &m, NULL));
1251*d9eadc85SPierre Jolivet           PetscCall(VecGetArrayRead(ilinkA->x, &read));
1252*d9eadc85SPierre Jolivet           PetscCall(PetscMalloc1(m * (N + 1), &v));
1253*d9eadc85SPierre Jolivet           PetscCall(PetscArraycpy(v + m * N, read, m)); // copy the input Vec in the last column of the composed Mat
1254*d9eadc85SPierre Jolivet           PetscCall(VecRestoreArrayRead(ilinkA->x, &read));
1255*d9eadc85SPierre Jolivet           PetscCall(MatCreateDense(PetscObjectComm((PetscObject)jac->schur), m, PETSC_DECIDE, M, N + 1, v, &A)); // number of columns of the Schur complement plus one
1256*d9eadc85SPierre Jolivet           PetscCall(MatHeaderReplace(AinvB, &A));
1257*d9eadc85SPierre Jolivet           PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
1258*d9eadc85SPierre Jolivet           PetscCall(KSPSetOperators(jac->kspschur, jac->schur, jac->schur_user));
1259*d9eadc85SPierre Jolivet           PetscCall(VecGetArrayWrite(ilinkA->y, &write));
1260*d9eadc85SPierre Jolivet           PetscCall(PetscArraycpy(write, v + m * N, m)); // retrieve the solution as the last column of the composed Mat
1261*d9eadc85SPierre Jolivet           PetscCall(VecRestoreArrayWrite(ilinkA->y, &write));
1262*d9eadc85SPierre Jolivet         }
1263*d9eadc85SPierre Jolivet       }
1264*d9eadc85SPierre Jolivet     }
1265*d9eadc85SPierre Jolivet     if (!AinvB || N != -1) PetscCall(KSPSolve(kspLower, ilinkA->x, ilinkA->y));
12669566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->y));
12679566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
12689566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
12699566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.0));
12709566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12719566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12723b224e63SBarry Smith 
12739566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1274e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
12759566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
1276e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
12779566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12789566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12799566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12803b224e63SBarry Smith 
1281443836d0SMatthew G Knepley     if (kspUpper == kspA) {
1282*d9eadc85SPierre Jolivet       if (!AinvB) {
12839566063dSJacob Faibussowitsch         PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->y));
12849566063dSJacob Faibussowitsch         PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y));
12859566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12869566063dSJacob Faibussowitsch         PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
12879566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12889566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
1289*d9eadc85SPierre Jolivet       } else PetscCall(MatMultAdd(AinvB, ilinkD->y, ilinkA->y, ilinkA->y));
1290443836d0SMatthew G Knepley     } else {
12919566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12929566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
12939566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12949566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
12959566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
12969566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspUpper, ilinkA->x, ilinkA->z));
12979566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->z));
12989566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
12999566063dSJacob Faibussowitsch       PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z));
1300443836d0SMatthew G Knepley     }
13019566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13029566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13039566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1304c5d2311dSJed Brown   }
13053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
13063b224e63SBarry Smith }
13073b224e63SBarry Smith 
13087b665727SPierre Jolivet static PetscErrorCode PCApplyTranspose_FieldSplit_Schur(PC pc, Vec x, Vec y)
13097b665727SPierre Jolivet {
13107b665727SPierre Jolivet   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
13117b665727SPierre Jolivet   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
13127b665727SPierre Jolivet   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
13137b665727SPierre Jolivet 
13147b665727SPierre Jolivet   PetscFunctionBegin;
13157b665727SPierre Jolivet   switch (jac->schurfactorization) {
13167b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
13177b665727SPierre Jolivet     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
13187b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13197b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
13207b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13217b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13227b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
13237b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13247b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13257b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13267b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
13277b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1328e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
13297b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
1330e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
13317b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13327b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13337b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->y, jac->schurscale));
13347b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13357b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13367b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13377b665727SPierre Jolivet     break;
13387b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
13397b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13407b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13417b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13427b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
13437b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13447b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13457b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x));
13467b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->x, -1.));
13477b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13487b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13497b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13507b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1351e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
13527b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
1353e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
13547b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13557b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13567b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13577b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13587b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13597b665727SPierre Jolivet     break;
13607b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
13617b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
13627b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
13637b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1364e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
13657b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
1366e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
13677b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13687b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13697b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x));
13707b665727SPierre Jolivet     PetscCall(VecScale(ilinkA->x, -1.));
13717b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
13727b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13737b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
13747b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13757b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
13767b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13777b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13787b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13797b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13807b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13817b665727SPierre Jolivet     break;
13827b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
13837b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13847b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13857b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL));
13867b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspUpper, ilinkA->x, ilinkA->y));
13877b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->y));
13887b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL));
13897b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x));
13907b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->x, -1.0));
13917b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13927b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13937b665727SPierre Jolivet 
13947b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1395e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
13967b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
1397e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
13987b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13997b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
14007b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14017b665727SPierre Jolivet 
14027b665727SPierre Jolivet     if (kspLower == kspA) {
14037b665727SPierre Jolivet       PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->y));
14047b665727SPierre Jolivet       PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y));
14057b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14067b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
14077b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
14087b665727SPierre Jolivet       PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14097b665727SPierre Jolivet     } else {
14107b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14117b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
14127b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
14137b665727SPierre Jolivet       PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x));
14147b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL));
14157b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspLower, ilinkA->x, ilinkA->z));
14167b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->z));
14177b665727SPierre Jolivet       PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL));
14187b665727SPierre Jolivet       PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z));
14197b665727SPierre Jolivet     }
14207b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14217b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14227b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14237b665727SPierre Jolivet   }
14247b665727SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
14257b665727SPierre Jolivet }
14267b665727SPierre Jolivet 
1427d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit(PC pc, Vec x, Vec y)
1428d71ae5a4SJacob Faibussowitsch {
14290971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
14305a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
1431939b8a20SBarry Smith   PetscInt          cnt, bs;
14320971522cSBarry Smith 
14330971522cSBarry Smith   PetscFunctionBegin;
143479416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
143580670ca5SBarry Smith     PetscBool matnest;
143680670ca5SBarry Smith 
143780670ca5SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest));
143880670ca5SBarry Smith     if (jac->defaultsplit && !matnest) {
14399566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
14402472a847SBarry 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);
14419566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
14422472a847SBarry 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);
14439566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
14445a9f2f41SSatish Balay       while (ilink) {
14459566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14469566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
14479566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14489566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14495a9f2f41SSatish Balay         ilink = ilink->next;
14500971522cSBarry Smith       }
14519566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
14521b9fc7fcSBarry Smith     } else {
14539566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
14545a9f2f41SSatish Balay       while (ilink) {
14559566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
14565a9f2f41SSatish Balay         ilink = ilink->next;
14571b9fc7fcSBarry Smith       }
14581b9fc7fcSBarry Smith     }
1459e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
14609566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1461e52d2c62SBarry Smith     /* solve on first block for first block variables */
14629566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
14639566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
14649566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14659566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
14669566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14679566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14689566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
14699566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
1470e52d2c62SBarry Smith 
1471e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
14729566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->Afield[1], ilink->y, ilink->next->x));
1473e52d2c62SBarry Smith     ilink = ilink->next;
14749566063dSJacob Faibussowitsch     PetscCall(VecScale(ilink->x, -1.0));
14759566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
14769566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
1477e52d2c62SBarry Smith 
1478e52d2c62SBarry Smith     /* solve on second block variables */
14799566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14809566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
14819566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14829566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14839566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
14849566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
148516913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
148679416396SBarry Smith     if (!jac->w1) {
14879566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
14889566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
148979416396SBarry Smith     }
14909566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
14919566063dSJacob Faibussowitsch     PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
14923e197d65SBarry Smith     cnt = 1;
14935a9f2f41SSatish Balay     while (ilink->next) {
14945a9f2f41SSatish Balay       ilink = ilink->next;
14953e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
14969566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->Afield[cnt++], y, ilink->x));
14979566063dSJacob Faibussowitsch       PetscCall(VecScale(ilink->x, -1.0));
14989566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
14999566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
15009566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15019566063dSJacob Faibussowitsch       PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
15029566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
15039566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15049566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
15059566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
15063e197d65SBarry Smith     }
150751f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
150811755939SBarry Smith       cnt -= 2;
150951f519a2SBarry Smith       while (ilink->previous) {
151051f519a2SBarry Smith         ilink = ilink->previous;
151111755939SBarry Smith         /* compute the residual only over the part of the vector needed */
15129566063dSJacob Faibussowitsch         PetscCall(MatMult(jac->Afield[cnt--], y, ilink->x));
15139566063dSJacob Faibussowitsch         PetscCall(VecScale(ilink->x, -1.0));
15149566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
15159566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
15169566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15179566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
15189566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
15199566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15209566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
15219566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
152251f519a2SBarry Smith       }
152311755939SBarry Smith     }
152463a3b9bcSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Unsupported or unknown composition %d", (int)jac->type);
15253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15260971522cSBarry Smith }
15270971522cSBarry Smith 
1528d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_GKB(PC pc, Vec x, Vec y)
1529d71ae5a4SJacob Faibussowitsch {
1530a51937d4SCarola Kruse   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
1531a51937d4SCarola Kruse   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1532a51937d4SCarola Kruse   KSP               ksp = ilinkA->ksp;
1533de482cd7SCarola Kruse   Vec               u, v, Hu, d, work1, work2;
1534e071a0a4SCarola Kruse   PetscScalar       alpha, z, nrmz2, *vecz;
1535e071a0a4SCarola Kruse   PetscReal         lowbnd, nu, beta;
1536a51937d4SCarola Kruse   PetscInt          j, iterGKB;
1537a51937d4SCarola Kruse 
1538a51937d4SCarola Kruse   PetscFunctionBegin;
15399566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
15409566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
15419566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
15429566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
1543e071a0a4SCarola Kruse 
1544e071a0a4SCarola Kruse   u     = jac->u;
1545e071a0a4SCarola Kruse   v     = jac->v;
1546e071a0a4SCarola Kruse   Hu    = jac->Hu;
1547e071a0a4SCarola Kruse   d     = jac->d;
1548e071a0a4SCarola Kruse   work1 = jac->w1;
1549e071a0a4SCarola Kruse   work2 = jac->w2;
1550e071a0a4SCarola Kruse   vecz  = jac->vecz;
1551a51937d4SCarola Kruse 
1552a51937d4SCarola Kruse   /* Change RHS to comply with matrix regularization H = A + nu*B*B' */
1553a51937d4SCarola Kruse   /* Add q = q + nu*B*b */
1554a51937d4SCarola Kruse   if (jac->gkbnu) {
1555a51937d4SCarola Kruse     nu = jac->gkbnu;
15569566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, jac->gkbnu));
15579566063dSJacob Faibussowitsch     PetscCall(MatMultAdd(jac->B, ilinkD->x, ilinkA->x, ilinkA->x)); /* q = q + nu*B*b */
1558a51937d4SCarola Kruse   } else {
1559a51937d4SCarola Kruse     /* Situation when no augmented Lagrangian is used. Then we set inner  */
1560a51937d4SCarola Kruse     /* matrix N = I in [Ar13], and thus nu = 1.                           */
1561a51937d4SCarola Kruse     nu = 1;
1562a51937d4SCarola Kruse   }
1563a51937d4SCarola Kruse 
1564a51937d4SCarola Kruse   /* Transform rhs from [q,tilde{b}] to [0,b] */
15659566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
15669566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, ilinkA->x, ilinkA->y));
15679566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, ilinkA->y));
15689566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
15699566063dSJacob Faibussowitsch   PetscCall(MatMultHermitianTranspose(jac->B, ilinkA->y, work1));
15709566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(work1, 1.0 / nu, -1.0, ilinkD->x)); /* c = b - B'*x        */
1571a51937d4SCarola Kruse 
1572a51937d4SCarola Kruse   /* First step of algorithm */
15739566063dSJacob Faibussowitsch   PetscCall(VecNorm(work1, NORM_2, &beta)); /* beta = sqrt(nu*c'*c)*/
1574e071a0a4SCarola Kruse   KSPCheckDot(ksp, beta);
1575addd1e01SJunchao Zhang   beta = PetscSqrtReal(nu) * beta;
15769566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(v, nu / beta, 0.0, work1)); /* v = nu/beta *c      */
15779566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->B, v, work2));          /* u = H^{-1}*B*v      */
15789566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
15799566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, work2, u));
15809566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, u));
15819566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
15829566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u      */
15839566063dSJacob Faibussowitsch   PetscCall(VecDot(Hu, u, &alpha));
1584e071a0a4SCarola Kruse   KSPCheckDot(ksp, alpha);
158508401ef6SPierre Jolivet   PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1586addd1e01SJunchao Zhang   alpha = PetscSqrtReal(PetscAbsScalar(alpha));
15879566063dSJacob Faibussowitsch   PetscCall(VecScale(u, 1.0 / alpha));
15889566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(d, 1.0 / alpha, 0.0, v)); /* v = nu/beta *c      */
1589de482cd7SCarola Kruse 
1590a51937d4SCarola Kruse   z       = beta / alpha;
1591a51937d4SCarola Kruse   vecz[1] = z;
1592a51937d4SCarola Kruse 
1593de482cd7SCarola Kruse   /* Computation of first iterate x(1) and p(1) */
15949566063dSJacob Faibussowitsch   PetscCall(VecAXPY(ilinkA->y, z, u));
15959566063dSJacob Faibussowitsch   PetscCall(VecCopy(d, ilinkD->y));
15969566063dSJacob Faibussowitsch   PetscCall(VecScale(ilinkD->y, -z));
1597a51937d4SCarola Kruse 
15989371c9d4SSatish Balay   iterGKB = 1;
15999371c9d4SSatish Balay   lowbnd  = 2 * jac->gkbtol;
160048a46eb9SPierre Jolivet   if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1601de482cd7SCarola Kruse 
1602a51937d4SCarola Kruse   while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) {
1603a51937d4SCarola Kruse     iterGKB += 1;
16049566063dSJacob Faibussowitsch     PetscCall(MatMultHermitianTranspose(jac->B, u, work1)); /* v <- nu*(B'*u-alpha/nu*v) */
16059566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(v, nu, -alpha, work1));
16069566063dSJacob Faibussowitsch     PetscCall(VecNorm(v, NORM_2, &beta)); /* beta = sqrt(nu)*v'*v      */
1607addd1e01SJunchao Zhang     beta = beta / PetscSqrtReal(nu);
16089566063dSJacob Faibussowitsch     PetscCall(VecScale(v, 1.0 / beta));
16099566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->B, v, work2)); /* u <- H^{-1}*(B*v-beta*H*u) */
16109566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu));
16119566063dSJacob Faibussowitsch     PetscCall(VecAXPY(work2, -beta, Hu));
16129566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
16139566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ksp, work2, u));
16149566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ksp, pc, u));
16159566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
16169566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u            */
16179566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, u, &alpha));
1618e071a0a4SCarola Kruse     KSPCheckDot(ksp, alpha);
161908401ef6SPierre Jolivet     PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1620addd1e01SJunchao Zhang     alpha = PetscSqrtReal(PetscAbsScalar(alpha));
16219566063dSJacob Faibussowitsch     PetscCall(VecScale(u, 1.0 / alpha));
1622a51937d4SCarola Kruse 
1623e071a0a4SCarola Kruse     z       = -beta / alpha * z; /* z <- beta/alpha*z     */
1624a51937d4SCarola Kruse     vecz[0] = z;
1625a51937d4SCarola Kruse 
1626a51937d4SCarola Kruse     /* Computation of new iterate x(i+1) and p(i+1) */
16279566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(d, 1.0 / alpha, -beta / alpha, v)); /* d = (v-beta*d)/alpha */
16289566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkA->y, z, u));                   /* r = r + z*u          */
16299566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkD->y, -z, d));                  /* p = p - z*d          */
16309566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, ilinkA->y, Hu));             /* ||u||_H = u'*H*u     */
16319566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, ilinkA->y, &nrmz2));
1632a51937d4SCarola Kruse 
1633a51937d4SCarola Kruse     /* Compute Lower Bound estimate */
1634a51937d4SCarola Kruse     if (iterGKB > jac->gkbdelay) {
1635a51937d4SCarola Kruse       lowbnd = 0.0;
1636ad540459SPierre Jolivet       for (j = 0; j < jac->gkbdelay; j++) lowbnd += PetscAbsScalar(vecz[j] * vecz[j]);
1637addd1e01SJunchao Zhang       lowbnd = PetscSqrtReal(lowbnd / PetscAbsScalar(nrmz2));
1638a51937d4SCarola Kruse     }
1639a51937d4SCarola Kruse 
1640ad540459SPierre Jolivet     for (j = 0; j < jac->gkbdelay - 1; j++) vecz[jac->gkbdelay - j - 1] = vecz[jac->gkbdelay - j - 2];
164148a46eb9SPierre Jolivet     if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1642a51937d4SCarola Kruse   }
1643a51937d4SCarola Kruse 
16449566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
16459566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
16469566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
16479566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
16483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1649a51937d4SCarola Kruse }
1650a51937d4SCarola Kruse 
1651421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink, xx, yy) \
16523ba16761SJacob 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) || \
16539371c9d4SSatish 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) || \
16543ba16761SJacob Faibussowitsch                     VecScatterEnd(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE)))
1655421e10b8SBarry Smith 
1656d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc, Vec x, Vec y)
1657d71ae5a4SJacob Faibussowitsch {
1658421e10b8SBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
1659421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1660939b8a20SBarry Smith   PetscInt          bs;
1661421e10b8SBarry Smith 
1662421e10b8SBarry Smith   PetscFunctionBegin;
1663421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
166480670ca5SBarry Smith     PetscBool matnest;
166580670ca5SBarry Smith 
166680670ca5SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest));
166780670ca5SBarry Smith     if (jac->defaultsplit && !matnest) {
16689566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
16692472a847SBarry 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);
16709566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
16712472a847SBarry 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);
16729566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
1673421e10b8SBarry Smith       while (ilink) {
16749566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
16759566063dSJacob Faibussowitsch         PetscCall(KSPSolveTranspose(ilink->ksp, ilink->x, ilink->y));
16769566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
16779566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
1678421e10b8SBarry Smith         ilink = ilink->next;
1679421e10b8SBarry Smith       }
16809566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
1681421e10b8SBarry Smith     } else {
16829566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
1683421e10b8SBarry Smith       while (ilink) {
16849566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1685421e10b8SBarry Smith         ilink = ilink->next;
1686421e10b8SBarry Smith       }
1687421e10b8SBarry Smith     }
1688421e10b8SBarry Smith   } else {
1689421e10b8SBarry Smith     if (!jac->w1) {
16909566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
16919566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
1692421e10b8SBarry Smith     }
16939566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1694421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
16959566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1696421e10b8SBarry Smith       while (ilink->next) {
1697421e10b8SBarry Smith         ilink = ilink->next;
16989566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
16999566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
17009566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1701421e10b8SBarry Smith       }
1702421e10b8SBarry Smith       while (ilink->previous) {
1703421e10b8SBarry Smith         ilink = ilink->previous;
17049566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
17059566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
17069566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1707421e10b8SBarry Smith       }
1708421e10b8SBarry Smith     } else {
1709421e10b8SBarry Smith       while (ilink->next) { /* get to last entry in linked list */
1710421e10b8SBarry Smith         ilink = ilink->next;
1711421e10b8SBarry Smith       }
17129566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1713421e10b8SBarry Smith       while (ilink->previous) {
1714421e10b8SBarry Smith         ilink = ilink->previous;
17159566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
17169566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
17179566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1718421e10b8SBarry Smith       }
1719421e10b8SBarry Smith     }
1720421e10b8SBarry Smith   }
17213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1722421e10b8SBarry Smith }
1723421e10b8SBarry Smith 
1724d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_FieldSplit(PC pc)
1725d71ae5a4SJacob Faibussowitsch {
17260971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
17275a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head, next;
1728*d9eadc85SPierre Jolivet   Mat               AinvB;
17290971522cSBarry Smith 
17300971522cSBarry Smith   PetscFunctionBegin;
17315a9f2f41SSatish Balay   while (ilink) {
17329566063dSJacob Faibussowitsch     PetscCall(KSPDestroy(&ilink->ksp));
17339566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->x));
17349566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->y));
17359566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->z));
17369566063dSJacob Faibussowitsch     PetscCall(VecScatterDestroy(&ilink->sctx));
17379566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
17389566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
17399566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->splitname));
17409566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields));
17419566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields_col));
17425a9f2f41SSatish Balay     next = ilink->next;
17439566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink));
17445a9f2f41SSatish Balay     ilink = next;
17450971522cSBarry Smith   }
1746f5f0d762SBarry Smith   jac->head = NULL;
17479566063dSJacob Faibussowitsch   PetscCall(PetscFree2(jac->x, jac->y));
1748574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
17499566063dSJacob Faibussowitsch     PetscCall(MatDestroyMatrices(jac->nsplits, &jac->mat));
1750574deadeSBarry Smith   } else if (jac->mat) {
17510298fd71SBarry Smith     jac->mat = NULL;
1752574deadeSBarry Smith   }
17539566063dSJacob Faibussowitsch   if (jac->pmat) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->pmat));
17549566063dSJacob Faibussowitsch   if (jac->Afield) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->Afield));
1755f5f0d762SBarry Smith   jac->nsplits = 0;
17569566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w1));
17579566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w2));
1758*d9eadc85SPierre Jolivet   if (jac->schur) {
1759*d9eadc85SPierre Jolivet     PetscCall(PetscObjectQuery((PetscObject)jac->schur, "AinvB", (PetscObject *)&AinvB));
1760*d9eadc85SPierre Jolivet     PetscCall(MatDestroy(&AinvB));
1761*d9eadc85SPierre Jolivet     PetscCall(PetscObjectCompose((PetscObject)jac->schur, "AinvB", NULL));
1762*d9eadc85SPierre Jolivet   }
17639566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur));
17649566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schurp));
17659566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur_user));
17669566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspschur));
17679566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspupper));
17689566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->B));
17699566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->C));
17709566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->H));
17719566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->u));
17729566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->v));
17739566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->Hu));
17749566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->d));
17759566063dSJacob Faibussowitsch   PetscCall(PetscFree(jac->vecz));
17769566063dSJacob Faibussowitsch   PetscCall(PetscViewerDestroy(&jac->gkbviewer));
17776dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
17783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1779574deadeSBarry Smith }
1780574deadeSBarry Smith 
1781d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1782d71ae5a4SJacob Faibussowitsch {
1783574deadeSBarry Smith   PetscFunctionBegin;
17849566063dSJacob Faibussowitsch   PetscCall(PCReset_FieldSplit(pc));
17859566063dSJacob Faibussowitsch   PetscCall(PetscFree(pc->data));
17862e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", NULL));
17879566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", NULL));
17889566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", NULL));
17899566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", NULL));
17909566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", NULL));
17912e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", NULL));
17922e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", NULL));
17932e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
17942e956fe4SStefano Zampini 
17952e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
17962e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
17972e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
17982e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
17992e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
18009566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
18019566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
18029566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
18032e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
18043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
18050971522cSBarry Smith }
18060971522cSBarry Smith 
1807d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc, PetscOptionItems *PetscOptionsObject)
1808d71ae5a4SJacob Faibussowitsch {
18096c924f48SJed Brown   PetscInt        bs;
18107b752e3dSPatrick Sanan   PetscBool       flg;
18119dcbbd2bSBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit *)pc->data;
18123b224e63SBarry Smith   PCCompositeType ctype;
18131b9fc7fcSBarry Smith 
18140971522cSBarry Smith   PetscFunctionBegin;
1815d0609cedSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "FieldSplit options");
18169566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_dm_splits", "Whether to use DMCreateFieldDecomposition() for splits", "PCFieldSplitSetDMSplits", jac->dm_splits, &jac->dm_splits, NULL));
18179566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-pc_fieldsplit_block_size", "Blocksize that defines number of fields", "PCFieldSplitSetBlockSize", jac->bs, &bs, &flg));
18181baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetBlockSize(pc, bs));
18192686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
18209566063dSJacob 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));
18212686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
18229566063dSJacob 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));
18239566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_detect_saddle_point", "Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint", jac->detect, &jac->detect, NULL));
18249566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDetectSaddlePoint(pc, jac->detect)); /* Sets split type and Schur PC type */
18259566063dSJacob Faibussowitsch   PetscCall(PetscOptionsEnum("-pc_fieldsplit_type", "Type of composition", "PCFieldSplitSetType", PCCompositeTypes, (PetscEnum)jac->type, (PetscEnum *)&ctype, &flg));
18261baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetType(pc, ctype));
1827c30613efSMatthew Knepley   /* Only setup fields once */
1828c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
182980670ca5SBarry Smith     /* only allow user to set fields from command line.
1830d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
18319566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
18329566063dSJacob Faibussowitsch     if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
1833d32f9abdSBarry Smith   }
1834c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
18359566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_schur_factorization_type", PCFieldSplitSchurFactTypes, (PetscEnum *)&jac->schurfactorization, &flg));
18369566063dSJacob Faibussowitsch     if (flg) PetscCall(PetscInfo(pc, "Deprecated use of -pc_fieldsplit_schur_factorization_type\n"));
18379566063dSJacob 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));
18389566063dSJacob Faibussowitsch     PetscCall(PetscOptionsEnum("-pc_fieldsplit_schur_precondition", "How to build preconditioner for Schur complement", "PCFieldSplitSetSchurPre", PCFieldSplitSchurPreTypes, (PetscEnum)jac->schurpre, (PetscEnum *)&jac->schurpre, NULL));
18399566063dSJacob Faibussowitsch     PetscCall(PetscOptionsScalar("-pc_fieldsplit_schur_scale", "Scale Schur complement", "PCFieldSplitSetSchurScale", jac->schurscale, &jac->schurscale, NULL));
1840a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1841a077d33dSBarry Smith     PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_tol", "The tolerance for the lower bound stopping criterion", "PCFieldSplitSetGKBTol", jac->gkbtol, &jac->gkbtol, NULL));
1842a077d33dSBarry Smith     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_delay", "The delay value for lower bound criterion", "PCFieldSplitSetGKBDelay", jac->gkbdelay, &jac->gkbdelay, NULL));
1843a077d33dSBarry Smith     PetscCall(PetscOptionsBoundedReal("-pc_fieldsplit_gkb_nu", "Parameter in augmented Lagrangian approach", "PCFieldSplitSetGKBNu", jac->gkbnu, &jac->gkbnu, NULL, 0.0));
1844a077d33dSBarry Smith     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_maxit", "Maximum allowed number of iterations", "PCFieldSplitSetGKBMaxit", jac->gkbmaxit, &jac->gkbmaxit, NULL));
18459566063dSJacob Faibussowitsch     PetscCall(PetscOptionsBool("-pc_fieldsplit_gkb_monitor", "Prints number of GKB iterations and error", "PCFieldSplitGKB", jac->gkbmonitor, &jac->gkbmonitor, NULL));
1846c5d2311dSJed Brown   }
184734603f55SBarry Smith   /*
184834603f55SBarry Smith     In the initial call to this routine the sub-solver data structures do not exist so we cannot call KSPSetFromOptions() on them yet.
184934603f55SBarry 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
185034603f55SBarry Smith     is called on the outer solver in case changes were made in the options database
185134603f55SBarry Smith 
185234603f55SBarry 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()
185334603f55SBarry 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.
185434603f55SBarry Smith     Without this extra check test p2p1fetidp_olof_full and others fail with incorrect matrix types.
185534603f55SBarry Smith 
185634603f55SBarry Smith     There could be a negative side effect of calling the KSPSetFromOptions() below.
185734603f55SBarry Smith 
185834603f55SBarry 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
185934603f55SBarry Smith   */
186034603f55SBarry Smith   if (jac->issetup) {
186134603f55SBarry Smith     PC_FieldSplitLink ilink = jac->head;
186234603f55SBarry Smith     if (jac->type == PC_COMPOSITE_SCHUR) {
186334603f55SBarry Smith       if (jac->kspupper && jac->kspupper->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspupper));
186434603f55SBarry Smith       if (jac->kspschur && jac->kspschur->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspschur));
186534603f55SBarry Smith     }
186634603f55SBarry Smith     while (ilink) {
186734603f55SBarry Smith       if (ilink->ksp->totalits > 0) PetscCall(KSPSetFromOptions(ilink->ksp));
186834603f55SBarry Smith       ilink = ilink->next;
186934603f55SBarry Smith     }
187034603f55SBarry Smith   }
1871d0609cedSBarry Smith   PetscOptionsHeadEnd();
18723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
18730971522cSBarry Smith }
18740971522cSBarry Smith 
1875d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col)
1876d71ae5a4SJacob Faibussowitsch {
187797bbdb24SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
18785a9f2f41SSatish Balay   PC_FieldSplitLink ilink, next = jac->head;
187969a612a9SBarry Smith   char              prefix[128];
18805d4c12cdSJungho Lee   PetscInt          i;
18810971522cSBarry Smith 
18820971522cSBarry Smith   PetscFunctionBegin;
18836c924f48SJed Brown   if (jac->splitdefined) {
18849566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
18853ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
18866c924f48SJed Brown   }
188780670ca5SBarry Smith   for (i = 0; i < n; i++) { PetscCheck(fields[i] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", fields[i]); }
18889566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
1889a04f6461SBarry Smith   if (splitname) {
18909566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
1891a04f6461SBarry Smith   } else {
18929566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(3, &ilink->splitname));
189363a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 2, "%" PetscInt_FMT, jac->nsplits));
1894a04f6461SBarry Smith   }
18959df09d43SBarry 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 */
18969566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields));
18979566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields, fields, n));
18989566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields_col));
18999566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields_col, fields_col, n));
19002fa5cd67SKarl Rupp 
19015a9f2f41SSatish Balay   ilink->nfields = n;
19020298fd71SBarry Smith   ilink->next    = NULL;
19039566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
19043821be0aSBarry Smith   PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel));
19059566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
19069566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
19079566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
190869a612a9SBarry Smith 
19099566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
19109566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
19110971522cSBarry Smith 
19120971522cSBarry Smith   if (!next) {
19135a9f2f41SSatish Balay     jac->head       = ilink;
19140298fd71SBarry Smith     ilink->previous = NULL;
19150971522cSBarry Smith   } else {
1916ad540459SPierre Jolivet     while (next->next) next = next->next;
19175a9f2f41SSatish Balay     next->next      = ilink;
191851f519a2SBarry Smith     ilink->previous = next;
19190971522cSBarry Smith   }
19200971522cSBarry Smith   jac->nsplits++;
19213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19220971522cSBarry Smith }
19230971522cSBarry Smith 
1924d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp)
1925d71ae5a4SJacob Faibussowitsch {
1926285fb4e2SStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1927285fb4e2SStefano Zampini 
1928285fb4e2SStefano Zampini   PetscFunctionBegin;
1929285fb4e2SStefano Zampini   *subksp = NULL;
1930285fb4e2SStefano Zampini   if (n) *n = 0;
1931285fb4e2SStefano Zampini   if (jac->type == PC_COMPOSITE_SCHUR) {
1932285fb4e2SStefano Zampini     PetscInt nn;
1933285fb4e2SStefano Zampini 
193428b400f6SJacob Faibussowitsch     PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()");
193563a3b9bcSJacob Faibussowitsch     PetscCheck(jac->nsplits == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unexpected number of splits %" PetscInt_FMT " != 2", jac->nsplits);
1936285fb4e2SStefano Zampini     nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0);
19379566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nn, subksp));
1938285fb4e2SStefano Zampini     (*subksp)[0] = jac->head->ksp;
1939285fb4e2SStefano Zampini     (*subksp)[1] = jac->kspschur;
1940285fb4e2SStefano Zampini     if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper;
1941285fb4e2SStefano Zampini     if (n) *n = nn;
1942285fb4e2SStefano Zampini   }
19433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1944285fb4e2SStefano Zampini }
1945285fb4e2SStefano Zampini 
1946d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc, PetscInt *n, KSP **subksp)
1947d71ae5a4SJacob Faibussowitsch {
1948e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1949e69d4d44SBarry Smith 
1950e69d4d44SBarry Smith   PetscFunctionBegin;
195128b400f6SJacob Faibussowitsch   PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
19529566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
19539566063dSJacob Faibussowitsch   PetscCall(MatSchurComplementGetKSP(jac->schur, *subksp));
19542fa5cd67SKarl Rupp 
1955e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
195613e0d083SBarry Smith   if (n) *n = jac->nsplits;
19573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1958e69d4d44SBarry Smith }
19590971522cSBarry Smith 
1960d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp)
1961d71ae5a4SJacob Faibussowitsch {
19620971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
19630971522cSBarry Smith   PetscInt          cnt   = 0;
19645a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
19650971522cSBarry Smith 
19660971522cSBarry Smith   PetscFunctionBegin;
19679566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
19685a9f2f41SSatish Balay   while (ilink) {
19695a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
19705a9f2f41SSatish Balay     ilink            = ilink->next;
19710971522cSBarry Smith   }
197263a3b9bcSJacob 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);
197313e0d083SBarry Smith   if (n) *n = jac->nsplits;
19743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19750971522cSBarry Smith }
19760971522cSBarry Smith 
1977cc4c1da9SBarry Smith /*@
1978f1580f4eSBarry Smith   PCFieldSplitRestrictIS - Restricts the fieldsplit `IS`s to be within a given `IS`.
19796dbb499eSCian Wilson 
19806dbb499eSCian Wilson   Input Parameters:
19816dbb499eSCian Wilson + pc  - the preconditioner context
1982feefa0e1SJacob Faibussowitsch - isy - the index set that defines the indices to which the fieldsplit is to be restricted
19836dbb499eSCian Wilson 
19846dbb499eSCian Wilson   Level: advanced
19856dbb499eSCian Wilson 
1986feefa0e1SJacob Faibussowitsch   Developer Notes:
1987f1580f4eSBarry Smith   It seems the resulting `IS`s will not cover the entire space, so
1988f1580f4eSBarry Smith   how can they define a convergent preconditioner? Needs explaining.
1989f1580f4eSBarry Smith 
199060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
19916dbb499eSCian Wilson @*/
1992d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitRestrictIS(PC pc, IS isy)
1993d71ae5a4SJacob Faibussowitsch {
19946dbb499eSCian Wilson   PetscFunctionBegin;
19956dbb499eSCian Wilson   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
19966dbb499eSCian Wilson   PetscValidHeaderSpecific(isy, IS_CLASSID, 2);
1997cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitRestrictIS_C", (PC, IS), (pc, isy));
19983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19996dbb499eSCian Wilson }
20006dbb499eSCian Wilson 
2001d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
2002d71ae5a4SJacob Faibussowitsch {
20036dbb499eSCian Wilson   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
20046dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
20056dbb499eSCian Wilson   PetscInt          localsize, size, sizez, i;
20066dbb499eSCian Wilson   const PetscInt   *ind, *indz;
20076dbb499eSCian Wilson   PetscInt         *indc, *indcz;
20086dbb499eSCian Wilson   PetscBool         flg;
20096dbb499eSCian Wilson 
20106dbb499eSCian Wilson   PetscFunctionBegin;
20119566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(isy, &localsize));
20129566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&localsize, &size, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)isy)));
20136dbb499eSCian Wilson   size -= localsize;
20146dbb499eSCian Wilson   while (ilink) {
20156dbb499eSCian Wilson     IS isrl, isr;
20161c7cfba8SBarry Smith     PC subpc;
20179566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl));
20189566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(isrl, &localsize));
20199566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(localsize, &indc));
20209566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(isrl, &ind));
20219566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(indc, ind, localsize));
20229566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(isrl, &ind));
20239566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isrl));
20246dbb499eSCian Wilson     for (i = 0; i < localsize; i++) *(indc + i) += size;
20259566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)isy), localsize, indc, PETSC_OWN_POINTER, &isr));
20269566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
20279566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
20286dbb499eSCian Wilson     ilink->is = isr;
20299566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
20309566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
20316dbb499eSCian Wilson     ilink->is_col = isr;
20329566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isr));
20339566063dSJacob Faibussowitsch     PetscCall(KSPGetPC(ilink->ksp, &subpc));
20349566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)subpc, PCFIELDSPLIT, &flg));
20356dbb499eSCian Wilson     if (flg) {
20366dbb499eSCian Wilson       IS       iszl, isz;
20376dbb499eSCian Wilson       MPI_Comm comm;
20389566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(ilink->is, &localsize));
20396dbb499eSCian Wilson       comm = PetscObjectComm((PetscObject)ilink->is);
20409566063dSJacob Faibussowitsch       PetscCall(ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl));
20419566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Scan(&localsize, &sizez, 1, MPIU_INT, MPI_SUM, comm));
20426dbb499eSCian Wilson       sizez -= localsize;
20439566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(iszl, &localsize));
20449566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(localsize, &indcz));
20459566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(iszl, &indz));
20469566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(indcz, indz, localsize));
20479566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(iszl, &indz));
20489566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&iszl));
20496dbb499eSCian Wilson       for (i = 0; i < localsize; i++) *(indcz + i) += sizez;
20509566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(comm, localsize, indcz, PETSC_OWN_POINTER, &isz));
20519566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitRestrictIS(subpc, isz));
20529566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&isz));
20536dbb499eSCian Wilson     }
20546dbb499eSCian Wilson     next  = ilink->next;
20556dbb499eSCian Wilson     ilink = next;
20566dbb499eSCian Wilson   }
20576dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
20583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20596dbb499eSCian Wilson }
20606dbb499eSCian Wilson 
2061d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc, const char splitname[], IS is)
2062d71ae5a4SJacob Faibussowitsch {
2063704ba839SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
2064704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
2065704ba839SBarry Smith   char              prefix[128];
2066704ba839SBarry Smith 
2067704ba839SBarry Smith   PetscFunctionBegin;
20686c924f48SJed Brown   if (jac->splitdefined) {
20699566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
20703ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
20716c924f48SJed Brown   }
20729566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
2073a04f6461SBarry Smith   if (splitname) {
20749566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
2075a04f6461SBarry Smith   } else {
20769566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(8, &ilink->splitname));
207763a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 7, "%" PetscInt_FMT, jac->nsplits));
2078a04f6461SBarry Smith   }
20799df09d43SBarry 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 */
20809566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
20819566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is));
2082b5787286SJed Brown   ilink->is = is;
20839566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
20849566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is_col));
2085b5787286SJed Brown   ilink->is_col = is;
20860298fd71SBarry Smith   ilink->next   = NULL;
20879566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
20883821be0aSBarry Smith   PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel));
20899566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
20909566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
20919566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
2092704ba839SBarry Smith 
20939566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
20949566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
2095704ba839SBarry Smith 
2096704ba839SBarry Smith   if (!next) {
2097704ba839SBarry Smith     jac->head       = ilink;
20980298fd71SBarry Smith     ilink->previous = NULL;
2099704ba839SBarry Smith   } else {
2100ad540459SPierre Jolivet     while (next->next) next = next->next;
2101704ba839SBarry Smith     next->next      = ilink;
2102704ba839SBarry Smith     ilink->previous = next;
2103704ba839SBarry Smith   }
2104704ba839SBarry Smith   jac->nsplits++;
21053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2106704ba839SBarry Smith }
2107704ba839SBarry Smith 
21085d83a8b1SBarry Smith /*@
210960f59c3bSBarry Smith   PCFieldSplitSetFields - Sets the fields that define one particular split in `PCFIELDSPLIT`
21100971522cSBarry Smith 
2111c3339decSBarry Smith   Logically Collective
21120971522cSBarry Smith 
21130971522cSBarry Smith   Input Parameters:
21140971522cSBarry Smith + pc         - the preconditioner context
211560f59c3bSBarry Smith . splitname  - name of this split, if `NULL` the number of the split is used
21160971522cSBarry Smith . n          - the number of fields in this split
21173b374dbdSBarry Smith . fields     - the fields in this split
211880670ca5SBarry Smith - fields_col - generally the same as `fields`, if it does not match `fields` then the submatrix that is solved for this set of fields comes from an off-diagonal block
211980670ca5SBarry Smith                of the matrix and `fields_col` provides the column indices for that block
212080670ca5SBarry Smith 
212180670ca5SBarry Smith   Options Database Key:
212280670ca5SBarry Smith . -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the `%d`'th split
21230971522cSBarry Smith 
21240971522cSBarry Smith   Level: intermediate
21250971522cSBarry Smith 
212695452b02SPatrick Sanan   Notes:
2127f1580f4eSBarry Smith   Use `PCFieldSplitSetIS()` to set a  general set of indices as a split.
2128d32f9abdSBarry Smith 
212980670ca5SBarry Smith   If the matrix used to construct the preconditioner is `MATNEST` then field i refers to the `is_row[i]` `IS` passed to `MatCreateNest()`.
213080670ca5SBarry Smith 
213180670ca5SBarry Smith   If the matrix used to construct the preconditioner is not `MATNEST` then
213280670ca5SBarry Smith   `PCFieldSplitSetFields()` is for defining fields as strided blocks (based on the block size provided to the matrix with `MatSetBlocksize()` or
213380670ca5SBarry Smith   to the `PC` with `PCFieldSplitSetBlockSize()`). For example, if the block
2134f1580f4eSBarry 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
2135d32f9abdSBarry Smith   0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
2136f1580f4eSBarry Smith   where the numbered entries indicate what is in the split.
2137d32f9abdSBarry Smith 
2138db4c96c1SJed Brown   This function is called once per split (it creates a new split each time).  Solve options
213960f59c3bSBarry Smith   for this split will be available under the prefix `-fieldsplit_SPLITNAME_`.
2140db4c96c1SJed Brown 
214180670ca5SBarry Smith   `PCFieldSplitSetIS()` does not support having a `fields_col` different from `fields`
21423b374dbdSBarry Smith 
2143feefa0e1SJacob Faibussowitsch   Developer Notes:
2144f1580f4eSBarry Smith   This routine does not actually create the `IS` representing the split, that is delayed
2145f1580f4eSBarry Smith   until `PCSetUp_FieldSplit()`, because information about the vector/matrix layouts may not be
21465d4c12cdSJungho Lee   available when this routine is called.
21475d4c12cdSJungho Lee 
214880670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetIS()`, `PCFieldSplitRestrictIS()`,
214980670ca5SBarry Smith           `MatSetBlocksize()`, `MatCreateNest()`
21500971522cSBarry Smith @*/
2151cc4c1da9SBarry Smith PetscErrorCode PCFieldSplitSetFields(PC pc, const char splitname[], PetscInt n, const PetscInt fields[], const PetscInt fields_col[])
2152d71ae5a4SJacob Faibussowitsch {
21530971522cSBarry Smith   PetscFunctionBegin;
21540700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
21554f572ea9SToby Isaac   PetscAssertPointer(splitname, 2);
215663a3b9bcSJacob Faibussowitsch   PetscCheck(n >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Provided number of fields %" PetscInt_FMT " in split \"%s\" not positive", n, splitname);
21574f572ea9SToby Isaac   PetscAssertPointer(fields, 4);
2158cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetFields_C", (PC, const char[], PetscInt, const PetscInt *, const PetscInt *), (pc, splitname, n, fields, fields_col));
21593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21600971522cSBarry Smith }
21610971522cSBarry Smith 
2162c84da90fSDmitry Karpeev /*@
2163f1580f4eSBarry Smith   PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build
2164c14e9f00SDavid Andrs   the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2165c84da90fSDmitry Karpeev 
2166c3339decSBarry Smith   Logically Collective
2167c84da90fSDmitry Karpeev 
2168c84da90fSDmitry Karpeev   Input Parameters:
2169c84da90fSDmitry Karpeev + pc  - the preconditioner object
2170c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
2171c84da90fSDmitry Karpeev 
217220f4b53cSBarry Smith   Options Database Key:
2173147403d9SBarry Smith . -pc_fieldsplit_diag_use_amat - use the Amat to provide the diagonal blocks
2174c84da90fSDmitry Karpeev 
2175c84da90fSDmitry Karpeev   Level: intermediate
2176c84da90fSDmitry Karpeev 
217760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetDiagUseAmat()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFIELDSPLIT`
2178c84da90fSDmitry Karpeev @*/
2179d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc, PetscBool flg)
2180d71ae5a4SJacob Faibussowitsch {
2181c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2182c84da90fSDmitry Karpeev   PetscBool      isfs;
2183c84da90fSDmitry Karpeev 
2184c84da90fSDmitry Karpeev   PetscFunctionBegin;
2185c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
21869566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
218728b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2188c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
21893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2190c84da90fSDmitry Karpeev }
2191c84da90fSDmitry Karpeev 
2192c84da90fSDmitry Karpeev /*@
2193f1580f4eSBarry Smith   PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build
2194c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2195c84da90fSDmitry Karpeev 
2196c3339decSBarry Smith   Logically Collective
2197c84da90fSDmitry Karpeev 
219820f4b53cSBarry Smith   Input Parameter:
2199c84da90fSDmitry Karpeev . pc - the preconditioner object
2200c84da90fSDmitry Karpeev 
220120f4b53cSBarry Smith   Output Parameter:
2202c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
2203c84da90fSDmitry Karpeev 
2204c84da90fSDmitry Karpeev   Level: intermediate
2205c84da90fSDmitry Karpeev 
220660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetDiagUseAmat()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFIELDSPLIT`
2207c84da90fSDmitry Karpeev @*/
2208d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc, PetscBool *flg)
2209d71ae5a4SJacob Faibussowitsch {
2210c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2211c84da90fSDmitry Karpeev   PetscBool      isfs;
2212c84da90fSDmitry Karpeev 
2213c84da90fSDmitry Karpeev   PetscFunctionBegin;
2214c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22154f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
22169566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
221728b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2218c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
22193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2220c84da90fSDmitry Karpeev }
2221c84da90fSDmitry Karpeev 
2222c84da90fSDmitry Karpeev /*@
2223f1580f4eSBarry Smith   PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build
2224c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2225c84da90fSDmitry Karpeev 
2226c3339decSBarry Smith   Logically Collective
2227c84da90fSDmitry Karpeev 
2228c84da90fSDmitry Karpeev   Input Parameters:
2229c84da90fSDmitry Karpeev + pc  - the preconditioner object
2230c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2231c84da90fSDmitry Karpeev 
223220f4b53cSBarry Smith   Options Database Key:
2233147403d9SBarry Smith . -pc_fieldsplit_off_diag_use_amat <bool> - use the Amat to extract the off-diagonal blocks
2234c84da90fSDmitry Karpeev 
2235c84da90fSDmitry Karpeev   Level: intermediate
2236c84da90fSDmitry Karpeev 
223760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFieldSplitSetDiagUseAmat()`, `PCFIELDSPLIT`
2238c84da90fSDmitry Karpeev @*/
2239d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc, PetscBool flg)
2240d71ae5a4SJacob Faibussowitsch {
2241c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2242c84da90fSDmitry Karpeev   PetscBool      isfs;
2243c84da90fSDmitry Karpeev 
2244c84da90fSDmitry Karpeev   PetscFunctionBegin;
2245c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22469566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
224728b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2248c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
22493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2250c84da90fSDmitry Karpeev }
2251c84da90fSDmitry Karpeev 
2252c84da90fSDmitry Karpeev /*@
2253f1580f4eSBarry Smith   PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build
2254c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2255c84da90fSDmitry Karpeev 
2256c3339decSBarry Smith   Logically Collective
2257c84da90fSDmitry Karpeev 
225820f4b53cSBarry Smith   Input Parameter:
2259c84da90fSDmitry Karpeev . pc - the preconditioner object
2260c84da90fSDmitry Karpeev 
226120f4b53cSBarry Smith   Output Parameter:
2262c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2263c84da90fSDmitry Karpeev 
2264c84da90fSDmitry Karpeev   Level: intermediate
2265c84da90fSDmitry Karpeev 
226660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFieldSplitGetDiagUseAmat()`, `PCFIELDSPLIT`
2267c84da90fSDmitry Karpeev @*/
2268d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc, PetscBool *flg)
2269d71ae5a4SJacob Faibussowitsch {
2270c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2271c84da90fSDmitry Karpeev   PetscBool      isfs;
2272c84da90fSDmitry Karpeev 
2273c84da90fSDmitry Karpeev   PetscFunctionBegin;
2274c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22754f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
22769566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
227728b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2278c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
22793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2280c84da90fSDmitry Karpeev }
2281c84da90fSDmitry Karpeev 
2282cc4c1da9SBarry Smith /*@
2283f1580f4eSBarry Smith   PCFieldSplitSetIS - Sets the exact elements for a split in a `PCFIELDSPLIT`
2284704ba839SBarry Smith 
2285c3339decSBarry Smith   Logically Collective
2286704ba839SBarry Smith 
2287704ba839SBarry Smith   Input Parameters:
2288704ba839SBarry Smith + pc        - the preconditioner context
228960f59c3bSBarry Smith . splitname - name of this split, if `NULL` the number of the split is used
2290f1580f4eSBarry Smith - is        - the index set that defines the elements in this split
2291704ba839SBarry Smith 
229260f59c3bSBarry Smith   Level: intermediate
229360f59c3bSBarry Smith 
2294a6ffb8dbSJed Brown   Notes:
229580670ca5SBarry Smith   Use `PCFieldSplitSetFields()`, for splits defined by strided `IS` based on the matrix block size or the `is_rows[]` passed into `MATNEST`
2296a6ffb8dbSJed Brown 
2297db4c96c1SJed Brown   This function is called once per split (it creates a new split each time).  Solve options
2298db4c96c1SJed Brown   for this split will be available under the prefix -fieldsplit_SPLITNAME_.
2299d32f9abdSBarry Smith 
230080670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetFields()`
2301704ba839SBarry Smith @*/
2302d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetIS(PC pc, const char splitname[], IS is)
2303d71ae5a4SJacob Faibussowitsch {
2304704ba839SBarry Smith   PetscFunctionBegin;
23050700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23064f572ea9SToby Isaac   if (splitname) PetscAssertPointer(splitname, 2);
2307db4c96c1SJed Brown   PetscValidHeaderSpecific(is, IS_CLASSID, 3);
2308cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetIS_C", (PC, const char[], IS), (pc, splitname, is));
23093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2310704ba839SBarry Smith }
2311704ba839SBarry Smith 
2312cc4c1da9SBarry Smith /*@
2313f1580f4eSBarry Smith   PCFieldSplitGetIS - Retrieves the elements for a split as an `IS`
231457a9adfeSMatthew G Knepley 
2315c3339decSBarry Smith   Logically Collective
231657a9adfeSMatthew G Knepley 
231757a9adfeSMatthew G Knepley   Input Parameters:
231857a9adfeSMatthew G Knepley + pc        - the preconditioner context
231957a9adfeSMatthew G Knepley - splitname - name of this split
232057a9adfeSMatthew G Knepley 
232157a9adfeSMatthew G Knepley   Output Parameter:
2322feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split, or `NULL` if the split is not found
232357a9adfeSMatthew G Knepley 
232457a9adfeSMatthew G Knepley   Level: intermediate
232557a9adfeSMatthew G Knepley 
232680670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetIS()`, `PCFieldSplitGetISByIndex()`
232757a9adfeSMatthew G Knepley @*/
2328d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetIS(PC pc, const char splitname[], IS *is)
2329d71ae5a4SJacob Faibussowitsch {
233057a9adfeSMatthew G Knepley   PetscFunctionBegin;
233157a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23324f572ea9SToby Isaac   PetscAssertPointer(splitname, 2);
23334f572ea9SToby Isaac   PetscAssertPointer(is, 3);
233457a9adfeSMatthew G Knepley   {
233557a9adfeSMatthew G Knepley     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
233657a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
233757a9adfeSMatthew G Knepley     PetscBool         found;
233857a9adfeSMatthew G Knepley 
23390298fd71SBarry Smith     *is = NULL;
234057a9adfeSMatthew G Knepley     while (ilink) {
23419566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(ilink->splitname, splitname, &found));
234257a9adfeSMatthew G Knepley       if (found) {
234357a9adfeSMatthew G Knepley         *is = ilink->is;
234457a9adfeSMatthew G Knepley         break;
234557a9adfeSMatthew G Knepley       }
234657a9adfeSMatthew G Knepley       ilink = ilink->next;
234757a9adfeSMatthew G Knepley     }
234857a9adfeSMatthew G Knepley   }
23493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
235057a9adfeSMatthew G Knepley }
235157a9adfeSMatthew G Knepley 
2352cc4c1da9SBarry Smith /*@
2353f1580f4eSBarry Smith   PCFieldSplitGetISByIndex - Retrieves the elements for a given split as an `IS`
2354998f007dSPierre Jolivet 
2355c3339decSBarry Smith   Logically Collective
2356998f007dSPierre Jolivet 
2357998f007dSPierre Jolivet   Input Parameters:
2358998f007dSPierre Jolivet + pc    - the preconditioner context
2359998f007dSPierre Jolivet - index - index of this split
2360998f007dSPierre Jolivet 
2361998f007dSPierre Jolivet   Output Parameter:
2362feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split
2363998f007dSPierre Jolivet 
2364998f007dSPierre Jolivet   Level: intermediate
2365998f007dSPierre Jolivet 
236680670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitGetIS()`, `PCFieldSplitSetIS()`,
236780670ca5SBarry Smith 
2368998f007dSPierre Jolivet @*/
2369d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetISByIndex(PC pc, PetscInt index, IS *is)
2370d71ae5a4SJacob Faibussowitsch {
2371998f007dSPierre Jolivet   PetscFunctionBegin;
237263a3b9bcSJacob Faibussowitsch   PetscCheck(index >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", index);
2373998f007dSPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23744f572ea9SToby Isaac   PetscAssertPointer(is, 3);
2375998f007dSPierre Jolivet   {
2376998f007dSPierre Jolivet     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
2377998f007dSPierre Jolivet     PC_FieldSplitLink ilink = jac->head;
2378998f007dSPierre Jolivet     PetscInt          i     = 0;
237963a3b9bcSJacob Faibussowitsch     PetscCheck(index < jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", index, jac->nsplits);
2380998f007dSPierre Jolivet 
2381998f007dSPierre Jolivet     while (i < index) {
2382998f007dSPierre Jolivet       ilink = ilink->next;
2383998f007dSPierre Jolivet       ++i;
2384998f007dSPierre Jolivet     }
23859566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitGetIS(pc, ilink->splitname, is));
2386998f007dSPierre Jolivet   }
23873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2388998f007dSPierre Jolivet }
2389998f007dSPierre Jolivet 
239051f519a2SBarry Smith /*@
239151f519a2SBarry Smith   PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
239280670ca5SBarry Smith   fieldsplit preconditioner when calling `PCFieldSplitSetFields()`. If not set the matrix block size is used.
239351f519a2SBarry Smith 
2394c3339decSBarry Smith   Logically Collective
239551f519a2SBarry Smith 
239651f519a2SBarry Smith   Input Parameters:
239751f519a2SBarry Smith + pc - the preconditioner context
239851f519a2SBarry Smith - bs - the block size
239951f519a2SBarry Smith 
240051f519a2SBarry Smith   Level: intermediate
240151f519a2SBarry Smith 
240280670ca5SBarry Smith   Note:
240380670ca5SBarry Smith   If the matrix is a `MATNEST` then the `is_rows[]` passed to `MatCreateNest()` determines the fields.
240480670ca5SBarry Smith 
240560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
240651f519a2SBarry Smith @*/
2407d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetBlockSize(PC pc, PetscInt bs)
2408d71ae5a4SJacob Faibussowitsch {
240951f519a2SBarry Smith   PetscFunctionBegin;
24100700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2411c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc, bs, 2);
2412cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetBlockSize_C", (PC, PetscInt), (pc, bs));
24133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
241451f519a2SBarry Smith }
241551f519a2SBarry Smith 
24160971522cSBarry Smith /*@C
2417f1580f4eSBarry Smith   PCFieldSplitGetSubKSP - Gets the `KSP` contexts for all splits
24180971522cSBarry Smith 
2419c3339decSBarry Smith   Collective
24200971522cSBarry Smith 
24210971522cSBarry Smith   Input Parameter:
24220971522cSBarry Smith . pc - the preconditioner context
24230971522cSBarry Smith 
24240971522cSBarry Smith   Output Parameters:
242513e0d083SBarry Smith + n      - the number of splits
2426f1580f4eSBarry Smith - subksp - the array of `KSP` contexts
2427196cc216SBarry Smith 
24280971522cSBarry Smith   Level: advanced
24290971522cSBarry Smith 
2430f1580f4eSBarry Smith   Notes:
2431f1580f4eSBarry Smith   After `PCFieldSplitGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()`
2432f1580f4eSBarry Smith   (not the `KSP`, just the array that contains them).
2433f1580f4eSBarry Smith 
2434f1580f4eSBarry Smith   You must call `PCSetUp()` before calling `PCFieldSplitGetSubKSP()`.
2435f1580f4eSBarry Smith 
2436f1580f4eSBarry Smith   If the fieldsplit is of type `PC_COMPOSITE_SCHUR`, it returns the `KSP` object used inside the
2437f1580f4eSBarry Smith   Schur complement and the `KSP` object used to iterate over the Schur complement.
2438f1580f4eSBarry Smith   To access all the `KSP` objects used in `PC_COMPOSITE_SCHUR`, use `PCFieldSplitSchurGetSubKSP()`.
2439f1580f4eSBarry Smith 
2440f1580f4eSBarry Smith   If the fieldsplit is of type `PC_COMPOSITE_GKB`, it returns the `KSP` object used to solve the
2441f1580f4eSBarry Smith   inner linear system defined by the matrix H in each loop.
2442f1580f4eSBarry Smith 
2443feefa0e1SJacob Faibussowitsch   Fortran Notes:
2444f1580f4eSBarry Smith   You must pass in a `KSP` array that is large enough to contain all the `KSP`s.
2445f1580f4eSBarry Smith   You can call `PCFieldSplitGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the
2446f1580f4eSBarry Smith   `KSP` array must be.
2447f1580f4eSBarry Smith 
2448feefa0e1SJacob Faibussowitsch   Developer Notes:
2449f1580f4eSBarry Smith   There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()`
2450f1580f4eSBarry Smith 
24515d83a8b1SBarry Smith   The Fortran interface could be modernized to return directly the array of values.
2452f1580f4eSBarry Smith 
245360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitSchurGetSubKSP()`
24540971522cSBarry Smith @*/
2455d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSubKSP(PC pc, PetscInt *n, KSP *subksp[])
2456d71ae5a4SJacob Faibussowitsch {
24570971522cSBarry Smith   PetscFunctionBegin;
24580700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
24594f572ea9SToby Isaac   if (n) PetscAssertPointer(n, 2);
2460cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
24613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24620971522cSBarry Smith }
24630971522cSBarry Smith 
2464285fb4e2SStefano Zampini /*@C
2465f1580f4eSBarry Smith   PCFieldSplitSchurGetSubKSP - Gets the `KSP` contexts used inside the Schur complement based `PCFIELDSPLIT`
2466285fb4e2SStefano Zampini 
246760f59c3bSBarry Smith   Collective
2468285fb4e2SStefano Zampini 
2469285fb4e2SStefano Zampini   Input Parameter:
2470285fb4e2SStefano Zampini . pc - the preconditioner context
2471285fb4e2SStefano Zampini 
2472285fb4e2SStefano Zampini   Output Parameters:
2473285fb4e2SStefano Zampini + n      - the number of splits
2474f1580f4eSBarry Smith - subksp - the array of `KSP` contexts
2475285fb4e2SStefano Zampini 
2476285fb4e2SStefano Zampini   Level: advanced
2477285fb4e2SStefano Zampini 
2478f1580f4eSBarry Smith   Notes:
2479f1580f4eSBarry Smith   After `PCFieldSplitSchurGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()`
2480f1580f4eSBarry Smith   (not the `KSP` just the array that contains them).
2481f1580f4eSBarry Smith 
2482f1580f4eSBarry Smith   You must call `PCSetUp()` before calling `PCFieldSplitSchurGetSubKSP()`.
2483f1580f4eSBarry Smith 
2484f1580f4eSBarry Smith   If the fieldsplit type is of type `PC_COMPOSITE_SCHUR`, it returns (in order)
2485f1580f4eSBarry Smith +  1  - the `KSP` used for the (1,1) block
2486f1580f4eSBarry Smith .  2  - the `KSP` used for the Schur complement (not the one used for the interior Schur solver)
2487f1580f4eSBarry Smith -  3  - the `KSP` used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block).
2488f1580f4eSBarry Smith 
2489f1580f4eSBarry Smith   It returns a null array if the fieldsplit is not of type `PC_COMPOSITE_SCHUR`; in this case, you should use `PCFieldSplitGetSubKSP()`.
2490f1580f4eSBarry Smith 
2491feefa0e1SJacob Faibussowitsch   Fortran Notes:
2492f1580f4eSBarry Smith   You must pass in a `KSP` array that is large enough to contain all the local `KSP`s.
2493f1580f4eSBarry Smith   You can call `PCFieldSplitSchurGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the
2494f1580f4eSBarry Smith   `KSP` array must be.
2495f1580f4eSBarry Smith 
2496f1580f4eSBarry Smith   Developer Notes:
2497f1580f4eSBarry Smith   There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()`
2498f1580f4eSBarry Smith 
2499f1580f4eSBarry Smith   Should the functionality of `PCFieldSplitSchurGetSubKSP()` and `PCFieldSplitGetSubKSP()` be merged?
2500f1580f4eSBarry Smith 
2501f1580f4eSBarry Smith   The Fortran interface should be modernized to return directly the array of values.
2502f1580f4eSBarry Smith 
250360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitGetSubKSP()`
2504285fb4e2SStefano Zampini @*/
2505d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc, PetscInt *n, KSP *subksp[])
2506d71ae5a4SJacob Faibussowitsch {
2507285fb4e2SStefano Zampini   PetscFunctionBegin;
2508285fb4e2SStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
25094f572ea9SToby Isaac   if (n) PetscAssertPointer(n, 2);
2510cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitSchurGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
25113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2512285fb4e2SStefano Zampini }
2513285fb4e2SStefano Zampini 
2514e69d4d44SBarry Smith /*@
2515c14e9f00SDavid Andrs   PCFieldSplitSetSchurPre -  Indicates from what operator the preconditioner is constructed for the Schur complement.
2516a1e3cbf9SBarry Smith   The default is the A11 matrix.
2517e69d4d44SBarry Smith 
2518c3339decSBarry Smith   Collective
2519e69d4d44SBarry Smith 
2520e69d4d44SBarry Smith   Input Parameters:
2521e69d4d44SBarry Smith + pc    - the preconditioner context
2522f1580f4eSBarry Smith . ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11` (default),
2523f1580f4eSBarry Smith               `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER`,
2524f1580f4eSBarry Smith               `PC_FIELDSPLIT_SCHUR_PRE_SELFP`, and `PC_FIELDSPLIT_SCHUR_PRE_FULL`
252560f59c3bSBarry Smith - pre   - matrix to use for preconditioning, or `NULL`
2526084e4875SJed Brown 
2527f1580f4eSBarry Smith   Options Database Keys:
2528d59693daSPierre Jolivet + -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is `a11`. See notes for meaning of various arguments
2529a1e3cbf9SBarry Smith - -fieldsplit_1_pc_type <pctype>                               - the preconditioner algorithm that is used to construct the preconditioner from the operator
2530e69d4d44SBarry Smith 
253160f59c3bSBarry Smith   Level: intermediate
253260f59c3bSBarry Smith 
2533fd1303e9SJungho Lee   Notes:
2534f1580f4eSBarry Smith   If ptype is
2535f1580f4eSBarry Smith +     a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
2536f1580f4eSBarry Smith   matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
2537f1580f4eSBarry Smith .     self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
2538e7593814SPierre Jolivet   The only preconditioners that currently work with this symbolic representation matrix object are `PCLSC` and `PCHPDDM`
2539f1580f4eSBarry Smith .     user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
2540f1580f4eSBarry Smith   to this function).
2541a077d33dSBarry Smith .     selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation $ Sp = A11 - A10 inv(diag(A00)) A01 $
2542f1580f4eSBarry Smith   This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
2543d59693daSPierre Jolivet   lumped before extracting the diagonal using the additional option `-fieldsplit_1_mat_schur_complement_ainv_type lump`
2544f1580f4eSBarry Smith -     full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation
2545f1580f4eSBarry Smith   computed internally by `PCFIELDSPLIT` (this is expensive)
2546f1580f4eSBarry Smith   useful mostly as a test that the Schur complement approach can work for your problem
2547fd1303e9SJungho Lee 
2548d59693daSPierre Jolivet   When solving a saddle point problem, where the A11 block is identically zero, using `a11` as the ptype only makes sense
2549a077d33dSBarry Smith   with the additional option `-fieldsplit_1_pc_type none`. Usually for saddle point problems one would use a `ptype` of `self` and
2550d59693daSPierre Jolivet   `-fieldsplit_1_pc_type lsc` which uses the least squares commutator to compute a preconditioner for the Schur complement.
2551fd1303e9SJungho Lee 
2552a077d33dSBarry Smith   Developer Note:
2553a077d33dSBarry Smith   The name of this function and the option `-pc_fieldsplit_schur_precondition` are inconsistent; precondition should be used everywhere.
2554feefa0e1SJacob Faibussowitsch 
2555a077d33dSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`,
2556a077d33dSBarry Smith           `MatSchurComplementSetAinvType()`, `PCLSC`, `PCFieldSplitSetSchurFactType()`
2557e69d4d44SBarry Smith @*/
2558d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurPre(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2559d71ae5a4SJacob Faibussowitsch {
2560e69d4d44SBarry Smith   PetscFunctionBegin;
25610700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2562cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurPre_C", (PC, PCFieldSplitSchurPreType, Mat), (pc, ptype, pre));
25633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2564e69d4d44SBarry Smith }
2565686bed4dSStefano Zampini 
2566d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurPrecondition(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2567d71ae5a4SJacob Faibussowitsch {
25689371c9d4SSatish Balay   return PCFieldSplitSetSchurPre(pc, ptype, pre);
25699371c9d4SSatish Balay } /* Deprecated name */
2570e69d4d44SBarry Smith 
257137a82bf0SJed Brown /*@
257237a82bf0SJed Brown   PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
2573f1580f4eSBarry Smith   preconditioned.  See `PCFieldSplitSetSchurPre()` for details.
257437a82bf0SJed Brown 
2575c3339decSBarry Smith   Logically Collective
257637a82bf0SJed Brown 
2577f899ff85SJose E. Roman   Input Parameter:
257837a82bf0SJed Brown . pc - the preconditioner context
257937a82bf0SJed Brown 
258037a82bf0SJed Brown   Output Parameters:
2581d59693daSPierre 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`
2582d59693daSPierre Jolivet - pre   - matrix to use for preconditioning (with `PC_FIELDSPLIT_SCHUR_PRE_USER`), or `NULL`
258337a82bf0SJed Brown 
258437a82bf0SJed Brown   Level: intermediate
258537a82bf0SJed Brown 
2586d59693daSPierre Jolivet .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCLSC`
258737a82bf0SJed Brown @*/
2588d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurPre(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre)
2589d71ae5a4SJacob Faibussowitsch {
259037a82bf0SJed Brown   PetscFunctionBegin;
259137a82bf0SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2592cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSchurPre_C", (PC, PCFieldSplitSchurPreType *, Mat *), (pc, ptype, pre));
25933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2594e69d4d44SBarry Smith }
2595e69d4d44SBarry Smith 
259645e7fc46SDmitry Karpeev /*@
2597f1580f4eSBarry Smith   PCFieldSplitSchurGetS -  extract the `MATSCHURCOMPLEMENT` object used by this `PCFIELDSPLIT` in case it needs to be configured separately
259845e7fc46SDmitry Karpeev 
259920f4b53cSBarry Smith   Not Collective
260045e7fc46SDmitry Karpeev 
260145e7fc46SDmitry Karpeev   Input Parameter:
260245e7fc46SDmitry Karpeev . pc - the preconditioner context
260345e7fc46SDmitry Karpeev 
260445e7fc46SDmitry Karpeev   Output Parameter:
2605470b340bSDmitry Karpeev . S - the Schur complement matrix
260645e7fc46SDmitry Karpeev 
260760f59c3bSBarry Smith   Level: advanced
260860f59c3bSBarry Smith 
2609f1580f4eSBarry Smith   Note:
2610f1580f4eSBarry Smith   This matrix should not be destroyed using `MatDestroy()`; rather, use `PCFieldSplitSchurRestoreS()`.
261145e7fc46SDmitry Karpeev 
261260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MATSCHURCOMPLEMENT`, `PCFieldSplitSchurRestoreS()`,
2613f1580f4eSBarry Smith           `MatCreateSchurComplement()`, `MatSchurComplementGetKSP()`, `MatSchurComplementComputeExplicitOperator()`, `MatGetSchurComplement()`
261445e7fc46SDmitry Karpeev @*/
2615d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetS(PC pc, Mat *S)
2616d71ae5a4SJacob Faibussowitsch {
261745e7fc46SDmitry Karpeev   const char    *t;
261845e7fc46SDmitry Karpeev   PetscBool      isfs;
261945e7fc46SDmitry Karpeev   PC_FieldSplit *jac;
262045e7fc46SDmitry Karpeev 
262145e7fc46SDmitry Karpeev   PetscFunctionBegin;
262245e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
26239566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
26249566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
262528b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
262645e7fc46SDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
262763a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
2628470b340bSDmitry Karpeev   if (S) *S = jac->schur;
26293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
263045e7fc46SDmitry Karpeev }
263145e7fc46SDmitry Karpeev 
2632470b340bSDmitry Karpeev /*@
2633f1580f4eSBarry Smith   PCFieldSplitSchurRestoreS -  returns the `MATSCHURCOMPLEMENT` matrix used by this `PC`
2634470b340bSDmitry Karpeev 
263520f4b53cSBarry Smith   Not Collective
2636470b340bSDmitry Karpeev 
2637470b340bSDmitry Karpeev   Input Parameters:
2638470b340bSDmitry Karpeev + pc - the preconditioner context
2639a2b725a8SWilliam Gropp - S  - the Schur complement matrix
2640470b340bSDmitry Karpeev 
2641470b340bSDmitry Karpeev   Level: advanced
2642470b340bSDmitry Karpeev 
264360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MatSchurComplement`, `PCFieldSplitSchurGetS()`
2644470b340bSDmitry Karpeev @*/
2645d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurRestoreS(PC pc, Mat *S)
2646d71ae5a4SJacob Faibussowitsch {
2647470b340bSDmitry Karpeev   const char    *t;
2648470b340bSDmitry Karpeev   PetscBool      isfs;
2649470b340bSDmitry Karpeev   PC_FieldSplit *jac;
2650470b340bSDmitry Karpeev 
2651470b340bSDmitry Karpeev   PetscFunctionBegin;
2652470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
26539566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
26549566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
265528b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
2656470b340bSDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
265763a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
26587827d75bSBarry Smith   PetscCheck(S && (*S == jac->schur), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatSchurComplement restored is not the same as gotten");
26593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2660470b340bSDmitry Karpeev }
2661470b340bSDmitry Karpeev 
2662d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2663d71ae5a4SJacob Faibussowitsch {
2664e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2665e69d4d44SBarry Smith 
2666e69d4d44SBarry Smith   PetscFunctionBegin;
2667084e4875SJed Brown   jac->schurpre = ptype;
2668a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
26699566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&jac->schur_user));
2670084e4875SJed Brown     jac->schur_user = pre;
26719566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
2672084e4875SJed Brown   }
26733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2674e69d4d44SBarry Smith }
2675e69d4d44SBarry Smith 
2676d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre)
2677d71ae5a4SJacob Faibussowitsch {
267837a82bf0SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
267937a82bf0SJed Brown 
268037a82bf0SJed Brown   PetscFunctionBegin;
26816056e507SPierre Jolivet   if (ptype) *ptype = jac->schurpre;
26826056e507SPierre Jolivet   if (pre) *pre = jac->schur_user;
26833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
268437a82bf0SJed Brown }
268537a82bf0SJed Brown 
2686ab1df9f5SJed Brown /*@
26871d27aa22SBarry Smith   PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner {cite}`murphy2000note` and {cite}`ipsen2001note`
2688ab1df9f5SJed Brown 
2689c3339decSBarry Smith   Collective
2690ab1df9f5SJed Brown 
2691ab1df9f5SJed Brown   Input Parameters:
2692ab1df9f5SJed Brown + pc    - the preconditioner context
2693f1580f4eSBarry Smith - ftype - which blocks of factorization to retain, `PC_FIELDSPLIT_SCHUR_FACT_FULL` is default
2694ab1df9f5SJed Brown 
2695f1580f4eSBarry Smith   Options Database Key:
2696d59693daSPierre Jolivet . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - default is `full`
2697ab1df9f5SJed Brown 
2698ab1df9f5SJed Brown   Level: intermediate
2699ab1df9f5SJed Brown 
2700ab1df9f5SJed Brown   Notes:
2701ab1df9f5SJed Brown   The FULL factorization is
2702ab1df9f5SJed Brown 
2703a077d33dSBarry Smith   ```{math}
2704a077d33dSBarry Smith   \left(\begin{array}{cc} A & B \\
2705a077d33dSBarry Smith   C & E \\
2706a077d33dSBarry Smith   \end{array}\right) =
2707a077d33dSBarry Smith   \left(\begin{array}{cc} 1 & 0 \\
2708a077d33dSBarry Smith   C*A^{-1} & I \\
2709a077d33dSBarry Smith   \end{array}\right)
2710a077d33dSBarry Smith   \left(\begin{array}{cc} A & 0 \\
2711a077d33dSBarry Smith   0 & S \\
2712a077d33dSBarry Smith   \end{array}\right)
2713a077d33dSBarry Smith   \left(\begin{array}{cc} I & A^{-1}B \\
2714a077d33dSBarry Smith   0 & I \\
2715a077d33dSBarry Smith   \end{array}\right) = L D U.
2716a077d33dSBarry Smith   ```
2717a077d33dSBarry Smith 
2718a077d33dSBarry Smith   where $ S = E - C*A^{-1}*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$,
2719a077d33dSBarry Smith   and DIAG is the diagonal part with the sign of $ S $ flipped (because this makes the preconditioner positive definite for many formulations,
2720a077d33dSBarry Smith   thus allowing the use of `KSPMINRES)`. Sign flipping of $ S $ can be turned off with `PCFieldSplitSetSchurScale()`.
2721a077d33dSBarry Smith 
2722a077d33dSBarry Smith   If $A$ and $S$ are solved exactly
2723a077d33dSBarry Smith +  1 - FULL factorization is a direct solver.
2724a077d33dSBarry Smith .  2 - 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.
2725a077d33dSBarry Smith -  3 -  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.
2726ab1df9f5SJed Brown 
2727f1580f4eSBarry Smith   If the iteration count is very low, consider using `KSPFGMRES` or `KSPGCR` which can use one less preconditioner
27280ffb0e17SBarry 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.
27290ffb0e17SBarry Smith 
2730a077d33dSBarry Smith   For symmetric problems in which $A$ is positive definite and $S$ is negative definite, DIAG can be used with `KSPMINRES`.
27310ffb0e17SBarry Smith 
27321d27aa22SBarry 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).
2733ab1df9f5SJed Brown 
27341d27aa22SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurScale()`,
2735a077d33dSBarry Smith           [](sec_flexibleksp), `PCFieldSplitSetSchurPre()`
2736ab1df9f5SJed Brown @*/
2737d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurFactType(PC pc, PCFieldSplitSchurFactType ftype)
2738d71ae5a4SJacob Faibussowitsch {
2739ab1df9f5SJed Brown   PetscFunctionBegin;
2740ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2741cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurFactType_C", (PC, PCFieldSplitSchurFactType), (pc, ftype));
27423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2743ab1df9f5SJed Brown }
2744ab1df9f5SJed Brown 
2745d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc, PCFieldSplitSchurFactType ftype)
2746d71ae5a4SJacob Faibussowitsch {
2747ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2748ab1df9f5SJed Brown 
2749ab1df9f5SJed Brown   PetscFunctionBegin;
2750ab1df9f5SJed Brown   jac->schurfactorization = ftype;
27513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2752ab1df9f5SJed Brown }
2753ab1df9f5SJed Brown 
2754c096484dSStefano Zampini /*@
2755f1580f4eSBarry Smith   PCFieldSplitSetSchurScale -  Controls the sign flip of S for `PC_FIELDSPLIT_SCHUR_FACT_DIAG`.
2756c096484dSStefano Zampini 
2757c3339decSBarry Smith   Collective
2758c096484dSStefano Zampini 
2759c096484dSStefano Zampini   Input Parameters:
2760c096484dSStefano Zampini + pc    - the preconditioner context
2761c096484dSStefano Zampini - scale - scaling factor for the Schur complement
2762c096484dSStefano Zampini 
2763f1580f4eSBarry Smith   Options Database Key:
27641d27aa22SBarry Smith . -pc_fieldsplit_schur_scale <scale> - default is -1.0
2765c096484dSStefano Zampini 
2766c096484dSStefano Zampini   Level: intermediate
2767c096484dSStefano Zampini 
276842747ad1SJacob Faibussowitsch .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurFactType`, `PCFieldSplitSetSchurFactType()`
2769c096484dSStefano Zampini @*/
2770d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurScale(PC pc, PetscScalar scale)
2771d71ae5a4SJacob Faibussowitsch {
2772c096484dSStefano Zampini   PetscFunctionBegin;
2773c096484dSStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2774c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc, scale, 2);
2775cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurScale_C", (PC, PetscScalar), (pc, scale));
27763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2777c096484dSStefano Zampini }
2778c096484dSStefano Zampini 
2779d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc, PetscScalar scale)
2780d71ae5a4SJacob Faibussowitsch {
2781c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2782c096484dSStefano Zampini 
2783c096484dSStefano Zampini   PetscFunctionBegin;
2784c096484dSStefano Zampini   jac->schurscale = scale;
27853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2786c096484dSStefano Zampini }
2787c096484dSStefano Zampini 
278830ad9308SMatthew Knepley /*@C
27898c03b21aSDmitry Karpeev   PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
279030ad9308SMatthew Knepley 
2791c3339decSBarry Smith   Collective
279230ad9308SMatthew Knepley 
279330ad9308SMatthew Knepley   Input Parameter:
279430ad9308SMatthew Knepley . pc - the preconditioner context
279530ad9308SMatthew Knepley 
279630ad9308SMatthew Knepley   Output Parameters:
2797a04f6461SBarry Smith + A00 - the (0,0) block
2798a04f6461SBarry Smith . A01 - the (0,1) block
2799a04f6461SBarry Smith . A10 - the (1,0) block
2800a04f6461SBarry Smith - A11 - the (1,1) block
280130ad9308SMatthew Knepley 
280230ad9308SMatthew Knepley   Level: advanced
280330ad9308SMatthew Knepley 
28045d83a8b1SBarry Smith   Note:
28055d83a8b1SBarry Smith   Use `NULL` for any unneeded output arguments
28065d83a8b1SBarry Smith 
280760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `MatSchurComplementGetSubMatrices()`, `MatSchurComplementSetSubMatrices()`
280830ad9308SMatthew Knepley @*/
2809d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc, Mat *A00, Mat *A01, Mat *A10, Mat *A11)
2810d71ae5a4SJacob Faibussowitsch {
281130ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
281230ad9308SMatthew Knepley 
281330ad9308SMatthew Knepley   PetscFunctionBegin;
28140700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
281508401ef6SPierre Jolivet   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2816a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2817a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2818a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2819a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
28203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
282130ad9308SMatthew Knepley }
282230ad9308SMatthew Knepley 
2823b09e027eSCarola Kruse /*@
28241d27aa22SBarry Smith   PCFieldSplitSetGKBTol -  Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2825b09e027eSCarola Kruse 
2826c3339decSBarry Smith   Collective
2827e071a0a4SCarola Kruse 
2828b09e027eSCarola Kruse   Input Parameters:
2829b09e027eSCarola Kruse + pc        - the preconditioner context
2830b09e027eSCarola Kruse - tolerance - the solver tolerance
2831b09e027eSCarola Kruse 
2832f1580f4eSBarry Smith   Options Database Key:
28331d27aa22SBarry Smith . -pc_fieldsplit_gkb_tol <tolerance> - default is 1e-5
2834b09e027eSCarola Kruse 
2835b09e027eSCarola Kruse   Level: intermediate
2836b09e027eSCarola Kruse 
2837f1580f4eSBarry Smith   Note:
28381d27aa22SBarry Smith   The generalized GKB algorithm {cite}`arioli2013` uses a lower bound estimate of the error in energy norm as stopping criterion.
2839f1580f4eSBarry Smith   It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than
28401d27aa22SBarry Smith   this estimate, the stopping criterion is satisfactory in practical cases.
2841f1580f4eSBarry Smith 
284260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBMaxit()`
2843b09e027eSCarola Kruse @*/
2844d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBTol(PC pc, PetscReal tolerance)
2845d71ae5a4SJacob Faibussowitsch {
2846b09e027eSCarola Kruse   PetscFunctionBegin;
2847b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2848de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, tolerance, 2);
2849cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBTol_C", (PC, PetscReal), (pc, tolerance));
28503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2851b09e027eSCarola Kruse }
2852b09e027eSCarola Kruse 
2853d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc, PetscReal tolerance)
2854d71ae5a4SJacob Faibussowitsch {
2855b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2856b09e027eSCarola Kruse 
2857b09e027eSCarola Kruse   PetscFunctionBegin;
2858b09e027eSCarola Kruse   jac->gkbtol = tolerance;
28593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2860b09e027eSCarola Kruse }
2861b09e027eSCarola Kruse 
2862b09e027eSCarola Kruse /*@
286380670ca5SBarry Smith   PCFieldSplitSetGKBMaxit -  Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2864b09e027eSCarola Kruse 
2865c3339decSBarry Smith   Collective
2866b09e027eSCarola Kruse 
2867b09e027eSCarola Kruse   Input Parameters:
2868b09e027eSCarola Kruse + pc    - the preconditioner context
2869b09e027eSCarola Kruse - maxit - the maximum number of iterations
2870b09e027eSCarola Kruse 
2871f1580f4eSBarry Smith   Options Database Key:
28721d27aa22SBarry Smith . -pc_fieldsplit_gkb_maxit <maxit> - default is 100
2873b09e027eSCarola Kruse 
2874b09e027eSCarola Kruse   Level: intermediate
2875b09e027eSCarola Kruse 
287660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBNu()`
2877b09e027eSCarola Kruse @*/
2878d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc, PetscInt maxit)
2879d71ae5a4SJacob Faibussowitsch {
2880b09e027eSCarola Kruse   PetscFunctionBegin;
2881b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2882de482cd7SCarola Kruse   PetscValidLogicalCollectiveInt(pc, maxit, 2);
2883cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBMaxit_C", (PC, PetscInt), (pc, maxit));
28843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2885b09e027eSCarola Kruse }
2886b09e027eSCarola Kruse 
2887d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc, PetscInt maxit)
2888d71ae5a4SJacob Faibussowitsch {
2889b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2890b09e027eSCarola Kruse 
2891b09e027eSCarola Kruse   PetscFunctionBegin;
2892b09e027eSCarola Kruse   jac->gkbmaxit = maxit;
28933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2894b09e027eSCarola Kruse }
2895b09e027eSCarola Kruse 
2896b09e027eSCarola Kruse /*@
28971d27aa22SBarry Smith   PCFieldSplitSetGKBDelay -  Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization {cite}`arioli2013` in `PCFIELDSPLIT`
2898e071a0a4SCarola Kruse   preconditioner.
2899b09e027eSCarola Kruse 
2900c3339decSBarry Smith   Collective
2901b09e027eSCarola Kruse 
2902b09e027eSCarola Kruse   Input Parameters:
2903b09e027eSCarola Kruse + pc    - the preconditioner context
2904b09e027eSCarola Kruse - delay - the delay window in the lower bound estimate
2905b09e027eSCarola Kruse 
2906f1580f4eSBarry Smith   Options Database Key:
29071d27aa22SBarry Smith . -pc_fieldsplit_gkb_delay <delay> - default is 5
2908b09e027eSCarola Kruse 
2909b09e027eSCarola Kruse   Level: intermediate
2910b09e027eSCarola Kruse 
29111d27aa22SBarry Smith   Notes:
29121d27aa22SBarry 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 $
29131d27aa22SBarry 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
29141d27aa22SBarry Smith   at least (`delay` + 1) iterations to stop.
2915f1580f4eSBarry Smith 
29161d27aa22SBarry Smith   For more details on the generalized Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to {cite}`arioli2013`
2917f1580f4eSBarry Smith 
291860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
2919b09e027eSCarola Kruse @*/
2920d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBDelay(PC pc, PetscInt delay)
2921d71ae5a4SJacob Faibussowitsch {
2922b09e027eSCarola Kruse   PetscFunctionBegin;
2923b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2924b09e027eSCarola Kruse   PetscValidLogicalCollectiveInt(pc, delay, 2);
2925cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBDelay_C", (PC, PetscInt), (pc, delay));
29263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2927b09e027eSCarola Kruse }
2928b09e027eSCarola Kruse 
2929d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc, PetscInt delay)
2930d71ae5a4SJacob Faibussowitsch {
2931b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2932b09e027eSCarola Kruse 
2933b09e027eSCarola Kruse   PetscFunctionBegin;
2934b09e027eSCarola Kruse   jac->gkbdelay = delay;
29353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2936b09e027eSCarola Kruse }
2937b09e027eSCarola Kruse 
2938b09e027eSCarola Kruse /*@
29391d27aa22SBarry Smith   PCFieldSplitSetGKBNu -  Sets the scalar value nu >= 0 in the transformation H = A00 + nu*A01*A01' of the (1,1) block in the
29401d27aa22SBarry Smith   Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2941b09e027eSCarola Kruse 
2942c3339decSBarry Smith   Collective
2943f1580f4eSBarry Smith 
2944f1580f4eSBarry Smith   Input Parameters:
2945f1580f4eSBarry Smith + pc - the preconditioner context
2946f1580f4eSBarry Smith - nu - the shift parameter
2947f1580f4eSBarry Smith 
294820f4b53cSBarry Smith   Options Database Key:
29491d27aa22SBarry Smith . -pc_fieldsplit_gkb_nu <nu> - default is 1
2950f1580f4eSBarry Smith 
2951f1580f4eSBarry Smith   Level: intermediate
2952b09e027eSCarola Kruse 
2953b09e027eSCarola Kruse   Notes:
29541d27aa22SBarry 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,
29551d27aa22SBarry 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
2956b09e027eSCarola Kruse   necessary to find a good balance in between the convergence of the inner and outer loop.
2957b09e027eSCarola Kruse 
29581d27aa22SBarry 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.
2959b09e027eSCarola Kruse 
296060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
2961b09e027eSCarola Kruse @*/
2962d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBNu(PC pc, PetscReal nu)
2963d71ae5a4SJacob Faibussowitsch {
2964b09e027eSCarola Kruse   PetscFunctionBegin;
2965b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2966de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, nu, 2);
2967cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBNu_C", (PC, PetscReal), (pc, nu));
29683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2969b09e027eSCarola Kruse }
2970b09e027eSCarola Kruse 
2971d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc, PetscReal nu)
2972d71ae5a4SJacob Faibussowitsch {
2973b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2974b09e027eSCarola Kruse 
2975b09e027eSCarola Kruse   PetscFunctionBegin;
2976b09e027eSCarola Kruse   jac->gkbnu = nu;
29773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2978b09e027eSCarola Kruse }
2979b09e027eSCarola Kruse 
2980d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc, PCCompositeType type)
2981d71ae5a4SJacob Faibussowitsch {
298279416396SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
298379416396SBarry Smith 
298479416396SBarry Smith   PetscFunctionBegin;
298579416396SBarry Smith   jac->type = type;
29862e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
29872e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
29882e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
29892e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
29902e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
29912e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
29922e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
29932e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
29942e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
2995e071a0a4SCarola Kruse 
29963b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
29973b224e63SBarry Smith     pc->ops->apply          = PCApply_FieldSplit_Schur;
29987b665727SPierre Jolivet     pc->ops->applytranspose = PCApplyTranspose_FieldSplit_Schur;
29993b224e63SBarry Smith     pc->ops->view           = PCView_FieldSplit_Schur;
30002fa5cd67SKarl Rupp 
30019566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit_Schur));
30029566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", PCFieldSplitSetSchurPre_FieldSplit));
30039566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", PCFieldSplitGetSchurPre_FieldSplit));
30049566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", PCFieldSplitSetSchurFactType_FieldSplit));
30059566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", PCFieldSplitSetSchurScale_FieldSplit));
3006a51937d4SCarola Kruse   } else if (type == PC_COMPOSITE_GKB) {
3007a51937d4SCarola Kruse     pc->ops->apply = PCApply_FieldSplit_GKB;
3008a51937d4SCarola Kruse     pc->ops->view  = PCView_FieldSplit_GKB;
3009e69d4d44SBarry Smith 
30109566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
30119566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", PCFieldSplitSetGKBTol_FieldSplit));
30129566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", PCFieldSplitSetGKBMaxit_FieldSplit));
30139566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", PCFieldSplitSetGKBNu_FieldSplit));
30149566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", PCFieldSplitSetGKBDelay_FieldSplit));
30153b224e63SBarry Smith   } else {
30163b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
30173b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
30182fa5cd67SKarl Rupp 
30199566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
30203b224e63SBarry Smith   }
30213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
302279416396SBarry Smith }
302379416396SBarry Smith 
3024d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc, PetscInt bs)
3025d71ae5a4SJacob Faibussowitsch {
302651f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
302751f519a2SBarry Smith 
302851f519a2SBarry Smith   PetscFunctionBegin;
302963a3b9bcSJacob Faibussowitsch   PetscCheck(bs >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Blocksize must be positive, you gave %" PetscInt_FMT, bs);
30302472a847SBarry 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);
303151f519a2SBarry Smith   jac->bs = bs;
30323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
303351f519a2SBarry Smith }
303451f519a2SBarry Smith 
3035d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetCoordinates_FieldSplit(PC pc, PetscInt dim, PetscInt nloc, PetscReal coords[])
3036d71ae5a4SJacob Faibussowitsch {
30375ddf11f8SNicolas Barnafi   PC_FieldSplit    *jac           = (PC_FieldSplit *)pc->data;
30385ddf11f8SNicolas Barnafi   PC_FieldSplitLink ilink_current = jac->head;
30395ddf11f8SNicolas Barnafi   IS                is_owned;
30405ddf11f8SNicolas Barnafi 
30415ddf11f8SNicolas Barnafi   PetscFunctionBegin;
30425ddf11f8SNicolas Barnafi   jac->coordinates_set = PETSC_TRUE; // Internal flag
3043f3fa974cSJacob Faibussowitsch   PetscCall(MatGetOwnershipIS(pc->mat, &is_owned, NULL));
30445ddf11f8SNicolas Barnafi 
30455ddf11f8SNicolas Barnafi   while (ilink_current) {
30465ddf11f8SNicolas Barnafi     // For each IS, embed it to get local coords indces
30475ddf11f8SNicolas Barnafi     IS              is_coords;
30485ddf11f8SNicolas Barnafi     PetscInt        ndofs_block;
30495ddf11f8SNicolas Barnafi     const PetscInt *block_dofs_enumeration; // Numbering of the dofs relevant to the current block
30505ddf11f8SNicolas Barnafi 
30515ddf11f8SNicolas Barnafi     // Setting drop to true for safety. It should make no difference.
30529566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink_current->is, is_owned, PETSC_TRUE, &is_coords));
30539566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(is_coords, &ndofs_block));
30549566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(is_coords, &block_dofs_enumeration));
30555ddf11f8SNicolas Barnafi 
30565ddf11f8SNicolas Barnafi     // Allocate coordinates vector and set it directly
3057f4f49eeaSPierre Jolivet     PetscCall(PetscMalloc1(ndofs_block * dim, &ilink_current->coords));
30585ddf11f8SNicolas Barnafi     for (PetscInt dof = 0; dof < ndofs_block; ++dof) {
3059ad540459SPierre Jolivet       for (PetscInt d = 0; d < dim; ++d) (ilink_current->coords)[dim * dof + d] = coords[dim * block_dofs_enumeration[dof] + d];
30605ddf11f8SNicolas Barnafi     }
30615ddf11f8SNicolas Barnafi     ilink_current->dim   = dim;
30625ddf11f8SNicolas Barnafi     ilink_current->ndofs = ndofs_block;
30639566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(is_coords, &block_dofs_enumeration));
30649566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is_coords));
30655ddf11f8SNicolas Barnafi     ilink_current = ilink_current->next;
30665ddf11f8SNicolas Barnafi   }
30679566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_owned));
30683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30695ddf11f8SNicolas Barnafi }
30705ddf11f8SNicolas Barnafi 
3071bc08b0f1SBarry Smith /*@
3072f1580f4eSBarry Smith   PCFieldSplitSetType - Sets the type, `PCCompositeType`, of a `PCFIELDSPLIT`
307379416396SBarry Smith 
3074c3339decSBarry Smith   Collective
307579416396SBarry Smith 
3076d8d19677SJose E. Roman   Input Parameters:
3077a2b725a8SWilliam Gropp + pc   - the preconditioner context
3078a077d33dSBarry Smith - type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`,
3079a077d33dSBarry Smith          `PC_COMPOSITE_GKB`
308079416396SBarry Smith 
308179416396SBarry Smith   Options Database Key:
30821d27aa22SBarry Smith . -pc_fieldsplit_type <one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
308379416396SBarry Smith 
3084feefa0e1SJacob Faibussowitsch   Level: intermediate
308579416396SBarry Smith 
308660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCCompositeType`, `PCCompositeGetType()`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`,
3087a077d33dSBarry Smith           `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`, `PCFieldSplitSetSchurFactType()`
308879416396SBarry Smith @*/
3089d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetType(PC pc, PCCompositeType type)
3090d71ae5a4SJacob Faibussowitsch {
309179416396SBarry Smith   PetscFunctionBegin;
30920700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3093cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetType_C", (PC, PCCompositeType), (pc, type));
30943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
309579416396SBarry Smith }
309679416396SBarry Smith 
3097b02e2d75SMatthew G Knepley /*@
3098f1580f4eSBarry Smith   PCFieldSplitGetType - Gets the type, `PCCompositeType`, of a `PCFIELDSPLIT`
3099b02e2d75SMatthew G Knepley 
3100b02e2d75SMatthew G Knepley   Not collective
3101b02e2d75SMatthew G Knepley 
3102b02e2d75SMatthew G Knepley   Input Parameter:
3103b02e2d75SMatthew G Knepley . pc - the preconditioner context
3104b02e2d75SMatthew G Knepley 
3105b02e2d75SMatthew G Knepley   Output Parameter:
3106f1580f4eSBarry Smith . type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
3107b02e2d75SMatthew G Knepley 
3108feefa0e1SJacob Faibussowitsch   Level: intermediate
3109b02e2d75SMatthew G Knepley 
311060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCompositeSetType()`, `PCFIELDSPLIT`, `PCCompositeType`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`,
3111f1580f4eSBarry Smith           `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
3112b02e2d75SMatthew G Knepley @*/
3113d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
3114d71ae5a4SJacob Faibussowitsch {
3115b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
3116b02e2d75SMatthew G Knepley 
3117b02e2d75SMatthew G Knepley   PetscFunctionBegin;
3118b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
31194f572ea9SToby Isaac   PetscAssertPointer(type, 2);
3120b02e2d75SMatthew G Knepley   *type = jac->type;
31213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3122b02e2d75SMatthew G Knepley }
3123b02e2d75SMatthew G Knepley 
31244ab8060aSDmitry Karpeev /*@
3125f1580f4eSBarry Smith   PCFieldSplitSetDMSplits - Flags whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible.
31264ab8060aSDmitry Karpeev 
3127c3339decSBarry Smith   Logically Collective
31284ab8060aSDmitry Karpeev 
31294ab8060aSDmitry Karpeev   Input Parameters:
31304ab8060aSDmitry Karpeev + pc  - the preconditioner context
3131f1580f4eSBarry Smith - flg - boolean indicating whether to use field splits defined by the `DM`
31324ab8060aSDmitry Karpeev 
31334ab8060aSDmitry Karpeev   Options Database Key:
3134f1580f4eSBarry Smith . -pc_fieldsplit_dm_splits <bool> - use the field splits defined by the `DM`
31354ab8060aSDmitry Karpeev 
3136feefa0e1SJacob Faibussowitsch   Level: intermediate
31374ab8060aSDmitry Karpeev 
313873ff1848SBarry Smith   Developer Note:
313973ff1848SBarry Smith   The name should be `PCFieldSplitSetUseDMSplits()`, similar change to options database
314073ff1848SBarry Smith 
314173ff1848SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDMSplits()`, `DMCreateFieldDecomposition()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()`
31424ab8060aSDmitry Karpeev @*/
3143d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDMSplits(PC pc, PetscBool flg)
3144d71ae5a4SJacob Faibussowitsch {
31454ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
31464ab8060aSDmitry Karpeev   PetscBool      isfs;
31474ab8060aSDmitry Karpeev 
31484ab8060aSDmitry Karpeev   PetscFunctionBegin;
31494ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
31504ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc, flg, 2);
31519566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
3152ad540459SPierre Jolivet   if (isfs) jac->dm_splits = flg;
31533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
31544ab8060aSDmitry Karpeev }
31554ab8060aSDmitry Karpeev 
31564ab8060aSDmitry Karpeev /*@
3157f1580f4eSBarry Smith   PCFieldSplitGetDMSplits - Returns flag indicating whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible.
31584ab8060aSDmitry Karpeev 
31594ab8060aSDmitry Karpeev   Logically Collective
31604ab8060aSDmitry Karpeev 
31614ab8060aSDmitry Karpeev   Input Parameter:
31624ab8060aSDmitry Karpeev . pc - the preconditioner context
31634ab8060aSDmitry Karpeev 
31644ab8060aSDmitry Karpeev   Output Parameter:
3165f1580f4eSBarry Smith . flg - boolean indicating whether to use field splits defined by the `DM`
31664ab8060aSDmitry Karpeev 
3167feefa0e1SJacob Faibussowitsch   Level: intermediate
31684ab8060aSDmitry Karpeev 
316973ff1848SBarry Smith   Developer Note:
317073ff1848SBarry Smith   The name should be `PCFieldSplitGetUseDMSplits()`
317173ff1848SBarry Smith 
317273ff1848SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDMSplits()`, `DMCreateFieldDecomposition()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()`
31734ab8060aSDmitry Karpeev @*/
3174d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDMSplits(PC pc, PetscBool *flg)
3175d71ae5a4SJacob Faibussowitsch {
31764ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
31774ab8060aSDmitry Karpeev   PetscBool      isfs;
31784ab8060aSDmitry Karpeev 
31794ab8060aSDmitry Karpeev   PetscFunctionBegin;
31804ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
31814f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
31829566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
31834ab8060aSDmitry Karpeev   if (isfs) {
31844ab8060aSDmitry Karpeev     if (flg) *flg = jac->dm_splits;
31854ab8060aSDmitry Karpeev   }
31863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
31874ab8060aSDmitry Karpeev }
31884ab8060aSDmitry Karpeev 
31897b752e3dSPatrick Sanan /*@
3190f1580f4eSBarry Smith   PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries.
31917b752e3dSPatrick Sanan 
31927b752e3dSPatrick Sanan   Logically Collective
31937b752e3dSPatrick Sanan 
31947b752e3dSPatrick Sanan   Input Parameter:
31957b752e3dSPatrick Sanan . pc - the preconditioner context
31967b752e3dSPatrick Sanan 
31977b752e3dSPatrick Sanan   Output Parameter:
31987b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not
31997b752e3dSPatrick Sanan 
3200feefa0e1SJacob Faibussowitsch   Level: intermediate
32017b752e3dSPatrick Sanan 
320260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDetectSaddlePoint()`
32037b752e3dSPatrick Sanan @*/
3204d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc, PetscBool *flg)
3205d71ae5a4SJacob Faibussowitsch {
32067b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
32077b752e3dSPatrick Sanan 
32087b752e3dSPatrick Sanan   PetscFunctionBegin;
32097b752e3dSPatrick Sanan   *flg = jac->detect;
32103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32117b752e3dSPatrick Sanan }
32127b752e3dSPatrick Sanan 
32137b752e3dSPatrick Sanan /*@
3214f1580f4eSBarry Smith   PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries.
32157b752e3dSPatrick Sanan 
32167b752e3dSPatrick Sanan   Logically Collective
32177b752e3dSPatrick Sanan 
32187b752e3dSPatrick Sanan   Input Parameter:
32197b752e3dSPatrick Sanan . pc - the preconditioner context
32207b752e3dSPatrick Sanan 
32217b752e3dSPatrick Sanan   Output Parameter:
32227b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not
32237b752e3dSPatrick Sanan 
32247b752e3dSPatrick Sanan   Options Database Key:
3225147403d9SBarry Smith . -pc_fieldsplit_detect_saddle_point <bool> - detect and use the saddle point
3226147403d9SBarry Smith 
3227feefa0e1SJacob Faibussowitsch   Level: intermediate
322860f59c3bSBarry Smith 
3229f1580f4eSBarry Smith   Note:
3230f1580f4eSBarry 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()`).
32317b752e3dSPatrick Sanan 
323260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDetectSaddlePoint()`, `PCFieldSplitSetType()`, `PCFieldSplitSetSchurPre()`, `PC_FIELDSPLIT_SCHUR_PRE_SELF`
32337b752e3dSPatrick Sanan @*/
3234d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc, PetscBool flg)
3235d71ae5a4SJacob Faibussowitsch {
32367b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
32377b752e3dSPatrick Sanan 
32387b752e3dSPatrick Sanan   PetscFunctionBegin;
32397b752e3dSPatrick Sanan   jac->detect = flg;
32407b752e3dSPatrick Sanan   if (jac->detect) {
32419566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetType(pc, PC_COMPOSITE_SCHUR));
32429566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetSchurPre(pc, PC_FIELDSPLIT_SCHUR_PRE_SELF, NULL));
32437b752e3dSPatrick Sanan   }
32443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32457b752e3dSPatrick Sanan }
32467b752e3dSPatrick Sanan 
32470971522cSBarry Smith /*MC
3248a8c7a070SBarry Smith   PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
3249f1580f4eSBarry Smith   collections of variables (that may overlap) called splits. See [the users manual section on "Solving Block Matrices"](sec_block_matrices) for more details.
32500971522cSBarry Smith 
325179416396SBarry Smith   Options Database Keys:
3252de37d9f1SPatrick Sanan +   -pc_fieldsplit_%d_fields <a,b,..>                                                - indicates the fields to be used in the `%d`'th split
325381540f2fSBarry Smith .   -pc_fieldsplit_default                                                           - automatically add any fields to additional splits that have not
3254de37d9f1SPatrick Sanan                                                                                        been supplied explicitly by `-pc_fieldsplit_%d_fields`
325581540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs>                                                   - size of block that defines fields (i.e. there are bs fields)
325680670ca5SBarry Smith                                                                                        when the matrix is not of `MatType` `MATNEST`
3257a51937d4SCarola Kruse .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting
3258d59693daSPierre Jolivet .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full>                     - default is `a11`; see `PCFieldSplitSetSchurPre()`
32591d27aa22SBarry Smith .   -pc_fieldsplit_schur_fact_type <diag,lower,upper,full>                           - set factorization type when using `-pc_fieldsplit_type schur`;
32601d27aa22SBarry Smith                                                                                        see `PCFieldSplitSetSchurFactType()`
326173ff1848SBarry Smith .   -pc_fieldsplit_dm_splits <true,false> (default is true)                          - Whether to use `DMCreateFieldDecomposition()` for splits
3262fb6809a2SPatrick Sanan -   -pc_fieldsplit_detect_saddle_point                                               - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
326379416396SBarry Smith 
3264de37d9f1SPatrick Sanan   Options prefixes for inner solvers when using the Schur complement preconditioner are `-fieldsplit_0_` and `-fieldsplit_1_` .
3265de37d9f1SPatrick Sanan   The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is `-fieldsplit_0_`
326660f59c3bSBarry Smith   For all other solvers they are `-fieldsplit_%d_` for the `%d`'th field; use `-fieldsplit_` for all fields.
326760f59c3bSBarry Smith 
326860f59c3bSBarry Smith   To set options on the solvers for each block append `-fieldsplit_` to all the `PC`
326960f59c3bSBarry Smith   options database keys. For example, `-fieldsplit_pc_type ilu` `-fieldsplit_pc_factor_levels 1`
327060f59c3bSBarry Smith 
327160f59c3bSBarry Smith   To set the options on the solvers separate for each block call `PCFieldSplitGetSubKSP()`
327260f59c3bSBarry Smith   and set the options directly on the resulting `KSP` object
327360f59c3bSBarry Smith 
327460f59c3bSBarry Smith   Level: intermediate
32755d4c12cdSJungho Lee 
3276c8a0d604SMatthew G Knepley   Notes:
327780670ca5SBarry Smith   Use `PCFieldSplitSetFields()` to set splits defined by "strided" entries or with a `MATNEST` and `PCFieldSplitSetIS()`
3278f1580f4eSBarry Smith   to define a split by an arbitrary collection of entries.
3279d32f9abdSBarry Smith 
328073ff1848SBarry Smith   If no splits are set, the default is used. If a `DM` is associated with the `PC` and it supports
328180670ca5SBarry Smith   `DMCreateFieldDecomposition()`, then that is used for the default. Otherwise if the matrix is not `MATNEST`, the splits are defined by entries strided by bs,
3282de37d9f1SPatrick Sanan   beginning at 0 then 1, etc to bs-1. The block size can be set with `PCFieldSplitSetBlockSize()`,
3283d32f9abdSBarry Smith   if this is not called the block size defaults to the blocksize of the second matrix passed
3284de37d9f1SPatrick Sanan   to `KSPSetOperators()`/`PCSetOperators()`.
3285d32f9abdSBarry Smith 
3286de37d9f1SPatrick Sanan   For the Schur complement preconditioner if
3287de37d9f1SPatrick Sanan   ```{math}
3288de37d9f1SPatrick Sanan     J = \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{10} & A_{11} \end{array}\right]
3289de37d9f1SPatrick Sanan   ```
3290e69d4d44SBarry Smith 
3291de37d9f1SPatrick Sanan   the preconditioner using `full` factorization is logically
3292de37d9f1SPatrick Sanan   ```{math}
3293ecaa082aSMatthew 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]
3294de37d9f1SPatrick Sanan       ```
3295de37d9f1SPatrick Sanan   where the action of $\text{inv}(A_{00})$ is applied using the KSP solver with prefix `-fieldsplit_0_`.  $S$ is the Schur complement
3296de37d9f1SPatrick Sanan   ```{math}
3297223e5b4fSPatrick Sanan      S = A_{11} - A_{10} \text{ksp}(A_{00}) A_{01}
3298de37d9f1SPatrick Sanan   ```
3299de37d9f1SPatrick 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
330060f59c3bSBarry Smith   in providing the SECOND split or 1 if not given). For `PCFieldSplitGetSubKSP()` when field number is 0,
330180670ca5SBarry Smith   it returns the `KSP` associated with `-fieldsplit_0_` while field number 1 gives `-fieldsplit_1_` KSP. By default
3302de37d9f1SPatrick Sanan   $A_{11}$ is used to construct a preconditioner for $S$, use `PCFieldSplitSetSchurPre()` for all the possible ways to construct the preconditioner for $S$.
3303de37d9f1SPatrick Sanan 
3304de37d9f1SPatrick Sanan   The factorization type is set using `-pc_fieldsplit_schur_fact_type <diag, lower, upper, full>`. `full` is shown above,
3305de37d9f1SPatrick Sanan   `diag` gives
3306de37d9f1SPatrick Sanan   ```{math}
3307de37d9f1SPatrick Sanan     \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\  0 & -\text{ksp}(S) \end{array}\right]
3308de37d9f1SPatrick Sanan   ```
3309de37d9f1SPatrick 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
3310de37d9f1SPatrick Sanan   can be turned off with `PCFieldSplitSetSchurScale()` or by command line `-pc_fieldsplit_schur_scale 1.0`. The `lower` factorization is the inverse of
3311de37d9f1SPatrick Sanan   ```{math}
3312de37d9f1SPatrick Sanan     \left[\begin{array}{cc} A_{00} & 0 \\  A_{10} & S \end{array}\right]
3313de37d9f1SPatrick Sanan   ```
3314de37d9f1SPatrick Sanan   where the inverses of A_{00} and S are applied using KSPs. The upper factorization is the inverse of
3315de37d9f1SPatrick Sanan   ```{math}
3316de37d9f1SPatrick Sanan     \left[\begin{array}{cc} A_{00} & A_{01} \\  0 & S \end{array}\right]
3317de37d9f1SPatrick Sanan   ```
3318de37d9f1SPatrick Sanan   where again the inverses of $A_{00}$ and $S$ are applied using `KSP`s.
3319de37d9f1SPatrick Sanan 
3320de37d9f1SPatrick Sanan   If only one set of indices (one `IS`) is provided with `PCFieldSplitSetIS()` then the complement of that `IS`
332180670ca5SBarry Smith   is used automatically for a second submatrix.
3322edf189efSBarry Smith 
3323f1580f4eSBarry Smith   The fieldsplit preconditioner cannot currently be used with the `MATBAIJ` or `MATSBAIJ` data formats if the blocksize is larger than 1.
332480670ca5SBarry Smith   Generally it should be used with the `MATAIJ` or `MATNEST` `MatType`
3325ff218e97SBarry Smith 
332680670ca5SBarry Smith   The forms of these preconditioners are closely related, if not identical, to forms derived as "Distributive Iterations", see,
33271d569b8fSBarry Smith   for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling {cite}`wesseling2009`.
332880670ca5SBarry Smith   One can also use `PCFIELDSPLIT` inside a smoother resulting in "Distributive Smoothers".
33290716a85fSBarry Smith 
3330de37d9f1SPatrick Sanan   See "A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations" {cite}`elman2008tcp`.
3331a6a584a2SBarry Smith 
3332de37d9f1SPatrick Sanan   The Constrained Pressure Preconditioner (CPR) can be implemented using `PCCOMPOSITE` with `PCGALERKIN`. CPR first solves an $R A P$ subsystem, updates the
3333de37d9f1SPatrick Sanan   residual on all variables (`PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)`), and then applies a simple ILU like preconditioner on all the variables.
3334a51937d4SCarola Kruse 
3335de37d9f1SPatrick Sanan   The generalized Golub-Kahan bidiagonalization preconditioner (GKB) can be applied to symmetric $2 \times 2$ block matrices of the shape
3336de37d9f1SPatrick Sanan   ```{math}
3337de37d9f1SPatrick Sanan     \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{01}' & 0 \end{array}\right]
3338de37d9f1SPatrick Sanan   ```
33391d569b8fSBarry 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}'$.
3340de37d9f1SPatrick 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_`.
3341a51937d4SCarola Kruse 
334260f59c3bSBarry Smith   Developer Note:
334360f59c3bSBarry Smith   The Schur complement functionality of `PCFIELDSPLIT` should likely be factored into its own `PC` thus simplifying the implementation of the preconditioners and their
334460f59c3bSBarry Smith   user API.
3345f1580f4eSBarry Smith 
334660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCLSC`,
3347db781477SPatrick Sanan           `PCFieldSplitGetSubKSP()`, `PCFieldSplitSchurGetSubKSP()`, `PCFieldSplitSetFields()`,
3348db781477SPatrick Sanan           `PCFieldSplitSetType()`, `PCFieldSplitSetIS()`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitSetSchurFactType()`,
3349db781477SPatrick Sanan           `MatSchurComplementSetAinvType()`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetDetectSaddlePoint()`
33500971522cSBarry Smith M*/
33510971522cSBarry Smith 
3352d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
3353d71ae5a4SJacob Faibussowitsch {
33540971522cSBarry Smith   PC_FieldSplit *jac;
33550971522cSBarry Smith 
33560971522cSBarry Smith   PetscFunctionBegin;
33574dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&jac));
33582fa5cd67SKarl Rupp 
33590971522cSBarry Smith   jac->bs                 = -1;
33600971522cSBarry Smith   jac->nsplits            = 0;
33613e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
3362e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
3363c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
3364c096484dSStefano Zampini   jac->schurscale         = -1.0;
3365fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
33667b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
3367a51937d4SCarola Kruse   jac->gkbtol             = 1e-5;
3368a51937d4SCarola Kruse   jac->gkbdelay           = 5;
3369a51937d4SCarola Kruse   jac->gkbnu              = 1;
3370a51937d4SCarola Kruse   jac->gkbmaxit           = 100;
3371de482cd7SCarola Kruse   jac->gkbmonitor         = PETSC_FALSE;
33725ddf11f8SNicolas Barnafi   jac->coordinates_set    = PETSC_FALSE;
337351f519a2SBarry Smith 
33740971522cSBarry Smith   pc->data = (void *)jac;
33750971522cSBarry Smith 
33760971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
3377421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
33780971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
3379574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
33800971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
33810971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
33820971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
33830a545947SLisandro Dalcin   pc->ops->applyrichardson = NULL;
33840971522cSBarry Smith 
33859566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", PCFieldSplitSchurGetSubKSP_FieldSplit));
33869566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
33879566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", PCFieldSplitSetFields_FieldSplit));
33889566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", PCFieldSplitSetIS_FieldSplit));
33899566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", PCFieldSplitSetType_FieldSplit));
33909566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", PCFieldSplitSetBlockSize_FieldSplit));
33919566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", PCFieldSplitRestrictIS_FieldSplit));
33929566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", PCSetCoordinates_FieldSplit));
33933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
33940971522cSBarry Smith }
3395