xref: /petsc/src/ksp/pc/impls/fieldsplit/fieldsplit.c (revision 2686e3e9bd1d8c7e804587ed09960210e6e8f8a0)
1dba47a55SKris Buschelman 
2b45d2f2cSJed Brown #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;
175d4c12cdSJungho Lee   IS                is,is_col;
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 */
45c1570756SJed Brown   PetscBool                 suboptionsset;          /* Indicates that the KSPSetFromOptions() has been called on the sub-KSPs */
464ab8060aSDmitry Karpeev   PetscBool                 dm_splits;              /* Whether to use DMCreateFieldDecomposition() whenever possible */
47c84da90fSDmitry Karpeev   PetscBool                 diag_use_amat;          /* Whether to extract diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
48c84da90fSDmitry Karpeev   PetscBool                 offdiag_use_amat;       /* Whether to extract off-diagonal matrix blocks from Amat, rather than Pmat (weaker than -pc_use_amat) */
490971522cSBarry Smith } PC_FieldSplit;
500971522cSBarry Smith 
5116913363SBarry Smith /*
5216913363SBarry Smith     Notes: there is no particular reason that pmat, x, and y are stored as arrays in PC_FieldSplit instead of
5316913363SBarry Smith    inside PC_FieldSplitLink, just historical. If you want to be able to add new fields after already using the
5416913363SBarry Smith    PC you could change this.
5516913363SBarry Smith */
56084e4875SJed Brown 
57e6cab6aaSJed Brown /* This helper is so that setting a user-provided preconditioning matrix is orthogonal to choosing to use it.  This way the
58084e4875SJed Brown * application-provided FormJacobian can provide this matrix without interfering with the user's (command-line) choices. */
59084e4875SJed Brown static Mat FieldSplitSchurPre(PC_FieldSplit *jac)
60084e4875SJed Brown {
61084e4875SJed Brown   switch (jac->schurpre) {
62084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_SELF: return jac->schur;
63a7476a74SDmitry Karpeev   case PC_FIELDSPLIT_SCHUR_PRE_SELFP: return jac->schurp;
64e87fab1bSBarry Smith   case PC_FIELDSPLIT_SCHUR_PRE_A11: return jac->pmat[1];
65e74569cdSMatthew G. Knepley   case PC_FIELDSPLIT_SCHUR_PRE_FULL: /* We calculate this and store it in schur_user */
66084e4875SJed Brown   case PC_FIELDSPLIT_SCHUR_PRE_USER: /* Use a user-provided matrix if it is given, otherwise diagonal block */
67084e4875SJed Brown   default:
68084e4875SJed Brown     return jac->schur_user ? jac->schur_user : jac->pmat[1];
69084e4875SJed Brown   }
70084e4875SJed Brown }
71084e4875SJed Brown 
72084e4875SJed Brown 
739804daf3SBarry Smith #include <petscdraw.h>
740971522cSBarry Smith #undef __FUNCT__
750971522cSBarry Smith #define __FUNCT__ "PCView_FieldSplit"
760971522cSBarry Smith static PetscErrorCode PCView_FieldSplit(PC pc,PetscViewer viewer)
770971522cSBarry Smith {
780971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
790971522cSBarry Smith   PetscErrorCode    ierr;
80d9884438SBarry Smith   PetscBool         iascii,isdraw;
810971522cSBarry Smith   PetscInt          i,j;
825a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
830971522cSBarry Smith 
840971522cSBarry Smith   PetscFunctionBegin;
85251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
86d9884438SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
870971522cSBarry Smith   if (iascii) {
882c9966d7SBarry Smith     if (jac->bs > 0) {
8951f519a2SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D, blocksize = %D\n",PCCompositeTypes[jac->type],jac->nsplits,jac->bs);CHKERRQ(ierr);
902c9966d7SBarry Smith     } else {
912c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with %s composition: total splits = %D\n",PCCompositeTypes[jac->type],jac->nsplits);CHKERRQ(ierr);
922c9966d7SBarry Smith     }
93f5236f50SJed Brown     if (pc->useAmat) {
94f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
95a3df900dSMatthew G Knepley     }
96c84da90fSDmitry Karpeev     if (jac->diag_use_amat) {
97c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for diagonal blocks\n");CHKERRQ(ierr);
98c84da90fSDmitry Karpeev     }
99c84da90fSDmitry Karpeev     if (jac->offdiag_use_amat) {
100c84da90fSDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for off-diagonal blocks\n");CHKERRQ(ierr);
101c84da90fSDmitry Karpeev     }
10269a612a9SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Solver info for each split is in the following KSP objects:\n");CHKERRQ(ierr);
1030971522cSBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1040971522cSBarry Smith     for (i=0; i<jac->nsplits; i++) {
1051ab39975SBarry Smith       if (ilink->fields) {
1060971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
10779416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1085a9f2f41SSatish Balay         for (j=0; j<ilink->nfields; j++) {
10979416396SBarry Smith           if (j > 0) {
11079416396SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
11179416396SBarry Smith           }
1125a9f2f41SSatish Balay           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1130971522cSBarry Smith         }
1140971522cSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
11579416396SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
1161ab39975SBarry Smith       } else {
1171ab39975SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
1181ab39975SBarry Smith       }
1195a9f2f41SSatish Balay       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
1205a9f2f41SSatish Balay       ilink = ilink->next;
1210971522cSBarry Smith     }
1220971522cSBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1232fa5cd67SKarl Rupp   }
1242fa5cd67SKarl Rupp 
1252fa5cd67SKarl Rupp  if (isdraw) {
126d9884438SBarry Smith     PetscDraw draw;
127d9884438SBarry Smith     PetscReal x,y,w,wd;
128d9884438SBarry Smith 
129d9884438SBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
130d9884438SBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
131d9884438SBarry Smith     w    = 2*PetscMin(1.0 - x,x);
132d9884438SBarry Smith     wd   = w/(jac->nsplits + 1);
133d9884438SBarry Smith     x    = x - wd*(jac->nsplits-1)/2.0;
134d9884438SBarry Smith     for (i=0; i<jac->nsplits; i++) {
135d9884438SBarry Smith       ierr  = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
136d9884438SBarry Smith       ierr  = KSPView(ilink->ksp,viewer);CHKERRQ(ierr);
137d9884438SBarry Smith       ierr  = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
138d9884438SBarry Smith       x    += wd;
139d9884438SBarry Smith       ilink = ilink->next;
140d9884438SBarry Smith     }
1410971522cSBarry Smith   }
1420971522cSBarry Smith   PetscFunctionReturn(0);
1430971522cSBarry Smith }
1440971522cSBarry Smith 
1450971522cSBarry Smith #undef __FUNCT__
1463b224e63SBarry Smith #define __FUNCT__ "PCView_FieldSplit_Schur"
1473b224e63SBarry Smith static PetscErrorCode PCView_FieldSplit_Schur(PC pc,PetscViewer viewer)
1483b224e63SBarry Smith {
1493b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1503b224e63SBarry Smith   PetscErrorCode    ierr;
1514996c5bdSBarry Smith   PetscBool         iascii,isdraw;
1523b224e63SBarry Smith   PetscInt          i,j;
1533b224e63SBarry Smith   PC_FieldSplitLink ilink = jac->head;
1543b224e63SBarry Smith 
1553b224e63SBarry Smith   PetscFunctionBegin;
156251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1574996c5bdSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1583b224e63SBarry Smith   if (iascii) {
1592c9966d7SBarry Smith     if (jac->bs > 0) {
160c9c6ffaaSJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, blocksize = %D, factorization %s\n",jac->bs,PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1612c9966d7SBarry Smith     } else {
1622c9966d7SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  FieldSplit with Schur preconditioner, factorization %s\n",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
1632c9966d7SBarry Smith     }
164f5236f50SJed Brown     if (pc->useAmat) {
165f5236f50SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  using Amat (not Pmat) as operator for blocks\n");CHKERRQ(ierr);
166a3df900dSMatthew G Knepley     }
1673e8b8b31SMatthew G Knepley     switch (jac->schurpre) {
1683e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_SELF:
1693e8b8b31SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from S itself\n");CHKERRQ(ierr);break;
170a7476a74SDmitry Karpeev     case PC_FIELDSPLIT_SCHUR_PRE_SELFP:
1719506b623SDmitry Karpeev       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from Sp, an assembled approximation to S, which uses (the lumped) A00's diagonal's inverse\n");CHKERRQ(ierr);break;
172e87fab1bSBarry Smith     case PC_FIELDSPLIT_SCHUR_PRE_A11:
173e87fab1bSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);break;
174e74569cdSMatthew G. Knepley     case PC_FIELDSPLIT_SCHUR_PRE_FULL:
175e74569cdSMatthew G. Knepley       ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from the exact Schur complement\n");CHKERRQ(ierr);break;
1763e8b8b31SMatthew G Knepley     case PC_FIELDSPLIT_SCHUR_PRE_USER:
1773e8b8b31SMatthew G Knepley       if (jac->schur_user) {
1783e8b8b31SMatthew G Knepley         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from user provided matrix\n");CHKERRQ(ierr);
1793e8b8b31SMatthew G Knepley       } else {
180e87fab1bSBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"  Preconditioner for the Schur complement formed from A11\n");CHKERRQ(ierr);
1813e8b8b31SMatthew G Knepley       }
1823e8b8b31SMatthew G Knepley       break;
1833e8b8b31SMatthew G Knepley     default:
18482f516ccSBarry Smith       SETERRQ1(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_OUTOFRANGE, "Invalid Schur preconditioning type: %d", jac->schurpre);
1853e8b8b31SMatthew G Knepley     }
1863b224e63SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  Split info:\n");CHKERRQ(ierr);
1873b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1883b224e63SBarry Smith     for (i=0; i<jac->nsplits; i++) {
1893b224e63SBarry Smith       if (ilink->fields) {
1903b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Fields ",i);CHKERRQ(ierr);
1913b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_FALSE);CHKERRQ(ierr);
1923b224e63SBarry Smith         for (j=0; j<ilink->nfields; j++) {
1933b224e63SBarry Smith           if (j > 0) {
1943b224e63SBarry Smith             ierr = PetscViewerASCIIPrintf(viewer,",");CHKERRQ(ierr);
1953b224e63SBarry Smith           }
1963b224e63SBarry Smith           ierr = PetscViewerASCIIPrintf(viewer," %D",ilink->fields[j]);CHKERRQ(ierr);
1973b224e63SBarry Smith         }
1983b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"\n");CHKERRQ(ierr);
1993b224e63SBarry Smith         ierr = PetscViewerASCIIUseTabs(viewer,PETSC_TRUE);CHKERRQ(ierr);
2003b224e63SBarry Smith       } else {
2013b224e63SBarry Smith         ierr = PetscViewerASCIIPrintf(viewer,"Split number %D Defined by IS\n",i);CHKERRQ(ierr);
2023b224e63SBarry Smith       }
2033b224e63SBarry Smith       ilink = ilink->next;
2043b224e63SBarry Smith     }
205435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for A00 block\n");CHKERRQ(ierr);
2063b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
20706de4afeSJed Brown     if (jac->head) {
208443836d0SMatthew G Knepley       ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
20906de4afeSJed Brown     } else  {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
2103b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
21106de4afeSJed Brown     if (jac->head && jac->kspupper != jac->head->ksp) {
212443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for upper A00 in upper triangular factor \n");CHKERRQ(ierr);
213443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
214b2750c55SJed Brown       if (jac->kspupper) {ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);}
215b2750c55SJed Brown       else {ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);}
216443836d0SMatthew G Knepley       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
217443836d0SMatthew G Knepley     }
218435f959eSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"KSP solver for S = A11 - A10 inv(A00) A01 \n");CHKERRQ(ierr);
2193b224e63SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
22012cae6f2SJed Brown     if (jac->kspschur) {
2213b224e63SBarry Smith       ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
22212cae6f2SJed Brown     } else {
22312cae6f2SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  not yet available\n");CHKERRQ(ierr);
22412cae6f2SJed Brown     }
2253b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2263b224e63SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
22706de4afeSJed Brown   } else if (isdraw && jac->head) {
2284996c5bdSBarry Smith     PetscDraw draw;
2294996c5bdSBarry Smith     PetscReal x,y,w,wd,h;
2304996c5bdSBarry Smith     PetscInt  cnt = 2;
2314996c5bdSBarry Smith     char      str[32];
2324996c5bdSBarry Smith 
2334996c5bdSBarry Smith     ierr = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
2344996c5bdSBarry Smith     ierr = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
235c74581afSBarry Smith     if (jac->kspupper != jac->head->ksp) cnt++;
236c74581afSBarry Smith     w  = 2*PetscMin(1.0 - x,x);
237c74581afSBarry Smith     wd = w/(cnt + 1);
238c74581afSBarry Smith 
2394996c5bdSBarry Smith     ierr = PetscSNPrintf(str,32,"Schur fact. %s",PCFieldSplitSchurFactTypes[jac->schurfactorization]);CHKERRQ(ierr);
2400298fd71SBarry Smith     ierr = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2414996c5bdSBarry Smith     y   -= h;
2424996c5bdSBarry Smith     if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_USER &&  !jac->schur_user) {
243e87fab1bSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[PC_FIELDSPLIT_SCHUR_PRE_A11]);CHKERRQ(ierr);
2443b224e63SBarry Smith     } else {
2454996c5bdSBarry Smith       ierr = PetscSNPrintf(str,32,"Prec. for Schur from %s",PCFieldSplitSchurPreTypes[jac->schurpre]);CHKERRQ(ierr);
2464996c5bdSBarry Smith     }
2470298fd71SBarry Smith     ierr = PetscDrawBoxedString(draw,x+wd*(cnt-1)/2.0,y,PETSC_DRAW_RED,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
2484996c5bdSBarry Smith     y   -= h;
2494996c5bdSBarry Smith     x    = x - wd*(cnt-1)/2.0;
2504996c5bdSBarry Smith 
2514996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2524996c5bdSBarry Smith     ierr = KSPView(jac->head->ksp,viewer);CHKERRQ(ierr);
2534996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2544996c5bdSBarry Smith     if (jac->kspupper != jac->head->ksp) {
2554996c5bdSBarry Smith       x   += wd;
2564996c5bdSBarry Smith       ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2574996c5bdSBarry Smith       ierr = KSPView(jac->kspupper,viewer);CHKERRQ(ierr);
2584996c5bdSBarry Smith       ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2594996c5bdSBarry Smith     }
2604996c5bdSBarry Smith     x   += wd;
2614996c5bdSBarry Smith     ierr = PetscDrawPushCurrentPoint(draw,x,y);CHKERRQ(ierr);
2624996c5bdSBarry Smith     ierr = KSPView(jac->kspschur,viewer);CHKERRQ(ierr);
2634996c5bdSBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
2643b224e63SBarry Smith   }
2653b224e63SBarry Smith   PetscFunctionReturn(0);
2663b224e63SBarry Smith }
2673b224e63SBarry Smith 
2683b224e63SBarry Smith #undef __FUNCT__
2696c924f48SJed Brown #define __FUNCT__ "PCFieldSplitSetRuntimeSplits_Private"
2706c924f48SJed Brown /* Precondition: jac->bs is set to a meaningful value */
2716c924f48SJed Brown static PetscErrorCode PCFieldSplitSetRuntimeSplits_Private(PC pc)
2726c924f48SJed Brown {
2736c924f48SJed Brown   PetscErrorCode ierr;
2746c924f48SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
2755d4c12cdSJungho Lee   PetscInt       i,nfields,*ifields,nfields_col,*ifields_col;
2765d4c12cdSJungho Lee   PetscBool      flg,flg_col;
2775d4c12cdSJungho Lee   char           optionname[128],splitname[8],optionname_col[128];
2786c924f48SJed Brown 
2796c924f48SJed Brown   PetscFunctionBegin;
280785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields);CHKERRQ(ierr);
281785e854fSJed Brown   ierr = PetscMalloc1(jac->bs,&ifields_col);CHKERRQ(ierr);
2826c924f48SJed Brown   for (i=0,flg=PETSC_TRUE;; i++) {
2838caf3d72SBarry Smith     ierr        = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
2848caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname,sizeof(optionname),"-pc_fieldsplit_%D_fields",i);CHKERRQ(ierr);
2858caf3d72SBarry Smith     ierr        = PetscSNPrintf(optionname_col,sizeof(optionname_col),"-pc_fieldsplit_%D_fields_col",i);CHKERRQ(ierr);
2866c924f48SJed Brown     nfields     = jac->bs;
28729499fbbSJungho Lee     nfields_col = jac->bs;
2886c924f48SJed Brown     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname,ifields,&nfields,&flg);CHKERRQ(ierr);
2895d4c12cdSJungho Lee     ierr        = PetscOptionsGetIntArray(((PetscObject)pc)->prefix,optionname_col,ifields_col,&nfields_col,&flg_col);CHKERRQ(ierr);
2906c924f48SJed Brown     if (!flg) break;
2915d4c12cdSJungho Lee     else if (flg && !flg_col) {
2925d4c12cdSJungho Lee       if (!nfields) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2935d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields);CHKERRQ(ierr);
2942fa5cd67SKarl Rupp     } else {
2955d4c12cdSJungho Lee       if (!nfields || !nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Cannot list zero fields");
2965d4c12cdSJungho Lee       if (nfields != nfields_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Number of row and column fields must match");
2975d4c12cdSJungho Lee       ierr = PCFieldSplitSetFields(pc,splitname,nfields,ifields,ifields_col);CHKERRQ(ierr);
2985d4c12cdSJungho Lee     }
2996c924f48SJed Brown   }
3006c924f48SJed Brown   if (i > 0) {
3016c924f48SJed Brown     /* Makes command-line setting of splits take precedence over setting them in code.
3026c924f48SJed Brown        Otherwise subsequent calls to PCFieldSplitSetIS() or PCFieldSplitSetFields() would
3036c924f48SJed Brown        create new splits, which would probably not be what the user wanted. */
3046c924f48SJed Brown     jac->splitdefined = PETSC_TRUE;
3056c924f48SJed Brown   }
3066c924f48SJed Brown   ierr = PetscFree(ifields);CHKERRQ(ierr);
3075d4c12cdSJungho Lee   ierr = PetscFree(ifields_col);CHKERRQ(ierr);
3086c924f48SJed Brown   PetscFunctionReturn(0);
3096c924f48SJed Brown }
3106c924f48SJed Brown 
3116c924f48SJed Brown #undef __FUNCT__
31269a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitSetDefaults"
31369a612a9SBarry Smith static PetscErrorCode PCFieldSplitSetDefaults(PC pc)
3140971522cSBarry Smith {
3150971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
3160971522cSBarry Smith   PetscErrorCode    ierr;
3175a9f2f41SSatish Balay   PC_FieldSplitLink ilink              = jac->head;
3183a062f41SBarry Smith   PetscBool         fieldsplit_default = PETSC_FALSE,stokes = PETSC_FALSE,coupling = PETSC_FALSE;
3196c924f48SJed Brown   PetscInt          i;
3200971522cSBarry Smith 
3210971522cSBarry Smith   PetscFunctionBegin;
3227287d2a3SDmitry Karpeev   /*
3237287d2a3SDmitry Karpeev    Kinda messy, but at least this now uses DMCreateFieldDecomposition() even with jac->reset.
3247287d2a3SDmitry Karpeev    Should probably be rewritten.
3257287d2a3SDmitry Karpeev    */
3267287d2a3SDmitry Karpeev   if (!ilink || jac->reset) {
3270298fd71SBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
3283a062f41SBarry Smith     ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_coupling",&coupling,NULL);CHKERRQ(ierr);
3293a062f41SBarry Smith     if (pc->dm && jac->dm_splits && !stokes && !coupling) {
330bafc1b83SMatthew G Knepley       PetscInt  numFields, f, i, j;
3310784a22cSJed Brown       char      **fieldNames;
3327b62db95SJungho Lee       IS        *fields;
333e7c4fc90SDmitry Karpeev       DM        *dms;
334bafc1b83SMatthew G Knepley       DM        subdm[128];
335bafc1b83SMatthew G Knepley       PetscBool flg;
336bafc1b83SMatthew G Knepley 
33716621825SDmitry Karpeev       ierr = DMCreateFieldDecomposition(pc->dm, &numFields, &fieldNames, &fields, &dms);CHKERRQ(ierr);
338bafc1b83SMatthew G Knepley       /* Allow the user to prescribe the splits */
339bafc1b83SMatthew G Knepley       for (i = 0, flg = PETSC_TRUE;; i++) {
340bafc1b83SMatthew G Knepley         PetscInt ifields[128];
341bafc1b83SMatthew G Knepley         IS       compField;
342bafc1b83SMatthew G Knepley         char     optionname[128], splitname[8];
343bafc1b83SMatthew G Knepley         PetscInt nfields = numFields;
344bafc1b83SMatthew G Knepley 
3458caf3d72SBarry Smith         ierr = PetscSNPrintf(optionname, sizeof(optionname), "-pc_fieldsplit_%D_fields", i);CHKERRQ(ierr);
346bafc1b83SMatthew G Knepley         ierr = PetscOptionsGetIntArray(((PetscObject) pc)->prefix, optionname, ifields, &nfields, &flg);CHKERRQ(ierr);
347bafc1b83SMatthew G Knepley         if (!flg) break;
34882f516ccSBarry Smith         if (numFields > 128) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cannot currently support %d > 128 fields", numFields);
349bafc1b83SMatthew G Knepley         ierr = DMCreateSubDM(pc->dm, nfields, ifields, &compField, &subdm[i]);CHKERRQ(ierr);
350bafc1b83SMatthew G Knepley         if (nfields == 1) {
351bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[ifields[0]], compField);CHKERRQ(ierr);
35282f516ccSBarry Smith           /* ierr = PetscPrintf(PetscObjectComm((PetscObject)pc), "%s Field Indices:", fieldNames[ifields[0]]);CHKERRQ(ierr);
3530298fd71SBarry Smith              ierr = ISView(compField, NULL);CHKERRQ(ierr); */
354bafc1b83SMatthew G Knepley         } else {
3558caf3d72SBarry Smith           ierr = PetscSNPrintf(splitname, sizeof(splitname), "%D", i);CHKERRQ(ierr);
356bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, splitname, compField);CHKERRQ(ierr);
35782f516ccSBarry Smith           /* ierr = PetscPrintf(PetscObjectComm((PetscObject)pc), "%s Field Indices:", splitname);CHKERRQ(ierr);
3580298fd71SBarry Smith              ierr = ISView(compField, NULL);CHKERRQ(ierr); */
3597287d2a3SDmitry Karpeev         }
360bafc1b83SMatthew G Knepley         ierr = ISDestroy(&compField);CHKERRQ(ierr);
361bafc1b83SMatthew G Knepley         for (j = 0; j < nfields; ++j) {
362bafc1b83SMatthew G Knepley           f    = ifields[j];
3637b62db95SJungho Lee           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
3647b62db95SJungho Lee           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
3657b62db95SJungho Lee         }
366bafc1b83SMatthew G Knepley       }
367bafc1b83SMatthew G Knepley       if (i == 0) {
368bafc1b83SMatthew G Knepley         for (f = 0; f < numFields; ++f) {
369bafc1b83SMatthew G Knepley           ierr = PCFieldSplitSetIS(pc, fieldNames[f], fields[f]);CHKERRQ(ierr);
370bafc1b83SMatthew G Knepley           ierr = PetscFree(fieldNames[f]);CHKERRQ(ierr);
371bafc1b83SMatthew G Knepley           ierr = ISDestroy(&fields[f]);CHKERRQ(ierr);
372bafc1b83SMatthew G Knepley         }
373bafc1b83SMatthew G Knepley       } else {
374d724dfffSBarry Smith         for (j=0; j<numFields; j++) {
375d724dfffSBarry Smith           ierr = DMDestroy(dms+j);CHKERRQ(ierr);
376d724dfffSBarry Smith         }
377d724dfffSBarry Smith         ierr = PetscFree(dms);CHKERRQ(ierr);
378785e854fSJed Brown         ierr = PetscMalloc1(i, &dms);CHKERRQ(ierr);
3792fa5cd67SKarl Rupp         for (j = 0; j < i; ++j) dms[j] = subdm[j];
380bafc1b83SMatthew G Knepley       }
3817b62db95SJungho Lee       ierr = PetscFree(fieldNames);CHKERRQ(ierr);
3827b62db95SJungho Lee       ierr = PetscFree(fields);CHKERRQ(ierr);
383e7c4fc90SDmitry Karpeev       if (dms) {
3848b8307b2SJed Brown         ierr = PetscInfo(pc, "Setting up physics based fieldsplit preconditioner using the embedded DM\n");CHKERRQ(ierr);
385bafc1b83SMatthew G Knepley         for (ilink = jac->head, i = 0; ilink; ilink = ilink->next, ++i) {
3867287d2a3SDmitry Karpeev           const char *prefix;
3877287d2a3SDmitry Karpeev           ierr = PetscObjectGetOptionsPrefix((PetscObject)(ilink->ksp),&prefix);CHKERRQ(ierr);
3887287d2a3SDmitry Karpeev           ierr = PetscObjectSetOptionsPrefix((PetscObject)(dms[i]), prefix);CHKERRQ(ierr);
3897b62db95SJungho Lee           ierr = KSPSetDM(ilink->ksp, dms[i]);CHKERRQ(ierr);
3907b62db95SJungho Lee           ierr = KSPSetDMActive(ilink->ksp, PETSC_FALSE);CHKERRQ(ierr);
3917287d2a3SDmitry Karpeev           ierr = PetscObjectIncrementTabLevel((PetscObject)dms[i],(PetscObject)ilink->ksp,0);CHKERRQ(ierr);
392e7c4fc90SDmitry Karpeev           ierr = DMDestroy(&dms[i]);CHKERRQ(ierr);
3932fa5ba8aSJed Brown         }
3947b62db95SJungho Lee         ierr = PetscFree(dms);CHKERRQ(ierr);
3958b8307b2SJed Brown       }
39666ffff09SJed Brown     } else {
397521d7252SBarry Smith       if (jac->bs <= 0) {
398704ba839SBarry Smith         if (pc->pmat) {
399521d7252SBarry Smith           ierr = MatGetBlockSize(pc->pmat,&jac->bs);CHKERRQ(ierr);
4002fa5cd67SKarl Rupp         } else jac->bs = 1;
401521d7252SBarry Smith       }
402d32f9abdSBarry Smith 
4036ce1633cSBarry Smith       if (stokes) {
4046ce1633cSBarry Smith         IS       zerodiags,rest;
4056ce1633cSBarry Smith         PetscInt nmin,nmax;
4066ce1633cSBarry Smith 
4076ce1633cSBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4086ce1633cSBarry Smith         ierr = MatFindZeroDiagonals(pc->mat,&zerodiags);CHKERRQ(ierr);
4096ce1633cSBarry Smith         ierr = ISComplement(zerodiags,nmin,nmax,&rest);CHKERRQ(ierr);
4107287d2a3SDmitry Karpeev         if (jac->reset) {
4117287d2a3SDmitry Karpeev           jac->head->is       = rest;
4127287d2a3SDmitry Karpeev           jac->head->next->is = zerodiags;
4132fa5cd67SKarl Rupp         } else {
4146ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",rest);CHKERRQ(ierr);
4156ce1633cSBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",zerodiags);CHKERRQ(ierr);
4167287d2a3SDmitry Karpeev         }
417fcfd50ebSBarry Smith         ierr = ISDestroy(&zerodiags);CHKERRQ(ierr);
418fcfd50ebSBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4193a062f41SBarry Smith       } else if (coupling) {
4203a062f41SBarry Smith         IS       coupling,rest;
4213a062f41SBarry Smith         PetscInt nmin,nmax;
4223a062f41SBarry Smith 
4233a062f41SBarry Smith         ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
4243a062f41SBarry Smith         ierr = MatFindOffBlockDiagonalEntries(pc->mat,&coupling);CHKERRQ(ierr);
4256bea0878SBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc->mat),nmax-nmin,nmin,1,&rest);CHKERRQ(ierr);
4263a062f41SBarry Smith         if (jac->reset) {
4273a062f41SBarry Smith           jac->head->is       = coupling;
4283a062f41SBarry Smith           jac->head->next->is = rest;
4293a062f41SBarry Smith         } else {
4303a062f41SBarry Smith           ierr = PCFieldSplitSetIS(pc,"0",coupling);CHKERRQ(ierr);
4313a062f41SBarry Smith           ierr = PCFieldSplitSetIS(pc,"1",rest);CHKERRQ(ierr);
4323a062f41SBarry Smith         }
4333a062f41SBarry Smith         ierr = ISDestroy(&coupling);CHKERRQ(ierr);
4343a062f41SBarry Smith         ierr = ISDestroy(&rest);CHKERRQ(ierr);
4356ce1633cSBarry Smith       } else {
436ce94432eSBarry Smith         if (jac->reset) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Cases not yet handled when PCReset() was used");
4379eeaaa73SJed Brown         ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_default",&fieldsplit_default,NULL);CHKERRQ(ierr);
4387287d2a3SDmitry Karpeev         if (!fieldsplit_default) {
439d32f9abdSBarry Smith           /* Allow user to set fields from command line,  if bs was known at the time of PCSetFromOptions_FieldSplit()
440d32f9abdSBarry Smith            then it is set there. This is not ideal because we should only have options set in XXSetFromOptions(). */
4416c924f48SJed Brown           ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
4426c924f48SJed Brown           if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
443d32f9abdSBarry Smith         }
4447287d2a3SDmitry Karpeev         if (fieldsplit_default || !jac->splitdefined) {
445d32f9abdSBarry Smith           ierr = PetscInfo(pc,"Using default splitting of fields\n");CHKERRQ(ierr);
446db4c96c1SJed Brown           for (i=0; i<jac->bs; i++) {
4476c924f48SJed Brown             char splitname[8];
4488caf3d72SBarry Smith             ierr = PetscSNPrintf(splitname,sizeof(splitname),"%D",i);CHKERRQ(ierr);
4495d4c12cdSJungho Lee             ierr = PCFieldSplitSetFields(pc,splitname,1,&i,&i);CHKERRQ(ierr);
45079416396SBarry Smith           }
4515d4c12cdSJungho Lee           jac->defaultsplit = PETSC_TRUE;
452521d7252SBarry Smith         }
45366ffff09SJed Brown       }
4546ce1633cSBarry Smith     }
455edf189efSBarry Smith   } else if (jac->nsplits == 1) {
456edf189efSBarry Smith     if (ilink->is) {
457edf189efSBarry Smith       IS       is2;
458edf189efSBarry Smith       PetscInt nmin,nmax;
459edf189efSBarry Smith 
460edf189efSBarry Smith       ierr = MatGetOwnershipRange(pc->mat,&nmin,&nmax);CHKERRQ(ierr);
461edf189efSBarry Smith       ierr = ISComplement(ilink->is,nmin,nmax,&is2);CHKERRQ(ierr);
462db4c96c1SJed Brown       ierr = PCFieldSplitSetIS(pc,"1",is2);CHKERRQ(ierr);
463fcfd50ebSBarry Smith       ierr = ISDestroy(&is2);CHKERRQ(ierr);
46482f516ccSBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Must provide at least two sets of fields to PCFieldSplit()");
465edf189efSBarry Smith   }
466d0af7cd3SBarry Smith 
467d0af7cd3SBarry Smith 
46882f516ccSBarry Smith   if (jac->nsplits < 2) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_PLIB,"Unhandled case, must have at least two fields, not %d", jac->nsplits);
46969a612a9SBarry Smith   PetscFunctionReturn(0);
47069a612a9SBarry Smith }
47169a612a9SBarry Smith 
4725a576424SJed Brown PETSC_EXTERN PetscErrorCode PetscOptionsFindPairPrefix_Private(const char pre[], const char name[], char *value[], PetscBool *flg);
473514bf10dSMatthew G Knepley 
47469a612a9SBarry Smith #undef __FUNCT__
47569a612a9SBarry Smith #define __FUNCT__ "PCSetUp_FieldSplit"
47669a612a9SBarry Smith static PetscErrorCode PCSetUp_FieldSplit(PC pc)
47769a612a9SBarry Smith {
47869a612a9SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
47969a612a9SBarry Smith   PetscErrorCode    ierr;
4805a9f2f41SSatish Balay   PC_FieldSplitLink ilink;
4812c9966d7SBarry Smith   PetscInt          i,nsplit;
4825f4ab4e1SJungho Lee   PetscBool         sorted, sorted_col;
48369a612a9SBarry Smith 
48469a612a9SBarry Smith   PetscFunctionBegin;
48569a612a9SBarry Smith   ierr   = PCFieldSplitSetDefaults(pc);CHKERRQ(ierr);
48697bbdb24SBarry Smith   nsplit = jac->nsplits;
4875a9f2f41SSatish Balay   ilink  = jac->head;
48897bbdb24SBarry Smith 
48997bbdb24SBarry Smith   /* get the matrices for each split */
490704ba839SBarry Smith   if (!jac->issetup) {
4911b9fc7fcSBarry Smith     PetscInt rstart,rend,nslots,bs;
49297bbdb24SBarry Smith 
493704ba839SBarry Smith     jac->issetup = PETSC_TRUE;
494704ba839SBarry Smith 
4955d4c12cdSJungho Lee     /* This is done here instead of in PCFieldSplitSetFields() because may not have matrix at that point */
4962c9966d7SBarry Smith     if (jac->defaultsplit || !ilink->is) {
4972c9966d7SBarry Smith       if (jac->bs <= 0) jac->bs = nsplit;
4982c9966d7SBarry Smith     }
49951f519a2SBarry Smith     bs     = jac->bs;
50097bbdb24SBarry Smith     ierr   = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
5011b9fc7fcSBarry Smith     nslots = (rend - rstart)/bs;
5021b9fc7fcSBarry Smith     for (i=0; i<nsplit; i++) {
5031b9fc7fcSBarry Smith       if (jac->defaultsplit) {
504ce94432eSBarry Smith         ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+i,nsplit,&ilink->is);CHKERRQ(ierr);
5055f4ab4e1SJungho Lee         ierr = ISDuplicate(ilink->is,&ilink->is_col);CHKERRQ(ierr);
506704ba839SBarry Smith       } else if (!ilink->is) {
507ccb205f8SBarry Smith         if (ilink->nfields > 1) {
5085f4ab4e1SJungho Lee           PetscInt *ii,*jj,j,k,nfields = ilink->nfields,*fields = ilink->fields,*fields_col = ilink->fields_col;
509785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&ii);CHKERRQ(ierr);
510785e854fSJed Brown           ierr = PetscMalloc1(ilink->nfields*nslots,&jj);CHKERRQ(ierr);
5111b9fc7fcSBarry Smith           for (j=0; j<nslots; j++) {
5121b9fc7fcSBarry Smith             for (k=0; k<nfields; k++) {
5131b9fc7fcSBarry Smith               ii[nfields*j + k] = rstart + bs*j + fields[k];
5145f4ab4e1SJungho Lee               jj[nfields*j + k] = rstart + bs*j + fields_col[k];
51597bbdb24SBarry Smith             }
51697bbdb24SBarry Smith           }
517ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,ii,PETSC_OWN_POINTER,&ilink->is);CHKERRQ(ierr);
518ce94432eSBarry Smith           ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),nslots*nfields,jj,PETSC_OWN_POINTER,&ilink->is_col);CHKERRQ(ierr);
519ccb205f8SBarry Smith         } else {
520ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields[0],bs,&ilink->is);CHKERRQ(ierr);
521ce94432eSBarry Smith           ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),nslots,rstart+ilink->fields_col[0],bs,&ilink->is_col);CHKERRQ(ierr);
522ccb205f8SBarry Smith        }
5233e197d65SBarry Smith       }
524704ba839SBarry Smith       ierr = ISSorted(ilink->is,&sorted);CHKERRQ(ierr);
5255f4ab4e1SJungho Lee       if (ilink->is_col) { ierr = ISSorted(ilink->is_col,&sorted_col);CHKERRQ(ierr); }
5265f4ab4e1SJungho Lee       if (!sorted || !sorted_col) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_USER,"Fields must be sorted when creating split");
527704ba839SBarry Smith       ilink = ilink->next;
5281b9fc7fcSBarry Smith     }
5291b9fc7fcSBarry Smith   }
5301b9fc7fcSBarry Smith 
531704ba839SBarry Smith   ilink = jac->head;
53297bbdb24SBarry Smith   if (!jac->pmat) {
533bdddcaaaSMatthew G Knepley     Vec xtmp;
534bdddcaaaSMatthew G Knepley 
5352a7a6963SBarry Smith     ierr = MatCreateVecs(pc->pmat,&xtmp,NULL);CHKERRQ(ierr);
536785e854fSJed Brown     ierr = PetscMalloc1(nsplit,&jac->pmat);CHKERRQ(ierr);
537dcca6d9dSJed Brown     ierr = PetscMalloc2(nsplit,&jac->x,nsplit,&jac->y);CHKERRQ(ierr);
538cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
539bdddcaaaSMatthew G Knepley       MatNullSpace sp;
540bdddcaaaSMatthew G Knepley 
541a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
542a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &jac->pmat[i]);CHKERRQ(ierr);
543a3df900dSMatthew G Knepley       if (jac->pmat[i]) {
544a3df900dSMatthew G Knepley         ierr = PetscObjectReference((PetscObject) jac->pmat[i]);CHKERRQ(ierr);
545a3df900dSMatthew G Knepley         if (jac->type == PC_COMPOSITE_SCHUR) {
546a3df900dSMatthew G Knepley           jac->schur_user = jac->pmat[i];
5472fa5cd67SKarl Rupp 
548a3df900dSMatthew G Knepley           ierr = PetscObjectReference((PetscObject) jac->schur_user);CHKERRQ(ierr);
549a3df900dSMatthew G Knepley         }
550a3df900dSMatthew G Knepley       } else {
5513a062f41SBarry Smith         const char *prefix;
5525f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
5533a062f41SBarry Smith         ierr = KSPGetOptionsPrefix(ilink->ksp,&prefix);CHKERRQ(ierr);
5543a062f41SBarry Smith         ierr = MatSetOptionsPrefix(jac->pmat[i],prefix);CHKERRQ(ierr);
5553a062f41SBarry Smith         ierr = MatViewFromOptions(jac->pmat[i],NULL,"-mat_view");CHKERRQ(ierr);
556a3df900dSMatthew G Knepley       }
557bdddcaaaSMatthew G Knepley       /* create work vectors for each split */
5582a7a6963SBarry Smith       ierr     = MatCreateVecs(jac->pmat[i],&jac->x[i],&jac->y[i]);CHKERRQ(ierr);
5590298fd71SBarry Smith       ilink->x = jac->x[i]; ilink->y = jac->y[i]; ilink->z = NULL;
560bdddcaaaSMatthew G Knepley       /* compute scatter contexts needed by multiplicative versions and non-default splits */
5610298fd71SBarry Smith       ierr = VecScatterCreate(xtmp,ilink->is,jac->x[i],NULL,&ilink->sctx);CHKERRQ(ierr);
562ed1f0337SMatthew G Knepley       /* Check for null space attached to IS */
563bafc1b83SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nullspace", (PetscObject*) &sp);CHKERRQ(ierr);
564bafc1b83SMatthew G Knepley       if (sp) {
565bafc1b83SMatthew G Knepley         ierr = MatSetNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
566bafc1b83SMatthew G Knepley       }
567ed1f0337SMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "nearnullspace", (PetscObject*) &sp);CHKERRQ(ierr);
568ed1f0337SMatthew G Knepley       if (sp) {
569ed1f0337SMatthew G Knepley         ierr = MatSetNearNullSpace(jac->pmat[i], sp);CHKERRQ(ierr);
570ed1f0337SMatthew G Knepley       }
571704ba839SBarry Smith       ilink = ilink->next;
572cf502942SBarry Smith     }
573bdddcaaaSMatthew G Knepley     ierr = VecDestroy(&xtmp);CHKERRQ(ierr);
57497bbdb24SBarry Smith   } else {
575cf502942SBarry Smith     for (i=0; i<nsplit; i++) {
576a3df900dSMatthew G Knepley       Mat pmat;
577a3df900dSMatthew G Knepley 
578a3df900dSMatthew G Knepley       /* Check for preconditioning matrix attached to IS */
579a3df900dSMatthew G Knepley       ierr = PetscObjectQuery((PetscObject) ilink->is, "pmat", (PetscObject*) &pmat);CHKERRQ(ierr);
580a3df900dSMatthew G Knepley       if (!pmat) {
5815f4ab4e1SJungho Lee         ierr = MatGetSubMatrix(pc->pmat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->pmat[i]);CHKERRQ(ierr);
582a3df900dSMatthew G Knepley       }
583704ba839SBarry Smith       ilink = ilink->next;
584cf502942SBarry Smith     }
58597bbdb24SBarry Smith   }
5864e39094bSDmitry Karpeev   if (jac->diag_use_amat) {
587519d70e2SJed Brown     ilink = jac->head;
588519d70e2SJed Brown     if (!jac->mat) {
589785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->mat);CHKERRQ(ierr);
590519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5915f4ab4e1SJungho Lee         ierr  = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_INITIAL_MATRIX,&jac->mat[i]);CHKERRQ(ierr);
592519d70e2SJed Brown         ilink = ilink->next;
593519d70e2SJed Brown       }
594519d70e2SJed Brown     } else {
595519d70e2SJed Brown       for (i=0; i<nsplit; i++) {
5965f4ab4e1SJungho Lee         if (jac->mat[i]) {ierr = MatGetSubMatrix(pc->mat,ilink->is,ilink->is_col,MAT_REUSE_MATRIX,&jac->mat[i]);CHKERRQ(ierr);}
597519d70e2SJed Brown         ilink = ilink->next;
598519d70e2SJed Brown       }
599519d70e2SJed Brown     }
600519d70e2SJed Brown   } else {
601519d70e2SJed Brown     jac->mat = jac->pmat;
602519d70e2SJed Brown   }
60397bbdb24SBarry Smith 
6046c8605c2SJed Brown   if (jac->type != PC_COMPOSITE_ADDITIVE  && jac->type != PC_COMPOSITE_SCHUR) {
60568dd23aaSBarry Smith     /* extract the rows of the matrix associated with each field: used for efficient computation of residual inside algorithm */
6064e39094bSDmitry Karpeev     /* FIXME: Can/should we reuse jac->mat whenever (jac->diag_use_amat) is true? */
60768dd23aaSBarry Smith     ilink = jac->head;
60868dd23aaSBarry Smith     if (!jac->Afield) {
609785e854fSJed Brown       ierr = PetscMalloc1(nsplit,&jac->Afield);CHKERRQ(ierr);
61068dd23aaSBarry Smith       for (i=0; i<nsplit; i++) {
6110298fd71SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_INITIAL_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
61268dd23aaSBarry Smith         ilink = ilink->next;
61368dd23aaSBarry Smith       }
61468dd23aaSBarry Smith     } else {
61568dd23aaSBarry Smith       for (i=0; i<nsplit; i++) {
6160298fd71SBarry Smith         ierr  = MatGetSubMatrix(pc->mat,ilink->is,NULL,MAT_REUSE_MATRIX,&jac->Afield[i]);CHKERRQ(ierr);
61768dd23aaSBarry Smith         ilink = ilink->next;
61868dd23aaSBarry Smith       }
61968dd23aaSBarry Smith     }
62068dd23aaSBarry Smith   }
62168dd23aaSBarry Smith 
6223b224e63SBarry Smith   if (jac->type == PC_COMPOSITE_SCHUR) {
6233b224e63SBarry Smith     IS          ccis;
6244aa3045dSJed Brown     PetscInt    rstart,rend;
625093c86ffSJed Brown     char        lscname[256];
626093c86ffSJed Brown     PetscObject LSC_L;
627ce94432eSBarry Smith 
628ce94432eSBarry Smith     if (nsplit != 2) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_INCOMP,"To use Schur complement preconditioner you must have exactly 2 fields");
62968dd23aaSBarry Smith 
630e6cab6aaSJed Brown     /* When extracting off-diagonal submatrices, we take complements from this range */
631e6cab6aaSJed Brown     ierr = MatGetOwnershipRangeColumn(pc->mat,&rstart,&rend);CHKERRQ(ierr);
632e6cab6aaSJed Brown 
6333b224e63SBarry Smith     /* need to handle case when one is resetting up the preconditioner */
6343b224e63SBarry Smith     if (jac->schur) {
6350298fd71SBarry Smith       KSP kspA = jac->head->ksp, kspInner = NULL, kspUpper = jac->kspupper;
636443836d0SMatthew G Knepley 
637fb3147dbSMatthew G Knepley       ierr  = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
6383b224e63SBarry Smith       ilink = jac->head;
63949bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6404e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6414aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
642c84da90fSDmitry Karpeev       } else {
643df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->B);CHKERRQ(ierr);
644c84da90fSDmitry Karpeev       }
645fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6463b224e63SBarry Smith       ilink = ilink->next;
64749bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6484e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6494aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
650c84da90fSDmitry Karpeev       } else {
651df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_REUSE_MATRIX,&jac->C);CHKERRQ(ierr);
652c84da90fSDmitry Karpeev       }
653fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
654aa6c7ce3SBarry Smith       ierr  = MatSchurComplementUpdateSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
655a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
656a7476a74SDmitry Karpeev 	ierr = MatDestroy(&jac->schurp);CHKERRQ(ierr);
657a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
658a7476a74SDmitry Karpeev       }
659443836d0SMatthew G Knepley       if (kspA != kspInner) {
66023ee1639SBarry Smith         ierr = KSPSetOperators(kspA,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
661443836d0SMatthew G Knepley       }
662443836d0SMatthew G Knepley       if (kspUpper != kspA) {
66323ee1639SBarry Smith         ierr = KSPSetOperators(kspUpper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
664443836d0SMatthew G Knepley       }
66523ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
6663b224e63SBarry Smith     } else {
667bafc1b83SMatthew G Knepley       const char   *Dprefix;
668470b340bSDmitry Karpeev       char         schurprefix[256], schurmatprefix[256];
669514bf10dSMatthew G Knepley       char         schurtestoption[256];
670bdddcaaaSMatthew G Knepley       MatNullSpace sp;
671514bf10dSMatthew G Knepley       PetscBool    flg;
6723b224e63SBarry Smith 
673a04f6461SBarry Smith       /* extract the A01 and A10 matrices */
6743b224e63SBarry Smith       ilink = jac->head;
67549bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6764e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6774aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
678c84da90fSDmitry Karpeev       } else {
679df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->B);CHKERRQ(ierr);
680c84da90fSDmitry Karpeev       }
681fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
6823b224e63SBarry Smith       ilink = ilink->next;
68349bb4cd7SJungho Lee       ierr  = ISComplement(ilink->is_col,rstart,rend,&ccis);CHKERRQ(ierr);
6844e39094bSDmitry Karpeev       if (jac->offdiag_use_amat) {
6854aa3045dSJed Brown 	ierr  = MatGetSubMatrix(pc->mat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
686c84da90fSDmitry Karpeev       } else {
687df06c9e3SDmitry Karpeev 	ierr  = MatGetSubMatrix(pc->pmat,ilink->is,ccis,MAT_INITIAL_MATRIX,&jac->C);CHKERRQ(ierr);
688c84da90fSDmitry Karpeev       }
689fcfd50ebSBarry Smith       ierr  = ISDestroy(&ccis);CHKERRQ(ierr);
69020252d06SBarry Smith 
691f5236f50SJed Brown       /* Use mat[0] (diagonal block of Amat) preconditioned by pmat[0] to define Schur complement */
69220252d06SBarry Smith       ierr = MatCreate(((PetscObject)jac->mat[0])->comm,&jac->schur);CHKERRQ(ierr);
69320252d06SBarry Smith       ierr = MatSetType(jac->schur,MATSCHURCOMPLEMENT);CHKERRQ(ierr);
694bee83525SDmitry Karpeev       ierr = MatSchurComplementSetSubMatrices(jac->schur,jac->mat[0],jac->pmat[0],jac->B,jac->C,jac->mat[1]);CHKERRQ(ierr);
695470b340bSDmitry Karpeev       ierr = PetscSNPrintf(schurmatprefix, sizeof(schurmatprefix), "%sfieldsplit_%s_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
696470b340bSDmitry 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? */
697470b340bSDmitry Karpeev       ierr = MatSetOptionsPrefix(jac->schur,schurmatprefix);CHKERRQ(ierr);
698470b340bSDmitry Karpeev       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
699bdddcaaaSMatthew G Knepley       ierr = MatGetNullSpace(jac->pmat[1], &sp);CHKERRQ(ierr);
70020252d06SBarry Smith       if (sp) {
70120252d06SBarry Smith         ierr = MatSetNullSpace(jac->schur, sp);CHKERRQ(ierr);
70220252d06SBarry Smith       }
70320252d06SBarry Smith 
70420252d06SBarry Smith       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_inner_", ilink->splitname);CHKERRQ(ierr);
7050298fd71SBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
706514bf10dSMatthew G Knepley       if (flg) {
707514bf10dSMatthew G Knepley         DM  dmInner;
70821635b76SJed Brown         KSP kspInner;
70921635b76SJed Brown 
71021635b76SJed Brown         ierr = MatSchurComplementGetKSP(jac->schur, &kspInner);CHKERRQ(ierr);
71121635b76SJed Brown         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_inner_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
71221635b76SJed Brown         /* Indent this deeper to emphasize the "inner" nature of this solver. */
71321635b76SJed Brown         ierr = PetscObjectIncrementTabLevel((PetscObject)kspInner, (PetscObject) pc, 2);CHKERRQ(ierr);
71421635b76SJed Brown         ierr = KSPSetOptionsPrefix(kspInner, schurprefix);CHKERRQ(ierr);
715514bf10dSMatthew G Knepley 
716514bf10dSMatthew G Knepley         /* Set DM for new solver */
717bafc1b83SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
71821635b76SJed Brown         ierr = KSPSetDM(kspInner, dmInner);CHKERRQ(ierr);
71921635b76SJed Brown         ierr = KSPSetDMActive(kspInner, PETSC_FALSE);CHKERRQ(ierr);
720514bf10dSMatthew G Knepley       } else {
72121635b76SJed Brown          /* Use the outer solver for the inner solve, but revert the KSPPREONLY from PCFieldSplitSetFields_FieldSplit or
72221635b76SJed Brown           * PCFieldSplitSetIS_FieldSplit. We don't want KSPPREONLY because it makes the Schur complement inexact,
72321635b76SJed Brown           * preventing Schur complement reduction to be an accurate solve. Usually when an iterative solver is used for
72421635b76SJed 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
72521635b76SJed Brown           * GMRES the default. Note that it is also common to use PREONLY for S, in which case S may not be used
72621635b76SJed Brown           * directly, and the user is responsible for setting an inexact method for fieldsplit's A^{-1}. */
72721635b76SJed Brown         ierr = KSPSetType(jac->head->ksp,KSPGMRES);CHKERRQ(ierr);
728514bf10dSMatthew G Knepley         ierr = MatSchurComplementSetKSP(jac->schur,jac->head->ksp);CHKERRQ(ierr);
729bafc1b83SMatthew G Knepley       }
73023ee1639SBarry Smith       ierr = KSPSetOperators(jac->head->ksp,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
7315a9f2f41SSatish Balay       ierr = KSPSetFromOptions(jac->head->ksp);CHKERRQ(ierr);
73297bbdb24SBarry Smith       ierr = MatSetFromOptions(jac->schur);CHKERRQ(ierr);
73397bbdb24SBarry Smith 
734443836d0SMatthew G Knepley       ierr = PetscSNPrintf(schurtestoption, sizeof(schurtestoption), "-fieldsplit_%s_upper_", ilink->splitname);CHKERRQ(ierr);
7350298fd71SBarry Smith       ierr = PetscOptionsFindPairPrefix_Private(((PetscObject)pc)->prefix, schurtestoption, NULL, &flg);CHKERRQ(ierr);
736443836d0SMatthew G Knepley       if (flg) {
737443836d0SMatthew G Knepley         DM dmInner;
738443836d0SMatthew G Knepley 
739443836d0SMatthew G Knepley         ierr = PetscSNPrintf(schurprefix, sizeof(schurprefix), "%sfieldsplit_%s_upper_", ((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "", ilink->splitname);CHKERRQ(ierr);
74082f516ccSBarry Smith         ierr = KSPCreate(PetscObjectComm((PetscObject)pc), &jac->kspupper);CHKERRQ(ierr);
741443836d0SMatthew G Knepley         ierr = KSPSetOptionsPrefix(jac->kspupper, schurprefix);CHKERRQ(ierr);
742443836d0SMatthew G Knepley         ierr = KSPGetDM(jac->head->ksp, &dmInner);CHKERRQ(ierr);
743443836d0SMatthew G Knepley         ierr = KSPSetDM(jac->kspupper, dmInner);CHKERRQ(ierr);
744443836d0SMatthew G Knepley         ierr = KSPSetDMActive(jac->kspupper, PETSC_FALSE);CHKERRQ(ierr);
745443836d0SMatthew G Knepley         ierr = KSPSetFromOptions(jac->kspupper);CHKERRQ(ierr);
74623ee1639SBarry Smith         ierr = KSPSetOperators(jac->kspupper,jac->mat[0],jac->pmat[0]);CHKERRQ(ierr);
747443836d0SMatthew G Knepley         ierr = VecDuplicate(jac->head->x, &jac->head->z);CHKERRQ(ierr);
748443836d0SMatthew G Knepley       } else {
749443836d0SMatthew G Knepley         jac->kspupper = jac->head->ksp;
750443836d0SMatthew G Knepley         ierr          = PetscObjectReference((PetscObject) jac->head->ksp);CHKERRQ(ierr);
751443836d0SMatthew G Knepley       }
752443836d0SMatthew G Knepley 
753a7476a74SDmitry Karpeev       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELFP) {
754a7476a74SDmitry Karpeev 	ierr = MatSchurComplementGetPmat(jac->schur,MAT_INITIAL_MATRIX,&jac->schurp);CHKERRQ(ierr);
755a7476a74SDmitry Karpeev       }
756ce94432eSBarry Smith       ierr = KSPCreate(PetscObjectComm((PetscObject)pc),&jac->kspschur);CHKERRQ(ierr);
75797bbdb24SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)jac->kspschur);CHKERRQ(ierr);
75820252d06SBarry Smith       ierr = PetscObjectIncrementTabLevel((PetscObject)jac->kspschur,(PetscObject)pc,1);CHKERRQ(ierr);
75997bbdb24SBarry Smith       if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_SELF) {
7607233a360SDmitry Karpeev         PC pcschur;
7617233a360SDmitry Karpeev         ierr = KSPGetPC(jac->kspschur,&pcschur);CHKERRQ(ierr);
7627233a360SDmitry Karpeev         ierr = PCSetType(pcschur,PCNONE);CHKERRQ(ierr);
76397bbdb24SBarry Smith         /* Note: This is bad if there exist preconditioners for MATSCHURCOMPLEMENT */
764e74569cdSMatthew G. Knepley       } else if (jac->schurpre == PC_FIELDSPLIT_SCHUR_PRE_FULL) {
765e74569cdSMatthew G. Knepley         ierr = MatSchurComplementComputeExplicitOperator(jac->schur, &jac->schur_user);CHKERRQ(ierr);
76697bbdb24SBarry Smith       }
76723ee1639SBarry Smith       ierr = KSPSetOperators(jac->kspschur,jac->schur,FieldSplitSchurPre(jac));CHKERRQ(ierr);
76897bbdb24SBarry Smith       ierr = KSPGetOptionsPrefix(jac->head->next->ksp, &Dprefix);CHKERRQ(ierr);
76997bbdb24SBarry Smith       ierr = KSPSetOptionsPrefix(jac->kspschur,         Dprefix);CHKERRQ(ierr);
770b20b4189SMatthew G. Knepley       /* propogate DM */
771b20b4189SMatthew G. Knepley       {
772b20b4189SMatthew G. Knepley         DM sdm;
773b20b4189SMatthew G. Knepley         ierr = KSPGetDM(jac->head->next->ksp, &sdm);CHKERRQ(ierr);
774b20b4189SMatthew G. Knepley         if (sdm) {
775b20b4189SMatthew G. Knepley           ierr = KSPSetDM(jac->kspschur, sdm);CHKERRQ(ierr);
776b20b4189SMatthew G. Knepley           ierr = KSPSetDMActive(jac->kspschur, PETSC_FALSE);CHKERRQ(ierr);
777b20b4189SMatthew G. Knepley         }
778b20b4189SMatthew G. Knepley       }
77997bbdb24SBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
78097bbdb24SBarry Smith       /* need to call this every time, since the jac->kspschur is freshly created, otherwise its options never get set */
78197bbdb24SBarry Smith       ierr = KSPSetFromOptions(jac->kspschur);CHKERRQ(ierr);
78297bbdb24SBarry Smith     }
78397bbdb24SBarry Smith 
7845a9f2f41SSatish Balay     /* HACK: special support to forward L and Lp matrices that might be used by PCLSC */
7858caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_L",ilink->splitname);CHKERRQ(ierr);
786519d70e2SJed Brown     ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
7873b224e63SBarry Smith     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
788c1570756SJed Brown     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_L",(PetscObject)LSC_L);CHKERRQ(ierr);}
7898caf3d72SBarry Smith     ierr = PetscSNPrintf(lscname,sizeof(lscname),"%s_LSC_Lp",ilink->splitname);CHKERRQ(ierr);
79097bbdb24SBarry Smith     ierr = PetscObjectQuery((PetscObject)pc->pmat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);
7915a9f2f41SSatish Balay     if (!LSC_L) {ierr = PetscObjectQuery((PetscObject)pc->mat,lscname,(PetscObject*)&LSC_L);CHKERRQ(ierr);}
7920971522cSBarry Smith     if (LSC_L) {ierr = PetscObjectCompose((PetscObject)jac->schur,"LSC_Lp",(PetscObject)LSC_L);CHKERRQ(ierr);}
79397bbdb24SBarry Smith   } else {
79468bd789dSDmitry Karpeev     /* set up the individual splits' PCs */
7950971522cSBarry Smith     i     = 0;
7960971522cSBarry Smith     ilink = jac->head;
7970971522cSBarry Smith     while (ilink) {
79823ee1639SBarry Smith       ierr = KSPSetOperators(ilink->ksp,jac->mat[i],jac->pmat[i]);CHKERRQ(ierr);
7990971522cSBarry Smith       /* really want setfromoptions called in PCSetFromOptions_FieldSplit(), but it is not ready yet */
8000971522cSBarry Smith       if (!jac->suboptionsset) {ierr = KSPSetFromOptions(ilink->ksp);CHKERRQ(ierr);}
8010971522cSBarry Smith       i++;
8020971522cSBarry Smith       ilink = ilink->next;
8030971522cSBarry Smith     }
8043b224e63SBarry Smith   }
8053b224e63SBarry Smith 
806c1570756SJed Brown   jac->suboptionsset = PETSC_TRUE;
8070971522cSBarry Smith   PetscFunctionReturn(0);
8080971522cSBarry Smith }
8090971522cSBarry Smith 
8105a9f2f41SSatish Balay #define FieldSplitSplitSolveAdd(ilink,xx,yy) \
811ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
812ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->x,INSERT_VALUES,SCATTER_FORWARD) || \
8135a9f2f41SSatish Balay    KSPSolve(ilink->ksp,ilink->x,ilink->y) || \
814ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE) || \
815ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->y,yy,ADD_VALUES,SCATTER_REVERSE))
81679416396SBarry Smith 
8170971522cSBarry Smith #undef __FUNCT__
8183b224e63SBarry Smith #define __FUNCT__ "PCApply_FieldSplit_Schur"
8193b224e63SBarry Smith static PetscErrorCode PCApply_FieldSplit_Schur(PC pc,Vec x,Vec y)
8203b224e63SBarry Smith {
8213b224e63SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
8223b224e63SBarry Smith   PetscErrorCode    ierr;
8233b224e63SBarry Smith   PC_FieldSplitLink ilinkA = jac->head, ilinkD = ilinkA->next;
824443836d0SMatthew G Knepley   KSP               kspA   = ilinkA->ksp, kspLower = kspA, kspUpper = jac->kspupper;
8253b224e63SBarry Smith 
8263b224e63SBarry Smith   PetscFunctionBegin;
827c5d2311dSJed Brown   switch (jac->schurfactorization) {
828c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_DIAG:
829a04f6461SBarry Smith     /* [A00 0; 0 -S], positive definite, suitable for MINRES */
830c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
831c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
832c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
833443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
834c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
835c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
836c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
837c5d2311dSJed Brown     ierr = VecScale(ilinkD->y,-1.);CHKERRQ(ierr);
838c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
839c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
840c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
841c5d2311dSJed Brown     break;
842c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_LOWER:
843a04f6461SBarry Smith     /* [A00 0; A10 S], suitable for left preconditioning */
844c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
845c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
846443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
847c5d2311dSJed Brown     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
848c5d2311dSJed Brown     ierr = VecScale(ilinkD->x,-1.);CHKERRQ(ierr);
849c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
850c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
851c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
852c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
853c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
854c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
855c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
856c5d2311dSJed Brown     break;
857c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_UPPER:
858a04f6461SBarry Smith     /* [A00 A01; 0 S], suitable for right preconditioning */
859c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
860c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
861c5d2311dSJed Brown     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
862c5d2311dSJed Brown     ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
863c5d2311dSJed Brown     ierr = VecScale(ilinkA->x,-1.);CHKERRQ(ierr);
864c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
865c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
866c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
867443836d0SMatthew G Knepley     ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
868c5d2311dSJed Brown     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
869c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
870c5d2311dSJed Brown     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
871c5d2311dSJed Brown     break;
872c9c6ffaaSJed Brown   case PC_FIELDSPLIT_SCHUR_FACT_FULL:
873a04f6461SBarry 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 */
8743b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8753b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,x,ilinkA->x,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
876443836d0SMatthew G Knepley     ierr = KSPSolve(kspLower,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
8773b224e63SBarry Smith     ierr = MatMult(jac->C,ilinkA->y,ilinkD->x);CHKERRQ(ierr);
8783b224e63SBarry Smith     ierr = VecScale(ilinkD->x,-1.0);CHKERRQ(ierr);
8793b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8803b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,x,ilinkD->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
8813b224e63SBarry Smith 
8823b224e63SBarry Smith     ierr = KSPSolve(jac->kspschur,ilinkD->x,ilinkD->y);CHKERRQ(ierr);
8833b224e63SBarry Smith     ierr = VecScatterBegin(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
8843b224e63SBarry Smith     ierr = VecScatterEnd(ilinkD->sctx,ilinkD->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
8853b224e63SBarry Smith 
886443836d0SMatthew G Knepley     if (kspUpper == kspA) {
8873b224e63SBarry Smith       ierr = MatMult(jac->B,ilinkD->y,ilinkA->y);CHKERRQ(ierr);
8883b224e63SBarry Smith       ierr = VecAXPY(ilinkA->x,-1.0,ilinkA->y);CHKERRQ(ierr);
889443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
890443836d0SMatthew G Knepley     } else {
891443836d0SMatthew G Knepley       ierr = KSPSolve(kspA,ilinkA->x,ilinkA->y);CHKERRQ(ierr);
892443836d0SMatthew G Knepley       ierr = MatMult(jac->B,ilinkD->y,ilinkA->x);CHKERRQ(ierr);
893443836d0SMatthew G Knepley       ierr = KSPSolve(kspUpper,ilinkA->x,ilinkA->z);CHKERRQ(ierr);
894443836d0SMatthew G Knepley       ierr = VecAXPY(ilinkA->y,-1.0,ilinkA->z);CHKERRQ(ierr);
895443836d0SMatthew G Knepley     }
8963b224e63SBarry Smith     ierr = VecScatterBegin(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
8973b224e63SBarry Smith     ierr = VecScatterEnd(ilinkA->sctx,ilinkA->y,y,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
898c5d2311dSJed Brown   }
8993b224e63SBarry Smith   PetscFunctionReturn(0);
9003b224e63SBarry Smith }
9013b224e63SBarry Smith 
9023b224e63SBarry Smith #undef __FUNCT__
9030971522cSBarry Smith #define __FUNCT__ "PCApply_FieldSplit"
9040971522cSBarry Smith static PetscErrorCode PCApply_FieldSplit(PC pc,Vec x,Vec y)
9050971522cSBarry Smith {
9060971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
9070971522cSBarry Smith   PetscErrorCode    ierr;
9085a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
909939b8a20SBarry Smith   PetscInt          cnt,bs;
9100971522cSBarry Smith 
9110971522cSBarry Smith   PetscFunctionBegin;
91279416396SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
9131b9fc7fcSBarry Smith     if (jac->defaultsplit) {
914939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
915ce94432eSBarry 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);
916939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
917ce94432eSBarry 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);
9180971522cSBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
9195a9f2f41SSatish Balay       while (ilink) {
9205a9f2f41SSatish Balay         ierr  = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9215a9f2f41SSatish Balay         ilink = ilink->next;
9220971522cSBarry Smith       }
9230971522cSBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
9241b9fc7fcSBarry Smith     } else {
925efb30889SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
9265a9f2f41SSatish Balay       while (ilink) {
9275a9f2f41SSatish Balay         ierr  = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
9285a9f2f41SSatish Balay         ilink = ilink->next;
9291b9fc7fcSBarry Smith       }
9301b9fc7fcSBarry Smith     }
93116913363SBarry Smith   } else if (jac->type == PC_COMPOSITE_MULTIPLICATIVE || jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
93279416396SBarry Smith     if (!jac->w1) {
93379416396SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
93479416396SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
93579416396SBarry Smith     }
936efb30889SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
9375a9f2f41SSatish Balay     ierr = FieldSplitSplitSolveAdd(ilink,x,y);CHKERRQ(ierr);
9383e197d65SBarry Smith     cnt  = 1;
9395a9f2f41SSatish Balay     while (ilink->next) {
9405a9f2f41SSatish Balay       ilink = ilink->next;
9413e197d65SBarry Smith       /* compute the residual only over the part of the vector needed */
9423e197d65SBarry Smith       ierr = MatMult(jac->Afield[cnt++],y,ilink->x);CHKERRQ(ierr);
9433e197d65SBarry Smith       ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
9443e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9453e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
9463e197d65SBarry Smith       ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
9473e197d65SBarry Smith       ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9483e197d65SBarry Smith       ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
9493e197d65SBarry Smith     }
95051f519a2SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
95111755939SBarry Smith       cnt -= 2;
95251f519a2SBarry Smith       while (ilink->previous) {
95351f519a2SBarry Smith         ilink = ilink->previous;
95411755939SBarry Smith         /* compute the residual only over the part of the vector needed */
95511755939SBarry Smith         ierr = MatMult(jac->Afield[cnt--],y,ilink->x);CHKERRQ(ierr);
95611755939SBarry Smith         ierr = VecScale(ilink->x,-1.0);CHKERRQ(ierr);
95711755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
95811755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,x,ilink->x,ADD_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
95911755939SBarry Smith         ierr = KSPSolve(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
96011755939SBarry Smith         ierr = VecScatterBegin(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
96111755939SBarry Smith         ierr = VecScatterEnd(ilink->sctx,ilink->y,y,ADD_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
96251f519a2SBarry Smith       }
96311755939SBarry Smith     }
964ce94432eSBarry Smith   } else SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_SUP,"Unsupported or unknown composition",(int) jac->type);
9650971522cSBarry Smith   PetscFunctionReturn(0);
9660971522cSBarry Smith }
9670971522cSBarry Smith 
968421e10b8SBarry Smith #define FieldSplitSplitSolveAddTranspose(ilink,xx,yy) \
969ca9f406cSSatish Balay   (VecScatterBegin(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
970ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,xx,ilink->y,INSERT_VALUES,SCATTER_FORWARD) || \
971421e10b8SBarry Smith    KSPSolveTranspose(ilink->ksp,ilink->y,ilink->x) || \
972ca9f406cSSatish Balay    VecScatterBegin(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE) || \
973ca9f406cSSatish Balay    VecScatterEnd(ilink->sctx,ilink->x,yy,ADD_VALUES,SCATTER_REVERSE))
974421e10b8SBarry Smith 
975421e10b8SBarry Smith #undef __FUNCT__
9768c03b21aSDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_FieldSplit"
977421e10b8SBarry Smith static PetscErrorCode PCApplyTranspose_FieldSplit(PC pc,Vec x,Vec y)
978421e10b8SBarry Smith {
979421e10b8SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
980421e10b8SBarry Smith   PetscErrorCode    ierr;
981421e10b8SBarry Smith   PC_FieldSplitLink ilink = jac->head;
982939b8a20SBarry Smith   PetscInt          bs;
983421e10b8SBarry Smith 
984421e10b8SBarry Smith   PetscFunctionBegin;
985421e10b8SBarry Smith   if (jac->type == PC_COMPOSITE_ADDITIVE) {
986421e10b8SBarry Smith     if (jac->defaultsplit) {
987939b8a20SBarry Smith       ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
988ce94432eSBarry 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);
989939b8a20SBarry Smith       ierr = VecGetBlockSize(y,&bs);CHKERRQ(ierr);
990ce94432eSBarry 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);
991421e10b8SBarry Smith       ierr = VecStrideGatherAll(x,jac->x,INSERT_VALUES);CHKERRQ(ierr);
992421e10b8SBarry Smith       while (ilink) {
993421e10b8SBarry Smith         ierr  = KSPSolveTranspose(ilink->ksp,ilink->x,ilink->y);CHKERRQ(ierr);
994421e10b8SBarry Smith         ilink = ilink->next;
995421e10b8SBarry Smith       }
996421e10b8SBarry Smith       ierr = VecStrideScatterAll(jac->y,y,INSERT_VALUES);CHKERRQ(ierr);
997421e10b8SBarry Smith     } else {
998421e10b8SBarry Smith       ierr = VecSet(y,0.0);CHKERRQ(ierr);
999421e10b8SBarry Smith       while (ilink) {
1000421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1001421e10b8SBarry Smith         ilink = ilink->next;
1002421e10b8SBarry Smith       }
1003421e10b8SBarry Smith     }
1004421e10b8SBarry Smith   } else {
1005421e10b8SBarry Smith     if (!jac->w1) {
1006421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w1);CHKERRQ(ierr);
1007421e10b8SBarry Smith       ierr = VecDuplicate(x,&jac->w2);CHKERRQ(ierr);
1008421e10b8SBarry Smith     }
1009421e10b8SBarry Smith     ierr = VecSet(y,0.0);CHKERRQ(ierr);
1010421e10b8SBarry Smith     if (jac->type == PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE) {
1011421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1012421e10b8SBarry Smith       while (ilink->next) {
1013421e10b8SBarry Smith         ilink = ilink->next;
10149989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1015421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1016421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1017421e10b8SBarry Smith       }
1018421e10b8SBarry Smith       while (ilink->previous) {
1019421e10b8SBarry Smith         ilink = ilink->previous;
10209989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1021421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1022421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1023421e10b8SBarry Smith       }
1024421e10b8SBarry Smith     } else {
1025421e10b8SBarry Smith       while (ilink->next) {   /* get to last entry in linked list */
1026421e10b8SBarry Smith         ilink = ilink->next;
1027421e10b8SBarry Smith       }
1028421e10b8SBarry Smith       ierr = FieldSplitSplitSolveAddTranspose(ilink,x,y);CHKERRQ(ierr);
1029421e10b8SBarry Smith       while (ilink->previous) {
1030421e10b8SBarry Smith         ilink = ilink->previous;
10319989ab13SBarry Smith         ierr  = MatMultTranspose(pc->mat,y,jac->w1);CHKERRQ(ierr);
1032421e10b8SBarry Smith         ierr  = VecWAXPY(jac->w2,-1.0,jac->w1,x);CHKERRQ(ierr);
1033421e10b8SBarry Smith         ierr  = FieldSplitSplitSolveAddTranspose(ilink,jac->w2,y);CHKERRQ(ierr);
1034421e10b8SBarry Smith       }
1035421e10b8SBarry Smith     }
1036421e10b8SBarry Smith   }
1037421e10b8SBarry Smith   PetscFunctionReturn(0);
1038421e10b8SBarry Smith }
1039421e10b8SBarry Smith 
10400971522cSBarry Smith #undef __FUNCT__
1041574deadeSBarry Smith #define __FUNCT__ "PCReset_FieldSplit"
1042574deadeSBarry Smith static PetscErrorCode PCReset_FieldSplit(PC pc)
10430971522cSBarry Smith {
10440971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
10450971522cSBarry Smith   PetscErrorCode    ierr;
10465a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head,next;
10470971522cSBarry Smith 
10480971522cSBarry Smith   PetscFunctionBegin;
10495a9f2f41SSatish Balay   while (ilink) {
1050574deadeSBarry Smith     ierr  = KSPReset(ilink->ksp);CHKERRQ(ierr);
1051fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->x);CHKERRQ(ierr);
1052fcfd50ebSBarry Smith     ierr  = VecDestroy(&ilink->y);CHKERRQ(ierr);
1053443836d0SMatthew G Knepley     ierr  = VecDestroy(&ilink->z);CHKERRQ(ierr);
1054fcfd50ebSBarry Smith     ierr  = VecScatterDestroy(&ilink->sctx);CHKERRQ(ierr);
1055fcfd50ebSBarry Smith     ierr  = ISDestroy(&ilink->is);CHKERRQ(ierr);
1056b5787286SJed Brown     ierr  = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
10575a9f2f41SSatish Balay     next  = ilink->next;
10585a9f2f41SSatish Balay     ilink = next;
10590971522cSBarry Smith   }
106005b42c5fSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1061574deadeSBarry Smith   if (jac->mat && jac->mat != jac->pmat) {
1062574deadeSBarry Smith     ierr = MatDestroyMatrices(jac->nsplits,&jac->mat);CHKERRQ(ierr);
1063574deadeSBarry Smith   } else if (jac->mat) {
10640298fd71SBarry Smith     jac->mat = NULL;
1065574deadeSBarry Smith   }
106697bbdb24SBarry Smith   if (jac->pmat) {ierr = MatDestroyMatrices(jac->nsplits,&jac->pmat);CHKERRQ(ierr);}
106768dd23aaSBarry Smith   if (jac->Afield) {ierr = MatDestroyMatrices(jac->nsplits,&jac->Afield);CHKERRQ(ierr);}
10686bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w1);CHKERRQ(ierr);
10696bf464f9SBarry Smith   ierr       = VecDestroy(&jac->w2);CHKERRQ(ierr);
10706bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur);CHKERRQ(ierr);
1071a7476a74SDmitry Karpeev   ierr       = MatDestroy(&jac->schurp);CHKERRQ(ierr);
10726bf464f9SBarry Smith   ierr       = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
10736bf464f9SBarry Smith   ierr       = KSPDestroy(&jac->kspschur);CHKERRQ(ierr);
1074d78dad28SBarry Smith   ierr       = KSPDestroy(&jac->kspupper);CHKERRQ(ierr);
10756bf464f9SBarry Smith   ierr       = MatDestroy(&jac->B);CHKERRQ(ierr);
10766bf464f9SBarry Smith   ierr       = MatDestroy(&jac->C);CHKERRQ(ierr);
107763ec74ffSBarry Smith   jac->reset = PETSC_TRUE;
1078574deadeSBarry Smith   PetscFunctionReturn(0);
1079574deadeSBarry Smith }
1080574deadeSBarry Smith 
1081574deadeSBarry Smith #undef __FUNCT__
1082574deadeSBarry Smith #define __FUNCT__ "PCDestroy_FieldSplit"
1083574deadeSBarry Smith static PetscErrorCode PCDestroy_FieldSplit(PC pc)
1084574deadeSBarry Smith {
1085574deadeSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1086574deadeSBarry Smith   PetscErrorCode    ierr;
1087574deadeSBarry Smith   PC_FieldSplitLink ilink = jac->head,next;
1088574deadeSBarry Smith 
1089574deadeSBarry Smith   PetscFunctionBegin;
1090574deadeSBarry Smith   ierr = PCReset_FieldSplit(pc);CHKERRQ(ierr);
1091574deadeSBarry Smith   while (ilink) {
10926bf464f9SBarry Smith     ierr  = KSPDestroy(&ilink->ksp);CHKERRQ(ierr);
1093574deadeSBarry Smith     next  = ilink->next;
1094574deadeSBarry Smith     ierr  = PetscFree(ilink->splitname);CHKERRQ(ierr);
1095574deadeSBarry Smith     ierr  = PetscFree(ilink->fields);CHKERRQ(ierr);
10965d4c12cdSJungho Lee     ierr  = PetscFree(ilink->fields_col);CHKERRQ(ierr);
1097574deadeSBarry Smith     ierr  = PetscFree(ilink);CHKERRQ(ierr);
1098574deadeSBarry Smith     ilink = next;
1099574deadeSBarry Smith   }
1100574deadeSBarry Smith   ierr = PetscFree2(jac->x,jac->y);CHKERRQ(ierr);
1101c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
1102bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",NULL);CHKERRQ(ierr);
1103bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",NULL);CHKERRQ(ierr);
1104bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",NULL);CHKERRQ(ierr);
1105bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",NULL);CHKERRQ(ierr);
1106bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",NULL);CHKERRQ(ierr);
110729f8a81cSJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",NULL);CHKERRQ(ierr);
110837a82bf0SJed Brown   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",NULL);CHKERRQ(ierr);
1109bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",NULL);CHKERRQ(ierr);
11100971522cSBarry Smith   PetscFunctionReturn(0);
11110971522cSBarry Smith }
11120971522cSBarry Smith 
11130971522cSBarry Smith #undef __FUNCT__
11140971522cSBarry Smith #define __FUNCT__ "PCSetFromOptions_FieldSplit"
11158c34d3f5SBarry Smith static PetscErrorCode PCSetFromOptions_FieldSplit(PetscOptions *PetscOptionsObject,PC pc)
11160971522cSBarry Smith {
11171b9fc7fcSBarry Smith   PetscErrorCode  ierr;
11186c924f48SJed Brown   PetscInt        bs;
1119bc59fbc5SBarry Smith   PetscBool       flg,stokes = PETSC_FALSE;
11209dcbbd2bSBarry Smith   PC_FieldSplit   *jac = (PC_FieldSplit*)pc->data;
11213b224e63SBarry Smith   PCCompositeType ctype;
11221b9fc7fcSBarry Smith 
11230971522cSBarry Smith   PetscFunctionBegin;
1124e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"FieldSplit options");CHKERRQ(ierr);
11254ab8060aSDmitry Karpeev   ierr = PetscOptionsBool("-pc_fieldsplit_dm_splits","Whether to use DMCreateFieldDecomposition() for splits","PCFieldSplitSetDMSplits",jac->dm_splits,&jac->dm_splits,NULL);CHKERRQ(ierr);
112651f519a2SBarry Smith   ierr = PetscOptionsInt("-pc_fieldsplit_block_size","Blocksize that defines number of fields","PCFieldSplitSetBlockSize",jac->bs,&bs,&flg);CHKERRQ(ierr);
112751f519a2SBarry Smith   if (flg) {
112851f519a2SBarry Smith     ierr = PCFieldSplitSetBlockSize(pc,bs);CHKERRQ(ierr);
112951f519a2SBarry Smith   }
1130*2686e3e9SMatthew G. Knepley   jac->diag_use_amat = pc->useAmat;
1131*2686e3e9SMatthew 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);
1132*2686e3e9SMatthew G. Knepley   jac->offdiag_use_amat = pc->useAmat;
1133*2686e3e9SMatthew 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);
113400216929SDmitry Karpeev   /* FIXME: No programmatic equivalent to the following. */
11350298fd71SBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)pc)->prefix,"-pc_fieldsplit_detect_saddle_point",&stokes,NULL);CHKERRQ(ierr);
1136c0adfefeSBarry Smith   if (stokes) {
1137c0adfefeSBarry Smith     ierr          = PCFieldSplitSetType(pc,PC_COMPOSITE_SCHUR);CHKERRQ(ierr);
1138c0adfefeSBarry Smith     jac->schurpre = PC_FIELDSPLIT_SCHUR_PRE_SELF;
1139c0adfefeSBarry Smith   }
1140c0adfefeSBarry Smith 
11413b224e63SBarry Smith   ierr = PetscOptionsEnum("-pc_fieldsplit_type","Type of composition","PCFieldSplitSetType",PCCompositeTypes,(PetscEnum)jac->type,(PetscEnum*)&ctype,&flg);CHKERRQ(ierr);
11423b224e63SBarry Smith   if (flg) {
11433b224e63SBarry Smith     ierr = PCFieldSplitSetType(pc,ctype);CHKERRQ(ierr);
11443b224e63SBarry Smith   }
1145c30613efSMatthew Knepley   /* Only setup fields once */
1146c30613efSMatthew Knepley   if ((jac->bs > 0) && (jac->nsplits == 0)) {
1147d32f9abdSBarry Smith     /* only allow user to set fields from command line if bs is already known.
1148d32f9abdSBarry Smith        otherwise user can set them in PCFieldSplitSetDefaults() */
11496c924f48SJed Brown     ierr = PCFieldSplitSetRuntimeSplits_Private(pc);CHKERRQ(ierr);
11506c924f48SJed Brown     if (jac->splitdefined) {ierr = PetscInfo(pc,"Splits defined using the options database\n");CHKERRQ(ierr);}
1151d32f9abdSBarry Smith   }
1152c5d2311dSJed Brown   if (jac->type == PC_COMPOSITE_SCHUR) {
1153c9c6ffaaSJed Brown     ierr = PetscOptionsGetEnum(((PetscObject)pc)->prefix,"-pc_fieldsplit_schur_factorization_type",PCFieldSplitSchurFactTypes,(PetscEnum*)&jac->schurfactorization,&flg);CHKERRQ(ierr);
1154c9c6ffaaSJed Brown     if (flg) {ierr = PetscInfo(pc,"Deprecated use of -pc_fieldsplit_schur_factorization_type\n");CHKERRQ(ierr);}
11550298fd71SBarry 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);
115629f8a81cSJed 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);
1157c5d2311dSJed Brown   }
11581b9fc7fcSBarry Smith   ierr = PetscOptionsTail();CHKERRQ(ierr);
11590971522cSBarry Smith   PetscFunctionReturn(0);
11600971522cSBarry Smith }
11610971522cSBarry Smith 
11620971522cSBarry Smith /*------------------------------------------------------------------------------------*/
11630971522cSBarry Smith 
11640971522cSBarry Smith #undef __FUNCT__
11650971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields_FieldSplit"
11661e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetFields_FieldSplit(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
11670971522cSBarry Smith {
116897bbdb24SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
11690971522cSBarry Smith   PetscErrorCode    ierr;
11705a9f2f41SSatish Balay   PC_FieldSplitLink ilink,next = jac->head;
117169a612a9SBarry Smith   char              prefix[128];
11725d4c12cdSJungho Lee   PetscInt          i;
11730971522cSBarry Smith 
11740971522cSBarry Smith   PetscFunctionBegin;
11756c924f48SJed Brown   if (jac->splitdefined) {
11766c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
11776c924f48SJed Brown     PetscFunctionReturn(0);
11786c924f48SJed Brown   }
117951f519a2SBarry Smith   for (i=0; i<n; i++) {
1180e32f2f54SBarry 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);
1181e32f2f54SBarry Smith     if (fields[i] < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Negative field %D requested",fields[i]);
118251f519a2SBarry Smith   }
1183b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1184a04f6461SBarry Smith   if (splitname) {
1185db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1186a04f6461SBarry Smith   } else {
1187785e854fSJed Brown     ierr = PetscMalloc1(3,&ilink->splitname);CHKERRQ(ierr);
1188a04f6461SBarry Smith     ierr = PetscSNPrintf(ilink->splitname,2,"%s",jac->nsplits);CHKERRQ(ierr);
1189a04f6461SBarry Smith   }
1190785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields);CHKERRQ(ierr);
11915a9f2f41SSatish Balay   ierr = PetscMemcpy(ilink->fields,fields,n*sizeof(PetscInt));CHKERRQ(ierr);
1192785e854fSJed Brown   ierr = PetscMalloc1(n,&ilink->fields_col);CHKERRQ(ierr);
11935d4c12cdSJungho Lee   ierr = PetscMemcpy(ilink->fields_col,fields_col,n*sizeof(PetscInt));CHKERRQ(ierr);
11942fa5cd67SKarl Rupp 
11955a9f2f41SSatish Balay   ilink->nfields = n;
11960298fd71SBarry Smith   ilink->next    = NULL;
1197ce94432eSBarry Smith   ierr           = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
119820252d06SBarry Smith   ierr           = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
11995a9f2f41SSatish Balay   ierr           = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
12009005cf84SBarry Smith   ierr           = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
120169a612a9SBarry Smith 
12028caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
12035a9f2f41SSatish Balay   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
12040971522cSBarry Smith 
12050971522cSBarry Smith   if (!next) {
12065a9f2f41SSatish Balay     jac->head       = ilink;
12070298fd71SBarry Smith     ilink->previous = NULL;
12080971522cSBarry Smith   } else {
12090971522cSBarry Smith     while (next->next) {
12100971522cSBarry Smith       next = next->next;
12110971522cSBarry Smith     }
12125a9f2f41SSatish Balay     next->next      = ilink;
121351f519a2SBarry Smith     ilink->previous = next;
12140971522cSBarry Smith   }
12150971522cSBarry Smith   jac->nsplits++;
12160971522cSBarry Smith   PetscFunctionReturn(0);
12170971522cSBarry Smith }
12180971522cSBarry Smith 
1219e69d4d44SBarry Smith #undef __FUNCT__
1220e69d4d44SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit_Schur"
12211e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit_Schur(PC pc,PetscInt *n,KSP **subksp)
1222e69d4d44SBarry Smith {
1223e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1224e69d4d44SBarry Smith   PetscErrorCode ierr;
1225e69d4d44SBarry Smith 
1226e69d4d44SBarry Smith   PetscFunctionBegin;
1227785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
1228e69d4d44SBarry Smith   ierr = MatSchurComplementGetKSP(jac->schur,*subksp);CHKERRQ(ierr);
12292fa5cd67SKarl Rupp 
1230e69d4d44SBarry Smith   (*subksp)[1] = jac->kspschur;
123113e0d083SBarry Smith   if (n) *n = jac->nsplits;
1232e69d4d44SBarry Smith   PetscFunctionReturn(0);
1233e69d4d44SBarry Smith }
12340971522cSBarry Smith 
12350971522cSBarry Smith #undef __FUNCT__
123669a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP_FieldSplit"
12371e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitGetSubKSP_FieldSplit(PC pc,PetscInt *n,KSP **subksp)
12380971522cSBarry Smith {
12390971522cSBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
12400971522cSBarry Smith   PetscErrorCode    ierr;
12410971522cSBarry Smith   PetscInt          cnt   = 0;
12425a9f2f41SSatish Balay   PC_FieldSplitLink ilink = jac->head;
12430971522cSBarry Smith 
12440971522cSBarry Smith   PetscFunctionBegin;
1245785e854fSJed Brown   ierr = PetscMalloc1(jac->nsplits,subksp);CHKERRQ(ierr);
12465a9f2f41SSatish Balay   while (ilink) {
12475a9f2f41SSatish Balay     (*subksp)[cnt++] = ilink->ksp;
12485a9f2f41SSatish Balay     ilink            = ilink->next;
12490971522cSBarry Smith   }
12505d480477SMatthew 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);
125113e0d083SBarry Smith   if (n) *n = jac->nsplits;
12520971522cSBarry Smith   PetscFunctionReturn(0);
12530971522cSBarry Smith }
12540971522cSBarry Smith 
1255704ba839SBarry Smith #undef __FUNCT__
1256704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS_FieldSplit"
12571e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetIS_FieldSplit(PC pc,const char splitname[],IS is)
1258704ba839SBarry Smith {
1259704ba839SBarry Smith   PC_FieldSplit     *jac = (PC_FieldSplit*)pc->data;
1260704ba839SBarry Smith   PetscErrorCode    ierr;
1261704ba839SBarry Smith   PC_FieldSplitLink ilink, next = jac->head;
1262704ba839SBarry Smith   char              prefix[128];
1263704ba839SBarry Smith 
1264704ba839SBarry Smith   PetscFunctionBegin;
12656c924f48SJed Brown   if (jac->splitdefined) {
12666c924f48SJed Brown     ierr = PetscInfo1(pc,"Ignoring new split \"%s\" because the splits have already been defined\n",splitname);CHKERRQ(ierr);
12676c924f48SJed Brown     PetscFunctionReturn(0);
12686c924f48SJed Brown   }
1269b00a9115SJed Brown   ierr = PetscNew(&ilink);CHKERRQ(ierr);
1270a04f6461SBarry Smith   if (splitname) {
1271db4c96c1SJed Brown     ierr = PetscStrallocpy(splitname,&ilink->splitname);CHKERRQ(ierr);
1272a04f6461SBarry Smith   } else {
1273785e854fSJed Brown     ierr = PetscMalloc1(8,&ilink->splitname);CHKERRQ(ierr);
1274b5787286SJed Brown     ierr = PetscSNPrintf(ilink->splitname,7,"%D",jac->nsplits);CHKERRQ(ierr);
1275a04f6461SBarry Smith   }
12761ab39975SBarry Smith   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1277b5787286SJed Brown   ierr          = ISDestroy(&ilink->is);CHKERRQ(ierr);
1278b5787286SJed Brown   ilink->is     = is;
1279b5787286SJed Brown   ierr          = PetscObjectReference((PetscObject)is);CHKERRQ(ierr);
1280b5787286SJed Brown   ierr          = ISDestroy(&ilink->is_col);CHKERRQ(ierr);
1281b5787286SJed Brown   ilink->is_col = is;
12820298fd71SBarry Smith   ilink->next   = NULL;
1283ce94432eSBarry Smith   ierr          = KSPCreate(PetscObjectComm((PetscObject)pc),&ilink->ksp);CHKERRQ(ierr);
128420252d06SBarry Smith   ierr          = PetscObjectIncrementTabLevel((PetscObject)ilink->ksp,(PetscObject)pc,1);CHKERRQ(ierr);
1285704ba839SBarry Smith   ierr          = KSPSetType(ilink->ksp,KSPPREONLY);CHKERRQ(ierr);
12869005cf84SBarry Smith   ierr          = PetscLogObjectParent((PetscObject)pc,(PetscObject)ilink->ksp);CHKERRQ(ierr);
1287704ba839SBarry Smith 
12888caf3d72SBarry Smith   ierr = PetscSNPrintf(prefix,sizeof(prefix),"%sfieldsplit_%s_",((PetscObject)pc)->prefix ? ((PetscObject)pc)->prefix : "",ilink->splitname);CHKERRQ(ierr);
1289704ba839SBarry Smith   ierr = KSPSetOptionsPrefix(ilink->ksp,prefix);CHKERRQ(ierr);
1290704ba839SBarry Smith 
1291704ba839SBarry Smith   if (!next) {
1292704ba839SBarry Smith     jac->head       = ilink;
12930298fd71SBarry Smith     ilink->previous = NULL;
1294704ba839SBarry Smith   } else {
1295704ba839SBarry Smith     while (next->next) {
1296704ba839SBarry Smith       next = next->next;
1297704ba839SBarry Smith     }
1298704ba839SBarry Smith     next->next      = ilink;
1299704ba839SBarry Smith     ilink->previous = next;
1300704ba839SBarry Smith   }
1301704ba839SBarry Smith   jac->nsplits++;
1302704ba839SBarry Smith   PetscFunctionReturn(0);
1303704ba839SBarry Smith }
1304704ba839SBarry Smith 
13050971522cSBarry Smith #undef __FUNCT__
13060971522cSBarry Smith #define __FUNCT__ "PCFieldSplitSetFields"
13070971522cSBarry Smith /*@
13080971522cSBarry Smith     PCFieldSplitSetFields - Sets the fields for one particular split in the field split preconditioner
13090971522cSBarry Smith 
1310ad4df100SBarry Smith     Logically Collective on PC
13110971522cSBarry Smith 
13120971522cSBarry Smith     Input Parameters:
13130971522cSBarry Smith +   pc  - the preconditioner context
13140298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
13150971522cSBarry Smith .   n - the number of fields in this split
1316db4c96c1SJed Brown -   fields - the fields in this split
13170971522cSBarry Smith 
13180971522cSBarry Smith     Level: intermediate
13190971522cSBarry Smith 
1320d32f9abdSBarry Smith     Notes: Use PCFieldSplitSetIS() to set a completely general set of indices as a field.
1321d32f9abdSBarry Smith 
13227287d2a3SDmitry Karpeev      The PCFieldSplitSetFields() is for defining fields as strided blocks. For example, if the block
1323d32f9abdSBarry 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
1324d32f9abdSBarry Smith      0xx3xx6xx9xx12 ... x1xx4xx7xx ... xx2xx5xx8xx.. 01x34x67x... 0x1x3x5x7.. x12x45x78x....
1325d32f9abdSBarry Smith      where the numbered entries indicate what is in the field.
1326d32f9abdSBarry Smith 
1327db4c96c1SJed Brown      This function is called once per split (it creates a new split each time).  Solve options
1328db4c96c1SJed Brown      for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1329db4c96c1SJed Brown 
13305d4c12cdSJungho Lee      Developer Note: This routine does not actually create the IS representing the split, that is delayed
13315d4c12cdSJungho Lee      until PCSetUp_FieldSplit(), because information about the vector/matrix layouts may not be
13325d4c12cdSJungho Lee      available when this routine is called.
13335d4c12cdSJungho Lee 
1334d32f9abdSBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize(), PCFieldSplitSetIS()
13350971522cSBarry Smith 
13360971522cSBarry Smith @*/
13375d4c12cdSJungho Lee PetscErrorCode  PCFieldSplitSetFields(PC pc,const char splitname[],PetscInt n,const PetscInt *fields,const PetscInt *fields_col)
13380971522cSBarry Smith {
13394ac538c5SBarry Smith   PetscErrorCode ierr;
13400971522cSBarry Smith 
13410971522cSBarry Smith   PetscFunctionBegin;
13420700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1343db4c96c1SJed Brown   PetscValidCharPointer(splitname,2);
1344ce94432eSBarry Smith   if (n < 1) SETERRQ2(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Provided number of fields %D in split \"%s\" not positive",n,splitname);
1345db4c96c1SJed Brown   PetscValidIntPointer(fields,3);
13465d4c12cdSJungho Lee   ierr = PetscTryMethod(pc,"PCFieldSplitSetFields_C",(PC,const char[],PetscInt,const PetscInt*,const PetscInt*),(pc,splitname,n,fields,fields_col));CHKERRQ(ierr);
13470971522cSBarry Smith   PetscFunctionReturn(0);
13480971522cSBarry Smith }
13490971522cSBarry Smith 
13500971522cSBarry Smith #undef __FUNCT__
1351c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDiagUseAmat"
1352c84da90fSDmitry Karpeev /*@
1353c84da90fSDmitry Karpeev     PCFieldSplitSetDiagUseAmat - set flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1354c84da90fSDmitry Karpeev 
1355c84da90fSDmitry Karpeev     Logically Collective on PC
1356c84da90fSDmitry Karpeev 
1357c84da90fSDmitry Karpeev     Input Parameters:
1358c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1359c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1360c84da90fSDmitry Karpeev 
13619506b623SDmitry Karpeev     Options Database:
13629506b623SDmitry Karpeev .     -pc_fieldsplit_diag_use_amat
1363c84da90fSDmitry Karpeev 
1364c84da90fSDmitry Karpeev     Level: intermediate
1365c84da90fSDmitry Karpeev 
1366c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetDiagUseAmat(), PCFieldSplitSetOffDiagUseAmat(), PCFIELDSPLIT
1367c84da90fSDmitry Karpeev 
1368c84da90fSDmitry Karpeev @*/
1369c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDiagUseAmat(PC pc,PetscBool flg)
1370c84da90fSDmitry Karpeev {
1371c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1372c84da90fSDmitry Karpeev   PetscBool      isfs;
1373c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1374c84da90fSDmitry Karpeev 
1375c84da90fSDmitry Karpeev   PetscFunctionBegin;
1376c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1377c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1378c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1379c84da90fSDmitry Karpeev   jac->diag_use_amat = flg;
1380c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1381c84da90fSDmitry Karpeev }
1382c84da90fSDmitry Karpeev 
1383c84da90fSDmitry Karpeev #undef __FUNCT__
1384c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDiagUseAmat"
1385c84da90fSDmitry Karpeev /*@
1386c84da90fSDmitry Karpeev     PCFieldSplitGetDiagUseAmat - get the flag indicating whether to extract diagonal blocks from Amat (rather than Pmat)
1387c84da90fSDmitry Karpeev 
1388c84da90fSDmitry Karpeev     Logically Collective on PC
1389c84da90fSDmitry Karpeev 
1390c84da90fSDmitry Karpeev     Input Parameters:
1391c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1392c84da90fSDmitry Karpeev 
1393c84da90fSDmitry Karpeev     Output Parameters:
1394c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the diagonal blocks from
1395c84da90fSDmitry Karpeev 
1396c84da90fSDmitry Karpeev 
1397c84da90fSDmitry Karpeev     Level: intermediate
1398c84da90fSDmitry Karpeev 
1399c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetDiagUseAmat(), PCFieldSplitGetOffDiagUseAmat(), PCFIELDSPLIT
1400c84da90fSDmitry Karpeev 
1401c84da90fSDmitry Karpeev @*/
1402c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDiagUseAmat(PC pc,PetscBool *flg)
1403c84da90fSDmitry Karpeev {
1404c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1405c84da90fSDmitry Karpeev   PetscBool      isfs;
1406c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1407c84da90fSDmitry Karpeev 
1408c84da90fSDmitry Karpeev   PetscFunctionBegin;
1409c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1410c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1411c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1412c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1413c84da90fSDmitry Karpeev   *flg = jac->diag_use_amat;
1414c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1415c84da90fSDmitry Karpeev }
1416c84da90fSDmitry Karpeev 
1417c84da90fSDmitry Karpeev #undef __FUNCT__
1418c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetOffDiagUseAmat"
1419c84da90fSDmitry Karpeev /*@
1420c84da90fSDmitry Karpeev     PCFieldSplitSetOffDiagUseAmat - set flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1421c84da90fSDmitry Karpeev 
1422c84da90fSDmitry Karpeev     Logically Collective on PC
1423c84da90fSDmitry Karpeev 
1424c84da90fSDmitry Karpeev     Input Parameters:
1425c84da90fSDmitry Karpeev +   pc  - the preconditioner object
1426c84da90fSDmitry Karpeev -   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1427c84da90fSDmitry Karpeev 
14289506b623SDmitry Karpeev     Options Database:
14299506b623SDmitry Karpeev .     -pc_fieldsplit_off_diag_use_amat
1430c84da90fSDmitry Karpeev 
1431c84da90fSDmitry Karpeev     Level: intermediate
1432c84da90fSDmitry Karpeev 
1433c84da90fSDmitry Karpeev .seealso: PCFieldSplitGetOffDiagUseAmat(), PCFieldSplitSetDiagUseAmat(), PCFIELDSPLIT
1434c84da90fSDmitry Karpeev 
1435c84da90fSDmitry Karpeev @*/
1436c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitSetOffDiagUseAmat(PC pc,PetscBool flg)
1437c84da90fSDmitry Karpeev {
1438c84da90fSDmitry Karpeev   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1439c84da90fSDmitry Karpeev   PetscBool      isfs;
1440c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1441c84da90fSDmitry Karpeev 
1442c84da90fSDmitry Karpeev   PetscFunctionBegin;
1443c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1444c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1445c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1446c84da90fSDmitry Karpeev   jac->offdiag_use_amat = flg;
1447c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1448c84da90fSDmitry Karpeev }
1449c84da90fSDmitry Karpeev 
1450c84da90fSDmitry Karpeev #undef __FUNCT__
1451c84da90fSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetOffDiagUseAmat"
1452c84da90fSDmitry Karpeev /*@
1453c84da90fSDmitry Karpeev     PCFieldSplitGetOffDiagUseAmat - get the flag indicating whether to extract off-diagonal blocks from Amat (rather than Pmat)
1454c84da90fSDmitry Karpeev 
1455c84da90fSDmitry Karpeev     Logically Collective on PC
1456c84da90fSDmitry Karpeev 
1457c84da90fSDmitry Karpeev     Input Parameters:
1458c84da90fSDmitry Karpeev .   pc  - the preconditioner object
1459c84da90fSDmitry Karpeev 
1460c84da90fSDmitry Karpeev     Output Parameters:
1461c84da90fSDmitry Karpeev .   flg - boolean flag indicating whether or not to use Amat to extract the off-diagonal blocks from
1462c84da90fSDmitry Karpeev 
1463c84da90fSDmitry Karpeev 
1464c84da90fSDmitry Karpeev     Level: intermediate
1465c84da90fSDmitry Karpeev 
1466c84da90fSDmitry Karpeev .seealso: PCFieldSplitSetOffDiagUseAmat(), PCFieldSplitGetDiagUseAmat(), PCFIELDSPLIT
1467c84da90fSDmitry Karpeev 
1468c84da90fSDmitry Karpeev @*/
1469c84da90fSDmitry Karpeev PetscErrorCode  PCFieldSplitGetOffDiagUseAmat(PC pc,PetscBool *flg)
1470c84da90fSDmitry Karpeev {
1471c84da90fSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1472c84da90fSDmitry Karpeev   PetscBool      isfs;
1473c84da90fSDmitry Karpeev   PetscErrorCode ierr;
1474c84da90fSDmitry Karpeev 
1475c84da90fSDmitry Karpeev   PetscFunctionBegin;
1476c84da90fSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1477c84da90fSDmitry Karpeev   PetscValidPointer(flg,2);
1478c84da90fSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1479c84da90fSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"PC not of type %s",PCFIELDSPLIT);
1480c84da90fSDmitry Karpeev   *flg = jac->offdiag_use_amat;
1481c84da90fSDmitry Karpeev   PetscFunctionReturn(0);
1482c84da90fSDmitry Karpeev }
1483c84da90fSDmitry Karpeev 
1484c84da90fSDmitry Karpeev 
1485c84da90fSDmitry Karpeev 
1486c84da90fSDmitry Karpeev #undef __FUNCT__
1487704ba839SBarry Smith #define __FUNCT__ "PCFieldSplitSetIS"
1488704ba839SBarry Smith /*@
1489704ba839SBarry Smith     PCFieldSplitSetIS - Sets the exact elements for field
1490704ba839SBarry Smith 
1491ad4df100SBarry Smith     Logically Collective on PC
1492704ba839SBarry Smith 
1493704ba839SBarry Smith     Input Parameters:
1494704ba839SBarry Smith +   pc  - the preconditioner context
14950298fd71SBarry Smith .   splitname - name of this split, if NULL the number of the split is used
1496db4c96c1SJed Brown -   is - the index set that defines the vector elements in this field
1497704ba839SBarry Smith 
1498d32f9abdSBarry Smith 
1499a6ffb8dbSJed Brown     Notes:
1500a6ffb8dbSJed Brown     Use PCFieldSplitSetFields(), for fields defined by strided types.
1501a6ffb8dbSJed Brown 
1502db4c96c1SJed Brown     This function is called once per split (it creates a new split each time).  Solve options
1503db4c96c1SJed Brown     for this split will be available under the prefix -fieldsplit_SPLITNAME_.
1504d32f9abdSBarry Smith 
1505704ba839SBarry Smith     Level: intermediate
1506704ba839SBarry Smith 
1507704ba839SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetBlockSize()
1508704ba839SBarry Smith 
1509704ba839SBarry Smith @*/
15107087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetIS(PC pc,const char splitname[],IS is)
1511704ba839SBarry Smith {
15124ac538c5SBarry Smith   PetscErrorCode ierr;
1513704ba839SBarry Smith 
1514704ba839SBarry Smith   PetscFunctionBegin;
15150700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
15167b62db95SJungho Lee   if (splitname) PetscValidCharPointer(splitname,2);
1517db4c96c1SJed Brown   PetscValidHeaderSpecific(is,IS_CLASSID,3);
15184ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetIS_C",(PC,const char[],IS),(pc,splitname,is));CHKERRQ(ierr);
1519704ba839SBarry Smith   PetscFunctionReturn(0);
1520704ba839SBarry Smith }
1521704ba839SBarry Smith 
1522704ba839SBarry Smith #undef __FUNCT__
152357a9adfeSMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetIS"
152457a9adfeSMatthew G Knepley /*@
152557a9adfeSMatthew G Knepley     PCFieldSplitGetIS - Retrieves the elements for a field as an IS
152657a9adfeSMatthew G Knepley 
152757a9adfeSMatthew G Knepley     Logically Collective on PC
152857a9adfeSMatthew G Knepley 
152957a9adfeSMatthew G Knepley     Input Parameters:
153057a9adfeSMatthew G Knepley +   pc  - the preconditioner context
153157a9adfeSMatthew G Knepley -   splitname - name of this split
153257a9adfeSMatthew G Knepley 
153357a9adfeSMatthew G Knepley     Output Parameter:
15340298fd71SBarry Smith -   is - the index set that defines the vector elements in this field, or NULL if the field is not found
153557a9adfeSMatthew G Knepley 
153657a9adfeSMatthew G Knepley     Level: intermediate
153757a9adfeSMatthew G Knepley 
153857a9adfeSMatthew G Knepley .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetIS()
153957a9adfeSMatthew G Knepley 
154057a9adfeSMatthew G Knepley @*/
154157a9adfeSMatthew G Knepley PetscErrorCode PCFieldSplitGetIS(PC pc,const char splitname[],IS *is)
154257a9adfeSMatthew G Knepley {
154357a9adfeSMatthew G Knepley   PetscErrorCode ierr;
154457a9adfeSMatthew G Knepley 
154557a9adfeSMatthew G Knepley   PetscFunctionBegin;
154657a9adfeSMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
154757a9adfeSMatthew G Knepley   PetscValidCharPointer(splitname,2);
154857a9adfeSMatthew G Knepley   PetscValidPointer(is,3);
154957a9adfeSMatthew G Knepley   {
155057a9adfeSMatthew G Knepley     PC_FieldSplit     *jac  = (PC_FieldSplit*) pc->data;
155157a9adfeSMatthew G Knepley     PC_FieldSplitLink ilink = jac->head;
155257a9adfeSMatthew G Knepley     PetscBool         found;
155357a9adfeSMatthew G Knepley 
15540298fd71SBarry Smith     *is = NULL;
155557a9adfeSMatthew G Knepley     while (ilink) {
155657a9adfeSMatthew G Knepley       ierr = PetscStrcmp(ilink->splitname, splitname, &found);CHKERRQ(ierr);
155757a9adfeSMatthew G Knepley       if (found) {
155857a9adfeSMatthew G Knepley         *is = ilink->is;
155957a9adfeSMatthew G Knepley         break;
156057a9adfeSMatthew G Knepley       }
156157a9adfeSMatthew G Knepley       ilink = ilink->next;
156257a9adfeSMatthew G Knepley     }
156357a9adfeSMatthew G Knepley   }
156457a9adfeSMatthew G Knepley   PetscFunctionReturn(0);
156557a9adfeSMatthew G Knepley }
156657a9adfeSMatthew G Knepley 
156757a9adfeSMatthew G Knepley #undef __FUNCT__
156851f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize"
156951f519a2SBarry Smith /*@
157051f519a2SBarry Smith     PCFieldSplitSetBlockSize - Sets the block size for defining where fields start in the
157151f519a2SBarry Smith       fieldsplit preconditioner. If not set the matrix block size is used.
157251f519a2SBarry Smith 
1573ad4df100SBarry Smith     Logically Collective on PC
157451f519a2SBarry Smith 
157551f519a2SBarry Smith     Input Parameters:
157651f519a2SBarry Smith +   pc  - the preconditioner context
157751f519a2SBarry Smith -   bs - the block size
157851f519a2SBarry Smith 
157951f519a2SBarry Smith     Level: intermediate
158051f519a2SBarry Smith 
158151f519a2SBarry Smith .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields()
158251f519a2SBarry Smith 
158351f519a2SBarry Smith @*/
15847087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetBlockSize(PC pc,PetscInt bs)
158551f519a2SBarry Smith {
15864ac538c5SBarry Smith   PetscErrorCode ierr;
158751f519a2SBarry Smith 
158851f519a2SBarry Smith   PetscFunctionBegin;
15890700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1590c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(pc,bs,2);
15914ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetBlockSize_C",(PC,PetscInt),(pc,bs));CHKERRQ(ierr);
159251f519a2SBarry Smith   PetscFunctionReturn(0);
159351f519a2SBarry Smith }
159451f519a2SBarry Smith 
159551f519a2SBarry Smith #undef __FUNCT__
159669a612a9SBarry Smith #define __FUNCT__ "PCFieldSplitGetSubKSP"
15970971522cSBarry Smith /*@C
159869a612a9SBarry Smith    PCFieldSplitGetSubKSP - Gets the KSP contexts for all splits
15990971522cSBarry Smith 
160069a612a9SBarry Smith    Collective on KSP
16010971522cSBarry Smith 
16020971522cSBarry Smith    Input Parameter:
16030971522cSBarry Smith .  pc - the preconditioner context
16040971522cSBarry Smith 
16050971522cSBarry Smith    Output Parameters:
160613e0d083SBarry Smith +  n - the number of splits
160769a612a9SBarry Smith -  pc - the array of KSP contexts
16080971522cSBarry Smith 
16090971522cSBarry Smith    Note:
1610d32f9abdSBarry Smith    After PCFieldSplitGetSubKSP() the array of KSPs IS to be freed by the user
1611d32f9abdSBarry Smith    (not the KSP just the array that contains them).
16120971522cSBarry Smith 
161369a612a9SBarry Smith    You must call KSPSetUp() before calling PCFieldSplitGetSubKSP().
16140971522cSBarry Smith 
1615196cc216SBarry Smith    Fortran Usage: You must pass in a KSP array that is large enough to contain all the local KSPs.
16160298fd71SBarry Smith       You can call PCFieldSplitGetSubKSP(pc,n,NULL_OBJECT,ierr) to determine how large the
1617196cc216SBarry Smith       KSP array must be.
1618196cc216SBarry Smith 
1619196cc216SBarry Smith 
16200971522cSBarry Smith    Level: advanced
16210971522cSBarry Smith 
16220971522cSBarry Smith .seealso: PCFIELDSPLIT
16230971522cSBarry Smith @*/
16247087cfbeSBarry Smith PetscErrorCode  PCFieldSplitGetSubKSP(PC pc,PetscInt *n,KSP *subksp[])
16250971522cSBarry Smith {
16264ac538c5SBarry Smith   PetscErrorCode ierr;
16270971522cSBarry Smith 
16280971522cSBarry Smith   PetscFunctionBegin;
16290700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
163013e0d083SBarry Smith   if (n) PetscValidIntPointer(n,2);
16314ac538c5SBarry Smith   ierr = PetscUseMethod(pc,"PCFieldSplitGetSubKSP_C",(PC,PetscInt*,KSP **),(pc,n,subksp));CHKERRQ(ierr);
16320971522cSBarry Smith   PetscFunctionReturn(0);
16330971522cSBarry Smith }
16340971522cSBarry Smith 
1635e69d4d44SBarry Smith #undef __FUNCT__
163629f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre"
1637e69d4d44SBarry Smith /*@
163829f8a81cSJed Brown     PCFieldSplitSetSchurPre -  Indicates if the Schur complement is preconditioned by a preconditioner constructed by the
1639a04f6461SBarry Smith       A11 matrix. Otherwise no preconditioner is used.
1640e69d4d44SBarry Smith 
1641e69d4d44SBarry Smith     Collective on PC
1642e69d4d44SBarry Smith 
1643e69d4d44SBarry Smith     Input Parameters:
1644e69d4d44SBarry Smith +   pc      - the preconditioner context
1645a7476a74SDmitry 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
16460298fd71SBarry Smith -   userpre - matrix to use for preconditioning, or NULL
1647084e4875SJed Brown 
1648e69d4d44SBarry Smith     Options Database:
16492e71c61dSMatthew G. Knepley .     -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> default is a11
1650e69d4d44SBarry Smith 
1651fd1303e9SJungho Lee     Notes:
1652fd1303e9SJungho Lee $    If ptype is
1653fd1303e9SJungho Lee $        user then the preconditioner for the Schur complement is generated by the provided matrix (pre argument
1654fd1303e9SJungho Lee $             to this function).
1655585af1b9SMatthew G. Knepley $        a11 then the preconditioner for the Schur complement is generated by the block diagonal part of the preconditioner
1656585af1b9SMatthew G. Knepley $             matrix associated with the Schur complement (i.e. A11), not he Schur complement matrix
1657e74569cdSMatthew G. Knepley $        full then the preconditioner uses the exact Schur complement (this is expensive)
1658fd1303e9SJungho Lee $        self the preconditioner for the Schur complement is generated from the Schur complement matrix itself:
1659fd1303e9SJungho Lee $             The only preconditioner that currently works directly with the Schur complement matrix object is the PCLSC
1660fd1303e9SJungho Lee $             preconditioner
1661a7476a74SDmitry Karpeev $        selfp then the preconditioning matrix is an explicitly-assembled approximation Sp = A11 - A10 inv(diag(A00)) A01
1662a7476a74SDmitry Karpeev $             This is only a good preconditioner when diag(A00) is a good preconditioner for A00.
1663fd1303e9SJungho Lee 
1664e87fab1bSBarry Smith      When solving a saddle point problem, where the A11 block is identically zero, using a11 as the ptype only makes sense
1665fd1303e9SJungho Lee     with the additional option -fieldsplit_1_pc_type none. Usually for saddle point problems one would use a ptype of self and
1666a7476a74SDmitry Karpeev     -fieldsplit_1_pc_type lsc which uses the least squares commutator to compute a preconditioner for the Schur complement.
1667fd1303e9SJungho Lee 
1668e69d4d44SBarry Smith     Level: intermediate
1669e69d4d44SBarry Smith 
167037a82bf0SJed Brown .seealso: PCFieldSplitGetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
1671e69d4d44SBarry Smith 
1672e69d4d44SBarry Smith @*/
167329f8a81cSJed Brown PetscErrorCode PCFieldSplitSetSchurPre(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1674e69d4d44SBarry Smith {
16754ac538c5SBarry Smith   PetscErrorCode ierr;
1676e69d4d44SBarry Smith 
1677e69d4d44SBarry Smith   PetscFunctionBegin;
16780700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
167929f8a81cSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurPre_C",(PC,PCFieldSplitSchurPreType,Mat),(pc,ptype,pre));CHKERRQ(ierr);
1680e69d4d44SBarry Smith   PetscFunctionReturn(0);
1681e69d4d44SBarry Smith }
168229f8a81cSJed Brown PetscErrorCode PCFieldSplitSchurPrecondition(PC pc,PCFieldSplitSchurPreType ptype,Mat pre) {return PCFieldSplitSetSchurPre(pc,ptype,pre);} /* Deprecated name */
1683e69d4d44SBarry Smith 
1684e69d4d44SBarry Smith #undef __FUNCT__
168537a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre"
168637a82bf0SJed Brown /*@
168737a82bf0SJed Brown     PCFieldSplitGetSchurPre - For Schur complement fieldsplit, determine how the Schur complement will be
168829f8a81cSJed Brown     preconditioned.  See PCFieldSplitSetSchurPre() for details.
168937a82bf0SJed Brown 
169037a82bf0SJed Brown     Logically Collective on PC
169137a82bf0SJed Brown 
169237a82bf0SJed Brown     Input Parameters:
169337a82bf0SJed Brown .   pc      - the preconditioner context
169437a82bf0SJed Brown 
169537a82bf0SJed Brown     Output Parameters:
169637a82bf0SJed 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
169737a82bf0SJed Brown -   userpre - matrix to use for preconditioning (with PC_FIELDSPLIT_PRE_USER), or NULL
169837a82bf0SJed Brown 
169937a82bf0SJed Brown     Level: intermediate
170037a82bf0SJed Brown 
170129f8a81cSJed Brown .seealso: PCFieldSplitSetSchurPre(), PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType, PCLSC
170237a82bf0SJed Brown 
170337a82bf0SJed Brown @*/
170437a82bf0SJed Brown PetscErrorCode PCFieldSplitGetSchurPre(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
170537a82bf0SJed Brown {
170637a82bf0SJed Brown   PetscErrorCode ierr;
170737a82bf0SJed Brown 
170837a82bf0SJed Brown   PetscFunctionBegin;
170937a82bf0SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
171037a82bf0SJed Brown   ierr = PetscUseMethod(pc,"PCFieldSplitGetSchurPre_C",(PC,PCFieldSplitSchurPreType*,Mat*),(pc,ptype,pre));CHKERRQ(ierr);
1711e69d4d44SBarry Smith   PetscFunctionReturn(0);
1712e69d4d44SBarry Smith }
1713e69d4d44SBarry Smith 
1714e69d4d44SBarry Smith #undef __FUNCT__
1715470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurGetS"
171645e7fc46SDmitry Karpeev /*@
1717470b340bSDmitry Karpeev     PCFieldSplitSchurGetS -  extract the MatSchurComplement object used by this PC in case it needs to be configured separately
171845e7fc46SDmitry Karpeev 
171945e7fc46SDmitry Karpeev     Not collective
172045e7fc46SDmitry Karpeev 
172145e7fc46SDmitry Karpeev     Input Parameter:
172245e7fc46SDmitry Karpeev .   pc      - the preconditioner context
172345e7fc46SDmitry Karpeev 
172445e7fc46SDmitry Karpeev     Output Parameter:
1725470b340bSDmitry Karpeev .   S       - the Schur complement matrix
172645e7fc46SDmitry Karpeev 
1727470b340bSDmitry Karpeev     Notes:
1728470b340bSDmitry Karpeev     This matrix should not be destroyed using MatDestroy(); rather, use PCFieldSplitSchurRestoreS().
172945e7fc46SDmitry Karpeev 
173045e7fc46SDmitry Karpeev     Level: advanced
173145e7fc46SDmitry Karpeev 
173229f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurRestoreS()
173345e7fc46SDmitry Karpeev 
173445e7fc46SDmitry Karpeev @*/
1735470b340bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurGetS(PC pc,Mat *S)
173645e7fc46SDmitry Karpeev {
173745e7fc46SDmitry Karpeev   PetscErrorCode ierr;
173845e7fc46SDmitry Karpeev   const char*    t;
173945e7fc46SDmitry Karpeev   PetscBool      isfs;
174045e7fc46SDmitry Karpeev   PC_FieldSplit  *jac;
174145e7fc46SDmitry Karpeev 
174245e7fc46SDmitry Karpeev   PetscFunctionBegin;
174345e7fc46SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
174445e7fc46SDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
174545e7fc46SDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
174645e7fc46SDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
174745e7fc46SDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1748470b340bSDmitry 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);
1749470b340bSDmitry Karpeev   if (S) *S = jac->schur;
175045e7fc46SDmitry Karpeev   PetscFunctionReturn(0);
175145e7fc46SDmitry Karpeev }
175245e7fc46SDmitry Karpeev 
175345e7fc46SDmitry Karpeev #undef __FUNCT__
1754470b340bSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSchurRestoreS"
1755470b340bSDmitry Karpeev /*@
1756470b340bSDmitry Karpeev     PCFieldSplitSchurRestoreS -  restores the MatSchurComplement object used by this PC
1757470b340bSDmitry Karpeev 
1758470b340bSDmitry Karpeev     Not collective
1759470b340bSDmitry Karpeev 
1760470b340bSDmitry Karpeev     Input Parameters:
1761470b340bSDmitry Karpeev +   pc      - the preconditioner context
1762470b340bSDmitry Karpeev .   S       - the Schur complement matrix
1763470b340bSDmitry Karpeev 
1764470b340bSDmitry Karpeev     Level: advanced
1765470b340bSDmitry Karpeev 
176629f8a81cSJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSchurPreType, PCFieldSplitSetSchurPre(), MatSchurComplement, PCFieldSplitSchurGetS()
1767470b340bSDmitry Karpeev 
1768470b340bSDmitry Karpeev @*/
1769bca69d2bSDmitry Karpeev PetscErrorCode  PCFieldSplitSchurRestoreS(PC pc,Mat *S)
1770470b340bSDmitry Karpeev {
1771470b340bSDmitry Karpeev   PetscErrorCode ierr;
1772470b340bSDmitry Karpeev   const char*    t;
1773470b340bSDmitry Karpeev   PetscBool      isfs;
1774470b340bSDmitry Karpeev   PC_FieldSplit  *jac;
1775470b340bSDmitry Karpeev 
1776470b340bSDmitry Karpeev   PetscFunctionBegin;
1777470b340bSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1778470b340bSDmitry Karpeev   ierr = PetscObjectGetType((PetscObject)pc,&t);CHKERRQ(ierr);
1779470b340bSDmitry Karpeev   ierr = PetscStrcmp(t,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
1780470b340bSDmitry Karpeev   if (!isfs) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Expected PC of type PCFIELDSPLIT, got %s instead",t);
1781470b340bSDmitry Karpeev   jac = (PC_FieldSplit*)pc->data;
1782470b340bSDmitry 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);
1783bca69d2bSDmitry Karpeev   if (!S || *S != jac->schur) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"MatSchurComplement restored is not the same as gotten");
1784470b340bSDmitry Karpeev   PetscFunctionReturn(0);
1785470b340bSDmitry Karpeev }
1786470b340bSDmitry Karpeev 
1787470b340bSDmitry Karpeev 
1788470b340bSDmitry Karpeev #undef __FUNCT__
178929f8a81cSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurPre_FieldSplit"
179029f8a81cSJed Brown static PetscErrorCode  PCFieldSplitSetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType ptype,Mat pre)
1791e69d4d44SBarry Smith {
1792e69d4d44SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1793084e4875SJed Brown   PetscErrorCode ierr;
1794e69d4d44SBarry Smith 
1795e69d4d44SBarry Smith   PetscFunctionBegin;
1796084e4875SJed Brown   jac->schurpre = ptype;
1797a7476a74SDmitry Karpeev   if (ptype == PC_FIELDSPLIT_SCHUR_PRE_USER && pre) {
17986bf464f9SBarry Smith     ierr            = MatDestroy(&jac->schur_user);CHKERRQ(ierr);
1799084e4875SJed Brown     jac->schur_user = pre;
1800084e4875SJed Brown     ierr            = PetscObjectReference((PetscObject)jac->schur_user);CHKERRQ(ierr);
1801084e4875SJed Brown   }
1802e69d4d44SBarry Smith   PetscFunctionReturn(0);
1803e69d4d44SBarry Smith }
1804e69d4d44SBarry Smith 
180530ad9308SMatthew Knepley #undef __FUNCT__
180637a82bf0SJed Brown #define __FUNCT__ "PCFieldSplitGetSchurPre_FieldSplit"
180737a82bf0SJed Brown static PetscErrorCode  PCFieldSplitGetSchurPre_FieldSplit(PC pc,PCFieldSplitSchurPreType *ptype,Mat *pre)
180837a82bf0SJed Brown {
180937a82bf0SJed Brown   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
181037a82bf0SJed Brown 
181137a82bf0SJed Brown   PetscFunctionBegin;
181237a82bf0SJed Brown   *ptype = jac->schurpre;
181337a82bf0SJed Brown   *pre   = jac->schur_user;
181437a82bf0SJed Brown   PetscFunctionReturn(0);
181537a82bf0SJed Brown }
181637a82bf0SJed Brown 
181737a82bf0SJed Brown #undef __FUNCT__
1818c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType"
1819ab1df9f5SJed Brown /*@
1820c9c6ffaaSJed Brown     PCFieldSplitSetSchurFactType -  sets which blocks of the approximate block factorization to retain
1821ab1df9f5SJed Brown 
1822ab1df9f5SJed Brown     Collective on PC
1823ab1df9f5SJed Brown 
1824ab1df9f5SJed Brown     Input Parameters:
1825ab1df9f5SJed Brown +   pc  - the preconditioner context
1826c9c6ffaaSJed Brown -   ftype - which blocks of factorization to retain, PC_FIELDSPLIT_SCHUR_FACT_FULL is default
1827ab1df9f5SJed Brown 
1828ab1df9f5SJed Brown     Options Database:
1829c9c6ffaaSJed Brown .     -pc_fieldsplit_schur_fact_type <diag,lower,upper,full> default is full
1830ab1df9f5SJed Brown 
1831ab1df9f5SJed Brown 
1832ab1df9f5SJed Brown     Level: intermediate
1833ab1df9f5SJed Brown 
1834ab1df9f5SJed Brown     Notes:
1835ab1df9f5SJed Brown     The FULL factorization is
1836ab1df9f5SJed Brown 
1837ab1df9f5SJed Brown $   (A   B)  = (1       0) (A   0) (1  Ainv*B)
1838ab1df9f5SJed Brown $   (C   D)    (C*Ainv  1) (0   S) (0     1  )
1839ab1df9f5SJed Brown 
18406be4592eSBarry 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,
18416be4592eSBarry 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).
1842ab1df9f5SJed Brown 
18436be4592eSBarry 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
18446be4592eSBarry 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
18456be4592eSBarry 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,
18466be4592eSBarry 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.
1847ab1df9f5SJed Brown 
18486be4592eSBarry 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
18496be4592eSBarry 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).
1850ab1df9f5SJed Brown 
1851ab1df9f5SJed Brown     References:
1852ab1df9f5SJed Brown     Murphy, Golub, and Wathen, A note on preconditioning indefinite linear systems, SIAM J. Sci. Comput., 21 (2000) pp. 1969-1972.
1853ab1df9f5SJed Brown 
1854ab1df9f5SJed Brown     Ipsen, A note on preconditioning nonsymmetric matrices, SIAM J. Sci. Comput., 23 (2001), pp. 1050-1051.
1855ab1df9f5SJed Brown 
1856ab1df9f5SJed Brown .seealso: PCFieldSplitGetSubKSP(), PCFIELDSPLIT, PCFieldSplitSetFields(), PCFieldSplitSchurPreType
1857ab1df9f5SJed Brown @*/
1858c9c6ffaaSJed Brown PetscErrorCode  PCFieldSplitSetSchurFactType(PC pc,PCFieldSplitSchurFactType ftype)
1859ab1df9f5SJed Brown {
1860ab1df9f5SJed Brown   PetscErrorCode ierr;
1861ab1df9f5SJed Brown 
1862ab1df9f5SJed Brown   PetscFunctionBegin;
1863ab1df9f5SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1864c9c6ffaaSJed Brown   ierr = PetscTryMethod(pc,"PCFieldSplitSetSchurFactType_C",(PC,PCFieldSplitSchurFactType),(pc,ftype));CHKERRQ(ierr);
1865ab1df9f5SJed Brown   PetscFunctionReturn(0);
1866ab1df9f5SJed Brown }
1867ab1df9f5SJed Brown 
1868ab1df9f5SJed Brown #undef __FUNCT__
1869c9c6ffaaSJed Brown #define __FUNCT__ "PCFieldSplitSetSchurFactType_FieldSplit"
18701e6b0712SBarry Smith static PetscErrorCode PCFieldSplitSetSchurFactType_FieldSplit(PC pc,PCFieldSplitSchurFactType ftype)
1871ab1df9f5SJed Brown {
1872ab1df9f5SJed Brown   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
1873ab1df9f5SJed Brown 
1874ab1df9f5SJed Brown   PetscFunctionBegin;
1875ab1df9f5SJed Brown   jac->schurfactorization = ftype;
1876ab1df9f5SJed Brown   PetscFunctionReturn(0);
1877ab1df9f5SJed Brown }
1878ab1df9f5SJed Brown 
1879ab1df9f5SJed Brown #undef __FUNCT__
188030ad9308SMatthew Knepley #define __FUNCT__ "PCFieldSplitGetSchurBlocks"
188130ad9308SMatthew Knepley /*@C
18828c03b21aSDmitry Karpeev    PCFieldSplitGetSchurBlocks - Gets all matrix blocks for the Schur complement
188330ad9308SMatthew Knepley 
188430ad9308SMatthew Knepley    Collective on KSP
188530ad9308SMatthew Knepley 
188630ad9308SMatthew Knepley    Input Parameter:
188730ad9308SMatthew Knepley .  pc - the preconditioner context
188830ad9308SMatthew Knepley 
188930ad9308SMatthew Knepley    Output Parameters:
1890a04f6461SBarry Smith +  A00 - the (0,0) block
1891a04f6461SBarry Smith .  A01 - the (0,1) block
1892a04f6461SBarry Smith .  A10 - the (1,0) block
1893a04f6461SBarry Smith -  A11 - the (1,1) block
189430ad9308SMatthew Knepley 
189530ad9308SMatthew Knepley    Level: advanced
189630ad9308SMatthew Knepley 
189730ad9308SMatthew Knepley .seealso: PCFIELDSPLIT
189830ad9308SMatthew Knepley @*/
1899a04f6461SBarry Smith PetscErrorCode  PCFieldSplitGetSchurBlocks(PC pc,Mat *A00,Mat *A01,Mat *A10, Mat *A11)
190030ad9308SMatthew Knepley {
190130ad9308SMatthew Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
190230ad9308SMatthew Knepley 
190330ad9308SMatthew Knepley   PetscFunctionBegin;
19040700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1905ce94432eSBarry Smith   if (jac->type != PC_COMPOSITE_SCHUR) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONG, "FieldSplit is not using a Schur complement approach.");
1906a04f6461SBarry Smith   if (A00) *A00 = jac->pmat[0];
1907a04f6461SBarry Smith   if (A01) *A01 = jac->B;
1908a04f6461SBarry Smith   if (A10) *A10 = jac->C;
1909a04f6461SBarry Smith   if (A11) *A11 = jac->pmat[1];
191030ad9308SMatthew Knepley   PetscFunctionReturn(0);
191130ad9308SMatthew Knepley }
191230ad9308SMatthew Knepley 
191379416396SBarry Smith #undef __FUNCT__
191479416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType_FieldSplit"
19151e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetType_FieldSplit(PC pc,PCCompositeType type)
191679416396SBarry Smith {
191779416396SBarry Smith   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
1918e69d4d44SBarry Smith   PetscErrorCode ierr;
191979416396SBarry Smith 
192079416396SBarry Smith   PetscFunctionBegin;
192179416396SBarry Smith   jac->type = type;
19223b224e63SBarry Smith   if (type == PC_COMPOSITE_SCHUR) {
19233b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit_Schur;
19243b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit_Schur;
19252fa5cd67SKarl Rupp 
1926bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit_Schur);CHKERRQ(ierr);
192729f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",PCFieldSplitSetSchurPre_FieldSplit);CHKERRQ(ierr);
192837a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",PCFieldSplitGetSchurPre_FieldSplit);CHKERRQ(ierr);
1929bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",PCFieldSplitSetSchurFactType_FieldSplit);CHKERRQ(ierr);
1930e69d4d44SBarry Smith 
19313b224e63SBarry Smith   } else {
19323b224e63SBarry Smith     pc->ops->apply = PCApply_FieldSplit;
19333b224e63SBarry Smith     pc->ops->view  = PCView_FieldSplit;
19342fa5cd67SKarl Rupp 
1935bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
193629f8a81cSJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurPre_C",0);CHKERRQ(ierr);
193737a82bf0SJed Brown     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSchurPre_C",0);CHKERRQ(ierr);
1938bdf89e91SBarry Smith     ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetSchurFactType_C",0);CHKERRQ(ierr);
19393b224e63SBarry Smith   }
194079416396SBarry Smith   PetscFunctionReturn(0);
194179416396SBarry Smith }
194279416396SBarry Smith 
194351f519a2SBarry Smith #undef __FUNCT__
194451f519a2SBarry Smith #define __FUNCT__ "PCFieldSplitSetBlockSize_FieldSplit"
19451e6b0712SBarry Smith static PetscErrorCode  PCFieldSplitSetBlockSize_FieldSplit(PC pc,PetscInt bs)
194651f519a2SBarry Smith {
194751f519a2SBarry Smith   PC_FieldSplit *jac = (PC_FieldSplit*)pc->data;
194851f519a2SBarry Smith 
194951f519a2SBarry Smith   PetscFunctionBegin;
1950ce94432eSBarry Smith   if (bs < 1) SETERRQ1(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Blocksize must be positive, you gave %D",bs);
1951ce94432eSBarry 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);
195251f519a2SBarry Smith   jac->bs = bs;
195351f519a2SBarry Smith   PetscFunctionReturn(0);
195451f519a2SBarry Smith }
195551f519a2SBarry Smith 
195679416396SBarry Smith #undef __FUNCT__
195779416396SBarry Smith #define __FUNCT__ "PCFieldSplitSetType"
1958bc08b0f1SBarry Smith /*@
195979416396SBarry Smith    PCFieldSplitSetType - Sets the type of fieldsplit preconditioner.
196079416396SBarry Smith 
196179416396SBarry Smith    Collective on PC
196279416396SBarry Smith 
196379416396SBarry Smith    Input Parameter:
196479416396SBarry Smith .  pc - the preconditioner context
196581540f2fSBarry Smith .  type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
196679416396SBarry Smith 
196779416396SBarry Smith    Options Database Key:
1968a4efd8eaSMatthew Knepley .  -pc_fieldsplit_type <type: one of multiplicative, additive, symmetric_multiplicative, special, schur> - Sets fieldsplit preconditioner type
196979416396SBarry Smith 
1970b02e2d75SMatthew G Knepley    Level: Intermediate
197179416396SBarry Smith 
197279416396SBarry Smith .keywords: PC, set, type, composite preconditioner, additive, multiplicative
197379416396SBarry Smith 
197479416396SBarry Smith .seealso: PCCompositeSetType()
197579416396SBarry Smith 
197679416396SBarry Smith @*/
19777087cfbeSBarry Smith PetscErrorCode  PCFieldSplitSetType(PC pc,PCCompositeType type)
197879416396SBarry Smith {
19794ac538c5SBarry Smith   PetscErrorCode ierr;
198079416396SBarry Smith 
198179416396SBarry Smith   PetscFunctionBegin;
19820700a824SBarry Smith   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
19834ac538c5SBarry Smith   ierr = PetscTryMethod(pc,"PCFieldSplitSetType_C",(PC,PCCompositeType),(pc,type));CHKERRQ(ierr);
198479416396SBarry Smith   PetscFunctionReturn(0);
198579416396SBarry Smith }
198679416396SBarry Smith 
1987b02e2d75SMatthew G Knepley #undef __FUNCT__
1988b02e2d75SMatthew G Knepley #define __FUNCT__ "PCFieldSplitGetType"
1989b02e2d75SMatthew G Knepley /*@
1990b02e2d75SMatthew G Knepley   PCFieldSplitGetType - Gets the type of fieldsplit preconditioner.
1991b02e2d75SMatthew G Knepley 
1992b02e2d75SMatthew G Knepley   Not collective
1993b02e2d75SMatthew G Knepley 
1994b02e2d75SMatthew G Knepley   Input Parameter:
1995b02e2d75SMatthew G Knepley . pc - the preconditioner context
1996b02e2d75SMatthew G Knepley 
1997b02e2d75SMatthew G Knepley   Output Parameter:
1998b02e2d75SMatthew G Knepley . type - PC_COMPOSITE_ADDITIVE, PC_COMPOSITE_MULTIPLICATIVE (default), PC_COMPOSITE_SYMMETRIC_MULTIPLICATIVE, PC_COMPOSITE_SPECIAL, PC_COMPOSITE_SCHUR
1999b02e2d75SMatthew G Knepley 
2000b02e2d75SMatthew G Knepley   Level: Intermediate
2001b02e2d75SMatthew G Knepley 
2002b02e2d75SMatthew G Knepley .keywords: PC, set, type, composite preconditioner, additive, multiplicative
2003b02e2d75SMatthew G Knepley .seealso: PCCompositeSetType()
2004b02e2d75SMatthew G Knepley @*/
2005b02e2d75SMatthew G Knepley PetscErrorCode PCFieldSplitGetType(PC pc, PCCompositeType *type)
2006b02e2d75SMatthew G Knepley {
2007b02e2d75SMatthew G Knepley   PC_FieldSplit *jac = (PC_FieldSplit*) pc->data;
2008b02e2d75SMatthew G Knepley 
2009b02e2d75SMatthew G Knepley   PetscFunctionBegin;
2010b02e2d75SMatthew G Knepley   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2011b02e2d75SMatthew G Knepley   PetscValidIntPointer(type,2);
2012b02e2d75SMatthew G Knepley   *type = jac->type;
2013b02e2d75SMatthew G Knepley   PetscFunctionReturn(0);
2014b02e2d75SMatthew G Knepley }
2015b02e2d75SMatthew G Knepley 
20164ab8060aSDmitry Karpeev #undef __FUNCT__
20174ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitSetDMSplits"
20184ab8060aSDmitry Karpeev /*@
20194ab8060aSDmitry Karpeev    PCFieldSplitSetDMSplits - Flags whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
20204ab8060aSDmitry Karpeev 
20214ab8060aSDmitry Karpeev    Logically Collective
20224ab8060aSDmitry Karpeev 
20234ab8060aSDmitry Karpeev    Input Parameters:
20244ab8060aSDmitry Karpeev +  pc   - the preconditioner context
20254ab8060aSDmitry Karpeev -  flg  - boolean indicating whether to use field splits defined by the DM
20264ab8060aSDmitry Karpeev 
20274ab8060aSDmitry Karpeev    Options Database Key:
20284ab8060aSDmitry Karpeev .  -pc_fieldsplit_dm_splits
20294ab8060aSDmitry Karpeev 
20304ab8060aSDmitry Karpeev    Level: Intermediate
20314ab8060aSDmitry Karpeev 
20324ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
20334ab8060aSDmitry Karpeev 
20344ab8060aSDmitry Karpeev .seealso: PCFieldSplitGetDMSplits()
20354ab8060aSDmitry Karpeev 
20364ab8060aSDmitry Karpeev @*/
20374ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitSetDMSplits(PC pc,PetscBool flg)
20384ab8060aSDmitry Karpeev {
20394ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
20404ab8060aSDmitry Karpeev   PetscBool      isfs;
20414ab8060aSDmitry Karpeev   PetscErrorCode ierr;
20424ab8060aSDmitry Karpeev 
20434ab8060aSDmitry Karpeev   PetscFunctionBegin;
20444ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
20454ab8060aSDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
20464ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
20474ab8060aSDmitry Karpeev   if (isfs) {
20484ab8060aSDmitry Karpeev     jac->dm_splits = flg;
20494ab8060aSDmitry Karpeev   }
20504ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
20514ab8060aSDmitry Karpeev }
20524ab8060aSDmitry Karpeev 
20534ab8060aSDmitry Karpeev 
20544ab8060aSDmitry Karpeev #undef __FUNCT__
20554ab8060aSDmitry Karpeev #define __FUNCT__ "PCFieldSplitGetDMSplits"
20564ab8060aSDmitry Karpeev /*@
20574ab8060aSDmitry Karpeev    PCFieldSplitGetDMSplits - Returns flag indicating whether DMCreateFieldDecomposition() should be used to define the splits, whenever possible.
20584ab8060aSDmitry Karpeev 
20594ab8060aSDmitry Karpeev    Logically Collective
20604ab8060aSDmitry Karpeev 
20614ab8060aSDmitry Karpeev    Input Parameter:
20624ab8060aSDmitry Karpeev .  pc   - the preconditioner context
20634ab8060aSDmitry Karpeev 
20644ab8060aSDmitry Karpeev    Output Parameter:
20654ab8060aSDmitry Karpeev .  flg  - boolean indicating whether to use field splits defined by the DM
20664ab8060aSDmitry Karpeev 
20674ab8060aSDmitry Karpeev    Level: Intermediate
20684ab8060aSDmitry Karpeev 
20694ab8060aSDmitry Karpeev .keywords: PC, DM, composite preconditioner, additive, multiplicative
20704ab8060aSDmitry Karpeev 
20714ab8060aSDmitry Karpeev .seealso: PCFieldSplitSetDMSplits()
20724ab8060aSDmitry Karpeev 
20734ab8060aSDmitry Karpeev @*/
20744ab8060aSDmitry Karpeev PetscErrorCode  PCFieldSplitGetDMSplits(PC pc,PetscBool* flg)
20754ab8060aSDmitry Karpeev {
20764ab8060aSDmitry Karpeev   PC_FieldSplit  *jac = (PC_FieldSplit*)pc->data;
20774ab8060aSDmitry Karpeev   PetscBool      isfs;
20784ab8060aSDmitry Karpeev   PetscErrorCode ierr;
20794ab8060aSDmitry Karpeev 
20804ab8060aSDmitry Karpeev   PetscFunctionBegin;
20814ab8060aSDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
20824ab8060aSDmitry Karpeev   PetscValidPointer(flg,2);
20834ab8060aSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCFIELDSPLIT,&isfs);CHKERRQ(ierr);
20844ab8060aSDmitry Karpeev   if (isfs) {
20854ab8060aSDmitry Karpeev     if(flg) *flg = jac->dm_splits;
20864ab8060aSDmitry Karpeev   }
20874ab8060aSDmitry Karpeev   PetscFunctionReturn(0);
20884ab8060aSDmitry Karpeev }
20894ab8060aSDmitry Karpeev 
20900971522cSBarry Smith /* -------------------------------------------------------------------------------------*/
20910971522cSBarry Smith /*MC
2092a8c7a070SBarry Smith    PCFIELDSPLIT - Preconditioner created by combining separate preconditioners for individual
2093a04f6461SBarry Smith                   fields or groups of fields. See the users manual section "Solving Block Matrices" for more details.
20940971522cSBarry Smith 
2095edf189efSBarry Smith      To set options on the solvers for each block append -fieldsplit_ to all the PC
2096edf189efSBarry Smith         options database keys. For example, -fieldsplit_pc_type ilu -fieldsplit_pc_factor_levels 1
20970971522cSBarry Smith 
2098a8c7a070SBarry Smith      To set the options on the solvers separate for each block call PCFieldSplitGetSubKSP()
209969a612a9SBarry Smith          and set the options directly on the resulting KSP object
21000971522cSBarry Smith 
21010971522cSBarry Smith    Level: intermediate
21020971522cSBarry Smith 
210379416396SBarry Smith    Options Database Keys:
210481540f2fSBarry Smith +   -pc_fieldsplit_%d_fields <a,b,..> - indicates the fields to be used in the %d'th split
210581540f2fSBarry Smith .   -pc_fieldsplit_default - automatically add any fields to additional splits that have not
210681540f2fSBarry Smith                               been supplied explicitly by -pc_fieldsplit_%d_fields
210781540f2fSBarry Smith .   -pc_fieldsplit_block_size <bs> - size of block that defines fields (i.e. there are bs fields)
21080f188ba9SJed Brown .   -pc_fieldsplit_type <additive,multiplicative,symmetric_multiplicative,schur> - type of relaxation or factorization splitting
21092e71c61dSMatthew G. Knepley .   -pc_fieldsplit_schur_precondition <self,selfp,user,a11,full> - default is a11
2110435f959eSBarry Smith .   -pc_fieldsplit_detect_saddle_point - automatically finds rows with zero or negative diagonal and uses Schur complement with no preconditioner as the solver
211179416396SBarry Smith 
21125d4c12cdSJungho Lee -    Options prefix for inner solvers when using Schur complement preconditioner are -fieldsplit_0_ and -fieldsplit_1_
21135d4c12cdSJungho Lee      for all other solvers they are -fieldsplit_%d_ for the dth field, use -fieldsplit_ for all fields
21145d4c12cdSJungho Lee 
2115c8a0d604SMatthew G Knepley    Notes:
2116c8a0d604SMatthew G Knepley     Use PCFieldSplitSetFields() to set fields defined by "strided" entries and PCFieldSplitSetIS()
2117d32f9abdSBarry Smith      to define a field by an arbitrary collection of entries.
2118d32f9abdSBarry Smith 
2119d32f9abdSBarry Smith       If no fields are set the default is used. The fields are defined by entries strided by bs,
2120d32f9abdSBarry Smith       beginning at 0 then 1, etc to bs-1. The block size can be set with PCFieldSplitSetBlockSize(),
2121d32f9abdSBarry Smith       if this is not called the block size defaults to the blocksize of the second matrix passed
2122d32f9abdSBarry Smith       to KSPSetOperators()/PCSetOperators().
2123d32f9abdSBarry Smith 
2124c8a0d604SMatthew G Knepley $     For the Schur complement preconditioner if J = ( A00 A01 )
2125c8a0d604SMatthew G Knepley $                                                    ( A10 A11 )
2126c8a0d604SMatthew G Knepley $     the preconditioner using full factorization is
212713b05affSJed Brown $              ( I   -ksp(A00) A01 ) ( inv(A00)     0  ) (     I          0  )
2128c8a0d604SMatthew G Knepley $              ( 0         I       ) (   0      ksp(S) ) ( -A10 ksp(A00)  I  )
212913b05affSJed Brown      where the action of inv(A00) is applied using the KSP solver with prefix -fieldsplit_0_.  S is the Schur complement
213013b05affSJed Brown $              S = A11 - A10 ksp(A00) A01
213113b05affSJed 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
2132c8a0d604SMatthew G Knepley      in providing the SECOND split or 1 if not give). For PCFieldSplitGetKSP() when field number is 0,
2133c8a0d604SMatthew G Knepley      it returns the KSP associated with -fieldsplit_0_ while field number 1 gives -fieldsplit_1_ KSP. By default
213429f8a81cSJed Brown      A11 is used to construct a preconditioner for S, use PCFieldSplitSetSchurPre() to turn on or off this
2135a7476a74SDmitry Karpeev      option. You can use the preconditioner PCLSC to precondition the Schur complement with -fieldsplit_1_pc_type lsc.
2136a7476a74SDmitry Karpeev      When option -fieldsplit_schur_precondition selfp is given, an approximation to S is assembled --
2137a7476a74SDmitry Karpeev      Sp = A11 - A10 inv(diag(A00)) A01, which has type AIJ and can be used with a variety of preconditioners
2138a7476a74SDmitry Karpeev      (e.g., -fieldsplit_1_pc_type asm).
2139a7476a74SDmitry Karpeev      The factorization type is set using -pc_fieldsplit_schur_fact_type <diag, lower, upper, full>. The full is shown above,
21405668aaf4SBarry Smith      diag gives
2141c8a0d604SMatthew G Knepley $              ( inv(A00)     0   )
2142c8a0d604SMatthew G Knepley $              (   0      -ksp(S) )
21435668aaf4SBarry 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
2144c8a0d604SMatthew G Knepley $              (  A00   0 )
2145c8a0d604SMatthew G Knepley $              (  A10   S )
2146c8a0d604SMatthew G Knepley      where the inverses of A00 and S are applied using KSPs. The upper factorization is the inverse of
2147c8a0d604SMatthew G Knepley $              ( A00 A01 )
2148c8a0d604SMatthew G Knepley $              (  0   S  )
2149c8a0d604SMatthew G Knepley      where again the inverses of A00 and S are applied using KSPs.
2150e69d4d44SBarry Smith 
2151edf189efSBarry Smith      If only one set of indices (one IS) is provided with PCFieldSplitSetIS() then the complement of that IS
2152edf189efSBarry Smith      is used automatically for a second block.
2153edf189efSBarry Smith 
2154ff218e97SBarry Smith      The fieldsplit preconditioner cannot currently be used with the BAIJ or SBAIJ data formats if the blocksize is larger than 1.
2155ff218e97SBarry Smith      Generally it should be used with the AIJ format.
2156ff218e97SBarry Smith 
2157ff218e97SBarry Smith      The forms of these preconditioners are closely related if not identical to forms derived as "Distributive Iterations", see,
2158ff218e97SBarry Smith      for example, page 294 in "Principles of Computational Fluid Dynamics" by Pieter Wesseling. Note that one can also use PCFIELDSPLIT
2159ff218e97SBarry Smith      inside a smoother resulting in "Distributive Smoothers".
21600716a85fSBarry Smith 
2161a541d17aSBarry Smith    Concepts: physics based preconditioners, block preconditioners
21620971522cSBarry Smith 
21633bc631e0SBarry Smith    There is a nice discussion of block preconditioners in
21643bc631e0SBarry Smith 
21653bc631e0SBarry Smith [El08] A taxonomy and comparison of parallel block multi-level preconditioners for the incompressible Navier-Stokes equations
21663bc631e0SBarry Smith        Howard Elman, V.E. Howle, John Shadid, Robert Shuttleworth, Ray Tuminaro, Journal of Computational Physics 227 (2008) 1790--1808
21673bc631e0SBarry Smith        http://chess.cs.umd.edu/~elman/papers/tax.pdf
21683bc631e0SBarry Smith 
21697e8cb189SBarry Smith .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC, Block_Preconditioners, PCLSC,
217029f8a81cSJed Brown            PCFieldSplitGetSubKSP(), PCFieldSplitSetFields(), PCFieldSplitSetType(), PCFieldSplitSetIS(), PCFieldSplitSetSchurPre()
21710971522cSBarry Smith M*/
21720971522cSBarry Smith 
21730971522cSBarry Smith #undef __FUNCT__
21740971522cSBarry Smith #define __FUNCT__ "PCCreate_FieldSplit"
21758cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_FieldSplit(PC pc)
21760971522cSBarry Smith {
21770971522cSBarry Smith   PetscErrorCode ierr;
21780971522cSBarry Smith   PC_FieldSplit  *jac;
21790971522cSBarry Smith 
21800971522cSBarry Smith   PetscFunctionBegin;
2181b00a9115SJed Brown   ierr = PetscNewLog(pc,&jac);CHKERRQ(ierr);
21822fa5cd67SKarl Rupp 
21830971522cSBarry Smith   jac->bs                 = -1;
21840971522cSBarry Smith   jac->nsplits            = 0;
21853e197d65SBarry Smith   jac->type               = PC_COMPOSITE_MULTIPLICATIVE;
2186e6cab6aaSJed Brown   jac->schurpre           = PC_FIELDSPLIT_SCHUR_PRE_USER; /* Try user preconditioner first, fall back on diagonal */
2187c9c6ffaaSJed Brown   jac->schurfactorization = PC_FIELDSPLIT_SCHUR_FACT_FULL;
2188fbe7908bSJed Brown   jac->dm_splits          = PETSC_TRUE;
218951f519a2SBarry Smith 
21900971522cSBarry Smith   pc->data = (void*)jac;
21910971522cSBarry Smith 
21920971522cSBarry Smith   pc->ops->apply           = PCApply_FieldSplit;
2193421e10b8SBarry Smith   pc->ops->applytranspose  = PCApplyTranspose_FieldSplit;
21940971522cSBarry Smith   pc->ops->setup           = PCSetUp_FieldSplit;
2195574deadeSBarry Smith   pc->ops->reset           = PCReset_FieldSplit;
21960971522cSBarry Smith   pc->ops->destroy         = PCDestroy_FieldSplit;
21970971522cSBarry Smith   pc->ops->setfromoptions  = PCSetFromOptions_FieldSplit;
21980971522cSBarry Smith   pc->ops->view            = PCView_FieldSplit;
21990971522cSBarry Smith   pc->ops->applyrichardson = 0;
22000971522cSBarry Smith 
2201bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitGetSubKSP_C",PCFieldSplitGetSubKSP_FieldSplit);CHKERRQ(ierr);
2202bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetFields_C",PCFieldSplitSetFields_FieldSplit);CHKERRQ(ierr);
2203bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetIS_C",PCFieldSplitSetIS_FieldSplit);CHKERRQ(ierr);
2204bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetType_C",PCFieldSplitSetType_FieldSplit);CHKERRQ(ierr);
2205bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCFieldSplitSetBlockSize_C",PCFieldSplitSetBlockSize_FieldSplit);CHKERRQ(ierr);
22060971522cSBarry Smith   PetscFunctionReturn(0);
22070971522cSBarry Smith }
22080971522cSBarry Smith 
22090971522cSBarry Smith 
2210a541d17aSBarry Smith 
2211