xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 412be6bfbc80b685780b26ee7fe3dbc52a24308a)
1af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
2a80b646eSBarry Smith #include <petsc/private/kspimpl.h>    /*  This is needed to provide the appropriate PETSC_EXTERN for KSP_Solve_FS ....*/
31e25c274SJed Brown #include <petscdm.h>
40971522cSBarry Smith 
52e71c61dSMatthew G. Knepley const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0};
6c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0};
7c5d2311dSJed Brown 
89df09d43SBarry Smith PetscLogEvent KSP_Solve_FS_0,KSP_Solve_FS_1,KSP_Solve_FS_S,KSP_Solve_FS_U,KSP_Solve_FS_L,KSP_Solve_FS_2,KSP_Solve_FS_3,KSP_Solve_FS_4;
99df09d43SBarry Smith 
100971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
110971522cSBarry Smith struct _PC_FieldSplitLink {
1269a612a9SBarry Smith   KSP               ksp;
13443836d0SMatthew G Knepley   Vec               x,y,z;
14db4c96c1SJed Brown   char              *splitname;
150971522cSBarry Smith   PetscInt          nfields;
165d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
171b9fc7fcSBarry Smith   VecScatter        sctx;
18f5f0d762SBarry Smith   IS                is,is_col;
1951f519a2SBarry Smith   PC_FieldSplitLink next,previous;
209df09d43SBarry Smith   PetscLogEvent     event;
210971522cSBarry Smith };
220971522cSBarry Smith 
230971522cSBarry Smith typedef struct {
2468dd23aaSBarry Smith   PCCompositeType type;
25ace3abfcSBarry Smith   PetscBool       defaultsplit;                    /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
26ace3abfcSBarry Smith   PetscBool       splitdefined;                    /* Flag is set after the splits have been defined, to prevent more splits from being added */
2730ad9308SMatthew Knepley   PetscInt        bs;                              /* Block size for IS and Mat structures */
2830ad9308SMatthew Knepley   PetscInt        nsplits;                         /* Number of field divisions defined */
2979416396SBarry Smith   Vec             *x,*y,w1,w2;
30519d70e2SJed Brown   Mat             *mat;                            /* The diagonal block for each split */
31519d70e2SJed Brown   Mat             *pmat;                           /* The preconditioning diagonal block for each split */
3230ad9308SMatthew Knepley   Mat             *Afield;                         /* The rows of the matrix associated with each split */
33ace3abfcSBarry Smith   PetscBool       issetup;
342fa5cd67SKarl Rupp 
3530ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
3630ad9308SMatthew Knepley   Mat                       B;                     /* The (0,1) block */
3730ad9308SMatthew Knepley   Mat                       C;                     /* The (1,0) block */
38443836d0SMatthew G Knepley   Mat                       schur;                 /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
39a7476a74SDmitry Karpeev   Mat                       schurp;                /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
40084e4875SJed Brown   Mat                       schur_user;            /* User-provided preconditioning matrix for the Schur complement */
41084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;              /* Determines which preconditioning matrix is used for the Schur complement */
42c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4330ad9308SMatthew Knepley   KSP                       kspschur;              /* The solver for S */
44443836d0SMatthew G Knepley   KSP                       kspupper;              /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
45c096484dSStefano Zampini   PetscScalar               schurscale;            /* Scaling factor for the Schur complement solution with DIAG factorization */
46c096484dSStefano Zampini 
47a51937d4SCarola Kruse   /* Only used when Golub-Kahan bidiagonalization preconditioning is used */
48a51937d4SCarola Kruse   Mat                       H;                     /* The modified matrix H = A00 + nu*A01*A01'              */
49a51937d4SCarola Kruse   PetscReal                 gkbtol;                /* Stopping tolerance for lower bound estimate            */
50a51937d4SCarola Kruse   PetscInt                  gkbdelay;              /* The delay window for the stopping criterion            */
51a51937d4SCarola Kruse   PetscReal                 gkbnu;                 /* Parameter for augmented Lagrangian H = A + nu*A01*A01' */
52a51937d4SCarola Kruse   PetscInt                  gkbmaxit;              /* Maximum number of iterations for outer loop            */
53de482cd7SCarola Kruse   PetscBool                 gkbmonitor;            /* Monitor for gkb iterations and the lower bound error   */
54de482cd7SCarola Kruse   PetscViewer               gkbviewer;             /* Viewer context for gkbmonitor                          */
55e071a0a4SCarola Kruse   Vec                       u,v,d,Hu;              /* Work vectors for the GKB algorithm                     */
56e071a0a4SCarola Kruse   PetscScalar               *vecz;                 /* Contains intermediate values, eg for lower bound       */
57a51937d4SCarola Kruse 
5897bbdb24SBarry Smith   PC_FieldSplitLink         head;
596dbb499eSCian Wilson   PetscBool                 isrestrict;             /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */
60c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
614ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
62c84da90fSDmitry Karpeev   PetscBool                 diag_use_amat;          /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
63c84da90fSDmitry Karpeev   PetscBool                 offdiag_use_amat;       /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
647b752e3dSPatrick Sanan   PetscBool                 detect;                 /* Whether to form 2-way split by finding zero diagonal entries */
650971522cSBarry Smith } PC_FieldSplit;
660971522cSBarry Smith 
6716913363SBarry Smith /*
6895452b02SPatrick Sanan     Notes:
6995452b02SPatrick Sanan     there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
7016913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
7116913363SBarry Smith    PC you could change this.
7216913363SBarry Smith */
73084e4875SJed Brown 
74e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
75084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
76084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
77084e4875SJed Brown {
78084e4875SJed Brown   switch (jac->schurpre) {
79084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
80a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
81e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
82e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
83084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
84084e4875SJed Brown   default:
85084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
86084e4875SJed Brown   }
87084e4875SJed Brown }
88084e4875SJed Brown 
89084e4875SJed Brown 
909804daf3SBarry Smith #include <petscdraw.h>
910971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
920971522cSBarry Smith {
930971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
940971522cSBarry Smith   PetscErrorCode    ierr;
95d9884438SBarry Smith   PetscBool         iascii,isdraw;
960971522cSBarry Smith   PetscInt          i,j;
975a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
980971522cSBarry Smith 
990971522cSBarry Smith   PetscFunctionBegin;
100251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
101d9884438SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1020971522cSBarry Smith   if (iascii) {
1032c9966d7SBarry Smith     if (jac->bs > 0) {
10451f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
1052c9966d7SBarry Smith     } else {
1062c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
1072c9966d7SBarry Smith     }
108f5236f50SJed Brown     if (pc->useAmat) {
109f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
110a3df900dSMatthew G Knepley     }
111c84da90fSDmitry Karpeev     if (jac->diag_use_amat) {
112c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
113c84da90fSDmitry Karpeev     }
114c84da90fSDmitry Karpeev     if (jac->offdiag_use_amat) {
115c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
116c84da90fSDmitry Karpeev     }
11769a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1180971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1191ab39975SBarry Smith       if (ilink->fields) {
1200971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
12179416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1225a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
12379416396SBarry Smith           if (j > 0) {
12479416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
12579416396SBarry Smith           }
1265a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1270971522cSBarry Smith         }
1280971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
12979416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1301ab39975SBarry Smith       } else {
1311ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1321ab39975SBarry Smith       }
1335a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1345a9f2f41SSatish Balay       ilink = ilink->next;
1350971522cSBarry Smith     }
1362fa5cd67SKarl Rupp   }
1372fa5cd67SKarl Rupp 
1382fa5cd67SKarl Rupp  if (isdraw) {
139d9884438SBarry Smith     PetscDraw draw;
140d9884438SBarry Smith     PetscReal x,y,w,wd;
141d9884438SBarry Smith 
142d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
143d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
144d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
145d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
146d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
147d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
148d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
149d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
150d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
151d9884438SBarry Smith       x    += wd;
152d9884438SBarry Smith       ilink = ilink->next;
153d9884438SBarry Smith     }
1540971522cSBarry Smith   }
1550971522cSBarry Smith   PetscFunctionReturn(0);
1560971522cSBarry Smith }
1570971522cSBarry Smith 
1583b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1593b224e63SBarry Smith {
1603b224e63SBarry Smith   PC_FieldSplit              *jac = (PC_FieldSplit*)pc->data;
1613b224e63SBarry Smith   PetscErrorCode             ierr;
1624996c5bdSBarry Smith   PetscBool                  iascii,isdraw;
1633b224e63SBarry Smith   PetscInt                   i,j;
1643b224e63SBarry Smith   PC_FieldSplitLink          ilink = jac->head;
165a9908d51SBarry Smith   MatSchurComplementAinvType atype;
1663b224e63SBarry Smith 
1673b224e63SBarry Smith   PetscFunctionBegin;
168251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1694996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1703b224e63SBarry Smith   if (iascii) {
1712c9966d7SBarry Smith     if (jac->bs > 0) {
172c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1732c9966d7SBarry Smith     } else {
1742c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1752c9966d7SBarry Smith     }
176f5236f50SJed Brown     if (pc->useAmat) {
177f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
178a3df900dSMatthew G Knepley     }
1793e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1803e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
181a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);
182a9908d51SBarry Smith       break;
183a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
184a9908d51SBarry Smith       ierr = MatSchurComplementGetAinvType(jac->schur,&atype);CHKERRQ(ierr);
185d0a9c1a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses A00's %sdiagonal's inverse\n",atype == MAT_SCHUR_COMPLEMENT_AINV_DIAG ? "" : (atype == MAT_SCHUR_COMPLEMENT_AINV_BLOCK_DIAG ? "block " : "lumped "));CHKERRQ(ierr);break;
186e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
187a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
188a9908d51SBarry Smith       break;
189e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
190a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);
191a9908d51SBarry Smith       break;
1923e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1933e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1943e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1953e8b8b31SMatthew G Knepley       } else {
196e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1973e8b8b31SMatthew G Knepley       }
1983e8b8b31SMatthew G Knepley       break;
1993e8b8b31SMatthew G Knepley     default:
20082f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
2013e8b8b31SMatthew G Knepley     }
2023b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
2033b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2043b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
2053b224e63SBarry Smith       if (ilink->fields) {
2063b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
2073b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
2083b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
2093b224e63SBarry Smith           if (j > 0) {
2103b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
2113b224e63SBarry Smith           }
2123b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
2133b224e63SBarry Smith         }
2143b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
2153b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2163b224e63SBarry Smith       } else {
2173b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2183b224e63SBarry Smith       }
2193b224e63SBarry Smith       ilink = ilink->next;
2203b224e63SBarry Smith     }
221435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2223b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22306de4afeSJed Brown     if (jac->head) {
224443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
22506de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2263b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
22706de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
228443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
229443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
230b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
231b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
232443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
233443836d0SMatthew G Knepley     }
234435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2353b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
23612cae6f2SJed Brown     if (jac->kspschur) {
2373b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
23812cae6f2SJed Brown     } else {
23912cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
24012cae6f2SJed Brown     }
2413b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2423b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
24306de4afeSJed Brown   } else if (isdraw && jac->head) {
2444996c5bdSBarry Smith     PetscDraw draw;
2454996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2464996c5bdSBarry Smith     PetscInt  cnt = 2;
2474996c5bdSBarry Smith     char      str[32];
2484996c5bdSBarry Smith 
2494996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2504996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
251c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
252c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
253c74581afSBarry Smith     wd = w/(cnt + 1);
254c74581afSBarry Smith 
2554996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
25651fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2574996c5bdSBarry Smith     y   -= h;
2584996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
259e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2603b224e63SBarry Smith     } else {
2614996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2624996c5bdSBarry Smith     }
26351fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2644996c5bdSBarry Smith     y   -= h;
2654996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2664996c5bdSBarry Smith 
2674996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2684996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2694996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2704996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2714996c5bdSBarry Smith       x   += wd;
2724996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2734996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2744996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2754996c5bdSBarry Smith     }
2764996c5bdSBarry Smith     x   += wd;
2774996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2784996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2794996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2803b224e63SBarry Smith   }
2813b224e63SBarry Smith   PetscFunctionReturn(0);
2823b224e63SBarry Smith }
2833b224e63SBarry Smith 
284a51937d4SCarola Kruse static PetscErrorCode PCView_FieldSplit_GKB(PC pc,PetscViewer viewer)
285a51937d4SCarola Kruse {
286a51937d4SCarola Kruse   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
287a51937d4SCarola Kruse   PetscErrorCode    ierr;
288a51937d4SCarola Kruse   PetscBool         iascii,isdraw;
289a51937d4SCarola Kruse   PetscInt          i,j;
290a51937d4SCarola Kruse   PC_FieldSplitLink ilink = jac->head;
291a51937d4SCarola Kruse 
292a51937d4SCarola Kruse   PetscFunctionBegin;
293a51937d4SCarola Kruse   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
294a51937d4SCarola Kruse   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
295a51937d4SCarola Kruse   if (iascii) {
296a51937d4SCarola Kruse     if (jac->bs > 0) {
297a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
298a51937d4SCarola Kruse     } else {
299a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
300a51937d4SCarola Kruse     }
301a51937d4SCarola Kruse     if (pc->useAmat) {
302a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
303a51937d4SCarola Kruse     }
304a51937d4SCarola Kruse     if (jac->diag_use_amat) {
305a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
306a51937d4SCarola Kruse     }
307a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
308a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
309a51937d4SCarola Kruse     }
310a51937d4SCarola Kruse 
311a51937d4SCarola Kruse     ierr = PetscViewerASCIIPrintf(viewer,"  Stopping tolerance=%.1e, delay in error estimate=%D, maximum iterations=%D\n",jac->gkbtol,jac->gkbdelay,jac->gkbmaxit);CHKERRQ(ierr);
312a51937d4SCarola Kruse     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for H = A00 + nu*A01*A01' matrix:\n");CHKERRQ(ierr);
313a51937d4SCarola Kruse     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
314a51937d4SCarola Kruse 
315a51937d4SCarola Kruse     if (ilink->fields) {
316a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",0);CHKERRQ(ierr);
317a51937d4SCarola Kruse       ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
318a51937d4SCarola Kruse       for (j=0; j<ilink->nfields; j++) {
319a51937d4SCarola Kruse         if (j > 0) {
320a51937d4SCarola Kruse           ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
321a51937d4SCarola Kruse         }
322a51937d4SCarola Kruse         ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
323a51937d4SCarola Kruse       }
324a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
325a51937d4SCarola Kruse       ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
326a51937d4SCarola Kruse     } else {
327a51937d4SCarola Kruse         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",0);CHKERRQ(ierr);
328a51937d4SCarola Kruse     }
329a51937d4SCarola Kruse     ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
330a51937d4SCarola Kruse 
331a51937d4SCarola Kruse     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
332a51937d4SCarola Kruse   }
333a51937d4SCarola Kruse 
334a51937d4SCarola Kruse  if (isdraw) {
335a51937d4SCarola Kruse     PetscDraw draw;
336a51937d4SCarola Kruse     PetscReal x,y,w,wd;
337a51937d4SCarola Kruse 
338a51937d4SCarola Kruse     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
339a51937d4SCarola Kruse     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
340a51937d4SCarola Kruse     w    = 2*PetscMin(1.0 - x,x);
341a51937d4SCarola Kruse     wd   = w/(jac->nsplits + 1);
342a51937d4SCarola Kruse     x    = x - wd*(jac->nsplits-1)/2.0;
343a51937d4SCarola Kruse     for (i=0; i<jac->nsplits; i++) {
344a51937d4SCarola Kruse       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
345a51937d4SCarola Kruse       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
346a51937d4SCarola Kruse       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
347a51937d4SCarola Kruse       x    += wd;
348a51937d4SCarola Kruse       ilink = ilink->next;
349a51937d4SCarola Kruse     }
350a51937d4SCarola Kruse   }
351a51937d4SCarola Kruse   PetscFunctionReturn(0);
352a51937d4SCarola Kruse }
353a51937d4SCarola Kruse 
354a51937d4SCarola Kruse 
3556c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
3566c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
3576c924f48SJed Brown {
3586c924f48SJed Brown   PetscErrorCode ierr;
3596c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
3605d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
3615d4c12cdSJungho Lee   PetscBool      flg,flg_col;
3625d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
3636c924f48SJed Brown 
3646c924f48SJed Brown   PetscFunctionBegin;
365785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
366785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
3676c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
3688caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
3698caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
3708caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
3716c924f48SJed Brown     nfields     = jac->bs;
37229499fbbSJungho Lee     nfields_col = jac->bs;
373c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
374c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
3756c924f48SJed Brown     if (!flg) break;
3765d4c12cdSJungho Lee     else if (flg && !flg_col) {
3775d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
3785d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
3792fa5cd67SKarl Rupp     } else {
3805d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
3815d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
3825d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
3835d4c12cdSJungho Lee     }
3846c924f48SJed Brown   }
3856c924f48SJed Brown   if (i > 0) {
3866c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3876c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3886c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3896c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3906c924f48SJed Brown   }
3916c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3925d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3936c924f48SJed Brown   PetscFunctionReturn(0);
3946c924f48SJed Brown }
3956c924f48SJed Brown 
39669a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3970971522cSBarry Smith {
3980971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3990971522cSBarry Smith   PetscErrorCode    ierr;
4005a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
4017b752e3dSPatrick Sanan   PetscBool         fieldsplit_default = PETSC_FALSE,coupling = PETSC_FALSE;
4026c924f48SJed Brown   PetscInt          i;
4030971522cSBarry Smith 
4040971522cSBarry Smith   PetscFunctionBegin;
4057287d2a3SDmitry Karpeev   /*
406f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
4077287d2a3SDmitry Karpeev    Should probably be rewritten.
4087287d2a3SDmitry Karpeev    */
409f5f0d762SBarry Smith   if (!ilink) {
410c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
4117b752e3dSPatrick Sanan     if (pc->dm && jac->dm_splits && !jac->detect && !coupling) {
412bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
4130784a22cSJed Brown       char      **fieldNames;
4147b62db95SJungho Lee       IS        *fields;
415e7c4fc90SDmitry Karpeev       DM        *dms;
416bafc1b83SMatthew G Knepley       DM        subdm[128];
417bafc1b83SMatthew G Knepley       PetscBool flg;
418bafc1b83SMatthew G Knepley 
41916621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
420bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
421bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
422bafc1b83SMatthew G Knepley         PetscInt ifields[128];
423bafc1b83SMatthew G Knepley         IS       compField;
424bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
425bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
426bafc1b83SMatthew G Knepley 
4278caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
428c5929fdfSBarry Smith         ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
429bafc1b83SMatthew G Knepley         if (!flg) break;
43082f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
431bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
432bafc1b83SMatthew G Knepley         if (nfields == 1) {
433bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
434bafc1b83SMatthew G Knepley         } else {
4358caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
436bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
4377287d2a3SDmitry Karpeev         }
438bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
439bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
440bafc1b83SMatthew G Knepley           f    = ifields[j];
4417b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
4427b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
4437b62db95SJungho Lee         }
444bafc1b83SMatthew G Knepley       }
445bafc1b83SMatthew G Knepley       if (i == 0) {
446bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
447bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
448bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
449bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
450bafc1b83SMatthew G Knepley         }
451bafc1b83SMatthew G Knepley       } else {
452d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
453d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
454d724dfffSBarry Smith         }
455d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
456785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
4572fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
458bafc1b83SMatthew G Knepley       }
4597b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
4607b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
461e7c4fc90SDmitry Karpeev       if (dms) {
4628b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
463bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
4647287d2a3SDmitry Karpeev           const char *prefix;
4657287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
4667287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
4677b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
4687b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
46995dbaa6fSMatthew G. Knepley           {
47095dbaa6fSMatthew G. Knepley             PetscErrorCode (*func)(KSP,Mat,Mat,void*);
47195dbaa6fSMatthew G. Knepley             void            *ctx;
47295dbaa6fSMatthew G. Knepley 
47395dbaa6fSMatthew G. Knepley             ierr = DMKSPGetComputeOperators(pc->dm, &func, &ctx);CHKERRQ(ierr);
47495dbaa6fSMatthew G. Knepley             ierr = DMKSPSetComputeOperators(dms[i],  func,  ctx);CHKERRQ(ierr);
47595dbaa6fSMatthew G. Knepley           }
4767287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
477e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
4782fa5ba8aSJed Brown         }
4797b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
4808b8307b2SJed Brown       }
48166ffff09SJed Brown     } else {
482521d7252SBarry Smith       if (jac->bs <= 0) {
483704ba839SBarry Smith         if (pc->pmat) {
484521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
4852fa5cd67SKarl Rupp         } else jac->bs = 1;
486521d7252SBarry Smith       }
487d32f9abdSBarry Smith 
4887b752e3dSPatrick Sanan       if (jac->detect) {
4896ce1633cSBarry Smith         IS       zerodiags,rest;
4906ce1633cSBarry Smith         PetscInt nmin,nmax;
4916ce1633cSBarry Smith 
4926ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4936ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4946ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4956ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4966ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
497fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
498fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4993a062f41SBarry Smith       } else if (coupling) {
5003a062f41SBarry Smith         IS       coupling,rest;
5013a062f41SBarry Smith         PetscInt nmin,nmax;
5023a062f41SBarry Smith 
5033a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
5043a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
5056bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
506e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
507d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
508d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr);
5093a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
5103a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
5116ce1633cSBarry Smith       } else {
512c5929fdfSBarry Smith         ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
5137287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
514d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
515d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
5166c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
5176c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
518d32f9abdSBarry Smith         }
5196dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
5209f001fe8SStefano Zampini           Mat       M = pc->pmat;
521f3b928b9SStefano Zampini           PetscBool isnest;
522f3b928b9SStefano Zampini 
523d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
524f3b928b9SStefano Zampini           ierr = PetscObjectTypeCompare((PetscObject)pc->pmat,MATNEST,&isnest);CHKERRQ(ierr);
525f3b928b9SStefano Zampini           if (!isnest) {
5269f001fe8SStefano Zampini             M    = pc->mat;
527f3b928b9SStefano Zampini             ierr = PetscObjectTypeCompare((PetscObject)pc->mat,MATNEST,&isnest);CHKERRQ(ierr);
528f3b928b9SStefano Zampini           }
529f3b928b9SStefano Zampini           if (isnest) {
530f3b928b9SStefano Zampini             IS       *fields;
531f3b928b9SStefano Zampini             PetscInt nf;
532f3b928b9SStefano Zampini 
5339f001fe8SStefano Zampini             ierr = MatNestGetSize(M,&nf,NULL);CHKERRQ(ierr);
534f3b928b9SStefano Zampini             ierr = PetscMalloc1(nf,&fields);CHKERRQ(ierr);
5359f001fe8SStefano Zampini             ierr = MatNestGetISs(M,fields,NULL);CHKERRQ(ierr);
536f3b928b9SStefano Zampini             for (i=0;i<nf;i++) {
537f3b928b9SStefano Zampini               ierr = PCFieldSplitSetIS(pc,NULL,fields[i]);CHKERRQ(ierr);
538f3b928b9SStefano Zampini             }
539f3b928b9SStefano Zampini             ierr = PetscFree(fields);CHKERRQ(ierr);
540f3b928b9SStefano Zampini           } else {
541db4c96c1SJed Brown             for (i=0; i<jac->bs; i++) {
5426c924f48SJed Brown               char splitname[8];
5438caf3d72SBarry Smith               ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
5445d4c12cdSJungho Lee               ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
54579416396SBarry Smith             }
5465d4c12cdSJungho Lee             jac->defaultsplit = PETSC_TRUE;
547521d7252SBarry Smith           }
54866ffff09SJed Brown         }
5496ce1633cSBarry Smith       }
550f3b928b9SStefano Zampini     }
551edf189efSBarry Smith   } else if (jac->nsplits == 1) {
552edf189efSBarry Smith     if (ilink->is) {
553edf189efSBarry Smith       IS       is2;
554edf189efSBarry Smith       PetscInt nmin,nmax;
555edf189efSBarry Smith 
556edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
557edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
558db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
559fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
56082f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
561edf189efSBarry Smith   }
562d0af7cd3SBarry Smith 
56382f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
56469a612a9SBarry Smith   PetscFunctionReturn(0);
56569a612a9SBarry Smith }
56669a612a9SBarry Smith 
567a51937d4SCarola Kruse static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A,Mat B,Mat C,Mat *H,PetscReal gkbnu)
568a51937d4SCarola Kruse {
569a51937d4SCarola Kruse   PetscErrorCode    ierr;
570a51937d4SCarola Kruse   Mat               BT,T;
571de482cd7SCarola Kruse   PetscReal         nrmT,nrmB;
572a51937d4SCarola Kruse 
573a51937d4SCarola Kruse   PetscFunctionBegin;
574a51937d4SCarola Kruse   ierr = MatHermitianTranspose(C,MAT_INITIAL_MATRIX,&T);CHKERRQ(ierr);            /* Test if augmented matrix is symmetric */
575a51937d4SCarola Kruse   ierr = MatAXPY(T,-1.0,B,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
576de482cd7SCarola Kruse   ierr = MatNorm(T,NORM_1,&nrmT);CHKERRQ(ierr);
577de482cd7SCarola Kruse   ierr = MatNorm(B,NORM_1,&nrmB);CHKERRQ(ierr);
578de482cd7SCarola Kruse   if (nrmB > 0) {
579de482cd7SCarola Kruse     if (nrmT/nrmB >= PETSC_SMALL) {
580de482cd7SCarola Kruse       SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Matrix is not symmetric/hermitian, GKB is not applicable.");
581de482cd7SCarola Kruse     }
582a51937d4SCarola Kruse   }
583a51937d4SCarola Kruse   /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */
584a51937d4SCarola Kruse   /* setting N := 1/nu*I in [Ar13].                                                 */
585a51937d4SCarola Kruse   ierr = MatHermitianTranspose(B,MAT_INITIAL_MATRIX,&BT);CHKERRQ(ierr);
586a51937d4SCarola Kruse   ierr = MatMatMult(B,BT,MAT_INITIAL_MATRIX,PETSC_DEFAULT,H);CHKERRQ(ierr);       /* H = A01*A01'          */
587a51937d4SCarola Kruse   ierr = MatAYPX(*H,gkbnu,A,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);             /* H = A00 + nu*A01*A01' */
588a51937d4SCarola Kruse 
589a51937d4SCarola Kruse   ierr = MatDestroy(&BT);CHKERRQ(ierr);
590a51937d4SCarola Kruse   ierr = MatDestroy(&T);CHKERRQ(ierr);
591a51937d4SCarola Kruse   PetscFunctionReturn(0);
592a51937d4SCarola Kruse }
593a51937d4SCarola Kruse 
5942d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[],const char *value[],PetscBool *flg);
595514bf10dSMatthew G Knepley 
59669a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
59769a612a9SBarry Smith {
59869a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
59969a612a9SBarry Smith   PetscErrorCode    ierr;
6005a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
6012c9966d7SBarry Smith   PetscInt          i,nsplit;
6025f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
60369a612a9SBarry Smith 
60469a612a9SBarry Smith   PetscFunctionBegin;
6055da88fe4STristan Konolige   pc->failedreason = PC_NOERROR;
60669a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
60797bbdb24SBarry Smith   nsplit = jac->nsplits;
6085a9f2f41SSatish Balay   ilink  = jac->head;
60997bbdb24SBarry Smith 
61097bbdb24SBarry Smith   /* get the matrices for each split */
611704ba839SBarry Smith   if (!jac->issetup) {
6121b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
61397bbdb24SBarry Smith 
614704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
615704ba839SBarry Smith 
6165d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
6172c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
6182c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
6192c9966d7SBarry Smith     }
62051f519a2SBarry Smith     bs     = jac->bs;
62197bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
6221b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
6231b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
6241b9fc7fcSBarry Smith       if (jac->defaultsplit) {
625ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
6265f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
627704ba839SBarry Smith       } else if (!ilink->is) {
628ccb205f8SBarry Smith         if (ilink->nfields > 1) {
6295f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
630785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
631785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
6321b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
6331b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
6341b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
6355f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
63697bbdb24SBarry Smith             }
63797bbdb24SBarry Smith           }
638ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
639ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
64090e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
64190e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
642ccb205f8SBarry Smith         } else {
643ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
644ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
645ccb205f8SBarry Smith         }
6463e197d65SBarry Smith       }
647704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
6485f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
6495f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
650704ba839SBarry Smith       ilink = ilink->next;
6511b9fc7fcSBarry Smith     }
6521b9fc7fcSBarry Smith   }
6531b9fc7fcSBarry Smith 
654704ba839SBarry Smith   ilink = jac->head;
65597bbdb24SBarry Smith   if (!jac->pmat) {
656bdddcaaaSMatthew G Knepley     Vec xtmp;
657bdddcaaaSMatthew G Knepley 
6582a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
659785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
660dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
661cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
662bdddcaaaSMatthew G Knepley       MatNullSpace sp;
663bdddcaaaSMatthew G Knepley 
664a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
665a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
666a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
667a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
668a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
669a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
6702fa5cd67SKarl Rupp 
671a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
672a3df900dSMatthew G Knepley         }
673a3df900dSMatthew G Knepley       } else {
6743a062f41SBarry Smith         const char *prefix;
6757dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
6763a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
6773a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
6783a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
679a3df900dSMatthew G Knepley       }
680bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
6812a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
6820298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
683bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
6849448b7f1SJunchao Zhang       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
685ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
686ed1f0337SMatthew G Knepley       if (sp) {
687ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
688ed1f0337SMatthew G Knepley       }
689704ba839SBarry Smith       ilink = ilink->next;
690cf502942SBarry Smith     }
691bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
69297bbdb24SBarry Smith   } else {
693ef7efd37SHong Zhang     MatReuse scall;
694ef7efd37SHong Zhang     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
695ef7efd37SHong Zhang       for (i=0; i<nsplit; i++) {
696ef7efd37SHong Zhang         ierr = MatDestroy(&jac->pmat[i]);CHKERRQ(ierr);
697ef7efd37SHong Zhang       }
698ef7efd37SHong Zhang       scall = MAT_INITIAL_MATRIX;
699ef7efd37SHong Zhang     } else scall = MAT_REUSE_MATRIX;
700ef7efd37SHong Zhang 
701cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
702a3df900dSMatthew G Knepley       Mat pmat;
703a3df900dSMatthew G Knepley 
704a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
705a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
706a3df900dSMatthew G Knepley       if (!pmat) {
707ef7efd37SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,scall,&jac->pmat[i]);CHKERRQ(ierr);
708a3df900dSMatthew G Knepley       }
709704ba839SBarry Smith       ilink = ilink->next;
710cf502942SBarry Smith     }
71197bbdb24SBarry Smith   }
7124e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
713519d70e2SJed Brown     ilink = jac->head;
714519d70e2SJed Brown     if (!jac->mat) {
715785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
716519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
7177dae84e0SHong Zhang         ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
718519d70e2SJed Brown         ilink = ilink->next;
719519d70e2SJed Brown       }
720519d70e2SJed Brown     } else {
721ef7efd37SHong Zhang       MatReuse scall;
722ef7efd37SHong Zhang       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
723519d70e2SJed Brown         for (i=0; i<nsplit; i++) {
724ef7efd37SHong Zhang           ierr = MatDestroy(&jac->mat[i]);CHKERRQ(ierr);
725ef7efd37SHong Zhang         }
726ef7efd37SHong Zhang         scall = MAT_INITIAL_MATRIX;
727ef7efd37SHong Zhang       } else scall = MAT_REUSE_MATRIX;
728ef7efd37SHong Zhang 
729ef7efd37SHong Zhang       for (i=0; i<nsplit; i++) {
730e9422dd5SStefano Zampini         ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,scall,&jac->mat[i]);CHKERRQ(ierr);
731519d70e2SJed Brown         ilink = ilink->next;
732519d70e2SJed Brown       }
733519d70e2SJed Brown     }
734519d70e2SJed Brown   } else {
735519d70e2SJed Brown     jac->mat = jac->pmat;
736519d70e2SJed Brown   }
73797bbdb24SBarry Smith 
73853935eafSBarry Smith   /* Check for null space attached to IS */
73953935eafSBarry Smith   ilink = jac->head;
74053935eafSBarry Smith   for (i=0; i<nsplit; i++) {
74153935eafSBarry Smith     MatNullSpace sp;
74253935eafSBarry Smith 
74353935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
74453935eafSBarry Smith     if (sp) {
74553935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
74653935eafSBarry Smith     }
74753935eafSBarry Smith     ilink = ilink->next;
74853935eafSBarry Smith   }
74953935eafSBarry Smith 
750a51937d4SCarola Kruse   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) {
75168dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
7524e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
75368dd23aaSBarry Smith     ilink = jac->head;
754e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
755e52d2c62SBarry 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 */
756e52d2c62SBarry Smith       if (!jac->Afield) {
757e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
75880c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7597dae84e0SHong Zhang           ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
760e52d2c62SBarry Smith         } else {
7617dae84e0SHong Zhang           ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
76280c96bb1SFande Kong         }
76380c96bb1SFande Kong       } else {
764ef7efd37SHong Zhang         MatReuse scall;
765e9422dd5SStefano Zampini 
766ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
767ef7efd37SHong Zhang           ierr  = MatDestroy(&jac->Afield[1]);CHKERRQ(ierr);
768ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
769ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
770ef7efd37SHong Zhang 
77180c96bb1SFande Kong         if (jac->offdiag_use_amat) {
772ef7efd37SHong Zhang           ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr);
77380c96bb1SFande Kong         } else {
774ef7efd37SHong Zhang           ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr);
77580c96bb1SFande Kong         }
776e52d2c62SBarry Smith       }
777e52d2c62SBarry Smith     } else {
77868dd23aaSBarry Smith       if (!jac->Afield) {
779785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
78068dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
78180c96bb1SFande Kong           if (jac->offdiag_use_amat) {
7827dae84e0SHong Zhang             ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
78380c96bb1SFande Kong           } else {
7847dae84e0SHong Zhang             ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
78580c96bb1SFande Kong           }
78668dd23aaSBarry Smith           ilink = ilink->next;
78768dd23aaSBarry Smith         }
78868dd23aaSBarry Smith       } else {
789ef7efd37SHong Zhang         MatReuse scall;
790ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
791ef7efd37SHong Zhang           for (i=0; i<nsplit; i++) {
792ef7efd37SHong Zhang             ierr = MatDestroy(&jac->Afield[i]);CHKERRQ(ierr);
793ef7efd37SHong Zhang           }
794ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
795ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
796ef7efd37SHong Zhang 
79768dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
79880c96bb1SFande Kong           if (jac->offdiag_use_amat) {
799ef7efd37SHong Zhang             ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr);
80080c96bb1SFande Kong           } else {
801ef7efd37SHong Zhang             ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr);
80280c96bb1SFande Kong           }
80368dd23aaSBarry Smith           ilink = ilink->next;
80468dd23aaSBarry Smith         }
80568dd23aaSBarry Smith       }
80668dd23aaSBarry Smith     }
807e52d2c62SBarry Smith   }
80868dd23aaSBarry Smith 
8093b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
8103b224e63SBarry Smith     IS          ccis;
811c096484dSStefano Zampini     PetscBool   isspd;
8124aa3045dSJed Brown     PetscInt    rstart,rend;
813093c86ffSJed Brown     char        lscname[256];
814093c86ffSJed Brown     PetscObject LSC_L;
815ce94432eSBarry Smith 
816ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
81768dd23aaSBarry Smith 
818c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
819c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
820c096484dSStefano Zampini       ierr = MatGetOption(pc->pmat,MAT_SPD,&isspd);CHKERRQ(ierr);
821c096484dSStefano Zampini       jac->schurscale = (isspd == PETSC_TRUE) ? 1.0 : -1.0;
822c096484dSStefano Zampini     }
823c096484dSStefano Zampini 
824e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
825e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
826e6cab6aaSJed Brown 
8273b224e63SBarry Smith     if (jac->schur) {
8280298fd71SBarry Smith       KSP      kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
829e9422dd5SStefano Zampini       MatReuse scall;
830e9422dd5SStefano Zampini 
831e9422dd5SStefano Zampini       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
832e9422dd5SStefano Zampini         scall = MAT_INITIAL_MATRIX;
833e9422dd5SStefano Zampini         ierr  = MatDestroy(&jac->B);CHKERRQ(ierr);
834e9422dd5SStefano Zampini         ierr  = MatDestroy(&jac->C);CHKERRQ(ierr);
835e9422dd5SStefano Zampini       } else scall = MAT_REUSE_MATRIX;
836443836d0SMatthew G Knepley 
837fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
8383b224e63SBarry Smith       ilink = jac->head;
83949bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8404e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
841e9422dd5SStefano Zampini 	ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,scall,&jac->B);CHKERRQ(ierr);
842c84da90fSDmitry Karpeev       } else {
843e9422dd5SStefano Zampini 	ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,scall,&jac->B);CHKERRQ(ierr);
844c84da90fSDmitry Karpeev       }
845fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
8463b224e63SBarry Smith       ilink = ilink->next;
84749bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8484e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
849e9422dd5SStefano Zampini 	ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,scall,&jac->C);CHKERRQ(ierr);
850c84da90fSDmitry Karpeev       } else {
851e9422dd5SStefano Zampini 	ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,scall,&jac->C);CHKERRQ(ierr);
852c84da90fSDmitry Karpeev       }
853fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
854aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
855a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
856a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
857a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
858a7476a74SDmitry Karpeev       }
859443836d0SMatthew G Knepley       if (kspA != kspInner) {
86023ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
861443836d0SMatthew G Knepley       }
862443836d0SMatthew G Knepley       if (kspUpper != kspA) {
86323ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
864443836d0SMatthew G Knepley       }
86523ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
8663b224e63SBarry Smith     } else {
867bafc1b83SMatthew G Knepley       const char   *Dprefix;
868470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
869514bf10dSMatthew G Knepley       char         schurtestoption[256];
870bdddcaaaSMatthew G Knepley       MatNullSpace sp;
871514bf10dSMatthew G Knepley       PetscBool    flg;
872686bed4dSStefano Zampini       KSP          kspt;
8733b224e63SBarry Smith 
874a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
8753b224e63SBarry Smith       ilink = jac->head;
87649bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8774e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8787dae84e0SHong Zhang 	ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
879c84da90fSDmitry Karpeev       } else {
8807dae84e0SHong Zhang 	ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
881c84da90fSDmitry Karpeev       }
882fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
8833b224e63SBarry Smith       ilink = ilink->next;
88449bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8854e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8867dae84e0SHong Zhang 	ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
887c84da90fSDmitry Karpeev       } else {
8887dae84e0SHong Zhang 	ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
889c84da90fSDmitry Karpeev       }
890fcfd50ebSBarry Smith       ierr = ISDestroy(&ccis);CHKERRQ(ierr);
89120252d06SBarry Smith 
892f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
89320252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
89420252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
895bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
896470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
897470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
898686bed4dSStefano Zampini       ierr = MatSchurComplementGetKSP(jac->schur,&kspt);CHKERRQ(ierr);
899686bed4dSStefano Zampini       ierr = KSPSetOptionsPrefix(kspt,schurmatprefix);CHKERRQ(ierr);
900686bed4dSStefano Zampini 
901686bed4dSStefano Zampini       /* Note: this is not true in general */
902895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
90320252d06SBarry Smith       if (sp) {
90420252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
90520252d06SBarry Smith       }
90620252d06SBarry Smith 
90720252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
908c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
909514bf10dSMatthew G Knepley       if (flg) {
910514bf10dSMatthew G Knepley         DM  dmInner;
91121635b76SJed Brown         KSP kspInner;
912686bed4dSStefano Zampini         PC  pcInner;
91321635b76SJed Brown 
91421635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
9152cc093acSMatthew G. Knepley         ierr = KSPReset(kspInner);CHKERRQ(ierr);
9162cc093acSMatthew G. Knepley         ierr = KSPSetOperators(kspInner,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
91721635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
91821635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
91921635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
9202cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject) pc, 2);CHKERRQ(ierr);
92121635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
922514bf10dSMatthew G Knepley 
923514bf10dSMatthew G Knepley         /* Set DM for new solver */
924bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
92521635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
92621635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
927686bed4dSStefano Zampini 
928686bed4dSStefano Zampini         /* Defaults to PCKSP as preconditioner */
929686bed4dSStefano Zampini         ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr);
930686bed4dSStefano Zampini         ierr = PCSetType(pcInner, PCKSP);CHKERRQ(ierr);
931686bed4dSStefano Zampini         ierr = PCKSPSetKSP(pcInner, jac->head->ksp);CHKERRQ(ierr);
932514bf10dSMatthew G Knepley       } else {
93321635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
93421635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
93521635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
93621635b76SJed 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
93721635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
93821635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
93921635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
940514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
941bafc1b83SMatthew G Knepley       }
94223ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
9435a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
94497bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
94597bbdb24SBarry Smith 
946686bed4dSStefano Zampini       ierr = PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg);CHKERRQ(ierr);
947686bed4dSStefano Zampini       if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */
948686bed4dSStefano Zampini         KSP kspInner;
949686bed4dSStefano Zampini         PC  pcInner;
950686bed4dSStefano Zampini 
951686bed4dSStefano Zampini         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
952686bed4dSStefano Zampini         ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr);
953686bed4dSStefano Zampini         ierr = PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg);CHKERRQ(ierr);
954686bed4dSStefano Zampini         if (flg) {
955686bed4dSStefano Zampini           KSP ksp;
956686bed4dSStefano Zampini 
957686bed4dSStefano Zampini           ierr = PCKSPGetKSP(pcInner, &ksp);CHKERRQ(ierr);
958686bed4dSStefano Zampini           if (ksp == jac->head->ksp) {
959686bed4dSStefano Zampini             ierr = PCSetUseAmat(pcInner, PETSC_TRUE);CHKERRQ(ierr);
960686bed4dSStefano Zampini           }
961686bed4dSStefano Zampini         }
962686bed4dSStefano Zampini       }
963443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
964c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
965443836d0SMatthew G Knepley       if (flg) {
966443836d0SMatthew G Knepley         DM dmInner;
967443836d0SMatthew G Knepley 
968443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
96982f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
970422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
971443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
9722cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject) pc, 1);CHKERRQ(ierr);
9732cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject) pc, 1);CHKERRQ(ierr);
974443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
975443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
976443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
977443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
97823ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
979443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
980443836d0SMatthew G Knepley       } else {
981443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
982443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
983443836d0SMatthew G Knepley       }
984443836d0SMatthew G Knepley 
985a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
986a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
987a7476a74SDmitry Karpeev       }
988ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
989422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
99097bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
99120252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
99297bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
9937233a360SDmitry Karpeev         PC pcschur;
9947233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
9957233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
99697bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
997e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
998e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
99997bbdb24SBarry Smith       }
100023ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
100197bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
100297bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
1003c096484dSStefano Zampini       /* propagate DM */
1004b20b4189SMatthew G. Knepley       {
1005b20b4189SMatthew G. Knepley         DM sdm;
1006b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
1007b20b4189SMatthew G. Knepley         if (sdm) {
1008b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
1009b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
1010b20b4189SMatthew G. Knepley         }
1011b20b4189SMatthew G. Knepley       }
101297bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
101397bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
101497bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
101597bbdb24SBarry Smith     }
1016686bed4dSStefano Zampini     ierr = MatAssemblyBegin(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1017686bed4dSStefano Zampini     ierr = MatAssemblyEnd(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
101897bbdb24SBarry Smith 
10195a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
10208caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
1021519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
10223b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
1023c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
10248caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
102597bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
10265a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
10270971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
1028a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1029a51937d4SCarola Kruse     IS          ccis;
1030a51937d4SCarola Kruse     PetscInt    rstart,rend;
1031a51937d4SCarola Kruse 
1032a51937d4SCarola Kruse     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use GKB preconditioner you must have exactly 2 fields");
1033a51937d4SCarola Kruse 
1034a51937d4SCarola Kruse     ilink = jac->head;
1035a51937d4SCarola Kruse 
1036a51937d4SCarola Kruse     /* When extracting off-diagonal submatrices, we take complements from this range */
1037a51937d4SCarola Kruse     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
1038a51937d4SCarola Kruse 
1039a51937d4SCarola Kruse     ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
1040a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
1041a51937d4SCarola Kruse       ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
1042a51937d4SCarola Kruse     } else {
1043a51937d4SCarola Kruse       ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
1044a51937d4SCarola Kruse     }
1045a51937d4SCarola Kruse     ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
1046e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
1047e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->u);CHKERRQ(ierr);
1048e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->Hu);CHKERRQ(ierr);
1049e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->w2);CHKERRQ(ierr);
1050a51937d4SCarola Kruse     ilink = ilink->next;
1051a51937d4SCarola Kruse     ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
1052a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
1053a51937d4SCarola Kruse       ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
1054a51937d4SCarola Kruse     } else {
1055a51937d4SCarola Kruse       ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
1056a51937d4SCarola Kruse     }
1057a51937d4SCarola Kruse     ierr = ISDestroy(&ccis);CHKERRQ(ierr);
1058e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
1059e071a0a4SCarola Kruse     ierr = VecDuplicate(ilink->x,&jac->v);CHKERRQ(ierr);
1060e071a0a4SCarola Kruse     ierr = VecDuplicate(ilink->x,&jac->d);CHKERRQ(ierr);
1061e071a0a4SCarola Kruse     ierr = VecDuplicate(ilink->x,&jac->w1);CHKERRQ(ierr);
1062a51937d4SCarola Kruse     ierr = MatGolubKahanComputeExplicitOperator(jac->mat[0],jac->B,jac->C,&jac->H,jac->gkbnu);CHKERRQ(ierr);
1063e071a0a4SCarola Kruse     ierr = PetscCalloc1(jac->gkbdelay,&jac->vecz);CHKERRQ(ierr);
1064e071a0a4SCarola Kruse 
1065a51937d4SCarola Kruse     ilink = jac->head;
1066a51937d4SCarola Kruse     ierr  = KSPSetOperators(ilink->ksp,jac->H,jac->H);CHKERRQ(ierr);
1067a51937d4SCarola Kruse     if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
1068e071a0a4SCarola Kruse     /* Create gkb_monitor context */
1069de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1070de482cd7SCarola Kruse       PetscInt  tablevel;
1071de482cd7SCarola Kruse       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&jac->gkbviewer);CHKERRQ(ierr);
1072de482cd7SCarola Kruse       ierr = PetscViewerSetType(jac->gkbviewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1073de482cd7SCarola Kruse       ierr = PetscObjectGetTabLevel((PetscObject)ilink->ksp,&tablevel);CHKERRQ(ierr);
1074e071a0a4SCarola Kruse       ierr = PetscViewerASCIISetTab(jac->gkbviewer,tablevel);CHKERRQ(ierr);
1075de482cd7SCarola Kruse       ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)ilink->ksp,1);CHKERRQ(ierr);
1076de482cd7SCarola Kruse     }
10770971522cSBarry Smith   } else {
107868bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
10790971522cSBarry Smith     i     = 0;
10800971522cSBarry Smith     ilink = jac->head;
10810971522cSBarry Smith     while (ilink) {
108223ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
10830971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
10840971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
10850971522cSBarry Smith       i++;
10860971522cSBarry Smith       ilink = ilink->next;
10870971522cSBarry Smith     }
10883b224e63SBarry Smith   }
10893b224e63SBarry Smith 
1090c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
10910971522cSBarry Smith   PetscFunctionReturn(0);
10920971522cSBarry Smith }
10930971522cSBarry Smith 
10945a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
1095ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
1096ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
10979df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
10985a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) ||                               \
1099c0decd05SBarry Smith    KSPCheckSolve(ilink->ksp,pc,ilink->y)  || \
11009df09d43SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
1101ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) ||  \
1102ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
110379416396SBarry Smith 
11043b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
11053b224e63SBarry Smith {
11063b224e63SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
11073b224e63SBarry Smith   PetscErrorCode     ierr;
11083b224e63SBarry Smith   PC_FieldSplitLink  ilinkA = jac->head, ilinkD = ilinkA->next;
1109443836d0SMatthew G Knepley   KSP                kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
11103b224e63SBarry Smith 
11113b224e63SBarry Smith   PetscFunctionBegin;
1112c5d2311dSJed Brown   switch (jac->schurfactorization) {
1113c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
1114a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
1115c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1116c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1117c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11189df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1119443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1120c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11219df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1122c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1123c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11249df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1125c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1126c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11279df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1128c096484dSStefano Zampini     ierr = VecScale(ilinkD->y,jac->schurscale);CHKERRQ(ierr);
1129c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1130653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1131c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1132c5d2311dSJed Brown     break;
1133c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
1134a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
1135c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1136c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11379df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1138443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1139c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11409df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1141c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
1142c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
1143c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1144c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1145c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11469df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1147c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1148c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11499df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1150c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1151653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1152c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1153c5d2311dSJed Brown     break;
1154c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
1155a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
1156c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1157c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11589df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1159c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1160c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11619df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);    ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
1162c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
1163c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1164c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1165c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11669df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1167443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1168c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11699df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1170c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1171653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1172c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1173c5d2311dSJed Brown     break;
1174c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
1175c238f8cdSStefano Zampini     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */
11763b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11773b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11789df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1179443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1180c0decd05SBarry Smith     ierr = KSPCheckSolve(kspLower,pc,ilinkA->y);CHKERRQ(ierr);
11819df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
11823b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
11833b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
11843b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11853b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11863b224e63SBarry Smith 
11879df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
11883b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1189c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11909df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
11913b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
11923b224e63SBarry Smith 
1193443836d0SMatthew G Knepley     if (kspUpper == kspA) {
11943b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
11953b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
11969df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1197443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1198c0decd05SBarry Smith       ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11999df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1200443836d0SMatthew G Knepley     } else {
12019df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1202443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1203c0decd05SBarry Smith       ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
1204443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
12059df09d43SBarry Smith       ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
1206443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
1207c0decd05SBarry Smith       ierr = KSPCheckSolve(kspUpper,pc,ilinkA->z);CHKERRQ(ierr);
12089df09d43SBarry Smith       ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
1209443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
1210443836d0SMatthew G Knepley     }
1211c238f8cdSStefano Zampini     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12123b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12133b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1214c5d2311dSJed Brown   }
12153b224e63SBarry Smith   PetscFunctionReturn(0);
12163b224e63SBarry Smith }
12173b224e63SBarry Smith 
12180971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
12190971522cSBarry Smith {
12200971522cSBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
12210971522cSBarry Smith   PetscErrorCode     ierr;
12225a9f2f41SSatish Balay   PC_FieldSplitLink  ilink = jac->head;
1223939b8a20SBarry Smith   PetscInt           cnt,bs;
12240971522cSBarry Smith 
12250971522cSBarry Smith   PetscFunctionBegin;
122679416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
12271b9fc7fcSBarry Smith     if (jac->defaultsplit) {
1228939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1229ce94432eSBarry Smith       if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of x vector %D does not match fieldsplit blocksize %D",bs,jac->bs);
1230939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1231ce94432eSBarry Smith       if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of y vector %D does not match fieldsplit blocksize %D",bs,jac->bs);
12320971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
12335a9f2f41SSatish Balay       while (ilink) {
12349df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12355a9f2f41SSatish Balay         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1236c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12379df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12385a9f2f41SSatish Balay         ilink = ilink->next;
12390971522cSBarry Smith       }
12400971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
12411b9fc7fcSBarry Smith     } else {
1242efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
12435a9f2f41SSatish Balay       while (ilink) {
12445a9f2f41SSatish Balay         ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
12455a9f2f41SSatish Balay         ilink = ilink->next;
12461b9fc7fcSBarry Smith       }
12471b9fc7fcSBarry Smith     }
1248e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
1249e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1250e52d2c62SBarry Smith     /* solve on first block for first block variables */
1251e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1252e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12539df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1254e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1255c0decd05SBarry Smith     ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12569df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1257e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1258e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1259e52d2c62SBarry Smith 
1260e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
1261e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
1262e52d2c62SBarry Smith     ilink = ilink->next;
1263e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
1264e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1265e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1266e52d2c62SBarry Smith 
1267e52d2c62SBarry Smith     /* solve on second block variables */
12689df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1269e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1270c0decd05SBarry Smith     ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12719df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1272e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1273e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
127416913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
127579416396SBarry Smith     if (!jac->w1) {
127679416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
127779416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
127879416396SBarry Smith     }
1279efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
12805a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
12813e197d65SBarry Smith     cnt  = 1;
12825a9f2f41SSatish Balay     while (ilink->next) {
12835a9f2f41SSatish Balay       ilink = ilink->next;
12843e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
12853e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
12863e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
12873e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12883e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12899df09d43SBarry Smith       ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12903e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1291c0decd05SBarry Smith       ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12929df09d43SBarry Smith       ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12933e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12943e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12953e197d65SBarry Smith     }
129651f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
129711755939SBarry Smith       cnt -= 2;
129851f519a2SBarry Smith       while (ilink->previous) {
129951f519a2SBarry Smith         ilink = ilink->previous;
130011755939SBarry Smith         /* compute the residual only over the part of the vector needed */
130111755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
130211755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
130311755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
130411755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
13059df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
130611755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1307c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
13089df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
130911755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
131011755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
131151f519a2SBarry Smith       }
131211755939SBarry Smith     }
1313ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
13140971522cSBarry Smith   PetscFunctionReturn(0);
13150971522cSBarry Smith }
13160971522cSBarry Smith 
1317a51937d4SCarola Kruse 
1318a51937d4SCarola Kruse static PetscErrorCode PCApply_FieldSplit_GKB(PC pc,Vec x,Vec y)
1319a51937d4SCarola Kruse {
1320a51937d4SCarola Kruse   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1321a51937d4SCarola Kruse   PetscErrorCode     ierr;
1322a51937d4SCarola Kruse   PC_FieldSplitLink  ilinkA = jac->head,ilinkD = ilinkA->next;
1323a51937d4SCarola Kruse   KSP                ksp = ilinkA->ksp;
1324de482cd7SCarola Kruse   Vec                u,v,Hu,d,work1,work2;
1325e071a0a4SCarola Kruse   PetscScalar        alpha,z,nrmz2,*vecz;
1326e071a0a4SCarola Kruse   PetscReal          lowbnd,nu,beta;
1327a51937d4SCarola Kruse   PetscInt           j,iterGKB;
1328a51937d4SCarola Kruse 
1329a51937d4SCarola Kruse   PetscFunctionBegin;
1330a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1331a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1332de482cd7SCarola Kruse   ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1333a51937d4SCarola Kruse   ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1334e071a0a4SCarola Kruse 
1335e071a0a4SCarola Kruse   u     = jac->u;
1336e071a0a4SCarola Kruse   v     = jac->v;
1337e071a0a4SCarola Kruse   Hu    = jac->Hu;
1338e071a0a4SCarola Kruse   d     = jac->d;
1339e071a0a4SCarola Kruse   work1 = jac->w1;
1340e071a0a4SCarola Kruse   work2 = jac->w2;
1341e071a0a4SCarola Kruse   vecz  = jac->vecz;
1342a51937d4SCarola Kruse 
1343a51937d4SCarola Kruse   /* Change RHS to comply with matrix regularization H = A + nu*B*B' */
1344a51937d4SCarola Kruse   /* Add q = q + nu*B*b */
1345a51937d4SCarola Kruse   if (jac->gkbnu) {
1346a51937d4SCarola Kruse     nu = jac->gkbnu;
1347de482cd7SCarola Kruse     ierr = VecScale(ilinkD->x,jac->gkbnu);CHKERRQ(ierr);
1348de482cd7SCarola Kruse     ierr = MatMultAdd(jac->B,ilinkD->x,ilinkA->x,ilinkA->x);CHKERRQ(ierr);            /* q = q + nu*B*b */
1349a51937d4SCarola Kruse   } else {
1350a51937d4SCarola Kruse     /* Situation when no augmented Lagrangian is used. Then we set inner  */
1351a51937d4SCarola Kruse     /* matrix N = I in [Ar13], and thus nu = 1.                           */
1352a51937d4SCarola Kruse     nu = 1;
1353a51937d4SCarola Kruse   }
1354a51937d4SCarola Kruse 
1355a51937d4SCarola Kruse   /* Transform rhs from [q,tilde{b}] to [0,b] */
1356de482cd7SCarola Kruse   ierr = PetscLogEventBegin(ilinkA->event,ksp,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1357de482cd7SCarola Kruse   ierr = KSPSolve(ksp,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1358c0decd05SBarry Smith   ierr = KSPCheckSolve(ksp,pc,ilinkA->y);CHKERRQ(ierr);
1359de482cd7SCarola Kruse   ierr = PetscLogEventEnd(ilinkA->event,ksp,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1360a51937d4SCarola Kruse   ierr = MatMultHermitianTranspose(jac->B,ilinkA->y,work1);CHKERRQ(ierr);
136192c1e38eSCarola Kruse   ierr = VecAXPBY(work1,1.0/nu,-1.0,ilinkD->x);CHKERRQ(ierr);            /* c = b - B'*x        */
1362a51937d4SCarola Kruse 
1363a51937d4SCarola Kruse   /* First step of algorithm */
1364de482cd7SCarola Kruse   ierr  = VecNorm(work1,NORM_2,&beta);CHKERRQ(ierr);                   /* beta = sqrt(nu*c'*c)*/
1365e071a0a4SCarola Kruse   KSPCheckDot(ksp,beta);
1366de482cd7SCarola Kruse   beta  = PetscSqrtScalar(nu)*beta;
136792c1e38eSCarola Kruse   ierr  = VecAXPBY(v,nu/beta,0.0,work1);CHKERRQ(ierr);                   /* v = nu/beta *c      */
1368a51937d4SCarola Kruse   ierr  = MatMult(jac->B,v,work2);CHKERRQ(ierr);                       /* u = H^{-1}*B*v      */
1369a51937d4SCarola Kruse   ierr  = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1370a51937d4SCarola Kruse   ierr  = KSPSolve(ksp,work2,u);CHKERRQ(ierr);
1371c0decd05SBarry Smith   ierr  = KSPCheckSolve(ksp,pc,u);CHKERRQ(ierr);
1372a51937d4SCarola Kruse   ierr  = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1373a51937d4SCarola Kruse   ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);                          /* alpha = u'*H*u      */
1374a51937d4SCarola Kruse   ierr  = VecDot(Hu,u,&alpha);CHKERRQ(ierr);
1375e071a0a4SCarola Kruse   KSPCheckDot(ksp,alpha);
1376e071a0a4SCarola Kruse   if (PetscRealPart(alpha) <= 0.0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_NOT_CONVERGED,"GKB preconditioner diverged, H is not positive definite");
1377de482cd7SCarola Kruse   alpha = PetscSqrtScalar(PetscAbsScalar(alpha));
137892c1e38eSCarola Kruse   ierr  = VecScale(u,1.0/alpha);CHKERRQ(ierr);
137992c1e38eSCarola Kruse   ierr  = VecAXPBY(d,1.0/alpha,0.0,v);CHKERRQ(ierr);                       /* v = nu/beta *c      */
1380de482cd7SCarola Kruse 
1381a51937d4SCarola Kruse   z = beta/alpha;
1382a51937d4SCarola Kruse   vecz[1] = z;
1383a51937d4SCarola Kruse 
1384de482cd7SCarola Kruse   /* Computation of first iterate x(1) and p(1) */
1385a51937d4SCarola Kruse   ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr);
1386a51937d4SCarola Kruse   ierr = VecCopy(d,ilinkD->y);CHKERRQ(ierr);
1387a51937d4SCarola Kruse   ierr = VecScale(ilinkD->y,-z);CHKERRQ(ierr);
1388a51937d4SCarola Kruse 
1389a51937d4SCarola Kruse   iterGKB = 1; lowbnd = 2*jac->gkbtol;
1390de482cd7SCarola Kruse   if (jac->gkbmonitor) {
1391de482cd7SCarola Kruse       ierr = PetscViewerASCIIPrintf(jac->gkbviewer,"%3D GKB Lower bound estimate %14.12e\n",iterGKB,lowbnd);CHKERRQ(ierr);
1392de482cd7SCarola Kruse   }
1393de482cd7SCarola Kruse 
1394a51937d4SCarola Kruse   while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) {
1395a51937d4SCarola Kruse     iterGKB += 1;
1396e071a0a4SCarola Kruse     ierr  = MatMultHermitianTranspose(jac->B,u,work1);CHKERRQ(ierr); /* v <- nu*(B'*u-alpha/nu*v) */
1397e071a0a4SCarola Kruse     ierr  = VecAXPBY(v,nu,-alpha,work1);CHKERRQ(ierr);
1398e071a0a4SCarola Kruse     ierr  = VecNorm(v,NORM_2,&beta);CHKERRQ(ierr);                   /* beta = sqrt(nu)*v'*v      */
1399de482cd7SCarola Kruse     beta  = beta/PetscSqrtScalar(nu);
140092c1e38eSCarola Kruse     ierr  = VecScale(v,1.0/beta);CHKERRQ(ierr);
1401e071a0a4SCarola Kruse     ierr  = MatMult(jac->B,v,work2);CHKERRQ(ierr);                  /* u <- H^{-1}*(B*v-beta*H*u) */
1402a51937d4SCarola Kruse     ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);
1403a51937d4SCarola Kruse     ierr  = VecAXPY(work2,-beta,Hu);CHKERRQ(ierr);
1404a51937d4SCarola Kruse     ierr  = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1405a51937d4SCarola Kruse     ierr  = KSPSolve(ksp,work2,u);CHKERRQ(ierr);
1406c0decd05SBarry Smith     ierr  = KSPCheckSolve(ksp,pc,u);CHKERRQ(ierr);
1407a51937d4SCarola Kruse     ierr  = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1408a51937d4SCarola Kruse     ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);                      /* alpha = u'*H*u            */
1409a51937d4SCarola Kruse     ierr  = VecDot(Hu,u,&alpha);CHKERRQ(ierr);
1410e071a0a4SCarola Kruse     KSPCheckDot(ksp,alpha);
1411e071a0a4SCarola Kruse     if (PetscRealPart(alpha) <= 0.0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_NOT_CONVERGED,"GKB preconditioner diverged, H is not positive definite");
1412de482cd7SCarola Kruse     alpha = PetscSqrtScalar(PetscAbsScalar(alpha));
141392c1e38eSCarola Kruse     ierr  = VecScale(u,1.0/alpha);CHKERRQ(ierr);
1414a51937d4SCarola Kruse 
1415e071a0a4SCarola Kruse     z = -beta/alpha*z;                                            /* z <- beta/alpha*z     */
1416a51937d4SCarola Kruse     vecz[0] = z;
1417a51937d4SCarola Kruse 
1418a51937d4SCarola Kruse     /* Computation of new iterate x(i+1) and p(i+1) */
141992c1e38eSCarola Kruse     ierr = VecAXPBY(d,1.0/alpha,-beta/alpha,v);CHKERRQ(ierr);       /* d = (v-beta*d)/alpha */
1420a51937d4SCarola Kruse     ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr);                  /* r = r + z*u          */
1421a51937d4SCarola Kruse     ierr = VecAXPY(ilinkD->y,-z,d);CHKERRQ(ierr);                 /* p = p - z*d          */
1422de482cd7SCarola Kruse     ierr = MatMult(jac->H,ilinkA->y,Hu);CHKERRQ(ierr);            /* ||u||_H = u'*H*u     */
1423a51937d4SCarola Kruse     ierr = VecDot(Hu,ilinkA->y,&nrmz2);CHKERRQ(ierr);
1424a51937d4SCarola Kruse 
1425a51937d4SCarola Kruse     /* Compute Lower Bound estimate */
1426a51937d4SCarola Kruse     if (iterGKB > jac->gkbdelay) {
1427a51937d4SCarola Kruse       lowbnd = 0.0;
1428a51937d4SCarola Kruse       for (j=0; j<jac->gkbdelay; j++) {
1429a51937d4SCarola Kruse         lowbnd += PetscAbsScalar(vecz[j]*vecz[j]);
1430a51937d4SCarola Kruse       }
1431a51937d4SCarola Kruse       lowbnd = PetscSqrtScalar(lowbnd/PetscAbsScalar(nrmz2));
1432a51937d4SCarola Kruse     }
1433a51937d4SCarola Kruse 
1434a51937d4SCarola Kruse     for (j=0; j<jac->gkbdelay-1; j++) {
1435a51937d4SCarola Kruse       vecz[jac->gkbdelay-j-1] = vecz[jac->gkbdelay-j-2];
1436a51937d4SCarola Kruse     }
1437de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1438de482cd7SCarola Kruse       ierr = PetscViewerASCIIPrintf(jac->gkbviewer,"%3D GKB Lower bound estimate %14.12e\n",iterGKB,lowbnd);CHKERRQ(ierr);
1439de482cd7SCarola Kruse     }
1440a51937d4SCarola Kruse   }
1441a51937d4SCarola Kruse 
1442a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1443de482cd7SCarola Kruse   ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1444a29b4eb7SJunchao Zhang   ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1445a51937d4SCarola Kruse   ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1446a51937d4SCarola Kruse 
1447a51937d4SCarola Kruse   PetscFunctionReturn(0);
1448a51937d4SCarola Kruse }
1449a51937d4SCarola Kruse 
1450a51937d4SCarola Kruse 
1451421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1452ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1453ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
14549df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1455421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) ||                  \
1456c0decd05SBarry Smith    KSPCheckSolve(ilink->ksp,pc,ilink->x) || \
1457c0decd05SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) ||   \
1458ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1459ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1460421e10b8SBarry Smith 
1461421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1462421e10b8SBarry Smith {
1463421e10b8SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1464421e10b8SBarry Smith   PetscErrorCode     ierr;
1465421e10b8SBarry Smith   PC_FieldSplitLink  ilink = jac->head;
1466939b8a20SBarry Smith   PetscInt           bs;
1467421e10b8SBarry Smith 
1468421e10b8SBarry Smith   PetscFunctionBegin;
1469421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1470421e10b8SBarry Smith     if (jac->defaultsplit) {
1471939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1472ce94432eSBarry Smith       if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of x vector %D does not match fieldsplit blocksize %D",bs,jac->bs);
1473939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1474ce94432eSBarry Smith       if (jac->bs > 0 && bs != jac->bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Blocksize of y vector %D does not match fieldsplit blocksize %D",bs,jac->bs);
1475421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1476421e10b8SBarry Smith       while (ilink) {
14779df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1478421e10b8SBarry Smith         ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1479c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
14809df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1481421e10b8SBarry Smith         ilink = ilink->next;
1482421e10b8SBarry Smith       }
1483421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1484421e10b8SBarry Smith     } else {
1485421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1486421e10b8SBarry Smith       while (ilink) {
1487421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1488421e10b8SBarry Smith         ilink = ilink->next;
1489421e10b8SBarry Smith       }
1490421e10b8SBarry Smith     }
1491421e10b8SBarry Smith   } else {
1492421e10b8SBarry Smith     if (!jac->w1) {
1493421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1494421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1495421e10b8SBarry Smith     }
1496421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1497421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1498421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1499421e10b8SBarry Smith       while (ilink->next) {
1500421e10b8SBarry Smith         ilink = ilink->next;
15019989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1502421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1503421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1504421e10b8SBarry Smith       }
1505421e10b8SBarry Smith       while (ilink->previous) {
1506421e10b8SBarry Smith         ilink = ilink->previous;
15079989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1508421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1509421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1510421e10b8SBarry Smith       }
1511421e10b8SBarry Smith     } else {
1512421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1513421e10b8SBarry Smith         ilink = ilink->next;
1514421e10b8SBarry Smith       }
1515421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1516421e10b8SBarry Smith       while (ilink->previous) {
1517421e10b8SBarry Smith         ilink = ilink->previous;
15189989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1519421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1520421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1521421e10b8SBarry Smith       }
1522421e10b8SBarry Smith     }
1523421e10b8SBarry Smith   }
1524421e10b8SBarry Smith   PetscFunctionReturn(0);
1525421e10b8SBarry Smith }
1526421e10b8SBarry Smith 
1527574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
15280971522cSBarry Smith {
15290971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
15300971522cSBarry Smith   PetscErrorCode    ierr;
15315a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
15320971522cSBarry Smith 
15330971522cSBarry Smith   PetscFunctionBegin;
15345a9f2f41SSatish Balay   while (ilink) {
1535f5f0d762SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1536fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1537fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1538443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1539fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1540fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1541b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1542f5f0d762SBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1543f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
1544f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
15455a9f2f41SSatish Balay     next  = ilink->next;
1546f5f0d762SBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
15475a9f2f41SSatish Balay     ilink = next;
15480971522cSBarry Smith   }
1549f5f0d762SBarry Smith   jac->head = NULL;
155005b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1551574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1552574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1553574deadeSBarry Smith   } else if (jac->mat) {
15540298fd71SBarry Smith     jac->mat = NULL;
1555574deadeSBarry Smith   }
155697bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
155768dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
1558f5f0d762SBarry Smith   jac->nsplits = 0;
15596bf464f9SBarry Smith   ierr = VecDestroy(&jac->w1);CHKERRQ(ierr);
15606bf464f9SBarry Smith   ierr = VecDestroy(&jac->w2);CHKERRQ(ierr);
15616bf464f9SBarry Smith   ierr = MatDestroy(&jac->schur);CHKERRQ(ierr);
1562a7476a74SDmitry Karpeev   ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
15636bf464f9SBarry Smith   ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
15646bf464f9SBarry Smith   ierr = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1565d78dad28SBarry Smith   ierr = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
15666bf464f9SBarry Smith   ierr = MatDestroy(&jac->B);CHKERRQ(ierr);
15676bf464f9SBarry Smith   ierr = MatDestroy(&jac->C);CHKERRQ(ierr);
1568a51937d4SCarola Kruse   ierr = MatDestroy(&jac->H);CHKERRQ(ierr);
1569e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->u);CHKERRQ(ierr);
1570e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->v);CHKERRQ(ierr);
1571e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->Hu);CHKERRQ(ierr);
1572e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->d);CHKERRQ(ierr);
1573e071a0a4SCarola Kruse   ierr = PetscFree(jac->vecz);CHKERRQ(ierr);
1574de482cd7SCarola Kruse   ierr = PetscViewerDestroy(&jac->gkbviewer);CHKERRQ(ierr);
15756dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1576574deadeSBarry Smith   PetscFunctionReturn(0);
1577574deadeSBarry Smith }
1578574deadeSBarry Smith 
1579574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1580574deadeSBarry Smith {
1581574deadeSBarry Smith   PetscErrorCode    ierr;
1582574deadeSBarry Smith 
1583574deadeSBarry Smith   PetscFunctionBegin;
1584574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1585c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1586285fb4e2SStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",NULL);CHKERRQ(ierr);
1587bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1588bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1589bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1590bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1591bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
159229f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
159337a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1594bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
15956dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr);
15960971522cSBarry Smith   PetscFunctionReturn(0);
15970971522cSBarry Smith }
15980971522cSBarry Smith 
15994416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
16000971522cSBarry Smith {
16011b9fc7fcSBarry Smith   PetscErrorCode  ierr;
16026c924f48SJed Brown   PetscInt        bs;
16037b752e3dSPatrick Sanan   PetscBool       flg;
16049dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
16053b224e63SBarry Smith   PCCompositeType ctype;
16061b9fc7fcSBarry Smith 
16070971522cSBarry Smith   PetscFunctionBegin;
1608e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
16094ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
161051f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
161151f519a2SBarry Smith   if (flg) {
161251f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
161351f519a2SBarry Smith   }
16142686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
16152686e3e9SMatthew G. Knepley   ierr = 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);CHKERRQ(ierr);
16162686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
16172686e3e9SMatthew G. Knepley   ierr = 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);CHKERRQ(ierr);
16187b752e3dSPatrick Sanan   ierr = PetscOptionsBool("-pc_fieldsplit_detect_saddle_point","Form 2-way split by detecting zero diagonal entries", "PCFieldSplitSetDetectSaddlePoint",jac->detect,&jac->detect,NULL);CHKERRQ(ierr);
16197b752e3dSPatrick Sanan   ierr = PCFieldSplitSetDetectSaddlePoint(pc,jac->detect);CHKERRQ(ierr); /* Sets split type and Schur PC type */
16203b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
16213b224e63SBarry Smith   if (flg) {
16223b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
16233b224e63SBarry Smith   }
1624c30613efSMatthew Knepley   /* Only setup fields once */
1625c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1626d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1627d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
16286c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
16296c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1630d32f9abdSBarry Smith   }
1631c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1632c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1633c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
16340298fd71SBarry Smith     ierr = 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);CHKERRQ(ierr);
163529f8a81cSJed Brown     ierr = PetscOptionsEnum("-pc_fieldsplit_schur_precondition","How to build preconditioner for Schur complement","PCFieldSplitSetSchurPre",PCFieldSplitSchurPreTypes,(PetscEnum)jac->schurpre,(PetscEnum*)&jac->schurpre,NULL);CHKERRQ(ierr);
1636c096484dSStefano Zampini     ierr = PetscOptionsScalar("-pc_fieldsplit_schur_scale","Scale Schur complement","PCFieldSplitSetSchurScale",jac->schurscale,&jac->schurscale,NULL);CHKERRQ(ierr);
1637a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1638a51937d4SCarola Kruse     ierr = PetscOptionsReal("-pc_fieldsplit_gkb_tol","The tolerance for the lower bound stopping criterion","PCFieldSplitGKBTol",jac->gkbtol,&jac->gkbtol,NULL);CHKERRQ(ierr);
1639a51937d4SCarola Kruse     ierr = PetscOptionsInt("-pc_fieldsplit_gkb_delay","The delay value for lower bound criterion","PCFieldSplitGKBDelay",jac->gkbdelay,&jac->gkbdelay,NULL);CHKERRQ(ierr);
1640a51937d4SCarola Kruse     ierr = PetscOptionsReal("-pc_fieldsplit_gkb_nu","Parameter in augmented Lagrangian approach","PCFieldSplitGKBNu",jac->gkbnu,&jac->gkbnu,NULL);CHKERRQ(ierr);
1641e071a0a4SCarola Kruse     if (jac->gkbnu < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nu cannot be less than 0: value %f",jac->gkbnu);
1642a51937d4SCarola Kruse     ierr = PetscOptionsInt("-pc_fieldsplit_gkb_maxit","Maximum allowed number of iterations","PCFieldSplitGKBMaxit",jac->gkbmaxit,&jac->gkbmaxit,NULL);CHKERRQ(ierr);
1643de482cd7SCarola Kruse     ierr = PetscOptionsBool("-pc_fieldsplit_gkb_monitor","Prints number of GKB iterations and error","PCFieldSplitGKB",jac->gkbmonitor,&jac->gkbmonitor,NULL);CHKERRQ(ierr);
1644c5d2311dSJed Brown   }
16451b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
16460971522cSBarry Smith   PetscFunctionReturn(0);
16470971522cSBarry Smith }
16480971522cSBarry Smith 
16490971522cSBarry Smith /*------------------------------------------------------------------------------------*/
16500971522cSBarry Smith 
16511e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
16520971522cSBarry Smith {
165397bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
16540971522cSBarry Smith   PetscErrorCode    ierr;
16555a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
165669a612a9SBarry Smith   char              prefix[128];
16575d4c12cdSJungho Lee   PetscInt          i;
16580971522cSBarry Smith 
16590971522cSBarry Smith   PetscFunctionBegin;
16606c924f48SJed Brown   if (jac->splitdefined) {
16616c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
16626c924f48SJed Brown     PetscFunctionReturn(0);
16636c924f48SJed Brown   }
166451f519a2SBarry Smith   for (i=0; i<n; i++) {
1665e32f2f54SBarry Smith     if (fields[i] >= jac->bs) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Field %D requested but only %D exist",fields[i],jac->bs);
1666e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
166751f519a2SBarry Smith   }
1668b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1669a04f6461SBarry Smith   if (splitname) {
1670db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1671a04f6461SBarry Smith   } else {
1672785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1673a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1674a04f6461SBarry Smith   }
16759df09d43SBarry Smith   ilink->event = jac->nsplits < 5 ? KSP_Solve_FS_0 + jac->nsplits : KSP_Solve_FS_0 + 4; /* Any split great than 4 gets logged in the 4th split */
1676785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
1677580bdb30SBarry Smith   ierr = PetscArraycpy(ilink->fields,fields,n);CHKERRQ(ierr);
1678785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
1679580bdb30SBarry Smith   ierr = PetscArraycpy(ilink->fields_col,fields_col,n);CHKERRQ(ierr);
16802fa5cd67SKarl Rupp 
16815a9f2f41SSatish Balay   ilink->nfields = n;
16820298fd71SBarry Smith   ilink->next    = NULL;
1683ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1684422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
168520252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
16865a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
16879005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
168869a612a9SBarry Smith 
16898caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
16905a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
16910971522cSBarry Smith 
16920971522cSBarry Smith   if (!next) {
16935a9f2f41SSatish Balay     jac->head       = ilink;
16940298fd71SBarry Smith     ilink->previous = NULL;
16950971522cSBarry Smith   } else {
16960971522cSBarry Smith     while (next->next) {
16970971522cSBarry Smith       next = next->next;
16980971522cSBarry Smith     }
16995a9f2f41SSatish Balay     next->next      = ilink;
170051f519a2SBarry Smith     ilink->previous = next;
17010971522cSBarry Smith   }
17020971522cSBarry Smith   jac->nsplits++;
17030971522cSBarry Smith   PetscFunctionReturn(0);
17040971522cSBarry Smith }
17050971522cSBarry Smith 
1706285fb4e2SStefano Zampini static PetscErrorCode  PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
1707285fb4e2SStefano Zampini {
1708285fb4e2SStefano Zampini   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1709285fb4e2SStefano Zampini   PetscErrorCode ierr;
1710285fb4e2SStefano Zampini 
1711285fb4e2SStefano Zampini   PetscFunctionBegin;
1712285fb4e2SStefano Zampini   *subksp = NULL;
1713285fb4e2SStefano Zampini   if (n) *n = 0;
1714285fb4e2SStefano Zampini   if (jac->type == PC_COMPOSITE_SCHUR) {
1715285fb4e2SStefano Zampini     PetscInt nn;
1716285fb4e2SStefano Zampini 
1717285fb4e2SStefano Zampini     if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()");
1718285fb4e2SStefano Zampini     if (jac->nsplits != 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unexpected number of splits %D != 2",jac->nsplits);
1719285fb4e2SStefano Zampini     nn   = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0);
1720285fb4e2SStefano Zampini     ierr = PetscMalloc1(nn,subksp);CHKERRQ(ierr);
1721285fb4e2SStefano Zampini     (*subksp)[0] = jac->head->ksp;
1722285fb4e2SStefano Zampini     (*subksp)[1] = jac->kspschur;
1723285fb4e2SStefano Zampini     if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper;
1724285fb4e2SStefano Zampini     if (n) *n = nn;
1725285fb4e2SStefano Zampini   }
1726285fb4e2SStefano Zampini   PetscFunctionReturn(0);
1727285fb4e2SStefano Zampini }
1728285fb4e2SStefano Zampini 
17291e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1730e69d4d44SBarry Smith {
1731e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1732e69d4d44SBarry Smith   PetscErrorCode ierr;
1733e69d4d44SBarry Smith 
1734e69d4d44SBarry Smith   PetscFunctionBegin;
173534a3b412SBarry Smith   if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
1736785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1737e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
17382fa5cd67SKarl Rupp 
1739e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
174013e0d083SBarry Smith   if (n) *n = jac->nsplits;
1741e69d4d44SBarry Smith   PetscFunctionReturn(0);
1742e69d4d44SBarry Smith }
17430971522cSBarry Smith 
17441e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
17450971522cSBarry Smith {
17460971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
17470971522cSBarry Smith   PetscErrorCode    ierr;
17480971522cSBarry Smith   PetscInt          cnt   = 0;
17495a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
17500971522cSBarry Smith 
17510971522cSBarry Smith   PetscFunctionBegin;
1752785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
17535a9f2f41SSatish Balay   while (ilink) {
17545a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
17555a9f2f41SSatish Balay     ilink            = ilink->next;
17560971522cSBarry Smith   }
17575d480477SMatthew G Knepley   if (cnt != jac->nsplits) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Corrupt PCFIELDSPLIT object: number of splits in linked list %D does not match number in object %D",cnt,jac->nsplits);
175813e0d083SBarry Smith   if (n) *n = jac->nsplits;
17590971522cSBarry Smith   PetscFunctionReturn(0);
17600971522cSBarry Smith }
17610971522cSBarry Smith 
17626dbb499eSCian Wilson /*@C
17636dbb499eSCian Wilson     PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS.
17646dbb499eSCian Wilson 
17656dbb499eSCian Wilson     Input Parameters:
17666dbb499eSCian Wilson +   pc  - the preconditioner context
1767a2b725a8SWilliam Gropp -   is - the index set that defines the indices to which the fieldsplit is to be restricted
17686dbb499eSCian Wilson 
17696dbb499eSCian Wilson     Level: advanced
17706dbb499eSCian Wilson 
17716dbb499eSCian Wilson @*/
17726dbb499eSCian Wilson PetscErrorCode  PCFieldSplitRestrictIS(PC pc,IS isy)
17736dbb499eSCian Wilson {
17746dbb499eSCian Wilson   PetscErrorCode ierr;
17756dbb499eSCian Wilson 
17766dbb499eSCian Wilson   PetscFunctionBegin;
17776dbb499eSCian Wilson   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
17786dbb499eSCian Wilson   PetscValidHeaderSpecific(isy,IS_CLASSID,2);
17790246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr);
17806dbb499eSCian Wilson   PetscFunctionReturn(0);
17816dbb499eSCian Wilson }
17826dbb499eSCian Wilson 
17836dbb499eSCian Wilson 
17846dbb499eSCian Wilson static PetscErrorCode  PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
17856dbb499eSCian Wilson {
17866dbb499eSCian Wilson   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
17876dbb499eSCian Wilson   PetscErrorCode    ierr;
17886dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
17896dbb499eSCian Wilson   PetscInt          localsize,size,sizez,i;
17906dbb499eSCian Wilson   const PetscInt    *ind, *indz;
17916dbb499eSCian Wilson   PetscInt          *indc, *indcz;
17926dbb499eSCian Wilson   PetscBool         flg;
17936dbb499eSCian Wilson 
17946dbb499eSCian Wilson   PetscFunctionBegin;
17956dbb499eSCian Wilson   ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr);
17966dbb499eSCian Wilson   ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr);
17976dbb499eSCian Wilson   size -= localsize;
17986dbb499eSCian Wilson   while(ilink) {
17996dbb499eSCian Wilson     IS isrl,isr;
18001c7cfba8SBarry Smith     PC subpc;
18016dbb499eSCian Wilson     ierr          = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
18026dbb499eSCian Wilson     ierr          = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr);
18036dbb499eSCian Wilson     ierr          = PetscMalloc1(localsize,&indc);CHKERRQ(ierr);
18046dbb499eSCian Wilson     ierr          = ISGetIndices(isrl,&ind);CHKERRQ(ierr);
1805580bdb30SBarry Smith     ierr          = PetscArraycpy(indc,ind,localsize);CHKERRQ(ierr);
18066dbb499eSCian Wilson     ierr          = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr);
18076dbb499eSCian Wilson     ierr          = ISDestroy(&isrl);CHKERRQ(ierr);
18086dbb499eSCian Wilson     for (i=0; i<localsize; i++) *(indc+i) += size;
18096dbb499eSCian Wilson     ierr          = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr);
18106dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
18116dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
18126dbb499eSCian Wilson     ilink->is     = isr;
18136dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
18146dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
18156dbb499eSCian Wilson     ilink->is_col = isr;
18166dbb499eSCian Wilson     ierr          = ISDestroy(&isr);CHKERRQ(ierr);
18176dbb499eSCian Wilson     ierr          = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr);
18186dbb499eSCian Wilson     ierr          = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr);
18196dbb499eSCian Wilson     if(flg) {
18206dbb499eSCian Wilson       IS iszl,isz;
18216dbb499eSCian Wilson       MPI_Comm comm;
18226dbb499eSCian Wilson       ierr   = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr);
18236dbb499eSCian Wilson       comm   = PetscObjectComm((PetscObject)ilink->is);
18246dbb499eSCian Wilson       ierr   = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr);
18256dbb499eSCian Wilson       ierr   = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr);
18266dbb499eSCian Wilson       sizez -= localsize;
18276dbb499eSCian Wilson       ierr   = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr);
18286dbb499eSCian Wilson       ierr   = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr);
18296dbb499eSCian Wilson       ierr   = ISGetIndices(iszl,&indz);CHKERRQ(ierr);
1830580bdb30SBarry Smith       ierr   = PetscArraycpy(indcz,indz,localsize);CHKERRQ(ierr);
18316dbb499eSCian Wilson       ierr   = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr);
18326dbb499eSCian Wilson       ierr   = ISDestroy(&iszl);CHKERRQ(ierr);
18336dbb499eSCian Wilson       for (i=0; i<localsize; i++) *(indcz+i) += sizez;
18346dbb499eSCian Wilson       ierr   = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr);
18356dbb499eSCian Wilson       ierr   = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr);
18366dbb499eSCian Wilson       ierr   = ISDestroy(&isz);CHKERRQ(ierr);
18376dbb499eSCian Wilson     }
18386dbb499eSCian Wilson     next = ilink->next;
18396dbb499eSCian Wilson     ilink = next;
18406dbb499eSCian Wilson   }
18416dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
18426dbb499eSCian Wilson   PetscFunctionReturn(0);
18436dbb499eSCian Wilson }
18446dbb499eSCian Wilson 
18451e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1846704ba839SBarry Smith {
1847704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1848704ba839SBarry Smith   PetscErrorCode    ierr;
1849704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1850704ba839SBarry Smith   char              prefix[128];
1851704ba839SBarry Smith 
1852704ba839SBarry Smith   PetscFunctionBegin;
18536c924f48SJed Brown   if (jac->splitdefined) {
18546c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
18556c924f48SJed Brown     PetscFunctionReturn(0);
18566c924f48SJed Brown   }
1857b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1858a04f6461SBarry Smith   if (splitname) {
1859db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1860a04f6461SBarry Smith   } else {
1861785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1862b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1863a04f6461SBarry Smith   }
18649df09d43SBarry Smith   ilink->event  = jac->nsplits < 5 ? KSP_Solve_FS_0 + jac->nsplits : KSP_Solve_FS_0 + 4; /* Any split great than 4 gets logged in the 4th split */
18651ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1866b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1867b5787286SJed Brown   ilink->is     = is;
1868b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1869b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1870b5787286SJed Brown   ilink->is_col = is;
18710298fd71SBarry Smith   ilink->next   = NULL;
1872ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1873422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
187420252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1875704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
18769005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1877704ba839SBarry Smith 
18788caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1879704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1880704ba839SBarry Smith 
1881704ba839SBarry Smith   if (!next) {
1882704ba839SBarry Smith     jac->head       = ilink;
18830298fd71SBarry Smith     ilink->previous = NULL;
1884704ba839SBarry Smith   } else {
1885704ba839SBarry Smith     while (next->next) {
1886704ba839SBarry Smith       next = next->next;
1887704ba839SBarry Smith     }
1888704ba839SBarry Smith     next->next      = ilink;
1889704ba839SBarry Smith     ilink->previous = next;
1890704ba839SBarry Smith   }
1891704ba839SBarry Smith   jac->nsplits++;
1892704ba839SBarry Smith   PetscFunctionReturn(0);
1893704ba839SBarry Smith }
1894704ba839SBarry Smith 
189594ef8ddeSSatish Balay /*@C
18960971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
18970971522cSBarry Smith 
1898ad4df100SBarry Smith     Logically Collective on PC
18990971522cSBarry Smith 
19000971522cSBarry Smith     Input Parameters:
19010971522cSBarry Smith +   pc  - the preconditioner context
19020298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
19030971522cSBarry Smith .   n - the number of fields in this split
1904db4c96c1SJed Brown -   fields - the fields in this split
19050971522cSBarry Smith 
19060971522cSBarry Smith     Level: intermediate
19070971522cSBarry Smith 
190895452b02SPatrick Sanan     Notes:
190995452b02SPatrick Sanan     Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1910d32f9abdSBarry Smith 
19117287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1912d32f9abdSBarry Smith      size is three then one can define a field as 0, or 1 or 2 or 0,1 or 0,2 or 1,2 which mean
1913d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1914d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1915d32f9abdSBarry Smith 
1916db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1917db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1918db4c96c1SJed Brown 
19195d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
19205d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
19215d4c12cdSJungho Lee      available when this routine is called.
19225d4c12cdSJungho Lee 
1923d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
19240971522cSBarry Smith 
19250971522cSBarry Smith @*/
19265d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
19270971522cSBarry Smith {
19284ac538c5SBarry Smith   PetscErrorCode ierr;
19290971522cSBarry Smith 
19300971522cSBarry Smith   PetscFunctionBegin;
19310700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1932db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1933ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1934db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
19350246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
19360971522cSBarry Smith   PetscFunctionReturn(0);
19370971522cSBarry Smith }
19380971522cSBarry Smith 
1939c84da90fSDmitry Karpeev /*@
1940c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1941c84da90fSDmitry Karpeev 
1942c84da90fSDmitry Karpeev     Logically Collective on PC
1943c84da90fSDmitry Karpeev 
1944c84da90fSDmitry Karpeev     Input Parameters:
1945c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1946c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1947c84da90fSDmitry Karpeev 
19489506b623SDmitry Karpeev     Options Database:
19499506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1950c84da90fSDmitry Karpeev 
1951c84da90fSDmitry Karpeev     Level: intermediate
1952c84da90fSDmitry Karpeev 
1953c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1954c84da90fSDmitry Karpeev 
1955c84da90fSDmitry Karpeev @*/
1956c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1957c84da90fSDmitry Karpeev {
1958c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1959c84da90fSDmitry Karpeev   PetscBool      isfs;
1960c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1961c84da90fSDmitry Karpeev 
1962c84da90fSDmitry Karpeev   PetscFunctionBegin;
1963c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1964c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1965c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1966c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1967c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1968c84da90fSDmitry Karpeev }
1969c84da90fSDmitry Karpeev 
1970c84da90fSDmitry Karpeev /*@
1971c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1972c84da90fSDmitry Karpeev 
1973c84da90fSDmitry Karpeev     Logically Collective on PC
1974c84da90fSDmitry Karpeev 
1975c84da90fSDmitry Karpeev     Input Parameters:
1976c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1977c84da90fSDmitry Karpeev 
1978c84da90fSDmitry Karpeev     Output Parameters:
1979c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1980c84da90fSDmitry Karpeev 
1981c84da90fSDmitry Karpeev 
1982c84da90fSDmitry Karpeev     Level: intermediate
1983c84da90fSDmitry Karpeev 
1984c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1985c84da90fSDmitry Karpeev 
1986c84da90fSDmitry Karpeev @*/
1987c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1988c84da90fSDmitry Karpeev {
1989c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1990c84da90fSDmitry Karpeev   PetscBool      isfs;
1991c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1992c84da90fSDmitry Karpeev 
1993c84da90fSDmitry Karpeev   PetscFunctionBegin;
1994c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1995534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
1996c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1997c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1998c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1999c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2000c84da90fSDmitry Karpeev }
2001c84da90fSDmitry Karpeev 
2002c84da90fSDmitry Karpeev /*@
2003c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
2004c84da90fSDmitry Karpeev 
2005c84da90fSDmitry Karpeev     Logically Collective on PC
2006c84da90fSDmitry Karpeev 
2007c84da90fSDmitry Karpeev     Input Parameters:
2008c84da90fSDmitry Karpeev +   pc  - the preconditioner object
2009c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2010c84da90fSDmitry Karpeev 
20119506b623SDmitry Karpeev     Options Database:
20129506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
2013c84da90fSDmitry Karpeev 
2014c84da90fSDmitry Karpeev     Level: intermediate
2015c84da90fSDmitry Karpeev 
2016c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
2017c84da90fSDmitry Karpeev 
2018c84da90fSDmitry Karpeev @*/
2019c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
2020c84da90fSDmitry Karpeev {
2021c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2022c84da90fSDmitry Karpeev   PetscBool      isfs;
2023c84da90fSDmitry Karpeev   PetscErrorCode ierr;
2024c84da90fSDmitry Karpeev 
2025c84da90fSDmitry Karpeev   PetscFunctionBegin;
2026c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2027c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2028c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
2029c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
2030c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2031c84da90fSDmitry Karpeev }
2032c84da90fSDmitry Karpeev 
2033c84da90fSDmitry Karpeev /*@
2034c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
2035c84da90fSDmitry Karpeev 
2036c84da90fSDmitry Karpeev     Logically Collective on PC
2037c84da90fSDmitry Karpeev 
2038c84da90fSDmitry Karpeev     Input Parameters:
2039c84da90fSDmitry Karpeev .   pc  - the preconditioner object
2040c84da90fSDmitry Karpeev 
2041c84da90fSDmitry Karpeev     Output Parameters:
2042c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2043c84da90fSDmitry Karpeev 
2044c84da90fSDmitry Karpeev 
2045c84da90fSDmitry Karpeev     Level: intermediate
2046c84da90fSDmitry Karpeev 
2047c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
2048c84da90fSDmitry Karpeev 
2049c84da90fSDmitry Karpeev @*/
2050c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
2051c84da90fSDmitry Karpeev {
2052c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2053c84da90fSDmitry Karpeev   PetscBool      isfs;
2054c84da90fSDmitry Karpeev   PetscErrorCode ierr;
2055c84da90fSDmitry Karpeev 
2056c84da90fSDmitry Karpeev   PetscFunctionBegin;
2057c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2058534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
2059c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2060c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
2061c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
2062c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2063c84da90fSDmitry Karpeev }
2064c84da90fSDmitry Karpeev 
2065c84da90fSDmitry Karpeev 
2066c84da90fSDmitry Karpeev 
2067218d4943SBarry Smith /*@C
2068704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
2069704ba839SBarry Smith 
2070ad4df100SBarry Smith     Logically Collective on PC
2071704ba839SBarry Smith 
2072704ba839SBarry Smith     Input Parameters:
2073704ba839SBarry Smith +   pc  - the preconditioner context
20740298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
2075db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
2076704ba839SBarry Smith 
2077d32f9abdSBarry Smith 
2078a6ffb8dbSJed Brown     Notes:
2079a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
2080a6ffb8dbSJed Brown 
2081db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
2082db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
2083d32f9abdSBarry Smith 
2084704ba839SBarry Smith     Level: intermediate
2085704ba839SBarry Smith 
2086704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
2087704ba839SBarry Smith 
2088704ba839SBarry Smith @*/
20897087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
2090704ba839SBarry Smith {
20914ac538c5SBarry Smith   PetscErrorCode ierr;
2092704ba839SBarry Smith 
2093704ba839SBarry Smith   PetscFunctionBegin;
20940700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
20957b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
2096db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
2097ccc738f7SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
2098704ba839SBarry Smith   PetscFunctionReturn(0);
2099704ba839SBarry Smith }
2100704ba839SBarry Smith 
210194ef8ddeSSatish Balay /*@C
210257a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
210357a9adfeSMatthew G Knepley 
210457a9adfeSMatthew G Knepley     Logically Collective on PC
210557a9adfeSMatthew G Knepley 
210657a9adfeSMatthew G Knepley     Input Parameters:
210757a9adfeSMatthew G Knepley +   pc  - the preconditioner context
210857a9adfeSMatthew G Knepley -   splitname - name of this split
210957a9adfeSMatthew G Knepley 
211057a9adfeSMatthew G Knepley     Output Parameter:
21110298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
211257a9adfeSMatthew G Knepley 
211357a9adfeSMatthew G Knepley     Level: intermediate
211457a9adfeSMatthew G Knepley 
211557a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
211657a9adfeSMatthew G Knepley 
211757a9adfeSMatthew G Knepley @*/
211857a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
211957a9adfeSMatthew G Knepley {
212057a9adfeSMatthew G Knepley   PetscErrorCode ierr;
212157a9adfeSMatthew G Knepley 
212257a9adfeSMatthew G Knepley   PetscFunctionBegin;
212357a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
212457a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
212557a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
212657a9adfeSMatthew G Knepley   {
212757a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
212857a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
212957a9adfeSMatthew G Knepley     PetscBool         found;
213057a9adfeSMatthew G Knepley 
21310298fd71SBarry Smith     *is = NULL;
213257a9adfeSMatthew G Knepley     while (ilink) {
213357a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
213457a9adfeSMatthew G Knepley       if (found) {
213557a9adfeSMatthew G Knepley         *is = ilink->is;
213657a9adfeSMatthew G Knepley         break;
213757a9adfeSMatthew G Knepley       }
213857a9adfeSMatthew G Knepley       ilink = ilink->next;
213957a9adfeSMatthew G Knepley     }
214057a9adfeSMatthew G Knepley   }
214157a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
214257a9adfeSMatthew G Knepley }
214357a9adfeSMatthew G Knepley 
2144998f007dSPierre Jolivet /*@C
2145998f007dSPierre Jolivet     PCFieldSplitGetISByIndex - Retrieves the elements for a given index field as an IS
2146998f007dSPierre Jolivet 
2147998f007dSPierre Jolivet     Logically Collective on PC
2148998f007dSPierre Jolivet 
2149998f007dSPierre Jolivet     Input Parameters:
2150998f007dSPierre Jolivet +   pc  - the preconditioner context
2151998f007dSPierre Jolivet -   index - index of this split
2152998f007dSPierre Jolivet 
2153998f007dSPierre Jolivet     Output Parameter:
2154998f007dSPierre Jolivet -   is - the index set that defines the vector elements in this field
2155998f007dSPierre Jolivet 
2156998f007dSPierre Jolivet     Level: intermediate
2157998f007dSPierre Jolivet 
2158998f007dSPierre Jolivet .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitGetIS(), PCFieldSplitSetIS()
2159998f007dSPierre Jolivet 
2160998f007dSPierre Jolivet @*/
2161998f007dSPierre Jolivet PetscErrorCode PCFieldSplitGetISByIndex(PC pc,PetscInt index,IS *is)
2162998f007dSPierre Jolivet {
2163998f007dSPierre Jolivet   PetscErrorCode ierr;
2164998f007dSPierre Jolivet 
2165998f007dSPierre Jolivet   PetscFunctionBegin;
2166998f007dSPierre Jolivet   if (index < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",index);
2167998f007dSPierre Jolivet   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2168998f007dSPierre Jolivet   PetscValidPointer(is,3);
2169998f007dSPierre Jolivet   {
2170998f007dSPierre Jolivet     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
2171998f007dSPierre Jolivet     PC_FieldSplitLink ilink = jac->head;
2172998f007dSPierre Jolivet     PetscInt          i     = 0;
2173998f007dSPierre Jolivet     if (index >= jac->nsplits) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Field %D requested but only %D exist",index,jac->nsplits);
2174998f007dSPierre Jolivet 
2175998f007dSPierre Jolivet     while (i < index) {
2176998f007dSPierre Jolivet       ilink = ilink->next;
2177998f007dSPierre Jolivet       ++i;
2178998f007dSPierre Jolivet     }
2179998f007dSPierre Jolivet     ierr = PCFieldSplitGetIS(pc,ilink->splitname,is);CHKERRQ(ierr);
2180998f007dSPierre Jolivet   }
2181998f007dSPierre Jolivet   PetscFunctionReturn(0);
2182998f007dSPierre Jolivet }
2183998f007dSPierre Jolivet 
218451f519a2SBarry Smith /*@
218551f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
218651f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
218751f519a2SBarry Smith 
2188ad4df100SBarry Smith     Logically Collective on PC
218951f519a2SBarry Smith 
219051f519a2SBarry Smith     Input Parameters:
219151f519a2SBarry Smith +   pc  - the preconditioner context
219251f519a2SBarry Smith -   bs - the block size
219351f519a2SBarry Smith 
219451f519a2SBarry Smith     Level: intermediate
219551f519a2SBarry Smith 
219651f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
219751f519a2SBarry Smith 
219851f519a2SBarry Smith @*/
21997087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
220051f519a2SBarry Smith {
22014ac538c5SBarry Smith   PetscErrorCode ierr;
220251f519a2SBarry Smith 
220351f519a2SBarry Smith   PetscFunctionBegin;
22040700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2205c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
22064ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
220751f519a2SBarry Smith   PetscFunctionReturn(0);
220851f519a2SBarry Smith }
220951f519a2SBarry Smith 
22100971522cSBarry Smith /*@C
221169a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
22120971522cSBarry Smith 
221369a612a9SBarry Smith    Collective on KSP
22140971522cSBarry Smith 
22150971522cSBarry Smith    Input Parameter:
22160971522cSBarry Smith .  pc - the preconditioner context
22170971522cSBarry Smith 
22180971522cSBarry Smith    Output Parameters:
221913e0d083SBarry Smith +  n - the number of splits
22203111de3cSBarry Smith -  subksp - the array of KSP contexts
22210971522cSBarry Smith 
22220971522cSBarry Smith    Note:
22239a4f7e47SBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
2224d32f9abdSBarry Smith    (not the KSP just the array that contains them).
22250971522cSBarry Smith 
2226285fb4e2SStefano Zampini    You must call PCSetUp() before calling PCFieldSplitGetSubKSP().
2227285fb4e2SStefano Zampini 
2228285fb4e2SStefano Zampini    If the fieldsplit is of type PC_COMPOSITE_SCHUR, it returns the KSP object used inside the
2229285fb4e2SStefano Zampini    Schur complement and the KSP object used to iterate over the Schur complement.
2230a51937d4SCarola Kruse    To access all the KSP objects used in PC_COMPOSITE_SCHUR, use PCFieldSplitSchurGetSubKSP().
2231a51937d4SCarola Kruse 
2232a51937d4SCarola Kruse    If the fieldsplit is of type PC_COMPOSITE_GKB, it returns the KSP object used to solve the
2233a51937d4SCarola Kruse    inner linear system defined by the matrix H in each loop.
22340971522cSBarry Smith 
2235196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
22362bf68e3eSBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
2237196cc216SBarry Smith       KSP array must be.
2238196cc216SBarry Smith 
2239196cc216SBarry Smith 
22400971522cSBarry Smith    Level: advanced
22410971522cSBarry Smith 
22420971522cSBarry Smith .seealso: PCFIELDSPLIT
22430971522cSBarry Smith @*/
22447087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
22450971522cSBarry Smith {
22464ac538c5SBarry Smith   PetscErrorCode ierr;
22470971522cSBarry Smith 
22480971522cSBarry Smith   PetscFunctionBegin;
22490700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
225013e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
22514ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
22520971522cSBarry Smith   PetscFunctionReturn(0);
22530971522cSBarry Smith }
22540971522cSBarry Smith 
2255285fb4e2SStefano Zampini /*@C
2256285fb4e2SStefano Zampini    PCFieldSplitSchurGetSubKSP - Gets the KSP contexts used inside the Schur complement based PCFIELDSPLIT
2257285fb4e2SStefano Zampini 
2258285fb4e2SStefano Zampini    Collective on KSP
2259285fb4e2SStefano Zampini 
2260285fb4e2SStefano Zampini    Input Parameter:
2261285fb4e2SStefano Zampini .  pc - the preconditioner context
2262285fb4e2SStefano Zampini 
2263285fb4e2SStefano Zampini    Output Parameters:
2264285fb4e2SStefano Zampini +  n - the number of splits
2265285fb4e2SStefano Zampini -  subksp - the array of KSP contexts
2266285fb4e2SStefano Zampini 
2267285fb4e2SStefano Zampini    Note:
2268285fb4e2SStefano Zampini    After PCFieldSplitSchurGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
2269285fb4e2SStefano Zampini    (not the KSP just the array that contains them).
2270285fb4e2SStefano Zampini 
2271285fb4e2SStefano Zampini    You must call PCSetUp() before calling PCFieldSplitSchurGetSubKSP().
2272285fb4e2SStefano Zampini 
2273285fb4e2SStefano Zampini    If the fieldsplit type is of type PC_COMPOSITE_SCHUR, it returns (in order)
2274285fb4e2SStefano Zampini    - the KSP used for the (1,1) block
2275285fb4e2SStefano Zampini    - the KSP used for the Schur complement (not the one used for the interior Schur solver)
2276285fb4e2SStefano Zampini    - the KSP used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block).
2277285fb4e2SStefano Zampini 
2278285fb4e2SStefano Zampini    It returns a null array if the fieldsplit is not of type PC_COMPOSITE_SCHUR; in this case, you should use PCFieldSplitGetSubKSP().
2279285fb4e2SStefano Zampini 
2280285fb4e2SStefano Zampini    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
2281285fb4e2SStefano Zampini       You can call PCFieldSplitSchurGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
2282285fb4e2SStefano Zampini       KSP array must be.
2283285fb4e2SStefano Zampini 
2284285fb4e2SStefano Zampini    Level: advanced
2285285fb4e2SStefano Zampini 
2286285fb4e2SStefano Zampini .seealso: PCFIELDSPLIT
2287285fb4e2SStefano Zampini @*/
2288285fb4e2SStefano Zampini PetscErrorCode  PCFieldSplitSchurGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
2289285fb4e2SStefano Zampini {
2290285fb4e2SStefano Zampini   PetscErrorCode ierr;
2291285fb4e2SStefano Zampini 
2292285fb4e2SStefano Zampini   PetscFunctionBegin;
2293285fb4e2SStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2294285fb4e2SStefano Zampini   if (n) PetscValidIntPointer(n,2);
2295285fb4e2SStefano Zampini   ierr = PetscUseMethod(pc,"PCFieldSplitSchurGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
2296285fb4e2SStefano Zampini   PetscFunctionReturn(0);
2297285fb4e2SStefano Zampini }
2298285fb4e2SStefano Zampini 
2299e69d4d44SBarry Smith /*@
2300a1e3cbf9SBarry Smith     PCFieldSplitSetSchurPre -  Indicates from what operator the preconditioner is constructucted for the Schur complement.
2301a1e3cbf9SBarry Smith       The default is the A11 matrix.
2302e69d4d44SBarry Smith 
2303e69d4d44SBarry Smith     Collective on PC
2304e69d4d44SBarry Smith 
2305e69d4d44SBarry Smith     Input Parameters:
2306e69d4d44SBarry Smith +   pc      - the preconditioner context
23076fdd48a9SBarry Smith .   ptype   - which matrix to use for preconditioning the Schur complement: PC_FIELDSPLIT_SCHUR_PRE_A11 (default), PC_FIELDSPLIT_SCHUR_PRE_SELF, PC_FIELDSPLIT_SCHUR_PRE_USER
23086fdd48a9SBarry Smith               PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL
23090298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
2310084e4875SJed Brown 
2311e69d4d44SBarry Smith     Options Database:
2312a1e3cbf9SBarry Smith +    -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments
2313a1e3cbf9SBarry Smith -    -fieldsplit_1_pc_type <pctype> - the preconditioner algorithm that is used to construct the preconditioner from the operator
2314e69d4d44SBarry Smith 
2315fd1303e9SJungho Lee     Notes:
2316fd1303e9SJungho Lee $    If ptype is
2317a1e3cbf9SBarry Smith $        a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
231853f2277eSBarry Smith $        matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
2319a1e3cbf9SBarry Smith $        self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
2320a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
2321fd1303e9SJungho Lee $             preconditioner
2322a1e3cbf9SBarry Smith $        user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
23236fdd48a9SBarry Smith $             to this function).
2324a1e3cbf9SBarry Smith $        selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
23251d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
23266fdd48a9SBarry Smith $             lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump
2327a1e3cbf9SBarry Smith $        full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation computed internally by PCFIELDSPLIT (this is expensive)
23286fdd48a9SBarry Smith $             useful mostly as a test that the Schur complement approach can work for your problem
2329fd1303e9SJungho Lee 
2330e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
2331fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
2332a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
2333fd1303e9SJungho Lee 
2334e69d4d44SBarry Smith     Level: intermediate
2335e69d4d44SBarry Smith 
23361d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
23371d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
2338e69d4d44SBarry Smith 
2339e69d4d44SBarry Smith @*/
234029f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
2341e69d4d44SBarry Smith {
23424ac538c5SBarry Smith   PetscErrorCode ierr;
2343e69d4d44SBarry Smith 
2344e69d4d44SBarry Smith   PetscFunctionBegin;
23450700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
234629f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
2347e69d4d44SBarry Smith   PetscFunctionReturn(0);
2348e69d4d44SBarry Smith }
2349686bed4dSStefano Zampini 
235029f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
2351e69d4d44SBarry Smith 
235237a82bf0SJed Brown /*@
235337a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
235429f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
235537a82bf0SJed Brown 
235637a82bf0SJed Brown     Logically Collective on PC
235737a82bf0SJed Brown 
235837a82bf0SJed Brown     Input Parameters:
235937a82bf0SJed Brown .   pc      - the preconditioner context
236037a82bf0SJed Brown 
236137a82bf0SJed Brown     Output Parameters:
236237a82bf0SJed Brown +   ptype   - which matrix to use for preconditioning the Schur complement: PC_FIELDSPLIT_SCHUR_PRE_A11, PC_FIELDSPLIT_SCHUR_PRE_SELF, PC_FIELDSPLIT_PRE_USER
236337a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
236437a82bf0SJed Brown 
236537a82bf0SJed Brown     Level: intermediate
236637a82bf0SJed Brown 
236729f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
236837a82bf0SJed Brown 
236937a82bf0SJed Brown @*/
237037a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
237137a82bf0SJed Brown {
237237a82bf0SJed Brown   PetscErrorCode ierr;
237337a82bf0SJed Brown 
237437a82bf0SJed Brown   PetscFunctionBegin;
237537a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
237637a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
2377e69d4d44SBarry Smith   PetscFunctionReturn(0);
2378e69d4d44SBarry Smith }
2379e69d4d44SBarry Smith 
238045e7fc46SDmitry Karpeev /*@
2381470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
238245e7fc46SDmitry Karpeev 
238345e7fc46SDmitry Karpeev     Not collective
238445e7fc46SDmitry Karpeev 
238545e7fc46SDmitry Karpeev     Input Parameter:
238645e7fc46SDmitry Karpeev .   pc      - the preconditioner context
238745e7fc46SDmitry Karpeev 
238845e7fc46SDmitry Karpeev     Output Parameter:
2389470b340bSDmitry Karpeev .   S       - the Schur complement matrix
239045e7fc46SDmitry Karpeev 
2391470b340bSDmitry Karpeev     Notes:
2392470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
239345e7fc46SDmitry Karpeev 
239445e7fc46SDmitry Karpeev     Level: advanced
239545e7fc46SDmitry Karpeev 
239629f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
239745e7fc46SDmitry Karpeev 
239845e7fc46SDmitry Karpeev @*/
2399470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
240045e7fc46SDmitry Karpeev {
240145e7fc46SDmitry Karpeev   PetscErrorCode ierr;
240245e7fc46SDmitry Karpeev   const char*    t;
240345e7fc46SDmitry Karpeev   PetscBool      isfs;
240445e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
240545e7fc46SDmitry Karpeev 
240645e7fc46SDmitry Karpeev   PetscFunctionBegin;
240745e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
240845e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
240945e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
241045e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
241145e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2412470b340bSDmitry Karpeev   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PCFIELDSPLIT of type SCHUR, got %D instead",jac->type);
2413470b340bSDmitry Karpeev   if (S) *S = jac->schur;
241445e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
241545e7fc46SDmitry Karpeev }
241645e7fc46SDmitry Karpeev 
2417470b340bSDmitry Karpeev /*@
2418470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
2419470b340bSDmitry Karpeev 
2420470b340bSDmitry Karpeev     Not collective
2421470b340bSDmitry Karpeev 
2422470b340bSDmitry Karpeev     Input Parameters:
2423470b340bSDmitry Karpeev +   pc      - the preconditioner context
2424a2b725a8SWilliam Gropp -   S       - the Schur complement matrix
2425470b340bSDmitry Karpeev 
2426470b340bSDmitry Karpeev     Level: advanced
2427470b340bSDmitry Karpeev 
242829f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
2429470b340bSDmitry Karpeev 
2430470b340bSDmitry Karpeev @*/
2431bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
2432470b340bSDmitry Karpeev {
2433470b340bSDmitry Karpeev   PetscErrorCode ierr;
2434470b340bSDmitry Karpeev   const char*    t;
2435470b340bSDmitry Karpeev   PetscBool      isfs;
2436470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
2437470b340bSDmitry Karpeev 
2438470b340bSDmitry Karpeev   PetscFunctionBegin;
2439470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2440470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
2441470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2442470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
2443470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2444470b340bSDmitry Karpeev   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PCFIELDSPLIT of type SCHUR, got %D instead",jac->type);
2445bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
2446470b340bSDmitry Karpeev   PetscFunctionReturn(0);
2447470b340bSDmitry Karpeev }
2448470b340bSDmitry Karpeev 
2449470b340bSDmitry Karpeev 
245029f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
2451e69d4d44SBarry Smith {
2452e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2453084e4875SJed Brown   PetscErrorCode ierr;
2454e69d4d44SBarry Smith 
2455e69d4d44SBarry Smith   PetscFunctionBegin;
2456084e4875SJed Brown   jac->schurpre = ptype;
2457a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
24586bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
2459084e4875SJed Brown     jac->schur_user = pre;
2460084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
2461084e4875SJed Brown   }
2462e69d4d44SBarry Smith   PetscFunctionReturn(0);
2463e69d4d44SBarry Smith }
2464e69d4d44SBarry Smith 
246537a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
246637a82bf0SJed Brown {
246737a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
246837a82bf0SJed Brown 
246937a82bf0SJed Brown   PetscFunctionBegin;
247037a82bf0SJed Brown   *ptype = jac->schurpre;
247137a82bf0SJed Brown   *pre   = jac->schur_user;
247237a82bf0SJed Brown   PetscFunctionReturn(0);
247337a82bf0SJed Brown }
247437a82bf0SJed Brown 
2475ab1df9f5SJed Brown /*@
24760ffb0e17SBarry Smith     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner
2477ab1df9f5SJed Brown 
2478ab1df9f5SJed Brown     Collective on PC
2479ab1df9f5SJed Brown 
2480ab1df9f5SJed Brown     Input Parameters:
2481ab1df9f5SJed Brown +   pc  - the preconditioner context
2482c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
2483ab1df9f5SJed Brown 
2484ab1df9f5SJed Brown     Options Database:
2485c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
2486ab1df9f5SJed Brown 
2487ab1df9f5SJed Brown 
2488ab1df9f5SJed Brown     Level: intermediate
2489ab1df9f5SJed Brown 
2490ab1df9f5SJed Brown     Notes:
2491ab1df9f5SJed Brown     The FULL factorization is
2492ab1df9f5SJed Brown 
24930ffb0e17SBarry Smith $   (A   B)  = (1       0) (A   0) (1  Ainv*B)  = L D U
24940ffb0e17SBarry Smith $   (C   E)    (C*Ainv  1) (0   S) (0     1  )
2495ab1df9f5SJed Brown 
24960ffb0e17SBarry Smith     where S = E - C*Ainv*B. In practice, the full factorization is applied via block triangular solves with the grouping L*(D*U). UPPER uses D*U, LOWER uses L*D,
2497c096484dSStefano Zampini     and DIAG is the diagonal part with the sign of S flipped (because this makes the preconditioner positive definite for many formulations, thus allowing the use of KSPMINRES). Sign flipping of S can be turned off with PCFieldSplitSetSchurScale().
2498ab1df9f5SJed Brown 
24990ffb0e17SBarry Smith $    If A and S are solved exactly
25000ffb0e17SBarry Smith $      *) FULL factorization is a direct solver.
25010ffb0e17SBarry Smith $      *) The preconditioned operator with LOWER or UPPER has all eigenvalues equal to 1 and minimal polynomial of degree 2, so KSPGMRES converges in 2 iterations.
25020ffb0e17SBarry Smith $      *) With DIAG, the preconditioned operator has three distinct nonzero eigenvalues and minimal polynomial of degree at most 4, so KSPGMRES converges in at most 4 iterations.
2503ab1df9f5SJed Brown 
25040ffb0e17SBarry Smith     If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
25050ffb0e17SBarry 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.
25060ffb0e17SBarry Smith 
25070ffb0e17SBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES.
25080ffb0e17SBarry Smith 
25090ffb0e17SBarry Smith     Note that a flexible method like KSPFGMRES or KSPGCR must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used to solve with A or S).
2510ab1df9f5SJed Brown 
2511ab1df9f5SJed Brown     References:
251296a0c994SBarry Smith +   1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
251396a0c994SBarry Smith -   2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2514ab1df9f5SJed Brown 
2515c096484dSStefano Zampini .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCFieldSplitSetSchurScale()
2516ab1df9f5SJed Brown @*/
2517c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
2518ab1df9f5SJed Brown {
2519ab1df9f5SJed Brown   PetscErrorCode ierr;
2520ab1df9f5SJed Brown 
2521ab1df9f5SJed Brown   PetscFunctionBegin;
2522ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2523c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
2524ab1df9f5SJed Brown   PetscFunctionReturn(0);
2525ab1df9f5SJed Brown }
2526ab1df9f5SJed Brown 
25271e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
2528ab1df9f5SJed Brown {
2529ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2530ab1df9f5SJed Brown 
2531ab1df9f5SJed Brown   PetscFunctionBegin;
2532ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2533ab1df9f5SJed Brown   PetscFunctionReturn(0);
2534ab1df9f5SJed Brown }
2535ab1df9f5SJed Brown 
2536c096484dSStefano Zampini /*@
2537c096484dSStefano Zampini     PCFieldSplitSetSchurScale -  Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG.
2538c096484dSStefano Zampini 
2539c096484dSStefano Zampini     Collective on PC
2540c096484dSStefano Zampini 
2541c096484dSStefano Zampini     Input Parameters:
2542c096484dSStefano Zampini +   pc    - the preconditioner context
2543c096484dSStefano Zampini -   scale - scaling factor for the Schur complement
2544c096484dSStefano Zampini 
2545c096484dSStefano Zampini     Options Database:
2546c096484dSStefano Zampini .     -pc_fieldsplit_schur_scale - default is -1.0
2547c096484dSStefano Zampini 
2548c096484dSStefano Zampini     Level: intermediate
2549c096484dSStefano Zampini 
2550c096484dSStefano Zampini .seealso: PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurFactType, PCFieldSplitSetSchurScale()
2551c096484dSStefano Zampini @*/
2552c096484dSStefano Zampini PetscErrorCode PCFieldSplitSetSchurScale(PC pc,PetscScalar scale)
2553c096484dSStefano Zampini {
2554c096484dSStefano Zampini   PetscErrorCode ierr;
2555c096484dSStefano Zampini 
2556c096484dSStefano Zampini   PetscFunctionBegin;
2557c096484dSStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2558c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc,scale,2);
2559c096484dSStefano Zampini   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurScale_C",(PC,PetscScalar),(pc,scale));CHKERRQ(ierr);
2560c096484dSStefano Zampini   PetscFunctionReturn(0);
2561c096484dSStefano Zampini }
2562c096484dSStefano Zampini 
2563c096484dSStefano Zampini static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc,PetscScalar scale)
2564c096484dSStefano Zampini {
2565c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2566c096484dSStefano Zampini 
2567c096484dSStefano Zampini   PetscFunctionBegin;
2568c096484dSStefano Zampini   jac->schurscale = scale;
2569c096484dSStefano Zampini   PetscFunctionReturn(0);
2570c096484dSStefano Zampini }
2571c096484dSStefano Zampini 
257230ad9308SMatthew Knepley /*@C
25738c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
257430ad9308SMatthew Knepley 
257530ad9308SMatthew Knepley    Collective on KSP
257630ad9308SMatthew Knepley 
257730ad9308SMatthew Knepley    Input Parameter:
257830ad9308SMatthew Knepley .  pc - the preconditioner context
257930ad9308SMatthew Knepley 
258030ad9308SMatthew Knepley    Output Parameters:
2581a04f6461SBarry Smith +  A00 - the (0,0) block
2582a04f6461SBarry Smith .  A01 - the (0,1) block
2583a04f6461SBarry Smith .  A10 - the (1,0) block
2584a04f6461SBarry Smith -  A11 - the (1,1) block
258530ad9308SMatthew Knepley 
258630ad9308SMatthew Knepley    Level: advanced
258730ad9308SMatthew Knepley 
258830ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
258930ad9308SMatthew Knepley @*/
2590a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
259130ad9308SMatthew Knepley {
259230ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
259330ad9308SMatthew Knepley 
259430ad9308SMatthew Knepley   PetscFunctionBegin;
25950700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2596ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2597a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2598a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2599a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2600a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
260130ad9308SMatthew Knepley   PetscFunctionReturn(0);
260230ad9308SMatthew Knepley }
260330ad9308SMatthew Knepley 
2604b09e027eSCarola Kruse /*@
2605e071a0a4SCarola Kruse     PCFieldSplitSetGKBTol -  Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner.
2606b09e027eSCarola Kruse 
2607b09e027eSCarola Kruse     Collective on PC
2608b09e027eSCarola Kruse 
2609e071a0a4SCarola Kruse     Notes:
2610e071a0a4SCarola Kruse     The generalized GKB algorithm uses a lower bound estimate of the error in energy norm as stopping criterion.
2611e071a0a4SCarola Kruse     It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than
2612e071a0a4SCarola Kruse     this estimate, the stopping criterion is satisfactory in practical cases [A13].
2613e071a0a4SCarola Kruse 
2614e071a0a4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2615e071a0a4SCarola Kruse 
2616b09e027eSCarola Kruse     Input Parameters:
2617b09e027eSCarola Kruse +   pc        - the preconditioner context
2618b09e027eSCarola Kruse -   tolerance - the solver tolerance
2619b09e027eSCarola Kruse 
2620b09e027eSCarola Kruse     Options Database:
2621b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_tol - default is 1e-5
2622b09e027eSCarola Kruse 
2623b09e027eSCarola Kruse     Level: intermediate
2624b09e027eSCarola Kruse 
2625b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBMaxit()
2626b09e027eSCarola Kruse @*/
2627b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBTol(PC pc,PetscReal tolerance)
2628b09e027eSCarola Kruse {
2629b09e027eSCarola Kruse   PetscErrorCode ierr;
2630b09e027eSCarola Kruse 
2631b09e027eSCarola Kruse   PetscFunctionBegin;
2632b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2633de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc,tolerance,2);
2634b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBTol_C",(PC,PetscReal),(pc,tolerance));CHKERRQ(ierr);
2635b09e027eSCarola Kruse   PetscFunctionReturn(0);
2636b09e027eSCarola Kruse }
2637b09e027eSCarola Kruse 
2638b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc,PetscReal tolerance)
2639b09e027eSCarola Kruse {
2640b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2641b09e027eSCarola Kruse 
2642b09e027eSCarola Kruse   PetscFunctionBegin;
2643b09e027eSCarola Kruse   jac->gkbtol = tolerance;
2644b09e027eSCarola Kruse   PetscFunctionReturn(0);
2645b09e027eSCarola Kruse }
2646b09e027eSCarola Kruse 
2647b09e027eSCarola Kruse 
2648b09e027eSCarola Kruse /*@
2649e071a0a4SCarola Kruse     PCFieldSplitSetGKBMaxit -  Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization
2650e071a0a4SCarola Kruse     preconditioner.
2651b09e027eSCarola Kruse 
2652b09e027eSCarola Kruse     Collective on PC
2653b09e027eSCarola Kruse 
2654b09e027eSCarola Kruse     Input Parameters:
2655b09e027eSCarola Kruse +   pc     - the preconditioner context
2656b09e027eSCarola Kruse -   maxit  - the maximum number of iterations
2657b09e027eSCarola Kruse 
2658b09e027eSCarola Kruse     Options Database:
2659b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_maxit - default is 100
2660b09e027eSCarola Kruse 
2661b09e027eSCarola Kruse     Level: intermediate
2662b09e027eSCarola Kruse 
2663b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBNu()
2664b09e027eSCarola Kruse @*/
2665b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc,PetscInt maxit)
2666b09e027eSCarola Kruse {
2667b09e027eSCarola Kruse   PetscErrorCode ierr;
2668b09e027eSCarola Kruse 
2669b09e027eSCarola Kruse   PetscFunctionBegin;
2670b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2671de482cd7SCarola Kruse   PetscValidLogicalCollectiveInt(pc,maxit,2);
2672b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBMaxit_C",(PC,PetscInt),(pc,maxit));CHKERRQ(ierr);
2673b09e027eSCarola Kruse   PetscFunctionReturn(0);
2674b09e027eSCarola Kruse }
2675b09e027eSCarola Kruse 
2676b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc,PetscInt maxit)
2677b09e027eSCarola Kruse {
2678b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2679b09e027eSCarola Kruse 
2680b09e027eSCarola Kruse   PetscFunctionBegin;
2681b09e027eSCarola Kruse   jac->gkbmaxit = maxit;
2682b09e027eSCarola Kruse   PetscFunctionReturn(0);
2683b09e027eSCarola Kruse }
2684b09e027eSCarola Kruse 
2685b09e027eSCarola Kruse /*@
2686e071a0a4SCarola Kruse     PCFieldSplitSetGKBDelay -  Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization
2687e071a0a4SCarola Kruse     preconditioner.
2688b09e027eSCarola Kruse 
2689b09e027eSCarola Kruse     Collective on PC
2690b09e027eSCarola Kruse 
2691b09e027eSCarola Kruse     Notes:
2692e071a0a4SCarola Kruse     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
2693e071a0a4SCarola Kruse     is expressed as a truncated sum. The error at iteration k can only be measured at iteration (k + delay), and thus the algorithm needs
2694e071a0a4SCarola Kruse     at least (delay + 1) iterations to stop. For more details on the generalized Golub-Kahan bidiagonalization method and its lower bound stopping criterion, please refer to
2695b09e027eSCarola Kruse 
2696b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2697b09e027eSCarola Kruse 
2698b09e027eSCarola Kruse     Input Parameters:
2699b09e027eSCarola Kruse +   pc     - the preconditioner context
2700b09e027eSCarola Kruse -   delay  - the delay window in the lower bound estimate
2701b09e027eSCarola Kruse 
2702b09e027eSCarola Kruse     Options Database:
2703b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_delay - default is 5
2704b09e027eSCarola Kruse 
2705b09e027eSCarola Kruse     Level: intermediate
2706b09e027eSCarola Kruse 
2707b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit()
2708b09e027eSCarola Kruse @*/
2709b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBDelay(PC pc,PetscInt delay)
2710b09e027eSCarola Kruse {
2711b09e027eSCarola Kruse   PetscErrorCode ierr;
2712b09e027eSCarola Kruse 
2713b09e027eSCarola Kruse   PetscFunctionBegin;
2714b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2715b09e027eSCarola Kruse   PetscValidLogicalCollectiveInt(pc,delay,2);
2716b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBDelay_C",(PC,PetscInt),(pc,delay));CHKERRQ(ierr);
2717b09e027eSCarola Kruse   PetscFunctionReturn(0);
2718b09e027eSCarola Kruse }
2719b09e027eSCarola Kruse 
2720b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc,PetscInt delay)
2721b09e027eSCarola Kruse {
2722b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2723b09e027eSCarola Kruse 
2724b09e027eSCarola Kruse   PetscFunctionBegin;
2725b09e027eSCarola Kruse   jac->gkbdelay = delay;
2726b09e027eSCarola Kruse   PetscFunctionReturn(0);
2727b09e027eSCarola Kruse }
2728b09e027eSCarola Kruse 
2729b09e027eSCarola Kruse /*@
2730b09e027eSCarola Kruse     PCFieldSplitSetGKBNu -  Sets the scalar value nu >= 0 in the transformation H = A00 + nu*A01*A01' of the (1,1) block in the Golub-Kahan bidiagonalization preconditioner.
2731b09e027eSCarola Kruse 
2732b09e027eSCarola Kruse     Collective on PC
2733b09e027eSCarola Kruse 
2734b09e027eSCarola Kruse     Notes:
2735e071a0a4SCarola Kruse     This shift is in general done to obtain better convergence properties for the outer loop of the algorithm. This is often achieved by chosing nu sufficiently big. However,
2736b09e027eSCarola Kruse     if nu is chosen too big, the matrix H might be badly conditioned and the solution of the linear system Hx = b in the inner loop gets difficult. It is therefore
2737b09e027eSCarola Kruse     necessary to find a good balance in between the convergence of the inner and outer loop.
2738b09e027eSCarola Kruse 
2739b09e027eSCarola Kruse     For nu = 0, no shift is done. In this case A00 has to be positive definite. The matrix N in [Ar13] is then chosen as identity.
2740b09e027eSCarola Kruse 
2741b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2742b09e027eSCarola Kruse 
2743b09e027eSCarola Kruse     Input Parameters:
2744b09e027eSCarola Kruse +   pc     - the preconditioner context
2745b09e027eSCarola Kruse -   nu     - the shift parameter
2746b09e027eSCarola Kruse 
2747b09e027eSCarola Kruse     Options Database:
2748b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_nu - default is 1
2749b09e027eSCarola Kruse 
2750b09e027eSCarola Kruse     Level: intermediate
2751b09e027eSCarola Kruse 
2752b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit()
2753b09e027eSCarola Kruse @*/
2754b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBNu(PC pc,PetscReal nu)
2755b09e027eSCarola Kruse {
2756b09e027eSCarola Kruse   PetscErrorCode ierr;
2757b09e027eSCarola Kruse 
2758b09e027eSCarola Kruse   PetscFunctionBegin;
2759b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2760de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc,nu,2);
2761b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBNu_C",(PC,PetscReal),(pc,nu));CHKERRQ(ierr);
2762b09e027eSCarola Kruse   PetscFunctionReturn(0);
2763b09e027eSCarola Kruse }
2764b09e027eSCarola Kruse 
2765b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc,PetscReal nu)
2766b09e027eSCarola Kruse {
2767b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2768b09e027eSCarola Kruse 
2769b09e027eSCarola Kruse   PetscFunctionBegin;
2770b09e027eSCarola Kruse   jac->gkbnu = nu;
2771b09e027eSCarola Kruse   PetscFunctionReturn(0);
2772b09e027eSCarola Kruse }
2773b09e027eSCarola Kruse 
2774b09e027eSCarola Kruse 
27751e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
277679416396SBarry Smith {
277779416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2778e69d4d44SBarry Smith   PetscErrorCode ierr;
277979416396SBarry Smith 
278079416396SBarry Smith   PetscFunctionBegin;
278179416396SBarry Smith   jac->type = type;
2782e071a0a4SCarola Kruse 
2783e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",0);CHKERRQ(ierr);
2784e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
2785e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2786e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
2787e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr);
2788e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",0);CHKERRQ(ierr);
2789e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",0);CHKERRQ(ierr);
2790e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",0);CHKERRQ(ierr);
2791e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",0);CHKERRQ(ierr);
2792e071a0a4SCarola Kruse 
27933b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
27943b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
27953b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
27962fa5cd67SKarl Rupp 
2797bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
279829f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
279937a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2800bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2801c096484dSStefano Zampini     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",PCFieldSplitSetSchurScale_FieldSplit);CHKERRQ(ierr);
2802a51937d4SCarola Kruse   } else if (type == PC_COMPOSITE_GKB){
2803a51937d4SCarola Kruse     pc->ops->apply = PCApply_FieldSplit_GKB;
2804a51937d4SCarola Kruse     pc->ops->view  = PCView_FieldSplit_GKB;
2805e69d4d44SBarry Smith 
2806a51937d4SCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2807b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",PCFieldSplitSetGKBTol_FieldSplit);CHKERRQ(ierr);
2808b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",PCFieldSplitSetGKBMaxit_FieldSplit);CHKERRQ(ierr);
2809b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",PCFieldSplitSetGKBNu_FieldSplit);CHKERRQ(ierr);
2810b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",PCFieldSplitSetGKBDelay_FieldSplit);CHKERRQ(ierr);
28113b224e63SBarry Smith   } else {
28123b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
28133b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
28142fa5cd67SKarl Rupp 
2815bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
28163b224e63SBarry Smith   }
281779416396SBarry Smith   PetscFunctionReturn(0);
281879416396SBarry Smith }
281979416396SBarry Smith 
28201e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
282151f519a2SBarry Smith {
282251f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
282351f519a2SBarry Smith 
282451f519a2SBarry Smith   PetscFunctionBegin;
2825ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2826ce94432eSBarry Smith   if (jac->bs > 0 && jac->bs != bs) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Cannot change fieldsplit blocksize from %D to %D after it has been set",jac->bs,bs);
282751f519a2SBarry Smith   jac->bs = bs;
282851f519a2SBarry Smith   PetscFunctionReturn(0);
282951f519a2SBarry Smith }
283051f519a2SBarry Smith 
2831bc08b0f1SBarry Smith /*@
283279416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
283379416396SBarry Smith 
283479416396SBarry Smith    Collective on PC
283579416396SBarry Smith 
283679416396SBarry Smith    Input Parameter:
2837a2b725a8SWilliam Gropp +  pc - the preconditioner context
2838a2b725a8SWilliam Gropp -  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
283979416396SBarry Smith 
284079416396SBarry Smith    Options Database Key:
2841a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
284279416396SBarry Smith 
2843b02e2d75SMatthew G Knepley    Level: Intermediate
284479416396SBarry Smith 
284579416396SBarry Smith .seealso: PCCompositeSetType()
284679416396SBarry Smith 
284779416396SBarry Smith @*/
28487087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
284979416396SBarry Smith {
28504ac538c5SBarry Smith   PetscErrorCode ierr;
285179416396SBarry Smith 
285279416396SBarry Smith   PetscFunctionBegin;
28530700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
28544ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
285579416396SBarry Smith   PetscFunctionReturn(0);
285679416396SBarry Smith }
285779416396SBarry Smith 
2858b02e2d75SMatthew G Knepley /*@
2859b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2860b02e2d75SMatthew G Knepley 
2861b02e2d75SMatthew G Knepley   Not collective
2862b02e2d75SMatthew G Knepley 
2863b02e2d75SMatthew G Knepley   Input Parameter:
2864b02e2d75SMatthew G Knepley . pc - the preconditioner context
2865b02e2d75SMatthew G Knepley 
2866b02e2d75SMatthew G Knepley   Output Parameter:
2867b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2868b02e2d75SMatthew G Knepley 
2869b02e2d75SMatthew G Knepley   Level: Intermediate
2870b02e2d75SMatthew G Knepley 
2871b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2872b02e2d75SMatthew G Knepley @*/
2873b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2874b02e2d75SMatthew G Knepley {
2875b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2876b02e2d75SMatthew G Knepley 
2877b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2878b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2879b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2880b02e2d75SMatthew G Knepley   *type = jac->type;
2881b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2882b02e2d75SMatthew G Knepley }
2883b02e2d75SMatthew G Knepley 
28844ab8060aSDmitry Karpeev /*@
28854ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
28864ab8060aSDmitry Karpeev 
28874ab8060aSDmitry Karpeev    Logically Collective
28884ab8060aSDmitry Karpeev 
28894ab8060aSDmitry Karpeev    Input Parameters:
28904ab8060aSDmitry Karpeev +  pc   - the preconditioner context
28914ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
28924ab8060aSDmitry Karpeev 
28934ab8060aSDmitry Karpeev    Options Database Key:
28944ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
28954ab8060aSDmitry Karpeev 
28964ab8060aSDmitry Karpeev    Level: Intermediate
28974ab8060aSDmitry Karpeev 
28984ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
28994ab8060aSDmitry Karpeev 
29004ab8060aSDmitry Karpeev @*/
29014ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
29024ab8060aSDmitry Karpeev {
29034ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
29044ab8060aSDmitry Karpeev   PetscBool      isfs;
29054ab8060aSDmitry Karpeev   PetscErrorCode ierr;
29064ab8060aSDmitry Karpeev 
29074ab8060aSDmitry Karpeev   PetscFunctionBegin;
29084ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
29094ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
29104ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
29114ab8060aSDmitry Karpeev   if (isfs) {
29124ab8060aSDmitry Karpeev     jac->dm_splits = flg;
29134ab8060aSDmitry Karpeev   }
29144ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
29154ab8060aSDmitry Karpeev }
29164ab8060aSDmitry Karpeev 
29174ab8060aSDmitry Karpeev 
29184ab8060aSDmitry Karpeev /*@
29194ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
29204ab8060aSDmitry Karpeev 
29214ab8060aSDmitry Karpeev    Logically Collective
29224ab8060aSDmitry Karpeev 
29234ab8060aSDmitry Karpeev    Input Parameter:
29244ab8060aSDmitry Karpeev .  pc   - the preconditioner context
29254ab8060aSDmitry Karpeev 
29264ab8060aSDmitry Karpeev    Output Parameter:
29274ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
29284ab8060aSDmitry Karpeev 
29294ab8060aSDmitry Karpeev    Level: Intermediate
29304ab8060aSDmitry Karpeev 
29314ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
29324ab8060aSDmitry Karpeev 
29334ab8060aSDmitry Karpeev @*/
29344ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
29354ab8060aSDmitry Karpeev {
29364ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
29374ab8060aSDmitry Karpeev   PetscBool      isfs;
29384ab8060aSDmitry Karpeev   PetscErrorCode ierr;
29394ab8060aSDmitry Karpeev 
29404ab8060aSDmitry Karpeev   PetscFunctionBegin;
29414ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2942534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
29434ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
29444ab8060aSDmitry Karpeev   if (isfs) {
29454ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
29464ab8060aSDmitry Karpeev   }
29474ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
29484ab8060aSDmitry Karpeev }
29494ab8060aSDmitry Karpeev 
29507b752e3dSPatrick Sanan /*@
29517b752e3dSPatrick Sanan    PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
29527b752e3dSPatrick Sanan 
29537b752e3dSPatrick Sanan    Logically Collective
29547b752e3dSPatrick Sanan 
29557b752e3dSPatrick Sanan    Input Parameter:
29567b752e3dSPatrick Sanan .  pc   - the preconditioner context
29577b752e3dSPatrick Sanan 
29587b752e3dSPatrick Sanan    Output Parameter:
29597b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
29607b752e3dSPatrick Sanan 
29617b752e3dSPatrick Sanan    Level: Intermediate
29627b752e3dSPatrick Sanan 
29637b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint()
29647b752e3dSPatrick Sanan 
29657b752e3dSPatrick Sanan @*/
29667b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc,PetscBool *flg)
29677b752e3dSPatrick Sanan {
29687b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
29697b752e3dSPatrick Sanan 
29707b752e3dSPatrick Sanan   PetscFunctionBegin;
29717b752e3dSPatrick Sanan   *flg = jac->detect;
29727b752e3dSPatrick Sanan   PetscFunctionReturn(0);
29737b752e3dSPatrick Sanan }
29747b752e3dSPatrick Sanan 
29757b752e3dSPatrick Sanan /*@
29767b752e3dSPatrick Sanan    PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
29777b752e3dSPatrick Sanan 
29787b752e3dSPatrick Sanan    Logically Collective
29797b752e3dSPatrick Sanan 
29807b752e3dSPatrick Sanan    Notes:
29817b752e3dSPatrick Sanan    Also sets the split type to PC_COMPOSITE_SCHUR (see PCFieldSplitSetType()) and the Schur preconditioner type to PC_FIELDSPLIT_SCHUR_PRE_SELF (see PCFieldSplitSetSchurPre()).
29827b752e3dSPatrick Sanan 
29837b752e3dSPatrick Sanan    Input Parameter:
29847b752e3dSPatrick Sanan .  pc   - the preconditioner context
29857b752e3dSPatrick Sanan 
29867b752e3dSPatrick Sanan    Output Parameter:
29877b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
29887b752e3dSPatrick Sanan 
29897b752e3dSPatrick Sanan    Options Database Key:
29907b752e3dSPatrick Sanan .  -pc_fieldsplit_detect_saddle_point
29917b752e3dSPatrick Sanan 
29927b752e3dSPatrick Sanan    Level: Intermediate
29937b752e3dSPatrick Sanan 
29947b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint(), PCFieldSplitSetType(), PCFieldSplitSetSchurPre()
29957b752e3dSPatrick Sanan 
29967b752e3dSPatrick Sanan @*/
29977b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc,PetscBool flg)
29987b752e3dSPatrick Sanan {
29997b752e3dSPatrick Sanan   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
30007b752e3dSPatrick Sanan   PetscErrorCode ierr;
30017b752e3dSPatrick Sanan 
30027b752e3dSPatrick Sanan   PetscFunctionBegin;
30037b752e3dSPatrick Sanan   jac->detect = flg;
30047b752e3dSPatrick Sanan   if (jac->detect) {
30057b752e3dSPatrick Sanan     ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
30067b752e3dSPatrick Sanan     ierr = PCFieldSplitSetSchurPre(pc,PC_FIELDSPLIT_SCHUR_PRE_SELF,NULL);CHKERRQ(ierr);
30077b752e3dSPatrick Sanan   }
30087b752e3dSPatrick Sanan   PetscFunctionReturn(0);
30097b752e3dSPatrick Sanan }
30107b752e3dSPatrick Sanan 
30110971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
30120971522cSBarry Smith /*MC
3013a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
3014a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
30150971522cSBarry Smith 
3016edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
3017edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
30180971522cSBarry Smith 
3019a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
302069a612a9SBarry Smith          and set the options directly on the resulting KSP object
30210971522cSBarry Smith 
30220971522cSBarry Smith    Level: intermediate
30230971522cSBarry Smith 
302479416396SBarry Smith    Options Database Keys:
302581540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
302681540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
302781540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
302881540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
3029a51937d4SCarola Kruse .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting
3030a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
3031*412be6bfSPatrick Sanan .   -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - set factorization type when using -pc_fieldsplit_type schur; see PCFieldSplitSetSchurFactType()
3032fb6809a2SPatrick Sanan -   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
303379416396SBarry Smith 
3034fb6809a2SPatrick Sanan      Options prefixes for inner solvers when using the Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_ .
3035fb6809a2SPatrick Sanan      For all other solvers they are -fieldsplit_%d_ for the dth field; use -fieldsplit_ for all fields.
3036fb6809a2SPatrick Sanan      The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is -fieldsplit_0_
30375d4c12cdSJungho Lee 
3038c8a0d604SMatthew G Knepley    Notes:
3039c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
3040d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
3041d32f9abdSBarry Smith 
3042d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
3043d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
3044d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
3045d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
3046d32f9abdSBarry Smith 
3047c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
3048c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
3049c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
305013b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
3051c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
305213b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
305313b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
305413b05affSJed Brown      which is usually dense and not stored explicitly.  The action of ksp(S) is computed using the KSP solver with prefix -fieldsplit_splitname_ (where splitname was given
3055686bed4dSStefano Zampini      in providing the SECOND split or 1 if not give). For PCFieldSplitGetSubKSP() when field number is 0,
3056c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
3057a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
30581d71051fSDmitry Karpeev 
3059a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
30605668aaf4SBarry Smith      diag gives
3061c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
3062c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
3063c096484dSStefano Zampini      note that slightly counter intuitively there is a negative in front of the ksp(S) so that the preconditioner is positive definite. For SPD matrices J, the sign flip
3064c096484dSStefano Zampini      can be turned off with PCFieldSplitSetSchurScale() or by command line -pc_fieldsplit_schur_scale 1.0. The lower factorization is the inverse of
3065c8a0d604SMatthew G Knepley $              (  A00   0 )
3066c8a0d604SMatthew G Knepley $              (  A10   S )
3067c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
3068c8a0d604SMatthew G Knepley $              ( A00 A01 )
3069c8a0d604SMatthew G Knepley $              (  0   S  )
3070c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
3071e69d4d44SBarry Smith 
3072edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
3073edf189efSBarry Smith      is used automatically for a second block.
3074edf189efSBarry Smith 
3075ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
3076ff218e97SBarry Smith      Generally it should be used with the AIJ format.
3077ff218e97SBarry Smith 
3078ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
3079ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
3080ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
30810716a85fSBarry Smith 
30823bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
30833bc631e0SBarry Smith 
30843bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
30853bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
30863bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
30873bc631e0SBarry Smith 
30884d308398SBarry Smith    The Constrained Pressure Preconditioner (CPR) can be implemented using PCCOMPOSITE with PCGALERKIN. CPR first solves an R A P subsystem, updates the
30894d308398SBarry Smith    residual on all variables (PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)), and then applies a simple ILU like preconditioner on all the variables.
3090a6a584a2SBarry Smith 
3091e071a0a4SCarola Kruse    The generalized Golub-Kahan bidiagonalization preconditioner (gkb) can be applied to symmetric 2x2 block matrices of the shape
3092a51937d4SCarola Kruse $        ( A00  A01 )
3093a51937d4SCarola Kruse $        ( A01' 0   )
3094a51937d4SCarola Kruse    with A00 positive semi-definite. The implementation follows [Ar13]. Therein, we choose N := 1/nu * I and the (1,1)-block of the matrix is modified to H = A00 + nu*A01*A01'.
3095e071a0a4SCarola Kruse    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_.
3096a51937d4SCarola Kruse 
3097a51937d4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
3098a51937d4SCarola Kruse 
3099*412be6bfSPatrick Sanan .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, PCLSC,
3100*412be6bfSPatrick Sanan            PCFieldSplitGetSubKSP(), PCFieldSplitSchurGetSubKSP(), PCFieldSplitSetFields(),
3101*412be6bfSPatrick Sanan            PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(), PCFieldSplitSetSchurFactType(),
3102*412be6bfSPatrick Sanan            MatSchurComplementSetAinvType(), PCFieldSplitSetSchurScale(), PCFieldSplitSetDetectSaddlePoint()
31030971522cSBarry Smith M*/
31040971522cSBarry Smith 
31058cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
31060971522cSBarry Smith {
31070971522cSBarry Smith   PetscErrorCode ierr;
31080971522cSBarry Smith   PC_FieldSplit  *jac;
31090971522cSBarry Smith 
31100971522cSBarry Smith   PetscFunctionBegin;
3111b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
31122fa5cd67SKarl Rupp 
31130971522cSBarry Smith   jac->bs                 = -1;
31140971522cSBarry Smith   jac->nsplits            = 0;
31153e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
3116e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
3117c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
3118c096484dSStefano Zampini   jac->schurscale         = -1.0;
3119fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
31207b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
3121a51937d4SCarola Kruse   jac->gkbtol             = 1e-5;
3122a51937d4SCarola Kruse   jac->gkbdelay           = 5;
3123a51937d4SCarola Kruse   jac->gkbnu              = 1;
3124a51937d4SCarola Kruse   jac->gkbmaxit           = 100;
3125de482cd7SCarola Kruse   jac->gkbmonitor         = PETSC_FALSE;
312651f519a2SBarry Smith 
31270971522cSBarry Smith   pc->data = (void*)jac;
31280971522cSBarry Smith 
31290971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
3130421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
31310971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
3132574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
31330971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
31340971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
31350971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
31360971522cSBarry Smith   pc->ops->applyrichardson = 0;
31370971522cSBarry Smith 
3138285fb4e2SStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",PCFieldSplitSchurGetSubKSP_FieldSplit);CHKERRQ(ierr);
3139bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
3140bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
3141bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
3142bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
3143bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
31446dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr);
31450971522cSBarry Smith   PetscFunctionReturn(0);
31460971522cSBarry Smith }
3147