xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 0df66cc4d345d602e1cfa25bd6975424bb853846)
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]) */
4797bbdb24SBarry Smith   PC_FieldSplitLink         head;
486dbb499eSCian Wilson   PetscBool                 isrestrict;             /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */
49c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
504ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
51c84da90fSDmitry Karpeev   PetscBool                 diag_use_amat;          /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
52c84da90fSDmitry Karpeev   PetscBool                 offdiag_use_amat;       /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
530971522cSBarry Smith } PC_FieldSplit;
540971522cSBarry Smith 
5516913363SBarry Smith /*
5616913363SBarry Smith     Notes: there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
5716913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
5816913363SBarry Smith    PC you could change this.
5916913363SBarry Smith */
60084e4875SJed Brown 
61e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
62084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
63084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
64084e4875SJed Brown {
65084e4875SJed Brown   switch (jac->schurpre) {
66084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
67a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
68e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
69e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
70084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
71084e4875SJed Brown   default:
72084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
73084e4875SJed Brown   }
74084e4875SJed Brown }
75084e4875SJed Brown 
76084e4875SJed Brown 
779804daf3SBarry Smith #include <petscdraw.h>
780971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
790971522cSBarry Smith {
800971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
810971522cSBarry Smith   PetscErrorCode    ierr;
82d9884438SBarry Smith   PetscBool         iascii,isdraw;
830971522cSBarry Smith   PetscInt          i,j;
845a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
850971522cSBarry Smith 
860971522cSBarry Smith   PetscFunctionBegin;
87251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
88d9884438SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
890971522cSBarry Smith   if (iascii) {
902c9966d7SBarry Smith     if (jac->bs > 0) {
9151f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
922c9966d7SBarry Smith     } else {
932c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
942c9966d7SBarry Smith     }
95f5236f50SJed Brown     if (pc->useAmat) {
96f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
97a3df900dSMatthew G Knepley     }
98c84da90fSDmitry Karpeev     if (jac->diag_use_amat) {
99c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
100c84da90fSDmitry Karpeev     }
101c84da90fSDmitry Karpeev     if (jac->offdiag_use_amat) {
102c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
103c84da90fSDmitry Karpeev     }
10469a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1050971522cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1060971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1071ab39975SBarry Smith       if (ilink->fields) {
1080971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
10979416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1105a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
11179416396SBarry Smith           if (j > 0) {
11279416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
11379416396SBarry Smith           }
1145a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1150971522cSBarry Smith         }
1160971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
11779416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1181ab39975SBarry Smith       } else {
1191ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1201ab39975SBarry Smith       }
1215a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1225a9f2f41SSatish Balay       ilink = ilink->next;
1230971522cSBarry Smith     }
1240971522cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1252fa5cd67SKarl Rupp   }
1262fa5cd67SKarl Rupp 
1272fa5cd67SKarl Rupp  if (isdraw) {
128d9884438SBarry Smith     PetscDraw draw;
129d9884438SBarry Smith     PetscReal x,y,w,wd;
130d9884438SBarry Smith 
131d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
132d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
133d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
134d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
135d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
136d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
137d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
138d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
139d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
140d9884438SBarry Smith       x    += wd;
141d9884438SBarry Smith       ilink = ilink->next;
142d9884438SBarry Smith     }
1430971522cSBarry Smith   }
1440971522cSBarry Smith   PetscFunctionReturn(0);
1450971522cSBarry Smith }
1460971522cSBarry Smith 
1473b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1483b224e63SBarry Smith {
1493b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1503b224e63SBarry Smith   PetscErrorCode    ierr;
1514996c5bdSBarry Smith   PetscBool         iascii,isdraw;
1523b224e63SBarry Smith   PetscInt          i,j;
1533b224e63SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1543b224e63SBarry Smith 
1553b224e63SBarry Smith   PetscFunctionBegin;
156251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1574996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1583b224e63SBarry Smith   if (iascii) {
1592c9966d7SBarry Smith     if (jac->bs > 0) {
160c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1612c9966d7SBarry Smith     } else {
1622c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1632c9966d7SBarry Smith     }
164f5236f50SJed Brown     if (pc->useAmat) {
165f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
166a3df900dSMatthew G Knepley     }
1673e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1683e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
1693e8b8b31SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);break;
170a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
1711d71051fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses (lumped, if requested) A00's diagonal's inverse\n");CHKERRQ(ierr);break;
172e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
173e87fab1bSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);break;
174e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
175e74569cdSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);break;
1763e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1773e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1783e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1793e8b8b31SMatthew G Knepley       } else {
180e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1813e8b8b31SMatthew G Knepley       }
1823e8b8b31SMatthew G Knepley       break;
1833e8b8b31SMatthew G Knepley     default:
18482f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1853e8b8b31SMatthew G Knepley     }
1863b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1873b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1883b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1893b224e63SBarry Smith       if (ilink->fields) {
1903b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
1913b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1923b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
1933b224e63SBarry Smith           if (j > 0) {
1943b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
1953b224e63SBarry Smith           }
1963b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1973b224e63SBarry Smith         }
1983b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
1993b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2003b224e63SBarry Smith       } else {
2013b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2023b224e63SBarry Smith       }
2033b224e63SBarry Smith       ilink = ilink->next;
2043b224e63SBarry Smith     }
205435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2063b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
20706de4afeSJed Brown     if (jac->head) {
208443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
20906de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2103b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21106de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
212443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
213443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
214b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
215b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
216443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
217443836d0SMatthew G Knepley     }
218435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2193b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22012cae6f2SJed Brown     if (jac->kspschur) {
2213b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
22212cae6f2SJed Brown     } else {
22312cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
22412cae6f2SJed Brown     }
2253b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2263b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
22706de4afeSJed Brown   } else if (isdraw && jac->head) {
2284996c5bdSBarry Smith     PetscDraw draw;
2294996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2304996c5bdSBarry Smith     PetscInt  cnt = 2;
2314996c5bdSBarry Smith     char      str[32];
2324996c5bdSBarry Smith 
2334996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2344996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
235c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
236c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
237c74581afSBarry Smith     wd = w/(cnt + 1);
238c74581afSBarry Smith 
2394996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
24051fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2414996c5bdSBarry Smith     y   -= h;
2424996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
243e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2443b224e63SBarry Smith     } else {
2454996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2464996c5bdSBarry Smith     }
24751fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2484996c5bdSBarry Smith     y   -= h;
2494996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2504996c5bdSBarry Smith 
2514996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2524996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2534996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2544996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2554996c5bdSBarry Smith       x   += wd;
2564996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2574996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2584996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2594996c5bdSBarry Smith     }
2604996c5bdSBarry Smith     x   += wd;
2614996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2624996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2634996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2643b224e63SBarry Smith   }
2653b224e63SBarry Smith   PetscFunctionReturn(0);
2663b224e63SBarry Smith }
2673b224e63SBarry Smith 
2686c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
2696c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
2706c924f48SJed Brown {
2716c924f48SJed Brown   PetscErrorCode ierr;
2726c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2735d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
2745d4c12cdSJungho Lee   PetscBool      flg,flg_col;
2755d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
2766c924f48SJed Brown 
2776c924f48SJed Brown   PetscFunctionBegin;
278785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
279785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
2806c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
2818caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
2828caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
2838caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
2846c924f48SJed Brown     nfields     = jac->bs;
28529499fbbSJungho Lee     nfields_col = jac->bs;
286c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
287c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
2886c924f48SJed Brown     if (!flg) break;
2895d4c12cdSJungho Lee     else if (flg && !flg_col) {
2905d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2915d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
2922fa5cd67SKarl Rupp     } else {
2935d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2945d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
2955d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
2965d4c12cdSJungho Lee     }
2976c924f48SJed Brown   }
2986c924f48SJed Brown   if (i > 0) {
2996c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3006c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3016c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3026c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3036c924f48SJed Brown   }
3046c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3055d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3066c924f48SJed Brown   PetscFunctionReturn(0);
3076c924f48SJed Brown }
3086c924f48SJed Brown 
30969a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3100971522cSBarry Smith {
3110971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3120971522cSBarry Smith   PetscErrorCode    ierr;
3135a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
3143a062f41SBarry Smith   PetscBool         fieldsplit_default = PETSC_FALSE,stokes = PETSC_FALSE,coupling = PETSC_FALSE;
3156c924f48SJed Brown   PetscInt          i;
3160971522cSBarry Smith 
3170971522cSBarry Smith   PetscFunctionBegin;
3187287d2a3SDmitry Karpeev   /*
319f5f0d762SBarry Smith    Kinda messy, but at least this now uses DMCreateFieldDecomposition().
3207287d2a3SDmitry Karpeev    Should probably be rewritten.
3217287d2a3SDmitry Karpeev    */
322f5f0d762SBarry Smith   if (!ilink) {
323c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
324c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
3253a062f41SBarry Smith     if (pc->dm && jac->dm_splits && !stokes && !coupling) {
326bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3270784a22cSJed Brown       char      **fieldNames;
3287b62db95SJungho Lee       IS        *fields;
329e7c4fc90SDmitry Karpeev       DM        *dms;
330bafc1b83SMatthew G Knepley       DM        subdm[128];
331bafc1b83SMatthew G Knepley       PetscBool flg;
332bafc1b83SMatthew G Knepley 
33316621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
334bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
335bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
336bafc1b83SMatthew G Knepley         PetscInt ifields[128];
337bafc1b83SMatthew G Knepley         IS       compField;
338bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
339bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
340bafc1b83SMatthew G Knepley 
3418caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
342c5929fdfSBarry Smith         ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
343bafc1b83SMatthew G Knepley         if (!flg) break;
34482f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
345bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
346bafc1b83SMatthew G Knepley         if (nfields == 1) {
347bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
348bafc1b83SMatthew G Knepley         } else {
3498caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
350bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
3517287d2a3SDmitry Karpeev         }
352bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
353bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
354bafc1b83SMatthew G Knepley           f    = ifields[j];
3557b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
3567b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
3577b62db95SJungho Lee         }
358bafc1b83SMatthew G Knepley       }
359bafc1b83SMatthew G Knepley       if (i == 0) {
360bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
361bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
362bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
363bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
364bafc1b83SMatthew G Knepley         }
365bafc1b83SMatthew G Knepley       } else {
366d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
367d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
368d724dfffSBarry Smith         }
369d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
370785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
3712fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
372bafc1b83SMatthew G Knepley       }
3737b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
3747b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
375e7c4fc90SDmitry Karpeev       if (dms) {
3768b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
377bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
3787287d2a3SDmitry Karpeev           const char *prefix;
3797287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
3807287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
3817b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
3827b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
3837287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
384e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
3852fa5ba8aSJed Brown         }
3867b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
3878b8307b2SJed Brown       }
38866ffff09SJed Brown     } else {
389521d7252SBarry Smith       if (jac->bs <= 0) {
390704ba839SBarry Smith         if (pc->pmat) {
391521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
3922fa5cd67SKarl Rupp         } else jac->bs = 1;
393521d7252SBarry Smith       }
394d32f9abdSBarry Smith 
3956ce1633cSBarry Smith       if (stokes) {
3966ce1633cSBarry Smith         IS       zerodiags,rest;
3976ce1633cSBarry Smith         PetscInt nmin,nmax;
3986ce1633cSBarry Smith 
3996ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4006ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4016ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4026ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4036ce1633cSBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
404fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
405fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4063a062f41SBarry Smith       } else if (coupling) {
4073a062f41SBarry Smith         IS       coupling,rest;
4083a062f41SBarry Smith         PetscInt nmin,nmax;
4093a062f41SBarry Smith 
4103a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4113a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
4126bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
413e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
414d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
415d020c841SBarry Smith         ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr);
4163a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
4173a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4186ce1633cSBarry Smith       } else {
419c5929fdfSBarry Smith         ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
4207287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
421d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
422d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4236c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
4246c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
425d32f9abdSBarry Smith         }
4266dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
427d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
428db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
4296c924f48SJed Brown             char splitname[8];
4308caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
4315d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
43279416396SBarry Smith           }
4335d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
434521d7252SBarry Smith         }
43566ffff09SJed Brown       }
4366ce1633cSBarry Smith     }
437edf189efSBarry Smith   } else if (jac->nsplits == 1) {
438edf189efSBarry Smith     if (ilink->is) {
439edf189efSBarry Smith       IS       is2;
440edf189efSBarry Smith       PetscInt nmin,nmax;
441edf189efSBarry Smith 
442edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
443edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
444db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
445fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
44682f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
447edf189efSBarry Smith   }
448d0af7cd3SBarry Smith 
44982f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
45069a612a9SBarry Smith   PetscFunctionReturn(0);
45169a612a9SBarry Smith }
45269a612a9SBarry Smith 
453c5929fdfSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[], char *value[], PetscBool *flg);
454514bf10dSMatthew G Knepley 
45569a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
45669a612a9SBarry Smith {
45769a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
45869a612a9SBarry Smith   PetscErrorCode    ierr;
4595a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4602c9966d7SBarry Smith   PetscInt          i,nsplit;
4615f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
46269a612a9SBarry Smith 
46369a612a9SBarry Smith   PetscFunctionBegin;
46469a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
46597bbdb24SBarry Smith   nsplit = jac->nsplits;
4665a9f2f41SSatish Balay   ilink  = jac->head;
46797bbdb24SBarry Smith 
46897bbdb24SBarry Smith   /* get the matrices for each split */
469704ba839SBarry Smith   if (!jac->issetup) {
4701b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
47197bbdb24SBarry Smith 
472704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
473704ba839SBarry Smith 
4745d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
4752c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
4762c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
4772c9966d7SBarry Smith     }
47851f519a2SBarry Smith     bs     = jac->bs;
47997bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
4801b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
4811b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
4821b9fc7fcSBarry Smith       if (jac->defaultsplit) {
483ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
4845f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
485704ba839SBarry Smith       } else if (!ilink->is) {
486ccb205f8SBarry Smith         if (ilink->nfields > 1) {
4875f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
488785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
489785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
4901b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
4911b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
4921b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
4935f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
49497bbdb24SBarry Smith             }
49597bbdb24SBarry Smith           }
496ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
497ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
49890e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
49990e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
500ccb205f8SBarry Smith         } else {
501ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
502ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
503ccb205f8SBarry Smith        }
5043e197d65SBarry Smith       }
505704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
5065f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
5075f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
508704ba839SBarry Smith       ilink = ilink->next;
5091b9fc7fcSBarry Smith     }
5101b9fc7fcSBarry Smith   }
5111b9fc7fcSBarry Smith 
512704ba839SBarry Smith   ilink = jac->head;
51397bbdb24SBarry Smith   if (!jac->pmat) {
514bdddcaaaSMatthew G Knepley     Vec xtmp;
515bdddcaaaSMatthew G Knepley 
5162a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
517785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
518dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
519cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
520bdddcaaaSMatthew G Knepley       MatNullSpace sp;
521bdddcaaaSMatthew G Knepley 
522a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
523a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
524a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
525a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
526a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
527a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
5282fa5cd67SKarl Rupp 
529a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
530a3df900dSMatthew G Knepley         }
531a3df900dSMatthew G Knepley       } else {
5323a062f41SBarry Smith         const char *prefix;
5335f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
5343a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
5353a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
5363a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
537a3df900dSMatthew G Knepley       }
538bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
5392a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
5400298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
541bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
5420298fd71SBarry Smith       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
543ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
544ed1f0337SMatthew G Knepley       if (sp) {
545ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
546ed1f0337SMatthew G Knepley       }
547704ba839SBarry Smith       ilink = ilink->next;
548cf502942SBarry Smith     }
549bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
55097bbdb24SBarry Smith   } else {
551cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
552a3df900dSMatthew G Knepley       Mat pmat;
553a3df900dSMatthew G Knepley 
554a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
555a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
556a3df900dSMatthew G Knepley       if (!pmat) {
5575f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
558a3df900dSMatthew G Knepley       }
559704ba839SBarry Smith       ilink = ilink->next;
560cf502942SBarry Smith     }
56197bbdb24SBarry Smith   }
5624e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
563519d70e2SJed Brown     ilink = jac->head;
564519d70e2SJed Brown     if (!jac->mat) {
565785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
566519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5675f4ab4e1SJungho Lee         ierr  = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
568519d70e2SJed Brown         ilink = ilink->next;
569519d70e2SJed Brown       }
570519d70e2SJed Brown     } else {
571519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5725f4ab4e1SJungho Lee         if (jac->mat[i]) {ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);}
573519d70e2SJed Brown         ilink = ilink->next;
574519d70e2SJed Brown       }
575519d70e2SJed Brown     }
576519d70e2SJed Brown   } else {
577519d70e2SJed Brown     jac->mat = jac->pmat;
578519d70e2SJed Brown   }
57997bbdb24SBarry Smith 
58053935eafSBarry Smith   /* Check for null space attached to IS */
58153935eafSBarry Smith   ilink = jac->head;
58253935eafSBarry Smith   for (i=0; i<nsplit; i++) {
58353935eafSBarry Smith     MatNullSpace sp;
58453935eafSBarry Smith 
58553935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
58653935eafSBarry Smith     if (sp) {
58753935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
58853935eafSBarry Smith     }
58953935eafSBarry Smith     ilink = ilink->next;
59053935eafSBarry Smith   }
59153935eafSBarry Smith 
5926c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
59368dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
5944e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
59568dd23aaSBarry Smith     ilink = jac->head;
596e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
597e52d2c62SBarry 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 */
598e52d2c62SBarry Smith       if (!jac->Afield) {
599e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
60080c96bb1SFande Kong         if (jac->offdiag_use_amat) {
601e52d2c62SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
602e52d2c62SBarry Smith         } else {
60380c96bb1SFande Kong           ierr  = MatGetSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
60480c96bb1SFande Kong         }
60580c96bb1SFande Kong       } else {
60680c96bb1SFande Kong         if (jac->offdiag_use_amat) {
607e52d2c62SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
60880c96bb1SFande Kong         } else {
60980c96bb1SFande Kong           ierr  = MatGetSubMatrix(pc->pmat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
61080c96bb1SFande Kong         }
611e52d2c62SBarry Smith       }
612e52d2c62SBarry Smith     } else {
61368dd23aaSBarry Smith       if (!jac->Afield) {
614785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
61568dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
61680c96bb1SFande Kong           if (jac->offdiag_use_amat) {
6170298fd71SBarry Smith             ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
61880c96bb1SFande Kong           } else {
61980c96bb1SFande Kong             ierr  = MatGetSubMatrix(pc->pmat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
62080c96bb1SFande Kong           }
62168dd23aaSBarry Smith           ilink = ilink->next;
62268dd23aaSBarry Smith         }
62368dd23aaSBarry Smith       } else {
62468dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
62580c96bb1SFande Kong           if (jac->offdiag_use_amat) {
6260298fd71SBarry Smith             ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
62780c96bb1SFande Kong           } else {
62880c96bb1SFande Kong             ierr  = MatGetSubMatrix(pc->pmat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
62980c96bb1SFande Kong           }
63068dd23aaSBarry Smith           ilink = ilink->next;
63168dd23aaSBarry Smith         }
63268dd23aaSBarry Smith       }
63368dd23aaSBarry Smith     }
634e52d2c62SBarry Smith   }
63568dd23aaSBarry Smith 
6363b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
6373b224e63SBarry Smith     IS          ccis;
6384aa3045dSJed Brown     PetscInt    rstart,rend;
639093c86ffSJed Brown     char        lscname[256];
640093c86ffSJed Brown     PetscObject LSC_L;
641ce94432eSBarry Smith 
642ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
64368dd23aaSBarry Smith 
644e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
645e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
646e6cab6aaSJed Brown 
6473b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
6483b224e63SBarry Smith     if (jac->schur) {
6490298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
650443836d0SMatthew G Knepley 
651fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
6523b224e63SBarry Smith       ilink = jac->head;
65349bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6544e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6554aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
656c84da90fSDmitry Karpeev       } else {
657df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
658c84da90fSDmitry Karpeev       }
659fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6603b224e63SBarry Smith       ilink = ilink->next;
66149bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6624e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6634aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
664c84da90fSDmitry Karpeev       } else {
665df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
666c84da90fSDmitry Karpeev       }
667fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
668aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
669a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
670a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
671a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
672a7476a74SDmitry Karpeev       }
673443836d0SMatthew G Knepley       if (kspA != kspInner) {
67423ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
675443836d0SMatthew G Knepley       }
676443836d0SMatthew G Knepley       if (kspUpper != kspA) {
67723ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
678443836d0SMatthew G Knepley       }
67923ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
6803b224e63SBarry Smith     } else {
681bafc1b83SMatthew G Knepley       const char   *Dprefix;
682470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
683514bf10dSMatthew G Knepley       char         schurtestoption[256];
684bdddcaaaSMatthew G Knepley       MatNullSpace sp;
685514bf10dSMatthew G Knepley       PetscBool    flg;
6863b224e63SBarry Smith 
687a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
6883b224e63SBarry Smith       ilink = jac->head;
68949bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6904e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6914aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
692c84da90fSDmitry Karpeev       } else {
693df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
694c84da90fSDmitry Karpeev       }
695fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6963b224e63SBarry Smith       ilink = ilink->next;
69749bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6984e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6994aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
700c84da90fSDmitry Karpeev       } else {
701df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
702c84da90fSDmitry Karpeev       }
703fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
70420252d06SBarry Smith 
705f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
70620252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
70720252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
708bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
709470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
710470b340bSDmitry Karpeev       /* Note that the inner KSP is NOT going to inherit this prefix, and if it did, it would be reset just below.  Is that what we want? */
711470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
712470b340bSDmitry Karpeev       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
713895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
71420252d06SBarry Smith       if (sp) {
71520252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
71620252d06SBarry Smith       }
71720252d06SBarry Smith 
71820252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
719c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
720514bf10dSMatthew G Knepley       if (flg) {
721514bf10dSMatthew G Knepley         DM  dmInner;
72221635b76SJed Brown         KSP kspInner;
72321635b76SJed Brown 
72421635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
72521635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
72621635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
72721635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
72821635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
729514bf10dSMatthew G Knepley 
730514bf10dSMatthew G Knepley         /* Set DM for new solver */
731bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
73221635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
73321635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
734514bf10dSMatthew G Knepley       } else {
73521635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
73621635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
73721635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
73821635b76SJed 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
73921635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
74021635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
74121635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
742514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
743bafc1b83SMatthew G Knepley       }
74423ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
7455a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
74697bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
74797bbdb24SBarry Smith 
748443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
749c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
750443836d0SMatthew G Knepley       if (flg) {
751443836d0SMatthew G Knepley         DM dmInner;
752443836d0SMatthew G Knepley 
753443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
75482f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
755422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
756443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
757443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
758443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
759443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
760443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
76123ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
762443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
763443836d0SMatthew G Knepley       } else {
764443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
765443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
766443836d0SMatthew G Knepley       }
767443836d0SMatthew G Knepley 
768a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
769a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
770a7476a74SDmitry Karpeev       }
771ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
772422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
77397bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
77420252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
77597bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
7767233a360SDmitry Karpeev         PC pcschur;
7777233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
7787233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
77997bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
780e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
781e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
78297bbdb24SBarry Smith       }
78323ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
78497bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
78597bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
786b20b4189SMatthew G. Knepley       /* propogate DM */
787b20b4189SMatthew G. Knepley       {
788b20b4189SMatthew G. Knepley         DM sdm;
789b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
790b20b4189SMatthew G. Knepley         if (sdm) {
791b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
792b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
793b20b4189SMatthew G. Knepley         }
794b20b4189SMatthew G. Knepley       }
79597bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
79697bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
79797bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
79897bbdb24SBarry Smith     }
79997bbdb24SBarry Smith 
8005a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
8018caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
802519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8033b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
804c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
8058caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
80697bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8075a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
8080971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
80997bbdb24SBarry Smith   } else {
81068bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
8110971522cSBarry Smith     i     = 0;
8120971522cSBarry Smith     ilink = jac->head;
8130971522cSBarry Smith     while (ilink) {
81423ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
8150971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
8160971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
8170971522cSBarry Smith       i++;
8180971522cSBarry Smith       ilink = ilink->next;
8190971522cSBarry Smith     }
8203b224e63SBarry Smith   }
8213b224e63SBarry Smith 
822c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
8230971522cSBarry Smith   PetscFunctionReturn(0);
8240971522cSBarry Smith }
8250971522cSBarry Smith 
8265a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
827ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
828ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
8299df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
8305a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) ||                               \
8319df09d43SBarry Smith    PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL) ||\
832ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) ||  \
833ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
83479416396SBarry Smith 
8353b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
8363b224e63SBarry Smith {
8373b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
8383b224e63SBarry Smith   PetscErrorCode    ierr;
8393b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
840443836d0SMatthew G Knepley   KSP               kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
8413b224e63SBarry Smith 
8423b224e63SBarry Smith   PetscFunctionBegin;
843c5d2311dSJed Brown   switch (jac->schurfactorization) {
844c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
845a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
846c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
847c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
848c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8499df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
850443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8519df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
852c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
853c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8549df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
855c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8569df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
857c5d2311dSJed Brown     ierr = VecScale(ilinkD->y,-1.);CHKERRQ(ierr);
858c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
859c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
860c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
861c5d2311dSJed Brown     break;
862c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
863a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
864c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
865c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8669df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
867443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8689df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
869c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
870c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
871c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
872c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
873c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8749df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
875c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8769df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
877c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
878c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
879c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
880c5d2311dSJed Brown     break;
881c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
882a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
883c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
884c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8859df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
886c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8879df09d43SBarry 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);
888c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
889c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
890c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
891c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8929df09d43SBarry Smith     ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
893443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8949df09d43SBarry Smith     ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
895c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
896c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
897c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
898c5d2311dSJed Brown     break;
899c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
900a04f6461SBarry Smith     /* [1 0; A10 A00^{-1} 1] [A00 0; 0 S] [1 A00^{-1}A01; 0 1], an exact solve if applied exactly, needs one extra solve with A */
9013b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9023b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9039df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
904443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9059df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_L,kspLower,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
9063b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
9073b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
9083b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9093b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9103b224e63SBarry Smith 
9119df09d43SBarry Smith     ierr = PetscLogEventBegin(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
9123b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9139df09d43SBarry Smith     ierr = PetscLogEventEnd(KSP_Solve_FS_S,jac->kspschur,ilinkD->x,ilinkD->y,NULL);CHKERRQ(ierr);
9143b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9153b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9163b224e63SBarry Smith 
917443836d0SMatthew G Knepley     if (kspUpper == kspA) {
9183b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
9193b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
9209df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
921443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9229df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
923443836d0SMatthew G Knepley     } else {
9249df09d43SBarry Smith       ierr = PetscLogEventBegin(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
925443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9269df09d43SBarry Smith       ierr = PetscLogEventEnd(ilinkA->event,kspA,ilinkA->x,ilinkA->y,NULL);CHKERRQ(ierr);
927443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
9289df09d43SBarry Smith       ierr = PetscLogEventBegin(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
929443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
9309df09d43SBarry Smith       ierr = PetscLogEventEnd(KSP_Solve_FS_U,kspUpper,ilinkA->x,ilinkA->z,NULL);CHKERRQ(ierr);
931443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
932443836d0SMatthew G Knepley     }
9333b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9343b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
935c5d2311dSJed Brown   }
9363b224e63SBarry Smith   PetscFunctionReturn(0);
9373b224e63SBarry Smith }
9383b224e63SBarry Smith 
9390971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
9400971522cSBarry Smith {
9410971522cSBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
9420971522cSBarry Smith   PetscErrorCode     ierr;
9435a9f2f41SSatish Balay   PC_FieldSplitLink  ilink = jac->head;
944939b8a20SBarry Smith   PetscInt           cnt,bs;
945568ed31eSHong Zhang   KSPConvergedReason reason;
9460971522cSBarry Smith 
9470971522cSBarry Smith   PetscFunctionBegin;
94879416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
9491b9fc7fcSBarry Smith     if (jac->defaultsplit) {
950939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
951ce94432eSBarry 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);
952939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
953ce94432eSBarry 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);
9540971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
9555a9f2f41SSatish Balay       while (ilink) {
9569df09d43SBarry Smith         ierr  = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
9575a9f2f41SSatish Balay         ierr  = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9589df09d43SBarry Smith         ierr  = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
959568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
960568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
961568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
962568ed31eSHong Zhang         }
9635a9f2f41SSatish Balay         ilink = ilink->next;
9640971522cSBarry Smith       }
9650971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
9661b9fc7fcSBarry Smith     } else {
967efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
9685a9f2f41SSatish Balay       while (ilink) {
9695a9f2f41SSatish Balay         ierr  = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
970568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
971568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
972568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
973568ed31eSHong Zhang         }
9745a9f2f41SSatish Balay         ilink = ilink->next;
9751b9fc7fcSBarry Smith       }
9761b9fc7fcSBarry Smith     }
977e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
978e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
979e52d2c62SBarry Smith     /* solve on first block for first block variables */
980e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
981e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9829df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
983e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9849df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
985568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
986568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
987568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
988568ed31eSHong Zhang     }
989e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
990e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
991e52d2c62SBarry Smith 
992e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
993e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
994e52d2c62SBarry Smith     ilink = ilink->next;
995e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
996e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
997e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
998e52d2c62SBarry Smith 
999e52d2c62SBarry Smith     /* solve on second block variables */
10009df09d43SBarry Smith     ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1001e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10029df09d43SBarry Smith     ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1003568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1004568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1005568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1006568ed31eSHong Zhang     }
1007e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
1008e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
100916913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
101079416396SBarry Smith     if (!jac->w1) {
101179416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
101279416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
101379416396SBarry Smith     }
1014efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
10155a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
1016568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1017568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1018568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1019568ed31eSHong Zhang     }
10203e197d65SBarry Smith     cnt  = 1;
10215a9f2f41SSatish Balay     while (ilink->next) {
10225a9f2f41SSatish Balay       ilink = ilink->next;
10233e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
10243e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
10253e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
10263e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10273e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10289df09d43SBarry Smith       ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10293e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10309df09d43SBarry Smith       ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10312618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
10322618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
10332618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
10342618eb8fSHong Zhang       }
10353e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10363e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10373e197d65SBarry Smith     }
103851f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
103911755939SBarry Smith       cnt -= 2;
104051f519a2SBarry Smith       while (ilink->previous) {
104151f519a2SBarry Smith         ilink = ilink->previous;
104211755939SBarry Smith         /* compute the residual only over the part of the vector needed */
104311755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
104411755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
104511755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
104611755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10479df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
104811755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10499df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1050568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1051568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1052568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
1053568ed31eSHong Zhang         }
105411755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
105511755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
105651f519a2SBarry Smith       }
105711755939SBarry Smith     }
1058ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
10590971522cSBarry Smith   PetscFunctionReturn(0);
10600971522cSBarry Smith }
10610971522cSBarry Smith 
1062421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1063ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1064ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
10659df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1066421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) ||                  \
10679df09d43SBarry Smith    PetscLogEventBegin(ilink->event,ilink->ksp,ilink->y,ilink->x,NULL) || \
1068ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1069ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1070421e10b8SBarry Smith 
1071421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1072421e10b8SBarry Smith {
1073421e10b8SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1074421e10b8SBarry Smith   PetscErrorCode     ierr;
1075421e10b8SBarry Smith   PC_FieldSplitLink  ilink = jac->head;
1076939b8a20SBarry Smith   PetscInt           bs;
1077291dd214SHong Zhang   KSPConvergedReason reason;
1078421e10b8SBarry Smith 
1079421e10b8SBarry Smith   PetscFunctionBegin;
1080421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1081421e10b8SBarry Smith     if (jac->defaultsplit) {
1082939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1083ce94432eSBarry 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);
1084939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1085ce94432eSBarry 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);
1086421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1087421e10b8SBarry Smith       while (ilink) {
10889df09d43SBarry Smith         ierr = PetscLogEventBegin(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
1089421e10b8SBarry Smith         ierr  = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10909df09d43SBarry Smith         ierr = PetscLogEventEnd(ilink->event,ilink->ksp,ilink->x,ilink->y,NULL);CHKERRQ(ierr);
10912618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
10922618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
10932618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
10942618eb8fSHong Zhang         }
1095421e10b8SBarry Smith         ilink = ilink->next;
1096421e10b8SBarry Smith       }
1097421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1098421e10b8SBarry Smith     } else {
1099421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1100421e10b8SBarry Smith       while (ilink) {
1101421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11022618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11032618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11042618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
11052618eb8fSHong Zhang         }
1106421e10b8SBarry Smith         ilink = ilink->next;
1107421e10b8SBarry Smith       }
1108421e10b8SBarry Smith     }
1109421e10b8SBarry Smith   } else {
1110421e10b8SBarry Smith     if (!jac->w1) {
1111421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1112421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1113421e10b8SBarry Smith     }
1114421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1115421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1116421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11172618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11182618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11192618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11202618eb8fSHong Zhang       }
1121421e10b8SBarry Smith       while (ilink->next) {
1122421e10b8SBarry Smith         ilink = ilink->next;
11239989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1124421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1125421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1126421e10b8SBarry Smith       }
1127421e10b8SBarry Smith       while (ilink->previous) {
1128421e10b8SBarry Smith         ilink = ilink->previous;
11299989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1130421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1131421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1132421e10b8SBarry Smith       }
1133421e10b8SBarry Smith     } else {
1134421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1135421e10b8SBarry Smith         ilink = ilink->next;
1136421e10b8SBarry Smith       }
1137421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11382618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11392618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11402618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11412618eb8fSHong Zhang       }
1142421e10b8SBarry Smith       while (ilink->previous) {
1143421e10b8SBarry Smith         ilink = ilink->previous;
11449989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1145421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1146421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1147421e10b8SBarry Smith       }
1148421e10b8SBarry Smith     }
1149421e10b8SBarry Smith   }
1150421e10b8SBarry Smith   PetscFunctionReturn(0);
1151421e10b8SBarry Smith }
1152421e10b8SBarry Smith 
1153574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
11540971522cSBarry Smith {
11550971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
11560971522cSBarry Smith   PetscErrorCode    ierr;
11575a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
11580971522cSBarry Smith 
11590971522cSBarry Smith   PetscFunctionBegin;
11605a9f2f41SSatish Balay   while (ilink) {
1161f5f0d762SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1162fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1163fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1164443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1165fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1166fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1167b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1168f5f0d762SBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1169f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
1170f5f0d762SBarry Smith     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
11715a9f2f41SSatish Balay     next  = ilink->next;
1172f5f0d762SBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
11735a9f2f41SSatish Balay     ilink = next;
11740971522cSBarry Smith   }
1175f5f0d762SBarry Smith   jac->head = NULL;
117605b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1177574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1178574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1179574deadeSBarry Smith   } else if (jac->mat) {
11800298fd71SBarry Smith     jac->mat = NULL;
1181574deadeSBarry Smith   }
118297bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
118368dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
1184f5f0d762SBarry Smith   jac->nsplits = 0;
11856bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
11866bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
11876bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1188a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
11896bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
11906bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1191d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
11926bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
11936bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
11946dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1195574deadeSBarry Smith   PetscFunctionReturn(0);
1196574deadeSBarry Smith }
1197574deadeSBarry Smith 
1198574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1199574deadeSBarry Smith {
1200574deadeSBarry Smith   PetscErrorCode    ierr;
1201574deadeSBarry Smith 
1202574deadeSBarry Smith   PetscFunctionBegin;
1203574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1204c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1205bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1206bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1207bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1208bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1209bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
121029f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
121137a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1212bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
12136dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr);
12140971522cSBarry Smith   PetscFunctionReturn(0);
12150971522cSBarry Smith }
12160971522cSBarry Smith 
12174416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
12180971522cSBarry Smith {
12191b9fc7fcSBarry Smith   PetscErrorCode  ierr;
12206c924f48SJed Brown   PetscInt        bs;
1221bc59fbc5SBarry Smith   PetscBool       flg,stokes = PETSC_FALSE;
12229dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
12233b224e63SBarry Smith   PCCompositeType ctype;
12241b9fc7fcSBarry Smith 
12250971522cSBarry Smith   PetscFunctionBegin;
1226e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
12274ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
122851f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
122951f519a2SBarry Smith   if (flg) {
123051f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
123151f519a2SBarry Smith   }
12322686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
12332686e3e9SMatthew 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);
12342686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
12352686e3e9SMatthew 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);
123600216929SDmitry Karpeev   /* FIXME: No programmatic equivalent to the following. */
1237c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
1238c0adfefeSBarry Smith   if (stokes) {
1239c0adfefeSBarry Smith     ierr          = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
1240c0adfefeSBarry Smith     jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF;
1241c0adfefeSBarry Smith   }
1242c0adfefeSBarry Smith 
12433b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
12443b224e63SBarry Smith   if (flg) {
12453b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
12463b224e63SBarry Smith   }
1247c30613efSMatthew Knepley   /* Only setup fields once */
1248c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1249d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1250d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
12516c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
12526c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1253d32f9abdSBarry Smith   }
1254c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1255c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1256c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
12570298fd71SBarry 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);
125829f8a81cSJed 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);
1259c5d2311dSJed Brown   }
12601b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
12610971522cSBarry Smith   PetscFunctionReturn(0);
12620971522cSBarry Smith }
12630971522cSBarry Smith 
12640971522cSBarry Smith /*------------------------------------------------------------------------------------*/
12650971522cSBarry Smith 
12661e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
12670971522cSBarry Smith {
126897bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
12690971522cSBarry Smith   PetscErrorCode    ierr;
12705a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
127169a612a9SBarry Smith   char              prefix[128];
12725d4c12cdSJungho Lee   PetscInt          i;
12730971522cSBarry Smith 
12740971522cSBarry Smith   PetscFunctionBegin;
12756c924f48SJed Brown   if (jac->splitdefined) {
12766c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
12776c924f48SJed Brown     PetscFunctionReturn(0);
12786c924f48SJed Brown   }
127951f519a2SBarry Smith   for (i=0; i<n; i++) {
1280e32f2f54SBarry 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);
1281e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
128251f519a2SBarry Smith   }
1283b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1284a04f6461SBarry Smith   if (splitname) {
1285db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1286a04f6461SBarry Smith   } else {
1287785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1288a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1289a04f6461SBarry Smith   }
12909df09d43SBarry 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 */
1291785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
12925a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
1293785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
12945d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
12952fa5cd67SKarl Rupp 
12965a9f2f41SSatish Balay   ilink->nfields = n;
12970298fd71SBarry Smith   ilink->next    = NULL;
1298ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1299422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
130020252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
13015a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
13029005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
130369a612a9SBarry Smith 
13048caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
13055a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
13060971522cSBarry Smith 
13070971522cSBarry Smith   if (!next) {
13085a9f2f41SSatish Balay     jac->head       = ilink;
13090298fd71SBarry Smith     ilink->previous = NULL;
13100971522cSBarry Smith   } else {
13110971522cSBarry Smith     while (next->next) {
13120971522cSBarry Smith       next = next->next;
13130971522cSBarry Smith     }
13145a9f2f41SSatish Balay     next->next      = ilink;
131551f519a2SBarry Smith     ilink->previous = next;
13160971522cSBarry Smith   }
13170971522cSBarry Smith   jac->nsplits++;
13180971522cSBarry Smith   PetscFunctionReturn(0);
13190971522cSBarry Smith }
13200971522cSBarry Smith 
13211e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1322e69d4d44SBarry Smith {
1323e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1324e69d4d44SBarry Smith   PetscErrorCode ierr;
1325e69d4d44SBarry Smith 
1326e69d4d44SBarry Smith   PetscFunctionBegin;
132734a3b412SBarry Smith   if (!jac->schur) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call KSPSetUp() or PCSetUp() before calling PCFieldSplitGetSubKSP()");
1328785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1329e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
13302fa5cd67SKarl Rupp 
1331e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
133213e0d083SBarry Smith   if (n) *n = jac->nsplits;
1333e69d4d44SBarry Smith   PetscFunctionReturn(0);
1334e69d4d44SBarry Smith }
13350971522cSBarry Smith 
13361e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
13370971522cSBarry Smith {
13380971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13390971522cSBarry Smith   PetscErrorCode    ierr;
13400971522cSBarry Smith   PetscInt          cnt   = 0;
13415a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
13420971522cSBarry Smith 
13430971522cSBarry Smith   PetscFunctionBegin;
1344785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
13455a9f2f41SSatish Balay   while (ilink) {
13465a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
13475a9f2f41SSatish Balay     ilink            = ilink->next;
13480971522cSBarry Smith   }
13495d480477SMatthew 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);
135013e0d083SBarry Smith   if (n) *n = jac->nsplits;
13510971522cSBarry Smith   PetscFunctionReturn(0);
13520971522cSBarry Smith }
13530971522cSBarry Smith 
13546dbb499eSCian Wilson /*@C
13556dbb499eSCian Wilson     PCFieldSplitRestrictIS - Restricts the fieldsplit ISs to be within a given IS.
13566dbb499eSCian Wilson 
13576dbb499eSCian Wilson     Input Parameters:
13586dbb499eSCian Wilson +   pc  - the preconditioner context
13596dbb499eSCian Wilson +   is - the index set that defines the indices to which the fieldsplit is to be restricted
13606dbb499eSCian Wilson 
13616dbb499eSCian Wilson     Level: advanced
13626dbb499eSCian Wilson 
13636dbb499eSCian Wilson @*/
13646dbb499eSCian Wilson PetscErrorCode  PCFieldSplitRestrictIS(PC pc,IS isy)
13656dbb499eSCian Wilson {
13666dbb499eSCian Wilson   PetscErrorCode ierr;
13676dbb499eSCian Wilson 
13686dbb499eSCian Wilson   PetscFunctionBegin;
13696dbb499eSCian Wilson   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
13706dbb499eSCian Wilson   PetscValidHeaderSpecific(isy,IS_CLASSID,2);
13710246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr);
13726dbb499eSCian Wilson   PetscFunctionReturn(0);
13736dbb499eSCian Wilson }
13746dbb499eSCian Wilson 
13756dbb499eSCian Wilson 
13766dbb499eSCian Wilson static PetscErrorCode  PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
13776dbb499eSCian Wilson {
13786dbb499eSCian Wilson   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13796dbb499eSCian Wilson   PetscErrorCode    ierr;
13806dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
13816dbb499eSCian Wilson   PetscInt          localsize,size,sizez,i;
13826dbb499eSCian Wilson   const PetscInt    *ind, *indz;
13836dbb499eSCian Wilson   PetscInt          *indc, *indcz;
13846dbb499eSCian Wilson   PetscBool         flg;
13856dbb499eSCian Wilson 
13866dbb499eSCian Wilson   PetscFunctionBegin;
13876dbb499eSCian Wilson   ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr);
13886dbb499eSCian Wilson   ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr);
13896dbb499eSCian Wilson   size -= localsize;
13906dbb499eSCian Wilson   while(ilink) {
13916dbb499eSCian Wilson     IS isrl,isr;
13921c7cfba8SBarry Smith     PC subpc;
13936dbb499eSCian Wilson     ierr          = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
13946dbb499eSCian Wilson     ierr          = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr);
13956dbb499eSCian Wilson     ierr          = PetscMalloc1(localsize,&indc);CHKERRQ(ierr);
13966dbb499eSCian Wilson     ierr          = ISGetIndices(isrl,&ind);CHKERRQ(ierr);
13976dbb499eSCian Wilson     ierr          = PetscMemcpy(indc,ind,localsize*sizeof(PetscInt));CHKERRQ(ierr);
13986dbb499eSCian Wilson     ierr          = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr);
13996dbb499eSCian Wilson     ierr          = ISDestroy(&isrl);CHKERRQ(ierr);
14006dbb499eSCian Wilson     for (i=0; i<localsize; i++) *(indc+i) += size;
14016dbb499eSCian Wilson     ierr          = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr);
14026dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14036dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
14046dbb499eSCian Wilson     ilink->is     = isr;
14056dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14066dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
14076dbb499eSCian Wilson     ilink->is_col = isr;
14086dbb499eSCian Wilson     ierr          = ISDestroy(&isr);CHKERRQ(ierr);
14096dbb499eSCian Wilson     ierr          = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr);
14106dbb499eSCian Wilson     ierr          = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr);
14116dbb499eSCian Wilson     if(flg) {
14126dbb499eSCian Wilson       IS iszl,isz;
14136dbb499eSCian Wilson       MPI_Comm comm;
14146dbb499eSCian Wilson       ierr   = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr);
14156dbb499eSCian Wilson       comm   = PetscObjectComm((PetscObject)ilink->is);
14166dbb499eSCian Wilson       ierr   = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr);
14176dbb499eSCian Wilson       ierr   = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr);
14186dbb499eSCian Wilson       sizez -= localsize;
14196dbb499eSCian Wilson       ierr   = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr);
14206dbb499eSCian Wilson       ierr   = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr);
14216dbb499eSCian Wilson       ierr   = ISGetIndices(iszl,&indz);CHKERRQ(ierr);
14226dbb499eSCian Wilson       ierr   = PetscMemcpy(indcz,indz,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14236dbb499eSCian Wilson       ierr   = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr);
14246dbb499eSCian Wilson       ierr   = ISDestroy(&iszl);CHKERRQ(ierr);
14256dbb499eSCian Wilson       for (i=0; i<localsize; i++) *(indcz+i) += sizez;
14266dbb499eSCian Wilson       ierr   = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr);
14276dbb499eSCian Wilson       ierr   = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr);
14286dbb499eSCian Wilson       ierr   = ISDestroy(&isz);CHKERRQ(ierr);
14296dbb499eSCian Wilson     }
14306dbb499eSCian Wilson     next = ilink->next;
14316dbb499eSCian Wilson     ilink = next;
14326dbb499eSCian Wilson   }
14336dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
14346dbb499eSCian Wilson   PetscFunctionReturn(0);
14356dbb499eSCian Wilson }
14366dbb499eSCian Wilson 
14371e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1438704ba839SBarry Smith {
1439704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1440704ba839SBarry Smith   PetscErrorCode    ierr;
1441704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1442704ba839SBarry Smith   char              prefix[128];
1443704ba839SBarry Smith 
1444704ba839SBarry Smith   PetscFunctionBegin;
14456c924f48SJed Brown   if (jac->splitdefined) {
14466c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
14476c924f48SJed Brown     PetscFunctionReturn(0);
14486c924f48SJed Brown   }
1449b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1450a04f6461SBarry Smith   if (splitname) {
1451db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1452a04f6461SBarry Smith   } else {
1453785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1454b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1455a04f6461SBarry Smith   }
14569df09d43SBarry 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 */
14571ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1458b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1459b5787286SJed Brown   ilink->is     = is;
1460b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1461b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1462b5787286SJed Brown   ilink->is_col = is;
14630298fd71SBarry Smith   ilink->next   = NULL;
1464ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1465422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
146620252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1467704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
14689005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1469704ba839SBarry Smith 
14708caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1471704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1472704ba839SBarry Smith 
1473704ba839SBarry Smith   if (!next) {
1474704ba839SBarry Smith     jac->head       = ilink;
14750298fd71SBarry Smith     ilink->previous = NULL;
1476704ba839SBarry Smith   } else {
1477704ba839SBarry Smith     while (next->next) {
1478704ba839SBarry Smith       next = next->next;
1479704ba839SBarry Smith     }
1480704ba839SBarry Smith     next->next      = ilink;
1481704ba839SBarry Smith     ilink->previous = next;
1482704ba839SBarry Smith   }
1483704ba839SBarry Smith   jac->nsplits++;
1484704ba839SBarry Smith   PetscFunctionReturn(0);
1485704ba839SBarry Smith }
1486704ba839SBarry Smith 
14870971522cSBarry Smith /*@
14880971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
14890971522cSBarry Smith 
1490ad4df100SBarry Smith     Logically Collective on PC
14910971522cSBarry Smith 
14920971522cSBarry Smith     Input Parameters:
14930971522cSBarry Smith +   pc  - the preconditioner context
14940298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
14950971522cSBarry Smith .   n - the number of fields in this split
1496db4c96c1SJed Brown -   fields - the fields in this split
14970971522cSBarry Smith 
14980971522cSBarry Smith     Level: intermediate
14990971522cSBarry Smith 
1500d32f9abdSBarry Smith     Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1501d32f9abdSBarry Smith 
15027287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1503d32f9abdSBarry 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
1504d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1505d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1506d32f9abdSBarry Smith 
1507db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1508db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1509db4c96c1SJed Brown 
15105d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
15115d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
15125d4c12cdSJungho Lee      available when this routine is called.
15135d4c12cdSJungho Lee 
1514d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
15150971522cSBarry Smith 
15160971522cSBarry Smith @*/
15175d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
15180971522cSBarry Smith {
15194ac538c5SBarry Smith   PetscErrorCode ierr;
15200971522cSBarry Smith 
15210971522cSBarry Smith   PetscFunctionBegin;
15220700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1523db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1524ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1525db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
15260246f55cSBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
15270971522cSBarry Smith   PetscFunctionReturn(0);
15280971522cSBarry Smith }
15290971522cSBarry Smith 
1530c84da90fSDmitry Karpeev /*@
1531c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1532c84da90fSDmitry Karpeev 
1533c84da90fSDmitry Karpeev     Logically Collective on PC
1534c84da90fSDmitry Karpeev 
1535c84da90fSDmitry Karpeev     Input Parameters:
1536c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1537c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1538c84da90fSDmitry Karpeev 
15399506b623SDmitry Karpeev     Options Database:
15409506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1541c84da90fSDmitry Karpeev 
1542c84da90fSDmitry Karpeev     Level: intermediate
1543c84da90fSDmitry Karpeev 
1544c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1545c84da90fSDmitry Karpeev 
1546c84da90fSDmitry Karpeev @*/
1547c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1548c84da90fSDmitry Karpeev {
1549c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1550c84da90fSDmitry Karpeev   PetscBool      isfs;
1551c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1552c84da90fSDmitry Karpeev 
1553c84da90fSDmitry Karpeev   PetscFunctionBegin;
1554c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1555c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1556c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1557c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1558c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1559c84da90fSDmitry Karpeev }
1560c84da90fSDmitry Karpeev 
1561c84da90fSDmitry Karpeev /*@
1562c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1563c84da90fSDmitry Karpeev 
1564c84da90fSDmitry Karpeev     Logically Collective on PC
1565c84da90fSDmitry Karpeev 
1566c84da90fSDmitry Karpeev     Input Parameters:
1567c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1568c84da90fSDmitry Karpeev 
1569c84da90fSDmitry Karpeev     Output Parameters:
1570c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1571c84da90fSDmitry Karpeev 
1572c84da90fSDmitry Karpeev 
1573c84da90fSDmitry Karpeev     Level: intermediate
1574c84da90fSDmitry Karpeev 
1575c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1576c84da90fSDmitry Karpeev 
1577c84da90fSDmitry Karpeev @*/
1578c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1579c84da90fSDmitry Karpeev {
1580c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1581c84da90fSDmitry Karpeev   PetscBool      isfs;
1582c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1583c84da90fSDmitry Karpeev 
1584c84da90fSDmitry Karpeev   PetscFunctionBegin;
1585c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1586c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1587c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1588c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1589c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1590c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1591c84da90fSDmitry Karpeev }
1592c84da90fSDmitry Karpeev 
1593c84da90fSDmitry Karpeev /*@
1594c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1595c84da90fSDmitry Karpeev 
1596c84da90fSDmitry Karpeev     Logically Collective on PC
1597c84da90fSDmitry Karpeev 
1598c84da90fSDmitry Karpeev     Input Parameters:
1599c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1600c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1601c84da90fSDmitry Karpeev 
16029506b623SDmitry Karpeev     Options Database:
16039506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
1604c84da90fSDmitry Karpeev 
1605c84da90fSDmitry Karpeev     Level: intermediate
1606c84da90fSDmitry Karpeev 
1607c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
1608c84da90fSDmitry Karpeev 
1609c84da90fSDmitry Karpeev @*/
1610c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
1611c84da90fSDmitry Karpeev {
1612c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1613c84da90fSDmitry Karpeev   PetscBool      isfs;
1614c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1615c84da90fSDmitry Karpeev 
1616c84da90fSDmitry Karpeev   PetscFunctionBegin;
1617c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1618c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1619c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1620c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
1621c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1622c84da90fSDmitry Karpeev }
1623c84da90fSDmitry Karpeev 
1624c84da90fSDmitry Karpeev /*@
1625c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1626c84da90fSDmitry Karpeev 
1627c84da90fSDmitry Karpeev     Logically Collective on PC
1628c84da90fSDmitry Karpeev 
1629c84da90fSDmitry Karpeev     Input Parameters:
1630c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1631c84da90fSDmitry Karpeev 
1632c84da90fSDmitry Karpeev     Output Parameters:
1633c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1634c84da90fSDmitry Karpeev 
1635c84da90fSDmitry Karpeev 
1636c84da90fSDmitry Karpeev     Level: intermediate
1637c84da90fSDmitry Karpeev 
1638c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
1639c84da90fSDmitry Karpeev 
1640c84da90fSDmitry Karpeev @*/
1641c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
1642c84da90fSDmitry Karpeev {
1643c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1644c84da90fSDmitry Karpeev   PetscBool      isfs;
1645c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1646c84da90fSDmitry Karpeev 
1647c84da90fSDmitry Karpeev   PetscFunctionBegin;
1648c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1649c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1650c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1651c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1652c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
1653c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1654c84da90fSDmitry Karpeev }
1655c84da90fSDmitry Karpeev 
1656c84da90fSDmitry Karpeev 
1657c84da90fSDmitry Karpeev 
1658218d4943SBarry Smith /*@C
1659704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1660704ba839SBarry Smith 
1661ad4df100SBarry Smith     Logically Collective on PC
1662704ba839SBarry Smith 
1663704ba839SBarry Smith     Input Parameters:
1664704ba839SBarry Smith +   pc  - the preconditioner context
16650298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
1666db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1667704ba839SBarry Smith 
1668d32f9abdSBarry Smith 
1669a6ffb8dbSJed Brown     Notes:
1670a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1671a6ffb8dbSJed Brown 
1672db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1673db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1674d32f9abdSBarry Smith 
1675704ba839SBarry Smith     Level: intermediate
1676704ba839SBarry Smith 
1677704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1678704ba839SBarry Smith 
1679704ba839SBarry Smith @*/
16807087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1681704ba839SBarry Smith {
16824ac538c5SBarry Smith   PetscErrorCode ierr;
1683704ba839SBarry Smith 
1684704ba839SBarry Smith   PetscFunctionBegin;
16850700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
16867b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1687db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
1688ccc738f7SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1689704ba839SBarry Smith   PetscFunctionReturn(0);
1690704ba839SBarry Smith }
1691704ba839SBarry Smith 
169257a9adfeSMatthew G Knepley /*@
169357a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
169457a9adfeSMatthew G Knepley 
169557a9adfeSMatthew G Knepley     Logically Collective on PC
169657a9adfeSMatthew G Knepley 
169757a9adfeSMatthew G Knepley     Input Parameters:
169857a9adfeSMatthew G Knepley +   pc  - the preconditioner context
169957a9adfeSMatthew G Knepley -   splitname - name of this split
170057a9adfeSMatthew G Knepley 
170157a9adfeSMatthew G Knepley     Output Parameter:
17020298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
170357a9adfeSMatthew G Knepley 
170457a9adfeSMatthew G Knepley     Level: intermediate
170557a9adfeSMatthew G Knepley 
170657a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
170757a9adfeSMatthew G Knepley 
170857a9adfeSMatthew G Knepley @*/
170957a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
171057a9adfeSMatthew G Knepley {
171157a9adfeSMatthew G Knepley   PetscErrorCode ierr;
171257a9adfeSMatthew G Knepley 
171357a9adfeSMatthew G Knepley   PetscFunctionBegin;
171457a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
171557a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
171657a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
171757a9adfeSMatthew G Knepley   {
171857a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
171957a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
172057a9adfeSMatthew G Knepley     PetscBool         found;
172157a9adfeSMatthew G Knepley 
17220298fd71SBarry Smith     *is = NULL;
172357a9adfeSMatthew G Knepley     while (ilink) {
172457a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
172557a9adfeSMatthew G Knepley       if (found) {
172657a9adfeSMatthew G Knepley         *is = ilink->is;
172757a9adfeSMatthew G Knepley         break;
172857a9adfeSMatthew G Knepley       }
172957a9adfeSMatthew G Knepley       ilink = ilink->next;
173057a9adfeSMatthew G Knepley     }
173157a9adfeSMatthew G Knepley   }
173257a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
173357a9adfeSMatthew G Knepley }
173457a9adfeSMatthew G Knepley 
173551f519a2SBarry Smith /*@
173651f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
173751f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
173851f519a2SBarry Smith 
1739ad4df100SBarry Smith     Logically Collective on PC
174051f519a2SBarry Smith 
174151f519a2SBarry Smith     Input Parameters:
174251f519a2SBarry Smith +   pc  - the preconditioner context
174351f519a2SBarry Smith -   bs - the block size
174451f519a2SBarry Smith 
174551f519a2SBarry Smith     Level: intermediate
174651f519a2SBarry Smith 
174751f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
174851f519a2SBarry Smith 
174951f519a2SBarry Smith @*/
17507087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
175151f519a2SBarry Smith {
17524ac538c5SBarry Smith   PetscErrorCode ierr;
175351f519a2SBarry Smith 
175451f519a2SBarry Smith   PetscFunctionBegin;
17550700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1756c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
17574ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
175851f519a2SBarry Smith   PetscFunctionReturn(0);
175951f519a2SBarry Smith }
176051f519a2SBarry Smith 
17610971522cSBarry Smith /*@C
176269a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
17630971522cSBarry Smith 
176469a612a9SBarry Smith    Collective on KSP
17650971522cSBarry Smith 
17660971522cSBarry Smith    Input Parameter:
17670971522cSBarry Smith .  pc - the preconditioner context
17680971522cSBarry Smith 
17690971522cSBarry Smith    Output Parameters:
177013e0d083SBarry Smith +  n - the number of splits
17713111de3cSBarry Smith -  subksp - the array of KSP contexts
17720971522cSBarry Smith 
17730971522cSBarry Smith    Note:
17749a4f7e47SBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs is to be freed by the user with PetscFree()
1775d32f9abdSBarry Smith    (not the KSP just the array that contains them).
17760971522cSBarry Smith 
177769a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
17780971522cSBarry Smith 
1779196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
17802bf68e3eSBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,PETSC_NULL_KSP,ierr) to determine how large the
1781196cc216SBarry Smith       KSP array must be.
1782196cc216SBarry Smith 
1783196cc216SBarry Smith 
17840971522cSBarry Smith    Level: advanced
17850971522cSBarry Smith 
17860971522cSBarry Smith .seealso: PCFIELDSPLIT
17870971522cSBarry Smith @*/
17887087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
17890971522cSBarry Smith {
17904ac538c5SBarry Smith   PetscErrorCode ierr;
17910971522cSBarry Smith 
17920971522cSBarry Smith   PetscFunctionBegin;
17930700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
179413e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
17954ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
17960971522cSBarry Smith   PetscFunctionReturn(0);
17970971522cSBarry Smith }
17980971522cSBarry Smith 
1799e69d4d44SBarry Smith /*@
180053f2277eSBarry Smith     PCFieldSplitSetSchurPre -  Indicates what operator is used to construct the preconditioner for the Schur complement.
1801a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1802e69d4d44SBarry Smith 
1803e69d4d44SBarry Smith     Collective on PC
1804e69d4d44SBarry Smith 
1805e69d4d44SBarry Smith     Input Parameters:
1806e69d4d44SBarry Smith +   pc      - the preconditioner context
18076fdd48a9SBarry 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
18086fdd48a9SBarry Smith               PC_FIELDSPLIT_SCHUR_PRE_SELFP, and PC_FIELDSPLIT_SCHUR_PRE_FULL
18090298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
1810084e4875SJed Brown 
1811e69d4d44SBarry Smith     Options Database:
18126fdd48a9SBarry Smith .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11. See notes for meaning of various arguments
1813e69d4d44SBarry Smith 
1814fd1303e9SJungho Lee     Notes:
1815fd1303e9SJungho Lee $    If ptype is
1816a6a584a2SBarry Smith $        a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
181753f2277eSBarry Smith $             matrix associated with the Schur complement (i.e. A11), not the Schur complement matrix
1818a6a584a2SBarry Smith $        self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
1819a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
1820fd1303e9SJungho Lee $             preconditioner
18216fdd48a9SBarry Smith $        user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
18226fdd48a9SBarry Smith $             to this function).
1823a6a584a2SBarry Smith $        selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
18241d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
18256fdd48a9SBarry Smith $             lumped before extracting the diagonal using the additional option -fieldsplit_1_mat_schur_complement_ainv_type lump
18266fdd48a9SBarry Smith $        full then the preconditioner for the Schur complement is generated from the exact Schur complement matrix representation computed internally by PFIELDSPLIT (this is expensive)
18276fdd48a9SBarry Smith $             useful mostly as a test that the Schur complement approach can work for your problem
1828fd1303e9SJungho Lee 
1829e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
1830fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1831a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
1832fd1303e9SJungho Lee 
1833e69d4d44SBarry Smith     Level: intermediate
1834e69d4d44SBarry Smith 
18351d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
18361d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
1837e69d4d44SBarry Smith 
1838e69d4d44SBarry Smith @*/
183929f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1840e69d4d44SBarry Smith {
18414ac538c5SBarry Smith   PetscErrorCode ierr;
1842e69d4d44SBarry Smith 
1843e69d4d44SBarry Smith   PetscFunctionBegin;
18440700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
184529f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1846e69d4d44SBarry Smith   PetscFunctionReturn(0);
1847e69d4d44SBarry Smith }
184829f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
1849e69d4d44SBarry Smith 
185037a82bf0SJed Brown /*@
185137a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
185229f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
185337a82bf0SJed Brown 
185437a82bf0SJed Brown     Logically Collective on PC
185537a82bf0SJed Brown 
185637a82bf0SJed Brown     Input Parameters:
185737a82bf0SJed Brown .   pc      - the preconditioner context
185837a82bf0SJed Brown 
185937a82bf0SJed Brown     Output Parameters:
186037a82bf0SJed 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
186137a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
186237a82bf0SJed Brown 
186337a82bf0SJed Brown     Level: intermediate
186437a82bf0SJed Brown 
186529f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
186637a82bf0SJed Brown 
186737a82bf0SJed Brown @*/
186837a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
186937a82bf0SJed Brown {
187037a82bf0SJed Brown   PetscErrorCode ierr;
187137a82bf0SJed Brown 
187237a82bf0SJed Brown   PetscFunctionBegin;
187337a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
187437a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
1875e69d4d44SBarry Smith   PetscFunctionReturn(0);
1876e69d4d44SBarry Smith }
1877e69d4d44SBarry Smith 
187845e7fc46SDmitry Karpeev /*@
1879470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
188045e7fc46SDmitry Karpeev 
188145e7fc46SDmitry Karpeev     Not collective
188245e7fc46SDmitry Karpeev 
188345e7fc46SDmitry Karpeev     Input Parameter:
188445e7fc46SDmitry Karpeev .   pc      - the preconditioner context
188545e7fc46SDmitry Karpeev 
188645e7fc46SDmitry Karpeev     Output Parameter:
1887470b340bSDmitry Karpeev .   S       - the Schur complement matrix
188845e7fc46SDmitry Karpeev 
1889470b340bSDmitry Karpeev     Notes:
1890470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
189145e7fc46SDmitry Karpeev 
189245e7fc46SDmitry Karpeev     Level: advanced
189345e7fc46SDmitry Karpeev 
189429f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
189545e7fc46SDmitry Karpeev 
189645e7fc46SDmitry Karpeev @*/
1897470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
189845e7fc46SDmitry Karpeev {
189945e7fc46SDmitry Karpeev   PetscErrorCode ierr;
190045e7fc46SDmitry Karpeev   const char*    t;
190145e7fc46SDmitry Karpeev   PetscBool      isfs;
190245e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
190345e7fc46SDmitry Karpeev 
190445e7fc46SDmitry Karpeev   PetscFunctionBegin;
190545e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
190645e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
190745e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
190845e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
190945e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1910470b340bSDmitry 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);
1911470b340bSDmitry Karpeev   if (S) *S = jac->schur;
191245e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
191345e7fc46SDmitry Karpeev }
191445e7fc46SDmitry Karpeev 
1915470b340bSDmitry Karpeev /*@
1916470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
1917470b340bSDmitry Karpeev 
1918470b340bSDmitry Karpeev     Not collective
1919470b340bSDmitry Karpeev 
1920470b340bSDmitry Karpeev     Input Parameters:
1921470b340bSDmitry Karpeev +   pc      - the preconditioner context
1922470b340bSDmitry Karpeev .   S       - the Schur complement matrix
1923470b340bSDmitry Karpeev 
1924470b340bSDmitry Karpeev     Level: advanced
1925470b340bSDmitry Karpeev 
192629f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
1927470b340bSDmitry Karpeev 
1928470b340bSDmitry Karpeev @*/
1929bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
1930470b340bSDmitry Karpeev {
1931470b340bSDmitry Karpeev   PetscErrorCode ierr;
1932470b340bSDmitry Karpeev   const char*    t;
1933470b340bSDmitry Karpeev   PetscBool      isfs;
1934470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
1935470b340bSDmitry Karpeev 
1936470b340bSDmitry Karpeev   PetscFunctionBegin;
1937470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1938470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
1939470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1940470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
1941470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1942470b340bSDmitry 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);
1943bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
1944470b340bSDmitry Karpeev   PetscFunctionReturn(0);
1945470b340bSDmitry Karpeev }
1946470b340bSDmitry Karpeev 
1947470b340bSDmitry Karpeev 
194829f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1949e69d4d44SBarry Smith {
1950e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1951084e4875SJed Brown   PetscErrorCode ierr;
1952e69d4d44SBarry Smith 
1953e69d4d44SBarry Smith   PetscFunctionBegin;
1954084e4875SJed Brown   jac->schurpre = ptype;
1955a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
19566bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
1957084e4875SJed Brown     jac->schur_user = pre;
1958084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
1959084e4875SJed Brown   }
1960e69d4d44SBarry Smith   PetscFunctionReturn(0);
1961e69d4d44SBarry Smith }
1962e69d4d44SBarry Smith 
196337a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
196437a82bf0SJed Brown {
196537a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
196637a82bf0SJed Brown 
196737a82bf0SJed Brown   PetscFunctionBegin;
196837a82bf0SJed Brown   *ptype = jac->schurpre;
196937a82bf0SJed Brown   *pre   = jac->schur_user;
197037a82bf0SJed Brown   PetscFunctionReturn(0);
197137a82bf0SJed Brown }
197237a82bf0SJed Brown 
1973ab1df9f5SJed Brown /*@
1974c9c6ffaaSJed Brown     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain
1975ab1df9f5SJed Brown 
1976ab1df9f5SJed Brown     Collective on PC
1977ab1df9f5SJed Brown 
1978ab1df9f5SJed Brown     Input Parameters:
1979ab1df9f5SJed Brown +   pc  - the preconditioner context
1980c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
1981ab1df9f5SJed Brown 
1982ab1df9f5SJed Brown     Options Database:
1983c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
1984ab1df9f5SJed Brown 
1985ab1df9f5SJed Brown 
1986ab1df9f5SJed Brown     Level: intermediate
1987ab1df9f5SJed Brown 
1988ab1df9f5SJed Brown     Notes:
1989ab1df9f5SJed Brown     The FULL factorization is
1990ab1df9f5SJed Brown 
1991ab1df9f5SJed Brown $   (A   B)  = (1       0) (A   0) (1  Ainv*B)
1992ab1df9f5SJed Brown $   (C   D)    (C*Ainv  1) (0   S) (0     1  )
1993ab1df9f5SJed Brown 
19946be4592eSBarry Smith     where S = D - 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,
19956be4592eSBarry Smith     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).
1996ab1df9f5SJed Brown 
19976be4592eSBarry Smith     If applied exactly, FULL factorization is a direct solver. The preconditioned operator with LOWER or UPPER has all eigenvalues equal to 1 and minimal polynomial
19986be4592eSBarry Smith     of degree 2, so KSPGMRES converges in 2 iterations. If the iteration count is very low, consider using KSPFGMRES or KSPGCR which can use one less preconditioner
19996be4592eSBarry 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. With DIAG,
20006be4592eSBarry Smith     the preconditioned operator has three distinct nonzero eigenvalues and minimal polynomial of degree at most 4, so KSPGMRES converges in at most 4 iterations.
2001ab1df9f5SJed Brown 
20026be4592eSBarry Smith     For symmetric problems in which A is positive definite and S is negative definite, DIAG can be used with KSPMINRES. Note that a flexible method like KSPFGMRES
20036be4592eSBarry Smith     or KSPGCR must be used if the fieldsplit preconditioner is nonlinear (e.g. a few iterations of a Krylov method is used inside a split).
2004ab1df9f5SJed Brown 
2005ab1df9f5SJed Brown     References:
200696a0c994SBarry Smith +   1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
200796a0c994SBarry Smith -   2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2008ab1df9f5SJed Brown 
2009ab1df9f5SJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType
2010ab1df9f5SJed Brown @*/
2011c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
2012ab1df9f5SJed Brown {
2013ab1df9f5SJed Brown   PetscErrorCode ierr;
2014ab1df9f5SJed Brown 
2015ab1df9f5SJed Brown   PetscFunctionBegin;
2016ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2017c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
2018ab1df9f5SJed Brown   PetscFunctionReturn(0);
2019ab1df9f5SJed Brown }
2020ab1df9f5SJed Brown 
20211e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
2022ab1df9f5SJed Brown {
2023ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2024ab1df9f5SJed Brown 
2025ab1df9f5SJed Brown   PetscFunctionBegin;
2026ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2027ab1df9f5SJed Brown   PetscFunctionReturn(0);
2028ab1df9f5SJed Brown }
2029ab1df9f5SJed Brown 
203030ad9308SMatthew Knepley /*@C
20318c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
203230ad9308SMatthew Knepley 
203330ad9308SMatthew Knepley    Collective on KSP
203430ad9308SMatthew Knepley 
203530ad9308SMatthew Knepley    Input Parameter:
203630ad9308SMatthew Knepley .  pc - the preconditioner context
203730ad9308SMatthew Knepley 
203830ad9308SMatthew Knepley    Output Parameters:
2039a04f6461SBarry Smith +  A00 - the (0,0) block
2040a04f6461SBarry Smith .  A01 - the (0,1) block
2041a04f6461SBarry Smith .  A10 - the (1,0) block
2042a04f6461SBarry Smith -  A11 - the (1,1) block
204330ad9308SMatthew Knepley 
204430ad9308SMatthew Knepley    Level: advanced
204530ad9308SMatthew Knepley 
204630ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
204730ad9308SMatthew Knepley @*/
2048a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
204930ad9308SMatthew Knepley {
205030ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
205130ad9308SMatthew Knepley 
205230ad9308SMatthew Knepley   PetscFunctionBegin;
20530700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2054ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2055a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2056a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2057a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2058a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
205930ad9308SMatthew Knepley   PetscFunctionReturn(0);
206030ad9308SMatthew Knepley }
206130ad9308SMatthew Knepley 
20621e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
206379416396SBarry Smith {
206479416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2065e69d4d44SBarry Smith   PetscErrorCode ierr;
206679416396SBarry Smith 
206779416396SBarry Smith   PetscFunctionBegin;
206879416396SBarry Smith   jac->type = type;
20693b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
20703b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
20713b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
20722fa5cd67SKarl Rupp 
2073bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
207429f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
207537a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2076bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2077e69d4d44SBarry Smith 
20783b224e63SBarry Smith   } else {
20793b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
20803b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
20812fa5cd67SKarl Rupp 
2082bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
208329f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
208437a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2085bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
20863b224e63SBarry Smith   }
208779416396SBarry Smith   PetscFunctionReturn(0);
208879416396SBarry Smith }
208979416396SBarry Smith 
20901e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
209151f519a2SBarry Smith {
209251f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
209351f519a2SBarry Smith 
209451f519a2SBarry Smith   PetscFunctionBegin;
2095ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2096ce94432eSBarry 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);
209751f519a2SBarry Smith   jac->bs = bs;
209851f519a2SBarry Smith   PetscFunctionReturn(0);
209951f519a2SBarry Smith }
210051f519a2SBarry Smith 
2101bc08b0f1SBarry Smith /*@
210279416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
210379416396SBarry Smith 
210479416396SBarry Smith    Collective on PC
210579416396SBarry Smith 
210679416396SBarry Smith    Input Parameter:
210779416396SBarry Smith .  pc - the preconditioner context
210881540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
210979416396SBarry Smith 
211079416396SBarry Smith    Options Database Key:
2111a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
211279416396SBarry Smith 
2113b02e2d75SMatthew G Knepley    Level: Intermediate
211479416396SBarry Smith 
211579416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
211679416396SBarry Smith 
211779416396SBarry Smith .seealso: PCCompositeSetType()
211879416396SBarry Smith 
211979416396SBarry Smith @*/
21207087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
212179416396SBarry Smith {
21224ac538c5SBarry Smith   PetscErrorCode ierr;
212379416396SBarry Smith 
212479416396SBarry Smith   PetscFunctionBegin;
21250700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
21264ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
212779416396SBarry Smith   PetscFunctionReturn(0);
212879416396SBarry Smith }
212979416396SBarry Smith 
2130b02e2d75SMatthew G Knepley /*@
2131b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2132b02e2d75SMatthew G Knepley 
2133b02e2d75SMatthew G Knepley   Not collective
2134b02e2d75SMatthew G Knepley 
2135b02e2d75SMatthew G Knepley   Input Parameter:
2136b02e2d75SMatthew G Knepley . pc - the preconditioner context
2137b02e2d75SMatthew G Knepley 
2138b02e2d75SMatthew G Knepley   Output Parameter:
2139b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2140b02e2d75SMatthew G Knepley 
2141b02e2d75SMatthew G Knepley   Level: Intermediate
2142b02e2d75SMatthew G Knepley 
2143b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
2144b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2145b02e2d75SMatthew G Knepley @*/
2146b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2147b02e2d75SMatthew G Knepley {
2148b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2149b02e2d75SMatthew G Knepley 
2150b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2151b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2152b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2153b02e2d75SMatthew G Knepley   *type = jac->type;
2154b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2155b02e2d75SMatthew G Knepley }
2156b02e2d75SMatthew G Knepley 
21574ab8060aSDmitry Karpeev /*@
21584ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
21594ab8060aSDmitry Karpeev 
21604ab8060aSDmitry Karpeev    Logically Collective
21614ab8060aSDmitry Karpeev 
21624ab8060aSDmitry Karpeev    Input Parameters:
21634ab8060aSDmitry Karpeev +  pc   - the preconditioner context
21644ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
21654ab8060aSDmitry Karpeev 
21664ab8060aSDmitry Karpeev    Options Database Key:
21674ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
21684ab8060aSDmitry Karpeev 
21694ab8060aSDmitry Karpeev    Level: Intermediate
21704ab8060aSDmitry Karpeev 
21714ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
21724ab8060aSDmitry Karpeev 
21734ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
21744ab8060aSDmitry Karpeev 
21754ab8060aSDmitry Karpeev @*/
21764ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
21774ab8060aSDmitry Karpeev {
21784ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
21794ab8060aSDmitry Karpeev   PetscBool      isfs;
21804ab8060aSDmitry Karpeev   PetscErrorCode ierr;
21814ab8060aSDmitry Karpeev 
21824ab8060aSDmitry Karpeev   PetscFunctionBegin;
21834ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
21844ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
21854ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
21864ab8060aSDmitry Karpeev   if (isfs) {
21874ab8060aSDmitry Karpeev     jac->dm_splits = flg;
21884ab8060aSDmitry Karpeev   }
21894ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
21904ab8060aSDmitry Karpeev }
21914ab8060aSDmitry Karpeev 
21924ab8060aSDmitry Karpeev 
21934ab8060aSDmitry Karpeev /*@
21944ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
21954ab8060aSDmitry Karpeev 
21964ab8060aSDmitry Karpeev    Logically Collective
21974ab8060aSDmitry Karpeev 
21984ab8060aSDmitry Karpeev    Input Parameter:
21994ab8060aSDmitry Karpeev .  pc   - the preconditioner context
22004ab8060aSDmitry Karpeev 
22014ab8060aSDmitry Karpeev    Output Parameter:
22024ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
22034ab8060aSDmitry Karpeev 
22044ab8060aSDmitry Karpeev    Level: Intermediate
22054ab8060aSDmitry Karpeev 
22064ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
22074ab8060aSDmitry Karpeev 
22084ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
22094ab8060aSDmitry Karpeev 
22104ab8060aSDmitry Karpeev @*/
22114ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
22124ab8060aSDmitry Karpeev {
22134ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
22144ab8060aSDmitry Karpeev   PetscBool      isfs;
22154ab8060aSDmitry Karpeev   PetscErrorCode ierr;
22164ab8060aSDmitry Karpeev 
22174ab8060aSDmitry Karpeev   PetscFunctionBegin;
22184ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22194ab8060aSDmitry Karpeev   PetscValidPointer(flg,2);
22204ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
22214ab8060aSDmitry Karpeev   if (isfs) {
22224ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
22234ab8060aSDmitry Karpeev   }
22244ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
22254ab8060aSDmitry Karpeev }
22264ab8060aSDmitry Karpeev 
22270971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
22280971522cSBarry Smith /*MC
2229a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2230a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
22310971522cSBarry Smith 
2232edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
2233edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
22340971522cSBarry Smith 
2235a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
223669a612a9SBarry Smith          and set the options directly on the resulting KSP object
22370971522cSBarry Smith 
22380971522cSBarry Smith    Level: intermediate
22390971522cSBarry Smith 
224079416396SBarry Smith    Options Database Keys:
224181540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
224281540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
224381540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
224481540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
22450f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
2246a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
2247435f959eSBarry Smith .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver
224879416396SBarry Smith 
22495d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
22505d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
22515d4c12cdSJungho Lee 
2252c8a0d604SMatthew G Knepley    Notes:
2253c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
2254d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
2255d32f9abdSBarry Smith 
2256d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
2257d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
2258d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
2259d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
2260d32f9abdSBarry Smith 
2261c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
2262c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
2263c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
226413b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
2265c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
226613b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
226713b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
226813b05affSJed 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
2269c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
2270c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
2271a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
22721d71051fSDmitry Karpeev 
2273a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
22745668aaf4SBarry Smith      diag gives
2275c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
2276c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
22775668aaf4SBarry Smith      note that slightly counter intuitively there is a negative in front of the ksp(S) so that the preconditioner is positive definite. The lower factorization is the inverse of
2278c8a0d604SMatthew G Knepley $              (  A00   0 )
2279c8a0d604SMatthew G Knepley $              (  A10   S )
2280c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
2281c8a0d604SMatthew G Knepley $              ( A00 A01 )
2282c8a0d604SMatthew G Knepley $              (  0   S  )
2283c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
2284e69d4d44SBarry Smith 
2285edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
2286edf189efSBarry Smith      is used automatically for a second block.
2287edf189efSBarry Smith 
2288ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2289ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2290ff218e97SBarry Smith 
2291ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2292ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
2293ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
22940716a85fSBarry Smith 
2295a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
22960971522cSBarry Smith 
22973bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
22983bc631e0SBarry Smith 
22993bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
23003bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
23013bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
23023bc631e0SBarry Smith 
2303*0df66cc4SMatthew G. Knepley    The Constrained Pressure Preconditioner (CPR) can be implemented using PCFIELDSPLIT with PCCOMPOSITE. CPR solves first the Schur complemented pressure equation, updates the
2304*0df66cc4SMatthew G. Knepley    residual on all variables and then applies a simple ILU like preconditioner on all the variables.
2305a6a584a2SBarry Smith 
23067e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
23071d71051fSDmitry Karpeev            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(),
23081d71051fSDmitry Karpeev 	   MatSchurComplementSetAinvType()
23090971522cSBarry Smith M*/
23100971522cSBarry Smith 
23118cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
23120971522cSBarry Smith {
23130971522cSBarry Smith   PetscErrorCode ierr;
23140971522cSBarry Smith   PC_FieldSplit  *jac;
23150971522cSBarry Smith 
23160971522cSBarry Smith   PetscFunctionBegin;
2317b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
23182fa5cd67SKarl Rupp 
23190971522cSBarry Smith   jac->bs                 = -1;
23200971522cSBarry Smith   jac->nsplits            = 0;
23213e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
2322e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
2323c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
2324fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
232551f519a2SBarry Smith 
23260971522cSBarry Smith   pc->data = (void*)jac;
23270971522cSBarry Smith 
23280971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
2329421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
23300971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
2331574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
23320971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
23330971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
23340971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
23350971522cSBarry Smith   pc->ops->applyrichardson = 0;
23360971522cSBarry Smith 
2337bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2338bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
2339bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
2340bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
2341bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
23426dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr);
23430971522cSBarry Smith   PetscFunctionReturn(0);
23440971522cSBarry Smith }
23450971522cSBarry Smith 
23460971522cSBarry Smith 
2347a541d17aSBarry Smith 
2348