xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 1c7cfba8086d34579c588ef184232f386e7aacb7)
1dba47a55SKris Buschelman 
2af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
31e25c274SJed Brown #include <petscdm.h>
40971522cSBarry Smith 
5443836d0SMatthew G Knepley 
62e71c61dSMatthew G. Knepley const char *const PCFieldSplitSchurPreTypes[] = {"SELF","SELFP","A11","USER","FULL","PCFieldSplitSchurPreType","PC_FIELDSPLIT_SCHUR_PRE_",0};
7c9c6ffaaSJed Brown const char *const PCFieldSplitSchurFactTypes[] = {"DIAG","LOWER","UPPER","FULL","PCFieldSplitSchurFactType","PC_FIELDSPLIT_SCHUR_FACT_",0};
8c5d2311dSJed Brown 
90971522cSBarry Smith typedef struct _PC_FieldSplitLink *PC_FieldSplitLink;
100971522cSBarry Smith struct _PC_FieldSplitLink {
1169a612a9SBarry Smith   KSP               ksp;
12443836d0SMatthew G Knepley   Vec               x,y,z;
13db4c96c1SJed Brown   char              *splitname;
140971522cSBarry Smith   PetscInt          nfields;
155d4c12cdSJungho Lee   PetscInt          *fields,*fields_col;
161b9fc7fcSBarry Smith   VecScatter        sctx;
176dbb499eSCian Wilson   IS                is,is_col,is_orig;
1851f519a2SBarry Smith   PC_FieldSplitLink next,previous;
190971522cSBarry Smith };
200971522cSBarry Smith 
210971522cSBarry Smith typedef struct {
2268dd23aaSBarry Smith   PCCompositeType type;
23ace3abfcSBarry Smith   PetscBool       defaultsplit;                    /* Flag for a system with a set of 'k' scalar fields with the same layout (and bs = k) */
24ace3abfcSBarry Smith   PetscBool       splitdefined;                    /* Flag is set after the splits have been defined, to prevent more splits from being added */
2530ad9308SMatthew Knepley   PetscInt        bs;                              /* Block size for IS and Mat structures */
2630ad9308SMatthew Knepley   PetscInt        nsplits;                         /* Number of field divisions defined */
2779416396SBarry Smith   Vec             *x,*y,w1,w2;
28519d70e2SJed Brown   Mat             *mat;                            /* The diagonal block for each split */
29519d70e2SJed Brown   Mat             *pmat;                           /* The preconditioning diagonal block for each split */
3030ad9308SMatthew Knepley   Mat             *Afield;                         /* The rows of the matrix associated with each split */
31ace3abfcSBarry Smith   PetscBool       issetup;
322fa5cd67SKarl Rupp 
3330ad9308SMatthew Knepley   /* Only used when Schur complement preconditioning is used */
3430ad9308SMatthew Knepley   Mat                       B;                     /* The (0,1) block */
3530ad9308SMatthew Knepley   Mat                       C;                     /* The (1,0) block */
36443836d0SMatthew G Knepley   Mat                       schur;                 /* The Schur complement S = A11 - A10 A00^{-1} A01, the KSP here, kspinner, is H_1 in [El08] */
37a7476a74SDmitry Karpeev   Mat                       schurp;                /* Assembled approximation to S built by MatSchurComplement to be used as a preconditioning matrix when solving with S */
38084e4875SJed Brown   Mat                       schur_user;            /* User-provided preconditioning matrix for the Schur complement */
39084e4875SJed Brown   PCFieldSplitSchurPreType  schurpre;              /* Determines which preconditioning matrix is used for the Schur complement */
40c9c6ffaaSJed Brown   PCFieldSplitSchurFactType schurfactorization;
4130ad9308SMatthew Knepley   KSP                       kspschur;              /* The solver for S */
42443836d0SMatthew G Knepley   KSP                       kspupper;              /* The solver for A in the upper diagonal part of the factorization (H_2 in [El08]) */
4397bbdb24SBarry Smith   PC_FieldSplitLink         head;
4463ec74ffSBarry Smith   PetscBool                 reset;                  /* indicates PCReset() has been last called on this object, hack */
456dbb499eSCian Wilson   PetscBool                 isrestrict;             /* indicates PCFieldSplitRestrictIS() has been last called on this object, hack */
46c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
474ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
48c84da90fSDmitry Karpeev   PetscBool                 diag_use_amat;          /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
49c84da90fSDmitry Karpeev   PetscBool                 offdiag_use_amat;       /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
500971522cSBarry Smith } PC_FieldSplit;
510971522cSBarry Smith 
5216913363SBarry Smith /*
5316913363SBarry Smith     Notes: there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
5416913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
5516913363SBarry Smith    PC you could change this.
5616913363SBarry Smith */
57084e4875SJed Brown 
58e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
59084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
60084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
61084e4875SJed Brown {
62084e4875SJed Brown   switch (jac->schurpre) {
63084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
64a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
65e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
66e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
67084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
68084e4875SJed Brown   default:
69084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
70084e4875SJed Brown   }
71084e4875SJed Brown }
72084e4875SJed Brown 
73084e4875SJed Brown 
749804daf3SBarry Smith #include <petscdraw.h>
750971522cSBarry Smith #undef __FUNCT__
760971522cSBarry Smith #define __FUNCT__ "PCView_FieldSplit"
770971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
780971522cSBarry Smith {
790971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
800971522cSBarry Smith   PetscErrorCode    ierr;
81d9884438SBarry Smith   PetscBool         iascii,isdraw;
820971522cSBarry Smith   PetscInt          i,j;
835a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
840971522cSBarry Smith 
850971522cSBarry Smith   PetscFunctionBegin;
86251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
87d9884438SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
880971522cSBarry Smith   if (iascii) {
892c9966d7SBarry Smith     if (jac->bs > 0) {
9051f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
912c9966d7SBarry Smith     } else {
922c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
932c9966d7SBarry Smith     }
94f5236f50SJed Brown     if (pc->useAmat) {
95f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
96a3df900dSMatthew G Knepley     }
97c84da90fSDmitry Karpeev     if (jac->diag_use_amat) {
98c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
99c84da90fSDmitry Karpeev     }
100c84da90fSDmitry Karpeev     if (jac->offdiag_use_amat) {
101c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
102c84da90fSDmitry Karpeev     }
10369a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1040971522cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1050971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1061ab39975SBarry Smith       if (ilink->fields) {
1070971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
10879416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1095a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
11079416396SBarry Smith           if (j > 0) {
11179416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
11279416396SBarry Smith           }
1135a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1140971522cSBarry Smith         }
1150971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
11679416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1171ab39975SBarry Smith       } else {
1181ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1191ab39975SBarry Smith       }
1205a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1215a9f2f41SSatish Balay       ilink = ilink->next;
1220971522cSBarry Smith     }
1230971522cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1242fa5cd67SKarl Rupp   }
1252fa5cd67SKarl Rupp 
1262fa5cd67SKarl Rupp  if (isdraw) {
127d9884438SBarry Smith     PetscDraw draw;
128d9884438SBarry Smith     PetscReal x,y,w,wd;
129d9884438SBarry Smith 
130d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
131d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
132d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
133d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
134d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
135d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
136d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
137d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
138d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
139d9884438SBarry Smith       x    += wd;
140d9884438SBarry Smith       ilink = ilink->next;
141d9884438SBarry Smith     }
1420971522cSBarry Smith   }
1430971522cSBarry Smith   PetscFunctionReturn(0);
1440971522cSBarry Smith }
1450971522cSBarry Smith 
1460971522cSBarry Smith #undef __FUNCT__
1473b224e63SBarry Smith #define __FUNCT__ "PCView_FieldSplit_Schur"
1483b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1493b224e63SBarry Smith {
1503b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1513b224e63SBarry Smith   PetscErrorCode    ierr;
1524996c5bdSBarry Smith   PetscBool         iascii,isdraw;
1533b224e63SBarry Smith   PetscInt          i,j;
1543b224e63SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1553b224e63SBarry Smith 
1563b224e63SBarry Smith   PetscFunctionBegin;
157251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1584996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1593b224e63SBarry Smith   if (iascii) {
1602c9966d7SBarry Smith     if (jac->bs > 0) {
161c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1622c9966d7SBarry Smith     } else {
1632c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1642c9966d7SBarry Smith     }
165f5236f50SJed Brown     if (pc->useAmat) {
166f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
167a3df900dSMatthew G Knepley     }
1683e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1693e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
1703e8b8b31SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);break;
171a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
1721d71051fSDmitry 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;
173e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
174e87fab1bSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);break;
175e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
176e74569cdSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);break;
1773e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1783e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1793e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1803e8b8b31SMatthew G Knepley       } else {
181e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1823e8b8b31SMatthew G Knepley       }
1833e8b8b31SMatthew G Knepley       break;
1843e8b8b31SMatthew G Knepley     default:
18582f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1863e8b8b31SMatthew G Knepley     }
1873b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1883b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1893b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1903b224e63SBarry Smith       if (ilink->fields) {
1913b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
1923b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1933b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
1943b224e63SBarry Smith           if (j > 0) {
1953b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
1963b224e63SBarry Smith           }
1973b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1983b224e63SBarry Smith         }
1993b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
2003b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2013b224e63SBarry Smith       } else {
2023b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2033b224e63SBarry Smith       }
2043b224e63SBarry Smith       ilink = ilink->next;
2053b224e63SBarry Smith     }
206435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2073b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
20806de4afeSJed Brown     if (jac->head) {
209443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
21006de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2113b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21206de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
213443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
214443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
215b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
216b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
217443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
218443836d0SMatthew G Knepley     }
219435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2203b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22112cae6f2SJed Brown     if (jac->kspschur) {
2223b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
22312cae6f2SJed Brown     } else {
22412cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
22512cae6f2SJed Brown     }
2263b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2273b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
22806de4afeSJed Brown   } else if (isdraw && jac->head) {
2294996c5bdSBarry Smith     PetscDraw draw;
2304996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2314996c5bdSBarry Smith     PetscInt  cnt = 2;
2324996c5bdSBarry Smith     char      str[32];
2334996c5bdSBarry Smith 
2344996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2354996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
236c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
237c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
238c74581afSBarry Smith     wd = w/(cnt + 1);
239c74581afSBarry Smith 
2404996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
24151fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2424996c5bdSBarry Smith     y   -= h;
2434996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
244e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2453b224e63SBarry Smith     } else {
2464996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2474996c5bdSBarry Smith     }
24851fa3d41SBarry Smith     ierr = PetscDrawStringBoxed(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2494996c5bdSBarry Smith     y   -= h;
2504996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2514996c5bdSBarry Smith 
2524996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2534996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2544996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2554996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2564996c5bdSBarry Smith       x   += wd;
2574996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2584996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2594996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2604996c5bdSBarry Smith     }
2614996c5bdSBarry Smith     x   += wd;
2624996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2634996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2644996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2653b224e63SBarry Smith   }
2663b224e63SBarry Smith   PetscFunctionReturn(0);
2673b224e63SBarry Smith }
2683b224e63SBarry Smith 
2693b224e63SBarry Smith #undef __FUNCT__
2706c924f48SJed Brown #define __FUNCT__ "PCFieldSplitSetRuntimeSplits_Private"
2716c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
2726c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
2736c924f48SJed Brown {
2746c924f48SJed Brown   PetscErrorCode ierr;
2756c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2765d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
2775d4c12cdSJungho Lee   PetscBool      flg,flg_col;
2785d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
2796c924f48SJed Brown 
2806c924f48SJed Brown   PetscFunctionBegin;
281785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
282785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
2836c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
2848caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
2858caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
2868caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
2876c924f48SJed Brown     nfields     = jac->bs;
28829499fbbSJungho Lee     nfields_col = jac->bs;
289c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
290c5929fdfSBarry Smith     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
2916c924f48SJed Brown     if (!flg) break;
2925d4c12cdSJungho Lee     else if (flg && !flg_col) {
2935d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2945d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
2952fa5cd67SKarl Rupp     } else {
2965d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2975d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
2985d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
2995d4c12cdSJungho Lee     }
3006c924f48SJed Brown   }
3016c924f48SJed Brown   if (i > 0) {
3026c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3036c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3046c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3056c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3066c924f48SJed Brown   }
3076c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3085d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3096c924f48SJed Brown   PetscFunctionReturn(0);
3106c924f48SJed Brown }
3116c924f48SJed Brown 
3126c924f48SJed Brown #undef __FUNCT__
31369a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitSetDefaults"
31469a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3150971522cSBarry Smith {
3160971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3170971522cSBarry Smith   PetscErrorCode    ierr;
3185a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3193a062f41SBarry Smith   PetscBool         fieldsplit_default = PETSC_FALSE,stokes = PETSC_FALSE,coupling = PETSC_FALSE;
3206c924f48SJed Brown   PetscInt          i;
3210971522cSBarry Smith 
3220971522cSBarry Smith   PetscFunctionBegin;
3237287d2a3SDmitry Karpeev   /*
3247287d2a3SDmitry Karpeev    Kinda messy, but at least this now uses DMCreateFieldDecomposition() even with jac->reset.
3257287d2a3SDmitry Karpeev    Should probably be rewritten.
3267287d2a3SDmitry Karpeev    */
3277287d2a3SDmitry Karpeev   if (!ilink || jac->reset) {
328c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
329c5929fdfSBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
3303a062f41SBarry Smith     if (pc->dm && jac->dm_splits && !stokes && !coupling) {
331bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3320784a22cSJed Brown       char      **fieldNames;
3337b62db95SJungho Lee       IS        *fields;
334e7c4fc90SDmitry Karpeev       DM        *dms;
335bafc1b83SMatthew G Knepley       DM        subdm[128];
336bafc1b83SMatthew G Knepley       PetscBool flg;
337bafc1b83SMatthew G Knepley 
33816621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
339bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
340bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
341bafc1b83SMatthew G Knepley         PetscInt ifields[128];
342bafc1b83SMatthew G Knepley         IS       compField;
343bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
344bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
345bafc1b83SMatthew G Knepley 
3468caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
347c5929fdfSBarry Smith         ierr = PetscOptionsGetIntArray(((PetscObject)pc)->options,((PetscObject)pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
348bafc1b83SMatthew G Knepley         if (!flg) break;
34982f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
350bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
351bafc1b83SMatthew G Knepley         if (nfields == 1) {
352bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
35382f516ccSBarry Smith           /* ierr = PetscPrintf(PetscObjectComm((PetscObject)pc), "%s Field Indices:", fieldNames[ifields[0]]);CHKERRQ(ierr);
3540298fd71SBarry Smith              ierr = ISView(compField, NULL);CHKERRQ(ierr); */
355bafc1b83SMatthew G Knepley         } else {
3568caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
357bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
35882f516ccSBarry Smith           /* ierr = PetscPrintf(PetscObjectComm((PetscObject)pc), "%s Field Indices:", splitname);CHKERRQ(ierr);
3590298fd71SBarry Smith              ierr = ISView(compField, NULL);CHKERRQ(ierr); */
3607287d2a3SDmitry Karpeev         }
361bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
362bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
363bafc1b83SMatthew G Knepley           f    = ifields[j];
3647b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
3657b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
3667b62db95SJungho Lee         }
367bafc1b83SMatthew G Knepley       }
368bafc1b83SMatthew G Knepley       if (i == 0) {
369bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
370bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
371bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
372bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
373bafc1b83SMatthew G Knepley         }
374bafc1b83SMatthew G Knepley       } else {
375d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
376d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
377d724dfffSBarry Smith         }
378d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
379785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
3802fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
381bafc1b83SMatthew G Knepley       }
3827b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
3837b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
384e7c4fc90SDmitry Karpeev       if (dms) {
3858b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
386bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
3877287d2a3SDmitry Karpeev           const char *prefix;
3887287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
3897287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
3907b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
3917b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
3927287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
393e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
3942fa5ba8aSJed Brown         }
3957b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
3968b8307b2SJed Brown       }
39766ffff09SJed Brown     } else {
398521d7252SBarry Smith       if (jac->bs <= 0) {
399704ba839SBarry Smith         if (pc->pmat) {
400521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
4012fa5cd67SKarl Rupp         } else jac->bs = 1;
402521d7252SBarry Smith       }
403d32f9abdSBarry Smith 
4046ce1633cSBarry Smith       if (stokes) {
4056ce1633cSBarry Smith         IS       zerodiags,rest;
4066ce1633cSBarry Smith         PetscInt nmin,nmax;
4076ce1633cSBarry Smith 
4086ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4096ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4106ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4117287d2a3SDmitry Karpeev         if (jac->reset) {
4127287d2a3SDmitry Karpeev           jac->head->is       = rest;
4137287d2a3SDmitry Karpeev           jac->head->next->is = zerodiags;
4142fa5cd67SKarl Rupp         } else {
4156ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4166ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
4177287d2a3SDmitry Karpeev         }
418fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
419fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4203a062f41SBarry Smith       } else if (coupling) {
4213a062f41SBarry Smith         IS       coupling,rest;
4223a062f41SBarry Smith         PetscInt nmin,nmax;
4233a062f41SBarry Smith 
4243a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4253a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
4266bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
427e52d2c62SBarry Smith         ierr = ISSetIdentity(rest);CHKERRQ(ierr);
4283a062f41SBarry Smith         if (jac->reset) {
429bb3d4b4cSBarry Smith           jac->head->is       = rest;
430bb3d4b4cSBarry Smith           jac->head->next->is = coupling;
4313a062f41SBarry Smith         } else {
432d020c841SBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
433d020c841SBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",coupling);CHKERRQ(ierr);
4343a062f41SBarry Smith         }
4353a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
4363a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4376ce1633cSBarry Smith       } else {
4386dbb499eSCian Wilson         if (jac->reset && !jac->isrestrict) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cases not yet handled when PCReset() was used");
439c5929fdfSBarry Smith         ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
4407287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
441d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
442d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4436c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
4446c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
445d32f9abdSBarry Smith         }
4466dbb499eSCian Wilson         if ((fieldsplit_default || !jac->splitdefined) && !jac->isrestrict) {
447d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
448db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
4496c924f48SJed Brown             char splitname[8];
4508caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
4515d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
45279416396SBarry Smith           }
4535d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
454521d7252SBarry Smith         }
45566ffff09SJed Brown       }
4566ce1633cSBarry Smith     }
457edf189efSBarry Smith   } else if (jac->nsplits == 1) {
458edf189efSBarry Smith     if (ilink->is) {
459edf189efSBarry Smith       IS       is2;
460edf189efSBarry Smith       PetscInt nmin,nmax;
461edf189efSBarry Smith 
462edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
463edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
464db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
465fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
46682f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
467edf189efSBarry Smith   }
468d0af7cd3SBarry Smith 
469d0af7cd3SBarry Smith 
47082f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
47169a612a9SBarry Smith   PetscFunctionReturn(0);
47269a612a9SBarry Smith }
47369a612a9SBarry Smith 
474c5929fdfSBarry Smith PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(PetscOptions,const char pre[], const char name[], char *value[], PetscBool *flg);
475514bf10dSMatthew G Knepley 
47669a612a9SBarry Smith #undef __FUNCT__
47769a612a9SBarry Smith #define __FUNCT__ "PCSetUp_FieldSplit"
47869a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
47969a612a9SBarry Smith {
48069a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
48169a612a9SBarry Smith   PetscErrorCode    ierr;
4825a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4832c9966d7SBarry Smith   PetscInt          i,nsplit;
4845f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
48569a612a9SBarry Smith 
48669a612a9SBarry Smith   PetscFunctionBegin;
48769a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
48897bbdb24SBarry Smith   nsplit = jac->nsplits;
4895a9f2f41SSatish Balay   ilink  = jac->head;
49097bbdb24SBarry Smith 
49197bbdb24SBarry Smith   /* get the matrices for each split */
492704ba839SBarry Smith   if (!jac->issetup) {
4931b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
49497bbdb24SBarry Smith 
495704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
496704ba839SBarry Smith 
4975d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
4982c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
4992c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
5002c9966d7SBarry Smith     }
50151f519a2SBarry Smith     bs     = jac->bs;
50297bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
5031b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
5041b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
5051b9fc7fcSBarry Smith       if (jac->defaultsplit) {
506ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
5075f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
508704ba839SBarry Smith       } else if (!ilink->is) {
509ccb205f8SBarry Smith         if (ilink->nfields > 1) {
5105f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
511785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
512785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
5131b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
5141b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
5151b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
5165f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
51797bbdb24SBarry Smith             }
51897bbdb24SBarry Smith           }
519ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
520ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
52190e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is, nfields);CHKERRQ(ierr);
52290e68f20SPatrick Farrell           ierr = ISSetBlockSize(ilink->is_col, nfields);CHKERRQ(ierr);
523ccb205f8SBarry Smith         } else {
524ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
525ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
526ccb205f8SBarry Smith        }
5273e197d65SBarry Smith       }
528704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
5295f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
5305f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
531704ba839SBarry Smith       ilink = ilink->next;
5321b9fc7fcSBarry Smith     }
5331b9fc7fcSBarry Smith   }
5341b9fc7fcSBarry Smith 
535704ba839SBarry Smith   ilink = jac->head;
53697bbdb24SBarry Smith   if (!jac->pmat) {
537bdddcaaaSMatthew G Knepley     Vec xtmp;
538bdddcaaaSMatthew G Knepley 
5392a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
540785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
541dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
542cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
543bdddcaaaSMatthew G Knepley       MatNullSpace sp;
544bdddcaaaSMatthew G Knepley 
545a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
546a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
547a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
548a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
549a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
550a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
5512fa5cd67SKarl Rupp 
552a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
553a3df900dSMatthew G Knepley         }
554a3df900dSMatthew G Knepley       } else {
5553a062f41SBarry Smith         const char *prefix;
5565f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
5573a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
5583a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
5593a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
560a3df900dSMatthew G Knepley       }
561bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
5622a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
5630298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
564bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
5650298fd71SBarry Smith       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
566ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
567ed1f0337SMatthew G Knepley       if (sp) {
568ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
569ed1f0337SMatthew G Knepley       }
570704ba839SBarry Smith       ilink = ilink->next;
571cf502942SBarry Smith     }
572bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
57397bbdb24SBarry Smith   } else {
574cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
575a3df900dSMatthew G Knepley       Mat pmat;
576a3df900dSMatthew G Knepley 
577a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
578a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
579a3df900dSMatthew G Knepley       if (!pmat) {
5805f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
581a3df900dSMatthew G Knepley       }
582704ba839SBarry Smith       ilink = ilink->next;
583cf502942SBarry Smith     }
58497bbdb24SBarry Smith   }
5854e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
586519d70e2SJed Brown     ilink = jac->head;
587519d70e2SJed Brown     if (!jac->mat) {
588785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
589519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5905f4ab4e1SJungho Lee         ierr  = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
591519d70e2SJed Brown         ilink = ilink->next;
592519d70e2SJed Brown       }
593519d70e2SJed Brown     } else {
594519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5955f4ab4e1SJungho Lee         if (jac->mat[i]) {ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);}
596519d70e2SJed Brown         ilink = ilink->next;
597519d70e2SJed Brown       }
598519d70e2SJed Brown     }
599519d70e2SJed Brown   } else {
600519d70e2SJed Brown     jac->mat = jac->pmat;
601519d70e2SJed Brown   }
60297bbdb24SBarry Smith 
60353935eafSBarry Smith   /* Check for null space attached to IS */
60453935eafSBarry Smith   ilink = jac->head;
60553935eafSBarry Smith   for (i=0; i<nsplit; i++) {
60653935eafSBarry Smith     MatNullSpace sp;
60753935eafSBarry Smith 
60853935eafSBarry Smith     ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
60953935eafSBarry Smith     if (sp) {
61053935eafSBarry Smith       ierr = MatSetNullSpace(jac->mat[i], sp);CHKERRQ(ierr);
61153935eafSBarry Smith     }
61253935eafSBarry Smith     ilink = ilink->next;
61353935eafSBarry Smith   }
61453935eafSBarry Smith 
6156c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
61668dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
6174e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
61868dd23aaSBarry Smith     ilink = jac->head;
619e52d2c62SBarry Smith     if (nsplit == 2 && jac->type == PC_COMPOSITE_MULTIPLICATIVE) {
620e52d2c62SBarry 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 */
621e52d2c62SBarry Smith       if (!jac->Afield) {
622e52d2c62SBarry Smith         ierr = PetscCalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
623e52d2c62SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_INITIAL_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
624e52d2c62SBarry Smith       } else {
625e52d2c62SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->next->is,ilink->is,MAT_REUSE_MATRIX,&jac->Afield[1]);CHKERRQ(ierr);
626e52d2c62SBarry Smith       }
627e52d2c62SBarry Smith     } else {
62868dd23aaSBarry Smith       if (!jac->Afield) {
629785e854fSJed Brown         ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
63068dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
6310298fd71SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
63268dd23aaSBarry Smith           ilink = ilink->next;
63368dd23aaSBarry Smith         }
63468dd23aaSBarry Smith       } else {
63568dd23aaSBarry Smith         for (i=0; i<nsplit; i++) {
6360298fd71SBarry Smith           ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
63768dd23aaSBarry Smith           ilink = ilink->next;
63868dd23aaSBarry Smith         }
63968dd23aaSBarry Smith       }
64068dd23aaSBarry Smith     }
641e52d2c62SBarry Smith   }
64268dd23aaSBarry Smith 
6433b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
6443b224e63SBarry Smith     IS          ccis;
6454aa3045dSJed Brown     PetscInt    rstart,rend;
646093c86ffSJed Brown     char        lscname[256];
647093c86ffSJed Brown     PetscObject LSC_L;
648ce94432eSBarry Smith 
649ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
65068dd23aaSBarry Smith 
651e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
652e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
653e6cab6aaSJed Brown 
6543b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
6553b224e63SBarry Smith     if (jac->schur) {
6560298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
657443836d0SMatthew G Knepley 
658fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
6593b224e63SBarry Smith       ilink = jac->head;
66049bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6614e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6624aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
663c84da90fSDmitry Karpeev       } else {
664df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
665c84da90fSDmitry Karpeev       }
666fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6673b224e63SBarry Smith       ilink = ilink->next;
66849bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6694e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6704aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
671c84da90fSDmitry Karpeev       } else {
672df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
673c84da90fSDmitry Karpeev       }
674fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
675aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
676a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
677a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
678a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
679a7476a74SDmitry Karpeev       }
680443836d0SMatthew G Knepley       if (kspA != kspInner) {
68123ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
682443836d0SMatthew G Knepley       }
683443836d0SMatthew G Knepley       if (kspUpper != kspA) {
68423ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
685443836d0SMatthew G Knepley       }
68623ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
6873b224e63SBarry Smith     } else {
688bafc1b83SMatthew G Knepley       const char   *Dprefix;
689470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
690514bf10dSMatthew G Knepley       char         schurtestoption[256];
691bdddcaaaSMatthew G Knepley       MatNullSpace sp;
692514bf10dSMatthew G Knepley       PetscBool    flg;
6933b224e63SBarry Smith 
694a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
6953b224e63SBarry Smith       ilink = jac->head;
69649bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6974e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6984aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
699c84da90fSDmitry Karpeev       } else {
700df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
701c84da90fSDmitry Karpeev       }
702fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
7033b224e63SBarry Smith       ilink = ilink->next;
70449bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
7054e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
7064aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
707c84da90fSDmitry Karpeev       } else {
708df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
709c84da90fSDmitry Karpeev       }
710fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
71120252d06SBarry Smith 
712f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
71320252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
71420252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
715bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
716470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
717470b340bSDmitry 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? */
718470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
719470b340bSDmitry Karpeev       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
720895c21f2SBarry Smith       ierr = MatGetNullSpace(jac->mat[1], &sp);CHKERRQ(ierr);
72120252d06SBarry Smith       if (sp) {
72220252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
72320252d06SBarry Smith       }
72420252d06SBarry Smith 
72520252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
726c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
727514bf10dSMatthew G Knepley       if (flg) {
728514bf10dSMatthew G Knepley         DM  dmInner;
72921635b76SJed Brown         KSP kspInner;
73021635b76SJed Brown 
73121635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
73221635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
73321635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
73421635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
73521635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
736514bf10dSMatthew G Knepley 
737514bf10dSMatthew G Knepley         /* Set DM for new solver */
738bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
73921635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
74021635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
741514bf10dSMatthew G Knepley       } else {
74221635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
74321635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
74421635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
74521635b76SJed 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
74621635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
74721635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
74821635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
749514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
750bafc1b83SMatthew G Knepley       }
75123ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
7525a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
75397bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
75497bbdb24SBarry Smith 
755443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
756c5929fdfSBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->options,((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
757443836d0SMatthew G Knepley       if (flg) {
758443836d0SMatthew G Knepley         DM dmInner;
759443836d0SMatthew G Knepley 
760443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
76182f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
762422a814eSBarry Smith         ierr = KSPSetErrorIfNotConverged(jac->kspupper,pc->erroriffailure);CHKERRQ(ierr);
763443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
764443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
765443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
766443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
767443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
76823ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
769443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
770443836d0SMatthew G Knepley       } else {
771443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
772443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
773443836d0SMatthew G Knepley       }
774443836d0SMatthew G Knepley 
775a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
776a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
777a7476a74SDmitry Karpeev       }
778ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
779422a814eSBarry Smith       ierr = KSPSetErrorIfNotConverged(jac->kspschur,pc->erroriffailure);CHKERRQ(ierr);
78097bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
78120252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
78297bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
7837233a360SDmitry Karpeev         PC pcschur;
7847233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
7857233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
78697bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
787e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
788e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
78997bbdb24SBarry Smith       }
79023ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
79197bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
79297bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
793b20b4189SMatthew G. Knepley       /* propogate DM */
794b20b4189SMatthew G. Knepley       {
795b20b4189SMatthew G. Knepley         DM sdm;
796b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
797b20b4189SMatthew G. Knepley         if (sdm) {
798b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
799b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
800b20b4189SMatthew G. Knepley         }
801b20b4189SMatthew G. Knepley       }
80297bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
80397bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
80497bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
80597bbdb24SBarry Smith     }
80697bbdb24SBarry Smith 
8075a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
8088caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
809519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8103b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
811c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
8128caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
81397bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
8145a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
8150971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
81697bbdb24SBarry Smith   } else {
81768bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
8180971522cSBarry Smith     i     = 0;
8190971522cSBarry Smith     ilink = jac->head;
8200971522cSBarry Smith     while (ilink) {
82123ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
8220971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
8230971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
8240971522cSBarry Smith       i++;
8250971522cSBarry Smith       ilink = ilink->next;
8260971522cSBarry Smith     }
8273b224e63SBarry Smith   }
8283b224e63SBarry Smith 
829c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
8300971522cSBarry Smith   PetscFunctionReturn(0);
8310971522cSBarry Smith }
8320971522cSBarry Smith 
8335a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
834ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
835ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
8365a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) || \
837ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) || \
838ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
83979416396SBarry Smith 
8400971522cSBarry Smith #undef __FUNCT__
8413b224e63SBarry Smith #define __FUNCT__ "PCApply_FieldSplit_Schur"
8423b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
8433b224e63SBarry Smith {
8443b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
8453b224e63SBarry Smith   PetscErrorCode    ierr;
8463b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
847443836d0SMatthew G Knepley   KSP               kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
8483b224e63SBarry Smith 
8493b224e63SBarry Smith   PetscFunctionBegin;
850c5d2311dSJed Brown   switch (jac->schurfactorization) {
851c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
852a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
853c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
854c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
855c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
856443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
857c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
858c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
859c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
860c5d2311dSJed Brown     ierr = VecScale(ilinkD->y,-1.);CHKERRQ(ierr);
861c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
862c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
863c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
864c5d2311dSJed Brown     break;
865c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
866a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
867c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
868c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
869443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
870c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
871c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
872c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
873c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
874c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
875c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
876c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
877c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
878c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
879c5d2311dSJed Brown     break;
880c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
881a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
882c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
883c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
884c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
885c5d2311dSJed Brown     ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
886c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
887c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
888c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
889c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
890443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
891c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
892c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
893c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
894c5d2311dSJed Brown     break;
895c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
896a04f6461SBarry 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 */
8973b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8983b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
899443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
9003b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
9013b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
9023b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9033b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9043b224e63SBarry Smith 
9053b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
9063b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9073b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9083b224e63SBarry Smith 
909443836d0SMatthew G Knepley     if (kspUpper == kspA) {
9103b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
9113b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
912443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
913443836d0SMatthew G Knepley     } else {
914443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
915443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
916443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
917443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
918443836d0SMatthew G Knepley     }
9193b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9203b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
921c5d2311dSJed Brown   }
9223b224e63SBarry Smith   PetscFunctionReturn(0);
9233b224e63SBarry Smith }
9243b224e63SBarry Smith 
9253b224e63SBarry Smith #undef __FUNCT__
9260971522cSBarry Smith #define __FUNCT__ "PCApply_FieldSplit"
9270971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
9280971522cSBarry Smith {
9290971522cSBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
9300971522cSBarry Smith   PetscErrorCode     ierr;
9315a9f2f41SSatish Balay   PC_FieldSplitLink  ilink = jac->head;
932939b8a20SBarry Smith   PetscInt           cnt,bs;
933568ed31eSHong Zhang   KSPConvergedReason reason;
9340971522cSBarry Smith 
9350971522cSBarry Smith   PetscFunctionBegin;
93679416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
9371b9fc7fcSBarry Smith     if (jac->defaultsplit) {
938939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
939ce94432eSBarry 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);
940939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
941ce94432eSBarry 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);
9420971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
9435a9f2f41SSatish Balay       while (ilink) {
9445a9f2f41SSatish Balay         ierr  = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
945568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
946568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
947568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
948568ed31eSHong Zhang         }
9495a9f2f41SSatish Balay         ilink = ilink->next;
9500971522cSBarry Smith       }
9510971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
9521b9fc7fcSBarry Smith     } else {
953efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
9545a9f2f41SSatish Balay       while (ilink) {
9555a9f2f41SSatish Balay         ierr  = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
956568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
957568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
958568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
959568ed31eSHong Zhang         }
9605a9f2f41SSatish Balay         ilink = ilink->next;
9611b9fc7fcSBarry Smith       }
9621b9fc7fcSBarry Smith     }
963e52d2c62SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE && jac->nsplits == 2) {
964e52d2c62SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
965e52d2c62SBarry Smith     /* solve on first block for first block variables */
966e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
967e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
968e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
969568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
970568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
971568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
972568ed31eSHong Zhang     }
973e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
974e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
975e52d2c62SBarry Smith 
976e52d2c62SBarry Smith     /* compute the residual only onto second block variables using first block variables */
977e52d2c62SBarry Smith     ierr = MatMult(jac->Afield[1],ilink->y,ilink->next->x);CHKERRQ(ierr);
978e52d2c62SBarry Smith     ilink = ilink->next;
979e52d2c62SBarry Smith     ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
980e52d2c62SBarry Smith     ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
981e52d2c62SBarry Smith     ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
982e52d2c62SBarry Smith 
983e52d2c62SBarry Smith     /* solve on second block variables */
984e52d2c62SBarry Smith     ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);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);
99116913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
99279416396SBarry Smith     if (!jac->w1) {
99379416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
99479416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
99579416396SBarry Smith     }
996efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
9975a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
998568ed31eSHong Zhang     ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
999568ed31eSHong Zhang     if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1000568ed31eSHong Zhang       pc->failedreason = PC_SUBPC_ERROR;
1001568ed31eSHong Zhang     }
10023e197d65SBarry Smith     cnt  = 1;
10035a9f2f41SSatish Balay     while (ilink->next) {
10045a9f2f41SSatish Balay       ilink = ilink->next;
10053e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
10063e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
10073e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
10083e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10093e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
10103e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10112618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
10122618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
10132618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
10142618eb8fSHong Zhang       }
10153e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10163e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
10173e197d65SBarry Smith     }
101851f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
101911755939SBarry Smith       cnt -= 2;
102051f519a2SBarry Smith       while (ilink->previous) {
102151f519a2SBarry Smith         ilink = ilink->previous;
102211755939SBarry Smith         /* compute the residual only over the part of the vector needed */
102311755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
102411755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
102511755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
102611755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
102711755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
1028568ed31eSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
1029568ed31eSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
1030568ed31eSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
1031568ed31eSHong Zhang         }
103211755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
103311755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
103451f519a2SBarry Smith       }
103511755939SBarry Smith     }
1036ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
10370971522cSBarry Smith   PetscFunctionReturn(0);
10380971522cSBarry Smith }
10390971522cSBarry Smith 
1040421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
1041ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1042ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
1043421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) || \
1044ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
1045ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
1046421e10b8SBarry Smith 
1047421e10b8SBarry Smith #undef __FUNCT__
10488c03b21aSDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_FieldSplit"
1049421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
1050421e10b8SBarry Smith {
1051421e10b8SBarry Smith   PC_FieldSplit      *jac = (PC_FieldSplit*)pc->data;
1052421e10b8SBarry Smith   PetscErrorCode     ierr;
1053421e10b8SBarry Smith   PC_FieldSplitLink  ilink = jac->head;
1054939b8a20SBarry Smith   PetscInt           bs;
1055291dd214SHong Zhang   KSPConvergedReason reason;
1056421e10b8SBarry Smith 
1057421e10b8SBarry Smith   PetscFunctionBegin;
1058421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
1059421e10b8SBarry Smith     if (jac->defaultsplit) {
1060939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
1061ce94432eSBarry 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);
1062939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
1063ce94432eSBarry 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);
1064421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
1065421e10b8SBarry Smith       while (ilink) {
1066421e10b8SBarry Smith         ierr = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
10672618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
10682618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
10692618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
10702618eb8fSHong Zhang         }
1071421e10b8SBarry Smith         ilink = ilink->next;
1072421e10b8SBarry Smith       }
1073421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
1074421e10b8SBarry Smith     } else {
1075421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
1076421e10b8SBarry Smith       while (ilink) {
1077421e10b8SBarry Smith         ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
10782618eb8fSHong Zhang         ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
10792618eb8fSHong Zhang         if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
10802618eb8fSHong Zhang           pc->failedreason = PC_SUBPC_ERROR;
10812618eb8fSHong Zhang         }
1082421e10b8SBarry Smith         ilink = ilink->next;
1083421e10b8SBarry Smith       }
1084421e10b8SBarry Smith     }
1085421e10b8SBarry Smith   } else {
1086421e10b8SBarry Smith     if (!jac->w1) {
1087421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1088421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1089421e10b8SBarry Smith     }
1090421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1091421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1092421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
10932618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
10942618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
10952618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
10962618eb8fSHong Zhang       }
1097421e10b8SBarry Smith       while (ilink->next) {
1098421e10b8SBarry Smith         ilink = ilink->next;
10999989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1100421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1101421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1102421e10b8SBarry Smith       }
1103421e10b8SBarry Smith       while (ilink->previous) {
1104421e10b8SBarry Smith         ilink = ilink->previous;
11059989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1106421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1107421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1108421e10b8SBarry Smith       }
1109421e10b8SBarry Smith     } else {
1110421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1111421e10b8SBarry Smith         ilink = ilink->next;
1112421e10b8SBarry Smith       }
1113421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
11142618eb8fSHong Zhang       ierr = KSPGetConvergedReason(ilink->ksp,&reason);CHKERRQ(ierr);
11152618eb8fSHong Zhang       if (reason == KSP_DIVERGED_PCSETUP_FAILED) {
11162618eb8fSHong Zhang         pc->failedreason = PC_SUBPC_ERROR;
11172618eb8fSHong Zhang       }
1118421e10b8SBarry Smith       while (ilink->previous) {
1119421e10b8SBarry Smith         ilink = ilink->previous;
11209989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1121421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1122421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1123421e10b8SBarry Smith       }
1124421e10b8SBarry Smith     }
1125421e10b8SBarry Smith   }
1126421e10b8SBarry Smith   PetscFunctionReturn(0);
1127421e10b8SBarry Smith }
1128421e10b8SBarry Smith 
11290971522cSBarry Smith #undef __FUNCT__
1130574deadeSBarry Smith #define __FUNCT__ "PCReset_FieldSplit"
1131574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
11320971522cSBarry Smith {
11330971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
11340971522cSBarry Smith   PetscErrorCode    ierr;
11355a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
11360971522cSBarry Smith 
11370971522cSBarry Smith   PetscFunctionBegin;
11385a9f2f41SSatish Balay   while (ilink) {
1139574deadeSBarry Smith     ierr  = KSPReset(ilink->ksp);CHKERRQ(ierr);
1140fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1141fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1142443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1143fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1144*1c7cfba8SBarry Smith     if (!ilink->is_orig) {             /* save the original IS */
11456dbb499eSCian Wilson       ierr = PetscObjectReference((PetscObject)ilink->is);CHKERRQ(ierr);
11466dbb499eSCian Wilson       ilink->is_orig = ilink->is;
11476dbb499eSCian Wilson     }
1148fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1149b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
11505a9f2f41SSatish Balay     next  = ilink->next;
11515a9f2f41SSatish Balay     ilink = next;
11520971522cSBarry Smith   }
115305b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1154574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1155574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1156574deadeSBarry Smith   } else if (jac->mat) {
11570298fd71SBarry Smith     jac->mat = NULL;
1158574deadeSBarry Smith   }
115997bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
116068dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
11616bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
11626bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
11636bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1164a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
11656bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
11666bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1167d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
11686bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
11696bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
117063ec74ffSBarry Smith   jac->reset = PETSC_TRUE;
11716dbb499eSCian Wilson   jac->isrestrict = PETSC_FALSE;
1172574deadeSBarry Smith   PetscFunctionReturn(0);
1173574deadeSBarry Smith }
1174574deadeSBarry Smith 
1175574deadeSBarry Smith #undef __FUNCT__
1176574deadeSBarry Smith #define __FUNCT__ "PCDestroy_FieldSplit"
1177574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1178574deadeSBarry Smith {
1179574deadeSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1180574deadeSBarry Smith   PetscErrorCode    ierr;
1181574deadeSBarry Smith   PC_FieldSplitLink ilink = jac->head,next;
1182574deadeSBarry Smith 
1183574deadeSBarry Smith   PetscFunctionBegin;
1184574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1185574deadeSBarry Smith   while (ilink) {
11866bf464f9SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
11876dbb499eSCian Wilson     ierr  = ISDestroy(&ilink->is_orig);CHKERRQ(ierr);
1188574deadeSBarry Smith     next  = ilink->next;
1189574deadeSBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1190574deadeSBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
11915d4c12cdSJungho Lee     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
1192574deadeSBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
1193574deadeSBarry Smith     ilink = next;
1194574deadeSBarry Smith   }
1195574deadeSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1196c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1197bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1198bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1199bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1200bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1201bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
120229f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
120337a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1204bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
12056dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",NULL);CHKERRQ(ierr);
12060971522cSBarry Smith   PetscFunctionReturn(0);
12070971522cSBarry Smith }
12080971522cSBarry Smith 
12090971522cSBarry Smith #undef __FUNCT__
12100971522cSBarry Smith #define __FUNCT__ "PCSetFromOptions_FieldSplit"
12114416b707SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptionItems *PetscOptionsObject,PC pc)
12120971522cSBarry Smith {
12131b9fc7fcSBarry Smith   PetscErrorCode  ierr;
12146c924f48SJed Brown   PetscInt        bs;
1215bc59fbc5SBarry Smith   PetscBool       flg,stokes = PETSC_FALSE;
12169dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
12173b224e63SBarry Smith   PCCompositeType ctype;
12181b9fc7fcSBarry Smith 
12190971522cSBarry Smith   PetscFunctionBegin;
1220e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
12214ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
122251f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
122351f519a2SBarry Smith   if (flg) {
122451f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
122551f519a2SBarry Smith   }
12262686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
12272686e3e9SMatthew 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);
12282686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
12292686e3e9SMatthew 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);
123000216929SDmitry Karpeev   /* FIXME: No programmatic equivalent to the following. */
1231c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
1232c0adfefeSBarry Smith   if (stokes) {
1233c0adfefeSBarry Smith     ierr          = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
1234c0adfefeSBarry Smith     jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF;
1235c0adfefeSBarry Smith   }
1236c0adfefeSBarry Smith 
12373b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
12383b224e63SBarry Smith   if (flg) {
12393b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
12403b224e63SBarry Smith   }
1241c30613efSMatthew Knepley   /* Only setup fields once */
1242c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1243d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1244d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
12456c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
12466c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1247d32f9abdSBarry Smith   }
1248c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1249c5929fdfSBarry Smith     ierr = PetscOptionsGetEnum(((PetscObject)pc)->options,((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1250c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
12510298fd71SBarry 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);
125229f8a81cSJed 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);
1253c5d2311dSJed Brown   }
12541b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
12550971522cSBarry Smith   PetscFunctionReturn(0);
12560971522cSBarry Smith }
12570971522cSBarry Smith 
12580971522cSBarry Smith /*------------------------------------------------------------------------------------*/
12590971522cSBarry Smith 
12600971522cSBarry Smith #undef __FUNCT__
12610971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields_FieldSplit"
12621e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
12630971522cSBarry Smith {
126497bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
12650971522cSBarry Smith   PetscErrorCode    ierr;
12665a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
126769a612a9SBarry Smith   char              prefix[128];
12685d4c12cdSJungho Lee   PetscInt          i;
12690971522cSBarry Smith 
12700971522cSBarry Smith   PetscFunctionBegin;
12716c924f48SJed Brown   if (jac->splitdefined) {
12726c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
12736c924f48SJed Brown     PetscFunctionReturn(0);
12746c924f48SJed Brown   }
127551f519a2SBarry Smith   for (i=0; i<n; i++) {
1276e32f2f54SBarry 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);
1277e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
127851f519a2SBarry Smith   }
1279b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1280a04f6461SBarry Smith   if (splitname) {
1281db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1282a04f6461SBarry Smith   } else {
1283785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1284a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1285a04f6461SBarry Smith   }
1286785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
12875a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
1288785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
12895d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
12902fa5cd67SKarl Rupp 
12915a9f2f41SSatish Balay   ilink->nfields = n;
12920298fd71SBarry Smith   ilink->next    = NULL;
1293ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1294422a814eSBarry Smith   ierr           = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
129520252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
12965a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
12979005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
129869a612a9SBarry Smith 
12998caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
13005a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
13010971522cSBarry Smith 
13020971522cSBarry Smith   if (!next) {
13035a9f2f41SSatish Balay     jac->head       = ilink;
13040298fd71SBarry Smith     ilink->previous = NULL;
13050971522cSBarry Smith   } else {
13060971522cSBarry Smith     while (next->next) {
13070971522cSBarry Smith       next = next->next;
13080971522cSBarry Smith     }
13095a9f2f41SSatish Balay     next->next      = ilink;
131051f519a2SBarry Smith     ilink->previous = next;
13110971522cSBarry Smith   }
13120971522cSBarry Smith   jac->nsplits++;
13130971522cSBarry Smith   PetscFunctionReturn(0);
13140971522cSBarry Smith }
13150971522cSBarry Smith 
1316e69d4d44SBarry Smith #undef __FUNCT__
1317e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit_Schur"
13181e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1319e69d4d44SBarry Smith {
1320e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1321e69d4d44SBarry Smith   PetscErrorCode ierr;
1322e69d4d44SBarry Smith 
1323e69d4d44SBarry Smith   PetscFunctionBegin;
1324785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1325e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
13262fa5cd67SKarl Rupp 
1327e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
132813e0d083SBarry Smith   if (n) *n = jac->nsplits;
1329e69d4d44SBarry Smith   PetscFunctionReturn(0);
1330e69d4d44SBarry Smith }
13310971522cSBarry Smith 
13320971522cSBarry Smith #undef __FUNCT__
133369a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit"
13341e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
13350971522cSBarry Smith {
13360971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13370971522cSBarry Smith   PetscErrorCode    ierr;
13380971522cSBarry Smith   PetscInt          cnt   = 0;
13395a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
13400971522cSBarry Smith 
13410971522cSBarry Smith   PetscFunctionBegin;
1342785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
13435a9f2f41SSatish Balay   while (ilink) {
13445a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
13455a9f2f41SSatish Balay     ilink            = ilink->next;
13460971522cSBarry Smith   }
13475d480477SMatthew 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);
134813e0d083SBarry Smith   if (n) *n = jac->nsplits;
13490971522cSBarry Smith   PetscFunctionReturn(0);
13500971522cSBarry Smith }
13510971522cSBarry Smith 
1352704ba839SBarry Smith #undef __FUNCT__
13536dbb499eSCian Wilson #define __FUNCT__ "PCFieldSplitRestrictIS"
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);
13716dbb499eSCian Wilson   ierr = PetscTryMethod(pc,"PCFieldSplitRestrictIS_C",(PC,IS),(pc,isy));CHKERRQ(ierr);
13726dbb499eSCian Wilson   PetscFunctionReturn(0);
13736dbb499eSCian Wilson }
13746dbb499eSCian Wilson 
13756dbb499eSCian Wilson 
13766dbb499eSCian Wilson #undef __FUNCT__
13776dbb499eSCian Wilson #define __FUNCT__ "PCFieldSplitRestrictIS_FieldSplit"
13786dbb499eSCian Wilson static PetscErrorCode  PCFieldSplitRestrictIS_FieldSplit(PC pc, IS isy)
13796dbb499eSCian Wilson {
13806dbb499eSCian Wilson   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
13816dbb499eSCian Wilson   PetscErrorCode    ierr;
13826dbb499eSCian Wilson   PC_FieldSplitLink ilink = jac->head, next;
13836dbb499eSCian Wilson   PetscInt          localsize,size,sizez,i;
13846dbb499eSCian Wilson   const PetscInt    *ind, *indz;
13856dbb499eSCian Wilson   PetscInt          *indc, *indcz;
13866dbb499eSCian Wilson   PetscBool         flg;
13876dbb499eSCian Wilson 
13886dbb499eSCian Wilson   PetscFunctionBegin;
13896dbb499eSCian Wilson   ierr = ISGetLocalSize(isy,&localsize);CHKERRQ(ierr);
13906dbb499eSCian Wilson   ierr = MPI_Scan(&localsize,&size,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)isy));CHKERRQ(ierr);
13916dbb499eSCian Wilson   size -= localsize;
13926dbb499eSCian Wilson   while(ilink) {
13936dbb499eSCian Wilson     IS isrl,isr;
1394*1c7cfba8SBarry Smith     PC subpc;
13956dbb499eSCian Wilson     if (jac->reset) {
13966dbb499eSCian Wilson       ierr = ISEmbed(ilink->is_orig, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
13976dbb499eSCian Wilson     } else {
13986dbb499eSCian Wilson       ierr = ISEmbed(ilink->is, isy, PETSC_TRUE, &isrl);CHKERRQ(ierr);
13996dbb499eSCian Wilson     }
14006dbb499eSCian Wilson     ierr          = ISGetLocalSize(isrl,&localsize);CHKERRQ(ierr);
14016dbb499eSCian Wilson     ierr          = PetscMalloc1(localsize,&indc);CHKERRQ(ierr);
14026dbb499eSCian Wilson     ierr          = ISGetIndices(isrl,&ind);CHKERRQ(ierr);
14036dbb499eSCian Wilson     ierr          = PetscMemcpy(indc,ind,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14046dbb499eSCian Wilson     ierr          = ISRestoreIndices(isrl,&ind);CHKERRQ(ierr);
14056dbb499eSCian Wilson     ierr          = ISDestroy(&isrl);CHKERRQ(ierr);
14066dbb499eSCian Wilson     for (i=0; i<localsize; i++) *(indc+i) += size;
14076dbb499eSCian Wilson     ierr          = ISCreateGeneral(PetscObjectComm((PetscObject)isy),localsize,indc,PETSC_OWN_POINTER,&isr);CHKERRQ(ierr);
14086dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14096dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
14106dbb499eSCian Wilson     ilink->is     = isr;
14116dbb499eSCian Wilson     ierr          = PetscObjectReference((PetscObject)isr);CHKERRQ(ierr);
14126dbb499eSCian Wilson     ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
14136dbb499eSCian Wilson     ilink->is_col = isr;
14146dbb499eSCian Wilson     ierr          = ISDestroy(&isr);CHKERRQ(ierr);
14156dbb499eSCian Wilson     ierr          = KSPGetPC(ilink->ksp, &subpc);CHKERRQ(ierr);
14166dbb499eSCian Wilson     ierr          = PetscObjectTypeCompare((PetscObject)subpc,PCFIELDSPLIT,&flg);CHKERRQ(ierr);
14176dbb499eSCian Wilson     if(flg) {
14186dbb499eSCian Wilson       IS iszl,isz;
14196dbb499eSCian Wilson       MPI_Comm comm;
14206dbb499eSCian Wilson       if (jac->reset) {
14216dbb499eSCian Wilson         ierr = ISGetLocalSize(ilink->is_orig,&localsize);CHKERRQ(ierr);
14226dbb499eSCian Wilson         comm = PetscObjectComm((PetscObject)ilink->is_orig);
14236dbb499eSCian Wilson         ierr = ISEmbed(isy, ilink->is_orig, PETSC_TRUE, &iszl);CHKERRQ(ierr);
14246dbb499eSCian Wilson       } else {
14256dbb499eSCian Wilson         ierr = ISGetLocalSize(ilink->is,&localsize);CHKERRQ(ierr);
14266dbb499eSCian Wilson         comm = PetscObjectComm((PetscObject)ilink->is);
14276dbb499eSCian Wilson         ierr = ISEmbed(isy, ilink->is, PETSC_TRUE, &iszl);CHKERRQ(ierr);
14286dbb499eSCian Wilson       }
14296dbb499eSCian Wilson       ierr   = MPI_Scan(&localsize,&sizez,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(ierr);
14306dbb499eSCian Wilson       sizez -= localsize;
14316dbb499eSCian Wilson       ierr   = ISGetLocalSize(iszl,&localsize);CHKERRQ(ierr);
14326dbb499eSCian Wilson       ierr   = PetscMalloc1(localsize,&indcz);CHKERRQ(ierr);
14336dbb499eSCian Wilson       ierr   = ISGetIndices(iszl,&indz);CHKERRQ(ierr);
14346dbb499eSCian Wilson       ierr   = PetscMemcpy(indcz,indz,localsize*sizeof(PetscInt));CHKERRQ(ierr);
14356dbb499eSCian Wilson       ierr   = ISRestoreIndices(iszl,&indz);CHKERRQ(ierr);
14366dbb499eSCian Wilson       ierr   = ISDestroy(&iszl);CHKERRQ(ierr);
14376dbb499eSCian Wilson       for (i=0; i<localsize; i++) *(indcz+i) += sizez;
14386dbb499eSCian Wilson       ierr   = ISCreateGeneral(comm,localsize,indcz,PETSC_OWN_POINTER,&isz);CHKERRQ(ierr);
14396dbb499eSCian Wilson       ierr   = PCFieldSplitRestrictIS(subpc,isz);CHKERRQ(ierr);
14406dbb499eSCian Wilson       ierr   = ISDestroy(&isz);CHKERRQ(ierr);
14416dbb499eSCian Wilson     }
14426dbb499eSCian Wilson     next = ilink->next;
14436dbb499eSCian Wilson     ilink = next;
14446dbb499eSCian Wilson   }
14456dbb499eSCian Wilson   jac->isrestrict = PETSC_TRUE;
14466dbb499eSCian Wilson   PetscFunctionReturn(0);
14476dbb499eSCian Wilson }
14486dbb499eSCian Wilson 
14496dbb499eSCian Wilson #undef __FUNCT__
1450704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS_FieldSplit"
14511e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1452704ba839SBarry Smith {
1453704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1454704ba839SBarry Smith   PetscErrorCode    ierr;
1455704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1456704ba839SBarry Smith   char              prefix[128];
1457704ba839SBarry Smith 
1458704ba839SBarry Smith   PetscFunctionBegin;
14596c924f48SJed Brown   if (jac->splitdefined) {
14606c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
14616c924f48SJed Brown     PetscFunctionReturn(0);
14626c924f48SJed Brown   }
1463b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1464a04f6461SBarry Smith   if (splitname) {
1465db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1466a04f6461SBarry Smith   } else {
1467785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1468b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1469a04f6461SBarry Smith   }
14701ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1471b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1472b5787286SJed Brown   ilink->is     = is;
1473b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1474b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1475b5787286SJed Brown   ilink->is_col = is;
14760298fd71SBarry Smith   ilink->next   = NULL;
1477ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
1478422a814eSBarry Smith   ierr          = KSPSetErrorIfNotConverged(ilink->ksp,pc->erroriffailure);CHKERRQ(ierr);
147920252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1480704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
14819005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1482704ba839SBarry Smith 
14838caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1484704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1485704ba839SBarry Smith 
1486704ba839SBarry Smith   if (!next) {
1487704ba839SBarry Smith     jac->head       = ilink;
14880298fd71SBarry Smith     ilink->previous = NULL;
1489704ba839SBarry Smith   } else {
1490704ba839SBarry Smith     while (next->next) {
1491704ba839SBarry Smith       next = next->next;
1492704ba839SBarry Smith     }
1493704ba839SBarry Smith     next->next      = ilink;
1494704ba839SBarry Smith     ilink->previous = next;
1495704ba839SBarry Smith   }
1496704ba839SBarry Smith   jac->nsplits++;
1497704ba839SBarry Smith   PetscFunctionReturn(0);
1498704ba839SBarry Smith }
1499704ba839SBarry Smith 
15000971522cSBarry Smith #undef __FUNCT__
15010971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields"
15020971522cSBarry Smith /*@
15030971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
15040971522cSBarry Smith 
1505ad4df100SBarry Smith     Logically Collective on PC
15060971522cSBarry Smith 
15070971522cSBarry Smith     Input Parameters:
15080971522cSBarry Smith +   pc  - the preconditioner context
15090298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
15100971522cSBarry Smith .   n - the number of fields in this split
1511db4c96c1SJed Brown -   fields - the fields in this split
15120971522cSBarry Smith 
15130971522cSBarry Smith     Level: intermediate
15140971522cSBarry Smith 
1515d32f9abdSBarry Smith     Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1516d32f9abdSBarry Smith 
15177287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1518d32f9abdSBarry 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
1519d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1520d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1521d32f9abdSBarry Smith 
1522db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1523db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1524db4c96c1SJed Brown 
15255d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
15265d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
15275d4c12cdSJungho Lee      available when this routine is called.
15285d4c12cdSJungho Lee 
1529d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
15300971522cSBarry Smith 
15310971522cSBarry Smith @*/
15325d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
15330971522cSBarry Smith {
15344ac538c5SBarry Smith   PetscErrorCode ierr;
15350971522cSBarry Smith 
15360971522cSBarry Smith   PetscFunctionBegin;
15370700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1538db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1539ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1540db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
15415d4c12cdSJungho Lee   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
15420971522cSBarry Smith   PetscFunctionReturn(0);
15430971522cSBarry Smith }
15440971522cSBarry Smith 
15450971522cSBarry Smith #undef __FUNCT__
1546c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDiagUseAmat"
1547c84da90fSDmitry Karpeev /*@
1548c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1549c84da90fSDmitry Karpeev 
1550c84da90fSDmitry Karpeev     Logically Collective on PC
1551c84da90fSDmitry Karpeev 
1552c84da90fSDmitry Karpeev     Input Parameters:
1553c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1554c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1555c84da90fSDmitry Karpeev 
15569506b623SDmitry Karpeev     Options Database:
15579506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1558c84da90fSDmitry Karpeev 
1559c84da90fSDmitry Karpeev     Level: intermediate
1560c84da90fSDmitry Karpeev 
1561c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1562c84da90fSDmitry Karpeev 
1563c84da90fSDmitry Karpeev @*/
1564c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1565c84da90fSDmitry Karpeev {
1566c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1567c84da90fSDmitry Karpeev   PetscBool      isfs;
1568c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1569c84da90fSDmitry Karpeev 
1570c84da90fSDmitry Karpeev   PetscFunctionBegin;
1571c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1572c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1573c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1574c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1575c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1576c84da90fSDmitry Karpeev }
1577c84da90fSDmitry Karpeev 
1578c84da90fSDmitry Karpeev #undef __FUNCT__
1579c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDiagUseAmat"
1580c84da90fSDmitry Karpeev /*@
1581c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1582c84da90fSDmitry Karpeev 
1583c84da90fSDmitry Karpeev     Logically Collective on PC
1584c84da90fSDmitry Karpeev 
1585c84da90fSDmitry Karpeev     Input Parameters:
1586c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1587c84da90fSDmitry Karpeev 
1588c84da90fSDmitry Karpeev     Output Parameters:
1589c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1590c84da90fSDmitry Karpeev 
1591c84da90fSDmitry Karpeev 
1592c84da90fSDmitry Karpeev     Level: intermediate
1593c84da90fSDmitry Karpeev 
1594c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1595c84da90fSDmitry Karpeev 
1596c84da90fSDmitry Karpeev @*/
1597c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1598c84da90fSDmitry Karpeev {
1599c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1600c84da90fSDmitry Karpeev   PetscBool      isfs;
1601c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1602c84da90fSDmitry Karpeev 
1603c84da90fSDmitry Karpeev   PetscFunctionBegin;
1604c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1605c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1606c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1607c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1608c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1609c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1610c84da90fSDmitry Karpeev }
1611c84da90fSDmitry Karpeev 
1612c84da90fSDmitry Karpeev #undef __FUNCT__
1613c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetOffDiagUseAmat"
1614c84da90fSDmitry Karpeev /*@
1615c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1616c84da90fSDmitry Karpeev 
1617c84da90fSDmitry Karpeev     Logically Collective on PC
1618c84da90fSDmitry Karpeev 
1619c84da90fSDmitry Karpeev     Input Parameters:
1620c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1621c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1622c84da90fSDmitry Karpeev 
16239506b623SDmitry Karpeev     Options Database:
16249506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
1625c84da90fSDmitry Karpeev 
1626c84da90fSDmitry Karpeev     Level: intermediate
1627c84da90fSDmitry Karpeev 
1628c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
1629c84da90fSDmitry Karpeev 
1630c84da90fSDmitry Karpeev @*/
1631c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
1632c84da90fSDmitry Karpeev {
1633c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1634c84da90fSDmitry Karpeev   PetscBool      isfs;
1635c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1636c84da90fSDmitry Karpeev 
1637c84da90fSDmitry Karpeev   PetscFunctionBegin;
1638c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1639c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1640c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1641c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
1642c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1643c84da90fSDmitry Karpeev }
1644c84da90fSDmitry Karpeev 
1645c84da90fSDmitry Karpeev #undef __FUNCT__
1646c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetOffDiagUseAmat"
1647c84da90fSDmitry Karpeev /*@
1648c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1649c84da90fSDmitry Karpeev 
1650c84da90fSDmitry Karpeev     Logically Collective on PC
1651c84da90fSDmitry Karpeev 
1652c84da90fSDmitry Karpeev     Input Parameters:
1653c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1654c84da90fSDmitry Karpeev 
1655c84da90fSDmitry Karpeev     Output Parameters:
1656c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1657c84da90fSDmitry Karpeev 
1658c84da90fSDmitry Karpeev 
1659c84da90fSDmitry Karpeev     Level: intermediate
1660c84da90fSDmitry Karpeev 
1661c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
1662c84da90fSDmitry Karpeev 
1663c84da90fSDmitry Karpeev @*/
1664c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
1665c84da90fSDmitry Karpeev {
1666c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1667c84da90fSDmitry Karpeev   PetscBool      isfs;
1668c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1669c84da90fSDmitry Karpeev 
1670c84da90fSDmitry Karpeev   PetscFunctionBegin;
1671c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1672c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1673c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1674c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1675c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
1676c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1677c84da90fSDmitry Karpeev }
1678c84da90fSDmitry Karpeev 
1679c84da90fSDmitry Karpeev 
1680c84da90fSDmitry Karpeev 
1681c84da90fSDmitry Karpeev #undef __FUNCT__
1682704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS"
1683218d4943SBarry Smith /*@C
1684704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1685704ba839SBarry Smith 
1686ad4df100SBarry Smith     Logically Collective on PC
1687704ba839SBarry Smith 
1688704ba839SBarry Smith     Input Parameters:
1689704ba839SBarry Smith +   pc  - the preconditioner context
16900298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
1691db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1692704ba839SBarry Smith 
1693d32f9abdSBarry Smith 
1694a6ffb8dbSJed Brown     Notes:
1695a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1696a6ffb8dbSJed Brown 
1697db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1698db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1699d32f9abdSBarry Smith 
1700704ba839SBarry Smith     Level: intermediate
1701704ba839SBarry Smith 
1702704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1703704ba839SBarry Smith 
1704704ba839SBarry Smith @*/
17057087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1706704ba839SBarry Smith {
17074ac538c5SBarry Smith   PetscErrorCode ierr;
1708704ba839SBarry Smith 
1709704ba839SBarry Smith   PetscFunctionBegin;
17100700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
17117b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1712db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
17134ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1714704ba839SBarry Smith   PetscFunctionReturn(0);
1715704ba839SBarry Smith }
1716704ba839SBarry Smith 
1717704ba839SBarry Smith #undef __FUNCT__
171857a9adfeSMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetIS"
171957a9adfeSMatthew G Knepley /*@
172057a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
172157a9adfeSMatthew G Knepley 
172257a9adfeSMatthew G Knepley     Logically Collective on PC
172357a9adfeSMatthew G Knepley 
172457a9adfeSMatthew G Knepley     Input Parameters:
172557a9adfeSMatthew G Knepley +   pc  - the preconditioner context
172657a9adfeSMatthew G Knepley -   splitname - name of this split
172757a9adfeSMatthew G Knepley 
172857a9adfeSMatthew G Knepley     Output Parameter:
17290298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
173057a9adfeSMatthew G Knepley 
173157a9adfeSMatthew G Knepley     Level: intermediate
173257a9adfeSMatthew G Knepley 
173357a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
173457a9adfeSMatthew G Knepley 
173557a9adfeSMatthew G Knepley @*/
173657a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
173757a9adfeSMatthew G Knepley {
173857a9adfeSMatthew G Knepley   PetscErrorCode ierr;
173957a9adfeSMatthew G Knepley 
174057a9adfeSMatthew G Knepley   PetscFunctionBegin;
174157a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
174257a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
174357a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
174457a9adfeSMatthew G Knepley   {
174557a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
174657a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
174757a9adfeSMatthew G Knepley     PetscBool         found;
174857a9adfeSMatthew G Knepley 
17490298fd71SBarry Smith     *is = NULL;
175057a9adfeSMatthew G Knepley     while (ilink) {
175157a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
175257a9adfeSMatthew G Knepley       if (found) {
175357a9adfeSMatthew G Knepley         *is = ilink->is;
175457a9adfeSMatthew G Knepley         break;
175557a9adfeSMatthew G Knepley       }
175657a9adfeSMatthew G Knepley       ilink = ilink->next;
175757a9adfeSMatthew G Knepley     }
175857a9adfeSMatthew G Knepley   }
175957a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
176057a9adfeSMatthew G Knepley }
176157a9adfeSMatthew G Knepley 
176257a9adfeSMatthew G Knepley #undef __FUNCT__
176351f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize"
176451f519a2SBarry Smith /*@
176551f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
176651f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
176751f519a2SBarry Smith 
1768ad4df100SBarry Smith     Logically Collective on PC
176951f519a2SBarry Smith 
177051f519a2SBarry Smith     Input Parameters:
177151f519a2SBarry Smith +   pc  - the preconditioner context
177251f519a2SBarry Smith -   bs - the block size
177351f519a2SBarry Smith 
177451f519a2SBarry Smith     Level: intermediate
177551f519a2SBarry Smith 
177651f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
177751f519a2SBarry Smith 
177851f519a2SBarry Smith @*/
17797087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
178051f519a2SBarry Smith {
17814ac538c5SBarry Smith   PetscErrorCode ierr;
178251f519a2SBarry Smith 
178351f519a2SBarry Smith   PetscFunctionBegin;
17840700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1785c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
17864ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
178751f519a2SBarry Smith   PetscFunctionReturn(0);
178851f519a2SBarry Smith }
178951f519a2SBarry Smith 
179051f519a2SBarry Smith #undef __FUNCT__
179169a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP"
17920971522cSBarry Smith /*@C
179369a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
17940971522cSBarry Smith 
179569a612a9SBarry Smith    Collective on KSP
17960971522cSBarry Smith 
17970971522cSBarry Smith    Input Parameter:
17980971522cSBarry Smith .  pc - the preconditioner context
17990971522cSBarry Smith 
18000971522cSBarry Smith    Output Parameters:
180113e0d083SBarry Smith +  n - the number of splits
180269a612a9SBarry Smith -  pc - the array of KSP contexts
18030971522cSBarry Smith 
18040971522cSBarry Smith    Note:
1805d32f9abdSBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs IS to be freed by the user
1806d32f9abdSBarry Smith    (not the KSP just the array that contains them).
18070971522cSBarry Smith 
180869a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
18090971522cSBarry Smith 
1810196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
18110298fd71SBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,NULL_OBJECT,ierr) to determine how large the
1812196cc216SBarry Smith       KSP array must be.
1813196cc216SBarry Smith 
1814196cc216SBarry Smith 
18150971522cSBarry Smith    Level: advanced
18160971522cSBarry Smith 
18170971522cSBarry Smith .seealso: PCFIELDSPLIT
18180971522cSBarry Smith @*/
18197087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
18200971522cSBarry Smith {
18214ac538c5SBarry Smith   PetscErrorCode ierr;
18220971522cSBarry Smith 
18230971522cSBarry Smith   PetscFunctionBegin;
18240700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
182513e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
18264ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
18270971522cSBarry Smith   PetscFunctionReturn(0);
18280971522cSBarry Smith }
18290971522cSBarry Smith 
1830e69d4d44SBarry Smith #undef __FUNCT__
183129f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre"
1832e69d4d44SBarry Smith /*@
183329f8a81cSJed Brown     PCFieldSplitSetSchurPre -  Indicates if the Schur complement is preconditioned by a preconditioner constructed by the
1834a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1835e69d4d44SBarry Smith 
1836e69d4d44SBarry Smith     Collective on PC
1837e69d4d44SBarry Smith 
1838e69d4d44SBarry Smith     Input Parameters:
1839e69d4d44SBarry Smith +   pc      - the preconditioner context
1840a7476a74SDmitry Karpeev .   ptype   - which matrix to use for preconditioning the Schur complement: PC_FIELDSPLIT_SCHUR_PRE_A11 (default), PC_FIELDSPLIT_SCHUR_PRE_SELF, PC_FIELDSPLIT_PRE_USER
18410298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
1842084e4875SJed Brown 
1843e69d4d44SBarry Smith     Options Database:
18442e71c61dSMatthew G. Knepley .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> default is a11
1845e69d4d44SBarry Smith 
1846fd1303e9SJungho Lee     Notes:
1847fd1303e9SJungho Lee $    If ptype is
1848a6a584a2SBarry Smith $        user then the preconditioner for the Schur complement is generated from the user provided matrix (pre argument
1849fd1303e9SJungho Lee $             to this function).
1850a6a584a2SBarry Smith $        a11 then the preconditioner for the Schur complement is generated from the block diagonal part of the preconditioner
1851585af1b9SMatthew G. Knepley $             matrix associated with the Schur complement (i.e. A11), not he Schur complement matrix
1852a6a584a2SBarry 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)
1853a6a584a2SBarry Smith $        self the preconditioner for the Schur complement is generated from the symbolic representation of the Schur complement matrix:
1854a6a584a2SBarry Smith $             The only preconditioner that currently works with this symbolic respresentation matrix object is the PCLSC
1855fd1303e9SJungho Lee $             preconditioner
1856a6a584a2SBarry Smith $        selfp then the preconditioning for the Schur complement is generated from an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
18571d71051fSDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00. Optionally, A00 can be
1858a6a584a2SBarry Smith $             lumped before extracting the diagonal: -fieldsplit_1_mat_schur_complement_ainv_type lump
1859fd1303e9SJungho Lee 
1860e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
1861fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1862a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
1863fd1303e9SJungho Lee 
1864e69d4d44SBarry Smith     Level: intermediate
1865e69d4d44SBarry Smith 
18661d71051fSDmitry Karpeev .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType,
18671d71051fSDmitry Karpeev           MatSchurComplementSetAinvType(), PCLSC
1868e69d4d44SBarry Smith 
1869e69d4d44SBarry Smith @*/
187029f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1871e69d4d44SBarry Smith {
18724ac538c5SBarry Smith   PetscErrorCode ierr;
1873e69d4d44SBarry Smith 
1874e69d4d44SBarry Smith   PetscFunctionBegin;
18750700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
187629f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1877e69d4d44SBarry Smith   PetscFunctionReturn(0);
1878e69d4d44SBarry Smith }
187929f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
1880e69d4d44SBarry Smith 
1881e69d4d44SBarry Smith #undef __FUNCT__
188237a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre"
188337a82bf0SJed Brown /*@
188437a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
188529f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
188637a82bf0SJed Brown 
188737a82bf0SJed Brown     Logically Collective on PC
188837a82bf0SJed Brown 
188937a82bf0SJed Brown     Input Parameters:
189037a82bf0SJed Brown .   pc      - the preconditioner context
189137a82bf0SJed Brown 
189237a82bf0SJed Brown     Output Parameters:
189337a82bf0SJed 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
189437a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
189537a82bf0SJed Brown 
189637a82bf0SJed Brown     Level: intermediate
189737a82bf0SJed Brown 
189829f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
189937a82bf0SJed Brown 
190037a82bf0SJed Brown @*/
190137a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
190237a82bf0SJed Brown {
190337a82bf0SJed Brown   PetscErrorCode ierr;
190437a82bf0SJed Brown 
190537a82bf0SJed Brown   PetscFunctionBegin;
190637a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
190737a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
1908e69d4d44SBarry Smith   PetscFunctionReturn(0);
1909e69d4d44SBarry Smith }
1910e69d4d44SBarry Smith 
1911e69d4d44SBarry Smith #undef __FUNCT__
1912470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurGetS"
191345e7fc46SDmitry Karpeev /*@
1914470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
191545e7fc46SDmitry Karpeev 
191645e7fc46SDmitry Karpeev     Not collective
191745e7fc46SDmitry Karpeev 
191845e7fc46SDmitry Karpeev     Input Parameter:
191945e7fc46SDmitry Karpeev .   pc      - the preconditioner context
192045e7fc46SDmitry Karpeev 
192145e7fc46SDmitry Karpeev     Output Parameter:
1922470b340bSDmitry Karpeev .   S       - the Schur complement matrix
192345e7fc46SDmitry Karpeev 
1924470b340bSDmitry Karpeev     Notes:
1925470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
192645e7fc46SDmitry Karpeev 
192745e7fc46SDmitry Karpeev     Level: advanced
192845e7fc46SDmitry Karpeev 
192929f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
193045e7fc46SDmitry Karpeev 
193145e7fc46SDmitry Karpeev @*/
1932470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
193345e7fc46SDmitry Karpeev {
193445e7fc46SDmitry Karpeev   PetscErrorCode ierr;
193545e7fc46SDmitry Karpeev   const char*    t;
193645e7fc46SDmitry Karpeev   PetscBool      isfs;
193745e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
193845e7fc46SDmitry Karpeev 
193945e7fc46SDmitry Karpeev   PetscFunctionBegin;
194045e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
194145e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
194245e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
194345e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
194445e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1945470b340bSDmitry 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);
1946470b340bSDmitry Karpeev   if (S) *S = jac->schur;
194745e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
194845e7fc46SDmitry Karpeev }
194945e7fc46SDmitry Karpeev 
195045e7fc46SDmitry Karpeev #undef __FUNCT__
1951470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurRestoreS"
1952470b340bSDmitry Karpeev /*@
1953470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
1954470b340bSDmitry Karpeev 
1955470b340bSDmitry Karpeev     Not collective
1956470b340bSDmitry Karpeev 
1957470b340bSDmitry Karpeev     Input Parameters:
1958470b340bSDmitry Karpeev +   pc      - the preconditioner context
1959470b340bSDmitry Karpeev .   S       - the Schur complement matrix
1960470b340bSDmitry Karpeev 
1961470b340bSDmitry Karpeev     Level: advanced
1962470b340bSDmitry Karpeev 
196329f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
1964470b340bSDmitry Karpeev 
1965470b340bSDmitry Karpeev @*/
1966bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
1967470b340bSDmitry Karpeev {
1968470b340bSDmitry Karpeev   PetscErrorCode ierr;
1969470b340bSDmitry Karpeev   const char*    t;
1970470b340bSDmitry Karpeev   PetscBool      isfs;
1971470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
1972470b340bSDmitry Karpeev 
1973470b340bSDmitry Karpeev   PetscFunctionBegin;
1974470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1975470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
1976470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1977470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
1978470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1979470b340bSDmitry 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);
1980bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
1981470b340bSDmitry Karpeev   PetscFunctionReturn(0);
1982470b340bSDmitry Karpeev }
1983470b340bSDmitry Karpeev 
1984470b340bSDmitry Karpeev 
1985470b340bSDmitry Karpeev #undef __FUNCT__
198629f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre_FieldSplit"
198729f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1988e69d4d44SBarry Smith {
1989e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1990084e4875SJed Brown   PetscErrorCode ierr;
1991e69d4d44SBarry Smith 
1992e69d4d44SBarry Smith   PetscFunctionBegin;
1993084e4875SJed Brown   jac->schurpre = ptype;
1994a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
19956bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
1996084e4875SJed Brown     jac->schur_user = pre;
1997084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
1998084e4875SJed Brown   }
1999e69d4d44SBarry Smith   PetscFunctionReturn(0);
2000e69d4d44SBarry Smith }
2001e69d4d44SBarry Smith 
200230ad9308SMatthew Knepley #undef __FUNCT__
200337a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre_FieldSplit"
200437a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
200537a82bf0SJed Brown {
200637a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
200737a82bf0SJed Brown 
200837a82bf0SJed Brown   PetscFunctionBegin;
200937a82bf0SJed Brown   *ptype = jac->schurpre;
201037a82bf0SJed Brown   *pre   = jac->schur_user;
201137a82bf0SJed Brown   PetscFunctionReturn(0);
201237a82bf0SJed Brown }
201337a82bf0SJed Brown 
201437a82bf0SJed Brown #undef __FUNCT__
2015c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType"
2016ab1df9f5SJed Brown /*@
2017c9c6ffaaSJed Brown     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain
2018ab1df9f5SJed Brown 
2019ab1df9f5SJed Brown     Collective on PC
2020ab1df9f5SJed Brown 
2021ab1df9f5SJed Brown     Input Parameters:
2022ab1df9f5SJed Brown +   pc  - the preconditioner context
2023c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
2024ab1df9f5SJed Brown 
2025ab1df9f5SJed Brown     Options Database:
2026c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
2027ab1df9f5SJed Brown 
2028ab1df9f5SJed Brown 
2029ab1df9f5SJed Brown     Level: intermediate
2030ab1df9f5SJed Brown 
2031ab1df9f5SJed Brown     Notes:
2032ab1df9f5SJed Brown     The FULL factorization is
2033ab1df9f5SJed Brown 
2034ab1df9f5SJed Brown $   (A   B)  = (1       0) (A   0) (1  Ainv*B)
2035ab1df9f5SJed Brown $   (C   D)    (C*Ainv  1) (0   S) (0     1  )
2036ab1df9f5SJed Brown 
20376be4592eSBarry 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,
20386be4592eSBarry 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).
2039ab1df9f5SJed Brown 
20406be4592eSBarry 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
20416be4592eSBarry 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
20426be4592eSBarry 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,
20436be4592eSBarry 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.
2044ab1df9f5SJed Brown 
20456be4592eSBarry 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
20466be4592eSBarry 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).
2047ab1df9f5SJed Brown 
2048ab1df9f5SJed Brown     References:
204996a0c994SBarry Smith +   1. - Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000).
205096a0c994SBarry Smith -   2. - Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001).
2051ab1df9f5SJed Brown 
2052ab1df9f5SJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType
2053ab1df9f5SJed Brown @*/
2054c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
2055ab1df9f5SJed Brown {
2056ab1df9f5SJed Brown   PetscErrorCode ierr;
2057ab1df9f5SJed Brown 
2058ab1df9f5SJed Brown   PetscFunctionBegin;
2059ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2060c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
2061ab1df9f5SJed Brown   PetscFunctionReturn(0);
2062ab1df9f5SJed Brown }
2063ab1df9f5SJed Brown 
2064ab1df9f5SJed Brown #undef __FUNCT__
2065c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType_FieldSplit"
20661e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
2067ab1df9f5SJed Brown {
2068ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
2069ab1df9f5SJed Brown 
2070ab1df9f5SJed Brown   PetscFunctionBegin;
2071ab1df9f5SJed Brown   jac->schurfactorization = ftype;
2072ab1df9f5SJed Brown   PetscFunctionReturn(0);
2073ab1df9f5SJed Brown }
2074ab1df9f5SJed Brown 
2075ab1df9f5SJed Brown #undef __FUNCT__
207630ad9308SMatthew Knepley #define __FUNCT__ "PCFieldSplitGetSchurBlocks"
207730ad9308SMatthew Knepley /*@C
20788c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
207930ad9308SMatthew Knepley 
208030ad9308SMatthew Knepley    Collective on KSP
208130ad9308SMatthew Knepley 
208230ad9308SMatthew Knepley    Input Parameter:
208330ad9308SMatthew Knepley .  pc - the preconditioner context
208430ad9308SMatthew Knepley 
208530ad9308SMatthew Knepley    Output Parameters:
2086a04f6461SBarry Smith +  A00 - the (0,0) block
2087a04f6461SBarry Smith .  A01 - the (0,1) block
2088a04f6461SBarry Smith .  A10 - the (1,0) block
2089a04f6461SBarry Smith -  A11 - the (1,1) block
209030ad9308SMatthew Knepley 
209130ad9308SMatthew Knepley    Level: advanced
209230ad9308SMatthew Knepley 
209330ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
209430ad9308SMatthew Knepley @*/
2095a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
209630ad9308SMatthew Knepley {
209730ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
209830ad9308SMatthew Knepley 
209930ad9308SMatthew Knepley   PetscFunctionBegin;
21000700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2101ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
2102a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
2103a04f6461SBarry Smith   if (A01) *A01 = jac->B;
2104a04f6461SBarry Smith   if (A10) *A10 = jac->C;
2105a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
210630ad9308SMatthew Knepley   PetscFunctionReturn(0);
210730ad9308SMatthew Knepley }
210830ad9308SMatthew Knepley 
210979416396SBarry Smith #undef __FUNCT__
211079416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType_FieldSplit"
21111e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
211279416396SBarry Smith {
211379416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2114e69d4d44SBarry Smith   PetscErrorCode ierr;
211579416396SBarry Smith 
211679416396SBarry Smith   PetscFunctionBegin;
211779416396SBarry Smith   jac->type = type;
21183b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
21193b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
21203b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
21212fa5cd67SKarl Rupp 
2122bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
212329f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
212437a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
2125bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
2126e69d4d44SBarry Smith 
21273b224e63SBarry Smith   } else {
21283b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
21293b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
21302fa5cd67SKarl Rupp 
2131bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
213229f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
213337a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
2134bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
21353b224e63SBarry Smith   }
213679416396SBarry Smith   PetscFunctionReturn(0);
213779416396SBarry Smith }
213879416396SBarry Smith 
213951f519a2SBarry Smith #undef __FUNCT__
214051f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize_FieldSplit"
21411e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
214251f519a2SBarry Smith {
214351f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
214451f519a2SBarry Smith 
214551f519a2SBarry Smith   PetscFunctionBegin;
2146ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
2147ce94432eSBarry 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);
214851f519a2SBarry Smith   jac->bs = bs;
214951f519a2SBarry Smith   PetscFunctionReturn(0);
215051f519a2SBarry Smith }
215151f519a2SBarry Smith 
215279416396SBarry Smith #undef __FUNCT__
215379416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType"
2154bc08b0f1SBarry Smith /*@
215579416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
215679416396SBarry Smith 
215779416396SBarry Smith    Collective on PC
215879416396SBarry Smith 
215979416396SBarry Smith    Input Parameter:
216079416396SBarry Smith .  pc - the preconditioner context
216181540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
216279416396SBarry Smith 
216379416396SBarry Smith    Options Database Key:
2164a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
216579416396SBarry Smith 
2166b02e2d75SMatthew G Knepley    Level: Intermediate
216779416396SBarry Smith 
216879416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
216979416396SBarry Smith 
217079416396SBarry Smith .seealso: PCCompositeSetType()
217179416396SBarry Smith 
217279416396SBarry Smith @*/
21737087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
217479416396SBarry Smith {
21754ac538c5SBarry Smith   PetscErrorCode ierr;
217679416396SBarry Smith 
217779416396SBarry Smith   PetscFunctionBegin;
21780700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
21794ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
218079416396SBarry Smith   PetscFunctionReturn(0);
218179416396SBarry Smith }
218279416396SBarry Smith 
2183b02e2d75SMatthew G Knepley #undef __FUNCT__
2184b02e2d75SMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetType"
2185b02e2d75SMatthew G Knepley /*@
2186b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
2187b02e2d75SMatthew G Knepley 
2188b02e2d75SMatthew G Knepley   Not collective
2189b02e2d75SMatthew G Knepley 
2190b02e2d75SMatthew G Knepley   Input Parameter:
2191b02e2d75SMatthew G Knepley . pc - the preconditioner context
2192b02e2d75SMatthew G Knepley 
2193b02e2d75SMatthew G Knepley   Output Parameter:
2194b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
2195b02e2d75SMatthew G Knepley 
2196b02e2d75SMatthew G Knepley   Level: Intermediate
2197b02e2d75SMatthew G Knepley 
2198b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
2199b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2200b02e2d75SMatthew G Knepley @*/
2201b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2202b02e2d75SMatthew G Knepley {
2203b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2204b02e2d75SMatthew G Knepley 
2205b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2206b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2207b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2208b02e2d75SMatthew G Knepley   *type = jac->type;
2209b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2210b02e2d75SMatthew G Knepley }
2211b02e2d75SMatthew G Knepley 
22124ab8060aSDmitry Karpeev #undef __FUNCT__
22134ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDMSplits"
22144ab8060aSDmitry Karpeev /*@
22154ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
22164ab8060aSDmitry Karpeev 
22174ab8060aSDmitry Karpeev    Logically Collective
22184ab8060aSDmitry Karpeev 
22194ab8060aSDmitry Karpeev    Input Parameters:
22204ab8060aSDmitry Karpeev +  pc   - the preconditioner context
22214ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
22224ab8060aSDmitry Karpeev 
22234ab8060aSDmitry Karpeev    Options Database Key:
22244ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
22254ab8060aSDmitry Karpeev 
22264ab8060aSDmitry Karpeev    Level: Intermediate
22274ab8060aSDmitry Karpeev 
22284ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
22294ab8060aSDmitry Karpeev 
22304ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
22314ab8060aSDmitry Karpeev 
22324ab8060aSDmitry Karpeev @*/
22334ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
22344ab8060aSDmitry Karpeev {
22354ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
22364ab8060aSDmitry Karpeev   PetscBool      isfs;
22374ab8060aSDmitry Karpeev   PetscErrorCode ierr;
22384ab8060aSDmitry Karpeev 
22394ab8060aSDmitry Karpeev   PetscFunctionBegin;
22404ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22414ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
22424ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
22434ab8060aSDmitry Karpeev   if (isfs) {
22444ab8060aSDmitry Karpeev     jac->dm_splits = flg;
22454ab8060aSDmitry Karpeev   }
22464ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
22474ab8060aSDmitry Karpeev }
22484ab8060aSDmitry Karpeev 
22494ab8060aSDmitry Karpeev 
22504ab8060aSDmitry Karpeev #undef __FUNCT__
22514ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDMSplits"
22524ab8060aSDmitry Karpeev /*@
22534ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
22544ab8060aSDmitry Karpeev 
22554ab8060aSDmitry Karpeev    Logically Collective
22564ab8060aSDmitry Karpeev 
22574ab8060aSDmitry Karpeev    Input Parameter:
22584ab8060aSDmitry Karpeev .  pc   - the preconditioner context
22594ab8060aSDmitry Karpeev 
22604ab8060aSDmitry Karpeev    Output Parameter:
22614ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
22624ab8060aSDmitry Karpeev 
22634ab8060aSDmitry Karpeev    Level: Intermediate
22644ab8060aSDmitry Karpeev 
22654ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
22664ab8060aSDmitry Karpeev 
22674ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
22684ab8060aSDmitry Karpeev 
22694ab8060aSDmitry Karpeev @*/
22704ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
22714ab8060aSDmitry Karpeev {
22724ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
22734ab8060aSDmitry Karpeev   PetscBool      isfs;
22744ab8060aSDmitry Karpeev   PetscErrorCode ierr;
22754ab8060aSDmitry Karpeev 
22764ab8060aSDmitry Karpeev   PetscFunctionBegin;
22774ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
22784ab8060aSDmitry Karpeev   PetscValidPointer(flg,2);
22794ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
22804ab8060aSDmitry Karpeev   if (isfs) {
22814ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
22824ab8060aSDmitry Karpeev   }
22834ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
22844ab8060aSDmitry Karpeev }
22854ab8060aSDmitry Karpeev 
22860971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
22870971522cSBarry Smith /*MC
2288a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2289a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
22900971522cSBarry Smith 
2291edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
2292edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
22930971522cSBarry Smith 
2294a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
229569a612a9SBarry Smith          and set the options directly on the resulting KSP object
22960971522cSBarry Smith 
22970971522cSBarry Smith    Level: intermediate
22980971522cSBarry Smith 
229979416396SBarry Smith    Options Database Keys:
230081540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
230181540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
230281540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
230381540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
23040f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
2305a6a584a2SBarry Smith .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11; see PCFieldSplitSetSchurPre()
2306435f959eSBarry Smith .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver
230779416396SBarry Smith 
23085d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
23095d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
23105d4c12cdSJungho Lee 
2311c8a0d604SMatthew G Knepley    Notes:
2312c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
2313d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
2314d32f9abdSBarry Smith 
2315d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
2316d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
2317d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
2318d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
2319d32f9abdSBarry Smith 
2320c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
2321c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
2322c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
232313b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
2324c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
232513b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
232613b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
232713b05affSJed 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
2328c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
2329c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
2330a6a584a2SBarry Smith      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() for all the possible ways to construct the preconditioner for S.
23311d71051fSDmitry Karpeev 
2332a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
23335668aaf4SBarry Smith      diag gives
2334c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
2335c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
23365668aaf4SBarry 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
2337c8a0d604SMatthew G Knepley $              (  A00   0 )
2338c8a0d604SMatthew G Knepley $              (  A10   S )
2339c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
2340c8a0d604SMatthew G Knepley $              ( A00 A01 )
2341c8a0d604SMatthew G Knepley $              (  0   S  )
2342c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
2343e69d4d44SBarry Smith 
2344edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
2345edf189efSBarry Smith      is used automatically for a second block.
2346edf189efSBarry Smith 
2347ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2348ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2349ff218e97SBarry Smith 
2350ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2351ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
2352ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
23530716a85fSBarry Smith 
2354a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
23550971522cSBarry Smith 
23563bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
23573bc631e0SBarry Smith 
23583bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
23593bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
23603bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
23613bc631e0SBarry Smith 
2362a6a584a2SBarry Smith    The Constrained Pressure Preconditioner (CPR) does not appear to be currently implementable directly with PCFIELDSPLIT. CPR solves first the Schur complemented pressure equation, updates the
2363a6a584a2SBarry Smith    residual on all variables and then applies a simple ILU like preconditioner on all the variables. So it is very much like the full Schur complement with selfp representing the Schur complement but instead
2364a6a584a2SBarry Smith    of backsolving for the saturations in the last step it solves a full coupled (ILU) system for updates to all the variables.
2365a6a584a2SBarry Smith 
23667e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
23671d71051fSDmitry Karpeev            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre(),
23681d71051fSDmitry Karpeev 	   MatSchurComplementSetAinvType()
23690971522cSBarry Smith M*/
23700971522cSBarry Smith 
23710971522cSBarry Smith #undef __FUNCT__
23720971522cSBarry Smith #define __FUNCT__ "PCCreate_FieldSplit"
23738cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
23740971522cSBarry Smith {
23750971522cSBarry Smith   PetscErrorCode ierr;
23760971522cSBarry Smith   PC_FieldSplit  *jac;
23770971522cSBarry Smith 
23780971522cSBarry Smith   PetscFunctionBegin;
2379b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
23802fa5cd67SKarl Rupp 
23810971522cSBarry Smith   jac->bs                 = -1;
23820971522cSBarry Smith   jac->nsplits            = 0;
23833e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
2384e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
2385c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
2386fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
238751f519a2SBarry Smith 
23880971522cSBarry Smith   pc->data = (void*)jac;
23890971522cSBarry Smith 
23900971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
2391421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
23920971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
2393574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
23940971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
23950971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
23960971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
23970971522cSBarry Smith   pc->ops->applyrichardson = 0;
23980971522cSBarry Smith 
2399bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2400bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
2401bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
2402bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
2403bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
24046dbb499eSCian Wilson   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitRestrictIS_C",PCFieldSplitRestrictIS_FieldSplit);CHKERRQ(ierr);
24050971522cSBarry Smith   PetscFunctionReturn(0);
24060971522cSBarry Smith }
24070971522cSBarry Smith 
24080971522cSBarry Smith 
2409a541d17aSBarry Smith 
2410