xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 534a8f05a7a8aff70dd8cfd53d9cd834400a8dbf)
1dba47a55SKris Buschelman 
2f5f0d762SBarry Smith 
3af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
4a80b646eSBarry Smith #include <petsc/private/kspimpl.h>    /*  This is needed to provide the appropriate PETSC_EXTERN for KSP_Solve_FS ....*/
51e25c274SJed Brown #include <petscdm.h>
60971522cSBarry Smith 
72e71c61dSMatthew G. Knepley const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0};
8c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0};
9c5d2311dSJed Brown 
109df09d43SBarry 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;
119df09d43SBarry Smith 
120971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
130971522cSBarry Smith struct _PC_FieldSplitLink {
1469a612a9SBarry Smith   KSP               ksp;
15443836d0SMatthew G Knepley   Vec               x,y,z;
16db4c96c1SJed Brown   char              *splitname;
170971522cSBarry Smith   PetscInt          nfields;
185d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
191b9fc7fcSBarry Smith   VecScatter        sctx;
20f5f0d762SBarry Smith   IS                is,is_col;
2151f519a2SBarry Smith   PC_FieldSplitLink next,previous;
229df09d43SBarry Smith   PetscLogEvent     event;
230971522cSBarry Smith };
240971522cSBarry Smith 
250971522cSBarry Smith typedef struct {
2668dd23aaSBarry Smith   PCCompositeType type;
27ace3abfcSBarry Smith   PetscBool       defaultsplit;                    /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
28ace3abfcSBarry Smith   PetscBool       splitdefined;                    /* Flag is set after the splits have been defined, to prevent more splits from being added */
2930ad9308SMatthew Knepley   PetscInt        bs;                              /* Block size for IS and Mat structures */
3030ad9308SMatthew Knepley   PetscInt        nsplits;                         /* Number of field divisions defined */
3179416396SBarry Smith   Vec             *x,*y,w1,w2;
32519d70e2SJed Brown   Mat             *mat;                            /* The diagonal block for each split */
33519d70e2SJed Brown   Mat             *pmat;                           /* The preconditioning diagonal block for each split */
3430ad9308SMatthew Knepley   Mat             *Afield;                         /* The rows of the matrix associated with each split */
35ace3abfcSBarry Smith   PetscBool       issetup;
362fa5cd67SKarl Rupp 
3730ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
3830ad9308SMatthew Knepley   Mat                       B;                     /* The (0,1) block */
3930ad9308SMatthew Knepley   Mat                       C;                     /* The (1,0) block */
40443836d0SMatthew G Knepley   Mat                       schur;                 /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
41a7476a74SDmitry Karpeev   Mat                       schurp;                /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
42084e4875SJed Brown   Mat                       schur_user;            /* User-provided preconditioning matrix for the Schur complement */
43084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;              /* Determines which preconditioning matrix is used for the Schur complement */
44c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4530ad9308SMatthew Knepley   KSP                       kspschur;              /* The solver for S */
46443836d0SMatthew G Knepley   KSP                       kspupper;              /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
47c096484dSStefano Zampini   PetscScalar               schurscale;            /* Scaling factor for the Schur complement solution with DIAG factorization */
48c096484dSStefano Zampini 
49a51937d4SCarola Kruse   /* Only used when Golub-Kahan bidiagonalization preconditioning is used */
50a51937d4SCarola Kruse   Mat                       H;                     /* The modified matrix H = A00 + nu*A01*A01'              */
51a51937d4SCarola Kruse   PetscReal                 gkbtol;                /* Stopping tolerance for lower bound estimate            */
52a51937d4SCarola Kruse   PetscInt                  gkbdelay;              /* The delay window for the stopping criterion            */
53a51937d4SCarola Kruse   PetscReal                 gkbnu;                 /* Parameter for augmented Lagrangian H = A + nu*A01*A01' */
54a51937d4SCarola Kruse   PetscInt                  gkbmaxit;              /* Maximum number of iterations for outer loop            */
55de482cd7SCarola Kruse   PetscBool                 gkbmonitor;            /* Monitor for gkb iterations and the lower bound error   */
56de482cd7SCarola Kruse   PetscViewer               gkbviewer;             /* Viewer context for gkbmonitor                          */
57e071a0a4SCarola Kruse   Vec                       u,v,d,Hu;              /* Work vectors for the GKB algorithm                     */
58e071a0a4SCarola Kruse   PetscScalar               *vecz;                 /* Contains intermediate values, eg for lower bound       */
59a51937d4SCarola Kruse 
6097bbdb24SBarry Smith   PC_FieldSplitLink         head;
616dbb499eSCian Wilson   PetscBool                 isrestrict;             /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */
62c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
634ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
64c84da90fSDmitry Karpeev   PetscBool                 diag_use_amat;          /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
65c84da90fSDmitry Karpeev   PetscBool                 offdiag_use_amat;       /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
667b752e3dSPatrick Sanan   PetscBool                 detect;                 /* Whether to form 2-way split by finding zero diagonal entries */
670971522cSBarry Smith } PC_FieldSplit;
680971522cSBarry Smith 
6916913363SBarry Smith /*
7095452b02SPatrick Sanan     Notes:
7195452b02SPatrick Sanan     there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
7216913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
7316913363SBarry Smith    PC you could change this.
7416913363SBarry Smith */
75084e4875SJed Brown 
76e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
77084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
78084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
79084e4875SJed Brown {
80084e4875SJed Brown   switch (jac->schurpre) {
81084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
82a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
83e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
84e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
85084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
86084e4875SJed Brown   default:
87084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
88084e4875SJed Brown   }
89084e4875SJed Brown }
90084e4875SJed Brown 
91084e4875SJed Brown 
929804daf3SBarry Smith #include <petscdraw.h>
930971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
940971522cSBarry Smith {
950971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
960971522cSBarry Smith   PetscErrorCode    ierr;
97d9884438SBarry Smith   PetscBool         iascii,isdraw;
980971522cSBarry Smith   PetscInt          i,j;
995a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
1000971522cSBarry Smith 
1010971522cSBarry Smith   PetscFunctionBegin;
102251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
103d9884438SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1040971522cSBarry Smith   if (iascii) {
1052c9966d7SBarry Smith     if (jac->bs > 0) {
10651f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
1072c9966d7SBarry Smith     } else {
1082c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
1092c9966d7SBarry Smith     }
110f5236f50SJed Brown     if (pc->useAmat) {
111f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
112a3df900dSMatthew G Knepley     }
113c84da90fSDmitry Karpeev     if (jac->diag_use_amat) {
114c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
115c84da90fSDmitry Karpeev     }
116c84da90fSDmitry Karpeev     if (jac->offdiag_use_amat) {
117c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
118c84da90fSDmitry Karpeev     }
11969a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1200971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1211ab39975SBarry Smith       if (ilink->fields) {
1220971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
12379416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1245a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
12579416396SBarry Smith           if (j > 0) {
12679416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
12779416396SBarry Smith           }
1285a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1290971522cSBarry Smith         }
1300971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
13179416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1321ab39975SBarry Smith       } else {
1331ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1341ab39975SBarry Smith       }
1355a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1365a9f2f41SSatish Balay       ilink = ilink->next;
1370971522cSBarry Smith     }
1382fa5cd67SKarl Rupp   }
1392fa5cd67SKarl Rupp 
1402fa5cd67SKarl Rupp  if (isdraw) {
141d9884438SBarry Smith     PetscDraw draw;
142d9884438SBarry Smith     PetscReal x,y,w,wd;
143d9884438SBarry Smith 
144d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
145d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
146d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
147d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
148d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
149d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
150d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
151d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
152d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
153d9884438SBarry Smith       x    += wd;
154d9884438SBarry Smith       ilink = ilink->next;
155d9884438SBarry Smith     }
1560971522cSBarry Smith   }
1570971522cSBarry Smith   PetscFunctionReturn(0);
1580971522cSBarry Smith }
1590971522cSBarry Smith 
1603b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1613b224e63SBarry Smith {
1623b224e63SBarry Smith   PC_FieldSplit              *jac = (PC_FieldSplit*)pc->data;
1633b224e63SBarry Smith   PetscErrorCode             ierr;
1644996c5bdSBarry Smith   PetscBool                  iascii,isdraw;
1653b224e63SBarry Smith   PetscInt                   i,j;
1663b224e63SBarry Smith   PC_FieldSplitLink          ilink = jac->head;
167a9908d51SBarry Smith   MatSchurComplementAinvType atype;
1683b224e63SBarry Smith 
1693b224e63SBarry Smith   PetscFunctionBegin;
170251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1714996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1723b224e63SBarry Smith   if (iascii) {
1732c9966d7SBarry Smith     if (jac->bs > 0) {
174c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1752c9966d7SBarry Smith     } else {
1762c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1772c9966d7SBarry Smith     }
178f5236f50SJed Brown     if (pc->useAmat) {
179f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
180a3df900dSMatthew G Knepley     }
1813e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1823e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
183a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);
184a9908d51SBarry Smith       break;
185a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
186a9908d51SBarry Smith       ierr = MatSchurComplementGetAinvType(jac->schur,&atype);CHKERRQ(ierr);
187d0a9c1a2SBarry 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;
188e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
189a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
190a9908d51SBarry Smith       break;
191e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
192a9908d51SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);
193a9908d51SBarry Smith       break;
1943e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1953e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1963e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1973e8b8b31SMatthew G Knepley       } else {
198e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1993e8b8b31SMatthew G Knepley       }
2003e8b8b31SMatthew G Knepley       break;
2013e8b8b31SMatthew G Knepley     default:
20282f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
2033e8b8b31SMatthew G Knepley     }
2043b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
2053b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2063b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
2073b224e63SBarry Smith       if (ilink->fields) {
2083b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
2093b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
2103b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
2113b224e63SBarry Smith           if (j > 0) {
2123b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
2133b224e63SBarry Smith           }
2143b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
2153b224e63SBarry Smith         }
2163b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
2173b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2183b224e63SBarry Smith       } else {
2193b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2203b224e63SBarry Smith       }
2213b224e63SBarry Smith       ilink = ilink->next;
2223b224e63SBarry Smith     }
223435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2243b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22506de4afeSJed Brown     if (jac->head) {
226443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
22706de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2283b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
22906de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
230443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
231443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
232b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
233b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
234443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
235443836d0SMatthew G Knepley     }
236435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2373b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
23812cae6f2SJed Brown     if (jac->kspschur) {
2393b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
24012cae6f2SJed Brown     } else {
24112cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
24212cae6f2SJed Brown     }
2433b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2443b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
24506de4afeSJed Brown   } else if (isdraw && jac->head) {
2464996c5bdSBarry Smith     PetscDraw draw;
2474996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2484996c5bdSBarry Smith     PetscInt  cnt = 2;
2494996c5bdSBarry Smith     char      str[32];
2504996c5bdSBarry Smith 
2514996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2524996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
253c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
254c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
255c74581afSBarry Smith     wd = w/(cnt + 1);
256c74581afSBarry Smith 
2574996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
25851fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2594996c5bdSBarry Smith     y   -= h;
2604996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
261e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2623b224e63SBarry Smith     } else {
2634996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2644996c5bdSBarry Smith     }
26551fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2664996c5bdSBarry Smith     y   -= h;
2674996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2684996c5bdSBarry Smith 
2694996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2704996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2714996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2724996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2734996c5bdSBarry Smith       x   += wd;
2744996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2754996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2764996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2774996c5bdSBarry Smith     }
2784996c5bdSBarry Smith     x   += wd;
2794996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2804996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2814996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2823b224e63SBarry Smith   }
2833b224e63SBarry Smith   PetscFunctionReturn(0);
2843b224e63SBarry Smith }
2853b224e63SBarry Smith 
286a51937d4SCarola Kruse static PetscErrorCode PCView_FieldSplit_GKB(PC pc,PetscViewer viewer)
287a51937d4SCarola Kruse {
288a51937d4SCarola Kruse   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
289a51937d4SCarola Kruse   PetscErrorCode    ierr;
290a51937d4SCarola Kruse   PetscBool         iascii,isdraw;
291a51937d4SCarola Kruse   PetscInt          i,j;
292a51937d4SCarola Kruse   PC_FieldSplitLink ilink = jac->head;
293a51937d4SCarola Kruse 
294a51937d4SCarola Kruse   PetscFunctionBegin;
295a51937d4SCarola Kruse   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
296a51937d4SCarola Kruse   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
297a51937d4SCarola Kruse   if (iascii) {
298a51937d4SCarola Kruse     if (jac->bs > 0) {
299a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
300a51937d4SCarola Kruse     } else {
301a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
302a51937d4SCarola Kruse     }
303a51937d4SCarola Kruse     if (pc->useAmat) {
304a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
305a51937d4SCarola Kruse     }
306a51937d4SCarola Kruse     if (jac->diag_use_amat) {
307a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
308a51937d4SCarola Kruse     }
309a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
310a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
311a51937d4SCarola Kruse     }
312a51937d4SCarola Kruse 
313a51937d4SCarola Kruse     ierr = PetscViewerASCIIPrintf(viewer,"  Stopping tolerance=%.1e, delay in error estimate=%D, maximum iterations=%D\n",jac->gkbtol,jac->gkbdelay,jac->gkbmaxit);CHKERRQ(ierr);
314a51937d4SCarola Kruse     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for H = A00 + nu*A01*A01' matrix:\n");CHKERRQ(ierr);
315a51937d4SCarola Kruse     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
316a51937d4SCarola Kruse 
317a51937d4SCarola Kruse     if (ilink->fields) {
318a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",0);CHKERRQ(ierr);
319a51937d4SCarola Kruse       ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
320a51937d4SCarola Kruse       for (j=0; j<ilink->nfields; j++) {
321a51937d4SCarola Kruse         if (j > 0) {
322a51937d4SCarola Kruse           ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
323a51937d4SCarola Kruse         }
324a51937d4SCarola Kruse         ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
325a51937d4SCarola Kruse       }
326a51937d4SCarola Kruse       ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
327a51937d4SCarola Kruse       ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
328a51937d4SCarola Kruse     } else {
329a51937d4SCarola Kruse         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",0);CHKERRQ(ierr);
330a51937d4SCarola Kruse     }
331a51937d4SCarola Kruse     ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
332a51937d4SCarola Kruse 
333a51937d4SCarola Kruse     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
334a51937d4SCarola Kruse   }
335a51937d4SCarola Kruse 
336a51937d4SCarola Kruse  if (isdraw) {
337a51937d4SCarola Kruse     PetscDraw draw;
338a51937d4SCarola Kruse     PetscReal x,y,w,wd;
339a51937d4SCarola Kruse 
340a51937d4SCarola Kruse     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
341a51937d4SCarola Kruse     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
342a51937d4SCarola Kruse     w    = 2*PetscMin(1.0 - x,x);
343a51937d4SCarola Kruse     wd   = w/(jac->nsplits + 1);
344a51937d4SCarola Kruse     x    = x - wd*(jac->nsplits-1)/2.0;
345a51937d4SCarola Kruse     for (i=0; i<jac->nsplits; i++) {
346a51937d4SCarola Kruse       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
347a51937d4SCarola Kruse       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
348a51937d4SCarola Kruse       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
349a51937d4SCarola Kruse       x    += wd;
350a51937d4SCarola Kruse       ilink = ilink->next;
351a51937d4SCarola Kruse     }
352a51937d4SCarola Kruse   }
353a51937d4SCarola Kruse   PetscFunctionReturn(0);
354a51937d4SCarola Kruse }
355a51937d4SCarola Kruse 
356a51937d4SCarola Kruse 
3576c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
3586c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
3596c924f48SJed Brown {
3606c924f48SJed Brown   PetscErrorCode ierr;
3616c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
3625d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
3635d4c12cdSJungho Lee   PetscBool      flg,flg_col;
3645d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
3656c924f48SJed Brown 
3666c924f48SJed Brown   PetscFunctionBegin;
367785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
368785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
3696c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
3708caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
3718caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
3728caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
3736c924f48SJed Brown     nfields     = jac->bs;
37429499fbbSJungho Lee     nfields_col = jac->bs;
375c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
376c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
3776c924f48SJed Brown     if (!flg) break;
3785d4c12cdSJungho Lee     else if (flg && !flg_col) {
3795d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
3805d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
3812fa5cd67SKarl Rupp     } else {
3825d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
3835d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
3845d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
3855d4c12cdSJungho Lee     }
3866c924f48SJed Brown   }
3876c924f48SJed Brown   if (i > 0) {
3886c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3896c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3906c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3916c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3926c924f48SJed Brown   }
3936c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3945d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3956c924f48SJed Brown   PetscFunctionReturn(0);
3966c924f48SJed Brown }
3976c924f48SJed Brown 
39869a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3990971522cSBarry Smith {
4000971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
4010971522cSBarry Smith   PetscErrorCode    ierr;
4025a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
4037b752e3dSPatrick Sanan   PetscBool         fieldsplit_default = PETSC_FALSE,coupling = PETSC_FALSE;
4046c924f48SJed Brown   PetscInt          i;
4050971522cSBarry Smith 
4060971522cSBarry Smith   PetscFunctionBegin;
4077287d2a3SDmitry Karpeev   /*
408f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
4097287d2a3SDmitry Karpeev    Should probably be rewritten.
4107287d2a3SDmitry Karpeev    */
411f5f0d762SBarry Smith   if (!ilink) {
412c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
4137b752e3dSPatrick Sanan     if (pc->dm && jac->dm_splits && !jac->detect && !coupling) {
414bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
4150784a22cSJed Brown       char      **fieldNames;
4167b62db95SJungho Lee       IS        *fields;
417e7c4fc90SDmitry Karpeev       DM        *dms;
418bafc1b83SMatthew G Knepley       DM        subdm[128];
419bafc1b83SMatthew G Knepley       PetscBool flg;
420bafc1b83SMatthew G Knepley 
42116621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
422bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
423bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
424bafc1b83SMatthew G Knepley         PetscInt ifields[128];
425bafc1b83SMatthew G Knepley         IS       compField;
426bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
427bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
428bafc1b83SMatthew G Knepley 
4298caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
430c5929fdfSBarry Smith         ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
431bafc1b83SMatthew G Knepley         if (!flg) break;
43282f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
433bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
434bafc1b83SMatthew G Knepley         if (nfields == 1) {
435bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
436bafc1b83SMatthew G Knepley         } else {
4378caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
438bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
4397287d2a3SDmitry Karpeev         }
440bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
441bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
442bafc1b83SMatthew G Knepley           f    = ifields[j];
4437b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
4447b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
4457b62db95SJungho Lee         }
446bafc1b83SMatthew G Knepley       }
447bafc1b83SMatthew G Knepley       if (i == 0) {
448bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
449bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
450bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
451bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
452bafc1b83SMatthew G Knepley         }
453bafc1b83SMatthew G Knepley       } else {
454d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
455d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
456d724dfffSBarry Smith         }
457d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
458785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
4592fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
460bafc1b83SMatthew G Knepley       }
4617b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
4627b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
463e7c4fc90SDmitry Karpeev       if (dms) {
4648b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
465bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
4667287d2a3SDmitry Karpeev           const char *prefix;
4677287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
4687287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
4697b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
4707b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
47195dbaa6fSMatthew G. Knepley           {
47295dbaa6fSMatthew G. Knepley             PetscErrorCode (*func)(KSP,Mat,Mat,void*);
47395dbaa6fSMatthew G. Knepley             void            *ctx;
47495dbaa6fSMatthew G. Knepley 
47595dbaa6fSMatthew G. Knepley             ierr = DMKSPGetComputeOperators(pc->dm, &func, &ctx);CHKERRQ(ierr);
47695dbaa6fSMatthew G. Knepley             ierr = DMKSPSetComputeOperators(dms[i],  func,  ctx);CHKERRQ(ierr);
47795dbaa6fSMatthew G. Knepley           }
4787287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
479e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
4802fa5ba8aSJed Brown         }
4817b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
4828b8307b2SJed Brown       }
48366ffff09SJed Brown     } else {
484521d7252SBarry Smith       if (jac->bs <= 0) {
485704ba839SBarry Smith         if (pc->pmat) {
486521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
4872fa5cd67SKarl Rupp         } else jac->bs = 1;
488521d7252SBarry Smith       }
489d32f9abdSBarry Smith 
4907b752e3dSPatrick Sanan       if (jac->detect) {
4916ce1633cSBarry Smith         IS       zerodiags,rest;
4926ce1633cSBarry Smith         PetscInt nmin,nmax;
4936ce1633cSBarry Smith 
4946ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4956ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4966ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4976ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4986ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
499fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
500fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
5013a062f41SBarry Smith       } else if (coupling) {
5023a062f41SBarry Smith         IS       coupling,rest;
5033a062f41SBarry Smith         PetscInt nmin,nmax;
5043a062f41SBarry Smith 
5053a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
5063a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
5076bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
508e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
509d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
510d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr);
5113a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
5123a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
5136ce1633cSBarry Smith       } else {
514c5929fdfSBarry Smith         ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
5157287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
516d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
517d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
5186c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
5196c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
520d32f9abdSBarry Smith         }
5216dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
522d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
523db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
5246c924f48SJed Brown             char splitname[8];
5258caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
5265d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
52779416396SBarry Smith           }
5285d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
529521d7252SBarry Smith         }
53066ffff09SJed Brown       }
5316ce1633cSBarry Smith     }
532edf189efSBarry Smith   } else if (jac->nsplits == 1) {
533edf189efSBarry Smith     if (ilink->is) {
534edf189efSBarry Smith       IS       is2;
535edf189efSBarry Smith       PetscInt nmin,nmax;
536edf189efSBarry Smith 
537edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
538edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
539db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
540fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
54182f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
542edf189efSBarry Smith   }
543d0af7cd3SBarry Smith 
54482f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
54569a612a9SBarry Smith   PetscFunctionReturn(0);
54669a612a9SBarry Smith }
54769a612a9SBarry Smith 
548a51937d4SCarola Kruse static PetscErrorCode MatGolubKahanComputeExplicitOperator(Mat A,Mat B,Mat C,Mat *H,PetscReal gkbnu)
549a51937d4SCarola Kruse {
550a51937d4SCarola Kruse   PetscErrorCode    ierr;
551a51937d4SCarola Kruse   Mat               BT,T;
552de482cd7SCarola Kruse   PetscReal         nrmT,nrmB;
553a51937d4SCarola Kruse 
554a51937d4SCarola Kruse   PetscFunctionBegin;
555a51937d4SCarola Kruse   ierr = MatHermitianTranspose(C,MAT_INITIAL_MATRIX,&T);CHKERRQ(ierr);            /* Test if augmented matrix is symmetric */
556a51937d4SCarola Kruse   ierr = MatAXPY(T,-1.0,B,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);
557de482cd7SCarola Kruse   ierr = MatNorm(T,NORM_1,&nrmT);CHKERRQ(ierr);
558de482cd7SCarola Kruse   ierr = MatNorm(B,NORM_1,&nrmB);CHKERRQ(ierr);
559de482cd7SCarola Kruse   if (nrmB > 0) {
560de482cd7SCarola Kruse     if (nrmT/nrmB >= PETSC_SMALL) {
561de482cd7SCarola Kruse       SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Matrix is not symmetric/hermitian, GKB is not applicable.");
562de482cd7SCarola Kruse     }
563a51937d4SCarola Kruse   }
564a51937d4SCarola Kruse   /* Compute augmented Lagrangian matrix H = A00 + nu*A01*A01'. This corresponds to */
565a51937d4SCarola Kruse   /* setting N := 1/nu*I in [Ar13].                                                 */
566a51937d4SCarola Kruse   ierr = MatHermitianTranspose(B,MAT_INITIAL_MATRIX,&BT);CHKERRQ(ierr);
567a51937d4SCarola Kruse   ierr = MatMatMult(B,BT,MAT_INITIAL_MATRIX,PETSC_DEFAULT,H);CHKERRQ(ierr);       /* H = A01*A01'          */
568a51937d4SCarola Kruse   ierr = MatAYPX(*H,gkbnu,A,DIFFERENT_NONZERO_PATTERN);CHKERRQ(ierr);             /* H = A00 + nu*A01*A01' */
569a51937d4SCarola Kruse 
570a51937d4SCarola Kruse   ierr = MatDestroy(&BT);CHKERRQ(ierr);
571a51937d4SCarola Kruse   ierr = MatDestroy(&T);CHKERRQ(ierr);
572a51937d4SCarola Kruse   PetscFunctionReturn(0);
573a51937d4SCarola Kruse }
574a51937d4SCarola Kruse 
5752d747510SLisandro Dalcin PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[],const char *value[],PetscBool *flg);
576514bf10dSMatthew G Knepley 
57769a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
57869a612a9SBarry Smith {
57969a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
58069a612a9SBarry Smith   PetscErrorCode    ierr;
5815a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
5822c9966d7SBarry Smith   PetscInt          i,nsplit;
5835f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
58469a612a9SBarry Smith 
58569a612a9SBarry Smith   PetscFunctionBegin;
5865da88fe4STristan Konolige   pc->failedreason = PC_NOERROR;
58769a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
58897bbdb24SBarry Smith   nsplit = jac->nsplits;
5895a9f2f41SSatish Balay   ilink  = jac->head;
59097bbdb24SBarry Smith 
59197bbdb24SBarry Smith   /* get the matrices for each split */
592704ba839SBarry Smith   if (!jac->issetup) {
5931b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
59497bbdb24SBarry Smith 
595704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
596704ba839SBarry Smith 
5975d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
5982c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
5992c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
6002c9966d7SBarry Smith     }
60151f519a2SBarry Smith     bs     = jac->bs;
60297bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
6031b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
6041b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
6051b9fc7fcSBarry Smith       if (jac->defaultsplit) {
606ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
6075f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
608704ba839SBarry Smith       } else if (!ilink->is) {
609ccb205f8SBarry Smith         if (ilink->nfields > 1) {
6105f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
611785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
612785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
6131b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
6141b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
6151b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
6165f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
61797bbdb24SBarry Smith             }
61897bbdb24SBarry Smith           }
619ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
620ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
62190e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
62290e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
623ccb205f8SBarry Smith         } else {
624ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
625ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
626ccb205f8SBarry Smith         }
6273e197d65SBarry Smith       }
628704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
6295f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
6305f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
631704ba839SBarry Smith       ilink = ilink->next;
6321b9fc7fcSBarry Smith     }
6331b9fc7fcSBarry Smith   }
6341b9fc7fcSBarry Smith 
635704ba839SBarry Smith   ilink = jac->head;
63697bbdb24SBarry Smith   if (!jac->pmat) {
637bdddcaaaSMatthew G Knepley     Vec xtmp;
638bdddcaaaSMatthew G Knepley 
6392a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
640785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
641dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
642cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
643bdddcaaaSMatthew G Knepley       MatNullSpace sp;
644bdddcaaaSMatthew G Knepley 
645a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
646a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
647a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
648a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
649a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
650a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
6512fa5cd67SKarl Rupp 
652a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
653a3df900dSMatthew G Knepley         }
654a3df900dSMatthew G Knepley       } else {
6553a062f41SBarry Smith         const char *prefix;
6567dae84e0SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
6573a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
6583a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
6593a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
660a3df900dSMatthew G Knepley       }
661bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
6622a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
6630298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
664bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
6659448b7f1SJunchao Zhang       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
666ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
667ed1f0337SMatthew G Knepley       if (sp) {
668ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
669ed1f0337SMatthew G Knepley       }
670704ba839SBarry Smith       ilink = ilink->next;
671cf502942SBarry Smith     }
672bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
67397bbdb24SBarry Smith   } else {
674ef7efd37SHong Zhang     MatReuse scall;
675ef7efd37SHong Zhang     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
676ef7efd37SHong Zhang       for (i=0; i<nsplit; i++) {
677ef7efd37SHong Zhang         ierr = MatDestroy(&jac->pmat[i]);CHKERRQ(ierr);
678ef7efd37SHong Zhang       }
679ef7efd37SHong Zhang       scall = MAT_INITIAL_MATRIX;
680ef7efd37SHong Zhang     } else scall = MAT_REUSE_MATRIX;
681ef7efd37SHong Zhang 
682cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
683a3df900dSMatthew G Knepley       Mat pmat;
684a3df900dSMatthew G Knepley 
685a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
686a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
687a3df900dSMatthew G Knepley       if (!pmat) {
688ef7efd37SHong Zhang         ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ilink->is_col,scall,&jac->pmat[i]);CHKERRQ(ierr);
689a3df900dSMatthew G Knepley       }
690704ba839SBarry Smith       ilink = ilink->next;
691cf502942SBarry Smith     }
69297bbdb24SBarry Smith   }
6934e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
694519d70e2SJed Brown     ilink = jac->head;
695519d70e2SJed Brown     if (!jac->mat) {
696785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
697519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
6987dae84e0SHong Zhang         ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
699519d70e2SJed Brown         ilink = ilink->next;
700519d70e2SJed Brown       }
701519d70e2SJed Brown     } else {
702ef7efd37SHong Zhang       MatReuse scall;
703ef7efd37SHong Zhang       if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
704519d70e2SJed Brown         for (i=0; i<nsplit; i++) {
705ef7efd37SHong Zhang           ierr = MatDestroy(&jac->mat[i]);CHKERRQ(ierr);
706ef7efd37SHong Zhang         }
707ef7efd37SHong Zhang         scall = MAT_INITIAL_MATRIX;
708ef7efd37SHong Zhang       } else scall = MAT_REUSE_MATRIX;
709ef7efd37SHong Zhang 
710ef7efd37SHong Zhang       for (i=0; i<nsplit; i++) {
711ef7efd37SHong Zhang         if (jac->mat[i]) {ierr = MatCreateSubMatrix(pc->mat,ilink->is,ilink->is_col,scall,&jac->mat[i]);CHKERRQ(ierr);}
712519d70e2SJed Brown         ilink = ilink->next;
713519d70e2SJed Brown       }
714519d70e2SJed Brown     }
715519d70e2SJed Brown   } else {
716519d70e2SJed Brown     jac->mat = jac->pmat;
717519d70e2SJed Brown   }
71897bbdb24SBarry Smith 
71953935eafSBarry Smith   /* Check for null space attached to IS */
72053935eafSBarry Smith   ilink = jac->head;
72153935eafSBarry Smith   for (i=0; i<nsplit; i++) {
72253935eafSBarry Smith     MatNullSpace sp;
72353935eafSBarry Smith 
72453935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
72553935eafSBarry Smith     if (sp) {
72653935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
72753935eafSBarry Smith     }
72853935eafSBarry Smith     ilink = ilink->next;
72953935eafSBarry Smith   }
73053935eafSBarry Smith 
731a51937d4SCarola Kruse   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR && jac->type != PC_COMPOSITE_GKB) {
73268dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
7334e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
73468dd23aaSBarry Smith     ilink = jac->head;
735e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
736e52d2c62SBarry 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 */
737e52d2c62SBarry Smith       if (!jac->Afield) {
738e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
73980c96bb1SFande Kong         if (jac->offdiag_use_amat) {
7407dae84e0SHong Zhang           ierr  = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
741e52d2c62SBarry Smith         } else {
7427dae84e0SHong Zhang           ierr  = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
74380c96bb1SFande Kong         }
74480c96bb1SFande Kong       } else {
745ef7efd37SHong Zhang         MatReuse scall;
746ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
747ef7efd37SHong Zhang           for (i=0; i<nsplit; i++) {
748ef7efd37SHong Zhang             ierr = MatDestroy(&jac->Afield[1]);CHKERRQ(ierr);
749ef7efd37SHong Zhang           }
750ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
751ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
752ef7efd37SHong Zhang 
75380c96bb1SFande Kong         if (jac->offdiag_use_amat) {
754ef7efd37SHong Zhang           ierr  = MatCreateSubMatrix(pc->mat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr);
75580c96bb1SFande Kong         } else {
756ef7efd37SHong Zhang           ierr  = MatCreateSubMatrix(pc->pmat,ilink->next->is,ilink->is,scall,&jac->Afield[1]);CHKERRQ(ierr);
75780c96bb1SFande Kong         }
758e52d2c62SBarry Smith       }
759e52d2c62SBarry Smith     } else {
76068dd23aaSBarry Smith       if (!jac->Afield) {
761785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
76268dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
76380c96bb1SFande Kong           if (jac->offdiag_use_amat) {
7647dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
76580c96bb1SFande Kong           } else {
7667dae84e0SHong Zhang             ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
76780c96bb1SFande Kong           }
76868dd23aaSBarry Smith           ilink = ilink->next;
76968dd23aaSBarry Smith         }
77068dd23aaSBarry Smith       } else {
771ef7efd37SHong Zhang         MatReuse scall;
772ef7efd37SHong Zhang         if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
773ef7efd37SHong Zhang           for (i=0; i<nsplit; i++) {
774ef7efd37SHong Zhang             ierr = MatDestroy(&jac->Afield[i]);CHKERRQ(ierr);
775ef7efd37SHong Zhang           }
776ef7efd37SHong Zhang           scall = MAT_INITIAL_MATRIX;
777ef7efd37SHong Zhang         } else scall = MAT_REUSE_MATRIX;
778ef7efd37SHong Zhang 
77968dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
78080c96bb1SFande Kong           if (jac->offdiag_use_amat) {
781ef7efd37SHong Zhang             ierr  = MatCreateSubMatrix(pc->mat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr);
78280c96bb1SFande Kong           } else {
783ef7efd37SHong Zhang             ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,NULL,scall,&jac->Afield[i]);CHKERRQ(ierr);
78480c96bb1SFande Kong           }
78568dd23aaSBarry Smith           ilink = ilink->next;
78668dd23aaSBarry Smith         }
78768dd23aaSBarry Smith       }
78868dd23aaSBarry Smith     }
789e52d2c62SBarry Smith   }
79068dd23aaSBarry Smith 
7913b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
7923b224e63SBarry Smith     IS          ccis;
793c096484dSStefano Zampini     PetscBool   isspd;
7944aa3045dSJed Brown     PetscInt    rstart,rend;
795093c86ffSJed Brown     char        lscname[256];
796093c86ffSJed Brown     PetscObject LSC_L;
797ce94432eSBarry Smith 
798ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
79968dd23aaSBarry Smith 
800c096484dSStefano Zampini     /* If pc->mat is SPD, don't scale by -1 the Schur complement */
801c096484dSStefano Zampini     if (jac->schurscale == (PetscScalar)-1.0) {
802c096484dSStefano Zampini       ierr = MatGetOption(pc->pmat,MAT_SPD,&isspd);CHKERRQ(ierr);
803c096484dSStefano Zampini       jac->schurscale = (isspd == PETSC_TRUE) ? 1.0 : -1.0;
804c096484dSStefano Zampini     }
805c096484dSStefano Zampini 
806e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
807e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
808e6cab6aaSJed Brown 
8093b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
8103b224e63SBarry Smith     if (jac->schur) {
8110298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
812443836d0SMatthew G Knepley 
813fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
8143b224e63SBarry Smith       ilink = jac->head;
81549bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8164e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8177dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
818c84da90fSDmitry Karpeev       } else {
8197dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
820c84da90fSDmitry Karpeev       }
821fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
8223b224e63SBarry Smith       ilink = ilink->next;
82349bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8244e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8257dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
826c84da90fSDmitry Karpeev       } else {
8277dae84e0SHong Zhang 	ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
828c84da90fSDmitry Karpeev       }
829fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
830aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
831a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
832a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
833a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
834a7476a74SDmitry Karpeev       }
835443836d0SMatthew G Knepley       if (kspA != kspInner) {
83623ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
837443836d0SMatthew G Knepley       }
838443836d0SMatthew G Knepley       if (kspUpper != kspA) {
83923ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
840443836d0SMatthew G Knepley       }
84123ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
8423b224e63SBarry Smith     } else {
843bafc1b83SMatthew G Knepley       const char   *Dprefix;
844470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
845514bf10dSMatthew G Knepley       char         schurtestoption[256];
846bdddcaaaSMatthew G Knepley       MatNullSpace sp;
847514bf10dSMatthew G Knepley       PetscBool    flg;
848686bed4dSStefano Zampini       KSP          kspt;
8493b224e63SBarry Smith 
850a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
8513b224e63SBarry Smith       ilink = jac->head;
85249bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8534e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8547dae84e0SHong Zhang 	ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
855c84da90fSDmitry Karpeev       } else {
8567dae84e0SHong Zhang 	ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
857c84da90fSDmitry Karpeev       }
858fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
8593b224e63SBarry Smith       ilink = ilink->next;
86049bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
8614e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
8627dae84e0SHong Zhang 	ierr = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
863c84da90fSDmitry Karpeev       } else {
8647dae84e0SHong Zhang 	ierr = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
865c84da90fSDmitry Karpeev       }
866fcfd50ebSBarry Smith       ierr = ISDestroy(&ccis);CHKERRQ(ierr);
86720252d06SBarry Smith 
868f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
86920252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
87020252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
871bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
872470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
873470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
874686bed4dSStefano Zampini       ierr = MatSchurComplementGetKSP(jac->schur,&kspt);CHKERRQ(ierr);
875686bed4dSStefano Zampini       ierr = KSPSetOptionsPrefix(kspt,schurmatprefix);CHKERRQ(ierr);
876686bed4dSStefano Zampini 
877686bed4dSStefano Zampini       /* Note: this is not true in general */
878895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
87920252d06SBarry Smith       if (sp) {
88020252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
88120252d06SBarry Smith       }
88220252d06SBarry Smith 
88320252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
884c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
885514bf10dSMatthew G Knepley       if (flg) {
886514bf10dSMatthew G Knepley         DM  dmInner;
88721635b76SJed Brown         KSP kspInner;
888686bed4dSStefano Zampini         PC  pcInner;
88921635b76SJed Brown 
89021635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
8912cc093acSMatthew G. Knepley         ierr = KSPReset(kspInner);CHKERRQ(ierr);
8922cc093acSMatthew G. Knepley         ierr = KSPSetOperators(kspInner,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
89321635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
89421635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
89521635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
8962cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner->pc, (PetscObject) pc, 2);CHKERRQ(ierr);
89721635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
898514bf10dSMatthew G Knepley 
899514bf10dSMatthew G Knepley         /* Set DM for new solver */
900bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
90121635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
90221635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
903686bed4dSStefano Zampini 
904686bed4dSStefano Zampini         /* Defaults to PCKSP as preconditioner */
905686bed4dSStefano Zampini         ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr);
906686bed4dSStefano Zampini         ierr = PCSetType(pcInner, PCKSP);CHKERRQ(ierr);
907686bed4dSStefano Zampini         ierr = PCKSPSetKSP(pcInner, jac->head->ksp);CHKERRQ(ierr);
908514bf10dSMatthew G Knepley       } else {
90921635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
91021635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
91121635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
91221635b76SJed 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
91321635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
91421635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
91521635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
916514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
917bafc1b83SMatthew G Knepley       }
91823ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
9195a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
92097bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
92197bbdb24SBarry Smith 
922686bed4dSStefano Zampini       ierr = PetscObjectTypeCompare((PetscObject)jac->schur, MATSCHURCOMPLEMENT, &flg);CHKERRQ(ierr);
923686bed4dSStefano Zampini       if (flg) { /* Need to do this otherwise PCSetUp_KSP will overwrite the amat of jac->head->ksp */
924686bed4dSStefano Zampini         KSP kspInner;
925686bed4dSStefano Zampini         PC  pcInner;
926686bed4dSStefano Zampini 
927686bed4dSStefano Zampini         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
928686bed4dSStefano Zampini         ierr = KSPGetPC(kspInner, &pcInner);CHKERRQ(ierr);
929686bed4dSStefano Zampini         ierr = PetscObjectTypeCompare((PetscObject)pcInner, PCKSP, &flg);CHKERRQ(ierr);
930686bed4dSStefano Zampini         if (flg) {
931686bed4dSStefano Zampini           KSP ksp;
932686bed4dSStefano Zampini 
933686bed4dSStefano Zampini           ierr = PCKSPGetKSP(pcInner, &ksp);CHKERRQ(ierr);
934686bed4dSStefano Zampini           if (ksp == jac->head->ksp) {
935686bed4dSStefano Zampini             ierr = PCSetUseAmat(pcInner, PETSC_TRUE);CHKERRQ(ierr);
936686bed4dSStefano Zampini           }
937686bed4dSStefano Zampini         }
938686bed4dSStefano Zampini       }
939443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
940c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
941443836d0SMatthew G Knepley       if (flg) {
942443836d0SMatthew G Knepley         DM dmInner;
943443836d0SMatthew G Knepley 
944443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
94582f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
946422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
947443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
9482cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper, (PetscObject) pc, 1);CHKERRQ(ierr);
9492cc093acSMatthew G. Knepley         ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspupper->pc, (PetscObject) pc, 1);CHKERRQ(ierr);
950443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
951443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
952443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
953443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
95423ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
955443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
956443836d0SMatthew G Knepley       } else {
957443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
958443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
959443836d0SMatthew G Knepley       }
960443836d0SMatthew G Knepley 
961a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
962a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
963a7476a74SDmitry Karpeev       }
964ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
965422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
96697bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
96720252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
96897bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
9697233a360SDmitry Karpeev         PC pcschur;
9707233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
9717233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
97297bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
973e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
974e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
97597bbdb24SBarry Smith       }
97623ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
97797bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
97897bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
979c096484dSStefano Zampini       /* propagate DM */
980b20b4189SMatthew G. Knepley       {
981b20b4189SMatthew G. Knepley         DM sdm;
982b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
983b20b4189SMatthew G. Knepley         if (sdm) {
984b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
985b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
986b20b4189SMatthew G. Knepley         }
987b20b4189SMatthew G. Knepley       }
98897bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
98997bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
99097bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
99197bbdb24SBarry Smith     }
992686bed4dSStefano Zampini     ierr = MatAssemblyBegin(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
993686bed4dSStefano Zampini     ierr = MatAssemblyEnd(jac->schur,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
99497bbdb24SBarry Smith 
9955a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
9968caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
997519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
9983b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
999c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
10008caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
100197bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
10025a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
10030971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
1004a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1005a51937d4SCarola Kruse     IS          ccis;
1006a51937d4SCarola Kruse     PetscInt    rstart,rend;
1007a51937d4SCarola Kruse 
1008a51937d4SCarola Kruse     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use GKB preconditioner you must have exactly 2 fields");
1009a51937d4SCarola Kruse 
1010a51937d4SCarola Kruse     ilink = jac->head;
1011a51937d4SCarola Kruse 
1012a51937d4SCarola Kruse     /* When extracting off-diagonal submatrices, we take complements from this range */
1013a51937d4SCarola Kruse     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
1014a51937d4SCarola Kruse 
1015a51937d4SCarola Kruse     ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
1016a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
1017a51937d4SCarola Kruse      ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
1018a51937d4SCarola Kruse     } else {
1019a51937d4SCarola Kruse       ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
1020a51937d4SCarola Kruse     }
1021a51937d4SCarola Kruse     ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
1022e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
1023e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->u);CHKERRQ(ierr);
1024e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->Hu);CHKERRQ(ierr);
1025e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->w2);CHKERRQ(ierr);
1026a51937d4SCarola Kruse     ilink = ilink->next;
1027a51937d4SCarola Kruse     ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
1028a51937d4SCarola Kruse     if (jac->offdiag_use_amat) {
1029a51937d4SCarola Kruse       ierr  = MatCreateSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
1030a51937d4SCarola Kruse     } else {
1031a51937d4SCarola Kruse       ierr  = MatCreateSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
1032a51937d4SCarola Kruse     }
1033a51937d4SCarola Kruse     ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
1034e071a0a4SCarola Kruse     /* Create work vectors for GKB algorithm */
1035e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->v);CHKERRQ(ierr);
1036e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->d);CHKERRQ(ierr);
1037e071a0a4SCarola Kruse     ierr  = VecDuplicate(ilink->x,&jac->w1);CHKERRQ(ierr);
1038a51937d4SCarola Kruse     ierr  = MatGolubKahanComputeExplicitOperator(jac->mat[0],jac->B,jac->C,&jac->H,jac->gkbnu);CHKERRQ(ierr);
1039e071a0a4SCarola Kruse     ierr  = PetscCalloc1(jac->gkbdelay,&jac->vecz);CHKERRQ(ierr);
1040e071a0a4SCarola Kruse 
1041a51937d4SCarola Kruse     ilink = jac->head;
1042a51937d4SCarola Kruse     ierr  = KSPSetOperators(ilink->ksp,jac->H,jac->H);CHKERRQ(ierr);
1043a51937d4SCarola Kruse     if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
1044e071a0a4SCarola Kruse     /* Create gkb_monitor context */
1045de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1046de482cd7SCarola Kruse       PetscInt  tablevel;
1047de482cd7SCarola Kruse       ierr = PetscViewerCreate(PETSC_COMM_WORLD,&jac->gkbviewer);CHKERRQ(ierr);
1048de482cd7SCarola Kruse       ierr = PetscViewerSetType(jac->gkbviewer,PETSCVIEWERASCII);CHKERRQ(ierr);
1049de482cd7SCarola Kruse       ierr = PetscObjectGetTabLevel((PetscObject)ilink->ksp,&tablevel);CHKERRQ(ierr);
1050e071a0a4SCarola Kruse       ierr = PetscViewerASCIISetTab(jac->gkbviewer,tablevel);CHKERRQ(ierr);
1051de482cd7SCarola Kruse       ierr = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)ilink->ksp,1);CHKERRQ(ierr);
1052de482cd7SCarola Kruse     }
10530971522cSBarry Smith   } else {
105468bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
10550971522cSBarry Smith     i     = 0;
10560971522cSBarry Smith     ilink = jac->head;
10570971522cSBarry Smith     while (ilink) {
105823ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
10590971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
10600971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
10610971522cSBarry Smith       i++;
10620971522cSBarry Smith       ilink = ilink->next;
10630971522cSBarry Smith     }
10643b224e63SBarry Smith   }
10653b224e63SBarry Smith 
1066c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
10670971522cSBarry Smith   PetscFunctionReturn(0);
10680971522cSBarry Smith }
10690971522cSBarry Smith 
10705a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
1071ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
1072ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
10739df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
10745a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) ||                               \
1075c0decd05SBarry Smith    KSPCheckSolve(ilink->ksp,pc,ilink->y)  || \
10769df09d43SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
1077ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) ||  \
1078ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
107979416396SBarry Smith 
10803b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
10813b224e63SBarry Smith {
10823b224e63SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
10833b224e63SBarry Smith   PetscErrorCode     ierr;
10843b224e63SBarry Smith   PC_FieldSplitLink  ilinkA = jac->head, ilinkD = ilinkA->next;
1085443836d0SMatthew G Knepley   KSP                kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
10863b224e63SBarry Smith 
10873b224e63SBarry Smith   PetscFunctionBegin;
1088c5d2311dSJed Brown   switch (jac->schurfactorization) {
1089c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
1090a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
1091c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1092c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1093c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10949df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1095443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1096c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
10979df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1098c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1099c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11009df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1101c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1102c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11039df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1104c096484dSStefano Zampini     ierr = VecScale(ilinkD->y,jac->schurscale);CHKERRQ(ierr);
1105c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1106653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1107c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1108c5d2311dSJed Brown     break;
1109c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
1110a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
1111c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1112c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11139df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1114443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1115c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11169df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1117c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
1118c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
1119c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1120c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1121c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11229df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1123c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1124c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11259df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1126c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1127653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1128c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1129c5d2311dSJed Brown     break;
1130c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
1131a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
1132c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1133c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11349df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
1135c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1136c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11379df09d43SBarry 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);
1138c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
1139c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1140c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1141c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11429df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1143443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1144c0decd05SBarry Smith     ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11459df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1146c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1147653b62c3SJunchao Zhang     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1148c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1149c5d2311dSJed Brown     break;
1150c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
1151c238f8cdSStefano Zampini     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1] */
11523b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11533b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11549df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1155443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1156c0decd05SBarry Smith     ierr = KSPCheckSolve(kspLower,pc,ilinkA->y);CHKERRQ(ierr);
11579df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
11583b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
11593b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
11603b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11613b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
11623b224e63SBarry Smith 
11639df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
11643b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
1165c0decd05SBarry Smith     ierr = KSPCheckSolve(jac->kspschur,pc,ilinkD->y);CHKERRQ(ierr);
11669df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
11673b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
11683b224e63SBarry Smith 
1169443836d0SMatthew G Knepley     if (kspUpper == kspA) {
11703b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
11713b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
11729df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1173443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1174c0decd05SBarry Smith       ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
11759df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1176443836d0SMatthew G Knepley     } else {
11779df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1178443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1179c0decd05SBarry Smith       ierr = KSPCheckSolve(kspA,pc,ilinkA->y);CHKERRQ(ierr);
1180443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
11819df09d43SBarry Smith       ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
1182443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
1183c0decd05SBarry Smith       ierr = KSPCheckSolve(kspUpper,pc,ilinkA->z);CHKERRQ(ierr);
11849df09d43SBarry Smith       ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
1185443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
1186443836d0SMatthew G Knepley     }
1187c238f8cdSStefano Zampini     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
11883b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
11893b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1190c5d2311dSJed Brown   }
11913b224e63SBarry Smith   PetscFunctionReturn(0);
11923b224e63SBarry Smith }
11933b224e63SBarry Smith 
11940971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
11950971522cSBarry Smith {
11960971522cSBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
11970971522cSBarry Smith   PetscErrorCode     ierr;
11985a9f2f41SSatish Balay   PC_FieldSplitLink  ilink = jac->head;
1199939b8a20SBarry Smith   PetscInt           cnt,bs;
12000971522cSBarry Smith 
12010971522cSBarry Smith   PetscFunctionBegin;
120279416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
12031b9fc7fcSBarry Smith     if (jac->defaultsplit) {
1204939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1205ce94432eSBarry 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);
1206939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1207ce94432eSBarry 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);
12080971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
12095a9f2f41SSatish Balay       while (ilink) {
12109df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12115a9f2f41SSatish Balay         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1212c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12139df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12145a9f2f41SSatish Balay         ilink = ilink->next;
12150971522cSBarry Smith       }
12160971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
12171b9fc7fcSBarry Smith     } else {
1218efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
12195a9f2f41SSatish Balay       while (ilink) {
12205a9f2f41SSatish Balay         ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
12215a9f2f41SSatish Balay         ilink = ilink->next;
12221b9fc7fcSBarry Smith       }
12231b9fc7fcSBarry Smith     }
1224e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
1225e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1226e52d2c62SBarry Smith     /* solve on first block for first block variables */
1227e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1228e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12299df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1230e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1231c0decd05SBarry Smith     ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12329df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1233e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1234e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1235e52d2c62SBarry Smith 
1236e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
1237e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
1238e52d2c62SBarry Smith     ilink = ilink->next;
1239e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
1240e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1241e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1242e52d2c62SBarry Smith 
1243e52d2c62SBarry Smith     /* solve on second block variables */
12449df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1245e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1246c0decd05SBarry Smith     ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12479df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1248e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1249e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
125016913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
125179416396SBarry Smith     if (!jac->w1) {
125279416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
125379416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
125479416396SBarry Smith     }
1255efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
12565a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
12573e197d65SBarry Smith     cnt  = 1;
12585a9f2f41SSatish Balay     while (ilink->next) {
12595a9f2f41SSatish Balay       ilink = ilink->next;
12603e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
12613e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
12623e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
12633e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12643e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12659df09d43SBarry Smith       ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12663e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1267c0decd05SBarry Smith       ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12689df09d43SBarry Smith       ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
12693e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12703e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
12713e197d65SBarry Smith     }
127251f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
127311755939SBarry Smith       cnt -= 2;
127451f519a2SBarry Smith       while (ilink->previous) {
127551f519a2SBarry Smith         ilink = ilink->previous;
127611755939SBarry Smith         /* compute the residual only over the part of the vector needed */
127711755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
127811755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
127911755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
128011755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
12819df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
128211755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1283c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
12849df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
128511755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
128611755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
128751f519a2SBarry Smith       }
128811755939SBarry Smith     }
1289ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
12900971522cSBarry Smith   PetscFunctionReturn(0);
12910971522cSBarry Smith }
12920971522cSBarry Smith 
1293a51937d4SCarola Kruse 
1294a51937d4SCarola Kruse static PetscErrorCode PCApply_FieldSplit_GKB(PC pc,Vec x,Vec y)
1295a51937d4SCarola Kruse {
1296a51937d4SCarola Kruse   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1297a51937d4SCarola Kruse   PetscErrorCode     ierr;
1298a51937d4SCarola Kruse   PC_FieldSplitLink  ilinkA = jac->head,ilinkD = ilinkA->next;
1299a51937d4SCarola Kruse   KSP                ksp = ilinkA->ksp;
1300de482cd7SCarola Kruse   Vec                u,v,Hu,d,work1,work2;
1301e071a0a4SCarola Kruse   PetscScalar        alpha,z,nrmz2,*vecz;
1302e071a0a4SCarola Kruse   PetscReal          lowbnd,nu,beta;
1303a51937d4SCarola Kruse   PetscInt           j,iterGKB;
1304a51937d4SCarola Kruse 
1305a51937d4SCarola Kruse   PetscFunctionBegin;
1306a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1307a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1308de482cd7SCarola Kruse   ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1309a51937d4SCarola Kruse   ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
1310e071a0a4SCarola Kruse 
1311e071a0a4SCarola Kruse   u     = jac->u;
1312e071a0a4SCarola Kruse   v     = jac->v;
1313e071a0a4SCarola Kruse   Hu    = jac->Hu;
1314e071a0a4SCarola Kruse   d     = jac->d;
1315e071a0a4SCarola Kruse   work1 = jac->w1;
1316e071a0a4SCarola Kruse   work2 = jac->w2;
1317e071a0a4SCarola Kruse   vecz  = jac->vecz;
1318a51937d4SCarola Kruse 
1319a51937d4SCarola Kruse   /* Change RHS to comply with matrix regularization H = A + nu*B*B' */
1320a51937d4SCarola Kruse   /* Add q = q + nu*B*b */
1321a51937d4SCarola Kruse   if (jac->gkbnu) {
1322a51937d4SCarola Kruse     nu = jac->gkbnu;
1323de482cd7SCarola Kruse     ierr = VecScale(ilinkD->x,jac->gkbnu);CHKERRQ(ierr);
1324de482cd7SCarola Kruse     ierr = MatMultAdd(jac->B,ilinkD->x,ilinkA->x,ilinkA->x);CHKERRQ(ierr);            /* q = q + nu*B*b */
1325a51937d4SCarola Kruse   } else {
1326a51937d4SCarola Kruse     /* Situation when no augmented Lagrangian is used. Then we set inner  */
1327a51937d4SCarola Kruse     /* matrix N = I in [Ar13], and thus nu = 1.                           */
1328a51937d4SCarola Kruse     nu = 1;
1329a51937d4SCarola Kruse   }
1330a51937d4SCarola Kruse 
1331a51937d4SCarola Kruse   /* Transform rhs from [q,tilde{b}] to [0,b] */
1332de482cd7SCarola Kruse   ierr = PetscLogEventBegin(ilinkA->event,ksp,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1333de482cd7SCarola Kruse   ierr = KSPSolve(ksp,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
1334c0decd05SBarry Smith   ierr = KSPCheckSolve(ksp,pc,ilinkA->y);CHKERRQ(ierr);
1335de482cd7SCarola Kruse   ierr = PetscLogEventEnd(ilinkA->event,ksp,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
1336a51937d4SCarola Kruse   ierr = MatMultHermitianTranspose(jac->B,ilinkA->y,work1);CHKERRQ(ierr);
133792c1e38eSCarola Kruse   ierr = VecAXPBY(work1,1.0/nu,-1.0,ilinkD->x);CHKERRQ(ierr);            /* c = b - B'*x        */
1338a51937d4SCarola Kruse 
1339a51937d4SCarola Kruse   /* First step of algorithm */
1340de482cd7SCarola Kruse   ierr  = VecNorm(work1,NORM_2,&beta);CHKERRQ(ierr);                   /* beta = sqrt(nu*c'*c)*/
1341e071a0a4SCarola Kruse   KSPCheckDot(ksp,beta);
1342de482cd7SCarola Kruse   beta  = PetscSqrtScalar(nu)*beta;
134392c1e38eSCarola Kruse   ierr  = VecAXPBY(v,nu/beta,0.0,work1);CHKERRQ(ierr);                   /* v = nu/beta *c      */
1344a51937d4SCarola Kruse   ierr  = MatMult(jac->B,v,work2);CHKERRQ(ierr);                       /* u = H^{-1}*B*v      */
1345a51937d4SCarola Kruse   ierr  = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1346a51937d4SCarola Kruse   ierr  = KSPSolve(ksp,work2,u);CHKERRQ(ierr);
1347c0decd05SBarry Smith   ierr  = KSPCheckSolve(ksp,pc,u);CHKERRQ(ierr);
1348a51937d4SCarola Kruse   ierr  = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1349a51937d4SCarola Kruse   ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);                          /* alpha = u'*H*u      */
1350a51937d4SCarola Kruse   ierr  = VecDot(Hu,u,&alpha);CHKERRQ(ierr);
1351e071a0a4SCarola Kruse   KSPCheckDot(ksp,alpha);
1352e071a0a4SCarola Kruse   if (PetscRealPart(alpha) <= 0.0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_NOT_CONVERGED,"GKB preconditioner diverged, H is not positive definite");
1353de482cd7SCarola Kruse   alpha = PetscSqrtScalar(PetscAbsScalar(alpha));
135492c1e38eSCarola Kruse   ierr  = VecScale(u,1.0/alpha);CHKERRQ(ierr);
135592c1e38eSCarola Kruse   ierr  = VecAXPBY(d,1.0/alpha,0.0,v);CHKERRQ(ierr);                       /* v = nu/beta *c      */
1356de482cd7SCarola Kruse 
1357a51937d4SCarola Kruse   z = beta/alpha;
1358a51937d4SCarola Kruse   vecz[1] = z;
1359a51937d4SCarola Kruse 
1360de482cd7SCarola Kruse   /* Computation of first iterate x(1) and p(1) */
1361a51937d4SCarola Kruse   ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr);
1362a51937d4SCarola Kruse   ierr = VecCopy(d,ilinkD->y);CHKERRQ(ierr);
1363a51937d4SCarola Kruse   ierr = VecScale(ilinkD->y,-z);CHKERRQ(ierr);
1364a51937d4SCarola Kruse 
1365a51937d4SCarola Kruse   iterGKB = 1; lowbnd = 2*jac->gkbtol;
1366de482cd7SCarola Kruse   if (jac->gkbmonitor) {
1367de482cd7SCarola Kruse       ierr = PetscViewerASCIIPrintf(jac->gkbviewer,"%3D GKB Lower bound estimate %14.12e\n",iterGKB,lowbnd);CHKERRQ(ierr);
1368de482cd7SCarola Kruse   }
1369de482cd7SCarola Kruse 
1370a51937d4SCarola Kruse   while (iterGKB < jac->gkbmaxit && lowbnd > jac->gkbtol) {
1371a51937d4SCarola Kruse     iterGKB += 1;
1372e071a0a4SCarola Kruse     ierr  = MatMultHermitianTranspose(jac->B,u,work1);CHKERRQ(ierr); /* v <- nu*(B'*u-alpha/nu*v) */
1373e071a0a4SCarola Kruse     ierr  = VecAXPBY(v,nu,-alpha,work1);CHKERRQ(ierr);
1374e071a0a4SCarola Kruse     ierr  = VecNorm(v,NORM_2,&beta);CHKERRQ(ierr);                   /* beta = sqrt(nu)*v'*v      */
1375de482cd7SCarola Kruse     beta  = beta/PetscSqrtScalar(nu);
137692c1e38eSCarola Kruse     ierr  = VecScale(v,1.0/beta);CHKERRQ(ierr);
1377e071a0a4SCarola Kruse     ierr  = MatMult(jac->B,v,work2);CHKERRQ(ierr);                  /* u <- H^{-1}*(B*v-beta*H*u) */
1378a51937d4SCarola Kruse     ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);
1379a51937d4SCarola Kruse     ierr  = VecAXPY(work2,-beta,Hu);CHKERRQ(ierr);
1380a51937d4SCarola Kruse     ierr  = PetscLogEventBegin(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1381a51937d4SCarola Kruse     ierr  = KSPSolve(ksp,work2,u);CHKERRQ(ierr);
1382c0decd05SBarry Smith     ierr  = KSPCheckSolve(ksp,pc,u);CHKERRQ(ierr);
1383a51937d4SCarola Kruse     ierr  = PetscLogEventEnd(ilinkA->event,ksp,work2,u,NULL);CHKERRQ(ierr);
1384a51937d4SCarola Kruse     ierr  = MatMult(jac->H,u,Hu);CHKERRQ(ierr);                      /* alpha = u'*H*u            */
1385a51937d4SCarola Kruse     ierr  = VecDot(Hu,u,&alpha);CHKERRQ(ierr);
1386e071a0a4SCarola Kruse     KSPCheckDot(ksp,alpha);
1387e071a0a4SCarola Kruse     if (PetscRealPart(alpha) <= 0.0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_NOT_CONVERGED,"GKB preconditioner diverged, H is not positive definite");
1388de482cd7SCarola Kruse     alpha = PetscSqrtScalar(PetscAbsScalar(alpha));
138992c1e38eSCarola Kruse     ierr  = VecScale(u,1.0/alpha);CHKERRQ(ierr);
1390a51937d4SCarola Kruse 
1391e071a0a4SCarola Kruse     z = -beta/alpha*z;                                            /* z <- beta/alpha*z     */
1392a51937d4SCarola Kruse     vecz[0] = z;
1393a51937d4SCarola Kruse 
1394a51937d4SCarola Kruse     /* Computation of new iterate x(i+1) and p(i+1) */
139592c1e38eSCarola Kruse     ierr = VecAXPBY(d,1.0/alpha,-beta/alpha,v);CHKERRQ(ierr);       /* d = (v-beta*d)/alpha */
1396a51937d4SCarola Kruse     ierr = VecAXPY(ilinkA->y,z,u);CHKERRQ(ierr);                  /* r = r + z*u          */
1397a51937d4SCarola Kruse     ierr = VecAXPY(ilinkD->y,-z,d);CHKERRQ(ierr);                 /* p = p - z*d          */
1398de482cd7SCarola Kruse     ierr = MatMult(jac->H,ilinkA->y,Hu);CHKERRQ(ierr);            /* ||u||_H = u'*H*u     */
1399a51937d4SCarola Kruse     ierr = VecDot(Hu,ilinkA->y,&nrmz2);CHKERRQ(ierr);
1400a51937d4SCarola Kruse 
1401a51937d4SCarola Kruse     /* Compute Lower Bound estimate */
1402a51937d4SCarola Kruse     if (iterGKB > jac->gkbdelay) {
1403a51937d4SCarola Kruse       lowbnd = 0.0;
1404a51937d4SCarola Kruse       for (j=0; j<jac->gkbdelay; j++) {
1405a51937d4SCarola Kruse         lowbnd += PetscAbsScalar(vecz[j]*vecz[j]);
1406a51937d4SCarola Kruse       }
1407a51937d4SCarola Kruse       lowbnd = PetscSqrtScalar(lowbnd/PetscAbsScalar(nrmz2));
1408a51937d4SCarola Kruse     }
1409a51937d4SCarola Kruse 
1410a51937d4SCarola Kruse     for (j=0; j<jac->gkbdelay-1; j++) {
1411a51937d4SCarola Kruse       vecz[jac->gkbdelay-j-1] = vecz[jac->gkbdelay-j-2];
1412a51937d4SCarola Kruse     }
1413de482cd7SCarola Kruse     if (jac->gkbmonitor) {
1414de482cd7SCarola Kruse       ierr = PetscViewerASCIIPrintf(jac->gkbviewer,"%3D GKB Lower bound estimate %14.12e\n",iterGKB,lowbnd);CHKERRQ(ierr);
1415de482cd7SCarola Kruse     }
1416a51937d4SCarola Kruse   }
1417a51937d4SCarola Kruse 
1418a51937d4SCarola Kruse   ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1419de482cd7SCarola Kruse   ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1420a29b4eb7SJunchao Zhang   ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1421a51937d4SCarola Kruse   ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1422a51937d4SCarola Kruse 
1423a51937d4SCarola Kruse   PetscFunctionReturn(0);
1424a51937d4SCarola Kruse }
1425a51937d4SCarola Kruse 
1426a51937d4SCarola Kruse 
1427421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1428ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1429ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
14309df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1431421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) ||                  \
1432c0decd05SBarry Smith    KSPCheckSolve(ilink->ksp,pc,ilink->x) || \
1433c0decd05SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) ||   \
1434ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1435ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1436421e10b8SBarry Smith 
1437421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1438421e10b8SBarry Smith {
1439421e10b8SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1440421e10b8SBarry Smith   PetscErrorCode     ierr;
1441421e10b8SBarry Smith   PC_FieldSplitLink  ilink = jac->head;
1442939b8a20SBarry Smith   PetscInt           bs;
1443421e10b8SBarry Smith 
1444421e10b8SBarry Smith   PetscFunctionBegin;
1445421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1446421e10b8SBarry Smith     if (jac->defaultsplit) {
1447939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1448ce94432eSBarry 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);
1449939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1450ce94432eSBarry 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);
1451421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1452421e10b8SBarry Smith       while (ilink) {
14539df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1454421e10b8SBarry Smith         ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1455c0decd05SBarry Smith         ierr = KSPCheckSolve(ilink->ksp,pc,ilink->y);CHKERRQ(ierr);
14569df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1457421e10b8SBarry Smith         ilink = ilink->next;
1458421e10b8SBarry Smith       }
1459421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1460421e10b8SBarry Smith     } else {
1461421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1462421e10b8SBarry Smith       while (ilink) {
1463421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1464421e10b8SBarry Smith         ilink = ilink->next;
1465421e10b8SBarry Smith       }
1466421e10b8SBarry Smith     }
1467421e10b8SBarry Smith   } else {
1468421e10b8SBarry Smith     if (!jac->w1) {
1469421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1470421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1471421e10b8SBarry Smith     }
1472421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1473421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1474421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1475421e10b8SBarry Smith       while (ilink->next) {
1476421e10b8SBarry Smith         ilink = ilink->next;
14779989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1478421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1479421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1480421e10b8SBarry Smith       }
1481421e10b8SBarry Smith       while (ilink->previous) {
1482421e10b8SBarry Smith         ilink = ilink->previous;
14839989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1484421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1485421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1486421e10b8SBarry Smith       }
1487421e10b8SBarry Smith     } else {
1488421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1489421e10b8SBarry Smith         ilink = ilink->next;
1490421e10b8SBarry Smith       }
1491421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1492421e10b8SBarry Smith       while (ilink->previous) {
1493421e10b8SBarry Smith         ilink = ilink->previous;
14949989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1495421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1496421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1497421e10b8SBarry Smith       }
1498421e10b8SBarry Smith     }
1499421e10b8SBarry Smith   }
1500421e10b8SBarry Smith   PetscFunctionReturn(0);
1501421e10b8SBarry Smith }
1502421e10b8SBarry Smith 
1503574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
15040971522cSBarry Smith {
15050971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
15060971522cSBarry Smith   PetscErrorCode    ierr;
15075a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
15080971522cSBarry Smith 
15090971522cSBarry Smith   PetscFunctionBegin;
15105a9f2f41SSatish Balay   while (ilink) {
1511f5f0d762SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1512fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1513fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1514443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1515fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1516fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1517b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1518f5f0d762SBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1519f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
1520f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
15215a9f2f41SSatish Balay     next  = ilink->next;
1522f5f0d762SBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
15235a9f2f41SSatish Balay     ilink = next;
15240971522cSBarry Smith   }
1525f5f0d762SBarry Smith   jac->head = NULL;
152605b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1527574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1528574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1529574deadeSBarry Smith   } else if (jac->mat) {
15300298fd71SBarry Smith     jac->mat = NULL;
1531574deadeSBarry Smith   }
153297bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
153368dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
1534f5f0d762SBarry Smith   jac->nsplits = 0;
15356bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
15366bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
15376bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1538a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
15396bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
15406bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1541d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
15426bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
15436bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
1544a51937d4SCarola Kruse   ierr       = MatDestroy(&jac->H);CHKERRQ(ierr);
1545e071a0a4SCarola Kruse   ierr       = VecDestroy(&jac->u);CHKERRQ(ierr);
1546e071a0a4SCarola Kruse   ierr       = VecDestroy(&jac->v);CHKERRQ(ierr);
1547e071a0a4SCarola Kruse   ierr       = VecDestroy(&jac->Hu);CHKERRQ(ierr);
1548e071a0a4SCarola Kruse   ierr       = VecDestroy(&jac->d);CHKERRQ(ierr);
1549e071a0a4SCarola Kruse   ierr       = PetscFree(jac->vecz);CHKERRQ(ierr);
1550de482cd7SCarola Kruse   ierr       = PetscViewerDestroy(&jac->gkbviewer);CHKERRQ(ierr);
15516dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1552574deadeSBarry Smith   PetscFunctionReturn(0);
1553574deadeSBarry Smith }
1554574deadeSBarry Smith 
1555574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1556574deadeSBarry Smith {
1557574deadeSBarry Smith   PetscErrorCode    ierr;
1558574deadeSBarry Smith 
1559574deadeSBarry Smith   PetscFunctionBegin;
1560574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1561c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1562285fb4e2SStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",NULL);CHKERRQ(ierr);
1563bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1564bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1565bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1566bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1567bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
156829f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
156937a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1570bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
15716dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr);
15720971522cSBarry Smith   PetscFunctionReturn(0);
15730971522cSBarry Smith }
15740971522cSBarry Smith 
15754416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
15760971522cSBarry Smith {
15771b9fc7fcSBarry Smith   PetscErrorCode  ierr;
15786c924f48SJed Brown   PetscInt        bs;
15797b752e3dSPatrick Sanan   PetscBool       flg;
15809dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
15813b224e63SBarry Smith   PCCompositeType ctype;
15821b9fc7fcSBarry Smith 
15830971522cSBarry Smith   PetscFunctionBegin;
1584e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
15854ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
158651f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
158751f519a2SBarry Smith   if (flg) {
158851f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
158951f519a2SBarry Smith   }
15902686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
15912686e3e9SMatthew 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);
15922686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
15932686e3e9SMatthew 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);
15947b752e3dSPatrick 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);
15957b752e3dSPatrick Sanan   ierr = PCFieldSplitSetDetectSaddlePoint(pc,jac->detect);CHKERRQ(ierr); /* Sets split type and Schur PC type */
15963b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
15973b224e63SBarry Smith   if (flg) {
15983b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
15993b224e63SBarry Smith   }
1600c30613efSMatthew Knepley   /* Only setup fields once */
1601c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1602d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1603d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
16046c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
16056c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1606d32f9abdSBarry Smith   }
1607c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1608c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1609c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
16100298fd71SBarry 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);
161129f8a81cSJed 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);
1612c096484dSStefano Zampini     ierr = PetscOptionsScalar("-pc_fieldsplit_schur_scale","Scale Schur complement","PCFieldSplitSetSchurScale",jac->schurscale,&jac->schurscale,NULL);CHKERRQ(ierr);
1613a51937d4SCarola Kruse   } else if (jac->type == PC_COMPOSITE_GKB) {
1614a51937d4SCarola Kruse     ierr = PetscOptionsReal("-pc_fieldsplit_gkb_tol","The tolerance for the lower bound stopping criterion","PCFieldSplitGKBTol",jac->gkbtol,&jac->gkbtol,NULL);CHKERRQ(ierr);
1615a51937d4SCarola Kruse     ierr = PetscOptionsInt("-pc_fieldsplit_gkb_delay","The delay value for lower bound criterion","PCFieldSplitGKBDelay",jac->gkbdelay,&jac->gkbdelay,NULL);CHKERRQ(ierr);
1616a51937d4SCarola Kruse     ierr = PetscOptionsReal("-pc_fieldsplit_gkb_nu","Parameter in augmented Lagrangian approach","PCFieldSplitGKBNu",jac->gkbnu,&jac->gkbnu,NULL);CHKERRQ(ierr);
1617e071a0a4SCarola Kruse     if (jac->gkbnu < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nu cannot be less than 0: value %f",jac->gkbnu);
1618a51937d4SCarola Kruse     ierr = PetscOptionsInt("-pc_fieldsplit_gkb_maxit","Maximum allowed number of iterations","PCFieldSplitGKBMaxit",jac->gkbmaxit,&jac->gkbmaxit,NULL);CHKERRQ(ierr);
1619de482cd7SCarola Kruse     ierr = PetscOptionsBool("-pc_fieldsplit_gkb_monitor","Prints number of GKB iterations and error","PCFieldSplitGKB",jac->gkbmonitor,&jac->gkbmonitor,NULL);CHKERRQ(ierr);
1620c5d2311dSJed Brown   }
16211b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
16220971522cSBarry Smith   PetscFunctionReturn(0);
16230971522cSBarry Smith }
16240971522cSBarry Smith 
16250971522cSBarry Smith /*------------------------------------------------------------------------------------*/
16260971522cSBarry Smith 
16271e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
16280971522cSBarry Smith {
162997bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
16300971522cSBarry Smith   PetscErrorCode    ierr;
16315a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
163269a612a9SBarry Smith   char              prefix[128];
16335d4c12cdSJungho Lee   PetscInt          i;
16340971522cSBarry Smith 
16350971522cSBarry Smith   PetscFunctionBegin;
16366c924f48SJed Brown   if (jac->splitdefined) {
16376c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
16386c924f48SJed Brown     PetscFunctionReturn(0);
16396c924f48SJed Brown   }
164051f519a2SBarry Smith   for (i=0; i<n; i++) {
1641e32f2f54SBarry 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);
1642e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
164351f519a2SBarry Smith   }
1644b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1645a04f6461SBarry Smith   if (splitname) {
1646db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1647a04f6461SBarry Smith   } else {
1648785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1649a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1650a04f6461SBarry Smith   }
16519df09d43SBarry 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 */
1652785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
1653580bdb30SBarry Smith   ierr = PetscArraycpy(ilink->fields,fields,n);CHKERRQ(ierr);
1654785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
1655580bdb30SBarry Smith   ierr = PetscArraycpy(ilink->fields_col,fields_col,n);CHKERRQ(ierr);
16562fa5cd67SKarl Rupp 
16575a9f2f41SSatish Balay   ilink->nfields = n;
16580298fd71SBarry Smith   ilink->next    = NULL;
1659ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1660422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
166120252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
16625a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
16639005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
166469a612a9SBarry Smith 
16658caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
16665a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
16670971522cSBarry Smith 
16680971522cSBarry Smith   if (!next) {
16695a9f2f41SSatish Balay     jac->head       = ilink;
16700298fd71SBarry Smith     ilink->previous = NULL;
16710971522cSBarry Smith   } else {
16720971522cSBarry Smith     while (next->next) {
16730971522cSBarry Smith       next = next->next;
16740971522cSBarry Smith     }
16755a9f2f41SSatish Balay     next->next      = ilink;
167651f519a2SBarry Smith     ilink->previous = next;
16770971522cSBarry Smith   }
16780971522cSBarry Smith   jac->nsplits++;
16790971522cSBarry Smith   PetscFunctionReturn(0);
16800971522cSBarry Smith }
16810971522cSBarry Smith 
1682285fb4e2SStefano Zampini static PetscErrorCode  PCFieldSplitSchurGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
1683285fb4e2SStefano Zampini {
1684285fb4e2SStefano Zampini   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1685285fb4e2SStefano Zampini   PetscErrorCode ierr;
1686285fb4e2SStefano Zampini 
1687285fb4e2SStefano Zampini   PetscFunctionBegin;
1688285fb4e2SStefano Zampini   *subksp = NULL;
1689285fb4e2SStefano Zampini   if (n) *n = 0;
1690285fb4e2SStefano Zampini   if (jac->type == PC_COMPOSITE_SCHUR) {
1691285fb4e2SStefano Zampini     PetscInt nn;
1692285fb4e2SStefano Zampini 
1693285fb4e2SStefano Zampini     if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitSchurGetSubKSP()");
1694285fb4e2SStefano Zampini     if (jac->nsplits != 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unexpected number of splits %D != 2",jac->nsplits);
1695285fb4e2SStefano Zampini     nn   = jac->nsplits + (jac->kspupper != jac->head->ksp ? 1 : 0);
1696285fb4e2SStefano Zampini     ierr = PetscMalloc1(nn,subksp);CHKERRQ(ierr);
1697285fb4e2SStefano Zampini     (*subksp)[0] = jac->head->ksp;
1698285fb4e2SStefano Zampini     (*subksp)[1] = jac->kspschur;
1699285fb4e2SStefano Zampini     if (jac->kspupper != jac->head->ksp) (*subksp)[2] = jac->kspupper;
1700285fb4e2SStefano Zampini     if (n) *n = nn;
1701285fb4e2SStefano Zampini   }
1702285fb4e2SStefano Zampini   PetscFunctionReturn(0);
1703285fb4e2SStefano Zampini }
1704285fb4e2SStefano Zampini 
17051e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1706e69d4d44SBarry Smith {
1707e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1708e69d4d44SBarry Smith   PetscErrorCode ierr;
1709e69d4d44SBarry Smith 
1710e69d4d44SBarry Smith   PetscFunctionBegin;
171134a3b412SBarry Smith   if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
1712785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1713e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
17142fa5cd67SKarl Rupp 
1715e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
171613e0d083SBarry Smith   if (n) *n = jac->nsplits;
1717e69d4d44SBarry Smith   PetscFunctionReturn(0);
1718e69d4d44SBarry Smith }
17190971522cSBarry Smith 
17201e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
17210971522cSBarry Smith {
17220971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
17230971522cSBarry Smith   PetscErrorCode    ierr;
17240971522cSBarry Smith   PetscInt          cnt   = 0;
17255a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
17260971522cSBarry Smith 
17270971522cSBarry Smith   PetscFunctionBegin;
1728785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
17295a9f2f41SSatish Balay   while (ilink) {
17305a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
17315a9f2f41SSatish Balay     ilink            = ilink->next;
17320971522cSBarry Smith   }
17335d480477SMatthew 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);
173413e0d083SBarry Smith   if (n) *n = jac->nsplits;
17350971522cSBarry Smith   PetscFunctionReturn(0);
17360971522cSBarry Smith }
17370971522cSBarry Smith 
17386dbb499eSCian Wilson /*@C
17396dbb499eSCian Wilson     PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS.
17406dbb499eSCian Wilson 
17416dbb499eSCian Wilson     Input Parameters:
17426dbb499eSCian Wilson +   pc  - the preconditioner context
1743a2b725a8SWilliam Gropp -   is - the index set that defines the indices to which the fieldsplit is to be restricted
17446dbb499eSCian Wilson 
17456dbb499eSCian Wilson     Level: advanced
17466dbb499eSCian Wilson 
17476dbb499eSCian Wilson @*/
17486dbb499eSCian Wilson PetscErrorCode  PCFieldSplitRestrictIS(PC pc,IS isy)
17496dbb499eSCian Wilson {
17506dbb499eSCian Wilson   PetscErrorCode ierr;
17516dbb499eSCian Wilson 
17526dbb499eSCian Wilson   PetscFunctionBegin;
17536dbb499eSCian Wilson   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
17546dbb499eSCian Wilson   PetscValidHeaderSpecific(isy,IS_CLASSID,2);
17550246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr);
17566dbb499eSCian Wilson   PetscFunctionReturn(0);
17576dbb499eSCian Wilson }
17586dbb499eSCian Wilson 
17596dbb499eSCian Wilson 
17606dbb499eSCian Wilson static PetscErrorCode  PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
17616dbb499eSCian Wilson {
17626dbb499eSCian Wilson   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
17636dbb499eSCian Wilson   PetscErrorCode    ierr;
17646dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
17656dbb499eSCian Wilson   PetscInt          localsize,size,sizez,i;
17666dbb499eSCian Wilson   const PetscInt    *ind, *indz;
17676dbb499eSCian Wilson   PetscInt          *indc, *indcz;
17686dbb499eSCian Wilson   PetscBool         flg;
17696dbb499eSCian Wilson 
17706dbb499eSCian Wilson   PetscFunctionBegin;
17716dbb499eSCian Wilson   ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr);
17726dbb499eSCian Wilson   ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr);
17736dbb499eSCian Wilson   size -= localsize;
17746dbb499eSCian Wilson   while(ilink) {
17756dbb499eSCian Wilson     IS isrl,isr;
17761c7cfba8SBarry Smith     PC subpc;
17776dbb499eSCian Wilson     ierr          = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
17786dbb499eSCian Wilson     ierr          = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr);
17796dbb499eSCian Wilson     ierr          = PetscMalloc1(localsize,&indc);CHKERRQ(ierr);
17806dbb499eSCian Wilson     ierr          = ISGetIndices(isrl,&ind);CHKERRQ(ierr);
1781580bdb30SBarry Smith     ierr          = PetscArraycpy(indc,ind,localsize);CHKERRQ(ierr);
17826dbb499eSCian Wilson     ierr          = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr);
17836dbb499eSCian Wilson     ierr          = ISDestroy(&isrl);CHKERRQ(ierr);
17846dbb499eSCian Wilson     for (i=0; i<localsize; i++) *(indc+i) += size;
17856dbb499eSCian Wilson     ierr          = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr);
17866dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
17876dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
17886dbb499eSCian Wilson     ilink->is     = isr;
17896dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
17906dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
17916dbb499eSCian Wilson     ilink->is_col = isr;
17926dbb499eSCian Wilson     ierr          = ISDestroy(&isr);CHKERRQ(ierr);
17936dbb499eSCian Wilson     ierr          = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr);
17946dbb499eSCian Wilson     ierr          = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr);
17956dbb499eSCian Wilson     if(flg) {
17966dbb499eSCian Wilson       IS iszl,isz;
17976dbb499eSCian Wilson       MPI_Comm comm;
17986dbb499eSCian Wilson       ierr   = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr);
17996dbb499eSCian Wilson       comm   = PetscObjectComm((PetscObject)ilink->is);
18006dbb499eSCian Wilson       ierr   = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr);
18016dbb499eSCian Wilson       ierr   = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr);
18026dbb499eSCian Wilson       sizez -= localsize;
18036dbb499eSCian Wilson       ierr   = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr);
18046dbb499eSCian Wilson       ierr   = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr);
18056dbb499eSCian Wilson       ierr   = ISGetIndices(iszl,&indz);CHKERRQ(ierr);
1806580bdb30SBarry Smith       ierr   = PetscArraycpy(indcz,indz,localsize);CHKERRQ(ierr);
18076dbb499eSCian Wilson       ierr   = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr);
18086dbb499eSCian Wilson       ierr   = ISDestroy(&iszl);CHKERRQ(ierr);
18096dbb499eSCian Wilson       for (i=0; i<localsize; i++) *(indcz+i) += sizez;
18106dbb499eSCian Wilson       ierr   = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr);
18116dbb499eSCian Wilson       ierr   = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr);
18126dbb499eSCian Wilson       ierr   = ISDestroy(&isz);CHKERRQ(ierr);
18136dbb499eSCian Wilson     }
18146dbb499eSCian Wilson     next = ilink->next;
18156dbb499eSCian Wilson     ilink = next;
18166dbb499eSCian Wilson   }
18176dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
18186dbb499eSCian Wilson   PetscFunctionReturn(0);
18196dbb499eSCian Wilson }
18206dbb499eSCian Wilson 
18211e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1822704ba839SBarry Smith {
1823704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1824704ba839SBarry Smith   PetscErrorCode    ierr;
1825704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1826704ba839SBarry Smith   char              prefix[128];
1827704ba839SBarry Smith 
1828704ba839SBarry Smith   PetscFunctionBegin;
18296c924f48SJed Brown   if (jac->splitdefined) {
18306c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
18316c924f48SJed Brown     PetscFunctionReturn(0);
18326c924f48SJed Brown   }
1833b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1834a04f6461SBarry Smith   if (splitname) {
1835db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1836a04f6461SBarry Smith   } else {
1837785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1838b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1839a04f6461SBarry Smith   }
18409df09d43SBarry 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 */
18411ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1842b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1843b5787286SJed Brown   ilink->is     = is;
1844b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1845b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1846b5787286SJed Brown   ilink->is_col = is;
18470298fd71SBarry Smith   ilink->next   = NULL;
1848ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1849422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
185020252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1851704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
18529005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1853704ba839SBarry Smith 
18548caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1855704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1856704ba839SBarry Smith 
1857704ba839SBarry Smith   if (!next) {
1858704ba839SBarry Smith     jac->head       = ilink;
18590298fd71SBarry Smith     ilink->previous = NULL;
1860704ba839SBarry Smith   } else {
1861704ba839SBarry Smith     while (next->next) {
1862704ba839SBarry Smith       next = next->next;
1863704ba839SBarry Smith     }
1864704ba839SBarry Smith     next->next      = ilink;
1865704ba839SBarry Smith     ilink->previous = next;
1866704ba839SBarry Smith   }
1867704ba839SBarry Smith   jac->nsplits++;
1868704ba839SBarry Smith   PetscFunctionReturn(0);
1869704ba839SBarry Smith }
1870704ba839SBarry Smith 
187194ef8ddeSSatish Balay /*@C
18720971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
18730971522cSBarry Smith 
1874ad4df100SBarry Smith     Logically Collective on PC
18750971522cSBarry Smith 
18760971522cSBarry Smith     Input Parameters:
18770971522cSBarry Smith +   pc  - the preconditioner context
18780298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
18790971522cSBarry Smith .   n - the number of fields in this split
1880db4c96c1SJed Brown -   fields - the fields in this split
18810971522cSBarry Smith 
18820971522cSBarry Smith     Level: intermediate
18830971522cSBarry Smith 
188495452b02SPatrick Sanan     Notes:
188595452b02SPatrick Sanan     Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1886d32f9abdSBarry Smith 
18877287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1888d32f9abdSBarry 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
1889d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1890d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1891d32f9abdSBarry Smith 
1892db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1893db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1894db4c96c1SJed Brown 
18955d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
18965d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
18975d4c12cdSJungho Lee      available when this routine is called.
18985d4c12cdSJungho Lee 
1899d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
19000971522cSBarry Smith 
19010971522cSBarry Smith @*/
19025d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
19030971522cSBarry Smith {
19044ac538c5SBarry Smith   PetscErrorCode ierr;
19050971522cSBarry Smith 
19060971522cSBarry Smith   PetscFunctionBegin;
19070700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1908db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1909ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1910db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
19110246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
19120971522cSBarry Smith   PetscFunctionReturn(0);
19130971522cSBarry Smith }
19140971522cSBarry Smith 
1915c84da90fSDmitry Karpeev /*@
1916c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1917c84da90fSDmitry Karpeev 
1918c84da90fSDmitry Karpeev     Logically Collective on PC
1919c84da90fSDmitry Karpeev 
1920c84da90fSDmitry Karpeev     Input Parameters:
1921c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1922c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1923c84da90fSDmitry Karpeev 
19249506b623SDmitry Karpeev     Options Database:
19259506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1926c84da90fSDmitry Karpeev 
1927c84da90fSDmitry Karpeev     Level: intermediate
1928c84da90fSDmitry Karpeev 
1929c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1930c84da90fSDmitry Karpeev 
1931c84da90fSDmitry Karpeev @*/
1932c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1933c84da90fSDmitry Karpeev {
1934c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1935c84da90fSDmitry Karpeev   PetscBool      isfs;
1936c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1937c84da90fSDmitry Karpeev 
1938c84da90fSDmitry Karpeev   PetscFunctionBegin;
1939c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1940c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1941c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1942c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1943c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1944c84da90fSDmitry Karpeev }
1945c84da90fSDmitry Karpeev 
1946c84da90fSDmitry Karpeev /*@
1947c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1948c84da90fSDmitry Karpeev 
1949c84da90fSDmitry Karpeev     Logically Collective on PC
1950c84da90fSDmitry Karpeev 
1951c84da90fSDmitry Karpeev     Input Parameters:
1952c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1953c84da90fSDmitry Karpeev 
1954c84da90fSDmitry Karpeev     Output Parameters:
1955c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1956c84da90fSDmitry Karpeev 
1957c84da90fSDmitry Karpeev 
1958c84da90fSDmitry Karpeev     Level: intermediate
1959c84da90fSDmitry Karpeev 
1960c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1961c84da90fSDmitry Karpeev 
1962c84da90fSDmitry Karpeev @*/
1963c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1964c84da90fSDmitry Karpeev {
1965c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1966c84da90fSDmitry Karpeev   PetscBool      isfs;
1967c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1968c84da90fSDmitry Karpeev 
1969c84da90fSDmitry Karpeev   PetscFunctionBegin;
1970c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1971*534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
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   *flg = jac->diag_use_amat;
1975c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1976c84da90fSDmitry Karpeev }
1977c84da90fSDmitry Karpeev 
1978c84da90fSDmitry Karpeev /*@
1979c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-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 -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1986c84da90fSDmitry Karpeev 
19879506b623SDmitry Karpeev     Options Database:
19889506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
1989c84da90fSDmitry Karpeev 
1990c84da90fSDmitry Karpeev     Level: intermediate
1991c84da90fSDmitry Karpeev 
1992c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
1993c84da90fSDmitry Karpeev 
1994c84da90fSDmitry Karpeev @*/
1995c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(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);
2003c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2004c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
2005c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
2006c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2007c84da90fSDmitry Karpeev }
2008c84da90fSDmitry Karpeev 
2009c84da90fSDmitry Karpeev /*@
2010c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
2011c84da90fSDmitry Karpeev 
2012c84da90fSDmitry Karpeev     Logically Collective on PC
2013c84da90fSDmitry Karpeev 
2014c84da90fSDmitry Karpeev     Input Parameters:
2015c84da90fSDmitry Karpeev .   pc  - the preconditioner object
2016c84da90fSDmitry Karpeev 
2017c84da90fSDmitry Karpeev     Output Parameters:
2018c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
2019c84da90fSDmitry Karpeev 
2020c84da90fSDmitry Karpeev 
2021c84da90fSDmitry Karpeev     Level: intermediate
2022c84da90fSDmitry Karpeev 
2023c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
2024c84da90fSDmitry Karpeev 
2025c84da90fSDmitry Karpeev @*/
2026c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
2027c84da90fSDmitry Karpeev {
2028c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2029c84da90fSDmitry Karpeev   PetscBool      isfs;
2030c84da90fSDmitry Karpeev   PetscErrorCode ierr;
2031c84da90fSDmitry Karpeev 
2032c84da90fSDmitry Karpeev   PetscFunctionBegin;
2033c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2034*534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
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   *flg = jac->offdiag_use_amat;
2038c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
2039c84da90fSDmitry Karpeev }
2040c84da90fSDmitry Karpeev 
2041c84da90fSDmitry Karpeev 
2042c84da90fSDmitry Karpeev 
2043218d4943SBarry Smith /*@C
2044704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
2045704ba839SBarry Smith 
2046ad4df100SBarry Smith     Logically Collective on PC
2047704ba839SBarry Smith 
2048704ba839SBarry Smith     Input Parameters:
2049704ba839SBarry Smith +   pc  - the preconditioner context
20500298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
2051db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
2052704ba839SBarry Smith 
2053d32f9abdSBarry Smith 
2054a6ffb8dbSJed Brown     Notes:
2055a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
2056a6ffb8dbSJed Brown 
2057db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
2058db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
2059d32f9abdSBarry Smith 
2060704ba839SBarry Smith     Level: intermediate
2061704ba839SBarry Smith 
2062704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
2063704ba839SBarry Smith 
2064704ba839SBarry Smith @*/
20657087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
2066704ba839SBarry Smith {
20674ac538c5SBarry Smith   PetscErrorCode ierr;
2068704ba839SBarry Smith 
2069704ba839SBarry Smith   PetscFunctionBegin;
20700700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
20717b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
2072db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
2073ccc738f7SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
2074704ba839SBarry Smith   PetscFunctionReturn(0);
2075704ba839SBarry Smith }
2076704ba839SBarry Smith 
207794ef8ddeSSatish Balay /*@C
207857a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
207957a9adfeSMatthew G Knepley 
208057a9adfeSMatthew G Knepley     Logically Collective on PC
208157a9adfeSMatthew G Knepley 
208257a9adfeSMatthew G Knepley     Input Parameters:
208357a9adfeSMatthew G Knepley +   pc  - the preconditioner context
208457a9adfeSMatthew G Knepley -   splitname - name of this split
208557a9adfeSMatthew G Knepley 
208657a9adfeSMatthew G Knepley     Output Parameter:
20870298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
208857a9adfeSMatthew G Knepley 
208957a9adfeSMatthew G Knepley     Level: intermediate
209057a9adfeSMatthew G Knepley 
209157a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
209257a9adfeSMatthew G Knepley 
209357a9adfeSMatthew G Knepley @*/
209457a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
209557a9adfeSMatthew G Knepley {
209657a9adfeSMatthew G Knepley   PetscErrorCode ierr;
209757a9adfeSMatthew G Knepley 
209857a9adfeSMatthew G Knepley   PetscFunctionBegin;
209957a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
210057a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
210157a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
210257a9adfeSMatthew G Knepley   {
210357a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
210457a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
210557a9adfeSMatthew G Knepley     PetscBool         found;
210657a9adfeSMatthew G Knepley 
21070298fd71SBarry Smith     *is = NULL;
210857a9adfeSMatthew G Knepley     while (ilink) {
210957a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
211057a9adfeSMatthew G Knepley       if (found) {
211157a9adfeSMatthew G Knepley         *is = ilink->is;
211257a9adfeSMatthew G Knepley         break;
211357a9adfeSMatthew G Knepley       }
211457a9adfeSMatthew G Knepley       ilink = ilink->next;
211557a9adfeSMatthew G Knepley     }
211657a9adfeSMatthew G Knepley   }
211757a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
211857a9adfeSMatthew G Knepley }
211957a9adfeSMatthew G Knepley 
2120998f007dSPierre Jolivet /*@C
2121998f007dSPierre Jolivet     PCFieldSplitGetISByIndex - Retrieves the elements for a given index field as an IS
2122998f007dSPierre Jolivet 
2123998f007dSPierre Jolivet     Logically Collective on PC
2124998f007dSPierre Jolivet 
2125998f007dSPierre Jolivet     Input Parameters:
2126998f007dSPierre Jolivet +   pc  - the preconditioner context
2127998f007dSPierre Jolivet -   index - index of this split
2128998f007dSPierre Jolivet 
2129998f007dSPierre Jolivet     Output Parameter:
2130998f007dSPierre Jolivet -   is - the index set that defines the vector elements in this field
2131998f007dSPierre Jolivet 
2132998f007dSPierre Jolivet     Level: intermediate
2133998f007dSPierre Jolivet 
2134998f007dSPierre Jolivet .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitGetIS(), PCFieldSplitSetIS()
2135998f007dSPierre Jolivet 
2136998f007dSPierre Jolivet @*/
2137998f007dSPierre Jolivet PetscErrorCode PCFieldSplitGetISByIndex(PC pc,PetscInt index,IS *is)
2138998f007dSPierre Jolivet {
2139998f007dSPierre Jolivet   PetscErrorCode ierr;
2140998f007dSPierre Jolivet 
2141998f007dSPierre Jolivet   PetscFunctionBegin;
2142998f007dSPierre Jolivet   if (index < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",index);
2143998f007dSPierre Jolivet   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2144998f007dSPierre Jolivet   PetscValidPointer(is,3);
2145998f007dSPierre Jolivet   {
2146998f007dSPierre Jolivet     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
2147998f007dSPierre Jolivet     PC_FieldSplitLink ilink = jac->head;
2148998f007dSPierre Jolivet     PetscInt          i     = 0;
2149998f007dSPierre Jolivet     if (index >= jac->nsplits) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Field %D requested but only %D exist",index,jac->nsplits);
2150998f007dSPierre Jolivet 
2151998f007dSPierre Jolivet     while (i < index) {
2152998f007dSPierre Jolivet       ilink = ilink->next;
2153998f007dSPierre Jolivet       ++i;
2154998f007dSPierre Jolivet     }
2155998f007dSPierre Jolivet     ierr = PCFieldSplitGetIS(pc,ilink->splitname,is);CHKERRQ(ierr);
2156998f007dSPierre Jolivet   }
2157998f007dSPierre Jolivet   PetscFunctionReturn(0);
2158998f007dSPierre Jolivet }
2159998f007dSPierre Jolivet 
216051f519a2SBarry Smith /*@
216151f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
216251f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
216351f519a2SBarry Smith 
2164ad4df100SBarry Smith     Logically Collective on PC
216551f519a2SBarry Smith 
216651f519a2SBarry Smith     Input Parameters:
216751f519a2SBarry Smith +   pc  - the preconditioner context
216851f519a2SBarry Smith -   bs - the block size
216951f519a2SBarry Smith 
217051f519a2SBarry Smith     Level: intermediate
217151f519a2SBarry Smith 
217251f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
217351f519a2SBarry Smith 
217451f519a2SBarry Smith @*/
21757087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
217651f519a2SBarry Smith {
21774ac538c5SBarry Smith   PetscErrorCode ierr;
217851f519a2SBarry Smith 
217951f519a2SBarry Smith   PetscFunctionBegin;
21800700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2181c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
21824ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
218351f519a2SBarry Smith   PetscFunctionReturn(0);
218451f519a2SBarry Smith }
218551f519a2SBarry Smith 
21860971522cSBarry Smith /*@C
218769a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
21880971522cSBarry Smith 
218969a612a9SBarry Smith    Collective on KSP
21900971522cSBarry Smith 
21910971522cSBarry Smith    Input Parameter:
21920971522cSBarry Smith .  pc - the preconditioner context
21930971522cSBarry Smith 
21940971522cSBarry Smith    Output Parameters:
219513e0d083SBarry Smith +  n - the number of splits
21963111de3cSBarry Smith -  subksp - the array of KSP contexts
21970971522cSBarry Smith 
21980971522cSBarry Smith    Note:
21999a4f7e47SBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
2200d32f9abdSBarry Smith    (not the KSP just the array that contains them).
22010971522cSBarry Smith 
2202285fb4e2SStefano Zampini    You must call PCSetUp() before calling PCFieldSplitGetSubKSP().
2203285fb4e2SStefano Zampini 
2204285fb4e2SStefano Zampini    If the fieldsplit is of type PC_COMPOSITE_SCHUR, it returns the KSP object used inside the
2205285fb4e2SStefano Zampini    Schur complement and the KSP object used to iterate over the Schur complement.
2206a51937d4SCarola Kruse    To access all the KSP objects used in PC_COMPOSITE_SCHUR, use PCFieldSplitSchurGetSubKSP().
2207a51937d4SCarola Kruse 
2208a51937d4SCarola Kruse    If the fieldsplit is of type PC_COMPOSITE_GKB, it returns the KSP object used to solve the
2209a51937d4SCarola Kruse    inner linear system defined by the matrix H in each loop.
22100971522cSBarry Smith 
2211196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
22122bf68e3eSBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
2213196cc216SBarry Smith       KSP array must be.
2214196cc216SBarry Smith 
2215196cc216SBarry Smith 
22160971522cSBarry Smith    Level: advanced
22170971522cSBarry Smith 
22180971522cSBarry Smith .seealso: PCFIELDSPLIT
22190971522cSBarry Smith @*/
22207087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
22210971522cSBarry Smith {
22224ac538c5SBarry Smith   PetscErrorCode ierr;
22230971522cSBarry Smith 
22240971522cSBarry Smith   PetscFunctionBegin;
22250700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
222613e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
22274ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
22280971522cSBarry Smith   PetscFunctionReturn(0);
22290971522cSBarry Smith }
22300971522cSBarry Smith 
2231285fb4e2SStefano Zampini /*@C
2232285fb4e2SStefano Zampini    PCFieldSplitSchurGetSubKSP - Gets the KSP contexts used inside the Schur complement based PCFIELDSPLIT
2233285fb4e2SStefano Zampini 
2234285fb4e2SStefano Zampini    Collective on KSP
2235285fb4e2SStefano Zampini 
2236285fb4e2SStefano Zampini    Input Parameter:
2237285fb4e2SStefano Zampini .  pc - the preconditioner context
2238285fb4e2SStefano Zampini 
2239285fb4e2SStefano Zampini    Output Parameters:
2240285fb4e2SStefano Zampini +  n - the number of splits
2241285fb4e2SStefano Zampini -  subksp - the array of KSP contexts
2242285fb4e2SStefano Zampini 
2243285fb4e2SStefano Zampini    Note:
2244285fb4e2SStefano Zampini    After PCFieldSplitSchurGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
2245285fb4e2SStefano Zampini    (not the KSP just the array that contains them).
2246285fb4e2SStefano Zampini 
2247285fb4e2SStefano Zampini    You must call PCSetUp() before calling PCFieldSplitSchurGetSubKSP().
2248285fb4e2SStefano Zampini 
2249285fb4e2SStefano Zampini    If the fieldsplit type is of type PC_COMPOSITE_SCHUR, it returns (in order)
2250285fb4e2SStefano Zampini    - the KSP used for the (1,1) block
2251285fb4e2SStefano Zampini    - the KSP used for the Schur complement (not the one used for the interior Schur solver)
2252285fb4e2SStefano Zampini    - the KSP used for the (1,1) block in the upper triangular factor (if different from that of the (1,1) block).
2253285fb4e2SStefano Zampini 
2254285fb4e2SStefano Zampini    It returns a null array if the fieldsplit is not of type PC_COMPOSITE_SCHUR; in this case, you should use PCFieldSplitGetSubKSP().
2255285fb4e2SStefano Zampini 
2256285fb4e2SStefano Zampini    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
2257285fb4e2SStefano Zampini       You can call PCFieldSplitSchurGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
2258285fb4e2SStefano Zampini       KSP array must be.
2259285fb4e2SStefano Zampini 
2260285fb4e2SStefano Zampini    Level: advanced
2261285fb4e2SStefano Zampini 
2262285fb4e2SStefano Zampini .seealso: PCFIELDSPLIT
2263285fb4e2SStefano Zampini @*/
2264285fb4e2SStefano Zampini PetscErrorCode  PCFieldSplitSchurGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
2265285fb4e2SStefano Zampini {
2266285fb4e2SStefano Zampini   PetscErrorCode ierr;
2267285fb4e2SStefano Zampini 
2268285fb4e2SStefano Zampini   PetscFunctionBegin;
2269285fb4e2SStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2270285fb4e2SStefano Zampini   if (n) PetscValidIntPointer(n,2);
2271285fb4e2SStefano Zampini   ierr = PetscUseMethod(pc,"PCFieldSplitSchurGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
2272285fb4e2SStefano Zampini   PetscFunctionReturn(0);
2273285fb4e2SStefano Zampini }
2274285fb4e2SStefano Zampini 
2275e69d4d44SBarry Smith /*@
227653f2277eSBarry Smith     PCFieldSplitSetSchurPre -  Indicates what operator is used to construct the preconditioner for the Schur complement.
2277a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
2278e69d4d44SBarry Smith 
2279e69d4d44SBarry Smith     Collective on PC
2280e69d4d44SBarry Smith 
2281e69d4d44SBarry Smith     Input Parameters:
2282e69d4d44SBarry Smith +   pc      - the preconditioner context
22836fdd48a9SBarry 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
22846fdd48a9SBarry Smith               PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL
22850298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
2286084e4875SJed Brown 
2287e69d4d44SBarry Smith     Options Database:
22886fdd48a9SBarry Smith .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments
2289e69d4d44SBarry Smith 
2290fd1303e9SJungho Lee     Notes:
2291fd1303e9SJungho Lee $    If ptype is
2292a6a584a2SBarry Smith $        a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
229353f2277eSBarry Smith $             matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
2294a6a584a2SBarry Smith $        self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
2295a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
2296fd1303e9SJungho Lee $             preconditioner
22976fdd48a9SBarry Smith $        user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
22986fdd48a9SBarry Smith $             to this function).
2299a6a584a2SBarry Smith $        selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
23001d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
23016fdd48a9SBarry Smith $             lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump
230294350679SMatthew Knepley $        full then the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation computed internally by PCFIELDSPLIT (this is expensive)
23036fdd48a9SBarry Smith $             useful mostly as a test that the Schur complement approach can work for your problem
2304fd1303e9SJungho Lee 
2305e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
2306fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
2307a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
2308fd1303e9SJungho Lee 
2309e69d4d44SBarry Smith     Level: intermediate
2310e69d4d44SBarry Smith 
23111d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
23121d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
2313e69d4d44SBarry Smith 
2314e69d4d44SBarry Smith @*/
231529f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
2316e69d4d44SBarry Smith {
23174ac538c5SBarry Smith   PetscErrorCode ierr;
2318e69d4d44SBarry Smith 
2319e69d4d44SBarry Smith   PetscFunctionBegin;
23200700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
232129f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
2322e69d4d44SBarry Smith   PetscFunctionReturn(0);
2323e69d4d44SBarry Smith }
2324686bed4dSStefano Zampini 
232529f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
2326e69d4d44SBarry Smith 
232737a82bf0SJed Brown /*@
232837a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
232929f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
233037a82bf0SJed Brown 
233137a82bf0SJed Brown     Logically Collective on PC
233237a82bf0SJed Brown 
233337a82bf0SJed Brown     Input Parameters:
233437a82bf0SJed Brown .   pc      - the preconditioner context
233537a82bf0SJed Brown 
233637a82bf0SJed Brown     Output Parameters:
233737a82bf0SJed 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
233837a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
233937a82bf0SJed Brown 
234037a82bf0SJed Brown     Level: intermediate
234137a82bf0SJed Brown 
234229f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
234337a82bf0SJed Brown 
234437a82bf0SJed Brown @*/
234537a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
234637a82bf0SJed Brown {
234737a82bf0SJed Brown   PetscErrorCode ierr;
234837a82bf0SJed Brown 
234937a82bf0SJed Brown   PetscFunctionBegin;
235037a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
235137a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
2352e69d4d44SBarry Smith   PetscFunctionReturn(0);
2353e69d4d44SBarry Smith }
2354e69d4d44SBarry Smith 
235545e7fc46SDmitry Karpeev /*@
2356470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
235745e7fc46SDmitry Karpeev 
235845e7fc46SDmitry Karpeev     Not collective
235945e7fc46SDmitry Karpeev 
236045e7fc46SDmitry Karpeev     Input Parameter:
236145e7fc46SDmitry Karpeev .   pc      - the preconditioner context
236245e7fc46SDmitry Karpeev 
236345e7fc46SDmitry Karpeev     Output Parameter:
2364470b340bSDmitry Karpeev .   S       - the Schur complement matrix
236545e7fc46SDmitry Karpeev 
2366470b340bSDmitry Karpeev     Notes:
2367470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
236845e7fc46SDmitry Karpeev 
236945e7fc46SDmitry Karpeev     Level: advanced
237045e7fc46SDmitry Karpeev 
237129f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
237245e7fc46SDmitry Karpeev 
237345e7fc46SDmitry Karpeev @*/
2374470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
237545e7fc46SDmitry Karpeev {
237645e7fc46SDmitry Karpeev   PetscErrorCode ierr;
237745e7fc46SDmitry Karpeev   const char*    t;
237845e7fc46SDmitry Karpeev   PetscBool      isfs;
237945e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
238045e7fc46SDmitry Karpeev 
238145e7fc46SDmitry Karpeev   PetscFunctionBegin;
238245e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
238345e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
238445e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
238545e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
238645e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2387470b340bSDmitry 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);
2388470b340bSDmitry Karpeev   if (S) *S = jac->schur;
238945e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
239045e7fc46SDmitry Karpeev }
239145e7fc46SDmitry Karpeev 
2392470b340bSDmitry Karpeev /*@
2393470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
2394470b340bSDmitry Karpeev 
2395470b340bSDmitry Karpeev     Not collective
2396470b340bSDmitry Karpeev 
2397470b340bSDmitry Karpeev     Input Parameters:
2398470b340bSDmitry Karpeev +   pc      - the preconditioner context
2399a2b725a8SWilliam Gropp -   S       - the Schur complement matrix
2400470b340bSDmitry Karpeev 
2401470b340bSDmitry Karpeev     Level: advanced
2402470b340bSDmitry Karpeev 
240329f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
2404470b340bSDmitry Karpeev 
2405470b340bSDmitry Karpeev @*/
2406bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
2407470b340bSDmitry Karpeev {
2408470b340bSDmitry Karpeev   PetscErrorCode ierr;
2409470b340bSDmitry Karpeev   const char*    t;
2410470b340bSDmitry Karpeev   PetscBool      isfs;
2411470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
2412470b340bSDmitry Karpeev 
2413470b340bSDmitry Karpeev   PetscFunctionBegin;
2414470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2415470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
2416470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
2417470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
2418470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
2419470b340bSDmitry 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);
2420bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
2421470b340bSDmitry Karpeev   PetscFunctionReturn(0);
2422470b340bSDmitry Karpeev }
2423470b340bSDmitry Karpeev 
2424470b340bSDmitry Karpeev 
242529f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
2426e69d4d44SBarry Smith {
2427e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2428084e4875SJed Brown   PetscErrorCode ierr;
2429e69d4d44SBarry Smith 
2430e69d4d44SBarry Smith   PetscFunctionBegin;
2431084e4875SJed Brown   jac->schurpre = ptype;
2432a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
24336bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
2434084e4875SJed Brown     jac->schur_user = pre;
2435084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
2436084e4875SJed Brown   }
2437e69d4d44SBarry Smith   PetscFunctionReturn(0);
2438e69d4d44SBarry Smith }
2439e69d4d44SBarry Smith 
244037a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
244137a82bf0SJed Brown {
244237a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
244337a82bf0SJed Brown 
244437a82bf0SJed Brown   PetscFunctionBegin;
244537a82bf0SJed Brown   *ptype = jac->schurpre;
244637a82bf0SJed Brown   *pre   = jac->schur_user;
244737a82bf0SJed Brown   PetscFunctionReturn(0);
244837a82bf0SJed Brown }
244937a82bf0SJed Brown 
2450ab1df9f5SJed Brown /*@
24510ffb0e17SBarry Smith     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain in the preconditioner
2452ab1df9f5SJed Brown 
2453ab1df9f5SJed Brown     Collective on PC
2454ab1df9f5SJed Brown 
2455ab1df9f5SJed Brown     Input Parameters:
2456ab1df9f5SJed Brown +   pc  - the preconditioner context
2457c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
2458ab1df9f5SJed Brown 
2459ab1df9f5SJed Brown     Options Database:
2460c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
2461ab1df9f5SJed Brown 
2462ab1df9f5SJed Brown 
2463ab1df9f5SJed Brown     Level: intermediate
2464ab1df9f5SJed Brown 
2465ab1df9f5SJed Brown     Notes:
2466ab1df9f5SJed Brown     The FULL factorization is
2467ab1df9f5SJed Brown 
24680ffb0e17SBarry Smith $   (A   B)  = (1       0) (A   0) (1  Ainv*B)  = L D U
24690ffb0e17SBarry Smith $   (C   E)    (C*Ainv  1) (0   S) (0     1  )
2470ab1df9f5SJed Brown 
24710ffb0e17SBarry 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,
2472c096484dSStefano 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().
2473ab1df9f5SJed Brown 
24740ffb0e17SBarry Smith $    If A and S are solved exactly
24750ffb0e17SBarry Smith $      *) FULL factorization is a direct solver.
24760ffb0e17SBarry 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.
24770ffb0e17SBarry 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.
2478ab1df9f5SJed Brown 
24790ffb0e17SBarry Smith     If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
24800ffb0e17SBarry 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.
24810ffb0e17SBarry Smith 
24820ffb0e17SBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES.
24830ffb0e17SBarry Smith 
24840ffb0e17SBarry 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).
2485ab1df9f5SJed Brown 
2486ab1df9f5SJed Brown     References:
248796a0c994SBarry Smith +   1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
248896a0c994SBarry Smith -   2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2489ab1df9f5SJed Brown 
2490c096484dSStefano Zampini .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCFieldSplitSetSchurScale()
2491ab1df9f5SJed Brown @*/
2492c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
2493ab1df9f5SJed Brown {
2494ab1df9f5SJed Brown   PetscErrorCode ierr;
2495ab1df9f5SJed Brown 
2496ab1df9f5SJed Brown   PetscFunctionBegin;
2497ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2498c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
2499ab1df9f5SJed Brown   PetscFunctionReturn(0);
2500ab1df9f5SJed Brown }
2501ab1df9f5SJed Brown 
25021e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
2503ab1df9f5SJed Brown {
2504ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2505ab1df9f5SJed Brown 
2506ab1df9f5SJed Brown   PetscFunctionBegin;
2507ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2508ab1df9f5SJed Brown   PetscFunctionReturn(0);
2509ab1df9f5SJed Brown }
2510ab1df9f5SJed Brown 
2511c096484dSStefano Zampini /*@
2512c096484dSStefano Zampini     PCFieldSplitSetSchurScale -  Controls the sign flip of S for PC_FIELDSPLIT_SCHUR_FACT_DIAG.
2513c096484dSStefano Zampini 
2514c096484dSStefano Zampini     Collective on PC
2515c096484dSStefano Zampini 
2516c096484dSStefano Zampini     Input Parameters:
2517c096484dSStefano Zampini +   pc    - the preconditioner context
2518c096484dSStefano Zampini -   scale - scaling factor for the Schur complement
2519c096484dSStefano Zampini 
2520c096484dSStefano Zampini     Options Database:
2521c096484dSStefano Zampini .     -pc_fieldsplit_schur_scale - default is -1.0
2522c096484dSStefano Zampini 
2523c096484dSStefano Zampini     Level: intermediate
2524c096484dSStefano Zampini 
2525c096484dSStefano Zampini .seealso: PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurFactType, PCFieldSplitSetSchurScale()
2526c096484dSStefano Zampini @*/
2527c096484dSStefano Zampini PetscErrorCode PCFieldSplitSetSchurScale(PC pc,PetscScalar scale)
2528c096484dSStefano Zampini {
2529c096484dSStefano Zampini   PetscErrorCode ierr;
2530c096484dSStefano Zampini 
2531c096484dSStefano Zampini   PetscFunctionBegin;
2532c096484dSStefano Zampini   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2533c096484dSStefano Zampini   PetscValidLogicalCollectiveScalar(pc,scale,2);
2534c096484dSStefano Zampini   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurScale_C",(PC,PetscScalar),(pc,scale));CHKERRQ(ierr);
2535c096484dSStefano Zampini   PetscFunctionReturn(0);
2536c096484dSStefano Zampini }
2537c096484dSStefano Zampini 
2538c096484dSStefano Zampini static PetscErrorCode PCFieldSplitSetSchurScale_FieldSplit(PC pc,PetscScalar scale)
2539c096484dSStefano Zampini {
2540c096484dSStefano Zampini   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2541c096484dSStefano Zampini 
2542c096484dSStefano Zampini   PetscFunctionBegin;
2543c096484dSStefano Zampini   jac->schurscale = scale;
2544c096484dSStefano Zampini   PetscFunctionReturn(0);
2545c096484dSStefano Zampini }
2546c096484dSStefano Zampini 
254730ad9308SMatthew Knepley /*@C
25488c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
254930ad9308SMatthew Knepley 
255030ad9308SMatthew Knepley    Collective on KSP
255130ad9308SMatthew Knepley 
255230ad9308SMatthew Knepley    Input Parameter:
255330ad9308SMatthew Knepley .  pc - the preconditioner context
255430ad9308SMatthew Knepley 
255530ad9308SMatthew Knepley    Output Parameters:
2556a04f6461SBarry Smith +  A00 - the (0,0) block
2557a04f6461SBarry Smith .  A01 - the (0,1) block
2558a04f6461SBarry Smith .  A10 - the (1,0) block
2559a04f6461SBarry Smith -  A11 - the (1,1) block
256030ad9308SMatthew Knepley 
256130ad9308SMatthew Knepley    Level: advanced
256230ad9308SMatthew Knepley 
256330ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
256430ad9308SMatthew Knepley @*/
2565a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
256630ad9308SMatthew Knepley {
256730ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
256830ad9308SMatthew Knepley 
256930ad9308SMatthew Knepley   PetscFunctionBegin;
25700700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2571ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2572a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2573a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2574a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2575a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
257630ad9308SMatthew Knepley   PetscFunctionReturn(0);
257730ad9308SMatthew Knepley }
257830ad9308SMatthew Knepley 
2579b09e027eSCarola Kruse /*@
2580e071a0a4SCarola Kruse     PCFieldSplitSetGKBTol -  Sets the solver tolerance for the generalized Golub-Kahan bidiagonalization preconditioner.
2581b09e027eSCarola Kruse 
2582b09e027eSCarola Kruse     Collective on PC
2583b09e027eSCarola Kruse 
2584e071a0a4SCarola Kruse     Notes:
2585e071a0a4SCarola Kruse     The generalized GKB algorithm uses a lower bound estimate of the error in energy norm as stopping criterion.
2586e071a0a4SCarola Kruse     It stops once the lower bound estimate undershoots the required solver tolerance. Although the actual error might be bigger than
2587e071a0a4SCarola Kruse     this estimate, the stopping criterion is satisfactory in practical cases [A13].
2588e071a0a4SCarola Kruse 
2589e071a0a4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2590e071a0a4SCarola Kruse 
2591b09e027eSCarola Kruse     Input Parameters:
2592b09e027eSCarola Kruse +   pc        - the preconditioner context
2593b09e027eSCarola Kruse -   tolerance - the solver tolerance
2594b09e027eSCarola Kruse 
2595b09e027eSCarola Kruse     Options Database:
2596b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_tol - default is 1e-5
2597b09e027eSCarola Kruse 
2598b09e027eSCarola Kruse     Level: intermediate
2599b09e027eSCarola Kruse 
2600b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBMaxit()
2601b09e027eSCarola Kruse @*/
2602b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBTol(PC pc,PetscReal tolerance)
2603b09e027eSCarola Kruse {
2604b09e027eSCarola Kruse   PetscErrorCode ierr;
2605b09e027eSCarola Kruse 
2606b09e027eSCarola Kruse   PetscFunctionBegin;
2607b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2608de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc,tolerance,2);
2609b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBTol_C",(PC,PetscReal),(pc,tolerance));CHKERRQ(ierr);
2610b09e027eSCarola Kruse   PetscFunctionReturn(0);
2611b09e027eSCarola Kruse }
2612b09e027eSCarola Kruse 
2613b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBTol_FieldSplit(PC pc,PetscReal tolerance)
2614b09e027eSCarola Kruse {
2615b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2616b09e027eSCarola Kruse 
2617b09e027eSCarola Kruse   PetscFunctionBegin;
2618b09e027eSCarola Kruse   jac->gkbtol = tolerance;
2619b09e027eSCarola Kruse   PetscFunctionReturn(0);
2620b09e027eSCarola Kruse }
2621b09e027eSCarola Kruse 
2622b09e027eSCarola Kruse 
2623b09e027eSCarola Kruse /*@
2624e071a0a4SCarola Kruse     PCFieldSplitSetGKBMaxit -  Sets the maximum number of iterations for the generalized Golub-Kahan bidiagonalization
2625e071a0a4SCarola Kruse     preconditioner.
2626b09e027eSCarola Kruse 
2627b09e027eSCarola Kruse     Collective on PC
2628b09e027eSCarola Kruse 
2629b09e027eSCarola Kruse     Input Parameters:
2630b09e027eSCarola Kruse +   pc     - the preconditioner context
2631b09e027eSCarola Kruse -   maxit  - the maximum number of iterations
2632b09e027eSCarola Kruse 
2633b09e027eSCarola Kruse     Options Database:
2634b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_maxit - default is 100
2635b09e027eSCarola Kruse 
2636b09e027eSCarola Kruse     Level: intermediate
2637b09e027eSCarola Kruse 
2638b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBNu()
2639b09e027eSCarola Kruse @*/
2640b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBMaxit(PC pc,PetscInt maxit)
2641b09e027eSCarola Kruse {
2642b09e027eSCarola Kruse   PetscErrorCode ierr;
2643b09e027eSCarola Kruse 
2644b09e027eSCarola Kruse   PetscFunctionBegin;
2645b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2646de482cd7SCarola Kruse   PetscValidLogicalCollectiveInt(pc,maxit,2);
2647b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBMaxit_C",(PC,PetscInt),(pc,maxit));CHKERRQ(ierr);
2648b09e027eSCarola Kruse   PetscFunctionReturn(0);
2649b09e027eSCarola Kruse }
2650b09e027eSCarola Kruse 
2651b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBMaxit_FieldSplit(PC pc,PetscInt maxit)
2652b09e027eSCarola Kruse {
2653b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2654b09e027eSCarola Kruse 
2655b09e027eSCarola Kruse   PetscFunctionBegin;
2656b09e027eSCarola Kruse   jac->gkbmaxit = maxit;
2657b09e027eSCarola Kruse   PetscFunctionReturn(0);
2658b09e027eSCarola Kruse }
2659b09e027eSCarola Kruse 
2660b09e027eSCarola Kruse /*@
2661e071a0a4SCarola Kruse     PCFieldSplitSetGKBDelay -  Sets the delay in the lower bound error estimate in the generalized Golub-Kahan bidiagonalization
2662e071a0a4SCarola Kruse     preconditioner.
2663b09e027eSCarola Kruse 
2664b09e027eSCarola Kruse     Collective on PC
2665b09e027eSCarola Kruse 
2666b09e027eSCarola Kruse     Notes:
2667e071a0a4SCarola 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
2668e071a0a4SCarola 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
2669e071a0a4SCarola 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
2670b09e027eSCarola Kruse 
2671b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2672b09e027eSCarola Kruse 
2673b09e027eSCarola Kruse     Input Parameters:
2674b09e027eSCarola Kruse +   pc     - the preconditioner context
2675b09e027eSCarola Kruse -   delay  - the delay window in the lower bound estimate
2676b09e027eSCarola Kruse 
2677b09e027eSCarola Kruse     Options Database:
2678b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_delay - default is 5
2679b09e027eSCarola Kruse 
2680b09e027eSCarola Kruse     Level: intermediate
2681b09e027eSCarola Kruse 
2682b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBNu(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit()
2683b09e027eSCarola Kruse @*/
2684b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBDelay(PC pc,PetscInt delay)
2685b09e027eSCarola Kruse {
2686b09e027eSCarola Kruse   PetscErrorCode ierr;
2687b09e027eSCarola Kruse 
2688b09e027eSCarola Kruse   PetscFunctionBegin;
2689b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2690b09e027eSCarola Kruse   PetscValidLogicalCollectiveInt(pc,delay,2);
2691b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBDelay_C",(PC,PetscInt),(pc,delay));CHKERRQ(ierr);
2692b09e027eSCarola Kruse   PetscFunctionReturn(0);
2693b09e027eSCarola Kruse }
2694b09e027eSCarola Kruse 
2695b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBDelay_FieldSplit(PC pc,PetscInt delay)
2696b09e027eSCarola Kruse {
2697b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2698b09e027eSCarola Kruse 
2699b09e027eSCarola Kruse   PetscFunctionBegin;
2700b09e027eSCarola Kruse   jac->gkbdelay = delay;
2701b09e027eSCarola Kruse   PetscFunctionReturn(0);
2702b09e027eSCarola Kruse }
2703b09e027eSCarola Kruse 
2704b09e027eSCarola Kruse /*@
2705b09e027eSCarola 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.
2706b09e027eSCarola Kruse 
2707b09e027eSCarola Kruse     Collective on PC
2708b09e027eSCarola Kruse 
2709b09e027eSCarola Kruse     Notes:
2710e071a0a4SCarola 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,
2711b09e027eSCarola 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
2712b09e027eSCarola Kruse     necessary to find a good balance in between the convergence of the inner and outer loop.
2713b09e027eSCarola Kruse 
2714b09e027eSCarola 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.
2715b09e027eSCarola Kruse 
2716b09e027eSCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
2717b09e027eSCarola Kruse 
2718b09e027eSCarola Kruse     Input Parameters:
2719b09e027eSCarola Kruse +   pc     - the preconditioner context
2720b09e027eSCarola Kruse -   nu     - the shift parameter
2721b09e027eSCarola Kruse 
2722b09e027eSCarola Kruse     Options Database:
2723b09e027eSCarola Kruse .     -pc_fieldsplit_gkb_nu - default is 1
2724b09e027eSCarola Kruse 
2725b09e027eSCarola Kruse     Level: intermediate
2726b09e027eSCarola Kruse 
2727b09e027eSCarola Kruse .seealso: PCFIELDSPLIT, PCFieldSplitSetGKBDelay(), PCFieldSplitSetGKBTol(), PCFieldSplitSetGKBMaxit()
2728b09e027eSCarola Kruse @*/
2729b09e027eSCarola Kruse PetscErrorCode PCFieldSplitSetGKBNu(PC pc,PetscReal nu)
2730b09e027eSCarola Kruse {
2731b09e027eSCarola Kruse   PetscErrorCode ierr;
2732b09e027eSCarola Kruse 
2733b09e027eSCarola Kruse   PetscFunctionBegin;
2734b09e027eSCarola Kruse   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2735de482cd7SCarola Kruse   PetscValidLogicalCollectiveReal(pc,nu,2);
2736b09e027eSCarola Kruse   ierr = PetscTryMethod(pc,"PCFieldSplitSetGKBNu_C",(PC,PetscReal),(pc,nu));CHKERRQ(ierr);
2737b09e027eSCarola Kruse   PetscFunctionReturn(0);
2738b09e027eSCarola Kruse }
2739b09e027eSCarola Kruse 
2740b09e027eSCarola Kruse static PetscErrorCode PCFieldSplitSetGKBNu_FieldSplit(PC pc,PetscReal nu)
2741b09e027eSCarola Kruse {
2742b09e027eSCarola Kruse   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2743b09e027eSCarola Kruse 
2744b09e027eSCarola Kruse   PetscFunctionBegin;
2745b09e027eSCarola Kruse   jac->gkbnu = nu;
2746b09e027eSCarola Kruse   PetscFunctionReturn(0);
2747b09e027eSCarola Kruse }
2748b09e027eSCarola Kruse 
2749b09e027eSCarola Kruse 
27501e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
275179416396SBarry Smith {
275279416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2753e69d4d44SBarry Smith   PetscErrorCode ierr;
275479416396SBarry Smith 
275579416396SBarry Smith   PetscFunctionBegin;
275679416396SBarry Smith   jac->type = type;
2757e071a0a4SCarola Kruse 
2758e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",0);CHKERRQ(ierr);
2759e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
2760e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2761e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
2762e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",0);CHKERRQ(ierr);
2763e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",0);CHKERRQ(ierr);
2764e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",0);CHKERRQ(ierr);
2765e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",0);CHKERRQ(ierr);
2766e071a0a4SCarola Kruse   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",0);CHKERRQ(ierr);
2767e071a0a4SCarola Kruse 
27683b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
27693b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
27703b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
27712fa5cd67SKarl Rupp 
2772bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
277329f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
277437a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2775bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2776c096484dSStefano Zampini     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurScale_C",PCFieldSplitSetSchurScale_FieldSplit);CHKERRQ(ierr);
2777a51937d4SCarola Kruse   } else if (type == PC_COMPOSITE_GKB){
2778a51937d4SCarola Kruse     pc->ops->apply = PCApply_FieldSplit_GKB;
2779a51937d4SCarola Kruse     pc->ops->view  = PCView_FieldSplit_GKB;
2780e69d4d44SBarry Smith 
2781a51937d4SCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2782b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBTol_C",PCFieldSplitSetGKBTol_FieldSplit);CHKERRQ(ierr);
2783b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBMaxit_C",PCFieldSplitSetGKBMaxit_FieldSplit);CHKERRQ(ierr);
2784b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBNu_C",PCFieldSplitSetGKBNu_FieldSplit);CHKERRQ(ierr);
2785b09e027eSCarola Kruse     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetGKBDelay_C",PCFieldSplitSetGKBDelay_FieldSplit);CHKERRQ(ierr);
27863b224e63SBarry Smith   } else {
27873b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
27883b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
27892fa5cd67SKarl Rupp 
2790bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
27913b224e63SBarry Smith   }
279279416396SBarry Smith   PetscFunctionReturn(0);
279379416396SBarry Smith }
279479416396SBarry Smith 
27951e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
279651f519a2SBarry Smith {
279751f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
279851f519a2SBarry Smith 
279951f519a2SBarry Smith   PetscFunctionBegin;
2800ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2801ce94432eSBarry 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);
280251f519a2SBarry Smith   jac->bs = bs;
280351f519a2SBarry Smith   PetscFunctionReturn(0);
280451f519a2SBarry Smith }
280551f519a2SBarry Smith 
2806bc08b0f1SBarry Smith /*@
280779416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
280879416396SBarry Smith 
280979416396SBarry Smith    Collective on PC
281079416396SBarry Smith 
281179416396SBarry Smith    Input Parameter:
2812a2b725a8SWilliam Gropp +  pc - the preconditioner context
2813a2b725a8SWilliam Gropp -  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
281479416396SBarry Smith 
281579416396SBarry Smith    Options Database Key:
2816a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
281779416396SBarry Smith 
2818b02e2d75SMatthew G Knepley    Level: Intermediate
281979416396SBarry Smith 
282079416396SBarry Smith .seealso: PCCompositeSetType()
282179416396SBarry Smith 
282279416396SBarry Smith @*/
28237087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
282479416396SBarry Smith {
28254ac538c5SBarry Smith   PetscErrorCode ierr;
282679416396SBarry Smith 
282779416396SBarry Smith   PetscFunctionBegin;
28280700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
28294ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
283079416396SBarry Smith   PetscFunctionReturn(0);
283179416396SBarry Smith }
283279416396SBarry Smith 
2833b02e2d75SMatthew G Knepley /*@
2834b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2835b02e2d75SMatthew G Knepley 
2836b02e2d75SMatthew G Knepley   Not collective
2837b02e2d75SMatthew G Knepley 
2838b02e2d75SMatthew G Knepley   Input Parameter:
2839b02e2d75SMatthew G Knepley . pc - the preconditioner context
2840b02e2d75SMatthew G Knepley 
2841b02e2d75SMatthew G Knepley   Output Parameter:
2842b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2843b02e2d75SMatthew G Knepley 
2844b02e2d75SMatthew G Knepley   Level: Intermediate
2845b02e2d75SMatthew G Knepley 
2846b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2847b02e2d75SMatthew G Knepley @*/
2848b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2849b02e2d75SMatthew G Knepley {
2850b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2851b02e2d75SMatthew G Knepley 
2852b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2853b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2854b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2855b02e2d75SMatthew G Knepley   *type = jac->type;
2856b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2857b02e2d75SMatthew G Knepley }
2858b02e2d75SMatthew G Knepley 
28594ab8060aSDmitry Karpeev /*@
28604ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
28614ab8060aSDmitry Karpeev 
28624ab8060aSDmitry Karpeev    Logically Collective
28634ab8060aSDmitry Karpeev 
28644ab8060aSDmitry Karpeev    Input Parameters:
28654ab8060aSDmitry Karpeev +  pc   - the preconditioner context
28664ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
28674ab8060aSDmitry Karpeev 
28684ab8060aSDmitry Karpeev    Options Database Key:
28694ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
28704ab8060aSDmitry Karpeev 
28714ab8060aSDmitry Karpeev    Level: Intermediate
28724ab8060aSDmitry Karpeev 
28734ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
28744ab8060aSDmitry Karpeev 
28754ab8060aSDmitry Karpeev @*/
28764ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
28774ab8060aSDmitry Karpeev {
28784ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
28794ab8060aSDmitry Karpeev   PetscBool      isfs;
28804ab8060aSDmitry Karpeev   PetscErrorCode ierr;
28814ab8060aSDmitry Karpeev 
28824ab8060aSDmitry Karpeev   PetscFunctionBegin;
28834ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
28844ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
28854ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
28864ab8060aSDmitry Karpeev   if (isfs) {
28874ab8060aSDmitry Karpeev     jac->dm_splits = flg;
28884ab8060aSDmitry Karpeev   }
28894ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
28904ab8060aSDmitry Karpeev }
28914ab8060aSDmitry Karpeev 
28924ab8060aSDmitry Karpeev 
28934ab8060aSDmitry Karpeev /*@
28944ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
28954ab8060aSDmitry Karpeev 
28964ab8060aSDmitry Karpeev    Logically Collective
28974ab8060aSDmitry Karpeev 
28984ab8060aSDmitry Karpeev    Input Parameter:
28994ab8060aSDmitry Karpeev .  pc   - the preconditioner context
29004ab8060aSDmitry Karpeev 
29014ab8060aSDmitry Karpeev    Output Parameter:
29024ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
29034ab8060aSDmitry Karpeev 
29044ab8060aSDmitry Karpeev    Level: Intermediate
29054ab8060aSDmitry Karpeev 
29064ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
29074ab8060aSDmitry Karpeev 
29084ab8060aSDmitry Karpeev @*/
29094ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(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);
2917*534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
29184ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
29194ab8060aSDmitry Karpeev   if (isfs) {
29204ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
29214ab8060aSDmitry Karpeev   }
29224ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
29234ab8060aSDmitry Karpeev }
29244ab8060aSDmitry Karpeev 
29257b752e3dSPatrick Sanan /*@
29267b752e3dSPatrick Sanan    PCFieldSplitGetDetectSaddlePoint - Returns flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
29277b752e3dSPatrick Sanan 
29287b752e3dSPatrick Sanan    Logically Collective
29297b752e3dSPatrick Sanan 
29307b752e3dSPatrick Sanan    Input Parameter:
29317b752e3dSPatrick Sanan .  pc   - the preconditioner context
29327b752e3dSPatrick Sanan 
29337b752e3dSPatrick Sanan    Output Parameter:
29347b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
29357b752e3dSPatrick Sanan 
29367b752e3dSPatrick Sanan    Level: Intermediate
29377b752e3dSPatrick Sanan 
29387b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint()
29397b752e3dSPatrick Sanan 
29407b752e3dSPatrick Sanan @*/
29417b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitGetDetectSaddlePoint(PC pc,PetscBool *flg)
29427b752e3dSPatrick Sanan {
29437b752e3dSPatrick Sanan   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
29447b752e3dSPatrick Sanan 
29457b752e3dSPatrick Sanan   PetscFunctionBegin;
29467b752e3dSPatrick Sanan   *flg = jac->detect;
29477b752e3dSPatrick Sanan   PetscFunctionReturn(0);
29487b752e3dSPatrick Sanan }
29497b752e3dSPatrick Sanan 
29507b752e3dSPatrick Sanan /*@
29517b752e3dSPatrick Sanan    PCFieldSplitSetDetectSaddlePoint - Sets flag indicating whether PCFieldSplit will attempt to automatically determine fields based on zero diagonal entries.
29527b752e3dSPatrick Sanan 
29537b752e3dSPatrick Sanan    Logically Collective
29547b752e3dSPatrick Sanan 
29557b752e3dSPatrick Sanan    Notes:
29567b752e3dSPatrick 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()).
29577b752e3dSPatrick Sanan 
29587b752e3dSPatrick Sanan    Input Parameter:
29597b752e3dSPatrick Sanan .  pc   - the preconditioner context
29607b752e3dSPatrick Sanan 
29617b752e3dSPatrick Sanan    Output Parameter:
29627b752e3dSPatrick Sanan .  flg  - boolean indicating whether to detect fields or not
29637b752e3dSPatrick Sanan 
29647b752e3dSPatrick Sanan    Options Database Key:
29657b752e3dSPatrick Sanan .  -pc_fieldsplit_detect_saddle_point
29667b752e3dSPatrick Sanan 
29677b752e3dSPatrick Sanan    Level: Intermediate
29687b752e3dSPatrick Sanan 
29697b752e3dSPatrick Sanan .seealso: PCFIELDSPLIT, PCFieldSplitSetDetectSaddlePoint(), PCFieldSplitSetType(), PCFieldSplitSetSchurPre()
29707b752e3dSPatrick Sanan 
29717b752e3dSPatrick Sanan @*/
29727b752e3dSPatrick Sanan PetscErrorCode PCFieldSplitSetDetectSaddlePoint(PC pc,PetscBool flg)
29737b752e3dSPatrick Sanan {
29747b752e3dSPatrick Sanan   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
29757b752e3dSPatrick Sanan   PetscErrorCode ierr;
29767b752e3dSPatrick Sanan 
29777b752e3dSPatrick Sanan   PetscFunctionBegin;
29787b752e3dSPatrick Sanan   jac->detect = flg;
29797b752e3dSPatrick Sanan   if (jac->detect) {
29807b752e3dSPatrick Sanan     ierr = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
29817b752e3dSPatrick Sanan     ierr = PCFieldSplitSetSchurPre(pc,PC_FIELDSPLIT_SCHUR_PRE_SELF,NULL);CHKERRQ(ierr);
29827b752e3dSPatrick Sanan   }
29837b752e3dSPatrick Sanan   PetscFunctionReturn(0);
29847b752e3dSPatrick Sanan }
29857b752e3dSPatrick Sanan 
29860971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
29870971522cSBarry Smith /*MC
2988a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2989a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
29900971522cSBarry Smith 
2991edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
2992edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
29930971522cSBarry Smith 
2994a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
299569a612a9SBarry Smith          and set the options directly on the resulting KSP object
29960971522cSBarry Smith 
29970971522cSBarry Smith    Level: intermediate
29980971522cSBarry Smith 
299979416396SBarry Smith    Options Database Keys:
300081540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
300181540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
300281540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
300381540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
3004a51937d4SCarola Kruse .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur,gkb> - type of relaxation or factorization splitting
3005a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
30067b752e3dSPatrick Sanan .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero diagonal and uses Schur complement with no preconditioner as the solver
300779416396SBarry Smith 
3008a51937d4SCarola Kruse .    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
30095d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
3010a51937d4SCarola Kruse -    Options prefix for inner solver when using Golub Kahan biadiagonalization preconditioner is -fieldsplit_0_
30115d4c12cdSJungho Lee 
3012c8a0d604SMatthew G Knepley    Notes:
3013c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
3014d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
3015d32f9abdSBarry Smith 
3016d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
3017d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
3018d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
3019d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
3020d32f9abdSBarry Smith 
3021c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
3022c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
3023c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
302413b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
3025c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
302613b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
302713b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
302813b05affSJed 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
3029686bed4dSStefano Zampini      in providing the SECOND split or 1 if not give). For PCFieldSplitGetSubKSP() when field number is 0,
3030c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
3031a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
30321d71051fSDmitry Karpeev 
3033a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
30345668aaf4SBarry Smith      diag gives
3035c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
3036c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
3037c096484dSStefano 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
3038c096484dSStefano Zampini      can be turned off with PCFieldSplitSetSchurScale() or by command line -pc_fieldsplit_schur_scale 1.0. The lower factorization is the inverse of
3039c8a0d604SMatthew G Knepley $              (  A00   0 )
3040c8a0d604SMatthew G Knepley $              (  A10   S )
3041c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
3042c8a0d604SMatthew G Knepley $              ( A00 A01 )
3043c8a0d604SMatthew G Knepley $              (  0   S  )
3044c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
3045e69d4d44SBarry Smith 
3046edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
3047edf189efSBarry Smith      is used automatically for a second block.
3048edf189efSBarry Smith 
3049ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
3050ff218e97SBarry Smith      Generally it should be used with the AIJ format.
3051ff218e97SBarry Smith 
3052ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
3053ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
3054ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
30550716a85fSBarry Smith 
30563bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
30573bc631e0SBarry Smith 
30583bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
30593bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
30603bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
30613bc631e0SBarry Smith 
30624d308398SBarry Smith    The Constrained Pressure Preconditioner (CPR) can be implemented using PCCOMPOSITE with PCGALERKIN. CPR first solves an R A P subsystem, updates the
30634d308398SBarry Smith    residual on all variables (PCCompositeSetType(pc,PC_COMPOSITE_MULTIPLICATIVE)), and then applies a simple ILU like preconditioner on all the variables.
3064a6a584a2SBarry Smith 
3065e071a0a4SCarola Kruse    The generalized Golub-Kahan bidiagonalization preconditioner (gkb) can be applied to symmetric 2x2 block matrices of the shape
3066a51937d4SCarola Kruse $        ( A00  A01 )
3067a51937d4SCarola Kruse $        ( A01' 0   )
3068a51937d4SCarola 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'.
3069e071a0a4SCarola 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_.
3070a51937d4SCarola Kruse 
3071a51937d4SCarola Kruse [Ar13] Generalized Golub-Kahan bidiagonalization and stopping criteria, SIAM J. Matrix Anal. Appl., Vol. 34, No. 2, pp. 571-592, 2013.
3072a51937d4SCarola Kruse 
30737e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
3074285fb4e2SStefano Zampini            PCFieldSplitGetSubKSP(), PCFieldSplitSchurGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(),
30757b752e3dSPatrick Sanan           MatSchurComplementSetAinvType(), PCFieldSplitSetSchurScale(),
30767b752e3dSPatrick Sanan           PCFieldSplitSetDetectSaddlePoint()
30770971522cSBarry Smith M*/
30780971522cSBarry Smith 
30798cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
30800971522cSBarry Smith {
30810971522cSBarry Smith   PetscErrorCode ierr;
30820971522cSBarry Smith   PC_FieldSplit  *jac;
30830971522cSBarry Smith 
30840971522cSBarry Smith   PetscFunctionBegin;
3085b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
30862fa5cd67SKarl Rupp 
30870971522cSBarry Smith   jac->bs                 = -1;
30880971522cSBarry Smith   jac->nsplits            = 0;
30893e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
3090e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
3091c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
3092c096484dSStefano Zampini   jac->schurscale         = -1.0;
3093fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
30947b752e3dSPatrick Sanan   jac->detect             = PETSC_FALSE;
3095a51937d4SCarola Kruse   jac->gkbtol             = 1e-5;
3096a51937d4SCarola Kruse   jac->gkbdelay           = 5;
3097a51937d4SCarola Kruse   jac->gkbnu              = 1;
3098a51937d4SCarola Kruse   jac->gkbmaxit           = 100;
3099de482cd7SCarola Kruse   jac->gkbmonitor         = PETSC_FALSE;
310051f519a2SBarry Smith 
31010971522cSBarry Smith   pc->data = (void*)jac;
31020971522cSBarry Smith 
31030971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
3104421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
31050971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
3106574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
31070971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
31080971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
31090971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
31100971522cSBarry Smith   pc->ops->applyrichardson = 0;
31110971522cSBarry Smith 
3112285fb4e2SStefano Zampini   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSchurGetSubKSP_C",PCFieldSplitSchurGetSubKSP_FieldSplit);CHKERRQ(ierr);
3113bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
3114bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
3115bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
3116bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
3117bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
31186dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr);
31190971522cSBarry Smith   PetscFunctionReturn(0);
31200971522cSBarry Smith }
3121