xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision addd1e01195cb0a04e2dcc1094239eced7cdc6e8) !
1af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
2a80b646eSBarry Smith #include <petsc/private/kspimpl.h>    /*  This is needed to provide the appropriate PETSC_EXTERN for KSP_Solve_FS ....*/
31e25c274SJed Brown #include <petscdm.h>
40971522cSBarry Smith 
50a545947SLisandro Dalcin const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",NULL};
60a545947SLisandro Dalcin const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",NULL};
7c5d2311dSJed Brown 
89df09d43SBarry Smith PetscLogEvent KSP_Solve_FS_0,KSP_Solve_FS_1,KSP_Solve_FS_S,KSP_Solve_FS_U,KSP_Solve_FS_L,KSP_Solve_FS_2,KSP_Solve_FS_3,KSP_Solve_FS_4;
99df09d43SBarry Smith 
100971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
110971522cSBarry Smith struct _PC_FieldSplitLink {
1269a612a9SBarry Smith   KSP               ksp;
13443836d0SMatthew G Knepley   Vec               x,y,z;
14db4c96c1SJed Brown   char              *splitname;
150971522cSBarry Smith   PetscInt          nfields;
165d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
171b9fc7fcSBarry Smith   VecScatter        sctx;
18f5f0d762SBarry Smith   IS                is,is_col;
1951f519a2SBarry Smith   PC_FieldSplitLink next,previous;
209df09d43SBarry Smith   PetscLogEvent     event;
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);
4937199da05SBarry Smith         if (jac->diag_use_amat) {
4946ce1633cSBarry Smith           ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4957199da05SBarry Smith         } else {
4967199da05SBarry Smith           ierr = MatFindZeroDiagonals(pc->pmat,&zerodiags);CHKERRQ(ierr);
4977199da05SBarry Smith         }
4986ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4996ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
5006ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
501fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
502fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
5033a062f41SBarry Smith       } else if (coupling) {
5043a062f41SBarry Smith         IS       coupling,rest;
5053a062f41SBarry Smith         PetscInt nmin,nmax;
5063a062f41SBarry Smith 
5073a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
5087199da05SBarry Smith         if (jac->offdiag_use_amat) {
5093a062f41SBarry Smith           ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
5107199da05SBarry Smith         } else {
5117199da05SBarry Smith           ierr = MatFindOffBlockDiagonalEntries(pc->pmat,&coupling);CHKERRQ(ierr);
5127199da05SBarry Smith         }
5136bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
514e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
515d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
516d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr);
5173a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
5183a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
5196ce1633cSBarry Smith       } else {
520c5929fdfSBarry Smith         ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
5217287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
522d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
523d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
5246c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
5256c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
526d32f9abdSBarry Smith         }
5276dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
5289f001fe8SStefano Zampini           Mat       M = pc->pmat;
529f3b928b9SStefano Zampini           PetscBool isnest;
530f3b928b9SStefano Zampini 
531d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
532f3b928b9SStefano Zampini           ierr = PetscObjectTypeCompare((PetscObject)pc->pmat,MATNEST,&isnest);CHKERRQ(ierr);
533f3b928b9SStefano Zampini           if (!isnest) {
5349f001fe8SStefano Zampini             M    = pc->mat;
535f3b928b9SStefano Zampini             ierr = PetscObjectTypeCompare((PetscObject)pc->mat,MATNEST,&isnest);CHKERRQ(ierr);
536f3b928b9SStefano Zampini           }
537f3b928b9SStefano Zampini           if (isnest) {
538f3b928b9SStefano Zampini             IS       *fields;
539f3b928b9SStefano Zampini             PetscInt nf;
540f3b928b9SStefano Zampini 
5419f001fe8SStefano Zampini             ierr = MatNestGetSize(M,&nf,NULL);CHKERRQ(ierr);
542f3b928b9SStefano Zampini             ierr = PetscMalloc1(nf,&fields);CHKERRQ(ierr);
5439f001fe8SStefano Zampini             ierr = MatNestGetISs(M,fields,NULL);CHKERRQ(ierr);
544f3b928b9SStefano Zampini             for (i=0;i<nf;i++) {
545f3b928b9SStefano Zampini               ierr = PCFieldSplitSetIS(pc,NULL,fields[i]);CHKERRQ(ierr);
546f3b928b9SStefano Zampini             }
547f3b928b9SStefano Zampini             ierr = PetscFree(fields);CHKERRQ(ierr);
548f3b928b9SStefano Zampini           } else {
549db4c96c1SJed Brown             for (i=0; i<jac->bs; i++) {
5506c924f48SJed Brown               char splitname[8];
5518caf3d72SBarry Smith               ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
5525d4c12cdSJungho Lee               ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
55379416396SBarry Smith             }
5545d4c12cdSJungho Lee             jac->defaultsplit = PETSC_TRUE;
555521d7252SBarry Smith           }
55666ffff09SJed Brown         }
5576ce1633cSBarry Smith       }
558f3b928b9SStefano Zampini     }
559edf189efSBarry Smith   } else if (jac->nsplits == 1) {
560edf189efSBarry Smith     if (ilink->is) {
561edf189efSBarry Smith       IS       is2;
562edf189efSBarry Smith       PetscInt nmin,nmax;
563edf189efSBarry Smith 
564edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
565edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
566db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
567fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
56882f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
569edf189efSBarry Smith   }
570d0af7cd3SBarry Smith 
57182f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
57269a612a9SBarry Smith   PetscFunctionReturn(0);
57369a612a9SBarry Smith }
57469a612a9SBarry Smith 
575a51937d4SCarola Kruse static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A,Mat B,Mat C,Mat *H,PetscReal gkbnu)
576a51937d4SCarola Kruse {
577a51937d4SCarola Kruse   PetscErrorCode    ierr;
578a51937d4SCarola Kruse   Mat               BT,T;
579de482cd7SCarola Kruse   PetscReal         nrmT,nrmB;
580a51937d4SCarola Kruse 
581a51937d4SCarola Kruse   PetscFunctionBegin;
582a51937d4SCarola Kruse   ierr = MatHermitianTranspose(C,MAT_INITIAL_MATRIX,&T);CHKERRQ(ierr);            /* Test if augmented matrix is symmetric */
583a51937d4SCarola Kruse   ierr = MatAXPY(T,-1.0,B,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
584de482cd7SCarola Kruse   ierr = MatNorm(T,NORM_1,&nrmT);CHKERRQ(ierr);
585de482cd7SCarola Kruse   ierr = MatNorm(B,NORM_1,&nrmB);CHKERRQ(ierr);
586de482cd7SCarola Kruse   if (nrmB > 0) {
587de482cd7SCarola Kruse     if (nrmT/nrmB >= PETSC_SMALL) {
588de482cd7SCarola Kruse       SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Matrix is not symmetric/hermitian, GKB is not applicable.");
589de482cd7SCarola Kruse     }
590a51937d4SCarola Kruse   }
591a51937d4SCarola Kruse   /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */
592a51937d4SCarola Kruse   /* setting N := 1/nu*I in [Ar13].                                                 */
593a51937d4SCarola Kruse   ierr = MatHermitianTranspose(B,MAT_INITIAL_MATRIX,&BT);CHKERRQ(ierr);
594a51937d4SCarola Kruse   ierr = MatMatMult(B,BT,MAT_INITIAL_MATRIX,PETSC_DEFAULT,H);CHKERRQ(ierr);       /* H = A01*A01'          */
595a51937d4SCarola Kruse   ierr = MatAYPX(*H,gkbnu,A,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);             /* H = A00 + nu*A01*A01' */
596a51937d4SCarola Kruse 
597a51937d4SCarola Kruse   ierr = MatDestroy(&BT);CHKERRQ(ierr);
598a51937d4SCarola Kruse   ierr = MatDestroy(&T);CHKERRQ(ierr);
599a51937d4SCarola Kruse   PetscFunctionReturn(0);
600a51937d4SCarola Kruse }
601a51937d4SCarola Kruse 
6022d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[],const char *value[],PetscBool *flg);
603514bf10dSMatthew G Knepley 
60469a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
60569a612a9SBarry Smith {
60669a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
60769a612a9SBarry Smith   PetscErrorCode    ierr;
6085a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
6092c9966d7SBarry Smith   PetscInt          i,nsplit;
6105f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
61169a612a9SBarry Smith 
61269a612a9SBarry Smith   PetscFunctionBegin;
6135da88fe4STristan Konolige   pc->failedreason = PC_NOERROR;
61469a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
61597bbdb24SBarry Smith   nsplit = jac->nsplits;
6165a9f2f41SSatish Balay   ilink  = jac->head;
61797bbdb24SBarry Smith 
61897bbdb24SBarry Smith   /* get the matrices for each split */
619704ba839SBarry Smith   if (!jac->issetup) {
6201b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
62197bbdb24SBarry Smith 
622704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
623704ba839SBarry Smith 
6245d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
6252c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
6262c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
6272c9966d7SBarry Smith     }
62851f519a2SBarry Smith     bs     = jac->bs;
62997bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
6301b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
6311b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
6321b9fc7fcSBarry Smith       if (jac->defaultsplit) {
633ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
6345f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
635704ba839SBarry Smith       } else if (!ilink->is) {
636ccb205f8SBarry Smith         if (ilink->nfields > 1) {
6375f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
638785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
639785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
6401b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
6411b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
6421b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
6435f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
64497bbdb24SBarry Smith             }
64597bbdb24SBarry Smith           }
646ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
647ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
64890e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
64990e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
650ccb205f8SBarry Smith         } else {
651ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
652ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
653ccb205f8SBarry Smith         }
6543e197d65SBarry Smith       }
655704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
6565f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
6575f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
658704ba839SBarry Smith       ilink = ilink->next;
6591b9fc7fcSBarry Smith     }
6601b9fc7fcSBarry Smith   }
6611b9fc7fcSBarry Smith 
662704ba839SBarry Smith   ilink = jac->head;
66397bbdb24SBarry Smith   if (!jac->pmat) {
664bdddcaaaSMatthew G Knepley     Vec xtmp;
665bdddcaaaSMatthew G Knepley 
6662a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
667785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
668dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
669cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
670bdddcaaaSMatthew G Knepley       MatNullSpace sp;
671bdddcaaaSMatthew G Knepley 
672a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
673a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
674a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
675a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
676a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
677a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
6782fa5cd67SKarl Rupp 
679a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
680a3df900dSMatthew G Knepley         }
681a3df900dSMatthew G Knepley       } else {
6823a062f41SBarry Smith         const char *prefix;
6837dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
6843a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
6853a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
6863a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
687a3df900dSMatthew G Knepley       }
688bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
6892a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
6900298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
691bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
6929448b7f1SJunchao Zhang       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
693ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
694ed1f0337SMatthew G Knepley       if (sp) {
695ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
696ed1f0337SMatthew G Knepley       }
697704ba839SBarry Smith       ilink = ilink->next;
698cf502942SBarry Smith     }
699bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
70097bbdb24SBarry Smith   } else {
701ef7efd37SHong Zhang     MatReuse scall;
702ef7efd37SHong Zhang     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
703ef7efd37SHong Zhang       for (i=0; i<nsplit; i++) {
704ef7efd37SHong Zhang         ierr = MatDestroy(&jac->pmat[i]);CHKERRQ(ierr);
705ef7efd37SHong Zhang       }
706ef7efd37SHong Zhang       scall = MAT_INITIAL_MATRIX;
707ef7efd37SHong Zhang     } else scall = MAT_REUSE_MATRIX;
708ef7efd37SHong Zhang 
709cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
710a3df900dSMatthew G Knepley       Mat pmat;
711a3df900dSMatthew G Knepley 
712a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
713a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
714a3df900dSMatthew G Knepley       if (!pmat) {
715ef7efd37SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,scall,&jac->pmat[i]);CHKERRQ(ierr);
716a3df900dSMatthew G Knepley       }
717704ba839SBarry Smith       ilink = ilink->next;
718cf502942SBarry Smith     }
71997bbdb24SBarry Smith   }
7204e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
721519d70e2SJed Brown     ilink = jac->head;
722519d70e2SJed Brown     if (!jac->mat) {
723785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
724519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
7257dae84e0SHong Zhang         ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
726519d70e2SJed Brown         ilink = ilink->next;
727519d70e2SJed Brown       }
728519d70e2SJed Brown     } else {
729ef7efd37SHong Zhang       MatReuse scall;
730ef7efd37SHong Zhang       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
731519d70e2SJed Brown         for (i=0; i<nsplit; i++) {
732ef7efd37SHong Zhang           ierr = MatDestroy(&jac->mat[i]);CHKERRQ(ierr);
733ef7efd37SHong Zhang         }
734ef7efd37SHong Zhang         scall = MAT_INITIAL_MATRIX;
735ef7efd37SHong Zhang       } else scall = MAT_REUSE_MATRIX;
736ef7efd37SHong Zhang 
737ef7efd37SHong Zhang       for (i=0; i<nsplit; i++) {
738e9422dd5SStefano Zampini         ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,scall,&jac->mat[i]);CHKERRQ(ierr);
739519d70e2SJed Brown         ilink = ilink->next;
740519d70e2SJed Brown       }
741519d70e2SJed Brown     }
742519d70e2SJed Brown   } else {
743519d70e2SJed Brown     jac->mat = jac->pmat;
744519d70e2SJed Brown   }
74597bbdb24SBarry Smith 
74653935eafSBarry Smith   /* Check for null space attached to IS */
74753935eafSBarry Smith   ilink = jac->head;
74853935eafSBarry Smith   for (i=0; i<nsplit; i++) {
74953935eafSBarry Smith     MatNullSpace sp;
75053935eafSBarry Smith 
75153935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
75253935eafSBarry Smith     if (sp) {
75353935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
75453935eafSBarry Smith     }
75553935eafSBarry Smith     ilink = ilink->next;
75653935eafSBarry Smith   }
75753935eafSBarry Smith 
758a51937d4SCarola Kruse   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) {
75968dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
7604e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
76168dd23aaSBarry Smith     ilink = jac->head;
762e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
763e52d2c62SBarry 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 */
764e52d2c62SBarry Smith       if (!jac->Afield) {
765e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
76680c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7677dae84e0SHong Zhang           ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
768e52d2c62SBarry Smith         } else {
7697dae84e0SHong Zhang           ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
77080c96bb1SFande Kong         }
77180c96bb1SFande Kong       } else {
772ef7efd37SHong Zhang         MatReuse scall;
773e9422dd5SStefano Zampini 
774ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
775ef7efd37SHong Zhang           ierr  = MatDestroy(&jac->Afield[1]);CHKERRQ(ierr);
776ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
777ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
778ef7efd37SHong Zhang 
77980c96bb1SFande Kong         if (jac->offdiag_use_amat) {
780ef7efd37SHong Zhang           ierr = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr);
78180c96bb1SFande Kong         } else {
782ef7efd37SHong Zhang           ierr = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr);
78380c96bb1SFande Kong         }
784e52d2c62SBarry Smith       }
785e52d2c62SBarry Smith     } else {
78668dd23aaSBarry Smith       if (!jac->Afield) {
787785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
78868dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
78980c96bb1SFande Kong           if (jac->offdiag_use_amat) {
7907dae84e0SHong Zhang             ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
79180c96bb1SFande Kong           } else {
7927dae84e0SHong Zhang             ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
79380c96bb1SFande Kong           }
79468dd23aaSBarry Smith           ilink = ilink->next;
79568dd23aaSBarry Smith         }
79668dd23aaSBarry Smith       } else {
797ef7efd37SHong Zhang         MatReuse scall;
798ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
799ef7efd37SHong Zhang           for (i=0; i<nsplit; i++) {
800ef7efd37SHong Zhang             ierr = MatDestroy(&jac->Afield[i]);CHKERRQ(ierr);
801ef7efd37SHong Zhang           }
802ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
803ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
804ef7efd37SHong Zhang 
80568dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
80680c96bb1SFande Kong           if (jac->offdiag_use_amat) {
807ef7efd37SHong Zhang             ierr = MatCreateSubMatrix(pc->mat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr);
80880c96bb1SFande Kong           } else {
809ef7efd37SHong Zhang             ierr = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr);
81080c96bb1SFande Kong           }
81168dd23aaSBarry Smith           ilink = ilink->next;
81268dd23aaSBarry Smith         }
81368dd23aaSBarry Smith       }
81468dd23aaSBarry Smith     }
815e52d2c62SBarry Smith   }
81668dd23aaSBarry Smith 
8173b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
8183b224e63SBarry Smith     IS          ccis;
819c096484dSStefano Zampini     PetscBool   isspd;
8204aa3045dSJed Brown     PetscInt    rstart,rend;
821093c86ffSJed Brown     char        lscname[256];
822093c86ffSJed Brown     PetscObject LSC_L;
823ce94432eSBarry Smith 
824ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
82568dd23aaSBarry Smith 
826c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
827c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
828c096484dSStefano Zampini       ierr = MatGetOption(pc->pmat,MAT_SPD,&isspd);CHKERRQ(ierr);
829c096484dSStefano Zampini       jac->schurscale = (isspd == PETSC_TRUE) ? 1.0 : -1.0;
830c096484dSStefano Zampini     }
831c096484dSStefano Zampini 
832e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
833e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
834e6cab6aaSJed Brown 
8353b224e63SBarry Smith     if (jac->schur) {
8360298fd71SBarry Smith       KSP      kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
837e9422dd5SStefano Zampini       MatReuse scall;
838e9422dd5SStefano Zampini 
839e9422dd5SStefano Zampini       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
840e9422dd5SStefano Zampini         scall = MAT_INITIAL_MATRIX;
841e9422dd5SStefano Zampini         ierr  = MatDestroy(&jac->B);CHKERRQ(ierr);
842e9422dd5SStefano Zampini         ierr  = MatDestroy(&jac->C);CHKERRQ(ierr);
843e9422dd5SStefano Zampini       } else scall = MAT_REUSE_MATRIX;
844443836d0SMatthew G Knepley 
845fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
8463b224e63SBarry Smith       ilink = jac->head;
84749bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8484e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
849e9422dd5SStefano Zampini         ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,scall,&jac->B);CHKERRQ(ierr);
850c84da90fSDmitry Karpeev       } else {
851e9422dd5SStefano Zampini         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,scall,&jac->B);CHKERRQ(ierr);
852c84da90fSDmitry Karpeev       }
853fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
8543b224e63SBarry Smith       ilink = ilink->next;
85549bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8564e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
857e9422dd5SStefano Zampini         ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,scall,&jac->C);CHKERRQ(ierr);
858c84da90fSDmitry Karpeev       } else {
859e9422dd5SStefano Zampini         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,scall,&jac->C);CHKERRQ(ierr);
860c84da90fSDmitry Karpeev       }
861fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
862aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
863a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
864a7476a74SDmitry Karpeev         ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
865a7476a74SDmitry Karpeev         ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
866a7476a74SDmitry Karpeev       }
867443836d0SMatthew G Knepley       if (kspA != kspInner) {
86823ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
869443836d0SMatthew G Knepley       }
870443836d0SMatthew G Knepley       if (kspUpper != kspA) {
87123ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
872443836d0SMatthew G Knepley       }
87323ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
8743b224e63SBarry Smith     } else {
875bafc1b83SMatthew G Knepley       const char   *Dprefix;
876470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
877514bf10dSMatthew G Knepley       char         schurtestoption[256];
878bdddcaaaSMatthew G Knepley       MatNullSpace sp;
879514bf10dSMatthew G Knepley       PetscBool    flg;
880686bed4dSStefano Zampini       KSP          kspt;
8813b224e63SBarry Smith 
882a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
8833b224e63SBarry Smith       ilink = jac->head;
88449bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8854e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8867dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
887c84da90fSDmitry Karpeev       } else {
8887dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
889c84da90fSDmitry Karpeev       }
890fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
8913b224e63SBarry Smith       ilink = ilink->next;
89249bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8934e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8947dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
895c84da90fSDmitry Karpeev       } else {
8967dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
897c84da90fSDmitry Karpeev       }
898fcfd50ebSBarry Smith       ierr = ISDestroy(&ccis);CHKERRQ(ierr);
89920252d06SBarry Smith 
900f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
90120252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
90220252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
903bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
904470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
905470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
906686bed4dSStefano Zampini       ierr = MatSchurComplementGetKSP(jac->schur,&kspt);CHKERRQ(ierr);
907686bed4dSStefano Zampini       ierr = KSPSetOptionsPrefix(kspt,schurmatprefix);CHKERRQ(ierr);
908686bed4dSStefano Zampini 
909686bed4dSStefano Zampini       /* Note: this is not true in general */
910895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
91120252d06SBarry Smith       if (sp) {
91220252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
91320252d06SBarry Smith       }
91420252d06SBarry Smith 
91520252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
916c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
917514bf10dSMatthew G Knepley       if (flg) {
918514bf10dSMatthew G Knepley         DM  dmInner;
91921635b76SJed Brown         KSP kspInner;
920686bed4dSStefano Zampini         PC  pcInner;
92121635b76SJed Brown 
92221635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
9232cc093acSMatthew G. Knepley         ierr = KSPReset(kspInner);CHKERRQ(ierr);
9242cc093acSMatthew G. Knepley         ierr = KSPSetOperators(kspInner,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
92521635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
92621635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
92721635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
9282cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject) pc, 2);CHKERRQ(ierr);
92921635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
930514bf10dSMatthew G Knepley 
931514bf10dSMatthew G Knepley         /* Set DM for new solver */
932bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
93321635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
93421635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
935686bed4dSStefano Zampini 
936686bed4dSStefano Zampini         /* Defaults to PCKSP as preconditioner */
937686bed4dSStefano Zampini         ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr);
938686bed4dSStefano Zampini         ierr = PCSetType(pcInner, PCKSP);CHKERRQ(ierr);
939686bed4dSStefano Zampini         ierr = PCKSPSetKSP(pcInner, jac->head->ksp);CHKERRQ(ierr);
940514bf10dSMatthew G Knepley       } else {
94121635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
94221635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
94321635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
94421635b76SJed 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
94521635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
94621635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
94721635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
948514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
949bafc1b83SMatthew G Knepley       }
95023ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
9515a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
95297bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
95397bbdb24SBarry Smith 
954686bed4dSStefano Zampini       ierr = PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg);CHKERRQ(ierr);
955686bed4dSStefano Zampini       if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */
956686bed4dSStefano Zampini         KSP kspInner;
957686bed4dSStefano Zampini         PC  pcInner;
958686bed4dSStefano Zampini 
959686bed4dSStefano Zampini         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
960686bed4dSStefano Zampini         ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr);
961686bed4dSStefano Zampini         ierr = PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg);CHKERRQ(ierr);
962686bed4dSStefano Zampini         if (flg) {
963686bed4dSStefano Zampini           KSP ksp;
964686bed4dSStefano Zampini 
965686bed4dSStefano Zampini           ierr = PCKSPGetKSP(pcInner, &ksp);CHKERRQ(ierr);
966686bed4dSStefano Zampini           if (ksp == jac->head->ksp) {
967686bed4dSStefano Zampini             ierr = PCSetUseAmat(pcInner, PETSC_TRUE);CHKERRQ(ierr);
968686bed4dSStefano Zampini           }
969686bed4dSStefano Zampini         }
970686bed4dSStefano Zampini       }
971443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
972c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
973443836d0SMatthew G Knepley       if (flg) {
974443836d0SMatthew G Knepley         DM dmInner;
975443836d0SMatthew G Knepley 
976443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
97782f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
978422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
979443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
9802cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject) pc, 1);CHKERRQ(ierr);
9812cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject) pc, 1);CHKERRQ(ierr);
982443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
983443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
984443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
985443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
98623ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
987443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
988443836d0SMatthew G Knepley       } else {
989443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
990443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
991443836d0SMatthew G Knepley       }
992443836d0SMatthew G Knepley 
993a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
994a7476a74SDmitry Karpeev         ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
995a7476a74SDmitry Karpeev       }
996ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
997422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
99897bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
99920252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
100097bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
10017233a360SDmitry Karpeev         PC pcschur;
10027233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
10037233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
100497bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
1005e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
1006e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
100797bbdb24SBarry Smith       }
100823ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
100997bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
101097bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
1011c096484dSStefano Zampini       /* propagate DM */
1012b20b4189SMatthew G. Knepley       {
1013b20b4189SMatthew G. Knepley         DM sdm;
1014b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
1015b20b4189SMatthew G. Knepley         if (sdm) {
1016b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
1017b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
1018b20b4189SMatthew G. Knepley         }
1019b20b4189SMatthew G. Knepley       }
102097bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
102197bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
102297bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
102397bbdb24SBarry Smith     }
1024686bed4dSStefano Zampini     ierr = MatAssemblyBegin(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
1025686bed4dSStefano Zampini     ierr = MatAssemblyEnd(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
102697bbdb24SBarry Smith 
10275a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
10288caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
1029519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
10303b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
1031c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
10328caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
103397bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
10345a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
10350971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
1036a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1037a51937d4SCarola Kruse     IS          ccis;
1038a51937d4SCarola Kruse     PetscInt    rstart,rend;
1039a51937d4SCarola Kruse 
1040a51937d4SCarola Kruse     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use GKB preconditioner you must have exactly 2 fields");
1041a51937d4SCarola Kruse 
1042a51937d4SCarola Kruse     ilink = jac->head;
1043a51937d4SCarola Kruse 
1044a51937d4SCarola Kruse     /* When extracting off-diagonal submatrices, we take complements from this range */
1045a51937d4SCarola Kruse     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
1046a51937d4SCarola Kruse 
1047a51937d4SCarola Kruse     ierr = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
1048a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
1049a51937d4SCarola Kruse       ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
1050a51937d4SCarola Kruse     } else {
1051a51937d4SCarola Kruse       ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
1052a51937d4SCarola Kruse     }
1053a51937d4SCarola Kruse     ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
1054e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
1055e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->u);CHKERRQ(ierr);
1056e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->Hu);CHKERRQ(ierr);
1057e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->w2);CHKERRQ(ierr);
1058a51937d4SCarola Kruse     ilink = ilink->next;
1059a51937d4SCarola Kruse     ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
1060a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
1061a51937d4SCarola Kruse       ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
1062a51937d4SCarola Kruse     } else {
1063a51937d4SCarola Kruse       ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
1064a51937d4SCarola Kruse     }
1065a51937d4SCarola Kruse     ierr = ISDestroy(&ccis);CHKERRQ(ierr);
1066e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
1067e071a0a4SCarola Kruse     ierr = VecDuplicate(ilink->x,&jac->v);CHKERRQ(ierr);
1068e071a0a4SCarola Kruse     ierr = VecDuplicate(ilink->x,&jac->d);CHKERRQ(ierr);
1069e071a0a4SCarola Kruse     ierr = VecDuplicate(ilink->x,&jac->w1);CHKERRQ(ierr);
1070a51937d4SCarola Kruse     ierr = MatGolubKahanComputeExplicitOperator(jac->mat[0],jac->B,jac->C,&jac->H,jac->gkbnu);CHKERRQ(ierr);
1071e071a0a4SCarola Kruse     ierr = PetscCalloc1(jac->gkbdelay,&jac->vecz);CHKERRQ(ierr);
1072e071a0a4SCarola Kruse 
1073a51937d4SCarola Kruse     ilink = jac->head;
1074a51937d4SCarola Kruse     ierr  = KSPSetOperators(ilink->ksp,jac->H,jac->H);CHKERRQ(ierr);
1075a51937d4SCarola Kruse     if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
1076e071a0a4SCarola Kruse     /* Create gkb_monitor context */
1077de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1078de482cd7SCarola Kruse       PetscInt  tablevel;
1079de482cd7SCarola Kruse       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&jac->gkbviewer);CHKERRQ(ierr);
1080de482cd7SCarola Kruse       ierr = PetscViewerSetType(jac->gkbviewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1081de482cd7SCarola Kruse       ierr = PetscObjectGetTabLevel((PetscObject)ilink->ksp,&tablevel);CHKERRQ(ierr);
1082e071a0a4SCarola Kruse       ierr = PetscViewerASCIISetTab(jac->gkbviewer,tablevel);CHKERRQ(ierr);
1083de482cd7SCarola Kruse       ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)ilink->ksp,1);CHKERRQ(ierr);
1084de482cd7SCarola Kruse     }
10850971522cSBarry Smith   } else {
108668bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
10870971522cSBarry Smith     i     = 0;
10880971522cSBarry Smith     ilink = jac->head;
10890971522cSBarry Smith     while (ilink) {
109023ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
10910971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
10920971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
10930971522cSBarry Smith       i++;
10940971522cSBarry Smith       ilink = ilink->next;
10950971522cSBarry Smith     }
10963b224e63SBarry Smith   }
10973b224e63SBarry Smith 
1098c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
10990971522cSBarry Smith   PetscFunctionReturn(0);
11000971522cSBarry Smith }
11010971522cSBarry Smith 
11025a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
1103ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
1104ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
11059df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
11065a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) ||                               \
1107c0decd05SBarry Smith    KSPCheckSolve(ilink->ksp,pc,ilink->y)  || \
11089df09d43SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
1109ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) ||  \
1110ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
111179416396SBarry Smith 
11123b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
11133b224e63SBarry Smith {
11143b224e63SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
11153b224e63SBarry Smith   PetscErrorCode     ierr;
11163b224e63SBarry Smith   PC_FieldSplitLink  ilinkA = jac->head, ilinkD = ilinkA->next;
1117443836d0SMatthew G Knepley   KSP                kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
11183b224e63SBarry Smith 
11193b224e63SBarry Smith   PetscFunctionBegin;
1120c5d2311dSJed Brown   switch (jac->schurfactorization) {
1121c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
1122a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
1123c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1124c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1125c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11269df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1127443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1128c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11299df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1130c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1131c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11329df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1133c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1134c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11359df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1136c096484dSStefano Zampini     ierr = VecScale(ilinkD->y,jac->schurscale);CHKERRQ(ierr);
1137c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1138653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1139c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1140c5d2311dSJed Brown     break;
1141c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
1142a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
1143c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1144c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11459df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1146443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1147c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11489df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1149c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
1150c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
1151c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1152c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1153c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11549df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1155c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1156c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11579df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1158c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1159653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1160c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1161c5d2311dSJed Brown     break;
1162c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
1163a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
1164c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1165c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11669df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1167c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1168c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11699df09d43SBarry 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);
1170c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
1171c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1172c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1173c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11749df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1175443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1176c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11779df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1178c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1179653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1180c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1181c5d2311dSJed Brown     break;
1182c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
1183c238f8cdSStefano Zampini     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */
11843b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11853b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11869df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1187443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1188c0decd05SBarry Smith     ierr = KSPCheckSolve(kspLower,pc,ilinkA->y);CHKERRQ(ierr);
11899df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
11903b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
11913b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
11923b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11933b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11943b224e63SBarry Smith 
11959df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
11963b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1197c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11989df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
11993b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12003b224e63SBarry Smith 
1201443836d0SMatthew G Knepley     if (kspUpper == kspA) {
12023b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
12033b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
12049df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1205443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1206c0decd05SBarry Smith       ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
12079df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1208443836d0SMatthew G Knepley     } else {
12099df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1210443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1211c0decd05SBarry Smith       ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
1212443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
12139df09d43SBarry Smith       ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
1214443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
1215c0decd05SBarry Smith       ierr = KSPCheckSolve(kspUpper,pc,ilinkA->z);CHKERRQ(ierr);
12169df09d43SBarry Smith       ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
1217443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
1218443836d0SMatthew G Knepley     }
1219c238f8cdSStefano Zampini     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12203b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12213b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1222c5d2311dSJed Brown   }
12233b224e63SBarry Smith   PetscFunctionReturn(0);
12243b224e63SBarry Smith }
12253b224e63SBarry Smith 
12260971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
12270971522cSBarry Smith {
12280971522cSBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
12290971522cSBarry Smith   PetscErrorCode     ierr;
12305a9f2f41SSatish Balay   PC_FieldSplitLink  ilink = jac->head;
1231939b8a20SBarry Smith   PetscInt           cnt,bs;
12320971522cSBarry Smith 
12330971522cSBarry Smith   PetscFunctionBegin;
123479416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
12351b9fc7fcSBarry Smith     if (jac->defaultsplit) {
1236939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1237ce94432eSBarry 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);
1238939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1239ce94432eSBarry 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);
12400971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
12415a9f2f41SSatish Balay       while (ilink) {
12429df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12435a9f2f41SSatish Balay         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1244c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12459df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12465a9f2f41SSatish Balay         ilink = ilink->next;
12470971522cSBarry Smith       }
12480971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
12491b9fc7fcSBarry Smith     } else {
1250efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
12515a9f2f41SSatish Balay       while (ilink) {
12525a9f2f41SSatish Balay         ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
12535a9f2f41SSatish Balay         ilink = ilink->next;
12541b9fc7fcSBarry Smith       }
12551b9fc7fcSBarry Smith     }
1256e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
1257e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1258e52d2c62SBarry Smith     /* solve on first block for first block variables */
1259e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1260e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12619df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1262e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1263c0decd05SBarry Smith     ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12649df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1265e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1266e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1267e52d2c62SBarry Smith 
1268e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
1269e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
1270e52d2c62SBarry Smith     ilink = ilink->next;
1271e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
1272e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1273e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1274e52d2c62SBarry Smith 
1275e52d2c62SBarry Smith     /* solve on second block variables */
12769df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1277e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1278c0decd05SBarry Smith     ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12799df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1280e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1281e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
128216913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
128379416396SBarry Smith     if (!jac->w1) {
128479416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
128579416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
128679416396SBarry Smith     }
1287efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
12885a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
12893e197d65SBarry Smith     cnt  = 1;
12905a9f2f41SSatish Balay     while (ilink->next) {
12915a9f2f41SSatish Balay       ilink = ilink->next;
12923e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
12933e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
12943e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
12953e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12963e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12979df09d43SBarry Smith       ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12983e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1299c0decd05SBarry Smith       ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
13009df09d43SBarry Smith       ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
13013e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
13023e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
13033e197d65SBarry Smith     }
130451f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
130511755939SBarry Smith       cnt -= 2;
130651f519a2SBarry Smith       while (ilink->previous) {
130751f519a2SBarry Smith         ilink = ilink->previous;
130811755939SBarry Smith         /* compute the residual only over the part of the vector needed */
130911755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
131011755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
131111755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
131211755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
13139df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
131411755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1315c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
13169df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
131711755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
131811755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
131951f519a2SBarry Smith       }
132011755939SBarry Smith     }
1321ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
13220971522cSBarry Smith   PetscFunctionReturn(0);
13230971522cSBarry Smith }
13240971522cSBarry Smith 
1325a51937d4SCarola Kruse 
1326a51937d4SCarola Kruse static PetscErrorCode PCApply_FieldSplit_GKB(PC pc,Vec x,Vec y)
1327a51937d4SCarola Kruse {
1328a51937d4SCarola Kruse   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1329a51937d4SCarola Kruse   PetscErrorCode     ierr;
1330a51937d4SCarola Kruse   PC_FieldSplitLink  ilinkA = jac->head,ilinkD = ilinkA->next;
1331a51937d4SCarola Kruse   KSP                ksp = ilinkA->ksp;
1332de482cd7SCarola Kruse   Vec                u,v,Hu,d,work1,work2;
1333e071a0a4SCarola Kruse   PetscScalar        alpha,z,nrmz2,*vecz;
1334e071a0a4SCarola Kruse   PetscReal          lowbnd,nu,beta;
1335a51937d4SCarola Kruse   PetscInt           j,iterGKB;
1336a51937d4SCarola Kruse 
1337a51937d4SCarola Kruse   PetscFunctionBegin;
1338a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1339a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1340de482cd7SCarola Kruse   ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1341a51937d4SCarola Kruse   ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1342e071a0a4SCarola Kruse 
1343e071a0a4SCarola Kruse   u     = jac->u;
1344e071a0a4SCarola Kruse   v     = jac->v;
1345e071a0a4SCarola Kruse   Hu    = jac->Hu;
1346e071a0a4SCarola Kruse   d     = jac->d;
1347e071a0a4SCarola Kruse   work1 = jac->w1;
1348e071a0a4SCarola Kruse   work2 = jac->w2;
1349e071a0a4SCarola Kruse   vecz  = jac->vecz;
1350a51937d4SCarola Kruse 
1351a51937d4SCarola Kruse   /* Change RHS to comply with matrix regularization H = A + nu*B*B' */
1352a51937d4SCarola Kruse   /* Add q = q + nu*B*b */
1353a51937d4SCarola Kruse   if (jac->gkbnu) {
1354a51937d4SCarola Kruse     nu = jac->gkbnu;
1355de482cd7SCarola Kruse     ierr = VecScale(ilinkD->x,jac->gkbnu);CHKERRQ(ierr);
1356de482cd7SCarola Kruse     ierr = MatMultAdd(jac->B,ilinkD->x,ilinkA->x,ilinkA->x);CHKERRQ(ierr);            /* q = q + nu*B*b */
1357a51937d4SCarola Kruse   } else {
1358a51937d4SCarola Kruse     /* Situation when no augmented Lagrangian is used. Then we set inner  */
1359a51937d4SCarola Kruse     /* matrix N = I in [Ar13], and thus nu = 1.                           */
1360a51937d4SCarola Kruse     nu = 1;
1361a51937d4SCarola Kruse   }
1362a51937d4SCarola Kruse 
1363a51937d4SCarola Kruse   /* Transform rhs from [q,tilde{b}] to [0,b] */
1364de482cd7SCarola Kruse   ierr = PetscLogEventBegin(ilinkA->event,ksp,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1365de482cd7SCarola Kruse   ierr = KSPSolve(ksp,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1366c0decd05SBarry Smith   ierr = KSPCheckSolve(ksp,pc,ilinkA->y);CHKERRQ(ierr);
1367de482cd7SCarola Kruse   ierr = PetscLogEventEnd(ilinkA->event,ksp,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1368a51937d4SCarola Kruse   ierr = MatMultHermitianTranspose(jac->B,ilinkA->y,work1);CHKERRQ(ierr);
136992c1e38eSCarola Kruse   ierr = VecAXPBY(work1,1.0/nu,-1.0,ilinkD->x);CHKERRQ(ierr);            /* c = b - B'*x        */
1370a51937d4SCarola Kruse 
1371a51937d4SCarola Kruse   /* First step of algorithm */
1372de482cd7SCarola Kruse   ierr  = VecNorm(work1,NORM_2,&beta);CHKERRQ(ierr);                   /* beta = sqrt(nu*c'*c)*/
1373e071a0a4SCarola Kruse   KSPCheckDot(ksp,beta);
1374*addd1e01SJunchao Zhang   beta  = PetscSqrtReal(nu)*beta;
137592c1e38eSCarola Kruse   ierr  = VecAXPBY(v,nu/beta,0.0,work1);CHKERRQ(ierr);                   /* v = nu/beta *c      */
1376a51937d4SCarola Kruse   ierr  = MatMult(jac->B,v,work2);CHKERRQ(ierr);                       /* u = H^{-1}*B*v      */
1377a51937d4SCarola Kruse   ierr  = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1378a51937d4SCarola Kruse   ierr  = KSPSolve(ksp,work2,u);CHKERRQ(ierr);
1379c0decd05SBarry Smith   ierr  = KSPCheckSolve(ksp,pc,u);CHKERRQ(ierr);
1380a51937d4SCarola Kruse   ierr  = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1381a51937d4SCarola Kruse   ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);                          /* alpha = u'*H*u      */
1382a51937d4SCarola Kruse   ierr  = VecDot(Hu,u,&alpha);CHKERRQ(ierr);
1383e071a0a4SCarola Kruse   KSPCheckDot(ksp,alpha);
1384e071a0a4SCarola Kruse   if (PetscRealPart(alpha) <= 0.0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_NOT_CONVERGED,"GKB preconditioner diverged, H is not positive definite");
1385*addd1e01SJunchao Zhang   alpha = PetscSqrtReal(PetscAbsScalar(alpha));
138692c1e38eSCarola Kruse   ierr  = VecScale(u,1.0/alpha);CHKERRQ(ierr);
138792c1e38eSCarola Kruse   ierr  = VecAXPBY(d,1.0/alpha,0.0,v);CHKERRQ(ierr);                       /* v = nu/beta *c      */
1388de482cd7SCarola Kruse 
1389a51937d4SCarola Kruse   z = beta/alpha;
1390a51937d4SCarola Kruse   vecz[1] = z;
1391a51937d4SCarola Kruse 
1392de482cd7SCarola Kruse   /* Computation of first iterate x(1) and p(1) */
1393a51937d4SCarola Kruse   ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr);
1394a51937d4SCarola Kruse   ierr = VecCopy(d,ilinkD->y);CHKERRQ(ierr);
1395a51937d4SCarola Kruse   ierr = VecScale(ilinkD->y,-z);CHKERRQ(ierr);
1396a51937d4SCarola Kruse 
1397a51937d4SCarola Kruse   iterGKB = 1; lowbnd = 2*jac->gkbtol;
1398de482cd7SCarola Kruse   if (jac->gkbmonitor) {
1399de482cd7SCarola Kruse       ierr = PetscViewerASCIIPrintf(jac->gkbviewer,"%3D GKB Lower bound estimate %14.12e\n",iterGKB,lowbnd);CHKERRQ(ierr);
1400de482cd7SCarola Kruse   }
1401de482cd7SCarola Kruse 
1402a51937d4SCarola Kruse   while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) {
1403a51937d4SCarola Kruse     iterGKB += 1;
1404e071a0a4SCarola Kruse     ierr  = MatMultHermitianTranspose(jac->B,u,work1);CHKERRQ(ierr); /* v <- nu*(B'*u-alpha/nu*v) */
1405e071a0a4SCarola Kruse     ierr  = VecAXPBY(v,nu,-alpha,work1);CHKERRQ(ierr);
1406e071a0a4SCarola Kruse     ierr  = VecNorm(v,NORM_2,&beta);CHKERRQ(ierr);                   /* beta = sqrt(nu)*v'*v      */
1407*addd1e01SJunchao Zhang     beta  = beta/PetscSqrtReal(nu);
140892c1e38eSCarola Kruse     ierr  = VecScale(v,1.0/beta);CHKERRQ(ierr);
1409e071a0a4SCarola Kruse     ierr  = MatMult(jac->B,v,work2);CHKERRQ(ierr);                  /* u <- H^{-1}*(B*v-beta*H*u) */
1410a51937d4SCarola Kruse     ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);
1411a51937d4SCarola Kruse     ierr  = VecAXPY(work2,-beta,Hu);CHKERRQ(ierr);
1412a51937d4SCarola Kruse     ierr  = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1413a51937d4SCarola Kruse     ierr  = KSPSolve(ksp,work2,u);CHKERRQ(ierr);
1414c0decd05SBarry Smith     ierr  = KSPCheckSolve(ksp,pc,u);CHKERRQ(ierr);
1415a51937d4SCarola Kruse     ierr  = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1416a51937d4SCarola Kruse     ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);                      /* alpha = u'*H*u            */
1417a51937d4SCarola Kruse     ierr  = VecDot(Hu,u,&alpha);CHKERRQ(ierr);
1418e071a0a4SCarola Kruse     KSPCheckDot(ksp,alpha);
1419e071a0a4SCarola Kruse     if (PetscRealPart(alpha) <= 0.0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_NOT_CONVERGED,"GKB preconditioner diverged, H is not positive definite");
1420*addd1e01SJunchao Zhang     alpha = PetscSqrtReal(PetscAbsScalar(alpha));
142192c1e38eSCarola Kruse     ierr  = VecScale(u,1.0/alpha);CHKERRQ(ierr);
1422a51937d4SCarola Kruse 
1423e071a0a4SCarola Kruse     z = -beta/alpha*z;                                            /* z <- beta/alpha*z     */
1424a51937d4SCarola Kruse     vecz[0] = z;
1425a51937d4SCarola Kruse 
1426a51937d4SCarola Kruse     /* Computation of new iterate x(i+1) and p(i+1) */
142792c1e38eSCarola Kruse     ierr = VecAXPBY(d,1.0/alpha,-beta/alpha,v);CHKERRQ(ierr);       /* d = (v-beta*d)/alpha */
1428a51937d4SCarola Kruse     ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr);                  /* r = r + z*u          */
1429a51937d4SCarola Kruse     ierr = VecAXPY(ilinkD->y,-z,d);CHKERRQ(ierr);                 /* p = p - z*d          */
1430de482cd7SCarola Kruse     ierr = MatMult(jac->H,ilinkA->y,Hu);CHKERRQ(ierr);            /* ||u||_H = u'*H*u     */
1431a51937d4SCarola Kruse     ierr = VecDot(Hu,ilinkA->y,&nrmz2);CHKERRQ(ierr);
1432a51937d4SCarola Kruse 
1433a51937d4SCarola Kruse     /* Compute Lower Bound estimate */
1434a51937d4SCarola Kruse     if (iterGKB > jac->gkbdelay) {
1435a51937d4SCarola Kruse       lowbnd = 0.0;
1436a51937d4SCarola Kruse       for (j=0; j<jac->gkbdelay; j++) {
1437a51937d4SCarola Kruse         lowbnd += PetscAbsScalar(vecz[j]*vecz[j]);
1438a51937d4SCarola Kruse       }
1439*addd1e01SJunchao Zhang       lowbnd = PetscSqrtReal(lowbnd/PetscAbsScalar(nrmz2));
1440a51937d4SCarola Kruse     }
1441a51937d4SCarola Kruse 
1442a51937d4SCarola Kruse     for (j=0; j<jac->gkbdelay-1; j++) {
1443a51937d4SCarola Kruse       vecz[jac->gkbdelay-j-1] = vecz[jac->gkbdelay-j-2];
1444a51937d4SCarola Kruse     }
1445de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1446de482cd7SCarola Kruse       ierr = PetscViewerASCIIPrintf(jac->gkbviewer,"%3D GKB Lower bound estimate %14.12e\n",iterGKB,lowbnd);CHKERRQ(ierr);
1447de482cd7SCarola Kruse     }
1448a51937d4SCarola Kruse   }
1449a51937d4SCarola Kruse 
1450a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1451de482cd7SCarola Kruse   ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1452a29b4eb7SJunchao Zhang   ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1453a51937d4SCarola Kruse   ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1454a51937d4SCarola Kruse 
1455a51937d4SCarola Kruse   PetscFunctionReturn(0);
1456a51937d4SCarola Kruse }
1457a51937d4SCarola Kruse 
1458a51937d4SCarola Kruse 
1459421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1460ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1461ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
14629df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1463421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) ||                  \
1464c0decd05SBarry Smith    KSPCheckSolve(ilink->ksp,pc,ilink->x) || \
1465c0decd05SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) ||   \
1466ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1467ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1468421e10b8SBarry Smith 
1469421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1470421e10b8SBarry Smith {
1471421e10b8SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1472421e10b8SBarry Smith   PetscErrorCode     ierr;
1473421e10b8SBarry Smith   PC_FieldSplitLink  ilink = jac->head;
1474939b8a20SBarry Smith   PetscInt           bs;
1475421e10b8SBarry Smith 
1476421e10b8SBarry Smith   PetscFunctionBegin;
1477421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1478421e10b8SBarry Smith     if (jac->defaultsplit) {
1479939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1480ce94432eSBarry 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);
1481939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1482ce94432eSBarry 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);
1483421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1484421e10b8SBarry Smith       while (ilink) {
14859df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1486421e10b8SBarry Smith         ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1487c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
14889df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1489421e10b8SBarry Smith         ilink = ilink->next;
1490421e10b8SBarry Smith       }
1491421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1492421e10b8SBarry Smith     } else {
1493421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1494421e10b8SBarry Smith       while (ilink) {
1495421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1496421e10b8SBarry Smith         ilink = ilink->next;
1497421e10b8SBarry Smith       }
1498421e10b8SBarry Smith     }
1499421e10b8SBarry Smith   } else {
1500421e10b8SBarry Smith     if (!jac->w1) {
1501421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1502421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1503421e10b8SBarry Smith     }
1504421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1505421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1506421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1507421e10b8SBarry Smith       while (ilink->next) {
1508421e10b8SBarry Smith         ilink = ilink->next;
15099989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1510421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1511421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1512421e10b8SBarry Smith       }
1513421e10b8SBarry Smith       while (ilink->previous) {
1514421e10b8SBarry Smith         ilink = ilink->previous;
15159989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1516421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1517421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1518421e10b8SBarry Smith       }
1519421e10b8SBarry Smith     } else {
1520421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1521421e10b8SBarry Smith         ilink = ilink->next;
1522421e10b8SBarry Smith       }
1523421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1524421e10b8SBarry Smith       while (ilink->previous) {
1525421e10b8SBarry Smith         ilink = ilink->previous;
15269989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1527421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1528421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1529421e10b8SBarry Smith       }
1530421e10b8SBarry Smith     }
1531421e10b8SBarry Smith   }
1532421e10b8SBarry Smith   PetscFunctionReturn(0);
1533421e10b8SBarry Smith }
1534421e10b8SBarry Smith 
1535574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
15360971522cSBarry Smith {
15370971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
15380971522cSBarry Smith   PetscErrorCode    ierr;
15395a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
15400971522cSBarry Smith 
15410971522cSBarry Smith   PetscFunctionBegin;
15425a9f2f41SSatish Balay   while (ilink) {
1543f5f0d762SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1544fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1545fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1546443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1547fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1548fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1549b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1550f5f0d762SBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1551f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
1552f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
15535a9f2f41SSatish Balay     next  = ilink->next;
1554f5f0d762SBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
15555a9f2f41SSatish Balay     ilink = next;
15560971522cSBarry Smith   }
1557f5f0d762SBarry Smith   jac->head = NULL;
155805b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1559574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1560574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1561574deadeSBarry Smith   } else if (jac->mat) {
15620298fd71SBarry Smith     jac->mat = NULL;
1563574deadeSBarry Smith   }
156497bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
156568dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
1566f5f0d762SBarry Smith   jac->nsplits = 0;
15676bf464f9SBarry Smith   ierr = VecDestroy(&jac->w1);CHKERRQ(ierr);
15686bf464f9SBarry Smith   ierr = VecDestroy(&jac->w2);CHKERRQ(ierr);
15696bf464f9SBarry Smith   ierr = MatDestroy(&jac->schur);CHKERRQ(ierr);
1570a7476a74SDmitry Karpeev   ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
15716bf464f9SBarry Smith   ierr = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
15726bf464f9SBarry Smith   ierr = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1573d78dad28SBarry Smith   ierr = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
15746bf464f9SBarry Smith   ierr = MatDestroy(&jac->B);CHKERRQ(ierr);
15756bf464f9SBarry Smith   ierr = MatDestroy(&jac->C);CHKERRQ(ierr);
1576a51937d4SCarola Kruse   ierr = MatDestroy(&jac->H);CHKERRQ(ierr);
1577e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->u);CHKERRQ(ierr);
1578e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->v);CHKERRQ(ierr);
1579e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->Hu);CHKERRQ(ierr);
1580e071a0a4SCarola Kruse   ierr = VecDestroy(&jac->d);CHKERRQ(ierr);
1581e071a0a4SCarola Kruse   ierr = PetscFree(jac->vecz);CHKERRQ(ierr);
1582de482cd7SCarola Kruse   ierr = PetscViewerDestroy(&jac->gkbviewer);CHKERRQ(ierr);
15836dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1584574deadeSBarry Smith   PetscFunctionReturn(0);
1585574deadeSBarry Smith }
1586574deadeSBarry Smith 
1587574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1588574deadeSBarry Smith {
1589574deadeSBarry Smith   PetscErrorCode    ierr;
1590574deadeSBarry Smith 
1591574deadeSBarry Smith   PetscFunctionBegin;
1592574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1593c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1594285fb4e2SStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",NULL);CHKERRQ(ierr);
1595bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1596bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1597bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1598bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1599bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
160029f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
160137a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1602bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
16036dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr);
16040971522cSBarry Smith   PetscFunctionReturn(0);
16050971522cSBarry Smith }
16060971522cSBarry Smith 
16074416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
16080971522cSBarry Smith {
16091b9fc7fcSBarry Smith   PetscErrorCode  ierr;
16106c924f48SJed Brown   PetscInt        bs;
16117b752e3dSPatrick Sanan   PetscBool       flg;
16129dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
16133b224e63SBarry Smith   PCCompositeType ctype;
16141b9fc7fcSBarry Smith 
16150971522cSBarry Smith   PetscFunctionBegin;
1616e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
16174ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
161851f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
161951f519a2SBarry Smith   if (flg) {
162051f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
162151f519a2SBarry Smith   }
16222686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
16232686e3e9SMatthew 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);
16242686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
16252686e3e9SMatthew 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);
16267b752e3dSPatrick 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);
16277b752e3dSPatrick Sanan   ierr = PCFieldSplitSetDetectSaddlePoint(pc,jac->detect);CHKERRQ(ierr); /* Sets split type and Schur PC type */
16283b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
16293b224e63SBarry Smith   if (flg) {
16303b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
16313b224e63SBarry Smith   }
1632c30613efSMatthew Knepley   /* Only setup fields once */
1633c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1634d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1635d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
16366c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
16376c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1638d32f9abdSBarry Smith   }
1639c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1640c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1641c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
16420298fd71SBarry 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);
164329f8a81cSJed 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);
1644c096484dSStefano Zampini     ierr = PetscOptionsScalar("-pc_fieldsplit_schur_scale","Scale Schur complement","PCFieldSplitSetSchurScale",jac->schurscale,&jac->schurscale,NULL);CHKERRQ(ierr);
1645a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1646a51937d4SCarola Kruse     ierr = PetscOptionsReal("-pc_fieldsplit_gkb_tol","The tolerance for the lower bound stopping criterion","PCFieldSplitGKBTol",jac->gkbtol,&jac->gkbtol,NULL);CHKERRQ(ierr);
1647a51937d4SCarola Kruse     ierr = PetscOptionsInt("-pc_fieldsplit_gkb_delay","The delay value for lower bound criterion","PCFieldSplitGKBDelay",jac->gkbdelay,&jac->gkbdelay,NULL);CHKERRQ(ierr);
1648a51937d4SCarola Kruse     ierr = PetscOptionsReal("-pc_fieldsplit_gkb_nu","Parameter in augmented Lagrangian approach","PCFieldSplitGKBNu",jac->gkbnu,&jac->gkbnu,NULL);CHKERRQ(ierr);
1649e071a0a4SCarola Kruse     if (jac->gkbnu < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nu cannot be less than 0: value %f",jac->gkbnu);
1650a51937d4SCarola Kruse     ierr = PetscOptionsInt("-pc_fieldsplit_gkb_maxit","Maximum allowed number of iterations","PCFieldSplitGKBMaxit",jac->gkbmaxit,&jac->gkbmaxit,NULL);CHKERRQ(ierr);
1651de482cd7SCarola Kruse     ierr = PetscOptionsBool("-pc_fieldsplit_gkb_monitor","Prints number of GKB iterations and error","PCFieldSplitGKB",jac->gkbmonitor,&jac->gkbmonitor,NULL);CHKERRQ(ierr);
1652c5d2311dSJed Brown   }
16531b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
16540971522cSBarry Smith   PetscFunctionReturn(0);
16550971522cSBarry Smith }
16560971522cSBarry Smith 
16570971522cSBarry Smith /*------------------------------------------------------------------------------------*/
16580971522cSBarry Smith 
16591e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
16600971522cSBarry Smith {
166197bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
16620971522cSBarry Smith   PetscErrorCode    ierr;
16635a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
166469a612a9SBarry Smith   char              prefix[128];
16655d4c12cdSJungho Lee   PetscInt          i;
16660971522cSBarry Smith 
16670971522cSBarry Smith   PetscFunctionBegin;
16686c924f48SJed Brown   if (jac->splitdefined) {
16696c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
16706c924f48SJed Brown     PetscFunctionReturn(0);
16716c924f48SJed Brown   }
167251f519a2SBarry Smith   for (i=0; i<n; i++) {
1673e32f2f54SBarry 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);
1674e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
167551f519a2SBarry Smith   }
1676b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1677a04f6461SBarry Smith   if (splitname) {
1678db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1679a04f6461SBarry Smith   } else {
1680785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1681a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1682a04f6461SBarry Smith   }
16839df09d43SBarry 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 */
1684785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
1685580bdb30SBarry Smith   ierr = PetscArraycpy(ilink->fields,fields,n);CHKERRQ(ierr);
1686785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
1687580bdb30SBarry Smith   ierr = PetscArraycpy(ilink->fields_col,fields_col,n);CHKERRQ(ierr);
16882fa5cd67SKarl Rupp 
16895a9f2f41SSatish Balay   ilink->nfields = n;
16900298fd71SBarry Smith   ilink->next    = NULL;
1691ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1692422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
169320252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
16945a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
16959005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
169669a612a9SBarry Smith 
16978caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
16985a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
16990971522cSBarry Smith 
17000971522cSBarry Smith   if (!next) {
17015a9f2f41SSatish Balay     jac->head       = ilink;
17020298fd71SBarry Smith     ilink->previous = NULL;
17030971522cSBarry Smith   } else {
17040971522cSBarry Smith     while (next->next) {
17050971522cSBarry Smith       next = next->next;
17060971522cSBarry Smith     }
17075a9f2f41SSatish Balay     next->next      = ilink;
170851f519a2SBarry Smith     ilink->previous = next;
17090971522cSBarry Smith   }
17100971522cSBarry Smith   jac->nsplits++;
17110971522cSBarry Smith   PetscFunctionReturn(0);
17120971522cSBarry Smith }
17130971522cSBarry Smith 
1714285fb4e2SStefano Zampini static PetscErrorCode  PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
1715285fb4e2SStefano Zampini {
1716285fb4e2SStefano Zampini   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1717285fb4e2SStefano Zampini   PetscErrorCode ierr;
1718285fb4e2SStefano Zampini 
1719285fb4e2SStefano Zampini   PetscFunctionBegin;
1720285fb4e2SStefano Zampini   *subksp = NULL;
1721285fb4e2SStefano Zampini   if (n) *n = 0;
1722285fb4e2SStefano Zampini   if (jac->type == PC_COMPOSITE_SCHUR) {
1723285fb4e2SStefano Zampini     PetscInt nn;
1724285fb4e2SStefano Zampini 
1725285fb4e2SStefano Zampini     if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()");
1726285fb4e2SStefano Zampini     if (jac->nsplits != 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unexpected number of splits %D != 2",jac->nsplits);
1727285fb4e2SStefano Zampini     nn   = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0);
1728285fb4e2SStefano Zampini     ierr = PetscMalloc1(nn,subksp);CHKERRQ(ierr);
1729285fb4e2SStefano Zampini     (*subksp)[0] = jac->head->ksp;
1730285fb4e2SStefano Zampini     (*subksp)[1] = jac->kspschur;
1731285fb4e2SStefano Zampini     if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper;
1732285fb4e2SStefano Zampini     if (n) *n = nn;
1733285fb4e2SStefano Zampini   }
1734285fb4e2SStefano Zampini   PetscFunctionReturn(0);
1735285fb4e2SStefano Zampini }
1736285fb4e2SStefano Zampini 
17371e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1738e69d4d44SBarry Smith {
1739e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1740e69d4d44SBarry Smith   PetscErrorCode ierr;
1741e69d4d44SBarry Smith 
1742e69d4d44SBarry Smith   PetscFunctionBegin;
174334a3b412SBarry Smith   if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
1744785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1745e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
17462fa5cd67SKarl Rupp 
1747e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
174813e0d083SBarry Smith   if (n) *n = jac->nsplits;
1749e69d4d44SBarry Smith   PetscFunctionReturn(0);
1750e69d4d44SBarry Smith }
17510971522cSBarry Smith 
17521e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
17530971522cSBarry Smith {
17540971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
17550971522cSBarry Smith   PetscErrorCode    ierr;
17560971522cSBarry Smith   PetscInt          cnt   = 0;
17575a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
17580971522cSBarry Smith 
17590971522cSBarry Smith   PetscFunctionBegin;
1760785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
17615a9f2f41SSatish Balay   while (ilink) {
17625a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
17635a9f2f41SSatish Balay     ilink            = ilink->next;
17640971522cSBarry Smith   }
17655d480477SMatthew 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);
176613e0d083SBarry Smith   if (n) *n = jac->nsplits;
17670971522cSBarry Smith   PetscFunctionReturn(0);
17680971522cSBarry Smith }
17690971522cSBarry Smith 
17706dbb499eSCian Wilson /*@C
17716dbb499eSCian Wilson     PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS.
17726dbb499eSCian Wilson 
17736dbb499eSCian Wilson     Input Parameters:
17746dbb499eSCian Wilson +   pc  - the preconditioner context
1775a2b725a8SWilliam Gropp -   is - the index set that defines the indices to which the fieldsplit is to be restricted
17766dbb499eSCian Wilson 
17776dbb499eSCian Wilson     Level: advanced
17786dbb499eSCian Wilson 
17796dbb499eSCian Wilson @*/
17806dbb499eSCian Wilson PetscErrorCode  PCFieldSplitRestrictIS(PC pc,IS isy)
17816dbb499eSCian Wilson {
17826dbb499eSCian Wilson   PetscErrorCode ierr;
17836dbb499eSCian Wilson 
17846dbb499eSCian Wilson   PetscFunctionBegin;
17856dbb499eSCian Wilson   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
17866dbb499eSCian Wilson   PetscValidHeaderSpecific(isy,IS_CLASSID,2);
17870246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr);
17886dbb499eSCian Wilson   PetscFunctionReturn(0);
17896dbb499eSCian Wilson }
17906dbb499eSCian Wilson 
17916dbb499eSCian Wilson 
17926dbb499eSCian Wilson static PetscErrorCode  PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
17936dbb499eSCian Wilson {
17946dbb499eSCian Wilson   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
17956dbb499eSCian Wilson   PetscErrorCode    ierr;
17966dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
17976dbb499eSCian Wilson   PetscInt          localsize,size,sizez,i;
17986dbb499eSCian Wilson   const PetscInt    *ind, *indz;
17996dbb499eSCian Wilson   PetscInt          *indc, *indcz;
18006dbb499eSCian Wilson   PetscBool         flg;
18016dbb499eSCian Wilson 
18026dbb499eSCian Wilson   PetscFunctionBegin;
18036dbb499eSCian Wilson   ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr);
1804ffc4695bSBarry Smith   ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRMPI(ierr);
18056dbb499eSCian Wilson   size -= localsize;
18066dbb499eSCian Wilson   while (ilink) {
18076dbb499eSCian Wilson     IS isrl,isr;
18081c7cfba8SBarry Smith     PC subpc;
18096dbb499eSCian Wilson     ierr          = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
18106dbb499eSCian Wilson     ierr          = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr);
18116dbb499eSCian Wilson     ierr          = PetscMalloc1(localsize,&indc);CHKERRQ(ierr);
18126dbb499eSCian Wilson     ierr          = ISGetIndices(isrl,&ind);CHKERRQ(ierr);
1813580bdb30SBarry Smith     ierr          = PetscArraycpy(indc,ind,localsize);CHKERRQ(ierr);
18146dbb499eSCian Wilson     ierr          = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr);
18156dbb499eSCian Wilson     ierr          = ISDestroy(&isrl);CHKERRQ(ierr);
18166dbb499eSCian Wilson     for (i=0; i<localsize; i++) *(indc+i) += size;
18176dbb499eSCian Wilson     ierr          = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr);
18186dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
18196dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
18206dbb499eSCian Wilson     ilink->is     = isr;
18216dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
18226dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
18236dbb499eSCian Wilson     ilink->is_col = isr;
18246dbb499eSCian Wilson     ierr          = ISDestroy(&isr);CHKERRQ(ierr);
18256dbb499eSCian Wilson     ierr          = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr);
18266dbb499eSCian Wilson     ierr          = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr);
18276dbb499eSCian Wilson     if (flg) {
18286dbb499eSCian Wilson       IS iszl,isz;
18296dbb499eSCian Wilson       MPI_Comm comm;
18306dbb499eSCian Wilson       ierr   = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr);
18316dbb499eSCian Wilson       comm   = PetscObjectComm((PetscObject)ilink->is);
18326dbb499eSCian Wilson       ierr   = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr);
183355b25c41SPierre Jolivet       ierr   = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRMPI(ierr);
18346dbb499eSCian Wilson       sizez -= localsize;
18356dbb499eSCian Wilson       ierr   = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr);
18366dbb499eSCian Wilson       ierr   = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr);
18376dbb499eSCian Wilson       ierr   = ISGetIndices(iszl,&indz);CHKERRQ(ierr);
1838580bdb30SBarry Smith       ierr   = PetscArraycpy(indcz,indz,localsize);CHKERRQ(ierr);
18396dbb499eSCian Wilson       ierr   = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr);
18406dbb499eSCian Wilson       ierr   = ISDestroy(&iszl);CHKERRQ(ierr);
18416dbb499eSCian Wilson       for (i=0; i<localsize; i++) *(indcz+i) += sizez;
18426dbb499eSCian Wilson       ierr   = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr);
18436dbb499eSCian Wilson       ierr   = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr);
18446dbb499eSCian Wilson       ierr   = ISDestroy(&isz);CHKERRQ(ierr);
18456dbb499eSCian Wilson     }
18466dbb499eSCian Wilson     next = ilink->next;
18476dbb499eSCian Wilson     ilink = next;
18486dbb499eSCian Wilson   }
18496dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
18506dbb499eSCian Wilson   PetscFunctionReturn(0);
18516dbb499eSCian Wilson }
18526dbb499eSCian Wilson 
18531e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1854704ba839SBarry Smith {
1855704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1856704ba839SBarry Smith   PetscErrorCode    ierr;
1857704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1858704ba839SBarry Smith   char              prefix[128];
1859704ba839SBarry Smith 
1860704ba839SBarry Smith   PetscFunctionBegin;
18616c924f48SJed Brown   if (jac->splitdefined) {
18626c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
18636c924f48SJed Brown     PetscFunctionReturn(0);
18646c924f48SJed Brown   }
1865b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1866a04f6461SBarry Smith   if (splitname) {
1867db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1868a04f6461SBarry Smith   } else {
1869785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1870b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1871a04f6461SBarry Smith   }
18729df09d43SBarry 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 */
18731ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1874b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1875b5787286SJed Brown   ilink->is     = is;
1876b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1877b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1878b5787286SJed Brown   ilink->is_col = is;
18790298fd71SBarry Smith   ilink->next   = NULL;
1880ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1881422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
188220252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1883704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
18849005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1885704ba839SBarry Smith 
18868caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1887704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1888704ba839SBarry Smith 
1889704ba839SBarry Smith   if (!next) {
1890704ba839SBarry Smith     jac->head       = ilink;
18910298fd71SBarry Smith     ilink->previous = NULL;
1892704ba839SBarry Smith   } else {
1893704ba839SBarry Smith     while (next->next) {
1894704ba839SBarry Smith       next = next->next;
1895704ba839SBarry Smith     }
1896704ba839SBarry Smith     next->next      = ilink;
1897704ba839SBarry Smith     ilink->previous = next;
1898704ba839SBarry Smith   }
1899704ba839SBarry Smith   jac->nsplits++;
1900704ba839SBarry Smith   PetscFunctionReturn(0);
1901704ba839SBarry Smith }
1902704ba839SBarry Smith 
190394ef8ddeSSatish Balay /*@C
19040971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
19050971522cSBarry Smith 
1906ad4df100SBarry Smith     Logically Collective on PC
19070971522cSBarry Smith 
19080971522cSBarry Smith     Input Parameters:
19090971522cSBarry Smith +   pc  - the preconditioner context
19100298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
19110971522cSBarry Smith .   n - the number of fields in this split
1912db4c96c1SJed Brown -   fields - the fields in this split
19130971522cSBarry Smith 
19140971522cSBarry Smith     Level: intermediate
19150971522cSBarry Smith 
191695452b02SPatrick Sanan     Notes:
191795452b02SPatrick Sanan     Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1918d32f9abdSBarry Smith 
19197287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1920d32f9abdSBarry 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
1921d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1922d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1923d32f9abdSBarry Smith 
1924db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1925db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1926db4c96c1SJed Brown 
19275d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
19285d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
19295d4c12cdSJungho Lee      available when this routine is called.
19305d4c12cdSJungho Lee 
1931d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
19320971522cSBarry Smith 
19330971522cSBarry Smith @*/
19345d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
19350971522cSBarry Smith {
19364ac538c5SBarry Smith   PetscErrorCode ierr;
19370971522cSBarry Smith 
19380971522cSBarry Smith   PetscFunctionBegin;
19390700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1940db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1941ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1942db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
19430246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
19440971522cSBarry Smith   PetscFunctionReturn(0);
19450971522cSBarry Smith }
19460971522cSBarry Smith 
1947c84da90fSDmitry Karpeev /*@
1948c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1949c84da90fSDmitry Karpeev 
1950c84da90fSDmitry Karpeev     Logically Collective on PC
1951c84da90fSDmitry Karpeev 
1952c84da90fSDmitry Karpeev     Input Parameters:
1953c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1954c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1955c84da90fSDmitry Karpeev 
19569506b623SDmitry Karpeev     Options Database:
19579506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1958c84da90fSDmitry Karpeev 
1959c84da90fSDmitry Karpeev     Level: intermediate
1960c84da90fSDmitry Karpeev 
1961c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1962c84da90fSDmitry Karpeev 
1963c84da90fSDmitry Karpeev @*/
1964c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1965c84da90fSDmitry Karpeev {
1966c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1967c84da90fSDmitry Karpeev   PetscBool      isfs;
1968c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1969c84da90fSDmitry Karpeev 
1970c84da90fSDmitry Karpeev   PetscFunctionBegin;
1971c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1972c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1973c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1974c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1975c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1976c84da90fSDmitry Karpeev }
1977c84da90fSDmitry Karpeev 
1978c84da90fSDmitry Karpeev /*@
1979c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1980c84da90fSDmitry Karpeev 
1981c84da90fSDmitry Karpeev     Logically Collective on PC
1982c84da90fSDmitry Karpeev 
1983c84da90fSDmitry Karpeev     Input Parameters:
1984c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1985c84da90fSDmitry Karpeev 
1986c84da90fSDmitry Karpeev     Output Parameters:
1987c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1988c84da90fSDmitry Karpeev 
1989c84da90fSDmitry Karpeev 
1990c84da90fSDmitry Karpeev     Level: intermediate
1991c84da90fSDmitry Karpeev 
1992c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1993c84da90fSDmitry Karpeev 
1994c84da90fSDmitry Karpeev @*/
1995c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1996c84da90fSDmitry Karpeev {
1997c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1998c84da90fSDmitry Karpeev   PetscBool      isfs;
1999c84da90fSDmitry Karpeev   PetscErrorCode ierr;
2000c84da90fSDmitry Karpeev 
2001c84da90fSDmitry Karpeev   PetscFunctionBegin;
2002c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2003534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
2004c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2005c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
2006c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
2007c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2008c84da90fSDmitry Karpeev }
2009c84da90fSDmitry Karpeev 
2010c84da90fSDmitry Karpeev /*@
2011c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
2012c84da90fSDmitry Karpeev 
2013c84da90fSDmitry Karpeev     Logically Collective on PC
2014c84da90fSDmitry Karpeev 
2015c84da90fSDmitry Karpeev     Input Parameters:
2016c84da90fSDmitry Karpeev +   pc  - the preconditioner object
2017c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2018c84da90fSDmitry Karpeev 
20199506b623SDmitry Karpeev     Options Database:
20209506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
2021c84da90fSDmitry Karpeev 
2022c84da90fSDmitry Karpeev     Level: intermediate
2023c84da90fSDmitry Karpeev 
2024c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
2025c84da90fSDmitry Karpeev 
2026c84da90fSDmitry Karpeev @*/
2027c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
2028c84da90fSDmitry Karpeev {
2029c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2030c84da90fSDmitry Karpeev   PetscBool      isfs;
2031c84da90fSDmitry Karpeev   PetscErrorCode ierr;
2032c84da90fSDmitry Karpeev 
2033c84da90fSDmitry Karpeev   PetscFunctionBegin;
2034c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2035c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2036c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
2037c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
2038c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2039c84da90fSDmitry Karpeev }
2040c84da90fSDmitry Karpeev 
2041c84da90fSDmitry Karpeev /*@
2042c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
2043c84da90fSDmitry Karpeev 
2044c84da90fSDmitry Karpeev     Logically Collective on PC
2045c84da90fSDmitry Karpeev 
2046c84da90fSDmitry Karpeev     Input Parameters:
2047c84da90fSDmitry Karpeev .   pc  - the preconditioner object
2048c84da90fSDmitry Karpeev 
2049c84da90fSDmitry Karpeev     Output Parameters:
2050c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2051c84da90fSDmitry Karpeev 
2052c84da90fSDmitry Karpeev 
2053c84da90fSDmitry Karpeev     Level: intermediate
2054c84da90fSDmitry Karpeev 
2055c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
2056c84da90fSDmitry Karpeev 
2057c84da90fSDmitry Karpeev @*/
2058c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
2059c84da90fSDmitry Karpeev {
2060c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2061c84da90fSDmitry Karpeev   PetscBool      isfs;
2062c84da90fSDmitry Karpeev   PetscErrorCode ierr;
2063c84da90fSDmitry Karpeev 
2064c84da90fSDmitry Karpeev   PetscFunctionBegin;
2065c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2066534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
2067c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2068c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
2069c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
2070c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2071c84da90fSDmitry Karpeev }
2072c84da90fSDmitry Karpeev 
2073c84da90fSDmitry Karpeev 
2074c84da90fSDmitry Karpeev 
2075218d4943SBarry Smith /*@C
2076704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
2077704ba839SBarry Smith 
2078ad4df100SBarry Smith     Logically Collective on PC
2079704ba839SBarry Smith 
2080704ba839SBarry Smith     Input Parameters:
2081704ba839SBarry Smith +   pc  - the preconditioner context
20820298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
2083db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
2084704ba839SBarry Smith 
2085d32f9abdSBarry Smith 
2086a6ffb8dbSJed Brown     Notes:
2087a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
2088a6ffb8dbSJed Brown 
2089db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
2090db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
2091d32f9abdSBarry Smith 
2092704ba839SBarry Smith     Level: intermediate
2093704ba839SBarry Smith 
2094704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
2095704ba839SBarry Smith 
2096704ba839SBarry Smith @*/
20977087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
2098704ba839SBarry Smith {
20994ac538c5SBarry Smith   PetscErrorCode ierr;
2100704ba839SBarry Smith 
2101704ba839SBarry Smith   PetscFunctionBegin;
21020700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
21037b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
2104db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
2105ccc738f7SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
2106704ba839SBarry Smith   PetscFunctionReturn(0);
2107704ba839SBarry Smith }
2108704ba839SBarry Smith 
210994ef8ddeSSatish Balay /*@C
211057a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
211157a9adfeSMatthew G Knepley 
211257a9adfeSMatthew G Knepley     Logically Collective on PC
211357a9adfeSMatthew G Knepley 
211457a9adfeSMatthew G Knepley     Input Parameters:
211557a9adfeSMatthew G Knepley +   pc  - the preconditioner context
211657a9adfeSMatthew G Knepley -   splitname - name of this split
211757a9adfeSMatthew G Knepley 
211857a9adfeSMatthew G Knepley     Output Parameter:
21190298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
212057a9adfeSMatthew G Knepley 
212157a9adfeSMatthew G Knepley     Level: intermediate
212257a9adfeSMatthew G Knepley 
212357a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
212457a9adfeSMatthew G Knepley 
212557a9adfeSMatthew G Knepley @*/
212657a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
212757a9adfeSMatthew G Knepley {
212857a9adfeSMatthew G Knepley   PetscErrorCode ierr;
212957a9adfeSMatthew G Knepley 
213057a9adfeSMatthew G Knepley   PetscFunctionBegin;
213157a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
213257a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
213357a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
213457a9adfeSMatthew G Knepley   {
213557a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
213657a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
213757a9adfeSMatthew G Knepley     PetscBool         found;
213857a9adfeSMatthew G Knepley 
21390298fd71SBarry Smith     *is = NULL;
214057a9adfeSMatthew G Knepley     while (ilink) {
214157a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
214257a9adfeSMatthew G Knepley       if (found) {
214357a9adfeSMatthew G Knepley         *is = ilink->is;
214457a9adfeSMatthew G Knepley         break;
214557a9adfeSMatthew G Knepley       }
214657a9adfeSMatthew G Knepley       ilink = ilink->next;
214757a9adfeSMatthew G Knepley     }
214857a9adfeSMatthew G Knepley   }
214957a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
215057a9adfeSMatthew G Knepley }
215157a9adfeSMatthew G Knepley 
2152998f007dSPierre Jolivet /*@C
2153998f007dSPierre Jolivet     PCFieldSplitGetISByIndex - Retrieves the elements for a given index field as an IS
2154998f007dSPierre Jolivet 
2155998f007dSPierre Jolivet     Logically Collective on PC
2156998f007dSPierre Jolivet 
2157998f007dSPierre Jolivet     Input Parameters:
2158998f007dSPierre Jolivet +   pc  - the preconditioner context
2159998f007dSPierre Jolivet -   index - index of this split
2160998f007dSPierre Jolivet 
2161998f007dSPierre Jolivet     Output Parameter:
2162998f007dSPierre Jolivet -   is - the index set that defines the vector elements in this field
2163998f007dSPierre Jolivet 
2164998f007dSPierre Jolivet     Level: intermediate
2165998f007dSPierre Jolivet 
2166998f007dSPierre Jolivet .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitGetIS(), PCFieldSplitSetIS()
2167998f007dSPierre Jolivet 
2168998f007dSPierre Jolivet @*/
2169998f007dSPierre Jolivet PetscErrorCode PCFieldSplitGetISByIndex(PC pc,PetscInt index,IS *is)
2170998f007dSPierre Jolivet {
2171998f007dSPierre Jolivet   PetscErrorCode ierr;
2172998f007dSPierre Jolivet 
2173998f007dSPierre Jolivet   PetscFunctionBegin;
2174998f007dSPierre Jolivet   if (index < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",index);
2175998f007dSPierre Jolivet   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2176998f007dSPierre Jolivet   PetscValidPointer(is,3);
2177998f007dSPierre Jolivet   {
2178998f007dSPierre Jolivet     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
2179998f007dSPierre Jolivet     PC_FieldSplitLink ilink = jac->head;
2180998f007dSPierre Jolivet     PetscInt          i     = 0;
2181998f007dSPierre Jolivet     if (index >= jac->nsplits) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Field %D requested but only %D exist",index,jac->nsplits);
2182998f007dSPierre Jolivet 
2183998f007dSPierre Jolivet     while (i < index) {
2184998f007dSPierre Jolivet       ilink = ilink->next;
2185998f007dSPierre Jolivet       ++i;
2186998f007dSPierre Jolivet     }
2187998f007dSPierre Jolivet     ierr = PCFieldSplitGetIS(pc,ilink->splitname,is);CHKERRQ(ierr);
2188998f007dSPierre Jolivet   }
2189998f007dSPierre Jolivet   PetscFunctionReturn(0);
2190998f007dSPierre Jolivet }
2191998f007dSPierre Jolivet 
219251f519a2SBarry Smith /*@
219351f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
219451f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
219551f519a2SBarry Smith 
2196ad4df100SBarry Smith     Logically Collective on PC
219751f519a2SBarry Smith 
219851f519a2SBarry Smith     Input Parameters:
219951f519a2SBarry Smith +   pc  - the preconditioner context
220051f519a2SBarry Smith -   bs - the block size
220151f519a2SBarry Smith 
220251f519a2SBarry Smith     Level: intermediate
220351f519a2SBarry Smith 
220451f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
220551f519a2SBarry Smith 
220651f519a2SBarry Smith @*/
22077087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
220851f519a2SBarry Smith {
22094ac538c5SBarry Smith   PetscErrorCode ierr;
221051f519a2SBarry Smith 
221151f519a2SBarry Smith   PetscFunctionBegin;
22120700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2213c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
22144ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
221551f519a2SBarry Smith   PetscFunctionReturn(0);
221651f519a2SBarry Smith }
221751f519a2SBarry Smith 
22180971522cSBarry Smith /*@C
221969a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
22200971522cSBarry Smith 
222169a612a9SBarry Smith    Collective on KSP
22220971522cSBarry Smith 
22230971522cSBarry Smith    Input Parameter:
22240971522cSBarry Smith .  pc - the preconditioner context
22250971522cSBarry Smith 
22260971522cSBarry Smith    Output Parameters:
222713e0d083SBarry Smith +  n - the number of splits
22283111de3cSBarry Smith -  subksp - the array of KSP contexts
22290971522cSBarry Smith 
22300971522cSBarry Smith    Note:
22319a4f7e47SBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
2232d32f9abdSBarry Smith    (not the KSP just the array that contains them).
22330971522cSBarry Smith 
2234285fb4e2SStefano Zampini    You must call PCSetUp() before calling PCFieldSplitGetSubKSP().
2235285fb4e2SStefano Zampini 
2236285fb4e2SStefano Zampini    If the fieldsplit is of type PC_COMPOSITE_SCHUR, it returns the KSP object used inside the
2237285fb4e2SStefano Zampini    Schur complement and the KSP object used to iterate over the Schur complement.
2238a51937d4SCarola Kruse    To access all the KSP objects used in PC_COMPOSITE_SCHUR, use PCFieldSplitSchurGetSubKSP().
2239a51937d4SCarola Kruse 
2240a51937d4SCarola Kruse    If the fieldsplit is of type PC_COMPOSITE_GKB, it returns the KSP object used to solve the
2241a51937d4SCarola Kruse    inner linear system defined by the matrix H in each loop.
22420971522cSBarry Smith 
2243196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
22442bf68e3eSBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
2245196cc216SBarry Smith       KSP array must be.
2246196cc216SBarry Smith 
2247196cc216SBarry Smith 
22480971522cSBarry Smith    Level: advanced
22490971522cSBarry Smith 
22500971522cSBarry Smith .seealso: PCFIELDSPLIT
22510971522cSBarry Smith @*/
22527087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
22530971522cSBarry Smith {
22544ac538c5SBarry Smith   PetscErrorCode ierr;
22550971522cSBarry Smith 
22560971522cSBarry Smith   PetscFunctionBegin;
22570700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
225813e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
22594ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
22600971522cSBarry Smith   PetscFunctionReturn(0);
22610971522cSBarry Smith }
22620971522cSBarry Smith 
2263285fb4e2SStefano Zampini /*@C
2264285fb4e2SStefano Zampini    PCFieldSplitSchurGetSubKSP - Gets the KSP contexts used inside the Schur complement based PCFIELDSPLIT
2265285fb4e2SStefano Zampini 
2266285fb4e2SStefano Zampini    Collective on KSP
2267285fb4e2SStefano Zampini 
2268285fb4e2SStefano Zampini    Input Parameter:
2269285fb4e2SStefano Zampini .  pc - the preconditioner context
2270285fb4e2SStefano Zampini 
2271285fb4e2SStefano Zampini    Output Parameters:
2272285fb4e2SStefano Zampini +  n - the number of splits
2273285fb4e2SStefano Zampini -  subksp - the array of KSP contexts
2274285fb4e2SStefano Zampini 
2275285fb4e2SStefano Zampini    Note:
2276285fb4e2SStefano Zampini    After PCFieldSplitSchurGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
2277285fb4e2SStefano Zampini    (not the KSP just the array that contains them).
2278285fb4e2SStefano Zampini 
2279285fb4e2SStefano Zampini    You must call PCSetUp() before calling PCFieldSplitSchurGetSubKSP().
2280285fb4e2SStefano Zampini 
2281285fb4e2SStefano Zampini    If the fieldsplit type is of type PC_COMPOSITE_SCHUR, it returns (in order)
2282285fb4e2SStefano Zampini    - the KSP used for the (1,1) block
2283285fb4e2SStefano Zampini    - the KSP used for the Schur complement (not the one used for the interior Schur solver)
2284285fb4e2SStefano Zampini    - the KSP used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block).
2285285fb4e2SStefano Zampini 
2286285fb4e2SStefano Zampini    It returns a null array if the fieldsplit is not of type PC_COMPOSITE_SCHUR; in this case, you should use PCFieldSplitGetSubKSP().
2287285fb4e2SStefano Zampini 
2288285fb4e2SStefano Zampini    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
2289285fb4e2SStefano Zampini       You can call PCFieldSplitSchurGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
2290285fb4e2SStefano Zampini       KSP array must be.
2291285fb4e2SStefano Zampini 
2292285fb4e2SStefano Zampini    Level: advanced
2293285fb4e2SStefano Zampini 
2294285fb4e2SStefano Zampini .seealso: PCFIELDSPLIT
2295285fb4e2SStefano Zampini @*/
2296285fb4e2SStefano Zampini PetscErrorCode  PCFieldSplitSchurGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
2297285fb4e2SStefano Zampini {
2298285fb4e2SStefano Zampini   PetscErrorCode ierr;
2299285fb4e2SStefano Zampini 
2300285fb4e2SStefano Zampini   PetscFunctionBegin;
2301285fb4e2SStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2302285fb4e2SStefano Zampini   if (n) PetscValidIntPointer(n,2);
2303285fb4e2SStefano Zampini   ierr = PetscUseMethod(pc,"PCFieldSplitSchurGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
2304285fb4e2SStefano Zampini   PetscFunctionReturn(0);
2305285fb4e2SStefano Zampini }
2306285fb4e2SStefano Zampini 
2307e69d4d44SBarry Smith /*@
2308a1e3cbf9SBarry Smith     PCFieldSplitSetSchurPre -  Indicates from what operator the preconditioner is constructucted for the Schur complement.
2309a1e3cbf9SBarry Smith       The default is the A11 matrix.
2310e69d4d44SBarry Smith 
2311e69d4d44SBarry Smith     Collective on PC
2312e69d4d44SBarry Smith 
2313e69d4d44SBarry Smith     Input Parameters:
2314e69d4d44SBarry Smith +   pc      - the preconditioner context
23156fdd48a9SBarry 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
23166fdd48a9SBarry Smith               PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL
23170298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
2318084e4875SJed Brown 
2319e69d4d44SBarry Smith     Options Database:
2320a1e3cbf9SBarry Smith +    -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments
2321a1e3cbf9SBarry Smith -    -fieldsplit_1_pc_type <pctype> - the preconditioner algorithm that is used to construct the preconditioner from the operator
2322e69d4d44SBarry Smith 
2323fd1303e9SJungho Lee     Notes:
2324fd1303e9SJungho Lee $    If ptype is
2325a1e3cbf9SBarry Smith $        a11 - the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
232653f2277eSBarry Smith $        matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
2327a1e3cbf9SBarry Smith $        self - the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
2328a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
2329fd1303e9SJungho Lee $             preconditioner
2330a1e3cbf9SBarry Smith $        user - the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
23316fdd48a9SBarry Smith $             to this function).
2332a1e3cbf9SBarry Smith $        selfp - the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
23331d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
23346fdd48a9SBarry Smith $             lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump
2335a1e3cbf9SBarry Smith $        full - the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation computed internally by PCFIELDSPLIT (this is expensive)
23366fdd48a9SBarry Smith $             useful mostly as a test that the Schur complement approach can work for your problem
2337fd1303e9SJungho Lee 
2338e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
2339fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
2340a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
2341fd1303e9SJungho Lee 
2342e69d4d44SBarry Smith     Level: intermediate
2343e69d4d44SBarry Smith 
23441d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
23451d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
2346e69d4d44SBarry Smith 
2347e69d4d44SBarry Smith @*/
234829f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
2349e69d4d44SBarry Smith {
23504ac538c5SBarry Smith   PetscErrorCode ierr;
2351e69d4d44SBarry Smith 
2352e69d4d44SBarry Smith   PetscFunctionBegin;
23530700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
235429f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
2355e69d4d44SBarry Smith   PetscFunctionReturn(0);
2356e69d4d44SBarry Smith }
2357686bed4dSStefano Zampini 
235829f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
2359e69d4d44SBarry Smith 
236037a82bf0SJed Brown /*@
236137a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
236229f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
236337a82bf0SJed Brown 
236437a82bf0SJed Brown     Logically Collective on PC
236537a82bf0SJed Brown 
236637a82bf0SJed Brown     Input Parameters:
236737a82bf0SJed Brown .   pc      - the preconditioner context
236837a82bf0SJed Brown 
236937a82bf0SJed Brown     Output Parameters:
237037a82bf0SJed 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
237137a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
237237a82bf0SJed Brown 
237337a82bf0SJed Brown     Level: intermediate
237437a82bf0SJed Brown 
237529f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
237637a82bf0SJed Brown 
237737a82bf0SJed Brown @*/
237837a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
237937a82bf0SJed Brown {
238037a82bf0SJed Brown   PetscErrorCode ierr;
238137a82bf0SJed Brown 
238237a82bf0SJed Brown   PetscFunctionBegin;
238337a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
238437a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
2385e69d4d44SBarry Smith   PetscFunctionReturn(0);
2386e69d4d44SBarry Smith }
2387e69d4d44SBarry Smith 
238845e7fc46SDmitry Karpeev /*@
2389470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
239045e7fc46SDmitry Karpeev 
239145e7fc46SDmitry Karpeev     Not collective
239245e7fc46SDmitry Karpeev 
239345e7fc46SDmitry Karpeev     Input Parameter:
239445e7fc46SDmitry Karpeev .   pc      - the preconditioner context
239545e7fc46SDmitry Karpeev 
239645e7fc46SDmitry Karpeev     Output Parameter:
2397470b340bSDmitry Karpeev .   S       - the Schur complement matrix
239845e7fc46SDmitry Karpeev 
2399470b340bSDmitry Karpeev     Notes:
2400470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
240145e7fc46SDmitry Karpeev 
240245e7fc46SDmitry Karpeev     Level: advanced
240345e7fc46SDmitry Karpeev 
240429f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
240545e7fc46SDmitry Karpeev 
240645e7fc46SDmitry Karpeev @*/
2407470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
240845e7fc46SDmitry Karpeev {
240945e7fc46SDmitry Karpeev   PetscErrorCode ierr;
241045e7fc46SDmitry Karpeev   const char*    t;
241145e7fc46SDmitry Karpeev   PetscBool      isfs;
241245e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
241345e7fc46SDmitry Karpeev 
241445e7fc46SDmitry Karpeev   PetscFunctionBegin;
241545e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
241645e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
241745e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
241845e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
241945e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2420470b340bSDmitry 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);
2421470b340bSDmitry Karpeev   if (S) *S = jac->schur;
242245e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
242345e7fc46SDmitry Karpeev }
242445e7fc46SDmitry Karpeev 
2425470b340bSDmitry Karpeev /*@
2426470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
2427470b340bSDmitry Karpeev 
2428470b340bSDmitry Karpeev     Not collective
2429470b340bSDmitry Karpeev 
2430470b340bSDmitry Karpeev     Input Parameters:
2431470b340bSDmitry Karpeev +   pc      - the preconditioner context
2432a2b725a8SWilliam Gropp -   S       - the Schur complement matrix
2433470b340bSDmitry Karpeev 
2434470b340bSDmitry Karpeev     Level: advanced
2435470b340bSDmitry Karpeev 
243629f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
2437470b340bSDmitry Karpeev 
2438470b340bSDmitry Karpeev @*/
2439bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
2440470b340bSDmitry Karpeev {
2441470b340bSDmitry Karpeev   PetscErrorCode ierr;
2442470b340bSDmitry Karpeev   const char*    t;
2443470b340bSDmitry Karpeev   PetscBool      isfs;
2444470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
2445470b340bSDmitry Karpeev 
2446470b340bSDmitry Karpeev   PetscFunctionBegin;
2447470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2448470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
2449470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2450470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
2451470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2452470b340bSDmitry 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);
2453bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
2454470b340bSDmitry Karpeev   PetscFunctionReturn(0);
2455470b340bSDmitry Karpeev }
2456470b340bSDmitry Karpeev 
2457470b340bSDmitry Karpeev 
245829f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
2459e69d4d44SBarry Smith {
2460e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2461084e4875SJed Brown   PetscErrorCode ierr;
2462e69d4d44SBarry Smith 
2463e69d4d44SBarry Smith   PetscFunctionBegin;
2464084e4875SJed Brown   jac->schurpre = ptype;
2465a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
24666bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
2467084e4875SJed Brown     jac->schur_user = pre;
2468084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
2469084e4875SJed Brown   }
2470e69d4d44SBarry Smith   PetscFunctionReturn(0);
2471e69d4d44SBarry Smith }
2472e69d4d44SBarry Smith 
247337a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
247437a82bf0SJed Brown {
247537a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
247637a82bf0SJed Brown 
247737a82bf0SJed Brown   PetscFunctionBegin;
247837a82bf0SJed Brown   *ptype = jac->schurpre;
247937a82bf0SJed Brown   *pre   = jac->schur_user;
248037a82bf0SJed Brown   PetscFunctionReturn(0);
248137a82bf0SJed Brown }
248237a82bf0SJed Brown 
2483ab1df9f5SJed Brown /*@
24840ffb0e17SBarry Smith     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner
2485ab1df9f5SJed Brown 
2486ab1df9f5SJed Brown     Collective on PC
2487ab1df9f5SJed Brown 
2488ab1df9f5SJed Brown     Input Parameters:
2489ab1df9f5SJed Brown +   pc  - the preconditioner context
2490c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
2491ab1df9f5SJed Brown 
2492ab1df9f5SJed Brown     Options Database:
2493c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
2494ab1df9f5SJed Brown 
2495ab1df9f5SJed Brown 
2496ab1df9f5SJed Brown     Level: intermediate
2497ab1df9f5SJed Brown 
2498ab1df9f5SJed Brown     Notes:
2499ab1df9f5SJed Brown     The FULL factorization is
2500ab1df9f5SJed Brown 
25010ffb0e17SBarry Smith $   (A   B)  = (1       0) (A   0) (1  Ainv*B)  = L D U
25020ffb0e17SBarry Smith $   (C   E)    (C*Ainv  1) (0   S) (0     1)
2503ab1df9f5SJed Brown 
25040ffb0e17SBarry 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,
2505c096484dSStefano 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().
2506ab1df9f5SJed Brown 
25070ffb0e17SBarry Smith $    If A and S are solved exactly
25080ffb0e17SBarry Smith $      *) FULL factorization is a direct solver.
25090ffb0e17SBarry 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.
25100ffb0e17SBarry 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.
2511ab1df9f5SJed Brown 
25120ffb0e17SBarry Smith     If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
25130ffb0e17SBarry 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.
25140ffb0e17SBarry Smith 
25150ffb0e17SBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES.
25160ffb0e17SBarry Smith 
25170ffb0e17SBarry 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).
2518ab1df9f5SJed Brown 
2519ab1df9f5SJed Brown     References:
252096a0c994SBarry Smith +   1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
252196a0c994SBarry Smith -   2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2522ab1df9f5SJed Brown 
2523c096484dSStefano Zampini .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCFieldSplitSetSchurScale()
2524ab1df9f5SJed Brown @*/
2525c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
2526ab1df9f5SJed Brown {
2527ab1df9f5SJed Brown   PetscErrorCode ierr;
2528ab1df9f5SJed Brown 
2529ab1df9f5SJed Brown   PetscFunctionBegin;
2530ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2531c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
2532ab1df9f5SJed Brown   PetscFunctionReturn(0);
2533ab1df9f5SJed Brown }
2534ab1df9f5SJed Brown 
25351e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
2536ab1df9f5SJed Brown {
2537ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2538ab1df9f5SJed Brown 
2539ab1df9f5SJed Brown   PetscFunctionBegin;
2540ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2541ab1df9f5SJed Brown   PetscFunctionReturn(0);
2542ab1df9f5SJed Brown }
2543ab1df9f5SJed Brown 
2544c096484dSStefano Zampini /*@
2545c096484dSStefano Zampini     PCFieldSplitSetSchurScale -  Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG.
2546c096484dSStefano Zampini 
2547c096484dSStefano Zampini     Collective on PC
2548c096484dSStefano Zampini 
2549c096484dSStefano Zampini     Input Parameters:
2550c096484dSStefano Zampini +   pc    - the preconditioner context
2551c096484dSStefano Zampini -   scale - scaling factor for the Schur complement
2552c096484dSStefano Zampini 
2553c096484dSStefano Zampini     Options Database:
2554c096484dSStefano Zampini .     -pc_fieldsplit_schur_scale - default is -1.0
2555c096484dSStefano Zampini 
2556c096484dSStefano Zampini     Level: intermediate
2557c096484dSStefano Zampini 
2558c096484dSStefano Zampini .seealso: PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurFactType, PCFieldSplitSetSchurScale()
2559c096484dSStefano Zampini @*/
2560c096484dSStefano Zampini PetscErrorCode PCFieldSplitSetSchurScale(PC pc,PetscScalar scale)
2561c096484dSStefano Zampini {
2562c096484dSStefano Zampini   PetscErrorCode ierr;
2563c096484dSStefano Zampini 
2564c096484dSStefano Zampini   PetscFunctionBegin;
2565c096484dSStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2566c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc,scale,2);
2567c096484dSStefano Zampini   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurScale_C",(PC,PetscScalar),(pc,scale));CHKERRQ(ierr);
2568c096484dSStefano Zampini   PetscFunctionReturn(0);
2569c096484dSStefano Zampini }
2570c096484dSStefano Zampini 
2571c096484dSStefano Zampini static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc,PetscScalar scale)
2572c096484dSStefano Zampini {
2573c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2574c096484dSStefano Zampini 
2575c096484dSStefano Zampini   PetscFunctionBegin;
2576c096484dSStefano Zampini   jac->schurscale = scale;
2577c096484dSStefano Zampini   PetscFunctionReturn(0);
2578c096484dSStefano Zampini }
2579c096484dSStefano Zampini 
258030ad9308SMatthew Knepley /*@C
25818c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
258230ad9308SMatthew Knepley 
258330ad9308SMatthew Knepley    Collective on KSP
258430ad9308SMatthew Knepley 
258530ad9308SMatthew Knepley    Input Parameter:
258630ad9308SMatthew Knepley .  pc - the preconditioner context
258730ad9308SMatthew Knepley 
258830ad9308SMatthew Knepley    Output Parameters:
2589a04f6461SBarry Smith +  A00 - the (0,0) block
2590a04f6461SBarry Smith .  A01 - the (0,1) block
2591a04f6461SBarry Smith .  A10 - the (1,0) block
2592a04f6461SBarry Smith -  A11 - the (1,1) block
259330ad9308SMatthew Knepley 
259430ad9308SMatthew Knepley    Level: advanced
259530ad9308SMatthew Knepley 
259630ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
259730ad9308SMatthew Knepley @*/
2598a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
259930ad9308SMatthew Knepley {
260030ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
260130ad9308SMatthew Knepley 
260230ad9308SMatthew Knepley   PetscFunctionBegin;
26030700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2604ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2605a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2606a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2607a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2608a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
260930ad9308SMatthew Knepley   PetscFunctionReturn(0);
261030ad9308SMatthew Knepley }
261130ad9308SMatthew Knepley 
2612b09e027eSCarola Kruse /*@
2613e071a0a4SCarola Kruse     PCFieldSplitSetGKBTol -  Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner.
2614b09e027eSCarola Kruse 
2615b09e027eSCarola Kruse     Collective on PC
2616b09e027eSCarola Kruse 
2617e071a0a4SCarola Kruse     Notes:
2618e071a0a4SCarola Kruse     The generalized GKB algorithm uses a lower bound estimate of the error in energy norm as stopping criterion.
2619e071a0a4SCarola Kruse     It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than
2620e071a0a4SCarola Kruse     this estimate, the stopping criterion is satisfactory in practical cases [A13].
2621e071a0a4SCarola Kruse 
2622e071a0a4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2623e071a0a4SCarola Kruse 
2624b09e027eSCarola Kruse     Input Parameters:
2625b09e027eSCarola Kruse +   pc        - the preconditioner context
2626b09e027eSCarola Kruse -   tolerance - the solver tolerance
2627b09e027eSCarola Kruse 
2628b09e027eSCarola Kruse     Options Database:
2629b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_tol - default is 1e-5
2630b09e027eSCarola Kruse 
2631b09e027eSCarola Kruse     Level: intermediate
2632b09e027eSCarola Kruse 
2633b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBMaxit()
2634b09e027eSCarola Kruse @*/
2635b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBTol(PC pc,PetscReal tolerance)
2636b09e027eSCarola Kruse {
2637b09e027eSCarola Kruse   PetscErrorCode ierr;
2638b09e027eSCarola Kruse 
2639b09e027eSCarola Kruse   PetscFunctionBegin;
2640b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2641de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc,tolerance,2);
2642b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBTol_C",(PC,PetscReal),(pc,tolerance));CHKERRQ(ierr);
2643b09e027eSCarola Kruse   PetscFunctionReturn(0);
2644b09e027eSCarola Kruse }
2645b09e027eSCarola Kruse 
2646b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc,PetscReal tolerance)
2647b09e027eSCarola Kruse {
2648b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2649b09e027eSCarola Kruse 
2650b09e027eSCarola Kruse   PetscFunctionBegin;
2651b09e027eSCarola Kruse   jac->gkbtol = tolerance;
2652b09e027eSCarola Kruse   PetscFunctionReturn(0);
2653b09e027eSCarola Kruse }
2654b09e027eSCarola Kruse 
2655b09e027eSCarola Kruse 
2656b09e027eSCarola Kruse /*@
2657e071a0a4SCarola Kruse     PCFieldSplitSetGKBMaxit -  Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization
2658e071a0a4SCarola Kruse     preconditioner.
2659b09e027eSCarola Kruse 
2660b09e027eSCarola Kruse     Collective on PC
2661b09e027eSCarola Kruse 
2662b09e027eSCarola Kruse     Input Parameters:
2663b09e027eSCarola Kruse +   pc     - the preconditioner context
2664b09e027eSCarola Kruse -   maxit  - the maximum number of iterations
2665b09e027eSCarola Kruse 
2666b09e027eSCarola Kruse     Options Database:
2667b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_maxit - default is 100
2668b09e027eSCarola Kruse 
2669b09e027eSCarola Kruse     Level: intermediate
2670b09e027eSCarola Kruse 
2671b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBNu()
2672b09e027eSCarola Kruse @*/
2673b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc,PetscInt maxit)
2674b09e027eSCarola Kruse {
2675b09e027eSCarola Kruse   PetscErrorCode ierr;
2676b09e027eSCarola Kruse 
2677b09e027eSCarola Kruse   PetscFunctionBegin;
2678b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2679de482cd7SCarola Kruse   PetscValidLogicalCollectiveInt(pc,maxit,2);
2680b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBMaxit_C",(PC,PetscInt),(pc,maxit));CHKERRQ(ierr);
2681b09e027eSCarola Kruse   PetscFunctionReturn(0);
2682b09e027eSCarola Kruse }
2683b09e027eSCarola Kruse 
2684b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc,PetscInt maxit)
2685b09e027eSCarola Kruse {
2686b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2687b09e027eSCarola Kruse 
2688b09e027eSCarola Kruse   PetscFunctionBegin;
2689b09e027eSCarola Kruse   jac->gkbmaxit = maxit;
2690b09e027eSCarola Kruse   PetscFunctionReturn(0);
2691b09e027eSCarola Kruse }
2692b09e027eSCarola Kruse 
2693b09e027eSCarola Kruse /*@
2694e071a0a4SCarola Kruse     PCFieldSplitSetGKBDelay -  Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization
2695e071a0a4SCarola Kruse     preconditioner.
2696b09e027eSCarola Kruse 
2697b09e027eSCarola Kruse     Collective on PC
2698b09e027eSCarola Kruse 
2699b09e027eSCarola Kruse     Notes:
2700e071a0a4SCarola 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
2701e071a0a4SCarola 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
2702e071a0a4SCarola 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
2703b09e027eSCarola Kruse 
2704b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2705b09e027eSCarola Kruse 
2706b09e027eSCarola Kruse     Input Parameters:
2707b09e027eSCarola Kruse +   pc     - the preconditioner context
2708b09e027eSCarola Kruse -   delay  - the delay window in the lower bound estimate
2709b09e027eSCarola Kruse 
2710b09e027eSCarola Kruse     Options Database:
2711b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_delay - default is 5
2712b09e027eSCarola Kruse 
2713b09e027eSCarola Kruse     Level: intermediate
2714b09e027eSCarola Kruse 
2715b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit()
2716b09e027eSCarola Kruse @*/
2717b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBDelay(PC pc,PetscInt delay)
2718b09e027eSCarola Kruse {
2719b09e027eSCarola Kruse   PetscErrorCode ierr;
2720b09e027eSCarola Kruse 
2721b09e027eSCarola Kruse   PetscFunctionBegin;
2722b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2723b09e027eSCarola Kruse   PetscValidLogicalCollectiveInt(pc,delay,2);
2724b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBDelay_C",(PC,PetscInt),(pc,delay));CHKERRQ(ierr);
2725b09e027eSCarola Kruse   PetscFunctionReturn(0);
2726b09e027eSCarola Kruse }
2727b09e027eSCarola Kruse 
2728b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc,PetscInt delay)
2729b09e027eSCarola Kruse {
2730b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2731b09e027eSCarola Kruse 
2732b09e027eSCarola Kruse   PetscFunctionBegin;
2733b09e027eSCarola Kruse   jac->gkbdelay = delay;
2734b09e027eSCarola Kruse   PetscFunctionReturn(0);
2735b09e027eSCarola Kruse }
2736b09e027eSCarola Kruse 
2737b09e027eSCarola Kruse /*@
2738b09e027eSCarola 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.
2739b09e027eSCarola Kruse 
2740b09e027eSCarola Kruse     Collective on PC
2741b09e027eSCarola Kruse 
2742b09e027eSCarola Kruse     Notes:
2743e071a0a4SCarola 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,
2744b09e027eSCarola 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
2745b09e027eSCarola Kruse     necessary to find a good balance in between the convergence of the inner and outer loop.
2746b09e027eSCarola Kruse 
2747b09e027eSCarola 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.
2748b09e027eSCarola Kruse 
2749b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2750b09e027eSCarola Kruse 
2751b09e027eSCarola Kruse     Input Parameters:
2752b09e027eSCarola Kruse +   pc     - the preconditioner context
2753b09e027eSCarola Kruse -   nu     - the shift parameter
2754b09e027eSCarola Kruse 
2755b09e027eSCarola Kruse     Options Database:
2756b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_nu - default is 1
2757b09e027eSCarola Kruse 
2758b09e027eSCarola Kruse     Level: intermediate
2759b09e027eSCarola Kruse 
2760b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit()
2761b09e027eSCarola Kruse @*/
2762b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBNu(PC pc,PetscReal nu)
2763b09e027eSCarola Kruse {
2764b09e027eSCarola Kruse   PetscErrorCode ierr;
2765b09e027eSCarola Kruse 
2766b09e027eSCarola Kruse   PetscFunctionBegin;
2767b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2768de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc,nu,2);
2769b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBNu_C",(PC,PetscReal),(pc,nu));CHKERRQ(ierr);
2770b09e027eSCarola Kruse   PetscFunctionReturn(0);
2771b09e027eSCarola Kruse }
2772b09e027eSCarola Kruse 
2773b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc,PetscReal nu)
2774b09e027eSCarola Kruse {
2775b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2776b09e027eSCarola Kruse 
2777b09e027eSCarola Kruse   PetscFunctionBegin;
2778b09e027eSCarola Kruse   jac->gkbnu = nu;
2779b09e027eSCarola Kruse   PetscFunctionReturn(0);
2780b09e027eSCarola Kruse }
2781b09e027eSCarola Kruse 
2782b09e027eSCarola Kruse 
27831e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
278479416396SBarry Smith {
278579416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2786e69d4d44SBarry Smith   PetscErrorCode ierr;
278779416396SBarry Smith 
278879416396SBarry Smith   PetscFunctionBegin;
278979416396SBarry Smith   jac->type = type;
2790e071a0a4SCarola Kruse 
2791e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",0);CHKERRQ(ierr);
2792e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
2793e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2794e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
2795e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr);
2796e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",0);CHKERRQ(ierr);
2797e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",0);CHKERRQ(ierr);
2798e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",0);CHKERRQ(ierr);
2799e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",0);CHKERRQ(ierr);
2800e071a0a4SCarola Kruse 
28013b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
28023b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
28033b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
28042fa5cd67SKarl Rupp 
2805bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
280629f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
280737a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2808bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2809c096484dSStefano Zampini     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",PCFieldSplitSetSchurScale_FieldSplit);CHKERRQ(ierr);
2810a51937d4SCarola Kruse   } else if (type == PC_COMPOSITE_GKB){
2811a51937d4SCarola Kruse     pc->ops->apply = PCApply_FieldSplit_GKB;
2812a51937d4SCarola Kruse     pc->ops->view  = PCView_FieldSplit_GKB;
2813e69d4d44SBarry Smith 
2814a51937d4SCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2815b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",PCFieldSplitSetGKBTol_FieldSplit);CHKERRQ(ierr);
2816b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",PCFieldSplitSetGKBMaxit_FieldSplit);CHKERRQ(ierr);
2817b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",PCFieldSplitSetGKBNu_FieldSplit);CHKERRQ(ierr);
2818b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",PCFieldSplitSetGKBDelay_FieldSplit);CHKERRQ(ierr);
28193b224e63SBarry Smith   } else {
28203b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
28213b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
28222fa5cd67SKarl Rupp 
2823bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
28243b224e63SBarry Smith   }
282579416396SBarry Smith   PetscFunctionReturn(0);
282679416396SBarry Smith }
282779416396SBarry Smith 
28281e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
282951f519a2SBarry Smith {
283051f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
283151f519a2SBarry Smith 
283251f519a2SBarry Smith   PetscFunctionBegin;
2833ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2834ce94432eSBarry 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);
283551f519a2SBarry Smith   jac->bs = bs;
283651f519a2SBarry Smith   PetscFunctionReturn(0);
283751f519a2SBarry Smith }
283851f519a2SBarry Smith 
2839bc08b0f1SBarry Smith /*@
284079416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
284179416396SBarry Smith 
284279416396SBarry Smith    Collective on PC
284379416396SBarry Smith 
284479416396SBarry Smith    Input Parameter:
2845a2b725a8SWilliam Gropp +  pc - the preconditioner context
2846a2b725a8SWilliam Gropp -  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
284779416396SBarry Smith 
284879416396SBarry Smith    Options Database Key:
2849a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
285079416396SBarry Smith 
2851b02e2d75SMatthew G Knepley    Level: Intermediate
285279416396SBarry Smith 
285379416396SBarry Smith .seealso: PCCompositeSetType()
285479416396SBarry Smith 
285579416396SBarry Smith @*/
28567087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
285779416396SBarry Smith {
28584ac538c5SBarry Smith   PetscErrorCode ierr;
285979416396SBarry Smith 
286079416396SBarry Smith   PetscFunctionBegin;
28610700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
28624ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
286379416396SBarry Smith   PetscFunctionReturn(0);
286479416396SBarry Smith }
286579416396SBarry Smith 
2866b02e2d75SMatthew G Knepley /*@
2867b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2868b02e2d75SMatthew G Knepley 
2869b02e2d75SMatthew G Knepley   Not collective
2870b02e2d75SMatthew G Knepley 
2871b02e2d75SMatthew G Knepley   Input Parameter:
2872b02e2d75SMatthew G Knepley . pc - the preconditioner context
2873b02e2d75SMatthew G Knepley 
2874b02e2d75SMatthew G Knepley   Output Parameter:
2875b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2876b02e2d75SMatthew G Knepley 
2877b02e2d75SMatthew G Knepley   Level: Intermediate
2878b02e2d75SMatthew G Knepley 
2879b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2880b02e2d75SMatthew G Knepley @*/
2881b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2882b02e2d75SMatthew G Knepley {
2883b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2884b02e2d75SMatthew G Knepley 
2885b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2886b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2887b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2888b02e2d75SMatthew G Knepley   *type = jac->type;
2889b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2890b02e2d75SMatthew G Knepley }
2891b02e2d75SMatthew G Knepley 
28924ab8060aSDmitry Karpeev /*@
28934ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
28944ab8060aSDmitry Karpeev 
28954ab8060aSDmitry Karpeev    Logically Collective
28964ab8060aSDmitry Karpeev 
28974ab8060aSDmitry Karpeev    Input Parameters:
28984ab8060aSDmitry Karpeev +  pc   - the preconditioner context
28994ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
29004ab8060aSDmitry Karpeev 
29014ab8060aSDmitry Karpeev    Options Database Key:
29024ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
29034ab8060aSDmitry Karpeev 
29044ab8060aSDmitry Karpeev    Level: Intermediate
29054ab8060aSDmitry Karpeev 
29064ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
29074ab8060aSDmitry Karpeev 
29084ab8060aSDmitry Karpeev @*/
29094ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
29104ab8060aSDmitry Karpeev {
29114ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
29124ab8060aSDmitry Karpeev   PetscBool      isfs;
29134ab8060aSDmitry Karpeev   PetscErrorCode ierr;
29144ab8060aSDmitry Karpeev 
29154ab8060aSDmitry Karpeev   PetscFunctionBegin;
29164ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
29174ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
29184ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
29194ab8060aSDmitry Karpeev   if (isfs) {
29204ab8060aSDmitry Karpeev     jac->dm_splits = flg;
29214ab8060aSDmitry Karpeev   }
29224ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
29234ab8060aSDmitry Karpeev }
29244ab8060aSDmitry Karpeev 
29254ab8060aSDmitry Karpeev 
29264ab8060aSDmitry Karpeev /*@
29274ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
29284ab8060aSDmitry Karpeev 
29294ab8060aSDmitry Karpeev    Logically Collective
29304ab8060aSDmitry Karpeev 
29314ab8060aSDmitry Karpeev    Input Parameter:
29324ab8060aSDmitry Karpeev .  pc   - the preconditioner context
29334ab8060aSDmitry Karpeev 
29344ab8060aSDmitry Karpeev    Output Parameter:
29354ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
29364ab8060aSDmitry Karpeev 
29374ab8060aSDmitry Karpeev    Level: Intermediate
29384ab8060aSDmitry Karpeev 
29394ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
29404ab8060aSDmitry Karpeev 
29414ab8060aSDmitry Karpeev @*/
29424ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
29434ab8060aSDmitry Karpeev {
29444ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
29454ab8060aSDmitry Karpeev   PetscBool      isfs;
29464ab8060aSDmitry Karpeev   PetscErrorCode ierr;
29474ab8060aSDmitry Karpeev 
29484ab8060aSDmitry Karpeev   PetscFunctionBegin;
29494ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2950534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
29514ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
29524ab8060aSDmitry Karpeev   if (isfs) {
29534ab8060aSDmitry Karpeev     if (flg) *flg = jac->dm_splits;
29544ab8060aSDmitry Karpeev   }
29554ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
29564ab8060aSDmitry Karpeev }
29574ab8060aSDmitry Karpeev 
29587b752e3dSPatrick Sanan /*@
29597b752e3dSPatrick Sanan    PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
29607b752e3dSPatrick Sanan 
29617b752e3dSPatrick Sanan    Logically Collective
29627b752e3dSPatrick Sanan 
29637b752e3dSPatrick Sanan    Input Parameter:
29647b752e3dSPatrick Sanan .  pc   - the preconditioner context
29657b752e3dSPatrick Sanan 
29667b752e3dSPatrick Sanan    Output Parameter:
29677b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
29687b752e3dSPatrick Sanan 
29697b752e3dSPatrick Sanan    Level: Intermediate
29707b752e3dSPatrick Sanan 
29717b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint()
29727b752e3dSPatrick Sanan 
29737b752e3dSPatrick Sanan @*/
29747b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc,PetscBool *flg)
29757b752e3dSPatrick Sanan {
29767b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
29777b752e3dSPatrick Sanan 
29787b752e3dSPatrick Sanan   PetscFunctionBegin;
29797b752e3dSPatrick Sanan   *flg = jac->detect;
29807b752e3dSPatrick Sanan   PetscFunctionReturn(0);
29817b752e3dSPatrick Sanan }
29827b752e3dSPatrick Sanan 
29837b752e3dSPatrick Sanan /*@
29847b752e3dSPatrick Sanan    PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
29857b752e3dSPatrick Sanan 
29867b752e3dSPatrick Sanan    Logically Collective
29877b752e3dSPatrick Sanan 
29887b752e3dSPatrick Sanan    Notes:
29897b752e3dSPatrick 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()).
29907b752e3dSPatrick Sanan 
29917b752e3dSPatrick Sanan    Input Parameter:
29927b752e3dSPatrick Sanan .  pc   - the preconditioner context
29937b752e3dSPatrick Sanan 
29947b752e3dSPatrick Sanan    Output Parameter:
29957b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
29967b752e3dSPatrick Sanan 
29977b752e3dSPatrick Sanan    Options Database Key:
29987b752e3dSPatrick Sanan .  -pc_fieldsplit_detect_saddle_point
29997b752e3dSPatrick Sanan 
30007b752e3dSPatrick Sanan    Level: Intermediate
30017b752e3dSPatrick Sanan 
30027b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint(), PCFieldSplitSetType(), PCFieldSplitSetSchurPre()
30037b752e3dSPatrick Sanan 
30047b752e3dSPatrick Sanan @*/
30057b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc,PetscBool flg)
30067b752e3dSPatrick Sanan {
30077b752e3dSPatrick Sanan   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
30087b752e3dSPatrick Sanan   PetscErrorCode ierr;
30097b752e3dSPatrick Sanan 
30107b752e3dSPatrick Sanan   PetscFunctionBegin;
30117b752e3dSPatrick Sanan   jac->detect = flg;
30127b752e3dSPatrick Sanan   if (jac->detect) {
30137b752e3dSPatrick Sanan     ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
30147b752e3dSPatrick Sanan     ierr = PCFieldSplitSetSchurPre(pc,PC_FIELDSPLIT_SCHUR_PRE_SELF,NULL);CHKERRQ(ierr);
30157b752e3dSPatrick Sanan   }
30167b752e3dSPatrick Sanan   PetscFunctionReturn(0);
30177b752e3dSPatrick Sanan }
30187b752e3dSPatrick Sanan 
30190971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
30200971522cSBarry Smith /*MC
3021a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
3022a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
30230971522cSBarry Smith 
3024edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
3025edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
30260971522cSBarry Smith 
3027a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
302869a612a9SBarry Smith          and set the options directly on the resulting KSP object
30290971522cSBarry Smith 
30300971522cSBarry Smith    Level: intermediate
30310971522cSBarry Smith 
303279416396SBarry Smith    Options Database Keys:
303381540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
303481540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
303581540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
303681540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
3037a51937d4SCarola Kruse .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting
3038a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
3039412be6bfSPatrick Sanan .   -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> - set factorization type when using -pc_fieldsplit_type schur; see PCFieldSplitSetSchurFactType()
3040fb6809a2SPatrick Sanan -   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
304179416396SBarry Smith 
3042fb6809a2SPatrick Sanan      Options prefixes for inner solvers when using the Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_ .
3043fb6809a2SPatrick Sanan      For all other solvers they are -fieldsplit_%d_ for the dth field; use -fieldsplit_ for all fields.
3044fb6809a2SPatrick Sanan      The options prefix for the inner solver when using the Golub-Kahan biadiagonalization preconditioner is -fieldsplit_0_
30455d4c12cdSJungho Lee 
3046c8a0d604SMatthew G Knepley    Notes:
3047c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
3048d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
3049d32f9abdSBarry Smith 
3050d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
3051d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
3052d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
3053d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
3054d32f9abdSBarry Smith 
30552da392ccSBarry Smith $     For the Schur complement preconditioner if J = [ A00 A01]
30562da392ccSBarry Smith $                                                    [ A10 A11]
3057c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
30582da392ccSBarry Smith $              [ I   -ksp(A00) A01] [ inv(A00)    0  ] [     I          0]
30592da392ccSBarry Smith $              [ 0         I      ] [   0      ksp(S)] [ -A10 ksp(A00)  I]
306013b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
306113b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
306213b05affSJed 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
3063686bed4dSStefano Zampini      in providing the SECOND split or 1 if not give). For PCFieldSplitGetSubKSP() when field number is 0,
3064c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
3065a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
30661d71051fSDmitry Karpeev 
3067a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
30685668aaf4SBarry Smith      diag gives
30692da392ccSBarry Smith $              [ inv(A00)     0 ]
30702da392ccSBarry Smith $              [   0      -ksp(S)]
3071c096484dSStefano 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
3072c096484dSStefano Zampini      can be turned off with PCFieldSplitSetSchurScale() or by command line -pc_fieldsplit_schur_scale 1.0. The lower factorization is the inverse of
30732da392ccSBarry Smith $              [  A00   0]
30742da392ccSBarry Smith $              [  A10   S]
3075c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
30762da392ccSBarry Smith $              [ A00 A01]
30772da392ccSBarry Smith $              [  0   S ]
3078c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
3079e69d4d44SBarry Smith 
3080edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
3081edf189efSBarry Smith      is used automatically for a second block.
3082edf189efSBarry Smith 
3083ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
3084ff218e97SBarry Smith      Generally it should be used with the AIJ format.
3085ff218e97SBarry Smith 
3086ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
3087ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
3088ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
30890716a85fSBarry Smith 
30902da392ccSBarry Smith      References:
30912da392ccSBarry Smith        A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
30923bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
30933bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
30943bc631e0SBarry Smith 
30954d308398SBarry Smith    The Constrained Pressure Preconditioner (CPR) can be implemented using PCCOMPOSITE with PCGALERKIN. CPR first solves an R A P subsystem, updates the
30964d308398SBarry Smith    residual on all variables (PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)), and then applies a simple ILU like preconditioner on all the variables.
3097a6a584a2SBarry Smith 
3098e071a0a4SCarola Kruse    The generalized Golub-Kahan bidiagonalization preconditioner (gkb) can be applied to symmetric 2x2 block matrices of the shape
30992da392ccSBarry Smith $        [ A00  A01]
31002da392ccSBarry Smith $        [ A01' 0  ]
3101a51937d4SCarola 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'.
3102e071a0a4SCarola 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_.
3103a51937d4SCarola Kruse 
3104a51937d4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
3105a51937d4SCarola Kruse 
3106412be6bfSPatrick Sanan .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, PCLSC,
3107412be6bfSPatrick Sanan            PCFieldSplitGetSubKSP(), PCFieldSplitSchurGetSubKSP(), PCFieldSplitSetFields(),
3108412be6bfSPatrick Sanan            PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(), PCFieldSplitSetSchurFactType(),
3109412be6bfSPatrick Sanan            MatSchurComplementSetAinvType(), PCFieldSplitSetSchurScale(), PCFieldSplitSetDetectSaddlePoint()
31100971522cSBarry Smith M*/
31110971522cSBarry Smith 
31128cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
31130971522cSBarry Smith {
31140971522cSBarry Smith   PetscErrorCode ierr;
31150971522cSBarry Smith   PC_FieldSplit  *jac;
31160971522cSBarry Smith 
31170971522cSBarry Smith   PetscFunctionBegin;
3118b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
31192fa5cd67SKarl Rupp 
31200971522cSBarry Smith   jac->bs                 = -1;
31210971522cSBarry Smith   jac->nsplits            = 0;
31223e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
3123e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
3124c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
3125c096484dSStefano Zampini   jac->schurscale         = -1.0;
3126fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
31277b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
3128a51937d4SCarola Kruse   jac->gkbtol             = 1e-5;
3129a51937d4SCarola Kruse   jac->gkbdelay           = 5;
3130a51937d4SCarola Kruse   jac->gkbnu              = 1;
3131a51937d4SCarola Kruse   jac->gkbmaxit           = 100;
3132de482cd7SCarola Kruse   jac->gkbmonitor         = PETSC_FALSE;
313351f519a2SBarry Smith 
31340971522cSBarry Smith   pc->data = (void*)jac;
31350971522cSBarry Smith 
31360971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
3137421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
31380971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
3139574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
31400971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
31410971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
31420971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
31430a545947SLisandro Dalcin   pc->ops->applyrichardson = NULL;
31440971522cSBarry Smith 
3145285fb4e2SStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",PCFieldSplitSchurGetSubKSP_FieldSplit);CHKERRQ(ierr);
3146bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
3147bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
3148bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
3149bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
3150bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
31516dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr);
31520971522cSBarry Smith   PetscFunctionReturn(0);
31530971522cSBarry Smith }
3154