xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 6497c311e7b976d467be1503c1effce92a60525c)
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>
4f7cbcdf3SPierre Jolivet #include <petscdevice.h>
5f7cbcdf3SPierre Jolivet #if PetscDefined(HAVE_CUDA)
6f7cbcdf3SPierre Jolivet   #include <petscdevice_cuda.h>
7f7cbcdf3SPierre Jolivet #endif
8f7cbcdf3SPierre Jolivet #if PetscDefined(HAVE_HIP)
9f7cbcdf3SPierre Jolivet   #include <petscdevice_hip.h>
10f7cbcdf3SPierre Jolivet #endif
110971522cSBarry Smith 
120a545947SLisandro Dalcin const char *const PCFieldSplitSchurPreTypes[]  = {"SELF", "SELFP", "A11", "USER", "FULL", "PCFieldSplitSchurPreType", "PC_FIELDSPLIT_SCHUR_PRE_", NULL};
130a545947SLisandro Dalcin const char *const PCFieldSplitSchurFactTypes[] = {"DIAG", "LOWER", "UPPER", "FULL", "PCFieldSplitSchurFactType", "PC_FIELDSPLIT_SCHUR_FACT_", NULL};
14c5d2311dSJed Brown 
159df09d43SBarry 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;
169df09d43SBarry Smith 
170971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
180971522cSBarry Smith struct _PC_FieldSplitLink {
1969a612a9SBarry Smith   KSP               ksp;
20443836d0SMatthew G Knepley   Vec               x, y, z;
21db4c96c1SJed Brown   char             *splitname;
220971522cSBarry Smith   PetscInt          nfields;
235d4c12cdSJungho Lee   PetscInt         *fields, *fields_col;
241b9fc7fcSBarry Smith   VecScatter        sctx;
25f5f0d762SBarry Smith   IS                is, is_col;
2651f519a2SBarry Smith   PC_FieldSplitLink next, previous;
279df09d43SBarry Smith   PetscLogEvent     event;
285ddf11f8SNicolas Barnafi 
295ddf11f8SNicolas Barnafi   /* Used only when setting coordinates with PCSetCoordinates */
305ddf11f8SNicolas Barnafi   PetscInt   dim;
315ddf11f8SNicolas Barnafi   PetscInt   ndofs;
325ddf11f8SNicolas Barnafi   PetscReal *coords;
330971522cSBarry Smith };
340971522cSBarry Smith 
350971522cSBarry Smith typedef struct {
3668dd23aaSBarry Smith   PCCompositeType type;
37ace3abfcSBarry Smith   PetscBool       defaultsplit; /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
38ace3abfcSBarry Smith   PetscBool       splitdefined; /* Flag is set after the splits have been defined, to prevent more splits from being added */
3930ad9308SMatthew Knepley   PetscInt        bs;           /* Block size for IS and Mat structures */
4030ad9308SMatthew Knepley   PetscInt        nsplits;      /* Number of field divisions defined */
4179416396SBarry Smith   Vec            *x, *y, w1, w2;
42519d70e2SJed Brown   Mat            *mat;    /* The diagonal block for each split */
43519d70e2SJed Brown   Mat            *pmat;   /* The preconditioning diagonal block for each split */
4430ad9308SMatthew Knepley   Mat            *Afield; /* The rows of the matrix associated with each split */
45ace3abfcSBarry Smith   PetscBool       issetup;
462fa5cd67SKarl Rupp 
4730ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
4830ad9308SMatthew Knepley   Mat                       B;          /* The (0,1) block */
4930ad9308SMatthew Knepley   Mat                       C;          /* The (1,0) block */
50443836d0SMatthew G Knepley   Mat                       schur;      /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
51a7476a74SDmitry Karpeev   Mat                       schurp;     /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
52084e4875SJed Brown   Mat                       schur_user; /* User-provided preconditioning matrix for the Schur complement */
53084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;   /* Determines which preconditioning matrix is used for the Schur complement */
54c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
5530ad9308SMatthew Knepley   KSP                       kspschur;   /* The solver for S */
56443836d0SMatthew G Knepley   KSP                       kspupper;   /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
57c096484dSStefano Zampini   PetscScalar               schurscale; /* Scaling factor for the Schur complement solution with DIAG factorization */
58c096484dSStefano Zampini 
59a51937d4SCarola Kruse   /* Only used when Golub-Kahan bidiagonalization preconditioning is used */
60a51937d4SCarola Kruse   Mat          H;           /* The modified matrix H = A00 + nu*A01*A01'              */
61a51937d4SCarola Kruse   PetscReal    gkbtol;      /* Stopping tolerance for lower bound estimate            */
62a51937d4SCarola Kruse   PetscInt     gkbdelay;    /* The delay window for the stopping criterion            */
63a51937d4SCarola Kruse   PetscReal    gkbnu;       /* Parameter for augmented Lagrangian H = A + nu*A01*A01' */
64a51937d4SCarola Kruse   PetscInt     gkbmaxit;    /* Maximum number of iterations for outer loop            */
65de482cd7SCarola Kruse   PetscBool    gkbmonitor;  /* Monitor for gkb iterations and the lower bound error   */
66de482cd7SCarola Kruse   PetscViewer  gkbviewer;   /* Viewer context for gkbmonitor                          */
67e071a0a4SCarola Kruse   Vec          u, v, d, Hu; /* Work vectors for the GKB algorithm                     */
68e071a0a4SCarola Kruse   PetscScalar *vecz;        /* Contains intermediate values, eg for lower bound       */
69a51937d4SCarola Kruse 
7097bbdb24SBarry Smith   PC_FieldSplitLink head;
716dbb499eSCian Wilson   PetscBool         isrestrict;       /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */
72c1570756SJed Brown   PetscBool         suboptionsset;    /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
734ab8060aSDmitry Karpeev   PetscBool         dm_splits;        /* Whether to use DMCreateFieldDecomposition() whenever possible */
74c84da90fSDmitry Karpeev   PetscBool         diag_use_amat;    /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
75c84da90fSDmitry Karpeev   PetscBool         offdiag_use_amat; /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
767b752e3dSPatrick Sanan   PetscBool         detect;           /* Whether to form 2-way split by finding zero diagonal entries */
775ddf11f8SNicolas Barnafi   PetscBool         coordinates_set;  /* Whether PCSetCoordinates has been called */
780971522cSBarry Smith } PC_FieldSplit;
790971522cSBarry Smith 
8016913363SBarry Smith /*
81f1580f4eSBarry Smith     Note:
8295452b02SPatrick Sanan     there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
8316913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
8416913363SBarry Smith    PC you could change this.
8516913363SBarry Smith */
86084e4875SJed Brown 
87e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
88084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
89d71ae5a4SJacob Faibussowitsch static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
90d71ae5a4SJacob Faibussowitsch {
91084e4875SJed Brown   switch (jac->schurpre) {
92d71ae5a4SJacob Faibussowitsch   case PC_FIELDSPLIT_SCHUR_PRE_SELF:
93d71ae5a4SJacob Faibussowitsch     return jac->schur;
94d71ae5a4SJacob Faibussowitsch   case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
95d71ae5a4SJacob Faibussowitsch     return jac->schurp;
96d71ae5a4SJacob Faibussowitsch   case PC_FIELDSPLIT_SCHUR_PRE_A11:
97d71ae5a4SJacob Faibussowitsch     return jac->pmat[1];
98e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
99084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
100d71ae5a4SJacob Faibussowitsch   default:
101d71ae5a4SJacob Faibussowitsch     return jac->schur_user ? jac->schur_user : jac->pmat[1];
102084e4875SJed Brown   }
103084e4875SJed Brown }
104084e4875SJed Brown 
1059804daf3SBarry Smith #include <petscdraw.h>
106d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit(PC pc, PetscViewer viewer)
107d71ae5a4SJacob Faibussowitsch {
1080971522cSBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
109d9884438SBarry Smith   PetscBool         iascii, isdraw;
1100971522cSBarry Smith   PetscInt          i, j;
1115a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
1120971522cSBarry Smith 
1130971522cSBarry Smith   PetscFunctionBegin;
1149566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
1159566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
1160971522cSBarry Smith   if (iascii) {
1172c9966d7SBarry Smith     if (jac->bs > 0) {
11863a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs));
1192c9966d7SBarry Smith     } else {
12063a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits));
1212c9966d7SBarry Smith     }
12248a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
12348a46eb9SPierre Jolivet     if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for diagonal blocks\n"));
12448a46eb9SPierre Jolivet     if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for off-diagonal blocks\n"));
1259566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Solver info for each split is in the following KSP objects:\n"));
1260971522cSBarry Smith     for (i = 0; i < jac->nsplits; i++) {
1271ab39975SBarry Smith       if (ilink->fields) {
12863a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i));
1299566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
1305a9f2f41SSatish Balay         for (j = 0; j < ilink->nfields; j++) {
13148a46eb9SPierre Jolivet           if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
13263a3b9bcSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
1330971522cSBarry Smith         }
1349566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
1359566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
1361ab39975SBarry Smith       } else {
13763a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i));
1381ab39975SBarry Smith       }
1399566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
1405a9f2f41SSatish Balay       ilink = ilink->next;
1410971522cSBarry Smith     }
1422fa5cd67SKarl Rupp   }
1432fa5cd67SKarl Rupp 
1442fa5cd67SKarl Rupp   if (isdraw) {
145d9884438SBarry Smith     PetscDraw draw;
146d9884438SBarry Smith     PetscReal x, y, w, wd;
147d9884438SBarry Smith 
1489566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
1499566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
150d9884438SBarry Smith     w  = 2 * PetscMin(1.0 - x, x);
151d9884438SBarry Smith     wd = w / (jac->nsplits + 1);
152d9884438SBarry Smith     x  = x - wd * (jac->nsplits - 1) / 2.0;
153d9884438SBarry Smith     for (i = 0; i < jac->nsplits; i++) {
1549566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
1559566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
1569566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
157d9884438SBarry Smith       x += wd;
158d9884438SBarry Smith       ilink = ilink->next;
159d9884438SBarry Smith     }
1600971522cSBarry Smith   }
1613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1620971522cSBarry Smith }
1630971522cSBarry Smith 
164d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_Schur(PC pc, PetscViewer viewer)
165d71ae5a4SJacob Faibussowitsch {
1663b224e63SBarry Smith   PC_FieldSplit             *jac = (PC_FieldSplit *)pc->data;
1674996c5bdSBarry Smith   PetscBool                  iascii, isdraw;
1683b224e63SBarry Smith   PetscInt                   i, j;
1693b224e63SBarry Smith   PC_FieldSplitLink          ilink = jac->head;
170a9908d51SBarry Smith   MatSchurComplementAinvType atype;
1713b224e63SBarry Smith 
1723b224e63SBarry Smith   PetscFunctionBegin;
1739566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
1749566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
1753b224e63SBarry Smith   if (iascii) {
1762c9966d7SBarry Smith     if (jac->bs > 0) {
17763a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with Schur preconditioner, blocksize = %" PetscInt_FMT ", factorization %s\n", jac->bs, PCFieldSplitSchurFactTypes[jac->schurfactorization]));
1782c9966d7SBarry Smith     } else {
1799566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with Schur preconditioner, factorization %s\n", PCFieldSplitSchurFactTypes[jac->schurfactorization]));
1802c9966d7SBarry Smith     }
18148a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
1823e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
183d71ae5a4SJacob Faibussowitsch     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
184d71ae5a4SJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from S itself\n"));
185d71ae5a4SJacob Faibussowitsch       break;
186a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
1877cf5f706SPierre Jolivet       if (jac->schur) {
1889566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetAinvType(jac->schur, &atype));
1899371c9d4SSatish 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 "))));
1907cf5f706SPierre Jolivet       }
191a9908d51SBarry Smith       break;
192d71ae5a4SJacob Faibussowitsch     case PC_FIELDSPLIT_SCHUR_PRE_A11:
193d71ae5a4SJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from A11\n"));
194d71ae5a4SJacob Faibussowitsch       break;
195d71ae5a4SJacob Faibussowitsch     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
196d71ae5a4SJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from the exact Schur complement\n"));
197d71ae5a4SJacob Faibussowitsch       break;
1983e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1993e8b8b31SMatthew G Knepley       if (jac->schur_user) {
2009566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from user provided matrix\n"));
2013e8b8b31SMatthew G Knepley       } else {
2029566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  Preconditioner for the Schur complement formed from A11\n"));
2033e8b8b31SMatthew G Knepley       }
2043e8b8b31SMatthew G Knepley       break;
205d71ae5a4SJacob Faibussowitsch     default:
206d71ae5a4SJacob Faibussowitsch       SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
2073e8b8b31SMatthew G Knepley     }
2089566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Split info:\n"));
2099566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
2103b224e63SBarry Smith     for (i = 0; i < jac->nsplits; i++) {
2113b224e63SBarry Smith       if (ilink->fields) {
21263a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Fields ", i));
2139566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
2143b224e63SBarry Smith         for (j = 0; j < ilink->nfields; j++) {
21548a46eb9SPierre Jolivet           if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
21663a3b9bcSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
2173b224e63SBarry Smith         }
2189566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
2199566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
2203b224e63SBarry Smith       } else {
22163a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "Split number %" PetscInt_FMT " Defined by IS\n", i));
2223b224e63SBarry Smith       }
2233b224e63SBarry Smith       ilink = ilink->next;
2243b224e63SBarry Smith     }
2259566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for A00 block\n"));
2269566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
22706de4afeSJed Brown     if (jac->head) {
2289566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->head->ksp, viewer));
2299566063dSJacob Faibussowitsch     } else PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
2309566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
23106de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
2329566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for upper A00 in upper triangular factor\n"));
2339566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPushTab(viewer));
2349566063dSJacob Faibussowitsch       if (jac->kspupper) PetscCall(KSPView(jac->kspupper, viewer));
2359566063dSJacob Faibussowitsch       else PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
2369566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPopTab(viewer));
237443836d0SMatthew G Knepley     }
2389566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for S = A11 - A10 inv(A00) A01\n"));
2399566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
24012cae6f2SJed Brown     if (jac->kspschur) {
2419566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->kspschur, viewer));
24212cae6f2SJed Brown     } else {
2439566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
24412cae6f2SJed Brown     }
2459566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
2469566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
24706de4afeSJed Brown   } else if (isdraw && jac->head) {
2484996c5bdSBarry Smith     PetscDraw draw;
2494996c5bdSBarry Smith     PetscReal x, y, w, wd, h;
2504996c5bdSBarry Smith     PetscInt  cnt = 2;
2514996c5bdSBarry Smith     char      str[32];
2524996c5bdSBarry Smith 
2539566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
2549566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
255c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
256c74581afSBarry Smith     w  = 2 * PetscMin(1.0 - x, x);
257c74581afSBarry Smith     wd = w / (cnt + 1);
258c74581afSBarry Smith 
2599566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(str, 32, "Schur fact. %s", PCFieldSplitSchurFactTypes[jac->schurfactorization]));
2609566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h));
2614996c5bdSBarry Smith     y -= h;
2624996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) {
2639566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]));
2643b224e63SBarry Smith     } else {
2659566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[jac->schurpre]));
2664996c5bdSBarry Smith     }
2679566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x + wd * (cnt - 1) / 2.0, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h));
2684996c5bdSBarry Smith     y -= h;
2694996c5bdSBarry Smith     x = x - wd * (cnt - 1) / 2.0;
2704996c5bdSBarry Smith 
2719566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2729566063dSJacob Faibussowitsch     PetscCall(KSPView(jac->head->ksp, viewer));
2739566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
2744996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2754996c5bdSBarry Smith       x += wd;
2769566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2779566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->kspupper, viewer));
2789566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
2794996c5bdSBarry Smith     }
2804996c5bdSBarry Smith     x += wd;
2819566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2829566063dSJacob Faibussowitsch     PetscCall(KSPView(jac->kspschur, viewer));
2839566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
2843b224e63SBarry Smith   }
2853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2863b224e63SBarry Smith }
2873b224e63SBarry Smith 
288d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_GKB(PC pc, PetscViewer viewer)
289d71ae5a4SJacob Faibussowitsch {
290a51937d4SCarola Kruse   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
291a51937d4SCarola Kruse   PetscBool         iascii, isdraw;
292a51937d4SCarola Kruse   PetscInt          i, j;
293a51937d4SCarola Kruse   PC_FieldSplitLink ilink = jac->head;
294a51937d4SCarola Kruse 
295a51937d4SCarola Kruse   PetscFunctionBegin;
2969566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
2979566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
298a51937d4SCarola Kruse   if (iascii) {
299a51937d4SCarola Kruse     if (jac->bs > 0) {
30063a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs));
301a51937d4SCarola Kruse     } else {
30263a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits));
303a51937d4SCarola Kruse     }
30448a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
30548a46eb9SPierre Jolivet     if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for diagonal blocks\n"));
30648a46eb9SPierre Jolivet     if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for off-diagonal blocks\n"));
307a51937d4SCarola Kruse 
30863a3b9bcSJacob 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));
3099566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Solver info for H = A00 + nu*A01*A01' matrix:\n"));
3109566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
311a51937d4SCarola Kruse 
312a51937d4SCarola Kruse     if (ilink->fields) {
31363a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Fields "));
3149566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
315a51937d4SCarola Kruse       for (j = 0; j < ilink->nfields; j++) {
31648a46eb9SPierre Jolivet         if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
31763a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
318a51937d4SCarola Kruse       }
3199566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
3209566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
321a51937d4SCarola Kruse     } else {
32263a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Defined by IS\n"));
323a51937d4SCarola Kruse     }
3249566063dSJacob Faibussowitsch     PetscCall(KSPView(ilink->ksp, viewer));
325a51937d4SCarola Kruse 
3269566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
327a51937d4SCarola Kruse   }
328a51937d4SCarola Kruse 
329a51937d4SCarola Kruse   if (isdraw) {
330a51937d4SCarola Kruse     PetscDraw draw;
331a51937d4SCarola Kruse     PetscReal x, y, w, wd;
332a51937d4SCarola Kruse 
3339566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
3349566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
335a51937d4SCarola Kruse     w  = 2 * PetscMin(1.0 - x, x);
336a51937d4SCarola Kruse     wd = w / (jac->nsplits + 1);
337a51937d4SCarola Kruse     x  = x - wd * (jac->nsplits - 1) / 2.0;
338a51937d4SCarola Kruse     for (i = 0; i < jac->nsplits; i++) {
3399566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
3409566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
3419566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
342a51937d4SCarola Kruse       x += wd;
343a51937d4SCarola Kruse       ilink = ilink->next;
344a51937d4SCarola Kruse     }
345a51937d4SCarola Kruse   }
3463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
347a51937d4SCarola Kruse }
348a51937d4SCarola Kruse 
34980670ca5SBarry Smith /* Precondition: jac->bs is set to a meaningful value or MATNEST */
350d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
351d71ae5a4SJacob Faibussowitsch {
3526c924f48SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
35380670ca5SBarry Smith   PetscInt       bs, i, nfields, *ifields, nfields_col, *ifields_col;
35480670ca5SBarry Smith   PetscBool      flg, flg_col, mnest;
3555d4c12cdSJungho Lee   char           optionname[128], splitname[8], optionname_col[128];
3566c924f48SJed Brown 
3576c924f48SJed Brown   PetscFunctionBegin;
35880670ca5SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &mnest));
35980670ca5SBarry Smith   if (mnest) {
36080670ca5SBarry Smith     PetscCall(MatNestGetSize(pc->pmat, &bs, NULL));
36180670ca5SBarry Smith   } else {
36280670ca5SBarry Smith     bs = jac->bs;
36380670ca5SBarry Smith   }
36480670ca5SBarry Smith   PetscCall(PetscMalloc2(bs, &ifields, bs, &ifields_col));
3656c924f48SJed Brown   for (i = 0, flg = PETSC_TRUE;; i++) {
36663a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
36763a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
36863a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname_col, sizeof(optionname_col), "-pc_fieldsplit_%" PetscInt_FMT "_fields_col", i));
36980670ca5SBarry Smith     nfields     = bs;
37080670ca5SBarry Smith     nfields_col = bs;
3719566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
3729566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname_col, ifields_col, &nfields_col, &flg_col));
3736c924f48SJed Brown     if (!flg) break;
3745d4c12cdSJungho Lee     else if (flg && !flg_col) {
37528b400f6SJacob Faibussowitsch       PetscCheck(nfields, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
3769566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields));
3772fa5cd67SKarl Rupp     } else {
3787827d75bSBarry Smith       PetscCheck(nfields && nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
37908401ef6SPierre Jolivet       PetscCheck(nfields == nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Number of row and column fields must match");
3809566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields_col));
3815d4c12cdSJungho Lee     }
3826c924f48SJed Brown   }
3836c924f48SJed Brown   if (i > 0) {
3846c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3856c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3866c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3876c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3886c924f48SJed Brown   }
38980670ca5SBarry Smith   PetscCall(PetscFree2(ifields, ifields_col));
3903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3916c924f48SJed Brown }
3926c924f48SJed Brown 
393d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
394d71ae5a4SJacob Faibussowitsch {
3950971522cSBarry Smith   PC_FieldSplit    *jac                = (PC_FieldSplit *)pc->data;
3965a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3977b752e3dSPatrick Sanan   PetscBool         fieldsplit_default = PETSC_FALSE, coupling = PETSC_FALSE;
3986c924f48SJed Brown   PetscInt          i;
3990971522cSBarry Smith 
4000971522cSBarry Smith   PetscFunctionBegin;
4017287d2a3SDmitry Karpeev   /*
402f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
4037287d2a3SDmitry Karpeev    Should probably be rewritten.
4047287d2a3SDmitry Karpeev    */
405f5f0d762SBarry Smith   if (!ilink) {
4069566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_detect_coupling", &coupling, NULL));
4077b752e3dSPatrick Sanan     if (pc->dm && jac->dm_splits && !jac->detect && !coupling) {
408bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
4090784a22cSJed Brown       char    **fieldNames;
4107b62db95SJungho Lee       IS       *fields;
411e7c4fc90SDmitry Karpeev       DM       *dms;
412bafc1b83SMatthew G Knepley       DM        subdm[128];
413bafc1b83SMatthew G Knepley       PetscBool flg;
414bafc1b83SMatthew G Knepley 
4159566063dSJacob Faibussowitsch       PetscCall(DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms));
416bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
417bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
418bafc1b83SMatthew G Knepley         PetscInt ifields[128];
419bafc1b83SMatthew G Knepley         IS       compField;
420bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
421bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
422bafc1b83SMatthew G Knepley 
42363a3b9bcSJacob Faibussowitsch         PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
4249566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
425bafc1b83SMatthew G Knepley         if (!flg) break;
42663a3b9bcSJacob Faibussowitsch         PetscCheck(numFields <= 128, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot currently support %" PetscInt_FMT " > 128 fields", numFields);
4279566063dSJacob Faibussowitsch         PetscCall(DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]));
428bafc1b83SMatthew G Knepley         if (nfields == 1) {
4299566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField));
430bafc1b83SMatthew G Knepley         } else {
43163a3b9bcSJacob Faibussowitsch           PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
4329566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, splitname, compField));
4337287d2a3SDmitry Karpeev         }
4349566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&compField));
435bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
436bafc1b83SMatthew G Knepley           f = ifields[j];
4379566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4389566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
4397b62db95SJungho Lee         }
440bafc1b83SMatthew G Knepley       }
441bafc1b83SMatthew G Knepley       if (i == 0) {
442bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
4439566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[f], fields[f]));
4449566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4459566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
446bafc1b83SMatthew G Knepley         }
447bafc1b83SMatthew G Knepley       } else {
44848a46eb9SPierre Jolivet         for (j = 0; j < numFields; j++) PetscCall(DMDestroy(dms + j));
4499566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4509566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(i, &dms));
4512fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
452bafc1b83SMatthew G Knepley       }
4539566063dSJacob Faibussowitsch       PetscCall(PetscFree(fieldNames));
4549566063dSJacob Faibussowitsch       PetscCall(PetscFree(fields));
455e7c4fc90SDmitry Karpeev       if (dms) {
4569566063dSJacob Faibussowitsch         PetscCall(PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n"));
457bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
4587287d2a3SDmitry Karpeev           const char *prefix;
459f4f49eeaSPierre Jolivet           PetscCall(PetscObjectGetOptionsPrefix((PetscObject)ilink->ksp, &prefix));
460f4f49eeaSPierre Jolivet           PetscCall(PetscObjectSetOptionsPrefix((PetscObject)dms[i], prefix));
4619566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(ilink->ksp, dms[i]));
4629566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(ilink->ksp, PETSC_FALSE));
4639566063dSJacob Faibussowitsch           PetscCall(PetscObjectIncrementTabLevel((PetscObject)dms[i], (PetscObject)ilink->ksp, 0));
4649566063dSJacob Faibussowitsch           PetscCall(DMDestroy(&dms[i]));
4652fa5ba8aSJed Brown         }
4669566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4678b8307b2SJed Brown       }
46866ffff09SJed Brown     } else {
469521d7252SBarry Smith       if (jac->bs <= 0) {
470704ba839SBarry Smith         if (pc->pmat) {
4719566063dSJacob Faibussowitsch           PetscCall(MatGetBlockSize(pc->pmat, &jac->bs));
4722fa5cd67SKarl Rupp         } else jac->bs = 1;
473521d7252SBarry Smith       }
474d32f9abdSBarry Smith 
4757b752e3dSPatrick Sanan       if (jac->detect) {
4766ce1633cSBarry Smith         IS       zerodiags, rest;
4776ce1633cSBarry Smith         PetscInt nmin, nmax;
4786ce1633cSBarry Smith 
4799566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4807199da05SBarry Smith         if (jac->diag_use_amat) {
4819566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->mat, &zerodiags));
4827199da05SBarry Smith         } else {
4839566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->pmat, &zerodiags));
4847199da05SBarry Smith         }
4859566063dSJacob Faibussowitsch         PetscCall(ISComplement(zerodiags, nmin, nmax, &rest));
4869566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
4879566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", zerodiags));
4889566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&zerodiags));
4899566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
4903a062f41SBarry Smith       } else if (coupling) {
4913a062f41SBarry Smith         IS       coupling, rest;
4923a062f41SBarry Smith         PetscInt nmin, nmax;
4933a062f41SBarry Smith 
4949566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4957199da05SBarry Smith         if (jac->offdiag_use_amat) {
4969566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->mat, &coupling));
4977199da05SBarry Smith         } else {
4989566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->pmat, &coupling));
4997199da05SBarry Smith         }
5009566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc->mat), nmax - nmin, nmin, 1, &rest));
5019566063dSJacob Faibussowitsch         PetscCall(ISSetIdentity(rest));
5029566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
5039566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", coupling));
5049566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&coupling));
5059566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
5066ce1633cSBarry Smith       } else {
5079566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_default", &fieldsplit_default, NULL));
5087287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
509d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
510d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
5119566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
5129566063dSJacob Faibussowitsch           if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
513d32f9abdSBarry Smith         }
5146dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
5159f001fe8SStefano Zampini           Mat       M = pc->pmat;
516f3b928b9SStefano Zampini           PetscBool isnest;
51780670ca5SBarry Smith           PetscInt  nf;
518f3b928b9SStefano Zampini 
5199566063dSJacob Faibussowitsch           PetscCall(PetscInfo(pc, "Using default splitting of fields\n"));
5209566063dSJacob Faibussowitsch           PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &isnest));
521f3b928b9SStefano Zampini           if (!isnest) {
5229f001fe8SStefano Zampini             M = pc->mat;
5239566063dSJacob Faibussowitsch             PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &isnest));
524f3b928b9SStefano Zampini           }
52580670ca5SBarry Smith           if (!isnest) nf = jac->bs;
52680670ca5SBarry Smith           else PetscCall(MatNestGetSize(M, &nf, NULL));
52780670ca5SBarry Smith           for (i = 0; i < nf; i++) {
5286c924f48SJed Brown             char splitname[8];
52980670ca5SBarry Smith 
53063a3b9bcSJacob Faibussowitsch             PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
5319566063dSJacob Faibussowitsch             PetscCall(PCFieldSplitSetFields(pc, splitname, 1, &i, &i));
53279416396SBarry Smith           }
5335d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
534521d7252SBarry Smith         }
53566ffff09SJed Brown       }
5366ce1633cSBarry Smith     }
537edf189efSBarry Smith   } else if (jac->nsplits == 1) {
538edf189efSBarry Smith     IS       is2;
539edf189efSBarry Smith     PetscInt nmin, nmax;
540edf189efSBarry Smith 
5410fdf79fbSJacob Faibussowitsch     PetscCheck(ilink->is, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Must provide at least two sets of fields to PCFieldSplit()");
5429566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
5439566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is, nmin, nmax, &is2));
5449566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetIS(pc, "1", is2));
5459566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is2));
546edf189efSBarry Smith   }
547d0af7cd3SBarry Smith 
54863a3b9bcSJacob Faibussowitsch   PetscCheck(jac->nsplits >= 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unhandled case, must have at least two fields, not %" PetscInt_FMT, jac->nsplits);
5493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
55069a612a9SBarry Smith }
55169a612a9SBarry Smith 
552d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A, Mat B, Mat C, Mat *H, PetscReal gkbnu)
553d71ae5a4SJacob Faibussowitsch {
554a51937d4SCarola Kruse   Mat       BT, T;
555de482cd7SCarola Kruse   PetscReal nrmT, nrmB;
556a51937d4SCarola Kruse 
557a51937d4SCarola Kruse   PetscFunctionBegin;
5589566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &T)); /* Test if augmented matrix is symmetric */
5599566063dSJacob Faibussowitsch   PetscCall(MatAXPY(T, -1.0, B, DIFFERENT_NONZERO_PATTERN));
5609566063dSJacob Faibussowitsch   PetscCall(MatNorm(T, NORM_1, &nrmT));
5619566063dSJacob Faibussowitsch   PetscCall(MatNorm(B, NORM_1, &nrmB));
562049d1499SBarry Smith   PetscCheck(nrmB <= 0 || nrmT / nrmB < PETSC_SMALL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix is not symmetric/hermitian, GKB is not applicable.");
563049d1499SBarry Smith 
564a51937d4SCarola Kruse   /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */
565a51937d4SCarola Kruse   /* setting N := 1/nu*I in [Ar13].                                                 */
5669566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(B, MAT_INITIAL_MATRIX, &BT));
567fb842aefSJose E. Roman   PetscCall(MatMatMult(B, BT, MAT_INITIAL_MATRIX, PETSC_CURRENT, H)); /* H = A01*A01'          */
5689566063dSJacob Faibussowitsch   PetscCall(MatAYPX(*H, gkbnu, A, DIFFERENT_NONZERO_PATTERN));        /* H = A00 + nu*A01*A01' */
569a51937d4SCarola Kruse 
5709566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&BT));
5719566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&T));
5723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
573a51937d4SCarola Kruse }
574a51937d4SCarola Kruse 
57554a546c1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions, const char pre[], const char name[], const char *option[], const char *value[], PetscBool *flg);
576514bf10dSMatthew G Knepley 
577d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_FieldSplit(PC pc)
578d71ae5a4SJacob Faibussowitsch {
57969a612a9SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
5805a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
5812c9966d7SBarry Smith   PetscInt          i, nsplit;
58280670ca5SBarry Smith   PetscBool         sorted, sorted_col, matnest = PETSC_FALSE;
58369a612a9SBarry Smith 
58469a612a9SBarry Smith   PetscFunctionBegin;
5855da88fe4STristan Konolige   pc->failedreason = PC_NOERROR;
5869566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDefaults(pc));
58797bbdb24SBarry Smith   nsplit = jac->nsplits;
5885a9f2f41SSatish Balay   ilink  = jac->head;
58980670ca5SBarry Smith   if (pc->pmat) PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest));
59097bbdb24SBarry Smith 
59197bbdb24SBarry Smith   /* get the matrices for each split */
592704ba839SBarry Smith   if (!jac->issetup) {
5931b9fc7fcSBarry Smith     PetscInt rstart, rend, nslots, bs;
59497bbdb24SBarry Smith 
595704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
596704ba839SBarry Smith 
5975d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
5982c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
5992c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
6002c9966d7SBarry Smith     }
6014db63379SBarry Smith 
6024db63379SBarry Smith     /*  MatCreateSubMatrix() for [S]BAIJ matrices can only work if the indices include entire blocks of the matrix */
6034db63379SBarry Smith     PetscCall(MatGetBlockSize(pc->pmat, &bs));
6044db63379SBarry Smith     if (bs > 1 && (jac->bs <= bs || jac->bs % bs)) {
6054db63379SBarry Smith       PetscBool blk;
6064db63379SBarry Smith 
6074db63379SBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)pc->pmat, &blk, MATBAIJ, MATSBAIJ, MATSEQBAIJ, MATSEQSBAIJ, MATMPIBAIJ, MATMPISBAIJ, NULL));
6084db63379SBarry Smith       PetscCheck(!blk, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Cannot use MATBAIJ with PCFIELDSPLIT and currently set matrix and PC blocksizes");
6094db63379SBarry Smith     }
6104db63379SBarry Smith 
61180670ca5SBarry Smith     if (!matnest) { /* use the matrix blocksize and stride IS to determine the index sets that define the submatrices */
61251f519a2SBarry Smith       bs = jac->bs;
6139566063dSJacob Faibussowitsch       PetscCall(MatGetOwnershipRange(pc->pmat, &rstart, &rend));
6141b9fc7fcSBarry Smith       nslots = (rend - rstart) / bs;
6151b9fc7fcSBarry Smith       for (i = 0; i < nsplit; i++) {
6161b9fc7fcSBarry Smith         if (jac->defaultsplit) {
6179566063dSJacob Faibussowitsch           PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + i, nsplit, &ilink->is));
6189566063dSJacob Faibussowitsch           PetscCall(ISDuplicate(ilink->is, &ilink->is_col));
619704ba839SBarry Smith         } else if (!ilink->is) {
620ccb205f8SBarry Smith           if (ilink->nfields > 1) {
6215f4ab4e1SJungho Lee             PetscInt *ii, *jj, j, k, nfields = ilink->nfields, *fields = ilink->fields, *fields_col = ilink->fields_col;
62280670ca5SBarry Smith 
6239566063dSJacob Faibussowitsch             PetscCall(PetscMalloc1(ilink->nfields * nslots, &ii));
6249566063dSJacob Faibussowitsch             PetscCall(PetscMalloc1(ilink->nfields * nslots, &jj));
6251b9fc7fcSBarry Smith             for (j = 0; j < nslots; j++) {
6261b9fc7fcSBarry Smith               for (k = 0; k < nfields; k++) {
6271b9fc7fcSBarry Smith                 ii[nfields * j + k] = rstart + bs * j + fields[k];
6285f4ab4e1SJungho Lee                 jj[nfields * j + k] = rstart + bs * j + fields_col[k];
62997bbdb24SBarry Smith               }
63097bbdb24SBarry Smith             }
6319566063dSJacob Faibussowitsch             PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, ii, PETSC_OWN_POINTER, &ilink->is));
6329566063dSJacob Faibussowitsch             PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, jj, PETSC_OWN_POINTER, &ilink->is_col));
6339566063dSJacob Faibussowitsch             PetscCall(ISSetBlockSize(ilink->is, nfields));
6349566063dSJacob Faibussowitsch             PetscCall(ISSetBlockSize(ilink->is_col, nfields));
635ccb205f8SBarry Smith           } else {
6369566063dSJacob Faibussowitsch             PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields[0], bs, &ilink->is));
6379566063dSJacob Faibussowitsch             PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields_col[0], bs, &ilink->is_col));
638ccb205f8SBarry Smith           }
6393e197d65SBarry Smith         }
6409566063dSJacob Faibussowitsch         PetscCall(ISSorted(ilink->is, &sorted));
6419566063dSJacob Faibussowitsch         if (ilink->is_col) PetscCall(ISSorted(ilink->is_col, &sorted_col));
6427827d75bSBarry Smith         PetscCheck(sorted && sorted_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Fields must be sorted when creating split");
643704ba839SBarry Smith         ilink = ilink->next;
6441b9fc7fcSBarry Smith       }
64580670ca5SBarry Smith     } else { /* use the IS that define the MATNEST to determine the index sets that define the submatrices */
64680670ca5SBarry Smith       IS      *rowis, *colis, *ises = NULL;
64780670ca5SBarry Smith       PetscInt mis, nis;
64880670ca5SBarry Smith 
64980670ca5SBarry Smith       PetscCall(MatNestGetSize(pc->pmat, &mis, &nis));
65080670ca5SBarry Smith       PetscCall(PetscMalloc2(mis, &rowis, nis, &colis));
65180670ca5SBarry Smith       PetscCall(MatNestGetISs(pc->pmat, rowis, colis));
65280670ca5SBarry Smith       if (!jac->defaultsplit) PetscCall(PetscMalloc1(mis, &ises));
65380670ca5SBarry Smith 
65480670ca5SBarry Smith       for (i = 0; i < nsplit; i++) {
65580670ca5SBarry Smith         if (jac->defaultsplit) {
65680670ca5SBarry Smith           PetscCall(ISDuplicate(rowis[i], &ilink->is));
65780670ca5SBarry Smith           PetscCall(ISDuplicate(ilink->is, &ilink->is_col));
65880670ca5SBarry Smith         } else if (!ilink->is) {
65980670ca5SBarry Smith           if (ilink->nfields > 1) {
66080670ca5SBarry Smith             for (PetscInt j = 0; j < ilink->nfields; j++) ises[j] = rowis[ilink->fields[j]];
66180670ca5SBarry Smith             PetscCall(ISConcatenate(PetscObjectComm((PetscObject)pc), ilink->nfields, ises, &ilink->is));
66280670ca5SBarry Smith           } else {
66380670ca5SBarry Smith             PetscCall(ISDuplicate(rowis[ilink->fields[0]], &ilink->is));
66480670ca5SBarry Smith           }
66580670ca5SBarry Smith           PetscCall(ISDuplicate(ilink->is, &ilink->is_col));
66680670ca5SBarry Smith         }
66780670ca5SBarry Smith         ilink = ilink->next;
66880670ca5SBarry Smith       }
66980670ca5SBarry Smith       PetscCall(PetscFree2(rowis, colis));
67080670ca5SBarry Smith       PetscCall(PetscFree(ises));
67180670ca5SBarry Smith     }
6721b9fc7fcSBarry Smith   }
6731b9fc7fcSBarry Smith 
674704ba839SBarry Smith   ilink = jac->head;
67597bbdb24SBarry Smith   if (!jac->pmat) {
676bdddcaaaSMatthew G Knepley     Vec xtmp;
677bdddcaaaSMatthew G Knepley 
6789566063dSJacob Faibussowitsch     PetscCall(MatCreateVecs(pc->pmat, &xtmp, NULL));
6799566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nsplit, &jac->pmat));
6809566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nsplit, &jac->x, nsplit, &jac->y));
681cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
682bdddcaaaSMatthew G Knepley       MatNullSpace sp;
683bdddcaaaSMatthew G Knepley 
684a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
6859566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&jac->pmat[i]));
686a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
6879566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->pmat[i]));
688a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
689a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
6902fa5cd67SKarl Rupp 
6919566063dSJacob Faibussowitsch           PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
692a3df900dSMatthew G Knepley         }
693a3df900dSMatthew G Knepley       } else {
6943a062f41SBarry Smith         const char *prefix;
6959566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->pmat[i]));
6962f427464SPierre Jolivet         PetscCall(MatGetOptionsPrefix(jac->pmat[i], &prefix));
6972f427464SPierre Jolivet         if (!prefix) {
6989566063dSJacob Faibussowitsch           PetscCall(KSPGetOptionsPrefix(ilink->ksp, &prefix));
6999566063dSJacob Faibussowitsch           PetscCall(MatSetOptionsPrefix(jac->pmat[i], prefix));
7002f427464SPierre Jolivet         }
70145881c45SPierre Jolivet         PetscCall(MatSetFromOptions(jac->pmat[i]));
7029566063dSJacob Faibussowitsch         PetscCall(MatViewFromOptions(jac->pmat[i], NULL, "-mat_view"));
703a3df900dSMatthew G Knepley       }
704bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
7059566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(jac->pmat[i], &jac->x[i], &jac->y[i]));
7069371c9d4SSatish Balay       ilink->x = jac->x[i];
7079371c9d4SSatish Balay       ilink->y = jac->y[i];
7089371c9d4SSatish Balay       ilink->z = NULL;
709bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
7109566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(xtmp, ilink->is, jac->x[i], NULL, &ilink->sctx));
7119566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nearnullspace", (PetscObject *)&sp));
71248a46eb9SPierre Jolivet       if (sp) PetscCall(MatSetNearNullSpace(jac->pmat[i], sp));
713704ba839SBarry Smith       ilink = ilink->next;
714cf502942SBarry Smith     }
7159566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&xtmp));
71697bbdb24SBarry Smith   } else {
717ef7efd37SHong Zhang     MatReuse      scall;
7184849c82aSBarry Smith     MatNullSpace *nullsp = NULL;
7194849c82aSBarry Smith 
720ef7efd37SHong Zhang     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7214849c82aSBarry Smith       PetscCall(MatGetNullSpaces(nsplit, jac->pmat, &nullsp));
72248a46eb9SPierre Jolivet       for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->pmat[i]));
723ef7efd37SHong Zhang       scall = MAT_INITIAL_MATRIX;
724ef7efd37SHong Zhang     } else scall = MAT_REUSE_MATRIX;
725ef7efd37SHong Zhang 
726cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
727a3df900dSMatthew G Knepley       Mat pmat;
728a3df900dSMatthew G Knepley 
729a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
7309566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&pmat));
73148a46eb9SPierre Jolivet       if (!pmat) PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, scall, &jac->pmat[i]));
732704ba839SBarry Smith       ilink = ilink->next;
733cf502942SBarry Smith     }
7344849c82aSBarry Smith     if (nullsp) PetscCall(MatRestoreNullSpaces(nsplit, jac->pmat, &nullsp));
73597bbdb24SBarry Smith   }
7364e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
737519d70e2SJed Brown     ilink = jac->head;
738519d70e2SJed Brown     if (!jac->mat) {
7399566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nsplit, &jac->mat));
740519d70e2SJed Brown       for (i = 0; i < nsplit; i++) {
7419566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->mat[i]));
742519d70e2SJed Brown         ilink = ilink->next;
743519d70e2SJed Brown       }
744519d70e2SJed Brown     } else {
745ef7efd37SHong Zhang       MatReuse      scall;
7464849c82aSBarry Smith       MatNullSpace *nullsp = NULL;
7474849c82aSBarry Smith 
748ef7efd37SHong Zhang       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7494849c82aSBarry Smith         PetscCall(MatGetNullSpaces(nsplit, jac->mat, &nullsp));
75048a46eb9SPierre Jolivet         for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->mat[i]));
751ef7efd37SHong Zhang         scall = MAT_INITIAL_MATRIX;
752ef7efd37SHong Zhang       } else scall = MAT_REUSE_MATRIX;
753ef7efd37SHong Zhang 
754ef7efd37SHong Zhang       for (i = 0; i < nsplit; i++) {
7559566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, scall, &jac->mat[i]));
756519d70e2SJed Brown         ilink = ilink->next;
757519d70e2SJed Brown       }
7584849c82aSBarry Smith       if (nullsp) PetscCall(MatRestoreNullSpaces(nsplit, jac->mat, &nullsp));
759519d70e2SJed Brown     }
760519d70e2SJed Brown   } else {
761519d70e2SJed Brown     jac->mat = jac->pmat;
762519d70e2SJed Brown   }
76397bbdb24SBarry Smith 
76453935eafSBarry Smith   /* Check for null space attached to IS */
76553935eafSBarry Smith   ilink = jac->head;
76653935eafSBarry Smith   for (i = 0; i < nsplit; i++) {
76753935eafSBarry Smith     MatNullSpace sp;
76853935eafSBarry Smith 
7699566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nullspace", (PetscObject *)&sp));
77048a46eb9SPierre Jolivet     if (sp) PetscCall(MatSetNullSpace(jac->mat[i], sp));
77153935eafSBarry Smith     ilink = ilink->next;
77253935eafSBarry Smith   }
77353935eafSBarry Smith 
774a51937d4SCarola Kruse   if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) {
77568dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
7764e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
77768dd23aaSBarry Smith     ilink = jac->head;
778e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
779e52d2c62SBarry Smith       /* special case need where Afield[0] is not needed and only certain columns of Afield[1] are needed since update is only on those rows of the solution */
780e52d2c62SBarry Smith       if (!jac->Afield) {
7819566063dSJacob Faibussowitsch         PetscCall(PetscCalloc1(nsplit, &jac->Afield));
78280c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7839566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
784e52d2c62SBarry Smith         } else {
7859566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
78680c96bb1SFande Kong         }
78780c96bb1SFande Kong       } else {
788ef7efd37SHong Zhang         MatReuse scall;
789e9422dd5SStefano Zampini 
790ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7919566063dSJacob Faibussowitsch           PetscCall(MatDestroy(&jac->Afield[1]));
792ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
793ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
794ef7efd37SHong Zhang 
79580c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7969566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
79780c96bb1SFande Kong         } else {
7989566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
79980c96bb1SFande Kong         }
800e52d2c62SBarry Smith       }
801e52d2c62SBarry Smith     } else {
80268dd23aaSBarry Smith       if (!jac->Afield) {
8039566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nsplit, &jac->Afield));
80468dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
80580c96bb1SFande Kong           if (jac->offdiag_use_amat) {
8069566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
80780c96bb1SFande Kong           } else {
8089566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
80980c96bb1SFande Kong           }
81068dd23aaSBarry Smith           ilink = ilink->next;
81168dd23aaSBarry Smith         }
81268dd23aaSBarry Smith       } else {
813ef7efd37SHong Zhang         MatReuse scall;
814ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
81548a46eb9SPierre Jolivet           for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->Afield[i]));
816ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
817ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
818ef7efd37SHong Zhang 
81968dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
82080c96bb1SFande Kong           if (jac->offdiag_use_amat) {
8219566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, scall, &jac->Afield[i]));
82280c96bb1SFande Kong           } else {
8239566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, scall, &jac->Afield[i]));
82480c96bb1SFande Kong           }
82568dd23aaSBarry Smith           ilink = ilink->next;
82668dd23aaSBarry Smith         }
82768dd23aaSBarry Smith       }
82868dd23aaSBarry Smith     }
829e52d2c62SBarry Smith   }
83068dd23aaSBarry Smith 
8313b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
8323b224e63SBarry Smith     IS          ccis;
833b94d7dedSBarry Smith     PetscBool   isset, isspd;
8344aa3045dSJed Brown     PetscInt    rstart, rend;
835093c86ffSJed Brown     char        lscname[256];
836093c86ffSJed Brown     PetscObject LSC_L;
837558f3fe8SPierre Jolivet     PetscBool   set, flg;
838ce94432eSBarry Smith 
83908401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use Schur complement preconditioner you must have exactly 2 fields");
84068dd23aaSBarry Smith 
841c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
842c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
843b94d7dedSBarry Smith       PetscCall(MatIsSPDKnown(pc->pmat, &isset, &isspd));
844b94d7dedSBarry Smith       jac->schurscale = (isset && isspd) ? 1.0 : -1.0;
845c096484dSStefano Zampini     }
846c096484dSStefano Zampini 
847e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
8489566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend));
849558f3fe8SPierre Jolivet     PetscCall(PetscObjectTypeCompareAny(jac->offdiag_use_amat ? (PetscObject)pc->mat : (PetscObject)pc->pmat, &flg, MATSEQSBAIJ, MATMPISBAIJ, ""));
850e6cab6aaSJed Brown 
8513b224e63SBarry Smith     if (jac->schur) {
8520298fd71SBarry Smith       KSP      kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
853e9422dd5SStefano Zampini       MatReuse scall;
854e9422dd5SStefano Zampini 
855e9422dd5SStefano Zampini       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
856e9422dd5SStefano Zampini         scall = MAT_INITIAL_MATRIX;
8579566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->B));
8589566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->C));
859e9422dd5SStefano Zampini       } else scall = MAT_REUSE_MATRIX;
860443836d0SMatthew G Knepley 
8619566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
8623b224e63SBarry Smith       ilink = jac->head;
8639566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8644e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8659566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->B));
866c84da90fSDmitry Karpeev       } else {
8679566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->B));
868c84da90fSDmitry Karpeev       }
8699566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
870558f3fe8SPierre Jolivet       if (!flg) {
8713b224e63SBarry Smith         ilink = ilink->next;
8729566063dSJacob Faibussowitsch         PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
8734e39094bSDmitry Karpeev         if (jac->offdiag_use_amat) {
8749566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, scall, &jac->C));
875c84da90fSDmitry Karpeev         } else {
8769566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, scall, &jac->C));
877c84da90fSDmitry Karpeev         }
8789566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&ccis));
879558f3fe8SPierre Jolivet       } else {
880558f3fe8SPierre Jolivet         PetscCall(MatIsHermitianKnown(jac->offdiag_use_amat ? pc->mat : pc->pmat, &set, &flg));
881558f3fe8SPierre Jolivet         if (set && flg) PetscCall(MatCreateHermitianTranspose(jac->B, &jac->C));
882558f3fe8SPierre Jolivet         else PetscCall(MatCreateTranspose(jac->B, &jac->C));
883558f3fe8SPierre Jolivet       }
8849566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementUpdateSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
885a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
8869566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->schurp));
8879566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
888d9eadc85SPierre Jolivet       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
889d9eadc85SPierre Jolivet         PetscCall(MatDestroy(&jac->schur_user));
890d9eadc85SPierre Jolivet         if (jac->kspupper == jac->head->ksp) {
891d9eadc85SPierre Jolivet           Mat AinvB;
892d9eadc85SPierre Jolivet 
893d9eadc85SPierre Jolivet           PetscCall(MatCreate(PetscObjectComm((PetscObject)jac->schur), &AinvB));
894d9eadc85SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)jac->schur, "AinvB", (PetscObject)AinvB));
89573716367SStefano Zampini           PetscCall(MatDestroy(&AinvB));
896d9eadc85SPierre Jolivet         }
897d9eadc85SPierre Jolivet         PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
898a7476a74SDmitry Karpeev       }
89948a46eb9SPierre Jolivet       if (kspA != kspInner) PetscCall(KSPSetOperators(kspA, jac->mat[0], jac->pmat[0]));
90048a46eb9SPierre Jolivet       if (kspUpper != kspA) PetscCall(KSPSetOperators(kspUpper, jac->mat[0], jac->pmat[0]));
9019566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
9023b224e63SBarry Smith     } else {
903bafc1b83SMatthew G Knepley       const char  *Dprefix;
904470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
905514bf10dSMatthew G Knepley       char         schurtestoption[256];
906bdddcaaaSMatthew G Knepley       MatNullSpace sp;
907686bed4dSStefano Zampini       KSP          kspt;
9083b224e63SBarry Smith 
909a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
9103b224e63SBarry Smith       ilink = jac->head;
9119566063dSJacob Faibussowitsch       PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
9124e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
9139566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
914c84da90fSDmitry Karpeev       } else {
9159566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
916c84da90fSDmitry Karpeev       }
9179566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&ccis));
9183b224e63SBarry Smith       ilink = ilink->next;
919558f3fe8SPierre Jolivet       if (!flg) {
9209566063dSJacob Faibussowitsch         PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
9214e39094bSDmitry Karpeev         if (jac->offdiag_use_amat) {
9229566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
923c84da90fSDmitry Karpeev         } else {
9249566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
925c84da90fSDmitry Karpeev         }
9269566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&ccis));
927558f3fe8SPierre Jolivet       } else {
928558f3fe8SPierre Jolivet         PetscCall(MatIsHermitianKnown(jac->offdiag_use_amat ? pc->mat : pc->pmat, &set, &flg));
929558f3fe8SPierre Jolivet         if (set && flg) PetscCall(MatCreateHermitianTranspose(jac->B, &jac->C));
930558f3fe8SPierre Jolivet         else PetscCall(MatCreateTranspose(jac->B, &jac->C));
931558f3fe8SPierre Jolivet       }
932f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
9339566063dSJacob Faibussowitsch       PetscCall(MatCreate(((PetscObject)jac->mat[0])->comm, &jac->schur));
9349566063dSJacob Faibussowitsch       PetscCall(MatSetType(jac->schur, MATSCHURCOMPLEMENT));
9359566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementSetSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
9369566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
9379566063dSJacob Faibussowitsch       PetscCall(MatSetOptionsPrefix(jac->schur, schurmatprefix));
9389566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspt));
9399566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(kspt, schurmatprefix));
940686bed4dSStefano Zampini 
941686bed4dSStefano Zampini       /* Note: this is not true in general */
9429566063dSJacob Faibussowitsch       PetscCall(MatGetNullSpace(jac->mat[1], &sp));
9431baa6e33SBarry Smith       if (sp) PetscCall(MatSetNullSpace(jac->schur, sp));
94420252d06SBarry Smith 
9459566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname));
94654a546c1SMatthew G. Knepley       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, NULL, &flg));
947514bf10dSMatthew G Knepley       if (flg) {
948514bf10dSMatthew G Knepley         DM  dmInner;
94921635b76SJed Brown         KSP kspInner;
950686bed4dSStefano Zampini         PC  pcInner;
95121635b76SJed Brown 
9529566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
9539566063dSJacob Faibussowitsch         PetscCall(KSPReset(kspInner));
9549566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(kspInner, jac->mat[0], jac->pmat[0]));
9559566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
95621635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
9579566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject)pc, 2));
9589566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject)pc, 2));
9599566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(kspInner, schurprefix));
960514bf10dSMatthew G Knepley 
961514bf10dSMatthew G Knepley         /* Set DM for new solver */
9629566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
9639566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(kspInner, dmInner));
9649566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(kspInner, PETSC_FALSE));
965686bed4dSStefano Zampini 
966686bed4dSStefano Zampini         /* Defaults to PCKSP as preconditioner */
9679566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9689566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcInner, PCKSP));
9699566063dSJacob Faibussowitsch         PetscCall(PCKSPSetKSP(pcInner, jac->head->ksp));
970514bf10dSMatthew G Knepley       } else {
97121635b76SJed Brown         /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
97221635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
97321635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
97421635b76SJed 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
97521635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
97621635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
9779566063dSJacob Faibussowitsch         PetscCall(KSPSetType(jac->head->ksp, KSPGMRES));
9789566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementSetKSP(jac->schur, jac->head->ksp));
979bafc1b83SMatthew G Knepley       }
9809566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->head->ksp, jac->mat[0], jac->pmat[0]));
9819566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->head->ksp));
9829566063dSJacob Faibussowitsch       PetscCall(MatSetFromOptions(jac->schur));
9833b224e63SBarry Smith 
9849566063dSJacob Faibussowitsch       PetscCall(PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg));
985686bed4dSStefano Zampini       if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */
986686bed4dSStefano Zampini         KSP kspInner;
987686bed4dSStefano Zampini         PC  pcInner;
988686bed4dSStefano Zampini 
9899566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
9909566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9919566063dSJacob Faibussowitsch         PetscCall(PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg));
992686bed4dSStefano Zampini         if (flg) {
993686bed4dSStefano Zampini           KSP ksp;
994686bed4dSStefano Zampini 
9959566063dSJacob Faibussowitsch           PetscCall(PCKSPGetKSP(pcInner, &ksp));
99648a46eb9SPierre Jolivet           if (ksp == jac->head->ksp) PetscCall(PCSetUseAmat(pcInner, PETSC_TRUE));
997686bed4dSStefano Zampini         }
998686bed4dSStefano Zampini       }
9999566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname));
100054a546c1SMatthew G. Knepley       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, NULL, &flg));
1001443836d0SMatthew G Knepley       if (flg) {
1002443836d0SMatthew G Knepley         DM dmInner;
1003443836d0SMatthew G Knepley 
10049566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
10059566063dSJacob Faibussowitsch         PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper));
10063821be0aSBarry Smith         PetscCall(KSPSetNestLevel(jac->kspupper, pc->kspnestlevel));
10079566063dSJacob Faibussowitsch         PetscCall(KSPSetErrorIfNotConverged(jac->kspupper, pc->erroriffailure));
10089566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(jac->kspupper, schurprefix));
10099566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject)pc, 1));
10109566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject)pc, 1));
10119566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
10129566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(jac->kspupper, dmInner));
10139566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(jac->kspupper, PETSC_FALSE));
10149566063dSJacob Faibussowitsch         PetscCall(KSPSetFromOptions(jac->kspupper));
10159566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(jac->kspupper, jac->mat[0], jac->pmat[0]));
10169566063dSJacob Faibussowitsch         PetscCall(VecDuplicate(jac->head->x, &jac->head->z));
1017443836d0SMatthew G Knepley       } else {
1018443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
10199566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->head->ksp));
1020443836d0SMatthew G Knepley       }
1021443836d0SMatthew G Knepley 
102248a46eb9SPierre Jolivet       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
10239566063dSJacob Faibussowitsch       PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspschur));
10243821be0aSBarry Smith       PetscCall(KSPSetNestLevel(jac->kspschur, pc->kspnestlevel));
10259566063dSJacob Faibussowitsch       PetscCall(KSPSetErrorIfNotConverged(jac->kspschur, pc->erroriffailure));
10269566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspschur, (PetscObject)pc, 1));
1027084e4875SJed Brown       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
10287233a360SDmitry Karpeev         PC pcschur;
10299566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(jac->kspschur, &pcschur));
10309566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcschur, PCNONE));
1031084e4875SJed Brown         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
1032e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
1033d9eadc85SPierre Jolivet         if (jac->schurfactorization == PC_FIELDSPLIT_SCHUR_FACT_FULL && jac->kspupper == jac->head->ksp) {
1034d9eadc85SPierre Jolivet           Mat AinvB;
1035d9eadc85SPierre Jolivet 
1036d9eadc85SPierre Jolivet           PetscCall(MatCreate(PetscObjectComm((PetscObject)jac->schur), &AinvB));
1037d9eadc85SPierre Jolivet           PetscCall(PetscObjectCompose((PetscObject)jac->schur, "AinvB", (PetscObject)AinvB));
103873716367SStefano Zampini           PetscCall(MatDestroy(&AinvB));
1039d9eadc85SPierre Jolivet         }
10409566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
1041e69d4d44SBarry Smith       }
10429566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
10439566063dSJacob Faibussowitsch       PetscCall(KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix));
10449566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(jac->kspschur, Dprefix));
1045c096484dSStefano Zampini       /* propagate DM */
1046b20b4189SMatthew G. Knepley       {
1047b20b4189SMatthew G. Knepley         DM sdm;
10489566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->next->ksp, &sdm));
1049b20b4189SMatthew G. Knepley         if (sdm) {
10509566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(jac->kspschur, sdm));
10519566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(jac->kspschur, PETSC_FALSE));
1052b20b4189SMatthew G. Knepley         }
1053b20b4189SMatthew G. Knepley       }
10543b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
105520b26d62SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
10569566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->kspschur));
10573b224e63SBarry Smith     }
10589566063dSJacob Faibussowitsch     PetscCall(MatAssemblyBegin(jac->schur, MAT_FINAL_ASSEMBLY));
10599566063dSJacob Faibussowitsch     PetscCall(MatAssemblyEnd(jac->schur, MAT_FINAL_ASSEMBLY));
1060093c86ffSJed Brown 
1061093c86ffSJed Brown     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
10629566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_L", ilink->splitname));
10639566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L));
10649566063dSJacob Faibussowitsch     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L));
10659566063dSJacob Faibussowitsch     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_L", (PetscObject)LSC_L));
10669566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_Lp", ilink->splitname));
10679566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, (PetscObject *)&LSC_L));
10689566063dSJacob Faibussowitsch     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, (PetscObject *)&LSC_L));
10699566063dSJacob Faibussowitsch     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_Lp", (PetscObject)LSC_L));
1070a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1071a51937d4SCarola Kruse     IS       ccis;
1072a51937d4SCarola Kruse     PetscInt rstart, rend;
1073a51937d4SCarola Kruse 
107408401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use GKB preconditioner you must have exactly 2 fields");
1075a51937d4SCarola Kruse 
1076a51937d4SCarola Kruse     ilink = jac->head;
1077a51937d4SCarola Kruse 
1078a51937d4SCarola Kruse     /* When extracting off-diagonal submatrices, we take complements from this range */
10799566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRangeColumn(pc->mat, &rstart, &rend));
1080a51937d4SCarola Kruse 
10819566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
1082a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
10839566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
1084a51937d4SCarola Kruse     } else {
10859566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->B));
1086a51937d4SCarola Kruse     }
10879566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ccis));
1088e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
10899566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->u));
10909566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->Hu));
10919566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w2));
1092a51937d4SCarola Kruse     ilink = ilink->next;
10939566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is_col, rstart, rend, &ccis));
1094a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
10959566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
1096a51937d4SCarola Kruse     } else {
10979566063dSJacob Faibussowitsch       PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ccis, MAT_INITIAL_MATRIX, &jac->C));
1098a51937d4SCarola Kruse     }
10999566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ccis));
1100e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
11019566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->v));
11029566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->d));
11039566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w1));
11049566063dSJacob Faibussowitsch     PetscCall(MatGolubKahanComputeExplicitOperator(jac->mat[0], jac->B, jac->C, &jac->H, jac->gkbnu));
11059566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(jac->gkbdelay, &jac->vecz));
1106e071a0a4SCarola Kruse 
1107a51937d4SCarola Kruse     ilink = jac->head;
11089566063dSJacob Faibussowitsch     PetscCall(KSPSetOperators(ilink->ksp, jac->H, jac->H));
11099566063dSJacob Faibussowitsch     if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
1110e071a0a4SCarola Kruse     /* Create gkb_monitor context */
1111de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1112de482cd7SCarola Kruse       PetscInt tablevel;
11139566063dSJacob Faibussowitsch       PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &jac->gkbviewer));
11149566063dSJacob Faibussowitsch       PetscCall(PetscViewerSetType(jac->gkbviewer, PETSCVIEWERASCII));
11159566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetTabLevel((PetscObject)ilink->ksp, &tablevel));
11169566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISetTab(jac->gkbviewer, tablevel));
11179566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)ilink->ksp, 1));
1118de482cd7SCarola Kruse     }
11193b224e63SBarry Smith   } else {
112068bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
112197bbdb24SBarry Smith     i     = 0;
11225a9f2f41SSatish Balay     ilink = jac->head;
11235a9f2f41SSatish Balay     while (ilink) {
11249566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(ilink->ksp, jac->mat[i], jac->pmat[i]));
11253b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
11269566063dSJacob Faibussowitsch       if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
112797bbdb24SBarry Smith       i++;
11285a9f2f41SSatish Balay       ilink = ilink->next;
11290971522cSBarry Smith     }
11303b224e63SBarry Smith   }
11313b224e63SBarry Smith 
11325ddf11f8SNicolas Barnafi   /* Set coordinates to the sub PC objects whenever these are set */
11335ddf11f8SNicolas Barnafi   if (jac->coordinates_set) {
11345ddf11f8SNicolas Barnafi     PC pc_coords;
11355ddf11f8SNicolas Barnafi     if (jac->type == PC_COMPOSITE_SCHUR) {
11365ddf11f8SNicolas Barnafi       // Head is first block.
11379566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->head->ksp, &pc_coords));
11389566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->dim, jac->head->ndofs, jac->head->coords));
11395ddf11f8SNicolas Barnafi       // Second one is Schur block, but its KSP object is in kspschur.
11409566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->kspschur, &pc_coords));
11419566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->next->dim, jac->head->next->ndofs, jac->head->next->coords));
11425ddf11f8SNicolas Barnafi     } else if (jac->type == PC_COMPOSITE_GKB) {
11439d3446b2SPierre Jolivet       PetscCall(PetscInfo(pc, "Warning: Setting coordinates does nothing for the GKB Fieldpslit preconditioner\n"));
11445ddf11f8SNicolas Barnafi     } else {
11455ddf11f8SNicolas Barnafi       ilink = jac->head;
11465ddf11f8SNicolas Barnafi       while (ilink) {
11479566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(ilink->ksp, &pc_coords));
11489566063dSJacob Faibussowitsch         PetscCall(PCSetCoordinates(pc_coords, ilink->dim, ilink->ndofs, ilink->coords));
11495ddf11f8SNicolas Barnafi         ilink = ilink->next;
11505ddf11f8SNicolas Barnafi       }
11515ddf11f8SNicolas Barnafi     }
11525ddf11f8SNicolas Barnafi   }
11535ddf11f8SNicolas Barnafi 
1154c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
11553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11560971522cSBarry Smith }
11570971522cSBarry Smith 
11585a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink, xx, yy) \
11593ba16761SJacob 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) || \
11609371c9d4SSatish 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) || \
11613ba16761SJacob Faibussowitsch                     VecScatterEnd(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE)))
116279416396SBarry Smith 
116373716367SStefano Zampini static PetscErrorCode PCSetUpOnBlocks_FieldSplit_Schur(PC pc)
116473716367SStefano Zampini {
116573716367SStefano Zampini   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
116673716367SStefano Zampini   PC_FieldSplitLink ilinkA = jac->head;
116773716367SStefano Zampini   KSP               kspA = ilinkA->ksp, kspUpper = jac->kspupper;
116873716367SStefano Zampini 
116973716367SStefano Zampini   PetscFunctionBegin;
117073716367SStefano Zampini   if (jac->schurfactorization == PC_FIELDSPLIT_SCHUR_FACT_FULL && kspUpper != kspA) {
117173716367SStefano Zampini     PetscCall(KSPSetUp(kspUpper));
117273716367SStefano Zampini     PetscCall(KSPSetUpOnBlocks(kspUpper));
117373716367SStefano Zampini   }
117473716367SStefano Zampini   PetscCall(KSPSetUp(kspA));
117573716367SStefano Zampini   PetscCall(KSPSetUpOnBlocks(kspA));
117673716367SStefano Zampini   if (jac->schurpre != PC_FIELDSPLIT_SCHUR_PRE_FULL) {
117773716367SStefano Zampini     PetscCall(KSPSetUp(jac->kspschur));
117873716367SStefano Zampini     PetscCall(KSPSetUpOnBlocks(jac->kspschur));
1179ab1f0642SPierre Jolivet   } else if (kspUpper == kspA) {
1180ab1f0642SPierre Jolivet     Mat      AinvB, A;
1181ab1f0642SPierre Jolivet     PetscInt m, M, N;
1182ab1f0642SPierre Jolivet 
1183ab1f0642SPierre Jolivet     PetscCall(PetscObjectQuery((PetscObject)jac->schur, "AinvB", (PetscObject *)&AinvB));
1184ab1f0642SPierre Jolivet     if (AinvB) {
1185ab1f0642SPierre Jolivet       PetscCall(MatGetSize(AinvB, NULL, &N));
1186ab1f0642SPierre Jolivet       if (N == -1) { // first time PCSetUpOnBlocks_FieldSplit_Schur() is called
1187ab1f0642SPierre Jolivet         VecType      vtype;
1188ab1f0642SPierre Jolivet         PetscMemType mtype;
1189ab1f0642SPierre Jolivet         PetscScalar *array;
1190ab1f0642SPierre Jolivet 
1191ab1f0642SPierre Jolivet         PetscCall(MatGetSize(jac->B, &M, &N));
1192ab1f0642SPierre Jolivet         PetscCall(MatGetLocalSize(jac->B, &m, NULL));
1193ab1f0642SPierre Jolivet         PetscCall(MatGetVecType(jac->B, &vtype));
1194ab1f0642SPierre Jolivet         PetscCall(VecGetArrayAndMemType(ilinkA->x, &array, &mtype));
1195ab1f0642SPierre Jolivet         PetscCall(VecRestoreArrayAndMemType(ilinkA->x, &array));
1196ab1f0642SPierre Jolivet         if (PetscMemTypeHost(mtype) || (!PetscDefined(HAVE_CUDA) && !PetscDefined(HAVE_HIP))) PetscCall(PetscMalloc1(m * (N + 1), &array));
1197ab1f0642SPierre Jolivet #if PetscDefined(HAVE_CUDA)
1198ab1f0642SPierre Jolivet         else if (PetscMemTypeCUDA(mtype)) PetscCallCUDA(cudaMalloc((void **)&array, sizeof(PetscScalar) * m * (N + 1)));
1199ab1f0642SPierre Jolivet #endif
1200ab1f0642SPierre Jolivet #if PetscDefined(HAVE_HIP)
1201ab1f0642SPierre Jolivet         else if (PetscMemTypeHIP(mtype)) PetscCallHIP(hipMalloc((void **)&array, sizeof(PetscScalar) * m * (N + 1)));
1202ab1f0642SPierre Jolivet #endif
1203ab1f0642SPierre Jolivet         PetscCall(MatCreateDenseFromVecType(PetscObjectComm((PetscObject)jac->schur), vtype, m, PETSC_DECIDE, M, N + 1, -1, array, &A)); // number of columns of the Schur complement plus one
1204ab1f0642SPierre Jolivet         PetscCall(MatHeaderReplace(AinvB, &A));
1205ab1f0642SPierre Jolivet       }
1206ab1f0642SPierre Jolivet     }
120773716367SStefano Zampini   }
120873716367SStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
120973716367SStefano Zampini }
121073716367SStefano Zampini 
121173716367SStefano Zampini static PetscErrorCode PCSetUpOnBlocks_FieldSplit(PC pc)
121273716367SStefano Zampini {
121373716367SStefano Zampini   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
121473716367SStefano Zampini   PC_FieldSplitLink ilink = jac->head;
121573716367SStefano Zampini 
121673716367SStefano Zampini   PetscFunctionBegin;
121773716367SStefano Zampini   while (ilink) {
121873716367SStefano Zampini     PetscCall(KSPSetUp(ilink->ksp));
121973716367SStefano Zampini     PetscCall(KSPSetUpOnBlocks(ilink->ksp));
122073716367SStefano Zampini     ilink = ilink->next;
122173716367SStefano Zampini   }
122273716367SStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
122373716367SStefano Zampini }
122473716367SStefano Zampini 
122573716367SStefano Zampini static PetscErrorCode PCSetUpOnBlocks_FieldSplit_GKB(PC pc)
122673716367SStefano Zampini {
122773716367SStefano Zampini   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
122873716367SStefano Zampini   PC_FieldSplitLink ilinkA = jac->head;
122973716367SStefano Zampini   KSP               ksp    = ilinkA->ksp;
123073716367SStefano Zampini 
123173716367SStefano Zampini   PetscFunctionBegin;
123273716367SStefano Zampini   PetscCall(KSPSetUp(ksp));
123373716367SStefano Zampini   PetscCall(KSPSetUpOnBlocks(ksp));
123473716367SStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
123573716367SStefano Zampini }
123673716367SStefano Zampini 
1237d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_Schur(PC pc, Vec x, Vec y)
1238d71ae5a4SJacob Faibussowitsch {
12393b224e63SBarry Smith   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
12403b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1241443836d0SMatthew G Knepley   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
1242d9eadc85SPierre Jolivet   Mat               AinvB = NULL;
1243ab1f0642SPierre Jolivet   PetscInt          N, P;
12443b224e63SBarry Smith 
12453b224e63SBarry Smith   PetscFunctionBegin;
1246c5d2311dSJed Brown   switch (jac->schurfactorization) {
1247c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
1248a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
12499566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12509566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12519566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12529566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12539566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
12549566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12559566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12569566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12579566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12589566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1259e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
12609566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
12619566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
1262e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
12639566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12649566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->y, jac->schurscale));
12659566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12669566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12679566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1268c5d2311dSJed Brown     break;
1269c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
1270a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
12719566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12729566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12739566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12749566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
12759566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12769566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12779566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
12789566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.));
12799566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12809566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12819566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12829566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1283e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
12849566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
1285e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
12869566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12879566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12889566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12899566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12909566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1291c5d2311dSJed Brown     break;
1292c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
1293a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
12949566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12959566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12969566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1297e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
12989566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
1299e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
13009566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13019371c9d4SSatish Balay     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13029371c9d4SSatish Balay     PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
13039566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkA->x, -1.));
13049566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
13059566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13069566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
13079566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13089566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
13099566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13109566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13119566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13129566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13139566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1314c5d2311dSJed Brown     break;
1315c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
1316c238f8cdSStefano Zampini     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */
1317ab1f0642SPierre Jolivet     PetscCall(MatGetSize(jac->B, NULL, &P));
1318ab1f0642SPierre Jolivet     N = P;
13199566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13209566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13219566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
1322d9eadc85SPierre Jolivet     if (kspUpper == kspA) {
1323d9eadc85SPierre Jolivet       PetscCall(PetscObjectQuery((PetscObject)jac->schur, "AinvB", (PetscObject *)&AinvB));
1324d9eadc85SPierre Jolivet       if (AinvB) {
1325d9eadc85SPierre Jolivet         PetscCall(MatGetSize(AinvB, NULL, &N));
1326ab1f0642SPierre Jolivet         if (N > P) { // first time PCApply_FieldSplit_Schur() is called
1327f7cbcdf3SPierre Jolivet           PetscMemType mtype;
1328ab1f0642SPierre Jolivet           Vec          c = NULL;
1329f7cbcdf3SPierre Jolivet           PetscScalar *array;
1330ab1f0642SPierre Jolivet           PetscInt     m, M;
1331d9eadc85SPierre Jolivet 
1332ab1f0642SPierre Jolivet           PetscCall(MatGetSize(jac->B, &M, NULL));
1333d9eadc85SPierre Jolivet           PetscCall(MatGetLocalSize(jac->B, &m, NULL));
1334ab1f0642SPierre Jolivet           PetscCall(MatDenseGetArrayAndMemType(AinvB, &array, &mtype));
1335ab1f0642SPierre Jolivet           if (PetscMemTypeHost(mtype) || (!PetscDefined(HAVE_CUDA) && !PetscDefined(HAVE_HIP))) PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)jac->schur), 1, m, M, array + m * P, &c));
1336f7cbcdf3SPierre Jolivet #if PetscDefined(HAVE_CUDA)
1337ab1f0642SPierre Jolivet           else if (PetscMemTypeCUDA(mtype)) PetscCall(VecCreateMPICUDAWithArray(PetscObjectComm((PetscObject)jac->schur), 1, m, M, array + m * P, &c));
1338f7cbcdf3SPierre Jolivet #endif
1339f7cbcdf3SPierre Jolivet #if PetscDefined(HAVE_HIP)
1340ab1f0642SPierre Jolivet           else if (PetscMemTypeHIP(mtype)) PetscCall(VecCreateMPIHIPWithArray(PetscObjectComm((PetscObject)jac->schur), 1, m, M, array + m * P, &c));
1341f7cbcdf3SPierre Jolivet #endif
1342ab1f0642SPierre Jolivet           PetscCall(MatDenseRestoreArrayAndMemType(AinvB, &array));
1343ab1f0642SPierre Jolivet           PetscCall(VecCopy(ilinkA->x, c));
1344d9eadc85SPierre Jolivet           PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
1345d9eadc85SPierre Jolivet           PetscCall(KSPSetOperators(jac->kspschur, jac->schur, jac->schur_user));
1346f7cbcdf3SPierre Jolivet           PetscCall(VecCopy(c, ilinkA->y)); // retrieve the solution as the last column of the composed Mat
1347f7cbcdf3SPierre Jolivet           PetscCall(VecDestroy(&c));
1348d9eadc85SPierre Jolivet         }
1349d9eadc85SPierre Jolivet       }
1350d9eadc85SPierre Jolivet     }
1351ab1f0642SPierre Jolivet     if (N == P) PetscCall(KSPSolve(kspLower, ilinkA->x, ilinkA->y));
13529566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->y));
13539566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
13549566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
13559566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.0));
13569566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13579566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13583b224e63SBarry Smith 
13599566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1360e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
13619566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
1362e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
13639566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13649566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13659566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13663b224e63SBarry Smith 
1367443836d0SMatthew G Knepley     if (kspUpper == kspA) {
1368d9eadc85SPierre Jolivet       if (!AinvB) {
13699566063dSJacob Faibussowitsch         PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->y));
13709566063dSJacob Faibussowitsch         PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y));
13719566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13729566063dSJacob Faibussowitsch         PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
13739566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13749566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
1375d9eadc85SPierre Jolivet       } else PetscCall(MatMultAdd(AinvB, ilinkD->y, ilinkA->y, ilinkA->y));
1376443836d0SMatthew G Knepley     } else {
13779566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13789566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
13799566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13809566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
13819566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
13829566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspUpper, ilinkA->x, ilinkA->z));
13839566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->z));
13849566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
13859566063dSJacob Faibussowitsch       PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z));
1386443836d0SMatthew G Knepley     }
13879566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13889566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13899566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1390c5d2311dSJed Brown   }
13913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
13923b224e63SBarry Smith }
13933b224e63SBarry Smith 
13947b665727SPierre Jolivet static PetscErrorCode PCApplyTranspose_FieldSplit_Schur(PC pc, Vec x, Vec y)
13957b665727SPierre Jolivet {
13967b665727SPierre Jolivet   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
13977b665727SPierre Jolivet   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
13987b665727SPierre Jolivet   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
13997b665727SPierre Jolivet 
14007b665727SPierre Jolivet   PetscFunctionBegin;
14017b665727SPierre Jolivet   switch (jac->schurfactorization) {
14027b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
14037b665727SPierre Jolivet     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
14047b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
14057b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
14067b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
14077b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14087b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
14097b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
14107b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14117b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14127b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
14137b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1414e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
14157b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
1416e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
14177b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
14187b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
14197b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->y, jac->schurscale));
14207b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14217b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14227b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14237b665727SPierre Jolivet     break;
14247b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
14257b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
14267b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
14277b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14287b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
14297b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
14307b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14317b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x));
14327b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->x, -1.));
14337b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
14347b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14357b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
14367b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1437e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
14387b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
1439e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
14407b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
14417b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
14427b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14437b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14447b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14457b665727SPierre Jolivet     break;
14467b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
14477b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
14487b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
14497b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1450e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
14517b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
1452e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
14537b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
14547b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
14557b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x));
14567b665727SPierre Jolivet     PetscCall(VecScale(ilinkA->x, -1.));
14577b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
14587b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14597b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
14607b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14617b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
14627b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
14637b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14647b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14657b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14667b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14677b665727SPierre Jolivet     break;
14687b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
14697b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
14707b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
14717b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL));
14727b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspUpper, ilinkA->x, ilinkA->y));
14737b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->y));
14747b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL));
14757b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x));
14767b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->x, -1.0));
14777b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
14787b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
14797b665727SPierre Jolivet 
14807b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1481e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
14827b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
1483e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
14847b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
14857b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
14867b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14877b665727SPierre Jolivet 
14887b665727SPierre Jolivet     if (kspLower == kspA) {
14897b665727SPierre Jolivet       PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->y));
14907b665727SPierre Jolivet       PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y));
14917b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14927b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
14937b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
14947b665727SPierre Jolivet       PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14957b665727SPierre Jolivet     } else {
14967b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14977b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
14987b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
14997b665727SPierre Jolivet       PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x));
15007b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL));
15017b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspLower, ilinkA->x, ilinkA->z));
15027b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->z));
15037b665727SPierre Jolivet       PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL));
15047b665727SPierre Jolivet       PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z));
15057b665727SPierre Jolivet     }
15067b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
15077b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
15087b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
15097b665727SPierre Jolivet   }
15107b665727SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
15117b665727SPierre Jolivet }
15127b665727SPierre Jolivet 
1513d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit(PC pc, Vec x, Vec y)
1514d71ae5a4SJacob Faibussowitsch {
15150971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
15165a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
1517939b8a20SBarry Smith   PetscInt          cnt, bs;
15180971522cSBarry Smith 
15190971522cSBarry Smith   PetscFunctionBegin;
152079416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
152180670ca5SBarry Smith     PetscBool matnest;
152280670ca5SBarry Smith 
152380670ca5SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest));
152480670ca5SBarry Smith     if (jac->defaultsplit && !matnest) {
15259566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
15262472a847SBarry 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);
15279566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
15282472a847SBarry 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);
15299566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
15305a9f2f41SSatish Balay       while (ilink) {
15319566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15329566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
15339566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
15349566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15355a9f2f41SSatish Balay         ilink = ilink->next;
15360971522cSBarry Smith       }
15379566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
15381b9fc7fcSBarry Smith     } else {
15399566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
15405a9f2f41SSatish Balay       while (ilink) {
15419566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
15425a9f2f41SSatish Balay         ilink = ilink->next;
15431b9fc7fcSBarry Smith       }
15441b9fc7fcSBarry Smith     }
1545e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
15469566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1547e52d2c62SBarry Smith     /* solve on first block for first block variables */
15489566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
15499566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
15509566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15519566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
15529566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
15539566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15549566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
15559566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
1556e52d2c62SBarry Smith 
1557e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
15589566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->Afield[1], ilink->y, ilink->next->x));
1559e52d2c62SBarry Smith     ilink = ilink->next;
15609566063dSJacob Faibussowitsch     PetscCall(VecScale(ilink->x, -1.0));
15619566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
15629566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
1563e52d2c62SBarry Smith 
1564e52d2c62SBarry Smith     /* solve on second block variables */
15659566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15669566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
15679566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
15689566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15699566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
15709566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
157116913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
157279416396SBarry Smith     if (!jac->w1) {
15739566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
15749566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
157579416396SBarry Smith     }
15769566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
15779566063dSJacob Faibussowitsch     PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
15783e197d65SBarry Smith     cnt = 1;
15795a9f2f41SSatish Balay     while (ilink->next) {
15805a9f2f41SSatish Balay       ilink = ilink->next;
15813e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
15829566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->Afield[cnt++], y, ilink->x));
15839566063dSJacob Faibussowitsch       PetscCall(VecScale(ilink->x, -1.0));
15849566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
15859566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
15869566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15879566063dSJacob Faibussowitsch       PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
15889566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
15899566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15909566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
15919566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
15923e197d65SBarry Smith     }
159351f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
159411755939SBarry Smith       cnt -= 2;
159551f519a2SBarry Smith       while (ilink->previous) {
159651f519a2SBarry Smith         ilink = ilink->previous;
159711755939SBarry Smith         /* compute the residual only over the part of the vector needed */
15989566063dSJacob Faibussowitsch         PetscCall(MatMult(jac->Afield[cnt--], y, ilink->x));
15999566063dSJacob Faibussowitsch         PetscCall(VecScale(ilink->x, -1.0));
16009566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
16019566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
16029566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
16039566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
16049566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
16059566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
16069566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
16079566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
160851f519a2SBarry Smith       }
160911755939SBarry Smith     }
161063a3b9bcSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Unsupported or unknown composition %d", (int)jac->type);
16113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
16120971522cSBarry Smith }
16130971522cSBarry Smith 
1614d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_GKB(PC pc, Vec x, Vec y)
1615d71ae5a4SJacob Faibussowitsch {
1616a51937d4SCarola Kruse   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
1617a51937d4SCarola Kruse   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1618a51937d4SCarola Kruse   KSP               ksp = ilinkA->ksp;
1619de482cd7SCarola Kruse   Vec               u, v, Hu, d, work1, work2;
1620e071a0a4SCarola Kruse   PetscScalar       alpha, z, nrmz2, *vecz;
1621e071a0a4SCarola Kruse   PetscReal         lowbnd, nu, beta;
1622a51937d4SCarola Kruse   PetscInt          j, iterGKB;
1623a51937d4SCarola Kruse 
1624a51937d4SCarola Kruse   PetscFunctionBegin;
16259566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
16269566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
16279566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
16289566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
1629e071a0a4SCarola Kruse 
1630e071a0a4SCarola Kruse   u     = jac->u;
1631e071a0a4SCarola Kruse   v     = jac->v;
1632e071a0a4SCarola Kruse   Hu    = jac->Hu;
1633e071a0a4SCarola Kruse   d     = jac->d;
1634e071a0a4SCarola Kruse   work1 = jac->w1;
1635e071a0a4SCarola Kruse   work2 = jac->w2;
1636e071a0a4SCarola Kruse   vecz  = jac->vecz;
1637a51937d4SCarola Kruse 
1638a51937d4SCarola Kruse   /* Change RHS to comply with matrix regularization H = A + nu*B*B' */
1639a51937d4SCarola Kruse   /* Add q = q + nu*B*b */
1640a51937d4SCarola Kruse   if (jac->gkbnu) {
1641a51937d4SCarola Kruse     nu = jac->gkbnu;
16429566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, jac->gkbnu));
16439566063dSJacob Faibussowitsch     PetscCall(MatMultAdd(jac->B, ilinkD->x, ilinkA->x, ilinkA->x)); /* q = q + nu*B*b */
1644a51937d4SCarola Kruse   } else {
1645a51937d4SCarola Kruse     /* Situation when no augmented Lagrangian is used. Then we set inner  */
1646a51937d4SCarola Kruse     /* matrix N = I in [Ar13], and thus nu = 1.                           */
1647a51937d4SCarola Kruse     nu = 1;
1648a51937d4SCarola Kruse   }
1649a51937d4SCarola Kruse 
1650a51937d4SCarola Kruse   /* Transform rhs from [q,tilde{b}] to [0,b] */
16519566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
16529566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, ilinkA->x, ilinkA->y));
16539566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, ilinkA->y));
16549566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
16559566063dSJacob Faibussowitsch   PetscCall(MatMultHermitianTranspose(jac->B, ilinkA->y, work1));
16569566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(work1, 1.0 / nu, -1.0, ilinkD->x)); /* c = b - B'*x        */
1657a51937d4SCarola Kruse 
1658a51937d4SCarola Kruse   /* First step of algorithm */
16599566063dSJacob Faibussowitsch   PetscCall(VecNorm(work1, NORM_2, &beta)); /* beta = sqrt(nu*c'*c)*/
1660e071a0a4SCarola Kruse   KSPCheckDot(ksp, beta);
1661addd1e01SJunchao Zhang   beta = PetscSqrtReal(nu) * beta;
16629566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(v, nu / beta, 0.0, work1)); /* v = nu/beta *c      */
16639566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->B, v, work2));          /* u = H^{-1}*B*v      */
16649566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
16659566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, work2, u));
16669566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, u));
16679566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
16689566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u      */
16699566063dSJacob Faibussowitsch   PetscCall(VecDot(Hu, u, &alpha));
1670e071a0a4SCarola Kruse   KSPCheckDot(ksp, alpha);
167108401ef6SPierre Jolivet   PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1672addd1e01SJunchao Zhang   alpha = PetscSqrtReal(PetscAbsScalar(alpha));
16739566063dSJacob Faibussowitsch   PetscCall(VecScale(u, 1.0 / alpha));
16749566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(d, 1.0 / alpha, 0.0, v)); /* v = nu/beta *c      */
1675de482cd7SCarola Kruse 
1676a51937d4SCarola Kruse   z       = beta / alpha;
1677a51937d4SCarola Kruse   vecz[1] = z;
1678a51937d4SCarola Kruse 
1679de482cd7SCarola Kruse   /* Computation of first iterate x(1) and p(1) */
16809566063dSJacob Faibussowitsch   PetscCall(VecAXPY(ilinkA->y, z, u));
16819566063dSJacob Faibussowitsch   PetscCall(VecCopy(d, ilinkD->y));
16829566063dSJacob Faibussowitsch   PetscCall(VecScale(ilinkD->y, -z));
1683a51937d4SCarola Kruse 
16849371c9d4SSatish Balay   iterGKB = 1;
16859371c9d4SSatish Balay   lowbnd  = 2 * jac->gkbtol;
168648a46eb9SPierre Jolivet   if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1687de482cd7SCarola Kruse 
1688a51937d4SCarola Kruse   while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) {
1689a51937d4SCarola Kruse     iterGKB += 1;
16909566063dSJacob Faibussowitsch     PetscCall(MatMultHermitianTranspose(jac->B, u, work1)); /* v <- nu*(B'*u-alpha/nu*v) */
16919566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(v, nu, -alpha, work1));
16929566063dSJacob Faibussowitsch     PetscCall(VecNorm(v, NORM_2, &beta)); /* beta = sqrt(nu)*v'*v      */
1693addd1e01SJunchao Zhang     beta = beta / PetscSqrtReal(nu);
16949566063dSJacob Faibussowitsch     PetscCall(VecScale(v, 1.0 / beta));
16959566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->B, v, work2)); /* u <- H^{-1}*(B*v-beta*H*u) */
16969566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu));
16979566063dSJacob Faibussowitsch     PetscCall(VecAXPY(work2, -beta, Hu));
16989566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
16999566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ksp, work2, u));
17009566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ksp, pc, u));
17019566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
17029566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u            */
17039566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, u, &alpha));
1704e071a0a4SCarola Kruse     KSPCheckDot(ksp, alpha);
170508401ef6SPierre Jolivet     PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1706addd1e01SJunchao Zhang     alpha = PetscSqrtReal(PetscAbsScalar(alpha));
17079566063dSJacob Faibussowitsch     PetscCall(VecScale(u, 1.0 / alpha));
1708a51937d4SCarola Kruse 
1709e071a0a4SCarola Kruse     z       = -beta / alpha * z; /* z <- beta/alpha*z     */
1710a51937d4SCarola Kruse     vecz[0] = z;
1711a51937d4SCarola Kruse 
1712a51937d4SCarola Kruse     /* Computation of new iterate x(i+1) and p(i+1) */
17139566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(d, 1.0 / alpha, -beta / alpha, v)); /* d = (v-beta*d)/alpha */
17149566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkA->y, z, u));                   /* r = r + z*u          */
17159566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkD->y, -z, d));                  /* p = p - z*d          */
17169566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, ilinkA->y, Hu));             /* ||u||_H = u'*H*u     */
17179566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, ilinkA->y, &nrmz2));
1718a51937d4SCarola Kruse 
1719a51937d4SCarola Kruse     /* Compute Lower Bound estimate */
1720a51937d4SCarola Kruse     if (iterGKB > jac->gkbdelay) {
1721a51937d4SCarola Kruse       lowbnd = 0.0;
1722ad540459SPierre Jolivet       for (j = 0; j < jac->gkbdelay; j++) lowbnd += PetscAbsScalar(vecz[j] * vecz[j]);
1723addd1e01SJunchao Zhang       lowbnd = PetscSqrtReal(lowbnd / PetscAbsScalar(nrmz2));
1724a51937d4SCarola Kruse     }
1725a51937d4SCarola Kruse 
1726ad540459SPierre Jolivet     for (j = 0; j < jac->gkbdelay - 1; j++) vecz[jac->gkbdelay - j - 1] = vecz[jac->gkbdelay - j - 2];
172748a46eb9SPierre Jolivet     if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1728a51937d4SCarola Kruse   }
1729a51937d4SCarola Kruse 
17309566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
17319566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
17329566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
17339566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
17343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1735a51937d4SCarola Kruse }
1736a51937d4SCarola Kruse 
1737421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink, xx, yy) \
17383ba16761SJacob 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) || \
17399371c9d4SSatish 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) || \
17403ba16761SJacob Faibussowitsch                     VecScatterEnd(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE)))
1741421e10b8SBarry Smith 
1742d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc, Vec x, Vec y)
1743d71ae5a4SJacob Faibussowitsch {
1744421e10b8SBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
1745421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1746939b8a20SBarry Smith   PetscInt          bs;
1747421e10b8SBarry Smith 
1748421e10b8SBarry Smith   PetscFunctionBegin;
1749421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
175080670ca5SBarry Smith     PetscBool matnest;
175180670ca5SBarry Smith 
175280670ca5SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest));
175380670ca5SBarry Smith     if (jac->defaultsplit && !matnest) {
17549566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
17552472a847SBarry 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);
17569566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
17572472a847SBarry 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);
17589566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
1759421e10b8SBarry Smith       while (ilink) {
17609566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
17619566063dSJacob Faibussowitsch         PetscCall(KSPSolveTranspose(ilink->ksp, ilink->x, ilink->y));
17629566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
17639566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
1764421e10b8SBarry Smith         ilink = ilink->next;
1765421e10b8SBarry Smith       }
17669566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
1767421e10b8SBarry Smith     } else {
17689566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
1769421e10b8SBarry Smith       while (ilink) {
17709566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1771421e10b8SBarry Smith         ilink = ilink->next;
1772421e10b8SBarry Smith       }
1773421e10b8SBarry Smith     }
1774421e10b8SBarry Smith   } else {
1775421e10b8SBarry Smith     if (!jac->w1) {
17769566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
17779566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
1778421e10b8SBarry Smith     }
17799566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1780421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
17819566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1782421e10b8SBarry Smith       while (ilink->next) {
1783421e10b8SBarry Smith         ilink = ilink->next;
17849566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
17859566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
17869566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1787421e10b8SBarry Smith       }
1788421e10b8SBarry Smith       while (ilink->previous) {
1789421e10b8SBarry Smith         ilink = ilink->previous;
17909566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
17919566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
17929566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1793421e10b8SBarry Smith       }
1794421e10b8SBarry Smith     } else {
1795421e10b8SBarry Smith       while (ilink->next) { /* get to last entry in linked list */
1796421e10b8SBarry Smith         ilink = ilink->next;
1797421e10b8SBarry Smith       }
17989566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1799421e10b8SBarry Smith       while (ilink->previous) {
1800421e10b8SBarry Smith         ilink = ilink->previous;
18019566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
18029566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
18039566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1804421e10b8SBarry Smith       }
1805421e10b8SBarry Smith     }
1806421e10b8SBarry Smith   }
18073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1808421e10b8SBarry Smith }
1809421e10b8SBarry Smith 
1810d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_FieldSplit(PC pc)
1811d71ae5a4SJacob Faibussowitsch {
18120971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
18135a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head, next;
18140971522cSBarry Smith 
18150971522cSBarry Smith   PetscFunctionBegin;
18165a9f2f41SSatish Balay   while (ilink) {
18179566063dSJacob Faibussowitsch     PetscCall(KSPDestroy(&ilink->ksp));
18189566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->x));
18199566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->y));
18209566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->z));
18219566063dSJacob Faibussowitsch     PetscCall(VecScatterDestroy(&ilink->sctx));
18229566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
18239566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
18249566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->splitname));
18259566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields));
18269566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields_col));
18275a9f2f41SSatish Balay     next = ilink->next;
18289566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink));
18295a9f2f41SSatish Balay     ilink = next;
18300971522cSBarry Smith   }
1831f5f0d762SBarry Smith   jac->head = NULL;
18329566063dSJacob Faibussowitsch   PetscCall(PetscFree2(jac->x, jac->y));
1833574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
18349566063dSJacob Faibussowitsch     PetscCall(MatDestroyMatrices(jac->nsplits, &jac->mat));
1835574deadeSBarry Smith   } else if (jac->mat) {
18360298fd71SBarry Smith     jac->mat = NULL;
1837574deadeSBarry Smith   }
18389566063dSJacob Faibussowitsch   if (jac->pmat) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->pmat));
18399566063dSJacob Faibussowitsch   if (jac->Afield) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->Afield));
1840f5f0d762SBarry Smith   jac->nsplits = 0;
18419566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w1));
18429566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w2));
184373716367SStefano Zampini   if (jac->schur) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "AinvB", NULL));
18449566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur));
18459566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schurp));
18469566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur_user));
18479566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspschur));
18489566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspupper));
18499566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->B));
18509566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->C));
18519566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->H));
18529566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->u));
18539566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->v));
18549566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->Hu));
18559566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->d));
18569566063dSJacob Faibussowitsch   PetscCall(PetscFree(jac->vecz));
18579566063dSJacob Faibussowitsch   PetscCall(PetscViewerDestroy(&jac->gkbviewer));
18586dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
18593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1860574deadeSBarry Smith }
1861574deadeSBarry Smith 
1862d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1863d71ae5a4SJacob Faibussowitsch {
1864574deadeSBarry Smith   PetscFunctionBegin;
18659566063dSJacob Faibussowitsch   PetscCall(PCReset_FieldSplit(pc));
18669566063dSJacob Faibussowitsch   PetscCall(PetscFree(pc->data));
18672e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", NULL));
18689566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", NULL));
18699566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", NULL));
18709566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", NULL));
18719566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", NULL));
18722e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", NULL));
18732e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", NULL));
18742e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
18752e956fe4SStefano Zampini 
18762e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
18772e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
18782e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
18792e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
18802e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
18819566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
18829566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
18839566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
18842e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
18853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
18860971522cSBarry Smith }
18870971522cSBarry Smith 
1888d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc, PetscOptionItems *PetscOptionsObject)
1889d71ae5a4SJacob Faibussowitsch {
18906c924f48SJed Brown   PetscInt        bs;
18917b752e3dSPatrick Sanan   PetscBool       flg;
18929dcbbd2bSBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit *)pc->data;
18933b224e63SBarry Smith   PCCompositeType ctype;
18941b9fc7fcSBarry Smith 
18950971522cSBarry Smith   PetscFunctionBegin;
1896d0609cedSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "FieldSplit options");
18979566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_dm_splits", "Whether to use DMCreateFieldDecomposition() for splits", "PCFieldSplitSetDMSplits", jac->dm_splits, &jac->dm_splits, NULL));
18989566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-pc_fieldsplit_block_size", "Blocksize that defines number of fields", "PCFieldSplitSetBlockSize", jac->bs, &bs, &flg));
18991baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetBlockSize(pc, bs));
19002686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
19019566063dSJacob 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));
19022686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
19039566063dSJacob 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));
19049566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_detect_saddle_point", "Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint", jac->detect, &jac->detect, NULL));
19059566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDetectSaddlePoint(pc, jac->detect)); /* Sets split type and Schur PC type */
19069566063dSJacob Faibussowitsch   PetscCall(PetscOptionsEnum("-pc_fieldsplit_type", "Type of composition", "PCFieldSplitSetType", PCCompositeTypes, (PetscEnum)jac->type, (PetscEnum *)&ctype, &flg));
19071baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetType(pc, ctype));
1908c30613efSMatthew Knepley   /* Only setup fields once */
1909c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
191080670ca5SBarry Smith     /* only allow user to set fields from command line.
1911d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
19129566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
19139566063dSJacob Faibussowitsch     if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
1914d32f9abdSBarry Smith   }
1915c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
19169566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_schur_factorization_type", PCFieldSplitSchurFactTypes, (PetscEnum *)&jac->schurfactorization, &flg));
19179566063dSJacob Faibussowitsch     if (flg) PetscCall(PetscInfo(pc, "Deprecated use of -pc_fieldsplit_schur_factorization_type\n"));
19189566063dSJacob 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));
19199566063dSJacob Faibussowitsch     PetscCall(PetscOptionsEnum("-pc_fieldsplit_schur_precondition", "How to build preconditioner for Schur complement", "PCFieldSplitSetSchurPre", PCFieldSplitSchurPreTypes, (PetscEnum)jac->schurpre, (PetscEnum *)&jac->schurpre, NULL));
19209566063dSJacob Faibussowitsch     PetscCall(PetscOptionsScalar("-pc_fieldsplit_schur_scale", "Scale Schur complement", "PCFieldSplitSetSchurScale", jac->schurscale, &jac->schurscale, NULL));
1921a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1922a077d33dSBarry Smith     PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_tol", "The tolerance for the lower bound stopping criterion", "PCFieldSplitSetGKBTol", jac->gkbtol, &jac->gkbtol, NULL));
1923a077d33dSBarry Smith     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_delay", "The delay value for lower bound criterion", "PCFieldSplitSetGKBDelay", jac->gkbdelay, &jac->gkbdelay, NULL));
1924a077d33dSBarry Smith     PetscCall(PetscOptionsBoundedReal("-pc_fieldsplit_gkb_nu", "Parameter in augmented Lagrangian approach", "PCFieldSplitSetGKBNu", jac->gkbnu, &jac->gkbnu, NULL, 0.0));
1925a077d33dSBarry Smith     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_maxit", "Maximum allowed number of iterations", "PCFieldSplitSetGKBMaxit", jac->gkbmaxit, &jac->gkbmaxit, NULL));
19269566063dSJacob Faibussowitsch     PetscCall(PetscOptionsBool("-pc_fieldsplit_gkb_monitor", "Prints number of GKB iterations and error", "PCFieldSplitGKB", jac->gkbmonitor, &jac->gkbmonitor, NULL));
1927c5d2311dSJed Brown   }
192834603f55SBarry Smith   /*
192934603f55SBarry Smith     In the initial call to this routine the sub-solver data structures do not exist so we cannot call KSPSetFromOptions() on them yet.
193034603f55SBarry 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
193134603f55SBarry Smith     is called on the outer solver in case changes were made in the options database
193234603f55SBarry Smith 
193334603f55SBarry 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()
193434603f55SBarry 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.
193534603f55SBarry Smith     Without this extra check test p2p1fetidp_olof_full and others fail with incorrect matrix types.
193634603f55SBarry Smith 
193734603f55SBarry Smith     There could be a negative side effect of calling the KSPSetFromOptions() below.
193834603f55SBarry Smith 
193934603f55SBarry 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
194034603f55SBarry Smith   */
194134603f55SBarry Smith   if (jac->issetup) {
194234603f55SBarry Smith     PC_FieldSplitLink ilink = jac->head;
194334603f55SBarry Smith     if (jac->type == PC_COMPOSITE_SCHUR) {
194434603f55SBarry Smith       if (jac->kspupper && jac->kspupper->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspupper));
194534603f55SBarry Smith       if (jac->kspschur && jac->kspschur->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspschur));
194634603f55SBarry Smith     }
194734603f55SBarry Smith     while (ilink) {
194834603f55SBarry Smith       if (ilink->ksp->totalits > 0) PetscCall(KSPSetFromOptions(ilink->ksp));
194934603f55SBarry Smith       ilink = ilink->next;
195034603f55SBarry Smith     }
195134603f55SBarry Smith   }
1952d0609cedSBarry Smith   PetscOptionsHeadEnd();
19533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19540971522cSBarry Smith }
19550971522cSBarry Smith 
1956d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col)
1957d71ae5a4SJacob Faibussowitsch {
195897bbdb24SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
19595a9f2f41SSatish Balay   PC_FieldSplitLink ilink, next = jac->head;
196069a612a9SBarry Smith   char              prefix[128];
19615d4c12cdSJungho Lee   PetscInt          i;
19620971522cSBarry Smith 
19630971522cSBarry Smith   PetscFunctionBegin;
19646c924f48SJed Brown   if (jac->splitdefined) {
19659566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
19663ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
19676c924f48SJed Brown   }
196880670ca5SBarry 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]); }
19699566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
1970a04f6461SBarry Smith   if (splitname) {
19719566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
1972a04f6461SBarry Smith   } else {
19739566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(3, &ilink->splitname));
197463a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 2, "%" PetscInt_FMT, jac->nsplits));
1975a04f6461SBarry Smith   }
1976*6497c311SBarry Smith   ilink->event = jac->nsplits < 5 ? (PetscLogEvent)(KSP_Solve_FS_0 + jac->nsplits) : (PetscLogEvent)(KSP_Solve_FS_0 + 4); /* Splits greater than 4 logged in 4th split */
19779566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields));
19789566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields, fields, n));
19799566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields_col));
19809566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields_col, fields_col, n));
19812fa5cd67SKarl Rupp 
19825a9f2f41SSatish Balay   ilink->nfields = n;
19830298fd71SBarry Smith   ilink->next    = NULL;
19849566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
19853821be0aSBarry Smith   PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel));
19869566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
19879566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
19889566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
198969a612a9SBarry Smith 
19909566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
19919566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
19920971522cSBarry Smith 
19930971522cSBarry Smith   if (!next) {
19945a9f2f41SSatish Balay     jac->head       = ilink;
19950298fd71SBarry Smith     ilink->previous = NULL;
19960971522cSBarry Smith   } else {
1997ad540459SPierre Jolivet     while (next->next) next = next->next;
19985a9f2f41SSatish Balay     next->next      = ilink;
199951f519a2SBarry Smith     ilink->previous = next;
20000971522cSBarry Smith   }
20010971522cSBarry Smith   jac->nsplits++;
20023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20030971522cSBarry Smith }
20040971522cSBarry Smith 
2005d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp)
2006d71ae5a4SJacob Faibussowitsch {
2007285fb4e2SStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2008285fb4e2SStefano Zampini 
2009285fb4e2SStefano Zampini   PetscFunctionBegin;
2010285fb4e2SStefano Zampini   *subksp = NULL;
2011285fb4e2SStefano Zampini   if (n) *n = 0;
2012285fb4e2SStefano Zampini   if (jac->type == PC_COMPOSITE_SCHUR) {
2013285fb4e2SStefano Zampini     PetscInt nn;
2014285fb4e2SStefano Zampini 
201528b400f6SJacob Faibussowitsch     PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()");
201663a3b9bcSJacob Faibussowitsch     PetscCheck(jac->nsplits == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unexpected number of splits %" PetscInt_FMT " != 2", jac->nsplits);
2017285fb4e2SStefano Zampini     nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0);
20189566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nn, subksp));
2019285fb4e2SStefano Zampini     (*subksp)[0] = jac->head->ksp;
2020285fb4e2SStefano Zampini     (*subksp)[1] = jac->kspschur;
2021285fb4e2SStefano Zampini     if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper;
2022285fb4e2SStefano Zampini     if (n) *n = nn;
2023285fb4e2SStefano Zampini   }
20243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2025285fb4e2SStefano Zampini }
2026285fb4e2SStefano Zampini 
2027d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc, PetscInt *n, KSP **subksp)
2028d71ae5a4SJacob Faibussowitsch {
2029e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2030e69d4d44SBarry Smith 
2031e69d4d44SBarry Smith   PetscFunctionBegin;
203228b400f6SJacob Faibussowitsch   PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
20339566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
20349566063dSJacob Faibussowitsch   PetscCall(MatSchurComplementGetKSP(jac->schur, *subksp));
20352fa5cd67SKarl Rupp 
2036e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
203713e0d083SBarry Smith   if (n) *n = jac->nsplits;
20383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2039e69d4d44SBarry Smith }
20400971522cSBarry Smith 
2041d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp)
2042d71ae5a4SJacob Faibussowitsch {
20430971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
20440971522cSBarry Smith   PetscInt          cnt   = 0;
20455a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
20460971522cSBarry Smith 
20470971522cSBarry Smith   PetscFunctionBegin;
20489566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
20495a9f2f41SSatish Balay   while (ilink) {
20505a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
20515a9f2f41SSatish Balay     ilink            = ilink->next;
20520971522cSBarry Smith   }
205363a3b9bcSJacob 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);
205413e0d083SBarry Smith   if (n) *n = jac->nsplits;
20553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20560971522cSBarry Smith }
20570971522cSBarry Smith 
2058cc4c1da9SBarry Smith /*@
2059f1580f4eSBarry Smith   PCFieldSplitRestrictIS - Restricts the fieldsplit `IS`s to be within a given `IS`.
20606dbb499eSCian Wilson 
20616dbb499eSCian Wilson   Input Parameters:
20626dbb499eSCian Wilson + pc  - the preconditioner context
2063feefa0e1SJacob Faibussowitsch - isy - the index set that defines the indices to which the fieldsplit is to be restricted
20646dbb499eSCian Wilson 
20656dbb499eSCian Wilson   Level: advanced
20666dbb499eSCian Wilson 
2067feefa0e1SJacob Faibussowitsch   Developer Notes:
2068f1580f4eSBarry Smith   It seems the resulting `IS`s will not cover the entire space, so
2069f1580f4eSBarry Smith   how can they define a convergent preconditioner? Needs explaining.
2070f1580f4eSBarry Smith 
207160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
20726dbb499eSCian Wilson @*/
2073d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitRestrictIS(PC pc, IS isy)
2074d71ae5a4SJacob Faibussowitsch {
20756dbb499eSCian Wilson   PetscFunctionBegin;
20766dbb499eSCian Wilson   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
20776dbb499eSCian Wilson   PetscValidHeaderSpecific(isy, IS_CLASSID, 2);
2078cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitRestrictIS_C", (PC, IS), (pc, isy));
20793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20806dbb499eSCian Wilson }
20816dbb499eSCian Wilson 
2082d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
2083d71ae5a4SJacob Faibussowitsch {
20846dbb499eSCian Wilson   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
20856dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
20866dbb499eSCian Wilson   PetscInt          localsize, size, sizez, i;
20876dbb499eSCian Wilson   const PetscInt   *ind, *indz;
20886dbb499eSCian Wilson   PetscInt         *indc, *indcz;
20896dbb499eSCian Wilson   PetscBool         flg;
20906dbb499eSCian Wilson 
20916dbb499eSCian Wilson   PetscFunctionBegin;
20929566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(isy, &localsize));
20939566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&localsize, &size, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)isy)));
20946dbb499eSCian Wilson   size -= localsize;
20956dbb499eSCian Wilson   while (ilink) {
20966dbb499eSCian Wilson     IS isrl, isr;
20971c7cfba8SBarry Smith     PC subpc;
20989566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl));
20999566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(isrl, &localsize));
21009566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(localsize, &indc));
21019566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(isrl, &ind));
21029566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(indc, ind, localsize));
21039566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(isrl, &ind));
21049566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isrl));
21056dbb499eSCian Wilson     for (i = 0; i < localsize; i++) *(indc + i) += size;
21069566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)isy), localsize, indc, PETSC_OWN_POINTER, &isr));
21079566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
21089566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
21096dbb499eSCian Wilson     ilink->is = isr;
21109566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
21119566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
21126dbb499eSCian Wilson     ilink->is_col = isr;
21139566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isr));
21149566063dSJacob Faibussowitsch     PetscCall(KSPGetPC(ilink->ksp, &subpc));
21159566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)subpc, PCFIELDSPLIT, &flg));
21166dbb499eSCian Wilson     if (flg) {
21176dbb499eSCian Wilson       IS       iszl, isz;
21186dbb499eSCian Wilson       MPI_Comm comm;
21199566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(ilink->is, &localsize));
21206dbb499eSCian Wilson       comm = PetscObjectComm((PetscObject)ilink->is);
21219566063dSJacob Faibussowitsch       PetscCall(ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl));
21229566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Scan(&localsize, &sizez, 1, MPIU_INT, MPI_SUM, comm));
21236dbb499eSCian Wilson       sizez -= localsize;
21249566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(iszl, &localsize));
21259566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(localsize, &indcz));
21269566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(iszl, &indz));
21279566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(indcz, indz, localsize));
21289566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(iszl, &indz));
21299566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&iszl));
21306dbb499eSCian Wilson       for (i = 0; i < localsize; i++) *(indcz + i) += sizez;
21319566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(comm, localsize, indcz, PETSC_OWN_POINTER, &isz));
21329566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitRestrictIS(subpc, isz));
21339566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&isz));
21346dbb499eSCian Wilson     }
21356dbb499eSCian Wilson     next  = ilink->next;
21366dbb499eSCian Wilson     ilink = next;
21376dbb499eSCian Wilson   }
21386dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
21393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21406dbb499eSCian Wilson }
21416dbb499eSCian Wilson 
2142d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc, const char splitname[], IS is)
2143d71ae5a4SJacob Faibussowitsch {
2144704ba839SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
2145704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
2146704ba839SBarry Smith   char              prefix[128];
2147704ba839SBarry Smith 
2148704ba839SBarry Smith   PetscFunctionBegin;
21496c924f48SJed Brown   if (jac->splitdefined) {
21509566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
21513ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
21526c924f48SJed Brown   }
21539566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
2154a04f6461SBarry Smith   if (splitname) {
21559566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
2156a04f6461SBarry Smith   } else {
21579566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(8, &ilink->splitname));
215863a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 7, "%" PetscInt_FMT, jac->nsplits));
2159a04f6461SBarry Smith   }
2160*6497c311SBarry Smith   ilink->event = jac->nsplits < 5 ? (PetscLogEvent)(KSP_Solve_FS_0 + jac->nsplits) : (PetscLogEvent)(KSP_Solve_FS_0 + 4); /* Splits greater than 4 logged in 4th split */
21619566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
21629566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is));
2163b5787286SJed Brown   ilink->is = is;
21649566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
21659566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is_col));
2166b5787286SJed Brown   ilink->is_col = is;
21670298fd71SBarry Smith   ilink->next   = NULL;
21689566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
21693821be0aSBarry Smith   PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel));
21709566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
21719566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
21729566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
2173704ba839SBarry Smith 
21749566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
21759566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
2176704ba839SBarry Smith 
2177704ba839SBarry Smith   if (!next) {
2178704ba839SBarry Smith     jac->head       = ilink;
21790298fd71SBarry Smith     ilink->previous = NULL;
2180704ba839SBarry Smith   } else {
2181ad540459SPierre Jolivet     while (next->next) next = next->next;
2182704ba839SBarry Smith     next->next      = ilink;
2183704ba839SBarry Smith     ilink->previous = next;
2184704ba839SBarry Smith   }
2185704ba839SBarry Smith   jac->nsplits++;
21863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2187704ba839SBarry Smith }
2188704ba839SBarry Smith 
21895d83a8b1SBarry Smith /*@
219060f59c3bSBarry Smith   PCFieldSplitSetFields - Sets the fields that define one particular split in `PCFIELDSPLIT`
21910971522cSBarry Smith 
2192c3339decSBarry Smith   Logically Collective
21930971522cSBarry Smith 
21940971522cSBarry Smith   Input Parameters:
21950971522cSBarry Smith + pc         - the preconditioner context
219660f59c3bSBarry Smith . splitname  - name of this split, if `NULL` the number of the split is used
21970971522cSBarry Smith . n          - the number of fields in this split
21983b374dbdSBarry Smith . fields     - the fields in this split
219980670ca5SBarry 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
220080670ca5SBarry Smith                of the matrix and `fields_col` provides the column indices for that block
220180670ca5SBarry Smith 
220280670ca5SBarry Smith   Options Database Key:
220380670ca5SBarry Smith . -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the `%d`'th split
22040971522cSBarry Smith 
22050971522cSBarry Smith   Level: intermediate
22060971522cSBarry Smith 
220795452b02SPatrick Sanan   Notes:
2208f1580f4eSBarry Smith   Use `PCFieldSplitSetIS()` to set a  general set of indices as a split.
2209d32f9abdSBarry Smith 
221080670ca5SBarry Smith   If the matrix used to construct the preconditioner is `MATNEST` then field i refers to the `is_row[i]` `IS` passed to `MatCreateNest()`.
221180670ca5SBarry Smith 
221280670ca5SBarry Smith   If the matrix used to construct the preconditioner is not `MATNEST` then
221380670ca5SBarry Smith   `PCFieldSplitSetFields()` is for defining fields as strided blocks (based on the block size provided to the matrix with `MatSetBlocksize()` or
221480670ca5SBarry Smith   to the `PC` with `PCFieldSplitSetBlockSize()`). For example, if the block
2215f1580f4eSBarry 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
2216d32f9abdSBarry Smith   0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
2217f1580f4eSBarry Smith   where the numbered entries indicate what is in the split.
2218d32f9abdSBarry Smith 
2219db4c96c1SJed Brown   This function is called once per split (it creates a new split each time).  Solve options
222060f59c3bSBarry Smith   for this split will be available under the prefix `-fieldsplit_SPLITNAME_`.
2221db4c96c1SJed Brown 
222280670ca5SBarry Smith   `PCFieldSplitSetIS()` does not support having a `fields_col` different from `fields`
22233b374dbdSBarry Smith 
2224feefa0e1SJacob Faibussowitsch   Developer Notes:
2225f1580f4eSBarry Smith   This routine does not actually create the `IS` representing the split, that is delayed
2226f1580f4eSBarry Smith   until `PCSetUp_FieldSplit()`, because information about the vector/matrix layouts may not be
22275d4c12cdSJungho Lee   available when this routine is called.
22285d4c12cdSJungho Lee 
222980670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetIS()`, `PCFieldSplitRestrictIS()`,
223080670ca5SBarry Smith           `MatSetBlocksize()`, `MatCreateNest()`
22310971522cSBarry Smith @*/
2232cc4c1da9SBarry Smith PetscErrorCode PCFieldSplitSetFields(PC pc, const char splitname[], PetscInt n, const PetscInt fields[], const PetscInt fields_col[])
2233d71ae5a4SJacob Faibussowitsch {
22340971522cSBarry Smith   PetscFunctionBegin;
22350700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22364f572ea9SToby Isaac   PetscAssertPointer(splitname, 2);
223763a3b9bcSJacob Faibussowitsch   PetscCheck(n >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Provided number of fields %" PetscInt_FMT " in split \"%s\" not positive", n, splitname);
22384f572ea9SToby Isaac   PetscAssertPointer(fields, 4);
2239cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetFields_C", (PC, const char[], PetscInt, const PetscInt *, const PetscInt *), (pc, splitname, n, fields, fields_col));
22403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22410971522cSBarry Smith }
22420971522cSBarry Smith 
2243c84da90fSDmitry Karpeev /*@
2244f1580f4eSBarry Smith   PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build
2245c14e9f00SDavid Andrs   the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2246c84da90fSDmitry Karpeev 
2247c3339decSBarry Smith   Logically Collective
2248c84da90fSDmitry Karpeev 
2249c84da90fSDmitry Karpeev   Input Parameters:
2250c84da90fSDmitry Karpeev + pc  - the preconditioner object
2251c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
2252c84da90fSDmitry Karpeev 
225320f4b53cSBarry Smith   Options Database Key:
2254147403d9SBarry Smith . -pc_fieldsplit_diag_use_amat - use the Amat to provide the diagonal blocks
2255c84da90fSDmitry Karpeev 
2256c84da90fSDmitry Karpeev   Level: intermediate
2257c84da90fSDmitry Karpeev 
225860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetDiagUseAmat()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFIELDSPLIT`
2259c84da90fSDmitry Karpeev @*/
2260d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc, PetscBool flg)
2261d71ae5a4SJacob Faibussowitsch {
2262c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2263c84da90fSDmitry Karpeev   PetscBool      isfs;
2264c84da90fSDmitry Karpeev 
2265c84da90fSDmitry Karpeev   PetscFunctionBegin;
2266c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22679566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
226828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2269c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
22703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2271c84da90fSDmitry Karpeev }
2272c84da90fSDmitry Karpeev 
2273c84da90fSDmitry Karpeev /*@
2274f1580f4eSBarry Smith   PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build
2275c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2276c84da90fSDmitry Karpeev 
2277c3339decSBarry Smith   Logically Collective
2278c84da90fSDmitry Karpeev 
227920f4b53cSBarry Smith   Input Parameter:
2280c84da90fSDmitry Karpeev . pc - the preconditioner object
2281c84da90fSDmitry Karpeev 
228220f4b53cSBarry Smith   Output Parameter:
2283c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
2284c84da90fSDmitry Karpeev 
2285c84da90fSDmitry Karpeev   Level: intermediate
2286c84da90fSDmitry Karpeev 
228760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetDiagUseAmat()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFIELDSPLIT`
2288c84da90fSDmitry Karpeev @*/
2289d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc, PetscBool *flg)
2290d71ae5a4SJacob Faibussowitsch {
2291c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2292c84da90fSDmitry Karpeev   PetscBool      isfs;
2293c84da90fSDmitry Karpeev 
2294c84da90fSDmitry Karpeev   PetscFunctionBegin;
2295c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22964f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
22979566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
229828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2299c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
23003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2301c84da90fSDmitry Karpeev }
2302c84da90fSDmitry Karpeev 
2303c84da90fSDmitry Karpeev /*@
2304f1580f4eSBarry Smith   PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build
2305c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2306c84da90fSDmitry Karpeev 
2307c3339decSBarry Smith   Logically Collective
2308c84da90fSDmitry Karpeev 
2309c84da90fSDmitry Karpeev   Input Parameters:
2310c84da90fSDmitry Karpeev + pc  - the preconditioner object
2311c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2312c84da90fSDmitry Karpeev 
231320f4b53cSBarry Smith   Options Database Key:
2314147403d9SBarry Smith . -pc_fieldsplit_off_diag_use_amat <bool> - use the Amat to extract the off-diagonal blocks
2315c84da90fSDmitry Karpeev 
2316c84da90fSDmitry Karpeev   Level: intermediate
2317c84da90fSDmitry Karpeev 
231860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFieldSplitSetDiagUseAmat()`, `PCFIELDSPLIT`
2319c84da90fSDmitry Karpeev @*/
2320d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc, PetscBool flg)
2321d71ae5a4SJacob Faibussowitsch {
2322c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2323c84da90fSDmitry Karpeev   PetscBool      isfs;
2324c84da90fSDmitry Karpeev 
2325c84da90fSDmitry Karpeev   PetscFunctionBegin;
2326c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23279566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
232828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2329c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
23303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2331c84da90fSDmitry Karpeev }
2332c84da90fSDmitry Karpeev 
2333c84da90fSDmitry Karpeev /*@
2334f1580f4eSBarry Smith   PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build
2335c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2336c84da90fSDmitry Karpeev 
2337c3339decSBarry Smith   Logically Collective
2338c84da90fSDmitry Karpeev 
233920f4b53cSBarry Smith   Input Parameter:
2340c84da90fSDmitry Karpeev . pc - the preconditioner object
2341c84da90fSDmitry Karpeev 
234220f4b53cSBarry Smith   Output Parameter:
2343c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2344c84da90fSDmitry Karpeev 
2345c84da90fSDmitry Karpeev   Level: intermediate
2346c84da90fSDmitry Karpeev 
234760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFieldSplitGetDiagUseAmat()`, `PCFIELDSPLIT`
2348c84da90fSDmitry Karpeev @*/
2349d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc, PetscBool *flg)
2350d71ae5a4SJacob Faibussowitsch {
2351c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2352c84da90fSDmitry Karpeev   PetscBool      isfs;
2353c84da90fSDmitry Karpeev 
2354c84da90fSDmitry Karpeev   PetscFunctionBegin;
2355c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23564f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
23579566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
235828b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2359c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
23603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2361c84da90fSDmitry Karpeev }
2362c84da90fSDmitry Karpeev 
2363cc4c1da9SBarry Smith /*@
2364f1580f4eSBarry Smith   PCFieldSplitSetIS - Sets the exact elements for a split in a `PCFIELDSPLIT`
2365704ba839SBarry Smith 
2366c3339decSBarry Smith   Logically Collective
2367704ba839SBarry Smith 
2368704ba839SBarry Smith   Input Parameters:
2369704ba839SBarry Smith + pc        - the preconditioner context
237060f59c3bSBarry Smith . splitname - name of this split, if `NULL` the number of the split is used
2371f1580f4eSBarry Smith - is        - the index set that defines the elements in this split
2372704ba839SBarry Smith 
237360f59c3bSBarry Smith   Level: intermediate
237460f59c3bSBarry Smith 
2375a6ffb8dbSJed Brown   Notes:
237680670ca5SBarry Smith   Use `PCFieldSplitSetFields()`, for splits defined by strided `IS` based on the matrix block size or the `is_rows[]` passed into `MATNEST`
2377a6ffb8dbSJed Brown 
2378db4c96c1SJed Brown   This function is called once per split (it creates a new split each time).  Solve options
2379db4c96c1SJed Brown   for this split will be available under the prefix -fieldsplit_SPLITNAME_.
2380d32f9abdSBarry Smith 
238180670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetFields()`
2382704ba839SBarry Smith @*/
2383d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetIS(PC pc, const char splitname[], IS is)
2384d71ae5a4SJacob Faibussowitsch {
2385704ba839SBarry Smith   PetscFunctionBegin;
23860700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23874f572ea9SToby Isaac   if (splitname) PetscAssertPointer(splitname, 2);
2388db4c96c1SJed Brown   PetscValidHeaderSpecific(is, IS_CLASSID, 3);
2389cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetIS_C", (PC, const char[], IS), (pc, splitname, is));
23903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2391704ba839SBarry Smith }
2392704ba839SBarry Smith 
2393cc4c1da9SBarry Smith /*@
2394f1580f4eSBarry Smith   PCFieldSplitGetIS - Retrieves the elements for a split as an `IS`
239557a9adfeSMatthew G Knepley 
2396c3339decSBarry Smith   Logically Collective
239757a9adfeSMatthew G Knepley 
239857a9adfeSMatthew G Knepley   Input Parameters:
239957a9adfeSMatthew G Knepley + pc        - the preconditioner context
240057a9adfeSMatthew G Knepley - splitname - name of this split
240157a9adfeSMatthew G Knepley 
240257a9adfeSMatthew G Knepley   Output Parameter:
2403feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split, or `NULL` if the split is not found
240457a9adfeSMatthew G Knepley 
240557a9adfeSMatthew G Knepley   Level: intermediate
240657a9adfeSMatthew G Knepley 
240780670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetIS()`, `PCFieldSplitGetISByIndex()`
240857a9adfeSMatthew G Knepley @*/
2409d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetIS(PC pc, const char splitname[], IS *is)
2410d71ae5a4SJacob Faibussowitsch {
241157a9adfeSMatthew G Knepley   PetscFunctionBegin;
241257a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
24134f572ea9SToby Isaac   PetscAssertPointer(splitname, 2);
24144f572ea9SToby Isaac   PetscAssertPointer(is, 3);
241557a9adfeSMatthew G Knepley   {
241657a9adfeSMatthew G Knepley     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
241757a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
241857a9adfeSMatthew G Knepley     PetscBool         found;
241957a9adfeSMatthew G Knepley 
24200298fd71SBarry Smith     *is = NULL;
242157a9adfeSMatthew G Knepley     while (ilink) {
24229566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(ilink->splitname, splitname, &found));
242357a9adfeSMatthew G Knepley       if (found) {
242457a9adfeSMatthew G Knepley         *is = ilink->is;
242557a9adfeSMatthew G Knepley         break;
242657a9adfeSMatthew G Knepley       }
242757a9adfeSMatthew G Knepley       ilink = ilink->next;
242857a9adfeSMatthew G Knepley     }
242957a9adfeSMatthew G Knepley   }
24303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
243157a9adfeSMatthew G Knepley }
243257a9adfeSMatthew G Knepley 
2433cc4c1da9SBarry Smith /*@
2434f1580f4eSBarry Smith   PCFieldSplitGetISByIndex - Retrieves the elements for a given split as an `IS`
2435998f007dSPierre Jolivet 
2436c3339decSBarry Smith   Logically Collective
2437998f007dSPierre Jolivet 
2438998f007dSPierre Jolivet   Input Parameters:
2439998f007dSPierre Jolivet + pc    - the preconditioner context
2440998f007dSPierre Jolivet - index - index of this split
2441998f007dSPierre Jolivet 
2442998f007dSPierre Jolivet   Output Parameter:
2443feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split
2444998f007dSPierre Jolivet 
2445998f007dSPierre Jolivet   Level: intermediate
2446998f007dSPierre Jolivet 
244780670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitGetIS()`, `PCFieldSplitSetIS()`,
244880670ca5SBarry Smith 
2449998f007dSPierre Jolivet @*/
2450d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetISByIndex(PC pc, PetscInt index, IS *is)
2451d71ae5a4SJacob Faibussowitsch {
2452998f007dSPierre Jolivet   PetscFunctionBegin;
245363a3b9bcSJacob Faibussowitsch   PetscCheck(index >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", index);
2454998f007dSPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
24554f572ea9SToby Isaac   PetscAssertPointer(is, 3);
2456998f007dSPierre Jolivet   {
2457998f007dSPierre Jolivet     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
2458998f007dSPierre Jolivet     PC_FieldSplitLink ilink = jac->head;
2459998f007dSPierre Jolivet     PetscInt          i     = 0;
246063a3b9bcSJacob Faibussowitsch     PetscCheck(index < jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", index, jac->nsplits);
2461998f007dSPierre Jolivet 
2462998f007dSPierre Jolivet     while (i < index) {
2463998f007dSPierre Jolivet       ilink = ilink->next;
2464998f007dSPierre Jolivet       ++i;
2465998f007dSPierre Jolivet     }
24669566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitGetIS(pc, ilink->splitname, is));
2467998f007dSPierre Jolivet   }
24683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2469998f007dSPierre Jolivet }
2470998f007dSPierre Jolivet 
247151f519a2SBarry Smith /*@
247251f519a2SBarry Smith   PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
247380670ca5SBarry Smith   fieldsplit preconditioner when calling `PCFieldSplitSetFields()`. If not set the matrix block size is used.
247451f519a2SBarry Smith 
2475c3339decSBarry Smith   Logically Collective
247651f519a2SBarry Smith 
247751f519a2SBarry Smith   Input Parameters:
247851f519a2SBarry Smith + pc - the preconditioner context
247951f519a2SBarry Smith - bs - the block size
248051f519a2SBarry Smith 
248151f519a2SBarry Smith   Level: intermediate
248251f519a2SBarry Smith 
248380670ca5SBarry Smith   Note:
248480670ca5SBarry Smith   If the matrix is a `MATNEST` then the `is_rows[]` passed to `MatCreateNest()` determines the fields.
248580670ca5SBarry Smith 
248660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
248751f519a2SBarry Smith @*/
2488d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetBlockSize(PC pc, PetscInt bs)
2489d71ae5a4SJacob Faibussowitsch {
249051f519a2SBarry Smith   PetscFunctionBegin;
24910700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2492c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc, bs, 2);
2493cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetBlockSize_C", (PC, PetscInt), (pc, bs));
24943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
249551f519a2SBarry Smith }
249651f519a2SBarry Smith 
24970971522cSBarry Smith /*@C
2498f1580f4eSBarry Smith   PCFieldSplitGetSubKSP - Gets the `KSP` contexts for all splits
24990971522cSBarry Smith 
2500c3339decSBarry Smith   Collective
25010971522cSBarry Smith 
25020971522cSBarry Smith   Input Parameter:
25030971522cSBarry Smith . pc - the preconditioner context
25040971522cSBarry Smith 
25050971522cSBarry Smith   Output Parameters:
250613e0d083SBarry Smith + n      - the number of splits
2507f1580f4eSBarry Smith - subksp - the array of `KSP` contexts
2508196cc216SBarry Smith 
25090971522cSBarry Smith   Level: advanced
25100971522cSBarry Smith 
2511f1580f4eSBarry Smith   Notes:
2512f1580f4eSBarry Smith   After `PCFieldSplitGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()`
2513f1580f4eSBarry Smith   (not the `KSP`, just the array that contains them).
2514f1580f4eSBarry Smith 
2515f1580f4eSBarry Smith   You must call `PCSetUp()` before calling `PCFieldSplitGetSubKSP()`.
2516f1580f4eSBarry Smith 
2517f1580f4eSBarry Smith   If the fieldsplit is of type `PC_COMPOSITE_SCHUR`, it returns the `KSP` object used inside the
2518f1580f4eSBarry Smith   Schur complement and the `KSP` object used to iterate over the Schur complement.
2519f1580f4eSBarry Smith   To access all the `KSP` objects used in `PC_COMPOSITE_SCHUR`, use `PCFieldSplitSchurGetSubKSP()`.
2520f1580f4eSBarry Smith 
2521f1580f4eSBarry Smith   If the fieldsplit is of type `PC_COMPOSITE_GKB`, it returns the `KSP` object used to solve the
2522f1580f4eSBarry Smith   inner linear system defined by the matrix H in each loop.
2523f1580f4eSBarry Smith 
2524feefa0e1SJacob Faibussowitsch   Fortran Notes:
2525f1580f4eSBarry Smith   You must pass in a `KSP` array that is large enough to contain all the `KSP`s.
2526f1580f4eSBarry Smith   You can call `PCFieldSplitGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the
2527f1580f4eSBarry Smith   `KSP` array must be.
2528f1580f4eSBarry Smith 
2529feefa0e1SJacob Faibussowitsch   Developer Notes:
2530f1580f4eSBarry Smith   There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()`
2531f1580f4eSBarry Smith 
25325d83a8b1SBarry Smith   The Fortran interface could be modernized to return directly the array of values.
2533f1580f4eSBarry Smith 
253460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitSchurGetSubKSP()`
25350971522cSBarry Smith @*/
2536d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSubKSP(PC pc, PetscInt *n, KSP *subksp[])
2537d71ae5a4SJacob Faibussowitsch {
25380971522cSBarry Smith   PetscFunctionBegin;
25390700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
25404f572ea9SToby Isaac   if (n) PetscAssertPointer(n, 2);
2541cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
25423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25430971522cSBarry Smith }
25440971522cSBarry Smith 
2545285fb4e2SStefano Zampini /*@C
2546f1580f4eSBarry Smith   PCFieldSplitSchurGetSubKSP - Gets the `KSP` contexts used inside the Schur complement based `PCFIELDSPLIT`
2547285fb4e2SStefano Zampini 
254860f59c3bSBarry Smith   Collective
2549285fb4e2SStefano Zampini 
2550285fb4e2SStefano Zampini   Input Parameter:
2551285fb4e2SStefano Zampini . pc - the preconditioner context
2552285fb4e2SStefano Zampini 
2553285fb4e2SStefano Zampini   Output Parameters:
2554285fb4e2SStefano Zampini + n      - the number of splits
2555f1580f4eSBarry Smith - subksp - the array of `KSP` contexts
2556285fb4e2SStefano Zampini 
2557285fb4e2SStefano Zampini   Level: advanced
2558285fb4e2SStefano Zampini 
2559f1580f4eSBarry Smith   Notes:
2560f1580f4eSBarry Smith   After `PCFieldSplitSchurGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()`
2561f1580f4eSBarry Smith   (not the `KSP` just the array that contains them).
2562f1580f4eSBarry Smith 
2563f1580f4eSBarry Smith   You must call `PCSetUp()` before calling `PCFieldSplitSchurGetSubKSP()`.
2564f1580f4eSBarry Smith 
2565f1580f4eSBarry Smith   If the fieldsplit type is of type `PC_COMPOSITE_SCHUR`, it returns (in order)
2566f1580f4eSBarry Smith +  1  - the `KSP` used for the (1,1) block
2567f1580f4eSBarry Smith .  2  - the `KSP` used for the Schur complement (not the one used for the interior Schur solver)
2568f1580f4eSBarry Smith -  3  - the `KSP` used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block).
2569f1580f4eSBarry Smith 
2570f1580f4eSBarry Smith   It returns a null array if the fieldsplit is not of type `PC_COMPOSITE_SCHUR`; in this case, you should use `PCFieldSplitGetSubKSP()`.
2571f1580f4eSBarry Smith 
2572feefa0e1SJacob Faibussowitsch   Fortran Notes:
2573f1580f4eSBarry Smith   You must pass in a `KSP` array that is large enough to contain all the local `KSP`s.
2574f1580f4eSBarry Smith   You can call `PCFieldSplitSchurGetSubKSP`(pc,n,`PETSC_NULL_KSP`,ierr) to determine how large the
2575f1580f4eSBarry Smith   `KSP` array must be.
2576f1580f4eSBarry Smith 
2577f1580f4eSBarry Smith   Developer Notes:
2578f1580f4eSBarry Smith   There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()`
2579f1580f4eSBarry Smith 
2580f1580f4eSBarry Smith   Should the functionality of `PCFieldSplitSchurGetSubKSP()` and `PCFieldSplitGetSubKSP()` be merged?
2581f1580f4eSBarry Smith 
2582f1580f4eSBarry Smith   The Fortran interface should be modernized to return directly the array of values.
2583f1580f4eSBarry Smith 
258460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitGetSubKSP()`
2585285fb4e2SStefano Zampini @*/
2586d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc, PetscInt *n, KSP *subksp[])
2587d71ae5a4SJacob Faibussowitsch {
2588285fb4e2SStefano Zampini   PetscFunctionBegin;
2589285fb4e2SStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
25904f572ea9SToby Isaac   if (n) PetscAssertPointer(n, 2);
2591cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitSchurGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
25923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2593285fb4e2SStefano Zampini }
2594285fb4e2SStefano Zampini 
2595e69d4d44SBarry Smith /*@
2596c14e9f00SDavid Andrs   PCFieldSplitSetSchurPre -  Indicates from what operator the preconditioner is constructed for the Schur complement.
2597a1e3cbf9SBarry Smith   The default is the A11 matrix.
2598e69d4d44SBarry Smith 
2599c3339decSBarry Smith   Collective
2600e69d4d44SBarry Smith 
2601e69d4d44SBarry Smith   Input Parameters:
2602e69d4d44SBarry Smith + pc    - the preconditioner context
2603f1580f4eSBarry Smith . ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11` (default),
2604f1580f4eSBarry Smith               `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER`,
2605f1580f4eSBarry Smith               `PC_FIELDSPLIT_SCHUR_PRE_SELFP`, and `PC_FIELDSPLIT_SCHUR_PRE_FULL`
260660f59c3bSBarry Smith - pre   - matrix to use for preconditioning, or `NULL`
2607084e4875SJed Brown 
2608f1580f4eSBarry Smith   Options Database Keys:
2609d59693daSPierre Jolivet + -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is `a11`. See notes for meaning of various arguments
2610a1e3cbf9SBarry Smith - -fieldsplit_1_pc_type <pctype>                               - the preconditioner algorithm that is used to construct the preconditioner from the operator
2611e69d4d44SBarry Smith 
261260f59c3bSBarry Smith   Level: intermediate
261360f59c3bSBarry Smith 
2614fd1303e9SJungho Lee   Notes:
2615f1580f4eSBarry Smith   If ptype is
2616f1580f4eSBarry Smith +     a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
2617f1580f4eSBarry Smith   matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
2618f1580f4eSBarry Smith .     self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
2619e7593814SPierre Jolivet   The only preconditioners that currently work with this symbolic representation matrix object are `PCLSC` and `PCHPDDM`
2620f1580f4eSBarry Smith .     user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
2621f1580f4eSBarry Smith   to this function).
2622a077d33dSBarry Smith .     selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation $ Sp = A11 - A10 inv(diag(A00)) A01 $
2623f1580f4eSBarry Smith   This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
2624d59693daSPierre Jolivet   lumped before extracting the diagonal using the additional option `-fieldsplit_1_mat_schur_complement_ainv_type lump`
2625f1580f4eSBarry Smith -     full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation
2626f1580f4eSBarry Smith   computed internally by `PCFIELDSPLIT` (this is expensive)
2627f1580f4eSBarry Smith   useful mostly as a test that the Schur complement approach can work for your problem
2628fd1303e9SJungho Lee 
2629d59693daSPierre Jolivet   When solving a saddle point problem, where the A11 block is identically zero, using `a11` as the ptype only makes sense
2630a077d33dSBarry Smith   with the additional option `-fieldsplit_1_pc_type none`. Usually for saddle point problems one would use a `ptype` of `self` and
2631d59693daSPierre Jolivet   `-fieldsplit_1_pc_type lsc` which uses the least squares commutator to compute a preconditioner for the Schur complement.
2632fd1303e9SJungho Lee 
2633a077d33dSBarry Smith   Developer Note:
2634a077d33dSBarry Smith   The name of this function and the option `-pc_fieldsplit_schur_precondition` are inconsistent; precondition should be used everywhere.
2635feefa0e1SJacob Faibussowitsch 
2636a077d33dSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`,
2637a077d33dSBarry Smith           `MatSchurComplementSetAinvType()`, `PCLSC`, `PCFieldSplitSetSchurFactType()`
2638e69d4d44SBarry Smith @*/
2639d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurPre(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2640d71ae5a4SJacob Faibussowitsch {
2641e69d4d44SBarry Smith   PetscFunctionBegin;
26420700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2643cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurPre_C", (PC, PCFieldSplitSchurPreType, Mat), (pc, ptype, pre));
26443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2645e69d4d44SBarry Smith }
2646686bed4dSStefano Zampini 
2647d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurPrecondition(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2648d71ae5a4SJacob Faibussowitsch {
26499371c9d4SSatish Balay   return PCFieldSplitSetSchurPre(pc, ptype, pre);
26509371c9d4SSatish Balay } /* Deprecated name */
2651e69d4d44SBarry Smith 
265237a82bf0SJed Brown /*@
265337a82bf0SJed Brown   PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
2654f1580f4eSBarry Smith   preconditioned.  See `PCFieldSplitSetSchurPre()` for details.
265537a82bf0SJed Brown 
2656c3339decSBarry Smith   Logically Collective
265737a82bf0SJed Brown 
2658f899ff85SJose E. Roman   Input Parameter:
265937a82bf0SJed Brown . pc - the preconditioner context
266037a82bf0SJed Brown 
266137a82bf0SJed Brown   Output Parameters:
2662d59693daSPierre 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`
2663d59693daSPierre Jolivet - pre   - matrix to use for preconditioning (with `PC_FIELDSPLIT_SCHUR_PRE_USER`), or `NULL`
266437a82bf0SJed Brown 
266537a82bf0SJed Brown   Level: intermediate
266637a82bf0SJed Brown 
2667d59693daSPierre Jolivet .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCLSC`
266837a82bf0SJed Brown @*/
2669d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurPre(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre)
2670d71ae5a4SJacob Faibussowitsch {
267137a82bf0SJed Brown   PetscFunctionBegin;
267237a82bf0SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2673cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSchurPre_C", (PC, PCFieldSplitSchurPreType *, Mat *), (pc, ptype, pre));
26743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2675e69d4d44SBarry Smith }
2676e69d4d44SBarry Smith 
267745e7fc46SDmitry Karpeev /*@
2678f1580f4eSBarry Smith   PCFieldSplitSchurGetS -  extract the `MATSCHURCOMPLEMENT` object used by this `PCFIELDSPLIT` in case it needs to be configured separately
267945e7fc46SDmitry Karpeev 
268020f4b53cSBarry Smith   Not Collective
268145e7fc46SDmitry Karpeev 
268245e7fc46SDmitry Karpeev   Input Parameter:
268345e7fc46SDmitry Karpeev . pc - the preconditioner context
268445e7fc46SDmitry Karpeev 
268545e7fc46SDmitry Karpeev   Output Parameter:
2686470b340bSDmitry Karpeev . S - the Schur complement matrix
268745e7fc46SDmitry Karpeev 
268860f59c3bSBarry Smith   Level: advanced
268960f59c3bSBarry Smith 
2690f1580f4eSBarry Smith   Note:
2691f1580f4eSBarry Smith   This matrix should not be destroyed using `MatDestroy()`; rather, use `PCFieldSplitSchurRestoreS()`.
269245e7fc46SDmitry Karpeev 
269360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MATSCHURCOMPLEMENT`, `PCFieldSplitSchurRestoreS()`,
2694f1580f4eSBarry Smith           `MatCreateSchurComplement()`, `MatSchurComplementGetKSP()`, `MatSchurComplementComputeExplicitOperator()`, `MatGetSchurComplement()`
269545e7fc46SDmitry Karpeev @*/
2696d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetS(PC pc, Mat *S)
2697d71ae5a4SJacob Faibussowitsch {
269845e7fc46SDmitry Karpeev   const char    *t;
269945e7fc46SDmitry Karpeev   PetscBool      isfs;
270045e7fc46SDmitry Karpeev   PC_FieldSplit *jac;
270145e7fc46SDmitry Karpeev 
270245e7fc46SDmitry Karpeev   PetscFunctionBegin;
270345e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
27049566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
27059566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
270628b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
270745e7fc46SDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
270863a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
2709470b340bSDmitry Karpeev   if (S) *S = jac->schur;
27103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
271145e7fc46SDmitry Karpeev }
271245e7fc46SDmitry Karpeev 
2713470b340bSDmitry Karpeev /*@
2714f1580f4eSBarry Smith   PCFieldSplitSchurRestoreS -  returns the `MATSCHURCOMPLEMENT` matrix used by this `PC`
2715470b340bSDmitry Karpeev 
271620f4b53cSBarry Smith   Not Collective
2717470b340bSDmitry Karpeev 
2718470b340bSDmitry Karpeev   Input Parameters:
2719470b340bSDmitry Karpeev + pc - the preconditioner context
2720a2b725a8SWilliam Gropp - S  - the Schur complement matrix
2721470b340bSDmitry Karpeev 
2722470b340bSDmitry Karpeev   Level: advanced
2723470b340bSDmitry Karpeev 
272460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MatSchurComplement`, `PCFieldSplitSchurGetS()`
2725470b340bSDmitry Karpeev @*/
2726d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurRestoreS(PC pc, Mat *S)
2727d71ae5a4SJacob Faibussowitsch {
2728470b340bSDmitry Karpeev   const char    *t;
2729470b340bSDmitry Karpeev   PetscBool      isfs;
2730470b340bSDmitry Karpeev   PC_FieldSplit *jac;
2731470b340bSDmitry Karpeev 
2732470b340bSDmitry Karpeev   PetscFunctionBegin;
2733470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
27349566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
27359566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
273628b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
2737470b340bSDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
273863a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
27397827d75bSBarry Smith   PetscCheck(S && (*S == jac->schur), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatSchurComplement restored is not the same as gotten");
27403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2741470b340bSDmitry Karpeev }
2742470b340bSDmitry Karpeev 
2743d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2744d71ae5a4SJacob Faibussowitsch {
2745e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2746e69d4d44SBarry Smith 
2747e69d4d44SBarry Smith   PetscFunctionBegin;
2748084e4875SJed Brown   jac->schurpre = ptype;
2749a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
27509566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&jac->schur_user));
2751084e4875SJed Brown     jac->schur_user = pre;
27529566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
2753084e4875SJed Brown   }
27543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2755e69d4d44SBarry Smith }
2756e69d4d44SBarry Smith 
2757d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre)
2758d71ae5a4SJacob Faibussowitsch {
275937a82bf0SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
276037a82bf0SJed Brown 
276137a82bf0SJed Brown   PetscFunctionBegin;
27626056e507SPierre Jolivet   if (ptype) *ptype = jac->schurpre;
27636056e507SPierre Jolivet   if (pre) *pre = jac->schur_user;
27643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
276537a82bf0SJed Brown }
276637a82bf0SJed Brown 
2767ab1df9f5SJed Brown /*@
27681d27aa22SBarry Smith   PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner {cite}`murphy2000note` and {cite}`ipsen2001note`
2769ab1df9f5SJed Brown 
2770c3339decSBarry Smith   Collective
2771ab1df9f5SJed Brown 
2772ab1df9f5SJed Brown   Input Parameters:
2773ab1df9f5SJed Brown + pc    - the preconditioner context
2774f1580f4eSBarry Smith - ftype - which blocks of factorization to retain, `PC_FIELDSPLIT_SCHUR_FACT_FULL` is default
2775ab1df9f5SJed Brown 
2776f1580f4eSBarry Smith   Options Database Key:
2777d59693daSPierre Jolivet . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - default is `full`
2778ab1df9f5SJed Brown 
2779ab1df9f5SJed Brown   Level: intermediate
2780ab1df9f5SJed Brown 
2781ab1df9f5SJed Brown   Notes:
2782ab1df9f5SJed Brown   The FULL factorization is
2783ab1df9f5SJed Brown 
2784a077d33dSBarry Smith   ```{math}
2785a077d33dSBarry Smith   \left(\begin{array}{cc} A & B \\
2786a077d33dSBarry Smith   C & E \\
2787a077d33dSBarry Smith   \end{array}\right) =
2788a077d33dSBarry Smith   \left(\begin{array}{cc} 1 & 0 \\
2789a077d33dSBarry Smith   C*A^{-1} & I \\
2790a077d33dSBarry Smith   \end{array}\right)
2791a077d33dSBarry Smith   \left(\begin{array}{cc} A & 0 \\
2792a077d33dSBarry Smith   0 & S \\
2793a077d33dSBarry Smith   \end{array}\right)
2794a077d33dSBarry Smith   \left(\begin{array}{cc} I & A^{-1}B \\
2795a077d33dSBarry Smith   0 & I \\
2796a077d33dSBarry Smith   \end{array}\right) = L D U.
2797a077d33dSBarry Smith   ```
2798a077d33dSBarry Smith 
2799a077d33dSBarry 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$,
2800a077d33dSBarry Smith   and DIAG is the diagonal part with the sign of $ S $ flipped (because this makes the preconditioner positive definite for many formulations,
2801a077d33dSBarry Smith   thus allowing the use of `KSPMINRES)`. Sign flipping of $ S $ can be turned off with `PCFieldSplitSetSchurScale()`.
2802a077d33dSBarry Smith 
2803a077d33dSBarry Smith   If $A$ and $S$ are solved exactly
2804a077d33dSBarry Smith +  1 - FULL factorization is a direct solver.
2805a077d33dSBarry 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.
2806a077d33dSBarry 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.
2807ab1df9f5SJed Brown 
2808f1580f4eSBarry Smith   If the iteration count is very low, consider using `KSPFGMRES` or `KSPGCR` which can use one less preconditioner
28090ffb0e17SBarry 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.
28100ffb0e17SBarry Smith 
2811a077d33dSBarry Smith   For symmetric problems in which $A$ is positive definite and $S$ is negative definite, DIAG can be used with `KSPMINRES`.
28120ffb0e17SBarry Smith 
28131d27aa22SBarry 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).
2814ab1df9f5SJed Brown 
28151d27aa22SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurScale()`,
2816a077d33dSBarry Smith           [](sec_flexibleksp), `PCFieldSplitSetSchurPre()`
2817ab1df9f5SJed Brown @*/
2818d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurFactType(PC pc, PCFieldSplitSchurFactType ftype)
2819d71ae5a4SJacob Faibussowitsch {
2820ab1df9f5SJed Brown   PetscFunctionBegin;
2821ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2822cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurFactType_C", (PC, PCFieldSplitSchurFactType), (pc, ftype));
28233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2824ab1df9f5SJed Brown }
2825ab1df9f5SJed Brown 
2826d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc, PCFieldSplitSchurFactType ftype)
2827d71ae5a4SJacob Faibussowitsch {
2828ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2829ab1df9f5SJed Brown 
2830ab1df9f5SJed Brown   PetscFunctionBegin;
2831ab1df9f5SJed Brown   jac->schurfactorization = ftype;
28323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2833ab1df9f5SJed Brown }
2834ab1df9f5SJed Brown 
2835c096484dSStefano Zampini /*@
2836f1580f4eSBarry Smith   PCFieldSplitSetSchurScale -  Controls the sign flip of S for `PC_FIELDSPLIT_SCHUR_FACT_DIAG`.
2837c096484dSStefano Zampini 
2838c3339decSBarry Smith   Collective
2839c096484dSStefano Zampini 
2840c096484dSStefano Zampini   Input Parameters:
2841c096484dSStefano Zampini + pc    - the preconditioner context
2842c096484dSStefano Zampini - scale - scaling factor for the Schur complement
2843c096484dSStefano Zampini 
2844f1580f4eSBarry Smith   Options Database Key:
28451d27aa22SBarry Smith . -pc_fieldsplit_schur_scale <scale> - default is -1.0
2846c096484dSStefano Zampini 
2847c096484dSStefano Zampini   Level: intermediate
2848c096484dSStefano Zampini 
284942747ad1SJacob Faibussowitsch .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurFactType`, `PCFieldSplitSetSchurFactType()`
2850c096484dSStefano Zampini @*/
2851d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurScale(PC pc, PetscScalar scale)
2852d71ae5a4SJacob Faibussowitsch {
2853c096484dSStefano Zampini   PetscFunctionBegin;
2854c096484dSStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2855c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc, scale, 2);
2856cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurScale_C", (PC, PetscScalar), (pc, scale));
28573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2858c096484dSStefano Zampini }
2859c096484dSStefano Zampini 
2860d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc, PetscScalar scale)
2861d71ae5a4SJacob Faibussowitsch {
2862c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2863c096484dSStefano Zampini 
2864c096484dSStefano Zampini   PetscFunctionBegin;
2865c096484dSStefano Zampini   jac->schurscale = scale;
28663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2867c096484dSStefano Zampini }
2868c096484dSStefano Zampini 
286930ad9308SMatthew Knepley /*@C
28708c03b21aSDmitry Karpeev   PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
287130ad9308SMatthew Knepley 
2872c3339decSBarry Smith   Collective
287330ad9308SMatthew Knepley 
287430ad9308SMatthew Knepley   Input Parameter:
287530ad9308SMatthew Knepley . pc - the preconditioner context
287630ad9308SMatthew Knepley 
287730ad9308SMatthew Knepley   Output Parameters:
2878a04f6461SBarry Smith + A00 - the (0,0) block
2879a04f6461SBarry Smith . A01 - the (0,1) block
2880a04f6461SBarry Smith . A10 - the (1,0) block
2881a04f6461SBarry Smith - A11 - the (1,1) block
288230ad9308SMatthew Knepley 
288330ad9308SMatthew Knepley   Level: advanced
288430ad9308SMatthew Knepley 
28855d83a8b1SBarry Smith   Note:
28865d83a8b1SBarry Smith   Use `NULL` for any unneeded output arguments
28875d83a8b1SBarry Smith 
288860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `MatSchurComplementGetSubMatrices()`, `MatSchurComplementSetSubMatrices()`
288930ad9308SMatthew Knepley @*/
2890d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc, Mat *A00, Mat *A01, Mat *A10, Mat *A11)
2891d71ae5a4SJacob Faibussowitsch {
289230ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
289330ad9308SMatthew Knepley 
289430ad9308SMatthew Knepley   PetscFunctionBegin;
28950700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
289608401ef6SPierre Jolivet   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2897a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2898a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2899a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2900a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
29013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
290230ad9308SMatthew Knepley }
290330ad9308SMatthew Knepley 
2904b09e027eSCarola Kruse /*@
29051d27aa22SBarry Smith   PCFieldSplitSetGKBTol -  Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2906b09e027eSCarola Kruse 
2907c3339decSBarry Smith   Collective
2908e071a0a4SCarola Kruse 
2909b09e027eSCarola Kruse   Input Parameters:
2910b09e027eSCarola Kruse + pc        - the preconditioner context
2911b09e027eSCarola Kruse - tolerance - the solver tolerance
2912b09e027eSCarola Kruse 
2913f1580f4eSBarry Smith   Options Database Key:
29141d27aa22SBarry Smith . -pc_fieldsplit_gkb_tol <tolerance> - default is 1e-5
2915b09e027eSCarola Kruse 
2916b09e027eSCarola Kruse   Level: intermediate
2917b09e027eSCarola Kruse 
2918f1580f4eSBarry Smith   Note:
29191d27aa22SBarry Smith   The generalized GKB algorithm {cite}`arioli2013` uses a lower bound estimate of the error in energy norm as stopping criterion.
2920f1580f4eSBarry Smith   It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than
29211d27aa22SBarry Smith   this estimate, the stopping criterion is satisfactory in practical cases.
2922f1580f4eSBarry Smith 
292360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBMaxit()`
2924b09e027eSCarola Kruse @*/
2925d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBTol(PC pc, PetscReal tolerance)
2926d71ae5a4SJacob Faibussowitsch {
2927b09e027eSCarola Kruse   PetscFunctionBegin;
2928b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2929de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, tolerance, 2);
2930cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBTol_C", (PC, PetscReal), (pc, tolerance));
29313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2932b09e027eSCarola Kruse }
2933b09e027eSCarola Kruse 
2934d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc, PetscReal tolerance)
2935d71ae5a4SJacob Faibussowitsch {
2936b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2937b09e027eSCarola Kruse 
2938b09e027eSCarola Kruse   PetscFunctionBegin;
2939b09e027eSCarola Kruse   jac->gkbtol = tolerance;
29403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2941b09e027eSCarola Kruse }
2942b09e027eSCarola Kruse 
2943b09e027eSCarola Kruse /*@
294480670ca5SBarry Smith   PCFieldSplitSetGKBMaxit -  Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2945b09e027eSCarola Kruse 
2946c3339decSBarry Smith   Collective
2947b09e027eSCarola Kruse 
2948b09e027eSCarola Kruse   Input Parameters:
2949b09e027eSCarola Kruse + pc    - the preconditioner context
2950b09e027eSCarola Kruse - maxit - the maximum number of iterations
2951b09e027eSCarola Kruse 
2952f1580f4eSBarry Smith   Options Database Key:
29531d27aa22SBarry Smith . -pc_fieldsplit_gkb_maxit <maxit> - default is 100
2954b09e027eSCarola Kruse 
2955b09e027eSCarola Kruse   Level: intermediate
2956b09e027eSCarola Kruse 
295760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBNu()`
2958b09e027eSCarola Kruse @*/
2959d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc, PetscInt maxit)
2960d71ae5a4SJacob Faibussowitsch {
2961b09e027eSCarola Kruse   PetscFunctionBegin;
2962b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2963de482cd7SCarola Kruse   PetscValidLogicalCollectiveInt(pc, maxit, 2);
2964cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBMaxit_C", (PC, PetscInt), (pc, maxit));
29653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2966b09e027eSCarola Kruse }
2967b09e027eSCarola Kruse 
2968d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc, PetscInt maxit)
2969d71ae5a4SJacob Faibussowitsch {
2970b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2971b09e027eSCarola Kruse 
2972b09e027eSCarola Kruse   PetscFunctionBegin;
2973b09e027eSCarola Kruse   jac->gkbmaxit = maxit;
29743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2975b09e027eSCarola Kruse }
2976b09e027eSCarola Kruse 
2977b09e027eSCarola Kruse /*@
29781d27aa22SBarry Smith   PCFieldSplitSetGKBDelay -  Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization {cite}`arioli2013` in `PCFIELDSPLIT`
2979e071a0a4SCarola Kruse   preconditioner.
2980b09e027eSCarola Kruse 
2981c3339decSBarry Smith   Collective
2982b09e027eSCarola Kruse 
2983b09e027eSCarola Kruse   Input Parameters:
2984b09e027eSCarola Kruse + pc    - the preconditioner context
2985b09e027eSCarola Kruse - delay - the delay window in the lower bound estimate
2986b09e027eSCarola Kruse 
2987f1580f4eSBarry Smith   Options Database Key:
29881d27aa22SBarry Smith . -pc_fieldsplit_gkb_delay <delay> - default is 5
2989b09e027eSCarola Kruse 
2990b09e027eSCarola Kruse   Level: intermediate
2991b09e027eSCarola Kruse 
29921d27aa22SBarry Smith   Notes:
29931d27aa22SBarry 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 $
29941d27aa22SBarry 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
29951d27aa22SBarry Smith   at least (`delay` + 1) iterations to stop.
2996f1580f4eSBarry Smith 
29971d27aa22SBarry Smith   For more details on the generalized Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to {cite}`arioli2013`
2998f1580f4eSBarry Smith 
299960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
3000b09e027eSCarola Kruse @*/
3001d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBDelay(PC pc, PetscInt delay)
3002d71ae5a4SJacob Faibussowitsch {
3003b09e027eSCarola Kruse   PetscFunctionBegin;
3004b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3005b09e027eSCarola Kruse   PetscValidLogicalCollectiveInt(pc, delay, 2);
3006cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBDelay_C", (PC, PetscInt), (pc, delay));
30073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3008b09e027eSCarola Kruse }
3009b09e027eSCarola Kruse 
3010d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc, PetscInt delay)
3011d71ae5a4SJacob Faibussowitsch {
3012b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
3013b09e027eSCarola Kruse 
3014b09e027eSCarola Kruse   PetscFunctionBegin;
3015b09e027eSCarola Kruse   jac->gkbdelay = delay;
30163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3017b09e027eSCarola Kruse }
3018b09e027eSCarola Kruse 
3019b09e027eSCarola Kruse /*@
30201d27aa22SBarry Smith   PCFieldSplitSetGKBNu -  Sets the scalar value nu >= 0 in the transformation H = A00 + nu*A01*A01' of the (1,1) block in the
30211d27aa22SBarry Smith   Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
3022b09e027eSCarola Kruse 
3023c3339decSBarry Smith   Collective
3024f1580f4eSBarry Smith 
3025f1580f4eSBarry Smith   Input Parameters:
3026f1580f4eSBarry Smith + pc - the preconditioner context
3027f1580f4eSBarry Smith - nu - the shift parameter
3028f1580f4eSBarry Smith 
302920f4b53cSBarry Smith   Options Database Key:
30301d27aa22SBarry Smith . -pc_fieldsplit_gkb_nu <nu> - default is 1
3031f1580f4eSBarry Smith 
3032f1580f4eSBarry Smith   Level: intermediate
3033b09e027eSCarola Kruse 
3034b09e027eSCarola Kruse   Notes:
30351d27aa22SBarry 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,
30361d27aa22SBarry 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
3037b09e027eSCarola Kruse   necessary to find a good balance in between the convergence of the inner and outer loop.
3038b09e027eSCarola Kruse 
30391d27aa22SBarry 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.
3040b09e027eSCarola Kruse 
304160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
3042b09e027eSCarola Kruse @*/
3043d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBNu(PC pc, PetscReal nu)
3044d71ae5a4SJacob Faibussowitsch {
3045b09e027eSCarola Kruse   PetscFunctionBegin;
3046b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3047de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, nu, 2);
3048cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBNu_C", (PC, PetscReal), (pc, nu));
30493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3050b09e027eSCarola Kruse }
3051b09e027eSCarola Kruse 
3052d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc, PetscReal nu)
3053d71ae5a4SJacob Faibussowitsch {
3054b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
3055b09e027eSCarola Kruse 
3056b09e027eSCarola Kruse   PetscFunctionBegin;
3057b09e027eSCarola Kruse   jac->gkbnu = nu;
30583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3059b09e027eSCarola Kruse }
3060b09e027eSCarola Kruse 
3061d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc, PCCompositeType type)
3062d71ae5a4SJacob Faibussowitsch {
306379416396SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
306479416396SBarry Smith 
306579416396SBarry Smith   PetscFunctionBegin;
306679416396SBarry Smith   jac->type = type;
30672e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
30682e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
30692e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
30702e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
30712e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
30722e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
30732e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
30742e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
30752e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
3076e071a0a4SCarola Kruse 
30773b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
30783b224e63SBarry Smith     pc->ops->apply          = PCApply_FieldSplit_Schur;
30797b665727SPierre Jolivet     pc->ops->applytranspose = PCApplyTranspose_FieldSplit_Schur;
30803b224e63SBarry Smith     pc->ops->view           = PCView_FieldSplit_Schur;
308173716367SStefano Zampini     pc->ops->setuponblocks  = PCSetUpOnBlocks_FieldSplit_Schur;
30822fa5cd67SKarl Rupp 
30839566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit_Schur));
30849566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", PCFieldSplitSetSchurPre_FieldSplit));
30859566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", PCFieldSplitGetSchurPre_FieldSplit));
30869566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", PCFieldSplitSetSchurFactType_FieldSplit));
30879566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", PCFieldSplitSetSchurScale_FieldSplit));
3088a51937d4SCarola Kruse   } else if (type == PC_COMPOSITE_GKB) {
3089a51937d4SCarola Kruse     pc->ops->apply         = PCApply_FieldSplit_GKB;
3090a51937d4SCarola Kruse     pc->ops->view          = PCView_FieldSplit_GKB;
309173716367SStefano Zampini     pc->ops->setuponblocks = PCSetUpOnBlocks_FieldSplit_GKB;
3092e69d4d44SBarry Smith 
30939566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
30949566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", PCFieldSplitSetGKBTol_FieldSplit));
30959566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", PCFieldSplitSetGKBMaxit_FieldSplit));
30969566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", PCFieldSplitSetGKBNu_FieldSplit));
30979566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", PCFieldSplitSetGKBDelay_FieldSplit));
30983b224e63SBarry Smith   } else {
30993b224e63SBarry Smith     pc->ops->apply         = PCApply_FieldSplit;
31003b224e63SBarry Smith     pc->ops->view          = PCView_FieldSplit;
310173716367SStefano Zampini     pc->ops->setuponblocks = PCSetUpOnBlocks_FieldSplit;
31022fa5cd67SKarl Rupp 
31039566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
31043b224e63SBarry Smith   }
31053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
310679416396SBarry Smith }
310779416396SBarry Smith 
3108d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc, PetscInt bs)
3109d71ae5a4SJacob Faibussowitsch {
311051f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
311151f519a2SBarry Smith 
311251f519a2SBarry Smith   PetscFunctionBegin;
311363a3b9bcSJacob Faibussowitsch   PetscCheck(bs >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Blocksize must be positive, you gave %" PetscInt_FMT, bs);
31142472a847SBarry 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);
311551f519a2SBarry Smith   jac->bs = bs;
31163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
311751f519a2SBarry Smith }
311851f519a2SBarry Smith 
3119d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetCoordinates_FieldSplit(PC pc, PetscInt dim, PetscInt nloc, PetscReal coords[])
3120d71ae5a4SJacob Faibussowitsch {
31215ddf11f8SNicolas Barnafi   PC_FieldSplit    *jac           = (PC_FieldSplit *)pc->data;
31225ddf11f8SNicolas Barnafi   PC_FieldSplitLink ilink_current = jac->head;
31235ddf11f8SNicolas Barnafi   IS                is_owned;
31245ddf11f8SNicolas Barnafi 
31255ddf11f8SNicolas Barnafi   PetscFunctionBegin;
31265ddf11f8SNicolas Barnafi   jac->coordinates_set = PETSC_TRUE; // Internal flag
3127f3fa974cSJacob Faibussowitsch   PetscCall(MatGetOwnershipIS(pc->mat, &is_owned, NULL));
31285ddf11f8SNicolas Barnafi 
31295ddf11f8SNicolas Barnafi   while (ilink_current) {
31305ddf11f8SNicolas Barnafi     // For each IS, embed it to get local coords indces
31315ddf11f8SNicolas Barnafi     IS              is_coords;
31325ddf11f8SNicolas Barnafi     PetscInt        ndofs_block;
31335ddf11f8SNicolas Barnafi     const PetscInt *block_dofs_enumeration; // Numbering of the dofs relevant to the current block
31345ddf11f8SNicolas Barnafi 
31355ddf11f8SNicolas Barnafi     // Setting drop to true for safety. It should make no difference.
31369566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink_current->is, is_owned, PETSC_TRUE, &is_coords));
31379566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(is_coords, &ndofs_block));
31389566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(is_coords, &block_dofs_enumeration));
31395ddf11f8SNicolas Barnafi 
31405ddf11f8SNicolas Barnafi     // Allocate coordinates vector and set it directly
3141f4f49eeaSPierre Jolivet     PetscCall(PetscMalloc1(ndofs_block * dim, &ilink_current->coords));
31425ddf11f8SNicolas Barnafi     for (PetscInt dof = 0; dof < ndofs_block; ++dof) {
3143ad540459SPierre Jolivet       for (PetscInt d = 0; d < dim; ++d) (ilink_current->coords)[dim * dof + d] = coords[dim * block_dofs_enumeration[dof] + d];
31445ddf11f8SNicolas Barnafi     }
31455ddf11f8SNicolas Barnafi     ilink_current->dim   = dim;
31465ddf11f8SNicolas Barnafi     ilink_current->ndofs = ndofs_block;
31479566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(is_coords, &block_dofs_enumeration));
31489566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is_coords));
31495ddf11f8SNicolas Barnafi     ilink_current = ilink_current->next;
31505ddf11f8SNicolas Barnafi   }
31519566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_owned));
31523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
31535ddf11f8SNicolas Barnafi }
31545ddf11f8SNicolas Barnafi 
3155bc08b0f1SBarry Smith /*@
3156f1580f4eSBarry Smith   PCFieldSplitSetType - Sets the type, `PCCompositeType`, of a `PCFIELDSPLIT`
315779416396SBarry Smith 
3158c3339decSBarry Smith   Collective
315979416396SBarry Smith 
3160d8d19677SJose E. Roman   Input Parameters:
3161a2b725a8SWilliam Gropp + pc   - the preconditioner context
3162a077d33dSBarry Smith - type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`,
3163a077d33dSBarry Smith          `PC_COMPOSITE_GKB`
316479416396SBarry Smith 
316579416396SBarry Smith   Options Database Key:
31661d27aa22SBarry Smith . -pc_fieldsplit_type <one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
316779416396SBarry Smith 
3168feefa0e1SJacob Faibussowitsch   Level: intermediate
316979416396SBarry Smith 
317060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCCompositeType`, `PCCompositeGetType()`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`,
3171a077d33dSBarry Smith           `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`, `PCFieldSplitSetSchurFactType()`
317279416396SBarry Smith @*/
3173d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetType(PC pc, PCCompositeType type)
3174d71ae5a4SJacob Faibussowitsch {
317579416396SBarry Smith   PetscFunctionBegin;
31760700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3177cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetType_C", (PC, PCCompositeType), (pc, type));
31783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
317979416396SBarry Smith }
318079416396SBarry Smith 
3181b02e2d75SMatthew G Knepley /*@
3182f1580f4eSBarry Smith   PCFieldSplitGetType - Gets the type, `PCCompositeType`, of a `PCFIELDSPLIT`
3183b02e2d75SMatthew G Knepley 
3184b02e2d75SMatthew G Knepley   Not collective
3185b02e2d75SMatthew G Knepley 
3186b02e2d75SMatthew G Knepley   Input Parameter:
3187b02e2d75SMatthew G Knepley . pc - the preconditioner context
3188b02e2d75SMatthew G Knepley 
3189b02e2d75SMatthew G Knepley   Output Parameter:
3190f1580f4eSBarry Smith . type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
3191b02e2d75SMatthew G Knepley 
3192feefa0e1SJacob Faibussowitsch   Level: intermediate
3193b02e2d75SMatthew G Knepley 
319460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCompositeSetType()`, `PCFIELDSPLIT`, `PCCompositeType`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`,
3195f1580f4eSBarry Smith           `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
3196b02e2d75SMatthew G Knepley @*/
3197d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
3198d71ae5a4SJacob Faibussowitsch {
3199b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
3200b02e2d75SMatthew G Knepley 
3201b02e2d75SMatthew G Knepley   PetscFunctionBegin;
3202b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
32034f572ea9SToby Isaac   PetscAssertPointer(type, 2);
3204b02e2d75SMatthew G Knepley   *type = jac->type;
32053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3206b02e2d75SMatthew G Knepley }
3207b02e2d75SMatthew G Knepley 
32084ab8060aSDmitry Karpeev /*@
3209f1580f4eSBarry Smith   PCFieldSplitSetDMSplits - Flags whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible.
32104ab8060aSDmitry Karpeev 
3211c3339decSBarry Smith   Logically Collective
32124ab8060aSDmitry Karpeev 
32134ab8060aSDmitry Karpeev   Input Parameters:
32144ab8060aSDmitry Karpeev + pc  - the preconditioner context
3215f1580f4eSBarry Smith - flg - boolean indicating whether to use field splits defined by the `DM`
32164ab8060aSDmitry Karpeev 
32174ab8060aSDmitry Karpeev   Options Database Key:
3218f1580f4eSBarry Smith . -pc_fieldsplit_dm_splits <bool> - use the field splits defined by the `DM`
32194ab8060aSDmitry Karpeev 
3220feefa0e1SJacob Faibussowitsch   Level: intermediate
32214ab8060aSDmitry Karpeev 
322273ff1848SBarry Smith   Developer Note:
322373ff1848SBarry Smith   The name should be `PCFieldSplitSetUseDMSplits()`, similar change to options database
322473ff1848SBarry Smith 
322573ff1848SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDMSplits()`, `DMCreateFieldDecomposition()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()`
32264ab8060aSDmitry Karpeev @*/
3227d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDMSplits(PC pc, PetscBool flg)
3228d71ae5a4SJacob Faibussowitsch {
32294ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
32304ab8060aSDmitry Karpeev   PetscBool      isfs;
32314ab8060aSDmitry Karpeev 
32324ab8060aSDmitry Karpeev   PetscFunctionBegin;
32334ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
32344ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc, flg, 2);
32359566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
3236ad540459SPierre Jolivet   if (isfs) jac->dm_splits = flg;
32373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32384ab8060aSDmitry Karpeev }
32394ab8060aSDmitry Karpeev 
32404ab8060aSDmitry Karpeev /*@
3241f1580f4eSBarry Smith   PCFieldSplitGetDMSplits - Returns flag indicating whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible.
32424ab8060aSDmitry Karpeev 
32434ab8060aSDmitry Karpeev   Logically Collective
32444ab8060aSDmitry Karpeev 
32454ab8060aSDmitry Karpeev   Input Parameter:
32464ab8060aSDmitry Karpeev . pc - the preconditioner context
32474ab8060aSDmitry Karpeev 
32484ab8060aSDmitry Karpeev   Output Parameter:
3249f1580f4eSBarry Smith . flg - boolean indicating whether to use field splits defined by the `DM`
32504ab8060aSDmitry Karpeev 
3251feefa0e1SJacob Faibussowitsch   Level: intermediate
32524ab8060aSDmitry Karpeev 
325373ff1848SBarry Smith   Developer Note:
325473ff1848SBarry Smith   The name should be `PCFieldSplitGetUseDMSplits()`
325573ff1848SBarry Smith 
325673ff1848SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDMSplits()`, `DMCreateFieldDecomposition()`, `PCFieldSplitSetFields()`, `PCFieldsplitSetIS()`
32574ab8060aSDmitry Karpeev @*/
3258d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDMSplits(PC pc, PetscBool *flg)
3259d71ae5a4SJacob Faibussowitsch {
32604ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
32614ab8060aSDmitry Karpeev   PetscBool      isfs;
32624ab8060aSDmitry Karpeev 
32634ab8060aSDmitry Karpeev   PetscFunctionBegin;
32644ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
32654f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
32669566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
32674ab8060aSDmitry Karpeev   if (isfs) {
32684ab8060aSDmitry Karpeev     if (flg) *flg = jac->dm_splits;
32694ab8060aSDmitry Karpeev   }
32703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32714ab8060aSDmitry Karpeev }
32724ab8060aSDmitry Karpeev 
32737b752e3dSPatrick Sanan /*@
3274f1580f4eSBarry Smith   PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries.
32757b752e3dSPatrick Sanan 
32767b752e3dSPatrick Sanan   Logically Collective
32777b752e3dSPatrick Sanan 
32787b752e3dSPatrick Sanan   Input Parameter:
32797b752e3dSPatrick Sanan . pc - the preconditioner context
32807b752e3dSPatrick Sanan 
32817b752e3dSPatrick Sanan   Output Parameter:
32827b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not
32837b752e3dSPatrick Sanan 
3284feefa0e1SJacob Faibussowitsch   Level: intermediate
32857b752e3dSPatrick Sanan 
328660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDetectSaddlePoint()`
32877b752e3dSPatrick Sanan @*/
3288d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc, PetscBool *flg)
3289d71ae5a4SJacob Faibussowitsch {
32907b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
32917b752e3dSPatrick Sanan 
32927b752e3dSPatrick Sanan   PetscFunctionBegin;
32937b752e3dSPatrick Sanan   *flg = jac->detect;
32943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32957b752e3dSPatrick Sanan }
32967b752e3dSPatrick Sanan 
32977b752e3dSPatrick Sanan /*@
3298f1580f4eSBarry Smith   PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries.
32997b752e3dSPatrick Sanan 
33007b752e3dSPatrick Sanan   Logically Collective
33017b752e3dSPatrick Sanan 
33027b752e3dSPatrick Sanan   Input Parameter:
33037b752e3dSPatrick Sanan . pc - the preconditioner context
33047b752e3dSPatrick Sanan 
33057b752e3dSPatrick Sanan   Output Parameter:
33067b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not
33077b752e3dSPatrick Sanan 
33087b752e3dSPatrick Sanan   Options Database Key:
3309147403d9SBarry Smith . -pc_fieldsplit_detect_saddle_point <bool> - detect and use the saddle point
3310147403d9SBarry Smith 
3311feefa0e1SJacob Faibussowitsch   Level: intermediate
331260f59c3bSBarry Smith 
3313f1580f4eSBarry Smith   Note:
3314f1580f4eSBarry 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()`).
33157b752e3dSPatrick Sanan 
331660f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDetectSaddlePoint()`, `PCFieldSplitSetType()`, `PCFieldSplitSetSchurPre()`, `PC_FIELDSPLIT_SCHUR_PRE_SELF`
33177b752e3dSPatrick Sanan @*/
3318d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc, PetscBool flg)
3319d71ae5a4SJacob Faibussowitsch {
33207b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
33217b752e3dSPatrick Sanan 
33227b752e3dSPatrick Sanan   PetscFunctionBegin;
33237b752e3dSPatrick Sanan   jac->detect = flg;
33247b752e3dSPatrick Sanan   if (jac->detect) {
33259566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetType(pc, PC_COMPOSITE_SCHUR));
33269566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetSchurPre(pc, PC_FIELDSPLIT_SCHUR_PRE_SELF, NULL));
33277b752e3dSPatrick Sanan   }
33283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
33297b752e3dSPatrick Sanan }
33307b752e3dSPatrick Sanan 
33310971522cSBarry Smith /*MC
3332a8c7a070SBarry Smith   PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
3333f1580f4eSBarry Smith   collections of variables (that may overlap) called splits. See [the users manual section on "Solving Block Matrices"](sec_block_matrices) for more details.
33340971522cSBarry Smith 
333579416396SBarry Smith   Options Database Keys:
3336de37d9f1SPatrick Sanan +   -pc_fieldsplit_%d_fields <a,b,..>                                                - indicates the fields to be used in the `%d`'th split
333781540f2fSBarry Smith .   -pc_fieldsplit_default                                                           - automatically add any fields to additional splits that have not
3338de37d9f1SPatrick Sanan                                                                                        been supplied explicitly by `-pc_fieldsplit_%d_fields`
333981540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs>                                                   - size of block that defines fields (i.e. there are bs fields)
334080670ca5SBarry Smith                                                                                        when the matrix is not of `MatType` `MATNEST`
3341a51937d4SCarola Kruse .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting
3342d59693daSPierre Jolivet .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full>                     - default is `a11`; see `PCFieldSplitSetSchurPre()`
33431d27aa22SBarry Smith .   -pc_fieldsplit_schur_fact_type <diag,lower,upper,full>                           - set factorization type when using `-pc_fieldsplit_type schur`;
33441d27aa22SBarry Smith                                                                                        see `PCFieldSplitSetSchurFactType()`
334573ff1848SBarry Smith .   -pc_fieldsplit_dm_splits <true,false> (default is true)                          - Whether to use `DMCreateFieldDecomposition()` for splits
3346fb6809a2SPatrick Sanan -   -pc_fieldsplit_detect_saddle_point                                               - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
334779416396SBarry Smith 
3348de37d9f1SPatrick Sanan   Options prefixes for inner solvers when using the Schur complement preconditioner are `-fieldsplit_0_` and `-fieldsplit_1_` .
3349de37d9f1SPatrick Sanan   The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is `-fieldsplit_0_`
335060f59c3bSBarry Smith   For all other solvers they are `-fieldsplit_%d_` for the `%d`'th field; use `-fieldsplit_` for all fields.
335160f59c3bSBarry Smith 
335260f59c3bSBarry Smith   To set options on the solvers for each block append `-fieldsplit_` to all the `PC`
335360f59c3bSBarry Smith   options database keys. For example, `-fieldsplit_pc_type ilu` `-fieldsplit_pc_factor_levels 1`
335460f59c3bSBarry Smith 
335560f59c3bSBarry Smith   To set the options on the solvers separate for each block call `PCFieldSplitGetSubKSP()`
335660f59c3bSBarry Smith   and set the options directly on the resulting `KSP` object
335760f59c3bSBarry Smith 
335860f59c3bSBarry Smith   Level: intermediate
33595d4c12cdSJungho Lee 
3360c8a0d604SMatthew G Knepley   Notes:
336180670ca5SBarry Smith   Use `PCFieldSplitSetFields()` to set splits defined by "strided" entries or with a `MATNEST` and `PCFieldSplitSetIS()`
3362f1580f4eSBarry Smith   to define a split by an arbitrary collection of entries.
3363d32f9abdSBarry Smith 
336473ff1848SBarry Smith   If no splits are set, the default is used. If a `DM` is associated with the `PC` and it supports
336580670ca5SBarry 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,
3366de37d9f1SPatrick Sanan   beginning at 0 then 1, etc to bs-1. The block size can be set with `PCFieldSplitSetBlockSize()`,
3367d32f9abdSBarry Smith   if this is not called the block size defaults to the blocksize of the second matrix passed
3368de37d9f1SPatrick Sanan   to `KSPSetOperators()`/`PCSetOperators()`.
3369d32f9abdSBarry Smith 
3370de37d9f1SPatrick Sanan   For the Schur complement preconditioner if
3371de37d9f1SPatrick Sanan   ```{math}
3372de37d9f1SPatrick Sanan     J = \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{10} & A_{11} \end{array}\right]
3373de37d9f1SPatrick Sanan   ```
3374e69d4d44SBarry Smith 
3375de37d9f1SPatrick Sanan   the preconditioner using `full` factorization is logically
3376de37d9f1SPatrick Sanan   ```{math}
3377ecaa082aSMatthew 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]
3378de37d9f1SPatrick Sanan       ```
3379de37d9f1SPatrick Sanan   where the action of $\text{inv}(A_{00})$ is applied using the KSP solver with prefix `-fieldsplit_0_`.  $S$ is the Schur complement
3380de37d9f1SPatrick Sanan   ```{math}
3381223e5b4fSPatrick Sanan      S = A_{11} - A_{10} \text{ksp}(A_{00}) A_{01}
3382de37d9f1SPatrick Sanan   ```
3383de37d9f1SPatrick 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
338460f59c3bSBarry Smith   in providing the SECOND split or 1 if not given). For `PCFieldSplitGetSubKSP()` when field number is 0,
338580670ca5SBarry Smith   it returns the `KSP` associated with `-fieldsplit_0_` while field number 1 gives `-fieldsplit_1_` KSP. By default
3386de37d9f1SPatrick Sanan   $A_{11}$ is used to construct a preconditioner for $S$, use `PCFieldSplitSetSchurPre()` for all the possible ways to construct the preconditioner for $S$.
3387de37d9f1SPatrick Sanan 
3388de37d9f1SPatrick Sanan   The factorization type is set using `-pc_fieldsplit_schur_fact_type <diag, lower, upper, full>`. `full` is shown above,
3389de37d9f1SPatrick Sanan   `diag` gives
3390de37d9f1SPatrick Sanan   ```{math}
3391de37d9f1SPatrick Sanan     \left[\begin{array}{cc} \text{inv}(A_{00}) & 0 \\  0 & -\text{ksp}(S) \end{array}\right]
3392de37d9f1SPatrick Sanan   ```
3393de37d9f1SPatrick 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
3394de37d9f1SPatrick Sanan   can be turned off with `PCFieldSplitSetSchurScale()` or by command line `-pc_fieldsplit_schur_scale 1.0`. The `lower` factorization is the inverse of
3395de37d9f1SPatrick Sanan   ```{math}
3396de37d9f1SPatrick Sanan     \left[\begin{array}{cc} A_{00} & 0 \\  A_{10} & S \end{array}\right]
3397de37d9f1SPatrick Sanan   ```
3398de37d9f1SPatrick Sanan   where the inverses of A_{00} and S are applied using KSPs. The upper factorization is the inverse of
3399de37d9f1SPatrick Sanan   ```{math}
3400de37d9f1SPatrick Sanan     \left[\begin{array}{cc} A_{00} & A_{01} \\  0 & S \end{array}\right]
3401de37d9f1SPatrick Sanan   ```
3402de37d9f1SPatrick Sanan   where again the inverses of $A_{00}$ and $S$ are applied using `KSP`s.
3403de37d9f1SPatrick Sanan 
3404de37d9f1SPatrick Sanan   If only one set of indices (one `IS`) is provided with `PCFieldSplitSetIS()` then the complement of that `IS`
340580670ca5SBarry Smith   is used automatically for a second submatrix.
3406edf189efSBarry Smith 
3407f1580f4eSBarry Smith   The fieldsplit preconditioner cannot currently be used with the `MATBAIJ` or `MATSBAIJ` data formats if the blocksize is larger than 1.
340880670ca5SBarry Smith   Generally it should be used with the `MATAIJ` or `MATNEST` `MatType`
3409ff218e97SBarry Smith 
341080670ca5SBarry Smith   The forms of these preconditioners are closely related, if not identical, to forms derived as "Distributive Iterations", see,
34111d569b8fSBarry Smith   for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling {cite}`wesseling2009`.
341280670ca5SBarry Smith   One can also use `PCFIELDSPLIT` inside a smoother resulting in "Distributive Smoothers".
34130716a85fSBarry Smith 
3414de37d9f1SPatrick Sanan   See "A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations" {cite}`elman2008tcp`.
3415a6a584a2SBarry Smith 
3416de37d9f1SPatrick Sanan   The Constrained Pressure Preconditioner (CPR) can be implemented using `PCCOMPOSITE` with `PCGALERKIN`. CPR first solves an $R A P$ subsystem, updates the
3417de37d9f1SPatrick Sanan   residual on all variables (`PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)`), and then applies a simple ILU like preconditioner on all the variables.
3418a51937d4SCarola Kruse 
3419de37d9f1SPatrick Sanan   The generalized Golub-Kahan bidiagonalization preconditioner (GKB) can be applied to symmetric $2 \times 2$ block matrices of the shape
3420de37d9f1SPatrick Sanan   ```{math}
3421de37d9f1SPatrick Sanan     \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{01}' & 0 \end{array}\right]
3422de37d9f1SPatrick Sanan   ```
34231d569b8fSBarry 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}'$.
3424de37d9f1SPatrick 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_`.
3425a51937d4SCarola Kruse 
342660f59c3bSBarry Smith   Developer Note:
342760f59c3bSBarry Smith   The Schur complement functionality of `PCFIELDSPLIT` should likely be factored into its own `PC` thus simplifying the implementation of the preconditioners and their
342860f59c3bSBarry Smith   user API.
3429f1580f4eSBarry Smith 
343060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCLSC`,
3431db781477SPatrick Sanan           `PCFieldSplitGetSubKSP()`, `PCFieldSplitSchurGetSubKSP()`, `PCFieldSplitSetFields()`,
3432db781477SPatrick Sanan           `PCFieldSplitSetType()`, `PCFieldSplitSetIS()`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitSetSchurFactType()`,
3433db781477SPatrick Sanan           `MatSchurComplementSetAinvType()`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetDetectSaddlePoint()`
34340971522cSBarry Smith M*/
34350971522cSBarry Smith 
3436d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
3437d71ae5a4SJacob Faibussowitsch {
34380971522cSBarry Smith   PC_FieldSplit *jac;
34390971522cSBarry Smith 
34400971522cSBarry Smith   PetscFunctionBegin;
34414dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&jac));
34422fa5cd67SKarl Rupp 
34430971522cSBarry Smith   jac->bs                 = -1;
34440971522cSBarry Smith   jac->nsplits            = 0;
34453e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
3446e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
3447c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
3448c096484dSStefano Zampini   jac->schurscale         = -1.0;
3449fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
34507b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
3451a51937d4SCarola Kruse   jac->gkbtol             = 1e-5;
3452a51937d4SCarola Kruse   jac->gkbdelay           = 5;
3453a51937d4SCarola Kruse   jac->gkbnu              = 1;
3454a51937d4SCarola Kruse   jac->gkbmaxit           = 100;
3455de482cd7SCarola Kruse   jac->gkbmonitor         = PETSC_FALSE;
34565ddf11f8SNicolas Barnafi   jac->coordinates_set    = PETSC_FALSE;
345751f519a2SBarry Smith 
34580971522cSBarry Smith   pc->data = (void *)jac;
34590971522cSBarry Smith 
34600971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
3461421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
34620971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
3463574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
34640971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
34650971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
34660971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
34670a545947SLisandro Dalcin   pc->ops->applyrichardson = NULL;
34680971522cSBarry Smith 
34699566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", PCFieldSplitSchurGetSubKSP_FieldSplit));
34709566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
34719566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", PCFieldSplitSetFields_FieldSplit));
34729566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", PCFieldSplitSetIS_FieldSplit));
34739566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", PCFieldSplitSetType_FieldSplit));
34749566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", PCFieldSplitSetBlockSize_FieldSplit));
34759566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", PCFieldSplitRestrictIS_FieldSplit));
34769566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", PCSetCoordinates_FieldSplit));
34773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
34780971522cSBarry Smith }
3479