xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision a1e3cbf9a175a5d71691ac69d3811954c1150afa)
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++) {
730ef7efd37SHong Zhang         if (jac->mat[i]) {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;
765ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
766ef7efd37SHong Zhang           for (i=0; i<nsplit; i++) {
767ef7efd37SHong Zhang             ierr = MatDestroy(&jac->Afield[1]);CHKERRQ(ierr);
768ef7efd37SHong Zhang           }
769ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
770ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
771ef7efd37SHong Zhang 
77280c96bb1SFande Kong         if (jac->offdiag_use_amat) {
773ef7efd37SHong Zhang           ierr  = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr);
77480c96bb1SFande Kong         } else {
775ef7efd37SHong Zhang           ierr  = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr);
77680c96bb1SFande Kong         }
777e52d2c62SBarry Smith       }
778e52d2c62SBarry Smith     } else {
77968dd23aaSBarry Smith       if (!jac->Afield) {
780785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
78168dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
78280c96bb1SFande Kong           if (jac->offdiag_use_amat) {
7837dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
78480c96bb1SFande Kong           } else {
7857dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
78680c96bb1SFande Kong           }
78768dd23aaSBarry Smith           ilink = ilink->next;
78868dd23aaSBarry Smith         }
78968dd23aaSBarry Smith       } else {
790ef7efd37SHong Zhang         MatReuse scall;
791ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
792ef7efd37SHong Zhang           for (i=0; i<nsplit; i++) {
793ef7efd37SHong Zhang             ierr = MatDestroy(&jac->Afield[i]);CHKERRQ(ierr);
794ef7efd37SHong Zhang           }
795ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
796ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
797ef7efd37SHong Zhang 
79868dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
79980c96bb1SFande Kong           if (jac->offdiag_use_amat) {
800ef7efd37SHong Zhang             ierr  = MatCreateSubMatrix(pc->mat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr);
80180c96bb1SFande Kong           } else {
802ef7efd37SHong Zhang             ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr);
80380c96bb1SFande Kong           }
80468dd23aaSBarry Smith           ilink = ilink->next;
80568dd23aaSBarry Smith         }
80668dd23aaSBarry Smith       }
80768dd23aaSBarry Smith     }
808e52d2c62SBarry Smith   }
80968dd23aaSBarry Smith 
8103b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
8113b224e63SBarry Smith     IS          ccis;
812c096484dSStefano Zampini     PetscBool   isspd;
8134aa3045dSJed Brown     PetscInt    rstart,rend;
814093c86ffSJed Brown     char        lscname[256];
815093c86ffSJed Brown     PetscObject LSC_L;
816ce94432eSBarry Smith 
817ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
81868dd23aaSBarry Smith 
819c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
820c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
821c096484dSStefano Zampini       ierr = MatGetOption(pc->pmat,MAT_SPD,&isspd);CHKERRQ(ierr);
822c096484dSStefano Zampini       jac->schurscale = (isspd == PETSC_TRUE) ? 1.0 : -1.0;
823c096484dSStefano Zampini     }
824c096484dSStefano Zampini 
825e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
826e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
827e6cab6aaSJed Brown 
8283b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
8293b224e63SBarry Smith     if (jac->schur) {
8300298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
831443836d0SMatthew G Knepley 
832fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
8333b224e63SBarry Smith       ilink = jac->head;
83449bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8354e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8367dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
837c84da90fSDmitry Karpeev       } else {
8387dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
839c84da90fSDmitry Karpeev       }
840fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
8413b224e63SBarry Smith       ilink = ilink->next;
84249bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8434e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8447dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
845c84da90fSDmitry Karpeev       } else {
8467dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
847c84da90fSDmitry Karpeev       }
848fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
849aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
850a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
851a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
852a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
853a7476a74SDmitry Karpeev       }
854443836d0SMatthew G Knepley       if (kspA != kspInner) {
85523ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
856443836d0SMatthew G Knepley       }
857443836d0SMatthew G Knepley       if (kspUpper != kspA) {
85823ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
859443836d0SMatthew G Knepley       }
86023ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
8613b224e63SBarry Smith     } else {
862bafc1b83SMatthew G Knepley       const char   *Dprefix;
863470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
864514bf10dSMatthew G Knepley       char         schurtestoption[256];
865bdddcaaaSMatthew G Knepley       MatNullSpace sp;
866514bf10dSMatthew G Knepley       PetscBool    flg;
867686bed4dSStefano Zampini       KSP          kspt;
8683b224e63SBarry Smith 
869a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
8703b224e63SBarry Smith       ilink = jac->head;
87149bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8724e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8737dae84e0SHong Zhang 	ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
874c84da90fSDmitry Karpeev       } else {
8757dae84e0SHong Zhang 	ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
876c84da90fSDmitry Karpeev       }
877fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
8783b224e63SBarry Smith       ilink = ilink->next;
87949bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8804e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8817dae84e0SHong Zhang 	ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
882c84da90fSDmitry Karpeev       } else {
8837dae84e0SHong Zhang 	ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
884c84da90fSDmitry Karpeev       }
885fcfd50ebSBarry Smith       ierr = ISDestroy(&ccis);CHKERRQ(ierr);
88620252d06SBarry Smith 
887f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
88820252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
88920252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
890bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
891470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
892470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
893686bed4dSStefano Zampini       ierr = MatSchurComplementGetKSP(jac->schur,&kspt);CHKERRQ(ierr);
894686bed4dSStefano Zampini       ierr = KSPSetOptionsPrefix(kspt,schurmatprefix);CHKERRQ(ierr);
895686bed4dSStefano Zampini 
896686bed4dSStefano Zampini       /* Note: this is not true in general */
897895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
89820252d06SBarry Smith       if (sp) {
89920252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
90020252d06SBarry Smith       }
90120252d06SBarry Smith 
90220252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
903c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
904514bf10dSMatthew G Knepley       if (flg) {
905514bf10dSMatthew G Knepley         DM  dmInner;
90621635b76SJed Brown         KSP kspInner;
907686bed4dSStefano Zampini         PC  pcInner;
90821635b76SJed Brown 
90921635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
9102cc093acSMatthew G. Knepley         ierr = KSPReset(kspInner);CHKERRQ(ierr);
9112cc093acSMatthew G. Knepley         ierr = KSPSetOperators(kspInner,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
91221635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
91321635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
91421635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
9152cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject) pc, 2);CHKERRQ(ierr);
91621635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
917514bf10dSMatthew G Knepley 
918514bf10dSMatthew G Knepley         /* Set DM for new solver */
919bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
92021635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
92121635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
922686bed4dSStefano Zampini 
923686bed4dSStefano Zampini         /* Defaults to PCKSP as preconditioner */
924686bed4dSStefano Zampini         ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr);
925686bed4dSStefano Zampini         ierr = PCSetType(pcInner, PCKSP);CHKERRQ(ierr);
926686bed4dSStefano Zampini         ierr = PCKSPSetKSP(pcInner, jac->head->ksp);CHKERRQ(ierr);
927514bf10dSMatthew G Knepley       } else {
92821635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
92921635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
93021635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
93121635b76SJed 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
93221635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
93321635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
93421635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
935514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
936bafc1b83SMatthew G Knepley       }
93723ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
9385a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
93997bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
94097bbdb24SBarry Smith 
941686bed4dSStefano Zampini       ierr = PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg);CHKERRQ(ierr);
942686bed4dSStefano Zampini       if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */
943686bed4dSStefano Zampini         KSP kspInner;
944686bed4dSStefano Zampini         PC  pcInner;
945686bed4dSStefano Zampini 
946686bed4dSStefano Zampini         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
947686bed4dSStefano Zampini         ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr);
948686bed4dSStefano Zampini         ierr = PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg);CHKERRQ(ierr);
949686bed4dSStefano Zampini         if (flg) {
950686bed4dSStefano Zampini           KSP ksp;
951686bed4dSStefano Zampini 
952686bed4dSStefano Zampini           ierr = PCKSPGetKSP(pcInner, &ksp);CHKERRQ(ierr);
953686bed4dSStefano Zampini           if (ksp == jac->head->ksp) {
954686bed4dSStefano Zampini             ierr = PCSetUseAmat(pcInner, PETSC_TRUE);CHKERRQ(ierr);
955686bed4dSStefano Zampini           }
956686bed4dSStefano Zampini         }
957686bed4dSStefano Zampini       }
958443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
959c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
960443836d0SMatthew G Knepley       if (flg) {
961443836d0SMatthew G Knepley         DM dmInner;
962443836d0SMatthew G Knepley 
963443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
96482f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
965422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
966443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
9672cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject) pc, 1);CHKERRQ(ierr);
9682cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject) pc, 1);CHKERRQ(ierr);
969443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
970443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
971443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
972443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
97323ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
974443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
975443836d0SMatthew G Knepley       } else {
976443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
977443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
978443836d0SMatthew G Knepley       }
979443836d0SMatthew G Knepley 
980a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
981a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
982a7476a74SDmitry Karpeev       }
983ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
984422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
98597bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
98620252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
98797bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
9887233a360SDmitry Karpeev         PC pcschur;
9897233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
9907233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
99197bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
992e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
993e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
99497bbdb24SBarry Smith       }
99523ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
99697bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
99797bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
998c096484dSStefano Zampini       /* propagate DM */
999b20b4189SMatthew G. Knepley       {
1000b20b4189SMatthew G. Knepley         DM sdm;
1001b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
1002b20b4189SMatthew G. Knepley         if (sdm) {
1003b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
1004b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
1005b20b4189SMatthew G. Knepley         }
1006b20b4189SMatthew G. Knepley       }
100797bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
100897bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
100997bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
101097bbdb24SBarry Smith     }
1011686bed4dSStefano Zampini     ierr = MatAssemblyBegin(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1012686bed4dSStefano Zampini     ierr = MatAssemblyEnd(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
101397bbdb24SBarry Smith 
10145a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
10158caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
1016519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
10173b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
1018c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
10198caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
102097bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
10215a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
10220971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
1023a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1024a51937d4SCarola Kruse     IS          ccis;
1025a51937d4SCarola Kruse     PetscInt    rstart,rend;
1026a51937d4SCarola Kruse 
1027a51937d4SCarola Kruse     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use GKB preconditioner you must have exactly 2 fields");
1028a51937d4SCarola Kruse 
1029a51937d4SCarola Kruse     ilink = jac->head;
1030a51937d4SCarola Kruse 
1031a51937d4SCarola Kruse     /* When extracting off-diagonal submatrices, we take complements from this range */
1032a51937d4SCarola Kruse     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
1033a51937d4SCarola Kruse 
1034a51937d4SCarola Kruse     ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
1035a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
1036a51937d4SCarola Kruse      ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
1037a51937d4SCarola Kruse     } else {
1038a51937d4SCarola Kruse       ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
1039a51937d4SCarola Kruse     }
1040a51937d4SCarola Kruse     ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
1041e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
1042e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->u);CHKERRQ(ierr);
1043e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->Hu);CHKERRQ(ierr);
1044e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->w2);CHKERRQ(ierr);
1045a51937d4SCarola Kruse     ilink = ilink->next;
1046a51937d4SCarola Kruse     ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
1047a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
1048a51937d4SCarola Kruse       ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
1049a51937d4SCarola Kruse     } else {
1050a51937d4SCarola Kruse       ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
1051a51937d4SCarola Kruse     }
1052a51937d4SCarola Kruse     ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
1053e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
1054e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->v);CHKERRQ(ierr);
1055e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->d);CHKERRQ(ierr);
1056e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->w1);CHKERRQ(ierr);
1057a51937d4SCarola Kruse     ierr  = MatGolubKahanComputeExplicitOperator(jac->mat[0],jac->B,jac->C,&jac->H,jac->gkbnu);CHKERRQ(ierr);
1058e071a0a4SCarola Kruse     ierr  = PetscCalloc1(jac->gkbdelay,&jac->vecz);CHKERRQ(ierr);
1059e071a0a4SCarola Kruse 
1060a51937d4SCarola Kruse     ilink = jac->head;
1061a51937d4SCarola Kruse     ierr  = KSPSetOperators(ilink->ksp,jac->H,jac->H);CHKERRQ(ierr);
1062a51937d4SCarola Kruse     if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
1063e071a0a4SCarola Kruse     /* Create gkb_monitor context */
1064de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1065de482cd7SCarola Kruse       PetscInt  tablevel;
1066de482cd7SCarola Kruse       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&jac->gkbviewer);CHKERRQ(ierr);
1067de482cd7SCarola Kruse       ierr = PetscViewerSetType(jac->gkbviewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1068de482cd7SCarola Kruse       ierr = PetscObjectGetTabLevel((PetscObject)ilink->ksp,&tablevel);CHKERRQ(ierr);
1069e071a0a4SCarola Kruse       ierr = PetscViewerASCIISetTab(jac->gkbviewer,tablevel);CHKERRQ(ierr);
1070de482cd7SCarola Kruse       ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)ilink->ksp,1);CHKERRQ(ierr);
1071de482cd7SCarola Kruse     }
10720971522cSBarry Smith   } else {
107368bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
10740971522cSBarry Smith     i     = 0;
10750971522cSBarry Smith     ilink = jac->head;
10760971522cSBarry Smith     while (ilink) {
107723ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
10780971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
10790971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
10800971522cSBarry Smith       i++;
10810971522cSBarry Smith       ilink = ilink->next;
10820971522cSBarry Smith     }
10833b224e63SBarry Smith   }
10843b224e63SBarry Smith 
1085c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
10860971522cSBarry Smith   PetscFunctionReturn(0);
10870971522cSBarry Smith }
10880971522cSBarry Smith 
10895a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
1090ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
1091ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
10929df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
10935a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) ||                               \
1094c0decd05SBarry Smith    KSPCheckSolve(ilink->ksp,pc,ilink->y)  || \
10959df09d43SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
1096ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) ||  \
1097ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
109879416396SBarry Smith 
10993b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
11003b224e63SBarry Smith {
11013b224e63SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
11023b224e63SBarry Smith   PetscErrorCode     ierr;
11033b224e63SBarry Smith   PC_FieldSplitLink  ilinkA = jac->head, ilinkD = ilinkA->next;
1104443836d0SMatthew G Knepley   KSP                kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
11053b224e63SBarry Smith 
11063b224e63SBarry Smith   PetscFunctionBegin;
1107c5d2311dSJed Brown   switch (jac->schurfactorization) {
1108c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
1109a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
1110c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1111c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1112c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11139df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1114443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1115c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11169df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1117c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1118c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11199df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1120c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1121c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11229df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1123c096484dSStefano Zampini     ierr = VecScale(ilinkD->y,jac->schurscale);CHKERRQ(ierr);
1124c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1125653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1126c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1127c5d2311dSJed Brown     break;
1128c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
1129a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
1130c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1131c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11329df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1133443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1134c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11359df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1136c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
1137c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
1138c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1139c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1140c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11419df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1142c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1143c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11449df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1145c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1146653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1147c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1148c5d2311dSJed Brown     break;
1149c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
1150a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
1151c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1152c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11539df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1154c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1155c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11569df09d43SBarry 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);
1157c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
1158c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1159c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1160c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11619df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1162443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1163c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11649df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1165c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1166653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1167c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1168c5d2311dSJed Brown     break;
1169c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
1170c238f8cdSStefano Zampini     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */
11713b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11723b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11739df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1174443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1175c0decd05SBarry Smith     ierr = KSPCheckSolve(kspLower,pc,ilinkA->y);CHKERRQ(ierr);
11769df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
11773b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
11783b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
11793b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11803b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11813b224e63SBarry Smith 
11829df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
11833b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1184c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11859df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
11863b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
11873b224e63SBarry Smith 
1188443836d0SMatthew G Knepley     if (kspUpper == kspA) {
11893b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
11903b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
11919df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1192443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1193c0decd05SBarry Smith       ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11949df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1195443836d0SMatthew G Knepley     } else {
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);
1199443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
12009df09d43SBarry Smith       ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
1201443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
1202c0decd05SBarry Smith       ierr = KSPCheckSolve(kspUpper,pc,ilinkA->z);CHKERRQ(ierr);
12039df09d43SBarry Smith       ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
1204443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
1205443836d0SMatthew G Knepley     }
1206c238f8cdSStefano Zampini     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12073b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12083b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1209c5d2311dSJed Brown   }
12103b224e63SBarry Smith   PetscFunctionReturn(0);
12113b224e63SBarry Smith }
12123b224e63SBarry Smith 
12130971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
12140971522cSBarry Smith {
12150971522cSBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
12160971522cSBarry Smith   PetscErrorCode     ierr;
12175a9f2f41SSatish Balay   PC_FieldSplitLink  ilink = jac->head;
1218939b8a20SBarry Smith   PetscInt           cnt,bs;
12190971522cSBarry Smith 
12200971522cSBarry Smith   PetscFunctionBegin;
122179416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
12221b9fc7fcSBarry Smith     if (jac->defaultsplit) {
1223939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1224ce94432eSBarry 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);
1225939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1226ce94432eSBarry 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);
12270971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
12285a9f2f41SSatish Balay       while (ilink) {
12299df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12305a9f2f41SSatish Balay         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1231c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12329df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12335a9f2f41SSatish Balay         ilink = ilink->next;
12340971522cSBarry Smith       }
12350971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
12361b9fc7fcSBarry Smith     } else {
1237efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
12385a9f2f41SSatish Balay       while (ilink) {
12395a9f2f41SSatish Balay         ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
12405a9f2f41SSatish Balay         ilink = ilink->next;
12411b9fc7fcSBarry Smith       }
12421b9fc7fcSBarry Smith     }
1243e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
1244e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1245e52d2c62SBarry Smith     /* solve on first block for first block variables */
1246e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1247e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12489df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1249e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1250c0decd05SBarry Smith     ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12519df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1252e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1253e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1254e52d2c62SBarry Smith 
1255e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
1256e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
1257e52d2c62SBarry Smith     ilink = ilink->next;
1258e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
1259e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1260e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1261e52d2c62SBarry Smith 
1262e52d2c62SBarry Smith     /* solve on second block variables */
12639df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1264e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1265c0decd05SBarry Smith     ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12669df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1267e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1268e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
126916913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
127079416396SBarry Smith     if (!jac->w1) {
127179416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
127279416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
127379416396SBarry Smith     }
1274efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
12755a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
12763e197d65SBarry Smith     cnt  = 1;
12775a9f2f41SSatish Balay     while (ilink->next) {
12785a9f2f41SSatish Balay       ilink = ilink->next;
12793e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
12803e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
12813e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
12823e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12833e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12849df09d43SBarry Smith       ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12853e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1286c0decd05SBarry Smith       ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12879df09d43SBarry Smith       ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12883e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12893e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12903e197d65SBarry Smith     }
129151f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
129211755939SBarry Smith       cnt -= 2;
129351f519a2SBarry Smith       while (ilink->previous) {
129451f519a2SBarry Smith         ilink = ilink->previous;
129511755939SBarry Smith         /* compute the residual only over the part of the vector needed */
129611755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
129711755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
129811755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
129911755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
13009df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
130111755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1302c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
13039df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
130411755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
130511755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
130651f519a2SBarry Smith       }
130711755939SBarry Smith     }
1308ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
13090971522cSBarry Smith   PetscFunctionReturn(0);
13100971522cSBarry Smith }
13110971522cSBarry Smith 
1312a51937d4SCarola Kruse 
1313a51937d4SCarola Kruse static PetscErrorCode PCApply_FieldSplit_GKB(PC pc,Vec x,Vec y)
1314a51937d4SCarola Kruse {
1315a51937d4SCarola Kruse   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1316a51937d4SCarola Kruse   PetscErrorCode     ierr;
1317a51937d4SCarola Kruse   PC_FieldSplitLink  ilinkA = jac->head,ilinkD = ilinkA->next;
1318a51937d4SCarola Kruse   KSP                ksp = ilinkA->ksp;
1319de482cd7SCarola Kruse   Vec                u,v,Hu,d,work1,work2;
1320e071a0a4SCarola Kruse   PetscScalar        alpha,z,nrmz2,*vecz;
1321e071a0a4SCarola Kruse   PetscReal          lowbnd,nu,beta;
1322a51937d4SCarola Kruse   PetscInt           j,iterGKB;
1323a51937d4SCarola Kruse 
1324a51937d4SCarola Kruse   PetscFunctionBegin;
1325a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1326a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1327de482cd7SCarola Kruse   ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1328a51937d4SCarola Kruse   ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1329e071a0a4SCarola Kruse 
1330e071a0a4SCarola Kruse   u     = jac->u;
1331e071a0a4SCarola Kruse   v     = jac->v;
1332e071a0a4SCarola Kruse   Hu    = jac->Hu;
1333e071a0a4SCarola Kruse   d     = jac->d;
1334e071a0a4SCarola Kruse   work1 = jac->w1;
1335e071a0a4SCarola Kruse   work2 = jac->w2;
1336e071a0a4SCarola Kruse   vecz  = jac->vecz;
1337a51937d4SCarola Kruse 
1338a51937d4SCarola Kruse   /* Change RHS to comply with matrix regularization H = A + nu*B*B' */
1339a51937d4SCarola Kruse   /* Add q = q + nu*B*b */
1340a51937d4SCarola Kruse   if (jac->gkbnu) {
1341a51937d4SCarola Kruse     nu = jac->gkbnu;
1342de482cd7SCarola Kruse     ierr = VecScale(ilinkD->x,jac->gkbnu);CHKERRQ(ierr);
1343de482cd7SCarola Kruse     ierr = MatMultAdd(jac->B,ilinkD->x,ilinkA->x,ilinkA->x);CHKERRQ(ierr);            /* q = q + nu*B*b */
1344a51937d4SCarola Kruse   } else {
1345a51937d4SCarola Kruse     /* Situation when no augmented Lagrangian is used. Then we set inner  */
1346a51937d4SCarola Kruse     /* matrix N = I in [Ar13], and thus nu = 1.                           */
1347a51937d4SCarola Kruse     nu = 1;
1348a51937d4SCarola Kruse   }
1349a51937d4SCarola Kruse 
1350a51937d4SCarola Kruse   /* Transform rhs from [q,tilde{b}] to [0,b] */
1351de482cd7SCarola Kruse   ierr = PetscLogEventBegin(ilinkA->event,ksp,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1352de482cd7SCarola Kruse   ierr = KSPSolve(ksp,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1353c0decd05SBarry Smith   ierr = KSPCheckSolve(ksp,pc,ilinkA->y);CHKERRQ(ierr);
1354de482cd7SCarola Kruse   ierr = PetscLogEventEnd(ilinkA->event,ksp,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1355a51937d4SCarola Kruse   ierr = MatMultHermitianTranspose(jac->B,ilinkA->y,work1);CHKERRQ(ierr);
135692c1e38eSCarola Kruse   ierr = VecAXPBY(work1,1.0/nu,-1.0,ilinkD->x);CHKERRQ(ierr);            /* c = b - B'*x        */
1357a51937d4SCarola Kruse 
1358a51937d4SCarola Kruse   /* First step of algorithm */
1359de482cd7SCarola Kruse   ierr  = VecNorm(work1,NORM_2,&beta);CHKERRQ(ierr);                   /* beta = sqrt(nu*c'*c)*/
1360e071a0a4SCarola Kruse   KSPCheckDot(ksp,beta);
1361de482cd7SCarola Kruse   beta  = PetscSqrtScalar(nu)*beta;
136292c1e38eSCarola Kruse   ierr  = VecAXPBY(v,nu/beta,0.0,work1);CHKERRQ(ierr);                   /* v = nu/beta *c      */
1363a51937d4SCarola Kruse   ierr  = MatMult(jac->B,v,work2);CHKERRQ(ierr);                       /* u = H^{-1}*B*v      */
1364a51937d4SCarola Kruse   ierr  = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1365a51937d4SCarola Kruse   ierr  = KSPSolve(ksp,work2,u);CHKERRQ(ierr);
1366c0decd05SBarry Smith   ierr  = KSPCheckSolve(ksp,pc,u);CHKERRQ(ierr);
1367a51937d4SCarola Kruse   ierr  = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1368a51937d4SCarola Kruse   ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);                          /* alpha = u'*H*u      */
1369a51937d4SCarola Kruse   ierr  = VecDot(Hu,u,&alpha);CHKERRQ(ierr);
1370e071a0a4SCarola Kruse   KSPCheckDot(ksp,alpha);
1371e071a0a4SCarola Kruse   if (PetscRealPart(alpha) <= 0.0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_NOT_CONVERGED,"GKB preconditioner diverged, H is not positive definite");
1372de482cd7SCarola Kruse   alpha = PetscSqrtScalar(PetscAbsScalar(alpha));
137392c1e38eSCarola Kruse   ierr  = VecScale(u,1.0/alpha);CHKERRQ(ierr);
137492c1e38eSCarola Kruse   ierr  = VecAXPBY(d,1.0/alpha,0.0,v);CHKERRQ(ierr);                       /* v = nu/beta *c      */
1375de482cd7SCarola Kruse 
1376a51937d4SCarola Kruse   z = beta/alpha;
1377a51937d4SCarola Kruse   vecz[1] = z;
1378a51937d4SCarola Kruse 
1379de482cd7SCarola Kruse   /* Computation of first iterate x(1) and p(1) */
1380a51937d4SCarola Kruse   ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr);
1381a51937d4SCarola Kruse   ierr = VecCopy(d,ilinkD->y);CHKERRQ(ierr);
1382a51937d4SCarola Kruse   ierr = VecScale(ilinkD->y,-z);CHKERRQ(ierr);
1383a51937d4SCarola Kruse 
1384a51937d4SCarola Kruse   iterGKB = 1; lowbnd = 2*jac->gkbtol;
1385de482cd7SCarola Kruse   if (jac->gkbmonitor) {
1386de482cd7SCarola Kruse       ierr = PetscViewerASCIIPrintf(jac->gkbviewer,"%3D GKB Lower bound estimate %14.12e\n",iterGKB,lowbnd);CHKERRQ(ierr);
1387de482cd7SCarola Kruse   }
1388de482cd7SCarola Kruse 
1389a51937d4SCarola Kruse   while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) {
1390a51937d4SCarola Kruse     iterGKB += 1;
1391e071a0a4SCarola Kruse     ierr  = MatMultHermitianTranspose(jac->B,u,work1);CHKERRQ(ierr); /* v <- nu*(B'*u-alpha/nu*v) */
1392e071a0a4SCarola Kruse     ierr  = VecAXPBY(v,nu,-alpha,work1);CHKERRQ(ierr);
1393e071a0a4SCarola Kruse     ierr  = VecNorm(v,NORM_2,&beta);CHKERRQ(ierr);                   /* beta = sqrt(nu)*v'*v      */
1394de482cd7SCarola Kruse     beta  = beta/PetscSqrtScalar(nu);
139592c1e38eSCarola Kruse     ierr  = VecScale(v,1.0/beta);CHKERRQ(ierr);
1396e071a0a4SCarola Kruse     ierr  = MatMult(jac->B,v,work2);CHKERRQ(ierr);                  /* u <- H^{-1}*(B*v-beta*H*u) */
1397a51937d4SCarola Kruse     ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);
1398a51937d4SCarola Kruse     ierr  = VecAXPY(work2,-beta,Hu);CHKERRQ(ierr);
1399a51937d4SCarola Kruse     ierr  = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1400a51937d4SCarola Kruse     ierr  = KSPSolve(ksp,work2,u);CHKERRQ(ierr);
1401c0decd05SBarry Smith     ierr  = KSPCheckSolve(ksp,pc,u);CHKERRQ(ierr);
1402a51937d4SCarola Kruse     ierr  = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1403a51937d4SCarola Kruse     ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);                      /* alpha = u'*H*u            */
1404a51937d4SCarola Kruse     ierr  = VecDot(Hu,u,&alpha);CHKERRQ(ierr);
1405e071a0a4SCarola Kruse     KSPCheckDot(ksp,alpha);
1406e071a0a4SCarola Kruse     if (PetscRealPart(alpha) <= 0.0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_NOT_CONVERGED,"GKB preconditioner diverged, H is not positive definite");
1407de482cd7SCarola Kruse     alpha = PetscSqrtScalar(PetscAbsScalar(alpha));
140892c1e38eSCarola Kruse     ierr  = VecScale(u,1.0/alpha);CHKERRQ(ierr);
1409a51937d4SCarola Kruse 
1410e071a0a4SCarola Kruse     z = -beta/alpha*z;                                            /* z <- beta/alpha*z     */
1411a51937d4SCarola Kruse     vecz[0] = z;
1412a51937d4SCarola Kruse 
1413a51937d4SCarola Kruse     /* Computation of new iterate x(i+1) and p(i+1) */
141492c1e38eSCarola Kruse     ierr = VecAXPBY(d,1.0/alpha,-beta/alpha,v);CHKERRQ(ierr);       /* d = (v-beta*d)/alpha */
1415a51937d4SCarola Kruse     ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr);                  /* r = r + z*u          */
1416a51937d4SCarola Kruse     ierr = VecAXPY(ilinkD->y,-z,d);CHKERRQ(ierr);                 /* p = p - z*d          */
1417de482cd7SCarola Kruse     ierr = MatMult(jac->H,ilinkA->y,Hu);CHKERRQ(ierr);            /* ||u||_H = u'*H*u     */
1418a51937d4SCarola Kruse     ierr = VecDot(Hu,ilinkA->y,&nrmz2);CHKERRQ(ierr);
1419a51937d4SCarola Kruse 
1420a51937d4SCarola Kruse     /* Compute Lower Bound estimate */
1421a51937d4SCarola Kruse     if (iterGKB > jac->gkbdelay) {
1422a51937d4SCarola Kruse       lowbnd = 0.0;
1423a51937d4SCarola Kruse       for (j=0; j<jac->gkbdelay; j++) {
1424a51937d4SCarola Kruse         lowbnd += PetscAbsScalar(vecz[j]*vecz[j]);
1425a51937d4SCarola Kruse       }
1426a51937d4SCarola Kruse       lowbnd = PetscSqrtScalar(lowbnd/PetscAbsScalar(nrmz2));
1427a51937d4SCarola Kruse     }
1428a51937d4SCarola Kruse 
1429a51937d4SCarola Kruse     for (j=0; j<jac->gkbdelay-1; j++) {
1430a51937d4SCarola Kruse       vecz[jac->gkbdelay-j-1] = vecz[jac->gkbdelay-j-2];
1431a51937d4SCarola Kruse     }
1432de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1433de482cd7SCarola Kruse       ierr = PetscViewerASCIIPrintf(jac->gkbviewer,"%3D GKB Lower bound estimate %14.12e\n",iterGKB,lowbnd);CHKERRQ(ierr);
1434de482cd7SCarola Kruse     }
1435a51937d4SCarola Kruse   }
1436a51937d4SCarola Kruse 
1437a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1438de482cd7SCarola Kruse   ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1439a29b4eb7SJunchao Zhang   ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1440a51937d4SCarola Kruse   ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1441a51937d4SCarola Kruse 
1442a51937d4SCarola Kruse   PetscFunctionReturn(0);
1443a51937d4SCarola Kruse }
1444a51937d4SCarola Kruse 
1445a51937d4SCarola Kruse 
1446421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1447ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1448ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
14499df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1450421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) ||                  \
1451c0decd05SBarry Smith    KSPCheckSolve(ilink->ksp,pc,ilink->x) || \
1452c0decd05SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) ||   \
1453ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1454ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1455421e10b8SBarry Smith 
1456421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1457421e10b8SBarry Smith {
1458421e10b8SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1459421e10b8SBarry Smith   PetscErrorCode     ierr;
1460421e10b8SBarry Smith   PC_FieldSplitLink  ilink = jac->head;
1461939b8a20SBarry Smith   PetscInt           bs;
1462421e10b8SBarry Smith 
1463421e10b8SBarry Smith   PetscFunctionBegin;
1464421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1465421e10b8SBarry Smith     if (jac->defaultsplit) {
1466939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1467ce94432eSBarry 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);
1468939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1469ce94432eSBarry 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);
1470421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1471421e10b8SBarry Smith       while (ilink) {
14729df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1473421e10b8SBarry Smith         ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1474c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
14759df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1476421e10b8SBarry Smith         ilink = ilink->next;
1477421e10b8SBarry Smith       }
1478421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1479421e10b8SBarry Smith     } else {
1480421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1481421e10b8SBarry Smith       while (ilink) {
1482421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1483421e10b8SBarry Smith         ilink = ilink->next;
1484421e10b8SBarry Smith       }
1485421e10b8SBarry Smith     }
1486421e10b8SBarry Smith   } else {
1487421e10b8SBarry Smith     if (!jac->w1) {
1488421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1489421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1490421e10b8SBarry Smith     }
1491421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1492421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1493421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1494421e10b8SBarry Smith       while (ilink->next) {
1495421e10b8SBarry Smith         ilink = ilink->next;
14969989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1497421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1498421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1499421e10b8SBarry Smith       }
1500421e10b8SBarry Smith       while (ilink->previous) {
1501421e10b8SBarry Smith         ilink = ilink->previous;
15029989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1503421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1504421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1505421e10b8SBarry Smith       }
1506421e10b8SBarry Smith     } else {
1507421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1508421e10b8SBarry Smith         ilink = ilink->next;
1509421e10b8SBarry Smith       }
1510421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1511421e10b8SBarry Smith       while (ilink->previous) {
1512421e10b8SBarry Smith         ilink = ilink->previous;
15139989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1514421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1515421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1516421e10b8SBarry Smith       }
1517421e10b8SBarry Smith     }
1518421e10b8SBarry Smith   }
1519421e10b8SBarry Smith   PetscFunctionReturn(0);
1520421e10b8SBarry Smith }
1521421e10b8SBarry Smith 
1522574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
15230971522cSBarry Smith {
15240971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
15250971522cSBarry Smith   PetscErrorCode    ierr;
15265a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
15270971522cSBarry Smith 
15280971522cSBarry Smith   PetscFunctionBegin;
15295a9f2f41SSatish Balay   while (ilink) {
1530f5f0d762SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1531fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1532fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1533443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1534fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1535fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1536b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1537f5f0d762SBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1538f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
1539f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
15405a9f2f41SSatish Balay     next  = ilink->next;
1541f5f0d762SBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
15425a9f2f41SSatish Balay     ilink = next;
15430971522cSBarry Smith   }
1544f5f0d762SBarry Smith   jac->head = NULL;
154505b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1546574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1547574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1548574deadeSBarry Smith   } else if (jac->mat) {
15490298fd71SBarry Smith     jac->mat = NULL;
1550574deadeSBarry Smith   }
155197bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
155268dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
1553f5f0d762SBarry Smith   jac->nsplits = 0;
15546bf464f9SBarry Smith   ierr = VecDestroy(&jac->w1);CHKERRQ(ierr);
15556bf464f9SBarry Smith   ierr = VecDestroy(&jac->w2);CHKERRQ(ierr);
15566bf464f9SBarry Smith   ierr = MatDestroy(&jac->schur);CHKERRQ(ierr);
1557a7476a74SDmitry Karpeev   ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
15586bf464f9SBarry Smith   ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
15596bf464f9SBarry Smith   ierr = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1560d78dad28SBarry Smith   ierr = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
15616bf464f9SBarry Smith   ierr = MatDestroy(&jac->B);CHKERRQ(ierr);
15626bf464f9SBarry Smith   ierr = MatDestroy(&jac->C);CHKERRQ(ierr);
1563a51937d4SCarola Kruse   ierr = MatDestroy(&jac->H);CHKERRQ(ierr);
1564e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->u);CHKERRQ(ierr);
1565e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->v);CHKERRQ(ierr);
1566e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->Hu);CHKERRQ(ierr);
1567e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->d);CHKERRQ(ierr);
1568e071a0a4SCarola Kruse   ierr = PetscFree(jac->vecz);CHKERRQ(ierr);
1569de482cd7SCarola Kruse   ierr = PetscViewerDestroy(&jac->gkbviewer);CHKERRQ(ierr);
15706dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1571574deadeSBarry Smith   PetscFunctionReturn(0);
1572574deadeSBarry Smith }
1573574deadeSBarry Smith 
1574574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1575574deadeSBarry Smith {
1576574deadeSBarry Smith   PetscErrorCode    ierr;
1577574deadeSBarry Smith 
1578574deadeSBarry Smith   PetscFunctionBegin;
1579574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1580c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1581285fb4e2SStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",NULL);CHKERRQ(ierr);
1582bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1583bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1584bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1585bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1586bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
158729f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
158837a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1589bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
15906dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr);
15910971522cSBarry Smith   PetscFunctionReturn(0);
15920971522cSBarry Smith }
15930971522cSBarry Smith 
15944416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
15950971522cSBarry Smith {
15961b9fc7fcSBarry Smith   PetscErrorCode  ierr;
15976c924f48SJed Brown   PetscInt        bs;
15987b752e3dSPatrick Sanan   PetscBool       flg;
15999dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
16003b224e63SBarry Smith   PCCompositeType ctype;
16011b9fc7fcSBarry Smith 
16020971522cSBarry Smith   PetscFunctionBegin;
1603e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
16044ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
160551f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
160651f519a2SBarry Smith   if (flg) {
160751f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
160851f519a2SBarry Smith   }
16092686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
16102686e3e9SMatthew 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);
16112686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
16122686e3e9SMatthew 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);
16137b752e3dSPatrick 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);
16147b752e3dSPatrick Sanan   ierr = PCFieldSplitSetDetectSaddlePoint(pc,jac->detect);CHKERRQ(ierr); /* Sets split type and Schur PC type */
16153b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
16163b224e63SBarry Smith   if (flg) {
16173b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
16183b224e63SBarry Smith   }
1619c30613efSMatthew Knepley   /* Only setup fields once */
1620c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1621d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1622d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
16236c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
16246c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1625d32f9abdSBarry Smith   }
1626c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1627c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1628c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
16290298fd71SBarry 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);
163029f8a81cSJed 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);
1631c096484dSStefano Zampini     ierr = PetscOptionsScalar("-pc_fieldsplit_schur_scale","Scale Schur complement","PCFieldSplitSetSchurScale",jac->schurscale,&jac->schurscale,NULL);CHKERRQ(ierr);
1632a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1633a51937d4SCarola Kruse     ierr = PetscOptionsReal("-pc_fieldsplit_gkb_tol","The tolerance for the lower bound stopping criterion","PCFieldSplitGKBTol",jac->gkbtol,&jac->gkbtol,NULL);CHKERRQ(ierr);
1634a51937d4SCarola Kruse     ierr = PetscOptionsInt("-pc_fieldsplit_gkb_delay","The delay value for lower bound criterion","PCFieldSplitGKBDelay",jac->gkbdelay,&jac->gkbdelay,NULL);CHKERRQ(ierr);
1635a51937d4SCarola Kruse     ierr = PetscOptionsReal("-pc_fieldsplit_gkb_nu","Parameter in augmented Lagrangian approach","PCFieldSplitGKBNu",jac->gkbnu,&jac->gkbnu,NULL);CHKERRQ(ierr);
1636e071a0a4SCarola Kruse     if (jac->gkbnu < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nu cannot be less than 0: value %f",jac->gkbnu);
1637a51937d4SCarola Kruse     ierr = PetscOptionsInt("-pc_fieldsplit_gkb_maxit","Maximum allowed number of iterations","PCFieldSplitGKBMaxit",jac->gkbmaxit,&jac->gkbmaxit,NULL);CHKERRQ(ierr);
1638de482cd7SCarola Kruse     ierr = PetscOptionsBool("-pc_fieldsplit_gkb_monitor","Prints number of GKB iterations and error","PCFieldSplitGKB",jac->gkbmonitor,&jac->gkbmonitor,NULL);CHKERRQ(ierr);
1639c5d2311dSJed Brown   }
16401b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
16410971522cSBarry Smith   PetscFunctionReturn(0);
16420971522cSBarry Smith }
16430971522cSBarry Smith 
16440971522cSBarry Smith /*------------------------------------------------------------------------------------*/
16450971522cSBarry Smith 
16461e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
16470971522cSBarry Smith {
164897bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
16490971522cSBarry Smith   PetscErrorCode    ierr;
16505a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
165169a612a9SBarry Smith   char              prefix[128];
16525d4c12cdSJungho Lee   PetscInt          i;
16530971522cSBarry Smith 
16540971522cSBarry Smith   PetscFunctionBegin;
16556c924f48SJed Brown   if (jac->splitdefined) {
16566c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
16576c924f48SJed Brown     PetscFunctionReturn(0);
16586c924f48SJed Brown   }
165951f519a2SBarry Smith   for (i=0; i<n; i++) {
1660e32f2f54SBarry 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);
1661e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
166251f519a2SBarry Smith   }
1663b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1664a04f6461SBarry Smith   if (splitname) {
1665db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1666a04f6461SBarry Smith   } else {
1667785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1668a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1669a04f6461SBarry Smith   }
16709df09d43SBarry 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 */
1671785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
1672580bdb30SBarry Smith   ierr = PetscArraycpy(ilink->fields,fields,n);CHKERRQ(ierr);
1673785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
1674580bdb30SBarry Smith   ierr = PetscArraycpy(ilink->fields_col,fields_col,n);CHKERRQ(ierr);
16752fa5cd67SKarl Rupp 
16765a9f2f41SSatish Balay   ilink->nfields = n;
16770298fd71SBarry Smith   ilink->next    = NULL;
1678ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1679422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
168020252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
16815a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
16829005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
168369a612a9SBarry Smith 
16848caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
16855a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
16860971522cSBarry Smith 
16870971522cSBarry Smith   if (!next) {
16885a9f2f41SSatish Balay     jac->head       = ilink;
16890298fd71SBarry Smith     ilink->previous = NULL;
16900971522cSBarry Smith   } else {
16910971522cSBarry Smith     while (next->next) {
16920971522cSBarry Smith       next = next->next;
16930971522cSBarry Smith     }
16945a9f2f41SSatish Balay     next->next      = ilink;
169551f519a2SBarry Smith     ilink->previous = next;
16960971522cSBarry Smith   }
16970971522cSBarry Smith   jac->nsplits++;
16980971522cSBarry Smith   PetscFunctionReturn(0);
16990971522cSBarry Smith }
17000971522cSBarry Smith 
1701285fb4e2SStefano Zampini static PetscErrorCode  PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
1702285fb4e2SStefano Zampini {
1703285fb4e2SStefano Zampini   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1704285fb4e2SStefano Zampini   PetscErrorCode ierr;
1705285fb4e2SStefano Zampini 
1706285fb4e2SStefano Zampini   PetscFunctionBegin;
1707285fb4e2SStefano Zampini   *subksp = NULL;
1708285fb4e2SStefano Zampini   if (n) *n = 0;
1709285fb4e2SStefano Zampini   if (jac->type == PC_COMPOSITE_SCHUR) {
1710285fb4e2SStefano Zampini     PetscInt nn;
1711285fb4e2SStefano Zampini 
1712285fb4e2SStefano Zampini     if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()");
1713285fb4e2SStefano Zampini     if (jac->nsplits != 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unexpected number of splits %D != 2",jac->nsplits);
1714285fb4e2SStefano Zampini     nn   = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0);
1715285fb4e2SStefano Zampini     ierr = PetscMalloc1(nn,subksp);CHKERRQ(ierr);
1716285fb4e2SStefano Zampini     (*subksp)[0] = jac->head->ksp;
1717285fb4e2SStefano Zampini     (*subksp)[1] = jac->kspschur;
1718285fb4e2SStefano Zampini     if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper;
1719285fb4e2SStefano Zampini     if (n) *n = nn;
1720285fb4e2SStefano Zampini   }
1721285fb4e2SStefano Zampini   PetscFunctionReturn(0);
1722285fb4e2SStefano Zampini }
1723285fb4e2SStefano Zampini 
17241e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1725e69d4d44SBarry Smith {
1726e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1727e69d4d44SBarry Smith   PetscErrorCode ierr;
1728e69d4d44SBarry Smith 
1729e69d4d44SBarry Smith   PetscFunctionBegin;
173034a3b412SBarry Smith   if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
1731785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1732e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
17332fa5cd67SKarl Rupp 
1734e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
173513e0d083SBarry Smith   if (n) *n = jac->nsplits;
1736e69d4d44SBarry Smith   PetscFunctionReturn(0);
1737e69d4d44SBarry Smith }
17380971522cSBarry Smith 
17391e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
17400971522cSBarry Smith {
17410971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
17420971522cSBarry Smith   PetscErrorCode    ierr;
17430971522cSBarry Smith   PetscInt          cnt   = 0;
17445a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
17450971522cSBarry Smith 
17460971522cSBarry Smith   PetscFunctionBegin;
1747785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
17485a9f2f41SSatish Balay   while (ilink) {
17495a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
17505a9f2f41SSatish Balay     ilink            = ilink->next;
17510971522cSBarry Smith   }
17525d480477SMatthew 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);
175313e0d083SBarry Smith   if (n) *n = jac->nsplits;
17540971522cSBarry Smith   PetscFunctionReturn(0);
17550971522cSBarry Smith }
17560971522cSBarry Smith 
17576dbb499eSCian Wilson /*@C
17586dbb499eSCian Wilson     PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS.
17596dbb499eSCian Wilson 
17606dbb499eSCian Wilson     Input Parameters:
17616dbb499eSCian Wilson +   pc  - the preconditioner context
1762a2b725a8SWilliam Gropp -   is - the index set that defines the indices to which the fieldsplit is to be restricted
17636dbb499eSCian Wilson 
17646dbb499eSCian Wilson     Level: advanced
17656dbb499eSCian Wilson 
17666dbb499eSCian Wilson @*/
17676dbb499eSCian Wilson PetscErrorCode  PCFieldSplitRestrictIS(PC pc,IS isy)
17686dbb499eSCian Wilson {
17696dbb499eSCian Wilson   PetscErrorCode ierr;
17706dbb499eSCian Wilson 
17716dbb499eSCian Wilson   PetscFunctionBegin;
17726dbb499eSCian Wilson   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
17736dbb499eSCian Wilson   PetscValidHeaderSpecific(isy,IS_CLASSID,2);
17740246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr);
17756dbb499eSCian Wilson   PetscFunctionReturn(0);
17766dbb499eSCian Wilson }
17776dbb499eSCian Wilson 
17786dbb499eSCian Wilson 
17796dbb499eSCian Wilson static PetscErrorCode  PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
17806dbb499eSCian Wilson {
17816dbb499eSCian Wilson   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
17826dbb499eSCian Wilson   PetscErrorCode    ierr;
17836dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
17846dbb499eSCian Wilson   PetscInt          localsize,size,sizez,i;
17856dbb499eSCian Wilson   const PetscInt    *ind, *indz;
17866dbb499eSCian Wilson   PetscInt          *indc, *indcz;
17876dbb499eSCian Wilson   PetscBool         flg;
17886dbb499eSCian Wilson 
17896dbb499eSCian Wilson   PetscFunctionBegin;
17906dbb499eSCian Wilson   ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr);
17916dbb499eSCian Wilson   ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr);
17926dbb499eSCian Wilson   size -= localsize;
17936dbb499eSCian Wilson   while(ilink) {
17946dbb499eSCian Wilson     IS isrl,isr;
17951c7cfba8SBarry Smith     PC subpc;
17966dbb499eSCian Wilson     ierr          = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
17976dbb499eSCian Wilson     ierr          = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr);
17986dbb499eSCian Wilson     ierr          = PetscMalloc1(localsize,&indc);CHKERRQ(ierr);
17996dbb499eSCian Wilson     ierr          = ISGetIndices(isrl,&ind);CHKERRQ(ierr);
1800580bdb30SBarry Smith     ierr          = PetscArraycpy(indc,ind,localsize);CHKERRQ(ierr);
18016dbb499eSCian Wilson     ierr          = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr);
18026dbb499eSCian Wilson     ierr          = ISDestroy(&isrl);CHKERRQ(ierr);
18036dbb499eSCian Wilson     for (i=0; i<localsize; i++) *(indc+i) += size;
18046dbb499eSCian Wilson     ierr          = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr);
18056dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
18066dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
18076dbb499eSCian Wilson     ilink->is     = isr;
18086dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
18096dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
18106dbb499eSCian Wilson     ilink->is_col = isr;
18116dbb499eSCian Wilson     ierr          = ISDestroy(&isr);CHKERRQ(ierr);
18126dbb499eSCian Wilson     ierr          = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr);
18136dbb499eSCian Wilson     ierr          = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr);
18146dbb499eSCian Wilson     if(flg) {
18156dbb499eSCian Wilson       IS iszl,isz;
18166dbb499eSCian Wilson       MPI_Comm comm;
18176dbb499eSCian Wilson       ierr   = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr);
18186dbb499eSCian Wilson       comm   = PetscObjectComm((PetscObject)ilink->is);
18196dbb499eSCian Wilson       ierr   = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr);
18206dbb499eSCian Wilson       ierr   = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr);
18216dbb499eSCian Wilson       sizez -= localsize;
18226dbb499eSCian Wilson       ierr   = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr);
18236dbb499eSCian Wilson       ierr   = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr);
18246dbb499eSCian Wilson       ierr   = ISGetIndices(iszl,&indz);CHKERRQ(ierr);
1825580bdb30SBarry Smith       ierr   = PetscArraycpy(indcz,indz,localsize);CHKERRQ(ierr);
18266dbb499eSCian Wilson       ierr   = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr);
18276dbb499eSCian Wilson       ierr   = ISDestroy(&iszl);CHKERRQ(ierr);
18286dbb499eSCian Wilson       for (i=0; i<localsize; i++) *(indcz+i) += sizez;
18296dbb499eSCian Wilson       ierr   = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr);
18306dbb499eSCian Wilson       ierr   = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr);
18316dbb499eSCian Wilson       ierr   = ISDestroy(&isz);CHKERRQ(ierr);
18326dbb499eSCian Wilson     }
18336dbb499eSCian Wilson     next = ilink->next;
18346dbb499eSCian Wilson     ilink = next;
18356dbb499eSCian Wilson   }
18366dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
18376dbb499eSCian Wilson   PetscFunctionReturn(0);
18386dbb499eSCian Wilson }
18396dbb499eSCian Wilson 
18401e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1841704ba839SBarry Smith {
1842704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1843704ba839SBarry Smith   PetscErrorCode    ierr;
1844704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1845704ba839SBarry Smith   char              prefix[128];
1846704ba839SBarry Smith 
1847704ba839SBarry Smith   PetscFunctionBegin;
18486c924f48SJed Brown   if (jac->splitdefined) {
18496c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
18506c924f48SJed Brown     PetscFunctionReturn(0);
18516c924f48SJed Brown   }
1852b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1853a04f6461SBarry Smith   if (splitname) {
1854db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1855a04f6461SBarry Smith   } else {
1856785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1857b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1858a04f6461SBarry Smith   }
18599df09d43SBarry 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 */
18601ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1861b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1862b5787286SJed Brown   ilink->is     = is;
1863b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1864b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1865b5787286SJed Brown   ilink->is_col = is;
18660298fd71SBarry Smith   ilink->next   = NULL;
1867ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1868422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
186920252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1870704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
18719005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1872704ba839SBarry Smith 
18738caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1874704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1875704ba839SBarry Smith 
1876704ba839SBarry Smith   if (!next) {
1877704ba839SBarry Smith     jac->head       = ilink;
18780298fd71SBarry Smith     ilink->previous = NULL;
1879704ba839SBarry Smith   } else {
1880704ba839SBarry Smith     while (next->next) {
1881704ba839SBarry Smith       next = next->next;
1882704ba839SBarry Smith     }
1883704ba839SBarry Smith     next->next      = ilink;
1884704ba839SBarry Smith     ilink->previous = next;
1885704ba839SBarry Smith   }
1886704ba839SBarry Smith   jac->nsplits++;
1887704ba839SBarry Smith   PetscFunctionReturn(0);
1888704ba839SBarry Smith }
1889704ba839SBarry Smith 
189094ef8ddeSSatish Balay /*@C
18910971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
18920971522cSBarry Smith 
1893ad4df100SBarry Smith     Logically Collective on PC
18940971522cSBarry Smith 
18950971522cSBarry Smith     Input Parameters:
18960971522cSBarry Smith +   pc  - the preconditioner context
18970298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
18980971522cSBarry Smith .   n - the number of fields in this split
1899db4c96c1SJed Brown -   fields - the fields in this split
19000971522cSBarry Smith 
19010971522cSBarry Smith     Level: intermediate
19020971522cSBarry Smith 
190395452b02SPatrick Sanan     Notes:
190495452b02SPatrick Sanan     Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1905d32f9abdSBarry Smith 
19067287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1907d32f9abdSBarry 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
1908d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1909d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1910d32f9abdSBarry Smith 
1911db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1912db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1913db4c96c1SJed Brown 
19145d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
19155d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
19165d4c12cdSJungho Lee      available when this routine is called.
19175d4c12cdSJungho Lee 
1918d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
19190971522cSBarry Smith 
19200971522cSBarry Smith @*/
19215d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
19220971522cSBarry Smith {
19234ac538c5SBarry Smith   PetscErrorCode ierr;
19240971522cSBarry Smith 
19250971522cSBarry Smith   PetscFunctionBegin;
19260700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1927db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1928ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1929db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
19300246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
19310971522cSBarry Smith   PetscFunctionReturn(0);
19320971522cSBarry Smith }
19330971522cSBarry Smith 
1934c84da90fSDmitry Karpeev /*@
1935c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1936c84da90fSDmitry Karpeev 
1937c84da90fSDmitry Karpeev     Logically Collective on PC
1938c84da90fSDmitry Karpeev 
1939c84da90fSDmitry Karpeev     Input Parameters:
1940c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1941c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1942c84da90fSDmitry Karpeev 
19439506b623SDmitry Karpeev     Options Database:
19449506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1945c84da90fSDmitry Karpeev 
1946c84da90fSDmitry Karpeev     Level: intermediate
1947c84da90fSDmitry Karpeev 
1948c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1949c84da90fSDmitry Karpeev 
1950c84da90fSDmitry Karpeev @*/
1951c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1952c84da90fSDmitry Karpeev {
1953c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1954c84da90fSDmitry Karpeev   PetscBool      isfs;
1955c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1956c84da90fSDmitry Karpeev 
1957c84da90fSDmitry Karpeev   PetscFunctionBegin;
1958c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1959c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1960c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1961c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1962c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1963c84da90fSDmitry Karpeev }
1964c84da90fSDmitry Karpeev 
1965c84da90fSDmitry Karpeev /*@
1966c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1967c84da90fSDmitry Karpeev 
1968c84da90fSDmitry Karpeev     Logically Collective on PC
1969c84da90fSDmitry Karpeev 
1970c84da90fSDmitry Karpeev     Input Parameters:
1971c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1972c84da90fSDmitry Karpeev 
1973c84da90fSDmitry Karpeev     Output Parameters:
1974c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1975c84da90fSDmitry Karpeev 
1976c84da90fSDmitry Karpeev 
1977c84da90fSDmitry Karpeev     Level: intermediate
1978c84da90fSDmitry Karpeev 
1979c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1980c84da90fSDmitry Karpeev 
1981c84da90fSDmitry Karpeev @*/
1982c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1983c84da90fSDmitry Karpeev {
1984c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1985c84da90fSDmitry Karpeev   PetscBool      isfs;
1986c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1987c84da90fSDmitry Karpeev 
1988c84da90fSDmitry Karpeev   PetscFunctionBegin;
1989c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1990534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
1991c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1992c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1993c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1994c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1995c84da90fSDmitry Karpeev }
1996c84da90fSDmitry Karpeev 
1997c84da90fSDmitry Karpeev /*@
1998c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1999c84da90fSDmitry Karpeev 
2000c84da90fSDmitry Karpeev     Logically Collective on PC
2001c84da90fSDmitry Karpeev 
2002c84da90fSDmitry Karpeev     Input Parameters:
2003c84da90fSDmitry Karpeev +   pc  - the preconditioner object
2004c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2005c84da90fSDmitry Karpeev 
20069506b623SDmitry Karpeev     Options Database:
20079506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
2008c84da90fSDmitry Karpeev 
2009c84da90fSDmitry Karpeev     Level: intermediate
2010c84da90fSDmitry Karpeev 
2011c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
2012c84da90fSDmitry Karpeev 
2013c84da90fSDmitry Karpeev @*/
2014c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
2015c84da90fSDmitry Karpeev {
2016c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2017c84da90fSDmitry Karpeev   PetscBool      isfs;
2018c84da90fSDmitry Karpeev   PetscErrorCode ierr;
2019c84da90fSDmitry Karpeev 
2020c84da90fSDmitry Karpeev   PetscFunctionBegin;
2021c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2022c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2023c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
2024c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
2025c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2026c84da90fSDmitry Karpeev }
2027c84da90fSDmitry Karpeev 
2028c84da90fSDmitry Karpeev /*@
2029c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
2030c84da90fSDmitry Karpeev 
2031c84da90fSDmitry Karpeev     Logically Collective on PC
2032c84da90fSDmitry Karpeev 
2033c84da90fSDmitry Karpeev     Input Parameters:
2034c84da90fSDmitry Karpeev .   pc  - the preconditioner object
2035c84da90fSDmitry Karpeev 
2036c84da90fSDmitry Karpeev     Output Parameters:
2037c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2038c84da90fSDmitry Karpeev 
2039c84da90fSDmitry Karpeev 
2040c84da90fSDmitry Karpeev     Level: intermediate
2041c84da90fSDmitry Karpeev 
2042c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
2043c84da90fSDmitry Karpeev 
2044c84da90fSDmitry Karpeev @*/
2045c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
2046c84da90fSDmitry Karpeev {
2047c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2048c84da90fSDmitry Karpeev   PetscBool      isfs;
2049c84da90fSDmitry Karpeev   PetscErrorCode ierr;
2050c84da90fSDmitry Karpeev 
2051c84da90fSDmitry Karpeev   PetscFunctionBegin;
2052c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2053534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
2054c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2055c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
2056c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
2057c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2058c84da90fSDmitry Karpeev }
2059c84da90fSDmitry Karpeev 
2060c84da90fSDmitry Karpeev 
2061c84da90fSDmitry Karpeev 
2062218d4943SBarry Smith /*@C
2063704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
2064704ba839SBarry Smith 
2065ad4df100SBarry Smith     Logically Collective on PC
2066704ba839SBarry Smith 
2067704ba839SBarry Smith     Input Parameters:
2068704ba839SBarry Smith +   pc  - the preconditioner context
20690298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
2070db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
2071704ba839SBarry Smith 
2072d32f9abdSBarry Smith 
2073a6ffb8dbSJed Brown     Notes:
2074a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
2075a6ffb8dbSJed Brown 
2076db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
2077db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
2078d32f9abdSBarry Smith 
2079704ba839SBarry Smith     Level: intermediate
2080704ba839SBarry Smith 
2081704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
2082704ba839SBarry Smith 
2083704ba839SBarry Smith @*/
20847087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
2085704ba839SBarry Smith {
20864ac538c5SBarry Smith   PetscErrorCode ierr;
2087704ba839SBarry Smith 
2088704ba839SBarry Smith   PetscFunctionBegin;
20890700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
20907b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
2091db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
2092ccc738f7SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
2093704ba839SBarry Smith   PetscFunctionReturn(0);
2094704ba839SBarry Smith }
2095704ba839SBarry Smith 
209694ef8ddeSSatish Balay /*@C
209757a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
209857a9adfeSMatthew G Knepley 
209957a9adfeSMatthew G Knepley     Logically Collective on PC
210057a9adfeSMatthew G Knepley 
210157a9adfeSMatthew G Knepley     Input Parameters:
210257a9adfeSMatthew G Knepley +   pc  - the preconditioner context
210357a9adfeSMatthew G Knepley -   splitname - name of this split
210457a9adfeSMatthew G Knepley 
210557a9adfeSMatthew G Knepley     Output Parameter:
21060298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
210757a9adfeSMatthew G Knepley 
210857a9adfeSMatthew G Knepley     Level: intermediate
210957a9adfeSMatthew G Knepley 
211057a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
211157a9adfeSMatthew G Knepley 
211257a9adfeSMatthew G Knepley @*/
211357a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
211457a9adfeSMatthew G Knepley {
211557a9adfeSMatthew G Knepley   PetscErrorCode ierr;
211657a9adfeSMatthew G Knepley 
211757a9adfeSMatthew G Knepley   PetscFunctionBegin;
211857a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
211957a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
212057a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
212157a9adfeSMatthew G Knepley   {
212257a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
212357a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
212457a9adfeSMatthew G Knepley     PetscBool         found;
212557a9adfeSMatthew G Knepley 
21260298fd71SBarry Smith     *is = NULL;
212757a9adfeSMatthew G Knepley     while (ilink) {
212857a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
212957a9adfeSMatthew G Knepley       if (found) {
213057a9adfeSMatthew G Knepley         *is = ilink->is;
213157a9adfeSMatthew G Knepley         break;
213257a9adfeSMatthew G Knepley       }
213357a9adfeSMatthew G Knepley       ilink = ilink->next;
213457a9adfeSMatthew G Knepley     }
213557a9adfeSMatthew G Knepley   }
213657a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
213757a9adfeSMatthew G Knepley }
213857a9adfeSMatthew G Knepley 
2139998f007dSPierre Jolivet /*@C
2140998f007dSPierre Jolivet     PCFieldSplitGetISByIndex - Retrieves the elements for a given index field as an IS
2141998f007dSPierre Jolivet 
2142998f007dSPierre Jolivet     Logically Collective on PC
2143998f007dSPierre Jolivet 
2144998f007dSPierre Jolivet     Input Parameters:
2145998f007dSPierre Jolivet +   pc  - the preconditioner context
2146998f007dSPierre Jolivet -   index - index of this split
2147998f007dSPierre Jolivet 
2148998f007dSPierre Jolivet     Output Parameter:
2149998f007dSPierre Jolivet -   is - the index set that defines the vector elements in this field
2150998f007dSPierre Jolivet 
2151998f007dSPierre Jolivet     Level: intermediate
2152998f007dSPierre Jolivet 
2153998f007dSPierre Jolivet .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitGetIS(), PCFieldSplitSetIS()
2154998f007dSPierre Jolivet 
2155998f007dSPierre Jolivet @*/
2156998f007dSPierre Jolivet PetscErrorCode PCFieldSplitGetISByIndex(PC pc,PetscInt index,IS *is)
2157998f007dSPierre Jolivet {
2158998f007dSPierre Jolivet   PetscErrorCode ierr;
2159998f007dSPierre Jolivet 
2160998f007dSPierre Jolivet   PetscFunctionBegin;
2161998f007dSPierre Jolivet   if (index < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",index);
2162998f007dSPierre Jolivet   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2163998f007dSPierre Jolivet   PetscValidPointer(is,3);
2164998f007dSPierre Jolivet   {
2165998f007dSPierre Jolivet     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
2166998f007dSPierre Jolivet     PC_FieldSplitLink ilink = jac->head;
2167998f007dSPierre Jolivet     PetscInt          i     = 0;
2168998f007dSPierre Jolivet     if (index >= jac->nsplits) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Field %D requested but only %D exist",index,jac->nsplits);
2169998f007dSPierre Jolivet 
2170998f007dSPierre Jolivet     while (i < index) {
2171998f007dSPierre Jolivet       ilink = ilink->next;
2172998f007dSPierre Jolivet       ++i;
2173998f007dSPierre Jolivet     }
2174998f007dSPierre Jolivet     ierr = PCFieldSplitGetIS(pc,ilink->splitname,is);CHKERRQ(ierr);
2175998f007dSPierre Jolivet   }
2176998f007dSPierre Jolivet   PetscFunctionReturn(0);
2177998f007dSPierre Jolivet }
2178998f007dSPierre Jolivet 
217951f519a2SBarry Smith /*@
218051f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
218151f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
218251f519a2SBarry Smith 
2183ad4df100SBarry Smith     Logically Collective on PC
218451f519a2SBarry Smith 
218551f519a2SBarry Smith     Input Parameters:
218651f519a2SBarry Smith +   pc  - the preconditioner context
218751f519a2SBarry Smith -   bs - the block size
218851f519a2SBarry Smith 
218951f519a2SBarry Smith     Level: intermediate
219051f519a2SBarry Smith 
219151f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
219251f519a2SBarry Smith 
219351f519a2SBarry Smith @*/
21947087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
219551f519a2SBarry Smith {
21964ac538c5SBarry Smith   PetscErrorCode ierr;
219751f519a2SBarry Smith 
219851f519a2SBarry Smith   PetscFunctionBegin;
21990700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2200c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
22014ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
220251f519a2SBarry Smith   PetscFunctionReturn(0);
220351f519a2SBarry Smith }
220451f519a2SBarry Smith 
22050971522cSBarry Smith /*@C
220669a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
22070971522cSBarry Smith 
220869a612a9SBarry Smith    Collective on KSP
22090971522cSBarry Smith 
22100971522cSBarry Smith    Input Parameter:
22110971522cSBarry Smith .  pc - the preconditioner context
22120971522cSBarry Smith 
22130971522cSBarry Smith    Output Parameters:
221413e0d083SBarry Smith +  n - the number of splits
22153111de3cSBarry Smith -  subksp - the array of KSP contexts
22160971522cSBarry Smith 
22170971522cSBarry Smith    Note:
22189a4f7e47SBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
2219d32f9abdSBarry Smith    (not the KSP just the array that contains them).
22200971522cSBarry Smith 
2221285fb4e2SStefano Zampini    You must call PCSetUp() before calling PCFieldSplitGetSubKSP().
2222285fb4e2SStefano Zampini 
2223285fb4e2SStefano Zampini    If the fieldsplit is of type PC_COMPOSITE_SCHUR, it returns the KSP object used inside the
2224285fb4e2SStefano Zampini    Schur complement and the KSP object used to iterate over the Schur complement.
2225a51937d4SCarola Kruse    To access all the KSP objects used in PC_COMPOSITE_SCHUR, use PCFieldSplitSchurGetSubKSP().
2226a51937d4SCarola Kruse 
2227a51937d4SCarola Kruse    If the fieldsplit is of type PC_COMPOSITE_GKB, it returns the KSP object used to solve the
2228a51937d4SCarola Kruse    inner linear system defined by the matrix H in each loop.
22290971522cSBarry Smith 
2230196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
22312bf68e3eSBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
2232196cc216SBarry Smith       KSP array must be.
2233196cc216SBarry Smith 
2234196cc216SBarry Smith 
22350971522cSBarry Smith    Level: advanced
22360971522cSBarry Smith 
22370971522cSBarry Smith .seealso: PCFIELDSPLIT
22380971522cSBarry Smith @*/
22397087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
22400971522cSBarry Smith {
22414ac538c5SBarry Smith   PetscErrorCode ierr;
22420971522cSBarry Smith 
22430971522cSBarry Smith   PetscFunctionBegin;
22440700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
224513e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
22464ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
22470971522cSBarry Smith   PetscFunctionReturn(0);
22480971522cSBarry Smith }
22490971522cSBarry Smith 
2250285fb4e2SStefano Zampini /*@C
2251285fb4e2SStefano Zampini    PCFieldSplitSchurGetSubKSP - Gets the KSP contexts used inside the Schur complement based PCFIELDSPLIT
2252285fb4e2SStefano Zampini 
2253285fb4e2SStefano Zampini    Collective on KSP
2254285fb4e2SStefano Zampini 
2255285fb4e2SStefano Zampini    Input Parameter:
2256285fb4e2SStefano Zampini .  pc - the preconditioner context
2257285fb4e2SStefano Zampini 
2258285fb4e2SStefano Zampini    Output Parameters:
2259285fb4e2SStefano Zampini +  n - the number of splits
2260285fb4e2SStefano Zampini -  subksp - the array of KSP contexts
2261285fb4e2SStefano Zampini 
2262285fb4e2SStefano Zampini    Note:
2263285fb4e2SStefano Zampini    After PCFieldSplitSchurGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
2264285fb4e2SStefano Zampini    (not the KSP just the array that contains them).
2265285fb4e2SStefano Zampini 
2266285fb4e2SStefano Zampini    You must call PCSetUp() before calling PCFieldSplitSchurGetSubKSP().
2267285fb4e2SStefano Zampini 
2268285fb4e2SStefano Zampini    If the fieldsplit type is of type PC_COMPOSITE_SCHUR, it returns (in order)
2269285fb4e2SStefano Zampini    - the KSP used for the (1,1) block
2270285fb4e2SStefano Zampini    - the KSP used for the Schur complement (not the one used for the interior Schur solver)
2271285fb4e2SStefano Zampini    - the KSP used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block).
2272285fb4e2SStefano Zampini 
2273285fb4e2SStefano Zampini    It returns a null array if the fieldsplit is not of type PC_COMPOSITE_SCHUR; in this case, you should use PCFieldSplitGetSubKSP().
2274285fb4e2SStefano Zampini 
2275285fb4e2SStefano Zampini    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
2276285fb4e2SStefano Zampini       You can call PCFieldSplitSchurGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
2277285fb4e2SStefano Zampini       KSP array must be.
2278285fb4e2SStefano Zampini 
2279285fb4e2SStefano Zampini    Level: advanced
2280285fb4e2SStefano Zampini 
2281285fb4e2SStefano Zampini .seealso: PCFIELDSPLIT
2282285fb4e2SStefano Zampini @*/
2283285fb4e2SStefano Zampini PetscErrorCode  PCFieldSplitSchurGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
2284285fb4e2SStefano Zampini {
2285285fb4e2SStefano Zampini   PetscErrorCode ierr;
2286285fb4e2SStefano Zampini 
2287285fb4e2SStefano Zampini   PetscFunctionBegin;
2288285fb4e2SStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2289285fb4e2SStefano Zampini   if (n) PetscValidIntPointer(n,2);
2290285fb4e2SStefano Zampini   ierr = PetscUseMethod(pc,"PCFieldSplitSchurGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
2291285fb4e2SStefano Zampini   PetscFunctionReturn(0);
2292285fb4e2SStefano Zampini }
2293285fb4e2SStefano Zampini 
2294e69d4d44SBarry Smith /*@
2295*a1e3cbf9SBarry Smith     PCFieldSplitSetSchurPre -  Indicates from what operator the preconditioner is constructucted for the Schur complement.
2296*a1e3cbf9SBarry Smith       The default is the A11 matrix.
2297e69d4d44SBarry Smith 
2298e69d4d44SBarry Smith     Collective on PC
2299e69d4d44SBarry Smith 
2300e69d4d44SBarry Smith     Input Parameters:
2301e69d4d44SBarry Smith +   pc      - the preconditioner context
23026fdd48a9SBarry 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
23036fdd48a9SBarry Smith               PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL
23040298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
2305084e4875SJed Brown 
2306e69d4d44SBarry Smith     Options Database:
2307*a1e3cbf9SBarry Smith +    -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments
2308*a1e3cbf9SBarry Smith -    -fieldsplit_1_pc_type <pctype> - the preconditioner algorithm that is used to construct the preconditioner from the operator
2309e69d4d44SBarry Smith 
2310fd1303e9SJungho Lee     Notes:
2311fd1303e9SJungho Lee $    If ptype is
2312*a1e3cbf9SBarry Smith $        a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
231353f2277eSBarry Smith $        matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
2314*a1e3cbf9SBarry Smith $        self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
2315a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
2316fd1303e9SJungho Lee $             preconditioner
2317*a1e3cbf9SBarry Smith $        user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
23186fdd48a9SBarry Smith $             to this function).
2319*a1e3cbf9SBarry Smith $        selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
23201d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
23216fdd48a9SBarry Smith $             lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump
2322*a1e3cbf9SBarry Smith $        full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation computed internally by PCFIELDSPLIT (this is expensive)
23236fdd48a9SBarry Smith $             useful mostly as a test that the Schur complement approach can work for your problem
2324fd1303e9SJungho Lee 
2325e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
2326fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
2327a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
2328fd1303e9SJungho Lee 
2329e69d4d44SBarry Smith     Level: intermediate
2330e69d4d44SBarry Smith 
23311d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
23321d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
2333e69d4d44SBarry Smith 
2334e69d4d44SBarry Smith @*/
233529f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
2336e69d4d44SBarry Smith {
23374ac538c5SBarry Smith   PetscErrorCode ierr;
2338e69d4d44SBarry Smith 
2339e69d4d44SBarry Smith   PetscFunctionBegin;
23400700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
234129f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
2342e69d4d44SBarry Smith   PetscFunctionReturn(0);
2343e69d4d44SBarry Smith }
2344686bed4dSStefano Zampini 
234529f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
2346e69d4d44SBarry Smith 
234737a82bf0SJed Brown /*@
234837a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
234929f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
235037a82bf0SJed Brown 
235137a82bf0SJed Brown     Logically Collective on PC
235237a82bf0SJed Brown 
235337a82bf0SJed Brown     Input Parameters:
235437a82bf0SJed Brown .   pc      - the preconditioner context
235537a82bf0SJed Brown 
235637a82bf0SJed Brown     Output Parameters:
235737a82bf0SJed 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
235837a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
235937a82bf0SJed Brown 
236037a82bf0SJed Brown     Level: intermediate
236137a82bf0SJed Brown 
236229f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
236337a82bf0SJed Brown 
236437a82bf0SJed Brown @*/
236537a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
236637a82bf0SJed Brown {
236737a82bf0SJed Brown   PetscErrorCode ierr;
236837a82bf0SJed Brown 
236937a82bf0SJed Brown   PetscFunctionBegin;
237037a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
237137a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
2372e69d4d44SBarry Smith   PetscFunctionReturn(0);
2373e69d4d44SBarry Smith }
2374e69d4d44SBarry Smith 
237545e7fc46SDmitry Karpeev /*@
2376470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
237745e7fc46SDmitry Karpeev 
237845e7fc46SDmitry Karpeev     Not collective
237945e7fc46SDmitry Karpeev 
238045e7fc46SDmitry Karpeev     Input Parameter:
238145e7fc46SDmitry Karpeev .   pc      - the preconditioner context
238245e7fc46SDmitry Karpeev 
238345e7fc46SDmitry Karpeev     Output Parameter:
2384470b340bSDmitry Karpeev .   S       - the Schur complement matrix
238545e7fc46SDmitry Karpeev 
2386470b340bSDmitry Karpeev     Notes:
2387470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
238845e7fc46SDmitry Karpeev 
238945e7fc46SDmitry Karpeev     Level: advanced
239045e7fc46SDmitry Karpeev 
239129f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
239245e7fc46SDmitry Karpeev 
239345e7fc46SDmitry Karpeev @*/
2394470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
239545e7fc46SDmitry Karpeev {
239645e7fc46SDmitry Karpeev   PetscErrorCode ierr;
239745e7fc46SDmitry Karpeev   const char*    t;
239845e7fc46SDmitry Karpeev   PetscBool      isfs;
239945e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
240045e7fc46SDmitry Karpeev 
240145e7fc46SDmitry Karpeev   PetscFunctionBegin;
240245e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
240345e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
240445e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
240545e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
240645e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2407470b340bSDmitry 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);
2408470b340bSDmitry Karpeev   if (S) *S = jac->schur;
240945e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
241045e7fc46SDmitry Karpeev }
241145e7fc46SDmitry Karpeev 
2412470b340bSDmitry Karpeev /*@
2413470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
2414470b340bSDmitry Karpeev 
2415470b340bSDmitry Karpeev     Not collective
2416470b340bSDmitry Karpeev 
2417470b340bSDmitry Karpeev     Input Parameters:
2418470b340bSDmitry Karpeev +   pc      - the preconditioner context
2419a2b725a8SWilliam Gropp -   S       - the Schur complement matrix
2420470b340bSDmitry Karpeev 
2421470b340bSDmitry Karpeev     Level: advanced
2422470b340bSDmitry Karpeev 
242329f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
2424470b340bSDmitry Karpeev 
2425470b340bSDmitry Karpeev @*/
2426bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
2427470b340bSDmitry Karpeev {
2428470b340bSDmitry Karpeev   PetscErrorCode ierr;
2429470b340bSDmitry Karpeev   const char*    t;
2430470b340bSDmitry Karpeev   PetscBool      isfs;
2431470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
2432470b340bSDmitry Karpeev 
2433470b340bSDmitry Karpeev   PetscFunctionBegin;
2434470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2435470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
2436470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2437470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
2438470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2439470b340bSDmitry 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);
2440bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
2441470b340bSDmitry Karpeev   PetscFunctionReturn(0);
2442470b340bSDmitry Karpeev }
2443470b340bSDmitry Karpeev 
2444470b340bSDmitry Karpeev 
244529f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
2446e69d4d44SBarry Smith {
2447e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2448084e4875SJed Brown   PetscErrorCode ierr;
2449e69d4d44SBarry Smith 
2450e69d4d44SBarry Smith   PetscFunctionBegin;
2451084e4875SJed Brown   jac->schurpre = ptype;
2452a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
24536bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
2454084e4875SJed Brown     jac->schur_user = pre;
2455084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
2456084e4875SJed Brown   }
2457e69d4d44SBarry Smith   PetscFunctionReturn(0);
2458e69d4d44SBarry Smith }
2459e69d4d44SBarry Smith 
246037a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
246137a82bf0SJed Brown {
246237a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
246337a82bf0SJed Brown 
246437a82bf0SJed Brown   PetscFunctionBegin;
246537a82bf0SJed Brown   *ptype = jac->schurpre;
246637a82bf0SJed Brown   *pre   = jac->schur_user;
246737a82bf0SJed Brown   PetscFunctionReturn(0);
246837a82bf0SJed Brown }
246937a82bf0SJed Brown 
2470ab1df9f5SJed Brown /*@
24710ffb0e17SBarry Smith     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner
2472ab1df9f5SJed Brown 
2473ab1df9f5SJed Brown     Collective on PC
2474ab1df9f5SJed Brown 
2475ab1df9f5SJed Brown     Input Parameters:
2476ab1df9f5SJed Brown +   pc  - the preconditioner context
2477c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
2478ab1df9f5SJed Brown 
2479ab1df9f5SJed Brown     Options Database:
2480c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
2481ab1df9f5SJed Brown 
2482ab1df9f5SJed Brown 
2483ab1df9f5SJed Brown     Level: intermediate
2484ab1df9f5SJed Brown 
2485ab1df9f5SJed Brown     Notes:
2486ab1df9f5SJed Brown     The FULL factorization is
2487ab1df9f5SJed Brown 
24880ffb0e17SBarry Smith $   (A   B)  = (1       0) (A   0) (1  Ainv*B)  = L D U
24890ffb0e17SBarry Smith $   (C   E)    (C*Ainv  1) (0   S) (0     1  )
2490ab1df9f5SJed Brown 
24910ffb0e17SBarry 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,
2492c096484dSStefano 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().
2493ab1df9f5SJed Brown 
24940ffb0e17SBarry Smith $    If A and S are solved exactly
24950ffb0e17SBarry Smith $      *) FULL factorization is a direct solver.
24960ffb0e17SBarry 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.
24970ffb0e17SBarry 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.
2498ab1df9f5SJed Brown 
24990ffb0e17SBarry Smith     If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
25000ffb0e17SBarry 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.
25010ffb0e17SBarry Smith 
25020ffb0e17SBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES.
25030ffb0e17SBarry Smith 
25040ffb0e17SBarry 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).
2505ab1df9f5SJed Brown 
2506ab1df9f5SJed Brown     References:
250796a0c994SBarry Smith +   1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
250896a0c994SBarry Smith -   2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2509ab1df9f5SJed Brown 
2510c096484dSStefano Zampini .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCFieldSplitSetSchurScale()
2511ab1df9f5SJed Brown @*/
2512c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
2513ab1df9f5SJed Brown {
2514ab1df9f5SJed Brown   PetscErrorCode ierr;
2515ab1df9f5SJed Brown 
2516ab1df9f5SJed Brown   PetscFunctionBegin;
2517ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2518c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
2519ab1df9f5SJed Brown   PetscFunctionReturn(0);
2520ab1df9f5SJed Brown }
2521ab1df9f5SJed Brown 
25221e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
2523ab1df9f5SJed Brown {
2524ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2525ab1df9f5SJed Brown 
2526ab1df9f5SJed Brown   PetscFunctionBegin;
2527ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2528ab1df9f5SJed Brown   PetscFunctionReturn(0);
2529ab1df9f5SJed Brown }
2530ab1df9f5SJed Brown 
2531c096484dSStefano Zampini /*@
2532c096484dSStefano Zampini     PCFieldSplitSetSchurScale -  Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG.
2533c096484dSStefano Zampini 
2534c096484dSStefano Zampini     Collective on PC
2535c096484dSStefano Zampini 
2536c096484dSStefano Zampini     Input Parameters:
2537c096484dSStefano Zampini +   pc    - the preconditioner context
2538c096484dSStefano Zampini -   scale - scaling factor for the Schur complement
2539c096484dSStefano Zampini 
2540c096484dSStefano Zampini     Options Database:
2541c096484dSStefano Zampini .     -pc_fieldsplit_schur_scale - default is -1.0
2542c096484dSStefano Zampini 
2543c096484dSStefano Zampini     Level: intermediate
2544c096484dSStefano Zampini 
2545c096484dSStefano Zampini .seealso: PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurFactType, PCFieldSplitSetSchurScale()
2546c096484dSStefano Zampini @*/
2547c096484dSStefano Zampini PetscErrorCode PCFieldSplitSetSchurScale(PC pc,PetscScalar scale)
2548c096484dSStefano Zampini {
2549c096484dSStefano Zampini   PetscErrorCode ierr;
2550c096484dSStefano Zampini 
2551c096484dSStefano Zampini   PetscFunctionBegin;
2552c096484dSStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2553c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc,scale,2);
2554c096484dSStefano Zampini   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurScale_C",(PC,PetscScalar),(pc,scale));CHKERRQ(ierr);
2555c096484dSStefano Zampini   PetscFunctionReturn(0);
2556c096484dSStefano Zampini }
2557c096484dSStefano Zampini 
2558c096484dSStefano Zampini static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc,PetscScalar scale)
2559c096484dSStefano Zampini {
2560c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2561c096484dSStefano Zampini 
2562c096484dSStefano Zampini   PetscFunctionBegin;
2563c096484dSStefano Zampini   jac->schurscale = scale;
2564c096484dSStefano Zampini   PetscFunctionReturn(0);
2565c096484dSStefano Zampini }
2566c096484dSStefano Zampini 
256730ad9308SMatthew Knepley /*@C
25688c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
256930ad9308SMatthew Knepley 
257030ad9308SMatthew Knepley    Collective on KSP
257130ad9308SMatthew Knepley 
257230ad9308SMatthew Knepley    Input Parameter:
257330ad9308SMatthew Knepley .  pc - the preconditioner context
257430ad9308SMatthew Knepley 
257530ad9308SMatthew Knepley    Output Parameters:
2576a04f6461SBarry Smith +  A00 - the (0,0) block
2577a04f6461SBarry Smith .  A01 - the (0,1) block
2578a04f6461SBarry Smith .  A10 - the (1,0) block
2579a04f6461SBarry Smith -  A11 - the (1,1) block
258030ad9308SMatthew Knepley 
258130ad9308SMatthew Knepley    Level: advanced
258230ad9308SMatthew Knepley 
258330ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
258430ad9308SMatthew Knepley @*/
2585a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
258630ad9308SMatthew Knepley {
258730ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
258830ad9308SMatthew Knepley 
258930ad9308SMatthew Knepley   PetscFunctionBegin;
25900700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2591ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2592a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2593a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2594a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2595a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
259630ad9308SMatthew Knepley   PetscFunctionReturn(0);
259730ad9308SMatthew Knepley }
259830ad9308SMatthew Knepley 
2599b09e027eSCarola Kruse /*@
2600e071a0a4SCarola Kruse     PCFieldSplitSetGKBTol -  Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner.
2601b09e027eSCarola Kruse 
2602b09e027eSCarola Kruse     Collective on PC
2603b09e027eSCarola Kruse 
2604e071a0a4SCarola Kruse     Notes:
2605e071a0a4SCarola Kruse     The generalized GKB algorithm uses a lower bound estimate of the error in energy norm as stopping criterion.
2606e071a0a4SCarola Kruse     It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than
2607e071a0a4SCarola Kruse     this estimate, the stopping criterion is satisfactory in practical cases [A13].
2608e071a0a4SCarola Kruse 
2609e071a0a4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2610e071a0a4SCarola Kruse 
2611b09e027eSCarola Kruse     Input Parameters:
2612b09e027eSCarola Kruse +   pc        - the preconditioner context
2613b09e027eSCarola Kruse -   tolerance - the solver tolerance
2614b09e027eSCarola Kruse 
2615b09e027eSCarola Kruse     Options Database:
2616b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_tol - default is 1e-5
2617b09e027eSCarola Kruse 
2618b09e027eSCarola Kruse     Level: intermediate
2619b09e027eSCarola Kruse 
2620b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBMaxit()
2621b09e027eSCarola Kruse @*/
2622b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBTol(PC pc,PetscReal tolerance)
2623b09e027eSCarola Kruse {
2624b09e027eSCarola Kruse   PetscErrorCode ierr;
2625b09e027eSCarola Kruse 
2626b09e027eSCarola Kruse   PetscFunctionBegin;
2627b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2628de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc,tolerance,2);
2629b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBTol_C",(PC,PetscReal),(pc,tolerance));CHKERRQ(ierr);
2630b09e027eSCarola Kruse   PetscFunctionReturn(0);
2631b09e027eSCarola Kruse }
2632b09e027eSCarola Kruse 
2633b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc,PetscReal tolerance)
2634b09e027eSCarola Kruse {
2635b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2636b09e027eSCarola Kruse 
2637b09e027eSCarola Kruse   PetscFunctionBegin;
2638b09e027eSCarola Kruse   jac->gkbtol = tolerance;
2639b09e027eSCarola Kruse   PetscFunctionReturn(0);
2640b09e027eSCarola Kruse }
2641b09e027eSCarola Kruse 
2642b09e027eSCarola Kruse 
2643b09e027eSCarola Kruse /*@
2644e071a0a4SCarola Kruse     PCFieldSplitSetGKBMaxit -  Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization
2645e071a0a4SCarola Kruse     preconditioner.
2646b09e027eSCarola Kruse 
2647b09e027eSCarola Kruse     Collective on PC
2648b09e027eSCarola Kruse 
2649b09e027eSCarola Kruse     Input Parameters:
2650b09e027eSCarola Kruse +   pc     - the preconditioner context
2651b09e027eSCarola Kruse -   maxit  - the maximum number of iterations
2652b09e027eSCarola Kruse 
2653b09e027eSCarola Kruse     Options Database:
2654b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_maxit - default is 100
2655b09e027eSCarola Kruse 
2656b09e027eSCarola Kruse     Level: intermediate
2657b09e027eSCarola Kruse 
2658b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBNu()
2659b09e027eSCarola Kruse @*/
2660b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc,PetscInt maxit)
2661b09e027eSCarola Kruse {
2662b09e027eSCarola Kruse   PetscErrorCode ierr;
2663b09e027eSCarola Kruse 
2664b09e027eSCarola Kruse   PetscFunctionBegin;
2665b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2666de482cd7SCarola Kruse   PetscValidLogicalCollectiveInt(pc,maxit,2);
2667b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBMaxit_C",(PC,PetscInt),(pc,maxit));CHKERRQ(ierr);
2668b09e027eSCarola Kruse   PetscFunctionReturn(0);
2669b09e027eSCarola Kruse }
2670b09e027eSCarola Kruse 
2671b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc,PetscInt maxit)
2672b09e027eSCarola Kruse {
2673b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2674b09e027eSCarola Kruse 
2675b09e027eSCarola Kruse   PetscFunctionBegin;
2676b09e027eSCarola Kruse   jac->gkbmaxit = maxit;
2677b09e027eSCarola Kruse   PetscFunctionReturn(0);
2678b09e027eSCarola Kruse }
2679b09e027eSCarola Kruse 
2680b09e027eSCarola Kruse /*@
2681e071a0a4SCarola Kruse     PCFieldSplitSetGKBDelay -  Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization
2682e071a0a4SCarola Kruse     preconditioner.
2683b09e027eSCarola Kruse 
2684b09e027eSCarola Kruse     Collective on PC
2685b09e027eSCarola Kruse 
2686b09e027eSCarola Kruse     Notes:
2687e071a0a4SCarola 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
2688e071a0a4SCarola 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
2689e071a0a4SCarola 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
2690b09e027eSCarola Kruse 
2691b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2692b09e027eSCarola Kruse 
2693b09e027eSCarola Kruse     Input Parameters:
2694b09e027eSCarola Kruse +   pc     - the preconditioner context
2695b09e027eSCarola Kruse -   delay  - the delay window in the lower bound estimate
2696b09e027eSCarola Kruse 
2697b09e027eSCarola Kruse     Options Database:
2698b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_delay - default is 5
2699b09e027eSCarola Kruse 
2700b09e027eSCarola Kruse     Level: intermediate
2701b09e027eSCarola Kruse 
2702b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit()
2703b09e027eSCarola Kruse @*/
2704b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBDelay(PC pc,PetscInt delay)
2705b09e027eSCarola Kruse {
2706b09e027eSCarola Kruse   PetscErrorCode ierr;
2707b09e027eSCarola Kruse 
2708b09e027eSCarola Kruse   PetscFunctionBegin;
2709b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2710b09e027eSCarola Kruse   PetscValidLogicalCollectiveInt(pc,delay,2);
2711b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBDelay_C",(PC,PetscInt),(pc,delay));CHKERRQ(ierr);
2712b09e027eSCarola Kruse   PetscFunctionReturn(0);
2713b09e027eSCarola Kruse }
2714b09e027eSCarola Kruse 
2715b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc,PetscInt delay)
2716b09e027eSCarola Kruse {
2717b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2718b09e027eSCarola Kruse 
2719b09e027eSCarola Kruse   PetscFunctionBegin;
2720b09e027eSCarola Kruse   jac->gkbdelay = delay;
2721b09e027eSCarola Kruse   PetscFunctionReturn(0);
2722b09e027eSCarola Kruse }
2723b09e027eSCarola Kruse 
2724b09e027eSCarola Kruse /*@
2725b09e027eSCarola 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.
2726b09e027eSCarola Kruse 
2727b09e027eSCarola Kruse     Collective on PC
2728b09e027eSCarola Kruse 
2729b09e027eSCarola Kruse     Notes:
2730e071a0a4SCarola 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,
2731b09e027eSCarola 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
2732b09e027eSCarola Kruse     necessary to find a good balance in between the convergence of the inner and outer loop.
2733b09e027eSCarola Kruse 
2734b09e027eSCarola 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.
2735b09e027eSCarola Kruse 
2736b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2737b09e027eSCarola Kruse 
2738b09e027eSCarola Kruse     Input Parameters:
2739b09e027eSCarola Kruse +   pc     - the preconditioner context
2740b09e027eSCarola Kruse -   nu     - the shift parameter
2741b09e027eSCarola Kruse 
2742b09e027eSCarola Kruse     Options Database:
2743b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_nu - default is 1
2744b09e027eSCarola Kruse 
2745b09e027eSCarola Kruse     Level: intermediate
2746b09e027eSCarola Kruse 
2747b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit()
2748b09e027eSCarola Kruse @*/
2749b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBNu(PC pc,PetscReal nu)
2750b09e027eSCarola Kruse {
2751b09e027eSCarola Kruse   PetscErrorCode ierr;
2752b09e027eSCarola Kruse 
2753b09e027eSCarola Kruse   PetscFunctionBegin;
2754b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2755de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc,nu,2);
2756b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBNu_C",(PC,PetscReal),(pc,nu));CHKERRQ(ierr);
2757b09e027eSCarola Kruse   PetscFunctionReturn(0);
2758b09e027eSCarola Kruse }
2759b09e027eSCarola Kruse 
2760b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc,PetscReal nu)
2761b09e027eSCarola Kruse {
2762b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2763b09e027eSCarola Kruse 
2764b09e027eSCarola Kruse   PetscFunctionBegin;
2765b09e027eSCarola Kruse   jac->gkbnu = nu;
2766b09e027eSCarola Kruse   PetscFunctionReturn(0);
2767b09e027eSCarola Kruse }
2768b09e027eSCarola Kruse 
2769b09e027eSCarola Kruse 
27701e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
277179416396SBarry Smith {
277279416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2773e69d4d44SBarry Smith   PetscErrorCode ierr;
277479416396SBarry Smith 
277579416396SBarry Smith   PetscFunctionBegin;
277679416396SBarry Smith   jac->type = type;
2777e071a0a4SCarola Kruse 
2778e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",0);CHKERRQ(ierr);
2779e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
2780e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2781e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
2782e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr);
2783e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",0);CHKERRQ(ierr);
2784e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",0);CHKERRQ(ierr);
2785e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",0);CHKERRQ(ierr);
2786e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",0);CHKERRQ(ierr);
2787e071a0a4SCarola Kruse 
27883b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
27893b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
27903b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
27912fa5cd67SKarl Rupp 
2792bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
279329f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
279437a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2795bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2796c096484dSStefano Zampini     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",PCFieldSplitSetSchurScale_FieldSplit);CHKERRQ(ierr);
2797a51937d4SCarola Kruse   } else if (type == PC_COMPOSITE_GKB){
2798a51937d4SCarola Kruse     pc->ops->apply = PCApply_FieldSplit_GKB;
2799a51937d4SCarola Kruse     pc->ops->view  = PCView_FieldSplit_GKB;
2800e69d4d44SBarry Smith 
2801a51937d4SCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2802b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",PCFieldSplitSetGKBTol_FieldSplit);CHKERRQ(ierr);
2803b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",PCFieldSplitSetGKBMaxit_FieldSplit);CHKERRQ(ierr);
2804b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",PCFieldSplitSetGKBNu_FieldSplit);CHKERRQ(ierr);
2805b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",PCFieldSplitSetGKBDelay_FieldSplit);CHKERRQ(ierr);
28063b224e63SBarry Smith   } else {
28073b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
28083b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
28092fa5cd67SKarl Rupp 
2810bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
28113b224e63SBarry Smith   }
281279416396SBarry Smith   PetscFunctionReturn(0);
281379416396SBarry Smith }
281479416396SBarry Smith 
28151e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
281651f519a2SBarry Smith {
281751f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
281851f519a2SBarry Smith 
281951f519a2SBarry Smith   PetscFunctionBegin;
2820ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2821ce94432eSBarry 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);
282251f519a2SBarry Smith   jac->bs = bs;
282351f519a2SBarry Smith   PetscFunctionReturn(0);
282451f519a2SBarry Smith }
282551f519a2SBarry Smith 
2826bc08b0f1SBarry Smith /*@
282779416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
282879416396SBarry Smith 
282979416396SBarry Smith    Collective on PC
283079416396SBarry Smith 
283179416396SBarry Smith    Input Parameter:
2832a2b725a8SWilliam Gropp +  pc - the preconditioner context
2833a2b725a8SWilliam Gropp -  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
283479416396SBarry Smith 
283579416396SBarry Smith    Options Database Key:
2836a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
283779416396SBarry Smith 
2838b02e2d75SMatthew G Knepley    Level: Intermediate
283979416396SBarry Smith 
284079416396SBarry Smith .seealso: PCCompositeSetType()
284179416396SBarry Smith 
284279416396SBarry Smith @*/
28437087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
284479416396SBarry Smith {
28454ac538c5SBarry Smith   PetscErrorCode ierr;
284679416396SBarry Smith 
284779416396SBarry Smith   PetscFunctionBegin;
28480700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
28494ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
285079416396SBarry Smith   PetscFunctionReturn(0);
285179416396SBarry Smith }
285279416396SBarry Smith 
2853b02e2d75SMatthew G Knepley /*@
2854b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2855b02e2d75SMatthew G Knepley 
2856b02e2d75SMatthew G Knepley   Not collective
2857b02e2d75SMatthew G Knepley 
2858b02e2d75SMatthew G Knepley   Input Parameter:
2859b02e2d75SMatthew G Knepley . pc - the preconditioner context
2860b02e2d75SMatthew G Knepley 
2861b02e2d75SMatthew G Knepley   Output Parameter:
2862b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2863b02e2d75SMatthew G Knepley 
2864b02e2d75SMatthew G Knepley   Level: Intermediate
2865b02e2d75SMatthew G Knepley 
2866b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2867b02e2d75SMatthew G Knepley @*/
2868b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2869b02e2d75SMatthew G Knepley {
2870b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2871b02e2d75SMatthew G Knepley 
2872b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2873b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2874b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2875b02e2d75SMatthew G Knepley   *type = jac->type;
2876b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2877b02e2d75SMatthew G Knepley }
2878b02e2d75SMatthew G Knepley 
28794ab8060aSDmitry Karpeev /*@
28804ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
28814ab8060aSDmitry Karpeev 
28824ab8060aSDmitry Karpeev    Logically Collective
28834ab8060aSDmitry Karpeev 
28844ab8060aSDmitry Karpeev    Input Parameters:
28854ab8060aSDmitry Karpeev +  pc   - the preconditioner context
28864ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
28874ab8060aSDmitry Karpeev 
28884ab8060aSDmitry Karpeev    Options Database Key:
28894ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
28904ab8060aSDmitry Karpeev 
28914ab8060aSDmitry Karpeev    Level: Intermediate
28924ab8060aSDmitry Karpeev 
28934ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
28944ab8060aSDmitry Karpeev 
28954ab8060aSDmitry Karpeev @*/
28964ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
28974ab8060aSDmitry Karpeev {
28984ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
28994ab8060aSDmitry Karpeev   PetscBool      isfs;
29004ab8060aSDmitry Karpeev   PetscErrorCode ierr;
29014ab8060aSDmitry Karpeev 
29024ab8060aSDmitry Karpeev   PetscFunctionBegin;
29034ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
29044ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
29054ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
29064ab8060aSDmitry Karpeev   if (isfs) {
29074ab8060aSDmitry Karpeev     jac->dm_splits = flg;
29084ab8060aSDmitry Karpeev   }
29094ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
29104ab8060aSDmitry Karpeev }
29114ab8060aSDmitry Karpeev 
29124ab8060aSDmitry Karpeev 
29134ab8060aSDmitry Karpeev /*@
29144ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
29154ab8060aSDmitry Karpeev 
29164ab8060aSDmitry Karpeev    Logically Collective
29174ab8060aSDmitry Karpeev 
29184ab8060aSDmitry Karpeev    Input Parameter:
29194ab8060aSDmitry Karpeev .  pc   - the preconditioner context
29204ab8060aSDmitry Karpeev 
29214ab8060aSDmitry Karpeev    Output Parameter:
29224ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
29234ab8060aSDmitry Karpeev 
29244ab8060aSDmitry Karpeev    Level: Intermediate
29254ab8060aSDmitry Karpeev 
29264ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
29274ab8060aSDmitry Karpeev 
29284ab8060aSDmitry Karpeev @*/
29294ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
29304ab8060aSDmitry Karpeev {
29314ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
29324ab8060aSDmitry Karpeev   PetscBool      isfs;
29334ab8060aSDmitry Karpeev   PetscErrorCode ierr;
29344ab8060aSDmitry Karpeev 
29354ab8060aSDmitry Karpeev   PetscFunctionBegin;
29364ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2937534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
29384ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
29394ab8060aSDmitry Karpeev   if (isfs) {
29404ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
29414ab8060aSDmitry Karpeev   }
29424ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
29434ab8060aSDmitry Karpeev }
29444ab8060aSDmitry Karpeev 
29457b752e3dSPatrick Sanan /*@
29467b752e3dSPatrick Sanan    PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
29477b752e3dSPatrick Sanan 
29487b752e3dSPatrick Sanan    Logically Collective
29497b752e3dSPatrick Sanan 
29507b752e3dSPatrick Sanan    Input Parameter:
29517b752e3dSPatrick Sanan .  pc   - the preconditioner context
29527b752e3dSPatrick Sanan 
29537b752e3dSPatrick Sanan    Output Parameter:
29547b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
29557b752e3dSPatrick Sanan 
29567b752e3dSPatrick Sanan    Level: Intermediate
29577b752e3dSPatrick Sanan 
29587b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint()
29597b752e3dSPatrick Sanan 
29607b752e3dSPatrick Sanan @*/
29617b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc,PetscBool *flg)
29627b752e3dSPatrick Sanan {
29637b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
29647b752e3dSPatrick Sanan 
29657b752e3dSPatrick Sanan   PetscFunctionBegin;
29667b752e3dSPatrick Sanan   *flg = jac->detect;
29677b752e3dSPatrick Sanan   PetscFunctionReturn(0);
29687b752e3dSPatrick Sanan }
29697b752e3dSPatrick Sanan 
29707b752e3dSPatrick Sanan /*@
29717b752e3dSPatrick Sanan    PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
29727b752e3dSPatrick Sanan 
29737b752e3dSPatrick Sanan    Logically Collective
29747b752e3dSPatrick Sanan 
29757b752e3dSPatrick Sanan    Notes:
29767b752e3dSPatrick 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()).
29777b752e3dSPatrick Sanan 
29787b752e3dSPatrick Sanan    Input Parameter:
29797b752e3dSPatrick Sanan .  pc   - the preconditioner context
29807b752e3dSPatrick Sanan 
29817b752e3dSPatrick Sanan    Output Parameter:
29827b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
29837b752e3dSPatrick Sanan 
29847b752e3dSPatrick Sanan    Options Database Key:
29857b752e3dSPatrick Sanan .  -pc_fieldsplit_detect_saddle_point
29867b752e3dSPatrick Sanan 
29877b752e3dSPatrick Sanan    Level: Intermediate
29887b752e3dSPatrick Sanan 
29897b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint(), PCFieldSplitSetType(), PCFieldSplitSetSchurPre()
29907b752e3dSPatrick Sanan 
29917b752e3dSPatrick Sanan @*/
29927b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc,PetscBool flg)
29937b752e3dSPatrick Sanan {
29947b752e3dSPatrick Sanan   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
29957b752e3dSPatrick Sanan   PetscErrorCode ierr;
29967b752e3dSPatrick Sanan 
29977b752e3dSPatrick Sanan   PetscFunctionBegin;
29987b752e3dSPatrick Sanan   jac->detect = flg;
29997b752e3dSPatrick Sanan   if (jac->detect) {
30007b752e3dSPatrick Sanan     ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
30017b752e3dSPatrick Sanan     ierr = PCFieldSplitSetSchurPre(pc,PC_FIELDSPLIT_SCHUR_PRE_SELF,NULL);CHKERRQ(ierr);
30027b752e3dSPatrick Sanan   }
30037b752e3dSPatrick Sanan   PetscFunctionReturn(0);
30047b752e3dSPatrick Sanan }
30057b752e3dSPatrick Sanan 
30060971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
30070971522cSBarry Smith /*MC
3008a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
3009a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
30100971522cSBarry Smith 
3011edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
3012edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
30130971522cSBarry Smith 
3014a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
301569a612a9SBarry Smith          and set the options directly on the resulting KSP object
30160971522cSBarry Smith 
30170971522cSBarry Smith    Level: intermediate
30180971522cSBarry Smith 
301979416396SBarry Smith    Options Database Keys:
302081540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
302181540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
302281540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
302381540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
3024a51937d4SCarola Kruse .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting
3025a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
30267b752e3dSPatrick Sanan .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
302779416396SBarry Smith 
3028a51937d4SCarola Kruse .    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
30295d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
3030a51937d4SCarola Kruse -    Options prefix for inner solver when using Golub Kahan biadiagonalization preconditioner is -fieldsplit_0_
30315d4c12cdSJungho Lee 
3032c8a0d604SMatthew G Knepley    Notes:
3033c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
3034d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
3035d32f9abdSBarry Smith 
3036d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
3037d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
3038d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
3039d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
3040d32f9abdSBarry Smith 
3041c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
3042c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
3043c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
304413b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
3045c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
304613b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
304713b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
304813b05affSJed 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
3049686bed4dSStefano Zampini      in providing the SECOND split or 1 if not give). For PCFieldSplitGetSubKSP() when field number is 0,
3050c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
3051a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
30521d71051fSDmitry Karpeev 
3053a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
30545668aaf4SBarry Smith      diag gives
3055c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
3056c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
3057c096484dSStefano 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
3058c096484dSStefano Zampini      can be turned off with PCFieldSplitSetSchurScale() or by command line -pc_fieldsplit_schur_scale 1.0. The lower factorization is the inverse of
3059c8a0d604SMatthew G Knepley $              (  A00   0 )
3060c8a0d604SMatthew G Knepley $              (  A10   S )
3061c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
3062c8a0d604SMatthew G Knepley $              ( A00 A01 )
3063c8a0d604SMatthew G Knepley $              (  0   S  )
3064c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
3065e69d4d44SBarry Smith 
3066edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
3067edf189efSBarry Smith      is used automatically for a second block.
3068edf189efSBarry Smith 
3069ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
3070ff218e97SBarry Smith      Generally it should be used with the AIJ format.
3071ff218e97SBarry Smith 
3072ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
3073ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
3074ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
30750716a85fSBarry Smith 
30763bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
30773bc631e0SBarry Smith 
30783bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
30793bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
30803bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
30813bc631e0SBarry Smith 
30824d308398SBarry Smith    The Constrained Pressure Preconditioner (CPR) can be implemented using PCCOMPOSITE with PCGALERKIN. CPR first solves an R A P subsystem, updates the
30834d308398SBarry Smith    residual on all variables (PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)), and then applies a simple ILU like preconditioner on all the variables.
3084a6a584a2SBarry Smith 
3085e071a0a4SCarola Kruse    The generalized Golub-Kahan bidiagonalization preconditioner (gkb) can be applied to symmetric 2x2 block matrices of the shape
3086a51937d4SCarola Kruse $        ( A00  A01 )
3087a51937d4SCarola Kruse $        ( A01' 0   )
3088a51937d4SCarola 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'.
3089e071a0a4SCarola 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_.
3090a51937d4SCarola Kruse 
3091a51937d4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
3092a51937d4SCarola Kruse 
30937e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
3094285fb4e2SStefano Zampini            PCFieldSplitGetSubKSP(), PCFieldSplitSchurGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(),
30957b752e3dSPatrick Sanan           MatSchurComplementSetAinvType(), PCFieldSplitSetSchurScale(),
30967b752e3dSPatrick Sanan           PCFieldSplitSetDetectSaddlePoint()
30970971522cSBarry Smith M*/
30980971522cSBarry Smith 
30998cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
31000971522cSBarry Smith {
31010971522cSBarry Smith   PetscErrorCode ierr;
31020971522cSBarry Smith   PC_FieldSplit  *jac;
31030971522cSBarry Smith 
31040971522cSBarry Smith   PetscFunctionBegin;
3105b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
31062fa5cd67SKarl Rupp 
31070971522cSBarry Smith   jac->bs                 = -1;
31080971522cSBarry Smith   jac->nsplits            = 0;
31093e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
3110e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
3111c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
3112c096484dSStefano Zampini   jac->schurscale         = -1.0;
3113fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
31147b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
3115a51937d4SCarola Kruse   jac->gkbtol             = 1e-5;
3116a51937d4SCarola Kruse   jac->gkbdelay           = 5;
3117a51937d4SCarola Kruse   jac->gkbnu              = 1;
3118a51937d4SCarola Kruse   jac->gkbmaxit           = 100;
3119de482cd7SCarola Kruse   jac->gkbmonitor         = PETSC_FALSE;
312051f519a2SBarry Smith 
31210971522cSBarry Smith   pc->data = (void*)jac;
31220971522cSBarry Smith 
31230971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
3124421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
31250971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
3126574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
31270971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
31280971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
31290971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
31300971522cSBarry Smith   pc->ops->applyrichardson = 0;
31310971522cSBarry Smith 
3132285fb4e2SStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",PCFieldSplitSchurGetSubKSP_FieldSplit);CHKERRQ(ierr);
3133bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
3134bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
3135bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
3136bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
3137bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
31386dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr);
31390971522cSBarry Smith   PetscFunctionReturn(0);
31400971522cSBarry Smith }
3141