xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision ad881d7c01ba04ac39558bb1cb60a78017274ea3)
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] */
517addb90fSBarry Smith   Mat                       schurp;     /* Assembled approximation to S built by MatSchurComplement to be used as a matrix for constructing the preconditioner when solving with S */
527addb90fSBarry Smith   Mat                       schur_user; /* User-provided matrix for constructing the preconditioner for the Schur complement */
537addb90fSBarry Smith   PCFieldSplitSchurPreType  schurpre;   /* Determines which 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 
877addb90fSBarry Smith /* This helper is so that setting a user-provided 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;
1099f196a02SMartin Diehl   PetscBool         isascii, isdraw;
1100971522cSBarry Smith   PetscInt          i, j;
1115a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
1120971522cSBarry Smith 
1130971522cSBarry Smith   PetscFunctionBegin;
1149f196a02SMartin Diehl   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii));
1159566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
1169f196a02SMartin Diehl   if (isascii) {
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;
1679f196a02SMartin Diehl   PetscBool                  isascii, isdraw;
1683b224e63SBarry Smith   PetscInt                   i, j;
1693b224e63SBarry Smith   PC_FieldSplitLink          ilink = jac->head;
170a9908d51SBarry Smith   MatSchurComplementAinvType atype;
1713b224e63SBarry Smith 
1723b224e63SBarry Smith   PetscFunctionBegin;
1739f196a02SMartin Diehl   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii));
1749566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
1759f196a02SMartin Diehl   if (isascii) {
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));
227ac530a7eSPierre Jolivet     if (jac->head) PetscCall(KSPView(jac->head->ksp, viewer));
228ac530a7eSPierre Jolivet     else PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
2299566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
23006de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
2319566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for upper A00 in upper triangular factor\n"));
2329566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPushTab(viewer));
2339566063dSJacob Faibussowitsch       if (jac->kspupper) PetscCall(KSPView(jac->kspupper, viewer));
2349566063dSJacob Faibussowitsch       else PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
2359566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPopTab(viewer));
236443836d0SMatthew G Knepley     }
2379566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "KSP solver for S = A11 - A10 inv(A00) A01\n"));
2389566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
23912cae6f2SJed Brown     if (jac->kspschur) {
2409566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->kspschur, viewer));
24112cae6f2SJed Brown     } else {
2429566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  not yet available\n"));
24312cae6f2SJed Brown     }
2449566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
2459566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
24606de4afeSJed Brown   } else if (isdraw && jac->head) {
2474996c5bdSBarry Smith     PetscDraw draw;
2484996c5bdSBarry Smith     PetscReal x, y, w, wd, h;
2494996c5bdSBarry Smith     PetscInt  cnt = 2;
2504996c5bdSBarry Smith     char      str[32];
2514996c5bdSBarry Smith 
2529566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
2539566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
254c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
255c74581afSBarry Smith     w  = 2 * PetscMin(1.0 - x, x);
256c74581afSBarry Smith     wd = w / (cnt + 1);
257c74581afSBarry Smith 
2589566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(str, 32, "Schur fact. %s", PCFieldSplitSchurFactTypes[jac->schurfactorization]));
2599566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h));
2604996c5bdSBarry Smith     y -= h;
2614996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER && !jac->schur_user) {
2629566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]));
2633b224e63SBarry Smith     } else {
2649566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(str, 32, "Prec. for Schur from %s", PCFieldSplitSchurPreTypes[jac->schurpre]));
2654996c5bdSBarry Smith     }
2669566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x + wd * (cnt - 1) / 2.0, y, PETSC_DRAW_RED, PETSC_DRAW_BLACK, str, NULL, &h));
2674996c5bdSBarry Smith     y -= h;
2684996c5bdSBarry Smith     x = x - wd * (cnt - 1) / 2.0;
2694996c5bdSBarry Smith 
2709566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2719566063dSJacob Faibussowitsch     PetscCall(KSPView(jac->head->ksp, viewer));
2729566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
2734996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2744996c5bdSBarry Smith       x += wd;
2759566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2769566063dSJacob Faibussowitsch       PetscCall(KSPView(jac->kspupper, viewer));
2779566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
2784996c5bdSBarry Smith     }
2794996c5bdSBarry Smith     x += wd;
2809566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
2819566063dSJacob Faibussowitsch     PetscCall(KSPView(jac->kspschur, viewer));
2829566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
2833b224e63SBarry Smith   }
2843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2853b224e63SBarry Smith }
2863b224e63SBarry Smith 
287d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCView_FieldSplit_GKB(PC pc, PetscViewer viewer)
288d71ae5a4SJacob Faibussowitsch {
289a51937d4SCarola Kruse   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
2909f196a02SMartin Diehl   PetscBool         isascii, isdraw;
291a51937d4SCarola Kruse   PetscInt          i, j;
292a51937d4SCarola Kruse   PC_FieldSplitLink ilink = jac->head;
293a51937d4SCarola Kruse 
294a51937d4SCarola Kruse   PetscFunctionBegin;
2959f196a02SMartin Diehl   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii));
2969566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
2979f196a02SMartin Diehl   if (isascii) {
298a51937d4SCarola Kruse     if (jac->bs > 0) {
29963a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT ", blocksize = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits, jac->bs));
300a51937d4SCarola Kruse     } else {
30163a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  FieldSplit with %s composition: total splits = %" PetscInt_FMT "\n", PCCompositeTypes[jac->type], jac->nsplits));
302a51937d4SCarola Kruse     }
30348a46eb9SPierre Jolivet     if (pc->useAmat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for blocks\n"));
30448a46eb9SPierre Jolivet     if (jac->diag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for diagonal blocks\n"));
30548a46eb9SPierre Jolivet     if (jac->offdiag_use_amat) PetscCall(PetscViewerASCIIPrintf(viewer, "  using Amat (not Pmat) as operator for off-diagonal blocks\n"));
306a51937d4SCarola Kruse 
30763a3b9bcSJacob 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));
3089566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  Solver info for H = A00 + nu*A01*A01' matrix:\n"));
3099566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
310a51937d4SCarola Kruse 
311a51937d4SCarola Kruse     if (ilink->fields) {
31263a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Fields "));
3139566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_FALSE));
314a51937d4SCarola Kruse       for (j = 0; j < ilink->nfields; j++) {
31548a46eb9SPierre Jolivet         if (j > 0) PetscCall(PetscViewerASCIIPrintf(viewer, ","));
31663a3b9bcSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, " %" PetscInt_FMT, ilink->fields[j]));
317a51937d4SCarola Kruse       }
3189566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "\n"));
3199566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIUseTabs(viewer, PETSC_TRUE));
320a51937d4SCarola Kruse     } else {
32163a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "Split number 0 Defined by IS\n"));
322a51937d4SCarola Kruse     }
3239566063dSJacob Faibussowitsch     PetscCall(KSPView(ilink->ksp, viewer));
324a51937d4SCarola Kruse 
3259566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
326a51937d4SCarola Kruse   }
327a51937d4SCarola Kruse 
328a51937d4SCarola Kruse   if (isdraw) {
329a51937d4SCarola Kruse     PetscDraw draw;
330a51937d4SCarola Kruse     PetscReal x, y, w, wd;
331a51937d4SCarola Kruse 
3329566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
3339566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
334a51937d4SCarola Kruse     w  = 2 * PetscMin(1.0 - x, x);
335a51937d4SCarola Kruse     wd = w / (jac->nsplits + 1);
336a51937d4SCarola Kruse     x  = x - wd * (jac->nsplits - 1) / 2.0;
337a51937d4SCarola Kruse     for (i = 0; i < jac->nsplits; i++) {
3389566063dSJacob Faibussowitsch       PetscCall(PetscDrawPushCurrentPoint(draw, x, y));
3399566063dSJacob Faibussowitsch       PetscCall(KSPView(ilink->ksp, viewer));
3409566063dSJacob Faibussowitsch       PetscCall(PetscDrawPopCurrentPoint(draw));
341a51937d4SCarola Kruse       x += wd;
342a51937d4SCarola Kruse       ilink = ilink->next;
343a51937d4SCarola Kruse     }
344a51937d4SCarola Kruse   }
3453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
346a51937d4SCarola Kruse }
347a51937d4SCarola Kruse 
34880670ca5SBarry Smith /* Precondition: jac->bs is set to a meaningful value or MATNEST */
349d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
350d71ae5a4SJacob Faibussowitsch {
3516c924f48SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
35280670ca5SBarry Smith   PetscInt       bs, i, nfields, *ifields, nfields_col, *ifields_col;
35380670ca5SBarry Smith   PetscBool      flg, flg_col, mnest;
3545d4c12cdSJungho Lee   char           optionname[128], splitname[8], optionname_col[128];
3556c924f48SJed Brown 
3566c924f48SJed Brown   PetscFunctionBegin;
35780670ca5SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &mnest));
35880670ca5SBarry Smith   if (mnest) {
35980670ca5SBarry Smith     PetscCall(MatNestGetSize(pc->pmat, &bs, NULL));
36080670ca5SBarry Smith   } else {
36180670ca5SBarry Smith     bs = jac->bs;
36280670ca5SBarry Smith   }
36380670ca5SBarry Smith   PetscCall(PetscMalloc2(bs, &ifields, bs, &ifields_col));
3646c924f48SJed Brown   for (i = 0, flg = PETSC_TRUE;; i++) {
36563a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
36663a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
36763a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(optionname_col, sizeof(optionname_col), "-pc_fieldsplit_%" PetscInt_FMT "_fields_col", i));
36880670ca5SBarry Smith     nfields     = bs;
36980670ca5SBarry Smith     nfields_col = bs;
3709566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
3719566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname_col, ifields_col, &nfields_col, &flg_col));
3726c924f48SJed Brown     if (!flg) break;
3735d4c12cdSJungho Lee     else if (flg && !flg_col) {
37428b400f6SJacob Faibussowitsch       PetscCheck(nfields, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
3759566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields));
3762fa5cd67SKarl Rupp     } else {
3777827d75bSBarry Smith       PetscCheck(nfields && nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Cannot list zero fields");
37808401ef6SPierre Jolivet       PetscCheck(nfields == nfields_col, PETSC_COMM_SELF, PETSC_ERR_USER, "Number of row and column fields must match");
3799566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitSetFields(pc, splitname, nfields, ifields, ifields_col));
3805d4c12cdSJungho Lee     }
3816c924f48SJed Brown   }
3826c924f48SJed Brown   if (i > 0) {
3836c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3846c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3856c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3866c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3876c924f48SJed Brown   }
38880670ca5SBarry Smith   PetscCall(PetscFree2(ifields, ifields_col));
3893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3906c924f48SJed Brown }
3916c924f48SJed Brown 
392d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
393d71ae5a4SJacob Faibussowitsch {
3940971522cSBarry Smith   PC_FieldSplit    *jac                = (PC_FieldSplit *)pc->data;
3955a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3967b752e3dSPatrick Sanan   PetscBool         fieldsplit_default = PETSC_FALSE, coupling = PETSC_FALSE;
3976c924f48SJed Brown   PetscInt          i;
3980971522cSBarry Smith 
3990971522cSBarry Smith   PetscFunctionBegin;
4007287d2a3SDmitry Karpeev   /*
401f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
4027287d2a3SDmitry Karpeev    Should probably be rewritten.
4037287d2a3SDmitry Karpeev    */
404f5f0d762SBarry Smith   if (!ilink) {
4059566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_detect_coupling", &coupling, NULL));
4067b752e3dSPatrick Sanan     if (pc->dm && jac->dm_splits && !jac->detect && !coupling) {
407bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
4080784a22cSJed Brown       char    **fieldNames;
4097b62db95SJungho Lee       IS       *fields;
410e7c4fc90SDmitry Karpeev       DM       *dms;
411bafc1b83SMatthew G Knepley       DM        subdm[128];
412bafc1b83SMatthew G Knepley       PetscBool flg;
413bafc1b83SMatthew G Knepley 
4149566063dSJacob Faibussowitsch       PetscCall(DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms));
415bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
416bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
417bafc1b83SMatthew G Knepley         PetscInt ifields[128];
418bafc1b83SMatthew G Knepley         IS       compField;
419bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
420bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
421bafc1b83SMatthew G Knepley 
42263a3b9bcSJacob Faibussowitsch         PetscCall(PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%" PetscInt_FMT "_fields", i));
4239566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetIntArray(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg));
424bafc1b83SMatthew G Knepley         if (!flg) break;
42563a3b9bcSJacob Faibussowitsch         PetscCheck(numFields <= 128, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Cannot currently support %" PetscInt_FMT " > 128 fields", numFields);
4269566063dSJacob Faibussowitsch         PetscCall(DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]));
427bafc1b83SMatthew G Knepley         if (nfields == 1) {
4289566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField));
429bafc1b83SMatthew G Knepley         } else {
43063a3b9bcSJacob Faibussowitsch           PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
4319566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, splitname, compField));
4327287d2a3SDmitry Karpeev         }
4339566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&compField));
434bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
435bafc1b83SMatthew G Knepley           f = ifields[j];
4369566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4379566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
4387b62db95SJungho Lee         }
439bafc1b83SMatthew G Knepley       }
440bafc1b83SMatthew G Knepley       if (i == 0) {
441bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
4429566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetIS(pc, fieldNames[f], fields[f]));
4439566063dSJacob Faibussowitsch           PetscCall(PetscFree(fieldNames[f]));
4449566063dSJacob Faibussowitsch           PetscCall(ISDestroy(&fields[f]));
445bafc1b83SMatthew G Knepley         }
446bafc1b83SMatthew G Knepley       } else {
44748a46eb9SPierre Jolivet         for (j = 0; j < numFields; j++) PetscCall(DMDestroy(dms + j));
4489566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4499566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(i, &dms));
4502fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
451bafc1b83SMatthew G Knepley       }
4529566063dSJacob Faibussowitsch       PetscCall(PetscFree(fieldNames));
4539566063dSJacob Faibussowitsch       PetscCall(PetscFree(fields));
454e7c4fc90SDmitry Karpeev       if (dms) {
4559566063dSJacob Faibussowitsch         PetscCall(PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n"));
456bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
4577287d2a3SDmitry Karpeev           const char *prefix;
458f4f49eeaSPierre Jolivet           PetscCall(PetscObjectGetOptionsPrefix((PetscObject)ilink->ksp, &prefix));
459f4f49eeaSPierre Jolivet           PetscCall(PetscObjectSetOptionsPrefix((PetscObject)dms[i], prefix));
4609566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(ilink->ksp, dms[i]));
4619566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(ilink->ksp, PETSC_FALSE));
4629566063dSJacob Faibussowitsch           PetscCall(PetscObjectIncrementTabLevel((PetscObject)dms[i], (PetscObject)ilink->ksp, 0));
4639566063dSJacob Faibussowitsch           PetscCall(DMDestroy(&dms[i]));
4642fa5ba8aSJed Brown         }
4659566063dSJacob Faibussowitsch         PetscCall(PetscFree(dms));
4668b8307b2SJed Brown       }
46766ffff09SJed Brown     } else {
468521d7252SBarry Smith       if (jac->bs <= 0) {
469ac530a7eSPierre Jolivet         if (pc->pmat) PetscCall(MatGetBlockSize(pc->pmat, &jac->bs));
470ac530a7eSPierre Jolivet         else jac->bs = 1;
471521d7252SBarry Smith       }
472d32f9abdSBarry Smith 
4737b752e3dSPatrick Sanan       if (jac->detect) {
4746ce1633cSBarry Smith         IS       zerodiags, rest;
4756ce1633cSBarry Smith         PetscInt nmin, nmax;
4766ce1633cSBarry Smith 
4779566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4787199da05SBarry Smith         if (jac->diag_use_amat) {
4799566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->mat, &zerodiags));
4807199da05SBarry Smith         } else {
4819566063dSJacob Faibussowitsch           PetscCall(MatFindZeroDiagonals(pc->pmat, &zerodiags));
4827199da05SBarry Smith         }
4839566063dSJacob Faibussowitsch         PetscCall(ISComplement(zerodiags, nmin, nmax, &rest));
4849566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
4859566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", zerodiags));
4869566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&zerodiags));
4879566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
4883a062f41SBarry Smith       } else if (coupling) {
4893a062f41SBarry Smith         IS       coupling, rest;
4903a062f41SBarry Smith         PetscInt nmin, nmax;
4913a062f41SBarry Smith 
4929566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
4937199da05SBarry Smith         if (jac->offdiag_use_amat) {
4949566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->mat, &coupling));
4957199da05SBarry Smith         } else {
4969566063dSJacob Faibussowitsch           PetscCall(MatFindOffBlockDiagonalEntries(pc->pmat, &coupling));
4977199da05SBarry Smith         }
4989566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc->mat), nmax - nmin, nmin, 1, &rest));
4999566063dSJacob Faibussowitsch         PetscCall(ISSetIdentity(rest));
5009566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "0", rest));
5019566063dSJacob Faibussowitsch         PetscCall(PCFieldSplitSetIS(pc, "1", coupling));
5029566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&coupling));
5039566063dSJacob Faibussowitsch         PetscCall(ISDestroy(&rest));
5046ce1633cSBarry Smith       } else {
5059566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetBool(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_default", &fieldsplit_default, NULL));
5067287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
507d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
508d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
5099566063dSJacob Faibussowitsch           PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
5109566063dSJacob Faibussowitsch           if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
511d32f9abdSBarry Smith         }
5126dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
5139f001fe8SStefano Zampini           Mat       M = pc->pmat;
514f3b928b9SStefano Zampini           PetscBool isnest;
51580670ca5SBarry Smith           PetscInt  nf;
516f3b928b9SStefano Zampini 
5179566063dSJacob Faibussowitsch           PetscCall(PetscInfo(pc, "Using default splitting of fields\n"));
5189566063dSJacob Faibussowitsch           PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &isnest));
519f3b928b9SStefano Zampini           if (!isnest) {
5209f001fe8SStefano Zampini             M = pc->mat;
5219566063dSJacob Faibussowitsch             PetscCall(PetscObjectTypeCompare((PetscObject)pc->mat, MATNEST, &isnest));
522f3b928b9SStefano Zampini           }
52380670ca5SBarry Smith           if (!isnest) nf = jac->bs;
52480670ca5SBarry Smith           else PetscCall(MatNestGetSize(M, &nf, NULL));
52580670ca5SBarry Smith           for (i = 0; i < nf; i++) {
5266c924f48SJed Brown             char splitname[8];
52780670ca5SBarry Smith 
52863a3b9bcSJacob Faibussowitsch             PetscCall(PetscSNPrintf(splitname, sizeof(splitname), "%" PetscInt_FMT, i));
5299566063dSJacob Faibussowitsch             PetscCall(PCFieldSplitSetFields(pc, splitname, 1, &i, &i));
53079416396SBarry Smith           }
5315d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
532521d7252SBarry Smith         }
53366ffff09SJed Brown       }
5346ce1633cSBarry Smith     }
535edf189efSBarry Smith   } else if (jac->nsplits == 1) {
536edf189efSBarry Smith     IS       is2;
537edf189efSBarry Smith     PetscInt nmin, nmax;
538edf189efSBarry Smith 
5390fdf79fbSJacob Faibussowitsch     PetscCheck(ilink->is, PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Must provide at least two sets of fields to PCFieldSplit()");
5409566063dSJacob Faibussowitsch     PetscCall(MatGetOwnershipRange(pc->mat, &nmin, &nmax));
5419566063dSJacob Faibussowitsch     PetscCall(ISComplement(ilink->is, nmin, nmax, &is2));
5429566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetIS(pc, "1", is2));
5439566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is2));
544edf189efSBarry Smith   }
545d0af7cd3SBarry Smith 
54663a3b9bcSJacob Faibussowitsch   PetscCheck(jac->nsplits >= 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unhandled case, must have at least two fields, not %" PetscInt_FMT, jac->nsplits);
5473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
54869a612a9SBarry Smith }
54969a612a9SBarry Smith 
550d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A, Mat B, Mat C, Mat *H, PetscReal gkbnu)
551d71ae5a4SJacob Faibussowitsch {
552a51937d4SCarola Kruse   Mat       BT, T;
553de482cd7SCarola Kruse   PetscReal nrmT, nrmB;
554a51937d4SCarola Kruse 
555a51937d4SCarola Kruse   PetscFunctionBegin;
5569566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(C, MAT_INITIAL_MATRIX, &T)); /* Test if augmented matrix is symmetric */
5579566063dSJacob Faibussowitsch   PetscCall(MatAXPY(T, -1.0, B, DIFFERENT_NONZERO_PATTERN));
5589566063dSJacob Faibussowitsch   PetscCall(MatNorm(T, NORM_1, &nrmT));
5599566063dSJacob Faibussowitsch   PetscCall(MatNorm(B, NORM_1, &nrmB));
560b0c98d1dSPierre Jolivet   PetscCheck(nrmB <= 0 || nrmT / nrmB < PETSC_SMALL, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix is not symmetric/Hermitian, GKB is not applicable.");
561049d1499SBarry Smith 
562a51937d4SCarola Kruse   /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */
563a51937d4SCarola Kruse   /* setting N := 1/nu*I in [Ar13].                                                 */
5649566063dSJacob Faibussowitsch   PetscCall(MatHermitianTranspose(B, MAT_INITIAL_MATRIX, &BT));
565fb842aefSJose E. Roman   PetscCall(MatMatMult(B, BT, MAT_INITIAL_MATRIX, PETSC_CURRENT, H)); /* H = A01*A01'          */
5669566063dSJacob Faibussowitsch   PetscCall(MatAYPX(*H, gkbnu, A, DIFFERENT_NONZERO_PATTERN));        /* H = A00 + nu*A01*A01' */
567a51937d4SCarola Kruse 
5689566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&BT));
5699566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&T));
5703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
571a51937d4SCarola Kruse }
572a51937d4SCarola Kruse 
57354a546c1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions, const char pre[], const char name[], const char *option[], const char *value[], PetscBool *flg);
574514bf10dSMatthew G Knepley 
575d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetUp_FieldSplit(PC pc)
576d71ae5a4SJacob Faibussowitsch {
57769a612a9SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
5785a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
5792c9966d7SBarry Smith   PetscInt          i, nsplit;
5802033cbf1SStefano Zampini   PetscBool         matnest = PETSC_FALSE;
58169a612a9SBarry Smith 
58269a612a9SBarry Smith   PetscFunctionBegin;
5835da88fe4STristan Konolige   pc->failedreason = PC_NOERROR;
5849566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDefaults(pc));
58597bbdb24SBarry Smith   nsplit = jac->nsplits;
5865a9f2f41SSatish Balay   ilink  = jac->head;
58780670ca5SBarry Smith   if (pc->pmat) PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest));
58897bbdb24SBarry Smith 
58997bbdb24SBarry Smith   /* get the matrices for each split */
590704ba839SBarry Smith   if (!jac->issetup) {
5911b9fc7fcSBarry Smith     PetscInt rstart, rend, nslots, bs;
59297bbdb24SBarry Smith 
593704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
594704ba839SBarry Smith 
5955d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
5962c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
5972c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
5982c9966d7SBarry Smith     }
5994db63379SBarry Smith 
6004db63379SBarry Smith     /*  MatCreateSubMatrix() for [S]BAIJ matrices can only work if the indices include entire blocks of the matrix */
6014db63379SBarry Smith     PetscCall(MatGetBlockSize(pc->pmat, &bs));
6024db63379SBarry Smith     if (bs > 1 && (jac->bs <= bs || jac->bs % bs)) {
6034db63379SBarry Smith       PetscBool blk;
6044db63379SBarry Smith 
6054db63379SBarry Smith       PetscCall(PetscObjectTypeCompareAny((PetscObject)pc->pmat, &blk, MATBAIJ, MATSBAIJ, MATSEQBAIJ, MATSEQSBAIJ, MATMPIBAIJ, MATMPISBAIJ, NULL));
6064db63379SBarry Smith       PetscCheck(!blk, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Cannot use MATBAIJ with PCFIELDSPLIT and currently set matrix and PC blocksizes");
6074db63379SBarry Smith     }
6084db63379SBarry Smith 
60980670ca5SBarry Smith     if (!matnest) { /* use the matrix blocksize and stride IS to determine the index sets that define the submatrices */
61051f519a2SBarry Smith       bs = jac->bs;
6119566063dSJacob Faibussowitsch       PetscCall(MatGetOwnershipRange(pc->pmat, &rstart, &rend));
6121b9fc7fcSBarry Smith       nslots = (rend - rstart) / bs;
6131b9fc7fcSBarry Smith       for (i = 0; i < nsplit; i++) {
6141b9fc7fcSBarry Smith         if (jac->defaultsplit) {
6159566063dSJacob Faibussowitsch           PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + i, nsplit, &ilink->is));
6162033cbf1SStefano Zampini           PetscCall(PetscObjectReference((PetscObject)ilink->is));
6172033cbf1SStefano Zampini           ilink->is_col = ilink->is;
618704ba839SBarry Smith         } else if (!ilink->is) {
6192033cbf1SStefano Zampini           PetscBool same_fields = PETSC_TRUE;
6202033cbf1SStefano Zampini 
6212033cbf1SStefano Zampini           for (PetscInt k = 0; k < ilink->nfields; k++) {
6222033cbf1SStefano Zampini             if (ilink->fields[k] != ilink->fields_col[k]) same_fields = PETSC_FALSE;
6232033cbf1SStefano Zampini           }
6242033cbf1SStefano Zampini 
625ccb205f8SBarry Smith           if (ilink->nfields > 1) {
6265f4ab4e1SJungho Lee             PetscInt *ii, *jj, j, k, nfields = ilink->nfields, *fields = ilink->fields, *fields_col = ilink->fields_col;
62780670ca5SBarry Smith 
6289566063dSJacob Faibussowitsch             PetscCall(PetscMalloc1(ilink->nfields * nslots, &ii));
6292033cbf1SStefano Zampini             if (!same_fields) PetscCall(PetscMalloc1(ilink->nfields * nslots, &jj));
6301b9fc7fcSBarry Smith             for (j = 0; j < nslots; j++) {
6311b9fc7fcSBarry Smith               for (k = 0; k < nfields; k++) {
6321b9fc7fcSBarry Smith                 ii[nfields * j + k] = rstart + bs * j + fields[k];
6332033cbf1SStefano Zampini                 if (!same_fields) jj[nfields * j + k] = rstart + bs * j + fields_col[k];
63497bbdb24SBarry Smith               }
63597bbdb24SBarry Smith             }
6369566063dSJacob Faibussowitsch             PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, ii, PETSC_OWN_POINTER, &ilink->is));
6372033cbf1SStefano Zampini             if (!same_fields) PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)pc), nslots * nfields, jj, PETSC_OWN_POINTER, &ilink->is_col));
6382033cbf1SStefano Zampini             else {
6392033cbf1SStefano Zampini               PetscCall(PetscObjectReference((PetscObject)ilink->is));
6402033cbf1SStefano Zampini               ilink->is_col = ilink->is;
6412033cbf1SStefano Zampini             }
6429566063dSJacob Faibussowitsch             PetscCall(ISSetBlockSize(ilink->is, nfields));
6439566063dSJacob Faibussowitsch             PetscCall(ISSetBlockSize(ilink->is_col, nfields));
644ccb205f8SBarry Smith           } else {
6459566063dSJacob Faibussowitsch             PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields[0], bs, &ilink->is));
6462033cbf1SStefano Zampini             if (!same_fields) PetscCall(ISCreateStride(PetscObjectComm((PetscObject)pc), nslots, rstart + ilink->fields_col[0], bs, &ilink->is_col));
6472033cbf1SStefano Zampini             else {
6482033cbf1SStefano Zampini               PetscCall(PetscObjectReference((PetscObject)ilink->is));
6492033cbf1SStefano Zampini               ilink->is_col = ilink->is;
650ccb205f8SBarry Smith             }
6513e197d65SBarry Smith           }
6522033cbf1SStefano Zampini         }
653704ba839SBarry Smith         ilink = ilink->next;
6541b9fc7fcSBarry Smith       }
65580670ca5SBarry Smith     } else { /* use the IS that define the MATNEST to determine the index sets that define the submatrices */
65680670ca5SBarry Smith       IS      *rowis, *colis, *ises = NULL;
65780670ca5SBarry Smith       PetscInt mis, nis;
65880670ca5SBarry Smith 
65980670ca5SBarry Smith       PetscCall(MatNestGetSize(pc->pmat, &mis, &nis));
66080670ca5SBarry Smith       PetscCall(PetscMalloc2(mis, &rowis, nis, &colis));
66180670ca5SBarry Smith       PetscCall(MatNestGetISs(pc->pmat, rowis, colis));
66280670ca5SBarry Smith       if (!jac->defaultsplit) PetscCall(PetscMalloc1(mis, &ises));
66380670ca5SBarry Smith 
66480670ca5SBarry Smith       for (i = 0; i < nsplit; i++) {
66580670ca5SBarry Smith         if (jac->defaultsplit) {
66680670ca5SBarry Smith           PetscCall(ISDuplicate(rowis[i], &ilink->is));
6672033cbf1SStefano Zampini           PetscCall(PetscObjectReference((PetscObject)ilink->is));
6682033cbf1SStefano Zampini           ilink->is_col = ilink->is;
66980670ca5SBarry Smith         } else if (!ilink->is) {
67080670ca5SBarry Smith           if (ilink->nfields > 1) {
67180670ca5SBarry Smith             for (PetscInt j = 0; j < ilink->nfields; j++) ises[j] = rowis[ilink->fields[j]];
67280670ca5SBarry Smith             PetscCall(ISConcatenate(PetscObjectComm((PetscObject)pc), ilink->nfields, ises, &ilink->is));
67380670ca5SBarry Smith           } else {
67480670ca5SBarry Smith             PetscCall(ISDuplicate(rowis[ilink->fields[0]], &ilink->is));
67580670ca5SBarry Smith           }
6762033cbf1SStefano Zampini           PetscCall(PetscObjectReference((PetscObject)ilink->is));
6772033cbf1SStefano Zampini           ilink->is_col = ilink->is;
67880670ca5SBarry Smith         }
67980670ca5SBarry Smith         ilink = ilink->next;
68080670ca5SBarry Smith       }
68180670ca5SBarry Smith       PetscCall(PetscFree2(rowis, colis));
68280670ca5SBarry Smith       PetscCall(PetscFree(ises));
68380670ca5SBarry Smith     }
6841b9fc7fcSBarry Smith   }
6851b9fc7fcSBarry Smith 
686704ba839SBarry Smith   ilink = jac->head;
68797bbdb24SBarry Smith   if (!jac->pmat) {
688bdddcaaaSMatthew G Knepley     Vec xtmp;
689bdddcaaaSMatthew G Knepley 
6909566063dSJacob Faibussowitsch     PetscCall(MatCreateVecs(pc->pmat, &xtmp, NULL));
6919566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nsplit, &jac->pmat));
6929566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nsplit, &jac->x, nsplit, &jac->y));
693cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
694bdddcaaaSMatthew G Knepley       MatNullSpace sp;
695bdddcaaaSMatthew G Knepley 
6967addb90fSBarry Smith       /* Check for matrix attached to IS */
6979566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&jac->pmat[i]));
698a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
6999566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->pmat[i]));
700a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
701a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
7022fa5cd67SKarl Rupp 
7039566063dSJacob Faibussowitsch           PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
704a3df900dSMatthew G Knepley         }
705a3df900dSMatthew G Knepley       } else {
7063a062f41SBarry Smith         const char *prefix;
7079566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->pmat[i]));
7082f427464SPierre Jolivet         PetscCall(MatGetOptionsPrefix(jac->pmat[i], &prefix));
7092f427464SPierre Jolivet         if (!prefix) {
7109566063dSJacob Faibussowitsch           PetscCall(KSPGetOptionsPrefix(ilink->ksp, &prefix));
7119566063dSJacob Faibussowitsch           PetscCall(MatSetOptionsPrefix(jac->pmat[i], prefix));
7122f427464SPierre Jolivet         }
71345881c45SPierre Jolivet         PetscCall(MatSetFromOptions(jac->pmat[i]));
7149566063dSJacob Faibussowitsch         PetscCall(MatViewFromOptions(jac->pmat[i], NULL, "-mat_view"));
715a3df900dSMatthew G Knepley       }
716bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
7179566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(jac->pmat[i], &jac->x[i], &jac->y[i]));
7189371c9d4SSatish Balay       ilink->x = jac->x[i];
7199371c9d4SSatish Balay       ilink->y = jac->y[i];
7209371c9d4SSatish Balay       ilink->z = NULL;
721bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
7229566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(xtmp, ilink->is, jac->x[i], NULL, &ilink->sctx));
7239566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nearnullspace", (PetscObject *)&sp));
72448a46eb9SPierre Jolivet       if (sp) PetscCall(MatSetNearNullSpace(jac->pmat[i], sp));
725704ba839SBarry Smith       ilink = ilink->next;
726cf502942SBarry Smith     }
7279566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&xtmp));
72897bbdb24SBarry Smith   } else {
729ef7efd37SHong Zhang     MatReuse      scall;
7304849c82aSBarry Smith     MatNullSpace *nullsp = NULL;
7314849c82aSBarry Smith 
732ef7efd37SHong Zhang     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7334849c82aSBarry Smith       PetscCall(MatGetNullSpaces(nsplit, jac->pmat, &nullsp));
73448a46eb9SPierre Jolivet       for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->pmat[i]));
735ef7efd37SHong Zhang       scall = MAT_INITIAL_MATRIX;
736ef7efd37SHong Zhang     } else scall = MAT_REUSE_MATRIX;
737ef7efd37SHong Zhang 
738cf502942SBarry Smith     for (i = 0; i < nsplit; i++) {
739a3df900dSMatthew G Knepley       Mat pmat;
740a3df900dSMatthew G Knepley 
7417addb90fSBarry Smith       /* Check for matrix attached to IS */
7429566063dSJacob Faibussowitsch       PetscCall(PetscObjectQuery((PetscObject)ilink->is, "pmat", (PetscObject *)&pmat));
74348a46eb9SPierre Jolivet       if (!pmat) PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, ilink->is_col, scall, &jac->pmat[i]));
744704ba839SBarry Smith       ilink = ilink->next;
745cf502942SBarry Smith     }
7464849c82aSBarry Smith     if (nullsp) PetscCall(MatRestoreNullSpaces(nsplit, jac->pmat, &nullsp));
74797bbdb24SBarry Smith   }
7484e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
749519d70e2SJed Brown     ilink = jac->head;
750519d70e2SJed Brown     if (!jac->mat) {
7519566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nsplit, &jac->mat));
752519d70e2SJed Brown       for (i = 0; i < nsplit; i++) {
7539566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, MAT_INITIAL_MATRIX, &jac->mat[i]));
754519d70e2SJed Brown         ilink = ilink->next;
755519d70e2SJed Brown       }
756519d70e2SJed Brown     } else {
757ef7efd37SHong Zhang       MatReuse      scall;
7584849c82aSBarry Smith       MatNullSpace *nullsp = NULL;
7594849c82aSBarry Smith 
760ef7efd37SHong Zhang       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
7614849c82aSBarry Smith         PetscCall(MatGetNullSpaces(nsplit, jac->mat, &nullsp));
76248a46eb9SPierre Jolivet         for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->mat[i]));
763ef7efd37SHong Zhang         scall = MAT_INITIAL_MATRIX;
764ef7efd37SHong Zhang       } else scall = MAT_REUSE_MATRIX;
765ef7efd37SHong Zhang 
766ef7efd37SHong Zhang       for (i = 0; i < nsplit; i++) {
7679566063dSJacob Faibussowitsch         PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, ilink->is_col, scall, &jac->mat[i]));
768519d70e2SJed Brown         ilink = ilink->next;
769519d70e2SJed Brown       }
7704849c82aSBarry Smith       if (nullsp) PetscCall(MatRestoreNullSpaces(nsplit, jac->mat, &nullsp));
771519d70e2SJed Brown     }
772519d70e2SJed Brown   } else {
773519d70e2SJed Brown     jac->mat = jac->pmat;
774519d70e2SJed Brown   }
77597bbdb24SBarry Smith 
77653935eafSBarry Smith   /* Check for null space attached to IS */
77753935eafSBarry Smith   ilink = jac->head;
77853935eafSBarry Smith   for (i = 0; i < nsplit; i++) {
77953935eafSBarry Smith     MatNullSpace sp;
78053935eafSBarry Smith 
7819566063dSJacob Faibussowitsch     PetscCall(PetscObjectQuery((PetscObject)ilink->is, "nullspace", (PetscObject *)&sp));
78248a46eb9SPierre Jolivet     if (sp) PetscCall(MatSetNullSpace(jac->mat[i], sp));
78353935eafSBarry Smith     ilink = ilink->next;
78453935eafSBarry Smith   }
78553935eafSBarry Smith 
786a51937d4SCarola Kruse   if (jac->type != PC_COMPOSITE_ADDITIVE && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) {
78768dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
7884e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
78968dd23aaSBarry Smith     ilink = jac->head;
790e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
791e52d2c62SBarry 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 */
792e52d2c62SBarry Smith       if (!jac->Afield) {
7939566063dSJacob Faibussowitsch         PetscCall(PetscCalloc1(nsplit, &jac->Afield));
79480c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7959566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
796e52d2c62SBarry Smith         } else {
7979566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->Afield[1]));
79880c96bb1SFande Kong         }
79980c96bb1SFande Kong       } else {
800ef7efd37SHong Zhang         MatReuse scall;
801e9422dd5SStefano Zampini 
802ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
8039566063dSJacob Faibussowitsch           PetscCall(MatDestroy(&jac->Afield[1]));
804ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
805ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
806ef7efd37SHong Zhang 
80780c96bb1SFande Kong         if (jac->offdiag_use_amat) {
8089566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->mat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
80980c96bb1SFande Kong         } else {
8109566063dSJacob Faibussowitsch           PetscCall(MatCreateSubMatrix(pc->pmat, ilink->next->is, ilink->is, scall, &jac->Afield[1]));
81180c96bb1SFande Kong         }
812e52d2c62SBarry Smith       }
813e52d2c62SBarry Smith     } else {
81468dd23aaSBarry Smith       if (!jac->Afield) {
8159566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nsplit, &jac->Afield));
81668dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
81780c96bb1SFande Kong           if (jac->offdiag_use_amat) {
8189566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
81980c96bb1SFande Kong           } else {
8209566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, MAT_INITIAL_MATRIX, &jac->Afield[i]));
82180c96bb1SFande Kong           }
82268dd23aaSBarry Smith           ilink = ilink->next;
82368dd23aaSBarry Smith         }
82468dd23aaSBarry Smith       } else {
825ef7efd37SHong Zhang         MatReuse scall;
826ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
82748a46eb9SPierre Jolivet           for (i = 0; i < nsplit; i++) PetscCall(MatDestroy(&jac->Afield[i]));
828ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
829ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
830ef7efd37SHong Zhang 
83168dd23aaSBarry Smith         for (i = 0; i < nsplit; i++) {
83280c96bb1SFande Kong           if (jac->offdiag_use_amat) {
8339566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->mat, ilink->is, NULL, scall, &jac->Afield[i]));
83480c96bb1SFande Kong           } else {
8359566063dSJacob Faibussowitsch             PetscCall(MatCreateSubMatrix(pc->pmat, ilink->is, NULL, scall, &jac->Afield[i]));
83680c96bb1SFande Kong           }
83768dd23aaSBarry Smith           ilink = ilink->next;
83868dd23aaSBarry Smith         }
83968dd23aaSBarry Smith       }
84068dd23aaSBarry Smith     }
841e52d2c62SBarry Smith   }
84268dd23aaSBarry Smith 
8433b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
84418f54938SStefano Zampini     PetscBool   isset, isspd = PETSC_FALSE, issym = PETSC_FALSE, flg;
845093c86ffSJed Brown     char        lscname[256];
846093c86ffSJed Brown     PetscObject LSC_L;
847ce94432eSBarry Smith 
84808401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use Schur complement preconditioner you must have exactly 2 fields");
84968dd23aaSBarry Smith 
850c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
851b94d7dedSBarry Smith     PetscCall(MatIsSPDKnown(pc->pmat, &isset, &isspd));
85218f54938SStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) jac->schurscale = (isset && isspd) ? 1.0 : -1.0;
85318f54938SStefano Zampini     PetscCall(MatIsSymmetricKnown(pc->pmat, &isset, &issym));
854c096484dSStefano Zampini 
855558f3fe8SPierre Jolivet     PetscCall(PetscObjectTypeCompareAny(jac->offdiag_use_amat ? (PetscObject)pc->mat : (PetscObject)pc->pmat, &flg, MATSEQSBAIJ, MATMPISBAIJ, ""));
856e6cab6aaSJed Brown 
8573b224e63SBarry Smith     if (jac->schur) {
8580298fd71SBarry Smith       KSP      kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
859e9422dd5SStefano Zampini       MatReuse scall;
860e9422dd5SStefano Zampini 
861e9422dd5SStefano Zampini       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
862e9422dd5SStefano Zampini         scall = MAT_INITIAL_MATRIX;
8639566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->B));
8649566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->C));
865e9422dd5SStefano Zampini       } else scall = MAT_REUSE_MATRIX;
866443836d0SMatthew G Knepley 
8679566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
8683b224e63SBarry Smith       ilink = jac->head;
869*ad881d7cSPierre Jolivet       PetscCall(MatCreateSubMatrix(jac->offdiag_use_amat ? pc->mat : pc->pmat, ilink->is, ilink->next->is, scall, &jac->B));
870*ad881d7cSPierre Jolivet       if (!flg) PetscCall(MatCreateSubMatrix(jac->offdiag_use_amat ? pc->mat : pc->pmat, ilink->next->is, ilink->is, scall, &jac->C));
871*ad881d7cSPierre Jolivet       else {
87218f54938SStefano Zampini         PetscCall(MatIsHermitianKnown(jac->offdiag_use_amat ? pc->mat : pc->pmat, &isset, &flg));
87318f54938SStefano Zampini         if (isset && flg) PetscCall(MatCreateHermitianTranspose(jac->B, &jac->C));
874558f3fe8SPierre Jolivet         else PetscCall(MatCreateTranspose(jac->B, &jac->C));
875558f3fe8SPierre Jolivet       }
876*ad881d7cSPierre Jolivet       ilink = ilink->next;
8779566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementUpdateSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
878a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
8799566063dSJacob Faibussowitsch         PetscCall(MatDestroy(&jac->schurp));
8809566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
8815becce15SPierre Jolivet       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL && jac->kspupper != jac->head->ksp) {
882d9eadc85SPierre Jolivet         PetscCall(MatDestroy(&jac->schur_user));
883d9eadc85SPierre Jolivet         PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
884a7476a74SDmitry Karpeev       }
88548a46eb9SPierre Jolivet       if (kspA != kspInner) PetscCall(KSPSetOperators(kspA, jac->mat[0], jac->pmat[0]));
88648a46eb9SPierre Jolivet       if (kspUpper != kspA) PetscCall(KSPSetOperators(kspUpper, jac->mat[0], jac->pmat[0]));
8879566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
8883b224e63SBarry Smith     } else {
889bafc1b83SMatthew G Knepley       const char  *Dprefix;
890470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
891514bf10dSMatthew G Knepley       char         schurtestoption[256];
892bdddcaaaSMatthew G Knepley       MatNullSpace sp;
893686bed4dSStefano Zampini       KSP          kspt;
8943b224e63SBarry Smith 
895a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
8963b224e63SBarry Smith       ilink = jac->head;
897*ad881d7cSPierre Jolivet       PetscCall(MatCreateSubMatrix(jac->offdiag_use_amat ? pc->mat : pc->pmat, ilink->is, ilink->next->is, MAT_INITIAL_MATRIX, &jac->B));
898*ad881d7cSPierre Jolivet       if (!flg) PetscCall(MatCreateSubMatrix(jac->offdiag_use_amat ? pc->mat : pc->pmat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->C));
899*ad881d7cSPierre Jolivet       else {
90018f54938SStefano Zampini         PetscCall(MatIsHermitianKnown(jac->offdiag_use_amat ? pc->mat : pc->pmat, &isset, &flg));
90118f54938SStefano Zampini         if (isset && flg) PetscCall(MatCreateHermitianTranspose(jac->B, &jac->C));
902558f3fe8SPierre Jolivet         else PetscCall(MatCreateTranspose(jac->B, &jac->C));
903558f3fe8SPierre Jolivet       }
904*ad881d7cSPierre Jolivet       ilink = ilink->next;
905f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
9069566063dSJacob Faibussowitsch       PetscCall(MatCreate(((PetscObject)jac->mat[0])->comm, &jac->schur));
9079566063dSJacob Faibussowitsch       PetscCall(MatSetType(jac->schur, MATSCHURCOMPLEMENT));
9089566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementSetSubMatrices(jac->schur, jac->mat[0], jac->pmat[0], jac->B, jac->C, jac->mat[1]));
9099566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
9109566063dSJacob Faibussowitsch       PetscCall(MatSetOptionsPrefix(jac->schur, schurmatprefix));
9119566063dSJacob Faibussowitsch       PetscCall(MatSchurComplementGetKSP(jac->schur, &kspt));
9129566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(kspt, schurmatprefix));
913686bed4dSStefano Zampini 
914686bed4dSStefano Zampini       /* Note: this is not true in general */
9159566063dSJacob Faibussowitsch       PetscCall(MatGetNullSpace(jac->mat[1], &sp));
9161baa6e33SBarry Smith       if (sp) PetscCall(MatSetNullSpace(jac->schur, sp));
91720252d06SBarry Smith 
9189566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname));
91954a546c1SMatthew G. Knepley       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, NULL, &flg));
920514bf10dSMatthew G Knepley       if (flg) {
921514bf10dSMatthew G Knepley         DM  dmInner;
92221635b76SJed Brown         KSP kspInner;
923686bed4dSStefano Zampini         PC  pcInner;
92421635b76SJed Brown 
9259566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
9269566063dSJacob Faibussowitsch         PetscCall(KSPReset(kspInner));
9279566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(kspInner, jac->mat[0], jac->pmat[0]));
9289566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
92921635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
9309566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject)pc, 2));
9319566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject)pc, 2));
9329566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(kspInner, schurprefix));
933514bf10dSMatthew G Knepley 
934514bf10dSMatthew G Knepley         /* Set DM for new solver */
9359566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
9369566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(kspInner, dmInner));
9379566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(kspInner, PETSC_FALSE));
938686bed4dSStefano Zampini 
939686bed4dSStefano Zampini         /* Defaults to PCKSP as preconditioner */
9409566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9419566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcInner, PCKSP));
9429566063dSJacob Faibussowitsch         PetscCall(PCKSPSetKSP(pcInner, jac->head->ksp));
943514bf10dSMatthew G Knepley       } else {
94421635b76SJed Brown         /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
94521635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
94621635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
94721635b76SJed 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
94821635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
94921635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
9509566063dSJacob Faibussowitsch         PetscCall(KSPSetType(jac->head->ksp, KSPGMRES));
9519566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementSetKSP(jac->schur, jac->head->ksp));
952bafc1b83SMatthew G Knepley       }
9539566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->head->ksp, jac->mat[0], jac->pmat[0]));
9549566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->head->ksp));
9559566063dSJacob Faibussowitsch       PetscCall(MatSetFromOptions(jac->schur));
9563b224e63SBarry Smith 
9579566063dSJacob Faibussowitsch       PetscCall(PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg));
958686bed4dSStefano Zampini       if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */
959686bed4dSStefano Zampini         KSP kspInner;
960686bed4dSStefano Zampini         PC  pcInner;
961686bed4dSStefano Zampini 
9629566063dSJacob Faibussowitsch         PetscCall(MatSchurComplementGetKSP(jac->schur, &kspInner));
9639566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(kspInner, &pcInner));
9649566063dSJacob Faibussowitsch         PetscCall(PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg));
965686bed4dSStefano Zampini         if (flg) {
966686bed4dSStefano Zampini           KSP ksp;
967686bed4dSStefano Zampini 
9689566063dSJacob Faibussowitsch           PetscCall(PCKSPGetKSP(pcInner, &ksp));
96948a46eb9SPierre Jolivet           if (ksp == jac->head->ksp) PetscCall(PCSetUseAmat(pcInner, PETSC_TRUE));
970686bed4dSStefano Zampini         }
971686bed4dSStefano Zampini       }
9729566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname));
97354a546c1SMatthew G. Knepley       PetscCall(PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, schurtestoption, NULL, NULL, &flg));
974443836d0SMatthew G Knepley       if (flg) {
975443836d0SMatthew G Knepley         DM dmInner;
976443836d0SMatthew G Knepley 
9779566063dSJacob Faibussowitsch         PetscCall(PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
9789566063dSJacob Faibussowitsch         PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper));
9793821be0aSBarry Smith         PetscCall(KSPSetNestLevel(jac->kspupper, pc->kspnestlevel));
9809566063dSJacob Faibussowitsch         PetscCall(KSPSetErrorIfNotConverged(jac->kspupper, pc->erroriffailure));
9819566063dSJacob Faibussowitsch         PetscCall(KSPSetOptionsPrefix(jac->kspupper, schurprefix));
9829566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject)pc, 1));
9839566063dSJacob Faibussowitsch         PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject)pc, 1));
9849566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->ksp, &dmInner));
9859566063dSJacob Faibussowitsch         PetscCall(KSPSetDM(jac->kspupper, dmInner));
9869566063dSJacob Faibussowitsch         PetscCall(KSPSetDMActive(jac->kspupper, PETSC_FALSE));
9879566063dSJacob Faibussowitsch         PetscCall(KSPSetFromOptions(jac->kspupper));
9889566063dSJacob Faibussowitsch         PetscCall(KSPSetOperators(jac->kspupper, jac->mat[0], jac->pmat[0]));
9899566063dSJacob Faibussowitsch         PetscCall(VecDuplicate(jac->head->x, &jac->head->z));
990443836d0SMatthew G Knepley       } else {
991443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
9929566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)jac->head->ksp));
993443836d0SMatthew G Knepley       }
994443836d0SMatthew G Knepley 
99548a46eb9SPierre Jolivet       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) PetscCall(MatSchurComplementGetPmat(jac->schur, MAT_INITIAL_MATRIX, &jac->schurp));
9969566063dSJacob Faibussowitsch       PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspschur));
9973821be0aSBarry Smith       PetscCall(KSPSetNestLevel(jac->kspschur, pc->kspnestlevel));
9989566063dSJacob Faibussowitsch       PetscCall(KSPSetErrorIfNotConverged(jac->kspschur, pc->erroriffailure));
9999566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)jac->kspschur, (PetscObject)pc, 1));
1000084e4875SJed Brown       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
10017233a360SDmitry Karpeev         PC pcschur;
10029566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(jac->kspschur, &pcschur));
10039566063dSJacob Faibussowitsch         PetscCall(PCSetType(pcschur, PCNONE));
1004084e4875SJed Brown         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
1005e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
10065becce15SPierre Jolivet         if (jac->schurfactorization != PC_FIELDSPLIT_SCHUR_FACT_FULL || jac->kspupper != jac->head->ksp) PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
1007e69d4d44SBarry Smith       }
10089566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(jac->kspschur, jac->schur, FieldSplitSchurPre(jac)));
10099566063dSJacob Faibussowitsch       PetscCall(KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix));
10109566063dSJacob Faibussowitsch       PetscCall(KSPSetOptionsPrefix(jac->kspschur, Dprefix));
1011c096484dSStefano Zampini       /* propagate DM */
1012b20b4189SMatthew G. Knepley       {
1013b20b4189SMatthew G. Knepley         DM sdm;
10149566063dSJacob Faibussowitsch         PetscCall(KSPGetDM(jac->head->next->ksp, &sdm));
1015b20b4189SMatthew G. Knepley         if (sdm) {
10169566063dSJacob Faibussowitsch           PetscCall(KSPSetDM(jac->kspschur, sdm));
10179566063dSJacob Faibussowitsch           PetscCall(KSPSetDMActive(jac->kspschur, PETSC_FALSE));
1018b20b4189SMatthew G. Knepley         }
1019b20b4189SMatthew G. Knepley       }
10203b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
102120b26d62SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
10229566063dSJacob Faibussowitsch       PetscCall(KSPSetFromOptions(jac->kspschur));
10233b224e63SBarry Smith     }
10249566063dSJacob Faibussowitsch     PetscCall(MatAssemblyBegin(jac->schur, MAT_FINAL_ASSEMBLY));
10259566063dSJacob Faibussowitsch     PetscCall(MatAssemblyEnd(jac->schur, MAT_FINAL_ASSEMBLY));
102618f54938SStefano Zampini     if (issym) PetscCall(MatSetOption(jac->schur, MAT_SYMMETRIC, PETSC_TRUE));
102718f54938SStefano Zampini     if (isspd) PetscCall(MatSetOption(jac->schur, MAT_SPD, PETSC_TRUE));
1028093c86ffSJed Brown 
1029093c86ffSJed Brown     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
10309566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_L", ilink->splitname));
1031835f2295SStefano Zampini     PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, &LSC_L));
1032835f2295SStefano Zampini     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, &LSC_L));
1033835f2295SStefano Zampini     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_L", LSC_L));
10349566063dSJacob Faibussowitsch     PetscCall(PetscSNPrintf(lscname, sizeof(lscname), "%s_LSC_Lp", ilink->splitname));
1035835f2295SStefano Zampini     PetscCall(PetscObjectQuery((PetscObject)pc->pmat, lscname, &LSC_L));
1036835f2295SStefano Zampini     if (!LSC_L) PetscCall(PetscObjectQuery((PetscObject)pc->mat, lscname, &LSC_L));
1037835f2295SStefano Zampini     if (LSC_L) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "LSC_Lp", LSC_L));
1038a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
103908401ef6SPierre Jolivet     PetscCheck(nsplit == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_INCOMP, "To use GKB preconditioner you must have exactly 2 fields");
1040a51937d4SCarola Kruse     ilink = jac->head;
1041*ad881d7cSPierre Jolivet     PetscCall(MatCreateSubMatrix(jac->offdiag_use_amat ? pc->mat : pc->pmat, ilink->is, ilink->next->is, MAT_INITIAL_MATRIX, &jac->B));
1042e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
10439566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->u));
10449566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->Hu));
10459566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w2));
1046*ad881d7cSPierre Jolivet     PetscCall(MatCreateSubMatrix(jac->offdiag_use_amat ? pc->mat : pc->pmat, ilink->next->is, ilink->is, MAT_INITIAL_MATRIX, &jac->C));
1047a51937d4SCarola Kruse     ilink = ilink->next;
1048e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
10499566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->v));
10509566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->d));
10519566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ilink->x, &jac->w1));
10529566063dSJacob Faibussowitsch     PetscCall(MatGolubKahanComputeExplicitOperator(jac->mat[0], jac->B, jac->C, &jac->H, jac->gkbnu));
10539566063dSJacob Faibussowitsch     PetscCall(PetscCalloc1(jac->gkbdelay, &jac->vecz));
1054e071a0a4SCarola Kruse 
1055a51937d4SCarola Kruse     ilink = jac->head;
10569566063dSJacob Faibussowitsch     PetscCall(KSPSetOperators(ilink->ksp, jac->H, jac->H));
10579566063dSJacob Faibussowitsch     if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
1058e071a0a4SCarola Kruse     /* Create gkb_monitor context */
1059de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1060de482cd7SCarola Kruse       PetscInt tablevel;
10619566063dSJacob Faibussowitsch       PetscCall(PetscViewerCreate(PETSC_COMM_WORLD, &jac->gkbviewer));
10629566063dSJacob Faibussowitsch       PetscCall(PetscViewerSetType(jac->gkbviewer, PETSCVIEWERASCII));
10639566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetTabLevel((PetscObject)ilink->ksp, &tablevel));
10649566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISetTab(jac->gkbviewer, tablevel));
10659566063dSJacob Faibussowitsch       PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)ilink->ksp, 1));
1066de482cd7SCarola Kruse     }
10673b224e63SBarry Smith   } else {
106868bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
106997bbdb24SBarry Smith     i     = 0;
10705a9f2f41SSatish Balay     ilink = jac->head;
10715a9f2f41SSatish Balay     while (ilink) {
10729566063dSJacob Faibussowitsch       PetscCall(KSPSetOperators(ilink->ksp, jac->mat[i], jac->pmat[i]));
10733b224e63SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
10749566063dSJacob Faibussowitsch       if (!jac->suboptionsset) PetscCall(KSPSetFromOptions(ilink->ksp));
107597bbdb24SBarry Smith       i++;
10765a9f2f41SSatish Balay       ilink = ilink->next;
10770971522cSBarry Smith     }
10783b224e63SBarry Smith   }
10793b224e63SBarry Smith 
10805ddf11f8SNicolas Barnafi   /* Set coordinates to the sub PC objects whenever these are set */
10815ddf11f8SNicolas Barnafi   if (jac->coordinates_set) {
10825ddf11f8SNicolas Barnafi     PC pc_coords;
10835ddf11f8SNicolas Barnafi     if (jac->type == PC_COMPOSITE_SCHUR) {
10845ddf11f8SNicolas Barnafi       // Head is first block.
10859566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->head->ksp, &pc_coords));
10869566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->dim, jac->head->ndofs, jac->head->coords));
10875ddf11f8SNicolas Barnafi       // Second one is Schur block, but its KSP object is in kspschur.
10889566063dSJacob Faibussowitsch       PetscCall(KSPGetPC(jac->kspschur, &pc_coords));
10899566063dSJacob Faibussowitsch       PetscCall(PCSetCoordinates(pc_coords, jac->head->next->dim, jac->head->next->ndofs, jac->head->next->coords));
10905ddf11f8SNicolas Barnafi     } else if (jac->type == PC_COMPOSITE_GKB) {
10919d3446b2SPierre Jolivet       PetscCall(PetscInfo(pc, "Warning: Setting coordinates does nothing for the GKB Fieldpslit preconditioner\n"));
10925ddf11f8SNicolas Barnafi     } else {
10935ddf11f8SNicolas Barnafi       ilink = jac->head;
10945ddf11f8SNicolas Barnafi       while (ilink) {
10959566063dSJacob Faibussowitsch         PetscCall(KSPGetPC(ilink->ksp, &pc_coords));
10969566063dSJacob Faibussowitsch         PetscCall(PCSetCoordinates(pc_coords, ilink->dim, ilink->ndofs, ilink->coords));
10975ddf11f8SNicolas Barnafi         ilink = ilink->next;
10985ddf11f8SNicolas Barnafi       }
10995ddf11f8SNicolas Barnafi     }
11005ddf11f8SNicolas Barnafi   }
11015ddf11f8SNicolas Barnafi 
1102c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
11033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11040971522cSBarry Smith }
11050971522cSBarry Smith 
110673716367SStefano Zampini static PetscErrorCode PCSetUpOnBlocks_FieldSplit_Schur(PC pc)
110773716367SStefano Zampini {
110873716367SStefano Zampini   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
110973716367SStefano Zampini   PC_FieldSplitLink ilinkA = jac->head;
111073716367SStefano Zampini   KSP               kspA = ilinkA->ksp, kspUpper = jac->kspupper;
111173716367SStefano Zampini 
111273716367SStefano Zampini   PetscFunctionBegin;
111373716367SStefano Zampini   if (jac->schurfactorization == PC_FIELDSPLIT_SCHUR_FACT_FULL && kspUpper != kspA) {
111473716367SStefano Zampini     PetscCall(KSPSetUp(kspUpper));
111573716367SStefano Zampini     PetscCall(KSPSetUpOnBlocks(kspUpper));
111673716367SStefano Zampini   }
111773716367SStefano Zampini   PetscCall(KSPSetUp(kspA));
111873716367SStefano Zampini   PetscCall(KSPSetUpOnBlocks(kspA));
111973716367SStefano Zampini   if (jac->schurpre != PC_FIELDSPLIT_SCHUR_PRE_FULL) {
112073716367SStefano Zampini     PetscCall(KSPSetUp(jac->kspschur));
112173716367SStefano Zampini     PetscCall(KSPSetUpOnBlocks(jac->kspschur));
1122ab1f0642SPierre Jolivet   } else if (kspUpper == kspA) {
11235becce15SPierre Jolivet     Mat          A;
1124ab1f0642SPierre Jolivet     PetscInt     m, M, N;
1125ab1f0642SPierre Jolivet     VecType      vtype;
1126ab1f0642SPierre Jolivet     PetscMemType mtype;
1127ab1f0642SPierre Jolivet     PetscScalar *array;
1128ab1f0642SPierre Jolivet 
1129ab1f0642SPierre Jolivet     PetscCall(MatGetSize(jac->B, &M, &N));
1130ab1f0642SPierre Jolivet     PetscCall(MatGetLocalSize(jac->B, &m, NULL));
1131ab1f0642SPierre Jolivet     PetscCall(MatGetVecType(jac->B, &vtype));
1132ab1f0642SPierre Jolivet     PetscCall(VecGetArrayAndMemType(ilinkA->x, &array, &mtype));
1133ab1f0642SPierre Jolivet     PetscCall(VecRestoreArrayAndMemType(ilinkA->x, &array));
1134ab1f0642SPierre Jolivet     if (PetscMemTypeHost(mtype) || (!PetscDefined(HAVE_CUDA) && !PetscDefined(HAVE_HIP))) PetscCall(PetscMalloc1(m * (N + 1), &array));
1135ab1f0642SPierre Jolivet #if PetscDefined(HAVE_CUDA)
1136ab1f0642SPierre Jolivet     else if (PetscMemTypeCUDA(mtype)) PetscCallCUDA(cudaMalloc((void **)&array, sizeof(PetscScalar) * m * (N + 1)));
1137ab1f0642SPierre Jolivet #endif
1138ab1f0642SPierre Jolivet #if PetscDefined(HAVE_HIP)
1139ab1f0642SPierre Jolivet     else if (PetscMemTypeHIP(mtype)) PetscCallHIP(hipMalloc((void **)&array, sizeof(PetscScalar) * m * (N + 1)));
1140ab1f0642SPierre Jolivet #endif
1141ab1f0642SPierre 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
11425becce15SPierre Jolivet     PetscCall(PetscObjectCompose((PetscObject)jac->schur, "AinvB", (PetscObject)A));
11435becce15SPierre Jolivet     PetscCall(MatDestroy(&A));
114473716367SStefano Zampini   }
114573716367SStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
114673716367SStefano Zampini }
114773716367SStefano Zampini 
114873716367SStefano Zampini static PetscErrorCode PCSetUpOnBlocks_FieldSplit(PC pc)
114973716367SStefano Zampini {
115073716367SStefano Zampini   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
115173716367SStefano Zampini   PC_FieldSplitLink ilink = jac->head;
115273716367SStefano Zampini 
115373716367SStefano Zampini   PetscFunctionBegin;
115473716367SStefano Zampini   while (ilink) {
115573716367SStefano Zampini     PetscCall(KSPSetUp(ilink->ksp));
115673716367SStefano Zampini     PetscCall(KSPSetUpOnBlocks(ilink->ksp));
115773716367SStefano Zampini     ilink = ilink->next;
115873716367SStefano Zampini   }
115973716367SStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
116073716367SStefano Zampini }
116173716367SStefano Zampini 
116273716367SStefano Zampini static PetscErrorCode PCSetUpOnBlocks_FieldSplit_GKB(PC pc)
116373716367SStefano Zampini {
116473716367SStefano Zampini   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
116573716367SStefano Zampini   PC_FieldSplitLink ilinkA = jac->head;
116673716367SStefano Zampini   KSP               ksp    = ilinkA->ksp;
116773716367SStefano Zampini 
116873716367SStefano Zampini   PetscFunctionBegin;
116973716367SStefano Zampini   PetscCall(KSPSetUp(ksp));
117073716367SStefano Zampini   PetscCall(KSPSetUpOnBlocks(ksp));
117173716367SStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
117273716367SStefano Zampini }
117373716367SStefano Zampini 
1174d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_Schur(PC pc, Vec x, Vec y)
1175d71ae5a4SJacob Faibussowitsch {
11763b224e63SBarry Smith   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
11773b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1178443836d0SMatthew G Knepley   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
1179d9eadc85SPierre Jolivet   Mat               AinvB = NULL;
1180ab1f0642SPierre Jolivet   PetscInt          N, P;
11813b224e63SBarry Smith 
11823b224e63SBarry Smith   PetscFunctionBegin;
1183c5d2311dSJed Brown   switch (jac->schurfactorization) {
1184c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
1185a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
11869566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11879566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11889566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
11899566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11909566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
11919566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
11929566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
11939566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
11949566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
11959566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1196e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
11979566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
11989566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
1199e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
12009566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12019566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->y, jac->schurscale));
12029566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12039566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12049566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1205c5d2311dSJed Brown     break;
1206c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
1207a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
12089566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12099566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12109566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12119566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
12129566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12139566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12149566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
12159566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.));
12169566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12179566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12189566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12199566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1220e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
12219566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
1222e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
12239566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12249566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12259566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12269566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12279566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
1228c5d2311dSJed Brown     break;
1229c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
1230a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
12319566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12329566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
12339566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1234e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
12359566063dSJacob Faibussowitsch     PetscCall(KSPSolve(jac->kspschur, ilinkD->x, ilinkD->y));
1236e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
12379566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
12389371c9d4SSatish Balay     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
12399371c9d4SSatish Balay     PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
12409566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkA->x, -1.));
12419566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
12429566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12439566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
12449566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12459566063dSJacob Faibussowitsch     PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
12469566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
12479566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
12489566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
12499566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
12509566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1251c5d2311dSJed Brown     break;
1252c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
1253c238f8cdSStefano Zampini     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */
1254ab1f0642SPierre Jolivet     PetscCall(MatGetSize(jac->B, NULL, &P));
1255ab1f0642SPierre Jolivet     N = P;
12569566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12579566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
12589566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
1259d9eadc85SPierre Jolivet     if (kspUpper == kspA) {
1260d9eadc85SPierre Jolivet       PetscCall(PetscObjectQuery((PetscObject)jac->schur, "AinvB", (PetscObject *)&AinvB));
1261d9eadc85SPierre Jolivet       if (AinvB) {
1262d9eadc85SPierre Jolivet         PetscCall(MatGetSize(AinvB, NULL, &N));
1263ab1f0642SPierre Jolivet         if (N > P) { // first time PCApply_FieldSplit_Schur() is called
1264f7cbcdf3SPierre Jolivet           PetscMemType mtype;
1265ab1f0642SPierre Jolivet           Vec          c = NULL;
1266f7cbcdf3SPierre Jolivet           PetscScalar *array;
1267ab1f0642SPierre Jolivet           PetscInt     m, M;
1268d9eadc85SPierre Jolivet 
1269ab1f0642SPierre Jolivet           PetscCall(MatGetSize(jac->B, &M, NULL));
1270d9eadc85SPierre Jolivet           PetscCall(MatGetLocalSize(jac->B, &m, NULL));
1271ab1f0642SPierre Jolivet           PetscCall(MatDenseGetArrayAndMemType(AinvB, &array, &mtype));
1272ab1f0642SPierre Jolivet           if (PetscMemTypeHost(mtype) || (!PetscDefined(HAVE_CUDA) && !PetscDefined(HAVE_HIP))) PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)jac->schur), 1, m, M, array + m * P, &c));
1273f7cbcdf3SPierre Jolivet #if PetscDefined(HAVE_CUDA)
1274ab1f0642SPierre Jolivet           else if (PetscMemTypeCUDA(mtype)) PetscCall(VecCreateMPICUDAWithArray(PetscObjectComm((PetscObject)jac->schur), 1, m, M, array + m * P, &c));
1275f7cbcdf3SPierre Jolivet #endif
1276f7cbcdf3SPierre Jolivet #if PetscDefined(HAVE_HIP)
1277ab1f0642SPierre Jolivet           else if (PetscMemTypeHIP(mtype)) PetscCall(VecCreateMPIHIPWithArray(PetscObjectComm((PetscObject)jac->schur), 1, m, M, array + m * P, &c));
1278f7cbcdf3SPierre Jolivet #endif
1279ab1f0642SPierre Jolivet           PetscCall(MatDenseRestoreArrayAndMemType(AinvB, &array));
1280ab1f0642SPierre Jolivet           PetscCall(VecCopy(ilinkA->x, c));
1281d9eadc85SPierre Jolivet           PetscCall(MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user));
1282d9eadc85SPierre Jolivet           PetscCall(KSPSetOperators(jac->kspschur, jac->schur, jac->schur_user));
1283f7cbcdf3SPierre Jolivet           PetscCall(VecCopy(c, ilinkA->y)); // retrieve the solution as the last column of the composed Mat
1284f7cbcdf3SPierre Jolivet           PetscCall(VecDestroy(&c));
1285d9eadc85SPierre Jolivet         }
1286d9eadc85SPierre Jolivet       }
1287d9eadc85SPierre Jolivet     }
1288ab1f0642SPierre Jolivet     if (N == P) PetscCall(KSPSolve(kspLower, ilinkA->x, ilinkA->y));
12899566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->y));
12909566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->y, NULL));
12919566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->C, ilinkA->y, ilinkD->x));
12929566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, -1.0));
12939566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12949566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
12953b224e63SBarry Smith 
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));
13019566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13029566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13033b224e63SBarry Smith 
1304443836d0SMatthew G Knepley     if (kspUpper == kspA) {
1305d9eadc85SPierre Jolivet       if (!AinvB) {
13069566063dSJacob Faibussowitsch         PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->y));
13079566063dSJacob Faibussowitsch         PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y));
13089566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13099566063dSJacob Faibussowitsch         PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
13109566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13119566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
1312d9eadc85SPierre Jolivet       } else PetscCall(MatMultAdd(AinvB, ilinkD->y, ilinkA->y, ilinkA->y));
1313443836d0SMatthew G Knepley     } else {
13149566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13159566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspA, ilinkA->x, ilinkA->y));
13169566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13179566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->B, ilinkD->y, ilinkA->x));
13189566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
13199566063dSJacob Faibussowitsch       PetscCall(KSPSolve(kspUpper, ilinkA->x, ilinkA->z));
13209566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->z));
13219566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->z, NULL));
13229566063dSJacob Faibussowitsch       PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z));
1323443836d0SMatthew G Knepley     }
13249566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13259566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13269566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
1327c5d2311dSJed Brown   }
13283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
13293b224e63SBarry Smith }
13303b224e63SBarry Smith 
13317b665727SPierre Jolivet static PetscErrorCode PCApplyTranspose_FieldSplit_Schur(PC pc, Vec x, Vec y)
13327b665727SPierre Jolivet {
13337b665727SPierre Jolivet   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
13347b665727SPierre Jolivet   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
13357b665727SPierre Jolivet   KSP               kspA = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
13367b665727SPierre Jolivet 
13377b665727SPierre Jolivet   PetscFunctionBegin;
13387b665727SPierre Jolivet   switch (jac->schurfactorization) {
13397b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
13407b665727SPierre Jolivet     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
13417b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13427b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
13437b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13447b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13457b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
13467b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13477b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13487b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13497b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
13507b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1351e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
13527b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
1353e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
13547b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13557b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13567b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->y, jac->schurscale));
13577b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13587b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13597b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13607b665727SPierre Jolivet     break;
13617b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
13627b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13637b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
13647b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13657b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
13667b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
13677b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13687b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x));
13697b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->x, -1.));
13707b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13717b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13727b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
13737b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1374e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
13757b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
1376e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
13777b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13787b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13797b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
13807b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13817b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13827b665727SPierre Jolivet     break;
13837b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
13847b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
13857b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
13867b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1387e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
13887b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
1389e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
13907b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
13917b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
13927b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x));
13937b665727SPierre Jolivet     PetscCall(VecScale(ilinkA->x, -1.));
13947b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
13957b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
13967b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, ADD_VALUES, SCATTER_FORWARD));
13977b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
13987b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
13997b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
14007b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14017b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14027b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14037b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14047b665727SPierre Jolivet     break;
14057b665727SPierre Jolivet   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
14067b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
14077b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
14087b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL));
14097b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(kspUpper, ilinkA->x, ilinkA->y));
14107b665727SPierre Jolivet     PetscCall(KSPCheckSolve(kspUpper, pc, ilinkA->y));
14117b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_U, kspUpper, ilinkA->x, ilinkA->y, NULL));
14127b665727SPierre Jolivet     PetscCall(MatMultTranspose(jac->B, ilinkA->y, ilinkD->x));
14137b665727SPierre Jolivet     PetscCall(VecScale(ilinkD->x, -1.0));
14147b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
14157b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, ADD_VALUES, SCATTER_FORWARD));
14167b665727SPierre Jolivet 
14177b665727SPierre Jolivet     PetscCall(PetscLogEventBegin(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
1418e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, 1));
14197b665727SPierre Jolivet     PetscCall(KSPSolveTranspose(jac->kspschur, ilinkD->x, ilinkD->y));
1420e0b7e82fSBarry Smith     PetscCall(PetscObjectIncrementTabLevel((PetscObject)kspA, (PetscObject)kspA, -1));
14217b665727SPierre Jolivet     PetscCall(KSPCheckSolve(jac->kspschur, pc, ilinkD->y));
14227b665727SPierre Jolivet     PetscCall(PetscLogEventEnd(KSP_Solve_FS_S, jac->kspschur, ilinkD->x, ilinkD->y, NULL));
14237b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14247b665727SPierre Jolivet 
14257b665727SPierre Jolivet     if (kspLower == kspA) {
14267b665727SPierre Jolivet       PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->y));
14277b665727SPierre Jolivet       PetscCall(VecAXPY(ilinkA->x, -1.0, ilinkA->y));
14287b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14297b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
14307b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
14317b665727SPierre Jolivet       PetscCall(PetscLogEventEnd(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14327b665727SPierre Jolivet     } else {
14337b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(ilinkA->event, kspA, ilinkA->x, ilinkA->y, NULL));
14347b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspA, ilinkA->x, ilinkA->y));
14357b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspA, pc, ilinkA->y));
14367b665727SPierre Jolivet       PetscCall(MatMultTranspose(jac->C, ilinkD->y, ilinkA->x));
14377b665727SPierre Jolivet       PetscCall(PetscLogEventBegin(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL));
14387b665727SPierre Jolivet       PetscCall(KSPSolveTranspose(kspLower, ilinkA->x, ilinkA->z));
14397b665727SPierre Jolivet       PetscCall(KSPCheckSolve(kspLower, pc, ilinkA->z));
14407b665727SPierre Jolivet       PetscCall(PetscLogEventEnd(KSP_Solve_FS_L, kspLower, ilinkA->x, ilinkA->z, NULL));
14417b665727SPierre Jolivet       PetscCall(VecAXPY(ilinkA->y, -1.0, ilinkA->z));
14427b665727SPierre Jolivet     }
14437b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
14447b665727SPierre Jolivet     PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14457b665727SPierre Jolivet     PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
14467b665727SPierre Jolivet   }
14477b665727SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
14487b665727SPierre Jolivet }
14497b665727SPierre Jolivet 
14505becce15SPierre Jolivet #define FieldSplitSplitSolveAdd(ilink, xx, yy) \
14515becce15SPierre Jolivet   ((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) || \
14525becce15SPierre Jolivet                     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) || \
14535becce15SPierre Jolivet                     VecScatterEnd(ilink->sctx, ilink->y, yy, ADD_VALUES, SCATTER_REVERSE)))
14545becce15SPierre Jolivet 
1455d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit(PC pc, Vec x, Vec y)
1456d71ae5a4SJacob Faibussowitsch {
14570971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
14585a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
1459939b8a20SBarry Smith   PetscInt          cnt, bs;
14600971522cSBarry Smith 
14610971522cSBarry Smith   PetscFunctionBegin;
146279416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
146380670ca5SBarry Smith     PetscBool matnest;
146480670ca5SBarry Smith 
146580670ca5SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest));
146680670ca5SBarry Smith     if (jac->defaultsplit && !matnest) {
14679566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
14682472a847SBarry 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);
14699566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
14702472a847SBarry 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);
14719566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
14725a9f2f41SSatish Balay       while (ilink) {
14739566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14749566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
14759566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14769566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14775a9f2f41SSatish Balay         ilink = ilink->next;
14780971522cSBarry Smith       }
14799566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
14801b9fc7fcSBarry Smith     } else {
14819566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
14825a9f2f41SSatish Balay       while (ilink) {
14839566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
14845a9f2f41SSatish Balay         ilink = ilink->next;
14851b9fc7fcSBarry Smith       }
14861b9fc7fcSBarry Smith     }
1487e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
14889566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1489e52d2c62SBarry Smith     /* solve on first block for first block variables */
14909566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
14919566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, INSERT_VALUES, SCATTER_FORWARD));
14929566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14939566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
14949566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
14959566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
14969566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
14979566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
1498e52d2c62SBarry Smith 
1499e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
15009566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->Afield[1], ilink->y, ilink->next->x));
1501e52d2c62SBarry Smith     ilink = ilink->next;
15029566063dSJacob Faibussowitsch     PetscCall(VecScale(ilink->x, -1.0));
15039566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
15049566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
1505e52d2c62SBarry Smith 
1506e52d2c62SBarry Smith     /* solve on second block variables */
15079566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15089566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
15099566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
15109566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15119566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
15129566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
151316913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
151479416396SBarry Smith     if (!jac->w1) {
15159566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
15169566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
151779416396SBarry Smith     }
15189566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
15199566063dSJacob Faibussowitsch     PetscCall(FieldSplitSplitSolveAdd(ilink, x, y));
15203e197d65SBarry Smith     cnt = 1;
15215a9f2f41SSatish Balay     while (ilink->next) {
15225a9f2f41SSatish Balay       ilink = ilink->next;
15233e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
15249566063dSJacob Faibussowitsch       PetscCall(MatMult(jac->Afield[cnt++], y, ilink->x));
15259566063dSJacob Faibussowitsch       PetscCall(VecScale(ilink->x, -1.0));
15269566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
15279566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
15289566063dSJacob Faibussowitsch       PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15299566063dSJacob Faibussowitsch       PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
15309566063dSJacob Faibussowitsch       PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
15319566063dSJacob Faibussowitsch       PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15329566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
15339566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
15343e197d65SBarry Smith     }
153551f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
153611755939SBarry Smith       cnt -= 2;
153751f519a2SBarry Smith       while (ilink->previous) {
153851f519a2SBarry Smith         ilink = ilink->previous;
153911755939SBarry Smith         /* compute the residual only over the part of the vector needed */
15409566063dSJacob Faibussowitsch         PetscCall(MatMult(jac->Afield[cnt--], y, ilink->x));
15419566063dSJacob Faibussowitsch         PetscCall(VecScale(ilink->x, -1.0));
15429566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
15439566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, x, ilink->x, ADD_VALUES, SCATTER_FORWARD));
15449566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15459566063dSJacob Faibussowitsch         PetscCall(KSPSolve(ilink->ksp, ilink->x, ilink->y));
15469566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
15479566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
15489566063dSJacob Faibussowitsch         PetscCall(VecScatterBegin(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
15499566063dSJacob Faibussowitsch         PetscCall(VecScatterEnd(ilink->sctx, ilink->y, y, ADD_VALUES, SCATTER_REVERSE));
155051f519a2SBarry Smith       }
155111755939SBarry Smith     }
155263a3b9bcSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject)pc), PETSC_ERR_SUP, "Unsupported or unknown composition %d", (int)jac->type);
15533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
15540971522cSBarry Smith }
15550971522cSBarry Smith 
1556d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApply_FieldSplit_GKB(PC pc, Vec x, Vec y)
1557d71ae5a4SJacob Faibussowitsch {
1558a51937d4SCarola Kruse   PC_FieldSplit    *jac    = (PC_FieldSplit *)pc->data;
1559a51937d4SCarola Kruse   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
1560a51937d4SCarola Kruse   KSP               ksp = ilinkA->ksp;
1561de482cd7SCarola Kruse   Vec               u, v, Hu, d, work1, work2;
1562e071a0a4SCarola Kruse   PetscScalar       alpha, z, nrmz2, *vecz;
1563e071a0a4SCarola Kruse   PetscReal         lowbnd, nu, beta;
1564a51937d4SCarola Kruse   PetscInt          j, iterGKB;
1565a51937d4SCarola Kruse 
1566a51937d4SCarola Kruse   PetscFunctionBegin;
15679566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
15689566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
15699566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, x, ilinkA->x, INSERT_VALUES, SCATTER_FORWARD));
15709566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, x, ilinkD->x, INSERT_VALUES, SCATTER_FORWARD));
1571e071a0a4SCarola Kruse 
1572e071a0a4SCarola Kruse   u     = jac->u;
1573e071a0a4SCarola Kruse   v     = jac->v;
1574e071a0a4SCarola Kruse   Hu    = jac->Hu;
1575e071a0a4SCarola Kruse   d     = jac->d;
1576e071a0a4SCarola Kruse   work1 = jac->w1;
1577e071a0a4SCarola Kruse   work2 = jac->w2;
1578e071a0a4SCarola Kruse   vecz  = jac->vecz;
1579a51937d4SCarola Kruse 
1580a51937d4SCarola Kruse   /* Change RHS to comply with matrix regularization H = A + nu*B*B' */
1581a51937d4SCarola Kruse   /* Add q = q + nu*B*b */
1582a51937d4SCarola Kruse   if (jac->gkbnu) {
1583a51937d4SCarola Kruse     nu = jac->gkbnu;
15849566063dSJacob Faibussowitsch     PetscCall(VecScale(ilinkD->x, jac->gkbnu));
15859566063dSJacob Faibussowitsch     PetscCall(MatMultAdd(jac->B, ilinkD->x, ilinkA->x, ilinkA->x)); /* q = q + nu*B*b */
1586a51937d4SCarola Kruse   } else {
1587a51937d4SCarola Kruse     /* Situation when no augmented Lagrangian is used. Then we set inner  */
1588a51937d4SCarola Kruse     /* matrix N = I in [Ar13], and thus nu = 1.                           */
1589a51937d4SCarola Kruse     nu = 1;
1590a51937d4SCarola Kruse   }
1591a51937d4SCarola Kruse 
1592a51937d4SCarola Kruse   /* Transform rhs from [q,tilde{b}] to [0,b] */
15939566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
15949566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, ilinkA->x, ilinkA->y));
15959566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, ilinkA->y));
15969566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, ilinkA->x, ilinkA->y, NULL));
15979566063dSJacob Faibussowitsch   PetscCall(MatMultHermitianTranspose(jac->B, ilinkA->y, work1));
15989566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(work1, 1.0 / nu, -1.0, ilinkD->x)); /* c = b - B'*x        */
1599a51937d4SCarola Kruse 
1600a51937d4SCarola Kruse   /* First step of algorithm */
16019566063dSJacob Faibussowitsch   PetscCall(VecNorm(work1, NORM_2, &beta)); /* beta = sqrt(nu*c'*c)*/
1602e071a0a4SCarola Kruse   KSPCheckDot(ksp, beta);
1603addd1e01SJunchao Zhang   beta = PetscSqrtReal(nu) * beta;
16049566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(v, nu / beta, 0.0, work1)); /* v = nu/beta *c      */
16059566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->B, v, work2));          /* u = H^{-1}*B*v      */
16069566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
16079566063dSJacob Faibussowitsch   PetscCall(KSPSolve(ksp, work2, u));
16089566063dSJacob Faibussowitsch   PetscCall(KSPCheckSolve(ksp, pc, u));
16099566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
16109566063dSJacob Faibussowitsch   PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u      */
16119566063dSJacob Faibussowitsch   PetscCall(VecDot(Hu, u, &alpha));
1612e071a0a4SCarola Kruse   KSPCheckDot(ksp, alpha);
161308401ef6SPierre Jolivet   PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1614addd1e01SJunchao Zhang   alpha = PetscSqrtReal(PetscAbsScalar(alpha));
16159566063dSJacob Faibussowitsch   PetscCall(VecScale(u, 1.0 / alpha));
16169566063dSJacob Faibussowitsch   PetscCall(VecAXPBY(d, 1.0 / alpha, 0.0, v)); /* v = nu/beta *c      */
1617de482cd7SCarola Kruse 
1618a51937d4SCarola Kruse   z       = beta / alpha;
1619a51937d4SCarola Kruse   vecz[1] = z;
1620a51937d4SCarola Kruse 
1621de482cd7SCarola Kruse   /* Computation of first iterate x(1) and p(1) */
16229566063dSJacob Faibussowitsch   PetscCall(VecAXPY(ilinkA->y, z, u));
16239566063dSJacob Faibussowitsch   PetscCall(VecCopy(d, ilinkD->y));
16249566063dSJacob Faibussowitsch   PetscCall(VecScale(ilinkD->y, -z));
1625a51937d4SCarola Kruse 
16269371c9d4SSatish Balay   iterGKB = 1;
16279371c9d4SSatish Balay   lowbnd  = 2 * jac->gkbtol;
162848a46eb9SPierre Jolivet   if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1629de482cd7SCarola Kruse 
1630a51937d4SCarola Kruse   while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) {
1631a51937d4SCarola Kruse     iterGKB += 1;
16329566063dSJacob Faibussowitsch     PetscCall(MatMultHermitianTranspose(jac->B, u, work1)); /* v <- nu*(B'*u-alpha/nu*v) */
16339566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(v, nu, -alpha, work1));
16349566063dSJacob Faibussowitsch     PetscCall(VecNorm(v, NORM_2, &beta)); /* beta = sqrt(nu)*v'*v      */
1635addd1e01SJunchao Zhang     beta = beta / PetscSqrtReal(nu);
16369566063dSJacob Faibussowitsch     PetscCall(VecScale(v, 1.0 / beta));
16379566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->B, v, work2)); /* u <- H^{-1}*(B*v-beta*H*u) */
16389566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu));
16399566063dSJacob Faibussowitsch     PetscCall(VecAXPY(work2, -beta, Hu));
16409566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(ilinkA->event, ksp, work2, u, NULL));
16419566063dSJacob Faibussowitsch     PetscCall(KSPSolve(ksp, work2, u));
16429566063dSJacob Faibussowitsch     PetscCall(KSPCheckSolve(ksp, pc, u));
16439566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(ilinkA->event, ksp, work2, u, NULL));
16449566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, u, Hu)); /* alpha = u'*H*u            */
16459566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, u, &alpha));
1646e071a0a4SCarola Kruse     KSPCheckDot(ksp, alpha);
164708401ef6SPierre Jolivet     PetscCheck(PetscRealPart(alpha) > 0.0, PETSC_COMM_SELF, PETSC_ERR_NOT_CONVERGED, "GKB preconditioner diverged, H is not positive definite");
1648addd1e01SJunchao Zhang     alpha = PetscSqrtReal(PetscAbsScalar(alpha));
16499566063dSJacob Faibussowitsch     PetscCall(VecScale(u, 1.0 / alpha));
1650a51937d4SCarola Kruse 
1651e071a0a4SCarola Kruse     z       = -beta / alpha * z; /* z <- beta/alpha*z     */
1652a51937d4SCarola Kruse     vecz[0] = z;
1653a51937d4SCarola Kruse 
1654a51937d4SCarola Kruse     /* Computation of new iterate x(i+1) and p(i+1) */
16559566063dSJacob Faibussowitsch     PetscCall(VecAXPBY(d, 1.0 / alpha, -beta / alpha, v)); /* d = (v-beta*d)/alpha */
16569566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkA->y, z, u));                   /* r = r + z*u          */
16579566063dSJacob Faibussowitsch     PetscCall(VecAXPY(ilinkD->y, -z, d));                  /* p = p - z*d          */
16589566063dSJacob Faibussowitsch     PetscCall(MatMult(jac->H, ilinkA->y, Hu));             /* ||u||_H = u'*H*u     */
16599566063dSJacob Faibussowitsch     PetscCall(VecDot(Hu, ilinkA->y, &nrmz2));
1660a51937d4SCarola Kruse 
1661a51937d4SCarola Kruse     /* Compute Lower Bound estimate */
1662a51937d4SCarola Kruse     if (iterGKB > jac->gkbdelay) {
1663a51937d4SCarola Kruse       lowbnd = 0.0;
1664ad540459SPierre Jolivet       for (j = 0; j < jac->gkbdelay; j++) lowbnd += PetscAbsScalar(vecz[j] * vecz[j]);
1665addd1e01SJunchao Zhang       lowbnd = PetscSqrtReal(lowbnd / PetscAbsScalar(nrmz2));
1666a51937d4SCarola Kruse     }
1667a51937d4SCarola Kruse 
1668ad540459SPierre Jolivet     for (j = 0; j < jac->gkbdelay - 1; j++) vecz[jac->gkbdelay - j - 1] = vecz[jac->gkbdelay - j - 2];
166948a46eb9SPierre Jolivet     if (jac->gkbmonitor) PetscCall(PetscViewerASCIIPrintf(jac->gkbviewer, "%3" PetscInt_FMT " GKB Lower bound estimate %14.12e\n", iterGKB, (double)lowbnd));
1670a51937d4SCarola Kruse   }
1671a51937d4SCarola Kruse 
16729566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
16739566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkA->sctx, ilinkA->y, y, INSERT_VALUES, SCATTER_REVERSE));
16749566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
16759566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(ilinkD->sctx, ilinkD->y, y, INSERT_VALUES, SCATTER_REVERSE));
16763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1677a51937d4SCarola Kruse }
1678a51937d4SCarola Kruse 
1679421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink, xx, yy) \
16803ba16761SJacob 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) || \
16819371c9d4SSatish 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) || \
16823ba16761SJacob Faibussowitsch                     VecScatterEnd(ilink->sctx, ilink->x, yy, ADD_VALUES, SCATTER_REVERSE)))
1683421e10b8SBarry Smith 
1684d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc, Vec x, Vec y)
1685d71ae5a4SJacob Faibussowitsch {
1686421e10b8SBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
1687421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1688939b8a20SBarry Smith   PetscInt          bs;
1689421e10b8SBarry Smith 
1690421e10b8SBarry Smith   PetscFunctionBegin;
1691421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
169280670ca5SBarry Smith     PetscBool matnest;
169380670ca5SBarry Smith 
169480670ca5SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)pc->pmat, MATNEST, &matnest));
169580670ca5SBarry Smith     if (jac->defaultsplit && !matnest) {
16969566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(x, &bs));
16972472a847SBarry 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);
16989566063dSJacob Faibussowitsch       PetscCall(VecGetBlockSize(y, &bs));
16992472a847SBarry 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);
17009566063dSJacob Faibussowitsch       PetscCall(VecStrideGatherAll(x, jac->x, INSERT_VALUES));
1701421e10b8SBarry Smith       while (ilink) {
17029566063dSJacob Faibussowitsch         PetscCall(PetscLogEventBegin(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
17039566063dSJacob Faibussowitsch         PetscCall(KSPSolveTranspose(ilink->ksp, ilink->x, ilink->y));
17049566063dSJacob Faibussowitsch         PetscCall(KSPCheckSolve(ilink->ksp, pc, ilink->y));
17059566063dSJacob Faibussowitsch         PetscCall(PetscLogEventEnd(ilink->event, ilink->ksp, ilink->x, ilink->y, NULL));
1706421e10b8SBarry Smith         ilink = ilink->next;
1707421e10b8SBarry Smith       }
17089566063dSJacob Faibussowitsch       PetscCall(VecStrideScatterAll(jac->y, y, INSERT_VALUES));
1709421e10b8SBarry Smith     } else {
17109566063dSJacob Faibussowitsch       PetscCall(VecSet(y, 0.0));
1711421e10b8SBarry Smith       while (ilink) {
17129566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1713421e10b8SBarry Smith         ilink = ilink->next;
1714421e10b8SBarry Smith       }
1715421e10b8SBarry Smith     }
1716421e10b8SBarry Smith   } else {
1717421e10b8SBarry Smith     if (!jac->w1) {
17189566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w1));
17199566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(x, &jac->w2));
1720421e10b8SBarry Smith     }
17219566063dSJacob Faibussowitsch     PetscCall(VecSet(y, 0.0));
1722421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
17239566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1724421e10b8SBarry Smith       while (ilink->next) {
1725421e10b8SBarry Smith         ilink = ilink->next;
17269566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
17279566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
17289566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1729421e10b8SBarry Smith       }
1730421e10b8SBarry Smith       while (ilink->previous) {
1731421e10b8SBarry Smith         ilink = ilink->previous;
17329566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
17339566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
17349566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1735421e10b8SBarry Smith       }
1736421e10b8SBarry Smith     } else {
1737421e10b8SBarry Smith       while (ilink->next) { /* get to last entry in linked list */
1738421e10b8SBarry Smith         ilink = ilink->next;
1739421e10b8SBarry Smith       }
17409566063dSJacob Faibussowitsch       PetscCall(FieldSplitSplitSolveAddTranspose(ilink, x, y));
1741421e10b8SBarry Smith       while (ilink->previous) {
1742421e10b8SBarry Smith         ilink = ilink->previous;
17439566063dSJacob Faibussowitsch         PetscCall(MatMultTranspose(pc->mat, y, jac->w1));
17449566063dSJacob Faibussowitsch         PetscCall(VecWAXPY(jac->w2, -1.0, jac->w1, x));
17459566063dSJacob Faibussowitsch         PetscCall(FieldSplitSplitSolveAddTranspose(ilink, jac->w2, y));
1746421e10b8SBarry Smith       }
1747421e10b8SBarry Smith     }
1748421e10b8SBarry Smith   }
17493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1750421e10b8SBarry Smith }
1751421e10b8SBarry Smith 
1752d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCReset_FieldSplit(PC pc)
1753d71ae5a4SJacob Faibussowitsch {
17540971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
17555a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head, next;
17560971522cSBarry Smith 
17570971522cSBarry Smith   PetscFunctionBegin;
17585a9f2f41SSatish Balay   while (ilink) {
17599566063dSJacob Faibussowitsch     PetscCall(KSPDestroy(&ilink->ksp));
17609566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->x));
17619566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->y));
17629566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ilink->z));
17639566063dSJacob Faibussowitsch     PetscCall(VecScatterDestroy(&ilink->sctx));
17649566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
17659566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
17669566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->splitname));
17679566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields));
17689566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->fields_col));
17695a9f2f41SSatish Balay     next = ilink->next;
17709566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink));
17715a9f2f41SSatish Balay     ilink = next;
17720971522cSBarry Smith   }
1773f5f0d762SBarry Smith   jac->head = NULL;
17749566063dSJacob Faibussowitsch   PetscCall(PetscFree2(jac->x, jac->y));
1775574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
17769566063dSJacob Faibussowitsch     PetscCall(MatDestroyMatrices(jac->nsplits, &jac->mat));
1777574deadeSBarry Smith   } else if (jac->mat) {
17780298fd71SBarry Smith     jac->mat = NULL;
1779574deadeSBarry Smith   }
17809566063dSJacob Faibussowitsch   if (jac->pmat) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->pmat));
17819566063dSJacob Faibussowitsch   if (jac->Afield) PetscCall(MatDestroyMatrices(jac->nsplits, &jac->Afield));
1782f5f0d762SBarry Smith   jac->nsplits = 0;
17839566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w1));
17849566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->w2));
178573716367SStefano Zampini   if (jac->schur) PetscCall(PetscObjectCompose((PetscObject)jac->schur, "AinvB", NULL));
17869566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur));
17879566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schurp));
17889566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->schur_user));
17899566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspschur));
17909566063dSJacob Faibussowitsch   PetscCall(KSPDestroy(&jac->kspupper));
17919566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->B));
17929566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->C));
17939566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&jac->H));
17949566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->u));
17959566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->v));
17969566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->Hu));
17979566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&jac->d));
17989566063dSJacob Faibussowitsch   PetscCall(PetscFree(jac->vecz));
17999566063dSJacob Faibussowitsch   PetscCall(PetscViewerDestroy(&jac->gkbviewer));
18006dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
18013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1802574deadeSBarry Smith }
1803574deadeSBarry Smith 
1804d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1805d71ae5a4SJacob Faibussowitsch {
1806574deadeSBarry Smith   PetscFunctionBegin;
18079566063dSJacob Faibussowitsch   PetscCall(PCReset_FieldSplit(pc));
18089566063dSJacob Faibussowitsch   PetscCall(PetscFree(pc->data));
18092e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", NULL));
18109566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", NULL));
18119566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", NULL));
18129566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", NULL));
18139566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", NULL));
18142e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", NULL));
18152e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", NULL));
18162e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
18172e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
18182e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
18192e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
18202e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
18219566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
18229566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
18239566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
18242e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
18253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
18260971522cSBarry Smith }
18270971522cSBarry Smith 
1828ce78bad3SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PC pc, PetscOptionItems PetscOptionsObject)
1829d71ae5a4SJacob Faibussowitsch {
18306c924f48SJed Brown   PetscInt        bs;
18317b752e3dSPatrick Sanan   PetscBool       flg;
18329dcbbd2bSBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit *)pc->data;
18333b224e63SBarry Smith   PCCompositeType ctype;
18341b9fc7fcSBarry Smith 
18350971522cSBarry Smith   PetscFunctionBegin;
1836d0609cedSBarry Smith   PetscOptionsHeadBegin(PetscOptionsObject, "FieldSplit options");
18379566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_dm_splits", "Whether to use DMCreateFieldDecomposition() for splits", "PCFieldSplitSetDMSplits", jac->dm_splits, &jac->dm_splits, NULL));
18389566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-pc_fieldsplit_block_size", "Blocksize that defines number of fields", "PCFieldSplitSetBlockSize", jac->bs, &bs, &flg));
18391baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetBlockSize(pc, bs));
18402686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
18419566063dSJacob 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));
18422686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
18439566063dSJacob 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));
18449566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-pc_fieldsplit_detect_saddle_point", "Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint", jac->detect, &jac->detect, NULL));
18459566063dSJacob Faibussowitsch   PetscCall(PCFieldSplitSetDetectSaddlePoint(pc, jac->detect)); /* Sets split type and Schur PC type */
18469566063dSJacob Faibussowitsch   PetscCall(PetscOptionsEnum("-pc_fieldsplit_type", "Type of composition", "PCFieldSplitSetType", PCCompositeTypes, (PetscEnum)jac->type, (PetscEnum *)&ctype, &flg));
18471baa6e33SBarry Smith   if (flg) PetscCall(PCFieldSplitSetType(pc, ctype));
1848c30613efSMatthew Knepley   /* Only setup fields once */
1849b6555650SPierre Jolivet   if (jac->bs > 0 && jac->nsplits == 0) {
185080670ca5SBarry Smith     /* only allow user to set fields from command line.
1851d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
18529566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetRuntimeSplits_Private(pc));
18539566063dSJacob Faibussowitsch     if (jac->splitdefined) PetscCall(PetscInfo(pc, "Splits defined using the options database\n"));
1854d32f9abdSBarry Smith   }
1855c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
18569566063dSJacob Faibussowitsch     PetscCall(PetscOptionsGetEnum(((PetscObject)pc)->options, ((PetscObject)pc)->prefix, "-pc_fieldsplit_schur_factorization_type", PCFieldSplitSchurFactTypes, (PetscEnum *)&jac->schurfactorization, &flg));
18579566063dSJacob Faibussowitsch     if (flg) PetscCall(PetscInfo(pc, "Deprecated use of -pc_fieldsplit_schur_factorization_type\n"));
18589566063dSJacob 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));
18599566063dSJacob Faibussowitsch     PetscCall(PetscOptionsEnum("-pc_fieldsplit_schur_precondition", "How to build preconditioner for Schur complement", "PCFieldSplitSetSchurPre", PCFieldSplitSchurPreTypes, (PetscEnum)jac->schurpre, (PetscEnum *)&jac->schurpre, NULL));
18609566063dSJacob Faibussowitsch     PetscCall(PetscOptionsScalar("-pc_fieldsplit_schur_scale", "Scale Schur complement", "PCFieldSplitSetSchurScale", jac->schurscale, &jac->schurscale, NULL));
1861a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1862a077d33dSBarry Smith     PetscCall(PetscOptionsReal("-pc_fieldsplit_gkb_tol", "The tolerance for the lower bound stopping criterion", "PCFieldSplitSetGKBTol", jac->gkbtol, &jac->gkbtol, NULL));
1863a077d33dSBarry Smith     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_delay", "The delay value for lower bound criterion", "PCFieldSplitSetGKBDelay", jac->gkbdelay, &jac->gkbdelay, NULL));
1864a077d33dSBarry Smith     PetscCall(PetscOptionsBoundedReal("-pc_fieldsplit_gkb_nu", "Parameter in augmented Lagrangian approach", "PCFieldSplitSetGKBNu", jac->gkbnu, &jac->gkbnu, NULL, 0.0));
1865a077d33dSBarry Smith     PetscCall(PetscOptionsInt("-pc_fieldsplit_gkb_maxit", "Maximum allowed number of iterations", "PCFieldSplitSetGKBMaxit", jac->gkbmaxit, &jac->gkbmaxit, NULL));
18669566063dSJacob Faibussowitsch     PetscCall(PetscOptionsBool("-pc_fieldsplit_gkb_monitor", "Prints number of GKB iterations and error", "PCFieldSplitGKB", jac->gkbmonitor, &jac->gkbmonitor, NULL));
1867c5d2311dSJed Brown   }
186834603f55SBarry Smith   /*
186934603f55SBarry Smith     In the initial call to this routine the sub-solver data structures do not exist so we cannot call KSPSetFromOptions() on them yet.
187034603f55SBarry 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
187134603f55SBarry Smith     is called on the outer solver in case changes were made in the options database
187234603f55SBarry Smith 
187334603f55SBarry 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()
187434603f55SBarry 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.
187534603f55SBarry Smith     Without this extra check test p2p1fetidp_olof_full and others fail with incorrect matrix types.
187634603f55SBarry Smith 
187734603f55SBarry Smith     There could be a negative side effect of calling the KSPSetFromOptions() below.
187834603f55SBarry Smith 
187934603f55SBarry 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
188034603f55SBarry Smith   */
188134603f55SBarry Smith   if (jac->issetup) {
188234603f55SBarry Smith     PC_FieldSplitLink ilink = jac->head;
188334603f55SBarry Smith     if (jac->type == PC_COMPOSITE_SCHUR) {
188434603f55SBarry Smith       if (jac->kspupper && jac->kspupper->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspupper));
188534603f55SBarry Smith       if (jac->kspschur && jac->kspschur->totalits > 0) PetscCall(KSPSetFromOptions(jac->kspschur));
188634603f55SBarry Smith     }
188734603f55SBarry Smith     while (ilink) {
188834603f55SBarry Smith       if (ilink->ksp->totalits > 0) PetscCall(KSPSetFromOptions(ilink->ksp));
188934603f55SBarry Smith       ilink = ilink->next;
189034603f55SBarry Smith     }
189134603f55SBarry Smith   }
1892d0609cedSBarry Smith   PetscOptionsHeadEnd();
18933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
18940971522cSBarry Smith }
18950971522cSBarry Smith 
1896d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetFields_FieldSplit(PC pc, const char splitname[], PetscInt n, const PetscInt *fields, const PetscInt *fields_col)
1897d71ae5a4SJacob Faibussowitsch {
189897bbdb24SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
18995a9f2f41SSatish Balay   PC_FieldSplitLink ilink, next = jac->head;
190069a612a9SBarry Smith   char              prefix[128];
19015d4c12cdSJungho Lee   PetscInt          i;
1902835f2295SStefano Zampini   PetscLogEvent     nse;
19030971522cSBarry Smith 
19040971522cSBarry Smith   PetscFunctionBegin;
19056c924f48SJed Brown   if (jac->splitdefined) {
19069566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
19073ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
19086c924f48SJed Brown   }
1909ac530a7eSPierre Jolivet   for (i = 0; i < n; i++) PetscCheck(fields[i] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", fields[i]);
19109566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
1911a04f6461SBarry Smith   if (splitname) {
19129566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
1913a04f6461SBarry Smith   } else {
19149566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(3, &ilink->splitname));
191563a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 2, "%" PetscInt_FMT, jac->nsplits));
1916a04f6461SBarry Smith   }
1917835f2295SStefano Zampini   PetscCall(PetscMPIIntCast(jac->nsplits, &nse));
1918835f2295SStefano Zampini   ilink->event = jac->nsplits < 5 ? KSP_Solve_FS_0 + nse : KSP_Solve_FS_0 + 4; /* Splits greater than 4 logged in 4th split */
19199566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields));
19209566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields, fields, n));
19219566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &ilink->fields_col));
19229566063dSJacob Faibussowitsch   PetscCall(PetscArraycpy(ilink->fields_col, fields_col, n));
19232fa5cd67SKarl Rupp 
19245a9f2f41SSatish Balay   ilink->nfields = n;
19250298fd71SBarry Smith   ilink->next    = NULL;
19269566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
19273821be0aSBarry Smith   PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel));
19289566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
19299566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
19309566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
193169a612a9SBarry Smith 
19329566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
19339566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
19340971522cSBarry Smith 
19350971522cSBarry Smith   if (!next) {
19365a9f2f41SSatish Balay     jac->head       = ilink;
19370298fd71SBarry Smith     ilink->previous = NULL;
19380971522cSBarry Smith   } else {
1939ad540459SPierre Jolivet     while (next->next) next = next->next;
19405a9f2f41SSatish Balay     next->next      = ilink;
194151f519a2SBarry Smith     ilink->previous = next;
19420971522cSBarry Smith   }
19430971522cSBarry Smith   jac->nsplits++;
19443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19450971522cSBarry Smith }
19460971522cSBarry Smith 
1947d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp)
1948d71ae5a4SJacob Faibussowitsch {
1949285fb4e2SStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1950285fb4e2SStefano Zampini 
1951285fb4e2SStefano Zampini   PetscFunctionBegin;
1952285fb4e2SStefano Zampini   *subksp = NULL;
1953285fb4e2SStefano Zampini   if (n) *n = 0;
1954285fb4e2SStefano Zampini   if (jac->type == PC_COMPOSITE_SCHUR) {
1955285fb4e2SStefano Zampini     PetscInt nn;
1956285fb4e2SStefano Zampini 
195728b400f6SJacob Faibussowitsch     PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()");
195863a3b9bcSJacob Faibussowitsch     PetscCheck(jac->nsplits == 2, PetscObjectComm((PetscObject)pc), PETSC_ERR_PLIB, "Unexpected number of splits %" PetscInt_FMT " != 2", jac->nsplits);
1959285fb4e2SStefano Zampini     nn = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0);
19609566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nn, subksp));
1961285fb4e2SStefano Zampini     (*subksp)[0] = jac->head->ksp;
1962285fb4e2SStefano Zampini     (*subksp)[1] = jac->kspschur;
1963285fb4e2SStefano Zampini     if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper;
1964285fb4e2SStefano Zampini     if (n) *n = nn;
1965285fb4e2SStefano Zampini   }
19663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1967285fb4e2SStefano Zampini }
1968285fb4e2SStefano Zampini 
1969d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc, PetscInt *n, KSP **subksp)
1970d71ae5a4SJacob Faibussowitsch {
1971e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
1972e69d4d44SBarry Smith 
1973e69d4d44SBarry Smith   PetscFunctionBegin;
197428b400f6SJacob Faibussowitsch   PetscCheck(jac->schur, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONGSTATE, "Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
19759566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
19769566063dSJacob Faibussowitsch   PetscCall(MatSchurComplementGetKSP(jac->schur, *subksp));
19772fa5cd67SKarl Rupp 
1978e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
197913e0d083SBarry Smith   if (n) *n = jac->nsplits;
19803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1981e69d4d44SBarry Smith }
19820971522cSBarry Smith 
1983d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSubKSP_FieldSplit(PC pc, PetscInt *n, KSP **subksp)
1984d71ae5a4SJacob Faibussowitsch {
19850971522cSBarry Smith   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
19860971522cSBarry Smith   PetscInt          cnt   = 0;
19875a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
19880971522cSBarry Smith 
19890971522cSBarry Smith   PetscFunctionBegin;
19909566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(jac->nsplits, subksp));
19915a9f2f41SSatish Balay   while (ilink) {
19925a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
19935a9f2f41SSatish Balay     ilink            = ilink->next;
19940971522cSBarry Smith   }
199563a3b9bcSJacob 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);
199613e0d083SBarry Smith   if (n) *n = jac->nsplits;
19973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19980971522cSBarry Smith }
19990971522cSBarry Smith 
2000cc4c1da9SBarry Smith /*@
2001f1580f4eSBarry Smith   PCFieldSplitRestrictIS - Restricts the fieldsplit `IS`s to be within a given `IS`.
20026dbb499eSCian Wilson 
20036dbb499eSCian Wilson   Input Parameters:
20046dbb499eSCian Wilson + pc  - the preconditioner context
2005feefa0e1SJacob Faibussowitsch - isy - the index set that defines the indices to which the fieldsplit is to be restricted
20066dbb499eSCian Wilson 
20076dbb499eSCian Wilson   Level: advanced
20086dbb499eSCian Wilson 
2009feefa0e1SJacob Faibussowitsch   Developer Notes:
2010f1580f4eSBarry Smith   It seems the resulting `IS`s will not cover the entire space, so
2011f1580f4eSBarry Smith   how can they define a convergent preconditioner? Needs explaining.
2012f1580f4eSBarry Smith 
201360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
20146dbb499eSCian Wilson @*/
2015d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitRestrictIS(PC pc, IS isy)
2016d71ae5a4SJacob Faibussowitsch {
20176dbb499eSCian Wilson   PetscFunctionBegin;
20186dbb499eSCian Wilson   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
20196dbb499eSCian Wilson   PetscValidHeaderSpecific(isy, IS_CLASSID, 2);
2020cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitRestrictIS_C", (PC, IS), (pc, isy));
20213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20226dbb499eSCian Wilson }
20236dbb499eSCian Wilson 
2024d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
2025d71ae5a4SJacob Faibussowitsch {
20266dbb499eSCian Wilson   PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
20276dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
20286dbb499eSCian Wilson   PetscInt          localsize, size, sizez, i;
20296dbb499eSCian Wilson   const PetscInt   *ind, *indz;
20306dbb499eSCian Wilson   PetscInt         *indc, *indcz;
20316dbb499eSCian Wilson   PetscBool         flg;
20326dbb499eSCian Wilson 
20336dbb499eSCian Wilson   PetscFunctionBegin;
20349566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(isy, &localsize));
20359566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Scan(&localsize, &size, 1, MPIU_INT, MPI_SUM, PetscObjectComm((PetscObject)isy)));
20366dbb499eSCian Wilson   size -= localsize;
20376dbb499eSCian Wilson   while (ilink) {
20386dbb499eSCian Wilson     IS isrl, isr;
20391c7cfba8SBarry Smith     PC subpc;
20409566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl));
20419566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(isrl, &localsize));
20429566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(localsize, &indc));
20439566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(isrl, &ind));
20449566063dSJacob Faibussowitsch     PetscCall(PetscArraycpy(indc, ind, localsize));
20459566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(isrl, &ind));
20469566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isrl));
20476dbb499eSCian Wilson     for (i = 0; i < localsize; i++) *(indc + i) += size;
20489566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)isy), localsize, indc, PETSC_OWN_POINTER, &isr));
20499566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
20509566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
20516dbb499eSCian Wilson     ilink->is = isr;
20529566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)isr));
20539566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is_col));
20546dbb499eSCian Wilson     ilink->is_col = isr;
20559566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&isr));
20569566063dSJacob Faibussowitsch     PetscCall(KSPGetPC(ilink->ksp, &subpc));
20579566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)subpc, PCFIELDSPLIT, &flg));
20586dbb499eSCian Wilson     if (flg) {
20596dbb499eSCian Wilson       IS       iszl, isz;
20606dbb499eSCian Wilson       MPI_Comm comm;
20619566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(ilink->is, &localsize));
20626dbb499eSCian Wilson       comm = PetscObjectComm((PetscObject)ilink->is);
20639566063dSJacob Faibussowitsch       PetscCall(ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl));
20649566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Scan(&localsize, &sizez, 1, MPIU_INT, MPI_SUM, comm));
20656dbb499eSCian Wilson       sizez -= localsize;
20669566063dSJacob Faibussowitsch       PetscCall(ISGetLocalSize(iszl, &localsize));
20679566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(localsize, &indcz));
20689566063dSJacob Faibussowitsch       PetscCall(ISGetIndices(iszl, &indz));
20699566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(indcz, indz, localsize));
20709566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(iszl, &indz));
20719566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&iszl));
20726dbb499eSCian Wilson       for (i = 0; i < localsize; i++) *(indcz + i) += sizez;
20739566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(comm, localsize, indcz, PETSC_OWN_POINTER, &isz));
20749566063dSJacob Faibussowitsch       PetscCall(PCFieldSplitRestrictIS(subpc, isz));
20759566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&isz));
20766dbb499eSCian Wilson     }
20776dbb499eSCian Wilson     next  = ilink->next;
20786dbb499eSCian Wilson     ilink = next;
20796dbb499eSCian Wilson   }
20806dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
20813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20826dbb499eSCian Wilson }
20836dbb499eSCian Wilson 
2084d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetIS_FieldSplit(PC pc, const char splitname[], IS is)
2085d71ae5a4SJacob Faibussowitsch {
2086704ba839SBarry Smith   PC_FieldSplit    *jac = (PC_FieldSplit *)pc->data;
2087704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
2088704ba839SBarry Smith   char              prefix[128];
2089835f2295SStefano Zampini   PetscLogEvent     nse;
2090704ba839SBarry Smith 
2091704ba839SBarry Smith   PetscFunctionBegin;
20926c924f48SJed Brown   if (jac->splitdefined) {
20939566063dSJacob Faibussowitsch     PetscCall(PetscInfo(pc, "Ignoring new split \"%s\" because the splits have already been defined\n", splitname));
20943ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
20956c924f48SJed Brown   }
20969566063dSJacob Faibussowitsch   PetscCall(PetscNew(&ilink));
2097a04f6461SBarry Smith   if (splitname) {
20989566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(splitname, &ilink->splitname));
2099a04f6461SBarry Smith   } else {
21009566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(8, &ilink->splitname));
210163a3b9bcSJacob Faibussowitsch     PetscCall(PetscSNPrintf(ilink->splitname, 7, "%" PetscInt_FMT, jac->nsplits));
2102a04f6461SBarry Smith   }
2103835f2295SStefano Zampini   PetscCall(PetscMPIIntCast(jac->nsplits, &nse));
2104835f2295SStefano Zampini   ilink->event = jac->nsplits < 5 ? KSP_Solve_FS_0 + nse : KSP_Solve_FS_0 + 4; /* Splits greater than 4 logged in 4th split */
21059566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
21069566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is));
2107b5787286SJed Brown   ilink->is = is;
21089566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)is));
21099566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&ilink->is_col));
2110b5787286SJed Brown   ilink->is_col = is;
21110298fd71SBarry Smith   ilink->next   = NULL;
21129566063dSJacob Faibussowitsch   PetscCall(KSPCreate(PetscObjectComm((PetscObject)pc), &ilink->ksp));
21133821be0aSBarry Smith   PetscCall(KSPSetNestLevel(ilink->ksp, pc->kspnestlevel));
21149566063dSJacob Faibussowitsch   PetscCall(KSPSetErrorIfNotConverged(ilink->ksp, pc->erroriffailure));
21159566063dSJacob Faibussowitsch   PetscCall(PetscObjectIncrementTabLevel((PetscObject)ilink->ksp, (PetscObject)pc, 1));
21169566063dSJacob Faibussowitsch   PetscCall(KSPSetType(ilink->ksp, KSPPREONLY));
2117704ba839SBarry Smith 
21189566063dSJacob Faibussowitsch   PetscCall(PetscSNPrintf(prefix, sizeof(prefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname));
21199566063dSJacob Faibussowitsch   PetscCall(KSPSetOptionsPrefix(ilink->ksp, prefix));
2120704ba839SBarry Smith 
2121704ba839SBarry Smith   if (!next) {
2122704ba839SBarry Smith     jac->head       = ilink;
21230298fd71SBarry Smith     ilink->previous = NULL;
2124704ba839SBarry Smith   } else {
2125ad540459SPierre Jolivet     while (next->next) next = next->next;
2126704ba839SBarry Smith     next->next      = ilink;
2127704ba839SBarry Smith     ilink->previous = next;
2128704ba839SBarry Smith   }
2129704ba839SBarry Smith   jac->nsplits++;
21303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2131704ba839SBarry Smith }
2132704ba839SBarry Smith 
21335d83a8b1SBarry Smith /*@
213460f59c3bSBarry Smith   PCFieldSplitSetFields - Sets the fields that define one particular split in `PCFIELDSPLIT`
21350971522cSBarry Smith 
2136c3339decSBarry Smith   Logically Collective
21370971522cSBarry Smith 
21380971522cSBarry Smith   Input Parameters:
21390971522cSBarry Smith + pc         - the preconditioner context
214060f59c3bSBarry Smith . splitname  - name of this split, if `NULL` the number of the split is used
21410971522cSBarry Smith . n          - the number of fields in this split
21423b374dbdSBarry Smith . fields     - the fields in this split
214380670ca5SBarry 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
214480670ca5SBarry Smith                of the matrix and `fields_col` provides the column indices for that block
214580670ca5SBarry Smith 
214680670ca5SBarry Smith   Options Database Key:
214780670ca5SBarry Smith . -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the `%d`'th split
21480971522cSBarry Smith 
21490971522cSBarry Smith   Level: intermediate
21500971522cSBarry Smith 
215195452b02SPatrick Sanan   Notes:
2152f1580f4eSBarry Smith   Use `PCFieldSplitSetIS()` to set a  general set of indices as a split.
2153d32f9abdSBarry Smith 
215480670ca5SBarry Smith   If the matrix used to construct the preconditioner is `MATNEST` then field i refers to the `is_row[i]` `IS` passed to `MatCreateNest()`.
215580670ca5SBarry Smith 
215680670ca5SBarry Smith   If the matrix used to construct the preconditioner is not `MATNEST` then
215754c05997SPierre Jolivet   `PCFieldSplitSetFields()` is for defining fields as strided blocks (based on the block size provided to the matrix with `MatSetBlockSize()` or
215880670ca5SBarry Smith   to the `PC` with `PCFieldSplitSetBlockSize()`). For example, if the block
2159f1580f4eSBarry 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
216014c74629SNuno Nobre   0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x23x56x8.. x12x45x78x....
2161f1580f4eSBarry Smith   where the numbered entries indicate what is in the split.
2162d32f9abdSBarry Smith 
2163db4c96c1SJed Brown   This function is called once per split (it creates a new split each time).  Solve options
216460f59c3bSBarry Smith   for this split will be available under the prefix `-fieldsplit_SPLITNAME_`.
2165db4c96c1SJed Brown 
216680670ca5SBarry Smith   `PCFieldSplitSetIS()` does not support having a `fields_col` different from `fields`
21673b374dbdSBarry Smith 
2168feefa0e1SJacob Faibussowitsch   Developer Notes:
2169f1580f4eSBarry Smith   This routine does not actually create the `IS` representing the split, that is delayed
2170f1580f4eSBarry Smith   until `PCSetUp_FieldSplit()`, because information about the vector/matrix layouts may not be
21715d4c12cdSJungho Lee   available when this routine is called.
21725d4c12cdSJungho Lee 
217380670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetIS()`, `PCFieldSplitRestrictIS()`,
217454c05997SPierre Jolivet           `MatSetBlockSize()`, `MatCreateNest()`
21750971522cSBarry Smith @*/
2176cc4c1da9SBarry Smith PetscErrorCode PCFieldSplitSetFields(PC pc, const char splitname[], PetscInt n, const PetscInt fields[], const PetscInt fields_col[])
2177d71ae5a4SJacob Faibussowitsch {
21780971522cSBarry Smith   PetscFunctionBegin;
21790700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
21804f572ea9SToby Isaac   PetscAssertPointer(splitname, 2);
218163a3b9bcSJacob Faibussowitsch   PetscCheck(n >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Provided number of fields %" PetscInt_FMT " in split \"%s\" not positive", n, splitname);
21824f572ea9SToby Isaac   PetscAssertPointer(fields, 4);
2183cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetFields_C", (PC, const char[], PetscInt, const PetscInt *, const PetscInt *), (pc, splitname, n, fields, fields_col));
21843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21850971522cSBarry Smith }
21860971522cSBarry Smith 
2187c84da90fSDmitry Karpeev /*@
2188f1580f4eSBarry Smith   PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build
2189c14e9f00SDavid Andrs   the sub-matrices associated with each split. Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2190c84da90fSDmitry Karpeev 
2191c3339decSBarry Smith   Logically Collective
2192c84da90fSDmitry Karpeev 
2193c84da90fSDmitry Karpeev   Input Parameters:
2194c84da90fSDmitry Karpeev + pc  - the preconditioner object
2195c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
2196c84da90fSDmitry Karpeev 
219720f4b53cSBarry Smith   Options Database Key:
2198147403d9SBarry Smith . -pc_fieldsplit_diag_use_amat - use the Amat to provide the diagonal blocks
2199c84da90fSDmitry Karpeev 
2200c84da90fSDmitry Karpeev   Level: intermediate
2201c84da90fSDmitry Karpeev 
220260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetDiagUseAmat()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFIELDSPLIT`
2203c84da90fSDmitry Karpeev @*/
2204d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDiagUseAmat(PC pc, PetscBool flg)
2205d71ae5a4SJacob Faibussowitsch {
2206c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2207c84da90fSDmitry Karpeev   PetscBool      isfs;
2208c84da90fSDmitry Karpeev 
2209c84da90fSDmitry Karpeev   PetscFunctionBegin;
2210c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22119566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
221228b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2213c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
22143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2215c84da90fSDmitry Karpeev }
2216c84da90fSDmitry Karpeev 
2217c84da90fSDmitry Karpeev /*@
2218f1580f4eSBarry Smith   PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat) to build
2219c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2220c84da90fSDmitry Karpeev 
2221c3339decSBarry Smith   Logically Collective
2222c84da90fSDmitry Karpeev 
222320f4b53cSBarry Smith   Input Parameter:
2224c84da90fSDmitry Karpeev . pc - the preconditioner object
2225c84da90fSDmitry Karpeev 
222620f4b53cSBarry Smith   Output Parameter:
2227c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
2228c84da90fSDmitry Karpeev 
2229c84da90fSDmitry Karpeev   Level: intermediate
2230c84da90fSDmitry Karpeev 
223160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetDiagUseAmat()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFIELDSPLIT`
2232c84da90fSDmitry Karpeev @*/
2233d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDiagUseAmat(PC pc, PetscBool *flg)
2234d71ae5a4SJacob Faibussowitsch {
2235c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2236c84da90fSDmitry Karpeev   PetscBool      isfs;
2237c84da90fSDmitry Karpeev 
2238c84da90fSDmitry Karpeev   PetscFunctionBegin;
2239c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22404f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
22419566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
224228b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2243c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
22443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2245c84da90fSDmitry Karpeev }
2246c84da90fSDmitry Karpeev 
2247c84da90fSDmitry Karpeev /*@
2248f1580f4eSBarry Smith   PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build
2249c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2250c84da90fSDmitry Karpeev 
2251c3339decSBarry Smith   Logically Collective
2252c84da90fSDmitry Karpeev 
2253c84da90fSDmitry Karpeev   Input Parameters:
2254c84da90fSDmitry Karpeev + pc  - the preconditioner object
2255c84da90fSDmitry Karpeev - flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2256c84da90fSDmitry Karpeev 
225720f4b53cSBarry Smith   Options Database Key:
2258147403d9SBarry Smith . -pc_fieldsplit_off_diag_use_amat <bool> - use the Amat to extract the off-diagonal blocks
2259c84da90fSDmitry Karpeev 
2260c84da90fSDmitry Karpeev   Level: intermediate
2261c84da90fSDmitry Karpeev 
226260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitGetOffDiagUseAmat()`, `PCFieldSplitSetDiagUseAmat()`, `PCFIELDSPLIT`
2263c84da90fSDmitry Karpeev @*/
2264d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetOffDiagUseAmat(PC pc, PetscBool flg)
2265d71ae5a4SJacob Faibussowitsch {
2266c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2267c84da90fSDmitry Karpeev   PetscBool      isfs;
2268c84da90fSDmitry Karpeev 
2269c84da90fSDmitry Karpeev   PetscFunctionBegin;
2270c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
22719566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
227228b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2273c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
22743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2275c84da90fSDmitry Karpeev }
2276c84da90fSDmitry Karpeev 
2277c84da90fSDmitry Karpeev /*@
2278f1580f4eSBarry Smith   PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat) to build
2279c14e9f00SDavid Andrs   the sub-matrices associated with each split.  Where `KSPSetOperators`(ksp,Amat,Pmat) was used to supply the operators.
2280c84da90fSDmitry Karpeev 
2281c3339decSBarry Smith   Logically Collective
2282c84da90fSDmitry Karpeev 
228320f4b53cSBarry Smith   Input Parameter:
2284c84da90fSDmitry Karpeev . pc - the preconditioner object
2285c84da90fSDmitry Karpeev 
228620f4b53cSBarry Smith   Output Parameter:
2287c84da90fSDmitry Karpeev . flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2288c84da90fSDmitry Karpeev 
2289c84da90fSDmitry Karpeev   Level: intermediate
2290c84da90fSDmitry Karpeev 
229160f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCSetOperators()`, `KSPSetOperators()`, `PCFieldSplitSetOffDiagUseAmat()`, `PCFieldSplitGetDiagUseAmat()`, `PCFIELDSPLIT`
2292c84da90fSDmitry Karpeev @*/
2293d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetOffDiagUseAmat(PC pc, PetscBool *flg)
2294d71ae5a4SJacob Faibussowitsch {
2295c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2296c84da90fSDmitry Karpeev   PetscBool      isfs;
2297c84da90fSDmitry Karpeev 
2298c84da90fSDmitry Karpeev   PetscFunctionBegin;
2299c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23004f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
23019566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
230228b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "PC not of type %s", PCFIELDSPLIT);
2303c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
23043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2305c84da90fSDmitry Karpeev }
2306c84da90fSDmitry Karpeev 
2307cc4c1da9SBarry Smith /*@
2308f1580f4eSBarry Smith   PCFieldSplitSetIS - Sets the exact elements for a split in a `PCFIELDSPLIT`
2309704ba839SBarry Smith 
2310c3339decSBarry Smith   Logically Collective
2311704ba839SBarry Smith 
2312704ba839SBarry Smith   Input Parameters:
2313704ba839SBarry Smith + pc        - the preconditioner context
231460f59c3bSBarry Smith . splitname - name of this split, if `NULL` the number of the split is used
2315f1580f4eSBarry Smith - is        - the index set that defines the elements in this split
2316704ba839SBarry Smith 
231760f59c3bSBarry Smith   Level: intermediate
231860f59c3bSBarry Smith 
2319a6ffb8dbSJed Brown   Notes:
232080670ca5SBarry Smith   Use `PCFieldSplitSetFields()`, for splits defined by strided `IS` based on the matrix block size or the `is_rows[]` passed into `MATNEST`
2321a6ffb8dbSJed Brown 
2322db4c96c1SJed Brown   This function is called once per split (it creates a new split each time).  Solve options
2323db4c96c1SJed Brown   for this split will be available under the prefix -fieldsplit_SPLITNAME_.
2324d32f9abdSBarry Smith 
232580670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetBlockSize()`, `PCFieldSplitSetFields()`
2326704ba839SBarry Smith @*/
2327d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetIS(PC pc, const char splitname[], IS is)
2328d71ae5a4SJacob Faibussowitsch {
2329704ba839SBarry Smith   PetscFunctionBegin;
23300700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23314f572ea9SToby Isaac   if (splitname) PetscAssertPointer(splitname, 2);
2332db4c96c1SJed Brown   PetscValidHeaderSpecific(is, IS_CLASSID, 3);
2333cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetIS_C", (PC, const char[], IS), (pc, splitname, is));
23343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2335704ba839SBarry Smith }
2336704ba839SBarry Smith 
2337cc4c1da9SBarry Smith /*@
2338f1580f4eSBarry Smith   PCFieldSplitGetIS - Retrieves the elements for a split as an `IS`
233957a9adfeSMatthew G Knepley 
2340c3339decSBarry Smith   Logically Collective
234157a9adfeSMatthew G Knepley 
234257a9adfeSMatthew G Knepley   Input Parameters:
234357a9adfeSMatthew G Knepley + pc        - the preconditioner context
234457a9adfeSMatthew G Knepley - splitname - name of this split
234557a9adfeSMatthew G Knepley 
234657a9adfeSMatthew G Knepley   Output Parameter:
2347feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split, or `NULL` if the split is not found
234857a9adfeSMatthew G Knepley 
234957a9adfeSMatthew G Knepley   Level: intermediate
235057a9adfeSMatthew G Knepley 
235180670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetIS()`, `PCFieldSplitGetISByIndex()`
235257a9adfeSMatthew G Knepley @*/
2353d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetIS(PC pc, const char splitname[], IS *is)
2354d71ae5a4SJacob Faibussowitsch {
235557a9adfeSMatthew G Knepley   PetscFunctionBegin;
235657a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23574f572ea9SToby Isaac   PetscAssertPointer(splitname, 2);
23584f572ea9SToby Isaac   PetscAssertPointer(is, 3);
235957a9adfeSMatthew G Knepley   {
236057a9adfeSMatthew G Knepley     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
236157a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
236257a9adfeSMatthew G Knepley     PetscBool         found;
236357a9adfeSMatthew G Knepley 
23640298fd71SBarry Smith     *is = NULL;
236557a9adfeSMatthew G Knepley     while (ilink) {
23669566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(ilink->splitname, splitname, &found));
236757a9adfeSMatthew G Knepley       if (found) {
236857a9adfeSMatthew G Knepley         *is = ilink->is;
236957a9adfeSMatthew G Knepley         break;
237057a9adfeSMatthew G Knepley       }
237157a9adfeSMatthew G Knepley       ilink = ilink->next;
237257a9adfeSMatthew G Knepley     }
237357a9adfeSMatthew G Knepley   }
23743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
237557a9adfeSMatthew G Knepley }
237657a9adfeSMatthew G Knepley 
2377cc4c1da9SBarry Smith /*@
2378f1580f4eSBarry Smith   PCFieldSplitGetISByIndex - Retrieves the elements for a given split as an `IS`
2379998f007dSPierre Jolivet 
2380c3339decSBarry Smith   Logically Collective
2381998f007dSPierre Jolivet 
2382998f007dSPierre Jolivet   Input Parameters:
2383998f007dSPierre Jolivet + pc    - the preconditioner context
2384998f007dSPierre Jolivet - index - index of this split
2385998f007dSPierre Jolivet 
2386998f007dSPierre Jolivet   Output Parameter:
2387feefa0e1SJacob Faibussowitsch . is - the index set that defines the elements in this split
2388998f007dSPierre Jolivet 
2389998f007dSPierre Jolivet   Level: intermediate
2390998f007dSPierre Jolivet 
239180670ca5SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitGetIS()`, `PCFieldSplitSetIS()`,
239280670ca5SBarry Smith 
2393998f007dSPierre Jolivet @*/
2394d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetISByIndex(PC pc, PetscInt index, IS *is)
2395d71ae5a4SJacob Faibussowitsch {
2396998f007dSPierre Jolivet   PetscFunctionBegin;
239763a3b9bcSJacob Faibussowitsch   PetscCheck(index >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Negative field %" PetscInt_FMT " requested", index);
2398998f007dSPierre Jolivet   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
23994f572ea9SToby Isaac   PetscAssertPointer(is, 3);
2400998f007dSPierre Jolivet   {
2401998f007dSPierre Jolivet     PC_FieldSplit    *jac   = (PC_FieldSplit *)pc->data;
2402998f007dSPierre Jolivet     PC_FieldSplitLink ilink = jac->head;
2403998f007dSPierre Jolivet     PetscInt          i     = 0;
240463a3b9bcSJacob Faibussowitsch     PetscCheck(index < jac->nsplits, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field %" PetscInt_FMT " requested but only %" PetscInt_FMT " exist", index, jac->nsplits);
2405998f007dSPierre Jolivet 
2406998f007dSPierre Jolivet     while (i < index) {
2407998f007dSPierre Jolivet       ilink = ilink->next;
2408998f007dSPierre Jolivet       ++i;
2409998f007dSPierre Jolivet     }
24109566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitGetIS(pc, ilink->splitname, is));
2411998f007dSPierre Jolivet   }
24123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2413998f007dSPierre Jolivet }
2414998f007dSPierre Jolivet 
241551f519a2SBarry Smith /*@
241651f519a2SBarry Smith   PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
241780670ca5SBarry Smith   fieldsplit preconditioner when calling `PCFieldSplitSetFields()`. If not set the matrix block size is used.
241851f519a2SBarry Smith 
2419c3339decSBarry Smith   Logically Collective
242051f519a2SBarry Smith 
242151f519a2SBarry Smith   Input Parameters:
242251f519a2SBarry Smith + pc - the preconditioner context
242351f519a2SBarry Smith - bs - the block size
242451f519a2SBarry Smith 
242551f519a2SBarry Smith   Level: intermediate
242651f519a2SBarry Smith 
242780670ca5SBarry Smith   Note:
242880670ca5SBarry Smith   If the matrix is a `MATNEST` then the `is_rows[]` passed to `MatCreateNest()` determines the fields.
242980670ca5SBarry Smith 
243060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
243151f519a2SBarry Smith @*/
2432d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetBlockSize(PC pc, PetscInt bs)
2433d71ae5a4SJacob Faibussowitsch {
243451f519a2SBarry Smith   PetscFunctionBegin;
24350700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2436c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc, bs, 2);
2437cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetBlockSize_C", (PC, PetscInt), (pc, bs));
24383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
243951f519a2SBarry Smith }
244051f519a2SBarry Smith 
24410971522cSBarry Smith /*@C
2442f1580f4eSBarry Smith   PCFieldSplitGetSubKSP - Gets the `KSP` contexts for all splits
24430971522cSBarry Smith 
2444c3339decSBarry Smith   Collective
24450971522cSBarry Smith 
24460971522cSBarry Smith   Input Parameter:
24470971522cSBarry Smith . pc - the preconditioner context
24480971522cSBarry Smith 
24490971522cSBarry Smith   Output Parameters:
245013e0d083SBarry Smith + n      - the number of splits
2451f1580f4eSBarry Smith - subksp - the array of `KSP` contexts
2452196cc216SBarry Smith 
24530971522cSBarry Smith   Level: advanced
24540971522cSBarry Smith 
2455f1580f4eSBarry Smith   Notes:
2456f1580f4eSBarry Smith   After `PCFieldSplitGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()`
2457f1580f4eSBarry Smith   (not the `KSP`, just the array that contains them).
2458f1580f4eSBarry Smith 
2459f1580f4eSBarry Smith   You must call `PCSetUp()` before calling `PCFieldSplitGetSubKSP()`.
2460f1580f4eSBarry Smith 
2461f1580f4eSBarry Smith   If the fieldsplit is of type `PC_COMPOSITE_SCHUR`, it returns the `KSP` object used inside the
2462f1580f4eSBarry Smith   Schur complement and the `KSP` object used to iterate over the Schur complement.
2463f1580f4eSBarry Smith   To access all the `KSP` objects used in `PC_COMPOSITE_SCHUR`, use `PCFieldSplitSchurGetSubKSP()`.
2464f1580f4eSBarry Smith 
2465f1580f4eSBarry Smith   If the fieldsplit is of type `PC_COMPOSITE_GKB`, it returns the `KSP` object used to solve the
2466f1580f4eSBarry Smith   inner linear system defined by the matrix H in each loop.
2467f1580f4eSBarry Smith 
2468feaf08eaSBarry Smith   Fortran Note:
2469e41f517fSBarry Smith   Call `PCFieldSplitRestoreSubKSP()` when the array of `KSP` is no longer needed
2470f1580f4eSBarry Smith 
2471feefa0e1SJacob Faibussowitsch   Developer Notes:
2472f1580f4eSBarry Smith   There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()`
2473f1580f4eSBarry Smith 
247460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitSchurGetSubKSP()`
24750971522cSBarry Smith @*/
2476d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSubKSP(PC pc, PetscInt *n, KSP *subksp[])
2477d71ae5a4SJacob Faibussowitsch {
24780971522cSBarry Smith   PetscFunctionBegin;
24790700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
24804f572ea9SToby Isaac   if (n) PetscAssertPointer(n, 2);
2481cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
24823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24830971522cSBarry Smith }
24840971522cSBarry Smith 
2485285fb4e2SStefano Zampini /*@C
2486f1580f4eSBarry Smith   PCFieldSplitSchurGetSubKSP - Gets the `KSP` contexts used inside the Schur complement based `PCFIELDSPLIT`
2487285fb4e2SStefano Zampini 
248860f59c3bSBarry Smith   Collective
2489285fb4e2SStefano Zampini 
2490285fb4e2SStefano Zampini   Input Parameter:
2491285fb4e2SStefano Zampini . pc - the preconditioner context
2492285fb4e2SStefano Zampini 
2493285fb4e2SStefano Zampini   Output Parameters:
2494285fb4e2SStefano Zampini + n      - the number of splits
2495f1580f4eSBarry Smith - subksp - the array of `KSP` contexts
2496285fb4e2SStefano Zampini 
2497285fb4e2SStefano Zampini   Level: advanced
2498285fb4e2SStefano Zampini 
2499f1580f4eSBarry Smith   Notes:
2500f1580f4eSBarry Smith   After `PCFieldSplitSchurGetSubKSP()` the array of `KSP`s is to be freed by the user with `PetscFree()`
2501f1580f4eSBarry Smith   (not the `KSP` just the array that contains them).
2502f1580f4eSBarry Smith 
2503f1580f4eSBarry Smith   You must call `PCSetUp()` before calling `PCFieldSplitSchurGetSubKSP()`.
2504f1580f4eSBarry Smith 
2505f1580f4eSBarry Smith   If the fieldsplit type is of type `PC_COMPOSITE_SCHUR`, it returns (in order)
2506f1580f4eSBarry Smith +  1  - the `KSP` used for the (1,1) block
2507f1580f4eSBarry Smith .  2  - the `KSP` used for the Schur complement (not the one used for the interior Schur solver)
2508f1580f4eSBarry Smith -  3  - the `KSP` used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block).
2509f1580f4eSBarry Smith 
2510f1580f4eSBarry Smith   It returns a null array if the fieldsplit is not of type `PC_COMPOSITE_SCHUR`; in this case, you should use `PCFieldSplitGetSubKSP()`.
2511f1580f4eSBarry Smith 
2512feaf08eaSBarry Smith   Fortran Note:
2513e41f517fSBarry Smith   Call `PCFieldSplitSchurRestoreSubKSP()` when the array of `KSP` is no longer needed
2514f1580f4eSBarry Smith 
2515f1580f4eSBarry Smith   Developer Notes:
2516f1580f4eSBarry Smith   There should be a `PCFieldSplitRestoreSubKSP()` instead of requiring the user to call `PetscFree()`
2517f1580f4eSBarry Smith 
2518f1580f4eSBarry Smith   Should the functionality of `PCFieldSplitSchurGetSubKSP()` and `PCFieldSplitGetSubKSP()` be merged?
2519f1580f4eSBarry Smith 
252060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`, `PCFieldSplitGetSubKSP()`
2521285fb4e2SStefano Zampini @*/
2522d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetSubKSP(PC pc, PetscInt *n, KSP *subksp[])
2523d71ae5a4SJacob Faibussowitsch {
2524285fb4e2SStefano Zampini   PetscFunctionBegin;
2525285fb4e2SStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
25264f572ea9SToby Isaac   if (n) PetscAssertPointer(n, 2);
2527cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitSchurGetSubKSP_C", (PC, PetscInt *, KSP **), (pc, n, subksp));
25283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2529285fb4e2SStefano Zampini }
2530285fb4e2SStefano Zampini 
2531e69d4d44SBarry Smith /*@
2532c14e9f00SDavid Andrs   PCFieldSplitSetSchurPre -  Indicates from what operator the preconditioner is constructed for the Schur complement.
2533a1e3cbf9SBarry Smith   The default is the A11 matrix.
2534e69d4d44SBarry Smith 
2535c3339decSBarry Smith   Collective
2536e69d4d44SBarry Smith 
2537e69d4d44SBarry Smith   Input Parameters:
2538e69d4d44SBarry Smith + pc    - the preconditioner context
2539f1580f4eSBarry Smith . ptype - which matrix to use for preconditioning the Schur complement: `PC_FIELDSPLIT_SCHUR_PRE_A11` (default),
2540f1580f4eSBarry Smith               `PC_FIELDSPLIT_SCHUR_PRE_SELF`, `PC_FIELDSPLIT_SCHUR_PRE_USER`,
2541f1580f4eSBarry Smith               `PC_FIELDSPLIT_SCHUR_PRE_SELFP`, and `PC_FIELDSPLIT_SCHUR_PRE_FULL`
254260f59c3bSBarry Smith - pre   - matrix to use for preconditioning, or `NULL`
2543084e4875SJed Brown 
2544f1580f4eSBarry Smith   Options Database Keys:
2545d59693daSPierre Jolivet + -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is `a11`. See notes for meaning of various arguments
2546a1e3cbf9SBarry Smith - -fieldsplit_1_pc_type <pctype>                               - the preconditioner algorithm that is used to construct the preconditioner from the operator
2547e69d4d44SBarry Smith 
254860f59c3bSBarry Smith   Level: intermediate
254960f59c3bSBarry Smith 
2550fd1303e9SJungho Lee   Notes:
2551f1580f4eSBarry Smith   If ptype is
2552f1580f4eSBarry Smith +     a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
2553f1580f4eSBarry Smith   matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
2554f1580f4eSBarry Smith .     self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
2555e7593814SPierre Jolivet   The only preconditioners that currently work with this symbolic representation matrix object are `PCLSC` and `PCHPDDM`
2556f1580f4eSBarry Smith .     user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
2557f1580f4eSBarry Smith   to this function).
2558a077d33dSBarry Smith .     selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation $ Sp = A11 - A10 inv(diag(A00)) A01 $
2559f1580f4eSBarry Smith   This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
2560d59693daSPierre Jolivet   lumped before extracting the diagonal using the additional option `-fieldsplit_1_mat_schur_complement_ainv_type lump`
2561f1580f4eSBarry Smith -     full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation
2562f1580f4eSBarry Smith   computed internally by `PCFIELDSPLIT` (this is expensive)
2563f1580f4eSBarry Smith   useful mostly as a test that the Schur complement approach can work for your problem
2564fd1303e9SJungho Lee 
2565d59693daSPierre Jolivet   When solving a saddle point problem, where the A11 block is identically zero, using `a11` as the ptype only makes sense
2566a077d33dSBarry Smith   with the additional option `-fieldsplit_1_pc_type none`. Usually for saddle point problems one would use a `ptype` of `self` and
2567d59693daSPierre Jolivet   `-fieldsplit_1_pc_type lsc` which uses the least squares commutator to compute a preconditioner for the Schur complement.
2568fd1303e9SJungho Lee 
2569a077d33dSBarry Smith   Developer Note:
2570a077d33dSBarry Smith   The name of this function and the option `-pc_fieldsplit_schur_precondition` are inconsistent; precondition should be used everywhere.
2571feefa0e1SJacob Faibussowitsch 
2572a077d33dSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`,
2573a077d33dSBarry Smith           `MatSchurComplementSetAinvType()`, `PCLSC`, `PCFieldSplitSetSchurFactType()`
2574e69d4d44SBarry Smith @*/
2575d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurPre(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2576d71ae5a4SJacob Faibussowitsch {
2577e69d4d44SBarry Smith   PetscFunctionBegin;
25780700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2579cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurPre_C", (PC, PCFieldSplitSchurPreType, Mat), (pc, ptype, pre));
25803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2581e69d4d44SBarry Smith }
2582686bed4dSStefano Zampini 
2583d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurPrecondition(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2584d71ae5a4SJacob Faibussowitsch {
25859371c9d4SSatish Balay   return PCFieldSplitSetSchurPre(pc, ptype, pre);
25869371c9d4SSatish Balay } /* Deprecated name */
2587e69d4d44SBarry Smith 
258837a82bf0SJed Brown /*@
258937a82bf0SJed Brown   PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
2590f1580f4eSBarry Smith   preconditioned.  See `PCFieldSplitSetSchurPre()` for details.
259137a82bf0SJed Brown 
2592c3339decSBarry Smith   Logically Collective
259337a82bf0SJed Brown 
2594f899ff85SJose E. Roman   Input Parameter:
259537a82bf0SJed Brown . pc - the preconditioner context
259637a82bf0SJed Brown 
259737a82bf0SJed Brown   Output Parameters:
2598d59693daSPierre 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`
2599d59693daSPierre Jolivet - pre   - matrix to use for preconditioning (with `PC_FIELDSPLIT_SCHUR_PRE_USER`), or `NULL`
260037a82bf0SJed Brown 
260137a82bf0SJed Brown   Level: intermediate
260237a82bf0SJed Brown 
2603d59693daSPierre Jolivet .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCLSC`
260437a82bf0SJed Brown @*/
2605d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurPre(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre)
2606d71ae5a4SJacob Faibussowitsch {
260737a82bf0SJed Brown   PetscFunctionBegin;
260837a82bf0SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2609cac4c232SBarry Smith   PetscUseMethod(pc, "PCFieldSplitGetSchurPre_C", (PC, PCFieldSplitSchurPreType *, Mat *), (pc, ptype, pre));
26103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2611e69d4d44SBarry Smith }
2612e69d4d44SBarry Smith 
261345e7fc46SDmitry Karpeev /*@
2614f1580f4eSBarry Smith   PCFieldSplitSchurGetS -  extract the `MATSCHURCOMPLEMENT` object used by this `PCFIELDSPLIT` in case it needs to be configured separately
261545e7fc46SDmitry Karpeev 
261620f4b53cSBarry Smith   Not Collective
261745e7fc46SDmitry Karpeev 
261845e7fc46SDmitry Karpeev   Input Parameter:
261945e7fc46SDmitry Karpeev . pc - the preconditioner context
262045e7fc46SDmitry Karpeev 
262145e7fc46SDmitry Karpeev   Output Parameter:
2622470b340bSDmitry Karpeev . S - the Schur complement matrix
262345e7fc46SDmitry Karpeev 
262460f59c3bSBarry Smith   Level: advanced
262560f59c3bSBarry Smith 
2626f1580f4eSBarry Smith   Note:
2627f1580f4eSBarry Smith   This matrix should not be destroyed using `MatDestroy()`; rather, use `PCFieldSplitSchurRestoreS()`.
262845e7fc46SDmitry Karpeev 
262960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MATSCHURCOMPLEMENT`, `PCFieldSplitSchurRestoreS()`,
2630f1580f4eSBarry Smith           `MatCreateSchurComplement()`, `MatSchurComplementGetKSP()`, `MatSchurComplementComputeExplicitOperator()`, `MatGetSchurComplement()`
263145e7fc46SDmitry Karpeev @*/
2632d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurGetS(PC pc, Mat *S)
2633d71ae5a4SJacob Faibussowitsch {
263445e7fc46SDmitry Karpeev   const char    *t;
263545e7fc46SDmitry Karpeev   PetscBool      isfs;
263645e7fc46SDmitry Karpeev   PC_FieldSplit *jac;
263745e7fc46SDmitry Karpeev 
263845e7fc46SDmitry Karpeev   PetscFunctionBegin;
263945e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
26409566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
26419566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
264228b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
264345e7fc46SDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
264463a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
2645470b340bSDmitry Karpeev   if (S) *S = jac->schur;
26463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
264745e7fc46SDmitry Karpeev }
264845e7fc46SDmitry Karpeev 
2649470b340bSDmitry Karpeev /*@
2650f1580f4eSBarry Smith   PCFieldSplitSchurRestoreS -  returns the `MATSCHURCOMPLEMENT` matrix used by this `PC`
2651470b340bSDmitry Karpeev 
265220f4b53cSBarry Smith   Not Collective
2653470b340bSDmitry Karpeev 
2654470b340bSDmitry Karpeev   Input Parameters:
2655470b340bSDmitry Karpeev + pc - the preconditioner context
2656a2b725a8SWilliam Gropp - S  - the Schur complement matrix
2657470b340bSDmitry Karpeev 
2658470b340bSDmitry Karpeev   Level: advanced
2659470b340bSDmitry Karpeev 
266060f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurPre()`, `MatSchurComplement`, `PCFieldSplitSchurGetS()`
2661470b340bSDmitry Karpeev @*/
2662d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSchurRestoreS(PC pc, Mat *S)
2663d71ae5a4SJacob Faibussowitsch {
2664470b340bSDmitry Karpeev   const char    *t;
2665470b340bSDmitry Karpeev   PetscBool      isfs;
2666470b340bSDmitry Karpeev   PC_FieldSplit *jac;
2667470b340bSDmitry Karpeev 
2668470b340bSDmitry Karpeev   PetscFunctionBegin;
2669470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
26709566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetType((PetscObject)pc, &t));
26719566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(t, PCFIELDSPLIT, &isfs));
267228b400f6SJacob Faibussowitsch   PetscCheck(isfs, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PC of type PCFIELDSPLIT, got %s instead", t);
2673470b340bSDmitry Karpeev   jac = (PC_FieldSplit *)pc->data;
267463a3b9bcSJacob Faibussowitsch   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Expected PCFIELDSPLIT of type SCHUR, got %d instead", jac->type);
26757827d75bSBarry Smith   PetscCheck(S && (*S == jac->schur), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "MatSchurComplement restored is not the same as gotten");
26763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2677470b340bSDmitry Karpeev }
2678470b340bSDmitry Karpeev 
2679d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType ptype, Mat pre)
2680d71ae5a4SJacob Faibussowitsch {
2681e69d4d44SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2682e69d4d44SBarry Smith 
2683e69d4d44SBarry Smith   PetscFunctionBegin;
2684084e4875SJed Brown   jac->schurpre = ptype;
2685a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
26869566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&jac->schur_user));
2687084e4875SJed Brown     jac->schur_user = pre;
26889566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)jac->schur_user));
2689084e4875SJed Brown   }
26903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2691e69d4d44SBarry Smith }
2692e69d4d44SBarry Smith 
2693d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitGetSchurPre_FieldSplit(PC pc, PCFieldSplitSchurPreType *ptype, Mat *pre)
2694d71ae5a4SJacob Faibussowitsch {
269537a82bf0SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
269637a82bf0SJed Brown 
269737a82bf0SJed Brown   PetscFunctionBegin;
26986056e507SPierre Jolivet   if (ptype) *ptype = jac->schurpre;
26996056e507SPierre Jolivet   if (pre) *pre = jac->schur_user;
27003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
270137a82bf0SJed Brown }
270237a82bf0SJed Brown 
2703ab1df9f5SJed Brown /*@
27041d27aa22SBarry Smith   PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner {cite}`murphy2000note` and {cite}`ipsen2001note`
2705ab1df9f5SJed Brown 
2706c3339decSBarry Smith   Collective
2707ab1df9f5SJed Brown 
2708ab1df9f5SJed Brown   Input Parameters:
2709ab1df9f5SJed Brown + pc    - the preconditioner context
2710f1580f4eSBarry Smith - ftype - which blocks of factorization to retain, `PC_FIELDSPLIT_SCHUR_FACT_FULL` is default
2711ab1df9f5SJed Brown 
2712f1580f4eSBarry Smith   Options Database Key:
2713d59693daSPierre Jolivet . -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - default is `full`
2714ab1df9f5SJed Brown 
2715ab1df9f5SJed Brown   Level: intermediate
2716ab1df9f5SJed Brown 
2717ab1df9f5SJed Brown   Notes:
2718366f9a6aSPierre Jolivet   The `full` factorization is
2719ab1df9f5SJed Brown 
2720a077d33dSBarry Smith   ```{math}
2721a077d33dSBarry Smith   \left(\begin{array}{cc} A & B \\
2722a077d33dSBarry Smith   C & E \\
2723a077d33dSBarry Smith   \end{array}\right) =
2724366f9a6aSPierre Jolivet   \left(\begin{array}{cc} I & 0 \\
2725366f9a6aSPierre Jolivet   C A^{-1} & I \\
2726a077d33dSBarry Smith   \end{array}\right)
2727a077d33dSBarry Smith   \left(\begin{array}{cc} A & 0 \\
2728a077d33dSBarry Smith   0 & S \\
2729a077d33dSBarry Smith   \end{array}\right)
2730a077d33dSBarry Smith   \left(\begin{array}{cc} I & A^{-1}B \\
2731a077d33dSBarry Smith   0 & I \\
2732366f9a6aSPierre Jolivet   \end{array}\right) = L D U,
2733a077d33dSBarry Smith   ```
2734a077d33dSBarry Smith 
2735366f9a6aSPierre Jolivet   where $ S = E - C A^{-1} B $. In practice, the full factorization is applied via block triangular solves with the grouping $L(DU)$. `upper` uses $DU$, `lower` uses $LD$,
2736366f9a6aSPierre Jolivet   and `diag` is the diagonal part with the sign of $S$ flipped (because this makes the preconditioner positive definite for many formulations,
2737a077d33dSBarry Smith   thus allowing the use of `KSPMINRES)`. Sign flipping of $S$ can be turned off with `PCFieldSplitSetSchurScale()`.
2738a077d33dSBarry Smith 
2739a077d33dSBarry Smith   If $A$ and $S$ are solved exactly
2740366f9a6aSPierre Jolivet +  1 - `full` factorization is a direct solver.
2741366f9a6aSPierre Jolivet .  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.
2742366f9a6aSPierre Jolivet -  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.
2743ab1df9f5SJed Brown 
2744f1580f4eSBarry Smith   If the iteration count is very low, consider using `KSPFGMRES` or `KSPGCR` which can use one less preconditioner
27450ffb0e17SBarry 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.
27460ffb0e17SBarry Smith 
2747366f9a6aSPierre Jolivet   For symmetric problems in which $A$ is positive definite and $S$ is negative definite, `diag` can be used with `KSPMINRES`.
27480ffb0e17SBarry Smith 
2749366f9a6aSPierre Jolivet   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$).
2750ab1df9f5SJed Brown 
27511d27aa22SBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFieldSplitGetSubKSP()`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurPreType`, `PCFieldSplitSetSchurScale()`,
2752a077d33dSBarry Smith           [](sec_flexibleksp), `PCFieldSplitSetSchurPre()`
2753ab1df9f5SJed Brown @*/
2754d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurFactType(PC pc, PCFieldSplitSchurFactType ftype)
2755d71ae5a4SJacob Faibussowitsch {
2756ab1df9f5SJed Brown   PetscFunctionBegin;
2757ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2758cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurFactType_C", (PC, PCFieldSplitSchurFactType), (pc, ftype));
27593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2760ab1df9f5SJed Brown }
2761ab1df9f5SJed Brown 
2762d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc, PCFieldSplitSchurFactType ftype)
2763d71ae5a4SJacob Faibussowitsch {
2764ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2765ab1df9f5SJed Brown 
2766ab1df9f5SJed Brown   PetscFunctionBegin;
2767ab1df9f5SJed Brown   jac->schurfactorization = ftype;
27683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2769ab1df9f5SJed Brown }
2770ab1df9f5SJed Brown 
2771c096484dSStefano Zampini /*@
2772f1580f4eSBarry Smith   PCFieldSplitSetSchurScale -  Controls the sign flip of S for `PC_FIELDSPLIT_SCHUR_FACT_DIAG`.
2773c096484dSStefano Zampini 
2774c3339decSBarry Smith   Collective
2775c096484dSStefano Zampini 
2776c096484dSStefano Zampini   Input Parameters:
2777c096484dSStefano Zampini + pc    - the preconditioner context
2778c096484dSStefano Zampini - scale - scaling factor for the Schur complement
2779c096484dSStefano Zampini 
2780f1580f4eSBarry Smith   Options Database Key:
27811d27aa22SBarry Smith . -pc_fieldsplit_schur_scale <scale> - default is -1.0
2782c096484dSStefano Zampini 
2783c096484dSStefano Zampini   Level: intermediate
2784c096484dSStefano Zampini 
278542747ad1SJacob Faibussowitsch .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetFields()`, `PCFieldSplitSchurFactType`, `PCFieldSplitSetSchurFactType()`
2786c096484dSStefano Zampini @*/
2787d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetSchurScale(PC pc, PetscScalar scale)
2788d71ae5a4SJacob Faibussowitsch {
2789c096484dSStefano Zampini   PetscFunctionBegin;
2790c096484dSStefano Zampini   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2791c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc, scale, 2);
2792cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetSchurScale_C", (PC, PetscScalar), (pc, scale));
27933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2794c096484dSStefano Zampini }
2795c096484dSStefano Zampini 
2796d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc, PetscScalar scale)
2797d71ae5a4SJacob Faibussowitsch {
2798c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2799c096484dSStefano Zampini 
2800c096484dSStefano Zampini   PetscFunctionBegin;
2801c096484dSStefano Zampini   jac->schurscale = scale;
28023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2803c096484dSStefano Zampini }
2804c096484dSStefano Zampini 
280530ad9308SMatthew Knepley /*@C
28068c03b21aSDmitry Karpeev   PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
280730ad9308SMatthew Knepley 
2808c3339decSBarry Smith   Collective
280930ad9308SMatthew Knepley 
281030ad9308SMatthew Knepley   Input Parameter:
281130ad9308SMatthew Knepley . pc - the preconditioner context
281230ad9308SMatthew Knepley 
281330ad9308SMatthew Knepley   Output Parameters:
2814a04f6461SBarry Smith + A00 - the (0,0) block
2815a04f6461SBarry Smith . A01 - the (0,1) block
2816a04f6461SBarry Smith . A10 - the (1,0) block
2817a04f6461SBarry Smith - A11 - the (1,1) block
281830ad9308SMatthew Knepley 
281930ad9308SMatthew Knepley   Level: advanced
282030ad9308SMatthew Knepley 
28215d83a8b1SBarry Smith   Note:
28225d83a8b1SBarry Smith   Use `NULL` for any unneeded output arguments
28235d83a8b1SBarry Smith 
282460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `MatSchurComplementGetSubMatrices()`, `MatSchurComplementSetSubMatrices()`
282530ad9308SMatthew Knepley @*/
2826d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetSchurBlocks(PC pc, Mat *A00, Mat *A01, Mat *A10, Mat *A11)
2827d71ae5a4SJacob Faibussowitsch {
282830ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
282930ad9308SMatthew Knepley 
283030ad9308SMatthew Knepley   PetscFunctionBegin;
28310700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
283208401ef6SPierre Jolivet   PetscCheck(jac->type == PC_COMPOSITE_SCHUR, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2833a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2834a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2835a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2836a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
28373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
283830ad9308SMatthew Knepley }
283930ad9308SMatthew Knepley 
2840b09e027eSCarola Kruse /*@
28411d27aa22SBarry Smith   PCFieldSplitSetGKBTol -  Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2842b09e027eSCarola Kruse 
2843c3339decSBarry Smith   Collective
2844e071a0a4SCarola Kruse 
2845b09e027eSCarola Kruse   Input Parameters:
2846b09e027eSCarola Kruse + pc        - the preconditioner context
2847b09e027eSCarola Kruse - tolerance - the solver tolerance
2848b09e027eSCarola Kruse 
2849f1580f4eSBarry Smith   Options Database Key:
28501d27aa22SBarry Smith . -pc_fieldsplit_gkb_tol <tolerance> - default is 1e-5
2851b09e027eSCarola Kruse 
2852b09e027eSCarola Kruse   Level: intermediate
2853b09e027eSCarola Kruse 
2854f1580f4eSBarry Smith   Note:
28551d27aa22SBarry Smith   The generalized GKB algorithm {cite}`arioli2013` uses a lower bound estimate of the error in energy norm as stopping criterion.
2856f1580f4eSBarry Smith   It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than
28571d27aa22SBarry Smith   this estimate, the stopping criterion is satisfactory in practical cases.
2858f1580f4eSBarry Smith 
285960f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBMaxit()`
2860b09e027eSCarola Kruse @*/
2861d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBTol(PC pc, PetscReal tolerance)
2862d71ae5a4SJacob Faibussowitsch {
2863b09e027eSCarola Kruse   PetscFunctionBegin;
2864b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2865de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, tolerance, 2);
2866cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBTol_C", (PC, PetscReal), (pc, tolerance));
28673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2868b09e027eSCarola Kruse }
2869b09e027eSCarola Kruse 
2870d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc, PetscReal tolerance)
2871d71ae5a4SJacob Faibussowitsch {
2872b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2873b09e027eSCarola Kruse 
2874b09e027eSCarola Kruse   PetscFunctionBegin;
2875b09e027eSCarola Kruse   jac->gkbtol = tolerance;
28763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2877b09e027eSCarola Kruse }
2878b09e027eSCarola Kruse 
2879b09e027eSCarola Kruse /*@
288080670ca5SBarry Smith   PCFieldSplitSetGKBMaxit -  Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2881b09e027eSCarola Kruse 
2882c3339decSBarry Smith   Collective
2883b09e027eSCarola Kruse 
2884b09e027eSCarola Kruse   Input Parameters:
2885b09e027eSCarola Kruse + pc    - the preconditioner context
2886b09e027eSCarola Kruse - maxit - the maximum number of iterations
2887b09e027eSCarola Kruse 
2888f1580f4eSBarry Smith   Options Database Key:
28891d27aa22SBarry Smith . -pc_fieldsplit_gkb_maxit <maxit> - default is 100
2890b09e027eSCarola Kruse 
2891b09e027eSCarola Kruse   Level: intermediate
2892b09e027eSCarola Kruse 
289360f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBNu()`
2894b09e027eSCarola Kruse @*/
2895d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc, PetscInt maxit)
2896d71ae5a4SJacob Faibussowitsch {
2897b09e027eSCarola Kruse   PetscFunctionBegin;
2898b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2899de482cd7SCarola Kruse   PetscValidLogicalCollectiveInt(pc, maxit, 2);
2900cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBMaxit_C", (PC, PetscInt), (pc, maxit));
29013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2902b09e027eSCarola Kruse }
2903b09e027eSCarola Kruse 
2904d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc, PetscInt maxit)
2905d71ae5a4SJacob Faibussowitsch {
2906b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2907b09e027eSCarola Kruse 
2908b09e027eSCarola Kruse   PetscFunctionBegin;
2909b09e027eSCarola Kruse   jac->gkbmaxit = maxit;
29103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2911b09e027eSCarola Kruse }
2912b09e027eSCarola Kruse 
2913b09e027eSCarola Kruse /*@
29141d27aa22SBarry Smith   PCFieldSplitSetGKBDelay -  Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization {cite}`arioli2013` in `PCFIELDSPLIT`
2915e071a0a4SCarola Kruse   preconditioner.
2916b09e027eSCarola Kruse 
2917c3339decSBarry Smith   Collective
2918b09e027eSCarola Kruse 
2919b09e027eSCarola Kruse   Input Parameters:
2920b09e027eSCarola Kruse + pc    - the preconditioner context
2921b09e027eSCarola Kruse - delay - the delay window in the lower bound estimate
2922b09e027eSCarola Kruse 
2923f1580f4eSBarry Smith   Options Database Key:
29241d27aa22SBarry Smith . -pc_fieldsplit_gkb_delay <delay> - default is 5
2925b09e027eSCarola Kruse 
2926b09e027eSCarola Kruse   Level: intermediate
2927b09e027eSCarola Kruse 
29281d27aa22SBarry Smith   Notes:
29291d27aa22SBarry 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 $
29301d27aa22SBarry 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
29311d27aa22SBarry Smith   at least (`delay` + 1) iterations to stop.
2932f1580f4eSBarry Smith 
29331d27aa22SBarry Smith   For more details on the generalized Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to {cite}`arioli2013`
2934f1580f4eSBarry Smith 
293560f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBNu()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
2936b09e027eSCarola Kruse @*/
2937d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBDelay(PC pc, PetscInt delay)
2938d71ae5a4SJacob Faibussowitsch {
2939b09e027eSCarola Kruse   PetscFunctionBegin;
2940b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2941b09e027eSCarola Kruse   PetscValidLogicalCollectiveInt(pc, delay, 2);
2942cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBDelay_C", (PC, PetscInt), (pc, delay));
29433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2944b09e027eSCarola Kruse }
2945b09e027eSCarola Kruse 
2946d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc, PetscInt delay)
2947d71ae5a4SJacob Faibussowitsch {
2948b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2949b09e027eSCarola Kruse 
2950b09e027eSCarola Kruse   PetscFunctionBegin;
2951b09e027eSCarola Kruse   jac->gkbdelay = delay;
29523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2953b09e027eSCarola Kruse }
2954b09e027eSCarola Kruse 
2955b09e027eSCarola Kruse /*@
29561d27aa22SBarry Smith   PCFieldSplitSetGKBNu -  Sets the scalar value nu >= 0 in the transformation H = A00 + nu*A01*A01' of the (1,1) block in the
29571d27aa22SBarry Smith   Golub-Kahan bidiagonalization preconditioner {cite}`arioli2013` in `PCFIELDSPLIT`
2958b09e027eSCarola Kruse 
2959c3339decSBarry Smith   Collective
2960f1580f4eSBarry Smith 
2961f1580f4eSBarry Smith   Input Parameters:
2962f1580f4eSBarry Smith + pc - the preconditioner context
2963f1580f4eSBarry Smith - nu - the shift parameter
2964f1580f4eSBarry Smith 
296520f4b53cSBarry Smith   Options Database Key:
29661d27aa22SBarry Smith . -pc_fieldsplit_gkb_nu <nu> - default is 1
2967f1580f4eSBarry Smith 
2968f1580f4eSBarry Smith   Level: intermediate
2969b09e027eSCarola Kruse 
2970b09e027eSCarola Kruse   Notes:
29711d27aa22SBarry 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,
29721d27aa22SBarry 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
2973b09e027eSCarola Kruse   necessary to find a good balance in between the convergence of the inner and outer loop.
2974b09e027eSCarola Kruse 
29751d27aa22SBarry 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.
2976b09e027eSCarola Kruse 
297760f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetGKBDelay()`, `PCFieldSplitSetGKBTol()`, `PCFieldSplitSetGKBMaxit()`
2978b09e027eSCarola Kruse @*/
2979d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetGKBNu(PC pc, PetscReal nu)
2980d71ae5a4SJacob Faibussowitsch {
2981b09e027eSCarola Kruse   PetscFunctionBegin;
2982b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
2983de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc, nu, 2);
2984cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetGKBNu_C", (PC, PetscReal), (pc, nu));
29853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2986b09e027eSCarola Kruse }
2987b09e027eSCarola Kruse 
2988d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc, PetscReal nu)
2989d71ae5a4SJacob Faibussowitsch {
2990b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
2991b09e027eSCarola Kruse 
2992b09e027eSCarola Kruse   PetscFunctionBegin;
2993b09e027eSCarola Kruse   jac->gkbnu = nu;
29943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2995b09e027eSCarola Kruse }
2996b09e027eSCarola Kruse 
2997d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetType_FieldSplit(PC pc, PCCompositeType type)
2998d71ae5a4SJacob Faibussowitsch {
299979416396SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
300079416396SBarry Smith 
300179416396SBarry Smith   PetscFunctionBegin;
300279416396SBarry Smith   jac->type = type;
30032e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", NULL));
30042e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", NULL));
30052e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", NULL));
30062e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", NULL));
30072e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", NULL));
30082e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", NULL));
30092e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", NULL));
30102e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", NULL));
30112e956fe4SStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", NULL));
3012e071a0a4SCarola Kruse 
30133b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
30143b224e63SBarry Smith     pc->ops->apply          = PCApply_FieldSplit_Schur;
30157b665727SPierre Jolivet     pc->ops->applytranspose = PCApplyTranspose_FieldSplit_Schur;
30163b224e63SBarry Smith     pc->ops->view           = PCView_FieldSplit_Schur;
301773716367SStefano Zampini     pc->ops->setuponblocks  = PCSetUpOnBlocks_FieldSplit_Schur;
30182fa5cd67SKarl Rupp 
30199566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit_Schur));
30209566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurPre_C", PCFieldSplitSetSchurPre_FieldSplit));
30219566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSchurPre_C", PCFieldSplitGetSchurPre_FieldSplit));
30229566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurFactType_C", PCFieldSplitSetSchurFactType_FieldSplit));
30239566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetSchurScale_C", PCFieldSplitSetSchurScale_FieldSplit));
3024a51937d4SCarola Kruse   } else if (type == PC_COMPOSITE_GKB) {
3025a51937d4SCarola Kruse     pc->ops->apply          = PCApply_FieldSplit_GKB;
30267ff38633SStefano Zampini     pc->ops->applytranspose = NULL;
3027a51937d4SCarola Kruse     pc->ops->view           = PCView_FieldSplit_GKB;
302873716367SStefano Zampini     pc->ops->setuponblocks  = PCSetUpOnBlocks_FieldSplit_GKB;
3029e69d4d44SBarry Smith 
30309566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
30319566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBTol_C", PCFieldSplitSetGKBTol_FieldSplit));
30329566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBMaxit_C", PCFieldSplitSetGKBMaxit_FieldSplit));
30339566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBNu_C", PCFieldSplitSetGKBNu_FieldSplit));
30349566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetGKBDelay_C", PCFieldSplitSetGKBDelay_FieldSplit));
30353b224e63SBarry Smith   } else {
30363b224e63SBarry Smith     pc->ops->apply          = PCApply_FieldSplit;
30377ff38633SStefano Zampini     pc->ops->applytranspose = PCApplyTranspose_FieldSplit;
30383b224e63SBarry Smith     pc->ops->view           = PCView_FieldSplit;
303973716367SStefano Zampini     pc->ops->setuponblocks  = PCSetUpOnBlocks_FieldSplit;
30402fa5cd67SKarl Rupp 
30419566063dSJacob Faibussowitsch     PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitGetSubKSP_C", PCFieldSplitGetSubKSP_FieldSplit));
30423b224e63SBarry Smith   }
30433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
304479416396SBarry Smith }
304579416396SBarry Smith 
3046d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCFieldSplitSetBlockSize_FieldSplit(PC pc, PetscInt bs)
3047d71ae5a4SJacob Faibussowitsch {
304851f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
304951f519a2SBarry Smith 
305051f519a2SBarry Smith   PetscFunctionBegin;
305163a3b9bcSJacob Faibussowitsch   PetscCheck(bs >= 1, PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Blocksize must be positive, you gave %" PetscInt_FMT, bs);
30522472a847SBarry 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);
305351f519a2SBarry Smith   jac->bs = bs;
30543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
305551f519a2SBarry Smith }
305651f519a2SBarry Smith 
3057d71ae5a4SJacob Faibussowitsch static PetscErrorCode PCSetCoordinates_FieldSplit(PC pc, PetscInt dim, PetscInt nloc, PetscReal coords[])
3058d71ae5a4SJacob Faibussowitsch {
30595ddf11f8SNicolas Barnafi   PC_FieldSplit    *jac           = (PC_FieldSplit *)pc->data;
30605ddf11f8SNicolas Barnafi   PC_FieldSplitLink ilink_current = jac->head;
30615ddf11f8SNicolas Barnafi   IS                is_owned;
30625ddf11f8SNicolas Barnafi 
30635ddf11f8SNicolas Barnafi   PetscFunctionBegin;
30645ddf11f8SNicolas Barnafi   jac->coordinates_set = PETSC_TRUE; // Internal flag
3065f3fa974cSJacob Faibussowitsch   PetscCall(MatGetOwnershipIS(pc->mat, &is_owned, NULL));
30665ddf11f8SNicolas Barnafi 
30675ddf11f8SNicolas Barnafi   while (ilink_current) {
30685ddf11f8SNicolas Barnafi     // For each IS, embed it to get local coords indces
30695ddf11f8SNicolas Barnafi     IS              is_coords;
30705ddf11f8SNicolas Barnafi     PetscInt        ndofs_block;
30715ddf11f8SNicolas Barnafi     const PetscInt *block_dofs_enumeration; // Numbering of the dofs relevant to the current block
30725ddf11f8SNicolas Barnafi 
30735ddf11f8SNicolas Barnafi     // Setting drop to true for safety. It should make no difference.
30749566063dSJacob Faibussowitsch     PetscCall(ISEmbed(ilink_current->is, is_owned, PETSC_TRUE, &is_coords));
30759566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(is_coords, &ndofs_block));
30769566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(is_coords, &block_dofs_enumeration));
30775ddf11f8SNicolas Barnafi 
30785ddf11f8SNicolas Barnafi     // Allocate coordinates vector and set it directly
3079f4f49eeaSPierre Jolivet     PetscCall(PetscMalloc1(ndofs_block * dim, &ilink_current->coords));
30805ddf11f8SNicolas Barnafi     for (PetscInt dof = 0; dof < ndofs_block; ++dof) {
3081ad540459SPierre Jolivet       for (PetscInt d = 0; d < dim; ++d) (ilink_current->coords)[dim * dof + d] = coords[dim * block_dofs_enumeration[dof] + d];
30825ddf11f8SNicolas Barnafi     }
30835ddf11f8SNicolas Barnafi     ilink_current->dim   = dim;
30845ddf11f8SNicolas Barnafi     ilink_current->ndofs = ndofs_block;
30859566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(is_coords, &block_dofs_enumeration));
30869566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&is_coords));
30875ddf11f8SNicolas Barnafi     ilink_current = ilink_current->next;
30885ddf11f8SNicolas Barnafi   }
30899566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_owned));
30903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30915ddf11f8SNicolas Barnafi }
30925ddf11f8SNicolas Barnafi 
3093bc08b0f1SBarry Smith /*@
3094f1580f4eSBarry Smith   PCFieldSplitSetType - Sets the type, `PCCompositeType`, of a `PCFIELDSPLIT`
309579416396SBarry Smith 
3096c3339decSBarry Smith   Collective
309779416396SBarry Smith 
3098d8d19677SJose E. Roman   Input Parameters:
3099a2b725a8SWilliam Gropp + pc   - the preconditioner context
3100a077d33dSBarry Smith - type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`,
3101a077d33dSBarry Smith          `PC_COMPOSITE_GKB`
310279416396SBarry Smith 
310379416396SBarry Smith   Options Database Key:
31041d27aa22SBarry Smith . -pc_fieldsplit_type <one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
310579416396SBarry Smith 
3106feefa0e1SJacob Faibussowitsch   Level: intermediate
310779416396SBarry Smith 
310860f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCCompositeType`, `PCCompositeGetType()`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`,
3109a077d33dSBarry Smith           `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`, `PCFieldSplitSetSchurFactType()`
311079416396SBarry Smith @*/
3111d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetType(PC pc, PCCompositeType type)
3112d71ae5a4SJacob Faibussowitsch {
311379416396SBarry Smith   PetscFunctionBegin;
31140700a824SBarry Smith   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
3115cac4c232SBarry Smith   PetscTryMethod(pc, "PCFieldSplitSetType_C", (PC, PCCompositeType), (pc, type));
31163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
311779416396SBarry Smith }
311879416396SBarry Smith 
3119b02e2d75SMatthew G Knepley /*@
3120f1580f4eSBarry Smith   PCFieldSplitGetType - Gets the type, `PCCompositeType`, of a `PCFIELDSPLIT`
3121b02e2d75SMatthew G Knepley 
3122b02e2d75SMatthew G Knepley   Not collective
3123b02e2d75SMatthew G Knepley 
3124b02e2d75SMatthew G Knepley   Input Parameter:
3125b02e2d75SMatthew G Knepley . pc - the preconditioner context
3126b02e2d75SMatthew G Knepley 
3127b02e2d75SMatthew G Knepley   Output Parameter:
3128f1580f4eSBarry Smith . type - `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE` (default), `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
3129b02e2d75SMatthew G Knepley 
3130feefa0e1SJacob Faibussowitsch   Level: intermediate
3131b02e2d75SMatthew G Knepley 
313260f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCompositeSetType()`, `PCFIELDSPLIT`, `PCCompositeType`, `PC_COMPOSITE_ADDITIVE`, `PC_COMPOSITE_MULTIPLICATIVE`,
3133f1580f4eSBarry Smith           `PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE`, `PC_COMPOSITE_SPECIAL`, `PC_COMPOSITE_SCHUR`
3134b02e2d75SMatthew G Knepley @*/
3135d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
3136d71ae5a4SJacob Faibussowitsch {
3137b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
3138b02e2d75SMatthew G Knepley 
3139b02e2d75SMatthew G Knepley   PetscFunctionBegin;
3140b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
31414f572ea9SToby Isaac   PetscAssertPointer(type, 2);
3142b02e2d75SMatthew G Knepley   *type = jac->type;
31433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3144b02e2d75SMatthew G Knepley }
3145b02e2d75SMatthew G Knepley 
31464ab8060aSDmitry Karpeev /*@
3147f1580f4eSBarry Smith   PCFieldSplitSetDMSplits - Flags whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible.
31484ab8060aSDmitry Karpeev 
3149c3339decSBarry Smith   Logically Collective
31504ab8060aSDmitry Karpeev 
31514ab8060aSDmitry Karpeev   Input Parameters:
31524ab8060aSDmitry Karpeev + pc  - the preconditioner context
3153f1580f4eSBarry Smith - flg - boolean indicating whether to use field splits defined by the `DM`
31544ab8060aSDmitry Karpeev 
31554ab8060aSDmitry Karpeev   Options Database Key:
3156f1580f4eSBarry Smith . -pc_fieldsplit_dm_splits <bool> - use the field splits defined by the `DM`
31574ab8060aSDmitry Karpeev 
3158feefa0e1SJacob Faibussowitsch   Level: intermediate
31594ab8060aSDmitry Karpeev 
316073ff1848SBarry Smith   Developer Note:
316173ff1848SBarry Smith   The name should be `PCFieldSplitSetUseDMSplits()`, similar change to options database
316273ff1848SBarry Smith 
3163f8d70eaaSPierre Jolivet .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDMSplits()`, `DMCreateFieldDecomposition()`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
31644ab8060aSDmitry Karpeev @*/
3165d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDMSplits(PC pc, PetscBool flg)
3166d71ae5a4SJacob Faibussowitsch {
31674ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
31684ab8060aSDmitry Karpeev   PetscBool      isfs;
31694ab8060aSDmitry Karpeev 
31704ab8060aSDmitry Karpeev   PetscFunctionBegin;
31714ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
31724ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc, flg, 2);
31739566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
3174ad540459SPierre Jolivet   if (isfs) jac->dm_splits = flg;
31753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
31764ab8060aSDmitry Karpeev }
31774ab8060aSDmitry Karpeev 
31784ab8060aSDmitry Karpeev /*@
3179f1580f4eSBarry Smith   PCFieldSplitGetDMSplits - Returns flag indicating whether `DMCreateFieldDecomposition()` should be used to define the splits in a `PCFIELDSPLIT`, whenever possible.
31804ab8060aSDmitry Karpeev 
31814ab8060aSDmitry Karpeev   Logically Collective
31824ab8060aSDmitry Karpeev 
31834ab8060aSDmitry Karpeev   Input Parameter:
31844ab8060aSDmitry Karpeev . pc - the preconditioner context
31854ab8060aSDmitry Karpeev 
31864ab8060aSDmitry Karpeev   Output Parameter:
3187f1580f4eSBarry Smith . flg - boolean indicating whether to use field splits defined by the `DM`
31884ab8060aSDmitry Karpeev 
3189feefa0e1SJacob Faibussowitsch   Level: intermediate
31904ab8060aSDmitry Karpeev 
319173ff1848SBarry Smith   Developer Note:
319273ff1848SBarry Smith   The name should be `PCFieldSplitGetUseDMSplits()`
319373ff1848SBarry Smith 
3194f8d70eaaSPierre Jolivet .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDMSplits()`, `DMCreateFieldDecomposition()`, `PCFieldSplitSetFields()`, `PCFieldSplitSetIS()`
31954ab8060aSDmitry Karpeev @*/
3196d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDMSplits(PC pc, PetscBool *flg)
3197d71ae5a4SJacob Faibussowitsch {
31984ab8060aSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
31994ab8060aSDmitry Karpeev   PetscBool      isfs;
32004ab8060aSDmitry Karpeev 
32014ab8060aSDmitry Karpeev   PetscFunctionBegin;
32024ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc, PC_CLASSID, 1);
32034f572ea9SToby Isaac   PetscAssertPointer(flg, 2);
32049566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)pc, PCFIELDSPLIT, &isfs));
32054ab8060aSDmitry Karpeev   if (isfs) {
32064ab8060aSDmitry Karpeev     if (flg) *flg = jac->dm_splits;
32074ab8060aSDmitry Karpeev   }
32083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32094ab8060aSDmitry Karpeev }
32104ab8060aSDmitry Karpeev 
32117b752e3dSPatrick Sanan /*@
3212f1580f4eSBarry Smith   PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries.
32137b752e3dSPatrick Sanan 
32147b752e3dSPatrick Sanan   Logically Collective
32157b752e3dSPatrick Sanan 
32167b752e3dSPatrick Sanan   Input Parameter:
32177b752e3dSPatrick Sanan . pc - the preconditioner context
32187b752e3dSPatrick Sanan 
32197b752e3dSPatrick Sanan   Output Parameter:
32207b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not
32217b752e3dSPatrick Sanan 
3222feefa0e1SJacob Faibussowitsch   Level: intermediate
32237b752e3dSPatrick Sanan 
322460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitSetDetectSaddlePoint()`
32257b752e3dSPatrick Sanan @*/
3226d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc, PetscBool *flg)
3227d71ae5a4SJacob Faibussowitsch {
32287b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
32297b752e3dSPatrick Sanan 
32307b752e3dSPatrick Sanan   PetscFunctionBegin;
32317b752e3dSPatrick Sanan   *flg = jac->detect;
32323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32337b752e3dSPatrick Sanan }
32347b752e3dSPatrick Sanan 
32357b752e3dSPatrick Sanan /*@
3236f1580f4eSBarry Smith   PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether `PCFIELDSPLIT` will attempt to automatically determine fields based on zero diagonal entries.
32377b752e3dSPatrick Sanan 
32387b752e3dSPatrick Sanan   Logically Collective
32397b752e3dSPatrick Sanan 
32407b752e3dSPatrick Sanan   Input Parameter:
32417b752e3dSPatrick Sanan . pc - the preconditioner context
32427b752e3dSPatrick Sanan 
32437b752e3dSPatrick Sanan   Output Parameter:
32447b752e3dSPatrick Sanan . flg - boolean indicating whether to detect fields or not
32457b752e3dSPatrick Sanan 
32467b752e3dSPatrick Sanan   Options Database Key:
3247147403d9SBarry Smith . -pc_fieldsplit_detect_saddle_point <bool> - detect and use the saddle point
3248147403d9SBarry Smith 
3249feefa0e1SJacob Faibussowitsch   Level: intermediate
325060f59c3bSBarry Smith 
3251f1580f4eSBarry Smith   Note:
3252f1580f4eSBarry 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()`).
32537b752e3dSPatrick Sanan 
325460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCFIELDSPLIT`, `PCFieldSplitGetDetectSaddlePoint()`, `PCFieldSplitSetType()`, `PCFieldSplitSetSchurPre()`, `PC_FIELDSPLIT_SCHUR_PRE_SELF`
32557b752e3dSPatrick Sanan @*/
3256d71ae5a4SJacob Faibussowitsch PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc, PetscBool flg)
3257d71ae5a4SJacob Faibussowitsch {
32587b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit *)pc->data;
32597b752e3dSPatrick Sanan 
32607b752e3dSPatrick Sanan   PetscFunctionBegin;
32617b752e3dSPatrick Sanan   jac->detect = flg;
32627b752e3dSPatrick Sanan   if (jac->detect) {
32639566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetType(pc, PC_COMPOSITE_SCHUR));
32649566063dSJacob Faibussowitsch     PetscCall(PCFieldSplitSetSchurPre(pc, PC_FIELDSPLIT_SCHUR_PRE_SELF, NULL));
32657b752e3dSPatrick Sanan   }
32663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32677b752e3dSPatrick Sanan }
32687b752e3dSPatrick Sanan 
32690971522cSBarry Smith /*MC
3270a8c7a070SBarry Smith   PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
32710b4b7b1cSBarry Smith   collections of variables (that may overlap) called fields or splits. Each field often represents a different continuum variable
32720b4b7b1cSBarry Smith   represented on a grid, such as velocity, pressure, or temperature.
32730b4b7b1cSBarry Smith   In the literature these are sometimes called block preconditioners; but should not be confused with `PCBJACOBI`.
32740b4b7b1cSBarry Smith   See [the users manual section on "Solving Block Matrices"](sec_block_matrices) for more details.
32750971522cSBarry Smith 
327679416396SBarry Smith   Options Database Keys:
3277de37d9f1SPatrick Sanan +   -pc_fieldsplit_%d_fields <a,b,..>                                                - indicates the fields to be used in the `%d`'th split
327881540f2fSBarry Smith .   -pc_fieldsplit_default                                                           - automatically add any fields to additional splits that have not
3279de37d9f1SPatrick Sanan                                                                                        been supplied explicitly by `-pc_fieldsplit_%d_fields`
328081540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs>                                                   - size of block that defines fields (i.e. there are bs fields)
328180670ca5SBarry Smith                                                                                        when the matrix is not of `MatType` `MATNEST`
3282a51937d4SCarola Kruse .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting
3283d59693daSPierre Jolivet .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full>                     - default is `a11`; see `PCFieldSplitSetSchurPre()`
32841d27aa22SBarry Smith .   -pc_fieldsplit_schur_fact_type <diag,lower,upper,full>                           - set factorization type when using `-pc_fieldsplit_type schur`;
32851d27aa22SBarry Smith                                                                                        see `PCFieldSplitSetSchurFactType()`
328673ff1848SBarry Smith .   -pc_fieldsplit_dm_splits <true,false> (default is true)                          - Whether to use `DMCreateFieldDecomposition()` for splits
3287fb6809a2SPatrick Sanan -   -pc_fieldsplit_detect_saddle_point                                               - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
328879416396SBarry Smith 
3289de37d9f1SPatrick Sanan   Options prefixes for inner solvers when using the Schur complement preconditioner are `-fieldsplit_0_` and `-fieldsplit_1_` .
3290de37d9f1SPatrick Sanan   The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is `-fieldsplit_0_`
329160f59c3bSBarry Smith   For all other solvers they are `-fieldsplit_%d_` for the `%d`'th field; use `-fieldsplit_` for all fields.
329260f59c3bSBarry Smith 
329322399129SNuno Nobre   To set options on the solvers for all blocks, prepend `-fieldsplit_` to all the `PC`
329422399129SNuno Nobre   options database keys. For example, `-fieldsplit_pc_type ilu` `-fieldsplit_pc_factor_levels 1`.
329560f59c3bSBarry Smith 
329660f59c3bSBarry Smith   To set the options on the solvers separate for each block call `PCFieldSplitGetSubKSP()`
329760f59c3bSBarry Smith   and set the options directly on the resulting `KSP` object
329860f59c3bSBarry Smith 
329960f59c3bSBarry Smith   Level: intermediate
33005d4c12cdSJungho Lee 
3301c8a0d604SMatthew G Knepley   Notes:
330280670ca5SBarry Smith   Use `PCFieldSplitSetFields()` to set splits defined by "strided" entries or with a `MATNEST` and `PCFieldSplitSetIS()`
3303f1580f4eSBarry Smith   to define a split by an arbitrary collection of entries.
3304d32f9abdSBarry Smith 
330573ff1848SBarry Smith   If no splits are set, the default is used. If a `DM` is associated with the `PC` and it supports
330680670ca5SBarry 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,
3307de37d9f1SPatrick Sanan   beginning at 0 then 1, etc to bs-1. The block size can be set with `PCFieldSplitSetBlockSize()`,
3308d32f9abdSBarry Smith   if this is not called the block size defaults to the blocksize of the second matrix passed
3309de37d9f1SPatrick Sanan   to `KSPSetOperators()`/`PCSetOperators()`.
3310d32f9abdSBarry Smith 
3311de37d9f1SPatrick Sanan   For the Schur complement preconditioner if
3312de37d9f1SPatrick Sanan   ```{math}
3313de37d9f1SPatrick Sanan     J = \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{10} & A_{11} \end{array}\right]
3314de37d9f1SPatrick Sanan   ```
3315e69d4d44SBarry Smith 
3316de37d9f1SPatrick Sanan   the preconditioner using `full` factorization is logically
3317de37d9f1SPatrick Sanan   ```{math}
3318f820a28cSNuno Nobre     \left[\begin{array}{cc} I & -\text{ksp}(A_{00}) A_{01} \\ 0 & I \end{array}\right] \left[\begin{array}{cc} \text{ksp}(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]
3319de37d9f1SPatrick Sanan       ```
3320cee94454SNuno Nobre   where the action of $\text{ksp}(A_{00})$ is applied using the `KSP` solver with prefix `-fieldsplit_0_`.  $S$ is the Schur complement
3321de37d9f1SPatrick Sanan   ```{math}
3322223e5b4fSPatrick Sanan      S = A_{11} - A_{10} \text{ksp}(A_{00}) A_{01}
3323de37d9f1SPatrick Sanan   ```
33247cbeddf0SNuno Nobre   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`
33257cbeddf0SNuno Nobre   was given in providing the SECOND split or 1 if not given). Accordingly, if using `PCFieldSplitGetSubKSP()`, the array of sub-`KSP` contexts will hold two `KSP`s: at its
33267cbeddf0SNuno Nobre   0th index, the `KSP` associated with `-fieldsplit_0_`, and at its 1st index, the `KSP` corresponding to `-fieldsplit_1_`.
3327d82b6cdfSNuno Nobre   By default, $A_{11}$ is used to construct a preconditioner for $S$, use `PCFieldSplitSetSchurPre()` for all the possible ways to construct the preconditioner for $S$.
3328de37d9f1SPatrick Sanan 
3329de37d9f1SPatrick Sanan   The factorization type is set using `-pc_fieldsplit_schur_fact_type <diag, lower, upper, full>`. `full` is shown above,
3330de37d9f1SPatrick Sanan   `diag` gives
3331de37d9f1SPatrick Sanan   ```{math}
3332f820a28cSNuno Nobre     \left[\begin{array}{cc} \text{ksp}(A_{00}) & 0 \\  0 & -\text{ksp}(S) \end{array}\right]
3333de37d9f1SPatrick Sanan   ```
3334de37d9f1SPatrick 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
3335de37d9f1SPatrick Sanan   can be turned off with `PCFieldSplitSetSchurScale()` or by command line `-pc_fieldsplit_schur_scale 1.0`. The `lower` factorization is the inverse of
3336de37d9f1SPatrick Sanan   ```{math}
3337de37d9f1SPatrick Sanan     \left[\begin{array}{cc} A_{00} & 0 \\  A_{10} & S \end{array}\right]
3338de37d9f1SPatrick Sanan   ```
3339cee94454SNuno Nobre   where the inverses of $A_{00}$ and $S$ are applied using `KSP`s. The upper factorization is the inverse of
3340de37d9f1SPatrick Sanan   ```{math}
3341de37d9f1SPatrick Sanan     \left[\begin{array}{cc} A_{00} & A_{01} \\  0 & S \end{array}\right]
3342de37d9f1SPatrick Sanan   ```
3343de37d9f1SPatrick Sanan   where again the inverses of $A_{00}$ and $S$ are applied using `KSP`s.
3344de37d9f1SPatrick Sanan 
3345de37d9f1SPatrick Sanan   If only one set of indices (one `IS`) is provided with `PCFieldSplitSetIS()` then the complement of that `IS`
334680670ca5SBarry Smith   is used automatically for a second submatrix.
3347edf189efSBarry Smith 
3348f1580f4eSBarry Smith   The fieldsplit preconditioner cannot currently be used with the `MATBAIJ` or `MATSBAIJ` data formats if the blocksize is larger than 1.
334980670ca5SBarry Smith   Generally it should be used with the `MATAIJ` or `MATNEST` `MatType`
3350ff218e97SBarry Smith 
335180670ca5SBarry Smith   The forms of these preconditioners are closely related, if not identical, to forms derived as "Distributive Iterations", see,
33521d569b8fSBarry Smith   for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling {cite}`wesseling2009`.
335380670ca5SBarry Smith   One can also use `PCFIELDSPLIT` inside a smoother resulting in "Distributive Smoothers".
33540716a85fSBarry Smith 
3355de37d9f1SPatrick Sanan   See "A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations" {cite}`elman2008tcp`.
3356a6a584a2SBarry Smith 
3357de37d9f1SPatrick Sanan   The Constrained Pressure Preconditioner (CPR) can be implemented using `PCCOMPOSITE` with `PCGALERKIN`. CPR first solves an $R A P$ subsystem, updates the
3358de37d9f1SPatrick Sanan   residual on all variables (`PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)`), and then applies a simple ILU like preconditioner on all the variables.
3359a51937d4SCarola Kruse 
3360de37d9f1SPatrick Sanan   The generalized Golub-Kahan bidiagonalization preconditioner (GKB) can be applied to symmetric $2 \times 2$ block matrices of the shape
3361de37d9f1SPatrick Sanan   ```{math}
3362de37d9f1SPatrick Sanan     \left[\begin{array}{cc} A_{00} & A_{01} \\ A_{01}' & 0 \end{array}\right]
3363de37d9f1SPatrick Sanan   ```
33641d569b8fSBarry 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}'$.
3365de37d9f1SPatrick 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_`.
3366a51937d4SCarola Kruse 
33670b4b7b1cSBarry Smith   Some `PCFIELDSPLIT` variants are called physics-based preconditioners, since the preconditioner takes into account the underlying physics of the
33680b4b7b1cSBarry Smith   problem. But this nomenclature is not well-defined.
33690b4b7b1cSBarry Smith 
337060f59c3bSBarry Smith   Developer Note:
337160f59c3bSBarry Smith   The Schur complement functionality of `PCFIELDSPLIT` should likely be factored into its own `PC` thus simplifying the implementation of the preconditioners and their
337260f59c3bSBarry Smith   user API.
3373f1580f4eSBarry Smith 
337460f59c3bSBarry Smith .seealso: [](sec_block_matrices), `PC`, `PCCreate()`, `PCSetType()`, `PCType`, `PC`, `PCLSC`,
3375db781477SPatrick Sanan           `PCFieldSplitGetSubKSP()`, `PCFieldSplitSchurGetSubKSP()`, `PCFieldSplitSetFields()`,
3376db781477SPatrick Sanan           `PCFieldSplitSetType()`, `PCFieldSplitSetIS()`, `PCFieldSplitSetSchurPre()`, `PCFieldSplitSetSchurFactType()`,
3377db781477SPatrick Sanan           `MatSchurComplementSetAinvType()`, `PCFieldSplitSetSchurScale()`, `PCFieldSplitSetDetectSaddlePoint()`
33780971522cSBarry Smith M*/
33790971522cSBarry Smith 
3380d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
3381d71ae5a4SJacob Faibussowitsch {
33820971522cSBarry Smith   PC_FieldSplit *jac;
33830971522cSBarry Smith 
33840971522cSBarry Smith   PetscFunctionBegin;
33854dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&jac));
33862fa5cd67SKarl Rupp 
33870971522cSBarry Smith   jac->bs                 = -1;
33883e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
3389e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
3390c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
3391c096484dSStefano Zampini   jac->schurscale         = -1.0;
3392fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
3393a51937d4SCarola Kruse   jac->gkbtol             = 1e-5;
3394a51937d4SCarola Kruse   jac->gkbdelay           = 5;
3395a51937d4SCarola Kruse   jac->gkbnu              = 1;
3396a51937d4SCarola Kruse   jac->gkbmaxit           = 100;
339751f519a2SBarry Smith 
33980971522cSBarry Smith   pc->data = (void *)jac;
33990971522cSBarry Smith 
34000971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
3401574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
34020971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
34030971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
34040a545947SLisandro Dalcin   pc->ops->applyrichardson = NULL;
34050971522cSBarry Smith 
34069566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSchurGetSubKSP_C", PCFieldSplitSchurGetSubKSP_FieldSplit));
34079566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetFields_C", PCFieldSplitSetFields_FieldSplit));
34089566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetIS_C", PCFieldSplitSetIS_FieldSplit));
34099566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetType_C", PCFieldSplitSetType_FieldSplit));
34109566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitSetBlockSize_C", PCFieldSplitSetBlockSize_FieldSplit));
34119566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCFieldSplitRestrictIS_C", PCFieldSplitRestrictIS_FieldSplit));
34129566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)pc, "PCSetCoordinates_C", PCSetCoordinates_FieldSplit));
34137ff38633SStefano Zampini 
34147ff38633SStefano Zampini   /* Initialize function pointers */
34157ff38633SStefano Zampini   PetscCall(PCFieldSplitSetType(pc, jac->type));
34163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
34170971522cSBarry Smith }
3418